diff --git a/.github/workflows/check-oas-updates.yml b/.github/workflows/check-oas-updates.yml deleted file mode 100644 index 82e43906..00000000 --- a/.github/workflows/check-oas-updates.yml +++ /dev/null @@ -1,95 +0,0 @@ -name: Check OAS Updates - -on: - schedule: - # Run at 00:00 UTC every weekday - - cron: "0 0 * * 1-5" - workflow_dispatch: - # Allow manual triggering - -jobs: - check-oas-updates: - name: Check for OAS updates - runs-on: ubuntu-slim - permissions: - contents: write - pull-requests: write - - steps: - - name: Checkout repository - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 - - - name: Setup Bun - uses: oven-sh/setup-bun@735343b667d3e6f658f44d0eca948eb6282f2b76 # v2.0.2 - with: - bun-version: latest - - - name: Install dependencies - run: bun ci - - - name: Fetch latest OAS specs - run: bun run fetch:specs - - - name: Check for OAS changes - id: check-oas-changes - run: | - if [[ -n "$(git status --porcelain src/openapi/generated/)" ]]; then - echo "changes=true" >> $GITHUB_OUTPUT - echo "::notice::OAS changes detected" - else - echo "changes=false" >> $GITHUB_OUTPUT - echo "::notice::No OAS changes detected" - fi - - - name: Update test snapshots - if: steps.check-oas-changes.outputs.changes == 'true' - run: bun test -u - - - name: Verify changes work with the codebase - if: steps.check-oas-changes.outputs.changes == 'true' - run: | - # Run tests to ensure the updated OAS files don't break anything - bun test - - # Run linter to ensure code quality - bun run lint - - # Verify the package builds correctly with the updated OAS files - bun run build - - - name: Configure Git - if: steps.check-oas-changes.outputs.changes == 'true' - run: | - git config --global user.name 'github-actions[bot]' - git config --global user.email 'github-actions[bot]@users.noreply.github.com' - - - name: Create Pull Request - if: steps.check-oas-changes.outputs.changes == 'true' - id: create-pr - uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8 - with: - token: ${{ secrets.GITHUB_TOKEN }} - commit-message: "chore: update OAS specifications and test snapshots" - committer: github-actions[bot] - author: github-actions[bot] - title: "chore: update OAS specifications and test snapshots" - body: | - This PR updates the OpenAPI specifications to the latest version and regenerates test snapshots. - - Changes were automatically detected and committed by the GitHub Actions workflow. - - - [x] OAS files updated - - [x] Test snapshots updated - - [x] Verified changes work with the codebase (tests, lint, build) - branch: auto-update-oas - base: main - delete-branch: true - labels: | - automated - dependencies - - - name: PR Summary - if: steps.create-pr.outputs.pull-request-number - run: | - echo "::notice::Created PR #${{ steps.create-pr.outputs.pull-request-number }} with OAS updates" - echo "::notice::PR URL: ${{ steps.create-pr.outputs.pull-request-url }}" diff --git a/README.md b/README.md index 20c2e19b..30a5f9d7 100644 --- a/README.md +++ b/README.md @@ -6,16 +6,9 @@ -## Toolsets - -StackOne provides two toolsets: - -- `OpenAPIToolSet`: A toolset generated from supplied OpenAPI specifications -- `StackOneToolSet`: A toolset preloaded with StackOne Unified Tools (every [StackOne Unified API endpoints](https://docs.stackone.com/hris/introduction) has its tool equivalent in this toolset) - -These toolsets provide functionality to filter, transform, and execute tools. The toolsets can be easily used via common AI Agent libraries. +## StackOneToolSet -Under the hood the StackOneToolSet uses the same OpenAPIParser as the OpenAPIToolSet, but provides some convenience methods for using StackOne API keys and account IDs. +The StackOne AI SDK provides the `StackOneToolSet` class, which fetches tools dynamically from StackOne's MCP (Model Context Protocol) endpoint. This ensures you always have access to the latest tool definitions. ## Installation @@ -47,20 +40,24 @@ bun add ai ## Integrations -The OpenAPIToolSet and StackOneToolSet make it super easy to use these APIs as tools in your AI applications. +The StackOneToolSet makes it super easy to use StackOne APIs as tools in your AI applications. -### With Open AI library +### With OpenAI library ```typescript import { OpenAI } from "openai"; import { StackOneToolSet } from "@stackone/ai"; -const toolset = new StackOneToolSet(); +const toolset = new StackOneToolSet({ + baseUrl: "https://api.stackone.com", +}); -const tools = toolset.getTools("hris_*", "").toOpenAI(); +const tools = await toolset.fetchTools({ + actions: ["hris_*"], +}); await openai.chat.completions.create({ - model: "gpt-5", + model: "gpt-4o", messages: [ { role: "system", @@ -71,7 +68,7 @@ await openai.chat.completions.create({ content: "Create a time-off request for employee id cxIQ5764hj2", }, ], - tools: tools, + tools: tools.toOpenAI(), }); ``` @@ -84,27 +81,33 @@ import { openai } from "@ai-sdk/openai"; import { generateText } from "ai"; import { StackOneToolSet } from "@stackone/ai"; -const toolset = new StackOneToolSet(); +const toolset = new StackOneToolSet({ + baseUrl: "https://api.stackone.com", +}); + +const tools = await toolset.fetchTools({ + actions: ["hris_*"], +}); -const aiSdkTools = await toolset.getTools("hris_*").toAISDK(); await generateText({ - model: openai("gpt-5"), - tools: aiSdkTools, + model: openai("gpt-4o"), + tools: await tools.toAISDK(), maxSteps: 3, }); ``` [View full example](examples/ai-sdk-integration.ts) -## StackOneToolSet - -The StackOneToolSet is an extension of the OpenAPIToolSet that adds some convenience methods for using StackOne API keys and account IDs and some other features. +## Usage ```typescript import { StackOneToolSet } from "@stackone/ai"; -const toolset = new StackOneToolSet(); -const tools = toolset.getTools("hris_*", "your-account-id"); +const toolset = new StackOneToolSet({ + baseUrl: "https://api.stackone.com", +}); + +const tools = await toolset.fetchTools(); const employeeTool = tools.getTool("hris_list_employees"); const employees = await employeeTool.execute(); ``` @@ -128,11 +131,12 @@ StackOne uses account IDs to identify different integrations. You can specify th ```typescript import { StackOneToolSet } from "@stackone/ai"; -// Method 1: Set at toolset initialization +// Method 1: Set at toolset initialisation const toolset = new StackOneToolSet({ accountId: "your-account-id" }); -// Method 2: Set when getting tools (overrides toolset account ID) -const tools = toolset.getTools("hris_*", "override-account-id"); +// Method 2: Use setAccounts for filtering when fetching +toolset.setAccounts(["account-123", "account-456"]); +const tools = await toolset.fetchTools(); // Method 3: Set directly on a tool instance tools.setAccountId("direct-account-id"); @@ -141,26 +145,7 @@ const currentAccountId = tools.getAccountId(); // Get the current account ID [View full example](examples/account-id-usage.ts) -### Loading the Latest Tool Catalog - -Call `fetchTools()` when you want the SDK to pull the current tool definitions directly from StackOne without maintaining local specs: - -```typescript -const toolset = new StackOneToolSet({ - baseUrl: "https://api.stackone.com", -}); - -const tools = await toolset.fetchTools(); -const employeeTool = tools.getTool("hris_list_employees"); - -const result = await employeeTool?.execute({ - query: { limit: 5 }, -}); -``` - -`fetchTools()` reuses the credentials you already configured (for example via `STACKONE_API_KEY`) and binds the returned tool objects to StackOne's actions client. - -#### Filtering Tools with fetchTools() +### Filtering Tools with fetchTools() You can filter tools by account IDs, providers, and action patterns: @@ -200,108 +185,11 @@ This is especially useful when you want to: [View full example](examples/fetch-tools.ts) -### File Upload - -The `StackOneToolSet` comes with built-in transformations for file uploads: - -```typescript -import { StackOneToolSet } from "@stackone/ai"; - -const toolset = new StackOneToolSet(); -const tools = toolset.getTools("*file_upload*"); -const fileUploadTool = tools.getTool("storage_file_upload"); - -// Execute with just the file_path parameter -// The file_content, file_name, and file_format will be derived automatically -const result = await fileUploadTool.execute({ file_path: "/path/to/file.pdf" }); -``` - -[View full example](examples/file-uploads.ts) - -> Note: you can build your own custom transformations using both toolset classes. See the [Parameter Transformations](#parameter-transformations) section for more information. - -## OpenAPIToolSet - -The OpenAPIToolSet class allows you to parse OpenAPI specifications as tools from either a local file or a remote URL. - -### Loading from a File - -```typescript -import { OpenAPIToolSet } from "@stackone/ai"; -import path from "node:path"; - -// Create the toolset -const toolset = new OpenAPIToolSet({ - filePath: path.join(import.meta.dirname, "path/to/openapi-spec.json"); -}); - -// Get all tools -const allTools = toolset.getTools(); - -// Get filtered tools -const filteredTools = toolset.getTools("user_*"); -``` - -### Loading from a URL - -```typescript -import { OpenAPIToolSet } from "@stackone/ai"; - -// Create the toolset using the factory method -const toolset = await OpenAPIToolSet.fromUrl({ - url: "https://example.com/path/to/openapi-spec.json", -}); -``` - -### Authentication Options - -The OpenAPIToolSet supports easy usage of bot Basic and Bearer authentication: - -```typescript -// Basic Authentication -const toolsetWithBasicAuth = new OpenAPIToolSet({ - filePath: "path/to/spec.json", - authentication: { - type: "basic", - credentials: { - username: "user", - password: "pass", - }, - }, -}); - -// Bearer Authentication -const toolsetWithBearerAuth = await OpenAPIToolSet.fromUrl({ - url: "https://example.com/spec.json", - authentication: { - type: "bearer", - credentials: { - token: "your-bearer-token", - }, - }, -}); -``` - -You can also directly write to the toolset headers: - -```typescript -const toolsetWithHeaders = new OpenAPIToolSet({ - filePath: "path/to/spec.json", - headers: { - Authorization: "Bearer your-bearer-token", - }, -}); -``` - -[View full example](examples/openapi-toolset.ts) - -## Unified Features - -These are some of the features which you can use with the OpenAPIToolSet and StackOneToolSet. +## Features ### Feedback Collection Tool -The StackOne AI SDK includes a built-in feedback collection tool (`meta_collect_tool_feedback`) that allows users to provide feedback on their experience with StackOne tools. This tool is automatically included in the `StackOneToolSet` and helps improve the SDK based on user input. +The StackOne AI SDK includes a built-in feedback collection tool (`meta_collect_tool_feedback`) that allows users to provide feedback on their experience with StackOne tools. This tool is automatically included when using `fetchTools()` and helps improve the SDK based on user input. #### How It Works @@ -320,8 +208,10 @@ The feedback tool is automatically available when using `StackOneToolSet`: ```typescript import { StackOneToolSet } from "@stackone/ai"; -const toolset = new StackOneToolSet(); -const tools = toolset.getTools("*", "account-id"); +const toolset = new StackOneToolSet({ + baseUrl: "https://api.stackone.com", +}); +const tools = await toolset.fetchTools(); // The feedback tool is automatically included const feedbackTool = tools.getTool("meta_collect_tool_feedback"); @@ -421,8 +311,10 @@ Meta tools provide two core capabilities: ```typescript import { StackOneToolSet } from "@stackone/ai"; -const toolset = new StackOneToolSet(); -const tools = toolset.getStackOneTools("*", "account-id"); +const toolset = new StackOneToolSet({ + baseUrl: "https://api.stackone.com", +}); +const tools = await toolset.fetchTools(); // Get meta tools for dynamic discovery const metaTools = await tools.metaTools(); @@ -483,105 +375,35 @@ const toolset = new StackOneToolSet({ baseUrl: "https://api.example-dev.com" }); [View full example](examples/custom-base-url.ts) -### Advanced Parameter Transformations - -**โš ๏ธ EXPERIMENTAL**: For advanced use cases, you can dynamically transform tool schemas and parameters using the experimental schema override and preExecute functionality. - -This two-stage transformation approach allows you to: - -1. **Schema Override**: Change the tool's input schema at creation time -2. **PreExecute**: Transform parameters from the override schema back to the original API format at execution time +### Testing with dryRun -This is particularly powerful for document handling, where you can simplify complex file upload parameters: +You can use the `dryRun` option to return the api arguments from a tool call without making the actual api call: ```typescript import { StackOneToolSet } from "@stackone/ai"; -import type { - Experimental_SchemaOverride, - Experimental_PreExecuteFunction, -} from "@stackone/ai"; - -// 1. Schema Override: Simplify the input schema -const documentSchemaOverride: Experimental_SchemaOverride = ( - originalSchema -) => { - // Replace complex file parameters with simple doc_id - const newProperties = { ...originalSchema.properties }; - delete newProperties.content; - delete newProperties.name; - delete newProperties.file_format; - - newProperties.doc_id = { - type: "string", - description: "Document path or identifier", - }; - - return { ...originalSchema, properties: newProperties }; -}; - -// 2. PreExecute: Transform the simplified parameters back to API format -const documentPreExecute: Experimental_PreExecuteFunction = async (params) => { - const { doc_id, ...otherParams } = params; - - // Read file and convert to required API format - const fileContent = readFileSync(doc_id); - const base64Content = fileContent.toString("base64"); - const fileName = basename(doc_id); - const extension = extname(doc_id).slice(1); - - return { - ...otherParams, - content: base64Content, - name: fileName, - file_format: { value: extension }, - }; -}; - -// Use the experimental transformation -const toolset = new StackOneToolSet(); -const tools = toolset.getStackOneTools("hris_*", "account_id"); - -const documentTool = tools.getTool("hris_upload_employee_document", { - experimental_schemaOverride: documentSchemaOverride, - experimental_preExecute: documentPreExecute, -}); -// Now you can use the simplified schema -const result = await documentTool.execute({ - doc_id: "/path/to/document.pdf", // Simplified input - id: "employee_123", - category: { value: "shared" }, +// Initialise the toolset +const toolset = new StackOneToolSet({ + baseUrl: "https://api.stackone.com", }); -``` - -โš ๏ธ **Important**: This is experimental functionality and the API may change in future versions. - -[View full example](examples/experimental-document-handling.ts) -### Testing with dryRun - -You can use the `dryRun` option to return the api arguments from a tool call without making the actual api call: +const tools = await toolset.fetchTools(); +const employeeTool = tools.getTool("hris_list_employees"); -```typescript -import { StackOneToolSet } from "stackone-ai-node"; -import assert from "node:assert"; - -// Initialize the toolset -const toolset = new StackOneToolSet(); -const fileUploadTool = toolset - .getTools("*file_upload*") - .getTool("storage_file_upload"); - -// Use dryRun to see how the file path is derived into other parameters -const dryRunResult = await fileUploadTool.execute( - { file_path: "/path/to/file.pdf" }, +// Use dryRun to see the request details +const dryRunResult = await employeeTool.execute( + { query: { limit: 5 } }, { dryRun: true } ); -// Verify the derived parameters -assert("file_content" in dryRunResult.mappedParams); -assert("file_name" in dryRunResult.mappedParams); -assert("file_format" in dryRunResult.mappedParams); +console.log(dryRunResult); +// { +// url: "https://api.stackone.com/actions/rpc", +// method: "POST", +// headers: { ... }, +// body: "...", +// mappedParams: { ... } +// } ``` The `dryRun` option returns an object containing: @@ -589,6 +411,5 @@ The `dryRun` option returns an object containing: - `url`: The full URL with query parameters - `method`: The HTTP method - `headers`: The request headers -- `body`: The request body (or '[FormData]' for multipart form data) +- `body`: The request body - `mappedParams`: The parameters after mapping and derivation -- `originalParams`: The original parameters provided to the execute method diff --git a/examples/account-id-usage.ts b/examples/account-id-usage.ts deleted file mode 100644 index 1b6684e0..00000000 --- a/examples/account-id-usage.ts +++ /dev/null @@ -1,57 +0,0 @@ -#!/usr/bin/env bun -/** - * Example demonstrating different ways to set the account ID when using StackOne tools. - * - * This example shows: - * 1. Setting account ID when initializing the toolset - * 2. Setting account ID when getting tools - * 3. Using setAccountId method directly on a tool - * - * Usage: - * - * ```bash - * bun run examples/account-id-usage.ts - * ``` - */ - -import assert from 'node:assert'; -import { StackOneToolSet } from '../src'; -import { ACCOUNT_IDS } from './constants'; - -const accountIdUsage = async (): Promise => { - /* - * Set account ID on toolset initialization - */ - const toolset = new StackOneToolSet({ accountId: ACCOUNT_IDS.TEST.VALID }); - - const tools = toolset.getTools('hris_*'); - const employeeTool = tools.getStackOneTool('hris_list_employees'); - - assert( - employeeTool.getAccountId() === ACCOUNT_IDS.TEST.VALID, - 'Account ID should match what was set' - ); - - /* - * Setting account ID when getting tools (overrides toolset account ID) - */ - const toolsWithOverride = toolset.getStackOneTools('hris_*', ACCOUNT_IDS.TEST.OVERRIDE); - const employeeToolWithOverride = toolsWithOverride.getStackOneTool('hris_list_employees'); - - assert( - employeeToolWithOverride?.getAccountId() === ACCOUNT_IDS.TEST.OVERRIDE, - 'Account ID should match what was set' - ); - - /* - * Set the account ID directly on the tool - */ - employeeTool.setAccountId(ACCOUNT_IDS.TEST.DIRECT); - - assert( - employeeTool.getAccountId() === ACCOUNT_IDS.TEST.DIRECT, - 'Account ID should match what was set' - ); -}; - -accountIdUsage(); diff --git a/examples/ai-sdk-integration.ts b/examples/ai-sdk-integration.ts index 990b2ce6..3d9879c4 100644 --- a/examples/ai-sdk-integration.ts +++ b/examples/ai-sdk-integration.ts @@ -3,25 +3,41 @@ */ import assert from 'node:assert'; +import process from 'node:process'; import { openai } from '@ai-sdk/openai'; import { generateText } from 'ai'; import { StackOneToolSet } from '../src'; import { ACCOUNT_IDS } from './constants'; +const apiKey = process.env.STACKONE_API_KEY; +const isPlaceholderKey = !apiKey || apiKey === 'test-stackone-key'; +const shouldSkip = process.env.SKIP_FETCH_TOOLS_EXAMPLE !== '0' && isPlaceholderKey; + +if (shouldSkip) { + console.log( + 'Skipping ai-sdk-integration example. Provide STACKONE_API_KEY and set SKIP_FETCH_TOOLS_EXAMPLE=0 to run.' + ); + process.exit(0); +} + const aiSdkIntegration = async (): Promise => { - // Initialize StackOne - const toolset = new StackOneToolSet(); - const accountId = ACCOUNT_IDS.HRIS; + // Initialise StackOne + const toolset = new StackOneToolSet({ + accountId: ACCOUNT_IDS.HRIS, + baseUrl: process.env.STACKONE_BASE_URL ?? 'https://api.stackone.com', + }); - // Get HRIS tools - const tools = toolset.getStackOneTools('hris_get_*', accountId); + // Fetch HRIS tools via MCP + const tools = await toolset.fetchTools({ + actions: ['hris_get_*'], + }); // Convert to AI SDK tools const aiSdkTools = await tools.toAISDK(); // Use max steps to automatically call the tool if it's needed const { text } = await generateText({ - model: openai('gpt-5'), + model: openai('gpt-4o'), tools: aiSdkTools, prompt: 'Get all details about employee with id: c28xIQaWQ6MzM5MzczMDA2NzMzMzkwNzIwNA', maxSteps: 3, diff --git a/examples/custom-base-url.ts b/examples/custom-base-url.ts deleted file mode 100644 index 0e1adf0b..00000000 --- a/examples/custom-base-url.ts +++ /dev/null @@ -1,63 +0,0 @@ -#!/usr/bin/env bun -/** - * Example demonstrating how to use a custom base URL with StackOne tools. - * - * This is useful for: - * 1. Testing against development APIs - * 2. Working with self-hosted StackOne instances - * - * Usage: - * - * ```bash - * bun run examples/custom-base-url.ts - * ``` - */ - -import assert from 'node:assert'; -import { StackOneToolSet } from '../src'; - -const customBaseUrl = async (): Promise => { - /** - * Default base URL - */ - const defaultToolset = new StackOneToolSet(); - const hrisTools = defaultToolset.getTools('hris_*'); - - assert(hrisTools.length > 0, 'Should have at least one HRIS tool'); - const defaultTool = hrisTools.getTool('hris_get_employee'); - if (!defaultTool) { - throw new Error('Tool not found'); - } - - /** - * Custom base URL - */ - const devToolset = new StackOneToolSet({ - baseUrl: 'https://api.example-dev.com', - }); - - const devHrisTools = devToolset.getTools('hris_*'); - - assert(devHrisTools.length > 0, 'Should have at least one HRIS tool'); - const devTool = devHrisTools.getTool('hris_get_employee'); - if (!devTool) { - throw new Error('Tool not found'); - } - - /** - * Note this uses the same tools but substitutes the base URL - */ - if (defaultTool && devTool) { - assert(defaultTool.name === devTool.name, 'Tool names should be the same'); - assert( - defaultTool.executeConfig.url.includes('https://api.stackone.com'), - 'Default tool should use the default base URL' - ); - assert( - devTool.executeConfig.url.includes('https://api.example-dev.com'), - 'Custom tool should use the custom base URL' - ); - } -}; - -customBaseUrl(); diff --git a/examples/error-handling.ts b/examples/error-handling.ts deleted file mode 100644 index fa7f6f4e..00000000 --- a/examples/error-handling.ts +++ /dev/null @@ -1,99 +0,0 @@ -/** - * # Error Handling - * - * This example shows how to handle errors when using the StackOne SDK. - */ - -import assert from 'node:assert'; -import { StackOneAPIError, StackOneError, StackOneToolSet, ToolSetConfigError } from '../src'; -import { ACCOUNT_IDS } from './constants'; - -const errorHandling = async (): Promise => { - // Example 1: Handle initialization errors - const testInitializationErrors = async (): Promise => { - // Temporarily save the API key - const originalKey = process.env.STACKONE_API_KEY; - // Delete the API key to force an error - process.env.STACKONE_API_KEY = undefined; - - try { - // This will throw a ToolsetConfigError - const _toolset = new StackOneToolSet({ - strict: true, - }); - assert(false, 'Expected ToolSetConfigError was not thrown'); - } catch (error) { - assert(error instanceof ToolSetConfigError, 'Expected error to be ToolSetConfigError'); - } finally { - // Restore the API key - process.env.STACKONE_API_KEY = originalKey; - } - }; - - // Example 2: Handle API errors - const testApiErrors = async (): Promise => { - const toolset = new StackOneToolSet(); - const accountId = ACCOUNT_IDS.TEST.INVALID; // Invalid account ID to force an error - - try { - const tools = toolset.getStackOneTools('hris_*', accountId); - const employeeTool = tools.getTool('hris_list_employees'); - - if (employeeTool) { - // This will throw a StackOneAPIError due to the invalid account ID - await employeeTool.execute(); - assert(false, 'Expected StackOneAPIError was not thrown'); - } - } catch (error) { - assert( - error instanceof StackOneAPIError || error instanceof StackOneError, - 'Expected error to be StackOneAPIError or StackOneError' - ); - - if (error instanceof StackOneAPIError) { - assert(error.statusCode !== undefined, 'Expected statusCode to be defined'); - assert(error.responseBody !== undefined, 'Expected responseBody to be defined'); - } - } - }; - - // Example 3: Handle invalid tool name - const testInvalidToolName = async (): Promise => { - const toolset = new StackOneToolSet(); - const tools = toolset.getTools('hris_*'); - const nonExistentTool = tools.getTool('non_existent_tool'); - - assert(nonExistentTool === undefined, 'Expected non-existent tool to be undefined'); - }; - - // Example 4: Handle invalid arguments - const testInvalidArguments = async (): Promise => { - const toolset = new StackOneToolSet(); - const tools = toolset.getTools('hris_*'); - const employeeTool = tools.getTool('hris_get_employee'); - - if (employeeTool) { - try { - // This will throw an error due to missing required arguments - await employeeTool.execute(); - assert(false, 'Expected error was not thrown for missing arguments'); - } catch (error) { - assert( - error instanceof StackOneAPIError || - error instanceof StackOneError || - error instanceof Error, - 'Expected error to be a known error type' - ); - } - } - }; - - // Run all tests - await testInitializationErrors(); - await testApiErrors(); - await testInvalidToolName(); - await testInvalidArguments(); -}; - -// Run the example -errorHandling(); diff --git a/examples/experimental-document-handling.ts b/examples/experimental-document-handling.ts deleted file mode 100644 index c9a53d97..00000000 --- a/examples/experimental-document-handling.ts +++ /dev/null @@ -1,388 +0,0 @@ -/** - * EXPERIMENTAL: Document Handling with Schema Override + PreExecute - * - * This example demonstrates the new experimental schema override + preExecute functionality - * for handling documents from various sources (local files, URLs, databases, etc.) - * - * The new API provides two-stage transformation: - * 1. Schema Override: Changes the tool's input schema at creation time - * 2. PreExecute: Transforms from override schema back to original API format at execution time - * - * This is an experimental feature and the API may change in future versions. - * - * Run this example with: - * bun run examples/experimental-document-handling.ts - */ - -import assert from 'node:assert'; -import * as fs from 'node:fs'; -import * as path from 'node:path'; -import type { JSONSchema7Definition } from 'json-schema'; -import { - type Experimental_PreExecuteFunction, - type Experimental_SchemaOverride, - StackOneToolSet, -} from '../src'; -import { ACCOUNT_IDS } from './constants'; - -const accountId = ACCOUNT_IDS.HRIS; - -interface FileFormatParam { - value: string; -} - -interface DocumentParams { - content: string; - name: string; - file_format: FileFormatParam; - [key: string]: unknown; -} - -/** - * EXPERIMENTAL: Schema override for document upload - changes from complex schema to simple doc_id - */ -const createDocumentSchemaOverride = (): Experimental_SchemaOverride => { - return (originalSchema) => { - // Extract only the category from original schema, replace file-related params with doc_id - const newProperties: Record = {}; - - // Keep non-file parameters from original schema - for (const [key, value] of Object.entries(originalSchema.properties)) { - if (!['content', 'name', 'file_format'].includes(key)) { - newProperties[key] = value; - } - } - - // Add simplified document ID parameter - newProperties.doc_id = { - type: 'string', - description: 'Document identifier or file path', - }; - - return { - type: 'object', - properties: newProperties, - required: [ - 'doc_id', - ...(originalSchema.required?.filter( - (r) => !['content', 'name', 'file_format'].includes(r) - ) || []), - ], - }; - }; -}; - -/** - * EXPERIMENTAL: PreExecute function that transforms doc_id back to original file parameters - */ -const createDocumentPreExecute = (allowedPaths: string[]): Experimental_PreExecuteFunction => { - return async (params) => { - const { doc_id, ...otherParams } = params; - - if (typeof doc_id !== 'string') { - throw new Error('doc_id must be a string'); - } - - // Security check: only allow certain paths - const isAllowed = allowedPaths.some((allowedPath) => doc_id.startsWith(allowedPath)); - - if (!isAllowed) { - throw new Error(`Document path not allowed: ${doc_id}`); - } - - if (!fs.existsSync(doc_id)) { - throw new Error(`Document not found: ${doc_id}`); - } - - // Read file and convert to base64 - const fileContent = fs.readFileSync(doc_id); - const base64Content = fileContent.toString('base64'); - const fileName = path.basename(doc_id); - const extension = path.extname(doc_id).slice(1); - - // Transform back to original API format - return { - ...otherParams, - content: base64Content, - name: fileName, - file_format: { value: extension }, - }; - }; -}; - -/** - * EXPERIMENTAL: Schema override for external document references - */ -const createExternalDocumentSchemaOverride = (): Experimental_SchemaOverride => { - return (originalSchema) => { - const newProperties: Record = {}; - - // Keep non-file parameters from original schema - for (const [key, value] of Object.entries(originalSchema.properties)) { - if (!['content', 'name', 'file_format'].includes(key)) { - newProperties[key] = value; - } - } - - // Add external document reference parameter - newProperties.document_reference = { - type: 'string', - description: 'External document reference (S3 key, database ID, etc.)', - }; - - return { - type: 'object', - properties: newProperties, - required: [ - 'document_reference', - ...(originalSchema.required?.filter( - (r) => !['content', 'name', 'file_format'].includes(r) - ) || []), - ], - }; - }; -}; - -/** - * EXPERIMENTAL: PreExecute function for external document fetching - */ -const createExternalDocumentPreExecute = (): Experimental_PreExecuteFunction => { - return async (params) => { - const { document_reference, ...otherParams } = params; - - if (typeof document_reference !== 'string') { - throw new Error('document_reference must be a string'); - } - - // Simulate fetching from external source (S3, database, etc.) - console.log(`Fetching document from external source: ${document_reference}`); - - // In a real implementation, this would fetch from S3, database, etc. - const mockDocumentContent = 'This is a mock document fetched from external source'; - const base64Content = Buffer.from(mockDocumentContent).toString('base64'); - - // Transform back to original API format - return { - ...otherParams, - content: base64Content, - name: `external-doc-${document_reference}.txt`, - file_format: { value: 'txt' }, - }; - }; -}; - -/** - * EXPERIMENTAL: Schema override for multi-source documents (supports both local and external) - */ -const createMultiSourceSchemaOverride = (): Experimental_SchemaOverride => { - return (originalSchema) => { - const newProperties: Record = {}; - - // Keep non-file parameters from original schema - for (const [key, value] of Object.entries(originalSchema.properties)) { - if (!['content', 'name', 'file_format'].includes(key)) { - newProperties[key] = value; - } - } - - // Add both document parameters (user can provide either) - newProperties.doc_id = { - type: 'string', - description: 'Local document path (takes precedence if both provided)', - }; - - newProperties.document_reference = { - type: 'string', - description: 'External document reference (used if doc_id not provided)', - }; - - return { - type: 'object', - properties: newProperties, - required: [ - ...(originalSchema.required?.filter( - (r) => !['content', 'name', 'file_format'].includes(r) - ) || []), - ], - }; - }; -}; - -/** - * EXPERIMENTAL: PreExecute function for multi-source document handling with fallback - */ -const createMultiSourcePreExecute = (localPaths: string[]): Experimental_PreExecuteFunction => { - const localPreExecute = createDocumentPreExecute(localPaths); - const externalPreExecute = createExternalDocumentPreExecute(); - - return async (params) => { - // Try local file first if doc_id is provided - if (params.doc_id) { - try { - return await localPreExecute(params); - } catch (error) { - console.warn(`Local file handler failed: ${error}`); - } - } - - // Fallback to external handler if document_reference is provided - if (params.document_reference) { - return await externalPreExecute(params); - } - - // No document parameters provided - throw new Error('Either doc_id or document_reference must be provided'); - }; -}; - -const experimentalDocumentHandling = async (): Promise => { - // Create a sample file for testing - const sampleFilePath = path.join(__dirname, 'sample-document.txt'); - fs.writeFileSync(sampleFilePath, 'This is an experimental document handling test file.'); - - try { - // Initialize the StackOne toolset - const toolset = new StackOneToolSet(); - - // Get base tools for documents - const tools = toolset.getStackOneTools('hris_*', accountId); - - console.log('๐Ÿงช Testing EXPERIMENTAL schema override + preExecute for local files...'); - - // EXPERIMENTAL: Create a tool with schema override and preExecute for local files - const localDocumentTool = tools.getTool('hris_upload_employee_document', { - experimental_schemaOverride: createDocumentSchemaOverride(), - experimental_preExecute: createDocumentPreExecute([__dirname]), - }); - - assert(localDocumentTool !== undefined, 'Local document tool not found'); - - // Use the new simplified schema (doc_id instead of content/name/file_format) - const localFileResult = await localDocumentTool.execute( - { - doc_id: sampleFilePath, // Simplified schema - just document ID - id: 'c28xIQaWQ6MzM5MzczMDA2NzMzMzkwNzIwNA', - category: { value: 'shared' }, - }, - { - dryRun: true, - } - ); - - console.log('โœ… Local file schema override + preExecute successful'); - const localParams = localFileResult.mappedParams as Record; - const localDocumentParams = localParams as DocumentParams & Record; - assert( - localDocumentParams.file_format?.value === 'txt', - 'File format was not transformed correctly' - ); - assert( - localDocumentParams.name === 'sample-document.txt', - 'File name was not transformed correctly' - ); - assert( - typeof localDocumentParams.content === 'string', - 'File content was not transformed correctly' - ); - - console.log('๐Ÿงช Testing EXPERIMENTAL schema override + preExecute for external documents...'); - - // EXPERIMENTAL: Create a tool for external document references - const externalDocumentTool = tools.getTool('hris_upload_employee_document', { - experimental_schemaOverride: createExternalDocumentSchemaOverride(), - experimental_preExecute: createExternalDocumentPreExecute(), - }); - - assert(externalDocumentTool !== undefined, 'External document tool not found'); - - const externalResult = await externalDocumentTool.execute( - { - document_reference: 'external-doc-123', // Simplified schema - just reference - id: 'c28xIQaWQ6MzM5MzczMDA2NzMzMzkwNzIwNA', - category: { value: 'shared' }, - }, - { - dryRun: true, - } - ); - - console.log('โœ… External document schema override + preExecute successful'); - const externalParams = externalResult.mappedParams as Record; - const externalDocumentParams = externalParams as DocumentParams & Record; - assert( - externalDocumentParams.name.includes('external-doc-123'), - 'External document name was not transformed correctly' - ); - - console.log('๐Ÿงช Testing EXPERIMENTAL multi-source schema override + preExecute...'); - - // EXPERIMENTAL: Create a tool that supports both local and external documents - const multiSourceTool = tools.getTool('hris_upload_employee_document', { - experimental_schemaOverride: createMultiSourceSchemaOverride(), - experimental_preExecute: createMultiSourcePreExecute([__dirname]), - }); - - assert(multiSourceTool !== undefined, 'Multi-source tool not found'); - - // Test with local file - const multiSourceLocalResult = await multiSourceTool.execute( - { - doc_id: sampleFilePath, // Local file takes precedence - id: 'c28xIQaWQ6MzM5MzczMDA2NzMzMzkwNzIwNA', - category: { value: 'shared' }, - }, - { - dryRun: true, - } - ); - - console.log('โœ… Multi-source (local) schema override + preExecute successful'); - const multiLocalParams = multiSourceLocalResult.mappedParams as Record; - const multiLocalDocumentParams = multiLocalParams as DocumentParams & Record; - assert( - multiLocalDocumentParams.name === 'sample-document.txt', - 'Multi-source local document name was not transformed correctly' - ); - - // Test with external reference - const multiSourceExternalResult = await multiSourceTool.execute( - { - document_reference: 'external-doc-456', // Fallback to external - id: 'c28xIQaWQ6MzM5MzczMDA2NzMzMzkwNzIwNA', - category: { value: 'shared' }, - }, - { - dryRun: true, - } - ); - - console.log('โœ… Multi-source (external) schema override + preExecute successful'); - const multiExternalParams = multiSourceExternalResult.mappedParams as Record; - const multiExternalDocumentParams = multiExternalParams as DocumentParams & - Record; - assert( - multiExternalDocumentParams.name.includes('external-doc-456'), - 'Multi-source external document name was not transformed correctly' - ); - - console.log('๐ŸŽ‰ All EXPERIMENTAL schema override + preExecute tests passed!'); - console.log(''); - console.log('๐Ÿ“‹ API Summary:'); - console.log(' 1. experimental_schemaOverride: Changes tool input schema at creation time'); - console.log( - ' 2. experimental_preExecute: Transforms from override schema to original API format' - ); - console.log(' 3. Two-stage transformation: Schema definition โ†’ Parameter transformation'); - console.log(''); - console.log('โš ๏ธ IMPORTANT: This is experimental functionality.'); - console.log(' The API may change in future versions.'); - console.log(' Use at your own risk in production environments.'); - } finally { - // Clean up the sample file - if (fs.existsSync(sampleFilePath)) { - fs.unlinkSync(sampleFilePath); - } - } -}; - -experimentalDocumentHandling(); diff --git a/examples/filters.ts b/examples/filters.ts deleted file mode 100644 index 481d0bcb..00000000 --- a/examples/filters.ts +++ /dev/null @@ -1,297 +0,0 @@ -#!/usr/bin/env bun -/** - * Filters Example - * - * This example demonstrates how to use filters with the HRIS list employees endpoint. - * It showcases the deep object serialization implementation that properly converts - * nested filter objects to OpenAPI deepObject style query parameters. - * - * Key features demonstrated: - * 1. Basic filter usage (updated_after, email, employee_number) - * 2. Proxy parameter usage for provider-specific filters - * 3. Complex nested filter combinations - * 4. Proper serialization of filter objects to query parameters - * - * Usage: - * - * ```bash - * bun run examples/filters.ts - * ``` - */ - -import assert from 'node:assert'; -import { StackOneToolSet } from '../src'; -import { ACCOUNT_IDS } from './constants'; - -type DryRunResult = { url: string }; - -const hriseEmployeeFilters = async (): Promise => { - // Initialize the toolset - const toolset = new StackOneToolSet(); - const accountId = ACCOUNT_IDS.TEST.VALID; - - // Get the HRIS tools with account ID - const tools = toolset.getStackOneTools('hris_*', accountId); - const employeesTool = tools.getTool('hris_list_employees'); - - assert(employeesTool !== undefined, 'Expected to find hris_list_employees tool'); - - console.log('๐Ÿงช Testing HRIS Employee Filters with Deep Object Serialization\n'); - - /* - * Example 1: Basic date filter - * Demonstrates filtering employees updated after a specific date - */ - console.log('1๏ธโƒฃ Basic Date Filter Test'); - const basicDateFilter = (await employeesTool.execute( - { - filter: { - updated_after: '2023-01-01T00:00:00.000Z', - }, - }, - { dryRun: true } - )) as DryRunResult; - - console.log('Filter object:', { filter: { updated_after: '2023-01-01T00:00:00.000Z' } }); - console.log('Serialized URL:', basicDateFilter.url); - - // Verify that the filter is properly serialized as deepObject style - assert( - basicDateFilter.url.includes('filter%5Bupdated_after%5D=2023-01-01T00%3A00%3A00.000Z'), - 'Expected URL to contain properly serialized date filter' - ); - console.log('โœ… Date filter serialized correctly\n'); - - /* - * Example 2: Email filter - * Demonstrates filtering employees by email address - */ - console.log('2๏ธโƒฃ Email Filter Test'); - const emailFilter = (await employeesTool.execute( - { - filter: { - email: 'john.doe@company.com', - }, - }, - { dryRun: true } - )) as DryRunResult; - - console.log('Filter object:', { filter: { email: 'john.doe@company.com' } }); - console.log('Serialized URL:', emailFilter.url); - - assert( - emailFilter.url.includes('filter%5Bemail%5D=john.doe%40company.com'), - 'Expected URL to contain properly serialized email filter' - ); - console.log('โœ… Email filter serialized correctly\n'); - - /* - * Example 3: Employee number filter - * Demonstrates filtering employees by employee number - */ - console.log('3๏ธโƒฃ Employee Number Filter Test'); - const employeeNumberFilter = (await employeesTool.execute( - { - filter: { - employee_number: 'EMP001', - }, - }, - { dryRun: true } - )) as DryRunResult; - - console.log('Filter object:', { filter: { employee_number: 'EMP001' } }); - console.log('Serialized URL:', employeeNumberFilter.url); - - assert( - employeeNumberFilter.url.includes('filter%5Bemployee_number%5D=EMP001'), - 'Expected URL to contain properly serialized employee number filter' - ); - console.log('โœ… Employee number filter serialized correctly\n'); - - /* - * Example 4: Multiple filters combined - * Demonstrates using multiple filter parameters together - */ - console.log('4๏ธโƒฃ Multiple Filters Combined Test'); - const multipleFilters = (await employeesTool.execute( - { - filter: { - updated_after: '2023-06-01T00:00:00.000Z', - email: 'jane.smith@company.com', - employee_number: 'EMP002', - }, - }, - { dryRun: true } - )) as DryRunResult; - - console.log('Filter object:', { - filter: { - updated_after: '2023-06-01T00:00:00.000Z', - email: 'jane.smith@company.com', - employee_number: 'EMP002', - }, - }); - console.log('Serialized URL:', (multipleFilters as { url: string }).url); - - // Verify all filters are present in the URL - assert( - multipleFilters.url.includes('filter%5Bupdated_after%5D=2023-06-01T00%3A00%3A00.000Z'), - 'Expected URL to contain date filter' - ); - assert( - multipleFilters.url.includes('filter%5Bemail%5D=jane.smith%40company.com'), - 'Expected URL to contain email filter' - ); - assert( - multipleFilters.url.includes('filter%5Bemployee_number%5D=EMP002'), - 'Expected URL to contain employee number filter' - ); - console.log('โœ… Multiple filters serialized correctly\n'); - - /* - * Example 5: Proxy parameters for provider-specific filtering - * Demonstrates using proxy parameters which also use deepObject serialization - */ - console.log('5๏ธโƒฃ Proxy Parameters Test'); - const proxyParameters = (await employeesTool.execute( - { - proxy: { - custom_field: 'value123', - provider_filter: { - department: 'Engineering', - status: 'active', - }, - }, - }, - { dryRun: true } - )) as DryRunResult; - - console.log('Proxy object:', { - proxy: { - custom_field: 'value123', - provider_filter: { - department: 'Engineering', - status: 'active', - }, - }, - }); - console.log('Serialized URL:', proxyParameters.url); - - // Verify proxy parameters are properly serialized - assert( - proxyParameters.url.includes('proxy%5Bcustom_field%5D=value123'), - 'Expected URL to contain proxy custom_field parameter' - ); - assert( - proxyParameters.url.includes('proxy%5Bprovider_filter%5D%5Bdepartment%5D=Engineering'), - 'Expected URL to contain nested proxy department parameter' - ); - assert( - proxyParameters.url.includes('proxy%5Bprovider_filter%5D%5Bstatus%5D=active'), - 'Expected URL to contain nested proxy status parameter' - ); - console.log('โœ… Proxy parameters with nested objects serialized correctly\n'); - - /* - * Example 6: Complex combined scenario - * Demonstrates combining filters, proxy parameters, and other query parameters - */ - console.log('6๏ธโƒฃ Complex Combined Scenario Test'); - const complexScenario = (await employeesTool.execute( - { - filter: { - updated_after: '2023-09-01T00:00:00.000Z', - email: 'admin@company.com', - }, - proxy: { - include_terminated: 'false', - custom_sorting: { - field: 'hire_date', - order: 'desc', - }, - }, - fields: 'id,first_name,last_name,email,hire_date', - page_size: '50', - }, - { dryRun: true } - )) as DryRunResult; - - console.log('Complex parameters:', { - filter: { - updated_after: '2023-09-01T00:00:00.000Z', - email: 'admin@company.com', - }, - proxy: { - include_terminated: 'false', - custom_sorting: { - field: 'hire_date', - order: 'desc', - }, - }, - fields: 'id,first_name,last_name,email,hire_date', - page_size: '50', - }); - console.log('Serialized URL:', complexScenario.url); - - // Verify complex scenario serialization - assert( - complexScenario.url.includes('filter%5Bupdated_after%5D=2023-09-01T00%3A00%3A00.000Z'), - 'Expected URL to contain complex date filter' - ); - assert( - complexScenario.url.includes('filter%5Bemail%5D=admin%40company.com'), - 'Expected URL to contain complex email filter' - ); - assert( - complexScenario.url.includes('proxy%5Binclude_terminated%5D=false'), - 'Expected URL to contain proxy boolean parameter' - ); - assert( - complexScenario.url.includes('proxy%5Bcustom_sorting%5D%5Bfield%5D=hire_date'), - 'Expected URL to contain nested proxy field parameter' - ); - assert( - complexScenario.url.includes('proxy%5Bcustom_sorting%5D%5Border%5D=desc'), - 'Expected URL to contain nested proxy order parameter' - ); - assert( - complexScenario.url.includes('fields=id%2Cfirst_name%2Clast_name%2Cemail%2Chire_date'), - 'Expected URL to contain fields parameter' - ); - assert( - complexScenario.url.includes('page_size=50'), - 'Expected URL to contain page_size parameter' - ); - console.log('โœ… Complex combined scenario serialized correctly\n'); - - /* - * Example 7: Edge case - Empty filter objects - * Demonstrates handling of empty filter objects - */ - console.log('7๏ธโƒฃ Edge Case - Empty Filter Objects Test'); - const emptyFilterTest = (await employeesTool.execute( - { - filter: {}, - fields: 'id,first_name,last_name', - }, - { dryRun: true } - )) as DryRunResult; - - console.log('Empty filter object:', { filter: {}, fields: 'id,first_name,last_name' }); - console.log('Serialized URL:', emptyFilterTest.url); - - // Verify that empty filter objects don't create problematic parameters - assert( - emptyFilterTest.url.includes('fields=id%2Cfirst_name%2Clast_name'), - 'Expected URL to contain fields parameter even with empty filter' - ); - // Empty objects should not create parameters - assert( - !emptyFilterTest.url.includes('filter='), - 'Expected URL to not contain empty filter parameter' - ); - console.log('โœ… Empty filter objects handled correctly\n'); -}; - -// Run the example -hriseEmployeeFilters(); diff --git a/examples/human-in-the-loop.ts b/examples/human-in-the-loop.ts index 6d4e100f..ea781ee4 100644 --- a/examples/human-in-the-loop.ts +++ b/examples/human-in-the-loop.ts @@ -7,12 +7,24 @@ */ import { assert } from 'node:console'; +import process from 'node:process'; import { openai } from '@ai-sdk/openai'; import { generateText } from 'ai'; import { StackOneToolSet } from '../src'; import type { JsonDict } from '../src/types'; import { ACCOUNT_IDS } from './constants'; +const apiKey = process.env.STACKONE_API_KEY; +const isPlaceholderKey = !apiKey || apiKey === 'test-stackone-key'; +const shouldSkip = process.env.SKIP_FETCH_TOOLS_EXAMPLE !== '0' && isPlaceholderKey; + +if (shouldSkip) { + console.log( + 'Skipping human-in-the-loop example. Provide STACKONE_API_KEY and set SKIP_FETCH_TOOLS_EXAMPLE=0 to run.' + ); + process.exit(0); +} + interface ToolCall { toolName: string; args: Record; @@ -20,14 +32,19 @@ interface ToolCall { const humanInTheLoopExample = async (): Promise => { // Create a toolset - const toolset = new StackOneToolSet(); - const hrisAccountId = ACCOUNT_IDS.HRIS; + const toolset = new StackOneToolSet({ + accountId: ACCOUNT_IDS.HRIS, + baseUrl: process.env.STACKONE_BASE_URL ?? 'https://api.stackone.com', + }); - // Get the create employee tool - const createEmployeeTool = toolset.getTool('hris_create_employee', { - 'x-account-id': hrisAccountId, + // Fetch tools via MCP + const tools = await toolset.fetchTools({ + actions: ['hris_create_employee'], }); + // Get the create employee tool + const createEmployeeTool = tools.getTool('hris_create_employee'); + if (!createEmployeeTool) { throw new Error('Create employee tool not found'); } @@ -39,7 +56,7 @@ const humanInTheLoopExample = async (): Promise => { // Use the metadata for AI planning/generation const { toolCalls } = await generateText({ - model: openai('gpt-5'), + model: openai('gpt-4o'), tools: tool, prompt: 'Create a new employee in Workday, params: Full name: John Doe, personal email: john.doe@example.com, department: Engineering, start date: 2025-01-01, hire date: 2025-01-01', diff --git a/examples/index.ts b/examples/index.ts index 80e9cef8..30dadbbc 100644 --- a/examples/index.ts +++ b/examples/index.ts @@ -29,9 +29,10 @@ * StackOne uses account IDs to identify different integrations. * See the example in the README for more details. * - * This example will use the centralized account ID: + * This example will use the centralised account ID: */ +import process from 'node:process'; import { ACCOUNT_IDS } from './constants'; const accountId = ACCOUNT_IDS.HRIS; @@ -43,11 +44,27 @@ const accountId = ACCOUNT_IDS.HRIS; import assert from 'node:assert'; import { StackOneToolSet } from '../src'; +const apiKey = process.env.STACKONE_API_KEY; +const isPlaceholderKey = !apiKey || apiKey === 'test-stackone-key'; +const shouldSkip = process.env.SKIP_FETCH_TOOLS_EXAMPLE !== '0' && isPlaceholderKey; + +if (shouldSkip) { + console.log( + 'Skipping index example. Provide STACKONE_API_KEY and set SKIP_FETCH_TOOLS_EXAMPLE=0 to run.' + ); + process.exit(0); +} + const quickstart = async (): Promise => { - const toolset = new StackOneToolSet(); + const toolset = new StackOneToolSet({ + accountId, + baseUrl: process.env.STACKONE_BASE_URL ?? 'https://api.stackone.com', + }); - // Get all HRIS-related tools using the StackOneTool method (adds accountId to the request) - const tools = toolset.getStackOneTools('hris_*', accountId); + // Fetch HRIS-related tools via MCP + const tools = await toolset.fetchTools({ + actions: ['hris_*'], + }); // Verify we have tools assert(tools.length > 0, 'Expected to find HRIS tools'); @@ -72,8 +89,6 @@ quickstart(); * * - [OpenAI Integration](openai-integration.md) * - [AI SDK Integration](ai-sdk-integration.md) - * - [Error Handling](error-handling.md) - * - [EXPERIMENTAL: Document Handling](experimental-document-handling.md) - * - [Custom Base URL](custom-base-url.md) - * - [Account ID Usage](account-id-usage.md) + * - [Fetch Tools](fetch-tools.md) + * - [Meta Tools](meta-tools.md) */ diff --git a/examples/meta-tools.ts b/examples/meta-tools.ts index c77b0b0c..db1d14cb 100644 --- a/examples/meta-tools.ts +++ b/examples/meta-tools.ts @@ -9,21 +9,34 @@ import process from 'node:process'; import { openai } from '@ai-sdk/openai'; import { generateText } from 'ai'; -import { StackOneToolSet } from '../src'; +import { StackOneToolSet, Tools } from '../src'; import { ACCOUNT_IDS } from './constants'; +const apiKey = process.env.STACKONE_API_KEY; +const isPlaceholderKey = !apiKey || apiKey === 'test-stackone-key'; +const shouldSkip = process.env.SKIP_FETCH_TOOLS_EXAMPLE !== '0' && isPlaceholderKey; + +if (shouldSkip) { + console.log( + 'Skipping meta-tools example. Provide STACKONE_API_KEY and set SKIP_FETCH_TOOLS_EXAMPLE=0 to run.' + ); + process.exit(0); +} + /** * Example 1: Using meta tools with AI SDK for dynamic tool discovery */ const metaToolsWithAISDK = async (): Promise => { console.log('๐Ÿ” Example 1: Dynamic tool discovery with AI SDK\n'); - // Initialize StackOne toolset with all available tools - const toolset = new StackOneToolSet(); - const accountId = ACCOUNT_IDS.HRIS; + // Initialise StackOne toolset + const toolset = new StackOneToolSet({ + accountId: ACCOUNT_IDS.HRIS, + baseUrl: process.env.STACKONE_BASE_URL ?? 'https://api.stackone.com', + }); - // Get all available tools for the account - const allTools = toolset.getStackOneTools('*', accountId); + // Fetch all available tools via MCP + const allTools = await toolset.fetchTools(); // Get meta tools for dynamic discovery and execution const metaTools = await allTools.metaTools(); @@ -33,8 +46,8 @@ const metaToolsWithAISDK = async (): Promise => { const { text, toolCalls } = await generateText({ model: openai('gpt-4o-mini'), tools: aiSdkMetaTools, - prompt: `I need to create a time off request for an employee. - First, find the right tool for this task, then use it to create a time off request + prompt: `I need to create a time off request for an employee. + First, find the right tool for this task, then use it to create a time off request for employee ID "emp_123" from January 15, 2024 to January 19, 2024.`, maxSteps: 3, // Allow multiple tool calls }); @@ -54,12 +67,16 @@ const metaToolsWithOpenAI = async (): Promise => { apiKey: process.env.OPENAI_API_KEY, }); - // Initialize StackOne toolset - const toolset = new StackOneToolSet(); - const accountId = ACCOUNT_IDS.HRIS; + // Initialise StackOne toolset + const toolset = new StackOneToolSet({ + accountId: ACCOUNT_IDS.HRIS, + baseUrl: process.env.STACKONE_BASE_URL ?? 'https://api.stackone.com', + }); - // Get all HRIS tools - const hrisTools = toolset.getStackOneTools('hris_*', accountId); + // Fetch HRIS tools via MCP + const hrisTools = await toolset.fetchTools({ + actions: ['hris_*'], + }); // Get meta tools const metaTools = await hrisTools.metaTools(); @@ -71,7 +88,7 @@ const metaToolsWithOpenAI = async (): Promise => { messages: [ { role: 'system', - content: `You are an HR assistant with access to various HR tools. + content: `You are an HR assistant with access to various HR tools. Use the meta_search_tools to find appropriate tools for user requests, then use meta_execute_tool to execute them.`, }, @@ -102,12 +119,14 @@ const metaToolsWithOpenAI = async (): Promise => { const directMetaToolUsage = async (): Promise => { console.log('\n๐Ÿ› ๏ธ Example 3: Direct meta tool usage\n'); - // Initialize toolset - const toolset = new StackOneToolSet(); - const accountId = ACCOUNT_IDS.HRIS; + // Initialise toolset + const toolset = new StackOneToolSet({ + accountId: ACCOUNT_IDS.HRIS, + baseUrl: process.env.STACKONE_BASE_URL ?? 'https://api.stackone.com', + }); - // Get all available tools - const allTools = toolset.getStackOneTools('*', accountId); + // Fetch all available tools via MCP + const allTools = await toolset.fetchTools(); console.log(`Total available tools: ${allTools.length}`); // Get meta tools @@ -171,18 +190,21 @@ const directMetaToolUsage = async (): Promise => { const dynamicToolRouter = async (): Promise => { console.log('\n๐Ÿ”„ Example 4: Dynamic tool router\n'); - const toolset = new StackOneToolSet(); - const accountId = ACCOUNT_IDS.HRIS; + const toolset = new StackOneToolSet({ + accountId: ACCOUNT_IDS.HRIS, + baseUrl: process.env.STACKONE_BASE_URL ?? 'https://api.stackone.com', + }); - // Get tools from multiple categories - const hrisTools = toolset.getStackOneTools('hris_*', accountId); - const atsTools = toolset.getStackOneTools('ats_*', accountId); + // Fetch tools from multiple categories via MCP + const hrisTools = await toolset.fetchTools({ + actions: ['hris_*'], + }); + const atsTools = await toolset.fetchTools({ + actions: ['ats_*'], + }); // Combine tools - const combinedTools = new (await import('../src')).Tools([ - ...hrisTools.toArray(), - ...atsTools.toArray(), - ]); + const combinedTools = new Tools([...hrisTools.toArray(), ...atsTools.toArray()]); // Get meta tools for the combined set const metaTools = await combinedTools.metaTools(); diff --git a/examples/openai-integration.ts b/examples/openai-integration.ts index 46a7b8f9..203839f3 100644 --- a/examples/openai-integration.ts +++ b/examples/openai-integration.ts @@ -3,25 +3,41 @@ */ import assert from 'node:assert'; +import process from 'node:process'; import OpenAI from 'openai'; import { StackOneToolSet } from '../src'; import { ACCOUNT_IDS } from './constants'; +const apiKey = process.env.STACKONE_API_KEY; +const isPlaceholderKey = !apiKey || apiKey === 'test-stackone-key'; +const shouldSkip = process.env.SKIP_FETCH_TOOLS_EXAMPLE !== '0' && isPlaceholderKey; + +if (shouldSkip) { + console.log( + 'Skipping openai-integration example. Provide STACKONE_API_KEY and set SKIP_FETCH_TOOLS_EXAMPLE=0 to run.' + ); + process.exit(0); +} + const openaiIntegration = async (): Promise => { - // Initialize StackOne - const toolset = new StackOneToolSet(); - const accountId = ACCOUNT_IDS.HRIS; + // Initialise StackOne + const toolset = new StackOneToolSet({ + accountId: ACCOUNT_IDS.HRIS, + baseUrl: process.env.STACKONE_BASE_URL ?? 'https://api.stackone.com', + }); - // Get the correct tool - const tools = toolset.getStackOneTools('hris_get_*', accountId); + // Fetch HRIS tools via MCP + const tools = await toolset.fetchTools({ + actions: ['hris_get_*'], + }); const openAITools = tools.toOpenAI(); - // Initialize OpenAI client + // Initialise OpenAI client const openai = new OpenAI(); // Create a chat completion with tool calls const response = await openai.chat.completions.create({ - model: 'gpt-5', + model: 'gpt-4o', messages: [ { role: 'system', @@ -51,7 +67,6 @@ const openaiIntegration = async (): Promise => { // Parse the arguments to verify they contain the expected fields const args = JSON.parse(toolCall.function.arguments); assert(args.id === 'c28xIQaWQ6MzM5MzczMDA2NzMzMzkwNzIwNA', 'Expected id to match the query'); - assert(args.fields !== undefined, 'Expected fields to be defined'); }; // Run the example diff --git a/examples/openapi-toolset.ts b/examples/openapi-toolset.ts deleted file mode 100644 index 45140334..00000000 --- a/examples/openapi-toolset.ts +++ /dev/null @@ -1,104 +0,0 @@ -/** - * Basic OpenAPI Example - * - * This example demonstrates how to: - * 1. Load OpenAPI specifications from a file - * 2. Load OpenAPI specifications from a URL - * 3. Get and execute tools from the specifications - */ - -import assert from 'node:assert'; -import { OpenAPIToolSet } from '../src/toolsets/openapi'; -import { joinPaths } from '../src/utils/file'; - -/** - * Type for dry run result - */ -type DryRunResult = { - url: string; - method: string; - headers?: Record; - body?: string; -}; - -/** - * Example of loading OpenAPI specifications from a file - */ -async function fromFileExample(): Promise { - // Create an OpenAPIToolSet from a local file - const toolset = new OpenAPIToolSet({ - filePath: joinPaths(process.cwd(), 'src', 'toolsets', 'tests', 'fixtures', 'petstore.json'), - }); - - // Get all tools - const tools = toolset.getTools('*Pet*'); - assert(tools.length > 0, 'Expected to find tools in the specification'); - - // Get a specific tool - const getPetTool = tools.getTool('getPetById'); - assert(getPetTool !== undefined, 'Expected to find getPetById tool'); - - // Execute the tool with dry run to see what would be sent - const result = (await getPetTool.execute({ petId: 123 }, { dryRun: true })) as DryRunResult; - - assert(result !== undefined, 'Expected to get a result from dry run'); - assert(result.url.includes('/pet/123'), 'Expected URL to contain pet ID'); - assert(result.method === 'GET', 'Expected GET method'); -} - -/** - * Example of loading OpenAPI specifications from a URL - */ -async function fromUrlExample(): Promise { - try { - // Create an OpenAPIToolSet from a URL - const toolset = await OpenAPIToolSet.fromUrl({ - url: 'https://api.eu1.stackone.com/oas/hris.json', - }); - - // Get tools matching a pattern - const hrisTools = toolset.getTools('hris_*'); - assert(hrisTools.length > 0, 'Expected to find a bunch of tools'); - - // Get a specific tool - const getEmployeeTool = hrisTools.getTool('hris_get_employee'); - assert(getEmployeeTool !== undefined, 'Expected to find hris_get_employee tool'); - assert( - typeof getEmployeeTool.parameters.properties.id === 'object' && - getEmployeeTool.parameters.properties.id !== null && - getEmployeeTool.parameters.properties.id.type === 'string', - 'Expected to find string parameter for id' - ); - - // Execute the tool with dry run to see what would be sent - const result = (await getEmployeeTool.execute({ id: 123 }, { dryRun: true })) as DryRunResult; - - assert(result !== undefined, 'Expected to get a result from dry run'); - assert(result.method === 'GET', 'Expected GET method'); - - assert(result.url.includes('/employees/123'), 'Expected URL to contain employee ID'); - assert(result.body === undefined, 'Expected body to be undefined'); - } catch (error) { - throw new Error( - `Failed to load from URL: ${error instanceof Error ? error.message : String(error)}` - ); - } -} - -/** - * Run the examples - */ -async function main(): Promise { - try { - // Run the file example - await fromFileExample(); - - // Run the URL example - await fromUrlExample(); - } catch (error) { - console.error(error); - process.exit(1); - } -} - -main(); diff --git a/package.json b/package.json index 913b4f54..3506d753 100644 --- a/package.json +++ b/package.json @@ -20,13 +20,10 @@ "prepare": "bun prepare:git", "prepare:git": "git config --local core.hooksPath .githooks", "build": "bun -b tsdown", - "rebuild": "bun run fetch:specs && bun run build", - "prepack": "bun run rebuild", + "prepack": "bun run build", "test:unit": "bun test src", "test:examples": "bun test examples", - "test:scripts": "bun test scripts", - "test": "bun run test:unit && bun run test:examples && bun run test:scripts", - "fetch:specs": "bun run ./scripts/fetch-specs.ts && bun run format", + "test": "bun run test:unit && bun run test:examples", "lint": "biome check .", "typecheck": "tsgo --noEmit", "format": "biome format --write ." diff --git a/scripts/fetch-specs.spec.ts b/scripts/fetch-specs.spec.ts deleted file mode 100644 index 14e94f09..00000000 --- a/scripts/fetch-specs.spec.ts +++ /dev/null @@ -1,46 +0,0 @@ -import { beforeAll, describe, expect, it } from 'bun:test'; -import { createFixture } from 'fs-fixture'; -import { saveSpec } from './fetch-specs'; - -// Mock environment variables -beforeAll(() => { - Bun.env.STACKONE_API_KEY = 'test_api_key'; -}); - -describe('fetch-specs script', () => { - it('should fetch and save OpenAPI specs', async () => { - const category = 'hris'; - - const response = await fetch(`https://api.stackone.com/api/v1/${category}/openapi.json`, { - headers: { - Authorization: `Basic ${Buffer.from('test_api_key:').toString('base64')}`, - 'User-Agent': 'stackone-node/1.0.0', - }, - }); - - expect(response.ok).toBe(true); - - // Test fetchSpec function - const hrisSpec = await response.json(); - expect(hrisSpec).toMatchInlineSnapshot(` - { - "info": { - "title": "HRIS API", - "version": "1.0.0", - }, - "openapi": "3.0.0", - "paths": { - "/employees": {}, - }, - } - `); - }); - it('should save OpenAPI specs to file', async () => { - await using fixture = await createFixture(); - - // Test saveSpec function - await saveSpec('hris', {}, fixture.path); - - expect(await fixture.exists('hris.ts')).toBe(true); - }); -}); diff --git a/scripts/fetch-specs.ts b/scripts/fetch-specs.ts deleted file mode 100755 index 569532fd..00000000 --- a/scripts/fetch-specs.ts +++ /dev/null @@ -1,109 +0,0 @@ -#!/usr/bin/env bun -/** - * Script to fetch OpenAPI specifications from the StackOne documentation - * - * This script scrapes the StackOne documentation page to find all available - * OpenAPI specifications, then downloads and saves them to the .oas directory. - */ -import { existsSync } from 'node:fs'; -import { mkdir, writeFile } from 'node:fs/promises'; -import { join } from 'node:path'; -import { SPECS } from '../src/constants'; - -// Configuration -const STACKONE_DOCS_BASE = 'https://api.eu1.stackone.com/oas'; - -const OUTPUT_DIR = join(process.cwd(), 'src', 'openapi', 'generated'); - -/** - * Get the list of API specs to download - */ -const getApiSpecs = async (): Promise> => { - console.log('Preparing OpenAPI specs to download...'); - - const specs: Record = {}; - - for (const name of SPECS) { - // Include .json extension for the filename - const filename = `${name}.json`; - - specs[name] = filename; - } - - return specs; -}; - -/** - * Fetch an OpenAPI specification - */ -const fetchOasSpec = async (filename: string): Promise> => { - const url = `${STACKONE_DOCS_BASE}/${filename}`; - console.log(`Fetching spec from ${url}...`); - - const response = await fetch(url); - if (!response.ok) { - throw new Error(`Failed to fetch spec ${filename}: ${response.statusText}`); - } - - return response.json(); -}; - -/** - * Save an OpenAPI specification to a TypeScript file - */ -export const saveSpec = async (name: string, spec: Record, saveDir: string = OUTPUT_DIR): Promise => { - // Ensure the output directory exists - if (!existsSync(saveDir)) { - await mkdir(saveDir, { recursive: true }); - } - - const outputPath = join(saveDir, `${name}.ts`); - const tsContent = `// Generated OpenAPI specification for ${name} - // DO NOT EDIT THIS FILE DIRECTLY -export const ${name}Spec = ${JSON.stringify(spec, null, 2)}; -`; - await writeFile(outputPath, tsContent); - console.log(`โœ“ Saved ${name} API specification to ${outputPath}`); -}; - -/** - * Main function - */ -const main = async (): Promise => { - // Get specs and their IDs from the documentation page - const specs = await getApiSpecs(); - console.log(`Found ${Object.keys(specs).length} API specs to download:`); - - for (const [name, filename] of Object.entries(specs)) { - console.log(` - ${name} (${filename})`); - } - - // Download each spec - for (const [name, filename] of Object.entries(specs)) { - try { - const spec = await fetchOasSpec(filename); - await saveSpec(name, spec); - } catch (error) { - console.error(`โœ— Failed to download ${name} spec:`, error); - } - } - - // Create an index.ts file that exports all specs - const specNames = Object.keys(specs); - if (specNames.length > 0) { - const indexContent = specNames - .map(name => `export { ${name}Spec } from './${name}';`) - .join('\n') + '\n'; - - await writeFile(join(OUTPUT_DIR, 'index.ts'), indexContent); - console.log(`โœ“ Created index.ts file with exports for all ${specNames.length} specs`); - } else { - console.warn('No specs found. Index file not created.'); - } - - console.log('Done fetching OpenAPI specifications'); -}; - -if (import.meta.main) { - main() -} diff --git a/src/constants.ts b/src/constants.ts index f3fe7154..c87b2b63 100644 --- a/src/constants.ts +++ b/src/constants.ts @@ -1,24 +1,10 @@ -export const SPECS = [ - 'stackone', - 'crm', - 'ats', - 'hris', - 'documents', - 'marketing', - 'ticketing', - 'screening', - 'messaging', - 'iam', - 'lms', -]; - /** * Default weight for BM25 in hybrid BM25 + TF-IDF search. * * - alpha=0.2 means: 20% BM25 + 80% TF-IDF - * - This value was optimized through validation testing + * - This value was optimised through validation testing * - Provides 10.8% improvement in tool discovery accuracy - * - Lower values favor BM25 scoring (better keyword matching) - * - Higher values favor TF-IDF scoring (better semantic matching) + * - Lower values favour BM25 scoring (better keyword matching) + * - Higher values favour TF-IDF scoring (better semantic matching) */ export const DEFAULT_HYBRID_ALPHA = 0.2; diff --git a/src/index.ts b/src/index.ts index 09fddc18..39278372 100644 --- a/src/index.ts +++ b/src/index.ts @@ -2,22 +2,17 @@ * StackOne AI Node.js SDK */ -export * as OpenAPILoader from './openapi/loader'; -export { OpenAPIParser } from './openapi/parser'; export { BaseTool, StackOneTool, Tools } from './tool'; export { createFeedbackTool } from './tools/feedback'; export { StackOneAPIError, StackOneError } from './utils/errors'; export { - OpenAPIToolSet, StackOneToolSet, ToolSetConfigError, ToolSetError, ToolSetLoadError, type AuthenticationConfig, type BaseToolSetConfig, - type OpenAPIToolSetConfigFromFilePath, - type OpenAPIToolSetConfigFromUrl, type StackOneToolSetConfig, } from './toolsets'; diff --git a/src/openapi/generated/ats.ts b/src/openapi/generated/ats.ts deleted file mode 100644 index 7c49ea6e..00000000 --- a/src/openapi/generated/ats.ts +++ /dev/null @@ -1,27497 +0,0 @@ -// Generated OpenAPI specification for ats -// DO NOT EDIT THIS FILE DIRECTLY -export const atsSpec = { - openapi: '3.1.0', - paths: { - '/unified/ats/applications': { - get: { - operationId: 'ats_list_applications', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,candidate_id,remote_candidate_id,job_id,remote_job_id,job_posting_id,remote_job_posting_id,interview_stage,interview_stage_id,remote_interview_stage_id,application_stage,application_stage_id,remote_application_stage_id,rejected_reason,rejected_reason_id,remote_rejected_reason_id,rejected_reason_ids,remote_rejected_reason_ids,rejected_reasons,rejected_at,location_id,remote_location_id,location_ids,remote_location_ids,status,application_status,questionnaires,attachments,result_links,source,created_at,updated_at,documents,custom_fields,candidate,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'ATS Application Filter', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - created_after: { - description: - 'Use a string with a date to only select results created after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - job_id: { - description: 'Filter to select applications by job_id', - type: 'string', - nullable: true, - }, - stage: { - description: 'Filter to select applications by application_stage id', - type: 'string', - nullable: true, - }, - application_stage_id: { - description: 'Filter to select applications by application_stage_id', - type: 'string', - nullable: true, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'sync_token', - required: false, - in: 'query', - description: 'The sync token to select the only updated results', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'expand', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be expanded in the response', - schema: { - nullable: true, - example: 'documents', - type: 'string', - }, - }, - { - name: 'include', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be included in the response', - schema: { - nullable: true, - example: 'attachments,custom_fields', - type: 'string', - }, - }, - { - name: 'job_id', - required: false, - in: 'query', - description: 'Filter for job ID to retrieve a list of applications related to this job', - deprecated: true, - schema: { - nullable: true, - example: 'cxQiyiuasdFKfdsYfer', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of applications was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ApplicationsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Applications', - tags: ['Applications'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'list_applications', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - post: { - operationId: 'ats_create_application', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AtsCreateApplicationRequestDto', - }, - }, - }, - }, - responses: { - '201': { - description: 'The application was created successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Create Application', - tags: ['Applications'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'create_application', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/applications/{id}': { - get: { - operationId: 'ats_get_application', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,candidate_id,remote_candidate_id,job_id,remote_job_id,job_posting_id,remote_job_posting_id,interview_stage,interview_stage_id,remote_interview_stage_id,application_stage,application_stage_id,remote_application_stage_id,rejected_reason,rejected_reason_id,remote_rejected_reason_id,rejected_reason_ids,remote_rejected_reason_ids,rejected_reasons,rejected_at,location_id,remote_location_id,location_ids,remote_location_ids,status,application_status,questionnaires,attachments,result_links,source,created_at,updated_at,documents,custom_fields,candidate,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'expand', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be expanded in the response', - schema: { - nullable: true, - example: 'documents', - type: 'string', - }, - }, - { - name: 'include', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be included in the response', - schema: { - nullable: true, - example: 'attachments,custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The application with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ApplicationResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Application', - tags: ['Applications'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'get_application', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - patch: { - operationId: 'ats_update_application', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AtsUpdateApplicationRequestDto', - }, - }, - }, - }, - responses: { - '200': { - description: 'Record updated successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UpdateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Update Application', - tags: ['Applications'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'update_application', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/applications/{id}/offers': { - get: { - operationId: 'ats_list_applications_offers', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,application_id,remote_application_id,start_date,offer_status,salary,currency,created_at,updated_at,offer_history,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'sync_token', - required: false, - in: 'query', - description: 'The sync token to select the only updated results', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'The offers related to the application with the given identifier were retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/OffersPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Application Offers', - tags: ['Applications', 'Offers'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'list_applications_offers', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/applications/{id}/move': { - post: { - operationId: 'ats_move_application', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AtsMoveApplicationRequestDto', - }, - }, - }, - }, - responses: { - '200': { - description: 'The application was moved successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/MoveApplicationResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Move Application', - tags: ['Applications'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'move_application', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/applications/{id}/reject': { - post: { - operationId: 'ats_reject_application', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AtsRejectApplicationRequestDto', - }, - }, - }, - }, - responses: { - '200': { - description: 'The application was rejected successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RejectApplicationResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Reject Application', - tags: ['Applications'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'reject_application', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/applications/{id}/offers/{subResourceId}': { - get: { - operationId: 'ats_get_application_offer', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,application_id,remote_application_id,start_date,offer_status,salary,currency,created_at,updated_at,offer_history,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'The offer related to the application with the given identifiers was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/OffersResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Application Offer', - tags: ['Applications', 'Offers'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'get_application_offer', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/applications/{id}/scorecards': { - get: { - operationId: 'ats_list_application_scorecards', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,sections,label,candidate_id,remote_candidate_id,application_id,remote_application_id,interview_id,remote_interview_id,author_id,remote_author_id,overall_recommendation,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'sync_token', - required: false, - in: 'query', - description: 'The sync token to select the only updated results', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'The scorecards related to the application with the given identifier were retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ScorecardsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Application Scorecards', - tags: ['Applications', 'Scorecards'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'list_application_scorecards', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/applications/{id}/scorecards/{subResourceId}': { - get: { - operationId: 'ats_get_application_scorecard', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,sections,label,candidate_id,remote_candidate_id,application_id,remote_application_id,interview_id,remote_interview_id,author_id,remote_author_id,overall_recommendation,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'The scorecard related to the application with the given identifiers was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ScorecardsResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Application Scorecard', - tags: ['Applications'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'get_application_scorecard', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/applications/{id}/changes': { - get: { - operationId: 'ats_list_application_changes', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'event_id,remote_event_id,created_at,effective_at,change_type,actor,new_values,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: - 'Filter parameters for application changes (supports created_after and change_type)', - explode: true, - style: 'deepObject', - schema: { - properties: { - created_after: { - description: - 'Use a string with a date to only select results created after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - change_type: { - description: 'Filter by the type of change that occurred to the application', - enum: [ - 'application_status', - 'interview_stage', - 'rejected_reasons', - 'unmapped_value', - ], - type: 'string', - nullable: true, - }, - }, - nullable: true, - type: 'object', - }, - }, - ], - responses: { - '200': { - description: - 'The changes related to the application with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ApplicationChangesPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Application Changes', - tags: ['Applications', 'Application Changes'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'list_application_changes', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/applications/{id}/notes': { - get: { - operationId: 'ats_list_application_notes', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,content,author_id,remote_author_id,visibility,created_at,updated_at,deleted_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'sync_token', - required: false, - in: 'query', - description: 'The sync token to select the only updated results', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'The notes related to the application with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotesPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Application Notes', - tags: ['Applications', 'Notes'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'list_application_notes', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - post: { - operationId: 'ats_create_application_note', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AtsCreateNotesRequestDto', - }, - }, - }, - }, - responses: { - '201': { - description: 'Record created successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Create Application Note', - tags: ['Applications', 'Notes'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'create_application_note', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/applications/{id}/notes/{subResourceId}': { - get: { - operationId: 'ats_get_application_note', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,content,author_id,remote_author_id,visibility,created_at,updated_at,deleted_at,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'The note with the given identifier related to the application with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NoteResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Application Note', - tags: ['Applications', 'Notes'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'get_application_note', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - patch: { - operationId: 'ats_update_application_note', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AtsUpdateNotesRequestDto', - }, - }, - }, - }, - responses: { - '200': { - description: 'Record updated successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UpdateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Update Application Note', - tags: ['Applications', 'Notes'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'update_application_note', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/applications/{id}/scheduled_interviews': { - get: { - operationId: 'ats_list_applications_scheduled_interviews', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,application_id,remote_application_id,interview_stage_id,remote_interview_stage_id,interview_stage,status,interview_status,interviewer_ids,remote_interviewer_ids,interview_parts,interviewers,start_at,end_at,meeting_url,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'sync_token', - required: false, - in: 'query', - description: 'The sync token to select the only updated results', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of applications scheduled interviews was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ScheduledInterviewsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Applications scheduled interviews', - tags: ['Applications', 'Scheduled Interviews'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'list_applications_scheduled_interviews', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/applications/{id}/scheduled_interviews/{subResourceId}': { - get: { - operationId: 'ats_get_application_scheduled_interview', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,candidate_id,remote_candidate_id,job_id,remote_job_id,job_posting_id,remote_job_posting_id,interview_stage,interview_stage_id,remote_interview_stage_id,application_stage,application_stage_id,remote_application_stage_id,rejected_reason,rejected_reason_id,remote_rejected_reason_id,rejected_reason_ids,remote_rejected_reason_ids,rejected_reasons,rejected_at,location_id,remote_location_id,location_ids,remote_location_ids,status,application_status,questionnaires,attachments,result_links,source,created_at,updated_at,documents,custom_fields,candidate,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'The applications scheduled interview with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ScheduledInterviewsResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Applications scheduled interview', - tags: ['Applications', 'Scheduled Interviews'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'get_application_scheduled_interview', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/applications/{id}/documents/upload': { - post: { - operationId: 'ats_upload_application_document', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AtsDocumentsUploadRequestDto', - }, - }, - }, - }, - responses: { - '201': { - description: - 'The document related to the application with the given identifier was uploaded.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/WriteResultApiModel', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Upload Application Document', - tags: ['Applications', 'Documents'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'upload_application_document', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/applications/{id}/documents/{subResourceId}/download': { - get: { - operationId: 'ats_download_application_document', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'format', - required: false, - in: 'query', - description: 'The format to download the file in', - schema: { - nullable: true, - example: 'base64', - type: 'string', - }, - }, - { - name: 'export_format', - required: false, - in: 'query', - description: 'The export format of the file', - schema: { - nullable: true, - example: 'text/plain', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'The document related to the application with the given identifiers was retrieved.', - content: { - 'application/pdf': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/msword': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/vnd.openxmlformats-officedocument.wordprocessingml.document': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/vnd.ms-excel': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/vnd.ms-powerpoint': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/vnd.openxmlformats-officedocument.presentationml.presentation': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/rtf': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'text/plain': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'image/jpeg': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'image/png': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'image/gif': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'image/tiff': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'image/bmp': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'image/heic': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/zip': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/gzip': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/json': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/xml': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'text/csv': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/vnd.oasis.opendocument.text': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/vnd.oasis.opendocument.spreadsheet': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'audio/mpeg': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'video/mp4': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'video/webm': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'text/rtf': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/x-rar-compressed': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/x-7z-compressed': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'message/rfc822': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/vnd.ms-outlook': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/octet-stream': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'text/html': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'image/webp': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/vnd.oasis.opendocument.presentation': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'audio/wav': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'audio/mp4': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'video/avi': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'video/quicktime': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Download Application Document', - tags: ['Applications', 'Documents'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'download_application_document', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/applications/{id}/documents': { - get: { - operationId: 'ats_list_application_documents', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'ATS Document Filter', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - type: { - description: 'Filter to select documents by type', - type: 'string', - nullable: true, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'sync_token', - required: false, - in: 'query', - description: 'The sync token to select the only updated results', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'The documents related to the application with the given identifier were retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AtsDocumentsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Application Documents', - tags: ['Applications', 'Documents'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'list_application_documents', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/applications/{id}/documents/{subResourceId}': { - get: { - operationId: 'ats_get_application_document', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'The document related to the application with the given identifiers was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AtsDocumentResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Application Document', - tags: ['Applications', 'Documents'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'get_application_document', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/candidates': { - get: { - operationId: 'ats_list_candidates', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,first_name,last_name,email,emails,social_links,phone,phone_numbers,company,country,title,application_ids,remote_application_ids,hired_at,custom_fields,tags,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'ATS Candidate Filter', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - created_after: { - description: - 'Use a string with a date to only select results created after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - email: { - description: 'Filter to select candidates by email', - type: 'string', - nullable: true, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'sync_token', - required: false, - in: 'query', - description: 'The sync token to select the only updated results', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'include', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be included in the response', - schema: { - nullable: true, - example: 'custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of candidates was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CandidatesPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Candidates', - tags: ['Candidates'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'list_candidates', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - post: { - operationId: 'ats_create_candidate', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AtsCreateCandidateRequestDto', - }, - }, - }, - }, - responses: { - '201': { - description: 'The candidate was successfully created.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Create Candidate', - tags: ['Candidates'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'create_candidate', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/candidates/{id}': { - get: { - operationId: 'ats_get_candidate', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,first_name,last_name,email,emails,social_links,phone,phone_numbers,company,country,title,application_ids,remote_application_ids,hired_at,custom_fields,tags,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'include', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be included in the response', - schema: { - nullable: true, - example: 'custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The candidate with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CandidateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Candidate', - tags: ['Candidates'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'get_candidate', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - patch: { - operationId: 'ats_update_candidate', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AtsUpdateCandidateRequestDto', - }, - }, - }, - }, - responses: { - '200': { - description: 'The candidate was successfully updated.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Update Candidate', - tags: ['Candidates'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'update_candidate', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/candidates/{id}/notes': { - get: { - operationId: 'ats_list_candidate_notes', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,content,author_id,remote_author_id,visibility,created_at,updated_at,deleted_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'sync_token', - required: false, - in: 'query', - description: 'The sync token to select the only updated results', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'The notes related to the candidate with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotesPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Candidate Notes', - tags: ['Candidates', 'Notes'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'list_candidate_notes', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - post: { - operationId: 'ats_create_candidate_note', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AtsCreateNotesRequestDto', - }, - }, - }, - }, - responses: { - '201': { - description: 'Record created successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Create Candidate Note', - tags: ['Candidates', 'Notes'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'create_candidate_note', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/candidates/{id}/notes/{subResourceId}': { - get: { - operationId: 'ats_get_candidate_note', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,content,author_id,remote_author_id,visibility,created_at,updated_at,deleted_at,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'The note with the given identifier related to the candidate with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NoteResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Candidate Note', - tags: ['Candidates', 'Notes'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'get_candidate_note', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/custom_field_definitions/applications': { - get: { - operationId: 'ats_list_application_custom_field_definitions', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,description,type,options,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of application custom field definitions was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CustomFieldDefinitionsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Application Custom Field Definitions', - tags: ['Custom Field Definitions'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'list_application_custom_field_definitions', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/custom_field_definitions/applications/{id}': { - get: { - operationId: 'ats_get_application_custom_field_definition', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,description,type,options,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The application custom field definition was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CustomFieldDefinitionResultApiModel', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Application Custom Field Definition', - tags: ['Custom Field Definitions'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'get_application_custom_field_definition', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/custom_field_definitions/candidates': { - get: { - operationId: 'ats_list_candidate_custom_field_definitions', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,description,type,options,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of candidate custom field definitions was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CustomFieldDefinitionsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Candidate Custom Field Definitions', - tags: ['Custom Field Definitions'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'list_candidate_custom_field_definitions', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/custom_field_definitions/candidates/{id}': { - get: { - operationId: 'ats_get_candidate_custom_field_definition', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,description,type,options,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The candidate custom field definition was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CustomFieldDefinitionResultApiModel', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Candidate Custom Field Definition', - tags: ['Custom Field Definitions'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'get_candidate_custom_field_definition', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/custom_field_definitions/jobs': { - get: { - operationId: 'ats_list_job_custom_field_definitions', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,description,type,options,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of job custom field definitions was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CustomFieldDefinitionsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Job Custom Field Definitions', - tags: ['Custom Field Definitions'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'list_job_custom_field_definitions', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/custom_field_definitions/jobs/{id}': { - get: { - operationId: 'ats_get_job_custom_field_definition', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,description,type,options,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The job custom field definition was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CustomFieldDefinitionResultApiModel', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Job Custom Field Definition', - tags: ['Custom Field Definitions'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'get_job_custom_field_definition', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/departments': { - get: { - operationId: 'ats_list_departments', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'sync_token', - required: false, - in: 'query', - description: 'The sync token to select the only updated results', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of departments was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/DepartmentsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Departments', - tags: ['Departments'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'list_departments', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/departments/{id}': { - get: { - operationId: 'ats_get_department', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The department with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/DepartmentResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Department', - tags: ['Departments'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'get_department', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/interview_stages': { - get: { - deprecated: true, - operationId: 'ats_list_interview_stages', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,order,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'sync_token', - required: false, - in: 'query', - description: 'The sync token to select the only updated results', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of interview-stages was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InterviewStagesPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Interview Stages', - tags: ['Application Stages'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'list_interview_stages', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/interview_stages/{id}': { - get: { - deprecated: true, - operationId: 'ats_get_interview_stage', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,order,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The interview-stage with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InterviewStageResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Interview Stage', - tags: ['Application Stages'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'get_interview_stage', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/application_stages': { - get: { - operationId: 'ats_list_application_stages', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,order,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'sync_token', - required: false, - in: 'query', - description: 'The sync token to select the only updated results', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of application stages was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InterviewStagesPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Application Stages', - tags: ['Application Stages'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'list_application_stages', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/application_stages/{id}': { - get: { - operationId: 'ats_get_application_stage', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,order,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The application-stage with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InterviewStageResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Application Stage', - tags: ['Application Stages'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'get_application_stage', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/interviews': { - get: { - operationId: 'ats_list_interviews', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,application_id,remote_application_id,interview_stage_id,remote_interview_stage_id,interview_stage,status,interview_status,interviewer_ids,remote_interviewer_ids,interview_parts,interviewers,start_at,end_at,meeting_url,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'ATS Interviews Filter', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - created_after: { - description: - 'Use a string with a date to only select results created after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'sync_token', - required: false, - in: 'query', - description: 'The sync token to select the only updated results', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of interviews was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InterviewsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Interviews', - tags: ['Interviews'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'list_interviews', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/interviews/{id}': { - get: { - operationId: 'ats_get_interview', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,application_id,remote_application_id,interview_stage_id,remote_interview_stage_id,interview_stage,status,interview_status,interviewer_ids,remote_interviewer_ids,interview_parts,interviewers,start_at,end_at,meeting_url,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The interview with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InterviewsResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Interview', - tags: ['Interviews'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'get_interview', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/interviews/{id}/notes': { - post: { - operationId: 'ats_create_interview_note', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AtsCreateNotesRequestDto', - }, - }, - }, - }, - responses: { - '201': { - description: 'Record created successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Create Interview Note', - tags: ['Interviews', 'Notes'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'create_interview_note', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/interviews/{id}/notes/{subResourceId}': { - patch: { - operationId: 'ats_update_interview_note', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AtsUpdateNotesRequestDto', - }, - }, - }, - }, - responses: { - '200': { - description: 'Record updated successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UpdateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Update Interview Note', - tags: ['Interviews', 'Notes'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'update_interview_note', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/jobs': { - get: { - operationId: 'ats_list_jobs', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,code,title,description,status,job_status,department_ids,remote_department_ids,location_ids,remote_location_ids,hiring_team,interview_stages,confidential,custom_fields,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'ATS Jobs filters', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - created_after: { - description: - 'Use a string with a date to only select results created after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - status: { - description: 'The status of the job', - enum: ['open', 'draft', null], - nullable: true, - type: 'string', - deprecated: true, - }, - job_status: { - description: 'The job_status of the job', - enum: ['open', 'draft', null], - nullable: true, - type: 'string', - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'sync_token', - required: false, - in: 'query', - description: 'The sync token to select the only updated results', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'expand', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be expanded in the response', - schema: { - nullable: true, - example: 'job_postings,interview_stages', - type: 'string', - }, - }, - { - name: 'include', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be included in the response', - schema: { - nullable: true, - example: 'custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of jobs was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AtsJobsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Jobs', - tags: ['Jobs'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'list_jobs', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - post: { - operationId: 'ats_create_job', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AtsCreateJobRequestDto', - }, - }, - }, - }, - responses: { - '201': { - description: 'The job was successfully created.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Create Job', - tags: ['Jobs'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'create_job', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/jobs/{id}/application_stages': { - get: { - operationId: 'ats_list_job_application_stages', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,order,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'sync_token', - required: false, - in: 'query', - description: 'The sync token to select the only updated results', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'A list of all application stages that have been configured for the specified job.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ApplicationStagesPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Job Application Stages', - tags: ['Jobs', 'Application Stages'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'list_job_application_stages', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/jobs/{id}': { - get: { - operationId: 'ats_get_job', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,code,title,description,status,job_status,department_ids,remote_department_ids,location_ids,remote_location_ids,hiring_team,interview_stages,confidential,custom_fields,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'expand', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be expanded in the response', - schema: { - nullable: true, - example: 'job_postings,interview_stages', - type: 'string', - }, - }, - { - name: 'include', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be included in the response', - schema: { - nullable: true, - example: 'custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The job with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AtsJobResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Job', - tags: ['Jobs'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'get_job', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - patch: { - operationId: 'ats_update_job', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AtsUpdateJobRequestDto', - }, - }, - }, - }, - responses: { - '200': { - description: 'The job was successfully updated.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Update Job', - tags: ['Jobs'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'update_job', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/jobs/{id}/application_stages/{subResourceId}': { - get: { - operationId: 'ats_get_job_application_stage', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,order,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'A application stage that has been configured for the specified job.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ApplicationStageResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Job Application Stage', - tags: ['Jobs', 'Application Stages'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'get_job_application_stage', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/lists': { - get: { - operationId: 'ats_list_lists', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,created_at,updated_at,items,type,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The collection of lists was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ListsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get all Lists', - tags: ['Lists'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'list_lists', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/lists/{id}': { - get: { - operationId: 'ats_get_list', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,created_at,updated_at,items,type,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ListResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get List', - tags: ['Lists'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'get_list', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/locations': { - get: { - operationId: 'ats_list_locations', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'sync_token', - required: false, - in: 'query', - description: 'The sync token to select the only updated results', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of locations was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ATSLocationsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List locations', - tags: ['Locations'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'list_locations', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/locations/{id}': { - get: { - operationId: 'ats_get_location', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The location with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ATSLocationResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Location', - tags: ['Locations'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'get_location', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/rejected_reasons': { - get: { - operationId: 'ats_list_rejected_reasons', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,label,type,rejected_reason_type,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'sync_token', - required: false, - in: 'query', - description: 'The sync token to select the only updated results', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of rejected reasons was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RejectedReasonsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Rejected Reasons', - tags: ['Rejected Reasons'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'list_rejected_reasons', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/rejected_reasons/{id}': { - get: { - operationId: 'ats_get_rejected_reason', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,label,type,rejected_reason_type,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The rejected reason with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RejectedReasonResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Rejected Reason', - tags: ['Rejected Reasons'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'get_rejected_reason', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/users': { - get: { - operationId: 'ats_list_users', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,first_name,last_name,name,email,phone,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'sync_token', - required: false, - in: 'query', - description: 'The sync token to select the only updated results', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of users was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UsersPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Users', - tags: ['Users'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'list_users', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/users/{id}': { - get: { - operationId: 'ats_get_user', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,first_name,last_name,name,email,phone,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The user with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UserResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get User', - tags: ['Users'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'get_user', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/job_postings': { - get: { - operationId: 'ats_list_job_postings', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,title,locations,internal,status,job_id,remote_job_id,content,compensation,employment_type,employment_contract_type,external_url,external_apply_url,questionnaires,start_date,updated_at,created_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'ATS Job Postings Filter', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - created_after: { - description: - 'Use a string with a date to only select results created after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'sync_token', - required: false, - in: 'query', - description: 'The sync token to select the only updated results', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'include', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be included in the response', - schema: { - nullable: true, - example: 'questionnaires', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of job postings was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/JobPostingsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Job Postings', - tags: ['Job Postings'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'list_job_postings', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/job_postings/{id}': { - get: { - operationId: 'ats_get_job_posting', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,title,locations,internal,status,job_id,remote_job_id,content,compensation,employment_type,employment_contract_type,external_url,external_apply_url,questionnaires,start_date,updated_at,created_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'include', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be included in the response', - schema: { - nullable: true, - example: 'questionnaires', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The job with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/JobPostingResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Job Posting', - tags: ['Job Postings'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'get_job_posting', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/offers': { - get: { - operationId: 'ats_list_offers', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,application_id,remote_application_id,start_date,offer_status,salary,currency,created_at,updated_at,offer_history,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'sync_token', - required: false, - in: 'query', - description: 'The sync token to select the only updated results', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of offers was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/OffersPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Offers', - tags: ['Offers'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'list_offers', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - post: { - operationId: 'ats_create_offer', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AtsCreateOfferRequestDto', - }, - }, - }, - }, - responses: { - '201': { - description: 'The offer was created successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Create Offer', - tags: ['Offers'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'create_offer', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/offers/{id}': { - get: { - operationId: 'ats_get_offer', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,application_id,remote_application_id,start_date,offer_status,salary,currency,created_at,updated_at,offer_history,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The offer with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/OffersResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Offer', - tags: ['Offers'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'get_offer', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/assessments/packages': { - get: { - operationId: 'ats_list_assessments_packages', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields to return in the response (if empty, all fields are returned)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of assessments packages was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AssessmentPackagePaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Assessments Packages', - tags: ['Assessments', 'Packages'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'list_assessments_packages', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/assessments/packages/{id}': { - get: { - operationId: 'ats_get_assessments_package', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields to return in the response (if empty, all fields are returned)', - schema: { - nullable: true, - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The assessments package with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AssessmentPackageResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Assessments Package', - tags: ['Assessments', 'Packages'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'get_assessments_package', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/assessments/orders': { - post: { - operationId: 'ats_order_assessments_request', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AtsCreateCandidatesAssessmentsRequestDto', - }, - }, - }, - }, - responses: { - '200': { - description: 'The order request of the assessment for candidate.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateAssessmentOrderResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Order Assessments Request', - tags: ['Assessments', 'Orders'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'order_assessments_request', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/assessments/orders/{id}/result': { - patch: { - operationId: 'ats_update_assessments_result', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AtsUpdateCandidatesAssessmentsResultsRequestDto', - }, - }, - }, - }, - responses: { - '200': { - description: 'The result update of the assessment for candidate.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UpdateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Update Assessments Result', - tags: ['Assessments', 'Results'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'update_assessments_result', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/background_checks/packages': { - get: { - operationId: 'ats_list_background_check_packages', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,description,tests,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of background check packages was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BackgroundCheckPackagePaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Background Check Packages', - tags: ['Background Checks', 'Packages'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'list_background_check_packages', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - post: { - operationId: 'ats_create_background_check_package', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AtsCreateBackgroundCheckPackagesRequestDto', - }, - }, - }, - }, - responses: { - '201': { - description: 'Record created successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Create Background Check Package', - tags: ['Background Checks', 'Packages'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'create_background_check_package', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/background_checks/packages/{id}': { - get: { - operationId: 'ats_get_background_check_package', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,description,tests,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The background check package with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BackgroundCheckPackageResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Background Check Package', - tags: ['Background Checks', 'Packages'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'get_background_check_package', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - patch: { - operationId: 'ats_update_background_check_package', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AtsUpdateBackgroundCheckPackagesRequestDto', - }, - }, - }, - }, - responses: { - '200': { - description: 'Record updated successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UpdateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Update Background Check Package', - tags: ['Background Checks', 'Packages'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'update_background_check_package', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - delete: { - operationId: 'ats_delete_background_check_package', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'Record deleted successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/DeleteResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Delete Background Check Package', - tags: ['Background Checks', 'Packages'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'delete_background_check_package', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/background_checks/orders': { - post: { - operationId: 'ats_order_background_check_request', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AtsCreateBackgroundCheckOrderRequestDto', - }, - }, - }, - }, - responses: { - '200': { - description: 'The order request of the background check for candidate.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateBackgroundCheckOrderResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Order Background Check Request', - tags: ['Background Checks', 'Orders'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'order_background_check_request', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/background_checks/orders/{id}/result': { - patch: { - operationId: 'ats_update_background_check_result', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AtsUpdateBackgroundCheckResultRequestDto', - }, - }, - }, - }, - responses: { - '200': { - description: 'The result update of the background check for candidate.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UpdateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Update Background Check Result', - tags: ['Background Checks', 'Results'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'update_background_check_result', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/documents/application_categories': { - get: { - operationId: 'ats_list_application_document_categories', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,active,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of application document categories were retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ReferencePaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Application Document Categories', - tags: ['Documents'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'list_application_document_categories', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ats/documents/application_categories/{id}': { - get: { - operationId: 'ats_get_application_document_category', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,active,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'The application document category with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ReferenceResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Application Document Category', - tags: ['Documents'], - 'x-speakeasy-group': 'ats', - 'x-speakeasy-name-override': 'get_application_document_category', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - }, - info: { - title: 'ATS', - description: 'The documentation for the StackOne Unified API - ATS', - version: '1.0.0', - contact: {}, - }, - tags: [ - { - name: 'Application Changes', - description: - 'Chronological record of changes made to the application (this will only track changes for specific properties of the Application model).', - }, - { - name: 'Application Notes', - description: 'Notes or comments on applications.', - }, - { - name: 'Application Stages', - description: 'Stages of the job application process', - }, - { - name: 'Applications', - description: 'Job applications submitted by candidates.', - }, - { - name: 'Assessments', - description: 'Candidate assessments or tests.', - }, - { - name: 'Background Checks', - description: 'Background screening checks.', - }, - { - name: 'Candidates', - description: 'People applying for jobs.', - }, - { - name: 'Custom Field Definitions', - description: 'Definitions for custom fields on ATS resources.', - }, - { - name: 'Departments', - description: 'Departments within an organization.', - }, - { - name: 'Documents', - description: 'Files and documents related to candidates or jobs.', - }, - { - name: 'Interviews', - description: 'Scheduled interviews with candidates.', - }, - { - name: 'Job Postings', - description: 'Public job advertisements.', - }, - { - name: 'Jobs', - description: 'Open job positions.', - }, - { - name: 'Lists', - description: 'Lists for organizing candidates or jobs.', - }, - { - name: 'Locations', - description: 'Job or office locations.', - }, - { - name: 'Notes', - description: 'General notes or comments.', - }, - { - name: 'Offers', - description: 'Job offers extended to candidates.', - }, - { - name: 'Orders', - description: 'Orders for background checks or assessments.', - }, - { - name: 'Packages', - description: 'Assessment or offer packages.', - }, - { - name: 'Rejected Reasons', - description: 'Reasons for candidate rejection.', - }, - { - name: 'Results', - description: 'Results of assessments or background checks.', - }, - { - name: 'Scheduled Interviews', - description: 'Planned interview sessions.', - }, - { - name: 'Scorecards', - description: 'Evaluation scorecards for candidates.', - }, - { - name: 'Users', - description: 'System users with access to the ATS.', - }, - ], - servers: [ - { - url: 'https://api.stackone.com', - }, - ], - components: { - securitySchemes: { - basic: { - type: 'http', - scheme: 'basic', - }, - }, - schemas: { - Answer: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - type: { - description: 'Type of the answer', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/AnswerEnum', - }, - ], - }, - values: { - description: 'Values of the answer', - example: ['Yes', 'No Travel', 'It sounds pretty cool.', 'Excel', 'Power Point'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - }, - }, - AnswerEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'short_text', - 'long_text', - 'attachment', - 'multi_select', - 'single_select', - 'boolean', - 'number', - 'date', - 'video', - 'reference_check', - 'url', - 'unmapped_value', - null, - ], - description: 'The type of the answer.', - example: 'short_text', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the answer type.', - example: 'Short Text', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - Application: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - candidate_id: { - type: 'string', - description: 'Unique identifier of the candidate', - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - remote_candidate_id: { - type: 'string', - description: "Provider's unique identifier of the candidate", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - job_id: { - type: 'string', - description: 'Unique identifier of the job', - example: '4071538b-3cac-4fbf-ac76-f78ed250ffdd', - nullable: true, - }, - remote_job_id: { - type: 'string', - description: "Provider's unique identifier of the job", - example: '4071538b-3cac-4fbf-ac76-f78ed250ffdd', - nullable: true, - }, - interview_stage: { - deprecated: true, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/InterviewStage', - }, - ], - }, - application_stage: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ApplicationStage', - }, - ], - }, - interview_stage_id: { - type: 'string', - description: 'Unique identifier of the interview stage', - example: '18bcbb1b-3cbc-4198-a999-460861d19480', - deprecated: true, - nullable: true, - }, - remote_interview_stage_id: { - type: 'string', - description: "Provider's unique identifier of the interview stage", - example: '18bcbb1b-3cbc-4198-a999-460861d19480', - deprecated: true, - nullable: true, - }, - application_stage_id: { - type: 'string', - description: 'Unique identifier of the application stage', - example: '18bcbb1b-3cbc-4198-a999-460861d19480', - nullable: true, - }, - remote_application_stage_id: { - type: 'string', - description: 'Unique identifier of the application stage', - example: '18bcbb1b-3cbc-4198-a999-460861d19480', - nullable: true, - }, - rejected_reasons: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RejectedReason', - }, - }, - rejected_reason_ids: { - description: 'Unique identifiers of the rejection reasons', - example: ['f223d7f6-908b-48f0-9237-b201c307f609'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - remote_rejected_reason_ids: { - description: "Provider's unique identifiers of the rejection reasons", - example: ['f223d7f6-908b-48f0-9237-b201c307f609'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - rejected_at: { - type: 'string', - description: 'Date of rejection', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - location_id: { - type: 'string', - description: 'Unique identifier of the location', - example: 'dd8d41d1-5eb8-4408-9c87-9ba44604eae4', - deprecated: true, - nullable: true, - }, - remote_location_id: { - type: 'string', - description: "Provider's unique identifier of the location", - example: 'dd8d41d1-5eb8-4408-9c87-9ba44604eae4', - deprecated: true, - nullable: true, - }, - location_ids: { - description: 'Unique identifiers of the locations', - example: ['dd8d41d1-5eb8-4408-9c87-9ba44604eae4'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - remote_location_ids: { - description: "Remote's unique identifiers of the locations", - example: ['dd8d41d1-5eb8-4408-9c87-9ba44604eae4'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - application_status: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ApplicationStatusEnum', - }, - ], - }, - questionnaires: { - description: 'Questionnaires associated with the application', - example: { - id: 'right_to_work', - answers: [ - { - id: 'answer1', - type: 'text', - values: ['Yes'], - }, - ], - }, - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/Questionnaire', - }, - }, - candidate: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ApplicationCandidate', - }, - ], - }, - attachments: { - deprecated: true, - description: 'Use `documents` expand instead', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/ApplicationAttachment', - }, - }, - documents: { - description: - 'The documents attached to this application (eg. resume, cover letter etc.)', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/AtsDocumentApiModel', - }, - }, - result_links: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/ResultLink', - }, - }, - source: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/Source', - }, - ], - }, - created_at: { - type: 'string', - description: 'Date of creation', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'Date of last update', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - custom_fields: { - description: 'The application custom fields', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CustomFields', - }, - }, - }, - }, - ApplicationAttachment: { - type: 'object', - properties: { - file_name: { - type: 'string', - description: 'The file name of the attachment.', - example: 'resume.pdf', - nullable: true, - }, - content: { - type: 'string', - description: 'The content of the attachment.', - example: 'Base64 encoded content', - nullable: true, - }, - url: { - type: 'string', - description: 'The URL of the attachment.', - example: 'http://example.com/resume.pdf', - nullable: true, - }, - content_type: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/AttachmentContentType', - }, - ], - }, - }, - }, - ApplicationCandidate: { - type: 'object', - properties: { - name: { - type: 'string', - description: 'Candidate name', - example: 'Romain Sestier', - nullable: true, - }, - first_name: { - type: 'string', - description: 'First name of the candidate', - example: 'John', - nullable: true, - }, - last_name: { - type: 'string', - description: 'Last name of the candidate', - example: 'Doe', - nullable: true, - }, - email: { - type: 'string', - description: 'Email of the candidate', - example: 'john.doe@example.com', - nullable: true, - }, - emails: { - description: 'List of candidate emails', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CandidateEmail', - }, - }, - phone_numbers: { - description: - 'List of candidate phone numbers including the type of the number when available', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/PhoneNumber', - }, - }, - social_links: { - description: 'List of candidate social links', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/SocialLink', - }, - }, - company: { - type: 'string', - description: 'Candidate company', - example: 'Company Inc.', - nullable: true, - }, - title: { - type: 'string', - description: 'Candidate title', - example: 'Software Engineer', - nullable: true, - }, - }, - }, - ApplicationChanges: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - created_at: { - type: 'string', - description: 'Timestamp when the change was created', - example: '2024-01-15T10:30:00Z', - format: 'date-time', - }, - effective_at: { - type: 'string', - description: 'Timestamp when the change became effective', - example: '2024-01-15T10:30:00Z', - format: 'date-time', - nullable: true, - }, - actor: { - description: 'The actor who made the change', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ChangesActor', - }, - ], - }, - change_type: { - description: 'The type of change that occurred to the application', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ApplicationChangeTypeEnum', - }, - ], - }, - new_values: { - description: - 'The new values for changed application properties. Only includes fields that commonly change over the application lifecycle.', - allOf: [ - { - $ref: '#/components/schemas/ApplicationChangesDataModel', - }, - ], - }, - }, - required: ['created_at', 'new_values'], - }, - ApplicationChangesDataModel: { - type: 'object', - properties: { - interview_stage_id: { - type: 'string', - description: 'Unique identifier of the interview stage', - example: '18bcbb1b-3cbc-4198-a999-460861d19480', - deprecated: true, - nullable: true, - }, - rejected_reason_ids: { - description: 'Unique identifiers of the rejection reasons', - example: ['f223d7f6-908b-48f0-9237-b201c307f609'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - application_status: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ApplicationStatusEnum', - }, - ], - }, - }, - }, - ApplicationChangesPaginated: { - type: 'object', - properties: { - next: { - type: 'string', - nullable: true, - }, - data: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/ApplicationChanges', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - }, - ApplicationChangeTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'application_status', - 'interview_stage', - 'rejected_reasons', - 'unmapped_value', - null, - ], - description: 'The type of change that occurred to the application', - example: 'application_status', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the change type', - example: 'StatusChange', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - ApplicationResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/Application', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - ApplicationsPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/Application', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - ApplicationStage: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - name: { - type: 'string', - description: 'Application Stage name', - example: 'Review', - nullable: true, - }, - order: { - type: 'number', - description: 'Application Stage order', - example: '1', - nullable: true, - }, - created_at: { - type: 'string', - description: 'Application Stage created date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'Application Stage updated date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - ApplicationStageResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/ApplicationStage', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - ApplicationStagesPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/ApplicationStage', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - ApplicationStatusEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'active', - 'assessment', - 'background_check', - 'converted', - 'declined_by_candidate', - 'hired', - 'interview', - 'lead', - 'offer', - 'reference_check', - 'rejected', - 'review', - 'screen', - 'new', - 'onboarding', - 'created', - 'accepted', - 'short_list', - 'approved', - 'unmapped_value', - null, - ], - description: 'The status of the application.', - example: 'hired', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the application status.', - example: 'Hired', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - AssessmentPackage: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'Package name', - example: 'Test 1', - nullable: true, - }, - description: { - type: 'string', - description: 'Package description', - example: "Skills test to gauge a candidate's proficiency in job-specific skills", - nullable: true, - }, - }, - }, - AssessmentPackagePaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/AssessmentPackage', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - AssessmentPackageResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/AssessmentPackage', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - AssessmentTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'responsibilities', - 'skills', - 'benefits', - 'company_overview', - 'description', - 'other', - 'unmapped_value', - null, - ], - description: 'The type of the description.', - example: 'responsibilities', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the description type.', - example: 'key_responsibilities', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - AtsCreateApplicationRequestDto: { - type: 'object', - properties: { - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - job_id: { - type: 'string', - description: 'Unique identifier of the job', - example: '4071538b-3cac-4fbf-ac76-f78ed250ffdd', - nullable: true, - }, - job_posting_id: { - type: 'string', - description: 'Unique identifier of the job posting that is associated with application', - example: '1c702a20-8de8-4d03-ac18-cbf4ac42eb51', - nullable: true, - }, - location_id: { - type: 'string', - description: 'Unique identifier of the location', - example: 'dd8d41d1-5eb8-4408-9c87-9ba44604eae4', - nullable: true, - }, - application_status: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ApplicationStatusEnum', - }, - ], - }, - questionnaires: { - description: 'Questionnaires associated with the application', - example: { - id: 'right_to_work', - answers: [ - { - id: 'answer1', - type: 'text', - values: ['Yes'], - }, - ], - }, - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CreateQuestionnaire', - }, - }, - source: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/CreateSource', - }, - ], - }, - candidate_id: { - type: 'string', - description: - 'Unique identifier of the candidate. Provide this OR candidate, but not both.', - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - candidate: { - description: - 'Candidate Properties. Provide this OR candidate_id, but not both. Providing this attempts to create a new candidate with the application.', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/CreateCandidate', - }, - ], - }, - documents: { - description: - 'Document Properties. Providing this attempts to upload files with the application.', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/AtsDocumentsUploadRequestDto', - }, - }, - }, - }, - AtsCreateBackgroundCheckOrderRequestDto: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - application: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/OrderApplicationApiModel', - }, - ], - }, - job: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/OrderJobApiModel', - }, - ], - }, - candidate: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/OrderCandidateApiModel', - }, - ], - }, - requester: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/OrderJobHiringTeamApiModel', - }, - ], - }, - results_update_url: { - type: 'string', - description: 'Results update url', - example: 'https://exmaple.com/integrations/results/update', - nullable: true, - }, - package: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/OrderBackgroundCheckPackageApiModel', - }, - ], - }, - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - }, - }, - AtsCreateBackgroundCheckPackagesRequestDto: { - type: 'object', - properties: { - name: { - type: 'string', - description: 'Package name', - example: 'Test 1', - nullable: true, - }, - description: { - type: 'string', - description: 'Package description', - example: "Skills test to gauge a candidate's proficiency in job-specific skills", - nullable: true, - }, - tests: { - description: 'Package tests', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CreatePackage', - }, - }, - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - }, - }, - AtsCreateCandidateRequestDto: { - type: 'object', - properties: { - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - phone_number: { - type: 'string', - description: 'The candidate personal phone number', - example: '+1234567890', - deprecated: true, - nullable: true, - }, - phone_numbers: { - description: - 'List of candidate phone numbers including the type of the number when available', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/PhoneNumber', - }, - }, - name: { - type: 'string', - description: 'Candidate name', - example: 'Romain Sestier', - nullable: true, - }, - first_name: { - type: 'string', - description: 'Candidate first name', - example: 'Romain', - nullable: true, - }, - last_name: { - type: 'string', - description: 'Candidate last name', - example: 'Sestier', - nullable: true, - }, - email: { - type: 'string', - description: 'Candidate email', - example: 'sestier.romain123@gmail.com', - nullable: true, - }, - social_links: { - description: 'List of candidate social links', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/SocialLink', - }, - }, - company: { - type: 'string', - description: 'Candidate company', - example: 'Company Inc.', - nullable: true, - }, - title: { - type: 'string', - description: 'Candidate title', - example: 'Software Engineer', - nullable: true, - }, - hired_at: { - type: 'string', - description: 'Candidate hired date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - country: { - type: 'string', - description: 'Candidate country', - example: 'United States', - nullable: true, - }, - custom_fields: { - description: 'The candidate custom fields', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CustomFields', - }, - }, - }, - }, - AtsCreateCandidatesAssessmentsRequestDto: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - package: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/OrderPackageApiModel', - }, - ], - }, - application: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/OrderApplicationApiModel', - }, - ], - }, - job: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/OrderJobApiModel', - }, - ], - }, - candidate: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/OrderCandidateApiModel', - }, - ], - }, - requester: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/OrderJobHiringTeamApiModel', - }, - ], - }, - results_update_url: { - type: 'string', - description: 'Results update url', - example: 'https://exmaple.com/integrations/results/update', - nullable: true, - }, - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - }, - }, - AtsCreateJobRequestDto: { - type: 'object', - properties: { - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - code: { - type: 'string', - description: 'Code of the job', - example: '184919', - nullable: true, - }, - title: { - type: 'string', - description: 'Title of the job', - example: 'Software Engineer', - nullable: true, - }, - description: { - type: 'string', - description: 'Description of the job', - example: 'Responsible for identifying business requirements', - nullable: true, - }, - status: { - type: 'string', - deprecated: true, - description: 'Status of the job', - example: 'archived', - nullable: true, - }, - job_status: { - description: 'Status of the job', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/AtsJobStatusEnum', - }, - ], - }, - department_ids: { - description: 'Department ids of the job', - example: ['308570', '308571', '308572'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - location_ids: { - description: 'Location ids of the job', - example: ['668570', '678571', '688572'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - hiring_team: { - description: 'Hiring team for the job.', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/AtsJobHiringTeam', - }, - }, - interview_stages: { - description: 'Interview stages for the job.', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/InterviewStage', - }, - }, - confidential: { - type: 'string', - description: 'Confidential status of the job', - enum: ['true', 'false', 'unmapped_value', null], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - custom_fields: { - description: 'The job custom fields', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CustomFields', - }, - }, - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - }, - }, - AtsCreateNotesRequestDto: { - type: 'object', - properties: { - content: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/NoteContentApiModel', - }, - }, - author_id: { - type: 'string', - description: 'Unique identifier of the author', - example: '1234567890', - nullable: true, - }, - visibility: { - description: 'Visibility of the note', - example: 'public', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/NotesVisibilityEnum', - }, - ], - }, - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - }, - }, - AtsCreateOfferRequestDto: { - type: 'object', - properties: { - application_id: { - type: 'string', - nullable: true, - }, - start_date: { - type: 'string', - description: 'Date of creation', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - offer_status: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/OfferStatusEnum', - }, - ], - }, - salary: { - type: 'number', - nullable: true, - }, - currency: { - type: 'string', - nullable: true, - }, - offer_history: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/OfferHistory', - }, - }, - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - }, - }, - AtsDocumentApiModel: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'The name of the file', - example: 'My Document', - nullable: true, - }, - category: { - description: 'The category of the the document', - example: 'templates, forms, backups, etc.', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/FileCategoryEnumApiModel', - }, - ], - }, - contents: { - description: - 'The content of the file. Deprecated, use `url` and `file_format` one level up instead', - deprecated: true, - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/Content', - }, - }, - category_id: { - type: 'string', - description: 'The categoryId of the documents', - example: '6530', - nullable: true, - }, - created_at: { - type: 'string', - description: 'The creation date of the file', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The update date of the file', - example: '2021-01-02T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - remote_url: { - type: 'string', - description: 'URL where the file content is located', - example: 'https://example.com/file.pdf', - nullable: true, - }, - file_format: { - description: 'The file format of the file', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/FileFormatEnum', - }, - ], - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - type: { - description: 'The content type of the document', - deprecated: true, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/AtsDocumentTypeEnum', - }, - ], - }, - }, - }, - AtsDocumentResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/AtsDocumentApiModel', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - AtsDocumentsPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/AtsDocumentApiModel', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - AtsDocumentsUploadCategoryEnumApiModel: { - type: 'object', - properties: { - value: { - type: 'string', - description: 'The category name to associate with the file', - enum: [ - 'resume', - 'avatar', - 'cover_letter', - 'profile_picture', - 'policy', - 'passport', - 'assessment', - 'interview_attachment', - 'take_home_test', - 'offer_letter', - 'signed_offer_letter', - 'national_id', - 'offer_packet', - 'other', - 'unmapped_value', - null, - ], - example: 'resume', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - type: 'string', - description: - 'The provider specific category for associating uploaded files, if provided, the value will be ignored.', - example: '550e8400-e29b-41d4-a716-446655440000', - nullable: true, - }, - }, - }, - AtsDocumentsUploadRequestDto: { - type: 'object', - properties: { - name: { - type: 'string', - description: 'The filename of the file to upload', - example: 'weather-forecast', - nullable: true, - }, - file_format: { - description: 'The file format of the file', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/FileFormatEnum', - }, - ], - }, - content: { - type: 'string', - description: 'The base64 encoded content of the file to upload', - example: - 'VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE', - nullable: true, - }, - category_id: { - type: 'string', - description: 'The categoryId of the documents', - example: '6530', - nullable: true, - }, - path: { - type: 'string', - description: 'The path for the file to be uploaded to', - example: '/path/to/file', - nullable: true, - }, - confidential: { - description: 'The confidentiality level of the file to be uploaded', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ConfidentialEnumApiModel', - }, - ], - }, - category: { - description: - 'The category to be associated with the file to be uploaded. Id will take precedence over name.', - example: { - name: 'resume', - id: '550e8400-e29b-41d4-a716-446655440000', - }, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/AtsDocumentsUploadCategoryEnumApiModel', - }, - ], - }, - }, - }, - AtsDocumentTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - description: 'The category of the file', - nullable: true, - enum: [ - 'resume', - 'avatar', - 'cover_letter', - 'profile_picture', - 'policy', - 'passport', - 'assessment', - 'interview_attachment', - 'take_home_test', - 'offer_letter', - 'signed_offer_letter', - 'national_id', - 'offer_packet', - 'other', - 'unmapped_value', - null, - ], - 'x-speakeasy-unknown-values': 'allow', - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - AtsJob: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - code: { - type: 'string', - description: 'Code of the job', - example: '184919', - nullable: true, - }, - title: { - type: 'string', - description: 'Title of the job', - example: 'Software Engineer', - nullable: true, - }, - description: { - type: 'string', - description: 'Description of the job', - example: 'Responsible for identifying business requirements', - nullable: true, - }, - status: { - type: 'string', - deprecated: true, - description: 'Status of the job', - example: 'archived', - nullable: true, - }, - job_status: { - description: 'Status of the job', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/AtsJobStatusEnum', - }, - ], - }, - department_ids: { - description: 'Department ids of the job', - example: ['308570', '308571', '308572'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - remote_department_ids: { - description: "Provider's department ids of the job", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - location_ids: { - description: 'Location ids of the job', - example: ['668570', '678571', '688572'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - remote_location_ids: { - description: "Provider's location ids of the job", - example: ['668570', '678571', '688572'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - hiring_team: { - description: 'Hiring team for the job.', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/AtsJobHiringTeam', - }, - }, - interview_stages: { - description: 'Interview stages for the job.', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/InterviewStage', - }, - }, - confidential: { - type: 'string', - description: 'Confidential status of the job', - enum: ['true', 'false', 'unmapped_value', null], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - custom_fields: { - description: 'The job custom fields', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CustomFields', - }, - }, - created_at: { - type: 'string', - description: 'Date of creation', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'Date of last update', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - AtsJobHiringTeam: { - type: 'object', - properties: { - user_id: { - type: 'string', - example: '123456', - description: 'User ID of the hiring team member.', - nullable: true, - }, - remote_user_id: { - type: 'string', - description: "Provider's unique identifier of the user", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - first_name: { - type: 'string', - example: 'John', - description: 'First name of the hiring team member.', - nullable: true, - }, - last_name: { - type: 'string', - example: 'Doe', - description: 'Last name of the hiring team member.', - nullable: true, - }, - email: { - type: 'string', - example: 'john.doe@gmail.com', - description: 'Email of the hiring team member.', - nullable: true, - }, - role: { - type: 'string', - example: 'Software Engineer', - description: 'Role of the hiring team member.', - nullable: true, - }, - }, - }, - AtsJobResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/AtsJob', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - AtsJobsPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/AtsJob', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - AtsJobStatusEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'published', - 'draft', - 'pending', - 'internal', - 'archived', - 'closed', - 'open', - 'deleted', - 'on_hold', - 'unmapped_value', - null, - ], - description: 'The status of the job.', - example: 'published', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the job status.', - example: 'Published', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - ATSLocation: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - name: { - type: 'string', - nullable: true, - }, - }, - }, - ATSLocationResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/ATSLocation', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - ATSLocationsPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/ATSLocation', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - AtsMoveApplicationRequestDto: { - type: 'object', - properties: { - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - interview_stage_id: { - type: 'string', - description: 'Unique identifier of the application stage.', - example: 'f223d7f6-908b-48f0-9237-b201c307f609', - nullable: true, - }, - }, - }, - AtsRejectApplicationRequestDto: { - type: 'object', - properties: { - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - rejected_reason_id: { - type: 'string', - description: 'Unique identifier of the rejection reason', - example: 'f223d7f6-908b-48f0-9237-b201c307f609', - nullable: true, - }, - }, - }, - AtsUpdateApplicationRequestDto: { - type: 'object', - properties: { - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - custom_fields: { - description: 'The application custom fields', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CustomFields', - }, - }, - application_status: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ApplicationStatusEnum', - }, - ], - }, - source: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/CreateSource', - }, - ], - }, - }, - }, - AtsUpdateBackgroundCheckPackagesRequestDto: { - type: 'object', - properties: { - name: { - type: 'string', - description: 'Package name', - example: 'Test 1', - nullable: true, - }, - description: { - type: 'string', - description: 'Package description', - example: "Skills test to gauge a candidate's proficiency in job-specific skills", - nullable: true, - }, - tests: { - description: 'Package tests', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/UpdatePackage', - }, - }, - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - }, - }, - AtsUpdateBackgroundCheckResultRequestDto: { - type: 'object', - properties: { - score: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ScoreApiModel', - }, - ], - }, - start_date: { - type: 'string', - description: 'The start date of the candidate test', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - submission_date: { - type: 'string', - description: 'The submission date of the candidate test', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - summary: { - type: 'string', - description: 'The summary about the result of the test', - example: 'Test is passed', - nullable: true, - }, - result: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ResultEnum', - }, - ], - }, - result_url: { - type: 'string', - description: 'The test`s result url', - example: 'https://exmaple.com/result?id=xyz', - nullable: true, - }, - attachments: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/Attachment', - }, - }, - candidate: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/UpdateResultCandidateApiModel', - }, - ], - }, - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - }, - }, - AtsUpdateCandidateRequestDto: { - type: 'object', - properties: { - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - name: { - type: 'string', - description: 'Candidate name', - example: 'Romain Sestier', - nullable: true, - }, - first_name: { - type: 'string', - description: 'Candidate first name', - example: 'Romain', - nullable: true, - }, - last_name: { - type: 'string', - description: 'Candidate last name', - example: 'Sestier', - nullable: true, - }, - email: { - type: 'string', - description: 'Candidate email', - example: 'sestier.romain123@gmail.com', - nullable: true, - }, - emails: { - description: 'List of candidate emails', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CandidateEmail', - }, - }, - social_links: { - description: 'List of candidate social links', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/SocialLink', - }, - }, - phone: { - type: 'string', - description: 'Candidate phone number', - example: '+16178294093', - deprecated: true, - nullable: true, - }, - phone_numbers: { - description: - 'List of candidate phone numbers including the type of the number when available', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/PhoneNumber', - }, - }, - company: { - type: 'string', - description: 'Candidate company', - example: 'Company Inc.', - nullable: true, - }, - title: { - type: 'string', - description: 'Candidate title', - example: 'Software Engineer', - nullable: true, - }, - application_ids: { - description: 'List of candidate application IDs', - example: [ - '123e4567-e89b-12d3-a456-426614174000', - '523e1234-e89b-fdd2-a456-762545121101', - ], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - hired_at: { - type: 'string', - description: 'Candidate hired date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - country: { - type: 'string', - description: 'Candidate country', - example: 'United States', - nullable: true, - }, - custom_fields: { - description: 'The candidate custom fields', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CustomFields', - }, - }, - }, - }, - AtsUpdateCandidatesAssessmentsResultsRequestDto: { - type: 'object', - properties: { - score: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ScoreApiModel', - }, - ], - }, - start_date: { - type: 'string', - description: 'The start date of the candidate test', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - submission_date: { - type: 'string', - description: 'The submission date of the candidate test', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - summary: { - type: 'string', - description: 'The summary about the result of the test', - example: 'Test is passed', - nullable: true, - }, - result: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ResultEnum', - }, - ], - }, - result_url: { - type: 'string', - description: 'The test`s result url', - example: 'https://exmaple.com/result?id=xyz', - nullable: true, - }, - attachments: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/Attachment', - }, - }, - candidate: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/UpdateResultCandidateApiModel', - }, - ], - }, - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - }, - }, - AtsUpdateJobRequestDto: { - type: 'object', - properties: { - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - code: { - type: 'string', - description: 'Code of the job', - example: '184919', - nullable: true, - }, - title: { - type: 'string', - description: 'Title of the job', - example: 'Software Engineer', - nullable: true, - }, - description: { - type: 'string', - description: 'Description of the job', - example: 'Responsible for identifying business requirements', - nullable: true, - }, - status: { - type: 'string', - deprecated: true, - description: 'Status of the job', - example: 'archived', - nullable: true, - }, - job_status: { - description: 'Status of the job', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/AtsJobStatusEnum', - }, - ], - }, - department_ids: { - description: 'Department ids of the job', - example: ['308570', '308571', '308572'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - location_ids: { - description: 'Location ids of the job', - example: ['668570', '678571', '688572'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - hiring_team: { - description: 'Hiring team for the job.', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/AtsJobHiringTeam', - }, - }, - interview_stages: { - description: 'Interview stages for the job.', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/InterviewStage', - }, - }, - confidential: { - type: 'string', - description: 'Confidential status of the job', - enum: ['true', 'false', 'unmapped_value', null], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - custom_fields: { - description: 'The job custom fields', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CustomFields', - }, - }, - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - }, - }, - AtsUpdateNotesRequestDto: { - type: 'object', - properties: { - content: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/NoteContentApiModel', - }, - }, - author_id: { - type: 'string', - description: 'Unique identifier of the author', - example: '1234567890', - nullable: true, - }, - visibility: { - description: 'Visibility of the note', - example: 'public', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/NotesVisibilityEnum', - }, - ], - }, - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - }, - }, - Attachment: { - type: 'object', - properties: { - url: { - type: 'string', - description: 'The URL of the attachment.', - example: 'http://example.com/resume.pdf', - nullable: true, - }, - content_type: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/AttachmentContentType', - }, - ], - }, - }, - }, - AttachmentContentType: { - type: 'object', - properties: { - value: { - type: 'string', - enum: ['text', 'pdf', 'video', 'other', 'unmapped_value', null], - description: 'The content type of the attachment.', - example: 'text', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the content type.', - example: 'Text', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - BackgroundCheckPackage: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'Package name', - example: 'Test 1', - nullable: true, - }, - description: { - type: 'string', - description: 'Package description', - example: "Skills test to gauge a candidate's proficiency in job-specific skills", - nullable: true, - }, - tests: { - description: 'Package tests', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/Package', - }, - }, - }, - }, - BackgroundCheckPackagePaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/BackgroundCheckPackage', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - BackgroundCheckPackageResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/BackgroundCheckPackage', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - BadGatewayResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 502, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Gateway', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - BadRequestResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 400, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Request', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - data: { - description: 'Error details', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/UnifiedError', - }, - ], - }, - provider_errors: { - description: 'List of provider-specific errors', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/ProviderError', - }, - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - Candidate: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - name: { - type: 'string', - description: 'Candidate name', - example: 'Romain Sestier', - nullable: true, - }, - first_name: { - type: 'string', - description: 'Candidate first name', - example: 'Romain', - nullable: true, - }, - last_name: { - type: 'string', - description: 'Candidate last name', - example: 'Sestier', - nullable: true, - }, - email: { - type: 'string', - description: 'Candidate email', - example: 'sestier.romain123@gmail.com', - nullable: true, - }, - emails: { - description: 'List of candidate emails', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CandidateEmail', - }, - }, - social_links: { - description: 'List of candidate social links', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/SocialLink', - }, - }, - phone: { - type: 'string', - description: 'Candidate phone number', - example: '+16178294093', - deprecated: true, - nullable: true, - }, - phone_numbers: { - description: - 'List of candidate phone numbers including the type of the number when available', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/PhoneNumber', - }, - }, - company: { - type: 'string', - description: 'Candidate company', - example: 'Company Inc.', - nullable: true, - }, - title: { - type: 'string', - description: 'Candidate title', - example: 'Software Engineer', - nullable: true, - }, - application_ids: { - description: 'List of candidate application IDs', - example: [ - '123e4567-e89b-12d3-a456-426614174000', - '523e1234-e89b-fdd2-a456-762545121101', - ], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - remote_application_ids: { - description: "Provider's list of candidate application IDs", - example: [ - '123e4567-e89b-12d3-a456-426614174000', - '523e1234-e89b-fdd2-a456-762545121101', - ], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - hired_at: { - type: 'string', - description: 'Candidate hired date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - country: { - type: 'string', - description: 'Candidate country', - example: 'United States', - nullable: true, - }, - custom_fields: { - description: 'The candidate custom fields', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CustomFields', - }, - }, - tags: { - description: 'List of candidate tags indicating metadata associated with the candidate', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/Tag', - }, - }, - created_at: { - type: 'string', - description: 'Candidate created date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'Candidate updated date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - CandidateEmail: { - type: 'object', - properties: { - type: { - type: 'string', - description: 'Type of the email', - example: 'personal', - nullable: true, - }, - value: { - type: 'string', - description: 'Email value', - example: 'sestier.romain123@gmail.com', - nullable: true, - }, - }, - }, - CandidateResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/Candidate', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - CandidatesPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/Candidate', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - ChangesActor: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - }, - }, - CompensationTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'salary', - 'hourly', - 'commission', - 'bonus', - 'equity', - 'other', - 'unmapped_value', - null, - ], - description: 'The type of the compensation.', - example: 'salary', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the compensation type.', - example: 'Salary', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - ConditionTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: ['equals_to', 'contains', 'unmapped_value', null], - description: "The type of the question's condition", - example: 'equals_to', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: "The source value of the question's condition type", - example: 'EqualsTo', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - ConfidentialEnumApiModel: { - type: 'object', - properties: { - value: { - type: 'string', - description: 'Whether the file is confidential or not', - enum: ['true', 'false', 'unmapped_value', null], - example: 'true', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - example: 'public', - nullable: true, - }, - }, - }, - ConflictResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 409, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Conflict', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - Content: { - type: 'object', - properties: { - url: { - type: 'string', - description: 'URL where the file content is located', - example: 'https://example.com/file.pdf', - nullable: true, - }, - unified_url: { - type: 'string', - description: 'Unified download URL for retrieving file content.', - example: - 'https://api.stackone.com/unified/hris/employees/12345/documents/67890/download', - nullable: true, - }, - file_format: { - description: 'The file format of the file', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/FileFormatEnum', - }, - ], - }, - }, - }, - CreateAnswer: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - type: { - description: 'Type of the answer', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/AnswerEnum', - }, - ], - }, - values: { - description: 'Values of the answer', - example: ['Yes', 'No Travel', 'It sounds pretty cool.', 'Excel', 'Power Point'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - }, - }, - CreateAssessmentOrderResult: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - test_url: { - type: 'string', - description: 'Test url', - example: 'https://exmaple.com/integrations/candidate/test', - nullable: true, - }, - }, - }, - CreateBackgroundCheckOrderResult: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - test_url: { - type: 'string', - description: 'Test url', - example: 'https://exmaple.com/integrations/candidate/test', - nullable: true, - }, - }, - }, - CreateCandidate: { - type: 'object', - properties: { - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - phone_number: { - type: 'string', - description: 'The candidate personal phone number', - example: '+1234567890', - deprecated: true, - nullable: true, - }, - phone_numbers: { - description: - 'List of candidate phone numbers including the type of the number when available', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/PhoneNumber', - }, - }, - name: { - type: 'string', - description: 'Candidate name', - example: 'Romain Sestier', - nullable: true, - }, - first_name: { - type: 'string', - description: 'Candidate first name', - example: 'Romain', - nullable: true, - }, - last_name: { - type: 'string', - description: 'Candidate last name', - example: 'Sestier', - nullable: true, - }, - email: { - type: 'string', - description: 'Candidate email', - example: 'sestier.romain123@gmail.com', - nullable: true, - }, - social_links: { - description: 'List of candidate social links', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/SocialLink', - }, - }, - company: { - type: 'string', - description: 'Candidate company', - example: 'Company Inc.', - nullable: true, - }, - title: { - type: 'string', - description: 'Candidate title', - example: 'Software Engineer', - nullable: true, - }, - hired_at: { - type: 'string', - description: 'Candidate hired date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - country: { - type: 'string', - description: 'Candidate country', - example: 'United States', - nullable: true, - }, - custom_fields: { - description: 'The candidate custom fields', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CustomFields', - }, - }, - }, - }, - CreatePackage: { - type: 'object', - properties: { - name: { - type: 'string', - description: 'Package name', - example: 'Test 1', - nullable: true, - }, - description: { - type: 'string', - description: 'Package description', - example: "Skills test to gauge a candidate's proficiency in job-specific skills", - nullable: true, - }, - }, - }, - CreateQuestionnaire: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - answers: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CreateAnswer', - }, - }, - }, - }, - CreateResult: { - type: 'object', - properties: { - statusCode: { - type: 'number', - example: 201, - }, - message: { - type: 'string', - example: 'Record created successfully.', - }, - timestamp: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - }, - data: { - $ref: '#/components/schemas/CreateResultDataApiModel', - }, - }, - required: ['statusCode', 'message', 'timestamp', 'data'], - }, - CreateResultDataApiModel: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - }, - }, - CreateSource: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'The source of the application', - example: 'LinkedIn', - nullable: true, - }, - }, - }, - CustomFieldDefinition: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - nullable: true, - }, - description: { - type: 'string', - nullable: true, - }, - type: { - description: 'The type of the custom field.', - example: 'Dropdown', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/CustomFieldTypeEnum', - }, - ], - }, - options: { - description: 'An array of possible options for the custom field.', - example: [ - { - id: 'option_1', - value: 'Not Started', - }, - { - id: 'option_2', - value: 'In Progress', - }, - { - id: 'option_3', - value: 'Completed', - }, - ], - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CustomFieldOption', - }, - }, - }, - }, - CustomFieldDefinitionResultApiModel: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/CustomFieldDefinition', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - CustomFieldDefinitionsPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/CustomFieldDefinition', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - CustomFieldOption: { - type: 'object', - properties: { - id: { - type: 'string', - description: - 'The unique identifier for the option to be used when updating the custom field', - example: 'option_123', - }, - value: { - description: 'The human readable value of the option', - example: 'Not Started', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - }, - }, - required: ['id', 'value'], - }, - CustomFields: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'The name of the custom field.', - example: 'Training Completion Status', - nullable: true, - }, - value: { - description: 'The value associated with the custom field.', - example: 'Completed', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - { - type: 'string', - format: 'date-time', - }, - ], - nullable: true, - }, - value_id: { - type: 'string', - description: 'The unique identifier for the value of the custom field.', - example: 'value_456', - nullable: true, - }, - remote_value_id: { - type: 'string', - description: "Provider's unique identifier for the value of the custom field.", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - }, - }, - CustomFieldTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'date', - 'float', - 'integer', - 'list', - 'checkbox', - 'text', - 'boolean', - 'single_select', - 'multi_select', - 'url', - 'other', - 'unmapped_value', - null, - ], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - DeleteResult: { - type: 'object', - properties: { - statusCode: { - type: 'number', - example: 204, - }, - message: { - type: 'string', - example: 'Record deleted successfully.', - }, - timestamp: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - Department: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - name: { - type: 'string', - nullable: true, - }, - }, - }, - DepartmentResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/Department', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - DepartmentsPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/Department', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - DownloadApiModel: { - type: 'object', - properties: { - headers: { - description: 'Headers related to the download', - allOf: [ - { - $ref: '#/components/schemas/DownloadHeadersApiModel', - }, - ], - }, - data: { - type: 'string', - description: 'The file data in binary format', - format: 'binary', - }, - }, - required: ['headers', 'data'], - }, - DownloadHeadersApiModel: { - type: 'object', - properties: { - 'content-disposition': { - type: 'string', - description: 'Value of the Content-Disposition header', - example: 'attachment; filename="example.pdf"', - nullable: true, - }, - 'content-type': { - type: 'string', - description: 'MIME type of the file', - example: 'application/pdf', - nullable: true, - }, - 'content-length': { - type: 'number', - description: 'Size of the content in bytes', - example: 1024, - nullable: true, - }, - 'content-range': { - type: 'string', - description: 'Range of the content being sent', - example: 'bytes 0-1023/2048', - nullable: true, - }, - 'content-encoding': { - type: 'string', - description: 'Encoding of the content', - example: 'gzip', - nullable: true, - }, - 'transfer-encoding': { - type: 'string', - description: 'Transfer encoding type', - example: 'chunked', - nullable: true, - }, - }, - }, - EmploymentContractTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: ['full_time', 'shifts', 'part_time', 'unmapped_value', null], - description: 'The employment contract type.', - example: 'full_time', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the employment contract type.', - example: 'FullTime', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - EmploymentTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'contractor', - 'intern', - 'permanent', - 'apprentice', - 'freelance', - 'terminated', - 'temporary', - 'seasonal', - 'volunteer', - 'probation', - 'internal', - 'external', - 'expatriate', - 'employer_of_record', - 'casual', - 'Programme', - 'unmapped_value', - null, - ], - description: 'The type of the employment.', - example: 'permanent', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the employment type.', - example: 'Permanent', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - Field: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - label: { - type: 'string', - description: 'The label of the field', - example: 'Problem Solving', - nullable: true, - }, - type: { - type: 'string', - description: 'The type of the field', - example: 'text', - enum: [ - 'short_text', - 'long_text', - 'multi_select', - 'single_select', - 'boolean', - 'number', - 'date', - 'phone', - 'email', - 'score', - 'location', - 'unmapped_value', - null, - ], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - values: { - description: 'The possible values for the field', - example: ['Excellent', 'Good', 'Average', 'Poor'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - required: { - description: 'Indicates if the field is required', - example: true, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - }, - }, - FileCategoryEnumApiModel: { - type: 'object', - properties: { - value: { - type: 'string', - description: 'The category of the file', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - FileFormatEnum: { - type: 'object', - properties: { - value: { - type: 'string', - description: 'The file format of the file, expressed as a file extension', - enum: [ - 'unmapped_value', - 'ez', - 'aw', - 'atom', - 'atomcat', - 'atomdeleted', - 'atomsvc', - 'dwd', - 'held', - 'rsat', - 'bdoc', - 'xcs', - 'ccxml', - 'cdfx', - 'cdmia', - 'cdmic', - 'cdmid', - 'cdmio', - 'cdmiq', - 'cu', - 'mpd', - 'davmount', - 'dbk', - 'dssc', - 'xdssc', - 'es', - 'ecma', - 'emma', - 'emotionml', - 'epub', - 'exi', - 'exp', - 'fdt', - 'pfr', - 'geojson', - 'gml', - 'gpx', - 'gxf', - 'gz', - 'hjson', - 'stk', - 'ink', - 'inkml', - 'ipfix', - 'its', - 'jar', - 'war', - 'ear', - 'ser', - 'class', - 'js', - 'mjs', - 'json', - 'map', - 'json5', - 'jsonml', - 'jsonld', - 'lgr', - 'lostxml', - 'hqx', - 'cpt', - 'mads', - 'webmanifest', - 'mrc', - 'mrcx', - 'ma', - 'nb', - 'mb', - 'mathml', - 'mbox', - 'mscml', - 'metalink', - 'meta4', - 'mets', - 'maei', - 'musd', - 'mods', - 'm21', - 'mp21', - 'mp4s', - 'm4p', - 'doc', - 'dot', - 'mxf', - 'nq', - 'nt', - 'cjs', - 'bin', - 'dms', - 'lrf', - 'mar', - 'so', - 'dist', - 'distz', - 'pkg', - 'bpk', - 'dump', - 'elc', - 'deploy', - 'exe', - 'dll', - 'deb', - 'dmg', - 'iso', - 'img', - 'msi', - 'msp', - 'msm', - 'buffer', - 'oda', - 'opf', - 'ogx', - 'omdoc', - 'onetoc', - 'onetoc2', - 'onetmp', - 'onepkg', - 'oxps', - 'relo', - 'xer', - 'pdf', - 'pgp', - 'asc', - 'sig', - 'prf', - 'p10', - 'p7m', - 'p7c', - 'p7s', - 'p8', - 'ac', - 'cer', - 'crl', - 'pkipath', - 'pki', - 'pls', - 'ai', - 'eps', - 'ps', - 'provx', - 'pskcxml', - 'raml', - 'rdf', - 'owl', - 'rif', - 'rnc', - 'rl', - 'rld', - 'rs', - 'rapd', - 'sls', - 'rusd', - 'gbr', - 'mft', - 'roa', - 'rsd', - 'rss', - 'rtf', - 'sbml', - 'scq', - 'scs', - 'spq', - 'spp', - 'sdp', - 'senmlx', - 'sensmlx', - 'setpay', - 'setreg', - 'shf', - 'siv', - 'sieve', - 'smi', - 'smil', - 'rq', - 'srx', - 'gram', - 'grxml', - 'sru', - 'ssdl', - 'ssml', - 'swidtag', - 'tei', - 'teicorpus', - 'tfi', - 'tsd', - 'toml', - 'trig', - 'ttml', - 'ubj', - 'rsheet', - 'td', - 'vxml', - 'wasm', - 'wgt', - 'hlp', - 'wsdl', - 'wspolicy', - 'xaml', - 'xav', - 'xca', - 'xdf', - 'xel', - 'xns', - 'xenc', - 'xhtml', - 'xht', - 'xlf', - 'xml', - 'xsl', - 'xsd', - 'rng', - 'dtd', - 'xop', - 'xpl', - '*xsl', - 'xslt', - 'xspf', - 'mxml', - 'xhvml', - 'xvml', - 'xvm', - 'yang', - 'yin', - 'zip', - '*3gpp', - 'adp', - 'amr', - 'au', - 'snd', - 'mid', - 'midi', - 'kar', - 'rmi', - 'mxmf', - '*mp3', - 'm4a', - 'mp4a', - 'mpga', - 'mp2', - 'mp2a', - 'mp3', - 'm2a', - 'm3a', - 'oga', - 'ogg', - 'spx', - 'opus', - 's3m', - 'sil', - 'wav', - '*wav', - 'weba', - 'xm', - 'ttc', - 'otf', - 'ttf', - 'woff', - 'woff2', - 'exr', - 'apng', - 'avif', - 'bmp', - 'cgm', - 'drle', - 'emf', - 'fits', - 'g3', - 'gif', - 'heic', - 'heics', - 'heif', - 'heifs', - 'hej2', - 'hsj2', - 'ief', - 'jls', - 'jp2', - 'jpg2', - 'jpeg', - 'jpg', - 'jpe', - 'jph', - 'jhc', - 'jpm', - 'jpx', - 'jpf', - 'jxr', - 'jxra', - 'jxrs', - 'jxs', - 'jxsc', - 'jxsi', - 'jxss', - 'ktx', - 'ktx2', - 'png', - 'sgi', - 'svg', - 'svgz', - 't38', - 'tif', - 'tiff', - 'tfx', - 'webp', - 'wmf', - 'disposition-notification', - 'u8msg', - 'u8dsn', - 'u8mdn', - 'u8hdr', - 'eml', - 'mime', - '3mf', - 'gltf', - 'glb', - 'igs', - 'iges', - 'msh', - 'mesh', - 'silo', - 'mtl', - 'obj', - 'stpx', - 'stpz', - 'stpxz', - 'stl', - 'wrl', - 'vrml', - '*x3db', - 'x3dbz', - 'x3db', - '*x3dv', - 'x3dvz', - 'x3d', - 'x3dz', - 'x3dv', - 'appcache', - 'manifest', - 'ics', - 'ifb', - 'coffee', - 'litcoffee', - 'css', - 'csv', - 'html', - 'htm', - 'shtml', - 'jade', - 'jsx', - 'less', - 'markdown', - 'md', - 'mml', - 'mdx', - 'n3', - 'txt', - 'text', - 'conf', - 'def', - 'list', - 'log', - 'in', - 'ini', - 'rtx', - '*rtf', - 'sgml', - 'sgm', - 'shex', - 'slim', - 'slm', - 'spdx', - 'stylus', - 'styl', - 'tsv', - 't', - 'tr', - 'roff', - 'man', - 'me', - 'ms', - 'ttl', - 'uri', - 'uris', - 'urls', - 'vcard', - 'vtt', - '*xml', - 'yaml', - 'yml', - '3gp', - '3gpp', - '3g2', - 'h261', - 'h263', - 'h264', - 'm4s', - 'jpgv', - '*jpm', - 'jpgm', - 'mj2', - 'mjp2', - 'ts', - 'mp4', - 'mp4v', - 'mpg4', - 'mpeg', - 'mpg', - 'mpe', - 'm1v', - 'm2v', - 'ogv', - 'qt', - 'mov', - 'webm', - 'cww', - '1km', - 'plb', - 'psb', - 'pvb', - 'tcap', - 'pwn', - 'aso', - 'imp', - 'acu', - 'atc', - 'acutc', - 'air', - 'fcdt', - 'fxp', - 'fxpl', - 'xdp', - 'xfdf', - 'ahead', - 'azf', - 'azs', - 'azw', - 'acc', - 'ami', - 'apk', - 'cii', - 'fti', - 'atx', - 'mpkg', - 'key', - 'm3u8', - 'numbers', - 'pages', - 'pkpass', - 'swi', - 'iota', - 'aep', - 'bmml', - 'mpm', - 'bmi', - 'rep', - 'cdxml', - 'mmd', - 'cdy', - 'csl', - 'cla', - 'rp9', - 'c4g', - 'c4d', - 'c4f', - 'c4p', - 'c4u', - 'c11amc', - 'c11amz', - 'csp', - 'cdbcmsg', - 'cmc', - 'clkx', - 'clkk', - 'clkp', - 'clkt', - 'clkw', - 'wbs', - 'pml', - 'ppd', - 'car', - 'pcurl', - 'dart', - 'rdz', - 'dbf', - 'uvf', - 'uvvf', - 'uvd', - 'uvvd', - 'uvt', - 'uvvt', - 'uvx', - 'uvvx', - 'uvz', - 'uvvz', - 'fe_launch', - 'dna', - 'mlp', - 'mle', - 'dpg', - 'dfac', - 'kpxx', - 'ait', - 'svc', - 'geo', - 'mag', - 'nml', - 'esf', - 'msf', - 'qam', - 'slt', - 'ssf', - 'es3', - 'et3', - 'ez2', - 'ez3', - 'fdf', - 'mseed', - 'seed', - 'dataless', - 'gph', - 'ftc', - 'fm', - 'frame', - 'maker', - 'book', - 'fnc', - 'ltf', - 'fsc', - 'oas', - 'oa2', - 'oa3', - 'fg5', - 'bh2', - 'ddd', - 'xdw', - 'xbd', - 'fzs', - 'txd', - 'ggb', - 'ggt', - 'gex', - 'gre', - 'gxt', - 'g2w', - 'g3w', - 'gmx', - 'gdoc', - 'gslides', - 'gsheet', - 'kml', - 'kmz', - 'gqf', - 'gqs', - 'gac', - 'ghf', - 'gim', - 'grv', - 'gtm', - 'tpl', - 'vcg', - 'hal', - 'zmm', - 'hbci', - 'les', - 'hpgl', - 'hpid', - 'hps', - 'jlt', - 'pcl', - 'pclxl', - 'sfd-hdstx', - 'mpy', - 'afp', - 'listafp', - 'list3820', - 'irm', - 'sc', - 'icc', - 'icm', - 'igl', - 'ivp', - 'ivu', - 'igm', - 'xpw', - 'xpx', - 'i2g', - 'qbo', - 'qfx', - 'rcprofile', - 'irp', - 'xpr', - 'fcs', - 'jam', - 'rms', - 'jisp', - 'joda', - 'ktz', - 'ktr', - 'karbon', - 'chrt', - 'kfo', - 'flw', - 'kon', - 'kpr', - 'kpt', - 'ksp', - 'kwd', - 'kwt', - 'htke', - 'kia', - 'kne', - 'knp', - 'skp', - 'skd', - 'skt', - 'skm', - 'sse', - 'lasxml', - 'lbd', - 'lbe', - 'apr', - 'pre', - 'nsf', - 'org', - 'scm', - 'lwp', - 'portpkg', - 'mvt', - 'mcd', - 'mc1', - 'cdkey', - 'mwf', - 'mfm', - 'flo', - 'igx', - 'mif', - 'daf', - 'dis', - 'mbk', - 'mqy', - 'msl', - 'plc', - 'txf', - 'mpn', - 'mpc', - 'xul', - 'cil', - 'cab', - 'xls', - 'xlm', - 'xla', - 'xlc', - 'xlt', - 'xlw', - 'xlam', - 'xlsb', - 'xlsm', - 'xltm', - 'eot', - 'chm', - 'ims', - 'lrm', - 'thmx', - 'msg', - 'cat', - '*stl', - 'ppt', - 'pps', - 'pot', - 'ppam', - 'pptm', - 'sldm', - 'ppsm', - 'potm', - 'mpp', - 'mpt', - 'docm', - 'dotm', - 'wps', - 'wks', - 'wcm', - 'wdb', - 'wpl', - 'xps', - 'mseq', - 'mus', - 'msty', - 'taglet', - 'nlu', - 'ntf', - 'nitf', - 'nnd', - 'nns', - 'nnw', - '*ac', - 'ngdat', - 'n-gage', - 'rpst', - 'rpss', - 'edm', - 'edx', - 'ext', - 'odc', - 'otc', - 'odb', - 'odf', - 'odft', - 'odg', - 'otg', - 'odi', - 'oti', - 'odp', - 'otp', - 'ods', - 'ots', - 'odt', - 'odm', - 'ott', - 'oth', - 'xo', - 'dd2', - 'obgx', - 'oxt', - 'osm', - 'pptx', - 'sldx', - 'ppsx', - 'potx', - 'xlsx', - 'xltx', - 'docx', - 'dotx', - 'mgp', - 'dp', - 'esa', - 'pdb', - 'pqa', - 'oprc', - 'paw', - 'str', - 'ei6', - 'efif', - 'wg', - 'plf', - 'pbd', - 'box', - 'mgz', - 'qps', - 'ptid', - 'qxd', - 'qxt', - 'qwd', - 'qwt', - 'qxl', - 'qxb', - 'rar', - 'bed', - 'mxl', - 'musicxml', - 'cryptonote', - 'cod', - 'rm', - 'rmvb', - 'link66', - 'st', - 'see', - 'sema', - 'semd', - 'semf', - 'ifm', - 'itp', - 'iif', - 'ipk', - 'twd', - 'twds', - 'mmf', - 'teacher', - 'fo', - 'sdkm', - 'sdkd', - 'dxp', - 'sfs', - 'sdc', - 'sda', - 'sdd', - 'smf', - 'sdw', - 'vor', - 'sgl', - 'smzip', - 'sm', - 'wadl', - 'sxc', - 'stc', - 'sxd', - 'std', - 'sxi', - 'sti', - 'sxm', - 'sxw', - 'sxg', - 'stw', - 'sus', - 'susp', - 'svd', - 'sis', - 'sisx', - 'xsm', - 'bdm', - 'xdm', - 'ddf', - 'tao', - 'pcap', - 'cap', - 'dmp', - 'tmo', - 'tpt', - 'mxs', - 'tra', - 'ufd', - 'ufdl', - 'utz', - 'umj', - 'unityweb', - 'uoml', - 'vcx', - 'vsd', - 'vst', - 'vss', - 'vsw', - 'vis', - 'vsf', - 'wbxml', - 'wmlc', - 'wmlsc', - 'wtb', - 'nbp', - 'wpd', - 'wqd', - 'stf', - 'xar', - 'xfdl', - 'hvd', - 'hvs', - 'hvp', - 'osf', - 'osfpvg', - 'saf', - 'spf', - 'cmp', - 'zir', - 'zirz', - 'zaz', - '7z', - 'abw', - 'ace', - '*dmg', - 'arj', - 'aab', - 'x32', - 'u32', - 'vox', - 'aam', - 'aas', - 'bcpio', - '*bdoc', - 'torrent', - 'blb', - 'blorb', - 'bz', - 'bz2', - 'boz', - 'cbr', - 'cba', - 'cbt', - 'cbz', - 'cb7', - 'vcd', - 'cfs', - 'chat', - 'pgn', - 'crx', - 'cco', - 'nsc', - 'cpio', - 'csh', - '*deb', - 'udeb', - 'dgc', - 'dir', - 'dcr', - 'dxr', - 'cst', - 'cct', - 'cxt', - 'w3d', - 'fgd', - 'swa', - 'wad', - 'ncx', - 'dtb', - 'res', - 'dvi', - 'evy', - 'eva', - 'bdf', - 'gsf', - 'psf', - 'pcf', - 'snf', - 'pfa', - 'pfb', - 'pfm', - 'afm', - 'arc', - 'spl', - 'gca', - 'ulx', - 'gnumeric', - 'gramps', - 'gtar', - 'hdf', - 'php', - 'install', - '*iso', - '*key', - '*numbers', - '*pages', - 'jardiff', - 'jnlp', - 'kdbx', - 'latex', - 'luac', - 'lzh', - 'lha', - 'run', - 'mie', - 'prc', - 'mobi', - 'application', - 'lnk', - 'wmd', - 'wmz', - 'xbap', - 'mdb', - 'obd', - 'crd', - 'clp', - '*exe', - '*dll', - 'com', - 'bat', - '*msi', - 'mvb', - 'm13', - 'm14', - '*wmf', - '*wmz', - '*emf', - 'emz', - 'mny', - 'pub', - 'scd', - 'trm', - 'wri', - 'nc', - 'cdf', - 'pac', - 'nzb', - 'pl', - 'pm', - '*prc', - '*pdb', - 'p12', - 'pfx', - 'p7b', - 'spc', - 'p7r', - '*rar', - 'rpm', - 'ris', - 'sea', - 'sh', - 'shar', - 'swf', - 'xap', - 'sql', - 'sit', - 'sitx', - 'srt', - 'sv4cpio', - 'sv4crc', - 't3', - 'gam', - 'tar', - 'tcl', - 'tk', - 'tex', - 'tfm', - 'texinfo', - 'texi', - '*obj', - 'ustar', - 'hdd', - 'ova', - 'ovf', - 'vbox', - 'vbox-extpack', - 'vdi', - 'vhd', - 'vmdk', - 'src', - 'webapp', - 'der', - 'crt', - 'pem', - 'fig', - '*xlf', - 'xpi', - 'xz', - 'z1', - 'z2', - 'z3', - 'z4', - 'z5', - 'z6', - 'z7', - 'z8', - 'uva', - 'uvva', - 'eol', - 'dra', - 'dts', - 'dtshd', - 'lvp', - 'pya', - 'ecelp4800', - 'ecelp7470', - 'ecelp9600', - 'rip', - 'aac', - 'aif', - 'aiff', - 'aifc', - 'caf', - 'flac', - '*m4a', - 'mka', - 'm3u', - 'wax', - 'wma', - 'ram', - 'ra', - 'rmp', - '*ra', - 'cdx', - 'cif', - 'cmdf', - 'cml', - 'csml', - 'xyz', - 'btif', - 'pti', - 'psd', - 'azv', - 'uvi', - 'uvvi', - 'uvg', - 'uvvg', - 'djvu', - 'djv', - '*sub', - 'dwg', - 'dxf', - 'fbs', - 'fpx', - 'fst', - 'mmr', - 'rlc', - 'ico', - 'dds', - 'mdi', - 'wdp', - 'npx', - 'b16', - 'tap', - 'vtf', - 'wbmp', - 'xif', - 'pcx', - '3ds', - 'ras', - 'cmx', - 'fh', - 'fhc', - 'fh4', - 'fh5', - 'fh7', - '*ico', - 'jng', - 'sid', - '*bmp', - '*pcx', - 'pic', - 'pct', - 'pnm', - 'pbm', - 'pgm', - 'ppm', - 'rgb', - 'tga', - 'xbm', - 'xpm', - 'xwd', - 'wsc', - 'dae', - 'dwf', - 'gdl', - 'gtw', - 'mts', - 'ogex', - 'x_b', - 'x_t', - 'vds', - 'usdz', - 'bsp', - 'vtu', - 'dsc', - 'curl', - 'dcurl', - 'mcurl', - 'scurl', - 'sub', - 'fly', - 'flx', - 'gv', - '3dml', - 'spot', - 'jad', - 'wml', - 'wmls', - 's', - 'asm', - 'c', - 'cc', - 'cxx', - 'cpp', - 'h', - 'hh', - 'dic', - 'htc', - 'f', - 'for', - 'f77', - 'f90', - 'hbs', - 'java', - 'lua', - 'mkd', - 'nfo', - 'opml', - '*org', - 'p', - 'pas', - 'pde', - 'sass', - 'scss', - 'etx', - 'sfv', - 'ymp', - 'uu', - 'vcs', - 'vcf', - 'uvh', - 'uvvh', - 'uvm', - 'uvvm', - 'uvp', - 'uvvp', - 'uvs', - 'uvvs', - 'uvv', - 'uvvv', - 'dvb', - 'fvt', - 'mxu', - 'm4u', - 'pyv', - 'uvu', - 'uvvu', - 'viv', - 'f4v', - 'fli', - 'flv', - 'm4v', - 'mkv', - 'mk3d', - 'mks', - 'mng', - 'asf', - 'asx', - 'vob', - 'wm', - 'wmv', - 'wmx', - 'wvx', - 'avi', - 'movie', - 'smv', - 'ice', - 'mht', - null, - ], - example: 'pdf', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - example: 'application/pdf', - nullable: true, - }, - }, - }, - ForbiddenResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 403, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Forbidden resource', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - InternalServerErrorResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 500, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Internal server error', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - Interview: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - application_id: { - type: 'string', - nullable: true, - }, - remote_application_id: { - type: 'string', - description: "Provider's unique identifier of the application", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - interview_stage_id: { - type: 'string', - nullable: true, - }, - remote_interview_stage_id: { - type: 'string', - description: "Provider's unique identifier of the interview stage", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - interview_stage: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/InterviewStage', - }, - ], - }, - interview_status: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/InterviewStatusEnum', - }, - ], - }, - interviewer_ids: { - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - remote_interviewer_ids: { - description: "Provider's unique identifiers of the interviewers", - example: [ - 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - ], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - interview_parts: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/InterviewPart', - }, - }, - interviewers: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/Interviewer', - }, - }, - start_at: { - type: 'string', - description: 'Interview start date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - end_at: { - type: 'string', - description: 'Interview end date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - meeting_url: { - type: 'string', - nullable: true, - }, - created_at: { - type: 'string', - description: 'Interview created date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'Interview updated date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - Interviewer: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - first_name: { - type: 'string', - nullable: true, - }, - last_name: { - type: 'string', - nullable: true, - }, - name: { - type: 'string', - nullable: true, - }, - email: { - type: 'string', - nullable: true, - }, - }, - }, - InterviewPart: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - type: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/InterviewTypeEnum', - }, - ], - }, - title: { - type: 'string', - description: - 'The title of interview, usually corresponding to the title of an associated calendar event', - example: 'Interview (Informal Interview) - Elon and StackOne', - nullable: true, - }, - interviewer_ids: { - description: 'The user (interviewer) IDs taking part in this specific interview.', - example: ['cx28iQahdfDHa', 'cx28iQokkD78das'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - remote_interviewer_ids: { - description: - "Provider's user (interviewer) IDs taking part in this specific interview.", - example: ['cx28iQahdfDHa', 'cx28iQokkD78das'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - meeting_url: { - type: 'string', - description: - 'The meeting URL for the interview - this may be populated using the underlying location if the location string extracted is a valid url.', - example: 'zoomus://zoom.us/join?confno=123456789', - nullable: true, - }, - meeting_provider: { - type: 'string', - description: 'The video meeting provider used for the interview.', - example: 'zoom', - nullable: true, - }, - start_at: { - type: 'string', - description: "The specific interview part's start date", - example: '2021-01-01T17:00:00.000Z', - format: 'date-time', - nullable: true, - }, - end_at: { - type: 'string', - description: "The specific interview part's end date", - example: '2021-01-01T18:00:00.000Z', - format: 'date-time', - nullable: true, - }, - created_at: { - type: 'string', - description: 'Interview part created date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'Interview part updated date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - InterviewsPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/Interview', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - InterviewsResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/Interview', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - InterviewStage: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - name: { - type: 'string', - nullable: true, - }, - order: { - type: 'number', - nullable: true, - }, - created_at: { - type: 'string', - description: 'Interview Stage created date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'Interview Stage updated date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - InterviewStageResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/InterviewStage', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - InterviewStagesPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/InterviewStage', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - InterviewStatusEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'unscheduled', - 'scheduled', - 'completed', - 'cancelled', - 'pending_feedback', - 'unmapped_value', - null, - ], - description: 'The status of the interview.', - example: 'unscheduled', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the interview status.', - example: 'Unscheduled', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - InterviewTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'screening', - 'lunch', - 'on_site', - 'presentation', - 'sell', - 'culture', - 'informal', - 'test', - 'phone', - 'video', - 'unmapped_value', - null, - ], - description: 'The type of the interview.', - example: 'on_site', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the interview type.', - example: 'Onsite Interview', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - JobPosting: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - title: { - type: 'string', - example: 'Software Engineer', - nullable: true, - }, - locations: { - example: [ - { - id: '12345', - name: 'New York', - }, - { - id: '67890', - name: 'Remote', - }, - ], - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/JobPostingLocation', - }, - }, - internal: { - type: 'string', - enum: ['true', 'false', 'unmapped_value', null], - example: 'true', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - status: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/JobPostingStatusEnum', - }, - ], - }, - job_id: { - type: 'string', - example: 'job001', - nullable: true, - }, - remote_job_id: { - type: 'string', - description: "Provider's unique identifier of the job", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - content: { - example: { - plain: 'This is a plain text description', - html: '

This is an HTML description

', - }, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/JobPostingContent', - }, - ], - }, - compensation: { - example: [ - { - title: 'Base Salary', - type: 'salary', - pay_period: 'month', - pay_frequency: 'yearly', - currency: 'USD', - value: '50000', - min_value_range: '45000', - max_value_range: '55000', - }, - { - title: 'Bonus', - type: 'bonus', - pay_frequency: 'quarterly', - currency: 'USD', - value: '10%', - }, - ], - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/JobPostingCompensation', - }, - }, - employment_type: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/EmploymentTypeEnum', - }, - ], - }, - employment_contract_type: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/EmploymentContractTypeEnum', - }, - ], - }, - external_url: { - type: 'string', - example: 'https://www.example.com/job-posting/abcd1234', - nullable: true, - }, - external_apply_url: { - type: 'string', - example: 'https://www.example.com/job-posting/abcd1234/apply', - nullable: true, - }, - questionnaires: { - example: [ - { - id: 'about001', - name: 'About', - internal: 'false', - questions: [ - { - id: 'question001', - text: 'What is your name?', - type: 'short_text', - required: true, - parent_question: null, - }, - { - id: 'question002', - text: 'What are your hobbies?', - type: 'long_text', - required: false, - parent_question: null, - }, - { - id: 'question003', - text: 'What is your favourite animal?', - type: 'single_select', - required: true, - multiple_choice_answers: [ - { - id: '1', - text: 'Dog', - }, - { - id: '2', - text: 'Cat', - }, - { - id: '3', - text: 'Bird', - }, - { - id: '4', - text: 'Other', - }, - ], - parent_question: null, - }, - { - id: 'question004', - text: 'Do you have previous work experience??', - type: 'single_select', - required: true, - multiple_choice_answers: [ - { - id: '1', - text: 'Yes', - }, - { - id: '2', - text: 'No', - }, - ], - parent_question: null, - }, - { - id: 'question005', - text: 'What was the duration of your last employment?', - type: 'single_select', - required: true, - multiple_choice_answers: [ - { - id: '1', - text: 'Less than 1 year', - }, - { - id: '2', - text: '1-2 years', - }, - { - id: '2', - text: 'More than 2 year', - }, - ], - parent_question: { - id: 'question004', - option_ids: ['1'], - condition_type: 'equals_to', - }, - }, - ], - }, - { - id: 'experience001', - name: 'Experience', - internal: 'false', - questions: [ - { - id: 'question004', - text: 'Please upload your resume.', - type: 'attachment', - parent_question: null, - required: true, - }, - { - id: 'question005', - text: 'Select the programming languages you are proficient in.', - type: 'multi_select', - multiple_choice_answers: [ - { - id: '1', - text: 'JavaScript', - }, - { - id: '2', - text: 'Python', - }, - { - id: '3', - text: 'Java', - }, - ], - parent_question: null, - required: true, - }, - { - id: 'question006', - text: 'Are you willing to relocate?', - type: 'boolean', - parent_question: null, - }, - { - id: 'question007', - text: 'How many years of experience do you have?', - type: 'number', - parent_question: null, - }, - { - id: 'question008', - text: 'When did you start your most recent position?', - type: 'date', - parent_question: null, - }, - { - id: 'question009', - text: 'Do you have Project Management Experience?', - type: 'single_select', - multiple_choice_answers: [ - { - id: '1', - text: 'Yes', - }, - { - id: '2', - text: 'No', - }, - ], - parent_question: null, - required: true, - }, - { - id: 'question010', - text: 'How much Project Management experience do you have?', - type: 'single_select', - multiple_choice_answers: [ - { - id: '1', - text: '1-3 years', - }, - { - id: '2', - text: '3-5 years', - }, - { - id: '3', - text: '5-10 years', - }, - { - id: '4', - text: 'More than 10 years', - }, - ], - parent_question: { - id: 'question009', - option_ids: ['1'], - condition_type: 'equals_to', - }, - }, - ], - }, - ], - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/JobPostingQuestionnaire', - }, - }, - start_date: { - type: 'string', - description: 'The posting start date', - example: '2021-01-01T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - created_at: { - type: 'string', - description: 'Date of creation', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'Date of last update', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - JobPostingCompensation: { - type: 'object', - properties: { - title: { - type: 'string', - nullable: true, - }, - type: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/CompensationTypeEnum', - }, - ], - }, - pay_period: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/PayPeriodEnum', - }, - ], - }, - pay_frequency: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/PayFrequencyEnum', - }, - ], - }, - currency: { - type: 'string', - nullable: true, - }, - value: { - type: 'string', - nullable: true, - }, - min_value_range: { - type: 'string', - nullable: true, - }, - max_value_range: { - type: 'string', - nullable: true, - }, - }, - }, - JobPostingContent: { - type: 'object', - properties: { - plain: { - type: 'string', - nullable: true, - }, - html: { - type: 'string', - nullable: true, - }, - sections: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/JobPostingContentSection', - }, - }, - }, - }, - JobPostingContentSection: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - type: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/AssessmentTypeEnum', - }, - ], - }, - label: { - type: 'string', - example: 'Key Responsibilities', - nullable: true, - }, - content: { - type: 'string', - example: 'This is a plain description', - nullable: true, - }, - }, - }, - JobPostingLocation: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - nullable: true, - }, - }, - }, - JobPostingQuestionnaire: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - nullable: true, - }, - internal: { - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - questions: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/Question', - }, - }, - }, - }, - JobPostingResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/JobPosting', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - JobPostingsPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/JobPosting', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - JobPostingStatusEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'live', - 'draft', - 'pending', - 'internal', - 'rejected', - 'closed', - 'archived', - 'unmapped_value', - null, - ], - description: 'The status of the job postings.', - example: 'live', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the job postings status.', - example: 'Live', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - List: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - name: { - type: 'string', - nullable: true, - }, - items: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/ListItem', - }, - }, - created_at: { - type: 'string', - description: 'Timestamp when the list was created', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'Timestamp when the list was last updated', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - type: { - description: 'The list type', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ListTypeEnum', - }, - ], - }, - }, - }, - ListItem: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - }, - }, - ListResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/List', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - ListsPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/List', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - ListTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: ['candidates', 'contacts', 'companies', 'unmapped_value', null], - description: 'The type of the list.', - example: 'contacts', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the list type.', - example: 'Contacts', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - MoveApplicationResult: { - type: 'object', - properties: { - statusCode: { - type: 'number', - example: 200, - }, - message: { - type: 'string', - example: 'Application moved successfully.', - }, - timestamp: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - }, - data: { - $ref: '#/components/schemas/CreateResultDataApiModel', - }, - }, - required: ['statusCode', 'message', 'timestamp', 'data'], - }, - Note: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - content: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/NoteContentApiModel', - }, - }, - author_id: { - type: 'string', - description: 'Unique identifier of the author', - example: '1234567890', - nullable: true, - }, - remote_author_id: { - type: 'string', - description: "Provider's unique identifier of the author", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - visibility: { - description: 'Visibility of the note', - example: 'public', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/NotesVisibilityEnum', - }, - ], - }, - created_at: { - type: 'string', - description: 'Date of creation', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'Date of last update', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - deleted_at: { - type: 'string', - description: 'Date of Deletion', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - NoteContentApiModel: { - type: 'object', - properties: { - body: { - type: 'string', - description: 'Body of the note', - example: 'This candidate seems like a good fit for the role', - nullable: true, - }, - }, - }, - NoteResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/Note', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - NotesPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/Note', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - NotesVisibilityEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: ['private', 'public', 'unmapped_value', null], - description: 'The visibility of the notes.', - example: 'public', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the notes visibility.', - example: 'Public', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - NotFoundResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 404, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Not Found', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - NotImplementedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 501, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Not Implemented', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - Offer: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - application_id: { - type: 'string', - nullable: true, - }, - remote_application_id: { - type: 'string', - description: "Provider's unique identifier of the application", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - start_date: { - type: 'string', - description: 'Date of creation', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - offer_status: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/OfferStatusEnum', - }, - ], - }, - salary: { - type: 'number', - nullable: true, - }, - currency: { - type: 'string', - nullable: true, - }, - created_at: { - type: 'string', - description: 'Date of creation', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'Date of last update', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - offer_history: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/OfferHistory', - }, - }, - }, - }, - OfferHistory: { - type: 'object', - properties: { - start_date: { - type: 'string', - description: 'Start Date of the offer', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - salary: { - type: 'number', - nullable: true, - }, - currency: { - type: 'string', - nullable: true, - }, - created_at: { - type: 'string', - description: 'Date of creation', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'Date of last update', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - OffersPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/Offer', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - OffersResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/Offer', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - OfferStatusEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'pending', - 'retracted', - 'accepted', - 'rejected', - 'created', - 'approved', - 'not_approved', - 'unmapped_value', - null, - ], - description: 'The status of the offer.', - example: 'pending', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the offer status.', - example: 'Pending', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - OrderApplicationApiModel: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - application_status: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ApplicationStatusEnum', - }, - ], - }, - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - }, - }, - OrderBackgroundCheckPackageApiModel: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'Package name', - example: 'Test 1', - nullable: true, - }, - description: { - type: 'string', - description: 'Package description', - example: "Skills test to gauge a candidate's proficiency in job-specific skills", - nullable: true, - }, - tests: { - description: 'Package tests', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/Package', - }, - }, - }, - }, - OrderCandidateApiModel: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - first_name: { - type: 'string', - description: 'Candidate first name', - example: 'Romain', - nullable: true, - }, - last_name: { - type: 'string', - description: 'Candidate last name', - example: 'Sestier', - nullable: true, - }, - emails: { - description: 'List of candidate emails', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CandidateEmail', - }, - }, - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - profile_url: { - type: 'string', - description: 'Candidate profile url', - example: 'https://exmaple.com/candidate?id=xyz', - nullable: true, - }, - }, - }, - OrderJobApiModel: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - title: { - type: 'string', - description: 'Title of the job', - example: 'Software Engineer', - nullable: true, - }, - hiring_team: { - description: 'Hiring team for the job.', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/AtsJobHiringTeam', - }, - }, - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - }, - }, - OrderJobHiringTeamApiModel: { - type: 'object', - properties: { - user_id: { - type: 'string', - example: '123456', - description: 'User ID of the hiring team member.', - nullable: true, - }, - remote_user_id: { - type: 'string', - description: "Provider's unique identifier of the user", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - first_name: { - type: 'string', - example: 'John', - description: 'First name of the hiring team member.', - nullable: true, - }, - last_name: { - type: 'string', - example: 'Doe', - description: 'Last name of the hiring team member.', - nullable: true, - }, - email: { - type: 'string', - example: 'john.doe@gmail.com', - description: 'Email of the hiring team member.', - nullable: true, - }, - role: { - type: 'string', - example: 'Software Engineer', - description: 'Role of the hiring team member.', - nullable: true, - }, - }, - }, - OrderPackageApiModel: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'Package name', - example: 'Test 1', - nullable: true, - }, - description: { - type: 'string', - description: 'Package description', - example: "Skills test to gauge a candidate's proficiency in job-specific skills", - nullable: true, - }, - }, - }, - Package: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'Package name', - example: 'Test 1', - nullable: true, - }, - description: { - type: 'string', - description: 'Package description', - example: "Skills test to gauge a candidate's proficiency in job-specific skills", - nullable: true, - }, - }, - }, - ParentQuestion: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - option_ids: { - description: "List of parent questions's option IDs", - example: [ - '123e4567-e89b-12d3-a456-426614174000', - '523e1234-e89b-fdd2-a456-762545121101', - ], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - remote_option_ids: { - description: "Provider's list of parent questions's option IDs", - example: [ - '123e4567-e89b-12d3-a456-426614174000', - '523e1234-e89b-fdd2-a456-762545121101', - ], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - condition_type: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ConditionTypeEnum', - }, - ], - }, - }, - }, - PayFrequencyEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'hourly', - 'weekly', - 'bi_weekly', - 'four_weekly', - 'semi_monthly', - 'monthly', - 'bi_monthly', - 'quarterly', - 'semi_annually', - 'yearly', - 'thirteen_monthly', - 'pro_rata', - 'unmapped_value', - 'half_yearly', - 'daily', - null, - ], - description: 'The pay frequency of the job postings.', - example: 'hourly', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the pay frequency.', - example: 'Hourly', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - PayPeriodEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'hour', - 'day', - 'week', - 'every_two_weeks', - 'month', - 'twice_a_month', - 'every_two_months', - 'quarter', - 'every_six_months', - 'year', - 'one_off', - 'none', - 'unmapped_value', - null, - ], - description: 'The pay period of the job postings.', - example: 'hour', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the pay period.', - example: 'Hour', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - PhoneNumber: { - type: 'object', - properties: { - type: { - type: 'string', - description: 'Type of phone number', - enum: [ - 'personal', - 'work', - 'mobile', - 'home', - 'unknown', - 'other', - 'unmapped_value', - null, - ], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - phone: { - type: 'string', - description: 'Phone number string', - example: '+447700112233', - nullable: true, - }, - }, - }, - PreconditionFailedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 412, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Precondition failed', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - ProviderError: { - type: 'object', - properties: { - status: { - type: 'number', - description: 'HTTP status code of the provider error', - example: 400, - nullable: true, - }, - url: { - type: 'string', - description: 'URL that caused the error', - example: 'https://api.provider.com/v1/resource', - nullable: true, - }, - raw: { - type: 'object', - description: 'Raw error response from the provider', - example: { - message: 'Invalid input parameters', - }, - nullable: true, - }, - headers: { - type: 'object', - description: 'Response headers', - example: { - 'content-type': 'application/json', - 'x-request-id': '5678c28b211dace4e0a0f9171e6b88c5', - }, - nullable: true, - }, - }, - }, - ProviderErrorApiModel: { - type: 'object', - properties: { - status: { - type: 'number', - example: 400, - nullable: true, - }, - url: { - type: 'string', - example: 'https://api.someprovider.com/v1/endpoint', - nullable: true, - }, - raw: { - type: 'object', - nullable: true, - }, - headers: { - type: 'object', - example: { - date: 'Tue, 02 Apr 2024 13:52:01 GMT', - 'content-type': 'application/json; charset=utf-8', - 'transfer-encoding': 'chunked', - connection: 'close', - }, - nullable: true, - }, - }, - }, - Question: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - nullable: true, - }, - type: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/QuestionsTypeEnum', - }, - ], - }, - text: { - type: 'string', - nullable: true, - }, - required: { - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - multiple_choice_answers: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/QuestionMultipleChoiceAnswers', - }, - }, - parent_question: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ParentQuestion', - }, - ], - }, - }, - }, - QuestionMultipleChoiceAnswers: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - text: { - type: 'string', - nullable: true, - }, - }, - }, - Questionnaire: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - answers: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/Answer', - }, - }, - }, - }, - QuestionsTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'short_text', - 'long_text', - 'attachment', - 'multi_select', - 'single_select', - 'boolean', - 'number', - 'date', - 'video', - 'reference_check', - 'url', - 'unmapped_value', - null, - ], - description: 'The type of the questions.', - example: 'short_text', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the questions type.', - example: 'ShortText', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - RawResponse: { - type: 'object', - properties: { - method: { - type: 'string', - }, - url: { - type: 'string', - }, - body: { - oneOf: [ - { - type: 'string', - }, - { - type: 'object', - }, - { - type: 'array', - items: { - type: 'integer', - format: 'int32', - minimum: 0, - maximum: 255, - }, - }, - ], - additionalProperties: true, - nullable: true, - }, - response: { - oneOf: [ - { - type: 'object', - additionalProperties: true, - }, - { - type: 'array', - items: {}, - }, - { - type: 'string', - }, - ], - nullable: true, - }, - }, - required: ['method', 'url'], - }, - Reference: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'The reference id', - example: '1687-3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'The reference name', - example: '1687-4', - nullable: true, - }, - active: { - description: 'The reference status', - example: true, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - }, - }, - ReferencePaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/Reference', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - ReferenceResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/Reference', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - RejectApplicationResult: { - type: 'object', - properties: { - statusCode: { - type: 'number', - example: 200, - }, - message: { - type: 'string', - example: 'Application rejected successfully.', - }, - timestamp: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - }, - data: { - $ref: '#/components/schemas/CreateResultDataApiModel', - }, - }, - required: ['statusCode', 'message', 'timestamp', 'data'], - }, - RejectedReason: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - label: { - type: 'string', - description: 'The label of the rejected reason.', - example: 'Failed Phone Screen', - nullable: true, - }, - type: { - type: 'string', - description: 'The string type of the rejected reason.', - example: 'rejected_by_organization', - deprecated: true, - nullable: true, - }, - rejected_reason_type: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/RejectedReasonTypeEnum', - }, - ], - }, - }, - }, - RejectedReasonResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/RejectedReason', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - RejectedReasonsPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/RejectedReason', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - RejectedReasonTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'rejected_by_candidate', - 'rejected_by_organization', - 'other', - 'unknown', - 'unmapped_value', - null, - ], - description: 'The type of the rejected reason.', - example: 'rejected_by_organization', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the rejected reason type.', - example: 'RejectedByOrg', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - RequestTimedOutResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 408, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Request timed out', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - ResultEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'initiated', - 'in_progress', - 'cancelled', - 'completed', - 'expired', - 'failed', - 'passed', - 'unmapped_value', - null, - ], - description: 'The result of the test.', - example: 'passed', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the test result.', - example: 'Passed', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - ResultLink: { - type: 'object', - properties: { - label: { - type: 'string', - description: 'The label of the result link.', - example: 'test result link', - nullable: true, - }, - url: { - type: 'string', - description: 'The URL of the result link.', - example: 'http://example.com/test-result/4565765/data', - nullable: true, - }, - }, - }, - ScheduledInterview: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - application_id: { - type: 'string', - nullable: true, - }, - remote_application_id: { - type: 'string', - description: "Provider's unique identifier of the application", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - interview_stage_id: { - type: 'string', - nullable: true, - }, - remote_interview_stage_id: { - type: 'string', - description: "Provider's unique identifier of the interview stage", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - interview_stage: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/InterviewStage', - }, - ], - }, - interview_status: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/InterviewStatusEnum', - }, - ], - }, - interviewer_ids: { - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - remote_interviewer_ids: { - description: "Provider's unique identifiers of the interviewers", - example: [ - 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - ], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - interview_parts: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/InterviewPart', - }, - }, - interviewers: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/Interviewer', - }, - }, - start_at: { - type: 'string', - description: 'Interview start date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - end_at: { - type: 'string', - description: 'Interview end date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - meeting_url: { - type: 'string', - nullable: true, - }, - created_at: { - type: 'string', - description: 'Interview created date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'Interview updated date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - ScheduledInterviewsPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/ScheduledInterview', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - ScheduledInterviewsResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/ScheduledInterview', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - ScoreApiModel: { - type: 'object', - properties: { - label: { - type: 'string', - description: 'The label of the score', - example: 'Percentage', - nullable: true, - }, - value: { - type: 'string', - description: 'The value is the actual score', - example: '80', - nullable: true, - }, - min: { - type: 'string', - description: 'The minimum value of the score', - example: '0', - nullable: true, - }, - max: { - type: 'string', - description: 'The maximum value of the score', - example: '100', - nullable: true, - }, - }, - }, - Scorecard: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - sections: { - description: 'The sections in the scorecard', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/ScorecardSection', - }, - }, - label: { - type: 'string', - description: 'The label of the scorecard', - example: 'Technical Interview', - nullable: true, - }, - candidate_id: { - type: 'string', - description: 'The candidate ID associated with the scorecard', - example: '5678-9', - nullable: true, - }, - remote_candidate_id: { - type: 'string', - description: "Provider's unique identifier of the candidate", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - application_id: { - type: 'string', - description: 'The application ID associated with the scorecard', - example: '1011-12', - nullable: true, - }, - remote_application_id: { - type: 'string', - description: "Provider's unique identifier of the application", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - interview_id: { - type: 'string', - description: 'The interview ID associated with the scorecard', - example: '1314-15', - nullable: true, - }, - remote_interview_id: { - type: 'string', - description: "Provider's unique identifier of the interview", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - author_id: { - type: 'string', - description: 'The author ID of the scorecard', - example: '1617-18', - nullable: true, - }, - remote_author_id: { - type: 'string', - description: "Provider's unique identifier of the author", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - overall_recommendation: { - type: 'string', - description: 'The overall recommendation', - example: 'recommended', - enum: ['strong_yes', 'yes', 'no', 'strong_no', 'no_decision', 'unmapped_value', null], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - created_at: { - type: 'string', - description: 'The creation date of the scorecard', - example: '2021-01-01T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The update date of the scorecard', - example: '2021-01-01T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - ScorecardSection: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - label: { - type: 'string', - description: 'The label of the section', - example: 'Technical Skills', - nullable: true, - }, - fields: { - description: 'The fields within the section', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/Field', - }, - }, - }, - }, - ScorecardsPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/Scorecard', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - ScorecardsResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/Scorecard', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - SocialLink: { - type: 'object', - properties: { - type: { - type: 'string', - description: 'Type of the social link', - example: 'linkedin', - nullable: true, - }, - url: { - type: 'string', - description: 'URL of the social link', - example: 'https://www.linkedin.com/in/romainsestier/', - nullable: true, - }, - }, - }, - Source: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'The source of the application', - example: 'LinkedIn', - nullable: true, - }, - }, - }, - Tag: { - type: 'object', - properties: { - remote_id: { - type: 'string', - description: 'Remote ID of the tag', - example: '123e4567-e89b-12d3-a456-426614174000', - nullable: true, - }, - name: { - type: 'string', - description: 'Name of the tag', - example: 'Gold Medalist', - nullable: true, - }, - }, - }, - TooManyRequestsResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 429, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Too many requests', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - UnauthorizedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 401, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Unauthorized', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - UnifiedError: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 400, - nullable: true, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Request', - nullable: true, - }, - headers: { - type: 'object', - description: 'Response headers', - example: { - 'content-type': 'application/json', - 'x-request-id': '5678c28b211dace4e0a0f9171e6b88c5', - }, - nullable: true, - }, - }, - }, - UnifiedWarningApiModel: { - type: 'object', - properties: { - message: { - type: 'string', - example: 'The provided field type is not supported in the current model.', - nullable: true, - }, - }, - }, - UnprocessableEntityResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 422, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Unprocessable Entity', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - UpdatePackage: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'Package name', - example: 'Test 1', - nullable: true, - }, - description: { - type: 'string', - description: 'Package description', - example: "Skills test to gauge a candidate's proficiency in job-specific skills", - nullable: true, - }, - }, - }, - UpdateResult: { - type: 'object', - properties: { - statusCode: { - type: 'number', - example: 200, - }, - message: { - type: 'string', - example: 'Record updated successfully.', - }, - timestamp: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - UpdateResultCandidateApiModel: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - profile_url: { - type: 'string', - description: 'Candidate profile url', - example: 'https://exmaple.com/candidate?id=xyz', - nullable: true, - }, - }, - }, - User: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - email: { - type: 'string', - nullable: true, - }, - first_name: { - type: 'string', - nullable: true, - }, - last_name: { - type: 'string', - nullable: true, - }, - name: { - type: 'string', - nullable: true, - }, - phone: { - type: 'string', - nullable: true, - }, - }, - }, - UserResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/User', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - UsersPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/User', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - WriteResultApiModel: { - type: 'object', - properties: { - statusCode: { - type: 'number', - example: 201, - nullable: true, - }, - message: { - type: 'string', - example: 'Employee created successfully', - nullable: true, - }, - timestamp: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - provider_errors: { - example: [ - { - status: 400, - url: 'https://api.someprovider.com/v1/endpoint', - raw: { - error: 'Bad Request', - message: 'The supplied data is invalid', - }, - headers: { - date: 'Tue, 02 Apr 2024 13:52:01 GMT', - 'content-type': 'application/json; charset=utf-8', - 'transfer-encoding': 'chunked', - connection: 'close', - }, - }, - ], - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/ProviderErrorApiModel', - }, - }, - unified_warnings: { - example: [ - { - message: 'The provided field type is not supported in the current model.', - }, - ], - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/UnifiedWarningApiModel', - }, - }, - }, - }, - }, - }, -}; diff --git a/src/openapi/generated/crm.ts b/src/openapi/generated/crm.ts deleted file mode 100644 index 79fc4ec1..00000000 --- a/src/openapi/generated/crm.ts +++ /dev/null @@ -1,4050 +0,0 @@ -// Generated OpenAPI specification for crm -// DO NOT EDIT THIS FILE DIRECTLY -export const crmSpec = { - openapi: '3.1.0', - paths: { - '/unified/crm/contacts': { - get: { - operationId: 'crm_list_contacts', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,first_name,last_name,company_name,emails,phone_numbers,deal_ids,remote_deal_ids,account_ids,remote_account_ids,custom_fields,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'include', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be included in the response', - schema: { - nullable: true, - example: 'custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of contacts was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ContactsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Contacts', - tags: ['Contacts'], - 'x-speakeasy-group': 'crm', - 'x-speakeasy-name-override': 'list_contacts', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - post: { - operationId: 'crm_create_contact', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CrmCreateContactRequestDto', - }, - }, - }, - }, - responses: { - '200': { - description: 'The contact was successfully created.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ContactResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Create Contact', - tags: ['Contacts'], - 'x-speakeasy-group': 'crm', - 'x-speakeasy-name-override': 'create_contact', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/crm/contacts/{id}': { - get: { - operationId: 'crm_get_contact', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,first_name,last_name,company_name,emails,phone_numbers,deal_ids,remote_deal_ids,account_ids,remote_account_ids,custom_fields,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'include', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be included in the response', - schema: { - nullable: true, - example: 'custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The contact with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ContactResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Contact', - tags: ['Contacts'], - 'x-speakeasy-group': 'crm', - 'x-speakeasy-name-override': 'get_contact', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - patch: { - operationId: 'crm_update_contact', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CrmCreateContactRequestDto', - }, - }, - }, - }, - responses: { - '200': { - description: 'The contact was successfully updated.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ContactResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Update Contact (early access)', - tags: ['Contacts'], - 'x-speakeasy-group': 'crm', - 'x-speakeasy-name-override': 'update_contact', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/crm/accounts': { - get: { - operationId: 'crm_list_accounts', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,owner_id,remote_owner_id,name,description,industries,annual_revenue,website,addresses,phone_numbers,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of accounts was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AccountsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Accounts', - tags: ['Accounts'], - 'x-speakeasy-group': 'crm', - 'x-speakeasy-name-override': 'list_accounts', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/crm/accounts/{id}': { - get: { - operationId: 'crm_get_account', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,owner_id,remote_owner_id,name,description,industries,annual_revenue,website,addresses,phone_numbers,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The account with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AccountResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Account', - tags: ['Accounts'], - 'x-speakeasy-group': 'crm', - 'x-speakeasy-name-override': 'get_account', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/crm/lists': { - get: { - operationId: 'crm_list_lists', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,created_at,updated_at,items,type,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The collection of lists was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ListsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get all Lists', - tags: ['Lists'], - 'x-speakeasy-group': 'crm', - 'x-speakeasy-name-override': 'list_lists', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/crm/lists/{id}': { - get: { - operationId: 'crm_get_list', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,created_at,updated_at,items,type,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ListResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get List', - tags: ['Lists'], - 'x-speakeasy-group': 'crm', - 'x-speakeasy-name-override': 'get_list', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/crm/custom_field_definitions/contacts': { - get: { - operationId: 'crm_list_contact_custom_field_definitions', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,description,type,options,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of contacts custom field definitions was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CustomFieldDefinitionsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Contact Custom Field Definitions', - tags: ['Custom Field Definitions'], - 'x-speakeasy-group': 'crm', - 'x-speakeasy-name-override': 'list_contact_custom_field_definitions', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/crm/custom_field_definitions/contacts/{id}': { - get: { - operationId: 'crm_get_contact_custom_field_definition', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,description,type,options,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The contact custom field definition was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CustomFieldDefinitionResultApiModel', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Contact Custom Field Definition', - tags: ['Custom Field Definitions'], - 'x-speakeasy-group': 'crm', - 'x-speakeasy-name-override': 'get_contact_custom_field_definition', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - }, - info: { - title: 'CRM', - description: 'The documentation for the StackOne Unified API - CRM', - version: '1.0.0', - contact: {}, - }, - tags: [ - { - name: 'Accounts', - description: 'Customer or business accounts.', - }, - { - name: 'Contacts', - description: 'People or organizations that can be contacted.', - }, - { - name: 'Custom Field Definitions', - description: 'Definitions for custom fields on CRM resources.', - }, - { - name: 'Lists', - description: 'Lists for organizing contacts or accounts.', - }, - ], - servers: [ - { - url: 'https://api.stackone.com', - }, - ], - components: { - securitySchemes: { - basic: { - type: 'http', - scheme: 'basic', - }, - }, - schemas: { - Account: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - owner_id: { - type: 'string', - nullable: true, - }, - remote_owner_id: { - type: 'string', - description: "Provider's unique identifier of the owner", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - name: { - type: 'string', - nullable: true, - }, - description: { - type: 'string', - nullable: true, - }, - industries: { - description: 'Values of the industries', - example: [ - 'Information Technology', - 'Airlines & Airports', - 'Personal Care & Household Products', - ], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - annual_revenue: { - type: 'string', - nullable: true, - }, - website: { - type: 'string', - nullable: true, - }, - addresses: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/AccountAddress', - }, - }, - phone_numbers: { - description: 'List of account phone numbers', - example: ['+1123425334'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - created_at: { - type: 'string', - description: 'Timestamp when the account was created', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'Timestamp when the account was last updated', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - AccountAddress: { - type: 'object', - properties: { - street_1: { - type: 'string', - nullable: true, - }, - street_2: { - type: 'string', - nullable: true, - }, - city: { - type: 'string', - nullable: true, - }, - state: { - type: 'string', - nullable: true, - }, - zip_code: { - type: 'string', - nullable: true, - }, - country: { - description: 'The country code', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/CountryEnum', - }, - ], - }, - location_type: { - description: 'The location type', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/LocationTypeEnum', - }, - ], - }, - }, - }, - AccountResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/Account', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - AccountsPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/Account', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - BadGatewayResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 502, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Gateway', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - BadRequestResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 400, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Request', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - data: { - description: 'Error details', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/UnifiedError', - }, - ], - }, - provider_errors: { - description: 'List of provider-specific errors', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/ProviderError', - }, - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - ConflictResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 409, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Conflict', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - Contact: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - first_name: { - type: 'string', - description: 'The contact first name', - example: 'Steve', - nullable: true, - }, - last_name: { - type: 'string', - description: 'The contact last name', - example: 'Wozniak', - nullable: true, - }, - company_name: { - type: 'string', - description: 'The contact company name', - example: 'Apple Inc.', - nullable: true, - }, - emails: { - description: 'List of contact email addresses', - example: ['steve@apple.com'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - phone_numbers: { - description: 'List of contact phone numbers', - example: ['123-456-7890'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - deal_ids: { - description: 'List of associated deal IDs', - example: ['deal-001', 'deal-002'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - remote_deal_ids: { - description: "Provider's list of associated deal IDs", - example: [ - 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - 'e3cb75bf-aa84-466e-a6c1-b8322b257a49', - ], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - account_ids: { - description: 'List of associated account IDs', - example: ['account-123', 'account-456'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - remote_account_ids: { - description: "Provider's list of associated account IDs", - example: [ - 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - 'e3cb75bf-aa84-466e-a6c1-b8322b257a49', - ], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - custom_fields: { - description: 'Contact custom fields', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CustomFields', - }, - }, - created_at: { - type: 'string', - description: 'Timestamp when the contact was created', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'Timestamp when the contact was last updated', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - ContactResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/Contact', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - ContactsPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/Contact', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - CountryEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'AF', - 'AL', - 'DZ', - 'AS', - 'AD', - 'AO', - 'AI', - 'AQ', - 'AG', - 'AR', - 'AM', - 'AW', - 'AU', - 'AT', - 'AZ', - 'BS', - 'BH', - 'BD', - 'BB', - 'BY', - 'BE', - 'BZ', - 'BJ', - 'BM', - 'BT', - 'BO', - 'BQ', - 'BA', - 'BW', - 'BV', - 'BR', - 'IO', - 'BN', - 'BG', - 'BF', - 'BI', - 'KH', - 'CM', - 'CA', - 'CV', - 'KY', - 'CF', - 'TD', - 'CL', - 'CN', - 'CX', - 'CC', - 'CO', - 'KM', - 'CG', - 'CD', - 'CK', - 'CR', - 'HR', - 'CU', - 'CW', - 'CY', - 'CZ', - 'CI', - 'DK', - 'DJ', - 'DM', - 'DO', - 'EC', - 'EG', - 'SV', - 'GQ', - 'ER', - 'EE', - 'ET', - 'FK', - 'FO', - 'FJ', - 'FI', - 'FR', - 'GF', - 'PF', - 'TF', - 'GA', - 'GM', - 'GE', - 'DE', - 'GH', - 'GI', - 'GR', - 'GL', - 'GD', - 'GP', - 'GU', - 'GT', - 'GG', - 'GN', - 'GW', - 'GY', - 'HT', - 'HM', - 'VA', - 'HN', - 'HK', - 'HU', - 'IS', - 'IN', - 'ID', - 'IR', - 'IQ', - 'IE', - 'IM', - 'IL', - 'IT', - 'JM', - 'JP', - 'JE', - 'JO', - 'KZ', - 'KE', - 'KI', - 'KP', - 'KR', - 'KW', - 'KG', - 'LA', - 'LV', - 'LB', - 'LS', - 'LR', - 'LY', - 'LI', - 'LT', - 'LU', - 'MO', - 'MK', - 'MG', - 'MW', - 'MY', - 'MV', - 'ML', - 'MT', - 'MH', - 'MQ', - 'MR', - 'MU', - 'YT', - 'MX', - 'FM', - 'MD', - 'MC', - 'MN', - 'ME', - 'MS', - 'MA', - 'MZ', - 'MM', - 'NA', - 'NR', - 'NP', - 'NL', - 'NC', - 'NZ', - 'NI', - 'NE', - 'NG', - 'NU', - 'NF', - 'MP', - 'NO', - 'OM', - 'PK', - 'PW', - 'PS', - 'PA', - 'PG', - 'PY', - 'PE', - 'PH', - 'PN', - 'PL', - 'PT', - 'PR', - 'QA', - 'RO', - 'RU', - 'RW', - 'RE', - 'BL', - 'SH', - 'KN', - 'LC', - 'MF', - 'PM', - 'VC', - 'WS', - 'SM', - 'ST', - 'SA', - 'SN', - 'RS', - 'SC', - 'SL', - 'SG', - 'SX', - 'SK', - 'SI', - 'SB', - 'SO', - 'ZA', - 'GS', - 'SS', - 'ES', - 'LK', - 'SD', - 'SR', - 'SJ', - 'SZ', - 'SE', - 'CH', - 'SY', - 'TW', - 'TJ', - 'TZ', - 'TH', - 'TL', - 'TG', - 'TK', - 'TO', - 'TT', - 'TN', - 'TR', - 'TM', - 'TC', - 'TV', - 'UG', - 'UA', - 'AE', - 'GB', - 'US', - 'UM', - 'UY', - 'UZ', - 'VU', - 'VE', - 'VN', - 'VG', - 'VI', - 'WF', - 'EH', - 'YE', - 'ZM', - 'ZW', - 'unmapped_value', - null, - ], - description: 'The ISO 3166-1 alpha-2 code of the country.', - example: 'GB', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the ISO 3166-1 alpha-2 code of the country.', - example: 'GB', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - CrmCreateContactRequestDto: { - type: 'object', - properties: { - first_name: { - type: 'string', - description: 'The contact first name', - example: 'Steve', - nullable: true, - }, - last_name: { - type: 'string', - description: 'The contact last name', - example: 'Wozniak', - nullable: true, - }, - company_name: { - type: 'string', - description: 'The contact company name', - example: 'Apple Inc.', - nullable: true, - }, - emails: { - description: 'List of contact email addresses', - example: ['steve@apple.com'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - phone_numbers: { - description: 'List of contact phone numbers', - example: ['123-456-7890'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - deal_ids: { - description: 'List of associated deal IDs', - example: ['deal-001', 'deal-002'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - account_ids: { - description: 'List of associated account IDs', - example: ['account-123', 'account-456'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - custom_fields: { - description: 'Contact custom fields', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CustomFields', - }, - }, - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - }, - }, - CustomFieldDefinition: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - nullable: true, - }, - description: { - type: 'string', - nullable: true, - }, - type: { - description: 'The type of the custom field.', - example: 'Dropdown', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/CustomFieldTypeEnum', - }, - ], - }, - options: { - description: 'An array of possible options for the custom field.', - example: [ - { - id: 'option_1', - value: 'Not Started', - }, - { - id: 'option_2', - value: 'In Progress', - }, - { - id: 'option_3', - value: 'Completed', - }, - ], - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CustomFieldOption', - }, - }, - }, - }, - CustomFieldDefinitionResultApiModel: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/CustomFieldDefinition', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - CustomFieldDefinitionsPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/CustomFieldDefinition', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - CustomFieldOption: { - type: 'object', - properties: { - id: { - type: 'string', - description: - 'The unique identifier for the option to be used when updating the custom field', - example: 'option_123', - }, - value: { - description: 'The human readable value of the option', - example: 'Not Started', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - }, - }, - required: ['id', 'value'], - }, - CustomFields: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'The name of the custom field.', - example: 'Training Completion Status', - nullable: true, - }, - value: { - description: 'The value associated with the custom field.', - example: 'Completed', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - { - type: 'string', - format: 'date-time', - }, - ], - nullable: true, - }, - value_id: { - type: 'string', - description: 'The unique identifier for the value of the custom field.', - example: 'value_456', - nullable: true, - }, - remote_value_id: { - type: 'string', - description: "Provider's unique identifier for the value of the custom field.", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - }, - }, - CustomFieldTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'date', - 'float', - 'integer', - 'list', - 'checkbox', - 'text', - 'boolean', - 'single_select', - 'multi_select', - 'url', - 'other', - 'unmapped_value', - null, - ], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - ForbiddenResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 403, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Forbidden resource', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - InternalServerErrorResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 500, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Internal server error', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - List: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - name: { - type: 'string', - nullable: true, - }, - items: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/ListItem', - }, - }, - created_at: { - type: 'string', - description: 'Timestamp when the list was created', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'Timestamp when the list was last updated', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - type: { - description: 'The list type', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ListTypeEnum', - }, - ], - }, - }, - }, - ListItem: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - }, - }, - ListResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/List', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - ListsPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/List', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - ListTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: ['candidates', 'contacts', 'companies', 'unmapped_value', null], - description: 'The type of the list.', - example: 'contacts', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the list type.', - example: 'Contacts', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - LocationTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: ['home', 'work', 'unmapped_value', null], - description: 'The type of the location.', - example: 'home', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the location type.', - example: 'Home', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - NotFoundResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 404, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Not Found', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - NotImplementedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 501, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Not Implemented', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - PreconditionFailedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 412, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Precondition failed', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - ProviderError: { - type: 'object', - properties: { - status: { - type: 'number', - description: 'HTTP status code of the provider error', - example: 400, - nullable: true, - }, - url: { - type: 'string', - description: 'URL that caused the error', - example: 'https://api.provider.com/v1/resource', - nullable: true, - }, - raw: { - type: 'object', - description: 'Raw error response from the provider', - example: { - message: 'Invalid input parameters', - }, - nullable: true, - }, - headers: { - type: 'object', - description: 'Response headers', - example: { - 'content-type': 'application/json', - 'x-request-id': '5678c28b211dace4e0a0f9171e6b88c5', - }, - nullable: true, - }, - }, - }, - RawResponse: { - type: 'object', - properties: { - method: { - type: 'string', - }, - url: { - type: 'string', - }, - body: { - oneOf: [ - { - type: 'string', - }, - { - type: 'object', - }, - { - type: 'array', - items: { - type: 'integer', - format: 'int32', - minimum: 0, - maximum: 255, - }, - }, - ], - additionalProperties: true, - nullable: true, - }, - response: { - oneOf: [ - { - type: 'object', - additionalProperties: true, - }, - { - type: 'array', - items: {}, - }, - { - type: 'string', - }, - ], - nullable: true, - }, - }, - required: ['method', 'url'], - }, - RequestTimedOutResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 408, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Request timed out', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - TooManyRequestsResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 429, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Too many requests', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - UnauthorizedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 401, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Unauthorized', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - UnifiedError: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 400, - nullable: true, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Request', - nullable: true, - }, - headers: { - type: 'object', - description: 'Response headers', - example: { - 'content-type': 'application/json', - 'x-request-id': '5678c28b211dace4e0a0f9171e6b88c5', - }, - nullable: true, - }, - }, - }, - UnprocessableEntityResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 422, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Unprocessable Entity', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - }, - }, -}; diff --git a/src/openapi/generated/documents.ts b/src/openapi/generated/documents.ts deleted file mode 100644 index 7bcb1b00..00000000 --- a/src/openapi/generated/documents.ts +++ /dev/null @@ -1,4483 +0,0 @@ -// Generated OpenAPI specification for documents -// DO NOT EDIT THIS FILE DIRECTLY -export const documentsSpec = { - openapi: '3.1.0', - paths: { - '/unified/documents/files/{id}/download': { - get: { - operationId: 'documents_download_file', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'x-stackone-api-session-token', - in: 'header', - description: 'The session token', - required: false, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'format', - required: false, - in: 'query', - description: 'The format to download the file in', - schema: { - nullable: true, - example: 'base64', - type: 'string', - }, - }, - { - name: 'export_format', - required: false, - in: 'query', - description: 'The export format of the file', - schema: { - nullable: true, - example: 'text/plain', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The file with the given identifiers was retrieved.', - content: { - '*/*': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Download File', - tags: ['Files'], - 'x-speakeasy-group': 'documents', - 'x-speakeasy-name-override': 'download_file', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/documents/files/upload': { - post: { - operationId: 'documents_upload_file', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'x-stackone-api-session-token', - in: 'header', - description: 'The session token', - required: false, - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnifiedUploadRequestDto', - }, - }, - }, - }, - responses: { - '201': { - description: 'The file was uploaded.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/WriteResultApiModel', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Upload File', - tags: ['Files'], - 'x-speakeasy-group': 'documents', - 'x-speakeasy-name-override': 'upload_file', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/documents/files': { - get: { - operationId: 'documents_list_files', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'x-stackone-api-session-token', - in: 'header', - description: 'The session token', - required: false, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,description,url,size,file_format,path,owner_id,remote_owner_id,folder_id,remote_folder_id,drive_id,remote_drive_id,export_formats,default_download_format,created_at,updated_at,has_content,has_children,all_parent_folder_ids,remote_all_parent_folder_ids,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Documents Files Filter', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - name: { - description: 'Search if the name of the file contains the string', - example: 'john_doe_resume.pdf', - type: 'string', - nullable: true, - }, - content: { - description: - 'Search if the contents of the file contains the string (contents can include file metadata)', - example: 'FAQ of the project', - type: 'string', - nullable: true, - }, - created_after: { - description: - 'Use a string with a date to only select results created after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - drive_id: { - description: 'Use to only include Files within the specified Drive', - example: '1234567890', - type: 'string', - nullable: true, - }, - folder_id: { - description: - 'Use to only include Files within the specified Folder. Required when requesting nested items', - example: '1234567890', - type: 'string', - nullable: true, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'folder_id', - required: false, - in: 'query', - description: - 'Use to only include Files within the specified Folder. Required when requesting nested items', - schema: { - nullable: true, - example: '1234567890', - type: 'string', - }, - }, - { - name: 'nested_items', - required: false, - in: 'query', - description: - 'When "true" and used with filter[folder_id], the response includes Files and Files within descendant Folders', - schema: { - nullable: true, - default: 'false', - example: 'true', - type: 'string', - }, - }, - { - name: 'include', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be included in the response', - schema: { - nullable: true, - example: 'all_parent_folder_ids', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of files was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/FilesPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Files', - tags: ['Files'], - 'x-speakeasy-group': 'documents', - 'x-speakeasy-name-override': 'list_files', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/documents/files/{id}': { - get: { - operationId: 'documents_get_file', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'x-stackone-api-session-token', - in: 'header', - description: 'The session token', - required: false, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,description,url,size,file_format,path,owner_id,remote_owner_id,folder_id,remote_folder_id,drive_id,remote_drive_id,export_formats,default_download_format,created_at,updated_at,has_content,has_children,all_parent_folder_ids,remote_all_parent_folder_ids,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'include', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be included in the response', - schema: { - nullable: true, - example: 'all_parent_folder_ids', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The file with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/FileResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get File', - tags: ['Files'], - 'x-speakeasy-group': 'documents', - 'x-speakeasy-name-override': 'get_file', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/documents/folders': { - get: { - operationId: 'documents_list_folders', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,description,url,size,path,owner_id,remote_owner_id,parent_folder_id,remote_parent_folder_id,drive_id,remote_drive_id,created_at,updated_at,has_content,has_children,is_root,all_parent_folder_ids,remote_all_parent_folder_ids,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Documents Folders Filter', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - drive_id: { - description: 'Use to only include Folders within the specified Drive', - example: '1234567890', - type: 'string', - nullable: true, - additionalProperties: false, - }, - folder_id: { - description: - 'Use to only include Folders within the specified Folder. Required when requesting nested items', - example: '1234567890', - type: 'string', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'folder_id', - required: false, - in: 'query', - description: - 'Use to only include Folders within the specified Folder. Required when requesting nested items', - schema: { - nullable: true, - example: '1234567890', - type: 'string', - }, - }, - { - name: 'nested_items', - required: false, - in: 'query', - description: - 'When "true" and used with filter[folder_id], the response includes Folders and their descendant Folders', - schema: { - nullable: true, - default: 'false', - example: 'true', - type: 'string', - }, - }, - { - name: 'include', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be included in the response', - schema: { - nullable: true, - example: 'all_parent_folder_ids', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of folders was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/FoldersPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Folders', - tags: ['Folders'], - 'x-speakeasy-group': 'documents', - 'x-speakeasy-name-override': 'list_folders', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/documents/folders/{id}': { - get: { - operationId: 'documents_get_folder', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,description,url,size,path,owner_id,remote_owner_id,parent_folder_id,remote_parent_folder_id,drive_id,remote_drive_id,created_at,updated_at,has_content,has_children,is_root,all_parent_folder_ids,remote_all_parent_folder_ids,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'include', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be included in the response', - schema: { - nullable: true, - example: 'all_parent_folder_ids', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The folder with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/FolderResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Folder', - tags: ['Folders'], - 'x-speakeasy-group': 'documents', - 'x-speakeasy-name-override': 'get_folder', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/documents/drives': { - get: { - operationId: 'documents_list_drives', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,description,url,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of drives was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/DrivesPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Drives', - tags: ['Drives'], - 'x-speakeasy-group': 'documents', - 'x-speakeasy-name-override': 'list_drives', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/documents/drives/{id}': { - get: { - operationId: 'documents_get_drive', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,description,url,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The drive with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/DriveResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Drive', - tags: ['Drives'], - 'x-speakeasy-group': 'documents', - 'x-speakeasy-name-override': 'get_drive', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - }, - info: { - title: 'Documents', - description: 'The documentation for the StackOne Unified API - DOCUMENTS', - version: '1.0.0', - contact: {}, - }, - tags: [ - { - name: 'Files', - description: 'Files that can be uploaded or managed.', - }, - { - name: 'Folders', - description: 'Folders for organizing files.', - }, - { - name: 'Drives', - description: 'Drives for storing and managing files.', - }, - ], - servers: [ - { - url: 'https://api.stackone.com', - }, - ], - components: { - securitySchemes: { - basic: { - type: 'http', - scheme: 'basic', - }, - }, - schemas: { - BadGatewayResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 502, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Gateway', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - BadRequestResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 400, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Request', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - data: { - description: 'Error details', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/UnifiedError', - }, - ], - }, - provider_errors: { - description: 'List of provider-specific errors', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/ProviderError', - }, - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - ConfidentialEnumApiModel: { - type: 'object', - properties: { - value: { - type: 'string', - description: 'Whether the file is confidential or not', - enum: ['true', 'false', 'unmapped_value', null], - example: 'true', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - example: 'public', - nullable: true, - }, - }, - }, - ConflictResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 409, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Conflict', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - DownloadApiModel: { - type: 'object', - properties: { - headers: { - description: 'Headers related to the download', - allOf: [ - { - $ref: '#/components/schemas/DownloadHeadersApiModel', - }, - ], - }, - data: { - type: 'string', - description: 'The file data in binary format', - format: 'binary', - }, - }, - required: ['headers', 'data'], - }, - DownloadHeadersApiModel: { - type: 'object', - properties: { - 'content-disposition': { - type: 'string', - description: 'Value of the Content-Disposition header', - example: 'attachment; filename="example.pdf"', - nullable: true, - }, - 'content-type': { - type: 'string', - description: 'MIME type of the file', - example: 'application/pdf', - nullable: true, - }, - 'content-length': { - type: 'number', - description: 'Size of the content in bytes', - example: 1024, - nullable: true, - }, - 'content-range': { - type: 'string', - description: 'Range of the content being sent', - example: 'bytes 0-1023/2048', - nullable: true, - }, - 'content-encoding': { - type: 'string', - description: 'Encoding of the content', - example: 'gzip', - nullable: true, - }, - 'transfer-encoding': { - type: 'string', - description: 'Transfer encoding type', - example: 'chunked', - nullable: true, - }, - }, - }, - DriveResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/Drives', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - Drives: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'The ID associated with this drive', - example: '16873-IT345', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'The name associated with this drive', - example: 'USA Development Drive', - nullable: true, - }, - description: { - type: 'string', - description: 'The description associated with this drive', - example: 'Drive with USA Development documents', - nullable: true, - }, - url: { - type: 'string', - description: 'The url of the drive', - example: 'https://test.sharepoint.com/Document%20Library', - nullable: true, - }, - created_at: { - type: 'string', - description: 'The created date of the drive', - example: '2023-02-23T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The last updated date of the drive', - example: '2024-02-23T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - DrivesPaginated: { - type: 'object', - properties: { - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/Drives', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - FileFormatEnum: { - type: 'object', - properties: { - value: { - type: 'string', - description: 'The file format of the file, expressed as a file extension', - enum: [ - 'unmapped_value', - 'ez', - 'aw', - 'atom', - 'atomcat', - 'atomdeleted', - 'atomsvc', - 'dwd', - 'held', - 'rsat', - 'bdoc', - 'xcs', - 'ccxml', - 'cdfx', - 'cdmia', - 'cdmic', - 'cdmid', - 'cdmio', - 'cdmiq', - 'cu', - 'mpd', - 'davmount', - 'dbk', - 'dssc', - 'xdssc', - 'es', - 'ecma', - 'emma', - 'emotionml', - 'epub', - 'exi', - 'exp', - 'fdt', - 'pfr', - 'geojson', - 'gml', - 'gpx', - 'gxf', - 'gz', - 'hjson', - 'stk', - 'ink', - 'inkml', - 'ipfix', - 'its', - 'jar', - 'war', - 'ear', - 'ser', - 'class', - 'js', - 'mjs', - 'json', - 'map', - 'json5', - 'jsonml', - 'jsonld', - 'lgr', - 'lostxml', - 'hqx', - 'cpt', - 'mads', - 'webmanifest', - 'mrc', - 'mrcx', - 'ma', - 'nb', - 'mb', - 'mathml', - 'mbox', - 'mscml', - 'metalink', - 'meta4', - 'mets', - 'maei', - 'musd', - 'mods', - 'm21', - 'mp21', - 'mp4s', - 'm4p', - 'doc', - 'dot', - 'mxf', - 'nq', - 'nt', - 'cjs', - 'bin', - 'dms', - 'lrf', - 'mar', - 'so', - 'dist', - 'distz', - 'pkg', - 'bpk', - 'dump', - 'elc', - 'deploy', - 'exe', - 'dll', - 'deb', - 'dmg', - 'iso', - 'img', - 'msi', - 'msp', - 'msm', - 'buffer', - 'oda', - 'opf', - 'ogx', - 'omdoc', - 'onetoc', - 'onetoc2', - 'onetmp', - 'onepkg', - 'oxps', - 'relo', - 'xer', - 'pdf', - 'pgp', - 'asc', - 'sig', - 'prf', - 'p10', - 'p7m', - 'p7c', - 'p7s', - 'p8', - 'ac', - 'cer', - 'crl', - 'pkipath', - 'pki', - 'pls', - 'ai', - 'eps', - 'ps', - 'provx', - 'pskcxml', - 'raml', - 'rdf', - 'owl', - 'rif', - 'rnc', - 'rl', - 'rld', - 'rs', - 'rapd', - 'sls', - 'rusd', - 'gbr', - 'mft', - 'roa', - 'rsd', - 'rss', - 'rtf', - 'sbml', - 'scq', - 'scs', - 'spq', - 'spp', - 'sdp', - 'senmlx', - 'sensmlx', - 'setpay', - 'setreg', - 'shf', - 'siv', - 'sieve', - 'smi', - 'smil', - 'rq', - 'srx', - 'gram', - 'grxml', - 'sru', - 'ssdl', - 'ssml', - 'swidtag', - 'tei', - 'teicorpus', - 'tfi', - 'tsd', - 'toml', - 'trig', - 'ttml', - 'ubj', - 'rsheet', - 'td', - 'vxml', - 'wasm', - 'wgt', - 'hlp', - 'wsdl', - 'wspolicy', - 'xaml', - 'xav', - 'xca', - 'xdf', - 'xel', - 'xns', - 'xenc', - 'xhtml', - 'xht', - 'xlf', - 'xml', - 'xsl', - 'xsd', - 'rng', - 'dtd', - 'xop', - 'xpl', - '*xsl', - 'xslt', - 'xspf', - 'mxml', - 'xhvml', - 'xvml', - 'xvm', - 'yang', - 'yin', - 'zip', - '*3gpp', - 'adp', - 'amr', - 'au', - 'snd', - 'mid', - 'midi', - 'kar', - 'rmi', - 'mxmf', - '*mp3', - 'm4a', - 'mp4a', - 'mpga', - 'mp2', - 'mp2a', - 'mp3', - 'm2a', - 'm3a', - 'oga', - 'ogg', - 'spx', - 'opus', - 's3m', - 'sil', - 'wav', - '*wav', - 'weba', - 'xm', - 'ttc', - 'otf', - 'ttf', - 'woff', - 'woff2', - 'exr', - 'apng', - 'avif', - 'bmp', - 'cgm', - 'drle', - 'emf', - 'fits', - 'g3', - 'gif', - 'heic', - 'heics', - 'heif', - 'heifs', - 'hej2', - 'hsj2', - 'ief', - 'jls', - 'jp2', - 'jpg2', - 'jpeg', - 'jpg', - 'jpe', - 'jph', - 'jhc', - 'jpm', - 'jpx', - 'jpf', - 'jxr', - 'jxra', - 'jxrs', - 'jxs', - 'jxsc', - 'jxsi', - 'jxss', - 'ktx', - 'ktx2', - 'png', - 'sgi', - 'svg', - 'svgz', - 't38', - 'tif', - 'tiff', - 'tfx', - 'webp', - 'wmf', - 'disposition-notification', - 'u8msg', - 'u8dsn', - 'u8mdn', - 'u8hdr', - 'eml', - 'mime', - '3mf', - 'gltf', - 'glb', - 'igs', - 'iges', - 'msh', - 'mesh', - 'silo', - 'mtl', - 'obj', - 'stpx', - 'stpz', - 'stpxz', - 'stl', - 'wrl', - 'vrml', - '*x3db', - 'x3dbz', - 'x3db', - '*x3dv', - 'x3dvz', - 'x3d', - 'x3dz', - 'x3dv', - 'appcache', - 'manifest', - 'ics', - 'ifb', - 'coffee', - 'litcoffee', - 'css', - 'csv', - 'html', - 'htm', - 'shtml', - 'jade', - 'jsx', - 'less', - 'markdown', - 'md', - 'mml', - 'mdx', - 'n3', - 'txt', - 'text', - 'conf', - 'def', - 'list', - 'log', - 'in', - 'ini', - 'rtx', - '*rtf', - 'sgml', - 'sgm', - 'shex', - 'slim', - 'slm', - 'spdx', - 'stylus', - 'styl', - 'tsv', - 't', - 'tr', - 'roff', - 'man', - 'me', - 'ms', - 'ttl', - 'uri', - 'uris', - 'urls', - 'vcard', - 'vtt', - '*xml', - 'yaml', - 'yml', - '3gp', - '3gpp', - '3g2', - 'h261', - 'h263', - 'h264', - 'm4s', - 'jpgv', - '*jpm', - 'jpgm', - 'mj2', - 'mjp2', - 'ts', - 'mp4', - 'mp4v', - 'mpg4', - 'mpeg', - 'mpg', - 'mpe', - 'm1v', - 'm2v', - 'ogv', - 'qt', - 'mov', - 'webm', - 'cww', - '1km', - 'plb', - 'psb', - 'pvb', - 'tcap', - 'pwn', - 'aso', - 'imp', - 'acu', - 'atc', - 'acutc', - 'air', - 'fcdt', - 'fxp', - 'fxpl', - 'xdp', - 'xfdf', - 'ahead', - 'azf', - 'azs', - 'azw', - 'acc', - 'ami', - 'apk', - 'cii', - 'fti', - 'atx', - 'mpkg', - 'key', - 'm3u8', - 'numbers', - 'pages', - 'pkpass', - 'swi', - 'iota', - 'aep', - 'bmml', - 'mpm', - 'bmi', - 'rep', - 'cdxml', - 'mmd', - 'cdy', - 'csl', - 'cla', - 'rp9', - 'c4g', - 'c4d', - 'c4f', - 'c4p', - 'c4u', - 'c11amc', - 'c11amz', - 'csp', - 'cdbcmsg', - 'cmc', - 'clkx', - 'clkk', - 'clkp', - 'clkt', - 'clkw', - 'wbs', - 'pml', - 'ppd', - 'car', - 'pcurl', - 'dart', - 'rdz', - 'dbf', - 'uvf', - 'uvvf', - 'uvd', - 'uvvd', - 'uvt', - 'uvvt', - 'uvx', - 'uvvx', - 'uvz', - 'uvvz', - 'fe_launch', - 'dna', - 'mlp', - 'mle', - 'dpg', - 'dfac', - 'kpxx', - 'ait', - 'svc', - 'geo', - 'mag', - 'nml', - 'esf', - 'msf', - 'qam', - 'slt', - 'ssf', - 'es3', - 'et3', - 'ez2', - 'ez3', - 'fdf', - 'mseed', - 'seed', - 'dataless', - 'gph', - 'ftc', - 'fm', - 'frame', - 'maker', - 'book', - 'fnc', - 'ltf', - 'fsc', - 'oas', - 'oa2', - 'oa3', - 'fg5', - 'bh2', - 'ddd', - 'xdw', - 'xbd', - 'fzs', - 'txd', - 'ggb', - 'ggt', - 'gex', - 'gre', - 'gxt', - 'g2w', - 'g3w', - 'gmx', - 'gdoc', - 'gslides', - 'gsheet', - 'kml', - 'kmz', - 'gqf', - 'gqs', - 'gac', - 'ghf', - 'gim', - 'grv', - 'gtm', - 'tpl', - 'vcg', - 'hal', - 'zmm', - 'hbci', - 'les', - 'hpgl', - 'hpid', - 'hps', - 'jlt', - 'pcl', - 'pclxl', - 'sfd-hdstx', - 'mpy', - 'afp', - 'listafp', - 'list3820', - 'irm', - 'sc', - 'icc', - 'icm', - 'igl', - 'ivp', - 'ivu', - 'igm', - 'xpw', - 'xpx', - 'i2g', - 'qbo', - 'qfx', - 'rcprofile', - 'irp', - 'xpr', - 'fcs', - 'jam', - 'rms', - 'jisp', - 'joda', - 'ktz', - 'ktr', - 'karbon', - 'chrt', - 'kfo', - 'flw', - 'kon', - 'kpr', - 'kpt', - 'ksp', - 'kwd', - 'kwt', - 'htke', - 'kia', - 'kne', - 'knp', - 'skp', - 'skd', - 'skt', - 'skm', - 'sse', - 'lasxml', - 'lbd', - 'lbe', - 'apr', - 'pre', - 'nsf', - 'org', - 'scm', - 'lwp', - 'portpkg', - 'mvt', - 'mcd', - 'mc1', - 'cdkey', - 'mwf', - 'mfm', - 'flo', - 'igx', - 'mif', - 'daf', - 'dis', - 'mbk', - 'mqy', - 'msl', - 'plc', - 'txf', - 'mpn', - 'mpc', - 'xul', - 'cil', - 'cab', - 'xls', - 'xlm', - 'xla', - 'xlc', - 'xlt', - 'xlw', - 'xlam', - 'xlsb', - 'xlsm', - 'xltm', - 'eot', - 'chm', - 'ims', - 'lrm', - 'thmx', - 'msg', - 'cat', - '*stl', - 'ppt', - 'pps', - 'pot', - 'ppam', - 'pptm', - 'sldm', - 'ppsm', - 'potm', - 'mpp', - 'mpt', - 'docm', - 'dotm', - 'wps', - 'wks', - 'wcm', - 'wdb', - 'wpl', - 'xps', - 'mseq', - 'mus', - 'msty', - 'taglet', - 'nlu', - 'ntf', - 'nitf', - 'nnd', - 'nns', - 'nnw', - '*ac', - 'ngdat', - 'n-gage', - 'rpst', - 'rpss', - 'edm', - 'edx', - 'ext', - 'odc', - 'otc', - 'odb', - 'odf', - 'odft', - 'odg', - 'otg', - 'odi', - 'oti', - 'odp', - 'otp', - 'ods', - 'ots', - 'odt', - 'odm', - 'ott', - 'oth', - 'xo', - 'dd2', - 'obgx', - 'oxt', - 'osm', - 'pptx', - 'sldx', - 'ppsx', - 'potx', - 'xlsx', - 'xltx', - 'docx', - 'dotx', - 'mgp', - 'dp', - 'esa', - 'pdb', - 'pqa', - 'oprc', - 'paw', - 'str', - 'ei6', - 'efif', - 'wg', - 'plf', - 'pbd', - 'box', - 'mgz', - 'qps', - 'ptid', - 'qxd', - 'qxt', - 'qwd', - 'qwt', - 'qxl', - 'qxb', - 'rar', - 'bed', - 'mxl', - 'musicxml', - 'cryptonote', - 'cod', - 'rm', - 'rmvb', - 'link66', - 'st', - 'see', - 'sema', - 'semd', - 'semf', - 'ifm', - 'itp', - 'iif', - 'ipk', - 'twd', - 'twds', - 'mmf', - 'teacher', - 'fo', - 'sdkm', - 'sdkd', - 'dxp', - 'sfs', - 'sdc', - 'sda', - 'sdd', - 'smf', - 'sdw', - 'vor', - 'sgl', - 'smzip', - 'sm', - 'wadl', - 'sxc', - 'stc', - 'sxd', - 'std', - 'sxi', - 'sti', - 'sxm', - 'sxw', - 'sxg', - 'stw', - 'sus', - 'susp', - 'svd', - 'sis', - 'sisx', - 'xsm', - 'bdm', - 'xdm', - 'ddf', - 'tao', - 'pcap', - 'cap', - 'dmp', - 'tmo', - 'tpt', - 'mxs', - 'tra', - 'ufd', - 'ufdl', - 'utz', - 'umj', - 'unityweb', - 'uoml', - 'vcx', - 'vsd', - 'vst', - 'vss', - 'vsw', - 'vis', - 'vsf', - 'wbxml', - 'wmlc', - 'wmlsc', - 'wtb', - 'nbp', - 'wpd', - 'wqd', - 'stf', - 'xar', - 'xfdl', - 'hvd', - 'hvs', - 'hvp', - 'osf', - 'osfpvg', - 'saf', - 'spf', - 'cmp', - 'zir', - 'zirz', - 'zaz', - '7z', - 'abw', - 'ace', - '*dmg', - 'arj', - 'aab', - 'x32', - 'u32', - 'vox', - 'aam', - 'aas', - 'bcpio', - '*bdoc', - 'torrent', - 'blb', - 'blorb', - 'bz', - 'bz2', - 'boz', - 'cbr', - 'cba', - 'cbt', - 'cbz', - 'cb7', - 'vcd', - 'cfs', - 'chat', - 'pgn', - 'crx', - 'cco', - 'nsc', - 'cpio', - 'csh', - '*deb', - 'udeb', - 'dgc', - 'dir', - 'dcr', - 'dxr', - 'cst', - 'cct', - 'cxt', - 'w3d', - 'fgd', - 'swa', - 'wad', - 'ncx', - 'dtb', - 'res', - 'dvi', - 'evy', - 'eva', - 'bdf', - 'gsf', - 'psf', - 'pcf', - 'snf', - 'pfa', - 'pfb', - 'pfm', - 'afm', - 'arc', - 'spl', - 'gca', - 'ulx', - 'gnumeric', - 'gramps', - 'gtar', - 'hdf', - 'php', - 'install', - '*iso', - '*key', - '*numbers', - '*pages', - 'jardiff', - 'jnlp', - 'kdbx', - 'latex', - 'luac', - 'lzh', - 'lha', - 'run', - 'mie', - 'prc', - 'mobi', - 'application', - 'lnk', - 'wmd', - 'wmz', - 'xbap', - 'mdb', - 'obd', - 'crd', - 'clp', - '*exe', - '*dll', - 'com', - 'bat', - '*msi', - 'mvb', - 'm13', - 'm14', - '*wmf', - '*wmz', - '*emf', - 'emz', - 'mny', - 'pub', - 'scd', - 'trm', - 'wri', - 'nc', - 'cdf', - 'pac', - 'nzb', - 'pl', - 'pm', - '*prc', - '*pdb', - 'p12', - 'pfx', - 'p7b', - 'spc', - 'p7r', - '*rar', - 'rpm', - 'ris', - 'sea', - 'sh', - 'shar', - 'swf', - 'xap', - 'sql', - 'sit', - 'sitx', - 'srt', - 'sv4cpio', - 'sv4crc', - 't3', - 'gam', - 'tar', - 'tcl', - 'tk', - 'tex', - 'tfm', - 'texinfo', - 'texi', - '*obj', - 'ustar', - 'hdd', - 'ova', - 'ovf', - 'vbox', - 'vbox-extpack', - 'vdi', - 'vhd', - 'vmdk', - 'src', - 'webapp', - 'der', - 'crt', - 'pem', - 'fig', - '*xlf', - 'xpi', - 'xz', - 'z1', - 'z2', - 'z3', - 'z4', - 'z5', - 'z6', - 'z7', - 'z8', - 'uva', - 'uvva', - 'eol', - 'dra', - 'dts', - 'dtshd', - 'lvp', - 'pya', - 'ecelp4800', - 'ecelp7470', - 'ecelp9600', - 'rip', - 'aac', - 'aif', - 'aiff', - 'aifc', - 'caf', - 'flac', - '*m4a', - 'mka', - 'm3u', - 'wax', - 'wma', - 'ram', - 'ra', - 'rmp', - '*ra', - 'cdx', - 'cif', - 'cmdf', - 'cml', - 'csml', - 'xyz', - 'btif', - 'pti', - 'psd', - 'azv', - 'uvi', - 'uvvi', - 'uvg', - 'uvvg', - 'djvu', - 'djv', - '*sub', - 'dwg', - 'dxf', - 'fbs', - 'fpx', - 'fst', - 'mmr', - 'rlc', - 'ico', - 'dds', - 'mdi', - 'wdp', - 'npx', - 'b16', - 'tap', - 'vtf', - 'wbmp', - 'xif', - 'pcx', - '3ds', - 'ras', - 'cmx', - 'fh', - 'fhc', - 'fh4', - 'fh5', - 'fh7', - '*ico', - 'jng', - 'sid', - '*bmp', - '*pcx', - 'pic', - 'pct', - 'pnm', - 'pbm', - 'pgm', - 'ppm', - 'rgb', - 'tga', - 'xbm', - 'xpm', - 'xwd', - 'wsc', - 'dae', - 'dwf', - 'gdl', - 'gtw', - 'mts', - 'ogex', - 'x_b', - 'x_t', - 'vds', - 'usdz', - 'bsp', - 'vtu', - 'dsc', - 'curl', - 'dcurl', - 'mcurl', - 'scurl', - 'sub', - 'fly', - 'flx', - 'gv', - '3dml', - 'spot', - 'jad', - 'wml', - 'wmls', - 's', - 'asm', - 'c', - 'cc', - 'cxx', - 'cpp', - 'h', - 'hh', - 'dic', - 'htc', - 'f', - 'for', - 'f77', - 'f90', - 'hbs', - 'java', - 'lua', - 'mkd', - 'nfo', - 'opml', - '*org', - 'p', - 'pas', - 'pde', - 'sass', - 'scss', - 'etx', - 'sfv', - 'ymp', - 'uu', - 'vcs', - 'vcf', - 'uvh', - 'uvvh', - 'uvm', - 'uvvm', - 'uvp', - 'uvvp', - 'uvs', - 'uvvs', - 'uvv', - 'uvvv', - 'dvb', - 'fvt', - 'mxu', - 'm4u', - 'pyv', - 'uvu', - 'uvvu', - 'viv', - 'f4v', - 'fli', - 'flv', - 'm4v', - 'mkv', - 'mk3d', - 'mks', - 'mng', - 'asf', - 'asx', - 'vob', - 'wm', - 'wmv', - 'wmx', - 'wvx', - 'avi', - 'movie', - 'smv', - 'ice', - 'mht', - null, - ], - example: 'pdf', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - example: 'application/pdf', - nullable: true, - }, - }, - }, - FileResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/Files', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - Files: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'The name associated with this file', - example: 'Information-Technology', - nullable: true, - }, - description: { - type: 'string', - description: 'The description of the file', - example: 'This is the description associated to the file.', - nullable: true, - }, - size: { - type: 'number', - description: 'The size of this file', - example: 1024, - nullable: true, - }, - url: { - type: 'string', - description: 'The url of the file', - example: 'https://drive.google.com/file/d/nd8932h9d/view', - nullable: true, - }, - file_format: { - description: 'The file format of the file', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/FileFormatEnum', - }, - ], - }, - path: { - type: 'string', - description: 'The path where the file is stored', - example: '/path/to/file', - nullable: true, - }, - owner_id: { - type: 'string', - description: 'The user ID of owner of this file', - example: 'c28xyrc55866bvuv', - nullable: true, - }, - export_formats: { - description: 'List of supported export formats', - example: ['application/pdf'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - default_download_format: { - type: 'string', - description: 'Default download format', - example: 'application/pdf', - nullable: true, - }, - remote_owner_id: { - type: 'string', - description: "Provider's unique identifier of the owner of this file", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - folder_id: { - type: 'string', - description: 'The parent folder ID associated with this file', - example: 'c28xyrc55866bvuv', - nullable: true, - }, - remote_folder_id: { - type: 'string', - description: - "Provider's unique identifier of the parent folder associated with this file", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - drive_id: { - type: 'string', - description: 'The parent drive ID associated with this file', - example: 'c28xyrc55866bvuv', - nullable: true, - }, - remote_drive_id: { - type: 'string', - description: - "Provider's unique identifier of the parent drive associated with this file", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - created_at: { - type: 'string', - description: 'The created date of the file', - example: '2023-02-23T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The last updated date of the file', - example: '2024-02-23T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - has_content: { - description: 'Whether the file has content', - example: true, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - has_children: { - description: 'Whether the file has children', - example: true, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - all_parent_folder_ids: { - description: 'List of containing parent Folder IDs in descending order', - example: ['0123456789'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - }, - }, - FilesPaginated: { - type: 'object', - properties: { - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/Files', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - FolderResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/Folders', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - Folders: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'The name associated with this folder', - example: 'Information-Technology', - nullable: true, - }, - description: { - type: 'string', - description: 'The description of the folder', - example: 'This is the description associated to the folder.', - nullable: true, - }, - size: { - type: 'number', - description: 'The size of this folder in bytes', - example: 1024, - nullable: true, - }, - url: { - type: 'string', - description: 'The url of the folder', - example: 'https://drive.google.com/folder/d/nd8932h9d/view', - nullable: true, - }, - path: { - type: 'string', - description: 'The path where the folder is stored', - example: '/path/to/folder', - nullable: true, - }, - owner_id: { - type: 'string', - description: 'The user ID of owner of this folder', - example: 'c28xyrc55866bvuv', - nullable: true, - }, - remote_owner_id: { - type: 'string', - description: "Provider's unique identifier of the owner of this folder", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - parent_folder_id: { - type: 'string', - description: 'The parent folder ID associated with this folder', - example: 'c28xyrc55866bvuv', - nullable: true, - }, - remote_parent_folder_id: { - type: 'string', - description: - "Provider's unique identifier of the parent folder associated with this folder", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - drive_id: { - type: 'string', - description: 'The parent drive ID associated with this folder', - example: 'c28xyrc55866bvuv', - nullable: true, - }, - remote_drive_id: { - type: 'string', - description: - "Provider's unique identifier of the parent drive associated with this folder", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - created_at: { - type: 'string', - description: 'The created date of the folder', - example: '2023-02-23T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The last updated date of the folder', - example: '2024-02-23T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - has_content: { - description: 'Whether the folder has content', - example: true, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - has_children: { - description: 'Whether the folder has children', - example: true, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - is_root: { - description: 'Whether the folder is at the root level of the drive', - example: true, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - all_parent_folder_ids: { - description: 'List of containing parent Folder IDs in descending order', - example: ['0123456789'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - }, - }, - FoldersPaginated: { - type: 'object', - properties: { - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/Folders', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - ForbiddenResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 403, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Forbidden resource', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - InternalServerErrorResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 500, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Internal server error', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - NotFoundResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 404, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Not Found', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - NotImplementedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 501, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Not Implemented', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - PreconditionFailedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 412, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Precondition failed', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - ProviderError: { - type: 'object', - properties: { - status: { - type: 'number', - description: 'HTTP status code of the provider error', - example: 400, - nullable: true, - }, - url: { - type: 'string', - description: 'URL that caused the error', - example: 'https://api.provider.com/v1/resource', - nullable: true, - }, - raw: { - type: 'object', - description: 'Raw error response from the provider', - example: { - message: 'Invalid input parameters', - }, - nullable: true, - }, - headers: { - type: 'object', - description: 'Response headers', - example: { - 'content-type': 'application/json', - 'x-request-id': '5678c28b211dace4e0a0f9171e6b88c5', - }, - nullable: true, - }, - }, - }, - ProviderErrorApiModel: { - type: 'object', - properties: { - status: { - type: 'number', - example: 400, - nullable: true, - }, - url: { - type: 'string', - example: 'https://api.someprovider.com/v1/endpoint', - nullable: true, - }, - raw: { - type: 'object', - nullable: true, - }, - headers: { - type: 'object', - example: { - date: 'Tue, 02 Apr 2024 13:52:01 GMT', - 'content-type': 'application/json; charset=utf-8', - 'transfer-encoding': 'chunked', - connection: 'close', - }, - nullable: true, - }, - }, - }, - RawResponse: { - type: 'object', - properties: { - method: { - type: 'string', - }, - url: { - type: 'string', - }, - body: { - oneOf: [ - { - type: 'string', - }, - { - type: 'object', - }, - { - type: 'array', - items: { - type: 'integer', - format: 'int32', - minimum: 0, - maximum: 255, - }, - }, - ], - additionalProperties: true, - nullable: true, - }, - response: { - oneOf: [ - { - type: 'object', - additionalProperties: true, - }, - { - type: 'array', - items: {}, - }, - { - type: 'string', - }, - ], - nullable: true, - }, - }, - required: ['method', 'url'], - }, - RequestTimedOutResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 408, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Request timed out', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - TooManyRequestsResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 429, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Too many requests', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - UnauthorizedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 401, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Unauthorized', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - UnifiedError: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 400, - nullable: true, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Request', - nullable: true, - }, - headers: { - type: 'object', - description: 'Response headers', - example: { - 'content-type': 'application/json', - 'x-request-id': '5678c28b211dace4e0a0f9171e6b88c5', - }, - nullable: true, - }, - }, - }, - UnifiedUploadCategoryEnumApiModel: { - type: 'object', - properties: { - value: { - type: 'string', - description: 'The category name for associating uploaded files.', - example: 'reports, resumes', - nullable: true, - }, - source_value: { - type: 'string', - description: - 'The provider specific category for associating uploaded files, if provided, the value will be ignored.', - example: '550e8400-e29b-41d4-a716-446655440000, CUSTOM_CATEGORY_NAME', - nullable: true, - }, - }, - }, - UnifiedUploadRequestDto: { - type: 'object', - properties: { - name: { - type: 'string', - description: 'The filename of the file to upload', - example: 'weather-forecast', - nullable: true, - }, - file_format: { - description: 'The file format of the file', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/FileFormatEnum', - }, - ], - }, - content: { - type: 'string', - description: 'The base64 encoded content of the file to upload', - example: - 'VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE', - nullable: true, - }, - category_id: { - type: 'string', - description: 'The categoryId of the documents', - example: '6530', - nullable: true, - }, - path: { - type: 'string', - description: 'The path for the file to be uploaded to', - example: '/path/to/file', - nullable: true, - }, - category: { - description: - 'The category object for associating uploaded files. If both an ID and a name are provided, the ID takes precedence.', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/UnifiedUploadCategoryEnumApiModel', - }, - ], - }, - confidential: { - description: 'The confidentiality level of the file to be uploaded', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ConfidentialEnumApiModel', - }, - ], - }, - }, - }, - UnifiedWarningApiModel: { - type: 'object', - properties: { - message: { - type: 'string', - example: 'The provided field type is not supported in the current model.', - nullable: true, - }, - }, - }, - UnprocessableEntityResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 422, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Unprocessable Entity', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - WriteResultApiModel: { - type: 'object', - properties: { - statusCode: { - type: 'number', - example: 201, - nullable: true, - }, - message: { - type: 'string', - example: 'Employee created successfully', - nullable: true, - }, - timestamp: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - provider_errors: { - example: [ - { - status: 400, - url: 'https://api.someprovider.com/v1/endpoint', - raw: { - error: 'Bad Request', - message: 'The supplied data is invalid', - }, - headers: { - date: 'Tue, 02 Apr 2024 13:52:01 GMT', - 'content-type': 'application/json; charset=utf-8', - 'transfer-encoding': 'chunked', - connection: 'close', - }, - }, - ], - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/ProviderErrorApiModel', - }, - }, - unified_warnings: { - example: [ - { - message: 'The provided field type is not supported in the current model.', - }, - ], - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/UnifiedWarningApiModel', - }, - }, - }, - }, - }, - }, -}; diff --git a/src/openapi/generated/hris.ts b/src/openapi/generated/hris.ts deleted file mode 100644 index 58e68e56..00000000 --- a/src/openapi/generated/hris.ts +++ /dev/null @@ -1,29334 +0,0 @@ -// Generated OpenAPI specification for hris -// DO NOT EDIT THIS FILE DIRECTLY -export const hrisSpec = { - openapi: '3.1.0', - paths: { - '/unified/hris/companies': { - get: { - operationId: 'hris_list_companies', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,full_name,display_name,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of Companies was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CompaniesPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Companies', - tags: ['Companies'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'list_companies', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/companies/{id}': { - get: { - operationId: 'hris_get_company', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,full_name,display_name,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The Company with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CompanyResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Company', - tags: ['Companies'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'get_company', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/custom_field_definitions/employees': { - get: { - operationId: 'hris_list_employee_custom_field_definitions', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,description,type,options,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of employee custom field definitions was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CustomFieldDefinitionsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List employee Custom Field Definitions', - tags: ['Custom Field Definitions'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'list_employee_custom_field_definitions', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/custom_field_definitions/employees/{id}': { - get: { - operationId: 'hris_get_employee_custom_field_definition', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,description,type,options,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The employee custom field definition was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CustomFieldDefinitionResultApiModel', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get employee Custom Field Definition', - tags: ['Custom Field Definitions'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'get_employee_custom_field_definition', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/employees': { - get: { - operationId: 'hris_list_employees', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,title,first_name,last_name,name,display_name,gender,ethnicity,date_of_birth,birthday,marital_status,avatar_url,avatar,personal_email,personal_phone_number,work_email,work_phone_number,job_id,remote_job_id,job_title,job_description,department_id,remote_department_id,department,cost_centers,company,manager_id,remote_manager_id,hire_date,start_date,tenure,work_anniversary,employment_type,employment_contract_type,employment_status,termination_date,company_name,company_id,remote_company_id,preferred_language,citizenships,home_location,work_location,employments,custom_fields,created_at,updated_at,benefits,employee_number,national_identity_number,national_identity_numbers,bank_details,skills,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'HRIS Employees filters', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - email: { - description: 'Filter to select employees by email', - type: 'string', - nullable: true, - }, - employee_number: { - description: 'Filter to select employees by employee_number', - type: 'string', - nullable: true, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'expand', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be expanded in the response', - schema: { - nullable: true, - example: 'company,employments,work_location,home_location,groups,skills', - type: 'string', - }, - }, - { - name: 'include', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be included in the response', - schema: { - nullable: true, - example: 'avatar_url,avatar,custom_fields,job_description,benefits,bank_details', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of employees was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/EmployeesPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Employees', - tags: ['Employees'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'list_employees', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - 'x-speakeasy-usage-example': { - title: 'List Employees', - position: 1, - }, - }, - post: { - operationId: 'hris_create_employee', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HrisCreateEmployeeRequestDto', - }, - }, - }, - }, - responses: { - '201': { - description: 'The employee was created successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Create Employee', - tags: ['Employees'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'create_employee', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/employees/{id}': { - get: { - operationId: 'hris_get_employee', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,title,first_name,last_name,name,display_name,gender,ethnicity,date_of_birth,birthday,marital_status,avatar_url,avatar,personal_email,personal_phone_number,work_email,work_phone_number,job_id,remote_job_id,job_title,job_description,department_id,remote_department_id,department,cost_centers,company,manager_id,remote_manager_id,hire_date,start_date,tenure,work_anniversary,employment_type,employment_contract_type,employment_status,termination_date,company_name,company_id,remote_company_id,preferred_language,citizenships,home_location,work_location,employments,custom_fields,created_at,updated_at,benefits,employee_number,national_identity_number,national_identity_numbers,bank_details,skills,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'expand', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be expanded in the response', - schema: { - nullable: true, - example: 'company,employments,work_location,home_location,groups,skills', - type: 'string', - }, - }, - { - name: 'include', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be included in the response', - schema: { - nullable: true, - example: 'avatar_url,avatar,custom_fields,job_description,benefits,bank_details', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The employee with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/EmployeeResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Employee', - tags: ['Employees'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'get_employee', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - patch: { - operationId: 'hris_update_employee', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HrisUpdateEmployeeRequestDto', - }, - }, - }, - }, - responses: { - '200': { - description: 'Record updated successfully', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UpdateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Update Employee', - tags: ['Employees'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'update_employee', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/employees/{id}/invite': { - post: { - operationId: 'hris_invite_employee', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HrisInviteEmployeeRequestDto', - }, - }, - }, - }, - responses: { - '200': { - description: 'Record invited successfully', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InviteEmployeeResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Invite Employee', - tags: ['Employees'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'invite_employee', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/employees/{id}/shifts': { - get: { - operationId: 'hris_list_employee_shifts', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields to return in the response (if empty, all fields are returned)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'HRIS Employee Shifts filters', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - status: { - description: 'Filter to select shifts by status', - type: 'string', - nullable: true, - enum: ['draft', 'published', 'confirmed', 'cancelled', 'unmapped_value'], - }, - starts_after: { - description: 'Filter shifts that start after this date', - type: 'string', - format: 'datetime-local', - example: '2024-01-15T09:00', - }, - ends_before: { - description: 'Filter shifts that end before this date', - type: 'string', - format: 'datetime-local', - example: '2024-01-15T17:00', - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'The shifts related to the employee with the given identifier were retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HrisShiftsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Employee Shifts', - tags: ['Employees', 'Shifts'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'list_employee_shifts', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/employees/{id}/shifts/{subResourceId}': { - get: { - operationId: 'hris_get_employee_shift', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields to return in the response (if empty, all fields are returned)', - schema: { - nullable: true, - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'The shift with the given identifier for the specified employee was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HrisShiftResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Employee Shift', - tags: ['Employees', 'Shifts'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'get_employee_shift', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/employees/{id}/time_off': { - get: { - operationId: 'hris_list_employee_time_off_requests', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,time_off_policy_id,remote_time_off_policy_id,reason,comment,duration,created_at,updated_at,policy,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'HRIS Time Off filters', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - policy_ids: { - description: 'List of time off policy ids to filter by.', - nullable: true, - type: 'array', - items: { - type: 'string', - }, - additionalProperties: false, - }, - start_date: { - description: - 'Filter to include time off requests that start on or after this date.', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - nullable: true, - format: 'date-time', - additionalProperties: false, - }, - end_date: { - description: - 'Filter to include time off requests that end on or before this date.', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - nullable: true, - format: 'date-time', - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'expand', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be expanded in the response', - schema: { - nullable: true, - example: 'policy', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'The time off requests related to the employee with the given identifier were retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TimeOffPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Employee Time Off Requests', - tags: ['Employees', 'Time Off'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'list_employee_time_off_requests', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - post: { - operationId: 'hris_create_employee_time_off_request', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HrisCreateTimeOffRequestDto', - }, - }, - }, - }, - responses: { - '201': { - description: 'Record created successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Create Employee Time Off Request', - tags: ['Employees', 'Time Off'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'create_employee_time_off_request', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/employees/{id}/time_off/{subResourceId}': { - get: { - operationId: 'hris_get_employees_time_off_request', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,time_off_policy_id,remote_time_off_policy_id,reason,comment,duration,created_at,updated_at,policy,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'expand', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be expanded in the response', - schema: { - nullable: true, - example: 'policy', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'The time off request related to the employee with the given identifiers was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TimeOffResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Employees Time Off Request', - tags: ['Employees', 'Time Off'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'get_employees_time_off_request', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - patch: { - operationId: 'hris_update_employee_time_off_request', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HrisCreateTimeOffRequestDto', - }, - }, - }, - }, - responses: { - '200': { - description: 'Record updated successfully', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Update Employee Time Off Request', - tags: ['Employees', 'Time Off'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'update_employee_time_off_request', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - delete: { - operationId: 'hris_cancel_employee_time_off_request', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'Record cancelled successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/DeleteResult', - }, - }, - }, - }, - '204': { - description: - 'The time off request was cancelled successfully but no content was returned.', - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Cancel Employee Time Off Request', - tags: ['Employees', 'Time Off'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'cancel_employee_time_off_request', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/employees/{id}/documents/upload/batch': { - post: { - operationId: 'hris_batch_upload_employee_document', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HrisBatchDocumentUploadRequestDto', - }, - }, - }, - }, - responses: { - '202': { - description: 'Batch operation accepted', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BatchResultApiModel', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Batch Upload Employee Document', - tags: ['Employees', 'Documents'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'batch_upload_employee_document', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/employees/{id}/documents/upload': { - post: { - operationId: 'hris_upload_employee_document', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HrisDocumentsUploadRequestDto', - }, - }, - }, - }, - responses: { - '201': { - description: - 'The document related to the employee with the given identifier was uploaded.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/WriteResultApiModel', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Upload Employee Document', - tags: ['Employees', 'Documents'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'upload_employee_document', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/employees/{id}/documents/{subResourceId}/download': { - get: { - operationId: 'hris_download_employee_document', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'format', - required: false, - in: 'query', - description: 'The format to download the file in', - schema: { - nullable: true, - example: 'base64', - type: 'string', - }, - }, - { - name: 'export_format', - required: false, - in: 'query', - description: 'The export format of the file', - schema: { - nullable: true, - example: 'text/plain', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'The document related to the employee with the given identifiers was retrieved.', - content: { - 'application/pdf': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/msword': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/vnd.openxmlformats-officedocument.wordprocessingml.document': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/vnd.ms-excel': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/vnd.ms-powerpoint': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/vnd.openxmlformats-officedocument.presentationml.presentation': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/rtf': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'text/plain': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'image/jpeg': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'image/png': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'image/gif': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'image/tiff': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'image/bmp': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'image/heic': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/zip': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/gzip': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/json': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/xml': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'text/csv': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/vnd.oasis.opendocument.text': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/vnd.oasis.opendocument.spreadsheet': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'audio/mpeg': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'video/mp4': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'video/webm': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'text/rtf': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/x-rar-compressed': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/x-7z-compressed': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'message/rfc822': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/vnd.ms-outlook': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/octet-stream': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'text/html': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'image/webp': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'application/vnd.oasis.opendocument.presentation': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'audio/wav': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'audio/mp4': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'video/avi': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - 'video/quicktime': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Download Employee Document', - tags: ['Employees', 'Documents'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'download_employee_document', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/employees/{id}/documents': { - get: { - operationId: 'hris_list_employee_documents', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'The documents related to the employee with the given identifier were retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HrisDocumentsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Employee Documents', - tags: ['Employees', 'Documents'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'list_employee_documents', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/employees/{id}/documents/{subResourceId}': { - get: { - operationId: 'hris_get_employee_document', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'The document related to the employee with the given identifiers was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HrisDocumentResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Employee Document', - tags: ['Employees', 'Documents'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'get_employee_document', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/documents/employee_categories': { - get: { - operationId: 'hris_list_employee_categories', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,active,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of employee document categories were retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ReferencePaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Employee Document Categories', - tags: ['Documents'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'list_employee_categories', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/documents/employee_categories/{id}': { - get: { - operationId: 'hris_get_employee_document_category', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,active,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The employee document category with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ReferenceResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Employee Document Category', - tags: ['Documents'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'get_employee_document_category', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/employees/{id}/work_eligibility': { - get: { - operationId: 'hris_list_employee_work_eligibility', - parameters: [ - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,type,sub_type,document,valid_from,valid_to,issued_by,number,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'The work eligibility of the employee with the given identifier were retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/WorkEligibilityPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Employee Work Eligibility', - tags: ['Employees', 'Work Eligibility'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'list_employee_work_eligibility', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - post: { - operationId: 'hris_create_employee_work_eligibility_request', - parameters: [ - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HrisCreateWorkEligibilityRequestDto', - }, - }, - }, - }, - responses: { - '201': { - description: 'Record created successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Create Employee Work Eligibility Request', - tags: ['Employees', 'Work Eligibility'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'create_employee_work_eligibility_request', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/employees/{id}/work_eligibility/{subResourceId}': { - get: { - operationId: 'hris_get_employees_work_eligibility', - parameters: [ - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,type,sub_type,document,valid_from,valid_to,issued_by,number,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'The work eligibility of the employee with the given identifiers was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/WorkEligibilityResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Employees Work Eligibility', - tags: ['Employees', 'Work Eligibility'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'get_employees_work_eligibility', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - patch: { - operationId: 'hris_update_employee_work_eligibility_request', - parameters: [ - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HrisCreateWorkEligibilityRequestDto', - }, - }, - }, - }, - responses: { - '200': { - description: '', - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Update Employee Work Eligibility Request', - tags: ['Employees', 'Work Eligibility'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'update_employee_work_eligibility_request', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/employees/{id}/time_off_balances': { - get: { - operationId: 'hris_list_employee_time_off_balances', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,employee_id,remote_employee_id,policy_id,remote_policy_id,policy,current_balance,initial_balance,balance_unit,balance_start_date,balance_expiry_date,is_unlimited,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'HRIS Time Off Balance filters', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - policy_ids: { - description: 'List of policy ids to filter time off balances by.', - type: 'array', - nullable: true, - items: { - type: 'string', - }, - additionalProperties: false, - required: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'expand', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be expanded in the response', - schema: { - nullable: true, - example: 'policy', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'The list of time off balances of the employee with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TimeOffBalancesPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Employee Time Off Balances', - tags: ['Employees', 'Time Off Balances'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'list_employee_time_off_balances', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/employees/{id}/time_off_balances/{subResourceId}': { - get: { - operationId: 'hris_get_employee_time_off_balance', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,employee_id,remote_employee_id,policy_id,remote_policy_id,policy,current_balance,initial_balance,balance_unit,balance_start_date,balance_expiry_date,is_unlimited,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'expand', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be expanded in the response', - schema: { - nullable: true, - example: 'policy', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'The time off balance of the employee with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TimeOffBalanceResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Employee Time Off Balance', - tags: ['Employees', 'Time Off Balances'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'get_employee_time_off_balance', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/employments': { - get: { - operationId: 'hris_list_employments', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,employee_id,remote_employee_id,job_title,pay_rate,pay_period,pay_frequency,pay_currency,effective_date,end_date,employment_type,employment_contract_type,type,contract_type,change_reason,grade,work_time,payroll_code,fte,created_at,updated_at,start_date,active,department,team,cost_center,cost_centers,division,job,manager,groups,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'expand', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be expanded in the response', - schema: { - nullable: true, - example: 'groups', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of Employments was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/EmploymentsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Employments', - tags: ['Employments'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'list_employments', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/employments/{id}': { - get: { - operationId: 'hris_get_employment', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,employee_id,remote_employee_id,job_title,pay_rate,pay_period,pay_frequency,pay_currency,effective_date,end_date,employment_type,employment_contract_type,type,contract_type,change_reason,grade,work_time,payroll_code,fte,created_at,updated_at,start_date,active,department,team,cost_center,cost_centers,division,job,manager,groups,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'expand', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be expanded in the response', - schema: { - nullable: true, - example: 'groups', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The Employment with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/EmploymentResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Employment', - tags: ['Employments'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'get_employment', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/employees/{id}/employments': { - get: { - operationId: 'hris_list_employee_employments', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,employee_id,remote_employee_id,job_title,pay_rate,pay_period,pay_frequency,pay_currency,effective_date,end_date,employment_type,employment_contract_type,type,contract_type,change_reason,grade,work_time,payroll_code,fte,created_at,updated_at,start_date,active,department,team,cost_center,cost_centers,division,job,manager,groups,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'expand', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be expanded in the response', - schema: { - nullable: true, - example: 'groups', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of Employee Employments was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/EmploymentsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Employee Employments', - tags: ['Employees', 'Employments'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'list_employee_employments', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - post: { - operationId: 'hris_create_employee_employment', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HrisCreateEmploymentRequestDto', - }, - }, - }, - }, - responses: { - '201': { - description: 'The employee employment was created successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Create Employee Employment', - tags: ['Employees', 'Employments'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'create_employee_employment', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/employees/{id}/employments/{subResourceId}': { - get: { - operationId: 'hris_get_employee_employment', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,employee_id,remote_employee_id,job_title,pay_rate,pay_period,pay_frequency,pay_currency,effective_date,end_date,employment_type,employment_contract_type,type,contract_type,change_reason,grade,work_time,payroll_code,fte,created_at,updated_at,start_date,active,department,team,cost_center,cost_centers,division,job,manager,groups,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'expand', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be expanded in the response', - schema: { - nullable: true, - example: 'groups', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The Employee Employment with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/EmploymentResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Employee Employment', - tags: ['Employees', 'Employments'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'get_employee_employment', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - patch: { - operationId: 'hris_update_employee_employment', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HrisUpdateEmploymentRequestDto', - }, - }, - }, - }, - responses: { - '200': { - description: 'The employee employment was updated successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UpdateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Update Employee Employment', - tags: ['Employees', 'Employments'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'update_employee_employment', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/groups': { - get: { - operationId: 'hris_list_groups', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of groups was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HRISGroupsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Groups', - tags: ['Groups'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'list_groups', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/groups/departments': { - get: { - operationId: 'hris_list_department_groups', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of department groups was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HRISDepartmentsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Department Groups', - tags: ['Groups'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'list_department_groups', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/groups/cost_centers': { - get: { - operationId: 'hris_list_cost_center_groups', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,type,distribution_percentage,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of cost center groups was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HRISCostCenterPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Cost Center Groups', - tags: ['Groups'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'list_cost_center_groups', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/groups/teams': { - get: { - operationId: 'hris_list_team_groups', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of team groups was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HRISTeamsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Team Groups', - tags: ['Groups'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'list_team_groups', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/groups/divisions': { - get: { - operationId: 'hris_list_division_groups', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of division groups was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HRISDivisionsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Division Groups', - tags: ['Groups'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'list_division_groups', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/groups/companies': { - get: { - operationId: 'hris_list_companies_groups', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,full_name,display_name,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of companies groups was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CompaniesPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Companies Groups', - tags: ['Groups'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'list_companies_groups', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/groups/{id}': { - get: { - operationId: 'hris_get_group', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The group with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HRISGroupsResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Group', - tags: ['Groups'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'get_group', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/groups/departments/{id}': { - get: { - operationId: 'hris_get_department_group', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The department group with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HRISDepartmentsResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Department Group', - tags: ['Groups'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'get_department_group', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/groups/cost_centers/{id}': { - get: { - operationId: 'hris_get_cost_center_group', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,type,distribution_percentage,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The cost center group with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HRISCostCenterResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Cost Center Group', - tags: ['Groups'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'get_cost_center_group', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/groups/teams/{id}': { - get: { - operationId: 'hris_get_team_group', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The team group with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HRISTeamsResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Team Group', - tags: ['Groups'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'get_team_group', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/groups/divisions/{id}': { - get: { - operationId: 'hris_get_division_group', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The division group with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HRISDivisionsResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Division Group', - tags: ['Groups'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'get_division_group', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/groups/companies/{id}': { - get: { - operationId: 'hris_get_company_group', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,full_name,display_name,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The company group with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CompanyResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Company Group', - tags: ['Groups'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'get_company_group', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/jobs': { - get: { - operationId: 'hris_list_jobs', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,code,title,description,status,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of jobs was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HrisJobsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Jobs', - tags: ['Jobs'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'list_jobs', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/jobs/{id}': { - get: { - operationId: 'hris_get_job', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,code,title,description,status,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The job with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HrisJobResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Job', - tags: ['Jobs'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'get_job', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/locations': { - get: { - operationId: 'hris_list_locations', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,employee_id,remote_employee_id,name,phone_number,street_1,street_2,city,state,zip_code,country,location_type,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of work locations was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HRISLocationsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Work Locations', - tags: ['Locations'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'list_locations', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/locations/{id}': { - get: { - operationId: 'hris_get_location', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,employee_id,remote_employee_id,name,phone_number,street_1,street_2,city,state,zip_code,country,location_type,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The work location with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HRISLocationResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Work Location', - tags: ['Locations'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'get_location', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/positions': { - get: { - operationId: 'hris_list_positions', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields to return in the response (if empty, all fields are returned)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'status', - required: false, - in: 'query', - description: 'Filter positions by status', - 'x-speakeasy-unknown-values': 'allow', - schema: { - nullable: true, - example: 'open', - type: 'string', - enum: ['open', 'draft', 'closed', 'paused', 'unmapped_value', null], - }, - }, - ], - responses: { - '200': { - description: 'The list of positions was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PositionsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Positions', - tags: ['Positions'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'list_positions', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/positions/{id}': { - get: { - operationId: 'hris_get_position', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields to return in the response (if empty, all fields are returned)', - schema: { - nullable: true, - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The position with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PositionResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Position', - tags: ['Positions'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'get_position', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/time_entries': { - get: { - operationId: 'hris_list_time_entries', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,employee_id,remote_employee_id,start_time,end_time,hours_worked,break_duration,labor_type,location,status,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'HRIS Time Entries filters', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - employee_id: { - description: 'Filter to select time entries by employee_id', - type: 'string', - nullable: true, - additionalProperties: false, - }, - start_time: { - description: 'Filter to select time entries after a given time', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - nullable: true, - additionalProperties: false, - }, - end_time: { - description: 'Filter to select time entries before a given time', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of time entries was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TimeEntriesPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Time Entries', - tags: ['Time Entries'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'list_time_entries', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/time_entries/{id}': { - get: { - operationId: 'hris_get_time_entries', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,employee_id,remote_employee_id,start_time,end_time,hours_worked,break_duration,labor_type,location,status,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The time entry with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TimeEntriesResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Time Entry', - tags: ['Time Entries'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'get_time_entries', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/time_off': { - get: { - operationId: 'hris_list_time_off_requests', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,time_off_policy_id,remote_time_off_policy_id,reason,comment,duration,created_at,updated_at,policy,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'HRIS Time Off filters', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - policy_ids: { - description: 'List of time off policy ids to filter by.', - nullable: true, - type: 'array', - items: { - type: 'string', - }, - additionalProperties: false, - }, - start_date: { - description: - 'Filter to include time off requests that start on or after this date.', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - nullable: true, - format: 'date-time', - additionalProperties: false, - }, - end_date: { - description: - 'Filter to include time off requests that end on or before this date.', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - nullable: true, - format: 'date-time', - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'expand', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be expanded in the response', - schema: { - nullable: true, - example: 'policy', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of time off requests was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TimeOffPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List time off requests', - tags: ['Time Off'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'list_time_off_requests', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/time_off/{id}': { - get: { - operationId: 'hris_get_time_off_request', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,time_off_policy_id,remote_time_off_policy_id,reason,comment,duration,created_at,updated_at,policy,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'expand', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be expanded in the response', - schema: { - nullable: true, - example: 'policy', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The time off request with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TimeOffResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get time off request', - tags: ['Time Off'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'get_time_off_request', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/shifts': { - get: { - operationId: 'hris_list_shifts', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields to return in the response (if empty, all fields are returned)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'HRIS Shifts filters', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - status: { - description: 'Filter to select shifts by status', - type: 'string', - nullable: true, - enum: ['draft', 'published', 'confirmed', 'cancelled', 'unmapped_value'], - }, - starts_after: { - description: 'Filter shifts that start after this date', - type: 'string', - format: 'datetime-local', - example: '2024-01-15T09:00', - }, - ends_before: { - description: 'Filter shifts that end before this date', - type: 'string', - format: 'datetime-local', - example: '2024-01-15T17:00', - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of shifts was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HrisShiftsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Shifts', - tags: ['Shifts'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'list_shifts', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/shifts/{id}': { - get: { - operationId: 'hris_get_shift', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields to return in the response (if empty, all fields are returned)', - schema: { - nullable: true, - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The shift with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HrisShiftResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Shift', - tags: ['Shifts'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'get_shift', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/time_off_types': { - get: { - deprecated: true, - operationId: 'hris_list_time_off_types', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,active,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of time off types was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ReferencePaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List time off types', - tags: ['Time Off'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'list_time_off_types', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/time_off_types/{id}': { - get: { - deprecated: true, - operationId: 'hris_get_time_off_type', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,active,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The time off type with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ReferenceResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get time off type', - tags: ['Time Off'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'get_time_off_type', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/time_off_policies': { - get: { - operationId: 'hris_list_time_off_policies', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,description,type,duration_unit,reasons,updated_at,created_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'HRIS Time-Off Policies filters', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - type: { - description: 'Filter to select time-off policies by type', - enum: [ - 'sick', - 'unmapped_value', - 'vacation', - 'long_term_disability', - 'short_term_disability', - 'absent', - 'comp_time', - 'training', - 'annual_leave', - 'leave_of_absence', - 'break', - 'child_care_leave', - 'maternity_leave', - 'jury_duty', - 'sabbatical', - 'accident', - 'paid', - 'unpaid', - 'holiday', - 'personal', - 'in_lieu', - 'bereavement', - 'other', - null, - ], - nullable: true, - type: 'string', - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of time off policies was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TimeOffPoliciesPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Time Off Policies', - tags: ['Time Off Policies'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'list_time_off_policies', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/time_off_policies/{id}': { - get: { - operationId: 'hris_get_time_off_policy', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,description,type,duration_unit,reasons,updated_at,created_at,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The time off policy with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TimeOffPolicyResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Time Off Policy', - tags: ['Time Off Policies'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'get_time_off_policy', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/employees/{id}/time_off_policies': { - get: { - operationId: 'hris_list_employee_time_off_policies', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,description,type,duration_unit,reasons,updated_at,created_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'HRIS Time-Off Policies filters', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - type: { - description: 'Filter to select time-off policies by type', - enum: [ - 'sick', - 'unmapped_value', - 'vacation', - 'long_term_disability', - 'short_term_disability', - 'absent', - 'comp_time', - 'training', - 'annual_leave', - 'leave_of_absence', - 'break', - 'child_care_leave', - 'maternity_leave', - 'jury_duty', - 'sabbatical', - 'accident', - 'paid', - 'unpaid', - 'holiday', - 'personal', - 'in_lieu', - 'bereavement', - 'other', - null, - ], - nullable: true, - type: 'string', - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'The time off policies related to the employee with the given identifier were retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TimeOffPoliciesPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Assigned Time Off Policies', - tags: ['Employees', 'Time Off Policies'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'list_employee_time_off_policies', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/benefits': { - get: { - operationId: 'hris_list_benefits', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,benefit_type,provider,description,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of Benefits was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HRISBenefitsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List benefits', - tags: ['Benefits'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'list_benefits', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/benefits/{id}': { - get: { - operationId: 'hris_get_benefit', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,benefit_type,provider,description,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The Benefit with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/HRISBenefitResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Benefit', - tags: ['Benefits'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'get_benefit', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/employees/{id}/skills': { - get: { - operationId: 'hris_list_employee_skills', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,active,language,maximum_proficiency,minimum_proficiency,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'The skills related to the employee with the given identifier were retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/EntitySkillsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Employee Skills', - tags: ['Employees', 'Skills'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'list_employee_skills', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - post: { - operationId: 'hris_create_employee_skill', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/EntitySkillsCreateRequestDto', - }, - }, - }, - }, - responses: { - '201': { - description: 'The skill was created successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Create Employee Skill', - tags: ['Employees', 'Skills'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'create_employee_skill', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/employees/{id}/skills/{subResourceId}': { - get: { - operationId: 'hris_get_employee_skill', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,active,language,maximum_proficiency,minimum_proficiency,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'The skill related to the employee with the given identifiers was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/EntitySkillResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Employee Skill', - tags: ['Employees', 'Skills'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'get_employee_skill', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/employees/{id}/tasks': { - get: { - operationId: 'hris_list_employee_tasks', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,employee_id,remote_employee_id,name,description,type,status,due_date,completion_date,assigned_by_employee_id,remote_assigned_by_employee_id,assigned_by_employee_name,link_to_task,extracted_links,next_task_id,remote_next_task_id,parent_process_name,comments,attachments,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - }, - created_after: { - description: - 'Use a string with a date to only select results created after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - }, - }, - additionalProperties: false, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'expand', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be expanded in the response', - schema: { - nullable: true, - example: 'attachments', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'The list of tasks for the employee with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TasksPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Employee Tasks', - tags: ['Employees', 'Tasks'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'list_employee_tasks', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/employees/{id}/tasks/{subResourceId}': { - get: { - operationId: 'hris_get_employee_task', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,employee_id,remote_employee_id,name,description,type,status,due_date,completion_date,assigned_by_employee_id,remote_assigned_by_employee_id,assigned_by_employee_name,link_to_task,extracted_links,next_task_id,remote_next_task_id,parent_process_name,comments,attachments,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'expand', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be expanded in the response', - schema: { - nullable: true, - example: 'attachments', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The task with the given identifier for the employee was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TaskResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Employee Task', - tags: ['Employees', 'Tasks'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'get_employee_task', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - patch: { - operationId: 'hris_update_employee_task', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UpdateTaskRequestDto', - }, - }, - }, - }, - responses: { - '200': { - description: 'The task has been successfully updated.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UpdateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Update Employee Task', - tags: ['Employees', 'Tasks'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'update_employee_task', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/tasks': { - get: { - operationId: 'hris_list_tasks', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,employee_id,remote_employee_id,name,description,type,status,due_date,completion_date,assigned_by_employee_id,remote_assigned_by_employee_id,assigned_by_employee_name,link_to_task,extracted_links,next_task_id,remote_next_task_id,parent_process_name,comments,attachments,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - }, - created_after: { - description: - 'Use a string with a date to only select results created after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - }, - }, - additionalProperties: false, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'expand', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be expanded in the response', - schema: { - nullable: true, - example: 'attachments', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of tasks was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TasksPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Tasks', - tags: ['Tasks'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'list_tasks', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/hris/tasks/{id}': { - get: { - operationId: 'hris_get_task', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,employee_id,remote_employee_id,name,description,type,status,due_date,completion_date,assigned_by_employee_id,remote_assigned_by_employee_id,assigned_by_employee_name,link_to_task,extracted_links,next_task_id,remote_next_task_id,parent_process_name,comments,attachments,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'expand', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be expanded in the response', - schema: { - nullable: true, - example: 'attachments', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The task with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TaskResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Task', - tags: ['Tasks'], - 'x-speakeasy-group': 'hris', - 'x-speakeasy-name-override': 'get_task', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - }, - info: { - title: 'HRIS', - description: 'The documentation for the StackOne Unified API - HRIS', - version: '1.0.0', - contact: {}, - }, - tags: [ - { - name: 'Benefits', - description: 'Employee benefits and entitlements.', - }, - { - name: 'Companies', - description: 'Organizations or legal entities.', - }, - { - name: 'Custom Field Definitions', - description: 'Definitions for custom fields.', - }, - { - name: 'Documents', - description: 'Employee related documents.', - }, - { - name: 'Employees', - description: 'People employed by the company.', - }, - { - name: 'Employments', - description: "Details of an employee's employment.", - }, - { - name: 'Groups', - description: 'Organizational groups or teams.', - }, - { - name: 'Jobs', - description: 'Job positions or roles.', - }, - { - name: 'Locations', - description: 'Physical or virtual work locations.', - }, - { - name: 'Positions', - description: 'Job positions available for hiring.', - }, - { - name: 'Shifts', - description: 'Employee work shifts and schedules.', - }, - { - name: 'Skills', - description: 'Skills and competencies tracked for employees.', - }, - { - name: 'Tasks', - description: 'Tasks or assignments for employees.', - }, - { - name: 'Time Entries', - description: 'Records of hours worked or activities performed.', - }, - { - name: 'Time Off', - description: 'Employee leave and time off records.', - }, - { - name: 'Time Off Balances', - description: 'Available leave balances for employees.', - }, - { - name: 'Time Off Policies', - description: 'Rules and policies for employee leave.', - }, - { - name: 'Training', - description: 'Training records for employees.', - }, - { - name: 'Training Content', - description: 'Training content for employees.', - }, - { - name: 'Work Eligibility', - description: 'Eligibility status for employment.', - }, - ], - servers: [ - { - url: 'https://api.stackone.com', - }, - ], - components: { - securitySchemes: { - basic: { - type: 'http', - scheme: 'basic', - }, - }, - schemas: { - BadGatewayResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 502, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Gateway', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - BadRequestResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 400, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Request', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - data: { - description: 'Error details', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/UnifiedError', - }, - ], - }, - provider_errors: { - description: 'List of provider-specific errors', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/ProviderError', - }, - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - BankAccountTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - description: 'The type of bank account', - enum: [ - 'savings', - 'checking', - 'current', - 'business', - 'personal', - 'other', - 'unmapped_value', - null, - ], - example: 'checking', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - example: 'checking', - nullable: true, - }, - }, - }, - BatchResultApiModel: { - type: 'object', - properties: { - statusCode: { - type: 'number', - example: 202, - nullable: true, - }, - message: { - type: 'string', - example: 'Batch operation accepted', - nullable: true, - }, - timestamp: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - errors: { - type: 'array', - example: [['Missing field: name'], [], []], - items: { - type: 'array', - items: { - type: 'string', - }, - }, - nullable: true, - }, - }, - }, - BenefitsTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - description: 'The type of the benefit', - enum: [ - 'retirement_savings', - 'health_savings', - 'other', - 'health_insurance', - 'insurance', - 'unmapped_value', - null, - ], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - ClearingCode: { - type: 'object', - properties: { - type: { - description: 'The type of clearing code', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ClearingCodeTypeEnum', - }, - ], - }, - value: { - type: 'string', - description: 'The clearing code value', - example: '12-34-56', - nullable: true, - }, - }, - }, - ClearingCodeTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - description: 'The type of clearing code', - enum: [ - 'sort_code', - 'building_society_reference', - 'aba_routing', - 'chips_participant_id', - 'transit_number', - 'institution_number', - 'bsb_code', - 'ifsc_code', - 'micr_code', - 'clabe', - 'cnaps_code', - 'ch_bank_clearing_code', - 'ch_sic_code', - 'zengin_code', - 'nz_clearing_code', - 'hk_bank_code', - 'blz', - 'at_bankleitzahl', - 'nuban', - 'se_bankgiro_code', - 'unmapped_value', - null, - ], - example: 'sort_code', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - example: 'sort_code', - nullable: true, - }, - }, - }, - CompaniesPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/Company', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - Company: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - name: { - type: 'string', - description: 'The name of the company', - example: 'StackOne Technologies PLC', - nullable: true, - }, - full_name: { - type: 'string', - description: 'The full name of the company', - example: 'American Express Company', - nullable: true, - }, - display_name: { - type: 'string', - description: 'The display name of the company', - example: 'StackOne', - nullable: true, - }, - created_at: { - type: 'string', - description: 'The created_at date', - example: '2023-02-23T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The updated_at date', - example: '2024-02-23T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - CompanyResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/Company', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - ConfidentialEnumApiModel: { - type: 'object', - properties: { - value: { - type: 'string', - description: 'Whether the file is confidential or not', - enum: ['true', 'false', 'unmapped_value', null], - example: 'true', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - example: 'public', - nullable: true, - }, - }, - }, - ConflictResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 409, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Conflict', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - Content: { - type: 'object', - properties: { - url: { - type: 'string', - description: 'URL where the file content is located', - example: 'https://example.com/file.pdf', - nullable: true, - }, - unified_url: { - type: 'string', - description: 'Unified download URL for retrieving file content.', - example: - 'https://api.stackone.com/unified/hris/employees/12345/documents/67890/download', - nullable: true, - }, - file_format: { - description: 'The file format of the file', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/FileFormatEnum', - }, - ], - }, - }, - }, - ContractTypeApiModel: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - label: { - type: 'string', - description: 'The label of the employment type', - example: 'Full-Time', - nullable: true, - }, - contract_type: { - description: 'The employment work schedule type (e.g., full-time, part-time)', - example: 'full_time', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ContractTypeEnum', - }, - ], - }, - }, - }, - ContractTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: ['full_time', 'shifts', 'part_time', 'unmapped_value', null], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - CostCenters: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - example: 'R&D', - nullable: true, - }, - distribution_percentage: { - type: 'number', - example: 100, - nullable: true, - }, - }, - }, - CountryCodeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'AF', - 'AL', - 'DZ', - 'AS', - 'AD', - 'AO', - 'AI', - 'AQ', - 'AG', - 'AR', - 'AM', - 'AW', - 'AU', - 'AT', - 'AZ', - 'BS', - 'BH', - 'BD', - 'BB', - 'BY', - 'BE', - 'BZ', - 'BJ', - 'BM', - 'BT', - 'BO', - 'BQ', - 'BA', - 'BW', - 'BV', - 'BR', - 'IO', - 'BN', - 'BG', - 'BF', - 'BI', - 'KH', - 'CM', - 'CA', - 'CV', - 'KY', - 'CF', - 'TD', - 'CL', - 'CN', - 'CX', - 'CC', - 'CO', - 'KM', - 'CG', - 'CD', - 'CK', - 'CR', - 'HR', - 'CU', - 'CW', - 'CY', - 'CZ', - 'CI', - 'DK', - 'DJ', - 'DM', - 'DO', - 'EC', - 'EG', - 'SV', - 'GQ', - 'ER', - 'EE', - 'ET', - 'FK', - 'FO', - 'FJ', - 'FI', - 'FR', - 'GF', - 'PF', - 'TF', - 'GA', - 'GM', - 'GE', - 'DE', - 'GH', - 'GI', - 'GR', - 'GL', - 'GD', - 'GP', - 'GU', - 'GT', - 'GG', - 'GN', - 'GW', - 'GY', - 'HT', - 'HM', - 'VA', - 'HN', - 'HK', - 'HU', - 'IS', - 'IN', - 'ID', - 'IR', - 'IQ', - 'IE', - 'IM', - 'IL', - 'IT', - 'JM', - 'JP', - 'JE', - 'JO', - 'KZ', - 'KE', - 'KI', - 'KP', - 'KR', - 'KW', - 'KG', - 'LA', - 'LV', - 'LB', - 'LS', - 'LR', - 'LY', - 'LI', - 'LT', - 'LU', - 'MO', - 'MK', - 'MG', - 'MW', - 'MY', - 'MV', - 'ML', - 'MT', - 'MH', - 'MQ', - 'MR', - 'MU', - 'YT', - 'MX', - 'FM', - 'MD', - 'MC', - 'MN', - 'ME', - 'MS', - 'MA', - 'MZ', - 'MM', - 'NA', - 'NR', - 'NP', - 'NL', - 'NC', - 'NZ', - 'NI', - 'NE', - 'NG', - 'NU', - 'NF', - 'MP', - 'NO', - 'OM', - 'PK', - 'PW', - 'PS', - 'PA', - 'PG', - 'PY', - 'PE', - 'PH', - 'PN', - 'PL', - 'PT', - 'PR', - 'QA', - 'RO', - 'RU', - 'RW', - 'RE', - 'BL', - 'SH', - 'KN', - 'LC', - 'MF', - 'PM', - 'VC', - 'WS', - 'SM', - 'ST', - 'SA', - 'SN', - 'RS', - 'SC', - 'SL', - 'SG', - 'SX', - 'SK', - 'SI', - 'SB', - 'SO', - 'ZA', - 'GS', - 'SS', - 'ES', - 'LK', - 'SD', - 'SR', - 'SJ', - 'SZ', - 'SE', - 'CH', - 'SY', - 'TW', - 'TJ', - 'TZ', - 'TH', - 'TL', - 'TG', - 'TK', - 'TO', - 'TT', - 'TN', - 'TR', - 'TM', - 'TC', - 'TV', - 'UG', - 'UA', - 'AE', - 'GB', - 'US', - 'UM', - 'UY', - 'UZ', - 'VU', - 'VE', - 'VN', - 'VG', - 'VI', - 'WF', - 'EH', - 'YE', - 'ZM', - 'ZW', - 'unmapped_value', - null, - ], - description: 'The ISO3166-1 Alpha2 Code of the Country', - example: 'US', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - CreateCostCenterApiModel: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - example: 'R&D', - nullable: true, - }, - distribution_percentage: { - type: 'number', - example: 100, - nullable: true, - }, - }, - }, - CreateEmployeeEmploymentApiModel: { - type: 'object', - properties: { - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - job_title: { - type: 'string', - description: 'The job title of the employee', - example: 'Software Engineer', - nullable: true, - }, - pay_rate: { - type: 'string', - description: 'The amount of compensation for the employee', - example: '40.00', - nullable: true, - }, - pay_period: { - description: 'The time period over which the pay rate is calculated', - example: 'monthly', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/PayPeriodEnum', - }, - ], - }, - pay_frequency: { - description: 'How often the employee is paid', - example: 'hourly', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/PayFrequencyEnum', - }, - ], - }, - pay_currency: { - type: 'string', - description: 'The currency used for pay', - example: 'USD', - nullable: true, - }, - end_date: { - type: 'string', - description: 'The end date of employment', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - grade: { - description: 'Represents the employeeโ€™s position within the organizational hierarchy.', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/EmploymentGradeApiModel', - }, - ], - }, - employment_type: { - description: 'The type of employment (e.g., contractor, permanent)', - example: 'permanent', - deprecated: true, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/EmploymentTypeEnum', - }, - ], - }, - employment_contract_type: { - description: 'The employment work schedule type (e.g., full-time, part-time)', - example: 'full_time', - deprecated: true, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/EmploymentScheduleTypeEnum', - }, - ], - }, - type: { - description: 'The type of employment', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TypeApiModel', - }, - ], - }, - contract_type: { - description: 'The employment work schedule type', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ContractTypeApiModel', - }, - ], - }, - work_time: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/WorkTimeApiModel', - }, - ], - }, - payroll_code: { - type: 'string', - description: 'The payroll code of the employee', - example: 'PC1', - nullable: true, - }, - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - effective_date: { - type: 'string', - description: 'The employee effective date', - example: '2021-01-01T00:00:00.000Z', - format: 'date-time', - deprecated: true, - nullable: true, - }, - }, - }, - CreateEmployeeLocationApiModel: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'The name of the location', - example: 'Woolsthorpe Manor', - nullable: true, - }, - phone_number: { - type: 'string', - description: 'The phone number of the location', - example: '+44 1476 860 364', - nullable: true, - }, - street_1: { - type: 'string', - description: 'The first line of the address', - example: 'Water Lane', - nullable: true, - }, - street_2: { - type: 'string', - description: 'The second line of the address', - example: 'Woolsthorpe by Colsterworth', - nullable: true, - }, - city: { - type: 'string', - description: 'The city where the location is situated', - example: 'Grantham', - nullable: true, - }, - zip_code: { - type: 'string', - description: 'The ZIP code/Postal code of the location', - example: 'NG33 5NR', - nullable: true, - }, - country: { - description: 'The country code', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/CountryCodeEnum', - }, - ], - }, - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - state: { - description: 'The ISO3166-2 sub division where the location is situated', - example: 'GB-LIN', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ISO3166_2SubDivisionEnum', - }, - ], - }, - }, - }, - CreateEmploymentApiModel: { - type: 'object', - properties: { - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - job_title: { - type: 'string', - description: 'The job title of the employee', - example: 'Software Engineer', - nullable: true, - }, - pay_rate: { - type: 'string', - description: 'The amount of compensation for the employee', - example: '40.00', - nullable: true, - }, - pay_period: { - description: 'The time period over which the pay rate is calculated', - example: 'monthly', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/PayPeriodEnum', - }, - ], - }, - pay_frequency: { - description: 'How often the employee is paid', - example: 'hourly', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/PayFrequencyEnum', - }, - ], - }, - pay_currency: { - type: 'string', - description: 'The currency used for pay', - example: 'USD', - nullable: true, - }, - effective_date: { - type: 'string', - description: 'The effective date of the employment contract', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - end_date: { - type: 'string', - description: 'The end date of employment', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - grade: { - description: 'Represents the employeeโ€™s position within the organizational hierarchy.', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/EmploymentGradeApiModel', - }, - ], - }, - employment_type: { - description: 'The type of employment (e.g., contractor, permanent)', - example: 'permanent', - deprecated: true, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/EmploymentTypeEnum', - }, - ], - }, - employment_contract_type: { - description: 'The employment work schedule type (e.g., full-time, part-time)', - example: 'full_time', - deprecated: true, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/EmploymentScheduleTypeEnum', - }, - ], - }, - type: { - description: 'The type of employment', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TypeApiModel', - }, - ], - }, - contract_type: { - description: 'The employment work schedule type', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ContractTypeApiModel', - }, - ], - }, - work_time: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/WorkTimeApiModel', - }, - ], - }, - payroll_code: { - type: 'string', - description: 'The payroll code of the employee', - example: 'PC1', - nullable: true, - }, - job_id: { - type: 'string', - description: 'The employee job id', - example: '5290', - nullable: true, - }, - }, - }, - CreateHRISBenefit: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'The name of the benefit', - example: 'Health Insurance', - nullable: true, - }, - benefit_type: { - description: 'The type of the benefit', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/BenefitsTypeEnum', - }, - ], - }, - provider: { - type: 'string', - description: 'The provider of the benefit', - example: 'Aetna', - nullable: true, - }, - description: { - type: 'string', - description: 'The description of the benefit', - example: 'Health insurance for employees', - nullable: true, - }, - created_at: { - type: 'string', - description: 'The date and time the benefit was created', - example: '2021-01-01T00:00:00Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The date and time the benefit was last updated', - example: '2021-01-01T00:00:00Z', - format: 'date-time', - nullable: true, - }, - }, - }, - CreateResult: { - type: 'object', - properties: { - statusCode: { - type: 'number', - example: 201, - }, - message: { - type: 'string', - example: 'Record created successfully.', - }, - timestamp: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - }, - data: { - $ref: '#/components/schemas/CreateResultDataApiModel', - }, - }, - required: ['statusCode', 'message', 'timestamp', 'data'], - }, - CreateResultDataApiModel: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - }, - }, - CurrencyCodeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'AED', - 'AFN', - 'ALL', - 'AMD', - 'ANG', - 'AOA', - 'ARS', - 'AUD', - 'AWG', - 'AZN', - 'BAM', - 'BBD', - 'BDT', - 'BGN', - 'BHD', - 'BIF', - 'BMD', - 'BND', - 'BOB', - 'BRL', - 'BSD', - 'BTN', - 'BWP', - 'BYN', - 'BZD', - 'CAD', - 'CDF', - 'CHF', - 'CLP', - 'CNY', - 'COP', - 'CRC', - 'CUC', - 'CUP', - 'CVE', - 'CZK', - 'DJF', - 'DKK', - 'DOP', - 'DZD', - 'EGP', - 'ERN', - 'ETB', - 'EUR', - 'FJD', - 'FKP', - 'GBP', - 'GEL', - 'GHS', - 'GIP', - 'GMD', - 'GNF', - 'GTQ', - 'GYD', - 'HKD', - 'HNL', - 'HRK', - 'HTG', - 'HUF', - 'IDR', - 'ILS', - 'INR', - 'IQD', - 'IRR', - 'ISK', - 'JMD', - 'JOD', - 'JPY', - 'KES', - 'KGS', - 'KHR', - 'KMF', - 'KPW', - 'KRW', - 'KWD', - 'KYD', - 'KZT', - 'LAK', - 'LBP', - 'LKR', - 'LRD', - 'LSL', - 'LYD', - 'MAD', - 'MDL', - 'MGA', - 'MKD', - 'MMK', - 'MNT', - 'MOP', - 'MRU', - 'MUR', - 'MVR', - 'MWK', - 'MXN', - 'MYR', - 'MZN', - 'NAD', - 'NGN', - 'NIO', - 'NOK', - 'NPR', - 'NZD', - 'OMR', - 'PAB', - 'PEN', - 'PGK', - 'PHP', - 'PKR', - 'PLN', - 'PYG', - 'QAR', - 'RON', - 'RSD', - 'RUB', - 'RWF', - 'SAR', - 'SBD', - 'SCR', - 'SDG', - 'SEK', - 'SGD', - 'SHP', - 'SLL', - 'SOS', - 'SRD', - 'SSP', - 'STN', - 'SYP', - 'SZL', - 'THB', - 'TJS', - 'TMT', - 'TND', - 'TOP', - 'TRY', - 'TTD', - 'TWD', - 'TZS', - 'UAH', - 'UGX', - 'USD', - 'UYU', - 'UZS', - 'VES', - 'VND', - 'VUV', - 'WST', - 'XAF', - 'XCD', - 'XDR', - 'XOF', - 'XPF', - 'YER', - 'ZAR', - 'ZMW', - 'ZWL', - 'unmapped_value', - null, - ], - description: 'ISO 4217 currency code', - example: 'USD', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - example: 'USD', - nullable: true, - }, - }, - }, - CustomFieldDefinition: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - nullable: true, - }, - description: { - type: 'string', - nullable: true, - }, - type: { - description: 'The type of the custom field.', - example: 'Dropdown', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/CustomFieldTypeEnum', - }, - ], - }, - options: { - description: 'An array of possible options for the custom field.', - example: [ - { - id: 'option_1', - value: 'Not Started', - }, - { - id: 'option_2', - value: 'In Progress', - }, - { - id: 'option_3', - value: 'Completed', - }, - ], - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CustomFieldOption', - }, - }, - }, - }, - CustomFieldDefinitionResultApiModel: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/CustomFieldDefinition', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - CustomFieldDefinitionsPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/CustomFieldDefinition', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - CustomFieldOption: { - type: 'object', - properties: { - id: { - type: 'string', - description: - 'The unique identifier for the option to be used when updating the custom field', - example: 'option_123', - }, - value: { - description: 'The human readable value of the option', - example: 'Not Started', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - }, - }, - required: ['id', 'value'], - }, - CustomFields: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'The name of the custom field.', - example: 'Training Completion Status', - nullable: true, - }, - value: { - description: 'The value associated with the custom field.', - example: 'Completed', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - { - type: 'string', - format: 'date-time', - }, - ], - nullable: true, - }, - value_id: { - type: 'string', - description: 'The unique identifier for the value of the custom field.', - example: 'value_456', - nullable: true, - }, - remote_value_id: { - type: 'string', - description: "Provider's unique identifier for the value of the custom field.", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - }, - }, - CustomFieldTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'date', - 'float', - 'integer', - 'list', - 'checkbox', - 'text', - 'boolean', - 'single_select', - 'multi_select', - 'url', - 'other', - 'unmapped_value', - null, - ], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - DeleteResult: { - type: 'object', - properties: { - statusCode: { - type: 'number', - example: 204, - }, - message: { - type: 'string', - example: 'Record deleted successfully.', - }, - timestamp: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - DepartmentTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'department', - 'company', - 'division', - 'group', - 'project', - 'team', - 'unmapped_value', - null, - ], - example: 'department', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - DivisionTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'department', - 'company', - 'division', - 'group', - 'project', - 'cost_center', - 'team', - 'unmapped_value', - null, - ], - example: 'division', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - DownloadApiModel: { - type: 'object', - properties: { - headers: { - description: 'Headers related to the download', - allOf: [ - { - $ref: '#/components/schemas/DownloadHeadersApiModel', - }, - ], - }, - data: { - type: 'string', - description: 'The file data in binary format', - format: 'binary', - }, - }, - required: ['headers', 'data'], - }, - DownloadHeadersApiModel: { - type: 'object', - properties: { - 'content-disposition': { - type: 'string', - description: 'Value of the Content-Disposition header', - example: 'attachment; filename="example.pdf"', - nullable: true, - }, - 'content-type': { - type: 'string', - description: 'MIME type of the file', - example: 'application/pdf', - nullable: true, - }, - 'content-length': { - type: 'number', - description: 'Size of the content in bytes', - example: 1024, - nullable: true, - }, - 'content-range': { - type: 'string', - description: 'Range of the content being sent', - example: 'bytes 0-1023/2048', - nullable: true, - }, - 'content-encoding': { - type: 'string', - description: 'Encoding of the content', - example: 'gzip', - nullable: true, - }, - 'transfer-encoding': { - type: 'string', - description: 'Transfer encoding type', - example: 'chunked', - nullable: true, - }, - }, - }, - Employee: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - title: { - type: 'string', - description: "The prefix of the employee's name (e.g., Mr, Ms, Dr)", - example: 'Mr', - nullable: true, - }, - first_name: { - type: 'string', - description: 'The employee first name', - example: 'Isaac', - nullable: true, - }, - last_name: { - type: 'string', - description: 'The employee last name', - example: 'Newton', - nullable: true, - }, - name: { - type: 'string', - description: 'The employee name', - example: 'Isaac Newton', - nullable: true, - }, - display_name: { - type: 'string', - description: 'The employee display name', - example: 'Sir Isaac Newton', - nullable: true, - }, - avatar_url: { - type: 'string', - description: 'The employee avatar Url', - example: 'https://example.com/avatar.png', - nullable: true, - }, - personal_email: { - type: 'string', - description: 'The employee personal email', - example: 'isaac.newton@example.com', - nullable: true, - }, - personal_phone_number: { - type: 'string', - description: 'The employee personal phone number', - example: '+1234567890', - nullable: true, - }, - work_email: { - type: 'string', - description: 'The employee work email', - example: 'newton@example.com', - nullable: true, - }, - work_phone_number: { - type: 'string', - description: 'The employee work phone number', - example: '+1234567890', - nullable: true, - }, - job_id: { - type: 'string', - description: 'The employee job id', - example: '5290', - deprecated: true, - nullable: true, - }, - job_title: { - type: 'string', - description: 'The employee job title', - example: 'Physicist', - nullable: true, - }, - job_description: { - description: 'The employee job description', - example: 'Testing the laws of motion', - deprecated: true, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/JobDescriptionApiModel', - }, - ], - }, - department_id: { - type: 'string', - description: 'The employee department id', - example: '3093', - deprecated: true, - nullable: true, - }, - department: { - type: 'string', - description: 'The employee department', - example: 'Physics', - deprecated: true, - nullable: true, - }, - groups: { - description: 'The employee groups', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/HRISGroup', - }, - }, - cost_centers: { - description: 'The employee cost centers', - deprecated: true, - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CostCenters', - }, - }, - manager_id: { - type: 'string', - description: 'The employee manager ID', - example: '67890', - deprecated: true, - nullable: true, - }, - remote_manager_id: { - type: 'string', - description: "Provider's unique identifier of the manager", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - deprecated: true, - nullable: true, - }, - gender: { - description: 'The employee gender', - example: 'male', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/GenderEnum', - }, - ], - }, - preferred_language: { - description: 'The employee preferred language', - example: 'en_US', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/PreferredLanguageEnum', - }, - ], - }, - ethnicity: { - description: 'The employee ethnicity', - example: 'white', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/EthnicityEnum', - }, - ], - }, - date_of_birth: { - type: 'string', - description: 'The date when the employee was born', - example: '1990-01-01T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - birthday: { - type: 'string', - description: 'The next birthday of the employee (upcoming birthday)', - example: '2021-01-01T00:00:00Z', - format: 'date-time', - nullable: true, - }, - marital_status: { - description: 'The employee marital status', - example: 'single', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/MaritalStatusEnum', - }, - ], - }, - avatar: { - description: 'The employee avatar', - example: 'https://example.com/avatar.png', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/Image', - }, - ], - }, - hire_date: { - type: 'string', - description: 'The employee hire date', - example: '2021-01-01T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - start_date: { - type: 'string', - description: 'The employee start date', - example: '2021-01-01T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - tenure: { - type: 'number', - description: 'The employee tenure', - example: 2, - nullable: true, - }, - work_anniversary: { - type: 'string', - description: 'The employee work anniversary', - example: '2021-01-01T00:00:00Z', - format: 'date-time', - nullable: true, - }, - employment_type: { - description: 'The employee employment type', - example: 'full_time', - deprecated: true, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/EmploymentTypeEnum', - }, - ], - }, - employment_contract_type: { - description: 'The employment work schedule type (e.g., full-time, part-time)', - example: 'full_time', - deprecated: true, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/EmploymentScheduleTypeEnum', - }, - ], - }, - employment_status: { - description: 'The employee employment status', - example: 'active', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/EmploymentStatusEnum', - }, - ], - }, - termination_date: { - type: 'string', - description: 'The employee termination date', - example: '2021-01-01T00:00:00Z', - format: 'date-time', - nullable: true, - }, - company_name: { - type: 'string', - description: 'The employee company name', - example: 'Example Corp', - deprecated: true, - nullable: true, - }, - company_id: { - type: 'string', - description: 'The employee company id', - example: '1234567890', - nullable: true, - }, - citizenships: { - description: 'The citizenships of the Employee', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CountryCodeEnum', - }, - }, - home_location: { - description: 'The employee home location', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/HRISLocation', - }, - ], - }, - work_location: { - description: 'The employee work location', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/HRISLocation', - }, - ], - }, - company: { - description: 'The employee company', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/Company', - }, - ], - }, - employments: { - description: 'The employee employments', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/Employment', - }, - }, - custom_fields: { - description: 'The employee custom fields', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CustomFields', - }, - }, - benefits: { - description: 'Current benefits of the employee', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/HRISBenefit', - }, - }, - employee_number: { - type: 'string', - description: 'The assigned employee number', - example: '125', - nullable: true, - }, - bank_details: { - description: 'Bank account details for the employee', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/HRISBankDetails', - }, - }, - national_identity_number: { - description: 'The national identity number', - deprecated: true, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/NationalIdentityNumberApiModel', - }, - ], - }, - national_identity_numbers: { - description: 'The national identity numbers', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/NationalIdentityNumberApiModel', - }, - }, - skills: { - description: 'The employee skills', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/EntitySkills', - }, - }, - created_at: { - type: 'string', - description: 'The created_at date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The updated_at date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - EmployeeResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/Employee', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - EmployeesPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/Employee', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - Employment: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - job_title: { - type: 'string', - description: 'The job title of the employee', - example: 'Software Engineer', - nullable: true, - }, - pay_rate: { - type: 'string', - description: 'The amount of compensation for the employee', - example: '40.00', - nullable: true, - }, - pay_period: { - description: 'The time period over which the pay rate is calculated', - example: 'monthly', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/PayPeriodEnum', - }, - ], - }, - pay_frequency: { - description: 'How often the employee is paid', - example: 'hourly', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/PayFrequencyEnum', - }, - ], - }, - pay_currency: { - type: 'string', - description: 'The currency used for pay', - example: 'USD', - nullable: true, - }, - effective_date: { - type: 'string', - description: 'The effective date of the employment contract', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - end_date: { - type: 'string', - description: 'The end date of employment', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - grade: { - description: 'Represents the employeeโ€™s position within the organizational hierarchy.', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/EmploymentGradeApiModel', - }, - ], - }, - employment_type: { - description: 'The type of employment (e.g., contractor, permanent)', - example: 'permanent', - deprecated: true, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/EmploymentTypeEnum', - }, - ], - }, - employment_contract_type: { - description: 'The employment work schedule type (e.g., full-time, part-time)', - example: 'full_time', - deprecated: true, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/EmploymentScheduleTypeEnum', - }, - ], - }, - type: { - description: 'The type of employment', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TypeApiModel', - }, - ], - }, - contract_type: { - description: 'The employment work schedule type', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ContractTypeApiModel', - }, - ], - }, - work_time: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/WorkTimeApiModel', - }, - ], - }, - payroll_code: { - type: 'string', - description: 'The payroll code of the employee', - example: 'PC1', - nullable: true, - }, - employee_id: { - type: 'string', - description: 'The employee ID associated with this employment', - example: '1687-3', - nullable: true, - }, - remote_employee_id: { - type: 'string', - description: - "Provider's unique identifier of the employee associated with this employment", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - fte: { - type: 'number', - description: "the employee's working percentage relative to a full-time employee", - example: '1', - nullable: true, - }, - created_at: { - type: 'string', - description: 'The created_at date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The updated_at date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - start_date: { - type: 'string', - description: 'The start_date of employment', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - deprecated: true, - nullable: true, - }, - active: { - description: 'The employment active status', - example: true, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - department: { - description: 'The employee department', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/HRISGroup', - }, - ], - }, - cost_center: { - description: 'The employee cost_center', - deprecated: true, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/HRISGroup', - }, - ], - }, - cost_centers: { - description: 'The employee cost_centers', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/HRISCostCenter', - }, - }, - division: { - description: 'The employee division', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/HRISGroup', - }, - ], - }, - job: { - description: 'The job of employee', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/EmploymentJobApiModel', - }, - ], - }, - manager: { - description: 'The employee manager', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/EmploymentManagerApiModel', - }, - }, - }, - }, - EmploymentGradeApiModel: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'The reference id', - example: '1687-3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'The reference name', - example: '1687-4', - nullable: true, - }, - description: { - type: 'string', - description: 'description of the grade', - example: 'Mid-level employee demonstrating proficiency and autonomy.', - nullable: true, - }, - }, - }, - EmploymentJobApiModel: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - title: { - type: 'string', - description: 'Title of the job', - example: 'Software Engineer', - nullable: true, - }, - description: { - description: 'The employee job description', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/JobDescriptionApiModel', - }, - ], - }, - owner_id: { - type: 'string', - description: 'The owner_id of the job', - example: '5356', - nullable: true, - }, - parent_id: { - type: 'string', - description: 'The parent_id of the job', - example: '7577', - nullable: true, - }, - }, - }, - EmploymentManagerApiModel: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'The manager name', - example: 'John Doe', - nullable: true, - }, - email: { - type: 'string', - description: 'The manager email', - example: 'john.doe@example.com', - nullable: true, - }, - role: { - description: 'The role of manager', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ManagerRoleApiModel', - }, - ], - }, - }, - }, - EmploymentResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/Employment', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - EmploymentScheduleTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: ['full_time', 'shifts', 'part_time', 'unmapped_value', null], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - EmploymentsPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/Employment', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - EmploymentStatusEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'active', - 'pending', - 'terminated', - 'leave', - 'inactive', - 'unknown', - 'unmapped_value', - null, - ], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - EmploymentTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'contractor', - 'intern', - 'permanent', - 'apprentice', - 'freelance', - 'terminated', - 'temporary', - 'seasonal', - 'volunteer', - 'probation', - 'internal', - 'external', - 'expatriate', - 'employer_of_record', - 'casual', - 'Programme', - 'unmapped_value', - null, - ], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - EntitySkillResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/EntitySkills', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - EntitySkills: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'The ID associated with this skill', - example: '16873-IT345', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'The name associated with this skill', - example: 'Information-Technology', - nullable: true, - }, - active: { - description: 'Whether the skill is active and therefore available for use', - example: true, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - language: { - description: 'The language associated with this skill', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/LanguageEnum', - }, - ], - }, - maximum_proficiency: { - description: 'The proficiency level of the skill', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/Proficiency', - }, - ], - }, - minimum_proficiency: { - description: 'The proficiency level of the skill', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/Proficiency', - }, - ], - }, - }, - }, - EntitySkillsCreateRequestDto: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'The ID associated with this skill', - example: '16873-IT345', - nullable: true, - }, - name: { - type: 'string', - description: 'The name associated with this skill', - example: 'Information-Technology', - nullable: true, - }, - maximum_proficiency: { - description: 'The proficiency level of the skill', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/Proficiency', - }, - ], - }, - minimum_proficiency: { - description: 'The proficiency level of the skill', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/Proficiency', - }, - ], - }, - }, - }, - EntitySkillsPaginated: { - type: 'object', - properties: { - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/EntitySkills', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - EthnicityEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'white', - 'black_or_african_american', - 'asian', - 'hispanic_or_latino', - 'american_indian_or_alaska_native', - 'native_hawaiian_or_pacific_islander', - 'two_or_more_races', - 'not_disclosed', - 'other', - 'unmapped_value', - null, - ], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - File: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'The name of the file', - example: 'My Document', - nullable: true, - }, - category: { - description: 'The category of the file', - example: 'templates, forms, backups, etc.', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/FileCategoryEnumApiModel', - }, - ], - }, - contents: { - description: - 'The content of the file. Deprecated, use `url` and `file_format` one level up instead', - deprecated: true, - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/Content', - }, - }, - category_id: { - type: 'string', - description: 'The categoryId of the documents', - example: '6530', - nullable: true, - }, - created_at: { - type: 'string', - description: 'The creation date of the file', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The update date of the file', - example: '2021-01-02T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - remote_url: { - type: 'string', - description: 'URL where the file content is located', - example: 'https://example.com/file.pdf', - nullable: true, - }, - file_format: { - description: 'The file format of the file', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/FileFormatEnum', - }, - ], - }, - }, - }, - FileCategoryEnumApiModel: { - type: 'object', - properties: { - value: { - type: 'string', - description: 'The category of the file', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - FileFormatEnum: { - type: 'object', - properties: { - value: { - type: 'string', - description: 'The file format of the file, expressed as a file extension', - enum: [ - 'unmapped_value', - 'ez', - 'aw', - 'atom', - 'atomcat', - 'atomdeleted', - 'atomsvc', - 'dwd', - 'held', - 'rsat', - 'bdoc', - 'xcs', - 'ccxml', - 'cdfx', - 'cdmia', - 'cdmic', - 'cdmid', - 'cdmio', - 'cdmiq', - 'cu', - 'mpd', - 'davmount', - 'dbk', - 'dssc', - 'xdssc', - 'es', - 'ecma', - 'emma', - 'emotionml', - 'epub', - 'exi', - 'exp', - 'fdt', - 'pfr', - 'geojson', - 'gml', - 'gpx', - 'gxf', - 'gz', - 'hjson', - 'stk', - 'ink', - 'inkml', - 'ipfix', - 'its', - 'jar', - 'war', - 'ear', - 'ser', - 'class', - 'js', - 'mjs', - 'json', - 'map', - 'json5', - 'jsonml', - 'jsonld', - 'lgr', - 'lostxml', - 'hqx', - 'cpt', - 'mads', - 'webmanifest', - 'mrc', - 'mrcx', - 'ma', - 'nb', - 'mb', - 'mathml', - 'mbox', - 'mscml', - 'metalink', - 'meta4', - 'mets', - 'maei', - 'musd', - 'mods', - 'm21', - 'mp21', - 'mp4s', - 'm4p', - 'doc', - 'dot', - 'mxf', - 'nq', - 'nt', - 'cjs', - 'bin', - 'dms', - 'lrf', - 'mar', - 'so', - 'dist', - 'distz', - 'pkg', - 'bpk', - 'dump', - 'elc', - 'deploy', - 'exe', - 'dll', - 'deb', - 'dmg', - 'iso', - 'img', - 'msi', - 'msp', - 'msm', - 'buffer', - 'oda', - 'opf', - 'ogx', - 'omdoc', - 'onetoc', - 'onetoc2', - 'onetmp', - 'onepkg', - 'oxps', - 'relo', - 'xer', - 'pdf', - 'pgp', - 'asc', - 'sig', - 'prf', - 'p10', - 'p7m', - 'p7c', - 'p7s', - 'p8', - 'ac', - 'cer', - 'crl', - 'pkipath', - 'pki', - 'pls', - 'ai', - 'eps', - 'ps', - 'provx', - 'pskcxml', - 'raml', - 'rdf', - 'owl', - 'rif', - 'rnc', - 'rl', - 'rld', - 'rs', - 'rapd', - 'sls', - 'rusd', - 'gbr', - 'mft', - 'roa', - 'rsd', - 'rss', - 'rtf', - 'sbml', - 'scq', - 'scs', - 'spq', - 'spp', - 'sdp', - 'senmlx', - 'sensmlx', - 'setpay', - 'setreg', - 'shf', - 'siv', - 'sieve', - 'smi', - 'smil', - 'rq', - 'srx', - 'gram', - 'grxml', - 'sru', - 'ssdl', - 'ssml', - 'swidtag', - 'tei', - 'teicorpus', - 'tfi', - 'tsd', - 'toml', - 'trig', - 'ttml', - 'ubj', - 'rsheet', - 'td', - 'vxml', - 'wasm', - 'wgt', - 'hlp', - 'wsdl', - 'wspolicy', - 'xaml', - 'xav', - 'xca', - 'xdf', - 'xel', - 'xns', - 'xenc', - 'xhtml', - 'xht', - 'xlf', - 'xml', - 'xsl', - 'xsd', - 'rng', - 'dtd', - 'xop', - 'xpl', - '*xsl', - 'xslt', - 'xspf', - 'mxml', - 'xhvml', - 'xvml', - 'xvm', - 'yang', - 'yin', - 'zip', - '*3gpp', - 'adp', - 'amr', - 'au', - 'snd', - 'mid', - 'midi', - 'kar', - 'rmi', - 'mxmf', - '*mp3', - 'm4a', - 'mp4a', - 'mpga', - 'mp2', - 'mp2a', - 'mp3', - 'm2a', - 'm3a', - 'oga', - 'ogg', - 'spx', - 'opus', - 's3m', - 'sil', - 'wav', - '*wav', - 'weba', - 'xm', - 'ttc', - 'otf', - 'ttf', - 'woff', - 'woff2', - 'exr', - 'apng', - 'avif', - 'bmp', - 'cgm', - 'drle', - 'emf', - 'fits', - 'g3', - 'gif', - 'heic', - 'heics', - 'heif', - 'heifs', - 'hej2', - 'hsj2', - 'ief', - 'jls', - 'jp2', - 'jpg2', - 'jpeg', - 'jpg', - 'jpe', - 'jph', - 'jhc', - 'jpm', - 'jpx', - 'jpf', - 'jxr', - 'jxra', - 'jxrs', - 'jxs', - 'jxsc', - 'jxsi', - 'jxss', - 'ktx', - 'ktx2', - 'png', - 'sgi', - 'svg', - 'svgz', - 't38', - 'tif', - 'tiff', - 'tfx', - 'webp', - 'wmf', - 'disposition-notification', - 'u8msg', - 'u8dsn', - 'u8mdn', - 'u8hdr', - 'eml', - 'mime', - '3mf', - 'gltf', - 'glb', - 'igs', - 'iges', - 'msh', - 'mesh', - 'silo', - 'mtl', - 'obj', - 'stpx', - 'stpz', - 'stpxz', - 'stl', - 'wrl', - 'vrml', - '*x3db', - 'x3dbz', - 'x3db', - '*x3dv', - 'x3dvz', - 'x3d', - 'x3dz', - 'x3dv', - 'appcache', - 'manifest', - 'ics', - 'ifb', - 'coffee', - 'litcoffee', - 'css', - 'csv', - 'html', - 'htm', - 'shtml', - 'jade', - 'jsx', - 'less', - 'markdown', - 'md', - 'mml', - 'mdx', - 'n3', - 'txt', - 'text', - 'conf', - 'def', - 'list', - 'log', - 'in', - 'ini', - 'rtx', - '*rtf', - 'sgml', - 'sgm', - 'shex', - 'slim', - 'slm', - 'spdx', - 'stylus', - 'styl', - 'tsv', - 't', - 'tr', - 'roff', - 'man', - 'me', - 'ms', - 'ttl', - 'uri', - 'uris', - 'urls', - 'vcard', - 'vtt', - '*xml', - 'yaml', - 'yml', - '3gp', - '3gpp', - '3g2', - 'h261', - 'h263', - 'h264', - 'm4s', - 'jpgv', - '*jpm', - 'jpgm', - 'mj2', - 'mjp2', - 'ts', - 'mp4', - 'mp4v', - 'mpg4', - 'mpeg', - 'mpg', - 'mpe', - 'm1v', - 'm2v', - 'ogv', - 'qt', - 'mov', - 'webm', - 'cww', - '1km', - 'plb', - 'psb', - 'pvb', - 'tcap', - 'pwn', - 'aso', - 'imp', - 'acu', - 'atc', - 'acutc', - 'air', - 'fcdt', - 'fxp', - 'fxpl', - 'xdp', - 'xfdf', - 'ahead', - 'azf', - 'azs', - 'azw', - 'acc', - 'ami', - 'apk', - 'cii', - 'fti', - 'atx', - 'mpkg', - 'key', - 'm3u8', - 'numbers', - 'pages', - 'pkpass', - 'swi', - 'iota', - 'aep', - 'bmml', - 'mpm', - 'bmi', - 'rep', - 'cdxml', - 'mmd', - 'cdy', - 'csl', - 'cla', - 'rp9', - 'c4g', - 'c4d', - 'c4f', - 'c4p', - 'c4u', - 'c11amc', - 'c11amz', - 'csp', - 'cdbcmsg', - 'cmc', - 'clkx', - 'clkk', - 'clkp', - 'clkt', - 'clkw', - 'wbs', - 'pml', - 'ppd', - 'car', - 'pcurl', - 'dart', - 'rdz', - 'dbf', - 'uvf', - 'uvvf', - 'uvd', - 'uvvd', - 'uvt', - 'uvvt', - 'uvx', - 'uvvx', - 'uvz', - 'uvvz', - 'fe_launch', - 'dna', - 'mlp', - 'mle', - 'dpg', - 'dfac', - 'kpxx', - 'ait', - 'svc', - 'geo', - 'mag', - 'nml', - 'esf', - 'msf', - 'qam', - 'slt', - 'ssf', - 'es3', - 'et3', - 'ez2', - 'ez3', - 'fdf', - 'mseed', - 'seed', - 'dataless', - 'gph', - 'ftc', - 'fm', - 'frame', - 'maker', - 'book', - 'fnc', - 'ltf', - 'fsc', - 'oas', - 'oa2', - 'oa3', - 'fg5', - 'bh2', - 'ddd', - 'xdw', - 'xbd', - 'fzs', - 'txd', - 'ggb', - 'ggt', - 'gex', - 'gre', - 'gxt', - 'g2w', - 'g3w', - 'gmx', - 'gdoc', - 'gslides', - 'gsheet', - 'kml', - 'kmz', - 'gqf', - 'gqs', - 'gac', - 'ghf', - 'gim', - 'grv', - 'gtm', - 'tpl', - 'vcg', - 'hal', - 'zmm', - 'hbci', - 'les', - 'hpgl', - 'hpid', - 'hps', - 'jlt', - 'pcl', - 'pclxl', - 'sfd-hdstx', - 'mpy', - 'afp', - 'listafp', - 'list3820', - 'irm', - 'sc', - 'icc', - 'icm', - 'igl', - 'ivp', - 'ivu', - 'igm', - 'xpw', - 'xpx', - 'i2g', - 'qbo', - 'qfx', - 'rcprofile', - 'irp', - 'xpr', - 'fcs', - 'jam', - 'rms', - 'jisp', - 'joda', - 'ktz', - 'ktr', - 'karbon', - 'chrt', - 'kfo', - 'flw', - 'kon', - 'kpr', - 'kpt', - 'ksp', - 'kwd', - 'kwt', - 'htke', - 'kia', - 'kne', - 'knp', - 'skp', - 'skd', - 'skt', - 'skm', - 'sse', - 'lasxml', - 'lbd', - 'lbe', - 'apr', - 'pre', - 'nsf', - 'org', - 'scm', - 'lwp', - 'portpkg', - 'mvt', - 'mcd', - 'mc1', - 'cdkey', - 'mwf', - 'mfm', - 'flo', - 'igx', - 'mif', - 'daf', - 'dis', - 'mbk', - 'mqy', - 'msl', - 'plc', - 'txf', - 'mpn', - 'mpc', - 'xul', - 'cil', - 'cab', - 'xls', - 'xlm', - 'xla', - 'xlc', - 'xlt', - 'xlw', - 'xlam', - 'xlsb', - 'xlsm', - 'xltm', - 'eot', - 'chm', - 'ims', - 'lrm', - 'thmx', - 'msg', - 'cat', - '*stl', - 'ppt', - 'pps', - 'pot', - 'ppam', - 'pptm', - 'sldm', - 'ppsm', - 'potm', - 'mpp', - 'mpt', - 'docm', - 'dotm', - 'wps', - 'wks', - 'wcm', - 'wdb', - 'wpl', - 'xps', - 'mseq', - 'mus', - 'msty', - 'taglet', - 'nlu', - 'ntf', - 'nitf', - 'nnd', - 'nns', - 'nnw', - '*ac', - 'ngdat', - 'n-gage', - 'rpst', - 'rpss', - 'edm', - 'edx', - 'ext', - 'odc', - 'otc', - 'odb', - 'odf', - 'odft', - 'odg', - 'otg', - 'odi', - 'oti', - 'odp', - 'otp', - 'ods', - 'ots', - 'odt', - 'odm', - 'ott', - 'oth', - 'xo', - 'dd2', - 'obgx', - 'oxt', - 'osm', - 'pptx', - 'sldx', - 'ppsx', - 'potx', - 'xlsx', - 'xltx', - 'docx', - 'dotx', - 'mgp', - 'dp', - 'esa', - 'pdb', - 'pqa', - 'oprc', - 'paw', - 'str', - 'ei6', - 'efif', - 'wg', - 'plf', - 'pbd', - 'box', - 'mgz', - 'qps', - 'ptid', - 'qxd', - 'qxt', - 'qwd', - 'qwt', - 'qxl', - 'qxb', - 'rar', - 'bed', - 'mxl', - 'musicxml', - 'cryptonote', - 'cod', - 'rm', - 'rmvb', - 'link66', - 'st', - 'see', - 'sema', - 'semd', - 'semf', - 'ifm', - 'itp', - 'iif', - 'ipk', - 'twd', - 'twds', - 'mmf', - 'teacher', - 'fo', - 'sdkm', - 'sdkd', - 'dxp', - 'sfs', - 'sdc', - 'sda', - 'sdd', - 'smf', - 'sdw', - 'vor', - 'sgl', - 'smzip', - 'sm', - 'wadl', - 'sxc', - 'stc', - 'sxd', - 'std', - 'sxi', - 'sti', - 'sxm', - 'sxw', - 'sxg', - 'stw', - 'sus', - 'susp', - 'svd', - 'sis', - 'sisx', - 'xsm', - 'bdm', - 'xdm', - 'ddf', - 'tao', - 'pcap', - 'cap', - 'dmp', - 'tmo', - 'tpt', - 'mxs', - 'tra', - 'ufd', - 'ufdl', - 'utz', - 'umj', - 'unityweb', - 'uoml', - 'vcx', - 'vsd', - 'vst', - 'vss', - 'vsw', - 'vis', - 'vsf', - 'wbxml', - 'wmlc', - 'wmlsc', - 'wtb', - 'nbp', - 'wpd', - 'wqd', - 'stf', - 'xar', - 'xfdl', - 'hvd', - 'hvs', - 'hvp', - 'osf', - 'osfpvg', - 'saf', - 'spf', - 'cmp', - 'zir', - 'zirz', - 'zaz', - '7z', - 'abw', - 'ace', - '*dmg', - 'arj', - 'aab', - 'x32', - 'u32', - 'vox', - 'aam', - 'aas', - 'bcpio', - '*bdoc', - 'torrent', - 'blb', - 'blorb', - 'bz', - 'bz2', - 'boz', - 'cbr', - 'cba', - 'cbt', - 'cbz', - 'cb7', - 'vcd', - 'cfs', - 'chat', - 'pgn', - 'crx', - 'cco', - 'nsc', - 'cpio', - 'csh', - '*deb', - 'udeb', - 'dgc', - 'dir', - 'dcr', - 'dxr', - 'cst', - 'cct', - 'cxt', - 'w3d', - 'fgd', - 'swa', - 'wad', - 'ncx', - 'dtb', - 'res', - 'dvi', - 'evy', - 'eva', - 'bdf', - 'gsf', - 'psf', - 'pcf', - 'snf', - 'pfa', - 'pfb', - 'pfm', - 'afm', - 'arc', - 'spl', - 'gca', - 'ulx', - 'gnumeric', - 'gramps', - 'gtar', - 'hdf', - 'php', - 'install', - '*iso', - '*key', - '*numbers', - '*pages', - 'jardiff', - 'jnlp', - 'kdbx', - 'latex', - 'luac', - 'lzh', - 'lha', - 'run', - 'mie', - 'prc', - 'mobi', - 'application', - 'lnk', - 'wmd', - 'wmz', - 'xbap', - 'mdb', - 'obd', - 'crd', - 'clp', - '*exe', - '*dll', - 'com', - 'bat', - '*msi', - 'mvb', - 'm13', - 'm14', - '*wmf', - '*wmz', - '*emf', - 'emz', - 'mny', - 'pub', - 'scd', - 'trm', - 'wri', - 'nc', - 'cdf', - 'pac', - 'nzb', - 'pl', - 'pm', - '*prc', - '*pdb', - 'p12', - 'pfx', - 'p7b', - 'spc', - 'p7r', - '*rar', - 'rpm', - 'ris', - 'sea', - 'sh', - 'shar', - 'swf', - 'xap', - 'sql', - 'sit', - 'sitx', - 'srt', - 'sv4cpio', - 'sv4crc', - 't3', - 'gam', - 'tar', - 'tcl', - 'tk', - 'tex', - 'tfm', - 'texinfo', - 'texi', - '*obj', - 'ustar', - 'hdd', - 'ova', - 'ovf', - 'vbox', - 'vbox-extpack', - 'vdi', - 'vhd', - 'vmdk', - 'src', - 'webapp', - 'der', - 'crt', - 'pem', - 'fig', - '*xlf', - 'xpi', - 'xz', - 'z1', - 'z2', - 'z3', - 'z4', - 'z5', - 'z6', - 'z7', - 'z8', - 'uva', - 'uvva', - 'eol', - 'dra', - 'dts', - 'dtshd', - 'lvp', - 'pya', - 'ecelp4800', - 'ecelp7470', - 'ecelp9600', - 'rip', - 'aac', - 'aif', - 'aiff', - 'aifc', - 'caf', - 'flac', - '*m4a', - 'mka', - 'm3u', - 'wax', - 'wma', - 'ram', - 'ra', - 'rmp', - '*ra', - 'cdx', - 'cif', - 'cmdf', - 'cml', - 'csml', - 'xyz', - 'btif', - 'pti', - 'psd', - 'azv', - 'uvi', - 'uvvi', - 'uvg', - 'uvvg', - 'djvu', - 'djv', - '*sub', - 'dwg', - 'dxf', - 'fbs', - 'fpx', - 'fst', - 'mmr', - 'rlc', - 'ico', - 'dds', - 'mdi', - 'wdp', - 'npx', - 'b16', - 'tap', - 'vtf', - 'wbmp', - 'xif', - 'pcx', - '3ds', - 'ras', - 'cmx', - 'fh', - 'fhc', - 'fh4', - 'fh5', - 'fh7', - '*ico', - 'jng', - 'sid', - '*bmp', - '*pcx', - 'pic', - 'pct', - 'pnm', - 'pbm', - 'pgm', - 'ppm', - 'rgb', - 'tga', - 'xbm', - 'xpm', - 'xwd', - 'wsc', - 'dae', - 'dwf', - 'gdl', - 'gtw', - 'mts', - 'ogex', - 'x_b', - 'x_t', - 'vds', - 'usdz', - 'bsp', - 'vtu', - 'dsc', - 'curl', - 'dcurl', - 'mcurl', - 'scurl', - 'sub', - 'fly', - 'flx', - 'gv', - '3dml', - 'spot', - 'jad', - 'wml', - 'wmls', - 's', - 'asm', - 'c', - 'cc', - 'cxx', - 'cpp', - 'h', - 'hh', - 'dic', - 'htc', - 'f', - 'for', - 'f77', - 'f90', - 'hbs', - 'java', - 'lua', - 'mkd', - 'nfo', - 'opml', - '*org', - 'p', - 'pas', - 'pde', - 'sass', - 'scss', - 'etx', - 'sfv', - 'ymp', - 'uu', - 'vcs', - 'vcf', - 'uvh', - 'uvvh', - 'uvm', - 'uvvm', - 'uvp', - 'uvvp', - 'uvs', - 'uvvs', - 'uvv', - 'uvvv', - 'dvb', - 'fvt', - 'mxu', - 'm4u', - 'pyv', - 'uvu', - 'uvvu', - 'viv', - 'f4v', - 'fli', - 'flv', - 'm4v', - 'mkv', - 'mk3d', - 'mks', - 'mng', - 'asf', - 'asx', - 'vob', - 'wm', - 'wmv', - 'wmx', - 'wvx', - 'avi', - 'movie', - 'smv', - 'ice', - 'mht', - null, - ], - example: 'pdf', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - example: 'application/pdf', - nullable: true, - }, - }, - }, - ForbiddenResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 403, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Forbidden resource', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - GenderEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'male', - 'female', - 'non_binary', - 'other', - 'not_disclosed', - 'diverse', - 'unmapped_value', - null, - ], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - GroupTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'workspace', - 'team', - 'department', - 'group', - 'organization', - 'unmapped_value', - 'cost_center', - null, - ], - example: 'team', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - HRISBankDetails: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - account_name: { - type: 'string', - description: 'The name of the bank account', - example: 'John Doe Primary Account', - nullable: true, - }, - is_primary: { - description: 'Whether this is the primary bank account', - example: true, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - country_code: { - description: 'The country code where the bank is located', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/CountryCodeEnum', - }, - ], - }, - currency_code: { - description: 'The currency code for the account', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/CurrencyCodeEnum', - }, - ], - }, - bank_name: { - type: 'string', - description: 'The name of the bank', - example: 'Chase Bank', - nullable: true, - }, - account_type: { - description: 'The type of bank account', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/BankAccountTypeEnum', - }, - ], - }, - iban: { - type: 'string', - description: 'International Bank Account Number (IBAN)', - example: 'GB82WEST12345698765432', - nullable: true, - }, - local_account_number: { - type: 'string', - description: 'Local account number (used when IBAN is not available)', - example: '1234567890', - nullable: true, - }, - swift_bic: { - type: 'string', - description: 'SWIFT/BIC code for international transfers', - example: 'CHASUS33', - nullable: true, - }, - clearing_codes: { - description: 'Array of clearing codes required by the country', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/ClearingCode', - }, - }, - }, - }, - HrisBatchDocumentUploadRequestDto: { - type: 'object', - properties: { - items: { - description: 'The batch of items to create', - nullable: false, - type: 'array', - items: { - $ref: '#/components/schemas/HrisDocumentsUploadRequestDto', - }, - }, - }, - required: ['items'], - }, - HRISBenefit: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'The name of the benefit', - example: 'Health Insurance', - nullable: true, - }, - benefit_type: { - description: 'The type of the benefit', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/BenefitsTypeEnum', - }, - ], - }, - provider: { - type: 'string', - description: 'The provider of the benefit', - example: 'Aetna', - nullable: true, - }, - description: { - type: 'string', - description: 'The description of the benefit', - example: 'Health insurance for employees', - nullable: true, - }, - created_at: { - type: 'string', - description: 'The date and time the benefit was created', - example: '2021-01-01T00:00:00Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The date and time the benefit was last updated', - example: '2021-01-01T00:00:00Z', - format: 'date-time', - nullable: true, - }, - }, - }, - HRISBenefitResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/HRISBenefit', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - HRISBenefitsPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/HRISBenefit', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - HRISCostCenter: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - name: { - type: 'string', - description: 'The name of the group', - example: 'Engineering', - nullable: true, - }, - parent_ids: { - description: 'The list of parent group ids of the given group', - example: ['cxIQNjUyNDM0', 'cxIQNjQzNzI0MQ'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - remote_parent_ids: { - description: "Provider's list of parent group remote ids of the given group", - example: ['652434', '6437241'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - owner_ids: { - description: 'The list of group owner ids of the given group', - example: ['cxIQNjUyEDM0', 'cxIQNjQzNzA0MQ'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - remote_owner_ids: { - description: 'The list of remote group owner ids of the given group', - example: ['475364', '4327652'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - company_id: { - type: 'string', - description: 'The id of the company that the group belongs to', - example: '1234567890', - nullable: true, - }, - remote_company_id: { - type: 'string', - description: "Provider's id of the company that the group belongs to", - example: '1234567890', - nullable: true, - }, - distribution_percentage: { - type: 'number', - example: 85, - description: 'The distribution percentage for cost_center', - nullable: true, - }, - type: { - description: 'The type of the group', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/GroupTypeEnum', - }, - ], - }, - }, - }, - HRISCostCenterPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/HRISCostCenter', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - HRISCostCenterResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/HRISCostCenter', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - HrisCreateEmployeeRequestDto: { - type: 'object', - properties: { - title: { - type: 'string', - description: "The prefix of the employee's name (e.g., Mr, Ms, Dr)", - example: 'Mr', - nullable: true, - }, - first_name: { - type: 'string', - description: 'The employee first name', - example: 'Isaac', - nullable: true, - }, - last_name: { - type: 'string', - description: 'The employee last name', - example: 'Newton', - nullable: true, - }, - name: { - type: 'string', - description: 'The employee name', - example: 'Isaac Newton', - nullable: true, - }, - display_name: { - type: 'string', - description: 'The employee display name', - example: 'Sir Isaac Newton', - nullable: true, - }, - avatar_url: { - type: 'string', - description: 'The employee avatar Url', - example: 'https://example.com/avatar.png', - nullable: true, - }, - personal_email: { - type: 'string', - description: 'The employee personal email', - example: 'isaac.newton@example.com', - nullable: true, - }, - personal_phone_number: { - type: 'string', - description: 'The employee personal phone number', - example: '+1234567890', - nullable: true, - }, - work_email: { - type: 'string', - description: 'The employee work email', - example: 'newton@example.com', - nullable: true, - }, - work_phone_number: { - type: 'string', - description: 'The employee work phone number', - example: '+1234567890', - nullable: true, - }, - job_id: { - type: 'string', - description: 'The employee job id', - example: 'R-6789', - deprecated: true, - nullable: true, - }, - job_title: { - type: 'string', - description: - "If the source of the job_title is the Employee's current Employment, and that Employment pertains exclusively to this Employee, then the active Employment job_title will also be written", - example: 'Physicist', - nullable: true, - }, - department_id: { - type: 'string', - description: 'The employee department id', - example: '3093', - nullable: true, - }, - team_id: { - type: 'string', - description: 'The employee team id', - example: '2913', - nullable: true, - }, - department: { - type: 'string', - description: 'The employee department', - example: 'Physics', - nullable: true, - }, - manager_id: { - type: 'string', - description: 'The employee manager ID', - example: '67890', - nullable: true, - }, - gender: { - description: 'The employee gender', - example: 'male', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/GenderEnum', - }, - ], - }, - preferred_language: { - description: 'The employee preferred language', - example: 'eng', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/PreferredLanguageEnum', - }, - ], - }, - ethnicity: { - description: 'The employee ethnicity', - example: 'white', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/EthnicityEnum', - }, - ], - }, - date_of_birth: { - type: 'string', - description: 'The date when the employee was born', - example: '1990-01-01T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - birthday: { - type: 'string', - description: 'The next birthday of the employee (upcoming birthday)', - example: '2021-01-01T00:00:00Z', - format: 'date-time', - nullable: true, - }, - marital_status: { - description: 'The employee marital status', - example: 'single', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/MaritalStatusEnum', - }, - ], - }, - avatar: { - description: 'The employee avatar', - example: 'https://example.com/avatar.png', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/Image', - }, - ], - }, - hire_date: { - type: 'string', - description: 'The employee hire date', - example: '2021-01-01T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - start_date: { - type: 'string', - description: 'The employee start date', - example: '2021-01-01T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - employment_type: { - description: 'The employee employment type', - example: 'permanent', - deprecated: true, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/EmploymentTypeEnum', - }, - ], - }, - employment_contract_type: { - description: 'The employment work schedule type (e.g., full-time, part-time)', - example: 'full_time', - deprecated: true, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/EmploymentScheduleTypeEnum', - }, - ], - }, - employment_status: { - description: 'The employee employment status', - example: 'active', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/EmploymentStatusEnum', - }, - ], - }, - termination_date: { - type: 'string', - description: 'The employee termination date', - example: '2021-01-01T00:00:00Z', - format: 'date-time', - nullable: true, - }, - company_name: { - type: 'string', - description: 'The employee company name', - example: 'Example Corp', - deprecated: true, - nullable: true, - }, - company_id: { - type: 'string', - description: 'The employee company id', - example: '1234567890', - nullable: true, - }, - citizenships: { - description: 'The citizenships of the Employee', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CountryCodeEnum', - }, - }, - employments: { - description: 'The employee employments', - deprecated: true, - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CreateEmploymentApiModel', - }, - }, - employment: { - description: 'The employee employment', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/CreateEmployeeEmploymentApiModel', - }, - ], - }, - custom_fields: { - description: 'The employee custom fields', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CustomFields', - }, - }, - benefits: { - description: 'Current benefits of the employee', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CreateHRISBenefit', - }, - }, - employee_number: { - type: 'string', - description: 'The assigned employee number', - example: '125', - nullable: true, - }, - national_identity_number: { - description: 'The national identity number', - deprecated: true, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/NationalIdentityNumberApiModel', - }, - ], - }, - national_identity_numbers: { - description: 'The national identity numbers', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/NationalIdentityNumberApiModel', - }, - }, - home_location: { - description: 'The employee home location', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/CreateEmployeeLocationApiModel', - }, - ], - }, - work_location: { - description: 'The employee work location', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/CreateEmployeeLocationApiModel', - }, - ], - }, - cost_centers: { - description: 'The employee cost centers', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CreateCostCenterApiModel', - }, - }, - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - }, - }, - HrisCreateEmploymentRequestDto: { - type: 'object', - properties: { - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - job_title: { - type: 'string', - description: 'The job title of the employee', - example: 'Software Engineer', - nullable: true, - }, - pay_rate: { - type: 'string', - description: 'The amount of compensation for the employee', - example: '40.00', - nullable: true, - }, - pay_period: { - description: 'The time period over which the pay rate is calculated', - example: 'monthly', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/PayPeriodEnum', - }, - ], - }, - pay_frequency: { - description: 'How often the employee is paid', - example: 'hourly', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/PayFrequencyEnum', - }, - ], - }, - pay_currency: { - type: 'string', - description: 'The currency used for pay', - example: 'USD', - nullable: true, - }, - effective_date: { - type: 'string', - description: 'The effective date of the employment contract', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - end_date: { - type: 'string', - description: 'The end date of employment', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - grade: { - description: 'Represents the employeeโ€™s position within the organizational hierarchy.', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/EmploymentGradeApiModel', - }, - ], - }, - employment_type: { - description: 'The type of employment (e.g., contractor, permanent)', - example: 'permanent', - deprecated: true, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/EmploymentTypeEnum', - }, - ], - }, - employment_contract_type: { - description: 'The employment work schedule type (e.g., full-time, part-time)', - example: 'full_time', - deprecated: true, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/EmploymentScheduleTypeEnum', - }, - ], - }, - type: { - description: 'The type of employment', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TypeApiModel', - }, - ], - }, - contract_type: { - description: 'The employment work schedule type', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ContractTypeApiModel', - }, - ], - }, - work_time: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/WorkTimeApiModel', - }, - ], - }, - payroll_code: { - type: 'string', - description: 'The payroll code of the employee', - example: 'PC1', - nullable: true, - }, - job_id: { - type: 'string', - description: 'The employee job id', - example: '5290', - nullable: true, - }, - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - }, - }, - HrisCreateTimeOffRequestDto: { - type: 'object', - properties: { - approver_id: { - type: 'string', - description: 'The approver ID', - example: '1687-4', - nullable: true, - }, - status: { - description: 'The status of the time off request', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TimeOffStatusEnum', - }, - ], - }, - type: { - description: 'The type of the time off request', - deprecated: true, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TimeOffTypeEnum', - }, - ], - }, - start_date: { - type: 'string', - description: - 'The start date of the time off request (ISO8601 date-time without timezone)', - example: '2021-01-01T01:01:01.000', - format: 'datetime-local', - nullable: true, - }, - end_date: { - type: 'string', - description: - 'Inclusive end date of the time off request (ISO8601 date-time without timezone). The time off includes this day', - example: '2021-01-01T01:01:01.000', - format: 'datetime-local', - nullable: true, - }, - start_half_day: { - description: - 'True if the start of the time off request begins half way through the day', - example: true, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - end_half_day: { - description: 'True if the end of the time off request ends half way through the day', - example: true, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - time_off_policy_id: { - type: 'string', - description: 'The time off policy id associated with this time off request', - example: 'cx280928933', - nullable: true, - }, - reason: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/Reason', - }, - ], - }, - comment: { - type: 'string', - description: - 'Allows users to provide additional context or notes for their time off request', - example: 'Taking a day off for personal reasons', - nullable: true, - }, - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - }, - }, - HrisCreateWorkEligibilityRequestDto: { - type: 'object', - properties: { - document: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/File', - }, - ], - }, - issued_by: { - description: 'The country code of the issued by authority', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/CountryCodeEnum', - }, - ], - }, - number: { - type: 'string', - example: '1234567890', - nullable: true, - }, - sub_type: { - type: 'string', - example: 'H1B', - nullable: true, - }, - type: { - example: 'visa', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/WorkEligibilityTypeEnum', - }, - ], - }, - valid_from: { - type: 'string', - example: '2021-01-01T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - valid_to: { - type: 'string', - example: '2021-01-01T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - }, - }, - HRISDepartment: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - name: { - type: 'string', - description: 'The name of the group', - example: 'Engineering', - nullable: true, - }, - parent_ids: { - description: 'The list of parent group ids of the given group', - example: ['cxIQNjUyNDM0', 'cxIQNjQzNzI0MQ'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - remote_parent_ids: { - description: "Provider's list of parent group remote ids of the given group", - example: ['652434', '6437241'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - owner_ids: { - description: 'The list of group owner ids of the given group', - example: ['cxIQNjUyEDM0', 'cxIQNjQzNzA0MQ'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - remote_owner_ids: { - description: 'The list of remote group owner ids of the given group', - example: ['475364', '4327652'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - company_id: { - type: 'string', - description: 'The id of the company that the group belongs to', - example: '1234567890', - nullable: true, - }, - remote_company_id: { - type: 'string', - description: "Provider's id of the company that the group belongs to", - example: '1234567890', - nullable: true, - }, - type: { - description: 'The type of the department group', - example: 'department', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/DepartmentTypeEnum', - }, - ], - }, - }, - }, - HRISDepartmentsPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/HRISDepartment', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - HRISDepartmentsResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/HRISDepartment', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - HRISDivision: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - name: { - type: 'string', - description: 'The name of the group', - example: 'Engineering', - nullable: true, - }, - parent_ids: { - description: 'The list of parent group ids of the given group', - example: ['cxIQNjUyNDM0', 'cxIQNjQzNzI0MQ'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - remote_parent_ids: { - description: "Provider's list of parent group remote ids of the given group", - example: ['652434', '6437241'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - owner_ids: { - description: 'The list of group owner ids of the given group', - example: ['cxIQNjUyEDM0', 'cxIQNjQzNzA0MQ'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - remote_owner_ids: { - description: 'The list of remote group owner ids of the given group', - example: ['475364', '4327652'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - company_id: { - type: 'string', - description: 'The id of the company that the group belongs to', - example: '1234567890', - nullable: true, - }, - remote_company_id: { - type: 'string', - description: "Provider's id of the company that the group belongs to", - example: '1234567890', - nullable: true, - }, - type: { - description: 'The type of the division group', - example: 'division', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/DivisionTypeEnum', - }, - ], - }, - }, - }, - HRISDivisionsPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/HRISDivision', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - HRISDivisionsResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/HRISDivision', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - HrisDocumentApiModel: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'The name of the file', - example: 'My Document', - nullable: true, - }, - category: { - description: 'The category of the the document', - example: 'templates, forms, backups, etc.', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/HrisDocumentTypeEnum', - }, - ], - }, - contents: { - description: - 'The content of the file. Deprecated, use `url` and `file_format` one level up instead', - deprecated: true, - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/Content', - }, - }, - category_id: { - type: 'string', - description: 'The categoryId of the documents', - example: '6530', - nullable: true, - }, - created_at: { - type: 'string', - description: 'The creation date of the file', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The update date of the file', - example: '2021-01-02T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - remote_url: { - type: 'string', - description: 'URL where the file content is located', - example: 'https://example.com/file.pdf', - nullable: true, - }, - file_format: { - description: 'The file format of the file', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/FileFormatEnum', - }, - ], - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - type: { - description: 'The content type of the document', - deprecated: true, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/HrisDocumentTypeEnum', - }, - ], - }, - }, - }, - HrisDocumentResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/HrisDocumentApiModel', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - HrisDocumentsPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/HrisDocumentApiModel', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - HrisDocumentsUploadCategoryEnumApiModel: { - type: 'object', - properties: { - value: { - type: 'string', - description: 'The category name to associate with the file', - enum: [ - 'application', - 'academic', - 'contract', - 'certificates', - 'visa', - 'passport', - 'driver_license', - 'payslip', - 'payroll', - 'appraisal', - 'resume', - 'policy', - 'cover_letter', - 'offer_letter', - 'policy_agreement', - 'home_address', - 'national_id', - 'confidential', - 'signed', - 'shared', - 'other', - 'benefit', - 'id_verification', - 'background_check', - 'unmapped_value', - null, - ], - example: 'reports', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - type: 'string', - description: - 'The provider specific category for associating uploaded files, if provided, the value will be ignored.', - example: '550e8400-e29b-41d4-a716-446655440000', - nullable: true, - }, - }, - }, - HrisDocumentsUploadRequestDto: { - type: 'object', - properties: { - name: { - type: 'string', - description: 'The filename of the file to upload', - example: 'weather-forecast', - nullable: true, - }, - file_format: { - description: 'The file format of the file', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/FileFormatEnum', - }, - ], - }, - content: { - type: 'string', - description: 'The base64 encoded content of the file to upload', - example: - 'VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE', - nullable: true, - }, - category_id: { - type: 'string', - description: 'The categoryId of the documents', - example: '6530', - nullable: true, - }, - path: { - type: 'string', - description: 'The path for the file to be uploaded to', - example: '/path/to/file', - nullable: true, - }, - confidential: { - description: 'The confidentiality level of the file to be uploaded', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ConfidentialEnumApiModel', - }, - ], - }, - category: { - description: - 'The category to be associated with the file to be uploaded. Id will take precedence over name.', - example: { - name: 'reports', - id: '550e8400-e29b-41d4-a716-446655440000', - }, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/HrisDocumentsUploadCategoryEnumApiModel', - }, - ], - }, - }, - }, - HrisDocumentTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - description: 'The category of the file', - nullable: true, - enum: [ - 'application', - 'academic', - 'contract', - 'certificates', - 'visa', - 'passport', - 'driver_license', - 'payslip', - 'payroll', - 'appraisal', - 'resume', - 'policy', - 'cover_letter', - 'offer_letter', - 'policy_agreement', - 'home_address', - 'national_id', - 'confidential', - 'signed', - 'shared', - 'other', - 'benefit', - 'id_verification', - 'background_check', - 'unmapped_value', - null, - ], - 'x-speakeasy-unknown-values': 'allow', - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - HRISGroup: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - name: { - type: 'string', - description: 'The name of the group', - example: 'Engineering', - nullable: true, - }, - parent_ids: { - description: 'The list of parent group ids of the given group', - example: ['cxIQNjUyNDM0', 'cxIQNjQzNzI0MQ'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - remote_parent_ids: { - description: "Provider's list of parent group remote ids of the given group", - example: ['652434', '6437241'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - owner_ids: { - description: 'The list of group owner ids of the given group', - example: ['cxIQNjUyEDM0', 'cxIQNjQzNzA0MQ'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - remote_owner_ids: { - description: 'The list of remote group owner ids of the given group', - example: ['475364', '4327652'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - company_id: { - type: 'string', - description: 'The id of the company that the group belongs to', - example: '1234567890', - nullable: true, - }, - remote_company_id: { - type: 'string', - description: "Provider's id of the company that the group belongs to", - example: '1234567890', - nullable: true, - }, - type: { - description: 'The type of the group', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/GroupTypeEnum', - }, - ], - }, - }, - }, - HRISGroupsPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/HRISGroup', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - HRISGroupsResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/HRISGroup', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - HrisInviteEmployeeRequestDto: { - type: 'object', - properties: { - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - }, - }, - HrisJob: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - code: { - type: 'string', - description: 'Code of the job', - example: '184919', - nullable: true, - }, - title: { - type: 'string', - description: 'Title of the job', - example: 'Software Engineer', - nullable: true, - }, - description: { - type: 'string', - description: 'Description of the job', - example: 'Responsible for identifying business requirements', - nullable: true, - }, - status: { - description: 'Status of the job', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/HrisJobStatusEnum', - }, - ], - }, - created_at: { - type: 'string', - description: 'Date of creation', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'Date of last update', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - HrisJobResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/HrisJob', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - HrisJobsPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/HrisJob', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - HrisJobStatusEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'draft', - 'pending', - 'archived', - 'closed', - 'open', - 'deleted', - 'unmapped_value', - null, - ], - description: 'The status of the job.', - example: 'open', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the job status.', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - HRISLocation: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - employee_id: { - type: 'string', - description: 'The employee ID', - example: '1687-3', - nullable: true, - }, - remote_employee_id: { - type: 'string', - description: "Provider's unique identifier of the employee", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - name: { - type: 'string', - description: 'The name of the location', - example: 'Woolsthorpe Manor', - nullable: true, - }, - phone_number: { - type: 'string', - description: 'The phone number of the location', - example: '+44 1476 860 364', - nullable: true, - }, - street_1: { - type: 'string', - description: 'The first line of the address', - example: 'Water Lane', - nullable: true, - }, - street_2: { - type: 'string', - description: 'The second line of the address', - example: 'Woolsthorpe by Colsterworth', - nullable: true, - }, - city: { - type: 'string', - description: 'The city where the location is situated', - example: 'Grantham', - nullable: true, - }, - state: { - type: 'string', - description: 'The state where the location is situated', - example: 'Lincolnshire', - nullable: true, - }, - zip_code: { - type: 'string', - description: 'The ZIP code/Postal code of the location', - example: 'NG33 5NR', - nullable: true, - }, - country: { - description: 'The country code', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/CountryCodeEnum', - }, - ], - }, - location_type: { - description: 'The location type', - example: 'work', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/LocationTypeEnum', - }, - ], - }, - created_at: { - type: 'string', - description: 'The created_at date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The updated_at date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - HRISLocationResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/HRISLocation', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - HRISLocationsPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/HRISLocation', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - HrisShift: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - employee_id: { - type: 'string', - description: 'The employee ID associated with this shift', - example: 'emp_123456789', - nullable: true, - }, - location_id: { - type: 'string', - description: 'The location ID where this shift takes place', - example: 'loc_123456789', - nullable: true, - }, - company_id: { - type: 'string', - description: 'The company ID associated with this shift', - example: 'comp_123456789', - nullable: true, - }, - start_time: { - type: 'string', - description: 'The start time of the shift (ISO8601 date-time without timezone)', - example: '2024-03-20T09:00:00.000', - format: 'datetime-local', - nullable: true, - }, - end_time: { - type: 'string', - description: 'The end time of the shift (ISO8601 date-time without timezone)', - example: '2024-03-20T17:00:00.000', - format: 'datetime-local', - nullable: true, - }, - break_duration: { - type: 'string', - description: 'The total break duration for this shift in ISO 8601 duration format', - example: 'PT1H30M', - nullable: true, - }, - status: { - description: 'The status of the shift', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ShiftStatusEnum', - }, - ], - }, - approval_status: { - description: 'The approval status of the shift', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ShiftApprovalStatusEnum', - }, - ], - }, - breaks: { - description: 'The breaks taken during this shift', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/ShiftBreak', - }, - }, - created_at: { - type: 'string', - description: 'The date and time the shift was created', - example: '2024-03-20T08:00:00Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The date and time the shift was last updated', - example: '2024-03-20T08:00:00Z', - format: 'date-time', - nullable: true, - }, - }, - }, - HrisShiftResult: { - type: 'object', - properties: { - data: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/HrisShift', - }, - ], - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - }, - HrisShiftsPaginated: { - type: 'object', - properties: { - next: { - type: 'string', - nullable: true, - }, - data: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/HrisShift', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - }, - HRISTeam: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - name: { - type: 'string', - description: 'The name of the group', - example: 'Engineering', - nullable: true, - }, - parent_ids: { - description: 'The list of parent group ids of the given group', - example: ['cxIQNjUyNDM0', 'cxIQNjQzNzI0MQ'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - remote_parent_ids: { - description: "Provider's list of parent group remote ids of the given group", - example: ['652434', '6437241'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - owner_ids: { - description: 'The list of group owner ids of the given group', - example: ['cxIQNjUyEDM0', 'cxIQNjQzNzA0MQ'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - remote_owner_ids: { - description: 'The list of remote group owner ids of the given group', - example: ['475364', '4327652'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - company_id: { - type: 'string', - description: 'The id of the company that the group belongs to', - example: '1234567890', - nullable: true, - }, - remote_company_id: { - type: 'string', - description: "Provider's id of the company that the group belongs to", - example: '1234567890', - nullable: true, - }, - type: { - description: 'The type of the team group', - example: 'team', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TeamTypeEnum', - }, - ], - }, - }, - }, - HRISTeamsPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/HRISTeam', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - HRISTeamsResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/HRISTeam', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - HrisUpdateEmployeeRequestDto: { - type: 'object', - properties: { - title: { - type: 'string', - description: "The prefix of the employee's name (e.g., Mr, Ms, Dr)", - example: 'Mr', - nullable: true, - }, - first_name: { - type: 'string', - description: 'The employee first name', - example: 'Isaac', - nullable: true, - }, - last_name: { - type: 'string', - description: 'The employee last name', - example: 'Newton', - nullable: true, - }, - name: { - type: 'string', - description: 'The employee name', - example: 'Isaac Newton', - nullable: true, - }, - display_name: { - type: 'string', - description: 'The employee display name', - example: 'Sir Isaac Newton', - nullable: true, - }, - avatar_url: { - type: 'string', - description: 'The employee avatar Url', - example: 'https://example.com/avatar.png', - nullable: true, - }, - personal_email: { - type: 'string', - description: 'The employee personal email', - example: 'isaac.newton@example.com', - nullable: true, - }, - personal_phone_number: { - type: 'string', - description: 'The employee personal phone number', - example: '+1234567890', - nullable: true, - }, - work_email: { - type: 'string', - description: 'The employee work email', - example: 'newton@example.com', - nullable: true, - }, - work_phone_number: { - type: 'string', - description: 'The employee work phone number', - example: '+1234567890', - nullable: true, - }, - job_id: { - type: 'string', - description: 'The employee job id', - example: 'R-6789', - deprecated: true, - nullable: true, - }, - job_title: { - type: 'string', - description: - "If the source of the job_title is the Employee's current Employment, and that Employment pertains exclusively to this Employee, then the active Employment job_title will also be written", - example: 'Physicist', - nullable: true, - }, - department_id: { - type: 'string', - description: 'The employee department id', - example: '3093', - nullable: true, - }, - team_id: { - type: 'string', - description: 'The employee team id', - example: '2913', - nullable: true, - }, - department: { - type: 'string', - description: 'The employee department', - example: 'Physics', - nullable: true, - }, - manager_id: { - type: 'string', - description: 'The employee manager ID', - example: '67890', - nullable: true, - }, - gender: { - description: 'The employee gender', - example: 'male', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/GenderEnum', - }, - ], - }, - preferred_language: { - description: 'The employee preferred language', - example: 'eng', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/PreferredLanguageEnum', - }, - ], - }, - ethnicity: { - description: 'The employee ethnicity', - example: 'white', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/EthnicityEnum', - }, - ], - }, - date_of_birth: { - type: 'string', - description: 'The date when the employee was born', - example: '1990-01-01T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - birthday: { - type: 'string', - description: 'The next birthday of the employee (upcoming birthday)', - example: '2021-01-01T00:00:00Z', - format: 'date-time', - nullable: true, - }, - marital_status: { - description: 'The employee marital status', - example: 'single', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/MaritalStatusEnum', - }, - ], - }, - avatar: { - description: 'The employee avatar', - example: 'https://example.com/avatar.png', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/Image', - }, - ], - }, - hire_date: { - type: 'string', - description: 'The employee hire date', - example: '2021-01-01T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - start_date: { - type: 'string', - description: 'The employee start date', - example: '2021-01-01T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - employment_type: { - description: 'The employee employment type', - example: 'permanent', - deprecated: true, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/EmploymentTypeEnum', - }, - ], - }, - employment_contract_type: { - description: 'The employment work schedule type (e.g., full-time, part-time)', - example: 'full_time', - deprecated: true, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/EmploymentScheduleTypeEnum', - }, - ], - }, - employment_status: { - description: 'The employee employment status', - example: 'active', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/EmploymentStatusEnum', - }, - ], - }, - termination_date: { - type: 'string', - description: 'The employee termination date', - example: '2021-01-01T00:00:00Z', - format: 'date-time', - nullable: true, - }, - company_name: { - type: 'string', - description: 'The employee company name', - example: 'Example Corp', - deprecated: true, - nullable: true, - }, - company_id: { - type: 'string', - description: 'The employee company id', - example: '1234567890', - nullable: true, - }, - citizenships: { - description: 'The citizenships of the Employee', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CountryCodeEnum', - }, - }, - employment: { - description: 'The employee employment', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/CreateEmployeeEmploymentApiModel', - }, - ], - }, - custom_fields: { - description: 'The employee custom fields', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CustomFields', - }, - }, - benefits: { - description: 'Current benefits of the employee', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CreateHRISBenefit', - }, - }, - employee_number: { - type: 'string', - description: 'The assigned employee number', - example: '125', - nullable: true, - }, - national_identity_number: { - description: 'The national identity number', - deprecated: true, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/NationalIdentityNumberApiModel', - }, - ], - }, - national_identity_numbers: { - description: 'The national identity numbers', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/NationalIdentityNumberApiModel', - }, - }, - home_location: { - description: 'The employee home location', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/CreateEmployeeLocationApiModel', - }, - ], - }, - work_location: { - description: 'The employee work location', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/CreateEmployeeLocationApiModel', - }, - ], - }, - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - }, - }, - HrisUpdateEmploymentRequestDto: { - type: 'object', - properties: { - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - job_title: { - type: 'string', - description: 'The job title of the employee', - example: 'Software Engineer', - nullable: true, - }, - pay_rate: { - type: 'string', - description: 'The amount of compensation for the employee', - example: '40.00', - nullable: true, - }, - pay_period: { - description: 'The time period over which the pay rate is calculated', - example: 'monthly', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/PayPeriodEnum', - }, - ], - }, - pay_frequency: { - description: 'How often the employee is paid', - example: 'hourly', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/PayFrequencyEnum', - }, - ], - }, - pay_currency: { - type: 'string', - description: 'The currency used for pay', - example: 'USD', - nullable: true, - }, - effective_date: { - type: 'string', - description: 'The effective date of the employment contract', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - end_date: { - type: 'string', - description: 'The end date of employment', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - grade: { - description: 'Represents the employeeโ€™s position within the organizational hierarchy.', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/EmploymentGradeApiModel', - }, - ], - }, - employment_type: { - description: 'The type of employment (e.g., contractor, permanent)', - example: 'permanent', - deprecated: true, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/EmploymentTypeEnum', - }, - ], - }, - employment_contract_type: { - description: 'The employment work schedule type (e.g., full-time, part-time)', - example: 'full_time', - deprecated: true, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/EmploymentScheduleTypeEnum', - }, - ], - }, - type: { - description: 'The type of employment', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TypeApiModel', - }, - ], - }, - contract_type: { - description: 'The employment work schedule type', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ContractTypeApiModel', - }, - ], - }, - work_time: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/WorkTimeApiModel', - }, - ], - }, - payroll_code: { - type: 'string', - description: 'The payroll code of the employee', - example: 'PC1', - nullable: true, - }, - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - }, - }, - Image: { - type: 'object', - properties: { - url: { - type: 'string', - nullable: true, - }, - base64: { - type: 'string', - nullable: true, - }, - }, - }, - InternalServerErrorResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 500, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Internal server error', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - InviteEmployeeResult: { - type: 'object', - properties: { - statusCode: { - type: 'number', - example: 200, - }, - message: { - type: 'string', - example: 'Record invited successfully', - }, - timestamp: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - }, - data: { - $ref: '#/components/schemas/CreateResultDataApiModel', - }, - }, - required: ['statusCode', 'message', 'timestamp', 'data'], - }, - ISO3166_2SubDivisionEnum: { - type: 'object', - properties: { - value: { - type: 'string', - description: 'state (ISO3166-2 Sub Division Code) - value must be a valid enum value', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - JobDescriptionApiModel: { - type: 'object', - properties: { - text: { - type: 'string', - example: 'Testing the laws of motion', - nullable: true, - }, - }, - }, - LaborTypeApiModel: { - type: 'object', - properties: { - code: { - type: 'string', - example: 'ABC123', - nullable: true, - }, - }, - }, - LanguageEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'ar_AR', - 'aa_ER', - 'af_NA', - 'af_ZA', - 'am_ET', - 'ar_AE', - 'ar_BH', - 'ar_DJ', - 'ar_DZ', - 'ar_EG', - 'ar_ER', - 'ar_IQ', - 'ar_JO', - 'ar_KM', - 'ar_KW', - 'ar_LB', - 'ar_LY', - 'ar_MA', - 'ar_MR', - 'ar_OM', - 'ar_PS', - 'ar_QA', - 'ar_SA', - 'ar_SD', - 'ar_SY', - 'ar_TD', - 'ar_TN', - 'ar_YE', - 'ay_BO', - 'ay_PE', - 'az_AZ', - 'az_IR', - 'be_BY', - 'bg_BG', - 'bi_VU', - 'bn_BD', - 'bn_IN', - 'bs_BA', - 'bs-ME', - 'byn_ER', - 'ca_AD', - 'ca_ES', - 'ca_FR', - 'ca_IT', - 'ch_GU', - 'cs_CZ', - 'da_DK', - 'de_AT', - 'de_BE', - 'de_CH', - 'de_DE', - 'de_LI', - 'de_LU', - 'de_VA', - 'de_MV', - 'dv_MV', - 'dz_BT', - 'el_CY', - 'el_GR', - 'en_AG', - 'en_AI', - 'en_AS', - 'en_AU', - 'en_BB', - 'en_BE', - 'en_BM', - 'en_BS', - 'en_BW', - 'en_BZ', - 'en_CA', - 'en_CC', - 'en_CK', - 'en_CM', - 'en_CW', - 'en_CX', - 'en_DG', - 'en_DM', - 'en_ER', - 'en_FJ', - 'en_FK', - 'en_FM', - 'en_GB', - 'en_GD', - 'en_GG', - 'en_GH', - 'en_GI', - 'en_GM', - 'en_GS', - 'en_GU', - 'en_GY', - 'en_HK', - 'en_IE', - 'en_IM', - 'en_IN', - 'en_IO', - 'en_JE', - 'en_JM', - 'en_KE', - 'en_KI', - 'en_KN', - 'en_KY', - 'en_LC', - 'en_LR', - 'en_LS', - 'en_MF', - 'en_MG', - 'en_MH', - 'en_MO', - 'en_MP', - 'en_MS', - 'en_MT', - 'en_MU', - 'en_MW', - 'en_MY', - 'en_NA', - 'en_NF', - 'en_NG', - 'en_NL', - 'en_NR', - 'en_NU', - 'en_NZ', - 'en_PG', - 'en_PH', - 'en_PK', - 'en_PN', - 'en_PR', - 'en_PW', - 'en_RW', - 'en_SB', - 'en_SC', - 'en_SD', - 'en_SG', - 'en_SH', - 'en_SL', - 'en_SS', - 'en_SX', - 'en_SZ', - 'en_TC', - 'en_TK', - 'en_TO', - 'en_TT', - 'en_TV', - 'en_TZ', - 'en_UG', - 'en_UM', - 'en_US', - 'en_VC', - 'en_VG', - 'en_VI', - 'en_VU', - 'en_WS', - 'en_ZA', - 'en_ZM', - 'en_ZW', - 'es_AR', - 'es_BO', - 'es_BZ', - 'es_CL', - 'es_CO', - 'es_CR', - 'es_CU', - 'es_DO', - 'es_EA', - 'es_EC', - 'es_EH', - 'es_ES', - 'es_GQ', - 'es_GT', - 'es_HN', - 'es_IC', - 'es_LA', - 'es_MX', - 'es_NI', - 'es_PA', - 'es_PE', - 'es_PH', - 'es_PR', - 'es_PY', - 'es_SV', - 'es_US', - 'es_UY', - 'es_VE', - 'et_EE', - 'fa_AF', - 'fa_IR', - 'fan_GA', - 'ff_CM', - 'ff_GN', - 'ff_MR', - 'ff_SN', - 'ff_BF', - 'fi_FI', - 'fj_FJ', - 'fo_FO', - 'fr_BE', - 'fr_BF', - 'fr_BI', - 'fr_BJ', - 'fr_BL', - 'fr_CA', - 'fr_CD', - 'fr_CF', - 'fr_CG', - 'fr_CH', - 'fr_CI', - 'fr_CM', - 'fr_DJ', - 'fr_DZ', - 'fr_FR', - 'fr_GA', - 'fr_GF', - 'fr_GG', - 'fr_GN', - 'fr_GP', - 'fr_GQ', - 'fr_HT', - 'fr_KM', - 'fr_JE', - 'fr_LU', - 'fr_LB', - 'fr_MA', - 'fr_MC', - 'fr_MF', - 'fr_MG', - 'fr_ML', - 'fr_MQ', - 'fr_MR', - 'fr_MU', - 'fr_NC', - 'fr_NE', - 'fr_PF', - 'fr_PM', - 'fr_RE', - 'fr_RW', - 'fr_SC', - 'fr_SN', - 'fr_SY', - 'fr_TD', - 'fr_TF', - 'fr_TG', - 'fr_TN', - 'fr_VU', - 'fr_VA', - 'fr_WF', - 'fr_YT', - 'ga_IE', - 'gn_PY', - 'gn_AR', - 'gu_IN', - 'gv_IM', - 'he_IL', - 'hi_IN', - 'hr_BA', - 'hr_HR', - 'hr_ME', - 'ht_HT', - 'hu_HU', - 'hy_AM', - 'hy_CY', - 'id_ID', - 'is_IS', - 'it_CH', - 'it_IT', - 'it_SM', - 'it_VA', - 'ja_JP', - 'ka_GE', - 'kg_CD', - 'kk_KZ', - 'kl_GL', - 'km_KH', - 'ko_KP', - 'ko_KR', - 'ku_IQ', - 'ky_KG', - 'la_VA', - 'lb_LU', - 'ln_AO', - 'ln_CD', - 'ln_CF', - 'ln_CG', - 'lo_LA', - 'lt_LT', - 'lu_CD', - 'lv_LV', - 'mg_MG', - 'mh_MH', - 'mi_NZ', - 'mk_MK', - 'mn_MN', - 'mr_IN', - 'ms_BN', - 'ms_MY', - 'ms_SG', - 'mt_MT', - 'my_MM', - 'nb_NO', - 'nb_BV', - 'nb_ZW', - 'ne_NP', - 'nl_AW', - 'nl_BE', - 'nl_BQ', - 'nl_CW', - 'nl_NL', - 'nl_SR', - 'nl_SX', - 'nl_MF', - 'nn_NO', - 'nn_BV', - 'no_NO', - 'no_BV', - 'no_SJ', - 'nr_ZA', - 'ny_MW', - 'pa_IN', - 'pa_PK', - 'pl_PL', - 'ps_AF', - 'pt_AO', - 'pt_BR', - 'pt_CH', - 'pt_CV', - 'pt_GQ', - 'pt_GW', - 'pt_LU', - 'pt_MO', - 'pt_MZ', - 'pt_PT', - 'pt_ST', - 'pt_TL', - 'qu_BO', - 'qu_EC', - 'qu_PE', - 'rar_CK', - 'rm_CH', - 'rup_MK', - 'ro_MD', - 'ro_RO', - 'ru_BY', - 'ru_KG', - 'ru_KZ', - 'ru_MD', - 'ru_RU', - 'ru_UA', - 'ru_AQ', - 'ru_TJ', - 'ru_TM', - 'ru_UZ', - 'rw_RW', - 'se_SE', - 'sg_CF', - 'si_LK', - 'sk_SK', - 'sl_SI', - 'sm_AS', - 'sm_WS', - 'sn_ZW', - 'so_DJ', - 'so_ET', - 'so_KE', - 'so_SO', - 'sq_AL', - 'sq_ME', - 'sq_XK', - 'sr_BA', - 'sr_ME', - 'sr_RS', - 'sr_XK', - 'ss_SZ', - 'ss_ZA', - 'sv_AX', - 'sv_FI', - 'sv_SE', - 'sw_KE', - 'sw_TZ', - 'sw_UG', - 'sw_CD', - 'ta_IN', - 'ta_MY', - 'ta_SG', - 'ta_LK', - 'te_IN', - 'tg_TJ', - 'th_TH', - 'ti_ER', - 'ti_ET', - 'tig_ER', - 'tk_TM', - 'tk_AF', - 'tn_BW', - 'tn_ZA', - 'to_TO', - 'tr_CY', - 'tr_TR', - 'ts_ZA', - 'uk_UA', - 'ur_IN', - 'ur_PK', - 'uz_AF', - 'uz_UZ', - 've_ZA', - 'vi_VN', - 'xh_ZA', - 'zh_CN', - 'zh_HK', - 'zh_MO', - 'zh_SG', - 'zh_TW', - 'zu_ZA', - 'unmapped_value', - null, - ], - description: 'The Locale Code of the language', - example: 'en_GB', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - LocationTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: ['home', 'work', 'unmapped_value', null], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - ManagerRoleApiModel: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - label: { - type: 'string', - description: 'The label of the role type', - example: 'Admin', - nullable: true, - }, - role_type: { - description: 'The manager role type (e.g., admin, viewer)', - example: 'admin', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/RoleTypeEnum', - }, - ], - }, - }, - }, - MaritalStatusEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'single', - 'married', - 'common_law', - 'divorced', - 'widowed', - 'domestic_partnership', - 'separated', - 'other', - 'not_disclosed', - 'unmapped_value', - null, - ], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - NationalIdentityNumberApiModel: { - type: 'object', - properties: { - value: { - type: 'string', - example: '123456789', - nullable: true, - }, - type: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/NationalIdentityNumberTypeEnumApiModel', - }, - ], - }, - country: { - description: 'The country code', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/CountryCodeEnum', - }, - ], - }, - }, - }, - NationalIdentityNumberTypeEnumApiModel: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'ssn', - 'nin', - 'sin', - 'nid', - 'pin', - 'pn', - 'umcn', - 'pic', - 'ric', - 'idnum', - 'cid', - 'nidnr', - 'pan', - 'aadhaar', - 'epic', - 'ptn', - 'itin', - 'tin', - 'uprc', - 'pcode', - 'ssi', - 'cedula', - 'passport', - 'voterid', - 'ntin', - 'bn', - 'fnr', - 'mva', - 'civil_id', - 'cnic', - 'nric', - 'fin', - 'uen', - 'registrationnumber', - 'nic', - 'personnummer', - 'ahv', - 'id', - 'eid', - 'va', - 'pid', - 'nrt', - 'nipt', - 'cbu', - 'cuit', - 'dni', - 'businessid', - 'vnr', - 'abn', - 'acn', - 'tfn', - 'jmbg', - 'bis', - 'insz', - 'nn', - 'egn', - 'pnf', - 'vat', - 'cnpj', - 'unp', - 'gst', - 'pst', - 'qst', - 'ni', - 'dic', - 'rc', - 'uid', - 'rut', - 'uscc', - 'cpf', - 'cpj', - 'cr', - 'stnr', - 'svnr', - 'ncf', - 'rnc', - 'nif', - 'ci', - 'ik', - 'kmkr', - 'registrikood', - 'tn', - 'ruc', - 'nit', - 'alv', - 'hetu', - 'ytunnus', - 'vn', - 'utr', - 'nifp', - 'amka', - 'cui', - 'nir', - 'siren', - 'siret', - 'tva', - 'oib', - 'hkid', - 'anum', - 'kennitala', - 'vsk', - 'npwp', - 'pps', - 'gstin', - 'idnr', - 'hr', - 'aic', - 'codicefiscale', - 'iva', - 'peid', - 'asmens', - 'pvm', - 'ctps', - 'vrn', - 'vtk', - 'int', - 'tk', - 'pas', - 'rne', - 'rg', - 'nci', - 'crnm', - 'pis', - 'insee', - 'tax', - 'mpf', - 'epfo', - 'esi', - 'pran', - 'uan', - 'idk', - 'bsn', - 'mid', - 'sss', - 'nie', - 'nss', - 'arc', - 'curp', - 'imss', - 'rfc', - 'ein', - 'other', - 'unknown', - 'unmapped_value', - null, - ], - description: 'The type of the national identity number', - example: 'ssn', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - NotFoundResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 404, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Not Found', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - NotImplementedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 501, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Not Implemented', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - PayFrequencyEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'hourly', - 'weekly', - 'bi_weekly', - 'four_weekly', - 'semi_monthly', - 'monthly', - 'bi_monthly', - 'quarterly', - 'semi_annually', - 'yearly', - 'thirteen_monthly', - 'pro_rata', - 'unmapped_value', - 'half_yearly', - 'daily', - 'fixed', - null, - ], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - PayPeriodEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'hour', - 'day', - 'week', - 'every_two_weeks', - 'month', - 'quarter', - 'every_six_months', - 'year', - 'unmapped_value', - null, - ], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - Position: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - job_id: { - type: 'string', - description: 'Job ID from the HRIS provider', - example: 'JOB-12345', - nullable: true, - }, - title: { - type: 'string', - description: 'Title of the position', - example: 'Senior Software Engineer', - nullable: true, - }, - description: { - type: 'string', - description: 'Description of the position', - example: 'Responsible for developing and maintaining software applications', - nullable: true, - }, - department_id: { - type: 'string', - description: 'Department ID associated with the position', - example: 'dept-123', - nullable: true, - }, - location_id: { - type: 'string', - description: 'Location ID associated with the position', - example: 'loc-456', - nullable: true, - }, - employment_type: { - type: 'string', - description: 'Employment type for the position', - example: 'full-time', - nullable: true, - }, - status: { - description: 'Status of the position', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/PositionStatusEnum', - }, - ], - }, - posted_date: { - type: 'string', - description: 'Date when the position was posted', - example: '2024-01-15T10:00:00.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - PositionResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/Position', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - PositionsPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/Position', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - PositionStatusEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: ['open', 'draft', 'closed', 'paused', 'unmapped_value', null], - description: 'The status of the position.', - example: 'open', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the position status.', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - PreconditionFailedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 412, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Precondition failed', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - PreferredLanguageEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'aar', - 'afr', - 'amh', - 'ara', - 'aym', - 'aze', - 'bel', - 'bul', - 'bis', - 'ben', - 'bos', - 'byn', - 'cat', - 'cha', - 'ces', - 'dan', - 'deu', - 'div', - 'dzo', - 'ell', - 'eng', - 'spa', - 'est', - 'fas', - 'fan', - 'ful', - 'fin', - 'fij', - 'fao', - 'fra', - 'gle', - 'grn', - 'guj', - 'glv', - 'heb', - 'hin', - 'hrv', - 'hat', - 'hun', - 'hye', - 'ind', - 'isl', - 'ita', - 'jpn', - 'kat', - 'kon', - 'kaz', - 'kal', - 'khm', - 'kor', - 'kur', - 'kir', - 'lat', - 'ltz', - 'lin', - 'lao', - 'lit', - 'lub', - 'lav', - 'mlg', - 'mah', - 'mri', - 'mkd', - 'mon', - 'mar', - 'msa', - 'mlt', - 'mya', - 'nob', - 'nep', - 'nld', - 'nno', - 'nor', - 'nbl', - 'nya', - 'pan', - 'pol', - 'pus', - 'por', - 'que', - 'rar', - 'roh', - 'rup', - 'ron', - 'rus', - 'kin', - 'sme', - 'sag', - 'sin', - 'slk', - 'slv', - 'smo', - 'sna', - 'som', - 'sqi', - 'srp', - 'ssw', - 'swe', - 'swa', - 'tam', - 'tel', - 'tgk', - 'tha', - 'tir', - 'tig', - 'tuk', - 'tsn', - 'ton', - 'tur', - 'tso', - 'ukr', - 'urd', - 'uzb', - 'ven', - 'vie', - 'xho', - 'zho', - 'zul', - 'unmapped_value', - null, - ], - description: 'The ISO639-2 Code of the language', - example: 'eng', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - Proficiency: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'The name associated with this proficiency', - example: 'Expert', - nullable: true, - }, - value: { - type: 'string', - enum: ['1', '2', '3', '4', '5', 'unmapped_value', null], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - ProviderError: { - type: 'object', - properties: { - status: { - type: 'number', - description: 'HTTP status code of the provider error', - example: 400, - nullable: true, - }, - url: { - type: 'string', - description: 'URL that caused the error', - example: 'https://api.provider.com/v1/resource', - nullable: true, - }, - raw: { - type: 'object', - description: 'Raw error response from the provider', - example: { - message: 'Invalid input parameters', - }, - nullable: true, - }, - headers: { - type: 'object', - description: 'Response headers', - example: { - 'content-type': 'application/json', - 'x-request-id': '5678c28b211dace4e0a0f9171e6b88c5', - }, - nullable: true, - }, - }, - }, - ProviderErrorApiModel: { - type: 'object', - properties: { - status: { - type: 'number', - example: 400, - nullable: true, - }, - url: { - type: 'string', - example: 'https://api.someprovider.com/v1/endpoint', - nullable: true, - }, - raw: { - type: 'object', - nullable: true, - }, - headers: { - type: 'object', - example: { - date: 'Tue, 02 Apr 2024 13:52:01 GMT', - 'content-type': 'application/json; charset=utf-8', - 'transfer-encoding': 'chunked', - connection: 'close', - }, - nullable: true, - }, - }, - }, - RawResponse: { - type: 'object', - properties: { - method: { - type: 'string', - }, - url: { - type: 'string', - }, - body: { - oneOf: [ - { - type: 'string', - }, - { - type: 'object', - }, - { - type: 'array', - items: { - type: 'integer', - format: 'int32', - minimum: 0, - maximum: 255, - }, - }, - ], - additionalProperties: true, - nullable: true, - }, - response: { - oneOf: [ - { - type: 'object', - additionalProperties: true, - }, - { - type: 'array', - items: {}, - }, - { - type: 'string', - }, - ], - nullable: true, - }, - }, - required: ['method', 'url'], - }, - Reason: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - nullable: true, - }, - }, - }, - Reference: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'The reference id', - example: '1687-3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'The reference name', - example: '1687-4', - nullable: true, - }, - active: { - description: 'The reference status', - example: true, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - }, - }, - ReferencePaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/Reference', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - ReferenceResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/Reference', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - RequestTimedOutResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 408, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Request timed out', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - RoleTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'admin', - 'viewer', - 'editor', - 'basic', - 'guest', - 'unassigned', - 'restricted', - 'unmapped_value', - null, - ], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - ShiftApprovalStatusEnum: { - type: 'object', - properties: { - value: { - type: 'string', - description: 'The approval status of the shift', - enum: ['pending', 'approved', 'rejected', 'unmapped_value', null], - example: 'approved', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - example: 'Approved', - nullable: true, - }, - }, - }, - ShiftBreak: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'The unique identifier of the break', - example: 'break_123456789', - nullable: true, - }, - start_time: { - type: 'string', - description: 'The start time of the break', - example: '2024-03-20T12:00:00Z', - format: 'date-time', - nullable: true, - }, - end_time: { - type: 'string', - description: 'The end time of the break', - example: '2024-03-20T13:00:00Z', - format: 'date-time', - nullable: true, - }, - duration: { - type: 'string', - description: 'The duration of the break in ISO 8601 duration format', - example: 'PT1H', - nullable: true, - }, - is_paid: { - description: 'Whether the break is paid', - example: true, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - created_at: { - type: 'string', - description: 'The date and time the break was created', - example: '2024-03-20T10:00:00Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The date and time the break was last updated', - example: '2024-03-20T10:00:00Z', - format: 'date-time', - nullable: true, - }, - }, - }, - ShiftStatusEnum: { - type: 'object', - properties: { - value: { - type: 'string', - description: 'The status of the shift', - enum: ['draft', 'published', 'confirmed', 'cancelled', 'unmapped_value', null], - example: 'confirmed', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - example: 'Confirmed', - nullable: true, - }, - }, - }, - Task: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - employee_id: { - type: 'string', - description: 'The employee ID associated with this task', - example: 'cx280928937', - nullable: true, - }, - name: { - type: 'string', - description: 'The name of the task', - example: 'Complete onboarding documents', - nullable: true, - }, - description: { - type: 'string', - description: 'The description of the task', - example: 'Please complete all required onboarding documents in the employee portal', - nullable: true, - }, - type: { - description: 'The type of the task', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TaskTypeEnum', - }, - ], - }, - status: { - description: 'The status of the task', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TaskStatusEnum', - }, - ], - }, - due_date: { - type: 'string', - description: 'The due date of the task', - example: '2024-03-20T23:59:59.000Z', - format: 'date-time', - nullable: true, - }, - completion_date: { - type: 'string', - description: 'The completion date of the task', - example: '2024-03-19T15:30:00.000Z', - format: 'date-time', - nullable: true, - }, - assigned_by_employee_id: { - type: 'string', - description: 'The ID of the employee who assigned this task', - example: 'cx280928938', - nullable: true, - }, - assigned_by_employee_name: { - type: 'string', - description: 'The name of the employee who assigned this task', - example: 'John Smith', - nullable: true, - }, - link_to_task: { - type: 'string', - description: 'Link to the task in the provider system', - example: 'https://provider.com/tasks/123', - nullable: true, - }, - extracted_links: { - description: 'List of extracted links from the task', - example: ['https://provider.com/docs/1', 'https://provider.com/forms/2'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - next_task_id: { - type: 'string', - description: 'ID of the next task in sequence', - example: 'cx280928939', - nullable: true, - }, - parent_process_name: { - type: 'string', - description: 'Name of the parent process of this task', - example: 'Onboarding Tasks', - nullable: true, - }, - comments: { - description: 'The comments associated with this task', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/TaskCommentApiModel', - }, - }, - attachments: { - description: 'The documents attached to this task', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/File', - }, - }, - created_at: { - type: 'string', - description: 'The creation date of this task', - example: '2024-03-15T10:00:00.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The last updated date of this task', - example: '2024-03-19T15:30:00.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - TaskCommentApiModel: { - type: 'object', - properties: { - author_employee_id: { - type: 'string', - description: 'The Employee ID of the author of the comment', - nullable: true, - }, - comment: { - type: 'string', - description: 'The text of the comment', - example: 'Approved based on in-person assessment', - nullable: true, - }, - created_at: { - type: 'string', - description: 'The creation date of this comment', - example: '2024-03-15T10:00:00.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - TaskResult: { - type: 'object', - properties: { - data: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/Task', - }, - ], - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - }, - TasksPaginated: { - type: 'object', - properties: { - next: { - type: 'string', - nullable: true, - }, - data: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/Task', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - }, - TaskStatusEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'open', - 'in_progress', - 'blocked', - 'completed', - 'cancelled', - 'unmapped_value', - null, - ], - description: - 'The unified value for the status of the task. If the provider does not specify this status, the value will be set to UnmappedValue', - example: 'open', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - TaskTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: ['action', 'review', 'acknowledgment', 'edit', 'approve', 'unmapped_value', null], - description: - 'The unified value for the type of the task. If the provider does not specify this type, the value will be set to UnmappedValue', - example: 'action', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - TeamTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: ['team', 'unmapped_value', null], - example: 'team', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - TimeEntries: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - employee_id: { - type: 'string', - description: 'The employee ID associated with this time entry', - example: '1687-3', - nullable: true, - }, - remote_employee_id: { - type: 'string', - description: - "Provider's unique identifier of the employee associated with this time entry", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - start_time: { - type: 'string', - description: 'The start time of the time entry', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - end_time: { - type: 'string', - description: 'The end time of the time entry', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - hours_worked: { - type: 'number', - description: 'The hours worked in the time entry', - example: 8, - nullable: true, - }, - break_duration: { - type: 'number', - description: 'The duration of the break taken during time entry in hours', - example: 0.5, - nullable: true, - }, - status: { - description: 'The status of the time entry', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TimeEntryStatusEnum', - }, - ], - }, - labor_type: { - description: 'The labor type associated with this time entry', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/LaborTypeApiModel', - }, - ], - }, - location: { - description: 'The location of the time entry', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/Reference', - }, - ], - }, - created_at: { - type: 'string', - description: 'The created_at date', - example: '2023-02-23T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The updated_at date', - example: '2024-02-23T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - TimeEntriesPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/TimeEntries', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - TimeEntriesResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/TimeEntries', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - TimeEntryStatusEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: ['approved', 'unmapped_value', null], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - TimeOff: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - employee_id: { - type: 'string', - description: 'The employee ID', - example: '1687-3', - nullable: true, - }, - remote_employee_id: { - type: 'string', - description: "Provider's unique identifier of the employee", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - approver_id: { - type: 'string', - description: 'The approver ID', - example: '1687-4', - nullable: true, - }, - remote_approver_id: { - type: 'string', - description: "Provider's unique identifier of the approver", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - status: { - description: 'The status of the time off request', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TimeOffStatusEnum', - }, - ], - }, - type: { - description: 'The type of the time off request', - deprecated: true, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TimeOffTypeEnum', - }, - ], - }, - start_date: { - type: 'string', - description: - 'The start date of the time off request (ISO8601 date-time without timezone)', - example: '2021-01-01T01:01:01.000', - format: 'datetime-local', - nullable: true, - }, - end_date: { - type: 'string', - description: - 'Inclusive end date of the time off request (ISO8601 date-time without timezone). The time off includes this day', - example: '2021-01-01T01:01:01.000', - format: 'datetime-local', - nullable: true, - }, - start_half_day: { - description: - 'True if the start of the time off request begins half way through the day', - example: true, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - end_half_day: { - description: 'True if the end of the time off request ends half way through the day', - example: true, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - duration: { - type: 'string', - description: 'The duration of the time off request', - example: 'P3Y6M4DT12H30M5S', - format: 'duration', - nullable: true, - }, - time_off_policy_id: { - type: 'string', - description: 'The time off policy id associated with this time off request', - example: 'cx280928933', - nullable: true, - }, - remote_time_off_policy_id: { - type: 'string', - description: - "Provider's unique identifier of the time off policy id associated with this time off request", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - reason: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/Reason', - }, - ], - }, - created_at: { - type: 'string', - description: 'Timestamp when the time off request was created', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'Timestamp when the time off request was last updated', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - policy: { - description: 'The time off policy associated with Time Off', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TimeOffPolicies', - }, - ], - }, - comment: { - type: 'string', - description: - 'Allows users to provide additional context or notes for their time off request', - example: 'Taking a day off for personal reasons', - nullable: true, - }, - }, - }, - TimeOffBalanceResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/TimeOffBalances', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - TimeOffBalances: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - employee_id: { - type: 'string', - description: 'The employee id associated with this balance', - example: 'cx280928937', - nullable: true, - }, - remote_employee_id: { - type: 'string', - description: - "Provider's unique identifier of the employee associated with this balance", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - policy_id: { - type: 'string', - description: 'The time off policy id associated with this balance', - example: 'cx280928937', - nullable: true, - }, - remote_policy_id: { - type: 'string', - description: - "Provider's unique identifier of the time off policy id associated with this balance", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - policy: { - description: 'The time off policy associated with this balance', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TimeOffPolicies', - }, - ], - }, - current_balance: { - type: 'number', - description: - 'The current numeric balance for the associated employee and time off policy', - example: 8, - nullable: true, - }, - initial_balance: { - type: 'number', - description: - 'The initial numeric balance for the associated employee and time off policy as of the balance start date', - example: 8, - nullable: true, - }, - balance_unit: { - description: 'The duration unit of the current balance', - example: 'hours', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TimeOffBalanceUnitEnum', - }, - ], - }, - balance_start_date: { - type: 'string', - description: 'The date of when the initial balance quantity was set', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - balance_expiry_date: { - type: 'string', - description: 'The date of when the current balance expires', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - is_unlimited: { - description: 'Indicates if this time off balance represents unlimited leave', - example: true, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The updated_at date of this time off balance', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - TimeOffBalancesPaginated: { - type: 'object', - properties: { - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/TimeOffBalances', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - TimeOffBalanceUnitEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'minutes', - 'hours', - 'days', - 'weeks', - 'months', - 'years', - 'unknown', - 'unmapped_value', - null, - ], - description: - 'The unified value for the duration unit. If the provider does not specify this unit, the value will be set to unknown', - example: 'hours', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - TimeOffPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/TimeOff', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - TimeOffPolicies: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'The name of this policy', - example: 'Holidays', - nullable: true, - }, - description: { - type: 'string', - description: 'The description of this policy', - example: 'Usable for regional and national holidays of employees.', - nullable: true, - }, - type: { - description: 'The type of this policy', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TimeOffPolicyTypeEnum', - }, - ], - }, - duration_unit: { - description: 'The duration unit of the current policy', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TimeOffBalanceUnitEnum', - }, - ], - }, - reasons: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/Reason', - }, - }, - created_at: { - type: 'string', - description: 'The created_at date of this policy', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The updated_at date of this policy', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - TimeOffPoliciesPaginated: { - type: 'object', - properties: { - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/TimeOffPolicies', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - TimeOffPolicyResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/TimeOffPolicies', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - TimeOffPolicyTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'sick', - 'unmapped_value', - 'vacation', - 'long_term_disability', - 'short_term_disability', - 'absent', - 'comp_time', - 'training', - 'annual_leave', - 'leave_of_absence', - 'break', - 'child_care_leave', - 'maternity_leave', - 'jury_duty', - 'sabbatical', - 'accident', - 'paid', - 'unpaid', - 'holiday', - 'personal', - 'in_lieu', - 'bereavement', - 'other', - null, - ], - description: - 'The unified value for the type of the time off policy. If the provider does not specify this unit, the value will be set to unmapped_value', - example: 'holiday', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - TimeOffResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/TimeOff', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - TimeOffStatusEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'approved', - 'cancelled', - 'rejected', - 'pending', - 'deleted', - 'draft', - 'unmapped_value', - null, - ], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - TimeOffTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'sick', - 'unmapped_value', - 'vacation', - 'long_term_disability', - 'short_term_disability', - 'absent', - 'comp_time', - 'training', - 'annual_leave', - 'leave_of_absence', - 'break', - 'child_care_leave', - 'maternity_leave', - 'jury_duty', - 'sabbatical', - 'accident', - 'paid', - 'unpaid', - 'holiday', - 'personal', - 'in_lieu', - 'bereavement', - 'other', - null, - ], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - TooManyRequestsResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 429, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Too many requests', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - TypeApiModel: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - label: { - type: 'string', - description: 'The label of the employment type', - example: 'Permanent', - nullable: true, - }, - type: { - description: 'The type of employment (e.g., contractor, permanent)', - example: 'permanent', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TypeEnum', - }, - ], - }, - }, - }, - TypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'contractor', - 'intern', - 'permanent', - 'apprentice', - 'freelance', - 'terminated', - 'temporary', - 'seasonal', - 'volunteer', - 'probation', - 'internal', - 'external', - 'expatriate', - 'employer_of_record', - 'casual', - 'Programme', - 'unmapped_value', - null, - ], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - UnauthorizedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 401, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Unauthorized', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - UnifiedError: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 400, - nullable: true, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Request', - nullable: true, - }, - headers: { - type: 'object', - description: 'Response headers', - example: { - 'content-type': 'application/json', - 'x-request-id': '5678c28b211dace4e0a0f9171e6b88c5', - }, - nullable: true, - }, - }, - }, - UnifiedWarningApiModel: { - type: 'object', - properties: { - message: { - type: 'string', - example: 'The provided field type is not supported in the current model.', - nullable: true, - }, - }, - }, - UnprocessableEntityResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 422, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Unprocessable Entity', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - UpdateResult: { - type: 'object', - properties: { - statusCode: { - type: 'number', - example: 200, - }, - message: { - type: 'string', - example: 'Record updated successfully.', - }, - timestamp: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - UpdateTaskRequestDto: { - type: 'object', - properties: { - comment: { - type: 'string', - description: 'Comment or note about the task update', - example: 'All required documents have been submitted', - nullable: true, - }, - status: { - default: 'completed', - description: 'The status to apply to this Task', - example: 'blocked', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TaskStatusEnum', - }, - ], - }, - }, - }, - WorkEligibility: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - type: { - example: 'visa', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/WorkEligibilityTypeEnum', - }, - ], - }, - sub_type: { - type: 'string', - example: 'H1B', - nullable: true, - }, - document: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/File', - }, - ], - }, - valid_from: { - type: 'string', - example: '2021-01-01T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - valid_to: { - type: 'string', - example: '2021-01-01T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - issued_by: { - description: 'The country code of the issued by authority', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/CountryCodeEnum', - }, - ], - }, - number: { - type: 'string', - example: '1234567890', - nullable: true, - }, - }, - }, - WorkEligibilityPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/WorkEligibility', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - WorkEligibilityResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/WorkEligibility', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - WorkEligibilityTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'visa', - 'passport', - 'driver_license', - 'birth_certificate', - 'other', - 'unmapped_value', - null, - ], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - WorkTimeApiModel: { - type: 'object', - properties: { - duration: { - type: 'string', - description: 'The work time duration in ISO 8601 duration format', - example: 'P0Y0M0DT8H0M0S', - format: 'duration', - nullable: true, - }, - period: { - description: 'The period of the work time', - example: 'month', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/WorkTimeUnitEnum', - }, - ], - }, - }, - }, - WorkTimeUnitEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: ['day', 'week', 'month', 'year', 'unmapped_value', null], - description: 'The unified value for the period.', - example: 'month', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - WriteResultApiModel: { - type: 'object', - properties: { - statusCode: { - type: 'number', - example: 201, - nullable: true, - }, - message: { - type: 'string', - example: 'Employee created successfully', - nullable: true, - }, - timestamp: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - provider_errors: { - example: [ - { - status: 400, - url: 'https://api.someprovider.com/v1/endpoint', - raw: { - error: 'Bad Request', - message: 'The supplied data is invalid', - }, - headers: { - date: 'Tue, 02 Apr 2024 13:52:01 GMT', - 'content-type': 'application/json; charset=utf-8', - 'transfer-encoding': 'chunked', - connection: 'close', - }, - }, - ], - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/ProviderErrorApiModel', - }, - }, - unified_warnings: { - example: [ - { - message: 'The provided field type is not supported in the current model.', - }, - ], - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/UnifiedWarningApiModel', - }, - }, - }, - }, - }, - }, -}; diff --git a/src/openapi/generated/iam.ts b/src/openapi/generated/iam.ts deleted file mode 100644 index ef0563e6..00000000 --- a/src/openapi/generated/iam.ts +++ /dev/null @@ -1,5235 +0,0 @@ -// Generated OpenAPI specification for iam -// DO NOT EDIT THIS FILE DIRECTLY -export const iamSpec = { - openapi: '3.1.0', - paths: { - '/unified/iam/users': { - get: { - operationId: 'iam_list_users', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,first_name,last_name,name,primary_email_address,username,roles,groups,status,avatar,is_bot_user,last_active_at,last_login_at,created_at,updated_at,multi_factor_enabled,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'expand', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be expanded in the response', - schema: { - nullable: true, - example: 'roles,groups', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of users was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/IamUsersPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Users', - tags: ['Users'], - 'x-speakeasy-group': 'iam', - 'x-speakeasy-name-override': 'list_users', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/iam/users/{id}': { - get: { - operationId: 'iam_get_user', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,first_name,last_name,name,primary_email_address,username,roles,groups,status,avatar,is_bot_user,last_active_at,last_login_at,created_at,updated_at,multi_factor_enabled,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'expand', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be expanded in the response', - schema: { - nullable: true, - example: 'roles,groups', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The user with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/IamUserResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get User', - tags: ['Users'], - 'x-speakeasy-group': 'iam', - 'x-speakeasy-name-override': 'get_user', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - patch: { - operationId: 'iam_update_user', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/IamUpdateUserRequestDto', - }, - }, - }, - }, - responses: { - '200': { - description: 'Record updated successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UpdateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Update User', - tags: ['Users'], - 'x-speakeasy-group': 'iam', - 'x-speakeasy-name-override': 'update_user', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - delete: { - operationId: 'iam_delete_user', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The user was deleted successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/DeleteResult', - }, - }, - }, - }, - '204': { - description: 'The user was deleted successfully but no content was returned.', - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Delete User', - tags: ['Users'], - 'x-speakeasy-group': 'iam', - 'x-speakeasy-name-override': 'delete_user', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/iam/roles': { - get: { - operationId: 'iam_list_roles', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,type,policies,description,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'expand', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be expanded in the response', - schema: { - nullable: true, - example: 'policies', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of roles was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/IamRolesPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Roles', - tags: ['Roles'], - 'x-speakeasy-group': 'iam', - 'x-speakeasy-name-override': 'list_roles', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/iam/roles/{id}': { - get: { - operationId: 'iam_get_role', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,type,policies,description,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'expand', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be expanded in the response', - schema: { - nullable: true, - example: 'policies', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The role with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/IamRoleResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Role', - tags: ['Roles'], - 'x-speakeasy-group': 'iam', - 'x-speakeasy-name-override': 'get_role', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/iam/groups': { - get: { - operationId: 'iam_list_groups', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,parent_id,remote_parent_id,name,description,roles,type,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'expand', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be expanded in the response', - schema: { - nullable: true, - example: 'roles', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of groups was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/IamGroupsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Groups', - tags: ['Groups'], - 'x-speakeasy-group': 'iam', - 'x-speakeasy-name-override': 'list_groups', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/iam/groups/{id}': { - get: { - operationId: 'iam_get_group', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,parent_id,remote_parent_id,name,description,roles,type,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'expand', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be expanded in the response', - schema: { - nullable: true, - example: 'roles', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The group with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/IamGroupResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Group', - tags: ['Groups'], - 'x-speakeasy-group': 'iam', - 'x-speakeasy-name-override': 'get_group', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/iam/policies': { - get: { - operationId: 'iam_list_policies', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,permissions,description,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'expand', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be expanded in the response', - schema: { - nullable: true, - example: 'permissions', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of policies was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/IamPoliciesPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Policies', - tags: ['Policies'], - 'x-speakeasy-group': 'iam', - 'x-speakeasy-name-override': 'list_policies', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/iam/policies/{id}': { - get: { - operationId: 'iam_get_policy', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,permissions,description,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'expand', - required: false, - in: 'query', - description: 'The comma separated list of fields that will be expanded in the response', - schema: { - nullable: true, - example: 'permissions', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The policy with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/IamPolicyResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Policy', - tags: ['Policies'], - 'x-speakeasy-group': 'iam', - 'x-speakeasy-name-override': 'get_policy', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - }, - info: { - title: 'IAM', - description: 'The documentation for the StackOne Unified API - IAM', - version: '1.0.0', - contact: {}, - }, - tags: [ - { - name: 'Users', - description: 'People or accounts with access to the system.', - }, - { - name: 'Roles', - description: 'Roles assigned to users for access control.', - }, - { - name: 'Groups', - description: 'Groups for organizing users.', - }, - { - name: 'Policies', - description: 'Security and access policies.', - }, - { - name: 'Permissions', - description: 'Specific permissions granted to users or roles.', - }, - { - name: 'Resources', - description: 'Resources that can be accessed or managed.', - }, - ], - servers: [ - { - url: 'https://api.stackone.com', - }, - ], - components: { - securitySchemes: { - basic: { - type: 'http', - scheme: 'basic', - }, - }, - schemas: { - BadGatewayResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 502, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Gateway', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - BadRequestResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 400, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Request', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - data: { - description: 'Error details', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/UnifiedError', - }, - ], - }, - provider_errors: { - description: 'List of provider-specific errors', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/ProviderError', - }, - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - ConflictResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 409, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Conflict', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - Content: { - type: 'object', - properties: { - url: { - type: 'string', - description: 'URL where the file content is located', - example: 'https://example.com/file.pdf', - nullable: true, - }, - unified_url: { - type: 'string', - description: 'Unified download URL for retrieving file content.', - example: - 'https://api.stackone.com/unified/hris/employees/12345/documents/67890/download', - nullable: true, - }, - file_format: { - description: 'The file format of the file', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/FileFormatEnum', - }, - ], - }, - }, - }, - DeleteResult: { - type: 'object', - properties: { - statusCode: { - type: 'number', - example: 204, - }, - message: { - type: 'string', - example: 'Record deleted successfully.', - }, - timestamp: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - File: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'The name of the file', - example: 'My Document', - nullable: true, - }, - category: { - description: 'The category of the file', - example: 'templates, forms, backups, etc.', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/FileCategoryEnumApiModel', - }, - ], - }, - contents: { - description: - 'The content of the file. Deprecated, use `url` and `file_format` one level up instead', - deprecated: true, - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/Content', - }, - }, - category_id: { - type: 'string', - description: 'The categoryId of the documents', - example: '6530', - nullable: true, - }, - created_at: { - type: 'string', - description: 'The creation date of the file', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The update date of the file', - example: '2021-01-02T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - remote_url: { - type: 'string', - description: 'URL where the file content is located', - example: 'https://example.com/file.pdf', - nullable: true, - }, - file_format: { - description: 'The file format of the file', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/FileFormatEnum', - }, - ], - }, - }, - }, - FileCategoryEnumApiModel: { - type: 'object', - properties: { - value: { - type: 'string', - description: 'The category of the file', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - FileFormatEnum: { - type: 'object', - properties: { - value: { - type: 'string', - description: 'The file format of the file, expressed as a file extension', - enum: [ - 'unmapped_value', - 'ez', - 'aw', - 'atom', - 'atomcat', - 'atomdeleted', - 'atomsvc', - 'dwd', - 'held', - 'rsat', - 'bdoc', - 'xcs', - 'ccxml', - 'cdfx', - 'cdmia', - 'cdmic', - 'cdmid', - 'cdmio', - 'cdmiq', - 'cu', - 'mpd', - 'davmount', - 'dbk', - 'dssc', - 'xdssc', - 'es', - 'ecma', - 'emma', - 'emotionml', - 'epub', - 'exi', - 'exp', - 'fdt', - 'pfr', - 'geojson', - 'gml', - 'gpx', - 'gxf', - 'gz', - 'hjson', - 'stk', - 'ink', - 'inkml', - 'ipfix', - 'its', - 'jar', - 'war', - 'ear', - 'ser', - 'class', - 'js', - 'mjs', - 'json', - 'map', - 'json5', - 'jsonml', - 'jsonld', - 'lgr', - 'lostxml', - 'hqx', - 'cpt', - 'mads', - 'webmanifest', - 'mrc', - 'mrcx', - 'ma', - 'nb', - 'mb', - 'mathml', - 'mbox', - 'mscml', - 'metalink', - 'meta4', - 'mets', - 'maei', - 'musd', - 'mods', - 'm21', - 'mp21', - 'mp4s', - 'm4p', - 'doc', - 'dot', - 'mxf', - 'nq', - 'nt', - 'cjs', - 'bin', - 'dms', - 'lrf', - 'mar', - 'so', - 'dist', - 'distz', - 'pkg', - 'bpk', - 'dump', - 'elc', - 'deploy', - 'exe', - 'dll', - 'deb', - 'dmg', - 'iso', - 'img', - 'msi', - 'msp', - 'msm', - 'buffer', - 'oda', - 'opf', - 'ogx', - 'omdoc', - 'onetoc', - 'onetoc2', - 'onetmp', - 'onepkg', - 'oxps', - 'relo', - 'xer', - 'pdf', - 'pgp', - 'asc', - 'sig', - 'prf', - 'p10', - 'p7m', - 'p7c', - 'p7s', - 'p8', - 'ac', - 'cer', - 'crl', - 'pkipath', - 'pki', - 'pls', - 'ai', - 'eps', - 'ps', - 'provx', - 'pskcxml', - 'raml', - 'rdf', - 'owl', - 'rif', - 'rnc', - 'rl', - 'rld', - 'rs', - 'rapd', - 'sls', - 'rusd', - 'gbr', - 'mft', - 'roa', - 'rsd', - 'rss', - 'rtf', - 'sbml', - 'scq', - 'scs', - 'spq', - 'spp', - 'sdp', - 'senmlx', - 'sensmlx', - 'setpay', - 'setreg', - 'shf', - 'siv', - 'sieve', - 'smi', - 'smil', - 'rq', - 'srx', - 'gram', - 'grxml', - 'sru', - 'ssdl', - 'ssml', - 'swidtag', - 'tei', - 'teicorpus', - 'tfi', - 'tsd', - 'toml', - 'trig', - 'ttml', - 'ubj', - 'rsheet', - 'td', - 'vxml', - 'wasm', - 'wgt', - 'hlp', - 'wsdl', - 'wspolicy', - 'xaml', - 'xav', - 'xca', - 'xdf', - 'xel', - 'xns', - 'xenc', - 'xhtml', - 'xht', - 'xlf', - 'xml', - 'xsl', - 'xsd', - 'rng', - 'dtd', - 'xop', - 'xpl', - '*xsl', - 'xslt', - 'xspf', - 'mxml', - 'xhvml', - 'xvml', - 'xvm', - 'yang', - 'yin', - 'zip', - '*3gpp', - 'adp', - 'amr', - 'au', - 'snd', - 'mid', - 'midi', - 'kar', - 'rmi', - 'mxmf', - '*mp3', - 'm4a', - 'mp4a', - 'mpga', - 'mp2', - 'mp2a', - 'mp3', - 'm2a', - 'm3a', - 'oga', - 'ogg', - 'spx', - 'opus', - 's3m', - 'sil', - 'wav', - '*wav', - 'weba', - 'xm', - 'ttc', - 'otf', - 'ttf', - 'woff', - 'woff2', - 'exr', - 'apng', - 'avif', - 'bmp', - 'cgm', - 'drle', - 'emf', - 'fits', - 'g3', - 'gif', - 'heic', - 'heics', - 'heif', - 'heifs', - 'hej2', - 'hsj2', - 'ief', - 'jls', - 'jp2', - 'jpg2', - 'jpeg', - 'jpg', - 'jpe', - 'jph', - 'jhc', - 'jpm', - 'jpx', - 'jpf', - 'jxr', - 'jxra', - 'jxrs', - 'jxs', - 'jxsc', - 'jxsi', - 'jxss', - 'ktx', - 'ktx2', - 'png', - 'sgi', - 'svg', - 'svgz', - 't38', - 'tif', - 'tiff', - 'tfx', - 'webp', - 'wmf', - 'disposition-notification', - 'u8msg', - 'u8dsn', - 'u8mdn', - 'u8hdr', - 'eml', - 'mime', - '3mf', - 'gltf', - 'glb', - 'igs', - 'iges', - 'msh', - 'mesh', - 'silo', - 'mtl', - 'obj', - 'stpx', - 'stpz', - 'stpxz', - 'stl', - 'wrl', - 'vrml', - '*x3db', - 'x3dbz', - 'x3db', - '*x3dv', - 'x3dvz', - 'x3d', - 'x3dz', - 'x3dv', - 'appcache', - 'manifest', - 'ics', - 'ifb', - 'coffee', - 'litcoffee', - 'css', - 'csv', - 'html', - 'htm', - 'shtml', - 'jade', - 'jsx', - 'less', - 'markdown', - 'md', - 'mml', - 'mdx', - 'n3', - 'txt', - 'text', - 'conf', - 'def', - 'list', - 'log', - 'in', - 'ini', - 'rtx', - '*rtf', - 'sgml', - 'sgm', - 'shex', - 'slim', - 'slm', - 'spdx', - 'stylus', - 'styl', - 'tsv', - 't', - 'tr', - 'roff', - 'man', - 'me', - 'ms', - 'ttl', - 'uri', - 'uris', - 'urls', - 'vcard', - 'vtt', - '*xml', - 'yaml', - 'yml', - '3gp', - '3gpp', - '3g2', - 'h261', - 'h263', - 'h264', - 'm4s', - 'jpgv', - '*jpm', - 'jpgm', - 'mj2', - 'mjp2', - 'ts', - 'mp4', - 'mp4v', - 'mpg4', - 'mpeg', - 'mpg', - 'mpe', - 'm1v', - 'm2v', - 'ogv', - 'qt', - 'mov', - 'webm', - 'cww', - '1km', - 'plb', - 'psb', - 'pvb', - 'tcap', - 'pwn', - 'aso', - 'imp', - 'acu', - 'atc', - 'acutc', - 'air', - 'fcdt', - 'fxp', - 'fxpl', - 'xdp', - 'xfdf', - 'ahead', - 'azf', - 'azs', - 'azw', - 'acc', - 'ami', - 'apk', - 'cii', - 'fti', - 'atx', - 'mpkg', - 'key', - 'm3u8', - 'numbers', - 'pages', - 'pkpass', - 'swi', - 'iota', - 'aep', - 'bmml', - 'mpm', - 'bmi', - 'rep', - 'cdxml', - 'mmd', - 'cdy', - 'csl', - 'cla', - 'rp9', - 'c4g', - 'c4d', - 'c4f', - 'c4p', - 'c4u', - 'c11amc', - 'c11amz', - 'csp', - 'cdbcmsg', - 'cmc', - 'clkx', - 'clkk', - 'clkp', - 'clkt', - 'clkw', - 'wbs', - 'pml', - 'ppd', - 'car', - 'pcurl', - 'dart', - 'rdz', - 'dbf', - 'uvf', - 'uvvf', - 'uvd', - 'uvvd', - 'uvt', - 'uvvt', - 'uvx', - 'uvvx', - 'uvz', - 'uvvz', - 'fe_launch', - 'dna', - 'mlp', - 'mle', - 'dpg', - 'dfac', - 'kpxx', - 'ait', - 'svc', - 'geo', - 'mag', - 'nml', - 'esf', - 'msf', - 'qam', - 'slt', - 'ssf', - 'es3', - 'et3', - 'ez2', - 'ez3', - 'fdf', - 'mseed', - 'seed', - 'dataless', - 'gph', - 'ftc', - 'fm', - 'frame', - 'maker', - 'book', - 'fnc', - 'ltf', - 'fsc', - 'oas', - 'oa2', - 'oa3', - 'fg5', - 'bh2', - 'ddd', - 'xdw', - 'xbd', - 'fzs', - 'txd', - 'ggb', - 'ggt', - 'gex', - 'gre', - 'gxt', - 'g2w', - 'g3w', - 'gmx', - 'gdoc', - 'gslides', - 'gsheet', - 'kml', - 'kmz', - 'gqf', - 'gqs', - 'gac', - 'ghf', - 'gim', - 'grv', - 'gtm', - 'tpl', - 'vcg', - 'hal', - 'zmm', - 'hbci', - 'les', - 'hpgl', - 'hpid', - 'hps', - 'jlt', - 'pcl', - 'pclxl', - 'sfd-hdstx', - 'mpy', - 'afp', - 'listafp', - 'list3820', - 'irm', - 'sc', - 'icc', - 'icm', - 'igl', - 'ivp', - 'ivu', - 'igm', - 'xpw', - 'xpx', - 'i2g', - 'qbo', - 'qfx', - 'rcprofile', - 'irp', - 'xpr', - 'fcs', - 'jam', - 'rms', - 'jisp', - 'joda', - 'ktz', - 'ktr', - 'karbon', - 'chrt', - 'kfo', - 'flw', - 'kon', - 'kpr', - 'kpt', - 'ksp', - 'kwd', - 'kwt', - 'htke', - 'kia', - 'kne', - 'knp', - 'skp', - 'skd', - 'skt', - 'skm', - 'sse', - 'lasxml', - 'lbd', - 'lbe', - 'apr', - 'pre', - 'nsf', - 'org', - 'scm', - 'lwp', - 'portpkg', - 'mvt', - 'mcd', - 'mc1', - 'cdkey', - 'mwf', - 'mfm', - 'flo', - 'igx', - 'mif', - 'daf', - 'dis', - 'mbk', - 'mqy', - 'msl', - 'plc', - 'txf', - 'mpn', - 'mpc', - 'xul', - 'cil', - 'cab', - 'xls', - 'xlm', - 'xla', - 'xlc', - 'xlt', - 'xlw', - 'xlam', - 'xlsb', - 'xlsm', - 'xltm', - 'eot', - 'chm', - 'ims', - 'lrm', - 'thmx', - 'msg', - 'cat', - '*stl', - 'ppt', - 'pps', - 'pot', - 'ppam', - 'pptm', - 'sldm', - 'ppsm', - 'potm', - 'mpp', - 'mpt', - 'docm', - 'dotm', - 'wps', - 'wks', - 'wcm', - 'wdb', - 'wpl', - 'xps', - 'mseq', - 'mus', - 'msty', - 'taglet', - 'nlu', - 'ntf', - 'nitf', - 'nnd', - 'nns', - 'nnw', - '*ac', - 'ngdat', - 'n-gage', - 'rpst', - 'rpss', - 'edm', - 'edx', - 'ext', - 'odc', - 'otc', - 'odb', - 'odf', - 'odft', - 'odg', - 'otg', - 'odi', - 'oti', - 'odp', - 'otp', - 'ods', - 'ots', - 'odt', - 'odm', - 'ott', - 'oth', - 'xo', - 'dd2', - 'obgx', - 'oxt', - 'osm', - 'pptx', - 'sldx', - 'ppsx', - 'potx', - 'xlsx', - 'xltx', - 'docx', - 'dotx', - 'mgp', - 'dp', - 'esa', - 'pdb', - 'pqa', - 'oprc', - 'paw', - 'str', - 'ei6', - 'efif', - 'wg', - 'plf', - 'pbd', - 'box', - 'mgz', - 'qps', - 'ptid', - 'qxd', - 'qxt', - 'qwd', - 'qwt', - 'qxl', - 'qxb', - 'rar', - 'bed', - 'mxl', - 'musicxml', - 'cryptonote', - 'cod', - 'rm', - 'rmvb', - 'link66', - 'st', - 'see', - 'sema', - 'semd', - 'semf', - 'ifm', - 'itp', - 'iif', - 'ipk', - 'twd', - 'twds', - 'mmf', - 'teacher', - 'fo', - 'sdkm', - 'sdkd', - 'dxp', - 'sfs', - 'sdc', - 'sda', - 'sdd', - 'smf', - 'sdw', - 'vor', - 'sgl', - 'smzip', - 'sm', - 'wadl', - 'sxc', - 'stc', - 'sxd', - 'std', - 'sxi', - 'sti', - 'sxm', - 'sxw', - 'sxg', - 'stw', - 'sus', - 'susp', - 'svd', - 'sis', - 'sisx', - 'xsm', - 'bdm', - 'xdm', - 'ddf', - 'tao', - 'pcap', - 'cap', - 'dmp', - 'tmo', - 'tpt', - 'mxs', - 'tra', - 'ufd', - 'ufdl', - 'utz', - 'umj', - 'unityweb', - 'uoml', - 'vcx', - 'vsd', - 'vst', - 'vss', - 'vsw', - 'vis', - 'vsf', - 'wbxml', - 'wmlc', - 'wmlsc', - 'wtb', - 'nbp', - 'wpd', - 'wqd', - 'stf', - 'xar', - 'xfdl', - 'hvd', - 'hvs', - 'hvp', - 'osf', - 'osfpvg', - 'saf', - 'spf', - 'cmp', - 'zir', - 'zirz', - 'zaz', - '7z', - 'abw', - 'ace', - '*dmg', - 'arj', - 'aab', - 'x32', - 'u32', - 'vox', - 'aam', - 'aas', - 'bcpio', - '*bdoc', - 'torrent', - 'blb', - 'blorb', - 'bz', - 'bz2', - 'boz', - 'cbr', - 'cba', - 'cbt', - 'cbz', - 'cb7', - 'vcd', - 'cfs', - 'chat', - 'pgn', - 'crx', - 'cco', - 'nsc', - 'cpio', - 'csh', - '*deb', - 'udeb', - 'dgc', - 'dir', - 'dcr', - 'dxr', - 'cst', - 'cct', - 'cxt', - 'w3d', - 'fgd', - 'swa', - 'wad', - 'ncx', - 'dtb', - 'res', - 'dvi', - 'evy', - 'eva', - 'bdf', - 'gsf', - 'psf', - 'pcf', - 'snf', - 'pfa', - 'pfb', - 'pfm', - 'afm', - 'arc', - 'spl', - 'gca', - 'ulx', - 'gnumeric', - 'gramps', - 'gtar', - 'hdf', - 'php', - 'install', - '*iso', - '*key', - '*numbers', - '*pages', - 'jardiff', - 'jnlp', - 'kdbx', - 'latex', - 'luac', - 'lzh', - 'lha', - 'run', - 'mie', - 'prc', - 'mobi', - 'application', - 'lnk', - 'wmd', - 'wmz', - 'xbap', - 'mdb', - 'obd', - 'crd', - 'clp', - '*exe', - '*dll', - 'com', - 'bat', - '*msi', - 'mvb', - 'm13', - 'm14', - '*wmf', - '*wmz', - '*emf', - 'emz', - 'mny', - 'pub', - 'scd', - 'trm', - 'wri', - 'nc', - 'cdf', - 'pac', - 'nzb', - 'pl', - 'pm', - '*prc', - '*pdb', - 'p12', - 'pfx', - 'p7b', - 'spc', - 'p7r', - '*rar', - 'rpm', - 'ris', - 'sea', - 'sh', - 'shar', - 'swf', - 'xap', - 'sql', - 'sit', - 'sitx', - 'srt', - 'sv4cpio', - 'sv4crc', - 't3', - 'gam', - 'tar', - 'tcl', - 'tk', - 'tex', - 'tfm', - 'texinfo', - 'texi', - '*obj', - 'ustar', - 'hdd', - 'ova', - 'ovf', - 'vbox', - 'vbox-extpack', - 'vdi', - 'vhd', - 'vmdk', - 'src', - 'webapp', - 'der', - 'crt', - 'pem', - 'fig', - '*xlf', - 'xpi', - 'xz', - 'z1', - 'z2', - 'z3', - 'z4', - 'z5', - 'z6', - 'z7', - 'z8', - 'uva', - 'uvva', - 'eol', - 'dra', - 'dts', - 'dtshd', - 'lvp', - 'pya', - 'ecelp4800', - 'ecelp7470', - 'ecelp9600', - 'rip', - 'aac', - 'aif', - 'aiff', - 'aifc', - 'caf', - 'flac', - '*m4a', - 'mka', - 'm3u', - 'wax', - 'wma', - 'ram', - 'ra', - 'rmp', - '*ra', - 'cdx', - 'cif', - 'cmdf', - 'cml', - 'csml', - 'xyz', - 'btif', - 'pti', - 'psd', - 'azv', - 'uvi', - 'uvvi', - 'uvg', - 'uvvg', - 'djvu', - 'djv', - '*sub', - 'dwg', - 'dxf', - 'fbs', - 'fpx', - 'fst', - 'mmr', - 'rlc', - 'ico', - 'dds', - 'mdi', - 'wdp', - 'npx', - 'b16', - 'tap', - 'vtf', - 'wbmp', - 'xif', - 'pcx', - '3ds', - 'ras', - 'cmx', - 'fh', - 'fhc', - 'fh4', - 'fh5', - 'fh7', - '*ico', - 'jng', - 'sid', - '*bmp', - '*pcx', - 'pic', - 'pct', - 'pnm', - 'pbm', - 'pgm', - 'ppm', - 'rgb', - 'tga', - 'xbm', - 'xpm', - 'xwd', - 'wsc', - 'dae', - 'dwf', - 'gdl', - 'gtw', - 'mts', - 'ogex', - 'x_b', - 'x_t', - 'vds', - 'usdz', - 'bsp', - 'vtu', - 'dsc', - 'curl', - 'dcurl', - 'mcurl', - 'scurl', - 'sub', - 'fly', - 'flx', - 'gv', - '3dml', - 'spot', - 'jad', - 'wml', - 'wmls', - 's', - 'asm', - 'c', - 'cc', - 'cxx', - 'cpp', - 'h', - 'hh', - 'dic', - 'htc', - 'f', - 'for', - 'f77', - 'f90', - 'hbs', - 'java', - 'lua', - 'mkd', - 'nfo', - 'opml', - '*org', - 'p', - 'pas', - 'pde', - 'sass', - 'scss', - 'etx', - 'sfv', - 'ymp', - 'uu', - 'vcs', - 'vcf', - 'uvh', - 'uvvh', - 'uvm', - 'uvvm', - 'uvp', - 'uvvp', - 'uvs', - 'uvvs', - 'uvv', - 'uvvv', - 'dvb', - 'fvt', - 'mxu', - 'm4u', - 'pyv', - 'uvu', - 'uvvu', - 'viv', - 'f4v', - 'fli', - 'flv', - 'm4v', - 'mkv', - 'mk3d', - 'mks', - 'mng', - 'asf', - 'asx', - 'vob', - 'wm', - 'wmv', - 'wmx', - 'wvx', - 'avi', - 'movie', - 'smv', - 'ice', - 'mht', - null, - ], - example: 'pdf', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - example: 'application/pdf', - nullable: true, - }, - }, - }, - ForbiddenResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 403, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Forbidden resource', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - GroupTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'workspace', - 'team', - 'department', - 'group', - 'organization', - 'unmapped_value', - 'cost_center', - null, - ], - example: 'team', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - IamGroup: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - nullable: true, - }, - description: { - type: 'string', - nullable: true, - }, - type: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/GroupTypeEnum', - }, - ], - }, - roles: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/IamRole', - }, - }, - parent_id: { - type: 'string', - description: 'The parent group id for when a group belongs to another group.', - nullable: true, - }, - remote_parent_id: { - type: 'string', - description: - "Provider's unique identifier of the parent group id for when a group belongs to another group.", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - created_at: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - IamGroupResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/IamGroup', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - IamGroupsPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/IamGroup', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - IamMfaTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'sms', - 'email', - 'push', - 'totp', - 'phone_call', - 'question', - 'software_token', - 'hardware_token', - 'web', - 'unknown', - 'unmapped_value', - null, - ], - description: - "The unified value for the type of multi-factor authentication. If the provider does not send back a type but does specify that MFA is set-up for this user, the value will be set to 'unknown'.'", - example: 'totp', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - IamPermission: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'The name of the permission.', - example: 'read:users', - nullable: true, - }, - type: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/IamPermissionTypeEnum', - }, - ], - }, - resources: { - description: 'The resources that the permission applies to.', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/IamResource', - }, - }, - description: { - type: 'string', - nullable: true, - }, - created_at: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - IamPermissionTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'read', - 'read_write', - 'approve', - 'delete', - 'use', - 'export', - 'unmapped_value', - null, - ], - description: 'The type of the permission, e.g. read, read_write, delete, etc.', - example: 'read_write', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - IamPoliciesPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/IamPolicy', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - IamPolicy: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'The name of the policy.', - example: 'Remote Contractor Policy', - nullable: true, - }, - permissions: { - description: 'The set of permissions associated with the policy.', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/IamPermission', - }, - }, - description: { - type: 'string', - nullable: true, - }, - created_at: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - IamPolicyResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/IamPolicy', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - IamResource: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'The name of the resource.', - example: 'Company History Records', - nullable: true, - }, - location: { - type: 'string', - description: 'The location of the resource.', - example: 's3://bucket-name/folder-name', - nullable: true, - }, - type: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/IamResourceTypeEnum', - }, - ], - }, - description: { - type: 'string', - nullable: true, - }, - created_at: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - IamResourceTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'project', - 'file', - 'folder', - 'product', - 'property', - 'user', - 'unmapped_value', - null, - ], - description: 'The type of the resource, e.g. user, group, permission, etc.', - example: 'file', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - IamRole: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - nullable: true, - }, - description: { - type: 'string', - nullable: true, - }, - type: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/RoleTypeEnum', - }, - ], - }, - policies: { - description: 'The set of policies associated with the role.', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/IamPolicy', - }, - }, - created_at: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - IamRoleResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/IamRole', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - IamRolesPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/IamRole', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - IamUpdateUserRequestDto: { - type: 'object', - properties: { - primary_email_address: { - type: 'string', - description: - 'Primary email address of the user. This is generally a work email address.', - example: 'han@stackone.com', - nullable: true, - }, - first_name: { - type: 'string', - example: 'Han', - nullable: true, - }, - last_name: { - type: 'string', - example: 'Solo', - nullable: true, - }, - name: { - type: 'string', - description: "User's name which (can be a full name or display name)", - example: 'Han Solo', - nullable: true, - }, - username: { - type: 'string', - example: 'hansolo1977', - nullable: true, - }, - is_bot_user: { - description: 'Indicates if the user is a bot or service user', - example: true, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - status: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/UserStatusEnum', - }, - ], - }, - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - }, - }, - IamUser: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - primary_email_address: { - type: 'string', - description: - 'Primary email address of the user. This is generally a work email address.', - example: 'han@stackone.com', - nullable: true, - }, - first_name: { - type: 'string', - example: 'Han', - nullable: true, - }, - last_name: { - type: 'string', - example: 'Solo', - nullable: true, - }, - name: { - type: 'string', - description: "User's name which (can be a full name or display name)", - example: 'Han Solo', - nullable: true, - }, - username: { - type: 'string', - example: 'hansolo1977', - nullable: true, - }, - is_bot_user: { - description: 'Indicates if the user is a bot or service user', - example: true, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - roles: { - description: 'List of roles the user is assigned to', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/IamRole', - }, - }, - groups: { - description: 'List of groups the user is assigned to', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/IamGroup', - }, - }, - status: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/UserStatusEnum', - }, - ], - }, - last_active_at: { - type: 'string', - description: 'The date this user was last active', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - last_login_at: { - type: 'string', - description: 'The date this user last logged in', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - created_at: { - type: 'string', - description: 'The date the user was created', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The date the user was created', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - multi_factor_enabled: { - description: - 'The list of Multi-Factor Authentication (MFA) types enabled for the user.', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/IamMfaTypeEnum', - }, - }, - avatar: { - description: - "The user's avatar data. This generally contains a URL within this property's 'contents' array.", - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/File', - }, - ], - }, - }, - }, - IamUserResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/IamUser', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - IamUsersPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/IamUser', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - InternalServerErrorResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 500, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Internal server error', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - NotFoundResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 404, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Not Found', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - NotImplementedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 501, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Not Implemented', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - PreconditionFailedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 412, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Precondition failed', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - ProviderError: { - type: 'object', - properties: { - status: { - type: 'number', - description: 'HTTP status code of the provider error', - example: 400, - nullable: true, - }, - url: { - type: 'string', - description: 'URL that caused the error', - example: 'https://api.provider.com/v1/resource', - nullable: true, - }, - raw: { - type: 'object', - description: 'Raw error response from the provider', - example: { - message: 'Invalid input parameters', - }, - nullable: true, - }, - headers: { - type: 'object', - description: 'Response headers', - example: { - 'content-type': 'application/json', - 'x-request-id': '5678c28b211dace4e0a0f9171e6b88c5', - }, - nullable: true, - }, - }, - }, - RawResponse: { - type: 'object', - properties: { - method: { - type: 'string', - }, - url: { - type: 'string', - }, - body: { - oneOf: [ - { - type: 'string', - }, - { - type: 'object', - }, - { - type: 'array', - items: { - type: 'integer', - format: 'int32', - minimum: 0, - maximum: 255, - }, - }, - ], - additionalProperties: true, - nullable: true, - }, - response: { - oneOf: [ - { - type: 'object', - additionalProperties: true, - }, - { - type: 'array', - items: {}, - }, - { - type: 'string', - }, - ], - nullable: true, - }, - }, - required: ['method', 'url'], - }, - RequestTimedOutResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 408, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Request timed out', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - RoleTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'admin', - 'viewer', - 'editor', - 'basic', - 'guest', - 'unassigned', - 'restricted', - 'unmapped_value', - null, - ], - example: 'admin', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - TooManyRequestsResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 429, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Too many requests', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - UnauthorizedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 401, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Unauthorized', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - UnifiedError: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 400, - nullable: true, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Request', - nullable: true, - }, - headers: { - type: 'object', - description: 'Response headers', - example: { - 'content-type': 'application/json', - 'x-request-id': '5678c28b211dace4e0a0f9171e6b88c5', - }, - nullable: true, - }, - }, - }, - UnprocessableEntityResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 422, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Unprocessable Entity', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - UpdateResult: { - type: 'object', - properties: { - statusCode: { - type: 'number', - example: 200, - }, - message: { - type: 'string', - example: 'Record updated successfully.', - }, - timestamp: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - UserStatusEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: ['enabled', 'disabled', 'pending', 'unmapped_value', null], - description: - 'The status of the user, e.g. whether the user is enabled, has been disabled (eg. by an admin), or is pending (ie: awaiting approval by the user or an admin).', - example: 'enabled', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - }, - }, -}; diff --git a/src/openapi/generated/index.ts b/src/openapi/generated/index.ts deleted file mode 100644 index 936e2829..00000000 --- a/src/openapi/generated/index.ts +++ /dev/null @@ -1,11 +0,0 @@ -export { stackoneSpec } from './stackone'; -export { crmSpec } from './crm'; -export { atsSpec } from './ats'; -export { hrisSpec } from './hris'; -export { documentsSpec } from './documents'; -export { marketingSpec } from './marketing'; -export { ticketingSpec } from './ticketing'; -export { screeningSpec } from './screening'; -export { messagingSpec } from './messaging'; -export { iamSpec } from './iam'; -export { lmsSpec } from './lms'; diff --git a/src/openapi/generated/lms.ts b/src/openapi/generated/lms.ts deleted file mode 100644 index a7c985e8..00000000 --- a/src/openapi/generated/lms.ts +++ /dev/null @@ -1,8673 +0,0 @@ -// Generated OpenAPI specification for lms -// DO NOT EDIT THIS FILE DIRECTLY -export const lmsSpec = { - openapi: '3.1.0', - paths: { - '/unified/lms/courses': { - get: { - description: - 'Retrieve a list of course type learning objects. \n\nThese are collections of content type learning objects that are grouped together for a specific learning purpose.', - operationId: 'lms_list_courses', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,external_reference,content_ids,remote_content_ids,title,description,languages,cover_url,url,active,duration,categories,skills,updated_at,created_at,content,provider,localizations,authors,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'LMS Courses Filter', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - external_reference: { - description: 'Filter to select courses by external_reference', - type: 'string', - nullable: true, - }, - active: { - description: 'Filter to allow filtering of only active courses', - oneOf: [ - { - type: 'boolean', - const: true, - }, - { - type: 'string', - const: 'true', - }, - ], - nullable: true, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of courses was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CoursePaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Courses', - tags: ['Courses'], - 'x-speakeasy-group': 'lms', - 'x-speakeasy-name-override': 'list_courses', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/lms/courses/{id}': { - get: { - description: - 'Retrieve a course type learning object by its identifier. \n\nThese are collections of content type learning objects that are grouped together for a specific learning purpose.', - operationId: 'lms_get_course', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,external_reference,content_ids,remote_content_ids,title,description,languages,cover_url,url,active,duration,categories,skills,updated_at,created_at,content,provider,localizations,authors,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The course with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CourseResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Course', - tags: ['Courses'], - 'x-speakeasy-group': 'lms', - 'x-speakeasy-name-override': 'get_course', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/lms/users/{id}/assignments': { - get: { - description: - 'Retrieve a list of assignment type learning records for a user. \n\nThese are the records linking a user to learning objects. \n\nThey can be pending, in progress, or completed.', - operationId: 'lms_list_user_assignments', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,external_reference,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,assigned_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference,certificate_url,result,completed_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'LMS Assignment Filter', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - status: { - description: 'Filter to select assignment by status', - type: 'string', - enum: ['pending', 'in_progress', 'completed', 'unmapped_value', null], - nullable: true, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'user_id', - required: false, - in: 'query', - description: 'The user ID associated with this assignment', - schema: { - nullable: true, - example: 'c28xyrc55866bvuv', - type: 'string', - }, - }, - { - name: 'remote_user_id', - required: false, - in: 'query', - description: "Provider's unique identifier of the user related to the assignment", - schema: { - nullable: true, - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'The assignments related to the employee with the given identifier were retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AssignmentsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List User Assignments', - tags: ['Users', 'Assignments'], - 'x-speakeasy-group': 'lms', - 'x-speakeasy-name-override': 'list_user_assignments', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - post: { - description: - 'Create an assignment type learning record for a user. \n\nThis is the record linking a user to a learning object. \n\nIt can be pending or in progress.', - operationId: 'lms_create_user_assignment', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/LmsCreateAssignmentRequestDto', - }, - }, - }, - }, - responses: { - '201': { - description: 'The assignment was created successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Create User Assignment', - tags: ['Users', 'Assignments'], - 'x-speakeasy-group': 'lms', - 'x-speakeasy-name-override': 'create_user_assignment', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/lms/users/{id}/assignments/{subResourceId}': { - get: { - description: - 'Retrieve an assignment type learning record for a user by its identifier. \n\nThis is the record linking a user to a learning object. \n\nIt can be pending, in progress, or completed.', - operationId: 'lms_get_user_assignment', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields to return in the response (if empty, all fields are returned)', - schema: { - nullable: true, - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The assignment with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AssignmentResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get User Assignment', - tags: ['Users', 'Assignments'], - 'x-speakeasy-group': 'lms', - 'x-speakeasy-name-override': 'get_user_assignment', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/lms/content/batch': { - post: { - description: - 'Batch upsert multiple external linking learning objects that redirect users to a provider platform for consumption and progress tracking. \n\n**Note:** Partial updates are not supported. When updating content, you must provide all the same fields that are required when creating content. \n\nSee [here](https://docs.stackone.com/integration-guides/lms/external-content-providers/introduction) for more information about external linking learning objects.', - operationId: 'lms_batch_upsert_content', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/LmsBatchUpsertContentRequestDto', - }, - }, - }, - }, - responses: { - '202': { - description: 'Batch operation accepted', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BatchResultApiModel', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Batch Upsert External Linking Learning Objects', - tags: ['External Linking Learning Objects'], - 'x-speakeasy-group': 'lms', - 'x-speakeasy-name-override': 'batch_upsert_content', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/lms/content': { - put: { - description: - 'Create or update an external linking learning object that redirects users to a provider platform for consumption and progress tracking. \n\n**Note:** Partial updates are not supported. When updating content, you must provide all the same fields that are required when creating content. \n\nSee [here](https://docs.stackone.com/integration-guides/lms/external-content-providers/introduction) for more information about external linking learning objects.', - operationId: 'lms_upsert_content', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/LmsUpsertContentRequestDto', - }, - }, - }, - }, - responses: { - '201': { - description: 'The content was upserted successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UpsertResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Upsert External Linking Learning Objects', - tags: ['External Linking Learning Objects'], - 'x-speakeasy-group': 'lms', - 'x-speakeasy-name-override': 'upsert_content', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - get: { - description: - 'Retrieve a list of content type learning objects. \n\nThese are the most granular learning objects (e.g. video, document, podcast) on a platform. \n\nOnly content objects for which the platform supports progress and completion tracking are returned.', - operationId: 'lms_list_content', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,external_reference,course_ids,remote_course_ids,title,description,additional_data,languages,content_url,mobile_launch_content_url,content_type,cover_url,active,duration,order,categories,skills,updated_at,created_at,provider,localizations,tags,authors,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'LMS Courses Filter', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - active: { - description: 'Filter to allow filtering of only active content', - oneOf: [ - { - type: 'boolean', - const: true, - }, - { - type: 'string', - const: 'true', - }, - ], - nullable: true, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of content was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ContentPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Content', - tags: ['Content'], - 'x-speakeasy-group': 'lms', - 'x-speakeasy-name-override': 'list_content', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/lms/content/{id}': { - get: { - description: - 'Retrieve a content type learning object by its identifier. \n\nThese are the most granular learning objects (e.g. video, document, podcast) on a platform. \n\nOnly content objects for which the platform supports progress and completion tracking are returned.', - operationId: 'lms_get_content', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,external_reference,course_ids,remote_course_ids,title,description,additional_data,languages,content_url,mobile_launch_content_url,content_type,cover_url,active,duration,order,categories,skills,updated_at,created_at,provider,localizations,tags,authors,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The content with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ContentResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Content', - tags: ['Content'], - 'x-speakeasy-group': 'lms', - 'x-speakeasy-name-override': 'get_content', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/lms/users/{id}/completions': { - get: { - description: - 'Retrieve a list of completed learning records for a user. \n\nThese are the records of a user completing learning objects.', - operationId: 'lms_list_user_completions', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,external_id,remote_external_id,external_reference,content_id,remote_content_id,course_id,remote_course_id,user_id,remote_user_id,completed_at,updated_at,created_at,result,content_external_reference,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference,time_spent,certificate_url,score,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'LMS Completions Filter', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'The completions with for the users with the given identifier were retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CompletionsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List User Completions', - tags: ['Users', 'Completions'], - 'x-speakeasy-group': 'lms', - 'x-speakeasy-name-override': 'list_user_completions', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - post: { - description: - 'Create a completed learning record for a user. \n\nThis is the record of a user completing a learning object.', - operationId: 'lms_create_user_completion', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/LmsCreateCompletionRequestDto', - }, - }, - }, - }, - responses: { - '201': { - description: 'The completion was created successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Create User Completion', - tags: ['Users', 'Completions'], - 'x-speakeasy-group': 'lms', - 'x-speakeasy-name-override': 'create_user_completion', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/lms/users/{id}/completions/{subResourceId}': { - get: { - description: - 'Retrieve a completed learning record for a user by its identifier. \n\nThis is the record of a user completing a learning object.', - operationId: 'lms_get_user_completion', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields to return in the response (if empty, all fields are returned)', - schema: { - nullable: true, - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The completion with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CompletionResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get User Completion', - tags: ['Users', 'Completions'], - 'x-speakeasy-group': 'lms', - 'x-speakeasy-name-override': 'get_user_completion', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - delete: { - description: - 'Delete a completion type learning record for a user. \n\nThis is a record of a user completing a learning object.', - operationId: 'lms_delete_user_completion', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The completion was deleted successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/DeleteResult', - }, - }, - }, - }, - '204': { - description: 'The completion was deleted successfully but no content was returned.', - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Delete User Completion', - tags: ['Users', 'Completions'], - 'x-speakeasy-group': 'lms', - 'x-speakeasy-name-override': 'delete_user_completion', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/lms/completions': { - get: { - description: - 'Retrieve a list of completed learning records. These are the records of a user completing learning objects.', - operationId: 'lms_list_completions', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,external_id,remote_external_id,external_reference,content_id,remote_content_id,course_id,remote_course_id,user_id,remote_user_id,completed_at,updated_at,created_at,result,content_external_reference,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference,time_spent,certificate_url,score,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'LMS Completions Filter', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of completions was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CompletionsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Completions', - tags: ['Completions'], - 'x-speakeasy-group': 'lms', - 'x-speakeasy-name-override': 'list_completions', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/lms/completions/{id}': { - get: { - description: - 'Retrieve a completed learning record by its identifier. This is the record of a user completing a learning object.', - operationId: 'lms_get_completion', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields to return in the response (if empty, all fields are returned)', - schema: { - nullable: true, - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The completion with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CompletionResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Completion', - tags: ['Completions'], - 'x-speakeasy-group': 'lms', - 'x-speakeasy-name-override': 'get_completion', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/lms/categories/{id}': { - get: { - operationId: 'lms_get_category', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,active,hierarchy,level,language,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The category with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CategoryResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Category', - tags: ['Categories'], - 'x-speakeasy-group': 'lms', - 'x-speakeasy-name-override': 'get_category', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/lms/categories': { - get: { - operationId: 'lms_list_categories', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,active,hierarchy,level,language,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of categories was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CategoriesPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Categories', - tags: ['Categories'], - 'x-speakeasy-group': 'lms', - 'x-speakeasy-name-override': 'list_categories', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/lms/users': { - get: { - operationId: 'lms_list_users', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,external_reference,active,email,phone_number,created_at,updated_at,name,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'LMS Users Filter', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - email: { - description: 'Filter to select users by email', - type: 'string', - nullable: true, - }, - external_reference: { - description: 'Filter to select users by external_reference', - type: 'string', - nullable: true, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of users was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UsersPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Users', - tags: ['Users'], - 'x-speakeasy-group': 'lms', - 'x-speakeasy-name-override': 'list_users', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/lms/users/{id}': { - get: { - operationId: 'lms_get_user', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,external_reference,active,email,phone_number,created_at,updated_at,name,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The user with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UserResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get User', - tags: ['Users'], - 'x-speakeasy-group': 'lms', - 'x-speakeasy-name-override': 'get_user', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/lms/skills/{id}': { - get: { - operationId: 'lms_get_skill', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,active,hierarchy,language,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The skill with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/SkillResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Skill', - tags: ['Skills'], - 'x-speakeasy-group': 'lms', - 'x-speakeasy-name-override': 'get_skill', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/lms/skills': { - get: { - operationId: 'lms_list_skills', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,active,hierarchy,language,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of skills was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/SkillsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Skills', - tags: ['Skills'], - 'x-speakeasy-group': 'lms', - 'x-speakeasy-name-override': 'list_skills', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/lms/assignments': { - get: { - description: - 'Retrieve a list of assignment type learning records. \n\nThese are the records linking a user to a learning object. \n\nThey can be pending, in progress, or completed.', - operationId: 'lms_list_assignments', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,external_reference,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,assigned_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference,certificate_url,result,completed_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'LMS Assignment Filter', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - status: { - description: 'Filter to select assignment by status', - type: 'string', - enum: ['pending', 'in_progress', 'completed', 'unmapped_value', null], - nullable: true, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - { - name: 'user_id', - required: false, - in: 'query', - description: 'The user ID associated with this assignment', - schema: { - nullable: true, - example: 'c28xyrc55866bvuv', - type: 'string', - }, - }, - { - name: 'remote_user_id', - required: false, - in: 'query', - description: "Provider's unique identifier of the user related to the assignment", - schema: { - nullable: true, - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of assignments was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AssignmentsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Assignments', - tags: ['Assignments'], - 'x-speakeasy-group': 'lms', - 'x-speakeasy-name-override': 'list_assignments', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/lms/assignments/{id}': { - get: { - description: - 'Retrieve an assignment type learning record by its identifier. \n\nThis is the record linking a user to a learning object. \n\nIt can be pending, in progress, or completed.', - operationId: 'lms_get_assignment', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields to return in the response (if empty, all fields are returned)', - schema: { - nullable: true, - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The assignment with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/AssignmentResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Assignment', - tags: ['Assignments'], - 'x-speakeasy-group': 'lms', - 'x-speakeasy-name-override': 'get_assignment', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - }, - info: { - title: 'LMS', - description: 'The documentation for the StackOne Unified API - LMS', - version: '1.0.0', - contact: {}, - }, - tags: [ - { - name: 'Courses', - description: 'Collections of learning content.', - }, - { - name: 'Content', - description: 'Granular learning content items.', - }, - { - name: 'External Linking Learning Objects', - description: 'External linking learning objects.', - }, - { - name: 'Categories', - description: 'Categories for organizing learning content.', - }, - { - name: 'Users', - description: 'People enrolled in or using the LMS.', - }, - { - name: 'Skills', - description: 'Skills or competencies taught or tracked.', - }, - { - name: 'Assignments', - description: 'Tasks or assignments for learners.', - }, - { - name: 'Completions', - description: 'Records of completed assignments or courses.', - }, - { - name: 'Collections', - description: 'Groups of courses or learning resources.', - }, - ], - servers: [ - { - url: 'https://api.stackone.com', - }, - ], - components: { - securitySchemes: { - basic: { - type: 'http', - scheme: 'basic', - }, - }, - schemas: { - AdditionalData: { - type: 'object', - properties: { - id: { - type: 'string', - description: - 'The name of the additional data field. Speak to your Solutions Engineer to understand the id for the specific use case', - example: 'learning_outcomes', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'array', - items: { - type: 'string', - }, - }, - ], - nullable: true, - description: 'The value of the additional data', - example: 'This is additional data', - }, - }, - }, - Assignment: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'The ID associated with this assignment', - example: '123456', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - external_reference: { - type: 'string', - description: 'The external reference associated with this assignment', - example: 'e3gd34-23tr21-er234-345er56', - deprecated: true, - nullable: true, - }, - learning_object_id: { - type: 'string', - description: - 'The learning_object_id associated with this assignment. This is not required unless specified in an integration.', - example: 'e3gd34-23tr21-er234-345er56', - nullable: true, - }, - remote_learning_object_id: { - type: 'string', - description: - "Provider's unique identifier of the learning object related to the assignment", - example: 'e3cb55bf-aa84-466e-a6c1-b8302b257a49', - nullable: true, - }, - learning_object_external_reference: { - type: 'string', - description: - 'The external reference of the learning object associated with this assignment, this is the main identifier for creating assignments.', - example: 'learning-content-123', - nullable: true, - }, - progress: { - type: 'number', - description: 'The progress associated with this assigment', - example: '40', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The date the assignment was last updated', - example: '2021-07-21T14:00:00.000Z', - format: 'date-time', - nullable: true, - }, - created_at: { - type: 'string', - description: 'The date the assignment was created', - example: '2021-07-21T14:00:00.000Z', - format: 'date-time', - nullable: true, - }, - assigned_at: { - type: 'string', - description: 'The date the assignment was assigned', - example: '2021-07-21T14:00:00.000Z', - format: 'date-time', - nullable: true, - }, - due_date: { - type: 'string', - description: 'The date the assignment is due to be completed', - example: '2021-07-21T14:00:00.000Z', - format: 'date-time', - nullable: true, - }, - status: { - description: 'The status of the assignment', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/AssignmentStatusEnum', - }, - ], - }, - learning_object_type: { - description: 'The learning object type of the assignment', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/LearningObjectTypeEnum', - }, - ], - }, - user_id: { - type: 'string', - description: 'The user ID associated with this assignment', - example: 'c28xyrc55866bvuv', - nullable: true, - }, - remote_user_id: { - type: 'string', - description: "Provider's unique identifier of the user related to the assignment", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - certificate_url: { - type: 'string', - description: 'The certification URL associated with this assignment', - example: 'https://example.com/certificate/12345', - nullable: true, - }, - result: { - description: 'The result of the assignment', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ResultStatusEnum', - }, - ], - }, - completed_at: { - type: 'string', - description: 'The date the content was completed', - example: '2021-07-21T14:00:00.000Z', - format: 'date-time', - nullable: true, - }, - course_id: { - type: 'string', - description: 'The course ID associated with this assignment', - example: '16873-ENG-1', - deprecated: true, - nullable: true, - }, - remote_course_id: { - type: 'string', - description: "Provider's unique identifier of the course related to the assignment", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - deprecated: true, - nullable: true, - }, - }, - }, - AssignmentResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/Assignment', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - AssignmentsPaginated: { - type: 'object', - properties: { - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/Assignment', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - AssignmentStatusEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: ['pending', 'in_progress', 'completed', 'unmapped_value', null], - example: 'in_progress', - description: 'The StackOne unified assignment status.', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - description: 'The original status value from the provider before normalization.', - nullable: true, - }, - }, - }, - AuthorModel: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'The ID of the author', - example: '123', - nullable: true, - }, - name: { - type: 'string', - description: 'The name of the author', - example: 'John Doe', - nullable: true, - }, - }, - }, - BadGatewayResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 502, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Gateway', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - BadRequestResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 400, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Request', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - data: { - description: 'Error details', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/UnifiedError', - }, - ], - }, - provider_errors: { - description: 'List of provider-specific errors', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/ProviderError', - }, - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - BatchResultApiModel: { - type: 'object', - properties: { - statusCode: { - type: 'number', - example: 202, - nullable: true, - }, - message: { - type: 'string', - example: 'Batch operation accepted', - nullable: true, - }, - timestamp: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - errors: { - type: 'array', - example: [['Missing field: name'], [], []], - items: { - type: 'array', - items: { - type: 'string', - }, - }, - nullable: true, - }, - }, - }, - CategoriesPaginated: { - type: 'object', - properties: { - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/Category', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - Category: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'The ID associated with this category', - example: '16873-IT345', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - name: { - type: 'string', - description: 'The name associated with this category', - example: 'Information-Technology', - nullable: true, - }, - active: { - description: 'Whether the category is active and therefore available for use', - example: true, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - hierarchy: { - description: 'The hierarchal level of the category', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/CategoryLevelEnumModel', - }, - ], - }, - level: { - description: 'The hierarchal level of the category', - deprecated: true, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/CategoryLevelEnumModel', - }, - ], - }, - language: { - description: 'The language associated with this category', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/LanguageEnum', - }, - ], - }, - }, - }, - CategoryLevelEnumModel: { - type: 'object', - properties: { - value: { - type: 'string', - enum: ['primary', 'secondary', 'tertiary', 'unmapped_value', null], - description: - 'The unified category level. For write operations: provide one of the listed enum values, or omit/set to "unmapped_value" to use source_value instead.', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - description: - 'For read operations: the original category level from the provider. For write operations: fallback value used when value is omitted or "unmapped_value". You must ensure this matches the provider\'s format.', - nullable: true, - }, - }, - }, - CategoryResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/Category', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - Completion: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'The ID associated with this completion', - example: '123456', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - learning_object_external_reference: { - type: 'string', - description: - 'The external reference of the learning object associated with this completion, this is the main identifier for creating completions.', - example: 'learning-content-123', - nullable: true, - }, - external_reference: { - type: 'string', - description: 'The external reference associated with this completion', - example: 'e3gd34-23tr21-er234-345er56', - deprecated: true, - nullable: true, - }, - result: { - description: 'The result of the completion', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ResultStatusEnum', - }, - ], - }, - completed_at: { - type: 'string', - description: 'The date the content was completed', - example: '2021-07-21T14:00:00.000Z', - format: 'date-time', - nullable: true, - }, - created_at: { - type: 'string', - description: 'The created date of the completion', - example: '2021-07-21T14:00:00.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The updated date of the completion', - example: '2021-07-21T14:00:00.000Z', - format: 'date-time', - nullable: true, - }, - learning_object_type: { - description: 'The learning object type of the completion', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/LearningObjectTypeEnum', - }, - ], - }, - learning_object_id: { - type: 'string', - description: - 'The id of the learning object associated with this completion. This is not required unless specified in an integration.', - example: 'e3gd34-23tr21-er234-345er56', - nullable: true, - }, - remote_learning_object_id: { - type: 'string', - description: - "Provider's unique identifier of the learning object related to the completion", - example: 'e3cb55bf-aa84-466e-a6c1-b8302b257a49', - nullable: true, - }, - user_id: { - type: 'string', - description: 'The user ID associated with this completion', - example: 'c28xyrc55866bvuv', - nullable: true, - }, - remote_user_id: { - type: 'string', - description: "Provider's unique identifier of the user related to the completion", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - nullable: true, - }, - time_spent: { - type: 'string', - description: - 'ISO 8601 duration format representing the time spent on completing the learning object', - example: 'PT1H30M45S', - format: 'string', - nullable: true, - }, - certificate_url: { - type: 'string', - description: 'The certification URL associated with this completion', - example: 'https://example.com/certificate/12345', - nullable: true, - }, - external_id: { - type: 'string', - description: 'The external ID associated with this completion', - example: 'SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-COMPLETION', - deprecated: true, - nullable: true, - }, - content_external_reference: { - type: 'string', - description: 'The external reference associated with this content', - example: 'SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-CONTENT', - deprecated: true, - nullable: true, - }, - remote_external_id: { - type: 'string', - description: "Provider's unique identifier of the content external reference", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - deprecated: true, - nullable: true, - }, - content_id: { - type: 'string', - description: 'The content ID associated with this completion', - example: '16873-ENG-VIDEO-1', - deprecated: true, - nullable: true, - }, - remote_content_id: { - type: 'string', - description: - "Provider's unique identifier of the content associated with the completion", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - deprecated: true, - nullable: true, - }, - course_id: { - type: 'string', - description: 'The course ID associated with this completion', - example: '16873-ENG-COURSE-1', - deprecated: true, - nullable: true, - }, - remote_course_id: { - type: 'string', - description: - "Provider's unique identifier of the course associated with the completion", - example: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - deprecated: true, - nullable: true, - }, - score: { - description: 'The score associated with this completion', - example: { - percentage: 87, - raw_value: '87 / 100', - }, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ScoreModel', - }, - ], - }, - }, - }, - CompletionResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/Completion', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - CompletionsPaginated: { - type: 'object', - properties: { - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/Completion', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - ConflictResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 409, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Conflict', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - Content: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - external_reference: { - type: 'string', - description: 'The external ID associated with this content', - example: 'SOFTWARE-ENG-LV1-TRAINING-VIDEO-1', - nullable: true, - }, - course_ids: { - description: 'The parent ID/IDs associated with this content', - example: ['16873-SOFTWARE-ENG-COURSE', '16874-SOFTWARE-ENG-COURSE'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - remote_course_ids: { - description: - "Provider's unique identifier of the parent course ID associated with this content", - example: [ - 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - 'e3cb75bf-aa84-466e-a6c1-b8322b257a49', - ], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - title: { - type: 'string', - description: 'The title of the content', - example: 'Software Engineer Lv 1', - nullable: true, - }, - description: { - type: 'string', - description: 'The description of the content', - example: 'This video acts as learning content for software engineers.', - nullable: true, - }, - languages: { - description: 'The languages associated with this content', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/LanguageEnum', - }, - }, - content_url: { - type: 'string', - description: 'The external URL of the content', - example: 'https://www.youtube.com/watch?v=16873', - nullable: true, - }, - mobile_launch_content_url: { - type: 'string', - description: 'The mobile friendly URL of the content', - example: 'https://www.mobile.youtube.com/watch?v=16873', - nullable: true, - }, - content_type: { - description: 'The type of content', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ContentTypeEnum', - }, - ], - }, - cover_url: { - type: 'string', - description: 'The URL of the thumbnail image associated with the content.', - example: 'https://www.googledrive.com/?v=16873', - nullable: true, - }, - active: { - description: 'Whether the content is active and available for users.', - example: true, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - duration: { - type: 'string', - description: - 'The duration of the content following the ISO8601 standard. If duration_unit is applicable we will derive this from the smallest unit given in the duration string or the minimum unit accepted by the provider.', - example: 'P3Y6M4DT12H30M5S', - format: 'string', - nullable: true, - }, - categories: { - description: 'The categories associated with this content', - example: [ - { - id: '12345', - name: 'Technology', - }, - ], - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/Category', - }, - }, - skills: { - description: 'The skills associated with this course', - example: [ - { - id: '12345', - name: 'Sales Techniques', - }, - ], - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/Skills', - }, - }, - order: { - type: 'number', - description: - 'The order of the individual content within a content grouping. This is not applicable for pushing individual content.', - example: 1, - format: 'number', - nullable: true, - }, - provider: { - type: 'string', - description: 'The name of the content provider', - example: 'Content Provider', - nullable: true, - }, - short_description: { - type: 'string', - description: 'A short description or summary for the content', - example: 'This course is a valuable resource and acts as learning content for...', - deprecated: true, - nullable: true, - }, - localizations: { - description: 'Localised content information', - example: [ - { - title: 'Software Engineer Lv 1', - description: 'This video acts as learning content for software engineers.', - languages: { - value: 'en-US', - source_value: 'string', - }, - }, - ], - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/LocalizationModel', - }, - }, - tags: { - description: 'A list of tags associated with the content', - example: ['Sales Techniques', 'Customer Service'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - authors: { - description: 'The authors of the content', - example: [ - { - id: '123', - name: 'John Doe', - }, - ], - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/AuthorModel', - }, - }, - updated_at: { - type: 'string', - description: 'The date on which the content was last updated.', - example: '2021-07-21T14:00:00.000Z', - format: 'date-time', - nullable: true, - }, - created_at: { - type: 'string', - description: 'The date on which the content was created.', - example: '2021-07-21T14:00:00.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - ContentPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - total: { - type: 'number', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/Content', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - ContentResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/Content', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - ContentTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: ['video', 'quiz', 'document', 'audio', 'article', 'unmapped_value', null], - description: 'The StackOne unified content type.', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - description: 'The original value from the provider before normalization.', - nullable: true, - }, - }, - }, - Course: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - external_reference: { - type: 'string', - description: 'The external ID associated with this course', - example: 'SOFTWARE-ENG-LV1-TRAINING-VIDEO-1', - nullable: true, - }, - content_ids: { - description: 'The child ID/IDs associated with this course', - example: ['16873-SOFTWARE-ENG-COURSE', '16874-SOFTWARE-ENG-COURSE'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - remote_content_ids: { - description: - "Provider's unique identifier of the child content IDs associated with this course", - example: [ - 'e3cb75bf-aa84-466e-a6c1-b8322b257a48', - 'e3cb75bf-aa84-466e-a6c1-b8322b257a49', - ], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - title: { - type: 'string', - description: 'The title of the course', - example: 'Software Engineer Lv 1', - nullable: true, - }, - description: { - type: 'string', - description: 'The description of the course', - example: 'This course acts as learning content for software engineers.', - nullable: true, - }, - languages: { - description: 'The languages associated with this course', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/LanguageEnum', - }, - }, - cover_url: { - type: 'string', - description: 'The URL of the thumbnail image associated with the course.', - example: 'https://www.googledrive.com/?v=16873', - nullable: true, - }, - url: { - type: 'string', - description: 'The redirect URL of the course.', - example: 'https://www.linkedinlearning.com/?v=16873', - nullable: true, - }, - active: { - description: 'Whether the course is active and available for users.', - example: true, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - duration: { - type: 'string', - description: - 'The duration of the course following the ISO8601 standard. If duration_unit is applicable we will derive this from the smallest unit given in the duration string', - example: 'P3Y6M4DT12H30M5S', - format: 'string', - nullable: true, - }, - categories: { - description: 'The categories associated with this course', - example: [ - { - id: '12345', - name: 'Technology', - }, - ], - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/Category', - }, - }, - skills: { - description: 'The skills associated with this course', - example: [ - { - id: '12345', - name: 'Sales Techniques', - }, - ], - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/Skills', - }, - }, - provider: { - type: 'string', - description: 'The name of the course provider', - example: 'Course Provider', - format: 'string', - nullable: true, - }, - authors: { - description: 'The authors of the course', - example: [ - { - id: '123', - name: 'John Doe', - }, - ], - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/AuthorModel', - }, - }, - updated_at: { - type: 'string', - description: 'The date on which the course was last updated.', - example: '2021-07-21T14:00:00.000Z', - format: 'date-time', - nullable: true, - }, - created_at: { - type: 'string', - description: 'The date on which the course was created.', - example: '2021-07-21T14:00:00.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - CoursePaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - total: { - type: 'number', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/Course', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - CourseResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/Course', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - CreateCategoriesApiModel: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'The ID associated with this category', - example: '16873-IT345', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - name: { - type: 'string', - description: 'The name associated with this category', - example: 'Information-Technology', - nullable: true, - }, - hierarchy: { - description: 'The hierarchal level of the category', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/CategoryLevelEnumModel', - }, - ], - }, - level: { - description: 'The hierarchal level of the category', - deprecated: true, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/CategoryLevelEnumModel', - }, - ], - }, - language: { - description: 'The language associated with this category', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/LanguageEnum', - }, - ], - }, - }, - }, - CreateResult: { - type: 'object', - properties: { - statusCode: { - type: 'number', - example: 201, - }, - message: { - type: 'string', - example: 'Record created successfully.', - }, - timestamp: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - }, - data: { - $ref: '#/components/schemas/CreateResultDataApiModel', - }, - }, - required: ['statusCode', 'message', 'timestamp', 'data'], - }, - CreateResultDataApiModel: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - }, - }, - CreateSkillsApiModel: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'The ID associated with this skill', - example: '16873-IT345', - nullable: true, - }, - name: { - type: 'string', - description: 'The name associated with this skill', - example: 'Information-Technology', - nullable: true, - }, - hierarchy: { - description: 'The hierarchal level of the skill', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/SkillLevelEnum', - }, - ], - }, - language: { - description: 'The language associated with this skill', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/LanguageEnum', - }, - ], - }, - level: { - description: 'The hierarchal level of the skill', - deprecated: true, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/SkillLevelEnum', - }, - ], - }, - }, - }, - DeleteResult: { - type: 'object', - properties: { - statusCode: { - type: 'number', - example: 204, - }, - message: { - type: 'string', - example: 'Record deleted successfully.', - }, - timestamp: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - ForbiddenResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 403, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Forbidden resource', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - InternalServerErrorResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 500, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Internal server error', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - LanguageEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'ar_AR', - 'aa_ER', - 'af_NA', - 'af_ZA', - 'am_ET', - 'ar_AE', - 'ar_BH', - 'ar_DJ', - 'ar_DZ', - 'ar_EG', - 'ar_ER', - 'ar_IQ', - 'ar_JO', - 'ar_KM', - 'ar_KW', - 'ar_LB', - 'ar_LY', - 'ar_MA', - 'ar_MR', - 'ar_OM', - 'ar_PS', - 'ar_QA', - 'ar_SA', - 'ar_SD', - 'ar_SY', - 'ar_TD', - 'ar_TN', - 'ar_YE', - 'ay_BO', - 'ay_PE', - 'az_AZ', - 'az_IR', - 'be_BY', - 'bg_BG', - 'bi_VU', - 'bn_BD', - 'bn_IN', - 'bs_BA', - 'bs-ME', - 'byn_ER', - 'ca_AD', - 'ca_ES', - 'ca_FR', - 'ca_IT', - 'ch_GU', - 'cs_CZ', - 'da_DK', - 'de_AT', - 'de_BE', - 'de_CH', - 'de_DE', - 'de_LI', - 'de_LU', - 'de_VA', - 'de_MV', - 'dv_MV', - 'dz_BT', - 'el_CY', - 'el_GR', - 'en_AG', - 'en_AI', - 'en_AS', - 'en_AU', - 'en_BB', - 'en_BE', - 'en_BM', - 'en_BS', - 'en_BW', - 'en_BZ', - 'en_CA', - 'en_CC', - 'en_CK', - 'en_CM', - 'en_CW', - 'en_CX', - 'en_DG', - 'en_DM', - 'en_ER', - 'en_FJ', - 'en_FK', - 'en_FM', - 'en_GB', - 'en_GD', - 'en_GG', - 'en_GH', - 'en_GI', - 'en_GM', - 'en_GS', - 'en_GU', - 'en_GY', - 'en_HK', - 'en_IE', - 'en_IM', - 'en_IN', - 'en_IO', - 'en_JE', - 'en_JM', - 'en_KE', - 'en_KI', - 'en_KN', - 'en_KY', - 'en_LC', - 'en_LR', - 'en_LS', - 'en_MF', - 'en_MG', - 'en_MH', - 'en_MO', - 'en_MP', - 'en_MS', - 'en_MT', - 'en_MU', - 'en_MW', - 'en_MY', - 'en_NA', - 'en_NF', - 'en_NG', - 'en_NL', - 'en_NR', - 'en_NU', - 'en_NZ', - 'en_PG', - 'en_PH', - 'en_PK', - 'en_PN', - 'en_PR', - 'en_PW', - 'en_RW', - 'en_SB', - 'en_SC', - 'en_SD', - 'en_SG', - 'en_SH', - 'en_SL', - 'en_SS', - 'en_SX', - 'en_SZ', - 'en_TC', - 'en_TK', - 'en_TO', - 'en_TT', - 'en_TV', - 'en_TZ', - 'en_UG', - 'en_UM', - 'en_US', - 'en_VC', - 'en_VG', - 'en_VI', - 'en_VU', - 'en_WS', - 'en_ZA', - 'en_ZM', - 'en_ZW', - 'es_AR', - 'es_BO', - 'es_BZ', - 'es_CL', - 'es_CO', - 'es_CR', - 'es_CU', - 'es_DO', - 'es_EA', - 'es_EC', - 'es_EH', - 'es_ES', - 'es_GQ', - 'es_GT', - 'es_HN', - 'es_IC', - 'es_LA', - 'es_MX', - 'es_NI', - 'es_PA', - 'es_PE', - 'es_PH', - 'es_PR', - 'es_PY', - 'es_SV', - 'es_US', - 'es_UY', - 'es_VE', - 'et_EE', - 'fa_AF', - 'fa_IR', - 'fan_GA', - 'ff_CM', - 'ff_GN', - 'ff_MR', - 'ff_SN', - 'ff_BF', - 'fi_FI', - 'fj_FJ', - 'fo_FO', - 'fr_BE', - 'fr_BF', - 'fr_BI', - 'fr_BJ', - 'fr_BL', - 'fr_CA', - 'fr_CD', - 'fr_CF', - 'fr_CG', - 'fr_CH', - 'fr_CI', - 'fr_CM', - 'fr_DJ', - 'fr_DZ', - 'fr_FR', - 'fr_GA', - 'fr_GF', - 'fr_GG', - 'fr_GN', - 'fr_GP', - 'fr_GQ', - 'fr_HT', - 'fr_KM', - 'fr_JE', - 'fr_LU', - 'fr_LB', - 'fr_MA', - 'fr_MC', - 'fr_MF', - 'fr_MG', - 'fr_ML', - 'fr_MQ', - 'fr_MR', - 'fr_MU', - 'fr_NC', - 'fr_NE', - 'fr_PF', - 'fr_PM', - 'fr_RE', - 'fr_RW', - 'fr_SC', - 'fr_SN', - 'fr_SY', - 'fr_TD', - 'fr_TF', - 'fr_TG', - 'fr_TN', - 'fr_VU', - 'fr_VA', - 'fr_WF', - 'fr_YT', - 'ga_IE', - 'gn_PY', - 'gn_AR', - 'gu_IN', - 'gv_IM', - 'he_IL', - 'hi_IN', - 'hr_BA', - 'hr_HR', - 'hr_ME', - 'ht_HT', - 'hu_HU', - 'hy_AM', - 'hy_CY', - 'id_ID', - 'is_IS', - 'it_CH', - 'it_IT', - 'it_SM', - 'it_VA', - 'ja_JP', - 'ka_GE', - 'kg_CD', - 'kk_KZ', - 'kl_GL', - 'km_KH', - 'ko_KP', - 'ko_KR', - 'ku_IQ', - 'ky_KG', - 'la_VA', - 'lb_LU', - 'ln_AO', - 'ln_CD', - 'ln_CF', - 'ln_CG', - 'lo_LA', - 'lt_LT', - 'lu_CD', - 'lv_LV', - 'mg_MG', - 'mh_MH', - 'mi_NZ', - 'mk_MK', - 'mn_MN', - 'mr_IN', - 'ms_BN', - 'ms_MY', - 'ms_SG', - 'mt_MT', - 'my_MM', - 'nb_NO', - 'nb_BV', - 'nb_ZW', - 'ne_NP', - 'nl_AW', - 'nl_BE', - 'nl_BQ', - 'nl_CW', - 'nl_NL', - 'nl_SR', - 'nl_SX', - 'nl_MF', - 'nn_NO', - 'nn_BV', - 'no_NO', - 'no_BV', - 'no_SJ', - 'nr_ZA', - 'ny_MW', - 'pa_IN', - 'pa_PK', - 'pl_PL', - 'ps_AF', - 'pt_AO', - 'pt_BR', - 'pt_CH', - 'pt_CV', - 'pt_GQ', - 'pt_GW', - 'pt_LU', - 'pt_MO', - 'pt_MZ', - 'pt_PT', - 'pt_ST', - 'pt_TL', - 'qu_BO', - 'qu_EC', - 'qu_PE', - 'rar_CK', - 'rm_CH', - 'rup_MK', - 'ro_MD', - 'ro_RO', - 'ru_BY', - 'ru_KG', - 'ru_KZ', - 'ru_MD', - 'ru_RU', - 'ru_UA', - 'ru_AQ', - 'ru_TJ', - 'ru_TM', - 'ru_UZ', - 'rw_RW', - 'se_SE', - 'sg_CF', - 'si_LK', - 'sk_SK', - 'sl_SI', - 'sm_AS', - 'sm_WS', - 'sn_ZW', - 'so_DJ', - 'so_ET', - 'so_KE', - 'so_SO', - 'sq_AL', - 'sq_ME', - 'sq_XK', - 'sr_BA', - 'sr_ME', - 'sr_RS', - 'sr_XK', - 'ss_SZ', - 'ss_ZA', - 'sv_AX', - 'sv_FI', - 'sv_SE', - 'sw_KE', - 'sw_TZ', - 'sw_UG', - 'sw_CD', - 'ta_IN', - 'ta_MY', - 'ta_SG', - 'ta_LK', - 'te_IN', - 'tg_TJ', - 'th_TH', - 'ti_ER', - 'ti_ET', - 'tig_ER', - 'tk_TM', - 'tk_AF', - 'tn_BW', - 'tn_ZA', - 'to_TO', - 'tr_CY', - 'tr_TR', - 'ts_ZA', - 'uk_UA', - 'ur_IN', - 'ur_PK', - 'uz_AF', - 'uz_UZ', - 've_ZA', - 'vi_VN', - 'xh_ZA', - 'zh_CN', - 'zh_HK', - 'zh_MO', - 'zh_SG', - 'zh_TW', - 'zu_ZA', - 'unmapped_value', - null, - ], - description: - 'The unified locale code. For write operations: provide one of the listed enum values, or omit/set to "unmapped_value" to use source_value instead.', - example: 'en_GB', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - description: - 'For read operations: the original language code from the provider. For write operations: fallback value used when value is omitted or "unmapped_value". You must ensure this matches the provider\'s format.', - nullable: true, - }, - }, - }, - LearningObjectTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: ['content', 'course', 'collection', 'unmapped_value', null], - description: 'The StackOne unified learning object type.', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - description: - 'The original learning object type from the provider before normalization.', - nullable: true, - }, - }, - }, - LmsBatchUpsertContentRequestDto: { - type: 'object', - properties: { - items: { - description: 'The batch of items to upsert', - nullable: false, - type: 'array', - items: { - $ref: '#/components/schemas/LmsUpsertContentRequestDto', - }, - }, - }, - required: ['items'], - }, - LmsCreateAssignmentRequestDto: { - type: 'object', - properties: { - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - external_reference: { - type: 'string', - description: 'The external reference associated with this assignment', - example: 'e3gd34-23tr21-er234-345er56', - deprecated: true, - nullable: true, - }, - learning_object_id: { - type: 'string', - description: - 'The learning_object_id associated with this assignment. This is not required unless specified in an integration.', - example: 'e3gd34-23tr21-er234-345er56', - nullable: true, - }, - progress: { - type: 'number', - description: 'The progress associated with this assigment', - example: '40', - nullable: true, - }, - assigned_at: { - type: 'string', - description: 'The date the assignment was assigned', - example: '2021-07-21T14:00:00.000Z', - format: 'date-time', - nullable: true, - }, - due_date: { - type: 'string', - description: 'The date the assignment is due to be completed', - example: '2021-07-21T14:00:00.000Z', - format: 'date-time', - nullable: true, - }, - status: { - description: 'The status of the assignment', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/AssignmentStatusEnum', - }, - ], - }, - learning_object_external_reference: { - type: 'string', - description: - 'The external reference of the learning object associated with this assignment, this is the main identifier for creating assignments.', - example: 'learning-content-123', - }, - }, - required: ['learning_object_external_reference'], - }, - LmsCreateCompletionRequestDto: { - type: 'object', - properties: { - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - result: { - description: 'The result of the completion', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ResultStatusEnum', - }, - ], - }, - completed_at: { - type: 'string', - description: 'The date the content was completed', - example: '2021-07-21T14:00:00.000Z', - format: 'date-time', - nullable: true, - }, - learning_object_id: { - type: 'string', - description: - 'The id of the learning object associated with this completion. This is not required unless specified in an integration.', - example: 'e3gd34-23tr21-er234-345er56', - nullable: true, - }, - time_spent: { - type: 'string', - description: - 'ISO 8601 duration format representing the time spent on completing the learning object', - example: 'PT1H30M45S', - format: 'string', - nullable: true, - }, - content_external_reference: { - type: 'string', - description: 'The external reference associated with this content', - example: 'SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-CONTENT', - deprecated: true, - nullable: true, - }, - content_id: { - type: 'string', - description: 'The content ID associated with this completion', - example: '16873-ENG-VIDEO-1', - deprecated: true, - nullable: true, - }, - score: { - description: 'The score associated with this completion', - example: { - percentage: 87, - raw_value: '87 / 100', - }, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ScoreModel', - }, - ], - }, - learning_object_external_reference: { - type: 'string', - description: - 'The external reference of the learning object associated with this completion, this is the main identifier for creating completions.', - example: 'learning-content-123', - }, - }, - required: ['learning_object_external_reference'], - }, - LmsUpsertContentRequestDto: { - type: 'object', - properties: { - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - title: { - type: 'string', - description: 'The title of the content', - example: 'Software Engineer Lv 1', - nullable: true, - }, - description: { - type: 'string', - description: 'The description of the content', - example: 'This video acts as learning content for software engineers.', - nullable: true, - }, - languages: { - description: 'The languages associated with this content', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/LanguageEnum', - }, - }, - content_url: { - type: 'string', - description: 'The external URL of the content', - example: 'https://www.youtube.com/watch?v=16873', - nullable: true, - }, - mobile_launch_content_url: { - type: 'string', - description: 'The mobile friendly URL of the content', - example: 'https://www.mobile.youtube.com/watch?v=16873', - nullable: true, - }, - cover_url: { - type: 'string', - description: 'The URL of the thumbnail image associated with the content.', - example: 'https://www.googledrive.com/?v=16873', - nullable: true, - }, - active: { - description: 'Whether the content is active and available for users.', - example: true, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - duration: { - type: 'string', - description: - 'The duration of the content following the ISO8601 standard. If duration_unit is applicable we will derive this from the smallest unit given in the duration string or the minimum unit accepted by the provider.', - example: 'P3Y6M4DT12H30M5S', - format: 'string', - nullable: true, - }, - skills: { - description: 'The skills associated with this content', - example: [ - { - id: '12345', - name: 'Sales Techniques', - }, - ], - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CreateSkillsApiModel', - }, - }, - order: { - type: 'number', - description: - 'The order of the individual content within a content grouping. This is not applicable for pushing individual content.', - example: 1, - format: 'number', - nullable: true, - }, - short_description: { - type: 'string', - description: 'A short description or summary for the content', - example: 'This course is a valuable resource and acts as learning content for...', - deprecated: true, - nullable: true, - }, - localizations: { - description: 'The localization data for this course', - example: [ - { - title: 'Software Engineer Lv 1', - description: 'This course acts as learning resource for software engineers.', - languages: { - value: 'en-GB', - source_value: 'string', - }, - }, - { - title: 'Software Engineer: A comprehensive guide', - description: 'This course acts as learning resource for software engineers.', - languages: { - value: 'en-US', - source_value: 'string', - }, - }, - ], - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/LocalizationModel', - }, - }, - tags: { - description: 'A list of tags associated with the content', - example: ['Sales Techniques', 'Customer Service'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - authors: { - description: 'The authors of the content', - example: [ - { - id: '123', - name: 'John Doe', - }, - ], - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/AuthorModel', - }, - }, - updated_at: { - type: 'string', - description: 'The date on which the content was last updated.', - example: '2021-07-21T14:00:00.000Z', - format: 'date-time', - nullable: true, - }, - created_at: { - type: 'string', - description: 'The date on which the content was created.', - example: '2021-07-21T14:00:00.000Z', - format: 'date-time', - nullable: true, - }, - external_reference: { - type: 'string', - description: 'The external ID associated with this content', - example: 'SOFTWARE-ENG-LV1-TRAINING-VIDEO-1', - }, - categories: { - description: 'The categories associated with this content', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CreateCategoriesApiModel', - }, - }, - additional_data: { - description: 'The additional_data associated with this content', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/AdditionalData', - }, - }, - content_type: { - description: 'The type of content', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/WriteContentTypeEnum', - }, - ], - }, - }, - required: ['external_reference'], - }, - LmsUser: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - external_reference: { - type: 'string', - description: 'The external ID associated with this user', - example: 'al60043', - nullable: true, - }, - name: { - type: 'string', - description: 'The user name', - example: 'John Dew', - nullable: true, - }, - email: { - type: 'string', - description: 'The user email', - example: 'john@dew.com', - nullable: true, - }, - phone_number: { - type: 'string', - description: 'The user phone number', - example: '+1234567890', - nullable: true, - }, - active: { - description: 'The user active status', - example: true, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - created_at: { - type: 'string', - description: 'The created_at date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The updated_at date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - LocalizationModel: { - type: 'object', - properties: { - title: { - type: 'string', - description: 'The title of the content', - example: 'Software Engineer Lv 1', - nullable: true, - }, - description: { - type: 'string', - description: 'The description of the content', - example: 'This video acts as learning content for software engineers.', - nullable: true, - }, - language: { - description: 'The language associated with the localization details', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/LanguageEnum', - }, - ], - }, - tags: { - description: 'The tags associated with the localization details', - example: ['Sales Techniques', 'Customer Service'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - }, - }, - NotFoundResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 404, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Not Found', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - NotImplementedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 501, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Not Implemented', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - PreconditionFailedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 412, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Precondition failed', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - ProviderError: { - type: 'object', - properties: { - status: { - type: 'number', - description: 'HTTP status code of the provider error', - example: 400, - nullable: true, - }, - url: { - type: 'string', - description: 'URL that caused the error', - example: 'https://api.provider.com/v1/resource', - nullable: true, - }, - raw: { - type: 'object', - description: 'Raw error response from the provider', - example: { - message: 'Invalid input parameters', - }, - nullable: true, - }, - headers: { - type: 'object', - description: 'Response headers', - example: { - 'content-type': 'application/json', - 'x-request-id': '5678c28b211dace4e0a0f9171e6b88c5', - }, - nullable: true, - }, - }, - }, - RawResponse: { - type: 'object', - properties: { - method: { - type: 'string', - }, - url: { - type: 'string', - }, - body: { - oneOf: [ - { - type: 'string', - }, - { - type: 'object', - }, - { - type: 'array', - items: { - type: 'integer', - format: 'int32', - minimum: 0, - maximum: 255, - }, - }, - ], - additionalProperties: true, - nullable: true, - }, - response: { - oneOf: [ - { - type: 'object', - additionalProperties: true, - }, - { - type: 'array', - items: {}, - }, - { - type: 'string', - }, - ], - nullable: true, - }, - }, - required: ['method', 'url'], - }, - RequestTimedOutResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 408, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Request timed out', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - ResultStatusEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: ['Pass', 'Fail', 'unmapped_value', null], - description: 'The StackOne unified result status.', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - description: 'The original result status from the provider before normalization.', - nullable: true, - }, - }, - }, - ScoreModel: { - type: 'object', - properties: { - percentage: { - type: 'number', - description: 'The score percentage', - example: 87.5, - nullable: true, - }, - raw_value: { - type: 'string', - description: 'The raw string score value', - example: 87, - nullable: true, - }, - }, - }, - SkillLevelEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: ['primary', 'secondary', 'tertiary', 'unmapped_value', null], - description: - 'The unified skill level. For write operations: provide one of the listed enum values, or omit/set to "unmapped_value" to use source_value instead.', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - description: - 'For read operations: the original skill level from the provider. For write operations: fallback value used when value is omitted or "unmapped_value". You must ensure this matches the provider\'s format.', - nullable: true, - }, - }, - }, - SkillResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/Skills', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - Skills: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'The ID associated with this skill', - example: '16873-IT345', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'The name associated with this skill', - example: 'Information-Technology', - nullable: true, - }, - active: { - description: 'Whether the skill is active and therefore available for use', - example: true, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - hierarchy: { - description: 'The hierarchal level of the skill', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/SkillLevelEnum', - }, - ], - }, - language: { - description: 'The language associated with this skill', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/LanguageEnum', - }, - ], - }, - level: { - description: 'The hierarchal level of the skill', - deprecated: true, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/SkillLevelEnum', - }, - ], - }, - }, - }, - SkillsPaginated: { - type: 'object', - properties: { - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/Skills', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - TooManyRequestsResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 429, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Too many requests', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - UnauthorizedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 401, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Unauthorized', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - UnifiedError: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 400, - nullable: true, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Request', - nullable: true, - }, - headers: { - type: 'object', - description: 'Response headers', - example: { - 'content-type': 'application/json', - 'x-request-id': '5678c28b211dace4e0a0f9171e6b88c5', - }, - nullable: true, - }, - }, - }, - UnprocessableEntityResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 422, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Unprocessable Entity', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - UpsertResult: { - type: 'object', - properties: { - statusCode: { - type: 'number', - example: 201, - }, - message: { - type: 'string', - example: 'Record created successfully.', - }, - timestamp: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - }, - data: { - $ref: '#/components/schemas/UpsertResultDataExternalReferenceModel', - }, - }, - required: ['statusCode', 'message', 'timestamp', 'data'], - }, - UpsertResultDataExternalReferenceModel: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - external_reference: { - type: 'string', - description: 'The external identifier', - example: 'SOFTWARE-ENG-LV1-TRAINING-VIDEO-1', - nullable: true, - }, - }, - }, - UserResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/LmsUser', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - UsersPaginated: { - type: 'object', - properties: { - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/LmsUser', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - WriteContentTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'video', - 'quiz', - 'document', - 'audio', - 'article', - 'book', - 'event', - 'course', - 'collection', - 'interactive', - 'unmapped_value', - null, - ], - description: - 'The content type for write operations. Provide one of the listed enum values. If omitted or set to "unmapped_value", the source_value will be sent to the provider instead.', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - description: - 'The provider-specific value to use when value is omitted or set to "unmapped_value". You are responsible for ensuring this matches the provider\'s expected format.', - nullable: true, - }, - }, - }, - }, - }, -}; diff --git a/src/openapi/generated/marketing.ts b/src/openapi/generated/marketing.ts deleted file mode 100644 index 883bd52c..00000000 --- a/src/openapi/generated/marketing.ts +++ /dev/null @@ -1,7697 +0,0 @@ -// Generated OpenAPI specification for marketing -// DO NOT EDIT THIS FILE DIRECTLY -export const marketingSpec = { - openapi: '3.1.0', - paths: { - '/unified/marketing/templates/email': { - get: { - operationId: 'marketing_list_email_templates', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of email templates was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/EmailTemplatesPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Email Templates', - tags: ['Templates', 'Email'], - 'x-speakeasy-group': 'marketing', - 'x-speakeasy-name-override': 'list_email_templates', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - post: { - operationId: 'marketing_create_email_template', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/MarketingCreateEmailTemplateRequestDto', - }, - }, - }, - }, - responses: { - '201': { - description: 'Record created successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Create Email Templates', - tags: ['Templates', 'Email'], - 'x-speakeasy-group': 'marketing', - 'x-speakeasy-name-override': 'create_email_template', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/marketing/templates/email/{id}': { - get: { - operationId: 'marketing_get_email_template', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The email template with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/EmailTemplateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Email Templates', - tags: ['Templates', 'Email'], - 'x-speakeasy-group': 'marketing', - 'x-speakeasy-name-override': 'get_email_template', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - patch: { - operationId: 'marketing_update_email_template', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/MarketingCreateEmailTemplateRequestDto', - }, - }, - }, - }, - responses: { - '200': { - description: 'Record updated successfully', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Update Email Templates', - tags: ['Templates', 'Email'], - 'x-speakeasy-group': 'marketing', - 'x-speakeasy-name-override': 'update_email_template', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/marketing/templates/in_app': { - get: { - operationId: 'marketing_list_in_app_templates', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of in-app templates was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InAppTemplatesPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List In-App Templates', - tags: ['Templates', 'In App'], - 'x-speakeasy-group': 'marketing', - 'x-speakeasy-name-override': 'list_in_app_templates', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - post: { - operationId: 'marketing_create_in_app_template', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/MarketingCreateInAppTemplateRequestDto', - }, - }, - }, - }, - responses: { - '201': { - description: 'Record created successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Create In-App Template', - tags: ['Templates', 'In App'], - 'x-speakeasy-group': 'marketing', - 'x-speakeasy-name-override': 'create_in_app_template', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/marketing/templates/in_app/{id}': { - get: { - operationId: 'marketing_get_in_app_template', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The in-app template with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InAppTemplateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get In-App Template', - tags: ['Templates', 'In App'], - 'x-speakeasy-group': 'marketing', - 'x-speakeasy-name-override': 'get_in_app_template', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - patch: { - operationId: 'marketing_update_in_app_template', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/MarketingCreateInAppTemplateRequestDto', - }, - }, - }, - }, - responses: { - '200': { - description: 'Record updated successfully', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Update In-App Template', - tags: ['Templates', 'In App'], - 'x-speakeasy-group': 'marketing', - 'x-speakeasy-name-override': 'update_in_app_template', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/marketing/templates/sms': { - get: { - operationId: 'marketing_list_sms_templates', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of SMS templates was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/SmsTemplatesPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List SMS Templates', - tags: ['Templates', 'SMS'], - 'x-speakeasy-group': 'marketing', - 'x-speakeasy-name-override': 'list_sms_templates', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - post: { - operationId: 'marketing_create_sms_template', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/MarketingCreateSmsTemplateRequestDto', - }, - }, - }, - }, - responses: { - '201': { - description: 'Record created successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Create SMS Template', - tags: ['Templates', 'SMS'], - 'x-speakeasy-group': 'marketing', - 'x-speakeasy-name-override': 'create_sms_template', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/marketing/templates/sms/{id}': { - get: { - operationId: 'marketing_get_sms_template', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The SMS template with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/SmsTemplateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get SMS Template', - tags: ['Templates', 'SMS'], - 'x-speakeasy-group': 'marketing', - 'x-speakeasy-name-override': 'get_sms_template', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - patch: { - operationId: 'marketing_update_sms_template', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/MarketingCreateSmsTemplateRequestDto', - }, - }, - }, - }, - responses: { - '200': { - description: 'Record updated successfully', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Update SMS Template', - tags: ['Templates', 'SMS'], - 'x-speakeasy-group': 'marketing', - 'x-speakeasy-name-override': 'update_sms_template', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/marketing/templates/omni_channel': { - get: { - deprecated: true, - operationId: 'marketing_list_omni_channel_templates', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of omni-channel templates was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TemplatesPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Omni-Channel Templates', - tags: ['Templates', 'Omni-Channel'], - 'x-speakeasy-group': 'marketing', - 'x-speakeasy-name-override': 'list_omni_channel_templates', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - post: { - deprecated: true, - operationId: 'marketing_create_omni_channel_template', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/MarketingCreateTemplateRequestDto', - }, - }, - }, - }, - responses: { - '201': { - description: 'Record created successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Create Omni-Channel Template', - tags: ['Templates', 'Omni-Channel'], - 'x-speakeasy-group': 'marketing', - 'x-speakeasy-name-override': 'create_omni_channel_template', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/marketing/templates/omni_channel/{id}': { - get: { - deprecated: true, - operationId: 'marketing_get_omni_channel_template', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The omni-channel template with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TemplateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Omni-Channel Template', - tags: ['Templates', 'Omni-Channel'], - 'x-speakeasy-group': 'marketing', - 'x-speakeasy-name-override': 'get_omni_channel_template', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - patch: { - deprecated: true, - operationId: 'marketing_update_omni_channel_template', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/MarketingCreateTemplateRequestDto', - }, - }, - }, - }, - responses: { - '200': { - description: 'Record updated successfully', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Update Omni-Channel Template', - tags: ['Templates', 'Omni-Channel'], - 'x-speakeasy-group': 'marketing', - 'x-speakeasy-name-override': 'update_omni_channel_template', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/marketing/templates/push': { - get: { - operationId: 'marketing_list_push_templates', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of push templates was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PushTemplatesPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Push Templates', - tags: ['Templates', 'Push'], - 'x-speakeasy-group': 'marketing', - 'x-speakeasy-name-override': 'list_push_templates', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - post: { - operationId: 'marketing_create_push_template', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/MarketingCreatePushTemplateRequestDto', - }, - }, - }, - }, - responses: { - '201': { - description: 'Record created successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Create Push Template', - tags: ['Templates', 'Push'], - 'x-speakeasy-group': 'marketing', - 'x-speakeasy-name-override': 'create_push_template', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/marketing/templates/push/{id}': { - get: { - operationId: 'marketing_get_push_template', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,messages,created_at,updated_at,tags,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The push template with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PushTemplateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Push Template', - tags: ['Templates', 'Push'], - 'x-speakeasy-group': 'marketing', - 'x-speakeasy-name-override': 'get_push_template', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - patch: { - operationId: 'marketing_update_push_template', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/MarketingCreatePushTemplateRequestDto', - }, - }, - }, - }, - responses: { - '200': { - description: 'Record updated successfully', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Update Push Template', - tags: ['Templates', 'Push'], - 'x-speakeasy-group': 'marketing', - 'x-speakeasy-name-override': 'update_push_template', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/marketing/campaigns': { - get: { - operationId: 'marketing_list_campaigns', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,created_at,updated_at,description,schedule_type,status,channels,first_sent_at,last_sent_at,tags,messages,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of campaigns was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CampaignsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List campaigns', - tags: ['Campaigns'], - 'x-speakeasy-group': 'marketing', - 'x-speakeasy-name-override': 'list_campaigns', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/marketing/campaigns/{id}': { - get: { - operationId: 'marketing_get_campaign', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,created_at,updated_at,description,schedule_type,status,channels,first_sent_at,last_sent_at,tags,messages,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The campaign with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CampaignResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get campaign', - tags: ['Campaigns'], - 'x-speakeasy-group': 'marketing', - 'x-speakeasy-name-override': 'get_campaign', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/marketing/content_blocks': { - get: { - operationId: 'marketing_list_content_blocks', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,type,content,status,tags,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of Content Blocks was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ContentBlocksPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Content Blocks', - tags: ['Content Blocks'], - 'x-speakeasy-group': 'marketing', - 'x-speakeasy-name-override': 'list_content_blocks', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - post: { - operationId: 'marketing_create_content_block', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/MarketingCreateContentBlocksRequestDto', - }, - }, - }, - }, - responses: { - '201': { - description: 'Record created successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Create Content Block', - tags: ['Content Blocks'], - 'x-speakeasy-group': 'marketing', - 'x-speakeasy-name-override': 'create_content_block', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/marketing/content_blocks/{id}': { - get: { - operationId: 'marketing_get_content_block', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,name,type,content,status,tags,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The Content Block with the given identifier was retrieved', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ContentBlockResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Content Blocks', - tags: ['Content Blocks'], - 'x-speakeasy-group': 'marketing', - 'x-speakeasy-name-override': 'get_content_block', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - patch: { - operationId: 'marketing_update_content_block', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/MarketingCreateContentBlocksRequestDto', - }, - }, - }, - }, - responses: { - '200': { - description: 'Record updated successfully', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Update Content Block', - tags: ['Content Blocks'], - 'x-speakeasy-group': 'marketing', - 'x-speakeasy-name-override': 'update_content_block', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - }, - info: { - title: 'Marketing', - description: 'The documentation for the StackOne Unified API - MARKETING', - version: '1.0.0', - contact: {}, - }, - tags: [ - { - name: 'Campaigns', - description: 'Marketing campaigns and initiatives.', - }, - { - name: 'Content Blocks', - description: 'Reusable content blocks for marketing.', - }, - { - name: 'Email', - description: 'Email marketing messages.', - }, - { - name: 'In App', - description: 'In-app marketing messages.', - }, - { - name: 'Omni-Channel', - description: 'Omni-channel marketing communications.', - }, - { - name: 'Push', - description: 'Push notifications for marketing.', - }, - { - name: 'SMS', - description: 'SMS marketing messages.', - }, - { - name: 'Templates', - description: 'Templates for marketing content or campaigns.', - }, - ], - servers: [ - { - url: 'https://api.stackone.com', - }, - ], - components: { - securitySchemes: { - basic: { - type: 'http', - scheme: 'basic', - }, - }, - schemas: { - BadGatewayResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 502, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Gateway', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - BadRequestResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 400, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Request', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - data: { - description: 'Error details', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/UnifiedError', - }, - ], - }, - provider_errors: { - description: 'List of provider-specific errors', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/ProviderError', - }, - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - Campaign: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - nullable: true, - }, - created_at: { - type: 'string', - description: 'The created_at date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The updated_at date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - description: { - type: 'string', - nullable: true, - }, - schedule_type: { - description: 'The schedule type', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ScheduleTypeEnum', - }, - ], - }, - status: { - description: 'Status of the Campaign', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/StatusEnum', - }, - ], - }, - archived: { - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - draft: { - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - channels: { - description: 'channels of the Campaign', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/ChannelsEnum', - }, - }, - first_sent_at: { - type: 'string', - description: 'The first_sent_at date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - last_sent_at: { - type: 'string', - description: 'The last_sent_at date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - tags: { - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - messages: { - example: [ - { - id: 'message-id-1', - name: 'SMS Message', - message_type: { - value: 'sms', - sourceValue: 'sms-message', - }, - message_content: { - body: 'This is an example SMS body.', - from: '1-555-123-4567', - }, - }, - { - id: 'message-id-2', - name: 'Email Message', - message_type: { - value: 'email', - sourceValue: 'email-message', - }, - message_content: { - subject: 'Example Email Subject', - body: '

This is an example

\n

email body

', - from: 'Jane Smith', - 'reply-to': 'reply@example.com', - preheader: 'This is the preheader of the email.', - }, - }, - { - id: 'message-id-3', - name: 'iOS Push Message', - message_type: { - value: 'ios_push', - sourceValue: 'ios-push', - }, - message_content: { - body: 'This is an example push notification body.', - }, - }, - ], - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/Message', - }, - }, - }, - }, - CampaignResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/Campaign', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - CampaignsPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/Campaign', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - ChannelsEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'email', - 'sms', - 'web_push', - 'ios_push', - 'android_push', - 'unknown', - 'unmapped_value', - null, - ], - description: 'The Channels of the campaign.', - example: 'sms', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the Channels.', - example: 'SMS', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - ConflictResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 409, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Conflict', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - ContentBlock: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - nullable: true, - }, - tags: { - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - content: { - type: 'string', - nullable: true, - }, - type: { - description: 'Stackone enum identifying the type of content block.', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ContentBlockTypeEnumApiModel', - }, - ], - }, - status: { - description: 'Stackone enum identifying the status of content block.', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ContentBlockStatusEnumApiModel', - }, - ], - }, - created_at: { - type: 'string', - description: 'Date of creation', - example: '2021-01-01T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'Date of last update', - example: '2021-01-01T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - ContentBlockResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/ContentBlock', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - ContentBlocksPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/ContentBlock', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - ContentBlockStatusEnumApiModel: { - type: 'object', - properties: { - value: { - type: 'string', - enum: ['draft', 'live', 'archived', 'unmapped_value', null], - description: 'The Status of the content blocks.', - example: 'live', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the status.', - example: 'active', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - ContentBlockTypeEnumApiModel: { - type: 'object', - properties: { - value: { - type: 'string', - enum: ['text', 'html', 'image', 'code-snippet', 'unmapped_value', null], - description: 'The type of the content blocks.', - example: 'html', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the type.', - example: 'text', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - CreateMessage: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - nullable: true, - }, - message_type: { - description: - 'Stackone enum identifying the type of message associated with the content.', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/MessageTypeEnum', - }, - ], - }, - message_content: { - oneOf: [ - { - $ref: '#/components/schemas/SmsMessageContents', - }, - { - $ref: '#/components/schemas/EmailMessageContents', - }, - { - $ref: '#/components/schemas/PushMessageContents', - }, - ], - nullable: true, - }, - }, - }, - CreateResult: { - type: 'object', - properties: { - statusCode: { - type: 'number', - example: 201, - }, - message: { - type: 'string', - example: 'Record created successfully.', - }, - timestamp: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - }, - data: { - $ref: '#/components/schemas/CreateResultDataApiModel', - }, - }, - required: ['statusCode', 'message', 'timestamp', 'data'], - }, - CreateResultDataApiModel: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - }, - }, - EmailMessageContents: { - type: 'object', - properties: { - subject: { - type: 'string', - nullable: true, - }, - body: { - type: 'string', - nullable: true, - }, - from: { - type: 'string', - nullable: true, - }, - 'reply-to': { - type: 'string', - nullable: true, - }, - preheader: { - type: 'string', - nullable: true, - }, - }, - }, - EmailMessages: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - nullable: true, - }, - message_type: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/MessageTypeEnum', - }, - ], - }, - message_content: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/EmailMessageContents', - }, - ], - }, - }, - }, - EmailTemplate: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - nullable: true, - }, - tags: { - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - created_at: { - type: 'string', - description: 'Date of creation', - example: '2021-01-01T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'Date of last update', - example: '2021-01-01T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - messages: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/EmailMessages', - }, - }, - }, - }, - EmailTemplateResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/EmailTemplate', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - EmailTemplatesPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/EmailTemplate', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - ForbiddenResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 403, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Forbidden resource', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - InAppMessageContents: { - type: 'object', - properties: { - body: { - type: 'string', - nullable: true, - }, - }, - }, - InAppMessages: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - nullable: true, - }, - message_type: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/MessageTypeEnum', - }, - ], - }, - message_content: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/InAppMessageContents', - }, - ], - }, - }, - }, - InAppTemplate: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - nullable: true, - }, - tags: { - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - created_at: { - type: 'string', - description: 'Date of creation', - example: '2021-01-01T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'Date of last update', - example: '2021-01-01T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - messages: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/InAppMessages', - }, - }, - }, - }, - InAppTemplateResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/InAppTemplate', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - InAppTemplatesPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/InAppTemplate', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - InternalServerErrorResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 500, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Internal server error', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - MarketingCreateContentBlocksRequestDto: { - type: 'object', - properties: { - name: { - type: 'string', - nullable: true, - }, - tags: { - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - content: { - type: 'string', - nullable: true, - }, - type: { - description: 'Stackone enum identifying the type of content block.', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ContentBlockTypeEnumApiModel', - }, - ], - }, - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - }, - }, - MarketingCreateEmailTemplateRequestDto: { - type: 'object', - properties: { - name: { - type: 'string', - nullable: true, - }, - tags: { - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - messages: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/EmailMessages', - }, - }, - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - }, - }, - MarketingCreateInAppTemplateRequestDto: { - type: 'object', - properties: { - name: { - type: 'string', - nullable: true, - }, - tags: { - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - messages: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/InAppMessages', - }, - }, - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - }, - }, - MarketingCreatePushTemplateRequestDto: { - type: 'object', - properties: { - name: { - type: 'string', - nullable: true, - }, - tags: { - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - messages: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/PushMessages', - }, - }, - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - }, - }, - MarketingCreateSmsTemplateRequestDto: { - type: 'object', - properties: { - name: { - type: 'string', - nullable: true, - }, - tags: { - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - messages: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/SmsMessages', - }, - }, - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - }, - }, - MarketingCreateTemplateRequestDto: { - type: 'object', - properties: { - messages: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CreateMessage', - }, - }, - name: { - type: 'string', - nullable: true, - }, - tags: { - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - }, - }, - Message: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - nullable: true, - }, - message_type: { - description: - 'Stackone enum identifying the type of message associated with the content.', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/MessageTypeEnum', - }, - ], - }, - message_content: { - oneOf: [ - { - $ref: '#/components/schemas/SmsMessageContents', - }, - { - $ref: '#/components/schemas/EmailMessageContents', - }, - { - $ref: '#/components/schemas/PushMessageContents', - }, - ], - nullable: true, - }, - }, - }, - MessageTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'email', - 'sms', - 'push', - 'web_push', - 'ios_push', - 'android_push', - 'app_push', - 'omni_channel', - 'content_block', - 'in_app', - 'unknown', - 'unmapped_value', - null, - ], - description: 'The unified message type.', - example: 'email', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - description: - 'The original value from the provider used to derive the unified message type.', - example: 'Email', - nullable: true, - }, - }, - }, - NotFoundResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 404, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Not Found', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - NotImplementedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 501, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Not Implemented', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - PreconditionFailedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 412, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Precondition failed', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - ProviderError: { - type: 'object', - properties: { - status: { - type: 'number', - description: 'HTTP status code of the provider error', - example: 400, - nullable: true, - }, - url: { - type: 'string', - description: 'URL that caused the error', - example: 'https://api.provider.com/v1/resource', - nullable: true, - }, - raw: { - type: 'object', - description: 'Raw error response from the provider', - example: { - message: 'Invalid input parameters', - }, - nullable: true, - }, - headers: { - type: 'object', - description: 'Response headers', - example: { - 'content-type': 'application/json', - 'x-request-id': '5678c28b211dace4e0a0f9171e6b88c5', - }, - nullable: true, - }, - }, - }, - PushMessageContents: { - type: 'object', - properties: { - title: { - type: 'string', - nullable: true, - }, - subtitle: { - type: 'string', - nullable: true, - }, - body: { - type: 'string', - nullable: true, - }, - }, - }, - PushMessages: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - nullable: true, - }, - message_type: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/MessageTypeEnum', - }, - ], - }, - message_content: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/PushMessageContents', - }, - ], - }, - }, - }, - PushTemplate: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - nullable: true, - }, - tags: { - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - created_at: { - type: 'string', - description: 'Date of creation', - example: '2021-01-01T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'Date of last update', - example: '2021-01-01T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - messages: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/PushMessages', - }, - }, - }, - }, - PushTemplateResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/PushTemplate', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - PushTemplatesPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/PushTemplate', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - RawResponse: { - type: 'object', - properties: { - method: { - type: 'string', - }, - url: { - type: 'string', - }, - body: { - oneOf: [ - { - type: 'string', - }, - { - type: 'object', - }, - { - type: 'array', - items: { - type: 'integer', - format: 'int32', - minimum: 0, - maximum: 255, - }, - }, - ], - additionalProperties: true, - nullable: true, - }, - response: { - oneOf: [ - { - type: 'object', - additionalProperties: true, - }, - { - type: 'array', - items: {}, - }, - { - type: 'string', - }, - ], - nullable: true, - }, - }, - required: ['method', 'url'], - }, - RequestTimedOutResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 408, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Request timed out', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - ScheduleTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: [ - 'immediate', - 'scheduled', - 'recurring', - 'custom', - 'triggered', - 'unmapped_value', - null, - ], - description: 'The schedule type of the campaign.', - example: 'immediate', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the schedule type.', - example: 'Immediate', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - SmsMessageContents: { - type: 'object', - properties: { - body: { - type: 'string', - nullable: true, - }, - from: { - type: 'string', - nullable: true, - }, - }, - }, - SmsMessages: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - nullable: true, - }, - message_type: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/MessageTypeEnum', - }, - ], - }, - message_content: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/SmsMessageContents', - }, - ], - }, - }, - }, - SmsTemplate: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - nullable: true, - }, - tags: { - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - created_at: { - type: 'string', - description: 'Date of creation', - example: '2021-01-01T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'Date of last update', - example: '2021-01-01T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - messages: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/SmsMessages', - }, - }, - }, - }, - SmsTemplateResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/SmsTemplate', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - SmsTemplatesPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/SmsTemplate', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - StatusEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: ['draft', 'archived', 'live', 'unmapped_value', null], - description: 'The Status of the campaign.', - example: 'email', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the Status.', - example: 'Email', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - Template: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - nullable: true, - }, - tags: { - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - created_at: { - type: 'string', - description: 'Date of creation', - example: '2021-01-01T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'Date of last update', - example: '2021-01-01T00:00:00.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - TemplateResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/Template', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - TemplatesPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/Template', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - TooManyRequestsResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 429, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Too many requests', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - UnauthorizedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 401, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Unauthorized', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - UnifiedError: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 400, - nullable: true, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Request', - nullable: true, - }, - headers: { - type: 'object', - description: 'Response headers', - example: { - 'content-type': 'application/json', - 'x-request-id': '5678c28b211dace4e0a0f9171e6b88c5', - }, - nullable: true, - }, - }, - }, - UnprocessableEntityResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 422, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Unprocessable Entity', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - }, - }, -}; diff --git a/src/openapi/generated/messaging.ts b/src/openapi/generated/messaging.ts deleted file mode 100644 index e57f1cbb..00000000 --- a/src/openapi/generated/messaging.ts +++ /dev/null @@ -1,3704 +0,0 @@ -// Generated OpenAPI specification for messaging -// DO NOT EDIT THIS FILE DIRECTLY -export const messagingSpec = { - openapi: '3.1.0', - paths: { - '/unified/messaging/conversations': { - get: { - operationId: 'messaging_list_conversations', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,participants,name,private,created_at,last_message_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of conversations was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/MessagingConversationsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Conversations', - tags: ['Conversations'], - 'x-speakeasy-group': 'messaging', - 'x-speakeasy-name-override': 'list_conversations', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - post: { - operationId: 'messaging_create_conversation', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/MessagingCreateConversationRequestDto', - }, - }, - }, - }, - responses: { - '201': { - description: 'The conversation was created successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Create Conversation', - tags: ['Conversations'], - 'x-speakeasy-group': 'messaging', - 'x-speakeasy-name-override': 'create_conversation', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/messaging/conversations/{id}': { - get: { - operationId: 'messaging_get_conversation', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,participants,name,private,created_at,last_message_at,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The conversation with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/MessagingConversationResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Conversation', - tags: ['Conversations'], - 'x-speakeasy-group': 'messaging', - 'x-speakeasy-name-override': 'get_conversation', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/messaging/messages/{id}/attachments/{subResourceId}/download': { - get: { - operationId: 'messaging_download_messaging_attachment', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'format', - required: false, - in: 'query', - description: 'The format to download the file in', - schema: { - nullable: true, - example: 'base64', - type: 'string', - }, - }, - { - name: 'export_format', - required: false, - in: 'query', - description: 'The export format of the file', - schema: { - nullable: true, - example: 'text/plain', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The attachment file was downloaded successfully.', - content: { - '*/*': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Download Attachment', - tags: ['Messages', 'Attachments'], - 'x-speakeasy-group': 'messaging', - 'x-speakeasy-name-override': 'download_messaging_attachment', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/messaging/messages/{id}/attachments': { - get: { - operationId: 'messaging_list_attachments', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,file_name,file_size,file_type,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of attachments was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/MessagingAttachmentsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Attachments', - tags: ['Messages', 'Attachments'], - 'x-speakeasy-group': 'messaging', - 'x-speakeasy-name-override': 'list_attachments', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/messaging/messages/{id}/attachments/{subResourceId}': { - get: { - operationId: 'messaging_get_attachment', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,file_name,file_size,file_type,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The attachment with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/MessagingAttachmentResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Attachment', - tags: ['Messages', 'Attachments'], - 'x-speakeasy-group': 'messaging', - 'x-speakeasy-name-override': 'get_attachment', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/messaging/users': { - get: { - operationId: 'messaging_list_users', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,email,username,name,first_name,last_name,bot,active,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of users was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/MessagingUsersPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Users', - tags: ['Users'], - 'x-speakeasy-group': 'messaging', - 'x-speakeasy-name-override': 'list_users', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/messaging/users/{id}': { - get: { - operationId: 'messaging_get_user', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,email,username,name,first_name,last_name,bot,active,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The user with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/MessagingUserResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get User', - tags: ['Users'], - 'x-speakeasy-group': 'messaging', - 'x-speakeasy-name-override': 'get_user', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/messaging/conversations/{id}/messages': { - get: { - operationId: 'messaging_list_conversation_messages', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,content,parent_message_id,remote_parent_message_id,attachments,author,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of messages in the conversation was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/MessagingMessagesPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Conversation Messages', - tags: ['Conversations', 'Messages'], - 'x-speakeasy-group': 'messaging', - 'x-speakeasy-name-override': 'list_conversation_messages', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/messaging/messages/{id}': { - get: { - operationId: 'messaging_get_message', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,content,parent_message_id,remote_parent_message_id,attachments,author,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - explode: true, - style: 'deepObject', - schema: { - type: 'object', - }, - }, - ], - responses: { - '200': { - description: 'The message was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/MessagingMessageResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Message', - tags: ['Messages'], - 'x-speakeasy-group': 'messaging', - 'x-speakeasy-name-override': 'get_message', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/messaging/messages': { - post: { - operationId: 'messaging_send_message', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/MessagingMessageSendRequestDto', - }, - }, - }, - }, - responses: { - '201': { - description: 'The message was sent successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Send Message', - tags: ['Messages'], - 'x-speakeasy-group': 'messaging', - 'x-speakeasy-name-override': 'send_message', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - }, - info: { - title: 'Messaging', - description: 'The documentation for the StackOne Unified API - MESSAGING', - version: '1.0.0', - contact: {}, - }, - tags: [ - { - name: 'Conversations', - description: 'Spaces for exchanging messages between users.', - }, - { - name: 'Messages', - description: 'Messages exchanged in conversations.', - }, - { - name: 'Attachments', - description: 'Files attached to messages.', - }, - { - name: 'Users', - description: 'Accounts that can participate in conversations.', - }, - ], - servers: [ - { - url: 'https://api.stackone.com', - }, - ], - components: { - securitySchemes: { - basic: { - type: 'http', - scheme: 'basic', - }, - }, - schemas: { - BadGatewayResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 502, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Gateway', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - BadRequestResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 400, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Request', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - data: { - description: 'Error details', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/UnifiedError', - }, - ], - }, - provider_errors: { - description: 'List of provider-specific errors', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/ProviderError', - }, - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - ConflictResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 409, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Conflict', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - CreateResult: { - type: 'object', - properties: { - statusCode: { - type: 'number', - example: 201, - }, - message: { - type: 'string', - example: 'Record created successfully.', - }, - timestamp: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - }, - data: { - $ref: '#/components/schemas/CreateResultDataApiModel', - }, - }, - required: ['statusCode', 'message', 'timestamp', 'data'], - }, - CreateResultDataApiModel: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - }, - }, - DownloadApiModel: { - type: 'object', - properties: { - headers: { - description: 'Headers related to the download', - allOf: [ - { - $ref: '#/components/schemas/DownloadHeadersApiModel', - }, - ], - }, - data: { - type: 'string', - description: 'The file data in binary format', - format: 'binary', - }, - }, - required: ['headers', 'data'], - }, - DownloadHeadersApiModel: { - type: 'object', - properties: { - 'content-disposition': { - type: 'string', - description: 'Value of the Content-Disposition header', - example: 'attachment; filename="example.pdf"', - nullable: true, - }, - 'content-type': { - type: 'string', - description: 'MIME type of the file', - example: 'application/pdf', - nullable: true, - }, - 'content-length': { - type: 'number', - description: 'Size of the content in bytes', - example: 1024, - nullable: true, - }, - 'content-range': { - type: 'string', - description: 'Range of the content being sent', - example: 'bytes 0-1023/2048', - nullable: true, - }, - 'content-encoding': { - type: 'string', - description: 'Encoding of the content', - example: 'gzip', - nullable: true, - }, - 'transfer-encoding': { - type: 'string', - description: 'Transfer encoding type', - example: 'chunked', - nullable: true, - }, - }, - }, - ForbiddenResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 403, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Forbidden resource', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - InternalServerErrorResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 500, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Internal server error', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - LmsUser: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - external_reference: { - type: 'string', - description: 'The external ID associated with this user', - example: 'al60043', - nullable: true, - }, - name: { - type: 'string', - description: 'The user name', - example: 'John Dew', - nullable: true, - }, - email: { - type: 'string', - description: 'The user email', - example: 'john@dew.com', - nullable: true, - }, - phone_number: { - type: 'string', - description: 'The user phone number', - example: '+1234567890', - nullable: true, - }, - active: { - description: 'The user active status', - example: true, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - created_at: { - type: 'string', - description: 'The created_at date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The updated_at date', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - MessagingAttachment: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - file_name: { - type: 'string', - description: 'Name of the attached file', - example: 'document.pdf', - nullable: true, - }, - file_size: { - type: 'number', - description: 'Size of the attached file', - example: 1024, - nullable: true, - }, - file_type: { - type: 'string', - description: 'MIME type of the attached file', - example: 'application/pdf', - nullable: true, - }, - }, - }, - MessagingAttachmentResult: { - type: 'object', - properties: { - data: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/MessagingAttachment', - }, - ], - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - }, - MessagingAttachmentsPaginated: { - type: 'object', - properties: { - next: { - type: 'string', - nullable: true, - }, - data: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/MessagingAttachment', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - }, - MessagingConversation: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - participants: { - description: 'List of participant user IDs in the conversation', - example: ['c28xIQ1', 'c28xIQ2'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - name: { - type: 'string', - description: 'Name or title of the conversation', - example: 'Project Discussion', - nullable: true, - }, - private: { - description: 'Whether the conversation is private', - example: true, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - created_at: { - type: 'string', - description: 'Timestamp when the conversation was created', - example: '2024-03-20T10:00:00Z', - format: 'date-time', - nullable: true, - }, - last_message_at: { - type: 'string', - description: 'Timestamp of the last message in the conversation', - example: '2024-03-20T11:30:00Z', - format: 'date-time', - nullable: true, - }, - }, - }, - MessagingConversationResult: { - type: 'object', - properties: { - data: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/MessagingConversation', - }, - ], - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - }, - MessagingConversationsPaginated: { - type: 'object', - properties: { - next: { - type: 'string', - nullable: true, - }, - data: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/MessagingConversation', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - }, - MessagingCreateConversationRequestDto: { - type: 'object', - properties: { - participants: { - description: 'List of participant user IDs in the conversation', - example: ['c28xIQ1', 'c28xIQ2'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - name: { - type: 'string', - description: 'Name or title of the conversation', - example: 'Project Discussion', - nullable: true, - }, - private: { - description: 'Whether the conversation is private', - example: true, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - }, - }, - MessagingMessage: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - content: { - description: 'Content of the message', - example: { - html: '

Hello world

', - plain: 'Hello world', - }, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/MessagingMessageContent', - }, - ], - }, - parent_message_id: { - type: 'string', - description: 'ID of the parent message if this is a reply', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - attachments: { - description: 'List of attachments in the message', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/MessagingAttachment', - }, - }, - author: { - description: 'Author of the message', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/LmsUser', - }, - ], - }, - created_at: { - type: 'string', - description: 'Timestamp when the message was created', - example: '2024-03-20T10:00:00Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'Timestamp when the message was last updated', - example: '2024-03-20T10:00:00Z', - format: 'date-time', - nullable: true, - }, - }, - }, - MessagingMessageContent: { - type: 'object', - properties: { - html: { - type: 'string', - description: 'HTML content of the message', - example: '

Hello world

', - nullable: true, - }, - plain: { - type: 'string', - description: 'Plain text content of the message', - example: 'Hello world', - nullable: true, - }, - }, - }, - MessagingMessageResult: { - type: 'object', - properties: { - data: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/MessagingMessage', - }, - ], - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - }, - MessagingMessageSendRequestDto: { - type: 'object', - properties: { - content: { - type: 'string', - description: 'Content body of the message', - example: 'Hello, world!', - nullable: true, - }, - recipient: { - type: 'string', - description: 'Can be a conversation ID, user ID, email or phone number.', - example: 'c28xyrc55866bvuv', - nullable: true, - }, - sender: { - type: 'string', - description: 'The account_id or phone number of the message sender', - example: '+34820398402', - nullable: true, - }, - }, - }, - MessagingMessagesPaginated: { - type: 'object', - properties: { - next: { - type: 'string', - nullable: true, - }, - data: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/MessagingMessage', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - }, - MessagingUser: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - email: { - type: 'string', - description: 'Email address of the user', - example: 'john.doe@example.com', - nullable: true, - }, - username: { - type: 'string', - description: 'Username of the user', - example: 'johndoe', - nullable: true, - }, - name: { - type: 'string', - description: 'Full name of the user', - example: 'John Doe', - nullable: true, - }, - first_name: { - type: 'string', - description: 'First name of the user', - example: 'John', - nullable: true, - }, - last_name: { - type: 'string', - description: 'Last name of the user', - example: 'Doe', - nullable: true, - }, - bot: { - description: 'Whether the user is a bot', - example: false, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - active: { - description: 'Whether the user is active', - example: true, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - }, - }, - MessagingUserResult: { - type: 'object', - properties: { - data: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/MessagingUser', - }, - ], - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - }, - MessagingUsersPaginated: { - type: 'object', - properties: { - next: { - type: 'string', - nullable: true, - }, - data: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/MessagingUser', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - }, - NotFoundResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 404, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Not Found', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - NotImplementedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 501, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Not Implemented', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - PreconditionFailedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 412, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Precondition failed', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - ProviderError: { - type: 'object', - properties: { - status: { - type: 'number', - description: 'HTTP status code of the provider error', - example: 400, - nullable: true, - }, - url: { - type: 'string', - description: 'URL that caused the error', - example: 'https://api.provider.com/v1/resource', - nullable: true, - }, - raw: { - type: 'object', - description: 'Raw error response from the provider', - example: { - message: 'Invalid input parameters', - }, - nullable: true, - }, - headers: { - type: 'object', - description: 'Response headers', - example: { - 'content-type': 'application/json', - 'x-request-id': '5678c28b211dace4e0a0f9171e6b88c5', - }, - nullable: true, - }, - }, - }, - RawResponse: { - type: 'object', - properties: { - method: { - type: 'string', - }, - url: { - type: 'string', - }, - body: { - oneOf: [ - { - type: 'string', - }, - { - type: 'object', - }, - { - type: 'array', - items: { - type: 'integer', - format: 'int32', - minimum: 0, - maximum: 255, - }, - }, - ], - additionalProperties: true, - nullable: true, - }, - response: { - oneOf: [ - { - type: 'object', - additionalProperties: true, - }, - { - type: 'array', - items: {}, - }, - { - type: 'string', - }, - ], - nullable: true, - }, - }, - required: ['method', 'url'], - }, - RequestTimedOutResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 408, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Request timed out', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - TooManyRequestsResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 429, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Too many requests', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - UnauthorizedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 401, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Unauthorized', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - UnifiedError: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 400, - nullable: true, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Request', - nullable: true, - }, - headers: { - type: 'object', - description: 'Response headers', - example: { - 'content-type': 'application/json', - 'x-request-id': '5678c28b211dace4e0a0f9171e6b88c5', - }, - nullable: true, - }, - }, - }, - UnprocessableEntityResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 422, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Unprocessable Entity', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - }, - }, -}; diff --git a/src/openapi/generated/screening.ts b/src/openapi/generated/screening.ts deleted file mode 100644 index 77f1f0b7..00000000 --- a/src/openapi/generated/screening.ts +++ /dev/null @@ -1,1615 +0,0 @@ -// Generated OpenAPI specification for screening -// DO NOT EDIT THIS FILE DIRECTLY -export const screeningSpec = { - openapi: '3.1.0', - paths: { - '/unified/screening/packages': { - get: { - operationId: 'screening_list_screening_packages', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,description,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of screening packages was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ScreeningPackagesPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Screening Packages', - tags: ['Packages'], - 'x-speakeasy-group': 'screening', - 'x-speakeasy-name-override': 'list_screening_packages', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/screening/packages/{id}': { - get: { - operationId: 'screening_get_screening_package', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,description,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The screening package with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ScreeningPackageResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Screening Package', - tags: ['Packages'], - 'x-speakeasy-group': 'screening', - 'x-speakeasy-name-override': 'get_screening_package', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/screening/results/webhook': { - post: { - operationId: 'screening_webhook_screening_result', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ScreeningResultWebhook', - }, - }, - }, - }, - responses: { - '200': { - description: 'The screening result webhook was processed.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ScreeningResultWebhook', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Webhook Screening Result', - tags: ['Results'], - 'x-speakeasy-group': 'screening', - 'x-speakeasy-name-override': 'webhook_screening_result', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/screening/orders': { - post: { - operationId: 'screening_create_screening_order', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ScreeningCreateOrderRequestDto', - }, - }, - }, - }, - responses: { - '201': { - description: 'The screening order was created.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Create Screening Order', - tags: ['Orders'], - 'x-speakeasy-group': 'screening', - 'x-speakeasy-name-override': 'create_screening_order', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - }, - info: { - title: 'Screening', - description: 'The documentation for the StackOne Unified API - SCREENING', - version: '1.0.0', - contact: {}, - }, - tags: [ - { - name: 'Orders', - description: 'Requests for screening services.', - }, - { - name: 'Results', - description: 'Outcomes of screening services.', - }, - { - name: 'Packages', - description: 'Collections of screening services.', - }, - ], - servers: [ - { - url: 'https://api.stackone.com', - }, - ], - components: { - securitySchemes: { - basic: { - type: 'http', - scheme: 'basic', - }, - }, - schemas: { - BadGatewayResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 502, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Gateway', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - BadRequestResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 400, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Request', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - data: { - description: 'Error details', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/UnifiedError', - }, - ], - }, - provider_errors: { - description: 'List of provider-specific errors', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/ProviderError', - }, - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - ConflictResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 409, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Conflict', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - CreateResult: { - type: 'object', - properties: { - statusCode: { - type: 'number', - example: 201, - }, - message: { - type: 'string', - example: 'Record created successfully.', - }, - timestamp: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - }, - data: { - $ref: '#/components/schemas/CreateResultDataApiModel', - }, - }, - required: ['statusCode', 'message', 'timestamp', 'data'], - }, - CreateResultDataApiModel: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - }, - }, - ForbiddenResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 403, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Forbidden resource', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - InternalServerErrorResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 500, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Internal server error', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - NotFoundResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 404, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Not Found', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - NotImplementedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 501, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Not Implemented', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - PreconditionFailedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 412, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Precondition failed', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - ProviderError: { - type: 'object', - properties: { - status: { - type: 'number', - description: 'HTTP status code of the provider error', - example: 400, - nullable: true, - }, - url: { - type: 'string', - description: 'URL that caused the error', - example: 'https://api.provider.com/v1/resource', - nullable: true, - }, - raw: { - type: 'object', - description: 'Raw error response from the provider', - example: { - message: 'Invalid input parameters', - }, - nullable: true, - }, - headers: { - type: 'object', - description: 'Response headers', - example: { - 'content-type': 'application/json', - 'x-request-id': '5678c28b211dace4e0a0f9171e6b88c5', - }, - nullable: true, - }, - }, - }, - RawResponse: { - type: 'object', - properties: { - method: { - type: 'string', - }, - url: { - type: 'string', - }, - body: { - oneOf: [ - { - type: 'string', - }, - { - type: 'object', - }, - { - type: 'array', - items: { - type: 'integer', - format: 'int32', - minimum: 0, - maximum: 255, - }, - }, - ], - additionalProperties: true, - nullable: true, - }, - response: { - oneOf: [ - { - type: 'object', - additionalProperties: true, - }, - { - type: 'array', - items: {}, - }, - { - type: 'string', - }, - ], - nullable: true, - }, - }, - required: ['method', 'url'], - }, - RequestTimedOutResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 408, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Request timed out', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - ScreeningCreateOrderRequestDto: { - type: 'object', - properties: { - passthrough: { - type: 'object', - description: 'Value to pass through to the provider', - example: { - other_known_names: 'John Doe', - }, - additionalProperties: true, - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - package_id: { - type: 'string', - description: 'Package ID', - example: '54321', - }, - candidate: { - description: 'Candidate information', - allOf: [ - { - $ref: '#/components/schemas/ScreeningOrderCandidate', - }, - ], - }, - }, - required: ['package_id', 'candidate'], - }, - ScreeningOrderCandidate: { - type: 'object', - properties: { - first_name: { - type: 'string', - description: 'Candidate first name', - example: 'John', - nullable: true, - }, - last_name: { - type: 'string', - description: 'Candidate last name', - example: 'Doe', - nullable: true, - }, - email: { - type: 'string', - description: 'Candidate email', - example: 'john.doe@example.com', - nullable: true, - }, - }, - }, - ScreeningPackage: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - name: { - type: 'string', - description: 'The name of the screening package', - example: 'Basic Background Check', - }, - description: { - type: 'string', - description: 'The description of the screening package', - example: 'Basic background check including identity verification and criminal records', - nullable: true, - }, - }, - required: ['name'], - }, - ScreeningPackageResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/ScreeningPackage', - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - ScreeningPackagesPaginated: { - type: 'object', - properties: { - next_page: { - type: 'string', - deprecated: true, - nullable: true, - }, - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/ScreeningPackage', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['data'], - }, - ScreeningResult: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - order_id: { - type: 'string', - description: 'Order ID associated with this result', - example: '12345', - nullable: true, - }, - score: { - description: 'Score information', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ScreeningResultScore', - }, - ], - }, - start_date: { - type: 'string', - description: 'Start date of the screening', - example: '2023-01-01T00:00:00Z', - format: 'date-time', - nullable: true, - }, - submission_date: { - type: 'string', - description: 'Submission date of the screening', - example: '2023-01-02T00:00:00Z', - format: 'date-time', - nullable: true, - }, - summary: { - type: 'string', - description: 'Summary of the screening result', - example: 'Background check completed successfully', - nullable: true, - }, - status: { - type: 'string', - description: 'Result status', - example: 'completed', - enum: [ - 'pending', - 'in_progress', - 'completed', - 'failed', - 'cancelled', - 'unmapped_value', - null, - ], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - result_url: { - type: 'string', - description: 'URL to view the detailed result', - example: 'https://example.com/results/12345', - nullable: true, - }, - }, - }, - ScreeningResultScore: { - type: 'object', - properties: { - label: { - type: 'string', - description: 'Score label', - example: 'Overall Risk', - nullable: true, - }, - value: { - type: 'string', - description: 'Score value', - example: '75', - nullable: true, - }, - min: { - type: 'string', - description: 'Minimum score value', - example: '0', - nullable: true, - }, - max: { - type: 'string', - description: 'Maximum score value', - example: '100', - nullable: true, - }, - }, - }, - ScreeningResultWebhook: { - type: 'object', - properties: { - event: { - type: 'string', - description: 'The event type', - example: 'screening.result.completed', - enum: [ - 'screening.results.created', - 'screening.results.updated', - 'screening.results.completed', - 'screening.results.failed', - 'screening.results.cancelled', - ], - 'x-speakeasy-unknown-values': 'allow', - }, - data: { - description: 'The result data', - allOf: [ - { - $ref: '#/components/schemas/ScreeningResult', - }, - ], - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - required: ['event', 'data'], - }, - TooManyRequestsResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 429, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Too many requests', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - UnauthorizedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 401, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Unauthorized', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - UnifiedError: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 400, - nullable: true, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Request', - nullable: true, - }, - headers: { - type: 'object', - description: 'Response headers', - example: { - 'content-type': 'application/json', - 'x-request-id': '5678c28b211dace4e0a0f9171e6b88c5', - }, - nullable: true, - }, - }, - }, - UnprocessableEntityResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 422, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Unprocessable Entity', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - }, - }, -}; diff --git a/src/openapi/generated/stackone.ts b/src/openapi/generated/stackone.ts deleted file mode 100644 index de30ebc7..00000000 --- a/src/openapi/generated/stackone.ts +++ /dev/null @@ -1,6308 +0,0 @@ -// Generated OpenAPI specification for stackone -// DO NOT EDIT THIS FILE DIRECTLY -export const stackoneSpec = { - openapi: '3.1.0', - paths: { - '/connect_sessions': { - post: { - operationId: 'stackone_create_connect_session', - parameters: [], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConnectSessionCreate', - }, - }, - }, - }, - responses: { - '201': { - description: 'The details of the connect session created with token and auth link', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConnectSessionTokenAuthLink', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Create Connect Session', - tags: ['Connect Sessions'], - 'x-speakeasy-name-override': 'create_connect_session', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/connect_sessions/authenticate': { - post: { - operationId: 'stackone_authenticate_connect_session', - parameters: [], - requestBody: { - required: true, - description: 'The parameters to authenticate', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConnectSessionAuthenticate', - }, - }, - }, - }, - responses: { - '201': { - description: 'The details of the authenticated connect session.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConnectSession', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Authenticate Connect Session', - tags: ['Connect Sessions'], - 'x-speakeasy-name-override': 'authenticate_connect_session', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/accounts': { - get: { - operationId: 'stackone_list_linked_accounts', - parameters: [ - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - schema: { - nullable: true, - type: 'number', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page', - schema: { - nullable: true, - default: 25, - type: 'number', - }, - }, - { - name: 'provider', - required: false, - in: 'query', - description: 'The provider of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'origin_owner_id', - required: false, - in: 'query', - description: 'The origin owner identifier of the results to fetch', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'origin_owner_ids', - required: false, - in: 'query', - description: - 'The origin owner identifiers of the results to fetch (supports multiple IDs)', - schema: { - type: 'array', - items: { - type: 'string', - }, - }, - }, - { - name: 'providers', - required: false, - in: 'query', - description: 'The providers list of the results to fetch', - schema: { - type: 'array', - items: { - type: 'string', - }, - }, - }, - { - name: 'account_ids', - required: false, - in: 'query', - description: 'The providers list of the results to fetch', - schema: { - type: 'array', - items: { - type: 'string', - }, - }, - }, - { - name: 'status', - required: false, - in: 'query', - description: 'The status of the results to fetch', - schema: { - type: 'array', - items: { - type: 'string', - }, - }, - }, - ], - responses: { - '200': { - description: 'The list of accounts was retrieved.', - content: { - 'application/json': { - schema: { - type: 'array', - items: { - $ref: '#/components/schemas/LinkedAccount', - }, - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Accounts', - tags: ['Accounts'], - 'x-speakeasy-name-override': 'list_linked_accounts', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/accounts/{id}': { - get: { - operationId: 'stackone_get_account', - parameters: [ - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The account with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/LinkedAccount', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Account', - tags: ['Accounts'], - 'x-speakeasy-name-override': 'get_account', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - patch: { - operationId: 'stackone_update_account', - parameters: [ - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PatchAccountExternalDto', - }, - }, - }, - }, - responses: { - '200': { - description: 'The account with the given identifier was updated.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/LinkedAccount', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Update Account', - tags: ['Accounts'], - 'x-speakeasy-name-override': 'update_account', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - delete: { - operationId: 'stackone_delete_account', - parameters: [ - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The account with the given identifier was deleted.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/LinkedAccount', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Delete Account', - tags: ['Accounts'], - 'x-speakeasy-name-override': 'delete_account', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/accounts/{id}/meta': { - get: { - operationId: 'stackone_get_account_meta_info', - parameters: [ - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The meta information of the account was retrieved', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/LinkedAccountMeta', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Account Meta Information', - tags: ['Accounts'], - 'x-speakeasy-name-override': 'get_account_meta_info', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/requests/logs/steps': { - get: { - operationId: 'stackone_list_step_logs', - parameters: [ - { - name: 'order_by', - required: false, - in: 'query', - description: 'The field to order the results by.', - 'x-speakeasy-unknown-values': 'allow', - schema: { - additionalProperties: false, - nullable: true, - example: 'created_at', - type: 'string', - enum: ['provider', 'service', 'status', 'eventDatetime', 'duration', null], - }, - }, - { - name: 'order_direction', - required: false, - in: 'query', - description: 'The direction to order the results by.', - 'x-speakeasy-unknown-values': 'allow', - schema: { - additionalProperties: false, - nullable: true, - example: 'asc', - type: 'string', - enum: ['asc', 'desc', null], - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - maximum: 100, - nullable: true, - type: 'number', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - schema: { - properties: { - account_ids: { - description: 'A comma-separated list of account IDs to filter the results by.', - example: '45355976281015164504,45355976281015164505', - type: 'string', - nullable: true, - additionalProperties: false, - }, - start_date: { - description: 'A ISO8601 date string to filter the results by start_date.', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - end_date: { - description: 'A ISO8601 date string to filter the results by end_date.', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - request_ids: { - description: 'A comma-separated list of request IDs to filter the results by.', - example: - 'adbf752f-6457-4ddd-89b3-98ae2252b83b,adbf752f-6457-4ddd-89b3-98ae2252b83c', - type: 'string', - nullable: true, - additionalProperties: false, - }, - http_methods: { - description: 'A comma-separated list of HTTP methods to filter the results by.', - example: 'GET,POST', - type: 'string', - nullable: true, - additionalProperties: false, - }, - providers: { - description: 'A comma-separated list of provider keys to filter the results by.', - example: 'ashby,greenhouse', - type: 'string', - nullable: true, - additionalProperties: false, - }, - services: { - description: 'A comma-separated list of services to filter the results by.', - example: 'hris,ats', - type: 'string', - nullable: true, - additionalProperties: false, - }, - resources: { - description: 'A comma-separated list of resources to filter the results by.', - example: 'employees,users', - type: 'string', - nullable: true, - additionalProperties: false, - }, - child_resources: { - description: - 'A comma-separated list of child resources to filter the results by.', - example: 'documents,time-off', - type: 'string', - nullable: true, - additionalProperties: false, - }, - sub_resources: { - description: 'A comma-separated list of sub resources to filter the results by.', - example: 'documents,employees', - type: 'string', - nullable: true, - additionalProperties: false, - }, - actions: { - description: 'A comma-separated list of actions to filter the results by.', - example: 'download,upload', - type: 'string', - nullable: true, - additionalProperties: false, - }, - status_codes: { - description: 'A comma-separated list of status codes to filter the results by.', - example: '200,400', - type: 'string', - nullable: true, - additionalProperties: false, - }, - success: { - description: 'A boolean value to filter the results by success or failure.', - example: true, - type: 'boolean', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - ], - responses: { - '200': { - description: 'The list of step logs was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/StepLogsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Step Logs', - tags: ['Request Logs'], - 'x-speakeasy-name-override': 'list_step_logs', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/requests/logs/{id}': { - get: { - operationId: 'stackone_get_log', - parameters: [ - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'include', - required: false, - in: 'query', - description: - 'The include parameter allows you to include additional data in the response.', - 'x-speakeasy-unknown-values': 'allow', - schema: { - nullable: true, - example: 'step_logs', - type: 'string', - enum: ['step_logs', 'advanced_logs', null], - }, - }, - ], - responses: { - '200': { - description: 'The log was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnifiedLogResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Log', - tags: ['Request Logs'], - 'x-speakeasy-name-override': 'get_log', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/requests/logs': { - get: { - operationId: 'stackone_list_logs', - parameters: [ - { - name: 'order_by', - required: false, - in: 'query', - description: 'The field to order the results by.', - 'x-speakeasy-unknown-values': 'allow', - schema: { - additionalProperties: false, - nullable: true, - example: 'created_at', - type: 'string', - enum: ['provider', 'service', 'status', 'eventDatetime', 'duration', null], - }, - }, - { - name: 'order_direction', - required: false, - in: 'query', - description: 'The direction to order the results by.', - 'x-speakeasy-unknown-values': 'allow', - schema: { - additionalProperties: false, - nullable: true, - example: 'asc', - type: 'string', - enum: ['asc', 'desc', null], - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - maximum: 100, - nullable: true, - type: 'number', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'include', - required: false, - in: 'query', - description: - 'The include parameter allows you to include additional data in the response.', - 'x-speakeasy-unknown-values': 'allow', - schema: { - nullable: true, - example: 'step_logs', - type: 'string', - enum: ['step_logs', null], - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - schema: { - properties: { - account_ids: { - description: 'A comma-separated list of account IDs to filter the results by.', - example: '45355976281015164504,45355976281015164505', - type: 'string', - nullable: true, - additionalProperties: false, - }, - start_date: { - description: 'A ISO8601 date string to filter the results by start_date.', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - end_date: { - description: 'A ISO8601 date string to filter the results by end_date.', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - request_ids: { - description: 'A comma-separated list of request IDs to filter the results by.', - example: - 'adbf752f-6457-4ddd-89b3-98ae2252b83b,adbf752f-6457-4ddd-89b3-98ae2252b83c', - type: 'string', - nullable: true, - additionalProperties: false, - }, - source_types: { - description: 'A comma-separated list of source types to filter the results by.', - example: 'DASHBOARD,SYNTHETIC_WEBHOOK', - type: 'string', - nullable: true, - additionalProperties: false, - }, - source_values: { - description: 'A comma-separated list of source values to filter the results by.', - type: 'string', - nullable: true, - additionalProperties: false, - }, - source_ids: { - description: 'A comma-separated list of source IDs to filter the results by.', - type: 'string', - nullable: true, - additionalProperties: false, - }, - http_methods: { - description: 'A comma-separated list of HTTP methods to filter the results by.', - example: 'GET,POST', - type: 'string', - nullable: true, - additionalProperties: false, - }, - providers: { - description: 'A comma-separated list of provider keys to filter the results by.', - example: 'ashby,greenhouse', - type: 'string', - nullable: true, - additionalProperties: false, - }, - services: { - description: 'A comma-separated list of services to filter the results by.', - example: 'hris,ats', - type: 'string', - nullable: true, - additionalProperties: false, - }, - resources: { - description: 'A comma-separated list of resources to filter the results by.', - example: 'employees,users', - type: 'string', - nullable: true, - additionalProperties: false, - }, - child_resources: { - description: - 'A comma-separated list of child resources to filter the results by.', - example: 'documents,time-off', - type: 'string', - nullable: true, - additionalProperties: false, - }, - sub_resources: { - description: 'A comma-separated list of sub resources to filter the results by.', - example: 'documents,employees', - type: 'string', - nullable: true, - additionalProperties: false, - }, - actions: { - description: 'A comma-separated list of actions to filter the results by.', - example: 'download,upload', - type: 'string', - nullable: true, - additionalProperties: false, - }, - status_codes: { - description: 'A comma-separated list of status codes to filter the results by.', - example: '200,400', - type: 'string', - nullable: true, - additionalProperties: false, - }, - success: { - description: 'A boolean value to filter the results by success or failure.', - example: true, - type: 'boolean', - nullable: true, - additionalProperties: false, - }, - order_by: { - description: 'The field to order the results by.', - example: 'created_at', - type: 'string', - nullable: true, - enum: ['provider', 'service', 'status', 'eventDatetime', 'duration', null], - additionalProperties: false, - }, - order_direction: { - description: 'The direction to order the results by.', - example: 'asc', - type: 'string', - nullable: true, - enum: ['asc', 'desc', null], - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - ], - responses: { - '200': { - description: 'The list of logs was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnifiedLogsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Logs', - tags: ['Request Logs'], - 'x-speakeasy-name-override': 'list_logs', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/requests/platform-logs': { - get: { - operationId: 'stackone_list_platform_logs', - parameters: [ - { - name: 'order_by', - required: false, - in: 'query', - description: 'The field to order the results by.', - 'x-speakeasy-unknown-values': 'allow', - schema: { - additionalProperties: false, - nullable: true, - example: 'created_at', - type: 'string', - enum: ['provider', 'service', 'status', 'eventDatetime', 'duration', null], - }, - }, - { - name: 'order_direction', - required: false, - in: 'query', - description: 'The direction to order the results by.', - 'x-speakeasy-unknown-values': 'allow', - schema: { - additionalProperties: false, - nullable: true, - example: 'asc', - type: 'string', - enum: ['asc', 'desc', null], - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - maximum: 100, - nullable: true, - type: 'number', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - schema: { - properties: { - account_ids: { - description: 'A comma-separated list of account IDs to filter the results by.', - example: '45355976281015164504,45355976281015164505', - type: 'string', - nullable: true, - additionalProperties: false, - }, - start_date: { - description: 'A ISO8601 date string to filter the results by start_date.', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - end_date: { - description: 'A ISO8601 date string to filter the results by end_date.', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - request_ids: { - description: 'A comma-separated list of request IDs to filter the results by.', - example: - 'adbf752f-6457-4ddd-89b3-98ae2252b83b,adbf752f-6457-4ddd-89b3-98ae2252b83c', - type: 'string', - nullable: true, - additionalProperties: false, - }, - source_types: { - description: 'A comma-separated list of source types to filter the results by.', - example: 'DASHBOARD,SYNTHETIC_WEBHOOK', - type: 'string', - nullable: true, - additionalProperties: false, - }, - source_values: { - description: 'A comma-separated list of source values to filter the results by.', - type: 'string', - nullable: true, - additionalProperties: false, - }, - source_ids: { - description: 'A comma-separated list of source IDs to filter the results by.', - type: 'string', - nullable: true, - additionalProperties: false, - }, - http_methods: { - description: 'A comma-separated list of HTTP methods to filter the results by.', - example: 'GET,POST', - type: 'string', - nullable: true, - additionalProperties: false, - }, - categories: { - description: 'A comma-separated list of categories to filter the results by.', - example: 'hris,ats', - type: 'string', - nullable: true, - additionalProperties: false, - }, - resources: { - description: 'A comma-separated list of resources to filter the results by.', - example: 'employees,users', - type: 'string', - nullable: true, - additionalProperties: false, - }, - actions: { - description: 'A comma-separated list of actions to filter the results by.', - example: 'download,upload', - type: 'string', - nullable: true, - additionalProperties: false, - }, - status_codes: { - description: 'A comma-separated list of status codes to filter the results by.', - example: '200,400', - type: 'string', - nullable: true, - additionalProperties: false, - }, - success: { - description: 'A boolean value to filter the results by success or failure.', - example: true, - type: 'boolean', - nullable: true, - additionalProperties: false, - }, - order_by: { - description: 'The field to order the results by.', - example: 'created_at', - type: 'string', - nullable: true, - enum: ['provider', 'service', 'status', 'eventDatetime', 'duration', null], - additionalProperties: false, - }, - order_direction: { - description: 'The direction to order the results by.', - example: 'asc', - type: 'string', - nullable: true, - enum: ['asc', 'desc', null], - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - ], - responses: { - '200': { - description: 'The list of platform logs was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PlatformLogsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Platform Logs', - tags: ['Request Logs'], - 'x-speakeasy-name-override': 'list_platform_logs', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/connectors/meta': { - get: { - operationId: 'stackone_list_connectors_meta', - parameters: [ - { - name: 'include', - required: false, - in: 'query', - description: 'The comma separated list of data that will be included in the response', - schema: { - nullable: true, - example: 'field_path,unmapped_fields,resources,inactive,webhooks,static_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of connectors meta information was retrieved.', - content: { - 'application/json': { - schema: { - type: 'array', - items: { - $ref: '#/components/schemas/ConnectorsMeta', - }, - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Connector Meta Information', - tags: ['Connectors'], - 'x-speakeasy-name-override': 'list_connectors_meta', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/connectors/meta/{provider}': { - get: { - operationId: 'stackone_get_connector_meta', - parameters: [ - { - name: 'provider', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'include', - required: false, - in: 'query', - description: 'The comma separated list of data that will be included in the response', - schema: { - nullable: true, - example: 'field_path,unmapped_fields,resources,inactive,webhooks,static_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The connector meta information was retrieved', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConnectorsMeta', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Connector Meta Information', - tags: ['Connectors'], - 'x-speakeasy-name-override': 'get_connector_meta', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/mcp': { - post: { - description: 'Send JSON-RPC request to the MCP server over HTTP streaming transport', - operationId: 'stackone_mcp_post', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: - 'Account secure id for the target provider account (optional if x-account-id query parameter is provided)', - required: false, - schema: { - type: 'string', - }, - }, - { - name: 'x-account-id', - required: false, - in: 'query', - description: 'Account secure id (alternative to x-account-id header)', - schema: {}, - }, - { - name: 'mcp-session-id', - in: 'header', - description: 'Session id; omit for initialize, include for subsequent calls', - required: false, - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - description: 'JSON-RPC 2.0 message', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/JsonRpcMessageDto', - }, - examples: { - initialize: { - summary: 'Initialize session', - value: { - jsonrpc: '2.0', - method: 'initialize', - params: { - clientInfo: { - name: 'my-client', - version: '1.0.0', - }, - protocolVersion: '2025-03-26', - capabilities: {}, - }, - id: 'init-1', - }, - }, - toolsList: { - summary: 'List tools', - value: { - jsonrpc: '2.0', - method: 'tools/list', - params: {}, - id: 'tools-1', - }, - }, - toolsCall: { - summary: 'Call a tool', - value: { - jsonrpc: '2.0', - method: 'tools/call', - params: { - name: 'unified_hris_list_employees', - arguments: {}, - }, - id: 'call-1', - }, - }, - }, - }, - }, - }, - responses: { - '200': { - description: 'Processed successfully', - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - { - ApiKey: [], - }, - ], - summary: 'Send MCP JSON-RPC message', - tags: ['MCP'], - 'x-speakeasy-name-override': 'mcp_post', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - get: { - description: 'Open a dedicated Server-Sent Events stream for MCP notifications', - operationId: 'stackone_mcp_get', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: - 'Account secure id for the target provider account (optional if x-account-id query parameter is provided)', - required: false, - schema: { - type: 'string', - }, - }, - { - name: 'x-account-id', - required: false, - in: 'query', - description: 'Account secure id (alternative to x-account-id header)', - schema: {}, - }, - { - name: 'Accept', - in: 'header', - description: 'Must be text/event-stream', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'mcp-session-id', - in: 'header', - description: 'Session id', - required: true, - schema: { - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'SSE stream opened', - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - { - ApiKey: [], - }, - ], - summary: 'Open MCP SSE stream', - tags: ['MCP'], - 'x-speakeasy-name-override': 'mcp_get', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - delete: { - description: 'Close an existing MCP session for the provided session id', - operationId: 'stackone_mcp_delete', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: - 'Account secure id for the target provider account (optional if x-account-id query parameter is provided)', - required: false, - schema: { - type: 'string', - }, - }, - { - name: 'x-account-id', - required: false, - in: 'query', - description: 'Account secure id (alternative to x-account-id header)', - schema: {}, - }, - { - name: 'mcp-session-id', - in: 'header', - description: 'Session id', - required: true, - schema: { - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'Session closed', - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - { - ApiKey: [], - }, - ], - summary: 'Delete MCP session', - tags: ['MCP'], - 'x-speakeasy-name-override': 'mcp_delete', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/proxy': { - post: { - operationId: 'stackone_proxy_request', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - description: 'The request body', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ProxyRequestBody', - }, - }, - }, - }, - responses: { - '200': { - description: 'The proxy request was successful.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ProxyResponseApiModel', - }, - }, - }, - }, - '201': { - description: 'Resource was successfully created by the target service.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ProxyResponseApiModel', - }, - }, - }, - }, - '202': { - description: 'Request accepted by the target service.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ProxyResponseApiModel', - }, - }, - }, - }, - '204': { - description: 'Request succeeded with no content.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ProxyResponseApiModel', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Proxy Request', - tags: ['Proxy'], - 'x-speakeasy-name-override': 'proxy_request', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/actions': { - get: { - description: 'Retrieves a list of all actions metadata', - operationId: 'stackone_list_actions_meta', - parameters: [ - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'group_by', - required: false, - in: 'query', - description: 'The relation to group the results by', - schema: { - nullable: true, - default: 'connector', - example: ['connector'], - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Actions Metadata filters', - explode: true, - style: 'deepObject', - schema: { - properties: { - connectors: { - description: 'A comma-separated list of connectors to filter the results by.', - example: 'connector1,connector2', - type: 'string', - nullable: true, - additionalProperties: false, - }, - account_ids: { - description: 'A comma-separated list of account IDs to filter the results by.', - example: 'account1,account2', - type: 'string', - nullable: true, - additionalProperties: false, - }, - action_key: { - description: 'The action key to filter the results by', - example: 'action1', - type: 'string', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'include', - required: false, - in: 'query', - description: 'Additional data to include in the response', - schema: { - nullable: true, - example: ['action_details'], - type: 'array', - items: { - type: 'string', - enum: ['action_details'], - }, - }, - }, - ], - responses: { - '200': { - description: 'List of actions metadata', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ActionsMetaPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - summary: 'List all actions metadata', - tags: ['Actions'], - 'x-speakeasy-name-override': 'list_actions_meta', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/actions/rpc': { - post: { - description: 'Makes a remote procedure call to the specified action', - operationId: 'stackone_rpc_action', - parameters: [], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ActionsRpcRequestDto', - }, - }, - }, - }, - responses: { - '200': { - description: 'Action response', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ActionsRpcResponse', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - summary: 'Make an RPC call to an action', - tags: ['Actions'], - 'x-speakeasy-name-override': 'rpc_action', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - }, - info: { - title: 'StackOne', - description: 'The documentation for the StackOne API', - version: '1.0.0', - contact: {}, - }, - tags: [ - { - name: 'Accounts', - description: 'View and manage linked accounts.', - }, - { - name: 'Actions', - description: 'Retrieve Actions metadata and definitions.', - }, - { - name: 'AI', - description: 'AI-powered features.', - }, - { - name: 'Connect Sessions', - description: - 'Generate connection session tokens or auth URLs to allow your customers to connect their accounts.', - }, - { - name: 'Connectors', - description: 'Retrieve metadata for connectors.', - }, - { - name: 'MCP', - description: 'Model Context Protocol endpoint.', - }, - { - name: 'Proxy', - description: 'Routing API requests through StackOne directly to the underlying provider.', - }, - { - name: 'Request Logs', - description: 'API requests and response logs.', - }, - { - name: 'Webhooks', - description: 'Configure and manage webhooks.', - }, - ], - servers: [ - { - url: 'https://api.stackone.com', - }, - ], - components: { - securitySchemes: { - basic: { - type: 'http', - scheme: 'basic', - }, - }, - schemas: { - ActionMetaItem: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'The action ID', - nullable: true, - }, - label: { - type: 'string', - description: 'The action label', - nullable: true, - }, - description: { - type: 'string', - description: 'The action description', - nullable: true, - }, - schema_type: { - type: 'string', - description: 'The schema type for the action', - nullable: true, - }, - tags: { - description: 'The tags associated with this action', - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - authentication: { - description: 'The authentication methods supported by this action', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/AuthenticationMetaItem', - }, - }, - operation_details: { - type: 'object', - description: 'The operation details for the action', - additionalProperties: true, - nullable: true, - }, - }, - }, - ActionsMeta: { - type: 'object', - properties: { - version: { - type: 'string', - description: 'The version of the actions metadata', - nullable: true, - }, - name: { - type: 'string', - description: 'The name of the provider', - nullable: true, - }, - key: { - type: 'string', - description: 'The unique key for the provider', - nullable: true, - }, - icon: { - type: 'string', - description: 'The icon URL for the provider', - nullable: true, - }, - description: { - type: 'string', - description: 'The description of the provider', - nullable: true, - }, - authentication: { - description: 'The authentication methods supported by the provider', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/AuthenticationMetaItem', - }, - }, - actions: { - description: 'The list of actions available for this provider', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/ActionMetaItem', - }, - }, - }, - }, - ActionsMetaPaginated: { - type: 'object', - properties: { - next: { - type: 'string', - description: 'Cursor for fetching the next page of results', - nullable: true, - }, - data: { - description: 'The list of actions metadata', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/ActionsMeta', - }, - }, - }, - }, - ActionsRpcQueryDto: { - type: 'object', - properties: { - debug: { - type: 'boolean', - description: 'Enable debug mode for the action execution', - example: false, - nullable: true, - }, - }, - }, - ActionsRpcRequestDto: { - type: 'object', - properties: { - action: { - type: 'string', - description: 'The action to execute', - example: 'create_employee', - }, - path: { - type: 'object', - description: 'Path parameters for the action', - example: { - id: '123', - }, - nullable: true, - additionalProperties: true, - }, - query: { - description: 'Query parameters for the action', - nullable: true, - additionalProperties: true, - allOf: [ - { - $ref: '#/components/schemas/ActionsRpcQueryDto', - }, - ], - }, - headers: { - type: 'object', - description: 'Headers for the action', - example: { - 'Content-Type': 'application/json', - }, - nullable: true, - additionalProperties: true, - }, - body: { - type: 'object', - description: 'Request body for the action', - example: { - data: 'example', - }, - nullable: true, - additionalProperties: true, - }, - }, - required: ['action'], - }, - ActionsRpcResponse: { - type: 'object', - properties: { - next: { - type: 'string', - description: 'Cursor for fetching the next page of results', - nullable: true, - }, - data: { - description: 'The response data from the action RPC call', - oneOf: [ - { - type: 'object', - additionalProperties: true, - }, - { - type: 'array', - items: { - type: 'object', - additionalProperties: true, - }, - }, - { - type: 'null', - }, - ], - nullable: true, - }, - }, - }, - AdvancedLogRequestData: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'The request ID', - example: 'adbf752f-6457-4ddd-89b3-98ae2252b83b', - nullable: true, - }, - method: { - type: 'string', - description: 'The request method', - example: 'get', - nullable: true, - }, - headers: { - type: 'object', - additionalProperties: true, - example: { - 'content-type': 'application/json', - authorization: 'Bearer token', - }, - nullable: true, - }, - url: { - description: 'The request URL data', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/AdvancedLogRequestDataUrl', - }, - ], - }, - body: { - oneOf: [ - { - type: 'string', - }, - { - type: 'object', - }, - { - type: 'string', - format: 'binary', - }, - { - type: 'array', - items: { - type: 'integer', - format: 'int32', - minimum: 0, - maximum: 255, - }, - }, - { - type: 'string', - format: 'byte', - }, - ], - additionalProperties: true, - nullable: true, - }, - }, - }, - AdvancedLogRequestDataUrl: { - type: 'object', - properties: { - url: { - type: 'string', - description: 'The request URL', - example: 'https://example.com/api/v1/resource', - nullable: true, - }, - hostname: { - type: 'string', - description: 'The request URL hostname', - example: 'example.com', - nullable: true, - }, - path: { - type: 'string', - description: 'The request path', - example: '/api/v1/resource', - nullable: true, - }, - query_params: { - type: 'object', - description: 'The request query parameters', - additionalProperties: true, - example: { - page: 1, - limit: 10, - }, - nullable: true, - }, - }, - }, - AdvancedLogResponseData: { - type: 'object', - properties: { - status_code: { - type: 'number', - description: 'The response status code', - example: 200, - nullable: true, - }, - headers: { - type: 'object', - additionalProperties: true, - example: { - 'content-type': 'application/json', - authorization: 'Bearer token', - }, - nullable: true, - }, - body: { - oneOf: [ - { - type: 'string', - }, - { - type: 'object', - }, - { - type: 'string', - format: 'binary', - }, - { - type: 'array', - items: { - type: 'integer', - format: 'int32', - minimum: 0, - maximum: 255, - }, - }, - { - type: 'string', - format: 'byte', - }, - ], - additionalProperties: true, - nullable: true, - }, - custom_mapping_errors: { - description: 'The custom mapping errors', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/CustomMappingError', - }, - }, - provider_errors: { - description: 'The provider errors', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/ProviderError', - }, - }, - }, - }, - AuthenticationMetaItem: { - type: 'object', - properties: { - type: { - type: 'string', - description: 'The authentication type', - nullable: true, - }, - label: { - type: 'string', - description: 'The authentication label', - nullable: true, - }, - key: { - type: 'string', - description: 'The authentication key', - nullable: true, - }, - }, - }, - BadGatewayResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 502, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Gateway', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - BadRequestResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 400, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Request', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - data: { - description: 'Error details', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/UnifiedError', - }, - ], - }, - provider_errors: { - description: 'List of provider-specific errors', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/ProviderError', - }, - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - ConflictResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 409, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Conflict', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - ConnectorsMeta: { - type: 'object', - properties: { - provider: { - type: 'string', - example: 'hibob', - description: 'The provider key', - }, - provider_name: { - type: 'string', - example: 'Hibob', - description: 'The provider human-readable label', - }, - category: { - type: 'string', - enum: [ - 'ats', - 'hris', - 'hris-legacy', - 'crm', - 'iam', - 'marketing', - 'lms', - 'stackone', - 'documents', - 'ticketing', - 'screening', - 'messaging', - 'accounting', - 'scheduling', - ], - example: 'hris', - description: 'The provider service category', - 'x-speakeasy-unknown-values': 'allow', - }, - active: { - type: 'boolean', - example: true, - description: - 'Whether this provider has been enabled on the integrations page for the current project', - nullable: true, - }, - models: { - type: 'object', - additionalProperties: true, - example: { - employees: { - create: { - apiPath: '/unified/hris/employees/:id', - input: { - defaultFields: [ - { - name: 'first_name', - type: 'string', - }, - ], - }, - output: { - defaultFields: [ - { - name: 'id', - type: 'string', - }, - ], - }, - }, - }, - time_off: { - get: { - apiPath: '/unified/hris/employees/:id/time_off/:id', - output: { - defaultFields: [ - { - name: 'id', - type: 'string', - }, - ], - }, - }, - }, - }, - }, - resources: { - description: 'Resources for this provider, such as image assets', - example: { - images: { - logo_url: 'https://app.stackone.com/assets/logos/hibob.png', - original_logo_horizontal_url: - 'https://app.stackone.com/assets/logos/original/hibob_horizontal.png', - }, - }, - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ConnectorsMetaResources', - }, - ], - }, - }, - required: ['provider', 'provider_name', 'category', 'models'], - }, - ConnectorsMetaResources: { - type: 'object', - properties: { - images: { - description: 'Image assets for this provider', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/ConnectorsMetaResourcesImagesApiModel', - }, - ], - }, - }, - }, - ConnectorsMetaResourcesImagesApiModel: { - type: 'object', - properties: { - logo_url: { - type: 'string', - example: 'https://app.stackone.com/assets/logos/hibob.png', - description: 'URL of the square logo designed and used by StackOne for this provider', - nullable: true, - }, - original_logo_horizontal_url: { - type: 'string', - example: 'https://app.stackone.com/assets/logos/source/hibob.png', - description: - 'URL of the original provider logo (with logo and/or name aligned horizontally)', - nullable: true, - }, - }, - }, - ConnectSession: { - type: 'object', - properties: { - id: { - type: 'number', - }, - organization_id: { - type: 'number', - }, - project_id: { - type: 'string', - }, - categories: { - type: 'array', - example: [ - 'ats', - 'hris', - 'hrisLegacy', - 'crm', - 'iam', - 'marketing', - 'lms', - 'stackOne', - 'documents', - 'ticketing', - 'screening', - 'messaging', - 'accounting', - 'scheduling', - ], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - items: { - type: 'string', - enum: [ - 'ats', - 'hris', - 'hris-legacy', - 'crm', - 'iam', - 'marketing', - 'lms', - 'stackone', - 'documents', - 'ticketing', - 'screening', - 'messaging', - 'accounting', - 'scheduling', - null, - ], - }, - }, - provider: { - type: 'string', - nullable: true, - }, - origin_owner_id: { - type: 'string', - }, - origin_owner_name: { - type: 'string', - }, - origin_username: { - type: 'string', - nullable: true, - }, - account_id: { - type: 'string', - nullable: true, - }, - label: { - type: 'string', - nullable: true, - }, - created_at: { - format: 'date-time', - type: 'string', - }, - metadata: { - type: 'object', - description: - 'Arbitrary set of key and values defined during the session token creation. This can be used to tag an account (eg. based on their pricing plan)', - nullable: true, - }, - external_trigger_token: { - type: 'string', - description: 'External trigger token to be used to trigger actions on the account', - example: 'f0bc3d88-2178-5423-8c81-b81d6c9da824', - nullable: true, - }, - type: { - type: 'string', - description: 'The connect session account type', - enum: ['production', 'test', 'unmapped_value', null], - example: ['PRODUCTION', 'TEST'], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - integration_id: { - type: 'string', - description: 'The integration ID (UUID) associated with this connect session', - nullable: true, - }, - }, - required: [ - 'id', - 'organization_id', - 'project_id', - 'origin_owner_id', - 'origin_owner_name', - 'created_at', - ], - }, - ConnectSessionAuthenticate: { - type: 'object', - properties: { - token: { - type: 'string', - description: 'The token to authenticate with', - }, - }, - required: ['token'], - }, - ConnectSessionCreate: { - type: 'object', - properties: { - categories: { - type: 'array', - description: 'The categories of the provider to connect to', - example: [ - 'ats', - 'hris', - 'hrisLegacy', - 'crm', - 'iam', - 'marketing', - 'lms', - 'stackOne', - 'documents', - 'ticketing', - 'screening', - 'messaging', - 'accounting', - 'scheduling', - ], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - items: { - type: 'string', - enum: [ - 'ats', - 'hris', - 'hris-legacy', - 'crm', - 'iam', - 'marketing', - 'lms', - 'stackone', - 'documents', - 'ticketing', - 'screening', - 'messaging', - 'accounting', - 'scheduling', - null, - ], - }, - }, - provider: { - type: 'string', - description: 'The provider to connect to', - nullable: true, - }, - provider_version: { - type: 'string', - description: 'The provider version to connect to', - nullable: true, - }, - origin_owner_id: { - type: 'string', - description: 'The origin owner identifier', - }, - origin_owner_name: { - type: 'string', - description: 'The origin owner name', - }, - origin_username: { - type: 'string', - description: 'The origin username', - nullable: true, - }, - account_id: { - type: 'string', - description: - 'The unique identifier for the account associated with this connect session. When this field is present, the hub will launch in edit mode using the retrieved token.', - nullable: true, - }, - expires_in: { - type: 'number', - description: 'How long the session should be valid for in seconds', - default: 1800, - nullable: true, - }, - metadata: { - type: 'object', - description: 'The metadata for the connection', - nullable: true, - }, - multiple: { - type: 'boolean', - description: - 'If set, this connect session will allow creation of multiple accounts with the same origin owner id and provider. Has no effect if account_id is set.', - default: false, - nullable: true, - }, - label: { - type: 'string', - description: - 'The label to be applied to the account associated with this connect session.', - nullable: true, - }, - type: { - type: 'string', - description: 'The connect session account type', - enum: ['production', 'test', null], - example: ['PRODUCTION', 'TEST'], - default: 'production', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - integration_id: { - type: 'string', - description: 'The integration ID associated with this connect session', - nullable: true, - }, - }, - required: ['origin_owner_id', 'origin_owner_name'], - }, - ConnectSessionTokenAuthLink: { - type: 'object', - properties: { - id: { - type: 'number', - }, - organization_id: { - type: 'number', - }, - project_id: { - type: 'string', - }, - categories: { - type: 'array', - example: [ - 'ats', - 'hris', - 'hrisLegacy', - 'crm', - 'iam', - 'marketing', - 'lms', - 'stackOne', - 'documents', - 'ticketing', - 'screening', - 'messaging', - 'accounting', - 'scheduling', - ], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - items: { - type: 'string', - enum: [ - 'ats', - 'hris', - 'hris-legacy', - 'crm', - 'iam', - 'marketing', - 'lms', - 'stackone', - 'documents', - 'ticketing', - 'screening', - 'messaging', - 'accounting', - 'scheduling', - null, - ], - }, - }, - provider: { - type: 'string', - nullable: true, - }, - origin_owner_id: { - type: 'string', - }, - origin_owner_name: { - type: 'string', - }, - origin_username: { - type: 'string', - nullable: true, - }, - account_id: { - type: 'string', - nullable: true, - }, - label: { - type: 'string', - nullable: true, - }, - created_at: { - format: 'date-time', - type: 'string', - }, - metadata: { - type: 'object', - description: - 'Arbitrary set of key and values defined during the session token creation. This can be used to tag an account (eg. based on their pricing plan)', - nullable: true, - }, - external_trigger_token: { - type: 'string', - description: 'External trigger token to be used to trigger actions on the account', - example: 'f0bc3d88-2178-5423-8c81-b81d6c9da824', - nullable: true, - }, - type: { - type: 'string', - description: 'The connect session account type', - enum: ['production', 'test', 'unmapped_value', null], - example: ['PRODUCTION', 'TEST'], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - integration_id: { - type: 'string', - description: 'The integration ID (UUID) associated with this connect session', - nullable: true, - }, - token: { - type: 'string', - }, - auth_link_url: { - type: 'string', - }, - }, - required: [ - 'id', - 'organization_id', - 'project_id', - 'origin_owner_id', - 'origin_owner_name', - 'created_at', - 'token', - 'auth_link_url', - ], - }, - CustomMappingError: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'The custom mapping identifier', - example: 'adbf752f-6457-4ddd-89b3-98ae2252b83b', - nullable: true, - }, - message: { - type: 'string', - description: 'The error message', - example: 'Invalid value', - nullable: true, - }, - targetField: { - type: 'string', - description: 'The target field where the error occurred', - example: 'first_name', - nullable: true, - }, - }, - }, - ForbiddenResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 403, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Forbidden resource', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - InternalServerErrorResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 500, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Internal server error', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - JsonRpcMessageDto: { - type: 'object', - properties: { - jsonrpc: { - type: 'string', - example: '2.0', - description: 'JSON-RPC protocol version', - }, - method: { - type: 'string', - example: 'initialize', - description: 'JSON-RPC method name', - }, - params: { - type: 'object', - description: 'Method parameters (arbitrary JSON)', - nullable: true, - }, - id: { - type: 'object', - description: 'Request id (arbitrary JSON scalar)', - }, - }, - required: ['jsonrpc', 'method'], - }, - LinkedAccount: { - type: 'object', - properties: { - id: { - type: 'string', - }, - provider: { - type: 'string', - }, - provider_name: { - type: 'string', - nullable: true, - }, - status: { - type: 'string', - enum: ['active', 'inactive', 'suspended', 'archived', 'expired', 'error'], - 'x-speakeasy-unknown-values': 'allow', - }, - status_reasons: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/StatusReason', - }, - }, - origin_owner_id: { - type: 'string', - }, - origin_owner_name: { - type: 'string', - }, - origin_username: { - type: 'string', - nullable: true, - }, - credentials: { - type: 'object', - nullable: true, - }, - setup_information: { - type: 'object', - additionalProperties: true, - nullable: true, - }, - label: { - type: 'string', - nullable: true, - }, - created_at: { - format: 'date-time', - type: 'string', - }, - updated_at: { - format: 'date-time', - type: 'string', - }, - type: { - type: 'string', - description: 'The account type', - enum: ['production', 'test', 'unmapped_value', null], - example: ['PRODUCTION', 'TEST'], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - }, - required: [ - 'id', - 'provider', - 'status', - 'origin_owner_id', - 'origin_owner_name', - 'created_at', - 'updated_at', - ], - }, - LinkedAccountMeta: { - type: 'object', - properties: { - provider: { - type: 'string', - }, - category: { - type: 'string', - enum: [ - 'ats', - 'hris', - 'hris-legacy', - 'crm', - 'iam', - 'marketing', - 'lms', - 'stackone', - 'documents', - 'ticketing', - 'screening', - 'messaging', - 'accounting', - 'scheduling', - ], - 'x-speakeasy-unknown-values': 'allow', - }, - models: { - type: 'object', - additionalProperties: true, - }, - }, - required: ['provider', 'category', 'models'], - }, - NotFoundResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 404, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Not Found', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - NotImplementedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 501, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Not Implemented', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - PatchAccountExternalDto: { - type: 'object', - properties: { - provider: { - type: 'string', - nullable: true, - }, - origin_owner_id: { - type: 'string', - nullable: true, - }, - origin_owner_name: { - type: 'string', - nullable: true, - }, - origin_username: { - type: 'string', - nullable: true, - }, - credentials: { - type: 'object', - additionalProperties: false, - nullable: true, - }, - setup_information: { - type: 'object', - additionalProperties: false, - nullable: true, - }, - secrets: { - type: 'object', - additionalProperties: false, - nullable: true, - }, - authentication_config_key: { - type: 'string', - nullable: true, - }, - environment: { - type: 'string', - nullable: true, - }, - label: { - type: 'object', - nullable: true, - }, - metadata: { - type: 'object', - additionalProperties: false, - nullable: true, - }, - type: { - type: 'string', - description: 'The account type', - enum: ['production', 'test', null], - example: ['PRODUCTION', 'TEST'], - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - integration_id: { - type: 'string', - nullable: true, - }, - }, - }, - PlatformLog: { - type: 'object', - properties: { - request_id: { - type: 'string', - description: 'The request ID', - example: 'adbf752f-6457-4ddd-89b3-98ae2252b83b', - nullable: true, - }, - event_datetime: { - type: 'string', - description: 'The event ISO8601 date string', - example: '2021-01-01T00:00:00Z', - format: 'date-time', - nullable: true, - }, - start_time: { - type: 'string', - description: 'The request start time ISO8601 date string', - example: '2021-01-01T00:00:00Z', - format: 'date-time', - nullable: true, - }, - end_time: { - type: 'string', - description: 'The request end time ISO8601 date string', - example: '2021-01-01T00:00:00Z', - format: 'date-time', - nullable: true, - }, - account_id: { - type: 'string', - description: 'The account ID of the request', - example: '45355976281015164504', - nullable: true, - }, - project_id: { - type: 'string', - description: 'The project ID of the request', - example: 'dev-project-68574', - nullable: true, - }, - http_method: { - type: 'string', - description: 'The requested HTTP method', - example: 'get', - nullable: true, - }, - path: { - type: 'string', - description: 'The requested path', - example: '/unified/hris/employees', - nullable: true, - }, - url: { - type: 'string', - description: 'The requested URL', - example: 'https://api.stackone.com/unified/hris/employees?raw=false', - nullable: true, - }, - status: { - type: 'number', - description: 'The requests response status code', - example: 200, - nullable: true, - }, - duration: { - type: 'number', - description: 'The request duration in milliseconds', - example: 356, - nullable: true, - }, - success: { - type: 'boolean', - description: 'The request success flag', - example: true, - nullable: true, - }, - resource: { - type: 'string', - description: 'The requested resource', - example: 'employees', - nullable: true, - }, - child_resource: { - type: 'string', - description: 'The requested child resource', - example: 'time-off', - nullable: true, - }, - sub_resource: { - type: 'string', - description: 'The requested sub resource', - example: 'documents', - nullable: true, - }, - action: { - type: 'string', - description: 'The requested action', - example: 'download', - nullable: true, - }, - source_type: { - type: 'string', - description: 'The requests source type', - example: 'DASHBOARD', - nullable: true, - }, - source_value: { - type: 'string', - description: 'The requests source value', - example: 'ACCOUNT_TESTER', - nullable: true, - }, - source_id: { - type: 'string', - description: 'The requests source ID', - example: '1234567890', - nullable: true, - }, - source_ip: { - type: 'string', - description: 'The requests source IPV4 ip address', - example: '192.168.1.1', - nullable: true, - }, - category: { - type: 'string', - description: 'The requested category', - example: 'hris', - nullable: true, - }, - }, - }, - PlatformLogsPaginated: { - type: 'object', - properties: { - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/PlatformLog', - }, - }, - }, - required: ['data'], - }, - PreconditionFailedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 412, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Precondition failed', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - ProviderError: { - type: 'object', - properties: { - status: { - type: 'number', - description: 'HTTP status code of the provider error', - example: 400, - nullable: true, - }, - url: { - type: 'string', - description: 'URL that caused the error', - example: 'https://api.provider.com/v1/resource', - nullable: true, - }, - raw: { - type: 'object', - description: 'Raw error response from the provider', - example: { - message: 'Invalid input parameters', - }, - nullable: true, - }, - headers: { - type: 'object', - description: 'Response headers', - example: { - 'content-type': 'application/json', - 'x-request-id': '5678c28b211dace4e0a0f9171e6b88c5', - }, - nullable: true, - }, - }, - }, - ProviderErrorApiModel: { - type: 'object', - properties: { - status: { - type: 'number', - example: 400, - nullable: true, - }, - url: { - type: 'string', - example: 'https://api.someprovider.com/v1/endpoint', - nullable: true, - }, - raw: { - type: 'object', - nullable: true, - }, - headers: { - type: 'object', - example: { - date: 'Tue, 02 Apr 2024 13:52:01 GMT', - 'content-type': 'application/json; charset=utf-8', - 'transfer-encoding': 'chunked', - connection: 'close', - }, - nullable: true, - }, - }, - }, - ProxyRequestBody: { - type: 'object', - properties: { - url: { - type: 'string', - description: 'The base url of the request', - example: 'https://api.sample-integration.com/v1', - nullable: true, - }, - method: { - type: 'string', - description: 'The method of the request', - enum: ['get', 'post', 'put', 'delete', 'patch', null], - default: 'get', - nullable: true, - 'x-speakeasy-unknown-values': 'allow', - }, - path: { - type: 'string', - description: 'The path of the request including any query parameters', - example: '/employees/directory', - nullable: true, - }, - headers: { - type: 'object', - description: 'The headers to send in the request', - additionalProperties: true, - example: { - 'Content-Type': 'application/json', - }, - nullable: true, - }, - body: { - type: 'object', - description: 'The body of the request', - additionalProperties: true, - nullable: true, - }, - }, - }, - ProxyResponseApiModel: { - type: 'object', - properties: { - status: { - type: 'number', - description: 'The HTTP status code returned by the provider', - example: 200, - }, - headers: { - type: 'object', - description: 'The headers returned by the provider', - example: { - 'content-type': 'application/json', - 'x-request-id': '123e4567-e89b-12d3-a456-426614174000', - }, - additionalProperties: true, - nullable: true, - }, - data: { - description: - 'The response data from the provider. Can be an object, array, or primitive value.', - example: { - id: '123', - name: 'John Doe', - email: 'john.doe@example.com', - }, - oneOf: [ - { - type: 'object', - additionalProperties: true, - }, - { - type: 'array', - items: { - type: 'object', - additionalProperties: true, - }, - }, - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - ], - nullable: true, - }, - provider_errors: { - description: 'Provider-specific errors if any occurred', - example: [ - { - status: 400, - url: 'https://api.someprovider.com/v1/endpoint', - raw: { - error: 'Bad Request', - message: 'The supplied data is invalid', - }, - headers: { - date: 'Tue, 02 Apr 2024 13:52:01 GMT', - 'content-type': 'application/json; charset=utf-8', - }, - }, - ], - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/ProviderErrorApiModel', - }, - }, - }, - required: ['status'], - }, - RequestTimedOutResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 408, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Request timed out', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - StatusReason: { - type: 'object', - properties: { - code: { - type: 'string', - nullable: true, - }, - description: { - type: 'string', - nullable: true, - }, - timestamp: { - format: 'date-time', - type: 'string', - }, - }, - required: ['timestamp'], - }, - StepLog: { - type: 'object', - properties: { - request_id: { - type: 'string', - description: 'The request ID', - example: 'adbf752f-6457-4ddd-89b3-98ae2252b83b', - nullable: true, - }, - start_time: { - type: 'string', - description: 'The request start time ISO8601 date string', - example: '2021-01-01T00:00:00Z', - format: 'date-time', - nullable: true, - }, - end_time: { - type: 'string', - description: 'The request end time ISO8601 date string', - example: '2021-01-01T00:00:00Z', - format: 'date-time', - nullable: true, - }, - account_id: { - type: 'string', - description: 'The account ID of the request', - example: '45355976281015164504', - nullable: true, - }, - project_id: { - type: 'string', - description: 'The project ID of the request', - example: 'dev-project-68574', - nullable: true, - }, - http_method: { - type: 'string', - description: 'The requested HTTP method', - example: 'get', - nullable: true, - }, - path: { - type: 'string', - description: 'The requested path', - example: '/unified/hris/employees', - nullable: true, - }, - url: { - type: 'string', - description: 'The requested URL', - example: 'https://api.stackone.com/unified/hris/employees?raw=false', - nullable: true, - }, - status: { - type: 'number', - description: 'The requests response status code', - example: 200, - nullable: true, - }, - duration: { - type: 'number', - description: 'The request duration in milliseconds', - example: 356, - nullable: true, - }, - success: { - type: 'boolean', - description: 'The request success flag', - example: true, - nullable: true, - }, - provider: { - type: 'string', - description: 'The requested provider', - example: 'planday', - nullable: true, - }, - service: { - type: 'string', - description: 'The requested service', - example: 'hris', - nullable: true, - }, - resource: { - type: 'string', - description: 'The requested resource', - example: 'employees', - nullable: true, - }, - child_resource: { - type: 'string', - description: 'The requested child resource', - example: 'time-off', - nullable: true, - }, - sub_resource: { - type: 'string', - description: 'The requested sub resource', - example: 'documents', - nullable: true, - }, - action: { - type: 'string', - description: 'The requested action', - example: 'download', - nullable: true, - }, - is_worker: { - type: 'boolean', - description: 'The asynchronous worker flag', - example: false, - nullable: true, - }, - source_ip: { - type: 'string', - description: 'The requests source IPV4 ip address', - example: '192.168.1.1', - nullable: true, - }, - id: { - type: 'string', - description: 'The provider request ID', - example: 'adbf752f-6457-4ddd-89b3-98ae2252b83b', - nullable: true, - }, - request: { - description: 'The advanced log request data', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/AdvancedLogRequestData', - }, - ], - }, - response: { - description: 'The advanced log response data', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/AdvancedLogResponseData', - }, - ], - }, - }, - }, - StepLogPartial: { - type: 'object', - properties: { - request_id: { - type: 'string', - description: 'The request ID', - example: 'adbf752f-6457-4ddd-89b3-98ae2252b83b', - nullable: true, - }, - start_time: { - type: 'string', - description: 'The request start time ISO8601 date string', - example: '2021-01-01T00:00:00Z', - format: 'date-time', - nullable: true, - }, - end_time: { - type: 'string', - description: 'The request end time ISO8601 date string', - example: '2021-01-01T00:00:00Z', - format: 'date-time', - nullable: true, - }, - account_id: { - type: 'string', - description: 'The account ID of the request', - example: '45355976281015164504', - nullable: true, - }, - project_id: { - type: 'string', - description: 'The project ID of the request', - example: 'dev-project-68574', - nullable: true, - }, - http_method: { - type: 'string', - description: 'The requested HTTP method', - example: 'get', - nullable: true, - }, - path: { - type: 'string', - description: 'The requested path', - example: '/unified/hris/employees', - nullable: true, - }, - url: { - type: 'string', - description: 'The requested URL', - example: 'https://api.stackone.com/unified/hris/employees?raw=false', - nullable: true, - }, - status: { - type: 'number', - description: 'The requests response status code', - example: 200, - nullable: true, - }, - duration: { - type: 'number', - description: 'The request duration in milliseconds', - example: 356, - nullable: true, - }, - success: { - type: 'boolean', - description: 'The request success flag', - example: true, - nullable: true, - }, - provider: { - type: 'string', - description: 'The requested provider', - example: 'planday', - nullable: true, - }, - service: { - type: 'string', - description: 'The requested service', - example: 'hris', - nullable: true, - }, - resource: { - type: 'string', - description: 'The requested resource', - example: 'employees', - nullable: true, - }, - child_resource: { - type: 'string', - description: 'The requested child resource', - example: 'time-off', - nullable: true, - }, - sub_resource: { - type: 'string', - description: 'The requested sub resource', - example: 'documents', - nullable: true, - }, - action: { - type: 'string', - description: 'The requested action', - example: 'download', - nullable: true, - }, - is_worker: { - type: 'boolean', - description: 'The asynchronous worker flag', - example: false, - nullable: true, - }, - id: { - type: 'string', - description: 'The provider request ID', - example: 'adbf752f-6457-4ddd-89b3-98ae2252b83b', - nullable: true, - }, - }, - }, - StepLogsPaginated: { - type: 'object', - properties: { - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/StepLogPartial', - }, - }, - }, - required: ['data'], - }, - TooManyRequestsResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 429, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Too many requests', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - UnauthorizedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 401, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Unauthorized', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - UnifiedError: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 400, - nullable: true, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Request', - nullable: true, - }, - headers: { - type: 'object', - description: 'Response headers', - example: { - 'content-type': 'application/json', - 'x-request-id': '5678c28b211dace4e0a0f9171e6b88c5', - }, - nullable: true, - }, - }, - }, - UnifiedLogResult: { - type: 'object', - properties: { - data: { - $ref: '#/components/schemas/UnifiedLogs', - }, - }, - required: ['data'], - }, - UnifiedLogs: { - type: 'object', - properties: { - request_id: { - type: 'string', - description: 'The request ID', - example: 'adbf752f-6457-4ddd-89b3-98ae2252b83b', - nullable: true, - }, - event_datetime: { - type: 'string', - description: 'The event ISO8601 date string', - example: '2021-01-01T00:00:00Z', - format: 'date-time', - nullable: true, - }, - start_time: { - type: 'string', - description: 'The request start time ISO8601 date string', - example: '2021-01-01T00:00:00Z', - format: 'date-time', - nullable: true, - }, - end_time: { - type: 'string', - description: 'The request end time ISO8601 date string', - example: '2021-01-01T00:00:00Z', - format: 'date-time', - nullable: true, - }, - account_id: { - type: 'string', - description: 'The account ID of the request', - example: '45355976281015164504', - nullable: true, - }, - project_id: { - type: 'string', - description: 'The project ID of the request', - example: 'dev-project-68574', - nullable: true, - }, - http_method: { - type: 'string', - description: 'The requested HTTP method', - example: 'get', - nullable: true, - }, - path: { - type: 'string', - description: 'The requested path', - example: '/unified/hris/employees', - nullable: true, - }, - url: { - type: 'string', - description: 'The requested URL', - example: 'https://api.stackone.com/unified/hris/employees?raw=false', - nullable: true, - }, - status: { - type: 'number', - description: 'The requests response status code', - example: 200, - nullable: true, - }, - duration: { - type: 'number', - description: 'The request duration in milliseconds', - example: 356, - nullable: true, - }, - success: { - type: 'boolean', - description: 'The request success flag', - example: true, - nullable: true, - }, - provider: { - type: 'string', - description: 'The requested provider', - example: 'planday', - nullable: true, - }, - service: { - type: 'string', - description: 'The requested service', - example: 'hris', - nullable: true, - }, - resource: { - type: 'string', - description: 'The requested resource', - example: 'employees', - nullable: true, - }, - child_resource: { - type: 'string', - description: 'The requested child resource', - example: 'time-off', - nullable: true, - }, - sub_resource: { - type: 'string', - description: 'The requested sub resource', - example: 'documents', - nullable: true, - }, - action: { - type: 'string', - description: 'The requested action', - example: 'download', - nullable: true, - }, - is_worker: { - type: 'boolean', - description: 'The asynchronous worker flag', - example: false, - nullable: true, - }, - source_type: { - type: 'string', - description: 'The requests source type', - example: 'DASHBOARD', - nullable: true, - }, - source_value: { - type: 'string', - description: 'The requests source value', - example: 'ACCOUNT_TESTER', - nullable: true, - }, - source_id: { - type: 'string', - description: 'The requests source ID', - example: '1234567890', - nullable: true, - }, - request: { - description: 'The advanced log request data', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/AdvancedLogRequestData', - }, - ], - }, - response: { - description: 'The advanced log response data', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/AdvancedLogResponseData', - }, - ], - }, - source_ip: { - type: 'string', - description: 'The requests source IPV4 ip address', - example: '192.168.1.1', - nullable: true, - }, - step_requests: { - type: 'array', - description: 'The list of provider requests', - items: { - $ref: '#/components/schemas/StepLog', - }, - nullable: true, - }, - }, - }, - UnifiedLogsPaginated: { - type: 'object', - properties: { - next: { - type: 'string', - nullable: true, - }, - data: { - type: 'array', - items: { - $ref: '#/components/schemas/UnifiedLogsPartial', - }, - }, - }, - required: ['data'], - }, - UnifiedLogsPartial: { - type: 'object', - properties: { - request_id: { - type: 'string', - description: 'The request ID', - example: 'adbf752f-6457-4ddd-89b3-98ae2252b83b', - nullable: true, - }, - event_datetime: { - type: 'string', - description: 'The event ISO8601 date string', - example: '2021-01-01T00:00:00Z', - format: 'date-time', - nullable: true, - }, - start_time: { - type: 'string', - description: 'The request start time ISO8601 date string', - example: '2021-01-01T00:00:00Z', - format: 'date-time', - nullable: true, - }, - end_time: { - type: 'string', - description: 'The request end time ISO8601 date string', - example: '2021-01-01T00:00:00Z', - format: 'date-time', - nullable: true, - }, - account_id: { - type: 'string', - description: 'The account ID of the request', - example: '45355976281015164504', - nullable: true, - }, - project_id: { - type: 'string', - description: 'The project ID of the request', - example: 'dev-project-68574', - nullable: true, - }, - http_method: { - type: 'string', - description: 'The requested HTTP method', - example: 'get', - nullable: true, - }, - path: { - type: 'string', - description: 'The requested path', - example: '/unified/hris/employees', - nullable: true, - }, - url: { - type: 'string', - description: 'The requested URL', - example: 'https://api.stackone.com/unified/hris/employees?raw=false', - nullable: true, - }, - status: { - type: 'number', - description: 'The requests response status code', - example: 200, - nullable: true, - }, - duration: { - type: 'number', - description: 'The request duration in milliseconds', - example: 356, - nullable: true, - }, - success: { - type: 'boolean', - description: 'The request success flag', - example: true, - nullable: true, - }, - provider: { - type: 'string', - description: 'The requested provider', - example: 'planday', - nullable: true, - }, - service: { - type: 'string', - description: 'The requested service', - example: 'hris', - nullable: true, - }, - resource: { - type: 'string', - description: 'The requested resource', - example: 'employees', - nullable: true, - }, - child_resource: { - type: 'string', - description: 'The requested child resource', - example: 'time-off', - nullable: true, - }, - sub_resource: { - type: 'string', - description: 'The requested sub resource', - example: 'documents', - nullable: true, - }, - action: { - type: 'string', - description: 'The requested action', - example: 'download', - nullable: true, - }, - is_worker: { - type: 'boolean', - description: 'The asynchronous worker flag', - example: false, - nullable: true, - }, - source_type: { - type: 'string', - description: 'The requests source type', - example: 'DASHBOARD', - nullable: true, - }, - source_value: { - type: 'string', - description: 'The requests source value', - example: 'ACCOUNT_TESTER', - nullable: true, - }, - source_id: { - type: 'string', - description: 'The requests source ID', - example: '1234567890', - nullable: true, - }, - source_ip: { - type: 'string', - description: 'The requests source IPV4 ip address', - example: '192.168.1.1', - nullable: true, - }, - step_requests: { - type: 'array', - description: 'The list of provider requests', - items: { - $ref: '#/components/schemas/StepLogPartial', - }, - nullable: true, - }, - }, - }, - UnprocessableEntityResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 422, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Unprocessable Entity', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - }, - }, -}; diff --git a/src/openapi/generated/ticketing.ts b/src/openapi/generated/ticketing.ts deleted file mode 100644 index c820f171..00000000 --- a/src/openapi/generated/ticketing.ts +++ /dev/null @@ -1,7794 +0,0 @@ -// Generated OpenAPI specification for ticketing -// DO NOT EDIT THIS FILE DIRECTLY -export const ticketingSpec = { - openapi: '3.1.0', - paths: { - '/unified/ticketing/tickets': { - get: { - description: 'Retrieve a paginated list of tickets.', - operationId: 'ticketing_list_tickets', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,type,ticket_number,title,creator_id,remote_creator_id,reporters,assignees,content,parent_id,remote_parent_id,closed_at,ticket_url,status,priority,tags,projects,components,organization,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of tickets was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TicketingTicketsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Tickets', - tags: ['Tickets'], - 'x-speakeasy-group': 'ticketing', - 'x-speakeasy-name-override': 'list_tickets', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - post: { - description: 'Create a new ticket record.', - operationId: 'ticketing_create_ticket', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TicketingTicketCreateRequestDto', - }, - }, - }, - }, - responses: { - '201': { - description: 'Record created successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/CreateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Create Ticket', - tags: ['Tickets'], - 'x-speakeasy-group': 'ticketing', - 'x-speakeasy-name-override': 'create_ticket', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ticketing/tickets/{id}': { - get: { - description: 'Retrieve a single ticket by its identifier.', - operationId: 'ticketing_get_ticket', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,type,ticket_number,title,creator_id,remote_creator_id,reporters,assignees,content,parent_id,remote_parent_id,closed_at,ticket_url,status,priority,tags,projects,components,organization,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The ticket with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TicketingTicketResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Ticket', - tags: ['Tickets'], - 'x-speakeasy-group': 'ticketing', - 'x-speakeasy-name-override': 'get_ticket', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - patch: { - description: 'Update an existing ticket record by its identifier.', - operationId: 'ticketing_update_ticket', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - ], - requestBody: { - required: true, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TicketingTicketUpdateRequestDto', - }, - }, - }, - }, - responses: { - '200': { - description: 'Record updated successfully.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UpdateResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Update Ticket', - tags: ['Tickets'], - 'x-speakeasy-group': 'ticketing', - 'x-speakeasy-name-override': 'update_ticket', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ticketing/users': { - get: { - description: 'Retrieve a paginated list of users.', - operationId: 'ticketing_list_users', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,type,name,primary_email,primary_phone,username,active,first_name,last_name,customer_account_reference,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of users was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TicketingUsersPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Users', - tags: ['Users'], - 'x-speakeasy-group': 'ticketing', - 'x-speakeasy-name-override': 'list_users', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ticketing/users/{id}': { - get: { - description: 'Retrieve a single user by their identifier.', - operationId: 'ticketing_get_user', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,type,name,primary_email,primary_phone,username,active,first_name,last_name,customer_account_reference,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The user with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TicketingUserResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get User', - tags: ['Users'], - 'x-speakeasy-group': 'ticketing', - 'x-speakeasy-name-override': 'get_user', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ticketing/tickets/{id}/comments': { - get: { - description: 'Retrieve a paginated list of comments for a ticket.', - operationId: 'ticketing_list_comments', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,ticket_id,remote_ticket_id,content,user_id,remote_user_id,internal,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of comments was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TicketingCommentsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Comments', - tags: ['Tickets', 'Comments'], - 'x-speakeasy-group': 'ticketing', - 'x-speakeasy-name-override': 'list_comments', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ticketing/tickets/{id}/comments/{subResourceId}': { - get: { - description: 'Retrieve a single comment by its identifier for a ticket.', - operationId: 'ticketing_get_comment', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,ticket_id,remote_ticket_id,content,user_id,remote_user_id,internal,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The comment with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TicketingCommentResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Comment', - tags: ['Tickets', 'Comments'], - 'x-speakeasy-group': 'ticketing', - 'x-speakeasy-name-override': 'get_comment', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ticketing/tickets/{id}/attachments/{subResourceId}/download': { - get: { - description: 'Download the attachment file from a ticket.', - operationId: 'ticketing_download_ticketing_attachment', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'format', - required: false, - in: 'query', - description: 'The format to download the file in', - schema: { - nullable: true, - example: 'base64', - type: 'string', - }, - }, - { - name: 'export_format', - required: false, - in: 'query', - description: 'The export format of the file', - schema: { - nullable: true, - example: 'text/plain', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: - 'The document related to the application with the given identifiers was retrieved.', - content: { - '*/*': { - schema: { - $ref: '#/components/schemas/DownloadApiModel', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Download Attachment', - tags: ['Tickets', 'Attachments'], - 'x-speakeasy-group': 'ticketing', - 'x-speakeasy-name-override': 'download_ticketing_attachment', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ticketing/tickets/{id}/attachments': { - get: { - description: 'Retrieve a paginated list of attachment details for a ticket.', - operationId: 'ticketing_list_attachments', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,ticket_id,remote_ticket_id,user_id,remote_user_id,file_name,file_format,file_url,size,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of attachments was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TicketingAttachmentsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Attachments', - tags: ['Tickets', 'Attachments'], - 'x-speakeasy-group': 'ticketing', - 'x-speakeasy-name-override': 'list_attachments', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ticketing/tickets/{id}/attachments/{subResourceId}': { - get: { - description: 'Retrieve the details of a single attachment for a ticket.', - operationId: 'ticketing_get_attachment', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,ticket_id,remote_ticket_id,user_id,remote_user_id,file_name,file_format,file_url,size,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The attachment with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TicketingAttachmentResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Attachment', - tags: ['Tickets', 'Attachments'], - 'x-speakeasy-group': 'ticketing', - 'x-speakeasy-name-override': 'get_attachment', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ticketing/ticket_types': { - get: { - description: 'Retrieve a paginated list of all ticket types.', - operationId: 'ticketing_list_ticket_types', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,project_id,remote_project_id,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of ticket types was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TicketingTicketTypePaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Ticket Types', - tags: ['Ticket Types'], - 'x-speakeasy-group': 'ticketing', - 'x-speakeasy-name-override': 'list_ticket_types', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ticketing/ticket_types/{id}': { - get: { - description: 'Retrieve a single ticket type by its identifier.', - operationId: 'ticketing_get_ticket_type', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,project_id,remote_project_id,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The ticket type with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TicketingTicketTypeResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Ticket Type', - tags: ['Ticket Types'], - 'x-speakeasy-group': 'ticketing', - 'x-speakeasy-name-override': 'get_ticket_type', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ticketing/projects': { - get: { - description: 'Retrieve a paginated list of projects.', - operationId: 'ticketing_list_projects', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,organization_id,remote_organization_id,name,description,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of projects was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TicketingProjectsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Projects', - tags: ['Projects'], - 'x-speakeasy-group': 'ticketing', - 'x-speakeasy-name-override': 'list_projects', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ticketing/projects/{id}': { - get: { - description: 'Retrieve a single project by its identifier.', - operationId: 'ticketing_get_project', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,organization_id,remote_organization_id,name,description,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The project with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TicketingProjectResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Project', - tags: ['Projects'], - 'x-speakeasy-group': 'ticketing', - 'x-speakeasy-name-override': 'get_project', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ticketing/projects/{id}/components': { - get: { - description: 'Retrieve a paginated list of project components.', - operationId: 'ticketing_list_project_components', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,organization_id,remote_organization_id,project_id,remote_project_id,name,description,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of project components was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TicketingComponentsPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Project Components', - tags: ['Projects', 'Components'], - 'x-speakeasy-group': 'ticketing', - 'x-speakeasy-name-override': 'list_project_components', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ticketing/projects/{id}/components/{subResourceId}': { - get: { - description: 'Retrieve a single project component by its identifier.', - operationId: 'ticketing_get_project_component', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'subResourceId', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: - 'id,remote_id,organization_id,remote_organization_id,project_id,remote_project_id,name,description,created_at,updated_at,unified_custom_fields', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The project component with the given identifier was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TicketingComponentResult', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'Get Project Component', - tags: ['Projects', 'Components'], - 'x-speakeasy-group': 'ticketing', - 'x-speakeasy-name-override': 'get_project_component', - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ticketing/projects/{id}/ticket_types': { - get: { - description: 'Retrieve a paginated list of ticket types for a project.', - operationId: 'ticketing_list_project_ticket_types', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields that will be returned in the response (if empty, all fields are returned)', - schema: { - nullable: true, - example: 'id,remote_id,name,project_id,remote_project_id,unified_custom_fields', - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of project ticket types was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TicketingTicketTypePaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Project Ticket Types', - tags: ['Projects', 'Ticket Types'], - 'x-speakeasy-group': 'ticketing', - 'x-speakeasy-name-override': 'list_project_ticket_types', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - '/unified/ticketing/tickets/{id}/statuses': { - get: { - description: 'Retrieve a paginated list of statuses for a ticket.', - operationId: 'ticketing_list_ticket_statuses', - parameters: [ - { - name: 'x-account-id', - in: 'header', - description: 'The account identifier', - required: true, - schema: { - type: 'string', - }, - }, - { - name: 'id', - required: true, - in: 'path', - schema: { - type: 'string', - }, - }, - { - name: 'raw', - required: false, - in: 'query', - description: - 'Indicates that the raw request result should be returned in addition to the mapped result (default value is false)', - schema: { - nullable: true, - type: 'boolean', - }, - }, - { - name: 'proxy', - required: false, - in: 'query', - description: - "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - style: 'deepObject', - explode: true, - schema: { - additionalProperties: true, - nullable: true, - type: 'object', - }, - }, - { - name: 'fields', - required: false, - in: 'query', - description: - 'The comma separated list of fields to return in the response (if empty, all fields are returned)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'filter', - required: false, - in: 'query', - description: 'Filter parameters that allow greater customisation of the list response', - explode: true, - style: 'deepObject', - schema: { - properties: { - updated_after: { - description: - 'Use a string with a date to only select results updated after that given date', - example: '2020-01-01T00:00:00.000Z', - type: 'string', - format: 'date-time', - nullable: true, - additionalProperties: false, - }, - }, - nullable: true, - type: 'object', - }, - }, - { - name: 'page', - required: false, - in: 'query', - description: 'The page number of the results to fetch', - deprecated: true, - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'page_size', - required: false, - in: 'query', - description: 'The number of results per page (default value is 25)', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'next', - required: false, - in: 'query', - description: 'The unified cursor', - schema: { - nullable: true, - type: 'string', - }, - }, - { - name: 'updated_after', - required: false, - in: 'query', - description: - 'Use a string with a date to only select results updated after that given date', - deprecated: true, - schema: { - format: 'date-time', - nullable: true, - example: '2020-01-01T00:00:00.000Z', - type: 'string', - }, - }, - ], - responses: { - '200': { - description: 'The list of ticket statuses was retrieved.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TicketingTicketStatusesPaginated', - }, - }, - }, - }, - '400': { - description: 'Invalid request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadRequestResponse', - }, - }, - }, - }, - '401': { - description: 'Unauthorized access.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnauthorizedResponse', - }, - }, - }, - }, - '403': { - description: 'Forbidden.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ForbiddenResponse', - }, - }, - }, - }, - '404': { - description: 'Resource not found.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotFoundResponse', - }, - }, - }, - }, - '408': { - description: 'The request has timed out.', - headers: { - 'Retry-After': { - description: 'A time in seconds after which the request can be retried.', - schema: { - type: 'string', - }, - }, - }, - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/RequestTimedOutResponse', - }, - }, - }, - }, - '409': { - description: 'Conflict with current state.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/ConflictResponse', - }, - }, - }, - }, - '412': { - description: 'Precondition failed: linked account belongs to a disabled integration.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/PreconditionFailedResponse', - }, - }, - }, - }, - '422': { - description: 'Validation error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/UnprocessableEntityResponse', - }, - }, - }, - }, - '429': { - description: 'Too many requests.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/TooManyRequestsResponse', - }, - }, - }, - }, - '500': { - description: 'Server error while executing the request.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/InternalServerErrorResponse', - }, - }, - }, - }, - '501': { - description: 'This functionality is not implemented.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/NotImplementedResponse', - }, - }, - }, - }, - '502': { - description: 'Bad gateway error.', - content: { - 'application/json': { - schema: { - $ref: '#/components/schemas/BadGatewayResponse', - }, - }, - }, - }, - }, - security: [ - { - basic: [], - }, - ], - summary: 'List Ticket Statuses', - tags: ['Tickets', 'Ticket Statuses'], - 'x-speakeasy-group': 'ticketing', - 'x-speakeasy-name-override': 'list_ticket_statuses', - 'x-speakeasy-pagination': { - type: 'cursor', - inputs: [ - { - name: 'next', - in: 'parameters', - type: 'cursor', - }, - ], - outputs: { - nextCursor: '$.next', - }, - }, - 'x-speakeasy-retries': { - statusCodes: [429, 408], - strategy: 'backoff', - }, - }, - }, - }, - info: { - title: 'Ticketing', - description: 'The documentation for the StackOne Unified API - TICKETING', - version: '1.0.0', - contact: {}, - }, - tags: [ - { - name: 'Tickets', - description: 'Requests for support, assistance, or resolution.', - }, - { - name: 'Users', - description: 'Accounts that can create or work on tickets.', - }, - { - name: 'Comments', - description: 'Notes or messages added to tickets.', - }, - { - name: 'Attachments', - description: 'Files attached to tickets.', - }, - { - name: 'Ticket Types', - description: 'Types or categories of tickets.', - }, - { - name: 'Collections', - description: 'Groupings in which related tickets can be classified under.', - }, - { - name: 'Projects', - description: 'The top level grouping of tickets.', - }, - { - name: 'Components', - description: - 'A sub grouping under projects in which related tickets can be classified together.', - }, - { - name: 'Ticket Statuses', - description: 'Statuses representing ticket progress.', - }, - ], - servers: [ - { - url: 'https://api.stackone.com', - }, - ], - components: { - securitySchemes: { - basic: { - type: 'http', - scheme: 'basic', - }, - }, - schemas: { - BadGatewayResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 502, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Gateway', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - BadRequestResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 400, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Request', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - data: { - description: 'Error details', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/UnifiedError', - }, - ], - }, - provider_errors: { - description: 'List of provider-specific errors', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/ProviderError', - }, - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - ConflictResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 409, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Conflict', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - CreateResult: { - type: 'object', - properties: { - statusCode: { - type: 'number', - example: 201, - }, - message: { - type: 'string', - example: 'Record created successfully.', - }, - timestamp: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - }, - data: { - $ref: '#/components/schemas/CreateResultDataApiModel', - }, - }, - required: ['statusCode', 'message', 'timestamp', 'data'], - }, - CreateResultDataApiModel: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - }, - }, - DownloadApiModel: { - type: 'object', - properties: { - headers: { - description: 'Headers related to the download', - allOf: [ - { - $ref: '#/components/schemas/DownloadHeadersApiModel', - }, - ], - }, - data: { - type: 'string', - description: 'The file data in binary format', - format: 'binary', - }, - }, - required: ['headers', 'data'], - }, - DownloadHeadersApiModel: { - type: 'object', - properties: { - 'content-disposition': { - type: 'string', - description: 'Value of the Content-Disposition header', - example: 'attachment; filename="example.pdf"', - nullable: true, - }, - 'content-type': { - type: 'string', - description: 'MIME type of the file', - example: 'application/pdf', - nullable: true, - }, - 'content-length': { - type: 'number', - description: 'Size of the content in bytes', - example: 1024, - nullable: true, - }, - 'content-range': { - type: 'string', - description: 'Range of the content being sent', - example: 'bytes 0-1023/2048', - nullable: true, - }, - 'content-encoding': { - type: 'string', - description: 'Encoding of the content', - example: 'gzip', - nullable: true, - }, - 'transfer-encoding': { - type: 'string', - description: 'Transfer encoding type', - example: 'chunked', - nullable: true, - }, - }, - }, - FileFormatEnum: { - type: 'object', - properties: { - value: { - type: 'string', - description: 'The file format of the file, expressed as a file extension', - enum: [ - 'unmapped_value', - 'ez', - 'aw', - 'atom', - 'atomcat', - 'atomdeleted', - 'atomsvc', - 'dwd', - 'held', - 'rsat', - 'bdoc', - 'xcs', - 'ccxml', - 'cdfx', - 'cdmia', - 'cdmic', - 'cdmid', - 'cdmio', - 'cdmiq', - 'cu', - 'mpd', - 'davmount', - 'dbk', - 'dssc', - 'xdssc', - 'es', - 'ecma', - 'emma', - 'emotionml', - 'epub', - 'exi', - 'exp', - 'fdt', - 'pfr', - 'geojson', - 'gml', - 'gpx', - 'gxf', - 'gz', - 'hjson', - 'stk', - 'ink', - 'inkml', - 'ipfix', - 'its', - 'jar', - 'war', - 'ear', - 'ser', - 'class', - 'js', - 'mjs', - 'json', - 'map', - 'json5', - 'jsonml', - 'jsonld', - 'lgr', - 'lostxml', - 'hqx', - 'cpt', - 'mads', - 'webmanifest', - 'mrc', - 'mrcx', - 'ma', - 'nb', - 'mb', - 'mathml', - 'mbox', - 'mscml', - 'metalink', - 'meta4', - 'mets', - 'maei', - 'musd', - 'mods', - 'm21', - 'mp21', - 'mp4s', - 'm4p', - 'doc', - 'dot', - 'mxf', - 'nq', - 'nt', - 'cjs', - 'bin', - 'dms', - 'lrf', - 'mar', - 'so', - 'dist', - 'distz', - 'pkg', - 'bpk', - 'dump', - 'elc', - 'deploy', - 'exe', - 'dll', - 'deb', - 'dmg', - 'iso', - 'img', - 'msi', - 'msp', - 'msm', - 'buffer', - 'oda', - 'opf', - 'ogx', - 'omdoc', - 'onetoc', - 'onetoc2', - 'onetmp', - 'onepkg', - 'oxps', - 'relo', - 'xer', - 'pdf', - 'pgp', - 'asc', - 'sig', - 'prf', - 'p10', - 'p7m', - 'p7c', - 'p7s', - 'p8', - 'ac', - 'cer', - 'crl', - 'pkipath', - 'pki', - 'pls', - 'ai', - 'eps', - 'ps', - 'provx', - 'pskcxml', - 'raml', - 'rdf', - 'owl', - 'rif', - 'rnc', - 'rl', - 'rld', - 'rs', - 'rapd', - 'sls', - 'rusd', - 'gbr', - 'mft', - 'roa', - 'rsd', - 'rss', - 'rtf', - 'sbml', - 'scq', - 'scs', - 'spq', - 'spp', - 'sdp', - 'senmlx', - 'sensmlx', - 'setpay', - 'setreg', - 'shf', - 'siv', - 'sieve', - 'smi', - 'smil', - 'rq', - 'srx', - 'gram', - 'grxml', - 'sru', - 'ssdl', - 'ssml', - 'swidtag', - 'tei', - 'teicorpus', - 'tfi', - 'tsd', - 'toml', - 'trig', - 'ttml', - 'ubj', - 'rsheet', - 'td', - 'vxml', - 'wasm', - 'wgt', - 'hlp', - 'wsdl', - 'wspolicy', - 'xaml', - 'xav', - 'xca', - 'xdf', - 'xel', - 'xns', - 'xenc', - 'xhtml', - 'xht', - 'xlf', - 'xml', - 'xsl', - 'xsd', - 'rng', - 'dtd', - 'xop', - 'xpl', - '*xsl', - 'xslt', - 'xspf', - 'mxml', - 'xhvml', - 'xvml', - 'xvm', - 'yang', - 'yin', - 'zip', - '*3gpp', - 'adp', - 'amr', - 'au', - 'snd', - 'mid', - 'midi', - 'kar', - 'rmi', - 'mxmf', - '*mp3', - 'm4a', - 'mp4a', - 'mpga', - 'mp2', - 'mp2a', - 'mp3', - 'm2a', - 'm3a', - 'oga', - 'ogg', - 'spx', - 'opus', - 's3m', - 'sil', - 'wav', - '*wav', - 'weba', - 'xm', - 'ttc', - 'otf', - 'ttf', - 'woff', - 'woff2', - 'exr', - 'apng', - 'avif', - 'bmp', - 'cgm', - 'drle', - 'emf', - 'fits', - 'g3', - 'gif', - 'heic', - 'heics', - 'heif', - 'heifs', - 'hej2', - 'hsj2', - 'ief', - 'jls', - 'jp2', - 'jpg2', - 'jpeg', - 'jpg', - 'jpe', - 'jph', - 'jhc', - 'jpm', - 'jpx', - 'jpf', - 'jxr', - 'jxra', - 'jxrs', - 'jxs', - 'jxsc', - 'jxsi', - 'jxss', - 'ktx', - 'ktx2', - 'png', - 'sgi', - 'svg', - 'svgz', - 't38', - 'tif', - 'tiff', - 'tfx', - 'webp', - 'wmf', - 'disposition-notification', - 'u8msg', - 'u8dsn', - 'u8mdn', - 'u8hdr', - 'eml', - 'mime', - '3mf', - 'gltf', - 'glb', - 'igs', - 'iges', - 'msh', - 'mesh', - 'silo', - 'mtl', - 'obj', - 'stpx', - 'stpz', - 'stpxz', - 'stl', - 'wrl', - 'vrml', - '*x3db', - 'x3dbz', - 'x3db', - '*x3dv', - 'x3dvz', - 'x3d', - 'x3dz', - 'x3dv', - 'appcache', - 'manifest', - 'ics', - 'ifb', - 'coffee', - 'litcoffee', - 'css', - 'csv', - 'html', - 'htm', - 'shtml', - 'jade', - 'jsx', - 'less', - 'markdown', - 'md', - 'mml', - 'mdx', - 'n3', - 'txt', - 'text', - 'conf', - 'def', - 'list', - 'log', - 'in', - 'ini', - 'rtx', - '*rtf', - 'sgml', - 'sgm', - 'shex', - 'slim', - 'slm', - 'spdx', - 'stylus', - 'styl', - 'tsv', - 't', - 'tr', - 'roff', - 'man', - 'me', - 'ms', - 'ttl', - 'uri', - 'uris', - 'urls', - 'vcard', - 'vtt', - '*xml', - 'yaml', - 'yml', - '3gp', - '3gpp', - '3g2', - 'h261', - 'h263', - 'h264', - 'm4s', - 'jpgv', - '*jpm', - 'jpgm', - 'mj2', - 'mjp2', - 'ts', - 'mp4', - 'mp4v', - 'mpg4', - 'mpeg', - 'mpg', - 'mpe', - 'm1v', - 'm2v', - 'ogv', - 'qt', - 'mov', - 'webm', - 'cww', - '1km', - 'plb', - 'psb', - 'pvb', - 'tcap', - 'pwn', - 'aso', - 'imp', - 'acu', - 'atc', - 'acutc', - 'air', - 'fcdt', - 'fxp', - 'fxpl', - 'xdp', - 'xfdf', - 'ahead', - 'azf', - 'azs', - 'azw', - 'acc', - 'ami', - 'apk', - 'cii', - 'fti', - 'atx', - 'mpkg', - 'key', - 'm3u8', - 'numbers', - 'pages', - 'pkpass', - 'swi', - 'iota', - 'aep', - 'bmml', - 'mpm', - 'bmi', - 'rep', - 'cdxml', - 'mmd', - 'cdy', - 'csl', - 'cla', - 'rp9', - 'c4g', - 'c4d', - 'c4f', - 'c4p', - 'c4u', - 'c11amc', - 'c11amz', - 'csp', - 'cdbcmsg', - 'cmc', - 'clkx', - 'clkk', - 'clkp', - 'clkt', - 'clkw', - 'wbs', - 'pml', - 'ppd', - 'car', - 'pcurl', - 'dart', - 'rdz', - 'dbf', - 'uvf', - 'uvvf', - 'uvd', - 'uvvd', - 'uvt', - 'uvvt', - 'uvx', - 'uvvx', - 'uvz', - 'uvvz', - 'fe_launch', - 'dna', - 'mlp', - 'mle', - 'dpg', - 'dfac', - 'kpxx', - 'ait', - 'svc', - 'geo', - 'mag', - 'nml', - 'esf', - 'msf', - 'qam', - 'slt', - 'ssf', - 'es3', - 'et3', - 'ez2', - 'ez3', - 'fdf', - 'mseed', - 'seed', - 'dataless', - 'gph', - 'ftc', - 'fm', - 'frame', - 'maker', - 'book', - 'fnc', - 'ltf', - 'fsc', - 'oas', - 'oa2', - 'oa3', - 'fg5', - 'bh2', - 'ddd', - 'xdw', - 'xbd', - 'fzs', - 'txd', - 'ggb', - 'ggt', - 'gex', - 'gre', - 'gxt', - 'g2w', - 'g3w', - 'gmx', - 'gdoc', - 'gslides', - 'gsheet', - 'kml', - 'kmz', - 'gqf', - 'gqs', - 'gac', - 'ghf', - 'gim', - 'grv', - 'gtm', - 'tpl', - 'vcg', - 'hal', - 'zmm', - 'hbci', - 'les', - 'hpgl', - 'hpid', - 'hps', - 'jlt', - 'pcl', - 'pclxl', - 'sfd-hdstx', - 'mpy', - 'afp', - 'listafp', - 'list3820', - 'irm', - 'sc', - 'icc', - 'icm', - 'igl', - 'ivp', - 'ivu', - 'igm', - 'xpw', - 'xpx', - 'i2g', - 'qbo', - 'qfx', - 'rcprofile', - 'irp', - 'xpr', - 'fcs', - 'jam', - 'rms', - 'jisp', - 'joda', - 'ktz', - 'ktr', - 'karbon', - 'chrt', - 'kfo', - 'flw', - 'kon', - 'kpr', - 'kpt', - 'ksp', - 'kwd', - 'kwt', - 'htke', - 'kia', - 'kne', - 'knp', - 'skp', - 'skd', - 'skt', - 'skm', - 'sse', - 'lasxml', - 'lbd', - 'lbe', - 'apr', - 'pre', - 'nsf', - 'org', - 'scm', - 'lwp', - 'portpkg', - 'mvt', - 'mcd', - 'mc1', - 'cdkey', - 'mwf', - 'mfm', - 'flo', - 'igx', - 'mif', - 'daf', - 'dis', - 'mbk', - 'mqy', - 'msl', - 'plc', - 'txf', - 'mpn', - 'mpc', - 'xul', - 'cil', - 'cab', - 'xls', - 'xlm', - 'xla', - 'xlc', - 'xlt', - 'xlw', - 'xlam', - 'xlsb', - 'xlsm', - 'xltm', - 'eot', - 'chm', - 'ims', - 'lrm', - 'thmx', - 'msg', - 'cat', - '*stl', - 'ppt', - 'pps', - 'pot', - 'ppam', - 'pptm', - 'sldm', - 'ppsm', - 'potm', - 'mpp', - 'mpt', - 'docm', - 'dotm', - 'wps', - 'wks', - 'wcm', - 'wdb', - 'wpl', - 'xps', - 'mseq', - 'mus', - 'msty', - 'taglet', - 'nlu', - 'ntf', - 'nitf', - 'nnd', - 'nns', - 'nnw', - '*ac', - 'ngdat', - 'n-gage', - 'rpst', - 'rpss', - 'edm', - 'edx', - 'ext', - 'odc', - 'otc', - 'odb', - 'odf', - 'odft', - 'odg', - 'otg', - 'odi', - 'oti', - 'odp', - 'otp', - 'ods', - 'ots', - 'odt', - 'odm', - 'ott', - 'oth', - 'xo', - 'dd2', - 'obgx', - 'oxt', - 'osm', - 'pptx', - 'sldx', - 'ppsx', - 'potx', - 'xlsx', - 'xltx', - 'docx', - 'dotx', - 'mgp', - 'dp', - 'esa', - 'pdb', - 'pqa', - 'oprc', - 'paw', - 'str', - 'ei6', - 'efif', - 'wg', - 'plf', - 'pbd', - 'box', - 'mgz', - 'qps', - 'ptid', - 'qxd', - 'qxt', - 'qwd', - 'qwt', - 'qxl', - 'qxb', - 'rar', - 'bed', - 'mxl', - 'musicxml', - 'cryptonote', - 'cod', - 'rm', - 'rmvb', - 'link66', - 'st', - 'see', - 'sema', - 'semd', - 'semf', - 'ifm', - 'itp', - 'iif', - 'ipk', - 'twd', - 'twds', - 'mmf', - 'teacher', - 'fo', - 'sdkm', - 'sdkd', - 'dxp', - 'sfs', - 'sdc', - 'sda', - 'sdd', - 'smf', - 'sdw', - 'vor', - 'sgl', - 'smzip', - 'sm', - 'wadl', - 'sxc', - 'stc', - 'sxd', - 'std', - 'sxi', - 'sti', - 'sxm', - 'sxw', - 'sxg', - 'stw', - 'sus', - 'susp', - 'svd', - 'sis', - 'sisx', - 'xsm', - 'bdm', - 'xdm', - 'ddf', - 'tao', - 'pcap', - 'cap', - 'dmp', - 'tmo', - 'tpt', - 'mxs', - 'tra', - 'ufd', - 'ufdl', - 'utz', - 'umj', - 'unityweb', - 'uoml', - 'vcx', - 'vsd', - 'vst', - 'vss', - 'vsw', - 'vis', - 'vsf', - 'wbxml', - 'wmlc', - 'wmlsc', - 'wtb', - 'nbp', - 'wpd', - 'wqd', - 'stf', - 'xar', - 'xfdl', - 'hvd', - 'hvs', - 'hvp', - 'osf', - 'osfpvg', - 'saf', - 'spf', - 'cmp', - 'zir', - 'zirz', - 'zaz', - '7z', - 'abw', - 'ace', - '*dmg', - 'arj', - 'aab', - 'x32', - 'u32', - 'vox', - 'aam', - 'aas', - 'bcpio', - '*bdoc', - 'torrent', - 'blb', - 'blorb', - 'bz', - 'bz2', - 'boz', - 'cbr', - 'cba', - 'cbt', - 'cbz', - 'cb7', - 'vcd', - 'cfs', - 'chat', - 'pgn', - 'crx', - 'cco', - 'nsc', - 'cpio', - 'csh', - '*deb', - 'udeb', - 'dgc', - 'dir', - 'dcr', - 'dxr', - 'cst', - 'cct', - 'cxt', - 'w3d', - 'fgd', - 'swa', - 'wad', - 'ncx', - 'dtb', - 'res', - 'dvi', - 'evy', - 'eva', - 'bdf', - 'gsf', - 'psf', - 'pcf', - 'snf', - 'pfa', - 'pfb', - 'pfm', - 'afm', - 'arc', - 'spl', - 'gca', - 'ulx', - 'gnumeric', - 'gramps', - 'gtar', - 'hdf', - 'php', - 'install', - '*iso', - '*key', - '*numbers', - '*pages', - 'jardiff', - 'jnlp', - 'kdbx', - 'latex', - 'luac', - 'lzh', - 'lha', - 'run', - 'mie', - 'prc', - 'mobi', - 'application', - 'lnk', - 'wmd', - 'wmz', - 'xbap', - 'mdb', - 'obd', - 'crd', - 'clp', - '*exe', - '*dll', - 'com', - 'bat', - '*msi', - 'mvb', - 'm13', - 'm14', - '*wmf', - '*wmz', - '*emf', - 'emz', - 'mny', - 'pub', - 'scd', - 'trm', - 'wri', - 'nc', - 'cdf', - 'pac', - 'nzb', - 'pl', - 'pm', - '*prc', - '*pdb', - 'p12', - 'pfx', - 'p7b', - 'spc', - 'p7r', - '*rar', - 'rpm', - 'ris', - 'sea', - 'sh', - 'shar', - 'swf', - 'xap', - 'sql', - 'sit', - 'sitx', - 'srt', - 'sv4cpio', - 'sv4crc', - 't3', - 'gam', - 'tar', - 'tcl', - 'tk', - 'tex', - 'tfm', - 'texinfo', - 'texi', - '*obj', - 'ustar', - 'hdd', - 'ova', - 'ovf', - 'vbox', - 'vbox-extpack', - 'vdi', - 'vhd', - 'vmdk', - 'src', - 'webapp', - 'der', - 'crt', - 'pem', - 'fig', - '*xlf', - 'xpi', - 'xz', - 'z1', - 'z2', - 'z3', - 'z4', - 'z5', - 'z6', - 'z7', - 'z8', - 'uva', - 'uvva', - 'eol', - 'dra', - 'dts', - 'dtshd', - 'lvp', - 'pya', - 'ecelp4800', - 'ecelp7470', - 'ecelp9600', - 'rip', - 'aac', - 'aif', - 'aiff', - 'aifc', - 'caf', - 'flac', - '*m4a', - 'mka', - 'm3u', - 'wax', - 'wma', - 'ram', - 'ra', - 'rmp', - '*ra', - 'cdx', - 'cif', - 'cmdf', - 'cml', - 'csml', - 'xyz', - 'btif', - 'pti', - 'psd', - 'azv', - 'uvi', - 'uvvi', - 'uvg', - 'uvvg', - 'djvu', - 'djv', - '*sub', - 'dwg', - 'dxf', - 'fbs', - 'fpx', - 'fst', - 'mmr', - 'rlc', - 'ico', - 'dds', - 'mdi', - 'wdp', - 'npx', - 'b16', - 'tap', - 'vtf', - 'wbmp', - 'xif', - 'pcx', - '3ds', - 'ras', - 'cmx', - 'fh', - 'fhc', - 'fh4', - 'fh5', - 'fh7', - '*ico', - 'jng', - 'sid', - '*bmp', - '*pcx', - 'pic', - 'pct', - 'pnm', - 'pbm', - 'pgm', - 'ppm', - 'rgb', - 'tga', - 'xbm', - 'xpm', - 'xwd', - 'wsc', - 'dae', - 'dwf', - 'gdl', - 'gtw', - 'mts', - 'ogex', - 'x_b', - 'x_t', - 'vds', - 'usdz', - 'bsp', - 'vtu', - 'dsc', - 'curl', - 'dcurl', - 'mcurl', - 'scurl', - 'sub', - 'fly', - 'flx', - 'gv', - '3dml', - 'spot', - 'jad', - 'wml', - 'wmls', - 's', - 'asm', - 'c', - 'cc', - 'cxx', - 'cpp', - 'h', - 'hh', - 'dic', - 'htc', - 'f', - 'for', - 'f77', - 'f90', - 'hbs', - 'java', - 'lua', - 'mkd', - 'nfo', - 'opml', - '*org', - 'p', - 'pas', - 'pde', - 'sass', - 'scss', - 'etx', - 'sfv', - 'ymp', - 'uu', - 'vcs', - 'vcf', - 'uvh', - 'uvvh', - 'uvm', - 'uvvm', - 'uvp', - 'uvvp', - 'uvs', - 'uvvs', - 'uvv', - 'uvvv', - 'dvb', - 'fvt', - 'mxu', - 'm4u', - 'pyv', - 'uvu', - 'uvvu', - 'viv', - 'f4v', - 'fli', - 'flv', - 'm4v', - 'mkv', - 'mk3d', - 'mks', - 'mng', - 'asf', - 'asx', - 'vob', - 'wm', - 'wmv', - 'wmx', - 'wvx', - 'avi', - 'movie', - 'smv', - 'ice', - 'mht', - null, - ], - example: 'pdf', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - example: 'application/pdf', - nullable: true, - }, - }, - }, - ForbiddenResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 403, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Forbidden resource', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - InternalServerErrorResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 500, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Internal server error', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - NotFoundResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 404, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Not Found', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - NotImplementedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 501, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Not Implemented', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - PreconditionFailedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 412, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Precondition failed', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - ProviderError: { - type: 'object', - properties: { - status: { - type: 'number', - description: 'HTTP status code of the provider error', - example: 400, - nullable: true, - }, - url: { - type: 'string', - description: 'URL that caused the error', - example: 'https://api.provider.com/v1/resource', - nullable: true, - }, - raw: { - type: 'object', - description: 'Raw error response from the provider', - example: { - message: 'Invalid input parameters', - }, - nullable: true, - }, - headers: { - type: 'object', - description: 'Response headers', - example: { - 'content-type': 'application/json', - 'x-request-id': '5678c28b211dace4e0a0f9171e6b88c5', - }, - nullable: true, - }, - }, - }, - RawResponse: { - type: 'object', - properties: { - method: { - type: 'string', - }, - url: { - type: 'string', - }, - body: { - oneOf: [ - { - type: 'string', - }, - { - type: 'object', - }, - { - type: 'array', - items: { - type: 'integer', - format: 'int32', - minimum: 0, - maximum: 255, - }, - }, - ], - additionalProperties: true, - nullable: true, - }, - response: { - oneOf: [ - { - type: 'object', - additionalProperties: true, - }, - { - type: 'array', - items: {}, - }, - { - type: 'string', - }, - ], - nullable: true, - }, - }, - required: ['method', 'url'], - }, - RequestTimedOutResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 408, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Request timed out', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - TicketingAttachment: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - ticket_id: { - type: 'string', - example: 'ticket-001', - description: 'The reference ticket ID the attachment belongs to', - nullable: true, - }, - user_id: { - type: 'string', - description: 'The user who uploaded the file', - example: 'user-001', - nullable: true, - }, - file_name: { - type: 'string', - description: 'The name of the file', - example: 'file.pdf', - nullable: true, - }, - file_format: { - description: 'The type of the file', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/FileFormatEnum', - }, - ], - }, - file_url: { - type: 'string', - description: 'The resource URL of the file', - example: 'https://example.com/files/screenshot.png', - nullable: true, - }, - size: { - type: 'number', - description: 'The size of the file', - example: 1024, - nullable: true, - }, - created_at: { - type: 'string', - description: 'The timestamp when the record was created', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The timestamp when the record was last updated', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - TicketingAttachmentResult: { - type: 'object', - properties: { - data: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TicketingAttachment', - }, - ], - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - }, - TicketingAttachmentsPaginated: { - type: 'object', - properties: { - next: { - type: 'string', - nullable: true, - }, - data: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/TicketingAttachment', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - }, - TicketingComment: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - ticket_id: { - type: 'string', - description: 'The ticket ID associated with the comment', - example: 'ticket-001', - }, - user_id: { - type: 'string', - description: 'The user who created the comment', - example: 'user-001', - nullable: true, - }, - internal: { - description: 'Whether the comment is internal', - example: false, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - content: { - description: 'Array of content associated with the comment', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/TicketingContent', - }, - }, - created_at: { - type: 'string', - description: 'The timestamp when the record was created', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The timestamp when the record was last updated', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - }, - required: ['ticket_id'], - }, - TicketingCommentResult: { - type: 'object', - properties: { - data: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TicketingComment', - }, - ], - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - }, - TicketingCommentsPaginated: { - type: 'object', - properties: { - next: { - type: 'string', - nullable: true, - }, - data: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/TicketingComment', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - }, - TicketingComponent: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - organization_id: { - type: 'string', - description: 'The organization id related to the component', - example: 'organization-001', - nullable: true, - }, - project_id: { - type: 'string', - description: 'The project id related to the component', - example: 'project-001', - nullable: true, - }, - name: { - type: 'string', - description: 'The name of the component', - example: 'Component Falcon', - nullable: true, - }, - description: { - type: 'string', - description: 'The description of the component', - example: 'Description of the component', - nullable: true, - }, - created_at: { - type: 'string', - description: 'The timestamp when the record was created', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The timestamp when the record was last updated', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - TicketingComponentResult: { - type: 'object', - properties: { - data: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TicketingComponent', - }, - ], - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - }, - TicketingComponentsPaginated: { - type: 'object', - properties: { - next: { - type: 'string', - nullable: true, - }, - data: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/TicketingComponent', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - }, - TicketingContent: { - type: 'object', - properties: { - plain: { - type: 'string', - description: 'The content of the ticket', - example: 'This is some content', - nullable: true, - }, - html: { - type: 'string', - description: 'The HTML content of the ticket', - example: '

This is some content

', - nullable: true, - }, - }, - }, - TicketingOrganization: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - domain: { - type: 'string', - description: 'The domain of the organization', - example: 'company.com', - nullable: true, - }, - name: { - type: 'string', - description: 'The name of the organization', - example: 'Company', - nullable: true, - }, - }, - }, - TicketingProject: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - name: { - type: 'string', - description: 'The name of the project', - example: 'Project Falcon', - nullable: true, - }, - description: { - type: 'string', - description: 'The description of the project', - example: 'Description of the project', - nullable: true, - }, - organization_id: { - type: 'string', - description: 'The organization id related to the project', - example: 'organization-001', - nullable: true, - }, - created_at: { - type: 'string', - description: 'The timestamp when the record was created', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The timestamp when the record was last updated', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - TicketingProjectResult: { - type: 'object', - properties: { - data: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TicketingProject', - }, - ], - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - }, - TicketingProjectsPaginated: { - type: 'object', - properties: { - next: { - type: 'string', - nullable: true, - }, - data: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/TicketingProject', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - }, - TicketingReadTicket: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - title: { - type: 'string', - description: 'The title or subject of the ticket', - example: 'System outage in production environment', - nullable: true, - }, - creator_id: { - type: 'string', - description: 'The creator of the ticket', - example: 'user-001', - nullable: true, - }, - reporters: { - description: 'Users who reported the ticket', - example: ['user-001', 'user-002'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - assignees: { - description: 'Agents assigned to the ticket', - example: ['user-001', 'user-002'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - content: { - description: 'Array of content associated with the ticket', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/TicketingContent', - }, - }, - parent_id: { - type: 'string', - description: 'ID of the parent ticket if this is a sub-ticket', - example: 'ticket-002', - nullable: true, - }, - priority: { - description: 'Priority of the ticket', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TicketingTicketPriorityTypeEnum', - }, - ], - }, - tags: { - description: 'The tags of the ticket', - example: ['tag-001', 'tag-002'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - projects: { - description: 'Projects the ticket belongs to', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/TicketingProject', - }, - }, - ticket_number: { - type: 'string', - example: 'ticket-001', - description: 'The unique ticket number or reference ID', - nullable: true, - }, - type: { - description: 'The type of the ticket', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TicketingTicketType', - }, - ], - }, - closed_at: { - type: 'string', - description: 'The date the ticket was closed', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - ticket_url: { - type: 'string', - description: 'URL to view the ticket in the source system', - example: 'https://help.company.com/tickets/SUP-5689', - nullable: true, - }, - status: { - description: 'Current status of the ticket', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TicketingTicketStatus', - }, - ], - }, - organization: { - description: 'Organization associated with the ticket', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TicketingOrganization', - }, - ], - }, - components: { - description: 'Components associated with the ticket', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/TicketingComponent', - }, - }, - created_at: { - type: 'string', - description: 'The timestamp when the record was created', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The timestamp when the record was last updated', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - TicketingTicketCreateRequestDto: { - type: 'object', - properties: { - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - title: { - type: 'string', - description: 'The title or subject of the ticket', - example: 'System outage in production environment', - nullable: true, - }, - creator_id: { - type: 'string', - description: 'The creator of the ticket', - example: 'user-001', - nullable: true, - }, - reporters: { - description: 'Users who reported the ticket', - example: ['user-001', 'user-002'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - assignees: { - description: 'Agents assigned to the ticket', - example: ['user-001', 'user-002'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - content: { - description: 'Array of content associated with the ticket', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/TicketingContent', - }, - }, - parent_id: { - type: 'string', - description: 'ID of the parent ticket if this is a sub-ticket', - example: 'ticket-002', - nullable: true, - }, - priority: { - description: 'Priority of the ticket', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TicketingTicketPriorityTypeEnum', - }, - ], - }, - tags: { - description: 'The tags of the ticket', - example: ['tag-001', 'tag-002'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - organization_id: { - type: 'string', - description: 'Organization associated with the ticket', - example: 'organization-001', - nullable: true, - }, - project_id: { - type: 'string', - description: 'Project the ticket belongs to', - example: 'project-001', - nullable: true, - }, - component_ids: { - type: 'string', - description: 'Components to associate with the ticket', - example: ['component-001', 'component-002'], - nullable: true, - }, - type: { - type: 'string', - description: 'The type of the ticket', - example: 'ticket-type-001', - nullable: true, - }, - }, - }, - TicketingTicketPriorityTypeEnum: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'The id of the ticket priority.', - example: '001', - nullable: true, - }, - value: { - type: 'string', - enum: ['lowest', 'low', 'medium', 'high', 'highest', 'unmapped_value', null], - description: 'The priority of the ticket.', - example: 'medium', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the ticket priority.', - example: 'Normal', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - TicketingTicketResult: { - type: 'object', - properties: { - data: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TicketingReadTicket', - }, - ], - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - }, - TicketingTicketsPaginated: { - type: 'object', - properties: { - next: { - type: 'string', - nullable: true, - }, - data: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/TicketingReadTicket', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - }, - TicketingTicketStatus: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'The id of the ticket status.', - example: '001', - nullable: true, - }, - type: { - description: 'The type of this status', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TicketingTicketStatusTypeEnum', - }, - ], - }, - name: { - type: 'string', - description: 'The name of the ticket status.', - example: 'Backlog', - nullable: true, - }, - }, - }, - TicketingTicketStatusesPaginated: { - type: 'object', - properties: { - next: { - type: 'string', - nullable: true, - }, - data: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/TicketingTicketStatus', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - }, - TicketingTicketStatusTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: ['to-do', 'in-progress', 'closed', 'unmapped_value', null], - description: 'The type of this status', - example: 'to-do', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - description: 'The source value of this status type', - example: 'New', - nullable: true, - }, - }, - }, - TicketingTicketType: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'The id of the ticket type.', - example: '001', - nullable: true, - }, - name: { - type: 'string', - description: 'The name of the ticket type.', - example: 'Task', - nullable: true, - }, - project_id: { - type: 'string', - description: 'The project the ticket type belongs to.', - example: 'project-001', - nullable: true, - }, - }, - }, - TicketingTicketTypePaginated: { - type: 'object', - properties: { - next: { - type: 'string', - nullable: true, - }, - data: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/TicketingTicketType', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - }, - TicketingTicketTypeResult: { - type: 'object', - properties: { - data: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TicketingTicketType', - }, - ], - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - }, - TicketingTicketUpdateRequestDto: { - type: 'object', - properties: { - unified_custom_fields: { - type: 'object', - description: 'Custom Unified Fields configured in your StackOne project', - additionalProperties: true, - example: { - my_project_custom_field_1: 'REF-1236', - my_project_custom_field_2: 'some other value', - }, - nullable: true, - }, - title: { - type: 'string', - description: 'The title or subject of the ticket', - example: 'System outage in production environment', - nullable: true, - }, - reporters: { - description: 'Users who reported the ticket', - example: ['user-001', 'user-002'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - assignees: { - description: 'Agents assigned to the ticket', - example: ['user-001', 'user-002'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - content: { - description: 'Array of content associated with the ticket', - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/TicketingContent', - }, - }, - parent_id: { - type: 'string', - description: 'ID of the parent ticket if this is a sub-ticket', - example: 'ticket-002', - nullable: true, - }, - priority: { - description: 'Priority of the ticket', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TicketingTicketPriorityTypeEnum', - }, - ], - }, - tags: { - description: 'The tags of the ticket', - example: ['tag-001', 'tag-002'], - nullable: true, - type: 'array', - items: { - type: 'string', - }, - }, - project_id: { - type: 'string', - description: 'Project the ticket belongs to', - example: 'project-001', - nullable: true, - }, - component_ids: { - type: 'string', - description: 'Components to associate with the ticket', - example: ['component-001', 'component-002'], - nullable: true, - }, - status: { - description: 'Current status of the ticket', - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TicketingTicketStatus', - }, - ], - }, - }, - }, - TicketingUser: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'Unique identifier', - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - remote_id: { - type: 'string', - description: "Provider's unique identifier", - example: '8187e5da-dc77-475e-9949-af0f1fa4e4e3', - nullable: true, - }, - type: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TicketingUserTypeEnum', - }, - ], - }, - name: { - type: 'string', - description: 'John Doe', - example: 'John Doe', - nullable: true, - }, - primary_email: { - type: 'string', - description: "The user's primary email address", - example: 'john.doe@example.com', - nullable: true, - }, - primary_phone: { - type: 'string', - description: "The user's primary phone number", - example: '555-5555-5555', - nullable: true, - }, - username: { - type: 'string', - description: 'The username of the user in the provider system', - example: 'johndoe', - nullable: true, - }, - active: { - description: 'If the user is active', - example: true, - oneOf: [ - { - type: 'boolean', - }, - { - type: 'string', - enum: ['true', 'false'], - }, - ], - nullable: true, - }, - first_name: { - type: 'string', - description: 'The first name of the user', - example: 'John', - nullable: true, - }, - last_name: { - type: 'string', - description: 'The last name of the user', - example: 'Doe', - nullable: true, - }, - customer_account_reference: { - type: 'string', - description: - 'The unique account reference assigned as an external user (e.g. the customer account identifier registered on the customer-facing site or portal)', - example: 'JohnDoe123', - nullable: true, - }, - created_at: { - type: 'string', - description: 'The timestamp when the record was created', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - updated_at: { - type: 'string', - description: 'The timestamp when the record was last updated', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - nullable: true, - }, - }, - }, - TicketingUserResult: { - type: 'object', - properties: { - data: { - nullable: true, - allOf: [ - { - $ref: '#/components/schemas/TicketingUser', - }, - ], - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - }, - TicketingUsersPaginated: { - type: 'object', - properties: { - next: { - type: 'string', - nullable: true, - }, - data: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/TicketingUser', - }, - }, - raw: { - nullable: true, - type: 'array', - items: { - $ref: '#/components/schemas/RawResponse', - }, - }, - }, - }, - TicketingUserTypeEnum: { - type: 'object', - properties: { - value: { - type: 'string', - enum: ['agent', 'contact', 'bot', 'unmapped_value', null], - description: 'The type of the user.', - example: 'agent', - 'x-speakeasy-unknown-values': 'allow', - nullable: true, - }, - source_value: { - description: 'The source value of the user type.', - example: 'Live', - oneOf: [ - { - type: 'string', - }, - { - type: 'number', - }, - { - type: 'boolean', - }, - { - type: 'object', - }, - { - type: 'array', - items: {}, - }, - ], - nullable: true, - }, - }, - }, - TooManyRequestsResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 429, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Too many requests', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - UnauthorizedResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 401, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Unauthorized', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - UnifiedError: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 400, - nullable: true, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Bad Request', - nullable: true, - }, - headers: { - type: 'object', - description: 'Response headers', - example: { - 'content-type': 'application/json', - 'x-request-id': '5678c28b211dace4e0a0f9171e6b88c5', - }, - nullable: true, - }, - }, - }, - UnprocessableEntityResponse: { - type: 'object', - properties: { - statusCode: { - type: 'number', - description: 'HTTP status code', - example: 422, - }, - message: { - type: 'string', - description: 'Error message', - example: 'Unprocessable Entity', - }, - timestamp: { - type: 'string', - description: 'Timestamp when the error occurred', - example: '2023-05-30T00:00:00.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - UpdateResult: { - type: 'object', - properties: { - statusCode: { - type: 'number', - example: 200, - }, - message: { - type: 'string', - example: 'Record updated successfully.', - }, - timestamp: { - type: 'string', - example: '2021-01-01T01:01:01.000Z', - format: 'date-time', - }, - }, - required: ['statusCode', 'message', 'timestamp'], - }, - }, - }, -}; diff --git a/src/openapi/loader.ts b/src/openapi/loader.ts deleted file mode 100644 index 9b6102e9..00000000 --- a/src/openapi/loader.ts +++ /dev/null @@ -1,97 +0,0 @@ -import { ToolSetLoadError } from '../toolsets/base'; -import type { ToolDefinition } from '../types'; -import { readJsonFile } from '../utils/file'; -import { OpenAPIParser } from './parser'; - -// Import all specs from the generated index file -import * as specs from '../openapi/generated'; - -// Import the OpenAPIDocument type -import type { OpenAPIV3, OpenAPIV3_1 } from 'openapi-types'; -type OpenAPIDocument = OpenAPIV3.Document | OpenAPIV3_1.Document; - -/** - * Load all OpenAPI specs from the oas directory - * @param baseUrl Optional base URL to use for all operations - * @param removedParams Optional array of parameter names to remove from all tools - * @returns Dict mapping vertical names to their tool definitions - */ -export const loadStackOneSpecs = ( - baseUrl?: string, - removedParams: string[] = [] -): Record> => { - const tools: Record> = {}; - - // Process each spec from the imported specs object - for (const [key, value] of Object.entries(specs)) { - // The key will be in the format 'verticalSpec', we need to extract 'vertical' - const vertical = key.replace('Spec', ''); - const spec = value as unknown as OpenAPIDocument; - const parser = new OpenAPIParser(spec, baseUrl, removedParams); - tools[vertical] = parser.parseTools(); - } - - return tools; -}; - -/** - * Load OpenAPI spec from a file - * @param filePath Path to the OpenAPI spec file - * @param baseUrl Optional base URL to use for all operations - * @param removedParams Optional array of parameter names to remove from all tools - * @returns Tool definitions parsed from the spec - * @throws ToolSetLoadError If there is an error loading the spec - */ -export const loadFromFile = ( - filePath: string, - baseUrl?: string, - removedParams: string[] = [] -): Record => { - try { - const spec = readJsonFile(filePath); - const parser = new OpenAPIParser(spec, baseUrl, removedParams); - - return parser.parseTools(); - } catch (error) { - if (error instanceof ToolSetLoadError) { - throw error; - } - throw new ToolSetLoadError('Error loading spec from file', { cause: error }); - } -}; - -/** - * Load OpenAPI spec from a URL - * @param url URL of the OpenAPI spec - * @param baseUrl Optional base URL to use for all operations - * @param removedParams Optional array of parameter names to remove from all tools - * @returns Promise resolving to tool definitions parsed from the spec - * @throws ToolSetLoadError If there is an error loading the spec - */ -export const loadFromUrl = async ( - url: string, - baseUrl?: string, - removedParams: string[] = [] -): Promise> => { - try { - // Fetch the spec from the URL using native fetch - const response = await fetch(url); - if (!response.ok) { - throw new ToolSetLoadError( - `Failed to fetch OpenAPI spec from URL: ${url}, status: ${response.status}` - ); - } - - // Parse the spec - const specContent = await response.text(); - const spec = JSON.parse(specContent) as OpenAPIDocument; - const parser = new OpenAPIParser(spec, baseUrl, removedParams); - - return parser.parseTools(); - } catch (error) { - if (error instanceof ToolSetLoadError) { - throw error; - } - throw new ToolSetLoadError('Error loading spec from URL', { cause: error }); - } -}; diff --git a/src/openapi/parser.ts b/src/openapi/parser.ts deleted file mode 100644 index 11baed6a..00000000 --- a/src/openapi/parser.ts +++ /dev/null @@ -1,670 +0,0 @@ -import type { JSONSchema7 as JsonSchema } from 'json-schema'; -import type { OpenAPIV3, OpenAPIV3_1 } from 'openapi-types'; -import { type HttpExecuteConfig, ParameterLocation, type ToolDefinition } from '../types'; -// Define a type for OpenAPI document -type OpenAPIDocument = OpenAPIV3.Document | OpenAPIV3_1.Document; - -// Define a type for schema objects -type SchemaObject = OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject; - -// Define HTTP methods type -type HttpMethod = 'get' | 'put' | 'post' | 'delete' | 'options' | 'head' | 'patch' | 'trace'; - -/** - * Parser for OpenAPI specifications - */ -export class OpenAPIParser { - _spec: OpenAPIDocument; - _baseUrl: string; - private _removedParams: string[]; - - /** - * Create a new OpenAPIParser - * @param spec The OpenAPI specification object - * @param customBaseUrl Optional custom base URL to use for all operations - * @param removedParams Optional array of parameter names to remove from all tools - */ - constructor(spec: OpenAPIDocument, customBaseUrl?: string, removedParams?: string[]) { - this._spec = spec; - this._baseUrl = customBaseUrl || this.determineBaseUrl(); - // Default to removing source_value if no removedParams provided - this._removedParams = removedParams || []; - } - - /** - * Helper method to check if a parameter should be removed - */ - private isRemovedParam(paramName: string): boolean { - return this._removedParams.includes(paramName); - } - - /** - * Helper method to check if a schema is deprecated - */ - private isDeprecated(schema: unknown): boolean { - return ( - typeof schema === 'object' && - schema !== null && - 'deprecated' in schema && - (schema as { deprecated?: boolean }).deprecated === true - ); - } - - /** - * Helper method to check if a value is a non-null object - */ - private isObject(value: unknown): value is Record { - return typeof value === 'object' && value !== null; - } - - /** - * Determine the base URL from the servers array in the OpenAPI spec - * @returns The base URL to use for all operations - */ - private determineBaseUrl(): string { - // Extract base URL from servers if available - const servers = this._spec.servers || []; - return servers.length > 0 ? servers[0].url : 'https://api.stackone.com'; - } - - private normalizeBodyType(bodyType: string | null): HttpExecuteConfig['bodyType'] { - // Map OpenAPI content types into the narrower set supported by ExecuteConfig. - if (!bodyType) { - return 'json'; - } - - if (bodyType === 'form-data' || bodyType === 'multipart-form') { - return 'multipart-form'; - } - - if (bodyType === 'form' || bodyType === 'application/x-www-form-urlencoded') { - return 'form'; - } - - return 'json'; - } - - /** - * Create a parser from a JSON string - * @param specString OpenAPI specification as a JSON string - * @param customBaseUrl Optional custom base URL to use for all tools - * @param removedParams Optional array of parameter names to remove from all tools - * @returns A new OpenAPIParser instance - */ - public static fromString( - specString: string, - customBaseUrl?: string, - removedParams?: string[] - ): OpenAPIParser { - const spec = JSON.parse(specString) as OpenAPIDocument; - return new OpenAPIParser(spec, customBaseUrl, removedParams); - } - - /** - * Resolve a JSON schema reference in the OpenAPI spec - */ - public resolveSchemaRef(ref: string, visited: Set = new Set()): JsonSchema { - if (!ref.startsWith('#/')) { - const errorMsg = `Only local references are supported: ${ref}`; - throw new Error(errorMsg); - } - - if (visited.has(ref)) { - const errorMsg = `Circular reference detected: ${ref}`; - throw new Error(errorMsg); - } - - // Create a new set with the current ref added to avoid modifying the original set - const newVisited = new Set(visited); - newVisited.add(ref); - - const parts = ref.split('/').slice(1); // Skip the '#' - let current: unknown = this._spec; - for (const part of parts) { - if (this.isObject(current)) { - current = current[part]; - } else { - const errorMsg = `Invalid reference path: ${ref}`; - throw new Error(errorMsg); - } - } - - // After getting the referenced schema, resolve it fully - const resolved = this.resolveSchema(current as SchemaObject, newVisited); - return resolved; - } - - /** - * Resolve all references in a schema, preserving structure - * This also filters out deprecated properties and properties in removedParams - */ - public resolveSchema( - schema: SchemaObject | unknown, - visited: Set = new Set() - ): JsonSchema { - // Handle primitive types (string, number, etc) - if (!this.isObject(schema)) { - return schema as JsonSchema; - } - - // Skip if schema is deprecated - if (this.isDeprecated(schema)) { - return {} as JsonSchema; - } - - if (Array.isArray(schema)) { - return schema.map((item) => - this.resolveSchema(item, new Set(visited)) - ) as unknown as JsonSchema; - } - - // Handle direct reference - if ('$ref' in schema && typeof schema.$ref === 'string') { - const resolved = this.resolveSchemaRef(schema.$ref, visited); - if (!this.isObject(resolved)) { - return resolved; - } - // Merge any additional properties from the original schema - // Create a new object to avoid modifying the resolved schema - const result = { - ...JSON.parse(JSON.stringify(resolved)), - ...Object.fromEntries(Object.entries(schema).filter(([k]) => k !== '$ref')), - }; - return result as JsonSchema; - } - - // Handle allOf combinations - if ('allOf' in schema) { - const schemaObj = schema as OpenAPIV3.SchemaObject; - // Create a new object without the allOf property to avoid type issues - const { allOf, ...restSchema } = schemaObj; - const mergedSchema: JsonSchema = restSchema as JsonSchema; - - // Merge all schemas in allOf array - if (Array.isArray(allOf)) { - for (const subSchema of allOf) { - const resolved = this.resolveSchema(subSchema, new Set(visited)); - if (!this.isObject(resolved)) { - continue; - } - - // Merge properties - if ('properties' in resolved) { - if (!mergedSchema.properties) { - mergedSchema.properties = {}; - } - // Ensure both are objects before spreading - const resolvedProps = resolved.properties || {}; - mergedSchema.properties = { - ...(mergedSchema.properties || {}), - ...resolvedProps, - }; - } - - // Merge required fields - if ('required' in resolved && Array.isArray(resolved.required)) { - // Just use a simple array concat approach without spreading - if (mergedSchema.required) { - for (const req of resolved.required) { - if (!mergedSchema.required.includes(req)) { - mergedSchema.required.push(req); - } - } - } else { - mergedSchema.required = resolved.required.slice(); - } - } - - // Merge other fields - for (const [key, value] of Object.entries(resolved)) { - if (key !== 'properties' && key !== 'required' && !(key in mergedSchema)) { - (mergedSchema as Record)[key] = value; - } - } - } - } - - return mergedSchema; - } - - const schemaObj = schema as OpenAPIV3.SchemaObject; - const resolved: Record = {}; - - // Handle properties - if ('properties' in schemaObj && typeof schemaObj.properties === 'object') { - resolved.properties = {}; - const requiredProps: string[] = []; - - for (const [propName, propSchema] of Object.entries(schemaObj.properties)) { - // Skip null properties - if (propSchema === null) continue; - - // Skip properties that should be removed or are deprecated - if (this.isRemovedParam(propName) || this.isDeprecated(propSchema)) continue; - - // A property is required if: - // 1. It's in the parent's required array AND - // 2. It's not marked as nullable in OpenAPI - const isNullable = - this.isObject(propSchema) && 'nullable' in propSchema && propSchema.nullable === true; - const isRequired = - Array.isArray(schemaObj.required) && - schemaObj.required.includes(propName) && - !this.isRemovedParam(propName); - - if (isRequired && !isNullable) { - requiredProps.push(propName); - } - - // Process the property schema - (resolved.properties as Record)[propName] = this.resolveSchema( - propSchema, - new Set(visited) - ); - } - - // Only add required array if there are required properties - if (requiredProps.length > 0) { - resolved.required = requiredProps; - } - } else if ('required' in schemaObj && Array.isArray(schemaObj.required)) { - // Filter the required array to remove any properties in removedParams - const filteredRequired = schemaObj.required.filter((prop) => !this.isRemovedParam(prop)); - if (filteredRequired.length > 0) { - resolved.required = filteredRequired; - } - } - - // Process remaining fields - for (const [key, value] of Object.entries(schema)) { - // Skip already handled or special properties - if ( - key === 'properties' || - key === 'required' || - key === 'nullable' || - key === 'deprecated' || - key.startsWith('x-') - ) { - continue; - } - - if (this.isObject(value)) { - if (Array.isArray(value)) { - resolved[key] = value.map((item) => this.resolveSchema(item, new Set(visited))); - } else { - resolved[key] = this.resolveSchema(value, new Set(visited)); - } - } else { - resolved[key] = value; - } - } - - return resolved as JsonSchema; - } - - /** - * Parse content schema for a specific content type - */ - public parseContentSchema( - contentType: string, - content: Record - ): [JsonSchema | null, string | null] { - // Check if the content type exists in the content object - if (!content[contentType]) { - return [null, null]; - } - - // Get the schema for the content type - const mediaType = content[contentType]; - const schema = mediaType.schema; - - // Only handle JSON content types for now - if (contentType === 'application/json') { - return [this.resolveSchema(schema), 'json']; - } - if (contentType === 'multipart/form-data') { - return [this.resolveSchema(schema), 'form-data']; - } - if (contentType === 'application/x-www-form-urlencoded') { - return [this.resolveSchema(schema), 'form']; - } - - // Return null for other content types - return [null, null]; - } - - /** - * Resolve a request body reference - */ - public resolveRequestBodyRef(ref: string): OpenAPIV3.RequestBodyObject | null { - if (!ref.startsWith('#/components/requestBodies/')) { - return null; - } - - const name = ref.split('/').pop() as string; - const requestBodies = this._spec.components?.requestBodies; - if (!requestBodies || !(name in requestBodies)) { - return null; - } - - const refBody = requestBodies[name]; - if ('$ref' in refBody) { - // Don't support nested references for simplicity - return null; - } - - return refBody as OpenAPIV3.RequestBodyObject; - } - - /** - * Parse request body from an operation - */ - public parseRequestBody( - operation: OpenAPIV3.OperationObject - ): [JsonSchema | null, string | null] { - if (!operation.requestBody) { - return [null, null]; - } - - let requestBody = operation.requestBody as OpenAPIV3.RequestBodyObject; - - // Handle request body reference - if ('$ref' in operation.requestBody) { - const refBody = this.resolveRequestBodyRef( - (operation.requestBody as OpenAPIV3.ReferenceObject).$ref - ); - if (!refBody) { - return [null, null]; - } - requestBody = refBody as OpenAPIV3.RequestBodyObject; - } - - // Check for content - if (!requestBody.content) { - return [null, null]; - } - - // Try to parse JSON content first - if (requestBody.content['application/json']) { - return this.parseContentSchema('application/json', requestBody.content); - } - - // Then try multipart/form-data - if (requestBody.content['multipart/form-data']) { - return this.parseContentSchema('multipart/form-data', requestBody.content); - } - - // Then try application/x-www-form-urlencoded - if (requestBody.content['application/x-www-form-urlencoded']) { - return this.parseContentSchema('application/x-www-form-urlencoded', requestBody.content); - } - - // No supported content type found - return [null, null]; - } - - /** - * Helper method to check if an item should be skipped (removed or deprecated) - */ - private shouldSkipItem(name: string, item: unknown): boolean { - return this.isRemovedParam(name) || this.isDeprecated(item); - } - - /** - * Get the parameter location from a property schema - * @param propSchema The schema of the property - * @returns The parameter location (HEADER, QUERY, PATH, or BODY) - */ - public getParameterLocation( - propSchema: OpenAPIV3.ParameterObject | Record - ): ParameterLocation { - // If the parameter has an explicit 'in' property, use that - if (this.isObject(propSchema) && 'in' in propSchema) { - const location = propSchema.in; - - switch (location) { - case 'header': - return ParameterLocation.HEADER; - case 'query': - return ParameterLocation.QUERY; - case 'path': - return ParameterLocation.PATH; - case 'cookie': // Cookies are sent in headers - return ParameterLocation.HEADER; - default: - return ParameterLocation.BODY; - } - } - - // Default to BODY for request body properties - return ParameterLocation.BODY; - } - - /** - * Filter out removed parameters from both properties and required arrays - */ - private filterRemovedParams( - properties: Record, - required?: string[] - ): [Record, string[] | undefined] { - // Final cleanup of properties - const filteredProperties = { ...properties }; - for (const param of this._removedParams) { - delete filteredProperties[param]; - } - - // Final cleanup of required fields - const filteredRequired = required?.filter((param) => !this.isRemovedParam(param)); - - return [ - filteredProperties, - filteredRequired && filteredRequired.length > 0 ? filteredRequired : undefined, - ]; - } - - /** - * Parse OpenAPI spec into tool definitions - */ - public parseTools(): Record { - // Create a new empty tools object to ensure no tools from previous tests are included - const tools: Record = {}; - - try { - const paths = this._spec.paths || {}; - - for (const [path, pathItem] of Object.entries(paths)) { - if (!pathItem) { - continue; - } - - // Handle operations (get, post, put, delete, etc.) - const operations = this.extractOperations(pathItem); - - for (const [method, operation] of operations) { - // Check for operationId - this is required - if (!operation.operationId) { - const errorMsg = `Operation ID is required for tool parsing: ${method.toUpperCase()} ${path}`; - throw new Error(errorMsg); - } - - const name = operation.operationId; - - try { - // Parse request body if present - const [requestBodySchema, bodyType] = this.parseRequestBody(operation); - - // Track parameter locations and properties - // Create fresh objects for each operation to avoid shared state issues - const parameterLocations: Record = {}; - const properties: Record = {}; - let requiredParams: string[] = []; - - // Parse parameters - for (const param of operation.parameters || []) { - try { - // Resolve parameter reference if needed - const resolvedParam = this.resolveParameter(param); - if (!resolvedParam) { - continue; - } - - const paramName = resolvedParam.name; - - // Skip parameters that should be removed or are deprecated - if (this.shouldSkipItem(paramName, resolvedParam)) { - continue; - } - - const paramLocation = resolvedParam.in; // header, query, path, cookie - parameterLocations[paramName] = paramLocation as ParameterLocation; - - // Add to properties for tool parameters - const schema = { ...(resolvedParam.schema || {}) }; - if ('description' in resolvedParam) { - (schema as Record).description = resolvedParam.description; - } - properties[paramName] = this.resolveSchema(schema); - - // Add to required params if required - // Special case for x-account-id: only add to required if it's required in the spec - if (resolvedParam.required && !(paramName === 'x-account-id')) { - requiredParams.push(paramName); - } - } catch (_paramError) { - // Continue with other parameters even if one fails - } - } - - // Add request body properties if present - if (requestBodySchema && typeof requestBodySchema === 'object') { - const bodyProps = requestBodySchema.properties || {}; - - // Extract required fields from request body - if ('required' in requestBodySchema && Array.isArray(requestBodySchema.required)) { - requiredParams = [...requiredParams, ...requestBodySchema.required]; - } - - for (const [propName, propSchema] of Object.entries(bodyProps)) { - try { - // Skip items that should be removed or are deprecated - if (this.shouldSkipItem(propName, propSchema)) { - continue; - } - - // Create a deep copy of the propSchema to avoid shared state - properties[propName] = this.resolveSchema(propSchema); - parameterLocations[propName] = this.getParameterLocation( - propSchema as Record - ); - } catch (_propError) { - // Continue with other properties even if one fails - } - } - } - - // Filter out removed parameters from properties and required arrays - const [filteredProperties, filteredRequired] = this.filterRemovedParams( - properties, - requiredParams - ); - - // Create tool definition with deep copies to prevent shared state - const executeConfig = { - kind: 'http', - method: method.toUpperCase(), - url: `${this._baseUrl}${path}`, - bodyType: this.normalizeBodyType(bodyType), - params: Object.entries(parameterLocations) - .filter(([name]) => !this.isRemovedParam(name)) - .map(([name, location]) => { - return { - name, - location, - type: (filteredProperties[name]?.type as JsonSchema['type']) || 'string', - }; - }), - } satisfies HttpExecuteConfig; - - tools[name] = { - description: operation.summary || '', - parameters: { - type: 'object', - properties: filteredProperties, - required: filteredRequired, - }, - execute: executeConfig, - }; - } catch (operationError) { - console.error(`Error processing operation ${name}: ${operationError}`); - // Continue with other operations even if one fails - } - } - } - } catch (error) { - console.error('Error parsing OpenAPI spec:', error); - } - - return tools; - } - - /** - * Extract operations from a path item - */ - public extractOperations( - pathItem: OpenAPIV3.PathItemObject - ): [string, OpenAPIV3.OperationObject][] { - const operations: [string, OpenAPIV3.OperationObject][] = []; - const methods: HttpMethod[] = [ - 'get', - 'put', - 'post', - 'delete', - 'options', - 'head', - 'patch', - 'trace', - ]; - - for (const method of methods) { - const operation = pathItem[method]; - if (operation) { - operations.push([method, operation]); - } - } - - return operations; - } - - /** - * Resolve a parameter reference - */ - public resolveParameter( - param: OpenAPIV3.ParameterObject | OpenAPIV3.ReferenceObject - ): OpenAPIV3.ParameterObject | null { - try { - if ('$ref' in param) { - const ref = param.$ref; - const parts = ref.split('/').slice(1); // Skip the '#' - let current: unknown = this._spec; - for (const part of parts) { - if (this.isObject(current)) { - current = current[part]; - } else { - return null; - } - } - return current as OpenAPIV3.ParameterObject; - } - return param; - } catch (_error) { - return null; - } - } - - /** - * Get the base URL - */ - public get baseUrl(): string { - return this._baseUrl; - } -} diff --git a/src/openapi/tests/__snapshots__/openapi-parser.spec.ts.snap b/src/openapi/tests/__snapshots__/openapi-parser.spec.ts.snap deleted file mode 100644 index 453d3016..00000000 --- a/src/openapi/tests/__snapshots__/openapi-parser.spec.ts.snap +++ /dev/null @@ -1,18605 +0,0 @@ -// Bun Snapshot v1, https://bun.sh/docs/test/snapshots - -exports[`OpenAPIParser Snapshot Tests should parse all OpenAPI specs correctly 1`] = ` -{ - "hris_batch_upload_employee_document": { - "description": "Batch Upload Employee Document", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "POST", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "body", - "name": "items", - "type": "array", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/documents/upload/batch", - }, - "parameters": { - "properties": { - "id": { - "type": "string", - }, - "items": { - "description": "The batch of items to create", - "items": { - "properties": { - "category": { - "description": "The category to be associated with the file to be uploaded. Id will take precedence over name.", - "example": { - "id": "550e8400-e29b-41d4-a716-446655440000", - "name": "reports", - }, - "properties": { - "source_value": { - "description": "The provider specific category for associating uploaded files, if provided, the value will be ignored.", - "example": "550e8400-e29b-41d4-a716-446655440000", - "type": "string", - }, - "value": { - "description": "The category name to associate with the file", - "enum": [ - "application", - "academic", - "contract", - "certificates", - "visa", - "passport", - "driver_license", - "payslip", - "payroll", - "appraisal", - "resume", - "policy", - "cover_letter", - "offer_letter", - "policy_agreement", - "home_address", - "national_id", - "confidential", - "signed", - "shared", - "other", - "benefit", - "id_verification", - "background_check", - "unmapped_value", - null, - ], - "example": "reports", - "type": "string", - }, - }, - "type": "object", - }, - "category_id": { - "description": "The categoryId of the documents", - "example": "6530", - "type": "string", - }, - "confidential": { - "description": "The confidentiality level of the file to be uploaded", - "properties": { - "source_value": { - "example": "public", - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "Whether the file is confidential or not", - "enum": [ - "true", - "false", - "unmapped_value", - null, - ], - "example": "true", - "type": "string", - }, - }, - "type": "object", - }, - "content": { - "description": "The base64 encoded content of the file to upload", - "example": "VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE", - "type": "string", - }, - "file_format": { - "description": "The file format of the file", - "properties": { - "source_value": { - "example": "application/pdf", - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "The file format of the file, expressed as a file extension", - "enum": [ - "unmapped_value", - "ez", - "aw", - "atom", - "atomcat", - "atomdeleted", - "atomsvc", - "dwd", - "held", - "rsat", - "bdoc", - "xcs", - "ccxml", - "cdfx", - "cdmia", - "cdmic", - "cdmid", - "cdmio", - "cdmiq", - "cu", - "mpd", - "davmount", - "dbk", - "dssc", - "xdssc", - "es", - "ecma", - "emma", - "emotionml", - "epub", - "exi", - "exp", - "fdt", - "pfr", - "geojson", - "gml", - "gpx", - "gxf", - "gz", - "hjson", - "stk", - "ink", - "inkml", - "ipfix", - "its", - "jar", - "war", - "ear", - "ser", - "class", - "js", - "mjs", - "json", - "map", - "json5", - "jsonml", - "jsonld", - "lgr", - "lostxml", - "hqx", - "cpt", - "mads", - "webmanifest", - "mrc", - "mrcx", - "ma", - "nb", - "mb", - "mathml", - "mbox", - "mscml", - "metalink", - "meta4", - "mets", - "maei", - "musd", - "mods", - "m21", - "mp21", - "mp4s", - "m4p", - "doc", - "dot", - "mxf", - "nq", - "nt", - "cjs", - "bin", - "dms", - "lrf", - "mar", - "so", - "dist", - "distz", - "pkg", - "bpk", - "dump", - "elc", - "deploy", - "exe", - "dll", - "deb", - "dmg", - "iso", - "img", - "msi", - "msp", - "msm", - "buffer", - "oda", - "opf", - "ogx", - "omdoc", - "onetoc", - "onetoc2", - "onetmp", - "onepkg", - "oxps", - "relo", - "xer", - "pdf", - "pgp", - "asc", - "sig", - "prf", - "p10", - "p7m", - "p7c", - "p7s", - "p8", - "ac", - "cer", - "crl", - "pkipath", - "pki", - "pls", - "ai", - "eps", - "ps", - "provx", - "pskcxml", - "raml", - "rdf", - "owl", - "rif", - "rnc", - "rl", - "rld", - "rs", - "rapd", - "sls", - "rusd", - "gbr", - "mft", - "roa", - "rsd", - "rss", - "rtf", - "sbml", - "scq", - "scs", - "spq", - "spp", - "sdp", - "senmlx", - "sensmlx", - "setpay", - "setreg", - "shf", - "siv", - "sieve", - "smi", - "smil", - "rq", - "srx", - "gram", - "grxml", - "sru", - "ssdl", - "ssml", - "swidtag", - "tei", - "teicorpus", - "tfi", - "tsd", - "toml", - "trig", - "ttml", - "ubj", - "rsheet", - "td", - "vxml", - "wasm", - "wgt", - "hlp", - "wsdl", - "wspolicy", - "xaml", - "xav", - "xca", - "xdf", - "xel", - "xns", - "xenc", - "xhtml", - "xht", - "xlf", - "xml", - "xsl", - "xsd", - "rng", - "dtd", - "xop", - "xpl", - "*xsl", - "xslt", - "xspf", - "mxml", - "xhvml", - "xvml", - "xvm", - "yang", - "yin", - "zip", - "*3gpp", - "adp", - "amr", - "au", - "snd", - "mid", - "midi", - "kar", - "rmi", - "mxmf", - "*mp3", - "m4a", - "mp4a", - "mpga", - "mp2", - "mp2a", - "mp3", - "m2a", - "m3a", - "oga", - "ogg", - "spx", - "opus", - "s3m", - "sil", - "wav", - "*wav", - "weba", - "xm", - "ttc", - "otf", - "ttf", - "woff", - "woff2", - "exr", - "apng", - "avif", - "bmp", - "cgm", - "drle", - "emf", - "fits", - "g3", - "gif", - "heic", - "heics", - "heif", - "heifs", - "hej2", - "hsj2", - "ief", - "jls", - "jp2", - "jpg2", - "jpeg", - "jpg", - "jpe", - "jph", - "jhc", - "jpm", - "jpx", - "jpf", - "jxr", - "jxra", - "jxrs", - "jxs", - "jxsc", - "jxsi", - "jxss", - "ktx", - "ktx2", - "png", - "sgi", - "svg", - "svgz", - "t38", - "tif", - "tiff", - "tfx", - "webp", - "wmf", - "disposition-notification", - "u8msg", - "u8dsn", - "u8mdn", - "u8hdr", - "eml", - "mime", - "3mf", - "gltf", - "glb", - "igs", - "iges", - "msh", - "mesh", - "silo", - "mtl", - "obj", - "stpx", - "stpz", - "stpxz", - "stl", - "wrl", - "vrml", - "*x3db", - "x3dbz", - "x3db", - "*x3dv", - "x3dvz", - "x3d", - "x3dz", - "x3dv", - "appcache", - "manifest", - "ics", - "ifb", - "coffee", - "litcoffee", - "css", - "csv", - "html", - "htm", - "shtml", - "jade", - "jsx", - "less", - "markdown", - "md", - "mml", - "mdx", - "n3", - "txt", - "text", - "conf", - "def", - "list", - "log", - "in", - "ini", - "rtx", - "*rtf", - "sgml", - "sgm", - "shex", - "slim", - "slm", - "spdx", - "stylus", - "styl", - "tsv", - "t", - "tr", - "roff", - "man", - "me", - "ms", - "ttl", - "uri", - "uris", - "urls", - "vcard", - "vtt", - "*xml", - "yaml", - "yml", - "3gp", - "3gpp", - "3g2", - "h261", - "h263", - "h264", - "m4s", - "jpgv", - "*jpm", - "jpgm", - "mj2", - "mjp2", - "ts", - "mp4", - "mp4v", - "mpg4", - "mpeg", - "mpg", - "mpe", - "m1v", - "m2v", - "ogv", - "qt", - "mov", - "webm", - "cww", - "1km", - "plb", - "psb", - "pvb", - "tcap", - "pwn", - "aso", - "imp", - "acu", - "atc", - "acutc", - "air", - "fcdt", - "fxp", - "fxpl", - "xdp", - "xfdf", - "ahead", - "azf", - "azs", - "azw", - "acc", - "ami", - "apk", - "cii", - "fti", - "atx", - "mpkg", - "key", - "m3u8", - "numbers", - "pages", - "pkpass", - "swi", - "iota", - "aep", - "bmml", - "mpm", - "bmi", - "rep", - "cdxml", - "mmd", - "cdy", - "csl", - "cla", - "rp9", - "c4g", - "c4d", - "c4f", - "c4p", - "c4u", - "c11amc", - "c11amz", - "csp", - "cdbcmsg", - "cmc", - "clkx", - "clkk", - "clkp", - "clkt", - "clkw", - "wbs", - "pml", - "ppd", - "car", - "pcurl", - "dart", - "rdz", - "dbf", - "uvf", - "uvvf", - "uvd", - "uvvd", - "uvt", - "uvvt", - "uvx", - "uvvx", - "uvz", - "uvvz", - "fe_launch", - "dna", - "mlp", - "mle", - "dpg", - "dfac", - "kpxx", - "ait", - "svc", - "geo", - "mag", - "nml", - "esf", - "msf", - "qam", - "slt", - "ssf", - "es3", - "et3", - "ez2", - "ez3", - "fdf", - "mseed", - "seed", - "dataless", - "gph", - "ftc", - "fm", - "frame", - "maker", - "book", - "fnc", - "ltf", - "fsc", - "oas", - "oa2", - "oa3", - "fg5", - "bh2", - "ddd", - "xdw", - "xbd", - "fzs", - "txd", - "ggb", - "ggt", - "gex", - "gre", - "gxt", - "g2w", - "g3w", - "gmx", - "gdoc", - "gslides", - "gsheet", - "kml", - "kmz", - "gqf", - "gqs", - "gac", - "ghf", - "gim", - "grv", - "gtm", - "tpl", - "vcg", - "hal", - "zmm", - "hbci", - "les", - "hpgl", - "hpid", - "hps", - "jlt", - "pcl", - "pclxl", - "sfd-hdstx", - "mpy", - "afp", - "listafp", - "list3820", - "irm", - "sc", - "icc", - "icm", - "igl", - "ivp", - "ivu", - "igm", - "xpw", - "xpx", - "i2g", - "qbo", - "qfx", - "rcprofile", - "irp", - "xpr", - "fcs", - "jam", - "rms", - "jisp", - "joda", - "ktz", - "ktr", - "karbon", - "chrt", - "kfo", - "flw", - "kon", - "kpr", - "kpt", - "ksp", - "kwd", - "kwt", - "htke", - "kia", - "kne", - "knp", - "skp", - "skd", - "skt", - "skm", - "sse", - "lasxml", - "lbd", - "lbe", - "apr", - "pre", - "nsf", - "org", - "scm", - "lwp", - "portpkg", - "mvt", - "mcd", - "mc1", - "cdkey", - "mwf", - "mfm", - "flo", - "igx", - "mif", - "daf", - "dis", - "mbk", - "mqy", - "msl", - "plc", - "txf", - "mpn", - "mpc", - "xul", - "cil", - "cab", - "xls", - "xlm", - "xla", - "xlc", - "xlt", - "xlw", - "xlam", - "xlsb", - "xlsm", - "xltm", - "eot", - "chm", - "ims", - "lrm", - "thmx", - "msg", - "cat", - "*stl", - "ppt", - "pps", - "pot", - "ppam", - "pptm", - "sldm", - "ppsm", - "potm", - "mpp", - "mpt", - "docm", - "dotm", - "wps", - "wks", - "wcm", - "wdb", - "wpl", - "xps", - "mseq", - "mus", - "msty", - "taglet", - "nlu", - "ntf", - "nitf", - "nnd", - "nns", - "nnw", - "*ac", - "ngdat", - "n-gage", - "rpst", - "rpss", - "edm", - "edx", - "ext", - "odc", - "otc", - "odb", - "odf", - "odft", - "odg", - "otg", - "odi", - "oti", - "odp", - "otp", - "ods", - "ots", - "odt", - "odm", - "ott", - "oth", - "xo", - "dd2", - "obgx", - "oxt", - "osm", - "pptx", - "sldx", - "ppsx", - "potx", - "xlsx", - "xltx", - "docx", - "dotx", - "mgp", - "dp", - "esa", - "pdb", - "pqa", - "oprc", - "paw", - "str", - "ei6", - "efif", - "wg", - "plf", - "pbd", - "box", - "mgz", - "qps", - "ptid", - "qxd", - "qxt", - "qwd", - "qwt", - "qxl", - "qxb", - "rar", - "bed", - "mxl", - "musicxml", - "cryptonote", - "cod", - "rm", - "rmvb", - "link66", - "st", - "see", - "sema", - "semd", - "semf", - "ifm", - "itp", - "iif", - "ipk", - "twd", - "twds", - "mmf", - "teacher", - "fo", - "sdkm", - "sdkd", - "dxp", - "sfs", - "sdc", - "sda", - "sdd", - "smf", - "sdw", - "vor", - "sgl", - "smzip", - "sm", - "wadl", - "sxc", - "stc", - "sxd", - "std", - "sxi", - "sti", - "sxm", - "sxw", - "sxg", - "stw", - "sus", - "susp", - "svd", - "sis", - "sisx", - "xsm", - "bdm", - "xdm", - "ddf", - "tao", - "pcap", - "cap", - "dmp", - "tmo", - "tpt", - "mxs", - "tra", - "ufd", - "ufdl", - "utz", - "umj", - "unityweb", - "uoml", - "vcx", - "vsd", - "vst", - "vss", - "vsw", - "vis", - "vsf", - "wbxml", - "wmlc", - "wmlsc", - "wtb", - "nbp", - "wpd", - "wqd", - "stf", - "xar", - "xfdl", - "hvd", - "hvs", - "hvp", - "osf", - "osfpvg", - "saf", - "spf", - "cmp", - "zir", - "zirz", - "zaz", - "7z", - "abw", - "ace", - "*dmg", - "arj", - "aab", - "x32", - "u32", - "vox", - "aam", - "aas", - "bcpio", - "*bdoc", - "torrent", - "blb", - "blorb", - "bz", - "bz2", - "boz", - "cbr", - "cba", - "cbt", - "cbz", - "cb7", - "vcd", - "cfs", - "chat", - "pgn", - "crx", - "cco", - "nsc", - "cpio", - "csh", - "*deb", - "udeb", - "dgc", - "dir", - "dcr", - "dxr", - "cst", - "cct", - "cxt", - "w3d", - "fgd", - "swa", - "wad", - "ncx", - "dtb", - "res", - "dvi", - "evy", - "eva", - "bdf", - "gsf", - "psf", - "pcf", - "snf", - "pfa", - "pfb", - "pfm", - "afm", - "arc", - "spl", - "gca", - "ulx", - "gnumeric", - "gramps", - "gtar", - "hdf", - "php", - "install", - "*iso", - "*key", - "*numbers", - "*pages", - "jardiff", - "jnlp", - "kdbx", - "latex", - "luac", - "lzh", - "lha", - "run", - "mie", - "prc", - "mobi", - "application", - "lnk", - "wmd", - "wmz", - "xbap", - "mdb", - "obd", - "crd", - "clp", - "*exe", - "*dll", - "com", - "bat", - "*msi", - "mvb", - "m13", - "m14", - "*wmf", - "*wmz", - "*emf", - "emz", - "mny", - "pub", - "scd", - "trm", - "wri", - "nc", - "cdf", - "pac", - "nzb", - "pl", - "pm", - "*prc", - "*pdb", - "p12", - "pfx", - "p7b", - "spc", - "p7r", - "*rar", - "rpm", - "ris", - "sea", - "sh", - "shar", - "swf", - "xap", - "sql", - "sit", - "sitx", - "srt", - "sv4cpio", - "sv4crc", - "t3", - "gam", - "tar", - "tcl", - "tk", - "tex", - "tfm", - "texinfo", - "texi", - "*obj", - "ustar", - "hdd", - "ova", - "ovf", - "vbox", - "vbox-extpack", - "vdi", - "vhd", - "vmdk", - "src", - "webapp", - "der", - "crt", - "pem", - "fig", - "*xlf", - "xpi", - "xz", - "z1", - "z2", - "z3", - "z4", - "z5", - "z6", - "z7", - "z8", - "uva", - "uvva", - "eol", - "dra", - "dts", - "dtshd", - "lvp", - "pya", - "ecelp4800", - "ecelp7470", - "ecelp9600", - "rip", - "aac", - "aif", - "aiff", - "aifc", - "caf", - "flac", - "*m4a", - "mka", - "m3u", - "wax", - "wma", - "ram", - "ra", - "rmp", - "*ra", - "cdx", - "cif", - "cmdf", - "cml", - "csml", - "xyz", - "btif", - "pti", - "psd", - "azv", - "uvi", - "uvvi", - "uvg", - "uvvg", - "djvu", - "djv", - "*sub", - "dwg", - "dxf", - "fbs", - "fpx", - "fst", - "mmr", - "rlc", - "ico", - "dds", - "mdi", - "wdp", - "npx", - "b16", - "tap", - "vtf", - "wbmp", - "xif", - "pcx", - "3ds", - "ras", - "cmx", - "fh", - "fhc", - "fh4", - "fh5", - "fh7", - "*ico", - "jng", - "sid", - "*bmp", - "*pcx", - "pic", - "pct", - "pnm", - "pbm", - "pgm", - "ppm", - "rgb", - "tga", - "xbm", - "xpm", - "xwd", - "wsc", - "dae", - "dwf", - "gdl", - "gtw", - "mts", - "ogex", - "x_b", - "x_t", - "vds", - "usdz", - "bsp", - "vtu", - "dsc", - "curl", - "dcurl", - "mcurl", - "scurl", - "sub", - "fly", - "flx", - "gv", - "3dml", - "spot", - "jad", - "wml", - "wmls", - "s", - "asm", - "c", - "cc", - "cxx", - "cpp", - "h", - "hh", - "dic", - "htc", - "f", - "for", - "f77", - "f90", - "hbs", - "java", - "lua", - "mkd", - "nfo", - "opml", - "*org", - "p", - "pas", - "pde", - "sass", - "scss", - "etx", - "sfv", - "ymp", - "uu", - "vcs", - "vcf", - "uvh", - "uvvh", - "uvm", - "uvvm", - "uvp", - "uvvp", - "uvs", - "uvvs", - "uvv", - "uvvv", - "dvb", - "fvt", - "mxu", - "m4u", - "pyv", - "uvu", - "uvvu", - "viv", - "f4v", - "fli", - "flv", - "m4v", - "mkv", - "mk3d", - "mks", - "mng", - "asf", - "asx", - "vob", - "wm", - "wmv", - "wmx", - "wvx", - "avi", - "movie", - "smv", - "ice", - "mht", - null, - ], - "example": "pdf", - "type": "string", - }, - }, - "type": "object", - }, - "name": { - "description": "The filename of the file to upload", - "example": "weather-forecast", - "type": "string", - }, - "path": { - "description": "The path for the file to be uploaded to", - "example": "/path/to/file", - "type": "string", - }, - }, - "type": "object", - }, - "type": "array", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - "items", - ], - "type": "object", - }, - }, - "hris_cancel_employee_time_off_request": { - "description": "Cancel Employee Time Off Request", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "DELETE", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off/{subResourceId}", - }, - "parameters": { - "properties": { - "id": { - "type": "string", - }, - "subResourceId": { - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - }, - "hris_create_employee": { - "description": "Create Employee", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "POST", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "body", - "name": "title", - "type": "string", - }, - { - "location": "body", - "name": "first_name", - "type": "string", - }, - { - "location": "body", - "name": "last_name", - "type": "string", - }, - { - "location": "body", - "name": "name", - "type": "string", - }, - { - "location": "body", - "name": "display_name", - "type": "string", - }, - { - "location": "body", - "name": "avatar_url", - "type": "string", - }, - { - "location": "body", - "name": "personal_email", - "type": "string", - }, - { - "location": "body", - "name": "personal_phone_number", - "type": "string", - }, - { - "location": "body", - "name": "work_email", - "type": "string", - }, - { - "location": "body", - "name": "work_phone_number", - "type": "string", - }, - { - "location": "body", - "name": "job_title", - "type": "string", - }, - { - "location": "body", - "name": "department_id", - "type": "string", - }, - { - "location": "body", - "name": "team_id", - "type": "string", - }, - { - "location": "body", - "name": "department", - "type": "string", - }, - { - "location": "body", - "name": "manager_id", - "type": "string", - }, - { - "location": "body", - "name": "gender", - "type": "object", - }, - { - "location": "body", - "name": "preferred_language", - "type": "object", - }, - { - "location": "body", - "name": "ethnicity", - "type": "object", - }, - { - "location": "body", - "name": "date_of_birth", - "type": "string", - }, - { - "location": "body", - "name": "birthday", - "type": "string", - }, - { - "location": "body", - "name": "marital_status", - "type": "object", - }, - { - "location": "body", - "name": "avatar", - "type": "object", - }, - { - "location": "body", - "name": "hire_date", - "type": "string", - }, - { - "location": "body", - "name": "start_date", - "type": "string", - }, - { - "location": "body", - "name": "employment_status", - "type": "object", - }, - { - "location": "body", - "name": "termination_date", - "type": "string", - }, - { - "location": "body", - "name": "company_id", - "type": "string", - }, - { - "location": "body", - "name": "citizenships", - "type": "array", - }, - { - "location": "body", - "name": "employment", - "type": "object", - }, - { - "location": "body", - "name": "custom_fields", - "type": "array", - }, - { - "location": "body", - "name": "benefits", - "type": "array", - }, - { - "location": "body", - "name": "employee_number", - "type": "string", - }, - { - "location": "body", - "name": "national_identity_numbers", - "type": "array", - }, - { - "location": "body", - "name": "home_location", - "type": "object", - }, - { - "location": "body", - "name": "work_location", - "type": "object", - }, - { - "location": "body", - "name": "cost_centers", - "type": "array", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees", - }, - "parameters": { - "properties": { - "avatar": { - "description": "The employee avatar", - "example": "https://example.com/avatar.png", - "properties": { - "base64": { - "type": "string", - }, - "url": { - "type": "string", - }, - }, - "type": "object", - }, - "avatar_url": { - "description": "The employee avatar Url", - "example": "https://example.com/avatar.png", - "type": "string", - }, - "benefits": { - "description": "Current benefits of the employee", - "items": { - "properties": { - "benefit_type": { - "description": "The type of the benefit", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "The type of the benefit", - "enum": [ - "retirement_savings", - "health_savings", - "other", - "health_insurance", - "insurance", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "created_at": { - "description": "The date and time the benefit was created", - "example": "2021-01-01T00:00:00Z", - "format": "date-time", - "type": "string", - }, - "description": { - "description": "The description of the benefit", - "example": "Health insurance for employees", - "type": "string", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "name": { - "description": "The name of the benefit", - "example": "Health Insurance", - "type": "string", - }, - "provider": { - "description": "The provider of the benefit", - "example": "Aetna", - "type": "string", - }, - "updated_at": { - "description": "The date and time the benefit was last updated", - "example": "2021-01-01T00:00:00Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "type": "array", - }, - "birthday": { - "description": "The next birthday of the employee (upcoming birthday)", - "example": "2021-01-01T00:00:00Z", - "format": "date-time", - "type": "string", - }, - "citizenships": { - "description": "The citizenships of the Employee", - "items": { - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "type": "string", - }, - }, - "type": "object", - }, - "type": "array", - }, - "company_id": { - "description": "The employee company id", - "example": "1234567890", - "type": "string", - }, - "cost_centers": { - "description": "The employee cost centers", - "items": { - "properties": { - "distribution_percentage": { - "example": 100, - "type": "number", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "name": { - "example": "R&D", - "type": "string", - }, - }, - "type": "object", - }, - "type": "array", - }, - "custom_fields": { - "description": "The employee custom fields", - "items": { - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "name": { - "description": "The name of the custom field.", - "example": "Training Completion Status", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "remote_value_id": { - "description": "Provider's unique identifier for the value of the custom field.", - "example": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", - "type": "string", - }, - "value": { - "description": "The value associated with the custom field.", - "example": "Completed", - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - { - "format": "date-time", - "type": "string", - }, - ], - }, - "value_id": { - "description": "The unique identifier for the value of the custom field.", - "example": "value_456", - "type": "string", - }, - }, - "type": "object", - }, - "type": "array", - }, - "date_of_birth": { - "description": "The date when the employee was born", - "example": "1990-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "department": { - "description": "The employee department", - "example": "Physics", - "type": "string", - }, - "department_id": { - "description": "The employee department id", - "example": "3093", - "type": "string", - }, - "display_name": { - "description": "The employee display name", - "example": "Sir Isaac Newton", - "type": "string", - }, - "employee_number": { - "description": "The assigned employee number", - "example": "125", - "type": "string", - }, - "employment": { - "description": "The employee employment", - "properties": { - "contract_type": { - "description": "The employment work schedule type", - "properties": { - "contract_type": { - "description": "The employment work schedule type (e.g., full-time, part-time)", - "example": "full_time", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "enum": [ - "full_time", - "shifts", - "part_time", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "label": { - "description": "The label of the employment type", - "example": "Full-Time", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - }, - "type": "object", - }, - "end_date": { - "description": "The end date of employment", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "type": "string", - }, - "grade": { - "description": "Represents the employeeโ€™s position within the organizational hierarchy.", - "properties": { - "description": { - "description": "description of the grade", - "example": "Mid-level employee demonstrating proficiency and autonomy.", - "type": "string", - }, - "id": { - "description": "The reference id", - "example": "1687-3", - "type": "string", - }, - "name": { - "description": "The reference name", - "example": "1687-4", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - }, - "type": "object", - }, - "job_title": { - "description": "The job title of the employee", - "example": "Software Engineer", - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "type": "object", - }, - "pay_currency": { - "description": "The currency used for pay", - "example": "USD", - "type": "string", - }, - "pay_frequency": { - "description": "How often the employee is paid", - "example": "hourly", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "enum": [ - "hourly", - "weekly", - "bi_weekly", - "four_weekly", - "semi_monthly", - "monthly", - "bi_monthly", - "quarterly", - "semi_annually", - "yearly", - "thirteen_monthly", - "pro_rata", - "unmapped_value", - "half_yearly", - "daily", - "fixed", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "pay_period": { - "description": "The time period over which the pay rate is calculated", - "example": "monthly", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "enum": [ - "hour", - "day", - "week", - "every_two_weeks", - "month", - "quarter", - "every_six_months", - "year", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "pay_rate": { - "description": "The amount of compensation for the employee", - "example": "40.00", - "type": "string", - }, - "payroll_code": { - "description": "The payroll code of the employee", - "example": "PC1", - "type": "string", - }, - "type": { - "description": "The type of employment", - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "label": { - "description": "The label of the employment type", - "example": "Permanent", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "type": { - "description": "The type of employment (e.g., contractor, permanent)", - "example": "permanent", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "enum": [ - "contractor", - "intern", - "permanent", - "apprentice", - "freelance", - "terminated", - "temporary", - "seasonal", - "volunteer", - "probation", - "internal", - "external", - "expatriate", - "employer_of_record", - "casual", - "Programme", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - }, - "type": "object", - }, - "unified_custom_fields": { - "additionalProperties": true, - "description": "Custom Unified Fields configured in your StackOne project", - "example": { - "my_project_custom_field_1": "REF-1236", - "my_project_custom_field_2": "some other value", - }, - "type": "object", - }, - "work_time": { - "properties": { - "duration": { - "description": "The work time duration in ISO 8601 duration format", - "example": "P0Y0M0DT8H0M0S", - "format": "duration", - "type": "string", - }, - "period": { - "description": "The period of the work time", - "example": "month", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "The unified value for the period.", - "enum": [ - "day", - "week", - "month", - "year", - "unmapped_value", - null, - ], - "example": "month", - "type": "string", - }, - }, - "type": "object", - }, - }, - "type": "object", - }, - }, - "type": "object", - }, - "employment_status": { - "description": "The employee employment status", - "example": "active", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "enum": [ - "active", - "pending", - "terminated", - "leave", - "inactive", - "unknown", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "ethnicity": { - "description": "The employee ethnicity", - "example": "white", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "enum": [ - "white", - "black_or_african_american", - "asian", - "hispanic_or_latino", - "american_indian_or_alaska_native", - "native_hawaiian_or_pacific_islander", - "two_or_more_races", - "not_disclosed", - "other", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "first_name": { - "description": "The employee first name", - "example": "Isaac", - "type": "string", - }, - "gender": { - "description": "The employee gender", - "example": "male", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "enum": [ - "male", - "female", - "non_binary", - "other", - "not_disclosed", - "diverse", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "hire_date": { - "description": "The employee hire date", - "example": "2021-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "home_location": { - "description": "The employee home location", - "properties": { - "city": { - "description": "The city where the location is situated", - "example": "Grantham", - "type": "string", - }, - "country": { - "description": "The country code", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "name": { - "description": "The name of the location", - "example": "Woolsthorpe Manor", - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "type": "object", - }, - "phone_number": { - "description": "The phone number of the location", - "example": "+44 1476 860 364", - "type": "string", - }, - "state": { - "description": "The ISO3166-2 sub division where the location is situated", - "example": "GB-LIN", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "state (ISO3166-2 Sub Division Code) - value must be a valid enum value", - "type": "string", - }, - }, - "type": "object", - }, - "street_1": { - "description": "The first line of the address", - "example": "Water Lane", - "type": "string", - }, - "street_2": { - "description": "The second line of the address", - "example": "Woolsthorpe by Colsterworth", - "type": "string", - }, - "zip_code": { - "description": "The ZIP code/Postal code of the location", - "example": "NG33 5NR", - "type": "string", - }, - }, - "type": "object", - }, - "job_title": { - "description": "If the source of the job_title is the Employee's current Employment, and that Employment pertains exclusively to this Employee, then the active Employment job_title will also be written", - "example": "Physicist", - "type": "string", - }, - "last_name": { - "description": "The employee last name", - "example": "Newton", - "type": "string", - }, - "manager_id": { - "description": "The employee manager ID", - "example": "67890", - "type": "string", - }, - "marital_status": { - "description": "The employee marital status", - "example": "single", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "enum": [ - "single", - "married", - "common_law", - "divorced", - "widowed", - "domestic_partnership", - "separated", - "other", - "not_disclosed", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "name": { - "description": "The employee name", - "example": "Isaac Newton", - "type": "string", - }, - "national_identity_numbers": { - "description": "The national identity numbers", - "items": { - "properties": { - "country": { - "description": "The country code", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "type": "string", - }, - }, - "type": "object", - }, - "type": { - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "The type of the national identity number", - "enum": [ - "ssn", - "nin", - "sin", - "nid", - "pin", - "pn", - "umcn", - "pic", - "ric", - "idnum", - "cid", - "nidnr", - "pan", - "aadhaar", - "epic", - "ptn", - "itin", - "tin", - "uprc", - "pcode", - "ssi", - "cedula", - "passport", - "voterid", - "ntin", - "bn", - "fnr", - "mva", - "civil_id", - "cnic", - "nric", - "fin", - "uen", - "registrationnumber", - "nic", - "personnummer", - "ahv", - "id", - "eid", - "va", - "pid", - "nrt", - "nipt", - "cbu", - "cuit", - "dni", - "businessid", - "vnr", - "abn", - "acn", - "tfn", - "jmbg", - "bis", - "insz", - "nn", - "egn", - "pnf", - "vat", - "cnpj", - "unp", - "gst", - "pst", - "qst", - "ni", - "dic", - "rc", - "uid", - "rut", - "uscc", - "cpf", - "cpj", - "cr", - "stnr", - "svnr", - "ncf", - "rnc", - "nif", - "ci", - "ik", - "kmkr", - "registrikood", - "tn", - "ruc", - "nit", - "alv", - "hetu", - "ytunnus", - "vn", - "utr", - "nifp", - "amka", - "cui", - "nir", - "siren", - "siret", - "tva", - "oib", - "hkid", - "anum", - "kennitala", - "vsk", - "npwp", - "pps", - "gstin", - "idnr", - "hr", - "aic", - "codicefiscale", - "iva", - "peid", - "asmens", - "pvm", - "ctps", - "vrn", - "vtk", - "int", - "tk", - "pas", - "rne", - "rg", - "nci", - "crnm", - "pis", - "insee", - "tax", - "mpf", - "epfo", - "esi", - "pran", - "uan", - "idk", - "bsn", - "mid", - "sss", - "nie", - "nss", - "arc", - "curp", - "imss", - "rfc", - "ein", - "other", - "unknown", - "unmapped_value", - null, - ], - "example": "ssn", - "type": "string", - }, - }, - "type": "object", - }, - "value": { - "example": "123456789", - "type": "string", - }, - }, - "type": "object", - }, - "type": "array", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "type": "object", - }, - "personal_email": { - "description": "The employee personal email", - "example": "isaac.newton@example.com", - "type": "string", - }, - "personal_phone_number": { - "description": "The employee personal phone number", - "example": "+1234567890", - "type": "string", - }, - "preferred_language": { - "description": "The employee preferred language", - "example": "eng", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "The ISO639-2 Code of the language", - "enum": [ - "aar", - "afr", - "amh", - "ara", - "aym", - "aze", - "bel", - "bul", - "bis", - "ben", - "bos", - "byn", - "cat", - "cha", - "ces", - "dan", - "deu", - "div", - "dzo", - "ell", - "eng", - "spa", - "est", - "fas", - "fan", - "ful", - "fin", - "fij", - "fao", - "fra", - "gle", - "grn", - "guj", - "glv", - "heb", - "hin", - "hrv", - "hat", - "hun", - "hye", - "ind", - "isl", - "ita", - "jpn", - "kat", - "kon", - "kaz", - "kal", - "khm", - "kor", - "kur", - "kir", - "lat", - "ltz", - "lin", - "lao", - "lit", - "lub", - "lav", - "mlg", - "mah", - "mri", - "mkd", - "mon", - "mar", - "msa", - "mlt", - "mya", - "nob", - "nep", - "nld", - "nno", - "nor", - "nbl", - "nya", - "pan", - "pol", - "pus", - "por", - "que", - "rar", - "roh", - "rup", - "ron", - "rus", - "kin", - "sme", - "sag", - "sin", - "slk", - "slv", - "smo", - "sna", - "som", - "sqi", - "srp", - "ssw", - "swe", - "swa", - "tam", - "tel", - "tgk", - "tha", - "tir", - "tig", - "tuk", - "tsn", - "ton", - "tur", - "tso", - "ukr", - "urd", - "uzb", - "ven", - "vie", - "xho", - "zho", - "zul", - "unmapped_value", - null, - ], - "example": "eng", - "type": "string", - }, - }, - "type": "object", - }, - "start_date": { - "description": "The employee start date", - "example": "2021-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "team_id": { - "description": "The employee team id", - "example": "2913", - "type": "string", - }, - "termination_date": { - "description": "The employee termination date", - "example": "2021-01-01T00:00:00Z", - "format": "date-time", - "type": "string", - }, - "title": { - "description": "The prefix of the employee's name (e.g., Mr, Ms, Dr)", - "example": "Mr", - "type": "string", - }, - "work_email": { - "description": "The employee work email", - "example": "newton@example.com", - "type": "string", - }, - "work_location": { - "description": "The employee work location", - "properties": { - "city": { - "description": "The city where the location is situated", - "example": "Grantham", - "type": "string", - }, - "country": { - "description": "The country code", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "name": { - "description": "The name of the location", - "example": "Woolsthorpe Manor", - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "type": "object", - }, - "phone_number": { - "description": "The phone number of the location", - "example": "+44 1476 860 364", - "type": "string", - }, - "state": { - "description": "The ISO3166-2 sub division where the location is situated", - "example": "GB-LIN", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "state (ISO3166-2 Sub Division Code) - value must be a valid enum value", - "type": "string", - }, - }, - "type": "object", - }, - "street_1": { - "description": "The first line of the address", - "example": "Water Lane", - "type": "string", - }, - "street_2": { - "description": "The second line of the address", - "example": "Woolsthorpe by Colsterworth", - "type": "string", - }, - "zip_code": { - "description": "The ZIP code/Postal code of the location", - "example": "NG33 5NR", - "type": "string", - }, - }, - "type": "object", - }, - "work_phone_number": { - "description": "The employee work phone number", - "example": "+1234567890", - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_create_employee_employment": { - "description": "Create Employee Employment", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "POST", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "body", - "name": "unified_custom_fields", - "type": "object", - }, - { - "location": "body", - "name": "job_title", - "type": "string", - }, - { - "location": "body", - "name": "pay_rate", - "type": "string", - }, - { - "location": "body", - "name": "pay_period", - "type": "object", - }, - { - "location": "body", - "name": "pay_frequency", - "type": "object", - }, - { - "location": "body", - "name": "pay_currency", - "type": "string", - }, - { - "location": "body", - "name": "effective_date", - "type": "string", - }, - { - "location": "body", - "name": "end_date", - "type": "string", - }, - { - "location": "body", - "name": "grade", - "type": "object", - }, - { - "location": "body", - "name": "type", - "type": "object", - }, - { - "location": "body", - "name": "contract_type", - "type": "object", - }, - { - "location": "body", - "name": "work_time", - "type": "object", - }, - { - "location": "body", - "name": "payroll_code", - "type": "string", - }, - { - "location": "body", - "name": "job_id", - "type": "string", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/employments", - }, - "parameters": { - "properties": { - "contract_type": { - "description": "The employment work schedule type", - "properties": { - "contract_type": { - "description": "The employment work schedule type (e.g., full-time, part-time)", - "example": "full_time", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "enum": [ - "full_time", - "shifts", - "part_time", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "label": { - "description": "The label of the employment type", - "example": "Full-Time", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - }, - "type": "object", - }, - "effective_date": { - "description": "The effective date of the employment contract", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "type": "string", - }, - "end_date": { - "description": "The end date of employment", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "type": "string", - }, - "grade": { - "description": "Represents the employeeโ€™s position within the organizational hierarchy.", - "properties": { - "description": { - "description": "description of the grade", - "example": "Mid-level employee demonstrating proficiency and autonomy.", - "type": "string", - }, - "id": { - "description": "The reference id", - "example": "1687-3", - "type": "string", - }, - "name": { - "description": "The reference name", - "example": "1687-4", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "job_id": { - "description": "The employee job id", - "example": "5290", - "type": "string", - }, - "job_title": { - "description": "The job title of the employee", - "example": "Software Engineer", - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "type": "object", - }, - "pay_currency": { - "description": "The currency used for pay", - "example": "USD", - "type": "string", - }, - "pay_frequency": { - "description": "How often the employee is paid", - "example": "hourly", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "enum": [ - "hourly", - "weekly", - "bi_weekly", - "four_weekly", - "semi_monthly", - "monthly", - "bi_monthly", - "quarterly", - "semi_annually", - "yearly", - "thirteen_monthly", - "pro_rata", - "unmapped_value", - "half_yearly", - "daily", - "fixed", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "pay_period": { - "description": "The time period over which the pay rate is calculated", - "example": "monthly", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "enum": [ - "hour", - "day", - "week", - "every_two_weeks", - "month", - "quarter", - "every_six_months", - "year", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "pay_rate": { - "description": "The amount of compensation for the employee", - "example": "40.00", - "type": "string", - }, - "payroll_code": { - "description": "The payroll code of the employee", - "example": "PC1", - "type": "string", - }, - "type": { - "description": "The type of employment", - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "label": { - "description": "The label of the employment type", - "example": "Permanent", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "type": { - "description": "The type of employment (e.g., contractor, permanent)", - "example": "permanent", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "enum": [ - "contractor", - "intern", - "permanent", - "apprentice", - "freelance", - "terminated", - "temporary", - "seasonal", - "volunteer", - "probation", - "internal", - "external", - "expatriate", - "employer_of_record", - "casual", - "Programme", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - }, - "type": "object", - }, - "unified_custom_fields": { - "additionalProperties": true, - "description": "Custom Unified Fields configured in your StackOne project", - "example": { - "my_project_custom_field_1": "REF-1236", - "my_project_custom_field_2": "some other value", - }, - "type": "object", - }, - "work_time": { - "properties": { - "duration": { - "description": "The work time duration in ISO 8601 duration format", - "example": "P0Y0M0DT8H0M0S", - "format": "duration", - "type": "string", - }, - "period": { - "description": "The period of the work time", - "example": "month", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "The unified value for the period.", - "enum": [ - "day", - "week", - "month", - "year", - "unmapped_value", - null, - ], - "example": "month", - "type": "string", - }, - }, - "type": "object", - }, - }, - "type": "object", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_create_employee_skill": { - "description": "Create Employee Skill", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "POST", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "body", - "name": "id", - "type": "string", - }, - { - "location": "body", - "name": "name", - "type": "string", - }, - { - "location": "body", - "name": "maximum_proficiency", - "type": "object", - }, - { - "location": "body", - "name": "minimum_proficiency", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/skills", - }, - "parameters": { - "properties": { - "id": { - "description": "The ID associated with this skill", - "example": "16873-IT345", - "type": "string", - }, - "maximum_proficiency": { - "description": "The proficiency level of the skill", - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "name": { - "description": "The name associated with this proficiency", - "example": "Expert", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "enum": [ - "1", - "2", - "3", - "4", - "5", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "minimum_proficiency": { - "description": "The proficiency level of the skill", - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "name": { - "description": "The name associated with this proficiency", - "example": "Expert", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "enum": [ - "1", - "2", - "3", - "4", - "5", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "name": { - "description": "The name associated with this skill", - "example": "Information-Technology", - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_create_employee_time_off_request": { - "description": "Create Employee Time Off Request", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "POST", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "body", - "name": "approver_id", - "type": "string", - }, - { - "location": "body", - "name": "status", - "type": "object", - }, - { - "location": "body", - "name": "start_date", - "type": "string", - }, - { - "location": "body", - "name": "end_date", - "type": "string", - }, - { - "location": "body", - "name": "start_half_day", - "type": "string", - }, - { - "location": "body", - "name": "end_half_day", - "type": "string", - }, - { - "location": "body", - "name": "time_off_policy_id", - "type": "string", - }, - { - "location": "body", - "name": "reason", - "type": "object", - }, - { - "location": "body", - "name": "comment", - "type": "string", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off", - }, - "parameters": { - "properties": { - "approver_id": { - "description": "The approver ID", - "example": "1687-4", - "type": "string", - }, - "comment": { - "description": "Allows users to provide additional context or notes for their time off request", - "example": "Taking a day off for personal reasons", - "type": "string", - }, - "end_date": { - "description": "Inclusive end date of the time off request (ISO8601 date-time without timezone). The time off includes this day", - "example": "2021-01-01T01:01:01.000", - "format": "datetime-local", - "type": "string", - }, - "end_half_day": { - "description": "True if the end of the time off request ends half way through the day", - "example": true, - "oneOf": [ - { - "type": "boolean", - }, - { - "enum": [ - "true", - "false", - ], - "type": "string", - }, - ], - }, - "id": { - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "type": "object", - }, - "reason": { - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "name": { - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - }, - "type": "object", - }, - "start_date": { - "description": "The start date of the time off request (ISO8601 date-time without timezone)", - "example": "2021-01-01T01:01:01.000", - "format": "datetime-local", - "type": "string", - }, - "start_half_day": { - "description": "True if the start of the time off request begins half way through the day", - "example": true, - "oneOf": [ - { - "type": "boolean", - }, - { - "enum": [ - "true", - "false", - ], - "type": "string", - }, - ], - }, - "status": { - "description": "The status of the time off request", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "enum": [ - "approved", - "cancelled", - "rejected", - "pending", - "deleted", - "draft", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "time_off_policy_id": { - "description": "The time off policy id associated with this time off request", - "example": "cx280928933", - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_create_employee_work_eligibility_request": { - "description": "Create Employee Work Eligibility Request", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "POST", - "params": [ - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "body", - "name": "document", - "type": "object", - }, - { - "location": "body", - "name": "issued_by", - "type": "object", - }, - { - "location": "body", - "name": "number", - "type": "string", - }, - { - "location": "body", - "name": "sub_type", - "type": "string", - }, - { - "location": "body", - "name": "type", - "type": "object", - }, - { - "location": "body", - "name": "valid_from", - "type": "string", - }, - { - "location": "body", - "name": "valid_to", - "type": "string", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/work_eligibility", - }, - "parameters": { - "properties": { - "document": { - "properties": { - "category": { - "description": "The category of the file", - "example": "templates, forms, backups, etc.", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "The category of the file", - "type": "string", - }, - }, - "type": "object", - }, - "category_id": { - "description": "The categoryId of the documents", - "example": "6530", - "type": "string", - }, - "created_at": { - "description": "The creation date of the file", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "type": "string", - }, - "file_format": { - "description": "The file format of the file", - "properties": { - "source_value": { - "example": "application/pdf", - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "The file format of the file, expressed as a file extension", - "enum": [ - "unmapped_value", - "ez", - "aw", - "atom", - "atomcat", - "atomdeleted", - "atomsvc", - "dwd", - "held", - "rsat", - "bdoc", - "xcs", - "ccxml", - "cdfx", - "cdmia", - "cdmic", - "cdmid", - "cdmio", - "cdmiq", - "cu", - "mpd", - "davmount", - "dbk", - "dssc", - "xdssc", - "es", - "ecma", - "emma", - "emotionml", - "epub", - "exi", - "exp", - "fdt", - "pfr", - "geojson", - "gml", - "gpx", - "gxf", - "gz", - "hjson", - "stk", - "ink", - "inkml", - "ipfix", - "its", - "jar", - "war", - "ear", - "ser", - "class", - "js", - "mjs", - "json", - "map", - "json5", - "jsonml", - "jsonld", - "lgr", - "lostxml", - "hqx", - "cpt", - "mads", - "webmanifest", - "mrc", - "mrcx", - "ma", - "nb", - "mb", - "mathml", - "mbox", - "mscml", - "metalink", - "meta4", - "mets", - "maei", - "musd", - "mods", - "m21", - "mp21", - "mp4s", - "m4p", - "doc", - "dot", - "mxf", - "nq", - "nt", - "cjs", - "bin", - "dms", - "lrf", - "mar", - "so", - "dist", - "distz", - "pkg", - "bpk", - "dump", - "elc", - "deploy", - "exe", - "dll", - "deb", - "dmg", - "iso", - "img", - "msi", - "msp", - "msm", - "buffer", - "oda", - "opf", - "ogx", - "omdoc", - "onetoc", - "onetoc2", - "onetmp", - "onepkg", - "oxps", - "relo", - "xer", - "pdf", - "pgp", - "asc", - "sig", - "prf", - "p10", - "p7m", - "p7c", - "p7s", - "p8", - "ac", - "cer", - "crl", - "pkipath", - "pki", - "pls", - "ai", - "eps", - "ps", - "provx", - "pskcxml", - "raml", - "rdf", - "owl", - "rif", - "rnc", - "rl", - "rld", - "rs", - "rapd", - "sls", - "rusd", - "gbr", - "mft", - "roa", - "rsd", - "rss", - "rtf", - "sbml", - "scq", - "scs", - "spq", - "spp", - "sdp", - "senmlx", - "sensmlx", - "setpay", - "setreg", - "shf", - "siv", - "sieve", - "smi", - "smil", - "rq", - "srx", - "gram", - "grxml", - "sru", - "ssdl", - "ssml", - "swidtag", - "tei", - "teicorpus", - "tfi", - "tsd", - "toml", - "trig", - "ttml", - "ubj", - "rsheet", - "td", - "vxml", - "wasm", - "wgt", - "hlp", - "wsdl", - "wspolicy", - "xaml", - "xav", - "xca", - "xdf", - "xel", - "xns", - "xenc", - "xhtml", - "xht", - "xlf", - "xml", - "xsl", - "xsd", - "rng", - "dtd", - "xop", - "xpl", - "*xsl", - "xslt", - "xspf", - "mxml", - "xhvml", - "xvml", - "xvm", - "yang", - "yin", - "zip", - "*3gpp", - "adp", - "amr", - "au", - "snd", - "mid", - "midi", - "kar", - "rmi", - "mxmf", - "*mp3", - "m4a", - "mp4a", - "mpga", - "mp2", - "mp2a", - "mp3", - "m2a", - "m3a", - "oga", - "ogg", - "spx", - "opus", - "s3m", - "sil", - "wav", - "*wav", - "weba", - "xm", - "ttc", - "otf", - "ttf", - "woff", - "woff2", - "exr", - "apng", - "avif", - "bmp", - "cgm", - "drle", - "emf", - "fits", - "g3", - "gif", - "heic", - "heics", - "heif", - "heifs", - "hej2", - "hsj2", - "ief", - "jls", - "jp2", - "jpg2", - "jpeg", - "jpg", - "jpe", - "jph", - "jhc", - "jpm", - "jpx", - "jpf", - "jxr", - "jxra", - "jxrs", - "jxs", - "jxsc", - "jxsi", - "jxss", - "ktx", - "ktx2", - "png", - "sgi", - "svg", - "svgz", - "t38", - "tif", - "tiff", - "tfx", - "webp", - "wmf", - "disposition-notification", - "u8msg", - "u8dsn", - "u8mdn", - "u8hdr", - "eml", - "mime", - "3mf", - "gltf", - "glb", - "igs", - "iges", - "msh", - "mesh", - "silo", - "mtl", - "obj", - "stpx", - "stpz", - "stpxz", - "stl", - "wrl", - "vrml", - "*x3db", - "x3dbz", - "x3db", - "*x3dv", - "x3dvz", - "x3d", - "x3dz", - "x3dv", - "appcache", - "manifest", - "ics", - "ifb", - "coffee", - "litcoffee", - "css", - "csv", - "html", - "htm", - "shtml", - "jade", - "jsx", - "less", - "markdown", - "md", - "mml", - "mdx", - "n3", - "txt", - "text", - "conf", - "def", - "list", - "log", - "in", - "ini", - "rtx", - "*rtf", - "sgml", - "sgm", - "shex", - "slim", - "slm", - "spdx", - "stylus", - "styl", - "tsv", - "t", - "tr", - "roff", - "man", - "me", - "ms", - "ttl", - "uri", - "uris", - "urls", - "vcard", - "vtt", - "*xml", - "yaml", - "yml", - "3gp", - "3gpp", - "3g2", - "h261", - "h263", - "h264", - "m4s", - "jpgv", - "*jpm", - "jpgm", - "mj2", - "mjp2", - "ts", - "mp4", - "mp4v", - "mpg4", - "mpeg", - "mpg", - "mpe", - "m1v", - "m2v", - "ogv", - "qt", - "mov", - "webm", - "cww", - "1km", - "plb", - "psb", - "pvb", - "tcap", - "pwn", - "aso", - "imp", - "acu", - "atc", - "acutc", - "air", - "fcdt", - "fxp", - "fxpl", - "xdp", - "xfdf", - "ahead", - "azf", - "azs", - "azw", - "acc", - "ami", - "apk", - "cii", - "fti", - "atx", - "mpkg", - "key", - "m3u8", - "numbers", - "pages", - "pkpass", - "swi", - "iota", - "aep", - "bmml", - "mpm", - "bmi", - "rep", - "cdxml", - "mmd", - "cdy", - "csl", - "cla", - "rp9", - "c4g", - "c4d", - "c4f", - "c4p", - "c4u", - "c11amc", - "c11amz", - "csp", - "cdbcmsg", - "cmc", - "clkx", - "clkk", - "clkp", - "clkt", - "clkw", - "wbs", - "pml", - "ppd", - "car", - "pcurl", - "dart", - "rdz", - "dbf", - "uvf", - "uvvf", - "uvd", - "uvvd", - "uvt", - "uvvt", - "uvx", - "uvvx", - "uvz", - "uvvz", - "fe_launch", - "dna", - "mlp", - "mle", - "dpg", - "dfac", - "kpxx", - "ait", - "svc", - "geo", - "mag", - "nml", - "esf", - "msf", - "qam", - "slt", - "ssf", - "es3", - "et3", - "ez2", - "ez3", - "fdf", - "mseed", - "seed", - "dataless", - "gph", - "ftc", - "fm", - "frame", - "maker", - "book", - "fnc", - "ltf", - "fsc", - "oas", - "oa2", - "oa3", - "fg5", - "bh2", - "ddd", - "xdw", - "xbd", - "fzs", - "txd", - "ggb", - "ggt", - "gex", - "gre", - "gxt", - "g2w", - "g3w", - "gmx", - "gdoc", - "gslides", - "gsheet", - "kml", - "kmz", - "gqf", - "gqs", - "gac", - "ghf", - "gim", - "grv", - "gtm", - "tpl", - "vcg", - "hal", - "zmm", - "hbci", - "les", - "hpgl", - "hpid", - "hps", - "jlt", - "pcl", - "pclxl", - "sfd-hdstx", - "mpy", - "afp", - "listafp", - "list3820", - "irm", - "sc", - "icc", - "icm", - "igl", - "ivp", - "ivu", - "igm", - "xpw", - "xpx", - "i2g", - "qbo", - "qfx", - "rcprofile", - "irp", - "xpr", - "fcs", - "jam", - "rms", - "jisp", - "joda", - "ktz", - "ktr", - "karbon", - "chrt", - "kfo", - "flw", - "kon", - "kpr", - "kpt", - "ksp", - "kwd", - "kwt", - "htke", - "kia", - "kne", - "knp", - "skp", - "skd", - "skt", - "skm", - "sse", - "lasxml", - "lbd", - "lbe", - "apr", - "pre", - "nsf", - "org", - "scm", - "lwp", - "portpkg", - "mvt", - "mcd", - "mc1", - "cdkey", - "mwf", - "mfm", - "flo", - "igx", - "mif", - "daf", - "dis", - "mbk", - "mqy", - "msl", - "plc", - "txf", - "mpn", - "mpc", - "xul", - "cil", - "cab", - "xls", - "xlm", - "xla", - "xlc", - "xlt", - "xlw", - "xlam", - "xlsb", - "xlsm", - "xltm", - "eot", - "chm", - "ims", - "lrm", - "thmx", - "msg", - "cat", - "*stl", - "ppt", - "pps", - "pot", - "ppam", - "pptm", - "sldm", - "ppsm", - "potm", - "mpp", - "mpt", - "docm", - "dotm", - "wps", - "wks", - "wcm", - "wdb", - "wpl", - "xps", - "mseq", - "mus", - "msty", - "taglet", - "nlu", - "ntf", - "nitf", - "nnd", - "nns", - "nnw", - "*ac", - "ngdat", - "n-gage", - "rpst", - "rpss", - "edm", - "edx", - "ext", - "odc", - "otc", - "odb", - "odf", - "odft", - "odg", - "otg", - "odi", - "oti", - "odp", - "otp", - "ods", - "ots", - "odt", - "odm", - "ott", - "oth", - "xo", - "dd2", - "obgx", - "oxt", - "osm", - "pptx", - "sldx", - "ppsx", - "potx", - "xlsx", - "xltx", - "docx", - "dotx", - "mgp", - "dp", - "esa", - "pdb", - "pqa", - "oprc", - "paw", - "str", - "ei6", - "efif", - "wg", - "plf", - "pbd", - "box", - "mgz", - "qps", - "ptid", - "qxd", - "qxt", - "qwd", - "qwt", - "qxl", - "qxb", - "rar", - "bed", - "mxl", - "musicxml", - "cryptonote", - "cod", - "rm", - "rmvb", - "link66", - "st", - "see", - "sema", - "semd", - "semf", - "ifm", - "itp", - "iif", - "ipk", - "twd", - "twds", - "mmf", - "teacher", - "fo", - "sdkm", - "sdkd", - "dxp", - "sfs", - "sdc", - "sda", - "sdd", - "smf", - "sdw", - "vor", - "sgl", - "smzip", - "sm", - "wadl", - "sxc", - "stc", - "sxd", - "std", - "sxi", - "sti", - "sxm", - "sxw", - "sxg", - "stw", - "sus", - "susp", - "svd", - "sis", - "sisx", - "xsm", - "bdm", - "xdm", - "ddf", - "tao", - "pcap", - "cap", - "dmp", - "tmo", - "tpt", - "mxs", - "tra", - "ufd", - "ufdl", - "utz", - "umj", - "unityweb", - "uoml", - "vcx", - "vsd", - "vst", - "vss", - "vsw", - "vis", - "vsf", - "wbxml", - "wmlc", - "wmlsc", - "wtb", - "nbp", - "wpd", - "wqd", - "stf", - "xar", - "xfdl", - "hvd", - "hvs", - "hvp", - "osf", - "osfpvg", - "saf", - "spf", - "cmp", - "zir", - "zirz", - "zaz", - "7z", - "abw", - "ace", - "*dmg", - "arj", - "aab", - "x32", - "u32", - "vox", - "aam", - "aas", - "bcpio", - "*bdoc", - "torrent", - "blb", - "blorb", - "bz", - "bz2", - "boz", - "cbr", - "cba", - "cbt", - "cbz", - "cb7", - "vcd", - "cfs", - "chat", - "pgn", - "crx", - "cco", - "nsc", - "cpio", - "csh", - "*deb", - "udeb", - "dgc", - "dir", - "dcr", - "dxr", - "cst", - "cct", - "cxt", - "w3d", - "fgd", - "swa", - "wad", - "ncx", - "dtb", - "res", - "dvi", - "evy", - "eva", - "bdf", - "gsf", - "psf", - "pcf", - "snf", - "pfa", - "pfb", - "pfm", - "afm", - "arc", - "spl", - "gca", - "ulx", - "gnumeric", - "gramps", - "gtar", - "hdf", - "php", - "install", - "*iso", - "*key", - "*numbers", - "*pages", - "jardiff", - "jnlp", - "kdbx", - "latex", - "luac", - "lzh", - "lha", - "run", - "mie", - "prc", - "mobi", - "application", - "lnk", - "wmd", - "wmz", - "xbap", - "mdb", - "obd", - "crd", - "clp", - "*exe", - "*dll", - "com", - "bat", - "*msi", - "mvb", - "m13", - "m14", - "*wmf", - "*wmz", - "*emf", - "emz", - "mny", - "pub", - "scd", - "trm", - "wri", - "nc", - "cdf", - "pac", - "nzb", - "pl", - "pm", - "*prc", - "*pdb", - "p12", - "pfx", - "p7b", - "spc", - "p7r", - "*rar", - "rpm", - "ris", - "sea", - "sh", - "shar", - "swf", - "xap", - "sql", - "sit", - "sitx", - "srt", - "sv4cpio", - "sv4crc", - "t3", - "gam", - "tar", - "tcl", - "tk", - "tex", - "tfm", - "texinfo", - "texi", - "*obj", - "ustar", - "hdd", - "ova", - "ovf", - "vbox", - "vbox-extpack", - "vdi", - "vhd", - "vmdk", - "src", - "webapp", - "der", - "crt", - "pem", - "fig", - "*xlf", - "xpi", - "xz", - "z1", - "z2", - "z3", - "z4", - "z5", - "z6", - "z7", - "z8", - "uva", - "uvva", - "eol", - "dra", - "dts", - "dtshd", - "lvp", - "pya", - "ecelp4800", - "ecelp7470", - "ecelp9600", - "rip", - "aac", - "aif", - "aiff", - "aifc", - "caf", - "flac", - "*m4a", - "mka", - "m3u", - "wax", - "wma", - "ram", - "ra", - "rmp", - "*ra", - "cdx", - "cif", - "cmdf", - "cml", - "csml", - "xyz", - "btif", - "pti", - "psd", - "azv", - "uvi", - "uvvi", - "uvg", - "uvvg", - "djvu", - "djv", - "*sub", - "dwg", - "dxf", - "fbs", - "fpx", - "fst", - "mmr", - "rlc", - "ico", - "dds", - "mdi", - "wdp", - "npx", - "b16", - "tap", - "vtf", - "wbmp", - "xif", - "pcx", - "3ds", - "ras", - "cmx", - "fh", - "fhc", - "fh4", - "fh5", - "fh7", - "*ico", - "jng", - "sid", - "*bmp", - "*pcx", - "pic", - "pct", - "pnm", - "pbm", - "pgm", - "ppm", - "rgb", - "tga", - "xbm", - "xpm", - "xwd", - "wsc", - "dae", - "dwf", - "gdl", - "gtw", - "mts", - "ogex", - "x_b", - "x_t", - "vds", - "usdz", - "bsp", - "vtu", - "dsc", - "curl", - "dcurl", - "mcurl", - "scurl", - "sub", - "fly", - "flx", - "gv", - "3dml", - "spot", - "jad", - "wml", - "wmls", - "s", - "asm", - "c", - "cc", - "cxx", - "cpp", - "h", - "hh", - "dic", - "htc", - "f", - "for", - "f77", - "f90", - "hbs", - "java", - "lua", - "mkd", - "nfo", - "opml", - "*org", - "p", - "pas", - "pde", - "sass", - "scss", - "etx", - "sfv", - "ymp", - "uu", - "vcs", - "vcf", - "uvh", - "uvvh", - "uvm", - "uvvm", - "uvp", - "uvvp", - "uvs", - "uvvs", - "uvv", - "uvvv", - "dvb", - "fvt", - "mxu", - "m4u", - "pyv", - "uvu", - "uvvu", - "viv", - "f4v", - "fli", - "flv", - "m4v", - "mkv", - "mk3d", - "mks", - "mng", - "asf", - "asx", - "vob", - "wm", - "wmv", - "wmx", - "wvx", - "avi", - "movie", - "smv", - "ice", - "mht", - null, - ], - "example": "pdf", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "name": { - "description": "The name of the file", - "example": "My Document", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "remote_url": { - "description": "URL where the file content is located", - "example": "https://example.com/file.pdf", - "type": "string", - }, - "updated_at": { - "description": "The update date of the file", - "example": "2021-01-02T01:01:01.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "issued_by": { - "description": "The country code of the issued by authority", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "type": "string", - }, - }, - "type": "object", - }, - "number": { - "example": "1234567890", - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "type": "object", - }, - "sub_type": { - "example": "H1B", - "type": "string", - }, - "type": { - "example": "visa", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "enum": [ - "visa", - "passport", - "driver_license", - "birth_certificate", - "other", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "valid_from": { - "example": "2021-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "valid_to": { - "example": "2021-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_download_employee_document": { - "description": "Download Employee Document", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "format", - "type": "string", - }, - { - "location": "query", - "name": "export_format", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/documents/{subResourceId}/download", - }, - "parameters": { - "properties": { - "export_format": { - "description": "The export format of the file", - "example": "text/plain", - "type": "string", - }, - "format": { - "description": "The format to download the file in", - "example": "base64", - "type": "string", - }, - "id": { - "type": "string", - }, - "subResourceId": { - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - }, - "hris_get_benefit": { - "description": "Get Benefit", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/benefits/{id}", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,benefit_type,provider,description,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_company": { - "description": "Get Company", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/companies/{id}", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,full_name,display_name,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_company_group": { - "description": "Get Company Group", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/companies/{id}", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,full_name,display_name,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_cost_center_group": { - "description": "Get Cost Center Group", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/cost_centers/{id}", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,distribution_percentage,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_department_group": { - "description": "Get Department Group", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/departments/{id}", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_division_group": { - "description": "Get Division Group", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/divisions/{id}", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_employee": { - "description": "Get Employee", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - { - "location": "query", - "name": "include", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}", - }, - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "company,employments,work_location,home_location,groups,skills", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,title,first_name,last_name,name,display_name,gender,ethnicity,date_of_birth,birthday,marital_status,avatar_url,avatar,personal_email,personal_phone_number,work_email,work_phone_number,job_id,remote_job_id,job_title,job_description,department_id,remote_department_id,department,cost_centers,company,manager_id,remote_manager_id,hire_date,start_date,tenure,work_anniversary,employment_type,employment_contract_type,employment_status,termination_date,company_name,company_id,remote_company_id,preferred_language,citizenships,home_location,work_location,employments,custom_fields,created_at,updated_at,benefits,employee_number,national_identity_number,national_identity_numbers,bank_details,skills,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "include": { - "description": "The comma separated list of fields that will be included in the response", - "example": "avatar_url,avatar,custom_fields,job_description,benefits,bank_details", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_employee_custom_field_definition": { - "description": "Get employee Custom Field Definition", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/custom_field_definitions/employees/{id}", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,description,type,options,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_employee_document": { - "description": "Get Employee Document", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/documents/{subResourceId}", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "subResourceId": { - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - }, - "hris_get_employee_document_category": { - "description": "Get Employee Document Category", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/documents/employee_categories/{id}", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,active,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_employee_employment": { - "description": "Get Employee Employment", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/employments/{subResourceId}", - }, - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "groups", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,job_title,pay_rate,pay_period,pay_frequency,pay_currency,effective_date,end_date,employment_type,employment_contract_type,type,contract_type,change_reason,grade,work_time,payroll_code,fte,created_at,updated_at,start_date,active,department,team,cost_center,cost_centers,division,job,manager,groups,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "subResourceId": { - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - }, - "hris_get_employee_shift": { - "description": "Get Employee Shift", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/shifts/{subResourceId}", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields to return in the response (if empty, all fields are returned)", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "subResourceId": { - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - }, - "hris_get_employee_skill": { - "description": "Get Employee Skill", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/skills/{subResourceId}", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,active,language,maximum_proficiency,minimum_proficiency,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "subResourceId": { - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - }, - "hris_get_employee_task": { - "description": "Get Employee Task", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/tasks/{subResourceId}", - }, - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "attachments", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,name,description,type,status,due_date,completion_date,assigned_by_employee_id,remote_assigned_by_employee_id,assigned_by_employee_name,link_to_task,extracted_links,next_task_id,remote_next_task_id,parent_process_name,comments,attachments,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "subResourceId": { - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - }, - "hris_get_employee_time_off_balance": { - "description": "Get Employee Time Off Balance", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off_balances/{subResourceId}", - }, - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "policy", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,policy_id,remote_policy_id,policy,current_balance,initial_balance,balance_unit,balance_start_date,balance_expiry_date,is_unlimited,updated_at,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "subResourceId": { - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - }, - "hris_get_employees_time_off_request": { - "description": "Get Employees Time Off Request", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off/{subResourceId}", - }, - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "policy", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,time_off_policy_id,remote_time_off_policy_id,reason,comment,duration,created_at,updated_at,policy,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "subResourceId": { - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - }, - "hris_get_employees_work_eligibility": { - "description": "Get Employees Work Eligibility", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/work_eligibility/{subResourceId}", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,type,sub_type,document,valid_from,valid_to,issued_by,number,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "subResourceId": { - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - }, - "hris_get_employment": { - "description": "Get Employment", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employments/{id}", - }, - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "groups", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,job_title,pay_rate,pay_period,pay_frequency,pay_currency,effective_date,end_date,employment_type,employment_contract_type,type,contract_type,change_reason,grade,work_time,payroll_code,fte,created_at,updated_at,start_date,active,department,team,cost_center,cost_centers,division,job,manager,groups,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_group": { - "description": "Get Group", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/{id}", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_job": { - "description": "Get Job", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/jobs/{id}", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,code,title,description,status,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_location": { - "description": "Get Work Location", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/locations/{id}", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,name,phone_number,street_1,street_2,city,state,zip_code,country,location_type,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_position": { - "description": "Get Position", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/positions/{id}", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields to return in the response (if empty, all fields are returned)", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_shift": { - "description": "Get Shift", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/shifts/{id}", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields to return in the response (if empty, all fields are returned)", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_task": { - "description": "Get Task", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/tasks/{id}", - }, - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "attachments", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,name,description,type,status,due_date,completion_date,assigned_by_employee_id,remote_assigned_by_employee_id,assigned_by_employee_name,link_to_task,extracted_links,next_task_id,remote_next_task_id,parent_process_name,comments,attachments,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_team_group": { - "description": "Get Team Group", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/teams/{id}", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_time_entries": { - "description": "Get Time Entry", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_entries/{id}", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,start_time,end_time,hours_worked,break_duration,labor_type,location,status,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_time_off_policy": { - "description": "Get Time Off Policy", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_off_policies/{id}", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,description,type,duration_unit,reasons,updated_at,created_at,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_time_off_request": { - "description": "Get time off request", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_off/{id}", - }, - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "policy", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,time_off_policy_id,remote_time_off_policy_id,reason,comment,duration,created_at,updated_at,policy,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_time_off_type": { - "description": "Get time off type", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_off_types/{id}", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,active,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_invite_employee": { - "description": "Invite Employee", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "POST", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/invite", - }, - "parameters": { - "properties": { - "id": { - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "type": "object", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_list_benefits": { - "description": "List benefits", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/benefits", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,benefit_type,provider,description,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_companies": { - "description": "List Companies", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/companies", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,full_name,display_name,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_companies_groups": { - "description": "List Companies Groups", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/companies", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,full_name,display_name,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_cost_center_groups": { - "description": "List Cost Center Groups", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/cost_centers", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,distribution_percentage,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_department_groups": { - "description": "List Department Groups", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/departments", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_division_groups": { - "description": "List Division Groups", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/divisions", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_employee_categories": { - "description": "List Employee Document Categories", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/documents/employee_categories", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,active,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_employee_custom_field_definitions": { - "description": "List employee Custom Field Definitions", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/custom_field_definitions/employees", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,description,type,options,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_employee_documents": { - "description": "List Employee Documents", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/documents", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_list_employee_employments": { - "description": "List Employee Employments", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/employments", - }, - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "groups", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,job_title,pay_rate,pay_period,pay_frequency,pay_currency,effective_date,end_date,employment_type,employment_contract_type,type,contract_type,change_reason,grade,work_time,payroll_code,fte,created_at,updated_at,start_date,active,department,team,cost_center,cost_centers,division,job,manager,groups,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_list_employee_shifts": { - "description": "List Employee Shifts", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/shifts", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields to return in the response (if empty, all fields are returned)", - "type": "string", - }, - "filter": { - "description": "HRIS Employee Shifts filters", - "properties": { - "ends_before": { - "description": "Filter shifts that end before this date", - "example": "2024-01-15T17:00", - "format": "datetime-local", - "type": "string", - }, - "starts_after": { - "description": "Filter shifts that start after this date", - "example": "2024-01-15T09:00", - "format": "datetime-local", - "type": "string", - }, - "status": { - "description": "Filter to select shifts by status", - "enum": [ - "draft", - "published", - "confirmed", - "cancelled", - "unmapped_value", - ], - "type": "string", - }, - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_list_employee_skills": { - "description": "List Employee Skills", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/skills", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,active,language,maximum_proficiency,minimum_proficiency,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_list_employee_tasks": { - "description": "List Employee Tasks", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/tasks", - }, - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "attachments", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,name,description,type,status,due_date,completion_date,assigned_by_employee_id,remote_assigned_by_employee_id,assigned_by_employee_name,link_to_task,extracted_links,next_task_id,remote_next_task_id,parent_process_name,comments,attachments,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "filter": { - "additionalProperties": false, - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "created_after": { - "description": "Use a string with a date to only select results created after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "updated_after": { - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_list_employee_time_off_balances": { - "description": "List Employee Time Off Balances", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off_balances", - }, - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "policy", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,policy_id,remote_policy_id,policy,current_balance,initial_balance,balance_unit,balance_start_date,balance_expiry_date,is_unlimited,updated_at,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "HRIS Time Off Balance filters", - "properties": { - "policy_ids": { - "additionalProperties": false, - "description": "List of policy ids to filter time off balances by.", - "items": { - "type": "string", - }, - "type": "array", - }, - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_list_employee_time_off_policies": { - "description": "List Assigned Time Off Policies", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off_policies", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,description,type,duration_unit,reasons,updated_at,created_at,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "HRIS Time-Off Policies filters", - "properties": { - "type": { - "description": "Filter to select time-off policies by type", - "enum": [ - "sick", - "unmapped_value", - "vacation", - "long_term_disability", - "short_term_disability", - "absent", - "comp_time", - "training", - "annual_leave", - "leave_of_absence", - "break", - "child_care_leave", - "maternity_leave", - "jury_duty", - "sabbatical", - "accident", - "paid", - "unpaid", - "holiday", - "personal", - "in_lieu", - "bereavement", - "other", - null, - ], - "type": "string", - }, - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_list_employee_time_off_requests": { - "description": "List Employee Time Off Requests", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off", - }, - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "policy", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,time_off_policy_id,remote_time_off_policy_id,reason,comment,duration,created_at,updated_at,policy,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "HRIS Time Off filters", - "properties": { - "end_date": { - "additionalProperties": false, - "description": "Filter to include time off requests that end on or before this date.", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "policy_ids": { - "additionalProperties": false, - "description": "List of time off policy ids to filter by.", - "items": { - "type": "string", - }, - "type": "array", - }, - "start_date": { - "additionalProperties": false, - "description": "Filter to include time off requests that start on or after this date.", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_list_employee_work_eligibility": { - "description": "List Employee Work Eligibility", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/work_eligibility", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,type,sub_type,document,valid_from,valid_to,issued_by,number,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_list_employees": { - "description": "List Employees", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - { - "location": "query", - "name": "include", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees", - }, - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "company,employments,work_location,home_location,groups,skills", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,title,first_name,last_name,name,display_name,gender,ethnicity,date_of_birth,birthday,marital_status,avatar_url,avatar,personal_email,personal_phone_number,work_email,work_phone_number,job_id,remote_job_id,job_title,job_description,department_id,remote_department_id,department,cost_centers,company,manager_id,remote_manager_id,hire_date,start_date,tenure,work_anniversary,employment_type,employment_contract_type,employment_status,termination_date,company_name,company_id,remote_company_id,preferred_language,citizenships,home_location,work_location,employments,custom_fields,created_at,updated_at,benefits,employee_number,national_identity_number,national_identity_numbers,bank_details,skills,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "HRIS Employees filters", - "properties": { - "email": { - "description": "Filter to select employees by email", - "type": "string", - }, - "employee_number": { - "description": "Filter to select employees by employee_number", - "type": "string", - }, - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "include": { - "description": "The comma separated list of fields that will be included in the response", - "example": "avatar_url,avatar,custom_fields,job_description,benefits,bank_details", - "type": "string", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_employments": { - "description": "List Employments", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employments", - }, - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "groups", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,job_title,pay_rate,pay_period,pay_frequency,pay_currency,effective_date,end_date,employment_type,employment_contract_type,type,contract_type,change_reason,grade,work_time,payroll_code,fte,created_at,updated_at,start_date,active,department,team,cost_center,cost_centers,division,job,manager,groups,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_groups": { - "description": "List Groups", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_jobs": { - "description": "List Jobs", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/jobs", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,code,title,description,status,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_locations": { - "description": "List Work Locations", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/locations", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,name,phone_number,street_1,street_2,city,state,zip_code,country,location_type,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_positions": { - "description": "List Positions", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "status", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/positions", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields to return in the response (if empty, all fields are returned)", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "status": { - "description": "Filter positions by status", - "enum": [ - "open", - "draft", - "closed", - "paused", - "unmapped_value", - null, - ], - "example": "open", - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_shifts": { - "description": "List Shifts", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/shifts", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields to return in the response (if empty, all fields are returned)", - "type": "string", - }, - "filter": { - "description": "HRIS Shifts filters", - "properties": { - "ends_before": { - "description": "Filter shifts that end before this date", - "example": "2024-01-15T17:00", - "format": "datetime-local", - "type": "string", - }, - "starts_after": { - "description": "Filter shifts that start after this date", - "example": "2024-01-15T09:00", - "format": "datetime-local", - "type": "string", - }, - "status": { - "description": "Filter to select shifts by status", - "enum": [ - "draft", - "published", - "confirmed", - "cancelled", - "unmapped_value", - ], - "type": "string", - }, - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_tasks": { - "description": "List Tasks", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/tasks", - }, - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "attachments", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,name,description,type,status,due_date,completion_date,assigned_by_employee_id,remote_assigned_by_employee_id,assigned_by_employee_name,link_to_task,extracted_links,next_task_id,remote_next_task_id,parent_process_name,comments,attachments,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "filter": { - "additionalProperties": false, - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "created_after": { - "description": "Use a string with a date to only select results created after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "updated_after": { - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_team_groups": { - "description": "List Team Groups", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/teams", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_time_entries": { - "description": "List Time Entries", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_entries", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,start_time,end_time,hours_worked,break_duration,labor_type,location,status,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "HRIS Time Entries filters", - "properties": { - "employee_id": { - "additionalProperties": false, - "description": "Filter to select time entries by employee_id", - "type": "string", - }, - "end_time": { - "additionalProperties": false, - "description": "Filter to select time entries before a given time", - "example": "2020-01-01T00:00:00.000Z", - "type": "string", - }, - "start_time": { - "additionalProperties": false, - "description": "Filter to select time entries after a given time", - "example": "2020-01-01T00:00:00.000Z", - "type": "string", - }, - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_time_off_policies": { - "description": "List Time Off Policies", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_off_policies", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,description,type,duration_unit,reasons,updated_at,created_at,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "HRIS Time-Off Policies filters", - "properties": { - "type": { - "description": "Filter to select time-off policies by type", - "enum": [ - "sick", - "unmapped_value", - "vacation", - "long_term_disability", - "short_term_disability", - "absent", - "comp_time", - "training", - "annual_leave", - "leave_of_absence", - "break", - "child_care_leave", - "maternity_leave", - "jury_duty", - "sabbatical", - "accident", - "paid", - "unpaid", - "holiday", - "personal", - "in_lieu", - "bereavement", - "other", - null, - ], - "type": "string", - }, - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_time_off_requests": { - "description": "List time off requests", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_off", - }, - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "policy", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,time_off_policy_id,remote_time_off_policy_id,reason,comment,duration,created_at,updated_at,policy,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "HRIS Time Off filters", - "properties": { - "end_date": { - "additionalProperties": false, - "description": "Filter to include time off requests that end on or before this date.", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "policy_ids": { - "additionalProperties": false, - "description": "List of time off policy ids to filter by.", - "items": { - "type": "string", - }, - "type": "array", - }, - "start_date": { - "additionalProperties": false, - "description": "Filter to include time off requests that start on or after this date.", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_time_off_types": { - "description": "List time off types", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_off_types", - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,active,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_update_employee": { - "description": "Update Employee", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "PATCH", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "body", - "name": "title", - "type": "string", - }, - { - "location": "body", - "name": "first_name", - "type": "string", - }, - { - "location": "body", - "name": "last_name", - "type": "string", - }, - { - "location": "body", - "name": "name", - "type": "string", - }, - { - "location": "body", - "name": "display_name", - "type": "string", - }, - { - "location": "body", - "name": "avatar_url", - "type": "string", - }, - { - "location": "body", - "name": "personal_email", - "type": "string", - }, - { - "location": "body", - "name": "personal_phone_number", - "type": "string", - }, - { - "location": "body", - "name": "work_email", - "type": "string", - }, - { - "location": "body", - "name": "work_phone_number", - "type": "string", - }, - { - "location": "body", - "name": "job_title", - "type": "string", - }, - { - "location": "body", - "name": "department_id", - "type": "string", - }, - { - "location": "body", - "name": "team_id", - "type": "string", - }, - { - "location": "body", - "name": "department", - "type": "string", - }, - { - "location": "body", - "name": "manager_id", - "type": "string", - }, - { - "location": "body", - "name": "gender", - "type": "object", - }, - { - "location": "body", - "name": "preferred_language", - "type": "object", - }, - { - "location": "body", - "name": "ethnicity", - "type": "object", - }, - { - "location": "body", - "name": "date_of_birth", - "type": "string", - }, - { - "location": "body", - "name": "birthday", - "type": "string", - }, - { - "location": "body", - "name": "marital_status", - "type": "object", - }, - { - "location": "body", - "name": "avatar", - "type": "object", - }, - { - "location": "body", - "name": "hire_date", - "type": "string", - }, - { - "location": "body", - "name": "start_date", - "type": "string", - }, - { - "location": "body", - "name": "employment_status", - "type": "object", - }, - { - "location": "body", - "name": "termination_date", - "type": "string", - }, - { - "location": "body", - "name": "company_id", - "type": "string", - }, - { - "location": "body", - "name": "citizenships", - "type": "array", - }, - { - "location": "body", - "name": "employment", - "type": "object", - }, - { - "location": "body", - "name": "custom_fields", - "type": "array", - }, - { - "location": "body", - "name": "benefits", - "type": "array", - }, - { - "location": "body", - "name": "employee_number", - "type": "string", - }, - { - "location": "body", - "name": "national_identity_numbers", - "type": "array", - }, - { - "location": "body", - "name": "home_location", - "type": "object", - }, - { - "location": "body", - "name": "work_location", - "type": "object", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}", - }, - "parameters": { - "properties": { - "avatar": { - "description": "The employee avatar", - "example": "https://example.com/avatar.png", - "properties": { - "base64": { - "type": "string", - }, - "url": { - "type": "string", - }, - }, - "type": "object", - }, - "avatar_url": { - "description": "The employee avatar Url", - "example": "https://example.com/avatar.png", - "type": "string", - }, - "benefits": { - "description": "Current benefits of the employee", - "items": { - "properties": { - "benefit_type": { - "description": "The type of the benefit", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "The type of the benefit", - "enum": [ - "retirement_savings", - "health_savings", - "other", - "health_insurance", - "insurance", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "created_at": { - "description": "The date and time the benefit was created", - "example": "2021-01-01T00:00:00Z", - "format": "date-time", - "type": "string", - }, - "description": { - "description": "The description of the benefit", - "example": "Health insurance for employees", - "type": "string", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "name": { - "description": "The name of the benefit", - "example": "Health Insurance", - "type": "string", - }, - "provider": { - "description": "The provider of the benefit", - "example": "Aetna", - "type": "string", - }, - "updated_at": { - "description": "The date and time the benefit was last updated", - "example": "2021-01-01T00:00:00Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "type": "array", - }, - "birthday": { - "description": "The next birthday of the employee (upcoming birthday)", - "example": "2021-01-01T00:00:00Z", - "format": "date-time", - "type": "string", - }, - "citizenships": { - "description": "The citizenships of the Employee", - "items": { - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "type": "string", - }, - }, - "type": "object", - }, - "type": "array", - }, - "company_id": { - "description": "The employee company id", - "example": "1234567890", - "type": "string", - }, - "custom_fields": { - "description": "The employee custom fields", - "items": { - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "name": { - "description": "The name of the custom field.", - "example": "Training Completion Status", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "remote_value_id": { - "description": "Provider's unique identifier for the value of the custom field.", - "example": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", - "type": "string", - }, - "value": { - "description": "The value associated with the custom field.", - "example": "Completed", - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - { - "format": "date-time", - "type": "string", - }, - ], - }, - "value_id": { - "description": "The unique identifier for the value of the custom field.", - "example": "value_456", - "type": "string", - }, - }, - "type": "object", - }, - "type": "array", - }, - "date_of_birth": { - "description": "The date when the employee was born", - "example": "1990-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "department": { - "description": "The employee department", - "example": "Physics", - "type": "string", - }, - "department_id": { - "description": "The employee department id", - "example": "3093", - "type": "string", - }, - "display_name": { - "description": "The employee display name", - "example": "Sir Isaac Newton", - "type": "string", - }, - "employee_number": { - "description": "The assigned employee number", - "example": "125", - "type": "string", - }, - "employment": { - "description": "The employee employment", - "properties": { - "contract_type": { - "description": "The employment work schedule type", - "properties": { - "contract_type": { - "description": "The employment work schedule type (e.g., full-time, part-time)", - "example": "full_time", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "enum": [ - "full_time", - "shifts", - "part_time", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "label": { - "description": "The label of the employment type", - "example": "Full-Time", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - }, - "type": "object", - }, - "end_date": { - "description": "The end date of employment", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "type": "string", - }, - "grade": { - "description": "Represents the employeeโ€™s position within the organizational hierarchy.", - "properties": { - "description": { - "description": "description of the grade", - "example": "Mid-level employee demonstrating proficiency and autonomy.", - "type": "string", - }, - "id": { - "description": "The reference id", - "example": "1687-3", - "type": "string", - }, - "name": { - "description": "The reference name", - "example": "1687-4", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - }, - "type": "object", - }, - "job_title": { - "description": "The job title of the employee", - "example": "Software Engineer", - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "type": "object", - }, - "pay_currency": { - "description": "The currency used for pay", - "example": "USD", - "type": "string", - }, - "pay_frequency": { - "description": "How often the employee is paid", - "example": "hourly", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "enum": [ - "hourly", - "weekly", - "bi_weekly", - "four_weekly", - "semi_monthly", - "monthly", - "bi_monthly", - "quarterly", - "semi_annually", - "yearly", - "thirteen_monthly", - "pro_rata", - "unmapped_value", - "half_yearly", - "daily", - "fixed", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "pay_period": { - "description": "The time period over which the pay rate is calculated", - "example": "monthly", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "enum": [ - "hour", - "day", - "week", - "every_two_weeks", - "month", - "quarter", - "every_six_months", - "year", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "pay_rate": { - "description": "The amount of compensation for the employee", - "example": "40.00", - "type": "string", - }, - "payroll_code": { - "description": "The payroll code of the employee", - "example": "PC1", - "type": "string", - }, - "type": { - "description": "The type of employment", - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "label": { - "description": "The label of the employment type", - "example": "Permanent", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "type": { - "description": "The type of employment (e.g., contractor, permanent)", - "example": "permanent", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "enum": [ - "contractor", - "intern", - "permanent", - "apprentice", - "freelance", - "terminated", - "temporary", - "seasonal", - "volunteer", - "probation", - "internal", - "external", - "expatriate", - "employer_of_record", - "casual", - "Programme", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - }, - "type": "object", - }, - "unified_custom_fields": { - "additionalProperties": true, - "description": "Custom Unified Fields configured in your StackOne project", - "example": { - "my_project_custom_field_1": "REF-1236", - "my_project_custom_field_2": "some other value", - }, - "type": "object", - }, - "work_time": { - "properties": { - "duration": { - "description": "The work time duration in ISO 8601 duration format", - "example": "P0Y0M0DT8H0M0S", - "format": "duration", - "type": "string", - }, - "period": { - "description": "The period of the work time", - "example": "month", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "The unified value for the period.", - "enum": [ - "day", - "week", - "month", - "year", - "unmapped_value", - null, - ], - "example": "month", - "type": "string", - }, - }, - "type": "object", - }, - }, - "type": "object", - }, - }, - "type": "object", - }, - "employment_status": { - "description": "The employee employment status", - "example": "active", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "enum": [ - "active", - "pending", - "terminated", - "leave", - "inactive", - "unknown", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "ethnicity": { - "description": "The employee ethnicity", - "example": "white", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "enum": [ - "white", - "black_or_african_american", - "asian", - "hispanic_or_latino", - "american_indian_or_alaska_native", - "native_hawaiian_or_pacific_islander", - "two_or_more_races", - "not_disclosed", - "other", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "first_name": { - "description": "The employee first name", - "example": "Isaac", - "type": "string", - }, - "gender": { - "description": "The employee gender", - "example": "male", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "enum": [ - "male", - "female", - "non_binary", - "other", - "not_disclosed", - "diverse", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "hire_date": { - "description": "The employee hire date", - "example": "2021-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "home_location": { - "description": "The employee home location", - "properties": { - "city": { - "description": "The city where the location is situated", - "example": "Grantham", - "type": "string", - }, - "country": { - "description": "The country code", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "name": { - "description": "The name of the location", - "example": "Woolsthorpe Manor", - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "type": "object", - }, - "phone_number": { - "description": "The phone number of the location", - "example": "+44 1476 860 364", - "type": "string", - }, - "state": { - "description": "The ISO3166-2 sub division where the location is situated", - "example": "GB-LIN", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "state (ISO3166-2 Sub Division Code) - value must be a valid enum value", - "type": "string", - }, - }, - "type": "object", - }, - "street_1": { - "description": "The first line of the address", - "example": "Water Lane", - "type": "string", - }, - "street_2": { - "description": "The second line of the address", - "example": "Woolsthorpe by Colsterworth", - "type": "string", - }, - "zip_code": { - "description": "The ZIP code/Postal code of the location", - "example": "NG33 5NR", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "job_title": { - "description": "If the source of the job_title is the Employee's current Employment, and that Employment pertains exclusively to this Employee, then the active Employment job_title will also be written", - "example": "Physicist", - "type": "string", - }, - "last_name": { - "description": "The employee last name", - "example": "Newton", - "type": "string", - }, - "manager_id": { - "description": "The employee manager ID", - "example": "67890", - "type": "string", - }, - "marital_status": { - "description": "The employee marital status", - "example": "single", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "enum": [ - "single", - "married", - "common_law", - "divorced", - "widowed", - "domestic_partnership", - "separated", - "other", - "not_disclosed", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "name": { - "description": "The employee name", - "example": "Isaac Newton", - "type": "string", - }, - "national_identity_numbers": { - "description": "The national identity numbers", - "items": { - "properties": { - "country": { - "description": "The country code", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "type": "string", - }, - }, - "type": "object", - }, - "type": { - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "The type of the national identity number", - "enum": [ - "ssn", - "nin", - "sin", - "nid", - "pin", - "pn", - "umcn", - "pic", - "ric", - "idnum", - "cid", - "nidnr", - "pan", - "aadhaar", - "epic", - "ptn", - "itin", - "tin", - "uprc", - "pcode", - "ssi", - "cedula", - "passport", - "voterid", - "ntin", - "bn", - "fnr", - "mva", - "civil_id", - "cnic", - "nric", - "fin", - "uen", - "registrationnumber", - "nic", - "personnummer", - "ahv", - "id", - "eid", - "va", - "pid", - "nrt", - "nipt", - "cbu", - "cuit", - "dni", - "businessid", - "vnr", - "abn", - "acn", - "tfn", - "jmbg", - "bis", - "insz", - "nn", - "egn", - "pnf", - "vat", - "cnpj", - "unp", - "gst", - "pst", - "qst", - "ni", - "dic", - "rc", - "uid", - "rut", - "uscc", - "cpf", - "cpj", - "cr", - "stnr", - "svnr", - "ncf", - "rnc", - "nif", - "ci", - "ik", - "kmkr", - "registrikood", - "tn", - "ruc", - "nit", - "alv", - "hetu", - "ytunnus", - "vn", - "utr", - "nifp", - "amka", - "cui", - "nir", - "siren", - "siret", - "tva", - "oib", - "hkid", - "anum", - "kennitala", - "vsk", - "npwp", - "pps", - "gstin", - "idnr", - "hr", - "aic", - "codicefiscale", - "iva", - "peid", - "asmens", - "pvm", - "ctps", - "vrn", - "vtk", - "int", - "tk", - "pas", - "rne", - "rg", - "nci", - "crnm", - "pis", - "insee", - "tax", - "mpf", - "epfo", - "esi", - "pran", - "uan", - "idk", - "bsn", - "mid", - "sss", - "nie", - "nss", - "arc", - "curp", - "imss", - "rfc", - "ein", - "other", - "unknown", - "unmapped_value", - null, - ], - "example": "ssn", - "type": "string", - }, - }, - "type": "object", - }, - "value": { - "example": "123456789", - "type": "string", - }, - }, - "type": "object", - }, - "type": "array", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "type": "object", - }, - "personal_email": { - "description": "The employee personal email", - "example": "isaac.newton@example.com", - "type": "string", - }, - "personal_phone_number": { - "description": "The employee personal phone number", - "example": "+1234567890", - "type": "string", - }, - "preferred_language": { - "description": "The employee preferred language", - "example": "eng", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "The ISO639-2 Code of the language", - "enum": [ - "aar", - "afr", - "amh", - "ara", - "aym", - "aze", - "bel", - "bul", - "bis", - "ben", - "bos", - "byn", - "cat", - "cha", - "ces", - "dan", - "deu", - "div", - "dzo", - "ell", - "eng", - "spa", - "est", - "fas", - "fan", - "ful", - "fin", - "fij", - "fao", - "fra", - "gle", - "grn", - "guj", - "glv", - "heb", - "hin", - "hrv", - "hat", - "hun", - "hye", - "ind", - "isl", - "ita", - "jpn", - "kat", - "kon", - "kaz", - "kal", - "khm", - "kor", - "kur", - "kir", - "lat", - "ltz", - "lin", - "lao", - "lit", - "lub", - "lav", - "mlg", - "mah", - "mri", - "mkd", - "mon", - "mar", - "msa", - "mlt", - "mya", - "nob", - "nep", - "nld", - "nno", - "nor", - "nbl", - "nya", - "pan", - "pol", - "pus", - "por", - "que", - "rar", - "roh", - "rup", - "ron", - "rus", - "kin", - "sme", - "sag", - "sin", - "slk", - "slv", - "smo", - "sna", - "som", - "sqi", - "srp", - "ssw", - "swe", - "swa", - "tam", - "tel", - "tgk", - "tha", - "tir", - "tig", - "tuk", - "tsn", - "ton", - "tur", - "tso", - "ukr", - "urd", - "uzb", - "ven", - "vie", - "xho", - "zho", - "zul", - "unmapped_value", - null, - ], - "example": "eng", - "type": "string", - }, - }, - "type": "object", - }, - "start_date": { - "description": "The employee start date", - "example": "2021-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "team_id": { - "description": "The employee team id", - "example": "2913", - "type": "string", - }, - "termination_date": { - "description": "The employee termination date", - "example": "2021-01-01T00:00:00Z", - "format": "date-time", - "type": "string", - }, - "title": { - "description": "The prefix of the employee's name (e.g., Mr, Ms, Dr)", - "example": "Mr", - "type": "string", - }, - "work_email": { - "description": "The employee work email", - "example": "newton@example.com", - "type": "string", - }, - "work_location": { - "description": "The employee work location", - "properties": { - "city": { - "description": "The city where the location is situated", - "example": "Grantham", - "type": "string", - }, - "country": { - "description": "The country code", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "name": { - "description": "The name of the location", - "example": "Woolsthorpe Manor", - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "type": "object", - }, - "phone_number": { - "description": "The phone number of the location", - "example": "+44 1476 860 364", - "type": "string", - }, - "state": { - "description": "The ISO3166-2 sub division where the location is situated", - "example": "GB-LIN", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "state (ISO3166-2 Sub Division Code) - value must be a valid enum value", - "type": "string", - }, - }, - "type": "object", - }, - "street_1": { - "description": "The first line of the address", - "example": "Water Lane", - "type": "string", - }, - "street_2": { - "description": "The second line of the address", - "example": "Woolsthorpe by Colsterworth", - "type": "string", - }, - "zip_code": { - "description": "The ZIP code/Postal code of the location", - "example": "NG33 5NR", - "type": "string", - }, - }, - "type": "object", - }, - "work_phone_number": { - "description": "The employee work phone number", - "example": "+1234567890", - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_update_employee_employment": { - "description": "Update Employee Employment", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "PATCH", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "body", - "name": "unified_custom_fields", - "type": "object", - }, - { - "location": "body", - "name": "job_title", - "type": "string", - }, - { - "location": "body", - "name": "pay_rate", - "type": "string", - }, - { - "location": "body", - "name": "pay_period", - "type": "object", - }, - { - "location": "body", - "name": "pay_frequency", - "type": "object", - }, - { - "location": "body", - "name": "pay_currency", - "type": "string", - }, - { - "location": "body", - "name": "effective_date", - "type": "string", - }, - { - "location": "body", - "name": "end_date", - "type": "string", - }, - { - "location": "body", - "name": "grade", - "type": "object", - }, - { - "location": "body", - "name": "type", - "type": "object", - }, - { - "location": "body", - "name": "contract_type", - "type": "object", - }, - { - "location": "body", - "name": "work_time", - "type": "object", - }, - { - "location": "body", - "name": "payroll_code", - "type": "string", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/employments/{subResourceId}", - }, - "parameters": { - "properties": { - "contract_type": { - "description": "The employment work schedule type", - "properties": { - "contract_type": { - "description": "The employment work schedule type (e.g., full-time, part-time)", - "example": "full_time", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "enum": [ - "full_time", - "shifts", - "part_time", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "label": { - "description": "The label of the employment type", - "example": "Full-Time", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - }, - "type": "object", - }, - "effective_date": { - "description": "The effective date of the employment contract", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "type": "string", - }, - "end_date": { - "description": "The end date of employment", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "type": "string", - }, - "grade": { - "description": "Represents the employeeโ€™s position within the organizational hierarchy.", - "properties": { - "description": { - "description": "description of the grade", - "example": "Mid-level employee demonstrating proficiency and autonomy.", - "type": "string", - }, - "id": { - "description": "The reference id", - "example": "1687-3", - "type": "string", - }, - "name": { - "description": "The reference name", - "example": "1687-4", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "job_title": { - "description": "The job title of the employee", - "example": "Software Engineer", - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "type": "object", - }, - "pay_currency": { - "description": "The currency used for pay", - "example": "USD", - "type": "string", - }, - "pay_frequency": { - "description": "How often the employee is paid", - "example": "hourly", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "enum": [ - "hourly", - "weekly", - "bi_weekly", - "four_weekly", - "semi_monthly", - "monthly", - "bi_monthly", - "quarterly", - "semi_annually", - "yearly", - "thirteen_monthly", - "pro_rata", - "unmapped_value", - "half_yearly", - "daily", - "fixed", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "pay_period": { - "description": "The time period over which the pay rate is calculated", - "example": "monthly", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "enum": [ - "hour", - "day", - "week", - "every_two_weeks", - "month", - "quarter", - "every_six_months", - "year", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "pay_rate": { - "description": "The amount of compensation for the employee", - "example": "40.00", - "type": "string", - }, - "payroll_code": { - "description": "The payroll code of the employee", - "example": "PC1", - "type": "string", - }, - "subResourceId": { - "type": "string", - }, - "type": { - "description": "The type of employment", - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "label": { - "description": "The label of the employment type", - "example": "Permanent", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "type": { - "description": "The type of employment (e.g., contractor, permanent)", - "example": "permanent", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "enum": [ - "contractor", - "intern", - "permanent", - "apprentice", - "freelance", - "terminated", - "temporary", - "seasonal", - "volunteer", - "probation", - "internal", - "external", - "expatriate", - "employer_of_record", - "casual", - "Programme", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - }, - "type": "object", - }, - "unified_custom_fields": { - "additionalProperties": true, - "description": "Custom Unified Fields configured in your StackOne project", - "example": { - "my_project_custom_field_1": "REF-1236", - "my_project_custom_field_2": "some other value", - }, - "type": "object", - }, - "work_time": { - "properties": { - "duration": { - "description": "The work time duration in ISO 8601 duration format", - "example": "P0Y0M0DT8H0M0S", - "format": "duration", - "type": "string", - }, - "period": { - "description": "The period of the work time", - "example": "month", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "The unified value for the period.", - "enum": [ - "day", - "week", - "month", - "year", - "unmapped_value", - null, - ], - "example": "month", - "type": "string", - }, - }, - "type": "object", - }, - }, - "type": "object", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - }, - "hris_update_employee_task": { - "description": "Update Employee Task", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "PATCH", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "body", - "name": "comment", - "type": "string", - }, - { - "location": "body", - "name": "status", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/tasks/{subResourceId}", - }, - "parameters": { - "properties": { - "comment": { - "description": "Comment or note about the task update", - "example": "All required documents have been submitted", - "type": "string", - }, - "id": { - "type": "string", - }, - "status": { - "default": "completed", - "description": "The status to apply to this Task", - "example": "blocked", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "The unified value for the status of the task. If the provider does not specify this status, the value will be set to UnmappedValue", - "enum": [ - "open", - "in_progress", - "blocked", - "completed", - "cancelled", - "unmapped_value", - null, - ], - "example": "open", - "type": "string", - }, - }, - "type": "object", - }, - "subResourceId": { - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - }, - "hris_update_employee_time_off_request": { - "description": "Update Employee Time Off Request", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "PATCH", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "body", - "name": "approver_id", - "type": "string", - }, - { - "location": "body", - "name": "status", - "type": "object", - }, - { - "location": "body", - "name": "start_date", - "type": "string", - }, - { - "location": "body", - "name": "end_date", - "type": "string", - }, - { - "location": "body", - "name": "start_half_day", - "type": "string", - }, - { - "location": "body", - "name": "end_half_day", - "type": "string", - }, - { - "location": "body", - "name": "time_off_policy_id", - "type": "string", - }, - { - "location": "body", - "name": "reason", - "type": "object", - }, - { - "location": "body", - "name": "comment", - "type": "string", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off/{subResourceId}", - }, - "parameters": { - "properties": { - "approver_id": { - "description": "The approver ID", - "example": "1687-4", - "type": "string", - }, - "comment": { - "description": "Allows users to provide additional context or notes for their time off request", - "example": "Taking a day off for personal reasons", - "type": "string", - }, - "end_date": { - "description": "Inclusive end date of the time off request (ISO8601 date-time without timezone). The time off includes this day", - "example": "2021-01-01T01:01:01.000", - "format": "datetime-local", - "type": "string", - }, - "end_half_day": { - "description": "True if the end of the time off request ends half way through the day", - "example": true, - "oneOf": [ - { - "type": "boolean", - }, - { - "enum": [ - "true", - "false", - ], - "type": "string", - }, - ], - }, - "id": { - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "type": "object", - }, - "reason": { - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "name": { - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - }, - "type": "object", - }, - "start_date": { - "description": "The start date of the time off request (ISO8601 date-time without timezone)", - "example": "2021-01-01T01:01:01.000", - "format": "datetime-local", - "type": "string", - }, - "start_half_day": { - "description": "True if the start of the time off request begins half way through the day", - "example": true, - "oneOf": [ - { - "type": "boolean", - }, - { - "enum": [ - "true", - "false", - ], - "type": "string", - }, - ], - }, - "status": { - "description": "The status of the time off request", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "enum": [ - "approved", - "cancelled", - "rejected", - "pending", - "deleted", - "draft", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "subResourceId": { - "type": "string", - }, - "time_off_policy_id": { - "description": "The time off policy id associated with this time off request", - "example": "cx280928933", - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - }, - "hris_update_employee_work_eligibility_request": { - "description": "Update Employee Work Eligibility Request", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "PATCH", - "params": [ - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "body", - "name": "document", - "type": "object", - }, - { - "location": "body", - "name": "issued_by", - "type": "object", - }, - { - "location": "body", - "name": "number", - "type": "string", - }, - { - "location": "body", - "name": "sub_type", - "type": "string", - }, - { - "location": "body", - "name": "type", - "type": "object", - }, - { - "location": "body", - "name": "valid_from", - "type": "string", - }, - { - "location": "body", - "name": "valid_to", - "type": "string", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/work_eligibility/{subResourceId}", - }, - "parameters": { - "properties": { - "document": { - "properties": { - "category": { - "description": "The category of the file", - "example": "templates, forms, backups, etc.", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "The category of the file", - "type": "string", - }, - }, - "type": "object", - }, - "category_id": { - "description": "The categoryId of the documents", - "example": "6530", - "type": "string", - }, - "created_at": { - "description": "The creation date of the file", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "type": "string", - }, - "file_format": { - "description": "The file format of the file", - "properties": { - "source_value": { - "example": "application/pdf", - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "The file format of the file, expressed as a file extension", - "enum": [ - "unmapped_value", - "ez", - "aw", - "atom", - "atomcat", - "atomdeleted", - "atomsvc", - "dwd", - "held", - "rsat", - "bdoc", - "xcs", - "ccxml", - "cdfx", - "cdmia", - "cdmic", - "cdmid", - "cdmio", - "cdmiq", - "cu", - "mpd", - "davmount", - "dbk", - "dssc", - "xdssc", - "es", - "ecma", - "emma", - "emotionml", - "epub", - "exi", - "exp", - "fdt", - "pfr", - "geojson", - "gml", - "gpx", - "gxf", - "gz", - "hjson", - "stk", - "ink", - "inkml", - "ipfix", - "its", - "jar", - "war", - "ear", - "ser", - "class", - "js", - "mjs", - "json", - "map", - "json5", - "jsonml", - "jsonld", - "lgr", - "lostxml", - "hqx", - "cpt", - "mads", - "webmanifest", - "mrc", - "mrcx", - "ma", - "nb", - "mb", - "mathml", - "mbox", - "mscml", - "metalink", - "meta4", - "mets", - "maei", - "musd", - "mods", - "m21", - "mp21", - "mp4s", - "m4p", - "doc", - "dot", - "mxf", - "nq", - "nt", - "cjs", - "bin", - "dms", - "lrf", - "mar", - "so", - "dist", - "distz", - "pkg", - "bpk", - "dump", - "elc", - "deploy", - "exe", - "dll", - "deb", - "dmg", - "iso", - "img", - "msi", - "msp", - "msm", - "buffer", - "oda", - "opf", - "ogx", - "omdoc", - "onetoc", - "onetoc2", - "onetmp", - "onepkg", - "oxps", - "relo", - "xer", - "pdf", - "pgp", - "asc", - "sig", - "prf", - "p10", - "p7m", - "p7c", - "p7s", - "p8", - "ac", - "cer", - "crl", - "pkipath", - "pki", - "pls", - "ai", - "eps", - "ps", - "provx", - "pskcxml", - "raml", - "rdf", - "owl", - "rif", - "rnc", - "rl", - "rld", - "rs", - "rapd", - "sls", - "rusd", - "gbr", - "mft", - "roa", - "rsd", - "rss", - "rtf", - "sbml", - "scq", - "scs", - "spq", - "spp", - "sdp", - "senmlx", - "sensmlx", - "setpay", - "setreg", - "shf", - "siv", - "sieve", - "smi", - "smil", - "rq", - "srx", - "gram", - "grxml", - "sru", - "ssdl", - "ssml", - "swidtag", - "tei", - "teicorpus", - "tfi", - "tsd", - "toml", - "trig", - "ttml", - "ubj", - "rsheet", - "td", - "vxml", - "wasm", - "wgt", - "hlp", - "wsdl", - "wspolicy", - "xaml", - "xav", - "xca", - "xdf", - "xel", - "xns", - "xenc", - "xhtml", - "xht", - "xlf", - "xml", - "xsl", - "xsd", - "rng", - "dtd", - "xop", - "xpl", - "*xsl", - "xslt", - "xspf", - "mxml", - "xhvml", - "xvml", - "xvm", - "yang", - "yin", - "zip", - "*3gpp", - "adp", - "amr", - "au", - "snd", - "mid", - "midi", - "kar", - "rmi", - "mxmf", - "*mp3", - "m4a", - "mp4a", - "mpga", - "mp2", - "mp2a", - "mp3", - "m2a", - "m3a", - "oga", - "ogg", - "spx", - "opus", - "s3m", - "sil", - "wav", - "*wav", - "weba", - "xm", - "ttc", - "otf", - "ttf", - "woff", - "woff2", - "exr", - "apng", - "avif", - "bmp", - "cgm", - "drle", - "emf", - "fits", - "g3", - "gif", - "heic", - "heics", - "heif", - "heifs", - "hej2", - "hsj2", - "ief", - "jls", - "jp2", - "jpg2", - "jpeg", - "jpg", - "jpe", - "jph", - "jhc", - "jpm", - "jpx", - "jpf", - "jxr", - "jxra", - "jxrs", - "jxs", - "jxsc", - "jxsi", - "jxss", - "ktx", - "ktx2", - "png", - "sgi", - "svg", - "svgz", - "t38", - "tif", - "tiff", - "tfx", - "webp", - "wmf", - "disposition-notification", - "u8msg", - "u8dsn", - "u8mdn", - "u8hdr", - "eml", - "mime", - "3mf", - "gltf", - "glb", - "igs", - "iges", - "msh", - "mesh", - "silo", - "mtl", - "obj", - "stpx", - "stpz", - "stpxz", - "stl", - "wrl", - "vrml", - "*x3db", - "x3dbz", - "x3db", - "*x3dv", - "x3dvz", - "x3d", - "x3dz", - "x3dv", - "appcache", - "manifest", - "ics", - "ifb", - "coffee", - "litcoffee", - "css", - "csv", - "html", - "htm", - "shtml", - "jade", - "jsx", - "less", - "markdown", - "md", - "mml", - "mdx", - "n3", - "txt", - "text", - "conf", - "def", - "list", - "log", - "in", - "ini", - "rtx", - "*rtf", - "sgml", - "sgm", - "shex", - "slim", - "slm", - "spdx", - "stylus", - "styl", - "tsv", - "t", - "tr", - "roff", - "man", - "me", - "ms", - "ttl", - "uri", - "uris", - "urls", - "vcard", - "vtt", - "*xml", - "yaml", - "yml", - "3gp", - "3gpp", - "3g2", - "h261", - "h263", - "h264", - "m4s", - "jpgv", - "*jpm", - "jpgm", - "mj2", - "mjp2", - "ts", - "mp4", - "mp4v", - "mpg4", - "mpeg", - "mpg", - "mpe", - "m1v", - "m2v", - "ogv", - "qt", - "mov", - "webm", - "cww", - "1km", - "plb", - "psb", - "pvb", - "tcap", - "pwn", - "aso", - "imp", - "acu", - "atc", - "acutc", - "air", - "fcdt", - "fxp", - "fxpl", - "xdp", - "xfdf", - "ahead", - "azf", - "azs", - "azw", - "acc", - "ami", - "apk", - "cii", - "fti", - "atx", - "mpkg", - "key", - "m3u8", - "numbers", - "pages", - "pkpass", - "swi", - "iota", - "aep", - "bmml", - "mpm", - "bmi", - "rep", - "cdxml", - "mmd", - "cdy", - "csl", - "cla", - "rp9", - "c4g", - "c4d", - "c4f", - "c4p", - "c4u", - "c11amc", - "c11amz", - "csp", - "cdbcmsg", - "cmc", - "clkx", - "clkk", - "clkp", - "clkt", - "clkw", - "wbs", - "pml", - "ppd", - "car", - "pcurl", - "dart", - "rdz", - "dbf", - "uvf", - "uvvf", - "uvd", - "uvvd", - "uvt", - "uvvt", - "uvx", - "uvvx", - "uvz", - "uvvz", - "fe_launch", - "dna", - "mlp", - "mle", - "dpg", - "dfac", - "kpxx", - "ait", - "svc", - "geo", - "mag", - "nml", - "esf", - "msf", - "qam", - "slt", - "ssf", - "es3", - "et3", - "ez2", - "ez3", - "fdf", - "mseed", - "seed", - "dataless", - "gph", - "ftc", - "fm", - "frame", - "maker", - "book", - "fnc", - "ltf", - "fsc", - "oas", - "oa2", - "oa3", - "fg5", - "bh2", - "ddd", - "xdw", - "xbd", - "fzs", - "txd", - "ggb", - "ggt", - "gex", - "gre", - "gxt", - "g2w", - "g3w", - "gmx", - "gdoc", - "gslides", - "gsheet", - "kml", - "kmz", - "gqf", - "gqs", - "gac", - "ghf", - "gim", - "grv", - "gtm", - "tpl", - "vcg", - "hal", - "zmm", - "hbci", - "les", - "hpgl", - "hpid", - "hps", - "jlt", - "pcl", - "pclxl", - "sfd-hdstx", - "mpy", - "afp", - "listafp", - "list3820", - "irm", - "sc", - "icc", - "icm", - "igl", - "ivp", - "ivu", - "igm", - "xpw", - "xpx", - "i2g", - "qbo", - "qfx", - "rcprofile", - "irp", - "xpr", - "fcs", - "jam", - "rms", - "jisp", - "joda", - "ktz", - "ktr", - "karbon", - "chrt", - "kfo", - "flw", - "kon", - "kpr", - "kpt", - "ksp", - "kwd", - "kwt", - "htke", - "kia", - "kne", - "knp", - "skp", - "skd", - "skt", - "skm", - "sse", - "lasxml", - "lbd", - "lbe", - "apr", - "pre", - "nsf", - "org", - "scm", - "lwp", - "portpkg", - "mvt", - "mcd", - "mc1", - "cdkey", - "mwf", - "mfm", - "flo", - "igx", - "mif", - "daf", - "dis", - "mbk", - "mqy", - "msl", - "plc", - "txf", - "mpn", - "mpc", - "xul", - "cil", - "cab", - "xls", - "xlm", - "xla", - "xlc", - "xlt", - "xlw", - "xlam", - "xlsb", - "xlsm", - "xltm", - "eot", - "chm", - "ims", - "lrm", - "thmx", - "msg", - "cat", - "*stl", - "ppt", - "pps", - "pot", - "ppam", - "pptm", - "sldm", - "ppsm", - "potm", - "mpp", - "mpt", - "docm", - "dotm", - "wps", - "wks", - "wcm", - "wdb", - "wpl", - "xps", - "mseq", - "mus", - "msty", - "taglet", - "nlu", - "ntf", - "nitf", - "nnd", - "nns", - "nnw", - "*ac", - "ngdat", - "n-gage", - "rpst", - "rpss", - "edm", - "edx", - "ext", - "odc", - "otc", - "odb", - "odf", - "odft", - "odg", - "otg", - "odi", - "oti", - "odp", - "otp", - "ods", - "ots", - "odt", - "odm", - "ott", - "oth", - "xo", - "dd2", - "obgx", - "oxt", - "osm", - "pptx", - "sldx", - "ppsx", - "potx", - "xlsx", - "xltx", - "docx", - "dotx", - "mgp", - "dp", - "esa", - "pdb", - "pqa", - "oprc", - "paw", - "str", - "ei6", - "efif", - "wg", - "plf", - "pbd", - "box", - "mgz", - "qps", - "ptid", - "qxd", - "qxt", - "qwd", - "qwt", - "qxl", - "qxb", - "rar", - "bed", - "mxl", - "musicxml", - "cryptonote", - "cod", - "rm", - "rmvb", - "link66", - "st", - "see", - "sema", - "semd", - "semf", - "ifm", - "itp", - "iif", - "ipk", - "twd", - "twds", - "mmf", - "teacher", - "fo", - "sdkm", - "sdkd", - "dxp", - "sfs", - "sdc", - "sda", - "sdd", - "smf", - "sdw", - "vor", - "sgl", - "smzip", - "sm", - "wadl", - "sxc", - "stc", - "sxd", - "std", - "sxi", - "sti", - "sxm", - "sxw", - "sxg", - "stw", - "sus", - "susp", - "svd", - "sis", - "sisx", - "xsm", - "bdm", - "xdm", - "ddf", - "tao", - "pcap", - "cap", - "dmp", - "tmo", - "tpt", - "mxs", - "tra", - "ufd", - "ufdl", - "utz", - "umj", - "unityweb", - "uoml", - "vcx", - "vsd", - "vst", - "vss", - "vsw", - "vis", - "vsf", - "wbxml", - "wmlc", - "wmlsc", - "wtb", - "nbp", - "wpd", - "wqd", - "stf", - "xar", - "xfdl", - "hvd", - "hvs", - "hvp", - "osf", - "osfpvg", - "saf", - "spf", - "cmp", - "zir", - "zirz", - "zaz", - "7z", - "abw", - "ace", - "*dmg", - "arj", - "aab", - "x32", - "u32", - "vox", - "aam", - "aas", - "bcpio", - "*bdoc", - "torrent", - "blb", - "blorb", - "bz", - "bz2", - "boz", - "cbr", - "cba", - "cbt", - "cbz", - "cb7", - "vcd", - "cfs", - "chat", - "pgn", - "crx", - "cco", - "nsc", - "cpio", - "csh", - "*deb", - "udeb", - "dgc", - "dir", - "dcr", - "dxr", - "cst", - "cct", - "cxt", - "w3d", - "fgd", - "swa", - "wad", - "ncx", - "dtb", - "res", - "dvi", - "evy", - "eva", - "bdf", - "gsf", - "psf", - "pcf", - "snf", - "pfa", - "pfb", - "pfm", - "afm", - "arc", - "spl", - "gca", - "ulx", - "gnumeric", - "gramps", - "gtar", - "hdf", - "php", - "install", - "*iso", - "*key", - "*numbers", - "*pages", - "jardiff", - "jnlp", - "kdbx", - "latex", - "luac", - "lzh", - "lha", - "run", - "mie", - "prc", - "mobi", - "application", - "lnk", - "wmd", - "wmz", - "xbap", - "mdb", - "obd", - "crd", - "clp", - "*exe", - "*dll", - "com", - "bat", - "*msi", - "mvb", - "m13", - "m14", - "*wmf", - "*wmz", - "*emf", - "emz", - "mny", - "pub", - "scd", - "trm", - "wri", - "nc", - "cdf", - "pac", - "nzb", - "pl", - "pm", - "*prc", - "*pdb", - "p12", - "pfx", - "p7b", - "spc", - "p7r", - "*rar", - "rpm", - "ris", - "sea", - "sh", - "shar", - "swf", - "xap", - "sql", - "sit", - "sitx", - "srt", - "sv4cpio", - "sv4crc", - "t3", - "gam", - "tar", - "tcl", - "tk", - "tex", - "tfm", - "texinfo", - "texi", - "*obj", - "ustar", - "hdd", - "ova", - "ovf", - "vbox", - "vbox-extpack", - "vdi", - "vhd", - "vmdk", - "src", - "webapp", - "der", - "crt", - "pem", - "fig", - "*xlf", - "xpi", - "xz", - "z1", - "z2", - "z3", - "z4", - "z5", - "z6", - "z7", - "z8", - "uva", - "uvva", - "eol", - "dra", - "dts", - "dtshd", - "lvp", - "pya", - "ecelp4800", - "ecelp7470", - "ecelp9600", - "rip", - "aac", - "aif", - "aiff", - "aifc", - "caf", - "flac", - "*m4a", - "mka", - "m3u", - "wax", - "wma", - "ram", - "ra", - "rmp", - "*ra", - "cdx", - "cif", - "cmdf", - "cml", - "csml", - "xyz", - "btif", - "pti", - "psd", - "azv", - "uvi", - "uvvi", - "uvg", - "uvvg", - "djvu", - "djv", - "*sub", - "dwg", - "dxf", - "fbs", - "fpx", - "fst", - "mmr", - "rlc", - "ico", - "dds", - "mdi", - "wdp", - "npx", - "b16", - "tap", - "vtf", - "wbmp", - "xif", - "pcx", - "3ds", - "ras", - "cmx", - "fh", - "fhc", - "fh4", - "fh5", - "fh7", - "*ico", - "jng", - "sid", - "*bmp", - "*pcx", - "pic", - "pct", - "pnm", - "pbm", - "pgm", - "ppm", - "rgb", - "tga", - "xbm", - "xpm", - "xwd", - "wsc", - "dae", - "dwf", - "gdl", - "gtw", - "mts", - "ogex", - "x_b", - "x_t", - "vds", - "usdz", - "bsp", - "vtu", - "dsc", - "curl", - "dcurl", - "mcurl", - "scurl", - "sub", - "fly", - "flx", - "gv", - "3dml", - "spot", - "jad", - "wml", - "wmls", - "s", - "asm", - "c", - "cc", - "cxx", - "cpp", - "h", - "hh", - "dic", - "htc", - "f", - "for", - "f77", - "f90", - "hbs", - "java", - "lua", - "mkd", - "nfo", - "opml", - "*org", - "p", - "pas", - "pde", - "sass", - "scss", - "etx", - "sfv", - "ymp", - "uu", - "vcs", - "vcf", - "uvh", - "uvvh", - "uvm", - "uvvm", - "uvp", - "uvvp", - "uvs", - "uvvs", - "uvv", - "uvvv", - "dvb", - "fvt", - "mxu", - "m4u", - "pyv", - "uvu", - "uvvu", - "viv", - "f4v", - "fli", - "flv", - "m4v", - "mkv", - "mk3d", - "mks", - "mng", - "asf", - "asx", - "vob", - "wm", - "wmv", - "wmx", - "wvx", - "avi", - "movie", - "smv", - "ice", - "mht", - null, - ], - "example": "pdf", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "name": { - "description": "The name of the file", - "example": "My Document", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "remote_url": { - "description": "URL where the file content is located", - "example": "https://example.com/file.pdf", - "type": "string", - }, - "updated_at": { - "description": "The update date of the file", - "example": "2021-01-02T01:01:01.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "issued_by": { - "description": "The country code of the issued by authority", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "type": "string", - }, - }, - "type": "object", - }, - "number": { - "example": "1234567890", - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "type": "object", - }, - "subResourceId": { - "type": "string", - }, - "sub_type": { - "example": "H1B", - "type": "string", - }, - "type": { - "example": "visa", - "properties": { - "source_value": { - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "enum": [ - "visa", - "passport", - "driver_license", - "birth_certificate", - "other", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "valid_from": { - "example": "2021-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "valid_to": { - "example": "2021-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - }, - "hris_upload_employee_document": { - "description": "Upload Employee Document", - "execute": { - "bodyType": "json", - "kind": "http", - "method": "POST", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "body", - "name": "name", - "type": "string", - }, - { - "location": "body", - "name": "file_format", - "type": "object", - }, - { - "location": "body", - "name": "content", - "type": "string", - }, - { - "location": "body", - "name": "category_id", - "type": "string", - }, - { - "location": "body", - "name": "path", - "type": "string", - }, - { - "location": "body", - "name": "confidential", - "type": "object", - }, - { - "location": "body", - "name": "category", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/documents/upload", - }, - "parameters": { - "properties": { - "category": { - "description": "The category to be associated with the file to be uploaded. Id will take precedence over name.", - "example": { - "id": "550e8400-e29b-41d4-a716-446655440000", - "name": "reports", - }, - "properties": { - "source_value": { - "description": "The provider specific category for associating uploaded files, if provided, the value will be ignored.", - "example": "550e8400-e29b-41d4-a716-446655440000", - "type": "string", - }, - "value": { - "description": "The category name to associate with the file", - "enum": [ - "application", - "academic", - "contract", - "certificates", - "visa", - "passport", - "driver_license", - "payslip", - "payroll", - "appraisal", - "resume", - "policy", - "cover_letter", - "offer_letter", - "policy_agreement", - "home_address", - "national_id", - "confidential", - "signed", - "shared", - "other", - "benefit", - "id_verification", - "background_check", - "unmapped_value", - null, - ], - "example": "reports", - "type": "string", - }, - }, - "type": "object", - }, - "category_id": { - "description": "The categoryId of the documents", - "example": "6530", - "type": "string", - }, - "confidential": { - "description": "The confidentiality level of the file to be uploaded", - "properties": { - "source_value": { - "example": "public", - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "Whether the file is confidential or not", - "enum": [ - "true", - "false", - "unmapped_value", - null, - ], - "example": "true", - "type": "string", - }, - }, - "type": "object", - }, - "content": { - "description": "The base64 encoded content of the file to upload", - "example": "VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE", - "type": "string", - }, - "file_format": { - "description": "The file format of the file", - "properties": { - "source_value": { - "example": "application/pdf", - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value": { - "description": "The file format of the file, expressed as a file extension", - "enum": [ - "unmapped_value", - "ez", - "aw", - "atom", - "atomcat", - "atomdeleted", - "atomsvc", - "dwd", - "held", - "rsat", - "bdoc", - "xcs", - "ccxml", - "cdfx", - "cdmia", - "cdmic", - "cdmid", - "cdmio", - "cdmiq", - "cu", - "mpd", - "davmount", - "dbk", - "dssc", - "xdssc", - "es", - "ecma", - "emma", - "emotionml", - "epub", - "exi", - "exp", - "fdt", - "pfr", - "geojson", - "gml", - "gpx", - "gxf", - "gz", - "hjson", - "stk", - "ink", - "inkml", - "ipfix", - "its", - "jar", - "war", - "ear", - "ser", - "class", - "js", - "mjs", - "json", - "map", - "json5", - "jsonml", - "jsonld", - "lgr", - "lostxml", - "hqx", - "cpt", - "mads", - "webmanifest", - "mrc", - "mrcx", - "ma", - "nb", - "mb", - "mathml", - "mbox", - "mscml", - "metalink", - "meta4", - "mets", - "maei", - "musd", - "mods", - "m21", - "mp21", - "mp4s", - "m4p", - "doc", - "dot", - "mxf", - "nq", - "nt", - "cjs", - "bin", - "dms", - "lrf", - "mar", - "so", - "dist", - "distz", - "pkg", - "bpk", - "dump", - "elc", - "deploy", - "exe", - "dll", - "deb", - "dmg", - "iso", - "img", - "msi", - "msp", - "msm", - "buffer", - "oda", - "opf", - "ogx", - "omdoc", - "onetoc", - "onetoc2", - "onetmp", - "onepkg", - "oxps", - "relo", - "xer", - "pdf", - "pgp", - "asc", - "sig", - "prf", - "p10", - "p7m", - "p7c", - "p7s", - "p8", - "ac", - "cer", - "crl", - "pkipath", - "pki", - "pls", - "ai", - "eps", - "ps", - "provx", - "pskcxml", - "raml", - "rdf", - "owl", - "rif", - "rnc", - "rl", - "rld", - "rs", - "rapd", - "sls", - "rusd", - "gbr", - "mft", - "roa", - "rsd", - "rss", - "rtf", - "sbml", - "scq", - "scs", - "spq", - "spp", - "sdp", - "senmlx", - "sensmlx", - "setpay", - "setreg", - "shf", - "siv", - "sieve", - "smi", - "smil", - "rq", - "srx", - "gram", - "grxml", - "sru", - "ssdl", - "ssml", - "swidtag", - "tei", - "teicorpus", - "tfi", - "tsd", - "toml", - "trig", - "ttml", - "ubj", - "rsheet", - "td", - "vxml", - "wasm", - "wgt", - "hlp", - "wsdl", - "wspolicy", - "xaml", - "xav", - "xca", - "xdf", - "xel", - "xns", - "xenc", - "xhtml", - "xht", - "xlf", - "xml", - "xsl", - "xsd", - "rng", - "dtd", - "xop", - "xpl", - "*xsl", - "xslt", - "xspf", - "mxml", - "xhvml", - "xvml", - "xvm", - "yang", - "yin", - "zip", - "*3gpp", - "adp", - "amr", - "au", - "snd", - "mid", - "midi", - "kar", - "rmi", - "mxmf", - "*mp3", - "m4a", - "mp4a", - "mpga", - "mp2", - "mp2a", - "mp3", - "m2a", - "m3a", - "oga", - "ogg", - "spx", - "opus", - "s3m", - "sil", - "wav", - "*wav", - "weba", - "xm", - "ttc", - "otf", - "ttf", - "woff", - "woff2", - "exr", - "apng", - "avif", - "bmp", - "cgm", - "drle", - "emf", - "fits", - "g3", - "gif", - "heic", - "heics", - "heif", - "heifs", - "hej2", - "hsj2", - "ief", - "jls", - "jp2", - "jpg2", - "jpeg", - "jpg", - "jpe", - "jph", - "jhc", - "jpm", - "jpx", - "jpf", - "jxr", - "jxra", - "jxrs", - "jxs", - "jxsc", - "jxsi", - "jxss", - "ktx", - "ktx2", - "png", - "sgi", - "svg", - "svgz", - "t38", - "tif", - "tiff", - "tfx", - "webp", - "wmf", - "disposition-notification", - "u8msg", - "u8dsn", - "u8mdn", - "u8hdr", - "eml", - "mime", - "3mf", - "gltf", - "glb", - "igs", - "iges", - "msh", - "mesh", - "silo", - "mtl", - "obj", - "stpx", - "stpz", - "stpxz", - "stl", - "wrl", - "vrml", - "*x3db", - "x3dbz", - "x3db", - "*x3dv", - "x3dvz", - "x3d", - "x3dz", - "x3dv", - "appcache", - "manifest", - "ics", - "ifb", - "coffee", - "litcoffee", - "css", - "csv", - "html", - "htm", - "shtml", - "jade", - "jsx", - "less", - "markdown", - "md", - "mml", - "mdx", - "n3", - "txt", - "text", - "conf", - "def", - "list", - "log", - "in", - "ini", - "rtx", - "*rtf", - "sgml", - "sgm", - "shex", - "slim", - "slm", - "spdx", - "stylus", - "styl", - "tsv", - "t", - "tr", - "roff", - "man", - "me", - "ms", - "ttl", - "uri", - "uris", - "urls", - "vcard", - "vtt", - "*xml", - "yaml", - "yml", - "3gp", - "3gpp", - "3g2", - "h261", - "h263", - "h264", - "m4s", - "jpgv", - "*jpm", - "jpgm", - "mj2", - "mjp2", - "ts", - "mp4", - "mp4v", - "mpg4", - "mpeg", - "mpg", - "mpe", - "m1v", - "m2v", - "ogv", - "qt", - "mov", - "webm", - "cww", - "1km", - "plb", - "psb", - "pvb", - "tcap", - "pwn", - "aso", - "imp", - "acu", - "atc", - "acutc", - "air", - "fcdt", - "fxp", - "fxpl", - "xdp", - "xfdf", - "ahead", - "azf", - "azs", - "azw", - "acc", - "ami", - "apk", - "cii", - "fti", - "atx", - "mpkg", - "key", - "m3u8", - "numbers", - "pages", - "pkpass", - "swi", - "iota", - "aep", - "bmml", - "mpm", - "bmi", - "rep", - "cdxml", - "mmd", - "cdy", - "csl", - "cla", - "rp9", - "c4g", - "c4d", - "c4f", - "c4p", - "c4u", - "c11amc", - "c11amz", - "csp", - "cdbcmsg", - "cmc", - "clkx", - "clkk", - "clkp", - "clkt", - "clkw", - "wbs", - "pml", - "ppd", - "car", - "pcurl", - "dart", - "rdz", - "dbf", - "uvf", - "uvvf", - "uvd", - "uvvd", - "uvt", - "uvvt", - "uvx", - "uvvx", - "uvz", - "uvvz", - "fe_launch", - "dna", - "mlp", - "mle", - "dpg", - "dfac", - "kpxx", - "ait", - "svc", - "geo", - "mag", - "nml", - "esf", - "msf", - "qam", - "slt", - "ssf", - "es3", - "et3", - "ez2", - "ez3", - "fdf", - "mseed", - "seed", - "dataless", - "gph", - "ftc", - "fm", - "frame", - "maker", - "book", - "fnc", - "ltf", - "fsc", - "oas", - "oa2", - "oa3", - "fg5", - "bh2", - "ddd", - "xdw", - "xbd", - "fzs", - "txd", - "ggb", - "ggt", - "gex", - "gre", - "gxt", - "g2w", - "g3w", - "gmx", - "gdoc", - "gslides", - "gsheet", - "kml", - "kmz", - "gqf", - "gqs", - "gac", - "ghf", - "gim", - "grv", - "gtm", - "tpl", - "vcg", - "hal", - "zmm", - "hbci", - "les", - "hpgl", - "hpid", - "hps", - "jlt", - "pcl", - "pclxl", - "sfd-hdstx", - "mpy", - "afp", - "listafp", - "list3820", - "irm", - "sc", - "icc", - "icm", - "igl", - "ivp", - "ivu", - "igm", - "xpw", - "xpx", - "i2g", - "qbo", - "qfx", - "rcprofile", - "irp", - "xpr", - "fcs", - "jam", - "rms", - "jisp", - "joda", - "ktz", - "ktr", - "karbon", - "chrt", - "kfo", - "flw", - "kon", - "kpr", - "kpt", - "ksp", - "kwd", - "kwt", - "htke", - "kia", - "kne", - "knp", - "skp", - "skd", - "skt", - "skm", - "sse", - "lasxml", - "lbd", - "lbe", - "apr", - "pre", - "nsf", - "org", - "scm", - "lwp", - "portpkg", - "mvt", - "mcd", - "mc1", - "cdkey", - "mwf", - "mfm", - "flo", - "igx", - "mif", - "daf", - "dis", - "mbk", - "mqy", - "msl", - "plc", - "txf", - "mpn", - "mpc", - "xul", - "cil", - "cab", - "xls", - "xlm", - "xla", - "xlc", - "xlt", - "xlw", - "xlam", - "xlsb", - "xlsm", - "xltm", - "eot", - "chm", - "ims", - "lrm", - "thmx", - "msg", - "cat", - "*stl", - "ppt", - "pps", - "pot", - "ppam", - "pptm", - "sldm", - "ppsm", - "potm", - "mpp", - "mpt", - "docm", - "dotm", - "wps", - "wks", - "wcm", - "wdb", - "wpl", - "xps", - "mseq", - "mus", - "msty", - "taglet", - "nlu", - "ntf", - "nitf", - "nnd", - "nns", - "nnw", - "*ac", - "ngdat", - "n-gage", - "rpst", - "rpss", - "edm", - "edx", - "ext", - "odc", - "otc", - "odb", - "odf", - "odft", - "odg", - "otg", - "odi", - "oti", - "odp", - "otp", - "ods", - "ots", - "odt", - "odm", - "ott", - "oth", - "xo", - "dd2", - "obgx", - "oxt", - "osm", - "pptx", - "sldx", - "ppsx", - "potx", - "xlsx", - "xltx", - "docx", - "dotx", - "mgp", - "dp", - "esa", - "pdb", - "pqa", - "oprc", - "paw", - "str", - "ei6", - "efif", - "wg", - "plf", - "pbd", - "box", - "mgz", - "qps", - "ptid", - "qxd", - "qxt", - "qwd", - "qwt", - "qxl", - "qxb", - "rar", - "bed", - "mxl", - "musicxml", - "cryptonote", - "cod", - "rm", - "rmvb", - "link66", - "st", - "see", - "sema", - "semd", - "semf", - "ifm", - "itp", - "iif", - "ipk", - "twd", - "twds", - "mmf", - "teacher", - "fo", - "sdkm", - "sdkd", - "dxp", - "sfs", - "sdc", - "sda", - "sdd", - "smf", - "sdw", - "vor", - "sgl", - "smzip", - "sm", - "wadl", - "sxc", - "stc", - "sxd", - "std", - "sxi", - "sti", - "sxm", - "sxw", - "sxg", - "stw", - "sus", - "susp", - "svd", - "sis", - "sisx", - "xsm", - "bdm", - "xdm", - "ddf", - "tao", - "pcap", - "cap", - "dmp", - "tmo", - "tpt", - "mxs", - "tra", - "ufd", - "ufdl", - "utz", - "umj", - "unityweb", - "uoml", - "vcx", - "vsd", - "vst", - "vss", - "vsw", - "vis", - "vsf", - "wbxml", - "wmlc", - "wmlsc", - "wtb", - "nbp", - "wpd", - "wqd", - "stf", - "xar", - "xfdl", - "hvd", - "hvs", - "hvp", - "osf", - "osfpvg", - "saf", - "spf", - "cmp", - "zir", - "zirz", - "zaz", - "7z", - "abw", - "ace", - "*dmg", - "arj", - "aab", - "x32", - "u32", - "vox", - "aam", - "aas", - "bcpio", - "*bdoc", - "torrent", - "blb", - "blorb", - "bz", - "bz2", - "boz", - "cbr", - "cba", - "cbt", - "cbz", - "cb7", - "vcd", - "cfs", - "chat", - "pgn", - "crx", - "cco", - "nsc", - "cpio", - "csh", - "*deb", - "udeb", - "dgc", - "dir", - "dcr", - "dxr", - "cst", - "cct", - "cxt", - "w3d", - "fgd", - "swa", - "wad", - "ncx", - "dtb", - "res", - "dvi", - "evy", - "eva", - "bdf", - "gsf", - "psf", - "pcf", - "snf", - "pfa", - "pfb", - "pfm", - "afm", - "arc", - "spl", - "gca", - "ulx", - "gnumeric", - "gramps", - "gtar", - "hdf", - "php", - "install", - "*iso", - "*key", - "*numbers", - "*pages", - "jardiff", - "jnlp", - "kdbx", - "latex", - "luac", - "lzh", - "lha", - "run", - "mie", - "prc", - "mobi", - "application", - "lnk", - "wmd", - "wmz", - "xbap", - "mdb", - "obd", - "crd", - "clp", - "*exe", - "*dll", - "com", - "bat", - "*msi", - "mvb", - "m13", - "m14", - "*wmf", - "*wmz", - "*emf", - "emz", - "mny", - "pub", - "scd", - "trm", - "wri", - "nc", - "cdf", - "pac", - "nzb", - "pl", - "pm", - "*prc", - "*pdb", - "p12", - "pfx", - "p7b", - "spc", - "p7r", - "*rar", - "rpm", - "ris", - "sea", - "sh", - "shar", - "swf", - "xap", - "sql", - "sit", - "sitx", - "srt", - "sv4cpio", - "sv4crc", - "t3", - "gam", - "tar", - "tcl", - "tk", - "tex", - "tfm", - "texinfo", - "texi", - "*obj", - "ustar", - "hdd", - "ova", - "ovf", - "vbox", - "vbox-extpack", - "vdi", - "vhd", - "vmdk", - "src", - "webapp", - "der", - "crt", - "pem", - "fig", - "*xlf", - "xpi", - "xz", - "z1", - "z2", - "z3", - "z4", - "z5", - "z6", - "z7", - "z8", - "uva", - "uvva", - "eol", - "dra", - "dts", - "dtshd", - "lvp", - "pya", - "ecelp4800", - "ecelp7470", - "ecelp9600", - "rip", - "aac", - "aif", - "aiff", - "aifc", - "caf", - "flac", - "*m4a", - "mka", - "m3u", - "wax", - "wma", - "ram", - "ra", - "rmp", - "*ra", - "cdx", - "cif", - "cmdf", - "cml", - "csml", - "xyz", - "btif", - "pti", - "psd", - "azv", - "uvi", - "uvvi", - "uvg", - "uvvg", - "djvu", - "djv", - "*sub", - "dwg", - "dxf", - "fbs", - "fpx", - "fst", - "mmr", - "rlc", - "ico", - "dds", - "mdi", - "wdp", - "npx", - "b16", - "tap", - "vtf", - "wbmp", - "xif", - "pcx", - "3ds", - "ras", - "cmx", - "fh", - "fhc", - "fh4", - "fh5", - "fh7", - "*ico", - "jng", - "sid", - "*bmp", - "*pcx", - "pic", - "pct", - "pnm", - "pbm", - "pgm", - "ppm", - "rgb", - "tga", - "xbm", - "xpm", - "xwd", - "wsc", - "dae", - "dwf", - "gdl", - "gtw", - "mts", - "ogex", - "x_b", - "x_t", - "vds", - "usdz", - "bsp", - "vtu", - "dsc", - "curl", - "dcurl", - "mcurl", - "scurl", - "sub", - "fly", - "flx", - "gv", - "3dml", - "spot", - "jad", - "wml", - "wmls", - "s", - "asm", - "c", - "cc", - "cxx", - "cpp", - "h", - "hh", - "dic", - "htc", - "f", - "for", - "f77", - "f90", - "hbs", - "java", - "lua", - "mkd", - "nfo", - "opml", - "*org", - "p", - "pas", - "pde", - "sass", - "scss", - "etx", - "sfv", - "ymp", - "uu", - "vcs", - "vcf", - "uvh", - "uvvh", - "uvm", - "uvvm", - "uvp", - "uvvp", - "uvs", - "uvvs", - "uvv", - "uvvv", - "dvb", - "fvt", - "mxu", - "m4u", - "pyv", - "uvu", - "uvvu", - "viv", - "f4v", - "fli", - "flv", - "m4v", - "mkv", - "mk3d", - "mks", - "mng", - "asf", - "asx", - "vob", - "wm", - "wmv", - "wmx", - "wvx", - "avi", - "movie", - "smv", - "ice", - "mht", - null, - ], - "example": "pdf", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "name": { - "description": "The filename of the file to upload", - "example": "weather-forecast", - "type": "string", - }, - "path": { - "description": "The path for the file to be uploaded to", - "example": "/path/to/file", - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, -} -`; diff --git a/src/openapi/tests/openapi-loader.spec.ts b/src/openapi/tests/openapi-loader.spec.ts deleted file mode 100644 index dcb872be..00000000 --- a/src/openapi/tests/openapi-loader.spec.ts +++ /dev/null @@ -1,13 +0,0 @@ -import { describe, expect, it } from 'bun:test'; -import { loadStackOneSpecs } from '../loader'; - -describe('StackOne OpenAPI Loader', () => { - it('should load specs from OAS directory', () => { - // Load specs from the actual .oas directory - const tools = loadStackOneSpecs(); - - // Verify that tools were loaded - // We know there are multiple JSON files in the .oas directory - expect(Object.keys(tools).length).toBeGreaterThan(0); - }); -}); diff --git a/src/openapi/tests/openapi-parser.spec.ts b/src/openapi/tests/openapi-parser.spec.ts deleted file mode 100644 index 47d23336..00000000 --- a/src/openapi/tests/openapi-parser.spec.ts +++ /dev/null @@ -1,505 +0,0 @@ -import { describe, expect, it, mock, spyOn } from 'bun:test'; -import type { OpenAPIV3 } from 'openapi-types'; -import { ParameterLocation } from '../../types'; -import * as specs from '../generated'; -import { OpenAPIParser } from '../parser'; - -const mockSpec = specs.hrisSpec; - -// Helper function to create a minimal spec for testing -const createMinimalSpec = (customization: Partial = {}): OpenAPIV3.Document => { - return { - openapi: '3.0.0', - info: { - title: 'Test API', - version: '1.0.0', - }, - paths: {}, - ...customization, - }; -}; - -describe('OpenAPIParser', () => { - // Test initialization - describe('constructor', () => { - it('should initialize with a spec object', () => { - const parser = new OpenAPIParser(mockSpec as unknown as OpenAPIV3.Document); - expect(parser).toBeInstanceOf(OpenAPIParser); - }); - - it('should use custom base URL if provided', () => { - const customBaseUrl = 'https://custom-api.example.com'; - const parser = new OpenAPIParser(createMinimalSpec(), customBaseUrl); - - // We can now access the baseUrl property directly - expect(parser.baseUrl).toBe(customBaseUrl); - }); - - it('should correctly apply default base URL to parsed tools', () => { - // Create a minimal spec with a simple path - const minimalSpec = createMinimalSpec({ - paths: { - '/test-path': { - get: { - operationId: 'test_operation', - responses: { - '200': { - description: 'OK', - }, - }, - }, - }, - }, - }); - - const parser = new OpenAPIParser(minimalSpec); - const tools = parser.parseTools(); - - // Check that the tool URL uses the default base URL - expect(tools.test_operation.execute.url).toBe('https://api.stackone.com/test-path'); - }); - - it('should correctly apply custom base URL to parsed tools', () => { - // Create a minimal spec with a simple path - const minimalSpec = createMinimalSpec({ - paths: { - '/test-path': { - get: { - operationId: 'test_operation', - responses: { - '200': { - description: 'OK', - }, - }, - }, - }, - }, - }); - - const customBaseUrl = 'https://api.example-dev.com'; - const parser = new OpenAPIParser(minimalSpec, customBaseUrl); - const tools = parser.parseTools(); - - // Check that the tool URL uses the custom base URL - expect(tools.test_operation.execute.url).toBe('https://api.example-dev.com/test-path'); - }); - }); - - // Test static methods - describe('fromString', () => { - it('should create a parser from a JSON string', () => { - const spec = createMinimalSpec({ - paths: { - '/test': { - get: { - operationId: 'test', - responses: { - '200': { - description: 'OK', - }, - }, - }, - }, - }, - }); - - const jsonString = JSON.stringify(spec); - const parser = OpenAPIParser.fromString(jsonString); - expect(parser).toBeInstanceOf(OpenAPIParser); - }); - - it('should use custom base URL if provided', () => { - const spec = createMinimalSpec({ - paths: { - '/test': { - get: { - operationId: 'test', - responses: { - '200': { - description: 'OK', - }, - }, - }, - }, - }, - }); - - const jsonString = JSON.stringify(spec); - const customBaseUrl = 'https://custom-api.example.com'; - const parser = OpenAPIParser.fromString(jsonString, customBaseUrl); - expect(parser.baseUrl).toBe(customBaseUrl); - }); - }); - - // Test parseTools method - describe('parseTools', () => { - it('should parse tools from core spec', () => { - // Add a path with an operation to make sure there's at least one tool - const minimalSpec = createMinimalSpec({ - paths: { - '/test': { - get: { - operationId: 'test_operation', - responses: { - '200': { - description: 'OK', - }, - }, - }, - }, - }, - }); - - const parser = new OpenAPIParser(minimalSpec); - const tools = parser.parseTools(); - expect(Object.keys(tools).length).toBeGreaterThan(0); - }); - - it('should parse tools from crm spec', () => { - const parser = new OpenAPIParser(specs.crmSpec as unknown as OpenAPIV3.Document); - const tools = parser.parseTools(); - expect(Object.keys(tools).length).toBeGreaterThan(0); - }); - - it('should parse tools from documents spec', () => { - const parser = new OpenAPIParser(specs.documentsSpec as unknown as OpenAPIV3.Document); - const tools = parser.parseTools(); - expect(Object.keys(tools).length).toBeGreaterThan(0); - }); - - it('should parse tools from marketing spec', () => { - const parser = new OpenAPIParser(specs.marketingSpec as unknown as OpenAPIV3.Document); - const tools = parser.parseTools(); - expect(Object.keys(tools).length).toBeGreaterThan(0); - }); - - it('should throw error if operation ID is missing', () => { - // Create a spec with a missing operation ID - const invalidSpec = createMinimalSpec({ - paths: { - '/test': { - get: { - responses: { - '200': { - description: 'OK', - }, - }, - }, - }, - }, - }); - - // Use the spec object directly - const parser = new OpenAPIParser(invalidSpec); - - // Use Bun's mock function instead of modifying the instance - const mockParseToolsFn = mock(() => { - throw new Error('Operation ID is required for tool parsing: GET /test'); - }); - - // Use spyOn to temporarily replace the method - const spy = spyOn(parser, 'parseTools'); - spy.mockImplementation(mockParseToolsFn); - - try { - expect(() => parser.parseTools()).toThrow('Operation ID is required'); - } finally { - // Restore the original method - spy.mockRestore(); - } - }); - - it('should correctly set required fields in tool parameters', () => { - const spec = createMinimalSpec({ - paths: { - '/test': { - post: { - operationId: 'test_operation', - parameters: [ - { - name: 'x-api-key', - in: 'header', - required: true, - schema: { type: 'string' }, - }, - ], - requestBody: { - content: { - 'multipart/form-data': { - schema: { - type: 'object', - properties: { - name: { type: 'string' }, - content: { type: 'string' }, - file_format: { type: 'string' }, - }, - required: ['name', 'content', 'file_format'], - }, - }, - }, - }, - responses: { - '200': { - description: 'OK', - }, - }, - }, - }, - }, - }); - - const parser = new OpenAPIParser(spec); - const tools = parser.parseTools(); - - expect(tools).toHaveProperty('test_operation'); - expect(tools.test_operation.parameters).toHaveProperty('required'); - - // The required fields should include the original required fields - expect(tools.test_operation.parameters.required).toContain('x-api-key'); - expect(tools.test_operation.parameters.required).toContain('name'); - expect(tools.test_operation.parameters.required).toContain('content'); - expect(tools.test_operation.parameters.required).toContain('file_format'); - }); - }); - - describe('parseTools with required fields', () => { - it('should correctly set required fields in tool parameters', () => { - const spec = createMinimalSpec({ - paths: { - '/test': { - post: { - operationId: 'test_operation', - parameters: [ - { - name: 'x-api-key', - in: 'header', - required: true, - schema: { type: 'string' }, - }, - ], - requestBody: { - content: { - 'multipart/form-data': { - schema: { - type: 'object', - properties: { - name: { type: 'string' }, - content: { type: 'string' }, - file_format: { type: 'string' }, - }, - required: ['name', 'content', 'file_format'], - }, - }, - }, - }, - responses: { - '200': { - description: 'OK', - }, - }, - }, - }, - }, - }); - - const parser = new OpenAPIParser(spec); - const tools = parser.parseTools(); - - expect(tools).toHaveProperty('test_operation'); - expect(tools.test_operation.parameters).toHaveProperty('required'); - - // The required fields should include the original required fields - expect(tools.test_operation.parameters.required).toContain('x-api-key'); - expect(tools.test_operation.parameters.required).toContain('name'); - expect(tools.test_operation.parameters.required).toContain('content'); - expect(tools.test_operation.parameters.required).toContain('file_format'); - }); - }); - - // Unit tests for methods - describe('getParameterLocation', () => { - it('should determine parameter location based on schema type', () => { - const parser = new OpenAPIParser(createMinimalSpec()); - - // Default case - no 'in' property should return BODY - expect(parser.getParameterLocation({ type: 'string' })).toBe(ParameterLocation.BODY); - expect(parser.getParameterLocation({ type: 'string', format: 'binary' })).toBe( - ParameterLocation.BODY - ); - expect(parser.getParameterLocation({ type: 'array', items: { type: 'string' } })).toBe( - ParameterLocation.BODY - ); - - // Test with explicit 'in' property - expect(parser.getParameterLocation({ in: 'header', type: 'string' })).toBe( - ParameterLocation.HEADER - ); - expect(parser.getParameterLocation({ in: 'query', type: 'string' })).toBe( - ParameterLocation.QUERY - ); - expect(parser.getParameterLocation({ in: 'path', type: 'string' })).toBe( - ParameterLocation.PATH - ); - expect(parser.getParameterLocation({ in: 'cookie', type: 'string' })).toBe( - ParameterLocation.HEADER - ); - expect(parser.getParameterLocation({ in: 'unknown', type: 'string' })).toBe( - ParameterLocation.BODY - ); - }); - }); - - describe('extractOperations', () => { - it('should extract operations from a path item', () => { - const parser = new OpenAPIParser(createMinimalSpec()); - - const pathItem = { - get: { - operationId: 'getUser', - responses: { '200': { description: 'OK' } }, - }, - post: { - operationId: 'createUser', - responses: { '200': { description: 'OK' } }, - }, - }; - - const operations = parser.extractOperations(pathItem as OpenAPIV3.PathItemObject); - expect(operations.length).toBe(2); - expect(operations[0][0]).toBe('get'); - expect(operations[1][0]).toBe('post'); - }); - }); - - describe('resolveParameter', () => { - it('should resolve parameter references', () => { - const specWithParamRefs = createMinimalSpec({ - components: { - parameters: { - userId: { - name: 'userId', - in: 'path', - required: true, - schema: { - type: 'string', - }, - }, - }, - }, - }); - - const parser = new OpenAPIParser(specWithParamRefs); - - const param = { $ref: '#/components/parameters/userId' }; - const resolved = parser.resolveParameter(param); - expect(resolved).toBeDefined(); - expect(resolved?.name).toBe('userId'); - }); - - it('should return the parameter if it is not a reference', () => { - const parser = new OpenAPIParser(createMinimalSpec()); - - const param = { - name: 'userId', - in: 'path', - required: true, - schema: { - type: 'string', - }, - } as OpenAPIV3.ParameterObject; - - const resolved = parser.resolveParameter(param); - expect(resolved).toBe(param); - }); - }); - - // Snapshot tests - describe('Snapshot Tests', () => { - it('should parse all OpenAPI specs correctly', () => { - // Use the imported spec - const spec = specs.hrisSpec as unknown as OpenAPIV3.Document; - - const parser = new OpenAPIParser(spec); - const tools = parser.parseTools(); - - // Basic validation - expect(Object.keys(tools).length).toBeGreaterThan(0); - - // Check that each tool has the required properties - for (const toolName in tools) { - const tool = tools[toolName]; - expect(tool).toHaveProperty('description'); - expect(tool).toHaveProperty('parameters'); - expect(tool).toHaveProperty('execute'); - } - - expect(tools).toMatchSnapshot(); - }); - }); - - describe('Tool Parameter Handling', () => { - it('should strip source_value from tool parameters', () => { - const spec = createMinimalSpec({ - paths: { - '/test': { - get: { - operationId: 'test_operation', - parameters: [ - { - name: 'source_value', - in: 'query', - required: true, - schema: { type: 'string' }, - }, - ], - responses: { '200': { description: 'OK' } }, - }, - }, - }, - }); - - const parser = new OpenAPIParser(spec, undefined, ['source_value']); - const tools = parser.parseTools(); - - expect(tools).toHaveProperty('test_operation'); - expect(tools.test_operation.parameters).toHaveProperty('required'); - expect(tools.test_operation.parameters).toEqual({ - type: 'object', - properties: {}, - required: undefined, - }); - }); - - it('should remove deprecated parameters from tool parameters', () => { - const spec = createMinimalSpec({ - paths: { - '/test': { - get: { - operationId: 'test_operation', - parameters: [ - { - name: 'deprecated_param', - in: 'query', - deprecated: true, - schema: { type: 'string' }, - }, - ], - responses: { '200': { description: 'OK' } }, - }, - }, - }, - }); - - const parser = new OpenAPIParser(spec, undefined, ['deprecated_param']); - const tools = parser.parseTools(); - - expect(tools).toHaveProperty('test_operation'); - expect(tools.test_operation.parameters).toHaveProperty('required'); - expect(tools.test_operation.parameters).toEqual({ - type: 'object', - properties: {}, - required: undefined, - }); - }); - }); -}); diff --git a/src/tests/__snapshots__/openapi-parser.spec.ts.snap b/src/tests/__snapshots__/openapi-parser.spec.ts.snap deleted file mode 100644 index b90c5e1d..00000000 --- a/src/tests/__snapshots__/openapi-parser.spec.ts.snap +++ /dev/null @@ -1,34009 +0,0 @@ -// Bun Snapshot v1, https://goo.gl/fbAQLP - -exports[`OpenAPIParser Snapshot Tests should parse all OpenAPI specs correctly 1`] = ` -{ - "hris_batch_upload_employee_document": { - "description": "Batch Upload Employee Document", - "execute": { - "bodyType": "json", - "method": "POST", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "body", - "name": "items", - "type": "array", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/documents/upload/batch", - }, - "name": "hris_batch_upload_employee_document", - "parameters": { - "properties": { - "id": { - "type": "string", - }, - "items": { - "description": "The batch of items to create", - "items": { - "properties": { - "category": { - "description": "The category to be associated with the file to be uploaded. Id will take precedence over name.", - "example": { - "id": "550e8400-e29b-41d4-a716-446655440000", - "name": "reports", - }, - "nullable": true, - "properties": { - "value": { - "description": "The category name to associate with the file", - "enum": [ - "application", - "academic", - "contract", - "certificates", - "visa", - "passport", - "driver_license", - "payslip", - "payroll", - "appraisal", - "resume", - "policy", - "cover_letter", - "offer_letter", - "policy_agreement", - "home_address", - "national_id", - "confidential", - "signed", - "shared", - "other", - "benefit", - "id_verification", - "background_check", - "unmapped_value", - null, - ], - "example": "reports", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "category_id": { - "description": "The categoryId of the documents", - "example": "6530", - "nullable": true, - "type": "string", - }, - "confidential": { - "description": "The confidentiality level of the file to be uploaded", - "nullable": true, - "properties": { - "value": { - "description": "Whether the file is confidential or not", - "enum": [ - "true", - "false", - null, - ], - "example": "true", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "content": { - "description": "The base64 encoded content of the file to upload", - "example": "VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE", - "nullable": true, - "type": "string", - }, - "file_format": { - "description": "The file format of the file", - "nullable": true, - "properties": { - "value": { - "description": "The file format of the file, expressed as a file extension", - "enum": [ - "unmapped_value", - "ez", - "aw", - "atom", - "atomcat", - "atomdeleted", - "atomsvc", - "dwd", - "held", - "rsat", - "bdoc", - "xcs", - "ccxml", - "cdfx", - "cdmia", - "cdmic", - "cdmid", - "cdmio", - "cdmiq", - "cu", - "mpd", - "davmount", - "dbk", - "dssc", - "xdssc", - "es", - "ecma", - "emma", - "emotionml", - "epub", - "exi", - "exp", - "fdt", - "pfr", - "geojson", - "gml", - "gpx", - "gxf", - "gz", - "hjson", - "stk", - "ink", - "inkml", - "ipfix", - "its", - "jar", - "war", - "ear", - "ser", - "class", - "js", - "mjs", - "json", - "map", - "json5", - "jsonml", - "jsonld", - "lgr", - "lostxml", - "hqx", - "cpt", - "mads", - "webmanifest", - "mrc", - "mrcx", - "ma", - "nb", - "mb", - "mathml", - "mbox", - "mscml", - "metalink", - "meta4", - "mets", - "maei", - "musd", - "mods", - "m21", - "mp21", - "mp4s", - "m4p", - "doc", - "dot", - "mxf", - "nq", - "nt", - "cjs", - "bin", - "dms", - "lrf", - "mar", - "so", - "dist", - "distz", - "pkg", - "bpk", - "dump", - "elc", - "deploy", - "exe", - "dll", - "deb", - "dmg", - "iso", - "img", - "msi", - "msp", - "msm", - "buffer", - "oda", - "opf", - "ogx", - "omdoc", - "onetoc", - "onetoc2", - "onetmp", - "onepkg", - "oxps", - "relo", - "xer", - "pdf", - "pgp", - "asc", - "sig", - "prf", - "p10", - "p7m", - "p7c", - "p7s", - "p8", - "ac", - "cer", - "crl", - "pkipath", - "pki", - "pls", - "ai", - "eps", - "ps", - "provx", - "pskcxml", - "raml", - "rdf", - "owl", - "rif", - "rnc", - "rl", - "rld", - "rs", - "rapd", - "sls", - "rusd", - "gbr", - "mft", - "roa", - "rsd", - "rss", - "rtf", - "sbml", - "scq", - "scs", - "spq", - "spp", - "sdp", - "senmlx", - "sensmlx", - "setpay", - "setreg", - "shf", - "siv", - "sieve", - "smi", - "smil", - "rq", - "srx", - "gram", - "grxml", - "sru", - "ssdl", - "ssml", - "swidtag", - "tei", - "teicorpus", - "tfi", - "tsd", - "toml", - "trig", - "ttml", - "ubj", - "rsheet", - "td", - "vxml", - "wasm", - "wgt", - "hlp", - "wsdl", - "wspolicy", - "xaml", - "xav", - "xca", - "xdf", - "xel", - "xns", - "xenc", - "xhtml", - "xht", - "xlf", - "xml", - "xsl", - "xsd", - "rng", - "dtd", - "xop", - "xpl", - "*xsl", - "xslt", - "xspf", - "mxml", - "xhvml", - "xvml", - "xvm", - "yang", - "yin", - "zip", - "*3gpp", - "adp", - "amr", - "au", - "snd", - "mid", - "midi", - "kar", - "rmi", - "mxmf", - "*mp3", - "m4a", - "mp4a", - "mpga", - "mp2", - "mp2a", - "mp3", - "m2a", - "m3a", - "oga", - "ogg", - "spx", - "opus", - "s3m", - "sil", - "wav", - "*wav", - "weba", - "xm", - "ttc", - "otf", - "ttf", - "woff", - "woff2", - "exr", - "apng", - "avif", - "bmp", - "cgm", - "drle", - "emf", - "fits", - "g3", - "gif", - "heic", - "heics", - "heif", - "heifs", - "hej2", - "hsj2", - "ief", - "jls", - "jp2", - "jpg2", - "jpeg", - "jpg", - "jpe", - "jph", - "jhc", - "jpm", - "jpx", - "jpf", - "jxr", - "jxra", - "jxrs", - "jxs", - "jxsc", - "jxsi", - "jxss", - "ktx", - "ktx2", - "png", - "sgi", - "svg", - "svgz", - "t38", - "tif", - "tiff", - "tfx", - "webp", - "wmf", - "disposition-notification", - "u8msg", - "u8dsn", - "u8mdn", - "u8hdr", - "eml", - "mime", - "3mf", - "gltf", - "glb", - "igs", - "iges", - "msh", - "mesh", - "silo", - "mtl", - "obj", - "stpx", - "stpz", - "stpxz", - "stl", - "wrl", - "vrml", - "*x3db", - "x3dbz", - "x3db", - "*x3dv", - "x3dvz", - "x3d", - "x3dz", - "x3dv", - "appcache", - "manifest", - "ics", - "ifb", - "coffee", - "litcoffee", - "css", - "csv", - "html", - "htm", - "shtml", - "jade", - "jsx", - "less", - "markdown", - "md", - "mml", - "mdx", - "n3", - "txt", - "text", - "conf", - "def", - "list", - "log", - "in", - "ini", - "rtx", - "*rtf", - "sgml", - "sgm", - "shex", - "slim", - "slm", - "spdx", - "stylus", - "styl", - "tsv", - "t", - "tr", - "roff", - "man", - "me", - "ms", - "ttl", - "uri", - "uris", - "urls", - "vcard", - "vtt", - "*xml", - "yaml", - "yml", - "3gp", - "3gpp", - "3g2", - "h261", - "h263", - "h264", - "m4s", - "jpgv", - "*jpm", - "jpgm", - "mj2", - "mjp2", - "ts", - "mp4", - "mp4v", - "mpg4", - "mpeg", - "mpg", - "mpe", - "m1v", - "m2v", - "ogv", - "qt", - "mov", - "webm", - "cww", - "1km", - "plb", - "psb", - "pvb", - "tcap", - "pwn", - "aso", - "imp", - "acu", - "atc", - "acutc", - "air", - "fcdt", - "fxp", - "fxpl", - "xdp", - "xfdf", - "ahead", - "azf", - "azs", - "azw", - "acc", - "ami", - "apk", - "cii", - "fti", - "atx", - "mpkg", - "key", - "m3u8", - "numbers", - "pages", - "pkpass", - "swi", - "iota", - "aep", - "bmml", - "mpm", - "bmi", - "rep", - "cdxml", - "mmd", - "cdy", - "csl", - "cla", - "rp9", - "c4g", - "c4d", - "c4f", - "c4p", - "c4u", - "c11amc", - "c11amz", - "csp", - "cdbcmsg", - "cmc", - "clkx", - "clkk", - "clkp", - "clkt", - "clkw", - "wbs", - "pml", - "ppd", - "car", - "pcurl", - "dart", - "rdz", - "dbf", - "uvf", - "uvvf", - "uvd", - "uvvd", - "uvt", - "uvvt", - "uvx", - "uvvx", - "uvz", - "uvvz", - "fe_launch", - "dna", - "mlp", - "mle", - "dpg", - "dfac", - "kpxx", - "ait", - "svc", - "geo", - "mag", - "nml", - "esf", - "msf", - "qam", - "slt", - "ssf", - "es3", - "et3", - "ez2", - "ez3", - "fdf", - "mseed", - "seed", - "dataless", - "gph", - "ftc", - "fm", - "frame", - "maker", - "book", - "fnc", - "ltf", - "fsc", - "oas", - "oa2", - "oa3", - "fg5", - "bh2", - "ddd", - "xdw", - "xbd", - "fzs", - "txd", - "ggb", - "ggt", - "gex", - "gre", - "gxt", - "g2w", - "g3w", - "gmx", - "gdoc", - "gslides", - "gsheet", - "kml", - "kmz", - "gqf", - "gqs", - "gac", - "ghf", - "gim", - "grv", - "gtm", - "tpl", - "vcg", - "hal", - "zmm", - "hbci", - "les", - "hpgl", - "hpid", - "hps", - "jlt", - "pcl", - "pclxl", - "sfd-hdstx", - "mpy", - "afp", - "listafp", - "list3820", - "irm", - "sc", - "icc", - "icm", - "igl", - "ivp", - "ivu", - "igm", - "xpw", - "xpx", - "i2g", - "qbo", - "qfx", - "rcprofile", - "irp", - "xpr", - "fcs", - "jam", - "rms", - "jisp", - "joda", - "ktz", - "ktr", - "karbon", - "chrt", - "kfo", - "flw", - "kon", - "kpr", - "kpt", - "ksp", - "kwd", - "kwt", - "htke", - "kia", - "kne", - "knp", - "skp", - "skd", - "skt", - "skm", - "sse", - "lasxml", - "lbd", - "lbe", - "apr", - "pre", - "nsf", - "org", - "scm", - "lwp", - "portpkg", - "mvt", - "mcd", - "mc1", - "cdkey", - "mwf", - "mfm", - "flo", - "igx", - "mif", - "daf", - "dis", - "mbk", - "mqy", - "msl", - "plc", - "txf", - "mpn", - "mpc", - "xul", - "cil", - "cab", - "xls", - "xlm", - "xla", - "xlc", - "xlt", - "xlw", - "xlam", - "xlsb", - "xlsm", - "xltm", - "eot", - "chm", - "ims", - "lrm", - "thmx", - "msg", - "cat", - "*stl", - "ppt", - "pps", - "pot", - "ppam", - "pptm", - "sldm", - "ppsm", - "potm", - "mpp", - "mpt", - "docm", - "dotm", - "wps", - "wks", - "wcm", - "wdb", - "wpl", - "xps", - "mseq", - "mus", - "msty", - "taglet", - "nlu", - "ntf", - "nitf", - "nnd", - "nns", - "nnw", - "*ac", - "ngdat", - "n-gage", - "rpst", - "rpss", - "edm", - "edx", - "ext", - "odc", - "otc", - "odb", - "odf", - "odft", - "odg", - "otg", - "odi", - "oti", - "odp", - "otp", - "ods", - "ots", - "odt", - "odm", - "ott", - "oth", - "xo", - "dd2", - "obgx", - "oxt", - "osm", - "pptx", - "sldx", - "ppsx", - "potx", - "xlsx", - "xltx", - "docx", - "dotx", - "mgp", - "dp", - "esa", - "pdb", - "pqa", - "oprc", - "paw", - "str", - "ei6", - "efif", - "wg", - "plf", - "pbd", - "box", - "mgz", - "qps", - "ptid", - "qxd", - "qxt", - "qwd", - "qwt", - "qxl", - "qxb", - "rar", - "bed", - "mxl", - "musicxml", - "cryptonote", - "cod", - "rm", - "rmvb", - "link66", - "st", - "see", - "sema", - "semd", - "semf", - "ifm", - "itp", - "iif", - "ipk", - "twd", - "twds", - "mmf", - "teacher", - "fo", - "sdkm", - "sdkd", - "dxp", - "sfs", - "sdc", - "sda", - "sdd", - "smf", - "sdw", - "vor", - "sgl", - "smzip", - "sm", - "wadl", - "sxc", - "stc", - "sxd", - "std", - "sxi", - "sti", - "sxm", - "sxw", - "sxg", - "stw", - "sus", - "susp", - "svd", - "sis", - "sisx", - "xsm", - "bdm", - "xdm", - "ddf", - "tao", - "pcap", - "cap", - "dmp", - "tmo", - "tpt", - "mxs", - "tra", - "ufd", - "ufdl", - "utz", - "umj", - "unityweb", - "uoml", - "vcx", - "vsd", - "vst", - "vss", - "vsw", - "vis", - "vsf", - "wbxml", - "wmlc", - "wmlsc", - "wtb", - "nbp", - "wpd", - "wqd", - "stf", - "xar", - "xfdl", - "hvd", - "hvs", - "hvp", - "osf", - "osfpvg", - "saf", - "spf", - "cmp", - "zir", - "zirz", - "zaz", - "7z", - "abw", - "ace", - "*dmg", - "arj", - "aab", - "x32", - "u32", - "vox", - "aam", - "aas", - "bcpio", - "*bdoc", - "torrent", - "blb", - "blorb", - "bz", - "bz2", - "boz", - "cbr", - "cba", - "cbt", - "cbz", - "cb7", - "vcd", - "cfs", - "chat", - "pgn", - "crx", - "cco", - "nsc", - "cpio", - "csh", - "*deb", - "udeb", - "dgc", - "dir", - "dcr", - "dxr", - "cst", - "cct", - "cxt", - "w3d", - "fgd", - "swa", - "wad", - "ncx", - "dtb", - "res", - "dvi", - "evy", - "eva", - "bdf", - "gsf", - "psf", - "pcf", - "snf", - "pfa", - "pfb", - "pfm", - "afm", - "arc", - "spl", - "gca", - "ulx", - "gnumeric", - "gramps", - "gtar", - "hdf", - "php", - "install", - "*iso", - "*key", - "*numbers", - "*pages", - "jardiff", - "jnlp", - "kdbx", - "latex", - "luac", - "lzh", - "lha", - "run", - "mie", - "prc", - "mobi", - "application", - "lnk", - "wmd", - "wmz", - "xbap", - "mdb", - "obd", - "crd", - "clp", - "*exe", - "*dll", - "com", - "bat", - "*msi", - "mvb", - "m13", - "m14", - "*wmf", - "*wmz", - "*emf", - "emz", - "mny", - "pub", - "scd", - "trm", - "wri", - "nc", - "cdf", - "pac", - "nzb", - "pl", - "pm", - "*prc", - "*pdb", - "p12", - "pfx", - "p7b", - "spc", - "p7r", - "*rar", - "rpm", - "ris", - "sea", - "sh", - "shar", - "swf", - "xap", - "sql", - "sit", - "sitx", - "srt", - "sv4cpio", - "sv4crc", - "t3", - "gam", - "tar", - "tcl", - "tk", - "tex", - "tfm", - "texinfo", - "texi", - "*obj", - "ustar", - "hdd", - "ova", - "ovf", - "vbox", - "vbox-extpack", - "vdi", - "vhd", - "vmdk", - "src", - "webapp", - "der", - "crt", - "pem", - "fig", - "*xlf", - "xpi", - "xz", - "z1", - "z2", - "z3", - "z4", - "z5", - "z6", - "z7", - "z8", - "uva", - "uvva", - "eol", - "dra", - "dts", - "dtshd", - "lvp", - "pya", - "ecelp4800", - "ecelp7470", - "ecelp9600", - "rip", - "aac", - "aif", - "aiff", - "aifc", - "caf", - "flac", - "*m4a", - "mka", - "m3u", - "wax", - "wma", - "ram", - "ra", - "rmp", - "*ra", - "cdx", - "cif", - "cmdf", - "cml", - "csml", - "xyz", - "btif", - "pti", - "psd", - "azv", - "uvi", - "uvvi", - "uvg", - "uvvg", - "djvu", - "djv", - "*sub", - "dwg", - "dxf", - "fbs", - "fpx", - "fst", - "mmr", - "rlc", - "ico", - "dds", - "mdi", - "wdp", - "npx", - "b16", - "tap", - "vtf", - "wbmp", - "xif", - "pcx", - "3ds", - "ras", - "cmx", - "fh", - "fhc", - "fh4", - "fh5", - "fh7", - "*ico", - "jng", - "sid", - "*bmp", - "*pcx", - "pic", - "pct", - "pnm", - "pbm", - "pgm", - "ppm", - "rgb", - "tga", - "xbm", - "xpm", - "xwd", - "wsc", - "dae", - "dwf", - "gdl", - "gtw", - "mts", - "ogex", - "x_b", - "x_t", - "vds", - "usdz", - "bsp", - "vtu", - "dsc", - "curl", - "dcurl", - "mcurl", - "scurl", - "sub", - "fly", - "flx", - "gv", - "3dml", - "spot", - "jad", - "wml", - "wmls", - "s", - "asm", - "c", - "cc", - "cxx", - "cpp", - "h", - "hh", - "dic", - "htc", - "f", - "for", - "f77", - "f90", - "hbs", - "java", - "lua", - "mkd", - "nfo", - "opml", - "*org", - "p", - "pas", - "pde", - "sass", - "scss", - "etx", - "sfv", - "ymp", - "uu", - "vcs", - "vcf", - "uvh", - "uvvh", - "uvm", - "uvvm", - "uvp", - "uvvp", - "uvs", - "uvvs", - "uvv", - "uvvv", - "dvb", - "fvt", - "mxu", - "m4u", - "pyv", - "uvu", - "uvvu", - "viv", - "f4v", - "fli", - "flv", - "m4v", - "mkv", - "mk3d", - "mks", - "mng", - "asf", - "asx", - "vob", - "wm", - "wmv", - "wmx", - "wvx", - "avi", - "movie", - "smv", - "ice", - "mht", - null, - ], - "example": "pdf", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "name": { - "description": "The filename of the file to upload", - "example": "weather-forecast", - "nullable": true, - "type": "string", - }, - "path": { - "description": "The path for the file to be uploaded to", - "example": "/path/to/file", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "nullable": false, - "type": "array", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - "items", - ], - "type": "object", - }, - }, - "hris_create_employee": { - "description": "Creates an employee", - "execute": { - "bodyType": "json", - "method": "POST", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "body", - "name": "first_name", - "type": "string", - }, - { - "location": "body", - "name": "last_name", - "type": "string", - }, - { - "location": "body", - "name": "name", - "type": "string", - }, - { - "location": "body", - "name": "display_name", - "type": "string", - }, - { - "location": "body", - "name": "avatar_url", - "type": "string", - }, - { - "location": "body", - "name": "personal_email", - "type": "string", - }, - { - "location": "body", - "name": "personal_phone_number", - "type": "string", - }, - { - "location": "body", - "name": "work_email", - "type": "string", - }, - { - "location": "body", - "name": "work_phone_number", - "type": "string", - }, - { - "location": "body", - "name": "job_id", - "type": "string", - }, - { - "location": "body", - "name": "job_title", - "type": "string", - }, - { - "location": "body", - "name": "department_id", - "type": "string", - }, - { - "location": "body", - "name": "department", - "type": "string", - }, - { - "location": "body", - "name": "manager_id", - "type": "string", - }, - { - "location": "body", - "name": "gender", - "type": "object", - }, - { - "location": "body", - "name": "preferred_language", - "type": "object", - }, - { - "location": "body", - "name": "ethnicity", - "type": "object", - }, - { - "location": "body", - "name": "date_of_birth", - "type": "string", - }, - { - "location": "body", - "name": "birthday", - "type": "string", - }, - { - "location": "body", - "name": "marital_status", - "type": "object", - }, - { - "location": "body", - "name": "avatar", - "type": "object", - }, - { - "location": "body", - "name": "hire_date", - "type": "string", - }, - { - "location": "body", - "name": "start_date", - "type": "string", - }, - { - "location": "body", - "name": "tenure", - "type": "number", - }, - { - "location": "body", - "name": "work_anniversary", - "type": "string", - }, - { - "location": "body", - "name": "employment_type", - "type": "object", - }, - { - "location": "body", - "name": "employment_contract_type", - "type": "object", - }, - { - "location": "body", - "name": "employment_status", - "type": "object", - }, - { - "location": "body", - "name": "termination_date", - "type": "string", - }, - { - "location": "body", - "name": "company_name", - "type": "string", - }, - { - "location": "body", - "name": "company_id", - "type": "string", - }, - { - "location": "body", - "name": "citizenships", - "type": "array", - }, - { - "location": "body", - "name": "employments", - "type": "array", - }, - { - "location": "body", - "name": "custom_fields", - "type": "array", - }, - { - "location": "body", - "name": "benefits", - "type": "array", - }, - { - "location": "body", - "name": "employee_number", - "type": "string", - }, - { - "location": "body", - "name": "national_identity_number", - "type": "object", - }, - { - "location": "body", - "name": "national_identity_numbers", - "type": "array", - }, - { - "location": "body", - "name": "home_location", - "type": "object", - }, - { - "location": "body", - "name": "work_location", - "type": "object", - }, - { - "location": "body", - "name": "cost_centers", - "type": "array", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees", - }, - "name": "hris_create_employee", - "parameters": { - "properties": { - "avatar": { - "description": "The employee avatar", - "example": "https://example.com/avatar.png", - "nullable": true, - "properties": { - "base64": { - "nullable": true, - "type": "string", - }, - "url": { - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "avatar_url": { - "description": "The employee avatar Url", - "example": "https://example.com/avatar.png", - "nullable": true, - "type": "string", - }, - "benefits": { - "description": "Current benefits of the employee", - "items": { - "properties": { - "benefit_type": { - "description": "The type of the benefit", - "nullable": true, - "properties": { - "value": { - "description": "The type of the benefit", - "enum": [ - "retirement_savings", - "health_savings", - "other", - "health_insurance", - "insurance", - "unmapped_value", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "created_at": { - "description": "The date and time the benefit was created", - "example": "2021-01-01T00:00:00Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - "description": { - "description": "The description of the benefit", - "example": "Health insurance for employees", - "nullable": true, - "type": "string", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string", - }, - "name": { - "description": "The name of the benefit", - "example": "Health Insurance", - "nullable": true, - "type": "string", - }, - "provider": { - "description": "The provider of the benefit", - "example": "Aetna", - "nullable": true, - "type": "string", - }, - "updated_at": { - "description": "The date and time the benefit was last updated", - "example": "2021-01-01T00:00:00Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "nullable": true, - "type": "array", - }, - "birthday": { - "description": "The employee birthday", - "example": "2021-01-01T00:00:00Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - "citizenships": { - "description": "The citizenships of the Employee", - "items": { - "properties": { - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "nullable": true, - "type": "array", - }, - "company_id": { - "description": "The employee company id", - "example": "1234567890", - "nullable": true, - "type": "string", - }, - "company_name": { - "deprecated": true, - "description": "The employee company name", - "example": "Example Corp", - "nullable": true, - "type": "string", - }, - "cost_centers": { - "description": "The employee cost centers", - "items": { - "properties": { - "distribution_percentage": { - "example": 100, - "nullable": true, - "type": "number", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string", - }, - "name": { - "example": "R&D", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "nullable": true, - "type": "array", - }, - "custom_fields": { - "description": "The employee custom fields", - "items": { - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string", - }, - "name": { - "description": "The name of the custom field.", - "example": "Training Completion Status", - "nullable": true, - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string", - }, - "remote_value_id": { - "description": "Provider's unique identifier for the value of the custom field.", - "example": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", - "nullable": true, - "type": "string", - }, - "value": { - "description": "The value associated with the custom field.", - "example": "Completed", - "nullable": true, - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value_id": { - "description": "The unique identifier for the value of the custom field.", - "example": "value_456", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "nullable": true, - "type": "array", - }, - "date_of_birth": { - "description": "The employee date_of_birth", - "example": "1990-01-01T00:00.000Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - "department": { - "description": "The employee department", - "example": "Physics", - "nullable": true, - "type": "string", - }, - "department_id": { - "description": "The employee department id", - "example": "3093", - "nullable": true, - "type": "string", - }, - "display_name": { - "description": "The employee display name", - "example": "Sir Issac Newton", - "nullable": true, - "type": "string", - }, - "employee_number": { - "description": "The assigned employee number", - "example": "125", - "nullable": true, - "type": "string", - }, - "employment_contract_type": { - "description": "The employment work schedule type (e.g., full-time, part-time)", - "example": "full_time", - "nullable": true, - "properties": { - "value": { - "enum": [ - "full_time", - "shifts", - "part_time", - "unmapped_value", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "employment_status": { - "description": "The employee employment status", - "example": "active", - "nullable": true, - "properties": { - "value": { - "enum": [ - "active", - "pending", - "terminated", - "leave", - "inactive", - "unknown", - "unmapped_value", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "employment_type": { - "description": "The employee employment type", - "example": "full_time", - "nullable": true, - "properties": { - "value": { - "enum": [ - "contractor", - "intern", - "permanent", - "apprentice", - "freelance", - "terminated", - "temporary", - "seasonal", - "volunteer", - "probation", - "internal", - "external", - "expatriate", - "employer_of_record", - "casual", - "Programme", - "unmapped_value", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "employments": { - "description": "The employee employments", - "items": { - "properties": { - "effective_date": { - "description": "The effective date of the employment contract", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - "employee_id": { - "description": "The employee ID associated with this employment", - "example": "1687-3", - "nullable": true, - "type": "string", - }, - "employment_contract_type": { - "description": "The employment work schedule type (e.g., full-time, part-time)", - "example": "full_time", - "nullable": true, - "properties": { - "value": { - "enum": [ - "full_time", - "shifts", - "part_time", - "unmapped_value", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "employment_type": { - "description": "The type of employment (e.g., contractor, permanent)", - "example": "permanent", - "nullable": true, - "properties": { - "value": { - "enum": [ - "contractor", - "intern", - "permanent", - "apprentice", - "freelance", - "terminated", - "temporary", - "seasonal", - "volunteer", - "probation", - "internal", - "external", - "expatriate", - "employer_of_record", - "casual", - "Programme", - "unmapped_value", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string", - }, - "job_title": { - "description": "The job title of the employee", - "example": "Software Engineer", - "nullable": true, - "type": "string", - }, - "pay_currency": { - "description": "The currency used for pay", - "example": "USD", - "nullable": true, - "type": "string", - }, - "pay_frequency": { - "description": "The pay frequency", - "example": "hourly", - "nullable": true, - "properties": { - "value": { - "enum": [ - "hourly", - "weekly", - "bi_weekly", - "four_weekly", - "semi_monthly", - "monthly", - "bi_monthly", - "quarterly", - "semi_annually", - "yearly", - "thirteen_monthly", - "pro_rata", - "unmapped_value", - "half_yearly", - "daily", - "fixed", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "pay_period": { - "description": "The pay period", - "example": "monthly", - "nullable": true, - "properties": { - "value": { - "enum": [ - "hour", - "day", - "week", - "every_two_weeks", - "month", - "quarter", - "every_six_months", - "year", - "unmapped_value", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "pay_rate": { - "description": "The pay rate for the employee", - "example": "40.00", - "nullable": true, - "type": "string", - }, - "time_worked": { - "description": "The time worked for the employee in ISO 8601 duration format", - "example": "P0Y0M0DT8H0M0S", - "format": "duration", - "nullable": true, - "type": "string", - }, - "unified_custom_fields": { - "additionalProperties": true, - "description": "Custom Unified Fields configured in your StackOne project", - "example": { - "my_project_custom_field_1": "REF-1236", - "my_project_custom_field_2": "some other value", - }, - "nullable": true, - "type": "object", - }, - }, - "type": "object", - }, - "nullable": true, - "type": "array", - }, - "ethnicity": { - "description": "The employee ethnicity", - "example": "white", - "nullable": true, - "properties": { - "value": { - "enum": [ - "white", - "black_or_african_american", - "asian", - "hispanic_or_latino", - "american_indian_or_alaska_native", - "native_hawaiian_or_pacific_islander", - "two_or_more_races", - "not_disclosed", - "other", - "unmapped_value", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "first_name": { - "description": "The employee first name", - "example": "Issac", - "nullable": true, - "type": "string", - }, - "gender": { - "description": "The employee gender", - "example": "male", - "nullable": true, - "properties": { - "value": { - "enum": [ - "male", - "female", - "non_binary", - "other", - "not_disclosed", - "diverse", - "unmapped_value", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "hire_date": { - "description": "The employee hire date", - "example": "2021-01-01T00:00.000Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - "home_location": { - "description": "The employee home location", - "nullable": true, - "properties": { - "city": { - "description": "The city where the location is situated", - "example": "Grantham", - "nullable": true, - "type": "string", - }, - "country": { - "description": "The country code", - "nullable": true, - "properties": { - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string", - }, - "name": { - "description": "The name of the location", - "example": "Woolsthorpe Manor", - "nullable": true, - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "nullable": true, - "type": "object", - }, - "phone_number": { - "description": "The phone number of the location", - "example": "+44 1476 860 364", - "nullable": true, - "type": "string", - }, - "state": { - "description": "The ISO3166-2 sub division where the location is situated", - "example": "GB-LIN", - "nullable": true, - "properties": { - "value": { - "enum": [ - "AD-07", - "AD-02", - "AD-03", - "AD-08", - "AD-04", - "AD-05", - "AD-06", - "AE-AJ", - "AE-AZ", - "AE-FU", - "AE-SH", - "AE-DU", - "AE-RK", - "AE-UQ", - "AF-BDS", - "AF-BDG", - "AF-BGL", - "AF-BAL", - "AF-BAM", - "AF-DAY", - "AF-FRA", - "AF-FYB", - "AF-GHA", - "AF-GHO", - "AF-HEL", - "AF-HER", - "AF-JOW", - "AF-KAB", - "AF-KAN", - "AF-KAP", - "AF-KHO", - "AF-KDZ", - "AF-LAG", - "AF-LOG", - "AF-NAN", - "AF-NIM", - "AF-PIA", - "AF-PAR", - "AF-SAR", - "AF-TAK", - "AF-URU", - "AG-11", - "AG-03", - "AG-04", - "AG-06", - "AG-07", - "AG-08", - "AI-XX-1", - "AL-01", - "AL-09", - "AL-02", - "AL-03", - "AL-04", - "AL-05", - "AL-06", - "AL-07", - "AL-08", - "AL-10", - "AL-11", - "AL-12", - "AM-AG", - "AM-AR", - "AM-AV", - "AM-ER", - "AM-GR", - "AM-KT", - "AM-LO", - "AM-SH", - "AM-SU", - "AM-TV", - "AM-VD", - "AO-BGO", - "AO-BGU", - "AO-BIE", - "AO-CAB", - "AO-CCU", - "AO-CNO", - "AO-CUS", - "AO-CNN", - "AO-HUA", - "AO-HUI", - "AO-LUA", - "AO-LNO", - "AO-LSU", - "AO-MAL", - "AO-MOX", - "AO-NAM", - "AO-UIG", - "AO-ZAI", - "AQ-XX-1", - "AR-B", - "AR-K", - "AR-H", - "AR-U", - "AR-C", - "AR-X", - "AR-W", - "AR-E", - "AR-P", - "AR-Y", - "AR-L", - "AR-F", - "AR-M", - "AR-N", - "AR-Q", - "AR-R", - "AR-A", - "AR-J", - "AR-D", - "AR-Z", - "AR-S", - "AR-G", - "AR-V", - "AR-T", - "AS-XX-1", - "AS-XX-2", - "AT-1", - "AT-2", - "AT-3", - "AT-4", - "AT-5", - "AT-6", - "AT-7", - "AT-8", - "AT-9", - "AU-ACT", - "AU-NSW", - "AU-NT", - "AU-QLD", - "AU-SA", - "AU-TAS", - "AU-VIC", - "AU-WA", - "AW-XX-1", - "AX-XX-1", - "AX-XX-2", - "AX-XX-3", - "AX-XX-4", - "AX-XX-5", - "AX-XX-6", - "AX-XX-7", - "AX-XX-8", - "AZ-ABS", - "AZ-AGC", - "AZ-AGU", - "AZ-AST", - "AZ-BA", - "AZ-BAL", - "AZ-BAR", - "AZ-BEY", - "AZ-BIL", - "AZ-CAL", - "AZ-FUZ", - "AZ-GAD", - "AZ-GA", - "AZ-GOR", - "AZ-GOY", - "AZ-GYG", - "AZ-IMI", - "AZ-ISM", - "AZ-KUR", - "AZ-LA", - "AZ-MAS", - "AZ-MI", - "AZ-NA", - "AZ-NX", - "AZ-NEF", - "AZ-OGU", - "AZ-QAB", - "AZ-QAX", - "AZ-QAZ", - "AZ-QBA", - "AZ-QUS", - "AZ-SAT", - "AZ-SAB", - "AZ-SAK", - "AZ-SAL", - "AZ-SMI", - "AZ-SKR", - "AZ-SMX", - "AZ-SR", - "AZ-SM", - "AZ-TAR", - "AZ-UCA", - "AZ-XAC", - "AZ-XVD", - "AZ-YAR", - "AZ-YEV", - "AZ-ZAQ", - "AZ-ZAR", - "BA-BRC", - "BA-BIH", - "BA-SRP", - "BB-01", - "BB-02", - "BB-03", - "BB-04", - "BB-05", - "BB-07", - "BB-08", - "BB-09", - "BB-10", - "BB-11", - "BD-A", - "BD-B", - "BD-C", - "BD-D", - "BD-E", - "BD-F", - "BD-G", - "BE-VAN", - "BE-WBR", - "BE-BRU", - "BE-WHT", - "BE-WLG", - "BE-VLI", - "BE-WLX", - "BE-WNA", - "BE-VOV", - "BE-VBR", - "BE-VWV", - "BF-BAM", - "BF-BAZ", - "BF-BLG", - "BF-BLK", - "BF-COM", - "BF-GAN", - "BF-GNA", - "BF-GOU", - "BF-HOU", - "BF-IOB", - "BF-KAD", - "BF-KEN", - "BF-KMP", - "BF-KOS", - "BF-KOT", - "BF-KOW", - "BF-LER", - "BF-LOR", - "BF-MOU", - "BF-NAO", - "BF-NAM", - "BF-NAY", - "BF-OUB", - "BF-OUD", - "BF-PAS", - "BF-PON", - "BF-SNG", - "BF-SMT", - "BF-SEN", - "BF-SIS", - "BF-SOM", - "BF-SOR", - "BF-TAP", - "BF-TUI", - "BF-YAT", - "BF-ZIR", - "BF-ZON", - "BF-ZOU", - "BG-01", - "BG-02", - "BG-08", - "BG-07", - "BG-26", - "BG-09", - "BG-10", - "BG-11", - "BG-12", - "BG-13", - "BG-14", - "BG-15", - "BG-16", - "BG-17", - "BG-18", - "BG-27", - "BG-19", - "BG-20", - "BG-21", - "BG-23", - "BG-22", - "BG-24", - "BG-25", - "BG-03", - "BG-04", - "BG-05", - "BG-06", - "BG-28", - "BH-13", - "BH-14", - "BH-15", - "BH-17", - "BI-BM", - "BI-CI", - "BI-GI", - "BI-KR", - "BI-KI", - "BI-MW", - "BI-NG", - "BI-RM", - "BI-RT", - "BI-RY", - "BJ-AK", - "BJ-AQ", - "BJ-BO", - "BJ-CO", - "BJ-DO", - "BJ-LI", - "BJ-MO", - "BJ-OU", - "BJ-PL", - "BJ-ZO", - "BL-XX-1", - "BM-XX-1", - "BM-XX-2", - "BN-BE", - "BN-BM", - "BN-TE", - "BN-TU", - "BO-H", - "BO-C", - "BO-B", - "BO-L", - "BO-O", - "BO-N", - "BO-P", - "BO-S", - "BO-T", - "BQ-BO", - "BQ-SA", - "BQ-SE", - "BR-AC", - "BR-AL", - "BR-AP", - "BR-AM", - "BR-BA", - "BR-CE", - "BR-DF", - "BR-ES", - "BR-GO", - "BR-MA", - "BR-MT", - "BR-MS", - "BR-MG", - "BR-PA", - "BR-PB", - "BR-PR", - "BR-PE", - "BR-PI", - "BR-RN", - "BR-RS", - "BR-RJ", - "BR-RO", - "BR-RR", - "BR-SC", - "BR-SP", - "BR-SE", - "BR-TO", - "BS-BP", - "BS-CO", - "BS-FP", - "BS-EG", - "BS-HI", - "BS-LI", - "BS-NP", - "BS-NO", - "BS-NS", - "BS-NE", - "BS-SE", - "BS-WG", - "BT-33", - "BT-12", - "BT-22", - "BT-GA", - "BT-44", - "BT-42", - "BT-11", - "BT-43", - "BT-23", - "BT-45", - "BT-14", - "BT-31", - "BT-15", - "BT-41", - "BT-32", - "BT-21", - "BT-24", - "BV-XX-1", - "BW-CE", - "BW-CH", - "BW-GH", - "BW-KG", - "BW-KL", - "BW-KW", - "BW-NE", - "BW-NW", - "BW-SE", - "BW-SO", - "BY-BR", - "BY-HO", - "BY-HM", - "BY-HR", - "BY-MA", - "BY-MI", - "BY-VI", - "BZ-BZ", - "BZ-CY", - "BZ-CZL", - "BZ-OW", - "BZ-SC", - "BZ-TOL", - "CA-AB", - "CA-BC", - "CA-MB", - "CA-NB", - "CA-NL", - "CA-NT", - "CA-NS", - "CA-NU", - "CA-ON", - "CA-PE", - "CA-QC", - "CA-SK", - "CA-YT", - "CC-XX-1", - "CD-EQ", - "CD-HK", - "CD-HL", - "CD-IT", - "CD-KC", - "CD-KE", - "CD-KN", - "CD-BC", - "CD-KG", - "CD-KL", - "CD-LU", - "CD-NK", - "CD-SA", - "CD-SK", - "CD-TA", - "CD-TO", - "CD-TU", - "CF-BB", - "CF-BGF", - "CF-KB", - "CF-HM", - "CF-KG", - "CF-NM", - "CF-UK", - "CF-AC", - "CF-OP", - "CF-VK", - "CG-11", - "CG-BZV", - "CG-8", - "CG-9", - "CG-16", - "CG-13", - "CH-AG", - "CH-AR", - "CH-AI", - "CH-BL", - "CH-BS", - "CH-BE", - "CH-FR", - "CH-GE", - "CH-GL", - "CH-GR", - "CH-JU", - "CH-LU", - "CH-NE", - "CH-NW", - "CH-OW", - "CH-SG", - "CH-SH", - "CH-SZ", - "CH-SO", - "CH-TG", - "CH-TI", - "CH-UR", - "CH-VS", - "CH-VD", - "CH-ZG", - "CH-ZH", - "CI-AB", - "CI-BS", - "CI-CM", - "CI-DN", - "CI-GD", - "CI-LC", - "CI-LG", - "CI-MG", - "CI-SM", - "CI-SV", - "CI-VB", - "CI-WR", - "CI-YM", - "CI-ZZ", - "CK-XX-1", - "CL-AI", - "CL-AN", - "CL-AP", - "CL-AT", - "CL-BI", - "CL-CO", - "CL-AR", - "CL-LI", - "CL-LL", - "CL-LR", - "CL-MA", - "CL-ML", - "CL-NB", - "CL-RM", - "CL-TA", - "CL-VS", - "CM-AD", - "CM-CE", - "CM-ES", - "CM-EN", - "CM-LT", - "CM-NO", - "CM-NW", - "CM-OU", - "CM-SU", - "CM-SW", - "CN-AH", - "CN-BJ", - "CN-CQ", - "CN-FJ", - "CN-GS", - "CN-GD", - "CN-GX", - "CN-GZ", - "CN-HI", - "CN-HE", - "CN-HL", - "CN-HA", - "CN-HB", - "CN-HN", - "CN-JS", - "CN-JX", - "CN-JL", - "CN-LN", - "CN-NM", - "CN-NX", - "CN-QH", - "CN-SN", - "CN-SD", - "CN-SH", - "CN-SX", - "CN-SC", - "CN-TJ", - "CN-XJ", - "CN-XZ", - "CN-YN", - "CN-ZJ", - "CO-AMA", - "CO-ANT", - "CO-ARA", - "CO-ATL", - "CO-BOL", - "CO-BOY", - "CO-CAL", - "CO-CAQ", - "CO-CAS", - "CO-CAU", - "CO-CES", - "CO-CHO", - "CO-COR", - "CO-CUN", - "CO-DC", - "CO-GUA", - "CO-GUV", - "CO-HUI", - "CO-LAG", - "CO-MAG", - "CO-MET", - "CO-NAR", - "CO-NSA", - "CO-PUT", - "CO-QUI", - "CO-RIS", - "CO-SAP", - "CO-SAN", - "CO-SUC", - "CO-TOL", - "CO-VAC", - "CO-VID", - "CR-A", - "CR-C", - "CR-G", - "CR-H", - "CR-L", - "CR-P", - "CR-SJ", - "CU-15", - "CU-09", - "CU-08", - "CU-06", - "CU-12", - "CU-14", - "CU-11", - "CU-03", - "CU-10", - "CU-04", - "CU-16", - "CU-01", - "CU-07", - "CU-13", - "CU-05", - "CV-BV", - "CV-BR", - "CV-MO", - "CV-PN", - "CV-PR", - "CV-RS", - "CV-SL", - "CV-CR", - "CV-SD", - "CV-SO", - "CV-SV", - "CV-TA", - "CV-TS", - "CW-XX-1", - "CX-XX-1", - "CY-04", - "CY-06", - "CY-03", - "CY-01", - "CY-02", - "CY-05", - "CZ-31", - "CZ-64", - "CZ-41", - "CZ-63", - "CZ-52", - "CZ-51", - "CZ-80", - "CZ-71", - "CZ-53", - "CZ-32", - "CZ-10", - "CZ-20", - "CZ-42", - "CZ-72", - "DE-BW", - "DE-BY", - "DE-BE", - "DE-BB", - "DE-HB", - "DE-HH", - "DE-HE", - "DE-MV", - "DE-NI", - "DE-NW", - "DE-RP", - "DE-SL", - "DE-SN", - "DE-ST", - "DE-SH", - "DE-TH", - "DJ-AR", - "DJ-DJ", - "DK-84", - "DK-82", - "DK-81", - "DK-85", - "DK-83", - "DM-02", - "DM-04", - "DM-05", - "DM-06", - "DM-07", - "DM-09", - "DM-10", - "DO-02", - "DO-03", - "DO-04", - "DO-05", - "DO-01", - "DO-06", - "DO-08", - "DO-07", - "DO-09", - "DO-30", - "DO-19", - "DO-10", - "DO-11", - "DO-12", - "DO-13", - "DO-14", - "DO-28", - "DO-15", - "DO-29", - "DO-17", - "DO-18", - "DO-20", - "DO-21", - "DO-31", - "DO-22", - "DO-23", - "DO-24", - "DO-25", - "DO-26", - "DO-27", - "DZ-01", - "DZ-44", - "DZ-46", - "DZ-16", - "DZ-23", - "DZ-05", - "DZ-08", - "DZ-06", - "DZ-07", - "DZ-09", - "DZ-34", - "DZ-10", - "DZ-35", - "DZ-02", - "DZ-25", - "DZ-17", - "DZ-32", - "DZ-39", - "DZ-36", - "DZ-47", - "DZ-24", - "DZ-33", - "DZ-18", - "DZ-40", - "DZ-03", - "DZ-28", - "DZ-29", - "DZ-26", - "DZ-43", - "DZ-27", - "DZ-45", - "DZ-31", - "DZ-30", - "DZ-04", - "DZ-48", - "DZ-20", - "DZ-19", - "DZ-22", - "DZ-21", - "DZ-41", - "DZ-11", - "DZ-12", - "DZ-14", - "DZ-37", - "DZ-42", - "DZ-38", - "DZ-15", - "DZ-13", - "EC-A", - "EC-B", - "EC-F", - "EC-C", - "EC-H", - "EC-X", - "EC-O", - "EC-E", - "EC-W", - "EC-G", - "EC-I", - "EC-L", - "EC-R", - "EC-M", - "EC-S", - "EC-N", - "EC-D", - "EC-Y", - "EC-P", - "EC-SE", - "EC-SD", - "EC-U", - "EC-T", - "EC-Z", - "EE-37", - "EE-39", - "EE-45", - "EE-52", - "EE-50", - "EE-60", - "EE-56", - "EE-68", - "EE-64", - "EE-71", - "EE-74", - "EE-79", - "EE-81", - "EE-84", - "EE-87", - "EG-DK", - "EG-BA", - "EG-BH", - "EG-FYM", - "EG-GH", - "EG-ALX", - "EG-IS", - "EG-GZ", - "EG-MNF", - "EG-MN", - "EG-C", - "EG-KB", - "EG-LX", - "EG-WAD", - "EG-SUZ", - "EG-SHR", - "EG-ASN", - "EG-AST", - "EG-BNS", - "EG-PTS", - "EG-DT", - "EG-JS", - "EG-KFS", - "EG-MT", - "EG-KN", - "EG-SIN", - "EG-SHG", - "EH-XX-1", - "ER-MA", - "ER-DK", - "ER-SK", - "ES-AN", - "ES-AR", - "ES-AS", - "ES-CN", - "ES-CB", - "ES-CL", - "ES-CM", - "ES-CT", - "ES-CE", - "ES-EX", - "ES-GA", - "ES-IB", - "ES-RI", - "ES-MD", - "ES-ML", - "ES-MC", - "ES-NC", - "ES-PV", - "ES-VC", - "ET-AA", - "ET-AF", - "ET-AM", - "ET-BE", - "ET-DD", - "ET-GA", - "ET-HA", - "ET-OR", - "ET-SO", - "ET-TI", - "ET-SN", - "FI-02", - "FI-03", - "FI-04", - "FI-05", - "FI-06", - "FI-07", - "FI-08", - "FI-09", - "FI-10", - "FI-16", - "FI-11", - "FI-12", - "FI-13", - "FI-14", - "FI-15", - "FI-17", - "FI-18", - "FI-19", - "FJ-C", - "FJ-E", - "FJ-N", - "FJ-R", - "FJ-W", - "FK-XX-1", - "FM-TRK", - "FM-KSA", - "FM-PNI", - "FM-YAP", - "FO-XX-1", - "FO-XX-2", - "FO-XX-3", - "FO-XX-4", - "FO-XX-5", - "FR-ARA", - "FR-BFC", - "FR-BRE", - "FR-CVL", - "FR-20R", - "FR-GES", - "FR-HDF", - "FR-IDF", - "FR-NOR", - "FR-NAQ", - "FR-OCC", - "FR-PDL", - "FR-PAC", - "GA-1", - "GA-2", - "GA-4", - "GA-5", - "GA-8", - "GA-9", - "GB-ENG", - "GB-NIR", - "GB-SCT", - "GB-WLS", - "GB-CAM", - "GB-CMA", - "GB-DBY", - "GB-DEV", - "GB-DOR", - "GB-ESX", - "GB-ESS", - "GB-GLS", - "GB-HAM", - "GB-HRT", - "GB-KEN", - "GB-LAN", - "GB-LEC", - "GB-LIN", - "GB-NFK", - "GB-NYK", - "GB-NTT", - "GB-OXF", - "GB-SOM", - "GB-STS", - "GB-SFK", - "GB-SRY", - "GB-WAR", - "GB-WSX", - "GB-WOR", - "GB-LND", - "GB-BDG", - "GB-BNE", - "GB-BEX", - "GB-BEN", - "GB-BRY", - "GB-CMD", - "GB-CRY", - "GB-EAL", - "GB-ENF", - "GB-GRE", - "GB-HCK", - "GB-HMF", - "GB-HRY", - "GB-HRW", - "GB-HAV", - "GB-HIL", - "GB-HNS", - "GB-ISL", - "GB-KEC", - "GB-KTT", - "GB-LBH", - "GB-LEW", - "GB-MRT", - "GB-NWM", - "GB-RDB", - "GB-RIC", - "GB-SWK", - "GB-STN", - "GB-TWH", - "GB-WFT", - "GB-WND", - "GB-WSM", - "GB-BNS", - "GB-BIR", - "GB-BOL", - "GB-BRD", - "GB-BUR", - "GB-CLD", - "GB-COV", - "GB-DNC", - "GB-DUD", - "GB-GAT", - "GB-KIR", - "GB-KWL", - "GB-LDS", - "GB-LIV", - "GB-MAN", - "GB-NET", - "GB-NTY", - "GB-OLD", - "GB-RCH", - "GB-ROT", - "GB-SHN", - "GB-SLF", - "GB-SAW", - "GB-SFT", - "GB-SHF", - "GB-SOL", - "GB-STY", - "GB-SKP", - "GB-SND", - "GB-TAM", - "GB-TRF", - "GB-WKF", - "GB-WLL", - "GB-WGN", - "GB-WRL", - "GB-WLV", - "GB-BAS", - "GB-BDF", - "GB-BBD", - "GB-BPL", - "GB-BCP", - "GB-BRC", - "GB-BNH", - "GB-BST", - "GB-BKM", - "GB-CBF", - "GB-CHE", - "GB-CHW", - "GB-CON", - "GB-DAL", - "GB-DER", - "GB-DUR", - "GB-ERY", - "GB-HAL", - "GB-HPL", - "GB-HEF", - "GB-IOW", - "GB-IOS", - "GB-KHL", - "GB-LCE", - "GB-LUT", - "GB-MDW", - "GB-MDB", - "GB-MIK", - "GB-NEL", - "GB-NLN", - "GB-NNH", - "GB-NSM", - "GB-NBL", - "GB-NGM", - "GB-PTE", - "GB-PLY", - "GB-POR", - "GB-RDG", - "GB-RCC", - "GB-RUT", - "GB-SHR", - "GB-SLG", - "GB-SGC", - "GB-STH", - "GB-SOS", - "GB-STT", - "GB-STE", - "GB-SWD", - "GB-TFW", - "GB-THR", - "GB-TOB", - "GB-WRT", - "GB-WBK", - "GB-WNH", - "GB-WIL", - "GB-WNM", - "GB-WOK", - "GB-YOR", - "GB-ANN", - "GB-AND", - "GB-ABC", - "GB-BFS", - "GB-CCG", - "GB-DRS", - "GB-FMO", - "GB-LBC", - "GB-MEA", - "GB-MUL", - "GB-NMD", - "GB-ABE", - "GB-ABD", - "GB-ANS", - "GB-AGB", - "GB-CLK", - "GB-DGY", - "GB-DND", - "GB-EAY", - "GB-EDU", - "GB-ELN", - "GB-ERW", - "GB-EDH", - "GB-ELS", - "GB-FAL", - "GB-FIF", - "GB-GLG", - "GB-HLD", - "GB-IVC", - "GB-MLN", - "GB-MRY", - "GB-NAY", - "GB-NLK", - "GB-ORK", - "GB-PKN", - "GB-RFW", - "GB-SCB", - "GB-ZET", - "GB-SAY", - "GB-SLK", - "GB-STG", - "GB-WDU", - "GB-WLN", - "GB-BGW", - "GB-BGE", - "GB-CAY", - "GB-CRF", - "GB-CMN", - "GB-CGN", - "GB-CWY", - "GB-DEN", - "GB-FLN", - "GB-GWN", - "GB-AGY", - "GB-MTY", - "GB-MON", - "GB-NTL", - "GB-NWP", - "GB-PEM", - "GB-POW", - "GB-RCT", - "GB-SWA", - "GB-TOF", - "GB-VGL", - "GB-WRX", - "GD-01", - "GD-02", - "GD-03", - "GD-04", - "GD-05", - "GD-06", - "GD-10", - "GE-AB", - "GE-AJ", - "GE-GU", - "GE-IM", - "GE-KA", - "GE-KK", - "GE-MM", - "GE-RL", - "GE-SZ", - "GE-SJ", - "GE-SK", - "GE-TB", - "GF-XX-1", - "GG-XX-1", - "GH-AF", - "GH-AH", - "GH-BO", - "GH-BE", - "GH-CP", - "GH-EP", - "GH-AA", - "GH-NP", - "GH-UE", - "GH-UW", - "GH-TV", - "GH-WP", - "GI-XX-1", - "GL-AV", - "GL-KU", - "GL-QT", - "GL-SM", - "GL-QE", - "GM-B", - "GM-M", - "GM-L", - "GM-N", - "GM-U", - "GM-W", - "GN-BF", - "GN-B", - "GN-C", - "GN-CO", - "GN-DB", - "GN-DU", - "GN-K", - "GN-L", - "GN-LA", - "GN-MC", - "GN-N", - "GN-SI", - "GP-XX-1", - "GQ-BN", - "GQ-KN", - "GQ-LI", - "GQ-WN", - "GR-A", - "GR-I", - "GR-G", - "GR-C", - "GR-F", - "GR-D", - "GR-B", - "GR-M", - "GR-L", - "GR-J", - "GR-H", - "GR-E", - "GR-K", - "GS-XX-1", - "GT-16", - "GT-15", - "GT-04", - "GT-20", - "GT-02", - "GT-05", - "GT-01", - "GT-13", - "GT-18", - "GT-21", - "GT-22", - "GT-17", - "GT-09", - "GT-14", - "GT-11", - "GT-03", - "GT-12", - "GT-06", - "GT-07", - "GT-10", - "GT-08", - "GT-19", - "GU-XX-1", - "GU-XX-2", - "GU-XX-3", - "GU-XX-4", - "GU-XX-5", - "GU-XX-6", - "GU-XX-7", - "GU-XX-8", - "GU-XX-9", - "GU-XX-10", - "GU-XX-11", - "GU-XX-12", - "GU-XX-13", - "GU-XX-14", - "GU-XX-15", - "GU-XX-16", - "GW-BS", - "GW-GA", - "GY-CU", - "GY-DE", - "GY-EB", - "GY-ES", - "GY-MA", - "GY-PT", - "GY-UD", - "HK-XX-1", - "HM-XX-1", - "HN-AT", - "HN-CH", - "HN-CL", - "HN-CM", - "HN-CP", - "HN-CR", - "HN-EP", - "HN-FM", - "HN-GD", - "HN-IN", - "HN-IB", - "HN-LP", - "HN-LE", - "HN-OC", - "HN-OL", - "HN-SB", - "HN-VA", - "HN-YO", - "HR-07", - "HR-12", - "HR-19", - "HR-21", - "HR-18", - "HR-04", - "HR-06", - "HR-02", - "HR-09", - "HR-20", - "HR-14", - "HR-11", - "HR-08", - "HR-15", - "HR-03", - "HR-17", - "HR-05", - "HR-10", - "HR-16", - "HR-13", - "HR-01", - "HT-AR", - "HT-CE", - "HT-GA", - "HT-NI", - "HT-ND", - "HT-OU", - "HT-SD", - "HT-SE", - "HU-BK", - "HU-BA", - "HU-BE", - "HU-BZ", - "HU-BU", - "HU-CS", - "HU-FE", - "HU-GS", - "HU-HB", - "HU-HE", - "HU-JN", - "HU-KE", - "HU-NO", - "HU-PE", - "HU-SO", - "HU-SZ", - "HU-TO", - "HU-VA", - "HU-VE", - "HU-ZA", - "ID-AC", - "ID-BA", - "ID-BT", - "ID-BE", - "ID-GO", - "ID-JK", - "ID-JA", - "ID-JB", - "ID-JT", - "ID-JI", - "ID-KB", - "ID-KS", - "ID-KT", - "ID-KI", - "ID-KU", - "ID-BB", - "ID-KR", - "ID-LA", - "ID-ML", - "ID-MU", - "ID-NB", - "ID-NT", - "ID-PP", - "ID-PB", - "ID-RI", - "ID-SR", - "ID-SN", - "ID-ST", - "ID-SG", - "ID-SA", - "ID-SB", - "ID-SS", - "ID-SU", - "ID-YO", - "IE-CW", - "IE-CN", - "IE-CE", - "IE-CO", - "IE-DL", - "IE-D", - "IE-G", - "IE-KY", - "IE-KE", - "IE-KK", - "IE-LS", - "IE-LM", - "IE-LK", - "IE-LD", - "IE-LH", - "IE-MO", - "IE-MH", - "IE-MN", - "IE-OY", - "IE-RN", - "IE-SO", - "IE-TA", - "IE-WD", - "IE-WH", - "IE-WX", - "IE-WW", - "IL-D", - "IL-M", - "IL-Z", - "IL-HA", - "IL-TA", - "IL-JM", - "IM-XX-1", - "IN-AN", - "IN-AP", - "IN-AR", - "IN-AS", - "IN-BR", - "IN-CH", - "IN-CT", - "IN-DN", - "IN-DH", - "IN-DL", - "IN-GA", - "IN-GJ", - "IN-HR", - "IN-HP", - "IN-JK", - "IN-JH", - "IN-KA", - "IN-KL", - "IN-LD", - "IN-MP", - "IN-MH", - "IN-MN", - "IN-ML", - "IN-MZ", - "IN-NL", - "IN-OR", - "IN-PY", - "IN-PB", - "IN-RJ", - "IN-SK", - "IN-TN", - "IN-TG", - "IN-TR", - "IN-UP", - "IN-UT", - "IN-WB", - "IO-XX-1", - "IQ-AN", - "IQ-BA", - "IQ-MU", - "IQ-QA", - "IQ-NA", - "IQ-AR", - "IQ-SU", - "IQ-BB", - "IQ-BG", - "IQ-DA", - "IQ-DQ", - "IQ-DI", - "IQ-KA", - "IQ-KI", - "IQ-MA", - "IQ-NI", - "IQ-SD", - "IQ-WA", - "IR-30", - "IR-24", - "IR-04", - "IR-03", - "IR-18", - "IR-14", - "IR-10", - "IR-07", - "IR-01", - "IR-27", - "IR-13", - "IR-22", - "IR-16", - "IR-08", - "IR-05", - "IR-29", - "IR-09", - "IR-28", - "IR-06", - "IR-17", - "IR-12", - "IR-15", - "IR-00", - "IR-02", - "IR-26", - "IR-25", - "IR-20", - "IR-11", - "IR-23", - "IR-21", - "IR-19", - "IS-7", - "IS-1", - "IS-6", - "IS-5", - "IS-8", - "IS-2", - "IS-4", - "IS-3", - "IT-65", - "IT-77", - "IT-78", - "IT-72", - "IT-45", - "IT-36", - "IT-62", - "IT-42", - "IT-25", - "IT-57", - "IT-67", - "IT-21", - "IT-75", - "IT-88", - "IT-82", - "IT-52", - "IT-32", - "IT-55", - "IT-23", - "IT-34", - "JE-XX-1", - "JM-13", - "JM-09", - "JM-01", - "JM-12", - "JM-04", - "JM-02", - "JM-06", - "JM-14", - "JM-11", - "JM-08", - "JM-05", - "JM-03", - "JM-07", - "JM-10", - "JO-AJ", - "JO-AQ", - "JO-AM", - "JO-BA", - "JO-KA", - "JO-MA", - "JO-AT", - "JO-AZ", - "JO-IR", - "JO-JA", - "JO-MN", - "JO-MD", - "JP-23", - "JP-05", - "JP-02", - "JP-12", - "JP-38", - "JP-18", - "JP-40", - "JP-07", - "JP-21", - "JP-10", - "JP-34", - "JP-01", - "JP-28", - "JP-08", - "JP-17", - "JP-03", - "JP-37", - "JP-46", - "JP-14", - "JP-39", - "JP-43", - "JP-26", - "JP-24", - "JP-04", - "JP-45", - "JP-20", - "JP-42", - "JP-29", - "JP-15", - "JP-44", - "JP-33", - "JP-47", - "JP-27", - "JP-41", - "JP-11", - "JP-25", - "JP-32", - "JP-22", - "JP-09", - "JP-36", - "JP-13", - "JP-31", - "JP-16", - "JP-30", - "JP-06", - "JP-35", - "JP-19", - "KE-01", - "KE-02", - "KE-03", - "KE-04", - "KE-05", - "KE-06", - "KE-07", - "KE-08", - "KE-09", - "KE-10", - "KE-11", - "KE-12", - "KE-13", - "KE-14", - "KE-15", - "KE-16", - "KE-17", - "KE-18", - "KE-19", - "KE-20", - "KE-21", - "KE-22", - "KE-23", - "KE-24", - "KE-25", - "KE-26", - "KE-27", - "KE-28", - "KE-29", - "KE-30", - "KE-31", - "KE-32", - "KE-33", - "KE-34", - "KE-35", - "KE-36", - "KE-37", - "KE-38", - "KE-39", - "KE-40", - "KE-41", - "KE-42", - "KE-43", - "KE-44", - "KE-45", - "KE-46", - "KE-47", - "KG-B", - "KG-GB", - "KG-C", - "KG-J", - "KG-N", - "KG-GO", - "KG-T", - "KG-Y", - "KH-2", - "KH-1", - "KH-23", - "KH-3", - "KH-4", - "KH-5", - "KH-6", - "KH-7", - "KH-8", - "KH-10", - "KH-11", - "KH-24", - "KH-12", - "KH-15", - "KH-18", - "KH-14", - "KH-16", - "KH-17", - "KH-19", - "KH-20", - "KH-21", - "KI-G", - "KM-G", - "KM-M", - "KN-01", - "KN-02", - "KN-03", - "KN-05", - "KN-06", - "KN-07", - "KN-08", - "KN-09", - "KN-10", - "KN-11", - "KN-12", - "KN-13", - "KN-15", - "KP-01", - "KR-26", - "KR-43", - "KR-44", - "KR-27", - "KR-30", - "KR-42", - "KR-29", - "KR-41", - "KR-47", - "KR-48", - "KR-28", - "KR-49", - "KR-45", - "KR-46", - "KR-11", - "KR-31", - "KW-KU", - "KW-AH", - "KW-FA", - "KW-JA", - "KW-HA", - "KW-MU", - "KY-XX-1", - "KZ-ALA", - "KZ-ALM", - "KZ-AKM", - "KZ-AKT", - "KZ-ATY", - "KZ-ZAP", - "KZ-MAN", - "KZ-AST", - "KZ-YUZ", - "KZ-PAV", - "KZ-KAR", - "KZ-KUS", - "KZ-KZY", - "KZ-VOS", - "KZ-SHY", - "KZ-SEV", - "KZ-ZHA", - "LA-AT", - "LA-BL", - "LA-CH", - "LA-HO", - "LA-KH", - "LA-OU", - "LA-PH", - "LA-SV", - "LA-VI", - "LA-XA", - "LA-XE", - "LA-XI", - "LB-AK", - "LB-BH", - "LB-BI", - "LB-BA", - "LB-AS", - "LB-JA", - "LB-JL", - "LB-NA", - "LC-01", - "LC-02", - "LC-03", - "LC-05", - "LC-06", - "LC-07", - "LC-08", - "LC-10", - "LC-11", - "LI-01", - "LI-02", - "LI-03", - "LI-04", - "LI-05", - "LI-06", - "LI-07", - "LI-09", - "LI-10", - "LI-11", - "LK-2", - "LK-5", - "LK-7", - "LK-6", - "LK-4", - "LK-9", - "LK-3", - "LK-8", - "LK-1", - "LR-BM", - "LR-GB", - "LR-GG", - "LR-MG", - "LR-MO", - "LR-NI", - "LR-SI", - "LS-D", - "LS-B", - "LS-C", - "LS-E", - "LS-A", - "LS-F", - "LS-J", - "LS-H", - "LS-G", - "LS-K", - "LT-AL", - "LT-KU", - "LT-KL", - "LT-MR", - "LT-PN", - "LT-SA", - "LT-TA", - "LT-TE", - "LT-UT", - "LT-VL", - "LU-CA", - "LU-CL", - "LU-DI", - "LU-EC", - "LU-ES", - "LU-GR", - "LU-LU", - "LU-ME", - "LU-RD", - "LU-RM", - "LU-VD", - "LU-WI", - "LV-011", - "LV-002", - "LV-007", - "LV-111", - "LV-015", - "LV-016", - "LV-022", - "LV-DGV", - "LV-112", - "LV-026", - "LV-033", - "LV-042", - "LV-JEL", - "LV-041", - "LV-JUR", - "LV-052", - "LV-047", - "LV-050", - "LV-LPX", - "LV-054", - "LV-056", - "LV-058", - "LV-059", - "LV-062", - "LV-067", - "LV-068", - "LV-073", - "LV-077", - "LV-RIX", - "LV-080", - "LV-087", - "LV-088", - "LV-089", - "LV-091", - "LV-094", - "LV-097", - "LV-099", - "LV-101", - "LV-113", - "LV-102", - "LV-106", - "LY-BU", - "LY-JA", - "LY-JG", - "LY-JI", - "LY-JU", - "LY-KF", - "LY-MJ", - "LY-MB", - "LY-WA", - "LY-NQ", - "LY-ZA", - "LY-BA", - "LY-DR", - "LY-MI", - "LY-NL", - "LY-SB", - "LY-SR", - "LY-TB", - "LY-WS", - "MA-05", - "MA-06", - "MA-08", - "MA-03", - "MA-10", - "MA-02", - "MA-11", - "MA-07", - "MA-04", - "MA-09", - "MA-01", - "MC-FO", - "MC-CO", - "MC-MO", - "MC-MC", - "MC-SR", - "MD-AN", - "MD-BA", - "MD-BS", - "MD-BD", - "MD-BR", - "MD-CA", - "MD-CL", - "MD-CT", - "MD-CS", - "MD-CU", - "MD-CM", - "MD-CR", - "MD-DO", - "MD-DR", - "MD-DU", - "MD-ED", - "MD-FA", - "MD-FL", - "MD-GA", - "MD-GL", - "MD-HI", - "MD-IA", - "MD-LE", - "MD-NI", - "MD-OC", - "MD-OR", - "MD-RE", - "MD-RI", - "MD-SI", - "MD-SD", - "MD-SO", - "MD-SV", - "MD-SN", - "MD-ST", - "MD-TA", - "MD-TE", - "MD-UN", - "ME-01", - "ME-02", - "ME-03", - "ME-04", - "ME-05", - "ME-06", - "ME-07", - "ME-08", - "ME-10", - "ME-12", - "ME-13", - "ME-14", - "ME-15", - "ME-16", - "ME-17", - "ME-19", - "ME-24", - "ME-20", - "ME-21", - "MF-XX-1", - "MG-T", - "MG-D", - "MG-F", - "MG-M", - "MG-A", - "MG-U", - "MH-KWA", - "MH-MAJ", - "MK-802", - "MK-201", - "MK-501", - "MK-401", - "MK-601", - "MK-402", - "MK-602", - "MK-803", - "MK-109", - "MK-814", - "MK-210", - "MK-816", - "MK-303", - "MK-203", - "MK-502", - "MK-406", - "MK-503", - "MK-804", - "MK-405", - "MK-604", - "MK-102", - "MK-807", - "MK-606", - "MK-205", - "MK-104", - "MK-307", - "MK-809", - "MK-206", - "MK-701", - "MK-702", - "MK-505", - "MK-703", - "MK-704", - "MK-105", - "MK-207", - "MK-308", - "MK-607", - "MK-506", - "MK-106", - "MK-507", - "MK-408", - "MK-310", - "MK-208", - "MK-810", - "MK-311", - "MK-508", - "MK-209", - "MK-409", - "MK-705", - "MK-509", - "MK-107", - "MK-811", - "MK-812", - "MK-211", - "MK-312", - "MK-410", - "MK-813", - "MK-108", - "MK-608", - "MK-609", - "MK-403", - "MK-404", - "MK-101", - "MK-301", - "MK-202", - "MK-603", - "MK-806", - "MK-605", - "ML-BKO", - "ML-7", - "ML-1", - "ML-8", - "ML-2", - "ML-5", - "ML-4", - "ML-3", - "ML-6", - "MM-07", - "MM-02", - "MM-14", - "MM-11", - "MM-12", - "MM-13", - "MM-03", - "MM-04", - "MM-15", - "MM-18", - "MM-16", - "MM-01", - "MM-17", - "MM-05", - "MM-06", - "MN-071", - "MN-037", - "MN-061", - "MN-063", - "MN-065", - "MN-043", - "MN-035", - "MN-055", - "MN-049", - "MN-047", - "MN-1", - "MO-XX-1", - "MP-XX-1", - "MQ-XX-1", - "MR-07", - "MR-03", - "MR-05", - "MR-08", - "MR-04", - "MR-10", - "MR-01", - "MR-02", - "MR-12", - "MR-13", - "MR-09", - "MR-11", - "MR-06", - "MS-XX-1", - "MS-XX-2", - "MT-01", - "MT-02", - "MT-03", - "MT-04", - "MT-05", - "MT-06", - "MT-07", - "MT-08", - "MT-09", - "MT-10", - "MT-14", - "MT-15", - "MT-16", - "MT-17", - "MT-11", - "MT-12", - "MT-18", - "MT-19", - "MT-20", - "MT-21", - "MT-22", - "MT-23", - "MT-24", - "MT-25", - "MT-26", - "MT-27", - "MT-28", - "MT-29", - "MT-30", - "MT-31", - "MT-32", - "MT-33", - "MT-34", - "MT-35", - "MT-36", - "MT-37", - "MT-38", - "MT-39", - "MT-40", - "MT-41", - "MT-42", - "MT-43", - "MT-45", - "MT-46", - "MT-49", - "MT-48", - "MT-53", - "MT-51", - "MT-52", - "MT-54", - "MT-55", - "MT-56", - "MT-57", - "MT-58", - "MT-59", - "MT-60", - "MT-61", - "MT-62", - "MT-63", - "MT-64", - "MT-65", - "MT-67", - "MT-68", - "MU-BL", - "MU-FL", - "MU-GP", - "MU-MO", - "MU-PA", - "MU-PW", - "MU-PL", - "MU-RR", - "MU-RO", - "MU-SA", - "MV-01", - "MV-03", - "MV-04", - "MV-05", - "MV-MLE", - "MV-12", - "MV-13", - "MV-00", - "MV-28", - "MV-20", - "MV-25", - "MV-17", - "MW-BA", - "MW-BL", - "MW-CK", - "MW-CR", - "MW-DE", - "MW-DO", - "MW-KR", - "MW-LI", - "MW-MH", - "MW-MG", - "MW-MW", - "MW-MZ", - "MW-NE", - "MW-NK", - "MW-PH", - "MW-SA", - "MW-TH", - "MW-ZO", - "MX-AGU", - "MX-BCN", - "MX-BCS", - "MX-CAM", - "MX-CHP", - "MX-CHH", - "MX-CMX", - "MX-COA", - "MX-COL", - "MX-DUR", - "MX-GUA", - "MX-GRO", - "MX-HID", - "MX-JAL", - "MX-MEX", - "MX-MIC", - "MX-MOR", - "MX-NAY", - "MX-NLE", - "MX-OAX", - "MX-PUE", - "MX-QUE", - "MX-ROO", - "MX-SLP", - "MX-SIN", - "MX-SON", - "MX-TAB", - "MX-TAM", - "MX-TLA", - "MX-VER", - "MX-YUC", - "MX-ZAC", - "MY-01", - "MY-02", - "MY-03", - "MY-04", - "MY-05", - "MY-06", - "MY-08", - "MY-09", - "MY-07", - "MY-12", - "MY-13", - "MY-10", - "MY-11", - "MY-14", - "MY-15", - "MY-16", - "MZ-P", - "MZ-G", - "MZ-I", - "MZ-B", - "MZ-L", - "MZ-N", - "MZ-A", - "MZ-S", - "MZ-T", - "MZ-Q", - "NA-ER", - "NA-HA", - "NA-KA", - "NA-KE", - "NA-KW", - "NA-KH", - "NA-KU", - "NA-OW", - "NA-OH", - "NA-OS", - "NA-ON", - "NA-OT", - "NA-OD", - "NA-CA", - "NC-XX-1", - "NC-XX-2", - "NE-1", - "NE-2", - "NE-3", - "NE-8", - "NE-5", - "NE-6", - "NE-7", - "NF-XX-1", - "NG-AB", - "NG-FC", - "NG-AD", - "NG-AK", - "NG-AN", - "NG-BA", - "NG-BY", - "NG-BE", - "NG-BO", - "NG-CR", - "NG-DE", - "NG-EB", - "NG-ED", - "NG-EK", - "NG-EN", - "NG-GO", - "NG-IM", - "NG-JI", - "NG-KD", - "NG-KN", - "NG-KT", - "NG-KE", - "NG-KO", - "NG-KW", - "NG-LA", - "NG-NA", - "NG-NI", - "NG-OG", - "NG-ON", - "NG-OS", - "NG-OY", - "NG-PL", - "NG-RI", - "NG-SO", - "NG-TA", - "NG-YO", - "NG-ZA", - "NI-BO", - "NI-CA", - "NI-CI", - "NI-CO", - "NI-AN", - "NI-AS", - "NI-ES", - "NI-GR", - "NI-JI", - "NI-LE", - "NI-MD", - "NI-MN", - "NI-MS", - "NI-MT", - "NI-NS", - "NI-SJ", - "NI-RI", - "NL-DR", - "NL-FL", - "NL-FR", - "NL-GE", - "NL-GR", - "NL-LI", - "NL-NB", - "NL-NH", - "NL-OV", - "NL-UT", - "NL-ZE", - "NL-ZH", - "NO-42", - "NO-34", - "NO-15", - "NO-18", - "NO-03", - "NO-11", - "NO-54", - "NO-50", - "NO-38", - "NO-46", - "NO-30", - "NP-BA", - "NP-BH", - "NP-DH", - "NP-GA", - "NP-JA", - "NP-KA", - "NP-KO", - "NP-LU", - "NP-MA", - "NP-ME", - "NP-NA", - "NP-RA", - "NP-SA", - "NP-SE", - "NR-01", - "NR-03", - "NR-14", - "NU-XX-1", - "NZ-AUK", - "NZ-BOP", - "NZ-CAN", - "NZ-CIT", - "NZ-GIS", - "NZ-HKB", - "NZ-MWT", - "NZ-MBH", - "NZ-NSN", - "NZ-NTL", - "NZ-OTA", - "NZ-STL", - "NZ-TKI", - "NZ-TAS", - "NZ-WKO", - "NZ-WGN", - "NZ-WTC", - "OM-DA", - "OM-BU", - "OM-WU", - "OM-ZA", - "OM-BJ", - "OM-SJ", - "OM-MA", - "OM-MU", - "OM-BS", - "OM-SS", - "OM-ZU", - "PA-1", - "PA-4", - "PA-2", - "PA-3", - "PA-5", - "PA-KY", - "PA-6", - "PA-7", - "PA-NB", - "PA-8", - "PA-9", - "PE-AMA", - "PE-ANC", - "PE-APU", - "PE-ARE", - "PE-AYA", - "PE-CAJ", - "PE-CUS", - "PE-CAL", - "PE-HUV", - "PE-HUC", - "PE-ICA", - "PE-JUN", - "PE-LAL", - "PE-LAM", - "PE-LIM", - "PE-LOR", - "PE-MDD", - "PE-MOQ", - "PE-PAS", - "PE-PIU", - "PE-PUN", - "PE-SAM", - "PE-TAC", - "PE-TUM", - "PE-UCA", - "PF-XX-1", - "PF-XX-2", - "PF-XX-3", - "PF-XX-4", - "PF-XX-5", - "PG-NSB", - "PG-CPM", - "PG-CPK", - "PG-EBR", - "PG-EHG", - "PG-ESW", - "PG-MPM", - "PG-MRL", - "PG-MBA", - "PG-MPL", - "PG-NCD", - "PG-SHM", - "PG-WBK", - "PG-SAN", - "PG-WPD", - "PG-WHM", - "PH-ABR", - "PH-AGN", - "PH-AGS", - "PH-AKL", - "PH-ALB", - "PH-ANT", - "PH-APA", - "PH-AUR", - "PH-BAS", - "PH-BAN", - "PH-BTN", - "PH-BTG", - "PH-BEN", - "PH-BIL", - "PH-BOH", - "PH-BUK", - "PH-BUL", - "PH-CAG", - "PH-CAN", - "PH-CAS", - "PH-CAM", - "PH-CAP", - "PH-CAT", - "PH-CAV", - "PH-CEB", - "PH-NCO", - "PH-DAO", - "PH-COM", - "PH-DAV", - "PH-DAS", - "PH-DIN", - "PH-EAS", - "PH-GUI", - "PH-IFU", - "PH-ILN", - "PH-ILS", - "PH-ILI", - "PH-ISA", - "PH-KAL", - "PH-LUN", - "PH-LAG", - "PH-LAN", - "PH-LAS", - "PH-LEY", - "PH-MAG", - "PH-MAD", - "PH-MAS", - "PH-MDC", - "PH-MDR", - "PH-MSC", - "PH-MSR", - "PH-MOU", - "PH-00", - "PH-NEC", - "PH-NER", - "PH-NSA", - "PH-NUE", - "PH-NUV", - "PH-PLW", - "PH-PAM", - "PH-PAN", - "PH-QUE", - "PH-QUI", - "PH-RIZ", - "PH-ROM", - "PH-WSA", - "PH-SAR", - "PH-SIG", - "PH-SOR", - "PH-SCO", - "PH-SLE", - "PH-SUK", - "PH-SLU", - "PH-SUN", - "PH-SUR", - "PH-TAR", - "PH-TAW", - "PH-ZMB", - "PH-ZSI", - "PH-ZAN", - "PH-ZAS", - "PK-JK", - "PK-BA", - "PK-GB", - "PK-IS", - "PK-KP", - "PK-PB", - "PK-SD", - "PL-02", - "PL-04", - "PL-10", - "PL-06", - "PL-08", - "PL-12", - "PL-14", - "PL-16", - "PL-18", - "PL-20", - "PL-22", - "PL-24", - "PL-26", - "PL-28", - "PL-30", - "PL-32", - "PM-XX-1", - "PN-XX-1", - "PR-XX-1", - "PR-XX-2", - "PR-XX-3", - "PR-XX-4", - "PR-XX-5", - "PR-XX-6", - "PR-XX-7", - "PR-XX-8", - "PR-XX-9", - "PR-XX-10", - "PR-XX-11", - "PR-XX-12", - "PR-XX-13", - "PR-XX-14", - "PR-XX-15", - "PR-XX-16", - "PR-XX-17", - "PR-XX-18", - "PR-XX-19", - "PR-XX-20", - "PR-XX-21", - "PR-XX-22", - "PR-XX-23", - "PR-XX-24", - "PR-XX-25", - "PR-XX-26", - "PR-XX-27", - "PR-XX-28", - "PR-XX-29", - "PR-XX-30", - "PR-XX-31", - "PR-XX-32", - "PR-XX-33", - "PR-XX-34", - "PR-XX-35", - "PR-XX-36", - "PR-XX-37", - "PR-XX-38", - "PR-XX-39", - "PR-XX-40", - "PR-XX-41", - "PR-XX-42", - "PR-XX-43", - "PR-XX-44", - "PR-XX-45", - "PR-XX-46", - "PR-XX-47", - "PR-XX-48", - "PR-XX-49", - "PR-XX-50", - "PR-XX-51", - "PR-XX-52", - "PR-XX-53", - "PR-XX-54", - "PR-XX-55", - "PR-XX-56", - "PR-XX-57", - "PR-XX-58", - "PR-XX-59", - "PR-XX-60", - "PR-XX-61", - "PR-XX-62", - "PR-XX-63", - "PR-XX-64", - "PR-XX-65", - "PR-XX-66", - "PR-XX-67", - "PR-XX-68", - "PR-XX-69", - "PR-XX-70", - "PR-XX-71", - "PR-XX-72", - "PR-XX-73", - "PR-XX-74", - "PR-XX-75", - "PR-XX-76", - "PS-BTH", - "PS-DEB", - "PS-GZA", - "PS-HBN", - "PS-JEN", - "PS-JRH", - "PS-JEM", - "PS-KYS", - "PS-NBS", - "PS-QQA", - "PS-RFH", - "PS-RBH", - "PS-SLT", - "PS-TBS", - "PS-TKM", - "PT-01", - "PT-02", - "PT-03", - "PT-04", - "PT-05", - "PT-06", - "PT-07", - "PT-08", - "PT-09", - "PT-10", - "PT-11", - "PT-12", - "PT-13", - "PT-30", - "PT-20", - "PT-14", - "PT-15", - "PT-16", - "PT-17", - "PT-18", - "PW-004", - "PW-100", - "PW-150", - "PW-212", - "PW-214", - "PW-222", - "PY-10", - "PY-13", - "PY-ASU", - "PY-19", - "PY-5", - "PY-6", - "PY-14", - "PY-11", - "PY-1", - "PY-3", - "PY-4", - "PY-7", - "PY-8", - "PY-12", - "PY-9", - "PY-15", - "PY-2", - "QA-DA", - "QA-KH", - "QA-WA", - "QA-RA", - "QA-MS", - "QA-ZA", - "QA-US", - "RE-XX-1", - "RO-AB", - "RO-AR", - "RO-AG", - "RO-BC", - "RO-BH", - "RO-BN", - "RO-BT", - "RO-BR", - "RO-BV", - "RO-B", - "RO-BZ", - "RO-CL", - "RO-CS", - "RO-CJ", - "RO-CT", - "RO-CV", - "RO-DB", - "RO-DJ", - "RO-GL", - "RO-GR", - "RO-GJ", - "RO-HR", - "RO-HD", - "RO-IL", - "RO-IS", - "RO-IF", - "RO-MM", - "RO-MH", - "RO-MS", - "RO-NT", - "RO-OT", - "RO-PH", - "RO-SJ", - "RO-SM", - "RO-SB", - "RO-SV", - "RO-TR", - "RO-TM", - "RO-TL", - "RO-VL", - "RO-VS", - "RO-VN", - "RS-00", - "RS-14", - "RS-11", - "RS-23", - "RS-06", - "RS-04", - "RS-09", - "RS-28", - "RS-08", - "RS-17", - "RS-20", - "RS-24", - "RS-26", - "RS-22", - "RS-10", - "RS-13", - "RS-27", - "RS-19", - "RS-18", - "RS-01", - "RS-03", - "RS-02", - "RS-07", - "RS-12", - "RS-21", - "RS-15", - "RS-05", - "RS-16", - "RU-AD", - "RU-AL", - "RU-ALT", - "RU-AMU", - "RU-ARK", - "RU-AST", - "RU-BA", - "RU-BEL", - "RU-BRY", - "RU-BU", - "RU-CE", - "RU-CHE", - "RU-CHU", - "RU-CU", - "RU-DA", - "RU-IN", - "RU-IRK", - "RU-IVA", - "RU-KB", - "RU-KGD", - "RU-KL", - "RU-KLU", - "RU-KAM", - "RU-KC", - "RU-KR", - "RU-KEM", - "RU-KHA", - "RU-KK", - "RU-KHM", - "RU-KIR", - "RU-KO", - "RU-KOS", - "RU-KDA", - "RU-KYA", - "RU-KGN", - "RU-KRS", - "RU-LEN", - "RU-LIP", - "RU-MAG", - "RU-ME", - "RU-MO", - "RU-MOS", - "RU-MOW", - "RU-MUR", - "RU-NEN", - "RU-NIZ", - "RU-NGR", - "RU-NVS", - "RU-OMS", - "RU-ORE", - "RU-ORL", - "RU-PNZ", - "RU-PER", - "RU-PRI", - "RU-PSK", - "RU-ROS", - "RU-RYA", - "RU-SA", - "RU-SAK", - "RU-SAM", - "RU-SPE", - "RU-SAR", - "RU-SE", - "RU-SMO", - "RU-STA", - "RU-SVE", - "RU-TAM", - "RU-TA", - "RU-TOM", - "RU-TUL", - "RU-TVE", - "RU-TYU", - "RU-TY", - "RU-UD", - "RU-ULY", - "RU-VLA", - "RU-VGG", - "RU-VLG", - "RU-VOR", - "RU-YAN", - "RU-YAR", - "RU-YEV", - "RU-ZAB", - "RW-02", - "RW-03", - "RW-04", - "RW-05", - "RW-01", - "SA-14", - "SA-11", - "SA-08", - "SA-12", - "SA-03", - "SA-05", - "SA-01", - "SA-04", - "SA-06", - "SA-09", - "SA-02", - "SA-10", - "SA-07", - "SB-CH", - "SB-GU", - "SB-WE", - "SC-02", - "SC-05", - "SC-01", - "SC-06", - "SC-07", - "SC-08", - "SC-10", - "SC-11", - "SC-16", - "SC-13", - "SC-14", - "SC-15", - "SC-20", - "SC-23", - "SD-NB", - "SD-DC", - "SD-GD", - "SD-GZ", - "SD-KA", - "SD-KH", - "SD-DN", - "SD-KN", - "SD-NO", - "SD-RS", - "SD-NR", - "SD-SI", - "SD-DS", - "SD-KS", - "SD-DW", - "SD-GK", - "SD-NW", - "SE-K", - "SE-W", - "SE-X", - "SE-I", - "SE-N", - "SE-Z", - "SE-F", - "SE-H", - "SE-G", - "SE-BD", - "SE-T", - "SE-E", - "SE-M", - "SE-D", - "SE-AB", - "SE-C", - "SE-S", - "SE-AC", - "SE-Y", - "SE-U", - "SE-O", - "SG-XX-1", - "SH-HL", - "SI-001", - "SI-213", - "SI-195", - "SI-002", - "SI-148", - "SI-149", - "SI-003", - "SI-150", - "SI-004", - "SI-005", - "SI-006", - "SI-151", - "SI-007", - "SI-009", - "SI-008", - "SI-152", - "SI-011", - "SI-012", - "SI-013", - "SI-014", - "SI-196", - "SI-015", - "SI-017", - "SI-018", - "SI-019", - "SI-154", - "SI-020", - "SI-155", - "SI-021", - "SI-156", - "SI-023", - "SI-024", - "SI-025", - "SI-026", - "SI-207", - "SI-029", - "SI-031", - "SI-158", - "SI-032", - "SI-159", - "SI-160", - "SI-161", - "SI-162", - "SI-034", - "SI-035", - "SI-036", - "SI-037", - "SI-038", - "SI-039", - "SI-040", - "SI-041", - "SI-042", - "SI-043", - "SI-044", - "SI-045", - "SI-046", - "SI-047", - "SI-048", - "SI-049", - "SI-164", - "SI-050", - "SI-197", - "SI-165", - "SI-052", - "SI-053", - "SI-166", - "SI-054", - "SI-055", - "SI-056", - "SI-057", - "SI-058", - "SI-059", - "SI-060", - "SI-061", - "SI-063", - "SI-208", - "SI-064", - "SI-065", - "SI-066", - "SI-167", - "SI-067", - "SI-068", - "SI-069", - "SI-198", - "SI-070", - "SI-168", - "SI-071", - "SI-072", - "SI-073", - "SI-074", - "SI-169", - "SI-075", - "SI-212", - "SI-170", - "SI-076", - "SI-199", - "SI-077", - "SI-079", - "SI-080", - "SI-081", - "SI-082", - "SI-083", - "SI-084", - "SI-085", - "SI-086", - "SI-171", - "SI-087", - "SI-090", - "SI-091", - "SI-092", - "SI-172", - "SI-200", - "SI-173", - "SI-094", - "SI-174", - "SI-095", - "SI-175", - "SI-096", - "SI-097", - "SI-098", - "SI-099", - "SI-100", - "SI-101", - "SI-102", - "SI-103", - "SI-176", - "SI-209", - "SI-201", - "SI-104", - "SI-106", - "SI-105", - "SI-108", - "SI-033", - "SI-109", - "SI-183", - "SI-117", - "SI-118", - "SI-119", - "SI-120", - "SI-211", - "SI-110", - "SI-111", - "SI-121", - "SI-122", - "SI-123", - "SI-112", - "SI-113", - "SI-114", - "SI-124", - "SI-206", - "SI-125", - "SI-194", - "SI-179", - "SI-180", - "SI-126", - "SI-115", - "SI-127", - "SI-203", - "SI-204", - "SI-182", - "SI-116", - "SI-210", - "SI-205", - "SI-184", - "SI-010", - "SI-128", - "SI-129", - "SI-130", - "SI-185", - "SI-131", - "SI-186", - "SI-132", - "SI-133", - "SI-187", - "SI-134", - "SI-188", - "SI-135", - "SI-136", - "SI-137", - "SI-138", - "SI-139", - "SI-189", - "SI-140", - "SI-141", - "SI-142", - "SI-190", - "SI-143", - "SI-146", - "SI-191", - "SI-147", - "SI-144", - "SI-193", - "SJ-XX-1", - "SK-BC", - "SK-BL", - "SK-KI", - "SK-NI", - "SK-PV", - "SK-TC", - "SK-TA", - "SK-ZI", - "SL-E", - "SL-N", - "SL-S", - "SL-W", - "SM-07", - "SM-03", - "SM-04", - "SM-09", - "SN-DK", - "SN-DB", - "SN-FK", - "SN-KA", - "SN-KL", - "SN-KE", - "SN-KD", - "SN-LG", - "SN-MT", - "SN-SL", - "SN-SE", - "SN-TC", - "SN-TH", - "SN-ZG", - "SO-AW", - "SO-BN", - "SO-BR", - "SO-GA", - "SO-JH", - "SO-MU", - "SO-NU", - "SO-SH", - "SO-TO", - "SO-WO", - "SR-BR", - "SR-CM", - "SR-NI", - "SR-PR", - "SR-PM", - "SR-SI", - "SR-WA", - "SS-EC", - "SS-EE", - "SS-JG", - "SS-LK", - "SS-BN", - "SS-NU", - "SS-EW", - "ST-01", - "SV-AH", - "SV-CA", - "SV-CH", - "SV-CU", - "SV-LI", - "SV-PA", - "SV-UN", - "SV-MO", - "SV-SM", - "SV-SS", - "SV-SV", - "SV-SA", - "SV-SO", - "SV-US", - "SX-XX-1", - "SY-HA", - "SY-LA", - "SY-QU", - "SY-RA", - "SY-SU", - "SY-DR", - "SY-DY", - "SY-DI", - "SY-HL", - "SY-HM", - "SY-HI", - "SY-ID", - "SY-RD", - "SY-TA", - "SZ-HH", - "SZ-LU", - "SZ-MA", - "TC-XX-1", - "TD-BG", - "TD-CB", - "TD-GR", - "TD-LO", - "TD-ME", - "TD-OD", - "TD-ND", - "TF-XX-1", - "TG-C", - "TG-K", - "TG-M", - "TG-P", - "TH-37", - "TH-15", - "TH-38", - "TH-31", - "TH-24", - "TH-18", - "TH-36", - "TH-22", - "TH-50", - "TH-57", - "TH-20", - "TH-86", - "TH-46", - "TH-62", - "TH-71", - "TH-40", - "TH-81", - "TH-10", - "TH-52", - "TH-51", - "TH-42", - "TH-16", - "TH-58", - "TH-44", - "TH-49", - "TH-26", - "TH-73", - "TH-48", - "TH-30", - "TH-60", - "TH-80", - "TH-55", - "TH-96", - "TH-39", - "TH-43", - "TH-12", - "TH-13", - "TH-94", - "TH-82", - "TH-93", - "TH-56", - "TH-67", - "TH-76", - "TH-66", - "TH-65", - "TH-14", - "TH-54", - "TH-83", - "TH-25", - "TH-77", - "TH-85", - "TH-70", - "TH-21", - "TH-45", - "TH-27", - "TH-47", - "TH-11", - "TH-74", - "TH-75", - "TH-19", - "TH-91", - "TH-33", - "TH-17", - "TH-90", - "TH-64", - "TH-72", - "TH-84", - "TH-32", - "TH-63", - "TH-92", - "TH-23", - "TH-34", - "TH-41", - "TH-61", - "TH-53", - "TH-95", - "TH-35", - "TJ-DU", - "TJ-KT", - "TJ-RA", - "TJ-SU", - "TK-XX-1", - "TL-AN", - "TL-BO", - "TL-CO", - "TL-DI", - "TL-LI", - "TM-A", - "TM-B", - "TM-D", - "TM-L", - "TM-M", - "TN-31", - "TN-13", - "TN-23", - "TN-81", - "TN-71", - "TN-32", - "TN-41", - "TN-42", - "TN-73", - "TN-12", - "TN-14", - "TN-33", - "TN-53", - "TN-82", - "TN-52", - "TN-21", - "TN-61", - "TN-43", - "TN-34", - "TN-51", - "TN-83", - "TN-72", - "TN-11", - "TN-22", - "TO-02", - "TO-03", - "TO-04", - "TR-01", - "TR-02", - "TR-03", - "TR-04", - "TR-68", - "TR-05", - "TR-06", - "TR-07", - "TR-75", - "TR-08", - "TR-09", - "TR-10", - "TR-74", - "TR-72", - "TR-69", - "TR-11", - "TR-12", - "TR-13", - "TR-14", - "TR-15", - "TR-16", - "TR-17", - "TR-18", - "TR-19", - "TR-20", - "TR-21", - "TR-81", - "TR-22", - "TR-23", - "TR-24", - "TR-25", - "TR-26", - "TR-27", - "TR-28", - "TR-29", - "TR-30", - "TR-31", - "TR-76", - "TR-32", - "TR-34", - "TR-35", - "TR-46", - "TR-78", - "TR-70", - "TR-36", - "TR-37", - "TR-38", - "TR-79", - "TR-71", - "TR-39", - "TR-40", - "TR-41", - "TR-42", - "TR-43", - "TR-44", - "TR-45", - "TR-47", - "TR-33", - "TR-48", - "TR-49", - "TR-50", - "TR-51", - "TR-52", - "TR-80", - "TR-53", - "TR-54", - "TR-55", - "TR-63", - "TR-56", - "TR-57", - "TR-73", - "TR-58", - "TR-59", - "TR-60", - "TR-61", - "TR-62", - "TR-64", - "TR-65", - "TR-77", - "TR-66", - "TR-67", - "TT-ARI", - "TT-CHA", - "TT-CTT", - "TT-DMN", - "TT-MRC", - "TT-PED", - "TT-PTF", - "TT-POS", - "TT-PRT", - "TT-SFO", - "TT-SJL", - "TT-SGE", - "TT-SIP", - "TT-TOB", - "TT-TUP", - "TV-FUN", - "TW-CHA", - "TW-CYQ", - "TW-HSQ", - "TW-HUA", - "TW-KHH", - "TW-KEE", - "TW-KIN", - "TW-LIE", - "TW-MIA", - "TW-NAN", - "TW-NWT", - "TW-PEN", - "TW-PIF", - "TW-TXG", - "TW-TNN", - "TW-TPE", - "TW-TTT", - "TW-TAO", - "TW-ILA", - "TW-YUN", - "TZ-01", - "TZ-02", - "TZ-03", - "TZ-27", - "TZ-04", - "TZ-05", - "TZ-06", - "TZ-07", - "TZ-28", - "TZ-08", - "TZ-09", - "TZ-11", - "TZ-12", - "TZ-26", - "TZ-13", - "TZ-14", - "TZ-15", - "TZ-16", - "TZ-17", - "TZ-18", - "TZ-29", - "TZ-19", - "TZ-20", - "TZ-21", - "TZ-22", - "TZ-30", - "TZ-23", - "TZ-31", - "TZ-24", - "TZ-25", - "UA-43", - "UA-71", - "UA-74", - "UA-77", - "UA-12", - "UA-14", - "UA-26", - "UA-63", - "UA-65", - "UA-68", - "UA-35", - "UA-30", - "UA-32", - "UA-09", - "UA-46", - "UA-48", - "UA-51", - "UA-53", - "UA-56", - "UA-40", - "UA-59", - "UA-61", - "UA-05", - "UA-07", - "UA-21", - "UA-23", - "UA-18", - "UG-314", - "UG-301", - "UG-322", - "UG-323", - "UG-315", - "UG-324", - "UG-216", - "UG-316", - "UG-302", - "UG-303", - "UG-217", - "UG-218", - "UG-201", - "UG-420", - "UG-117", - "UG-219", - "UG-118", - "UG-220", - "UG-225", - "UG-401", - "UG-402", - "UG-202", - "UG-221", - "UG-120", - "UG-226", - "UG-317", - "UG-121", - "UG-304", - "UG-403", - "UG-417", - "UG-203", - "UG-418", - "UG-204", - "UG-318", - "UG-404", - "UG-405", - "UG-213", - "UG-101", - "UG-222", - "UG-122", - "UG-102", - "UG-205", - "UG-413", - "UG-206", - "UG-406", - "UG-207", - "UG-112", - "UG-407", - "UG-103", - "UG-227", - "UG-419", - "UG-421", - "UG-408", - "UG-305", - "UG-319", - "UG-306", - "UG-208", - "UG-228", - "UG-123", - "UG-422", - "UG-415", - "UG-326", - "UG-307", - "UG-229", - "UG-104", - "UG-124", - "UG-114", - "UG-223", - "UG-105", - "UG-409", - "UG-214", - "UG-209", - "UG-410", - "UG-423", - "UG-115", - "UG-308", - "UG-309", - "UG-106", - "UG-107", - "UG-108", - "UG-311", - "UG-116", - "UG-109", - "UG-230", - "UG-224", - "UG-327", - "UG-310", - "UG-231", - "UG-411", - "UG-328", - "UG-321", - "UG-312", - "UG-210", - "UG-110", - "UG-425", - "UG-412", - "UG-111", - "UG-232", - "UG-426", - "UG-215", - "UG-211", - "UG-212", - "UG-113", - "UG-313", - "UG-330", - "UM-95", - "US-AL", - "US-AK", - "US-AZ", - "US-AR", - "US-CA", - "US-CO", - "US-CT", - "US-DE", - "US-DC", - "US-FL", - "US-GA", - "US-HI", - "US-ID", - "US-IL", - "US-IN", - "US-IA", - "US-KS", - "US-KY", - "US-LA", - "US-ME", - "US-MD", - "US-MA", - "US-MI", - "US-MN", - "US-MS", - "US-MO", - "US-MT", - "US-NE", - "US-NV", - "US-NH", - "US-NJ", - "US-NM", - "US-NY", - "US-NC", - "US-ND", - "US-OH", - "US-OK", - "US-OR", - "US-PA", - "US-RI", - "US-SC", - "US-SD", - "US-TN", - "US-TX", - "US-UT", - "US-VT", - "US-VA", - "US-WA", - "US-WV", - "US-WI", - "US-WY", - "UY-AR", - "UY-CA", - "UY-CL", - "UY-CO", - "UY-DU", - "UY-FS", - "UY-FD", - "UY-LA", - "UY-MA", - "UY-MO", - "UY-PA", - "UY-RN", - "UY-RV", - "UY-RO", - "UY-SA", - "UY-SJ", - "UY-SO", - "UY-TA", - "UY-TT", - "UZ-AN", - "UZ-BU", - "UZ-FA", - "UZ-JI", - "UZ-NG", - "UZ-NW", - "UZ-QA", - "UZ-QR", - "UZ-SA", - "UZ-SI", - "UZ-SU", - "UZ-TK", - "UZ-XO", - "VA-XX-1", - "VC-01", - "VC-06", - "VC-04", - "VC-05", - "VE-Z", - "VE-B", - "VE-C", - "VE-D", - "VE-E", - "VE-F", - "VE-G", - "VE-H", - "VE-Y", - "VE-A", - "VE-I", - "VE-J", - "VE-X", - "VE-K", - "VE-L", - "VE-M", - "VE-N", - "VE-O", - "VE-P", - "VE-R", - "VE-S", - "VE-T", - "VE-U", - "VE-V", - "VG-XX-1", - "VI-XX-1", - "VN-44", - "VN-43", - "VN-54", - "VN-53", - "VN-55", - "VN-56", - "VN-50", - "VN-31", - "VN-57", - "VN-58", - "VN-40", - "VN-59", - "VN-CT", - "VN-04", - "VN-DN", - "VN-33", - "VN-72", - "VN-71", - "VN-39", - "VN-45", - "VN-30", - "VN-03", - "VN-63", - "VN-HN", - "VN-23", - "VN-61", - "VN-HP", - "VN-73", - "VN-SG", - "VN-14", - "VN-66", - "VN-34", - "VN-47", - "VN-28", - "VN-01", - "VN-35", - "VN-09", - "VN-02", - "VN-41", - "VN-67", - "VN-22", - "VN-18", - "VN-36", - "VN-68", - "VN-32", - "VN-24", - "VN-27", - "VN-29", - "VN-13", - "VN-25", - "VN-52", - "VN-05", - "VN-37", - "VN-20", - "VN-69", - "VN-21", - "VN-26", - "VN-46", - "VN-51", - "VN-07", - "VN-49", - "VN-70", - "VN-06", - "VU-SEE", - "VU-TAE", - "VU-TOB", - "WF-SG", - "WF-UV", - "WS-AT", - "WS-FA", - "WS-TU", - "YE-AD", - "YE-AM", - "YE-AB", - "YE-DA", - "YE-BA", - "YE-HU", - "YE-SA", - "YE-DH", - "YE-HD", - "YE-HJ", - "YE-IB", - "YE-LA", - "YE-MA", - "YE-SD", - "YE-SN", - "YE-SH", - "YE-TA", - "YT-XX-1", - "YT-XX-2", - "YT-XX-3", - "YT-XX-4", - "YT-XX-5", - "YT-XX-6", - "ZA-EC", - "ZA-FS", - "ZA-GP", - "ZA-KZN", - "ZA-LP", - "ZA-MP", - "ZA-NW", - "ZA-NC", - "ZA-WC", - "ZM-02", - "ZM-08", - "ZM-03", - "ZM-04", - "ZM-09", - "ZM-10", - "ZM-06", - "ZM-05", - "ZM-07", - "ZM-01", - "ZW-BU", - "ZW-HA", - "ZW-MA", - "ZW-MC", - "ZW-ME", - "ZW-MW", - "ZW-MV", - "ZW-MN", - "ZW-MS", - "ZW-MI", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "street_1": { - "description": "The first line of the address", - "example": "Water Lane", - "nullable": true, - "type": "string", - }, - "street_2": { - "description": "The second line of the address", - "example": "Woolsthorpe by Colsterworth", - "nullable": true, - "type": "string", - }, - "zip_code": { - "description": "The ZIP code/Postal code of the location", - "example": "NG33 5NR", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "job_id": { - "description": "The employee job id", - "example": "R-6789", - "nullable": true, - "type": "string", - }, - "job_title": { - "description": "The employee job title", - "example": "Physicist", - "nullable": true, - "type": "string", - }, - "last_name": { - "description": "The employee last name", - "example": "Newton", - "nullable": true, - "type": "string", - }, - "manager_id": { - "description": "The employee manager ID", - "example": "67890", - "nullable": true, - "type": "string", - }, - "marital_status": { - "description": "The employee marital status", - "example": "single", - "nullable": true, - "properties": { - "value": { - "enum": [ - "single", - "married", - "common_law", - "divorced", - "widowed", - "domestic_partnership", - "separated", - "other", - "not_disclosed", - "unmapped_value", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "name": { - "description": "The employee name", - "example": "Issac Newton", - "nullable": true, - "type": "string", - }, - "national_identity_number": { - "deprecated": true, - "description": "The national identity number", - "nullable": true, - "properties": { - "country": { - "description": "The country code", - "nullable": true, - "properties": { - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "type": { - "nullable": true, - "properties": { - "value": { - "description": "The type of the national identity number", - "enum": [ - "ssn", - "nin", - "sin", - "nid", - "pin", - "pn", - "umcn", - "pic", - "ric", - "idnum", - "cid", - "nidnr", - "pan", - "aadhaar", - "epic", - "ptn", - "itin", - "tin", - "uprc", - "pcode", - "ssi", - "cedula", - "passport", - "voterid", - "ntin", - "bn", - "fnr", - "mva", - "civil_id", - "cnic", - "nric", - "fin", - "uen", - "registrationnumber", - "nic", - "personnummer", - "ahv", - "id", - "eid", - "va", - "pid", - "nrt", - "nipt", - "cbu", - "cuit", - "dni", - "businessid", - "vnr", - "abn", - "acn", - "tfn", - "jmbg", - "bis", - "insz", - "nn", - "egn", - "pnf", - "vat", - "cnpj", - "unp", - "gst", - "pst", - "qst", - "ni", - "dic", - "rc", - "uid", - "rut", - "uscc", - "cpf", - "cpj", - "cr", - "stnr", - "svnr", - "ncf", - "rnc", - "nif", - "ci", - "ik", - "kmkr", - "registrikood", - "tn", - "ruc", - "nit", - "alv", - "hetu", - "ytunnus", - "vn", - "utr", - "nifp", - "amka", - "cui", - "nir", - "siren", - "siret", - "tva", - "oib", - "hkid", - "anum", - "kennitala", - "vsk", - "npwp", - "pps", - "gstin", - "idnr", - "hr", - "aic", - "codicefiscale", - "iva", - "peid", - "asmens", - "pvm", - "ctps", - "vrn", - "vtk", - "int", - "tk", - "pas", - "rne", - "rg", - "nci", - "crnm", - "pis", - "insee", - "tax", - "mpf", - "epfo", - "esi", - "pran", - "uan", - "idk", - "bsn", - "mid", - "sss", - "nie", - "nss", - "arc", - "curp", - "imss", - "rfc", - "ein", - "other", - "unknown", - null, - ], - "example": "ssn", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "value": { - "example": "123456789", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "national_identity_numbers": { - "description": "The national identity numbers", - "items": { - "properties": { - "country": { - "description": "The country code", - "nullable": true, - "properties": { - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "type": { - "nullable": true, - "properties": { - "value": { - "description": "The type of the national identity number", - "enum": [ - "ssn", - "nin", - "sin", - "nid", - "pin", - "pn", - "umcn", - "pic", - "ric", - "idnum", - "cid", - "nidnr", - "pan", - "aadhaar", - "epic", - "ptn", - "itin", - "tin", - "uprc", - "pcode", - "ssi", - "cedula", - "passport", - "voterid", - "ntin", - "bn", - "fnr", - "mva", - "civil_id", - "cnic", - "nric", - "fin", - "uen", - "registrationnumber", - "nic", - "personnummer", - "ahv", - "id", - "eid", - "va", - "pid", - "nrt", - "nipt", - "cbu", - "cuit", - "dni", - "businessid", - "vnr", - "abn", - "acn", - "tfn", - "jmbg", - "bis", - "insz", - "nn", - "egn", - "pnf", - "vat", - "cnpj", - "unp", - "gst", - "pst", - "qst", - "ni", - "dic", - "rc", - "uid", - "rut", - "uscc", - "cpf", - "cpj", - "cr", - "stnr", - "svnr", - "ncf", - "rnc", - "nif", - "ci", - "ik", - "kmkr", - "registrikood", - "tn", - "ruc", - "nit", - "alv", - "hetu", - "ytunnus", - "vn", - "utr", - "nifp", - "amka", - "cui", - "nir", - "siren", - "siret", - "tva", - "oib", - "hkid", - "anum", - "kennitala", - "vsk", - "npwp", - "pps", - "gstin", - "idnr", - "hr", - "aic", - "codicefiscale", - "iva", - "peid", - "asmens", - "pvm", - "ctps", - "vrn", - "vtk", - "int", - "tk", - "pas", - "rne", - "rg", - "nci", - "crnm", - "pis", - "insee", - "tax", - "mpf", - "epfo", - "esi", - "pran", - "uan", - "idk", - "bsn", - "mid", - "sss", - "nie", - "nss", - "arc", - "curp", - "imss", - "rfc", - "ein", - "other", - "unknown", - null, - ], - "example": "ssn", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "value": { - "example": "123456789", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "nullable": true, - "type": "array", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "nullable": true, - "type": "object", - }, - "personal_email": { - "description": "The employee personal email", - "example": "isaac.newton@example.com", - "nullable": true, - "type": "string", - }, - "personal_phone_number": { - "description": "The employee personal phone number", - "example": "+1234567890", - "nullable": true, - "type": "string", - }, - "preferred_language": { - "description": "The employee preferred language", - "example": "en_US", - "nullable": true, - "properties": { - "value": { - "description": "The ISO639-2 Code of the language", - "enum": [ - "aar", - "afr", - "amh", - "ara", - "aym", - "aze", - "bel", - "bul", - "bis", - "ben", - "bos", - "byn", - "cat", - "cha", - "ces", - "deu", - "div", - "dzo", - "ell", - "eng", - "spa", - "est", - "fas", - "fan", - "ful", - "fin", - "fij", - "fao", - "fra", - "gle", - "grn", - "glv", - "heb", - "hin", - "hrv", - "hat", - "hun", - "hye", - "ind", - "isl", - "ita", - "jpn", - "kat", - "kon", - "kaz", - "kal", - "khm", - "kor", - "kur", - "kir", - "lat", - "ltz", - "lin", - "lao", - "lit", - "lub", - "lav", - "mlg", - "mah", - "mri", - "mkd", - "msa", - "mlt", - "mya", - "nob", - "nep", - "nld", - "nno", - "nor", - "nbl", - "nya", - "pan", - "pol", - "pus", - "por", - "rar", - "roh", - "rup", - "ron", - "rus", - "kin", - "sag", - "sin", - "slk", - "smo", - "sna", - "som", - "sqi", - "srp", - "ssw", - "swe", - "swa", - "tam", - "tgk", - "tha", - "tir", - "tig", - "zho", - "unmapped_value", - null, - ], - "example": "eng", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "start_date": { - "description": "The employee start date", - "example": "2021-01-01T00:00.000Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - "tenure": { - "description": "The employee tenure", - "example": 2, - "nullable": true, - "type": "number", - }, - "termination_date": { - "description": "The employee termination date", - "example": "2021-01-01T00:00:00Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - "work_anniversary": { - "description": "The employee work anniversary", - "example": "2021-01-01T00:00:00Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - "work_email": { - "description": "The employee work email", - "example": "newton@example.com", - "nullable": true, - "type": "string", - }, - "work_location": { - "description": "The employee work location", - "nullable": true, - "properties": { - "city": { - "description": "The city where the location is situated", - "example": "Grantham", - "nullable": true, - "type": "string", - }, - "country": { - "description": "The country code", - "nullable": true, - "properties": { - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string", - }, - "name": { - "description": "The name of the location", - "example": "Woolsthorpe Manor", - "nullable": true, - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "nullable": true, - "type": "object", - }, - "phone_number": { - "description": "The phone number of the location", - "example": "+44 1476 860 364", - "nullable": true, - "type": "string", - }, - "state": { - "description": "The ISO3166-2 sub division where the location is situated", - "example": "GB-LIN", - "nullable": true, - "properties": { - "value": { - "enum": [ - "AD-07", - "AD-02", - "AD-03", - "AD-08", - "AD-04", - "AD-05", - "AD-06", - "AE-AJ", - "AE-AZ", - "AE-FU", - "AE-SH", - "AE-DU", - "AE-RK", - "AE-UQ", - "AF-BDS", - "AF-BDG", - "AF-BGL", - "AF-BAL", - "AF-BAM", - "AF-DAY", - "AF-FRA", - "AF-FYB", - "AF-GHA", - "AF-GHO", - "AF-HEL", - "AF-HER", - "AF-JOW", - "AF-KAB", - "AF-KAN", - "AF-KAP", - "AF-KHO", - "AF-KDZ", - "AF-LAG", - "AF-LOG", - "AF-NAN", - "AF-NIM", - "AF-PIA", - "AF-PAR", - "AF-SAR", - "AF-TAK", - "AF-URU", - "AG-11", - "AG-03", - "AG-04", - "AG-06", - "AG-07", - "AG-08", - "AI-XX-1", - "AL-01", - "AL-09", - "AL-02", - "AL-03", - "AL-04", - "AL-05", - "AL-06", - "AL-07", - "AL-08", - "AL-10", - "AL-11", - "AL-12", - "AM-AG", - "AM-AR", - "AM-AV", - "AM-ER", - "AM-GR", - "AM-KT", - "AM-LO", - "AM-SH", - "AM-SU", - "AM-TV", - "AM-VD", - "AO-BGO", - "AO-BGU", - "AO-BIE", - "AO-CAB", - "AO-CCU", - "AO-CNO", - "AO-CUS", - "AO-CNN", - "AO-HUA", - "AO-HUI", - "AO-LUA", - "AO-LNO", - "AO-LSU", - "AO-MAL", - "AO-MOX", - "AO-NAM", - "AO-UIG", - "AO-ZAI", - "AQ-XX-1", - "AR-B", - "AR-K", - "AR-H", - "AR-U", - "AR-C", - "AR-X", - "AR-W", - "AR-E", - "AR-P", - "AR-Y", - "AR-L", - "AR-F", - "AR-M", - "AR-N", - "AR-Q", - "AR-R", - "AR-A", - "AR-J", - "AR-D", - "AR-Z", - "AR-S", - "AR-G", - "AR-V", - "AR-T", - "AS-XX-1", - "AS-XX-2", - "AT-1", - "AT-2", - "AT-3", - "AT-4", - "AT-5", - "AT-6", - "AT-7", - "AT-8", - "AT-9", - "AU-ACT", - "AU-NSW", - "AU-NT", - "AU-QLD", - "AU-SA", - "AU-TAS", - "AU-VIC", - "AU-WA", - "AW-XX-1", - "AX-XX-1", - "AX-XX-2", - "AX-XX-3", - "AX-XX-4", - "AX-XX-5", - "AX-XX-6", - "AX-XX-7", - "AX-XX-8", - "AZ-ABS", - "AZ-AGC", - "AZ-AGU", - "AZ-AST", - "AZ-BA", - "AZ-BAL", - "AZ-BAR", - "AZ-BEY", - "AZ-BIL", - "AZ-CAL", - "AZ-FUZ", - "AZ-GAD", - "AZ-GA", - "AZ-GOR", - "AZ-GOY", - "AZ-GYG", - "AZ-IMI", - "AZ-ISM", - "AZ-KUR", - "AZ-LA", - "AZ-MAS", - "AZ-MI", - "AZ-NA", - "AZ-NX", - "AZ-NEF", - "AZ-OGU", - "AZ-QAB", - "AZ-QAX", - "AZ-QAZ", - "AZ-QBA", - "AZ-QUS", - "AZ-SAT", - "AZ-SAB", - "AZ-SAK", - "AZ-SAL", - "AZ-SMI", - "AZ-SKR", - "AZ-SMX", - "AZ-SR", - "AZ-SM", - "AZ-TAR", - "AZ-UCA", - "AZ-XAC", - "AZ-XVD", - "AZ-YAR", - "AZ-YEV", - "AZ-ZAQ", - "AZ-ZAR", - "BA-BRC", - "BA-BIH", - "BA-SRP", - "BB-01", - "BB-02", - "BB-03", - "BB-04", - "BB-05", - "BB-07", - "BB-08", - "BB-09", - "BB-10", - "BB-11", - "BD-A", - "BD-B", - "BD-C", - "BD-D", - "BD-E", - "BD-F", - "BD-G", - "BE-VAN", - "BE-WBR", - "BE-BRU", - "BE-WHT", - "BE-WLG", - "BE-VLI", - "BE-WLX", - "BE-WNA", - "BE-VOV", - "BE-VBR", - "BE-VWV", - "BF-BAM", - "BF-BAZ", - "BF-BLG", - "BF-BLK", - "BF-COM", - "BF-GAN", - "BF-GNA", - "BF-GOU", - "BF-HOU", - "BF-IOB", - "BF-KAD", - "BF-KEN", - "BF-KMP", - "BF-KOS", - "BF-KOT", - "BF-KOW", - "BF-LER", - "BF-LOR", - "BF-MOU", - "BF-NAO", - "BF-NAM", - "BF-NAY", - "BF-OUB", - "BF-OUD", - "BF-PAS", - "BF-PON", - "BF-SNG", - "BF-SMT", - "BF-SEN", - "BF-SIS", - "BF-SOM", - "BF-SOR", - "BF-TAP", - "BF-TUI", - "BF-YAT", - "BF-ZIR", - "BF-ZON", - "BF-ZOU", - "BG-01", - "BG-02", - "BG-08", - "BG-07", - "BG-26", - "BG-09", - "BG-10", - "BG-11", - "BG-12", - "BG-13", - "BG-14", - "BG-15", - "BG-16", - "BG-17", - "BG-18", - "BG-27", - "BG-19", - "BG-20", - "BG-21", - "BG-23", - "BG-22", - "BG-24", - "BG-25", - "BG-03", - "BG-04", - "BG-05", - "BG-06", - "BG-28", - "BH-13", - "BH-14", - "BH-15", - "BH-17", - "BI-BM", - "BI-CI", - "BI-GI", - "BI-KR", - "BI-KI", - "BI-MW", - "BI-NG", - "BI-RM", - "BI-RT", - "BI-RY", - "BJ-AK", - "BJ-AQ", - "BJ-BO", - "BJ-CO", - "BJ-DO", - "BJ-LI", - "BJ-MO", - "BJ-OU", - "BJ-PL", - "BJ-ZO", - "BL-XX-1", - "BM-XX-1", - "BM-XX-2", - "BN-BE", - "BN-BM", - "BN-TE", - "BN-TU", - "BO-H", - "BO-C", - "BO-B", - "BO-L", - "BO-O", - "BO-N", - "BO-P", - "BO-S", - "BO-T", - "BQ-BO", - "BQ-SA", - "BQ-SE", - "BR-AC", - "BR-AL", - "BR-AP", - "BR-AM", - "BR-BA", - "BR-CE", - "BR-DF", - "BR-ES", - "BR-GO", - "BR-MA", - "BR-MT", - "BR-MS", - "BR-MG", - "BR-PA", - "BR-PB", - "BR-PR", - "BR-PE", - "BR-PI", - "BR-RN", - "BR-RS", - "BR-RJ", - "BR-RO", - "BR-RR", - "BR-SC", - "BR-SP", - "BR-SE", - "BR-TO", - "BS-BP", - "BS-CO", - "BS-FP", - "BS-EG", - "BS-HI", - "BS-LI", - "BS-NP", - "BS-NO", - "BS-NS", - "BS-NE", - "BS-SE", - "BS-WG", - "BT-33", - "BT-12", - "BT-22", - "BT-GA", - "BT-44", - "BT-42", - "BT-11", - "BT-43", - "BT-23", - "BT-45", - "BT-14", - "BT-31", - "BT-15", - "BT-41", - "BT-32", - "BT-21", - "BT-24", - "BV-XX-1", - "BW-CE", - "BW-CH", - "BW-GH", - "BW-KG", - "BW-KL", - "BW-KW", - "BW-NE", - "BW-NW", - "BW-SE", - "BW-SO", - "BY-BR", - "BY-HO", - "BY-HM", - "BY-HR", - "BY-MA", - "BY-MI", - "BY-VI", - "BZ-BZ", - "BZ-CY", - "BZ-CZL", - "BZ-OW", - "BZ-SC", - "BZ-TOL", - "CA-AB", - "CA-BC", - "CA-MB", - "CA-NB", - "CA-NL", - "CA-NT", - "CA-NS", - "CA-NU", - "CA-ON", - "CA-PE", - "CA-QC", - "CA-SK", - "CA-YT", - "CC-XX-1", - "CD-EQ", - "CD-HK", - "CD-HL", - "CD-IT", - "CD-KC", - "CD-KE", - "CD-KN", - "CD-BC", - "CD-KG", - "CD-KL", - "CD-LU", - "CD-NK", - "CD-SA", - "CD-SK", - "CD-TA", - "CD-TO", - "CD-TU", - "CF-BB", - "CF-BGF", - "CF-KB", - "CF-HM", - "CF-KG", - "CF-NM", - "CF-UK", - "CF-AC", - "CF-OP", - "CF-VK", - "CG-11", - "CG-BZV", - "CG-8", - "CG-9", - "CG-16", - "CG-13", - "CH-AG", - "CH-AR", - "CH-AI", - "CH-BL", - "CH-BS", - "CH-BE", - "CH-FR", - "CH-GE", - "CH-GL", - "CH-GR", - "CH-JU", - "CH-LU", - "CH-NE", - "CH-NW", - "CH-OW", - "CH-SG", - "CH-SH", - "CH-SZ", - "CH-SO", - "CH-TG", - "CH-TI", - "CH-UR", - "CH-VS", - "CH-VD", - "CH-ZG", - "CH-ZH", - "CI-AB", - "CI-BS", - "CI-CM", - "CI-DN", - "CI-GD", - "CI-LC", - "CI-LG", - "CI-MG", - "CI-SM", - "CI-SV", - "CI-VB", - "CI-WR", - "CI-YM", - "CI-ZZ", - "CK-XX-1", - "CL-AI", - "CL-AN", - "CL-AP", - "CL-AT", - "CL-BI", - "CL-CO", - "CL-AR", - "CL-LI", - "CL-LL", - "CL-LR", - "CL-MA", - "CL-ML", - "CL-NB", - "CL-RM", - "CL-TA", - "CL-VS", - "CM-AD", - "CM-CE", - "CM-ES", - "CM-EN", - "CM-LT", - "CM-NO", - "CM-NW", - "CM-OU", - "CM-SU", - "CM-SW", - "CN-AH", - "CN-BJ", - "CN-CQ", - "CN-FJ", - "CN-GS", - "CN-GD", - "CN-GX", - "CN-GZ", - "CN-HI", - "CN-HE", - "CN-HL", - "CN-HA", - "CN-HB", - "CN-HN", - "CN-JS", - "CN-JX", - "CN-JL", - "CN-LN", - "CN-NM", - "CN-NX", - "CN-QH", - "CN-SN", - "CN-SD", - "CN-SH", - "CN-SX", - "CN-SC", - "CN-TJ", - "CN-XJ", - "CN-XZ", - "CN-YN", - "CN-ZJ", - "CO-AMA", - "CO-ANT", - "CO-ARA", - "CO-ATL", - "CO-BOL", - "CO-BOY", - "CO-CAL", - "CO-CAQ", - "CO-CAS", - "CO-CAU", - "CO-CES", - "CO-CHO", - "CO-COR", - "CO-CUN", - "CO-DC", - "CO-GUA", - "CO-GUV", - "CO-HUI", - "CO-LAG", - "CO-MAG", - "CO-MET", - "CO-NAR", - "CO-NSA", - "CO-PUT", - "CO-QUI", - "CO-RIS", - "CO-SAP", - "CO-SAN", - "CO-SUC", - "CO-TOL", - "CO-VAC", - "CO-VID", - "CR-A", - "CR-C", - "CR-G", - "CR-H", - "CR-L", - "CR-P", - "CR-SJ", - "CU-15", - "CU-09", - "CU-08", - "CU-06", - "CU-12", - "CU-14", - "CU-11", - "CU-03", - "CU-10", - "CU-04", - "CU-16", - "CU-01", - "CU-07", - "CU-13", - "CU-05", - "CV-BV", - "CV-BR", - "CV-MO", - "CV-PN", - "CV-PR", - "CV-RS", - "CV-SL", - "CV-CR", - "CV-SD", - "CV-SO", - "CV-SV", - "CV-TA", - "CV-TS", - "CW-XX-1", - "CX-XX-1", - "CY-04", - "CY-06", - "CY-03", - "CY-01", - "CY-02", - "CY-05", - "CZ-31", - "CZ-64", - "CZ-41", - "CZ-63", - "CZ-52", - "CZ-51", - "CZ-80", - "CZ-71", - "CZ-53", - "CZ-32", - "CZ-10", - "CZ-20", - "CZ-42", - "CZ-72", - "DE-BW", - "DE-BY", - "DE-BE", - "DE-BB", - "DE-HB", - "DE-HH", - "DE-HE", - "DE-MV", - "DE-NI", - "DE-NW", - "DE-RP", - "DE-SL", - "DE-SN", - "DE-ST", - "DE-SH", - "DE-TH", - "DJ-AR", - "DJ-DJ", - "DK-84", - "DK-82", - "DK-81", - "DK-85", - "DK-83", - "DM-02", - "DM-04", - "DM-05", - "DM-06", - "DM-07", - "DM-09", - "DM-10", - "DO-02", - "DO-03", - "DO-04", - "DO-05", - "DO-01", - "DO-06", - "DO-08", - "DO-07", - "DO-09", - "DO-30", - "DO-19", - "DO-10", - "DO-11", - "DO-12", - "DO-13", - "DO-14", - "DO-28", - "DO-15", - "DO-29", - "DO-17", - "DO-18", - "DO-20", - "DO-21", - "DO-31", - "DO-22", - "DO-23", - "DO-24", - "DO-25", - "DO-26", - "DO-27", - "DZ-01", - "DZ-44", - "DZ-46", - "DZ-16", - "DZ-23", - "DZ-05", - "DZ-08", - "DZ-06", - "DZ-07", - "DZ-09", - "DZ-34", - "DZ-10", - "DZ-35", - "DZ-02", - "DZ-25", - "DZ-17", - "DZ-32", - "DZ-39", - "DZ-36", - "DZ-47", - "DZ-24", - "DZ-33", - "DZ-18", - "DZ-40", - "DZ-03", - "DZ-28", - "DZ-29", - "DZ-26", - "DZ-43", - "DZ-27", - "DZ-45", - "DZ-31", - "DZ-30", - "DZ-04", - "DZ-48", - "DZ-20", - "DZ-19", - "DZ-22", - "DZ-21", - "DZ-41", - "DZ-11", - "DZ-12", - "DZ-14", - "DZ-37", - "DZ-42", - "DZ-38", - "DZ-15", - "DZ-13", - "EC-A", - "EC-B", - "EC-F", - "EC-C", - "EC-H", - "EC-X", - "EC-O", - "EC-E", - "EC-W", - "EC-G", - "EC-I", - "EC-L", - "EC-R", - "EC-M", - "EC-S", - "EC-N", - "EC-D", - "EC-Y", - "EC-P", - "EC-SE", - "EC-SD", - "EC-U", - "EC-T", - "EC-Z", - "EE-37", - "EE-39", - "EE-45", - "EE-52", - "EE-50", - "EE-60", - "EE-56", - "EE-68", - "EE-64", - "EE-71", - "EE-74", - "EE-79", - "EE-81", - "EE-84", - "EE-87", - "EG-DK", - "EG-BA", - "EG-BH", - "EG-FYM", - "EG-GH", - "EG-ALX", - "EG-IS", - "EG-GZ", - "EG-MNF", - "EG-MN", - "EG-C", - "EG-KB", - "EG-LX", - "EG-WAD", - "EG-SUZ", - "EG-SHR", - "EG-ASN", - "EG-AST", - "EG-BNS", - "EG-PTS", - "EG-DT", - "EG-JS", - "EG-KFS", - "EG-MT", - "EG-KN", - "EG-SIN", - "EG-SHG", - "EH-XX-1", - "ER-MA", - "ER-DK", - "ER-SK", - "ES-AN", - "ES-AR", - "ES-AS", - "ES-CN", - "ES-CB", - "ES-CL", - "ES-CM", - "ES-CT", - "ES-CE", - "ES-EX", - "ES-GA", - "ES-IB", - "ES-RI", - "ES-MD", - "ES-ML", - "ES-MC", - "ES-NC", - "ES-PV", - "ES-VC", - "ET-AA", - "ET-AF", - "ET-AM", - "ET-BE", - "ET-DD", - "ET-GA", - "ET-HA", - "ET-OR", - "ET-SO", - "ET-TI", - "ET-SN", - "FI-02", - "FI-03", - "FI-04", - "FI-05", - "FI-06", - "FI-07", - "FI-08", - "FI-09", - "FI-10", - "FI-16", - "FI-11", - "FI-12", - "FI-13", - "FI-14", - "FI-15", - "FI-17", - "FI-18", - "FI-19", - "FJ-C", - "FJ-E", - "FJ-N", - "FJ-R", - "FJ-W", - "FK-XX-1", - "FM-TRK", - "FM-KSA", - "FM-PNI", - "FM-YAP", - "FO-XX-1", - "FO-XX-2", - "FO-XX-3", - "FO-XX-4", - "FO-XX-5", - "FR-ARA", - "FR-BFC", - "FR-BRE", - "FR-CVL", - "FR-20R", - "FR-GES", - "FR-HDF", - "FR-IDF", - "FR-NOR", - "FR-NAQ", - "FR-OCC", - "FR-PDL", - "FR-PAC", - "GA-1", - "GA-2", - "GA-4", - "GA-5", - "GA-8", - "GA-9", - "GB-ENG", - "GB-NIR", - "GB-SCT", - "GB-WLS", - "GB-CAM", - "GB-CMA", - "GB-DBY", - "GB-DEV", - "GB-DOR", - "GB-ESX", - "GB-ESS", - "GB-GLS", - "GB-HAM", - "GB-HRT", - "GB-KEN", - "GB-LAN", - "GB-LEC", - "GB-LIN", - "GB-NFK", - "GB-NYK", - "GB-NTT", - "GB-OXF", - "GB-SOM", - "GB-STS", - "GB-SFK", - "GB-SRY", - "GB-WAR", - "GB-WSX", - "GB-WOR", - "GB-LND", - "GB-BDG", - "GB-BNE", - "GB-BEX", - "GB-BEN", - "GB-BRY", - "GB-CMD", - "GB-CRY", - "GB-EAL", - "GB-ENF", - "GB-GRE", - "GB-HCK", - "GB-HMF", - "GB-HRY", - "GB-HRW", - "GB-HAV", - "GB-HIL", - "GB-HNS", - "GB-ISL", - "GB-KEC", - "GB-KTT", - "GB-LBH", - "GB-LEW", - "GB-MRT", - "GB-NWM", - "GB-RDB", - "GB-RIC", - "GB-SWK", - "GB-STN", - "GB-TWH", - "GB-WFT", - "GB-WND", - "GB-WSM", - "GB-BNS", - "GB-BIR", - "GB-BOL", - "GB-BRD", - "GB-BUR", - "GB-CLD", - "GB-COV", - "GB-DNC", - "GB-DUD", - "GB-GAT", - "GB-KIR", - "GB-KWL", - "GB-LDS", - "GB-LIV", - "GB-MAN", - "GB-NET", - "GB-NTY", - "GB-OLD", - "GB-RCH", - "GB-ROT", - "GB-SHN", - "GB-SLF", - "GB-SAW", - "GB-SFT", - "GB-SHF", - "GB-SOL", - "GB-STY", - "GB-SKP", - "GB-SND", - "GB-TAM", - "GB-TRF", - "GB-WKF", - "GB-WLL", - "GB-WGN", - "GB-WRL", - "GB-WLV", - "GB-BAS", - "GB-BDF", - "GB-BBD", - "GB-BPL", - "GB-BCP", - "GB-BRC", - "GB-BNH", - "GB-BST", - "GB-BKM", - "GB-CBF", - "GB-CHE", - "GB-CHW", - "GB-CON", - "GB-DAL", - "GB-DER", - "GB-DUR", - "GB-ERY", - "GB-HAL", - "GB-HPL", - "GB-HEF", - "GB-IOW", - "GB-IOS", - "GB-KHL", - "GB-LCE", - "GB-LUT", - "GB-MDW", - "GB-MDB", - "GB-MIK", - "GB-NEL", - "GB-NLN", - "GB-NNH", - "GB-NSM", - "GB-NBL", - "GB-NGM", - "GB-PTE", - "GB-PLY", - "GB-POR", - "GB-RDG", - "GB-RCC", - "GB-RUT", - "GB-SHR", - "GB-SLG", - "GB-SGC", - "GB-STH", - "GB-SOS", - "GB-STT", - "GB-STE", - "GB-SWD", - "GB-TFW", - "GB-THR", - "GB-TOB", - "GB-WRT", - "GB-WBK", - "GB-WNH", - "GB-WIL", - "GB-WNM", - "GB-WOK", - "GB-YOR", - "GB-ANN", - "GB-AND", - "GB-ABC", - "GB-BFS", - "GB-CCG", - "GB-DRS", - "GB-FMO", - "GB-LBC", - "GB-MEA", - "GB-MUL", - "GB-NMD", - "GB-ABE", - "GB-ABD", - "GB-ANS", - "GB-AGB", - "GB-CLK", - "GB-DGY", - "GB-DND", - "GB-EAY", - "GB-EDU", - "GB-ELN", - "GB-ERW", - "GB-EDH", - "GB-ELS", - "GB-FAL", - "GB-FIF", - "GB-GLG", - "GB-HLD", - "GB-IVC", - "GB-MLN", - "GB-MRY", - "GB-NAY", - "GB-NLK", - "GB-ORK", - "GB-PKN", - "GB-RFW", - "GB-SCB", - "GB-ZET", - "GB-SAY", - "GB-SLK", - "GB-STG", - "GB-WDU", - "GB-WLN", - "GB-BGW", - "GB-BGE", - "GB-CAY", - "GB-CRF", - "GB-CMN", - "GB-CGN", - "GB-CWY", - "GB-DEN", - "GB-FLN", - "GB-GWN", - "GB-AGY", - "GB-MTY", - "GB-MON", - "GB-NTL", - "GB-NWP", - "GB-PEM", - "GB-POW", - "GB-RCT", - "GB-SWA", - "GB-TOF", - "GB-VGL", - "GB-WRX", - "GD-01", - "GD-02", - "GD-03", - "GD-04", - "GD-05", - "GD-06", - "GD-10", - "GE-AB", - "GE-AJ", - "GE-GU", - "GE-IM", - "GE-KA", - "GE-KK", - "GE-MM", - "GE-RL", - "GE-SZ", - "GE-SJ", - "GE-SK", - "GE-TB", - "GF-XX-1", - "GG-XX-1", - "GH-AF", - "GH-AH", - "GH-BO", - "GH-BE", - "GH-CP", - "GH-EP", - "GH-AA", - "GH-NP", - "GH-UE", - "GH-UW", - "GH-TV", - "GH-WP", - "GI-XX-1", - "GL-AV", - "GL-KU", - "GL-QT", - "GL-SM", - "GL-QE", - "GM-B", - "GM-M", - "GM-L", - "GM-N", - "GM-U", - "GM-W", - "GN-BF", - "GN-B", - "GN-C", - "GN-CO", - "GN-DB", - "GN-DU", - "GN-K", - "GN-L", - "GN-LA", - "GN-MC", - "GN-N", - "GN-SI", - "GP-XX-1", - "GQ-BN", - "GQ-KN", - "GQ-LI", - "GQ-WN", - "GR-A", - "GR-I", - "GR-G", - "GR-C", - "GR-F", - "GR-D", - "GR-B", - "GR-M", - "GR-L", - "GR-J", - "GR-H", - "GR-E", - "GR-K", - "GS-XX-1", - "GT-16", - "GT-15", - "GT-04", - "GT-20", - "GT-02", - "GT-05", - "GT-01", - "GT-13", - "GT-18", - "GT-21", - "GT-22", - "GT-17", - "GT-09", - "GT-14", - "GT-11", - "GT-03", - "GT-12", - "GT-06", - "GT-07", - "GT-10", - "GT-08", - "GT-19", - "GU-XX-1", - "GU-XX-2", - "GU-XX-3", - "GU-XX-4", - "GU-XX-5", - "GU-XX-6", - "GU-XX-7", - "GU-XX-8", - "GU-XX-9", - "GU-XX-10", - "GU-XX-11", - "GU-XX-12", - "GU-XX-13", - "GU-XX-14", - "GU-XX-15", - "GU-XX-16", - "GW-BS", - "GW-GA", - "GY-CU", - "GY-DE", - "GY-EB", - "GY-ES", - "GY-MA", - "GY-PT", - "GY-UD", - "HK-XX-1", - "HM-XX-1", - "HN-AT", - "HN-CH", - "HN-CL", - "HN-CM", - "HN-CP", - "HN-CR", - "HN-EP", - "HN-FM", - "HN-GD", - "HN-IN", - "HN-IB", - "HN-LP", - "HN-LE", - "HN-OC", - "HN-OL", - "HN-SB", - "HN-VA", - "HN-YO", - "HR-07", - "HR-12", - "HR-19", - "HR-21", - "HR-18", - "HR-04", - "HR-06", - "HR-02", - "HR-09", - "HR-20", - "HR-14", - "HR-11", - "HR-08", - "HR-15", - "HR-03", - "HR-17", - "HR-05", - "HR-10", - "HR-16", - "HR-13", - "HR-01", - "HT-AR", - "HT-CE", - "HT-GA", - "HT-NI", - "HT-ND", - "HT-OU", - "HT-SD", - "HT-SE", - "HU-BK", - "HU-BA", - "HU-BE", - "HU-BZ", - "HU-BU", - "HU-CS", - "HU-FE", - "HU-GS", - "HU-HB", - "HU-HE", - "HU-JN", - "HU-KE", - "HU-NO", - "HU-PE", - "HU-SO", - "HU-SZ", - "HU-TO", - "HU-VA", - "HU-VE", - "HU-ZA", - "ID-AC", - "ID-BA", - "ID-BT", - "ID-BE", - "ID-GO", - "ID-JK", - "ID-JA", - "ID-JB", - "ID-JT", - "ID-JI", - "ID-KB", - "ID-KS", - "ID-KT", - "ID-KI", - "ID-KU", - "ID-BB", - "ID-KR", - "ID-LA", - "ID-ML", - "ID-MU", - "ID-NB", - "ID-NT", - "ID-PP", - "ID-PB", - "ID-RI", - "ID-SR", - "ID-SN", - "ID-ST", - "ID-SG", - "ID-SA", - "ID-SB", - "ID-SS", - "ID-SU", - "ID-YO", - "IE-CW", - "IE-CN", - "IE-CE", - "IE-CO", - "IE-DL", - "IE-D", - "IE-G", - "IE-KY", - "IE-KE", - "IE-KK", - "IE-LS", - "IE-LM", - "IE-LK", - "IE-LD", - "IE-LH", - "IE-MO", - "IE-MH", - "IE-MN", - "IE-OY", - "IE-RN", - "IE-SO", - "IE-TA", - "IE-WD", - "IE-WH", - "IE-WX", - "IE-WW", - "IL-D", - "IL-M", - "IL-Z", - "IL-HA", - "IL-TA", - "IL-JM", - "IM-XX-1", - "IN-AN", - "IN-AP", - "IN-AR", - "IN-AS", - "IN-BR", - "IN-CH", - "IN-CT", - "IN-DN", - "IN-DH", - "IN-DL", - "IN-GA", - "IN-GJ", - "IN-HR", - "IN-HP", - "IN-JK", - "IN-JH", - "IN-KA", - "IN-KL", - "IN-LD", - "IN-MP", - "IN-MH", - "IN-MN", - "IN-ML", - "IN-MZ", - "IN-NL", - "IN-OR", - "IN-PY", - "IN-PB", - "IN-RJ", - "IN-SK", - "IN-TN", - "IN-TG", - "IN-TR", - "IN-UP", - "IN-UT", - "IN-WB", - "IO-XX-1", - "IQ-AN", - "IQ-BA", - "IQ-MU", - "IQ-QA", - "IQ-NA", - "IQ-AR", - "IQ-SU", - "IQ-BB", - "IQ-BG", - "IQ-DA", - "IQ-DQ", - "IQ-DI", - "IQ-KA", - "IQ-KI", - "IQ-MA", - "IQ-NI", - "IQ-SD", - "IQ-WA", - "IR-30", - "IR-24", - "IR-04", - "IR-03", - "IR-18", - "IR-14", - "IR-10", - "IR-07", - "IR-01", - "IR-27", - "IR-13", - "IR-22", - "IR-16", - "IR-08", - "IR-05", - "IR-29", - "IR-09", - "IR-28", - "IR-06", - "IR-17", - "IR-12", - "IR-15", - "IR-00", - "IR-02", - "IR-26", - "IR-25", - "IR-20", - "IR-11", - "IR-23", - "IR-21", - "IR-19", - "IS-7", - "IS-1", - "IS-6", - "IS-5", - "IS-8", - "IS-2", - "IS-4", - "IS-3", - "IT-65", - "IT-77", - "IT-78", - "IT-72", - "IT-45", - "IT-36", - "IT-62", - "IT-42", - "IT-25", - "IT-57", - "IT-67", - "IT-21", - "IT-75", - "IT-88", - "IT-82", - "IT-52", - "IT-32", - "IT-55", - "IT-23", - "IT-34", - "JE-XX-1", - "JM-13", - "JM-09", - "JM-01", - "JM-12", - "JM-04", - "JM-02", - "JM-06", - "JM-14", - "JM-11", - "JM-08", - "JM-05", - "JM-03", - "JM-07", - "JM-10", - "JO-AJ", - "JO-AQ", - "JO-AM", - "JO-BA", - "JO-KA", - "JO-MA", - "JO-AT", - "JO-AZ", - "JO-IR", - "JO-JA", - "JO-MN", - "JO-MD", - "JP-23", - "JP-05", - "JP-02", - "JP-12", - "JP-38", - "JP-18", - "JP-40", - "JP-07", - "JP-21", - "JP-10", - "JP-34", - "JP-01", - "JP-28", - "JP-08", - "JP-17", - "JP-03", - "JP-37", - "JP-46", - "JP-14", - "JP-39", - "JP-43", - "JP-26", - "JP-24", - "JP-04", - "JP-45", - "JP-20", - "JP-42", - "JP-29", - "JP-15", - "JP-44", - "JP-33", - "JP-47", - "JP-27", - "JP-41", - "JP-11", - "JP-25", - "JP-32", - "JP-22", - "JP-09", - "JP-36", - "JP-13", - "JP-31", - "JP-16", - "JP-30", - "JP-06", - "JP-35", - "JP-19", - "KE-01", - "KE-02", - "KE-03", - "KE-04", - "KE-05", - "KE-06", - "KE-07", - "KE-08", - "KE-09", - "KE-10", - "KE-11", - "KE-12", - "KE-13", - "KE-14", - "KE-15", - "KE-16", - "KE-17", - "KE-18", - "KE-19", - "KE-20", - "KE-21", - "KE-22", - "KE-23", - "KE-24", - "KE-25", - "KE-26", - "KE-27", - "KE-28", - "KE-29", - "KE-30", - "KE-31", - "KE-32", - "KE-33", - "KE-34", - "KE-35", - "KE-36", - "KE-37", - "KE-38", - "KE-39", - "KE-40", - "KE-41", - "KE-42", - "KE-43", - "KE-44", - "KE-45", - "KE-46", - "KE-47", - "KG-B", - "KG-GB", - "KG-C", - "KG-J", - "KG-N", - "KG-GO", - "KG-T", - "KG-Y", - "KH-2", - "KH-1", - "KH-23", - "KH-3", - "KH-4", - "KH-5", - "KH-6", - "KH-7", - "KH-8", - "KH-10", - "KH-11", - "KH-24", - "KH-12", - "KH-15", - "KH-18", - "KH-14", - "KH-16", - "KH-17", - "KH-19", - "KH-20", - "KH-21", - "KI-G", - "KM-G", - "KM-M", - "KN-01", - "KN-02", - "KN-03", - "KN-05", - "KN-06", - "KN-07", - "KN-08", - "KN-09", - "KN-10", - "KN-11", - "KN-12", - "KN-13", - "KN-15", - "KP-01", - "KR-26", - "KR-43", - "KR-44", - "KR-27", - "KR-30", - "KR-42", - "KR-29", - "KR-41", - "KR-47", - "KR-48", - "KR-28", - "KR-49", - "KR-45", - "KR-46", - "KR-11", - "KR-31", - "KW-KU", - "KW-AH", - "KW-FA", - "KW-JA", - "KW-HA", - "KW-MU", - "KY-XX-1", - "KZ-ALA", - "KZ-ALM", - "KZ-AKM", - "KZ-AKT", - "KZ-ATY", - "KZ-ZAP", - "KZ-MAN", - "KZ-AST", - "KZ-YUZ", - "KZ-PAV", - "KZ-KAR", - "KZ-KUS", - "KZ-KZY", - "KZ-VOS", - "KZ-SHY", - "KZ-SEV", - "KZ-ZHA", - "LA-AT", - "LA-BL", - "LA-CH", - "LA-HO", - "LA-KH", - "LA-OU", - "LA-PH", - "LA-SV", - "LA-VI", - "LA-XA", - "LA-XE", - "LA-XI", - "LB-AK", - "LB-BH", - "LB-BI", - "LB-BA", - "LB-AS", - "LB-JA", - "LB-JL", - "LB-NA", - "LC-01", - "LC-02", - "LC-03", - "LC-05", - "LC-06", - "LC-07", - "LC-08", - "LC-10", - "LC-11", - "LI-01", - "LI-02", - "LI-03", - "LI-04", - "LI-05", - "LI-06", - "LI-07", - "LI-09", - "LI-10", - "LI-11", - "LK-2", - "LK-5", - "LK-7", - "LK-6", - "LK-4", - "LK-9", - "LK-3", - "LK-8", - "LK-1", - "LR-BM", - "LR-GB", - "LR-GG", - "LR-MG", - "LR-MO", - "LR-NI", - "LR-SI", - "LS-D", - "LS-B", - "LS-C", - "LS-E", - "LS-A", - "LS-F", - "LS-J", - "LS-H", - "LS-G", - "LS-K", - "LT-AL", - "LT-KU", - "LT-KL", - "LT-MR", - "LT-PN", - "LT-SA", - "LT-TA", - "LT-TE", - "LT-UT", - "LT-VL", - "LU-CA", - "LU-CL", - "LU-DI", - "LU-EC", - "LU-ES", - "LU-GR", - "LU-LU", - "LU-ME", - "LU-RD", - "LU-RM", - "LU-VD", - "LU-WI", - "LV-011", - "LV-002", - "LV-007", - "LV-111", - "LV-015", - "LV-016", - "LV-022", - "LV-DGV", - "LV-112", - "LV-026", - "LV-033", - "LV-042", - "LV-JEL", - "LV-041", - "LV-JUR", - "LV-052", - "LV-047", - "LV-050", - "LV-LPX", - "LV-054", - "LV-056", - "LV-058", - "LV-059", - "LV-062", - "LV-067", - "LV-068", - "LV-073", - "LV-077", - "LV-RIX", - "LV-080", - "LV-087", - "LV-088", - "LV-089", - "LV-091", - "LV-094", - "LV-097", - "LV-099", - "LV-101", - "LV-113", - "LV-102", - "LV-106", - "LY-BU", - "LY-JA", - "LY-JG", - "LY-JI", - "LY-JU", - "LY-KF", - "LY-MJ", - "LY-MB", - "LY-WA", - "LY-NQ", - "LY-ZA", - "LY-BA", - "LY-DR", - "LY-MI", - "LY-NL", - "LY-SB", - "LY-SR", - "LY-TB", - "LY-WS", - "MA-05", - "MA-06", - "MA-08", - "MA-03", - "MA-10", - "MA-02", - "MA-11", - "MA-07", - "MA-04", - "MA-09", - "MA-01", - "MC-FO", - "MC-CO", - "MC-MO", - "MC-MC", - "MC-SR", - "MD-AN", - "MD-BA", - "MD-BS", - "MD-BD", - "MD-BR", - "MD-CA", - "MD-CL", - "MD-CT", - "MD-CS", - "MD-CU", - "MD-CM", - "MD-CR", - "MD-DO", - "MD-DR", - "MD-DU", - "MD-ED", - "MD-FA", - "MD-FL", - "MD-GA", - "MD-GL", - "MD-HI", - "MD-IA", - "MD-LE", - "MD-NI", - "MD-OC", - "MD-OR", - "MD-RE", - "MD-RI", - "MD-SI", - "MD-SD", - "MD-SO", - "MD-SV", - "MD-SN", - "MD-ST", - "MD-TA", - "MD-TE", - "MD-UN", - "ME-01", - "ME-02", - "ME-03", - "ME-04", - "ME-05", - "ME-06", - "ME-07", - "ME-08", - "ME-10", - "ME-12", - "ME-13", - "ME-14", - "ME-15", - "ME-16", - "ME-17", - "ME-19", - "ME-24", - "ME-20", - "ME-21", - "MF-XX-1", - "MG-T", - "MG-D", - "MG-F", - "MG-M", - "MG-A", - "MG-U", - "MH-KWA", - "MH-MAJ", - "MK-802", - "MK-201", - "MK-501", - "MK-401", - "MK-601", - "MK-402", - "MK-602", - "MK-803", - "MK-109", - "MK-814", - "MK-210", - "MK-816", - "MK-303", - "MK-203", - "MK-502", - "MK-406", - "MK-503", - "MK-804", - "MK-405", - "MK-604", - "MK-102", - "MK-807", - "MK-606", - "MK-205", - "MK-104", - "MK-307", - "MK-809", - "MK-206", - "MK-701", - "MK-702", - "MK-505", - "MK-703", - "MK-704", - "MK-105", - "MK-207", - "MK-308", - "MK-607", - "MK-506", - "MK-106", - "MK-507", - "MK-408", - "MK-310", - "MK-208", - "MK-810", - "MK-311", - "MK-508", - "MK-209", - "MK-409", - "MK-705", - "MK-509", - "MK-107", - "MK-811", - "MK-812", - "MK-211", - "MK-312", - "MK-410", - "MK-813", - "MK-108", - "MK-608", - "MK-609", - "MK-403", - "MK-404", - "MK-101", - "MK-301", - "MK-202", - "MK-603", - "MK-806", - "MK-605", - "ML-BKO", - "ML-7", - "ML-1", - "ML-8", - "ML-2", - "ML-5", - "ML-4", - "ML-3", - "ML-6", - "MM-07", - "MM-02", - "MM-14", - "MM-11", - "MM-12", - "MM-13", - "MM-03", - "MM-04", - "MM-15", - "MM-18", - "MM-16", - "MM-01", - "MM-17", - "MM-05", - "MM-06", - "MN-071", - "MN-037", - "MN-061", - "MN-063", - "MN-065", - "MN-043", - "MN-035", - "MN-055", - "MN-049", - "MN-047", - "MN-1", - "MO-XX-1", - "MP-XX-1", - "MQ-XX-1", - "MR-07", - "MR-03", - "MR-05", - "MR-08", - "MR-04", - "MR-10", - "MR-01", - "MR-02", - "MR-12", - "MR-13", - "MR-09", - "MR-11", - "MR-06", - "MS-XX-1", - "MS-XX-2", - "MT-01", - "MT-02", - "MT-03", - "MT-04", - "MT-05", - "MT-06", - "MT-07", - "MT-08", - "MT-09", - "MT-10", - "MT-14", - "MT-15", - "MT-16", - "MT-17", - "MT-11", - "MT-12", - "MT-18", - "MT-19", - "MT-20", - "MT-21", - "MT-22", - "MT-23", - "MT-24", - "MT-25", - "MT-26", - "MT-27", - "MT-28", - "MT-29", - "MT-30", - "MT-31", - "MT-32", - "MT-33", - "MT-34", - "MT-35", - "MT-36", - "MT-37", - "MT-38", - "MT-39", - "MT-40", - "MT-41", - "MT-42", - "MT-43", - "MT-45", - "MT-46", - "MT-49", - "MT-48", - "MT-53", - "MT-51", - "MT-52", - "MT-54", - "MT-55", - "MT-56", - "MT-57", - "MT-58", - "MT-59", - "MT-60", - "MT-61", - "MT-62", - "MT-63", - "MT-64", - "MT-65", - "MT-67", - "MT-68", - "MU-BL", - "MU-FL", - "MU-GP", - "MU-MO", - "MU-PA", - "MU-PW", - "MU-PL", - "MU-RR", - "MU-RO", - "MU-SA", - "MV-01", - "MV-03", - "MV-04", - "MV-05", - "MV-MLE", - "MV-12", - "MV-13", - "MV-00", - "MV-28", - "MV-20", - "MV-25", - "MV-17", - "MW-BA", - "MW-BL", - "MW-CK", - "MW-CR", - "MW-DE", - "MW-DO", - "MW-KR", - "MW-LI", - "MW-MH", - "MW-MG", - "MW-MW", - "MW-MZ", - "MW-NE", - "MW-NK", - "MW-PH", - "MW-SA", - "MW-TH", - "MW-ZO", - "MX-AGU", - "MX-BCN", - "MX-BCS", - "MX-CAM", - "MX-CHP", - "MX-CHH", - "MX-CMX", - "MX-COA", - "MX-COL", - "MX-DUR", - "MX-GUA", - "MX-GRO", - "MX-HID", - "MX-JAL", - "MX-MEX", - "MX-MIC", - "MX-MOR", - "MX-NAY", - "MX-NLE", - "MX-OAX", - "MX-PUE", - "MX-QUE", - "MX-ROO", - "MX-SLP", - "MX-SIN", - "MX-SON", - "MX-TAB", - "MX-TAM", - "MX-TLA", - "MX-VER", - "MX-YUC", - "MX-ZAC", - "MY-01", - "MY-02", - "MY-03", - "MY-04", - "MY-05", - "MY-06", - "MY-08", - "MY-09", - "MY-07", - "MY-12", - "MY-13", - "MY-10", - "MY-11", - "MY-14", - "MY-15", - "MY-16", - "MZ-P", - "MZ-G", - "MZ-I", - "MZ-B", - "MZ-L", - "MZ-N", - "MZ-A", - "MZ-S", - "MZ-T", - "MZ-Q", - "NA-ER", - "NA-HA", - "NA-KA", - "NA-KE", - "NA-KW", - "NA-KH", - "NA-KU", - "NA-OW", - "NA-OH", - "NA-OS", - "NA-ON", - "NA-OT", - "NA-OD", - "NA-CA", - "NC-XX-1", - "NC-XX-2", - "NE-1", - "NE-2", - "NE-3", - "NE-8", - "NE-5", - "NE-6", - "NE-7", - "NF-XX-1", - "NG-AB", - "NG-FC", - "NG-AD", - "NG-AK", - "NG-AN", - "NG-BA", - "NG-BY", - "NG-BE", - "NG-BO", - "NG-CR", - "NG-DE", - "NG-EB", - "NG-ED", - "NG-EK", - "NG-EN", - "NG-GO", - "NG-IM", - "NG-JI", - "NG-KD", - "NG-KN", - "NG-KT", - "NG-KE", - "NG-KO", - "NG-KW", - "NG-LA", - "NG-NA", - "NG-NI", - "NG-OG", - "NG-ON", - "NG-OS", - "NG-OY", - "NG-PL", - "NG-RI", - "NG-SO", - "NG-TA", - "NG-YO", - "NG-ZA", - "NI-BO", - "NI-CA", - "NI-CI", - "NI-CO", - "NI-AN", - "NI-AS", - "NI-ES", - "NI-GR", - "NI-JI", - "NI-LE", - "NI-MD", - "NI-MN", - "NI-MS", - "NI-MT", - "NI-NS", - "NI-SJ", - "NI-RI", - "NL-DR", - "NL-FL", - "NL-FR", - "NL-GE", - "NL-GR", - "NL-LI", - "NL-NB", - "NL-NH", - "NL-OV", - "NL-UT", - "NL-ZE", - "NL-ZH", - "NO-42", - "NO-34", - "NO-15", - "NO-18", - "NO-03", - "NO-11", - "NO-54", - "NO-50", - "NO-38", - "NO-46", - "NO-30", - "NP-BA", - "NP-BH", - "NP-DH", - "NP-GA", - "NP-JA", - "NP-KA", - "NP-KO", - "NP-LU", - "NP-MA", - "NP-ME", - "NP-NA", - "NP-RA", - "NP-SA", - "NP-SE", - "NR-01", - "NR-03", - "NR-14", - "NU-XX-1", - "NZ-AUK", - "NZ-BOP", - "NZ-CAN", - "NZ-CIT", - "NZ-GIS", - "NZ-HKB", - "NZ-MWT", - "NZ-MBH", - "NZ-NSN", - "NZ-NTL", - "NZ-OTA", - "NZ-STL", - "NZ-TKI", - "NZ-TAS", - "NZ-WKO", - "NZ-WGN", - "NZ-WTC", - "OM-DA", - "OM-BU", - "OM-WU", - "OM-ZA", - "OM-BJ", - "OM-SJ", - "OM-MA", - "OM-MU", - "OM-BS", - "OM-SS", - "OM-ZU", - "PA-1", - "PA-4", - "PA-2", - "PA-3", - "PA-5", - "PA-KY", - "PA-6", - "PA-7", - "PA-NB", - "PA-8", - "PA-9", - "PE-AMA", - "PE-ANC", - "PE-APU", - "PE-ARE", - "PE-AYA", - "PE-CAJ", - "PE-CUS", - "PE-CAL", - "PE-HUV", - "PE-HUC", - "PE-ICA", - "PE-JUN", - "PE-LAL", - "PE-LAM", - "PE-LIM", - "PE-LOR", - "PE-MDD", - "PE-MOQ", - "PE-PAS", - "PE-PIU", - "PE-PUN", - "PE-SAM", - "PE-TAC", - "PE-TUM", - "PE-UCA", - "PF-XX-1", - "PF-XX-2", - "PF-XX-3", - "PF-XX-4", - "PF-XX-5", - "PG-NSB", - "PG-CPM", - "PG-CPK", - "PG-EBR", - "PG-EHG", - "PG-ESW", - "PG-MPM", - "PG-MRL", - "PG-MBA", - "PG-MPL", - "PG-NCD", - "PG-SHM", - "PG-WBK", - "PG-SAN", - "PG-WPD", - "PG-WHM", - "PH-ABR", - "PH-AGN", - "PH-AGS", - "PH-AKL", - "PH-ALB", - "PH-ANT", - "PH-APA", - "PH-AUR", - "PH-BAS", - "PH-BAN", - "PH-BTN", - "PH-BTG", - "PH-BEN", - "PH-BIL", - "PH-BOH", - "PH-BUK", - "PH-BUL", - "PH-CAG", - "PH-CAN", - "PH-CAS", - "PH-CAM", - "PH-CAP", - "PH-CAT", - "PH-CAV", - "PH-CEB", - "PH-NCO", - "PH-DAO", - "PH-COM", - "PH-DAV", - "PH-DAS", - "PH-DIN", - "PH-EAS", - "PH-GUI", - "PH-IFU", - "PH-ILN", - "PH-ILS", - "PH-ILI", - "PH-ISA", - "PH-KAL", - "PH-LUN", - "PH-LAG", - "PH-LAN", - "PH-LAS", - "PH-LEY", - "PH-MAG", - "PH-MAD", - "PH-MAS", - "PH-MDC", - "PH-MDR", - "PH-MSC", - "PH-MSR", - "PH-MOU", - "PH-00", - "PH-NEC", - "PH-NER", - "PH-NSA", - "PH-NUE", - "PH-NUV", - "PH-PLW", - "PH-PAM", - "PH-PAN", - "PH-QUE", - "PH-QUI", - "PH-RIZ", - "PH-ROM", - "PH-WSA", - "PH-SAR", - "PH-SIG", - "PH-SOR", - "PH-SCO", - "PH-SLE", - "PH-SUK", - "PH-SLU", - "PH-SUN", - "PH-SUR", - "PH-TAR", - "PH-TAW", - "PH-ZMB", - "PH-ZSI", - "PH-ZAN", - "PH-ZAS", - "PK-JK", - "PK-BA", - "PK-GB", - "PK-IS", - "PK-KP", - "PK-PB", - "PK-SD", - "PL-02", - "PL-04", - "PL-10", - "PL-06", - "PL-08", - "PL-12", - "PL-14", - "PL-16", - "PL-18", - "PL-20", - "PL-22", - "PL-24", - "PL-26", - "PL-28", - "PL-30", - "PL-32", - "PM-XX-1", - "PN-XX-1", - "PR-XX-1", - "PR-XX-2", - "PR-XX-3", - "PR-XX-4", - "PR-XX-5", - "PR-XX-6", - "PR-XX-7", - "PR-XX-8", - "PR-XX-9", - "PR-XX-10", - "PR-XX-11", - "PR-XX-12", - "PR-XX-13", - "PR-XX-14", - "PR-XX-15", - "PR-XX-16", - "PR-XX-17", - "PR-XX-18", - "PR-XX-19", - "PR-XX-20", - "PR-XX-21", - "PR-XX-22", - "PR-XX-23", - "PR-XX-24", - "PR-XX-25", - "PR-XX-26", - "PR-XX-27", - "PR-XX-28", - "PR-XX-29", - "PR-XX-30", - "PR-XX-31", - "PR-XX-32", - "PR-XX-33", - "PR-XX-34", - "PR-XX-35", - "PR-XX-36", - "PR-XX-37", - "PR-XX-38", - "PR-XX-39", - "PR-XX-40", - "PR-XX-41", - "PR-XX-42", - "PR-XX-43", - "PR-XX-44", - "PR-XX-45", - "PR-XX-46", - "PR-XX-47", - "PR-XX-48", - "PR-XX-49", - "PR-XX-50", - "PR-XX-51", - "PR-XX-52", - "PR-XX-53", - "PR-XX-54", - "PR-XX-55", - "PR-XX-56", - "PR-XX-57", - "PR-XX-58", - "PR-XX-59", - "PR-XX-60", - "PR-XX-61", - "PR-XX-62", - "PR-XX-63", - "PR-XX-64", - "PR-XX-65", - "PR-XX-66", - "PR-XX-67", - "PR-XX-68", - "PR-XX-69", - "PR-XX-70", - "PR-XX-71", - "PR-XX-72", - "PR-XX-73", - "PR-XX-74", - "PR-XX-75", - "PR-XX-76", - "PS-BTH", - "PS-DEB", - "PS-GZA", - "PS-HBN", - "PS-JEN", - "PS-JRH", - "PS-JEM", - "PS-KYS", - "PS-NBS", - "PS-QQA", - "PS-RFH", - "PS-RBH", - "PS-SLT", - "PS-TBS", - "PS-TKM", - "PT-01", - "PT-02", - "PT-03", - "PT-04", - "PT-05", - "PT-06", - "PT-07", - "PT-08", - "PT-09", - "PT-10", - "PT-11", - "PT-12", - "PT-13", - "PT-30", - "PT-20", - "PT-14", - "PT-15", - "PT-16", - "PT-17", - "PT-18", - "PW-004", - "PW-100", - "PW-150", - "PW-212", - "PW-214", - "PW-222", - "PY-10", - "PY-13", - "PY-ASU", - "PY-19", - "PY-5", - "PY-6", - "PY-14", - "PY-11", - "PY-1", - "PY-3", - "PY-4", - "PY-7", - "PY-8", - "PY-12", - "PY-9", - "PY-15", - "PY-2", - "QA-DA", - "QA-KH", - "QA-WA", - "QA-RA", - "QA-MS", - "QA-ZA", - "QA-US", - "RE-XX-1", - "RO-AB", - "RO-AR", - "RO-AG", - "RO-BC", - "RO-BH", - "RO-BN", - "RO-BT", - "RO-BR", - "RO-BV", - "RO-B", - "RO-BZ", - "RO-CL", - "RO-CS", - "RO-CJ", - "RO-CT", - "RO-CV", - "RO-DB", - "RO-DJ", - "RO-GL", - "RO-GR", - "RO-GJ", - "RO-HR", - "RO-HD", - "RO-IL", - "RO-IS", - "RO-IF", - "RO-MM", - "RO-MH", - "RO-MS", - "RO-NT", - "RO-OT", - "RO-PH", - "RO-SJ", - "RO-SM", - "RO-SB", - "RO-SV", - "RO-TR", - "RO-TM", - "RO-TL", - "RO-VL", - "RO-VS", - "RO-VN", - "RS-00", - "RS-14", - "RS-11", - "RS-23", - "RS-06", - "RS-04", - "RS-09", - "RS-28", - "RS-08", - "RS-17", - "RS-20", - "RS-24", - "RS-26", - "RS-22", - "RS-10", - "RS-13", - "RS-27", - "RS-19", - "RS-18", - "RS-01", - "RS-03", - "RS-02", - "RS-07", - "RS-12", - "RS-21", - "RS-15", - "RS-05", - "RS-16", - "RU-AD", - "RU-AL", - "RU-ALT", - "RU-AMU", - "RU-ARK", - "RU-AST", - "RU-BA", - "RU-BEL", - "RU-BRY", - "RU-BU", - "RU-CE", - "RU-CHE", - "RU-CHU", - "RU-CU", - "RU-DA", - "RU-IN", - "RU-IRK", - "RU-IVA", - "RU-KB", - "RU-KGD", - "RU-KL", - "RU-KLU", - "RU-KAM", - "RU-KC", - "RU-KR", - "RU-KEM", - "RU-KHA", - "RU-KK", - "RU-KHM", - "RU-KIR", - "RU-KO", - "RU-KOS", - "RU-KDA", - "RU-KYA", - "RU-KGN", - "RU-KRS", - "RU-LEN", - "RU-LIP", - "RU-MAG", - "RU-ME", - "RU-MO", - "RU-MOS", - "RU-MOW", - "RU-MUR", - "RU-NEN", - "RU-NIZ", - "RU-NGR", - "RU-NVS", - "RU-OMS", - "RU-ORE", - "RU-ORL", - "RU-PNZ", - "RU-PER", - "RU-PRI", - "RU-PSK", - "RU-ROS", - "RU-RYA", - "RU-SA", - "RU-SAK", - "RU-SAM", - "RU-SPE", - "RU-SAR", - "RU-SE", - "RU-SMO", - "RU-STA", - "RU-SVE", - "RU-TAM", - "RU-TA", - "RU-TOM", - "RU-TUL", - "RU-TVE", - "RU-TYU", - "RU-TY", - "RU-UD", - "RU-ULY", - "RU-VLA", - "RU-VGG", - "RU-VLG", - "RU-VOR", - "RU-YAN", - "RU-YAR", - "RU-YEV", - "RU-ZAB", - "RW-02", - "RW-03", - "RW-04", - "RW-05", - "RW-01", - "SA-14", - "SA-11", - "SA-08", - "SA-12", - "SA-03", - "SA-05", - "SA-01", - "SA-04", - "SA-06", - "SA-09", - "SA-02", - "SA-10", - "SA-07", - "SB-CH", - "SB-GU", - "SB-WE", - "SC-02", - "SC-05", - "SC-01", - "SC-06", - "SC-07", - "SC-08", - "SC-10", - "SC-11", - "SC-16", - "SC-13", - "SC-14", - "SC-15", - "SC-20", - "SC-23", - "SD-NB", - "SD-DC", - "SD-GD", - "SD-GZ", - "SD-KA", - "SD-KH", - "SD-DN", - "SD-KN", - "SD-NO", - "SD-RS", - "SD-NR", - "SD-SI", - "SD-DS", - "SD-KS", - "SD-DW", - "SD-GK", - "SD-NW", - "SE-K", - "SE-W", - "SE-X", - "SE-I", - "SE-N", - "SE-Z", - "SE-F", - "SE-H", - "SE-G", - "SE-BD", - "SE-T", - "SE-E", - "SE-M", - "SE-D", - "SE-AB", - "SE-C", - "SE-S", - "SE-AC", - "SE-Y", - "SE-U", - "SE-O", - "SG-XX-1", - "SH-HL", - "SI-001", - "SI-213", - "SI-195", - "SI-002", - "SI-148", - "SI-149", - "SI-003", - "SI-150", - "SI-004", - "SI-005", - "SI-006", - "SI-151", - "SI-007", - "SI-009", - "SI-008", - "SI-152", - "SI-011", - "SI-012", - "SI-013", - "SI-014", - "SI-196", - "SI-015", - "SI-017", - "SI-018", - "SI-019", - "SI-154", - "SI-020", - "SI-155", - "SI-021", - "SI-156", - "SI-023", - "SI-024", - "SI-025", - "SI-026", - "SI-207", - "SI-029", - "SI-031", - "SI-158", - "SI-032", - "SI-159", - "SI-160", - "SI-161", - "SI-162", - "SI-034", - "SI-035", - "SI-036", - "SI-037", - "SI-038", - "SI-039", - "SI-040", - "SI-041", - "SI-042", - "SI-043", - "SI-044", - "SI-045", - "SI-046", - "SI-047", - "SI-048", - "SI-049", - "SI-164", - "SI-050", - "SI-197", - "SI-165", - "SI-052", - "SI-053", - "SI-166", - "SI-054", - "SI-055", - "SI-056", - "SI-057", - "SI-058", - "SI-059", - "SI-060", - "SI-061", - "SI-063", - "SI-208", - "SI-064", - "SI-065", - "SI-066", - "SI-167", - "SI-067", - "SI-068", - "SI-069", - "SI-198", - "SI-070", - "SI-168", - "SI-071", - "SI-072", - "SI-073", - "SI-074", - "SI-169", - "SI-075", - "SI-212", - "SI-170", - "SI-076", - "SI-199", - "SI-077", - "SI-079", - "SI-080", - "SI-081", - "SI-082", - "SI-083", - "SI-084", - "SI-085", - "SI-086", - "SI-171", - "SI-087", - "SI-090", - "SI-091", - "SI-092", - "SI-172", - "SI-200", - "SI-173", - "SI-094", - "SI-174", - "SI-095", - "SI-175", - "SI-096", - "SI-097", - "SI-098", - "SI-099", - "SI-100", - "SI-101", - "SI-102", - "SI-103", - "SI-176", - "SI-209", - "SI-201", - "SI-104", - "SI-106", - "SI-105", - "SI-108", - "SI-033", - "SI-109", - "SI-183", - "SI-117", - "SI-118", - "SI-119", - "SI-120", - "SI-211", - "SI-110", - "SI-111", - "SI-121", - "SI-122", - "SI-123", - "SI-112", - "SI-113", - "SI-114", - "SI-124", - "SI-206", - "SI-125", - "SI-194", - "SI-179", - "SI-180", - "SI-126", - "SI-115", - "SI-127", - "SI-203", - "SI-204", - "SI-182", - "SI-116", - "SI-210", - "SI-205", - "SI-184", - "SI-010", - "SI-128", - "SI-129", - "SI-130", - "SI-185", - "SI-131", - "SI-186", - "SI-132", - "SI-133", - "SI-187", - "SI-134", - "SI-188", - "SI-135", - "SI-136", - "SI-137", - "SI-138", - "SI-139", - "SI-189", - "SI-140", - "SI-141", - "SI-142", - "SI-190", - "SI-143", - "SI-146", - "SI-191", - "SI-147", - "SI-144", - "SI-193", - "SJ-XX-1", - "SK-BC", - "SK-BL", - "SK-KI", - "SK-NI", - "SK-PV", - "SK-TC", - "SK-TA", - "SK-ZI", - "SL-E", - "SL-N", - "SL-S", - "SL-W", - "SM-07", - "SM-03", - "SM-04", - "SM-09", - "SN-DK", - "SN-DB", - "SN-FK", - "SN-KA", - "SN-KL", - "SN-KE", - "SN-KD", - "SN-LG", - "SN-MT", - "SN-SL", - "SN-SE", - "SN-TC", - "SN-TH", - "SN-ZG", - "SO-AW", - "SO-BN", - "SO-BR", - "SO-GA", - "SO-JH", - "SO-MU", - "SO-NU", - "SO-SH", - "SO-TO", - "SO-WO", - "SR-BR", - "SR-CM", - "SR-NI", - "SR-PR", - "SR-PM", - "SR-SI", - "SR-WA", - "SS-EC", - "SS-EE", - "SS-JG", - "SS-LK", - "SS-BN", - "SS-NU", - "SS-EW", - "ST-01", - "SV-AH", - "SV-CA", - "SV-CH", - "SV-CU", - "SV-LI", - "SV-PA", - "SV-UN", - "SV-MO", - "SV-SM", - "SV-SS", - "SV-SV", - "SV-SA", - "SV-SO", - "SV-US", - "SX-XX-1", - "SY-HA", - "SY-LA", - "SY-QU", - "SY-RA", - "SY-SU", - "SY-DR", - "SY-DY", - "SY-DI", - "SY-HL", - "SY-HM", - "SY-HI", - "SY-ID", - "SY-RD", - "SY-TA", - "SZ-HH", - "SZ-LU", - "SZ-MA", - "TC-XX-1", - "TD-BG", - "TD-CB", - "TD-GR", - "TD-LO", - "TD-ME", - "TD-OD", - "TD-ND", - "TF-XX-1", - "TG-C", - "TG-K", - "TG-M", - "TG-P", - "TH-37", - "TH-15", - "TH-38", - "TH-31", - "TH-24", - "TH-18", - "TH-36", - "TH-22", - "TH-50", - "TH-57", - "TH-20", - "TH-86", - "TH-46", - "TH-62", - "TH-71", - "TH-40", - "TH-81", - "TH-10", - "TH-52", - "TH-51", - "TH-42", - "TH-16", - "TH-58", - "TH-44", - "TH-49", - "TH-26", - "TH-73", - "TH-48", - "TH-30", - "TH-60", - "TH-80", - "TH-55", - "TH-96", - "TH-39", - "TH-43", - "TH-12", - "TH-13", - "TH-94", - "TH-82", - "TH-93", - "TH-56", - "TH-67", - "TH-76", - "TH-66", - "TH-65", - "TH-14", - "TH-54", - "TH-83", - "TH-25", - "TH-77", - "TH-85", - "TH-70", - "TH-21", - "TH-45", - "TH-27", - "TH-47", - "TH-11", - "TH-74", - "TH-75", - "TH-19", - "TH-91", - "TH-33", - "TH-17", - "TH-90", - "TH-64", - "TH-72", - "TH-84", - "TH-32", - "TH-63", - "TH-92", - "TH-23", - "TH-34", - "TH-41", - "TH-61", - "TH-53", - "TH-95", - "TH-35", - "TJ-DU", - "TJ-KT", - "TJ-RA", - "TJ-SU", - "TK-XX-1", - "TL-AN", - "TL-BO", - "TL-CO", - "TL-DI", - "TL-LI", - "TM-A", - "TM-B", - "TM-D", - "TM-L", - "TM-M", - "TN-31", - "TN-13", - "TN-23", - "TN-81", - "TN-71", - "TN-32", - "TN-41", - "TN-42", - "TN-73", - "TN-12", - "TN-14", - "TN-33", - "TN-53", - "TN-82", - "TN-52", - "TN-21", - "TN-61", - "TN-43", - "TN-34", - "TN-51", - "TN-83", - "TN-72", - "TN-11", - "TN-22", - "TO-02", - "TO-03", - "TO-04", - "TR-01", - "TR-02", - "TR-03", - "TR-04", - "TR-68", - "TR-05", - "TR-06", - "TR-07", - "TR-75", - "TR-08", - "TR-09", - "TR-10", - "TR-74", - "TR-72", - "TR-69", - "TR-11", - "TR-12", - "TR-13", - "TR-14", - "TR-15", - "TR-16", - "TR-17", - "TR-18", - "TR-19", - "TR-20", - "TR-21", - "TR-81", - "TR-22", - "TR-23", - "TR-24", - "TR-25", - "TR-26", - "TR-27", - "TR-28", - "TR-29", - "TR-30", - "TR-31", - "TR-76", - "TR-32", - "TR-34", - "TR-35", - "TR-46", - "TR-78", - "TR-70", - "TR-36", - "TR-37", - "TR-38", - "TR-79", - "TR-71", - "TR-39", - "TR-40", - "TR-41", - "TR-42", - "TR-43", - "TR-44", - "TR-45", - "TR-47", - "TR-33", - "TR-48", - "TR-49", - "TR-50", - "TR-51", - "TR-52", - "TR-80", - "TR-53", - "TR-54", - "TR-55", - "TR-63", - "TR-56", - "TR-57", - "TR-73", - "TR-58", - "TR-59", - "TR-60", - "TR-61", - "TR-62", - "TR-64", - "TR-65", - "TR-77", - "TR-66", - "TR-67", - "TT-ARI", - "TT-CHA", - "TT-CTT", - "TT-DMN", - "TT-MRC", - "TT-PED", - "TT-PTF", - "TT-POS", - "TT-PRT", - "TT-SFO", - "TT-SJL", - "TT-SGE", - "TT-SIP", - "TT-TOB", - "TT-TUP", - "TV-FUN", - "TW-CHA", - "TW-CYQ", - "TW-HSQ", - "TW-HUA", - "TW-KHH", - "TW-KEE", - "TW-KIN", - "TW-LIE", - "TW-MIA", - "TW-NAN", - "TW-NWT", - "TW-PEN", - "TW-PIF", - "TW-TXG", - "TW-TNN", - "TW-TPE", - "TW-TTT", - "TW-TAO", - "TW-ILA", - "TW-YUN", - "TZ-01", - "TZ-02", - "TZ-03", - "TZ-27", - "TZ-04", - "TZ-05", - "TZ-06", - "TZ-07", - "TZ-28", - "TZ-08", - "TZ-09", - "TZ-11", - "TZ-12", - "TZ-26", - "TZ-13", - "TZ-14", - "TZ-15", - "TZ-16", - "TZ-17", - "TZ-18", - "TZ-29", - "TZ-19", - "TZ-20", - "TZ-21", - "TZ-22", - "TZ-30", - "TZ-23", - "TZ-31", - "TZ-24", - "TZ-25", - "UA-43", - "UA-71", - "UA-74", - "UA-77", - "UA-12", - "UA-14", - "UA-26", - "UA-63", - "UA-65", - "UA-68", - "UA-35", - "UA-30", - "UA-32", - "UA-09", - "UA-46", - "UA-48", - "UA-51", - "UA-53", - "UA-56", - "UA-40", - "UA-59", - "UA-61", - "UA-05", - "UA-07", - "UA-21", - "UA-23", - "UA-18", - "UG-314", - "UG-301", - "UG-322", - "UG-323", - "UG-315", - "UG-324", - "UG-216", - "UG-316", - "UG-302", - "UG-303", - "UG-217", - "UG-218", - "UG-201", - "UG-420", - "UG-117", - "UG-219", - "UG-118", - "UG-220", - "UG-225", - "UG-401", - "UG-402", - "UG-202", - "UG-221", - "UG-120", - "UG-226", - "UG-317", - "UG-121", - "UG-304", - "UG-403", - "UG-417", - "UG-203", - "UG-418", - "UG-204", - "UG-318", - "UG-404", - "UG-405", - "UG-213", - "UG-101", - "UG-222", - "UG-122", - "UG-102", - "UG-205", - "UG-413", - "UG-206", - "UG-406", - "UG-207", - "UG-112", - "UG-407", - "UG-103", - "UG-227", - "UG-419", - "UG-421", - "UG-408", - "UG-305", - "UG-319", - "UG-306", - "UG-208", - "UG-228", - "UG-123", - "UG-422", - "UG-415", - "UG-326", - "UG-307", - "UG-229", - "UG-104", - "UG-124", - "UG-114", - "UG-223", - "UG-105", - "UG-409", - "UG-214", - "UG-209", - "UG-410", - "UG-423", - "UG-115", - "UG-308", - "UG-309", - "UG-106", - "UG-107", - "UG-108", - "UG-311", - "UG-116", - "UG-109", - "UG-230", - "UG-224", - "UG-327", - "UG-310", - "UG-231", - "UG-411", - "UG-328", - "UG-321", - "UG-312", - "UG-210", - "UG-110", - "UG-425", - "UG-412", - "UG-111", - "UG-232", - "UG-426", - "UG-215", - "UG-211", - "UG-212", - "UG-113", - "UG-313", - "UG-330", - "UM-95", - "US-AL", - "US-AK", - "US-AZ", - "US-AR", - "US-CA", - "US-CO", - "US-CT", - "US-DE", - "US-DC", - "US-FL", - "US-GA", - "US-HI", - "US-ID", - "US-IL", - "US-IN", - "US-IA", - "US-KS", - "US-KY", - "US-LA", - "US-ME", - "US-MD", - "US-MA", - "US-MI", - "US-MN", - "US-MS", - "US-MO", - "US-MT", - "US-NE", - "US-NV", - "US-NH", - "US-NJ", - "US-NM", - "US-NY", - "US-NC", - "US-ND", - "US-OH", - "US-OK", - "US-OR", - "US-PA", - "US-RI", - "US-SC", - "US-SD", - "US-TN", - "US-TX", - "US-UT", - "US-VT", - "US-VA", - "US-WA", - "US-WV", - "US-WI", - "US-WY", - "UY-AR", - "UY-CA", - "UY-CL", - "UY-CO", - "UY-DU", - "UY-FS", - "UY-FD", - "UY-LA", - "UY-MA", - "UY-MO", - "UY-PA", - "UY-RN", - "UY-RV", - "UY-RO", - "UY-SA", - "UY-SJ", - "UY-SO", - "UY-TA", - "UY-TT", - "UZ-AN", - "UZ-BU", - "UZ-FA", - "UZ-JI", - "UZ-NG", - "UZ-NW", - "UZ-QA", - "UZ-QR", - "UZ-SA", - "UZ-SI", - "UZ-SU", - "UZ-TK", - "UZ-XO", - "VA-XX-1", - "VC-01", - "VC-06", - "VC-04", - "VC-05", - "VE-Z", - "VE-B", - "VE-C", - "VE-D", - "VE-E", - "VE-F", - "VE-G", - "VE-H", - "VE-Y", - "VE-A", - "VE-I", - "VE-J", - "VE-X", - "VE-K", - "VE-L", - "VE-M", - "VE-N", - "VE-O", - "VE-P", - "VE-R", - "VE-S", - "VE-T", - "VE-U", - "VE-V", - "VG-XX-1", - "VI-XX-1", - "VN-44", - "VN-43", - "VN-54", - "VN-53", - "VN-55", - "VN-56", - "VN-50", - "VN-31", - "VN-57", - "VN-58", - "VN-40", - "VN-59", - "VN-CT", - "VN-04", - "VN-DN", - "VN-33", - "VN-72", - "VN-71", - "VN-39", - "VN-45", - "VN-30", - "VN-03", - "VN-63", - "VN-HN", - "VN-23", - "VN-61", - "VN-HP", - "VN-73", - "VN-SG", - "VN-14", - "VN-66", - "VN-34", - "VN-47", - "VN-28", - "VN-01", - "VN-35", - "VN-09", - "VN-02", - "VN-41", - "VN-67", - "VN-22", - "VN-18", - "VN-36", - "VN-68", - "VN-32", - "VN-24", - "VN-27", - "VN-29", - "VN-13", - "VN-25", - "VN-52", - "VN-05", - "VN-37", - "VN-20", - "VN-69", - "VN-21", - "VN-26", - "VN-46", - "VN-51", - "VN-07", - "VN-49", - "VN-70", - "VN-06", - "VU-SEE", - "VU-TAE", - "VU-TOB", - "WF-SG", - "WF-UV", - "WS-AT", - "WS-FA", - "WS-TU", - "YE-AD", - "YE-AM", - "YE-AB", - "YE-DA", - "YE-BA", - "YE-HU", - "YE-SA", - "YE-DH", - "YE-HD", - "YE-HJ", - "YE-IB", - "YE-LA", - "YE-MA", - "YE-SD", - "YE-SN", - "YE-SH", - "YE-TA", - "YT-XX-1", - "YT-XX-2", - "YT-XX-3", - "YT-XX-4", - "YT-XX-5", - "YT-XX-6", - "ZA-EC", - "ZA-FS", - "ZA-GP", - "ZA-KZN", - "ZA-LP", - "ZA-MP", - "ZA-NW", - "ZA-NC", - "ZA-WC", - "ZM-02", - "ZM-08", - "ZM-03", - "ZM-04", - "ZM-09", - "ZM-10", - "ZM-06", - "ZM-05", - "ZM-07", - "ZM-01", - "ZW-BU", - "ZW-HA", - "ZW-MA", - "ZW-MC", - "ZW-ME", - "ZW-MW", - "ZW-MV", - "ZW-MN", - "ZW-MS", - "ZW-MI", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "street_1": { - "description": "The first line of the address", - "example": "Water Lane", - "nullable": true, - "type": "string", - }, - "street_2": { - "description": "The second line of the address", - "example": "Woolsthorpe by Colsterworth", - "nullable": true, - "type": "string", - }, - "zip_code": { - "description": "The ZIP code/Postal code of the location", - "example": "NG33 5NR", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "work_phone_number": { - "description": "The employee work phone number", - "example": "+1234567890", - "nullable": true, - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_create_employee_employment": { - "description": "Create Employee Employment", - "execute": { - "bodyType": "json", - "method": "POST", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "body", - "name": "id", - "type": "string", - }, - { - "location": "body", - "name": "unified_custom_fields", - "type": "object", - }, - { - "location": "body", - "name": "employee_id", - "type": "string", - }, - { - "location": "body", - "name": "job_title", - "type": "string", - }, - { - "location": "body", - "name": "pay_rate", - "type": "string", - }, - { - "location": "body", - "name": "pay_period", - "type": "object", - }, - { - "location": "body", - "name": "pay_frequency", - "type": "object", - }, - { - "location": "body", - "name": "pay_currency", - "type": "string", - }, - { - "location": "body", - "name": "effective_date", - "type": "string", - }, - { - "location": "body", - "name": "employment_type", - "type": "object", - }, - { - "location": "body", - "name": "employment_contract_type", - "type": "object", - }, - { - "location": "body", - "name": "time_worked", - "type": "string", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/employments", - }, - "name": "hris_create_employee_employment", - "parameters": { - "properties": { - "effective_date": { - "description": "The effective date of the employment contract", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - "employee_id": { - "description": "The employee ID associated with this employment", - "example": "1687-3", - "nullable": true, - "type": "string", - }, - "employment_contract_type": { - "description": "The employment work schedule type (e.g., full-time, part-time)", - "example": "full_time", - "nullable": true, - "properties": { - "value": { - "enum": [ - "full_time", - "shifts", - "part_time", - "unmapped_value", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "employment_type": { - "description": "The type of employment (e.g., contractor, permanent)", - "example": "permanent", - "nullable": true, - "properties": { - "value": { - "enum": [ - "contractor", - "intern", - "permanent", - "apprentice", - "freelance", - "terminated", - "temporary", - "seasonal", - "volunteer", - "probation", - "internal", - "external", - "expatriate", - "employer_of_record", - "casual", - "Programme", - "unmapped_value", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string", - }, - "job_title": { - "description": "The job title of the employee", - "example": "Software Engineer", - "nullable": true, - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "nullable": true, - "type": "object", - }, - "pay_currency": { - "description": "The currency used for pay", - "example": "USD", - "nullable": true, - "type": "string", - }, - "pay_frequency": { - "description": "The pay frequency", - "example": "hourly", - "nullable": true, - "properties": { - "value": { - "enum": [ - "hourly", - "weekly", - "bi_weekly", - "four_weekly", - "semi_monthly", - "monthly", - "bi_monthly", - "quarterly", - "semi_annually", - "yearly", - "thirteen_monthly", - "pro_rata", - "unmapped_value", - "half_yearly", - "daily", - "fixed", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "pay_period": { - "description": "The pay period", - "example": "monthly", - "nullable": true, - "properties": { - "value": { - "enum": [ - "hour", - "day", - "week", - "every_two_weeks", - "month", - "quarter", - "every_six_months", - "year", - "unmapped_value", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "pay_rate": { - "description": "The pay rate for the employee", - "example": "40.00", - "nullable": true, - "type": "string", - }, - "time_worked": { - "description": "The time worked for the employee in ISO 8601 duration format", - "example": "P0Y0M0DT8H0M0S", - "format": "duration", - "nullable": true, - "type": "string", - }, - "unified_custom_fields": { - "additionalProperties": true, - "description": "Custom Unified Fields configured in your StackOne project", - "example": { - "my_project_custom_field_1": "REF-1236", - "my_project_custom_field_2": "some other value", - }, - "nullable": true, - "type": "object", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_create_employee_skill": { - "description": "Create Employee Skill", - "execute": { - "bodyType": "json", - "method": "POST", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "body", - "name": "id", - "type": "string", - }, - { - "location": "body", - "name": "name", - "type": "string", - }, - { - "location": "body", - "name": "maximum_proficiency", - "type": "object", - }, - { - "location": "body", - "name": "minimum_proficiency", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/skills", - }, - "name": "hris_create_employee_skill", - "parameters": { - "properties": { - "id": { - "description": "The ID associated with this skill", - "example": "16873-IT345", - "nullable": true, - "type": "string", - }, - "maximum_proficiency": { - "description": "The proficiency level of the skill", - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string", - }, - "name": { - "description": "The name associated with this proficiency", - "example": "Expert", - "nullable": true, - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string", - }, - "value": { - "enum": [ - "1", - "2", - "3", - "4", - "5", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "minimum_proficiency": { - "description": "The proficiency level of the skill", - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string", - }, - "name": { - "description": "The name associated with this proficiency", - "example": "Expert", - "nullable": true, - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string", - }, - "value": { - "enum": [ - "1", - "2", - "3", - "4", - "5", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "name": { - "description": "The name associated with this skill", - "example": "Information-Technology", - "nullable": true, - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_create_employee_time_off_request": { - "description": "Create Employee Time Off Request", - "execute": { - "bodyType": "json", - "method": "POST", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "body", - "name": "employee_id", - "type": "string", - }, - { - "location": "body", - "name": "approver_id", - "type": "string", - }, - { - "location": "body", - "name": "status", - "type": "object", - }, - { - "location": "body", - "name": "type", - "type": "object", - }, - { - "location": "body", - "name": "start_date", - "type": "string", - }, - { - "location": "body", - "name": "end_date", - "type": "string", - }, - { - "location": "body", - "name": "start_half_day", - "type": "string", - }, - { - "location": "body", - "name": "end_half_day", - "type": "string", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off", - }, - "name": "hris_create_employee_time_off_request", - "parameters": { - "properties": { - "approver_id": { - "description": "The approver ID", - "example": "1687-4", - "nullable": true, - "type": "string", - }, - "employee_id": { - "description": "The employee ID", - "example": "1687-3", - "nullable": true, - "type": "string", - }, - "end_date": { - "description": "The end date of the time off request", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - "end_half_day": { - "description": "True if the end of the time off request ends half way through the day", - "example": true, - "nullable": true, - "oneOf": [ - { - "type": "boolean", - }, - { - "enum": [ - "true", - "false", - ], - "type": "string", - }, - ], - }, - "id": { - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "nullable": true, - "type": "object", - }, - "start_date": { - "description": "The start date of the time off request", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - "start_half_day": { - "description": "True if the start of the time off request begins half way through the day", - "example": true, - "nullable": true, - "oneOf": [ - { - "type": "boolean", - }, - { - "enum": [ - "true", - "false", - ], - "type": "string", - }, - ], - }, - "status": { - "description": "The status of the time off request", - "nullable": true, - "properties": { - "value": { - "enum": [ - "approved", - "cancelled", - "rejected", - "pending", - "unmapped_value", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "type": { - "description": "The type of the time off request", - "nullable": true, - "properties": { - "value": { - "enum": [ - "sick", - "unmapped_value", - "vacation", - "long_term_disability", - "short_term_disability", - "absent", - "comp_time", - "training", - "annual_leave", - "leave_of_absence", - "break", - "child_care_leave", - "maternity_leave", - "jury_duty", - "bereavement_leave", - "sabbatical", - "accident", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_create_employee_work_eligibility_request": { - "description": "Create Employee Work Eligibility Request", - "execute": { - "bodyType": "json", - "method": "POST", - "params": [ - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "body", - "name": "document", - "type": "object", - }, - { - "location": "body", - "name": "issued_by", - "type": "object", - }, - { - "location": "body", - "name": "number", - "type": "string", - }, - { - "location": "body", - "name": "sub_type", - "type": "string", - }, - { - "location": "body", - "name": "type", - "type": "object", - }, - { - "location": "body", - "name": "valid_from", - "type": "string", - }, - { - "location": "body", - "name": "valid_to", - "type": "string", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/work_eligibility", - }, - "name": "hris_create_employee_work_eligibility_request", - "parameters": { - "properties": { - "document": { - "nullable": true, - "properties": { - "category": { - "description": "The category of the file", - "example": "templates, forms, backups, etc.", - "nullable": true, - "properties": { - "value": { - "description": "The category of the file", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "category_id": { - "description": "The categoryId of the documents", - "example": "6530", - "nullable": true, - "type": "string", - }, - "contents": { - "deprecated": true, - "description": "The content of the file. Deprecated, use \`url\` and \`file_format\` one level up instead", - "items": { - "properties": { - "file_format": { - "description": "The file format of the file", - "nullable": true, - "properties": { - "value": { - "description": "The file format of the file, expressed as a file extension", - "enum": [ - "unmapped_value", - "ez", - "aw", - "atom", - "atomcat", - "atomdeleted", - "atomsvc", - "dwd", - "held", - "rsat", - "bdoc", - "xcs", - "ccxml", - "cdfx", - "cdmia", - "cdmic", - "cdmid", - "cdmio", - "cdmiq", - "cu", - "mpd", - "davmount", - "dbk", - "dssc", - "xdssc", - "es", - "ecma", - "emma", - "emotionml", - "epub", - "exi", - "exp", - "fdt", - "pfr", - "geojson", - "gml", - "gpx", - "gxf", - "gz", - "hjson", - "stk", - "ink", - "inkml", - "ipfix", - "its", - "jar", - "war", - "ear", - "ser", - "class", - "js", - "mjs", - "json", - "map", - "json5", - "jsonml", - "jsonld", - "lgr", - "lostxml", - "hqx", - "cpt", - "mads", - "webmanifest", - "mrc", - "mrcx", - "ma", - "nb", - "mb", - "mathml", - "mbox", - "mscml", - "metalink", - "meta4", - "mets", - "maei", - "musd", - "mods", - "m21", - "mp21", - "mp4s", - "m4p", - "doc", - "dot", - "mxf", - "nq", - "nt", - "cjs", - "bin", - "dms", - "lrf", - "mar", - "so", - "dist", - "distz", - "pkg", - "bpk", - "dump", - "elc", - "deploy", - "exe", - "dll", - "deb", - "dmg", - "iso", - "img", - "msi", - "msp", - "msm", - "buffer", - "oda", - "opf", - "ogx", - "omdoc", - "onetoc", - "onetoc2", - "onetmp", - "onepkg", - "oxps", - "relo", - "xer", - "pdf", - "pgp", - "asc", - "sig", - "prf", - "p10", - "p7m", - "p7c", - "p7s", - "p8", - "ac", - "cer", - "crl", - "pkipath", - "pki", - "pls", - "ai", - "eps", - "ps", - "provx", - "pskcxml", - "raml", - "rdf", - "owl", - "rif", - "rnc", - "rl", - "rld", - "rs", - "rapd", - "sls", - "rusd", - "gbr", - "mft", - "roa", - "rsd", - "rss", - "rtf", - "sbml", - "scq", - "scs", - "spq", - "spp", - "sdp", - "senmlx", - "sensmlx", - "setpay", - "setreg", - "shf", - "siv", - "sieve", - "smi", - "smil", - "rq", - "srx", - "gram", - "grxml", - "sru", - "ssdl", - "ssml", - "swidtag", - "tei", - "teicorpus", - "tfi", - "tsd", - "toml", - "trig", - "ttml", - "ubj", - "rsheet", - "td", - "vxml", - "wasm", - "wgt", - "hlp", - "wsdl", - "wspolicy", - "xaml", - "xav", - "xca", - "xdf", - "xel", - "xns", - "xenc", - "xhtml", - "xht", - "xlf", - "xml", - "xsl", - "xsd", - "rng", - "dtd", - "xop", - "xpl", - "*xsl", - "xslt", - "xspf", - "mxml", - "xhvml", - "xvml", - "xvm", - "yang", - "yin", - "zip", - "*3gpp", - "adp", - "amr", - "au", - "snd", - "mid", - "midi", - "kar", - "rmi", - "mxmf", - "*mp3", - "m4a", - "mp4a", - "mpga", - "mp2", - "mp2a", - "mp3", - "m2a", - "m3a", - "oga", - "ogg", - "spx", - "opus", - "s3m", - "sil", - "wav", - "*wav", - "weba", - "xm", - "ttc", - "otf", - "ttf", - "woff", - "woff2", - "exr", - "apng", - "avif", - "bmp", - "cgm", - "drle", - "emf", - "fits", - "g3", - "gif", - "heic", - "heics", - "heif", - "heifs", - "hej2", - "hsj2", - "ief", - "jls", - "jp2", - "jpg2", - "jpeg", - "jpg", - "jpe", - "jph", - "jhc", - "jpm", - "jpx", - "jpf", - "jxr", - "jxra", - "jxrs", - "jxs", - "jxsc", - "jxsi", - "jxss", - "ktx", - "ktx2", - "png", - "sgi", - "svg", - "svgz", - "t38", - "tif", - "tiff", - "tfx", - "webp", - "wmf", - "disposition-notification", - "u8msg", - "u8dsn", - "u8mdn", - "u8hdr", - "eml", - "mime", - "3mf", - "gltf", - "glb", - "igs", - "iges", - "msh", - "mesh", - "silo", - "mtl", - "obj", - "stpx", - "stpz", - "stpxz", - "stl", - "wrl", - "vrml", - "*x3db", - "x3dbz", - "x3db", - "*x3dv", - "x3dvz", - "x3d", - "x3dz", - "x3dv", - "appcache", - "manifest", - "ics", - "ifb", - "coffee", - "litcoffee", - "css", - "csv", - "html", - "htm", - "shtml", - "jade", - "jsx", - "less", - "markdown", - "md", - "mml", - "mdx", - "n3", - "txt", - "text", - "conf", - "def", - "list", - "log", - "in", - "ini", - "rtx", - "*rtf", - "sgml", - "sgm", - "shex", - "slim", - "slm", - "spdx", - "stylus", - "styl", - "tsv", - "t", - "tr", - "roff", - "man", - "me", - "ms", - "ttl", - "uri", - "uris", - "urls", - "vcard", - "vtt", - "*xml", - "yaml", - "yml", - "3gp", - "3gpp", - "3g2", - "h261", - "h263", - "h264", - "m4s", - "jpgv", - "*jpm", - "jpgm", - "mj2", - "mjp2", - "ts", - "mp4", - "mp4v", - "mpg4", - "mpeg", - "mpg", - "mpe", - "m1v", - "m2v", - "ogv", - "qt", - "mov", - "webm", - "cww", - "1km", - "plb", - "psb", - "pvb", - "tcap", - "pwn", - "aso", - "imp", - "acu", - "atc", - "acutc", - "air", - "fcdt", - "fxp", - "fxpl", - "xdp", - "xfdf", - "ahead", - "azf", - "azs", - "azw", - "acc", - "ami", - "apk", - "cii", - "fti", - "atx", - "mpkg", - "key", - "m3u8", - "numbers", - "pages", - "pkpass", - "swi", - "iota", - "aep", - "bmml", - "mpm", - "bmi", - "rep", - "cdxml", - "mmd", - "cdy", - "csl", - "cla", - "rp9", - "c4g", - "c4d", - "c4f", - "c4p", - "c4u", - "c11amc", - "c11amz", - "csp", - "cdbcmsg", - "cmc", - "clkx", - "clkk", - "clkp", - "clkt", - "clkw", - "wbs", - "pml", - "ppd", - "car", - "pcurl", - "dart", - "rdz", - "dbf", - "uvf", - "uvvf", - "uvd", - "uvvd", - "uvt", - "uvvt", - "uvx", - "uvvx", - "uvz", - "uvvz", - "fe_launch", - "dna", - "mlp", - "mle", - "dpg", - "dfac", - "kpxx", - "ait", - "svc", - "geo", - "mag", - "nml", - "esf", - "msf", - "qam", - "slt", - "ssf", - "es3", - "et3", - "ez2", - "ez3", - "fdf", - "mseed", - "seed", - "dataless", - "gph", - "ftc", - "fm", - "frame", - "maker", - "book", - "fnc", - "ltf", - "fsc", - "oas", - "oa2", - "oa3", - "fg5", - "bh2", - "ddd", - "xdw", - "xbd", - "fzs", - "txd", - "ggb", - "ggt", - "gex", - "gre", - "gxt", - "g2w", - "g3w", - "gmx", - "gdoc", - "gslides", - "gsheet", - "kml", - "kmz", - "gqf", - "gqs", - "gac", - "ghf", - "gim", - "grv", - "gtm", - "tpl", - "vcg", - "hal", - "zmm", - "hbci", - "les", - "hpgl", - "hpid", - "hps", - "jlt", - "pcl", - "pclxl", - "sfd-hdstx", - "mpy", - "afp", - "listafp", - "list3820", - "irm", - "sc", - "icc", - "icm", - "igl", - "ivp", - "ivu", - "igm", - "xpw", - "xpx", - "i2g", - "qbo", - "qfx", - "rcprofile", - "irp", - "xpr", - "fcs", - "jam", - "rms", - "jisp", - "joda", - "ktz", - "ktr", - "karbon", - "chrt", - "kfo", - "flw", - "kon", - "kpr", - "kpt", - "ksp", - "kwd", - "kwt", - "htke", - "kia", - "kne", - "knp", - "skp", - "skd", - "skt", - "skm", - "sse", - "lasxml", - "lbd", - "lbe", - "apr", - "pre", - "nsf", - "org", - "scm", - "lwp", - "portpkg", - "mvt", - "mcd", - "mc1", - "cdkey", - "mwf", - "mfm", - "flo", - "igx", - "mif", - "daf", - "dis", - "mbk", - "mqy", - "msl", - "plc", - "txf", - "mpn", - "mpc", - "xul", - "cil", - "cab", - "xls", - "xlm", - "xla", - "xlc", - "xlt", - "xlw", - "xlam", - "xlsb", - "xlsm", - "xltm", - "eot", - "chm", - "ims", - "lrm", - "thmx", - "msg", - "cat", - "*stl", - "ppt", - "pps", - "pot", - "ppam", - "pptm", - "sldm", - "ppsm", - "potm", - "mpp", - "mpt", - "docm", - "dotm", - "wps", - "wks", - "wcm", - "wdb", - "wpl", - "xps", - "mseq", - "mus", - "msty", - "taglet", - "nlu", - "ntf", - "nitf", - "nnd", - "nns", - "nnw", - "*ac", - "ngdat", - "n-gage", - "rpst", - "rpss", - "edm", - "edx", - "ext", - "odc", - "otc", - "odb", - "odf", - "odft", - "odg", - "otg", - "odi", - "oti", - "odp", - "otp", - "ods", - "ots", - "odt", - "odm", - "ott", - "oth", - "xo", - "dd2", - "obgx", - "oxt", - "osm", - "pptx", - "sldx", - "ppsx", - "potx", - "xlsx", - "xltx", - "docx", - "dotx", - "mgp", - "dp", - "esa", - "pdb", - "pqa", - "oprc", - "paw", - "str", - "ei6", - "efif", - "wg", - "plf", - "pbd", - "box", - "mgz", - "qps", - "ptid", - "qxd", - "qxt", - "qwd", - "qwt", - "qxl", - "qxb", - "rar", - "bed", - "mxl", - "musicxml", - "cryptonote", - "cod", - "rm", - "rmvb", - "link66", - "st", - "see", - "sema", - "semd", - "semf", - "ifm", - "itp", - "iif", - "ipk", - "twd", - "twds", - "mmf", - "teacher", - "fo", - "sdkm", - "sdkd", - "dxp", - "sfs", - "sdc", - "sda", - "sdd", - "smf", - "sdw", - "vor", - "sgl", - "smzip", - "sm", - "wadl", - "sxc", - "stc", - "sxd", - "std", - "sxi", - "sti", - "sxm", - "sxw", - "sxg", - "stw", - "sus", - "susp", - "svd", - "sis", - "sisx", - "xsm", - "bdm", - "xdm", - "ddf", - "tao", - "pcap", - "cap", - "dmp", - "tmo", - "tpt", - "mxs", - "tra", - "ufd", - "ufdl", - "utz", - "umj", - "unityweb", - "uoml", - "vcx", - "vsd", - "vst", - "vss", - "vsw", - "vis", - "vsf", - "wbxml", - "wmlc", - "wmlsc", - "wtb", - "nbp", - "wpd", - "wqd", - "stf", - "xar", - "xfdl", - "hvd", - "hvs", - "hvp", - "osf", - "osfpvg", - "saf", - "spf", - "cmp", - "zir", - "zirz", - "zaz", - "7z", - "abw", - "ace", - "*dmg", - "arj", - "aab", - "x32", - "u32", - "vox", - "aam", - "aas", - "bcpio", - "*bdoc", - "torrent", - "blb", - "blorb", - "bz", - "bz2", - "boz", - "cbr", - "cba", - "cbt", - "cbz", - "cb7", - "vcd", - "cfs", - "chat", - "pgn", - "crx", - "cco", - "nsc", - "cpio", - "csh", - "*deb", - "udeb", - "dgc", - "dir", - "dcr", - "dxr", - "cst", - "cct", - "cxt", - "w3d", - "fgd", - "swa", - "wad", - "ncx", - "dtb", - "res", - "dvi", - "evy", - "eva", - "bdf", - "gsf", - "psf", - "pcf", - "snf", - "pfa", - "pfb", - "pfm", - "afm", - "arc", - "spl", - "gca", - "ulx", - "gnumeric", - "gramps", - "gtar", - "hdf", - "php", - "install", - "*iso", - "*key", - "*numbers", - "*pages", - "jardiff", - "jnlp", - "kdbx", - "latex", - "luac", - "lzh", - "lha", - "run", - "mie", - "prc", - "mobi", - "application", - "lnk", - "wmd", - "wmz", - "xbap", - "mdb", - "obd", - "crd", - "clp", - "*exe", - "*dll", - "com", - "bat", - "*msi", - "mvb", - "m13", - "m14", - "*wmf", - "*wmz", - "*emf", - "emz", - "mny", - "pub", - "scd", - "trm", - "wri", - "nc", - "cdf", - "pac", - "nzb", - "pl", - "pm", - "*prc", - "*pdb", - "p12", - "pfx", - "p7b", - "spc", - "p7r", - "*rar", - "rpm", - "ris", - "sea", - "sh", - "shar", - "swf", - "xap", - "sql", - "sit", - "sitx", - "srt", - "sv4cpio", - "sv4crc", - "t3", - "gam", - "tar", - "tcl", - "tk", - "tex", - "tfm", - "texinfo", - "texi", - "*obj", - "ustar", - "hdd", - "ova", - "ovf", - "vbox", - "vbox-extpack", - "vdi", - "vhd", - "vmdk", - "src", - "webapp", - "der", - "crt", - "pem", - "fig", - "*xlf", - "xpi", - "xz", - "z1", - "z2", - "z3", - "z4", - "z5", - "z6", - "z7", - "z8", - "uva", - "uvva", - "eol", - "dra", - "dts", - "dtshd", - "lvp", - "pya", - "ecelp4800", - "ecelp7470", - "ecelp9600", - "rip", - "aac", - "aif", - "aiff", - "aifc", - "caf", - "flac", - "*m4a", - "mka", - "m3u", - "wax", - "wma", - "ram", - "ra", - "rmp", - "*ra", - "cdx", - "cif", - "cmdf", - "cml", - "csml", - "xyz", - "btif", - "pti", - "psd", - "azv", - "uvi", - "uvvi", - "uvg", - "uvvg", - "djvu", - "djv", - "*sub", - "dwg", - "dxf", - "fbs", - "fpx", - "fst", - "mmr", - "rlc", - "ico", - "dds", - "mdi", - "wdp", - "npx", - "b16", - "tap", - "vtf", - "wbmp", - "xif", - "pcx", - "3ds", - "ras", - "cmx", - "fh", - "fhc", - "fh4", - "fh5", - "fh7", - "*ico", - "jng", - "sid", - "*bmp", - "*pcx", - "pic", - "pct", - "pnm", - "pbm", - "pgm", - "ppm", - "rgb", - "tga", - "xbm", - "xpm", - "xwd", - "wsc", - "dae", - "dwf", - "gdl", - "gtw", - "mts", - "ogex", - "x_b", - "x_t", - "vds", - "usdz", - "bsp", - "vtu", - "dsc", - "curl", - "dcurl", - "mcurl", - "scurl", - "sub", - "fly", - "flx", - "gv", - "3dml", - "spot", - "jad", - "wml", - "wmls", - "s", - "asm", - "c", - "cc", - "cxx", - "cpp", - "h", - "hh", - "dic", - "htc", - "f", - "for", - "f77", - "f90", - "hbs", - "java", - "lua", - "mkd", - "nfo", - "opml", - "*org", - "p", - "pas", - "pde", - "sass", - "scss", - "etx", - "sfv", - "ymp", - "uu", - "vcs", - "vcf", - "uvh", - "uvvh", - "uvm", - "uvvm", - "uvp", - "uvvp", - "uvs", - "uvvs", - "uvv", - "uvvv", - "dvb", - "fvt", - "mxu", - "m4u", - "pyv", - "uvu", - "uvvu", - "viv", - "f4v", - "fli", - "flv", - "m4v", - "mkv", - "mk3d", - "mks", - "mng", - "asf", - "asx", - "vob", - "wm", - "wmv", - "wmx", - "wvx", - "avi", - "movie", - "smv", - "ice", - "mht", - null, - ], - "example": "pdf", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "unified_url": { - "description": "Unified download URL for retrieving file content.", - "example": "https://api.stackone.com/unified/hris/employees/12345/documents/67890/download", - "nullable": true, - "type": "string", - }, - "url": { - "description": "URL where the file content is located", - "example": "https://example.com/file.pdf", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "nullable": true, - "type": "array", - }, - "created_at": { - "description": "The creation date of the file", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - "file_format": { - "description": "The file format of the file", - "nullable": true, - "properties": { - "value": { - "description": "The file format of the file, expressed as a file extension", - "enum": [ - "unmapped_value", - "ez", - "aw", - "atom", - "atomcat", - "atomdeleted", - "atomsvc", - "dwd", - "held", - "rsat", - "bdoc", - "xcs", - "ccxml", - "cdfx", - "cdmia", - "cdmic", - "cdmid", - "cdmio", - "cdmiq", - "cu", - "mpd", - "davmount", - "dbk", - "dssc", - "xdssc", - "es", - "ecma", - "emma", - "emotionml", - "epub", - "exi", - "exp", - "fdt", - "pfr", - "geojson", - "gml", - "gpx", - "gxf", - "gz", - "hjson", - "stk", - "ink", - "inkml", - "ipfix", - "its", - "jar", - "war", - "ear", - "ser", - "class", - "js", - "mjs", - "json", - "map", - "json5", - "jsonml", - "jsonld", - "lgr", - "lostxml", - "hqx", - "cpt", - "mads", - "webmanifest", - "mrc", - "mrcx", - "ma", - "nb", - "mb", - "mathml", - "mbox", - "mscml", - "metalink", - "meta4", - "mets", - "maei", - "musd", - "mods", - "m21", - "mp21", - "mp4s", - "m4p", - "doc", - "dot", - "mxf", - "nq", - "nt", - "cjs", - "bin", - "dms", - "lrf", - "mar", - "so", - "dist", - "distz", - "pkg", - "bpk", - "dump", - "elc", - "deploy", - "exe", - "dll", - "deb", - "dmg", - "iso", - "img", - "msi", - "msp", - "msm", - "buffer", - "oda", - "opf", - "ogx", - "omdoc", - "onetoc", - "onetoc2", - "onetmp", - "onepkg", - "oxps", - "relo", - "xer", - "pdf", - "pgp", - "asc", - "sig", - "prf", - "p10", - "p7m", - "p7c", - "p7s", - "p8", - "ac", - "cer", - "crl", - "pkipath", - "pki", - "pls", - "ai", - "eps", - "ps", - "provx", - "pskcxml", - "raml", - "rdf", - "owl", - "rif", - "rnc", - "rl", - "rld", - "rs", - "rapd", - "sls", - "rusd", - "gbr", - "mft", - "roa", - "rsd", - "rss", - "rtf", - "sbml", - "scq", - "scs", - "spq", - "spp", - "sdp", - "senmlx", - "sensmlx", - "setpay", - "setreg", - "shf", - "siv", - "sieve", - "smi", - "smil", - "rq", - "srx", - "gram", - "grxml", - "sru", - "ssdl", - "ssml", - "swidtag", - "tei", - "teicorpus", - "tfi", - "tsd", - "toml", - "trig", - "ttml", - "ubj", - "rsheet", - "td", - "vxml", - "wasm", - "wgt", - "hlp", - "wsdl", - "wspolicy", - "xaml", - "xav", - "xca", - "xdf", - "xel", - "xns", - "xenc", - "xhtml", - "xht", - "xlf", - "xml", - "xsl", - "xsd", - "rng", - "dtd", - "xop", - "xpl", - "*xsl", - "xslt", - "xspf", - "mxml", - "xhvml", - "xvml", - "xvm", - "yang", - "yin", - "zip", - "*3gpp", - "adp", - "amr", - "au", - "snd", - "mid", - "midi", - "kar", - "rmi", - "mxmf", - "*mp3", - "m4a", - "mp4a", - "mpga", - "mp2", - "mp2a", - "mp3", - "m2a", - "m3a", - "oga", - "ogg", - "spx", - "opus", - "s3m", - "sil", - "wav", - "*wav", - "weba", - "xm", - "ttc", - "otf", - "ttf", - "woff", - "woff2", - "exr", - "apng", - "avif", - "bmp", - "cgm", - "drle", - "emf", - "fits", - "g3", - "gif", - "heic", - "heics", - "heif", - "heifs", - "hej2", - "hsj2", - "ief", - "jls", - "jp2", - "jpg2", - "jpeg", - "jpg", - "jpe", - "jph", - "jhc", - "jpm", - "jpx", - "jpf", - "jxr", - "jxra", - "jxrs", - "jxs", - "jxsc", - "jxsi", - "jxss", - "ktx", - "ktx2", - "png", - "sgi", - "svg", - "svgz", - "t38", - "tif", - "tiff", - "tfx", - "webp", - "wmf", - "disposition-notification", - "u8msg", - "u8dsn", - "u8mdn", - "u8hdr", - "eml", - "mime", - "3mf", - "gltf", - "glb", - "igs", - "iges", - "msh", - "mesh", - "silo", - "mtl", - "obj", - "stpx", - "stpz", - "stpxz", - "stl", - "wrl", - "vrml", - "*x3db", - "x3dbz", - "x3db", - "*x3dv", - "x3dvz", - "x3d", - "x3dz", - "x3dv", - "appcache", - "manifest", - "ics", - "ifb", - "coffee", - "litcoffee", - "css", - "csv", - "html", - "htm", - "shtml", - "jade", - "jsx", - "less", - "markdown", - "md", - "mml", - "mdx", - "n3", - "txt", - "text", - "conf", - "def", - "list", - "log", - "in", - "ini", - "rtx", - "*rtf", - "sgml", - "sgm", - "shex", - "slim", - "slm", - "spdx", - "stylus", - "styl", - "tsv", - "t", - "tr", - "roff", - "man", - "me", - "ms", - "ttl", - "uri", - "uris", - "urls", - "vcard", - "vtt", - "*xml", - "yaml", - "yml", - "3gp", - "3gpp", - "3g2", - "h261", - "h263", - "h264", - "m4s", - "jpgv", - "*jpm", - "jpgm", - "mj2", - "mjp2", - "ts", - "mp4", - "mp4v", - "mpg4", - "mpeg", - "mpg", - "mpe", - "m1v", - "m2v", - "ogv", - "qt", - "mov", - "webm", - "cww", - "1km", - "plb", - "psb", - "pvb", - "tcap", - "pwn", - "aso", - "imp", - "acu", - "atc", - "acutc", - "air", - "fcdt", - "fxp", - "fxpl", - "xdp", - "xfdf", - "ahead", - "azf", - "azs", - "azw", - "acc", - "ami", - "apk", - "cii", - "fti", - "atx", - "mpkg", - "key", - "m3u8", - "numbers", - "pages", - "pkpass", - "swi", - "iota", - "aep", - "bmml", - "mpm", - "bmi", - "rep", - "cdxml", - "mmd", - "cdy", - "csl", - "cla", - "rp9", - "c4g", - "c4d", - "c4f", - "c4p", - "c4u", - "c11amc", - "c11amz", - "csp", - "cdbcmsg", - "cmc", - "clkx", - "clkk", - "clkp", - "clkt", - "clkw", - "wbs", - "pml", - "ppd", - "car", - "pcurl", - "dart", - "rdz", - "dbf", - "uvf", - "uvvf", - "uvd", - "uvvd", - "uvt", - "uvvt", - "uvx", - "uvvx", - "uvz", - "uvvz", - "fe_launch", - "dna", - "mlp", - "mle", - "dpg", - "dfac", - "kpxx", - "ait", - "svc", - "geo", - "mag", - "nml", - "esf", - "msf", - "qam", - "slt", - "ssf", - "es3", - "et3", - "ez2", - "ez3", - "fdf", - "mseed", - "seed", - "dataless", - "gph", - "ftc", - "fm", - "frame", - "maker", - "book", - "fnc", - "ltf", - "fsc", - "oas", - "oa2", - "oa3", - "fg5", - "bh2", - "ddd", - "xdw", - "xbd", - "fzs", - "txd", - "ggb", - "ggt", - "gex", - "gre", - "gxt", - "g2w", - "g3w", - "gmx", - "gdoc", - "gslides", - "gsheet", - "kml", - "kmz", - "gqf", - "gqs", - "gac", - "ghf", - "gim", - "grv", - "gtm", - "tpl", - "vcg", - "hal", - "zmm", - "hbci", - "les", - "hpgl", - "hpid", - "hps", - "jlt", - "pcl", - "pclxl", - "sfd-hdstx", - "mpy", - "afp", - "listafp", - "list3820", - "irm", - "sc", - "icc", - "icm", - "igl", - "ivp", - "ivu", - "igm", - "xpw", - "xpx", - "i2g", - "qbo", - "qfx", - "rcprofile", - "irp", - "xpr", - "fcs", - "jam", - "rms", - "jisp", - "joda", - "ktz", - "ktr", - "karbon", - "chrt", - "kfo", - "flw", - "kon", - "kpr", - "kpt", - "ksp", - "kwd", - "kwt", - "htke", - "kia", - "kne", - "knp", - "skp", - "skd", - "skt", - "skm", - "sse", - "lasxml", - "lbd", - "lbe", - "apr", - "pre", - "nsf", - "org", - "scm", - "lwp", - "portpkg", - "mvt", - "mcd", - "mc1", - "cdkey", - "mwf", - "mfm", - "flo", - "igx", - "mif", - "daf", - "dis", - "mbk", - "mqy", - "msl", - "plc", - "txf", - "mpn", - "mpc", - "xul", - "cil", - "cab", - "xls", - "xlm", - "xla", - "xlc", - "xlt", - "xlw", - "xlam", - "xlsb", - "xlsm", - "xltm", - "eot", - "chm", - "ims", - "lrm", - "thmx", - "msg", - "cat", - "*stl", - "ppt", - "pps", - "pot", - "ppam", - "pptm", - "sldm", - "ppsm", - "potm", - "mpp", - "mpt", - "docm", - "dotm", - "wps", - "wks", - "wcm", - "wdb", - "wpl", - "xps", - "mseq", - "mus", - "msty", - "taglet", - "nlu", - "ntf", - "nitf", - "nnd", - "nns", - "nnw", - "*ac", - "ngdat", - "n-gage", - "rpst", - "rpss", - "edm", - "edx", - "ext", - "odc", - "otc", - "odb", - "odf", - "odft", - "odg", - "otg", - "odi", - "oti", - "odp", - "otp", - "ods", - "ots", - "odt", - "odm", - "ott", - "oth", - "xo", - "dd2", - "obgx", - "oxt", - "osm", - "pptx", - "sldx", - "ppsx", - "potx", - "xlsx", - "xltx", - "docx", - "dotx", - "mgp", - "dp", - "esa", - "pdb", - "pqa", - "oprc", - "paw", - "str", - "ei6", - "efif", - "wg", - "plf", - "pbd", - "box", - "mgz", - "qps", - "ptid", - "qxd", - "qxt", - "qwd", - "qwt", - "qxl", - "qxb", - "rar", - "bed", - "mxl", - "musicxml", - "cryptonote", - "cod", - "rm", - "rmvb", - "link66", - "st", - "see", - "sema", - "semd", - "semf", - "ifm", - "itp", - "iif", - "ipk", - "twd", - "twds", - "mmf", - "teacher", - "fo", - "sdkm", - "sdkd", - "dxp", - "sfs", - "sdc", - "sda", - "sdd", - "smf", - "sdw", - "vor", - "sgl", - "smzip", - "sm", - "wadl", - "sxc", - "stc", - "sxd", - "std", - "sxi", - "sti", - "sxm", - "sxw", - "sxg", - "stw", - "sus", - "susp", - "svd", - "sis", - "sisx", - "xsm", - "bdm", - "xdm", - "ddf", - "tao", - "pcap", - "cap", - "dmp", - "tmo", - "tpt", - "mxs", - "tra", - "ufd", - "ufdl", - "utz", - "umj", - "unityweb", - "uoml", - "vcx", - "vsd", - "vst", - "vss", - "vsw", - "vis", - "vsf", - "wbxml", - "wmlc", - "wmlsc", - "wtb", - "nbp", - "wpd", - "wqd", - "stf", - "xar", - "xfdl", - "hvd", - "hvs", - "hvp", - "osf", - "osfpvg", - "saf", - "spf", - "cmp", - "zir", - "zirz", - "zaz", - "7z", - "abw", - "ace", - "*dmg", - "arj", - "aab", - "x32", - "u32", - "vox", - "aam", - "aas", - "bcpio", - "*bdoc", - "torrent", - "blb", - "blorb", - "bz", - "bz2", - "boz", - "cbr", - "cba", - "cbt", - "cbz", - "cb7", - "vcd", - "cfs", - "chat", - "pgn", - "crx", - "cco", - "nsc", - "cpio", - "csh", - "*deb", - "udeb", - "dgc", - "dir", - "dcr", - "dxr", - "cst", - "cct", - "cxt", - "w3d", - "fgd", - "swa", - "wad", - "ncx", - "dtb", - "res", - "dvi", - "evy", - "eva", - "bdf", - "gsf", - "psf", - "pcf", - "snf", - "pfa", - "pfb", - "pfm", - "afm", - "arc", - "spl", - "gca", - "ulx", - "gnumeric", - "gramps", - "gtar", - "hdf", - "php", - "install", - "*iso", - "*key", - "*numbers", - "*pages", - "jardiff", - "jnlp", - "kdbx", - "latex", - "luac", - "lzh", - "lha", - "run", - "mie", - "prc", - "mobi", - "application", - "lnk", - "wmd", - "wmz", - "xbap", - "mdb", - "obd", - "crd", - "clp", - "*exe", - "*dll", - "com", - "bat", - "*msi", - "mvb", - "m13", - "m14", - "*wmf", - "*wmz", - "*emf", - "emz", - "mny", - "pub", - "scd", - "trm", - "wri", - "nc", - "cdf", - "pac", - "nzb", - "pl", - "pm", - "*prc", - "*pdb", - "p12", - "pfx", - "p7b", - "spc", - "p7r", - "*rar", - "rpm", - "ris", - "sea", - "sh", - "shar", - "swf", - "xap", - "sql", - "sit", - "sitx", - "srt", - "sv4cpio", - "sv4crc", - "t3", - "gam", - "tar", - "tcl", - "tk", - "tex", - "tfm", - "texinfo", - "texi", - "*obj", - "ustar", - "hdd", - "ova", - "ovf", - "vbox", - "vbox-extpack", - "vdi", - "vhd", - "vmdk", - "src", - "webapp", - "der", - "crt", - "pem", - "fig", - "*xlf", - "xpi", - "xz", - "z1", - "z2", - "z3", - "z4", - "z5", - "z6", - "z7", - "z8", - "uva", - "uvva", - "eol", - "dra", - "dts", - "dtshd", - "lvp", - "pya", - "ecelp4800", - "ecelp7470", - "ecelp9600", - "rip", - "aac", - "aif", - "aiff", - "aifc", - "caf", - "flac", - "*m4a", - "mka", - "m3u", - "wax", - "wma", - "ram", - "ra", - "rmp", - "*ra", - "cdx", - "cif", - "cmdf", - "cml", - "csml", - "xyz", - "btif", - "pti", - "psd", - "azv", - "uvi", - "uvvi", - "uvg", - "uvvg", - "djvu", - "djv", - "*sub", - "dwg", - "dxf", - "fbs", - "fpx", - "fst", - "mmr", - "rlc", - "ico", - "dds", - "mdi", - "wdp", - "npx", - "b16", - "tap", - "vtf", - "wbmp", - "xif", - "pcx", - "3ds", - "ras", - "cmx", - "fh", - "fhc", - "fh4", - "fh5", - "fh7", - "*ico", - "jng", - "sid", - "*bmp", - "*pcx", - "pic", - "pct", - "pnm", - "pbm", - "pgm", - "ppm", - "rgb", - "tga", - "xbm", - "xpm", - "xwd", - "wsc", - "dae", - "dwf", - "gdl", - "gtw", - "mts", - "ogex", - "x_b", - "x_t", - "vds", - "usdz", - "bsp", - "vtu", - "dsc", - "curl", - "dcurl", - "mcurl", - "scurl", - "sub", - "fly", - "flx", - "gv", - "3dml", - "spot", - "jad", - "wml", - "wmls", - "s", - "asm", - "c", - "cc", - "cxx", - "cpp", - "h", - "hh", - "dic", - "htc", - "f", - "for", - "f77", - "f90", - "hbs", - "java", - "lua", - "mkd", - "nfo", - "opml", - "*org", - "p", - "pas", - "pde", - "sass", - "scss", - "etx", - "sfv", - "ymp", - "uu", - "vcs", - "vcf", - "uvh", - "uvvh", - "uvm", - "uvvm", - "uvp", - "uvvp", - "uvs", - "uvvs", - "uvv", - "uvvv", - "dvb", - "fvt", - "mxu", - "m4u", - "pyv", - "uvu", - "uvvu", - "viv", - "f4v", - "fli", - "flv", - "m4v", - "mkv", - "mk3d", - "mks", - "mng", - "asf", - "asx", - "vob", - "wm", - "wmv", - "wmx", - "wvx", - "avi", - "movie", - "smv", - "ice", - "mht", - null, - ], - "example": "pdf", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string", - }, - "name": { - "description": "The name of the file", - "example": "My Document", - "nullable": true, - "type": "string", - }, - "path": { - "description": "The path where the file is stored", - "example": "/path/to/file", - "nullable": true, - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string", - }, - "remote_url": { - "description": "URL where the file content is located", - "example": "https://example.com/file.pdf", - "nullable": true, - "type": "string", - }, - "updated_at": { - "description": "The update date of the file", - "example": "2021-01-02T01:01:01.000Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "issued_by": { - "description": "The country code of the issued by authority", - "nullable": true, - "properties": { - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "number": { - "example": "1234567890", - "nullable": true, - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "nullable": true, - "type": "object", - }, - "sub_type": { - "example": "H1B", - "nullable": true, - "type": "string", - }, - "type": { - "example": "visa", - "nullable": true, - "properties": { - "value": { - "enum": [ - "visa", - "passport", - "driver_license", - "birth_certificate", - "other", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "valid_from": { - "example": "2021-01-01T00:00.000Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - "valid_to": { - "example": "2021-01-01T00:00.000Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_create_time_off_request": { - "description": "Creates a time off request", - "execute": { - "bodyType": "json", - "method": "POST", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "body", - "name": "employee_id", - "type": "string", - }, - { - "location": "body", - "name": "approver_id", - "type": "string", - }, - { - "location": "body", - "name": "status", - "type": "object", - }, - { - "location": "body", - "name": "type", - "type": "object", - }, - { - "location": "body", - "name": "start_date", - "type": "string", - }, - { - "location": "body", - "name": "end_date", - "type": "string", - }, - { - "location": "body", - "name": "start_half_day", - "type": "string", - }, - { - "location": "body", - "name": "end_half_day", - "type": "string", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_off", - }, - "name": "hris_create_time_off_request", - "parameters": { - "properties": { - "approver_id": { - "description": "The approver ID", - "example": "1687-4", - "nullable": true, - "type": "string", - }, - "employee_id": { - "description": "The employee ID", - "example": "1687-3", - "nullable": true, - "type": "string", - }, - "end_date": { - "description": "The end date of the time off request", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - "end_half_day": { - "description": "True if the end of the time off request ends half way through the day", - "example": true, - "nullable": true, - "oneOf": [ - { - "type": "boolean", - }, - { - "enum": [ - "true", - "false", - ], - "type": "string", - }, - ], - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "nullable": true, - "type": "object", - }, - "start_date": { - "description": "The start date of the time off request", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - "start_half_day": { - "description": "True if the start of the time off request begins half way through the day", - "example": true, - "nullable": true, - "oneOf": [ - { - "type": "boolean", - }, - { - "enum": [ - "true", - "false", - ], - "type": "string", - }, - ], - }, - "status": { - "description": "The status of the time off request", - "nullable": true, - "properties": { - "value": { - "enum": [ - "approved", - "cancelled", - "rejected", - "pending", - "unmapped_value", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "type": { - "description": "The type of the time off request", - "nullable": true, - "properties": { - "value": { - "enum": [ - "sick", - "unmapped_value", - "vacation", - "long_term_disability", - "short_term_disability", - "absent", - "comp_time", - "training", - "annual_leave", - "leave_of_absence", - "break", - "child_care_leave", - "maternity_leave", - "jury_duty", - "bereavement_leave", - "sabbatical", - "accident", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_download_employee_document": { - "description": "Download Employee Document", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "format", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/documents/{subResourceId}/download", - }, - "name": "hris_download_employee_document", - "parameters": { - "properties": { - "format": { - "description": "The format to download the file in", - "example": "base64", - "nullable": true, - "type": "string", - }, - "id": { - "type": "string", - }, - "subResourceId": { - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - }, - "hris_get_benefit": { - "description": "Get Benefit", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/benefits/{id}", - }, - "name": "hris_get_benefit", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,benefit_type,provider,description,created_at,updated_at", - "nullable": true, - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_company": { - "description": "Get Company", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/companies/{id}", - }, - "name": "hris_get_company", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,full_name,display_name,created_at,updated_at", - "nullable": true, - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_cost_center_group": { - "description": "Get Cost Center Group", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/cost_centers/{id}", - }, - "name": "hris_get_cost_center_group", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,distribution_percentage,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids", - "nullable": true, - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_department_group": { - "description": "Get Department Group", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/departments/{id}", - }, - "name": "hris_get_department_group", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name", - "nullable": true, - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_employee": { - "description": "Get Employee", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - { - "location": "query", - "name": "include", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}", - }, - "name": "hris_get_employee", - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "company,employments,work_location,home_location,groups,skills", - "nullable": true, - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,first_name,last_name,name,display_name,gender,ethnicity,date_of_birth,birthday,marital_status,avatar_url,avatar,personal_email,personal_phone_number,work_email,work_phone_number,job_id,remote_job_id,job_title,job_description,department_id,remote_department_id,department,cost_centers,benefits,company,manager_id,remote_manager_id,hire_date,start_date,tenure,work_anniversary,employment_type,employment_contract_type,employment_status,termination_date,company_name,company_id,remote_company_id,preferred_language,citizenships,home_location,work_location,employments,custom_fields,documents,created_at,updated_at,employee_number,national_identity_number,national_identity_numbers", - "nullable": true, - "type": "string", - }, - "id": { - "type": "string", - }, - "include": { - "description": "The comma separated list of fields that will be included in the response", - "example": "avatar_url,avatar,custom_fields,job_description,benefits", - "nullable": true, - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_employee_custom_field_definition": { - "description": "Get employee Custom Field Definition", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page", - "type": "string", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "updated_after", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/custom_field_definitions/employees/{id}", - }, - "name": "hris_get_employee_custom_field_definition", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,description,type,options", - "nullable": true, - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "next": { - "description": "The unified cursor", - "nullable": true, - "type": "string", - }, - "page": { - "description": "The page number of the results to fetch", - "nullable": true, - "type": "string", - }, - "page_size": { - "default": "25", - "description": "The number of results per page", - "nullable": true, - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "updated_after": { - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_employee_document": { - "description": "Get Employee Document", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/documents/{subResourceId}", - }, - "name": "hris_get_employee_document", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,path,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format", - "nullable": true, - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "subResourceId": { - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - }, - "hris_get_employee_document_category": { - "description": "Get Employee Document Category", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/documents/employee_categories/{id}", - }, - "name": "hris_get_employee_document_category", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,active", - "nullable": true, - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_employee_employment": { - "description": "Get Employee Employment", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/employments/{subResourceId}", - }, - "name": "hris_get_employee_employment", - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "groups", - "nullable": true, - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,job_title,pay_rate,pay_period,pay_frequency,pay_currency,effective_date,employment_type,employment_contract_type,time_worked,created_at,updated_at,start_date,end_date,active,department,team,cost_center,cost_centers,division,job,type,contract_type,manager", - "nullable": true, - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "subResourceId": { - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - }, - "hris_get_employee_skill": { - "description": "Get Employee Skill", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/skills/{subResourceId}", - }, - "name": "hris_get_employee_skill", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,active,language,maximum_proficiency,minimum_proficiency", - "nullable": true, - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "subResourceId": { - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - }, - "hris_get_employee_time_off_balance": { - "description": "Get Employee Time Off Balance", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off_balances/{subResourceId}", - }, - "name": "hris_get_employee_time_off_balance", - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "policy", - "nullable": true, - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,policy_id,remote_policy_id,policy,current_balance,initial_balance,balance_unit,balance_start_date,balance_expiry_date,updated_at", - "nullable": true, - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "subResourceId": { - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - }, - "hris_get_employees_time_off_request": { - "description": "Get Employees Time Off Request", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off/{subResourceId}", - }, - "name": "hris_get_employees_time_off_request", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,duration,created_at,updated_at", - "nullable": true, - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "subResourceId": { - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - }, - "hris_get_employees_work_eligibility": { - "description": "Get Employees Work Eligibility", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/work_eligibility/{subResourceId}", - }, - "name": "hris_get_employees_work_eligibility", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,type,sub_type,document,valid_from,valid_to,issued_by,number", - "nullable": true, - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "subResourceId": { - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - }, - "hris_get_employment": { - "description": "Get Employment", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employments/{id}", - }, - "name": "hris_get_employment", - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "groups", - "nullable": true, - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,job_title,pay_rate,pay_period,pay_frequency,pay_currency,effective_date,employment_type,employment_contract_type,time_worked,created_at,updated_at,start_date,end_date,active,department,team,cost_center,cost_centers,division,job,type,contract_type,manager", - "nullable": true, - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_group": { - "description": "Get Group", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/{id}", - }, - "name": "hris_get_group", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids", - "nullable": true, - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_job": { - "description": "Get Job", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/jobs/{id}", - }, - "name": "hris_get_job", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids", - "nullable": true, - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_location": { - "description": "Get Location", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/locations/{id}", - }, - "name": "hris_get_location", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,name,phone_number,street_1,street_2,city,state,zip_code,country,location_type,created_at,updated_at", - "nullable": true, - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_team_group": { - "description": "Get Team Group", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/teams/{id}", - }, - "name": "hris_get_team_group", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids", - "nullable": true, - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_time_entries": { - "description": "Get Time Entry", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_entries/{id}", - }, - "name": "hris_get_time_entries", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,start_time,end_time,hours_worked,break_duration,labor_type,location,status,created_at,updated_at", - "nullable": true, - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_time_off_policy": { - "description": "Get Time Off Policy", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_off_policies/{id}", - }, - "name": "hris_get_time_off_policy", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,description,type,updated_at,created_at", - "nullable": true, - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_time_off_request": { - "description": "Get time off request", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_off/{id}", - }, - "name": "hris_get_time_off_request", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,duration,created_at,updated_at", - "nullable": true, - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_get_time_off_type": { - "description": "Get time off type", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_off_types/{id}", - }, - "name": "hris_get_time_off_type", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,active", - "nullable": true, - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_invite_employee": { - "description": "Invite Employee", - "execute": { - "bodyType": "json", - "method": "POST", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/invite", - }, - "name": "hris_invite_employee", - "parameters": { - "properties": { - "id": { - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "nullable": true, - "type": "object", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_list_benefits": { - "description": "List benefits", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page", - "type": "string", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "updated_after", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/benefits", - }, - "name": "hris_list_benefits", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,benefit_type,provider,description,created_at,updated_at", - "nullable": true, - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "nullable": true, - "type": "string", - }, - "page": { - "description": "The page number of the results to fetch", - "nullable": true, - "type": "string", - }, - "page_size": { - "default": "25", - "description": "The number of results per page", - "nullable": true, - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "updated_after": { - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_companies": { - "description": "List Companies", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page", - "type": "string", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "updated_after", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/companies", - }, - "name": "hris_list_companies", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,full_name,display_name,created_at,updated_at", - "nullable": true, - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "nullable": true, - "type": "string", - }, - "page": { - "description": "The page number of the results to fetch", - "nullable": true, - "type": "string", - }, - "page_size": { - "default": "25", - "description": "The number of results per page", - "nullable": true, - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "updated_after": { - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_cost_center_groups": { - "description": "List Cost Center Groups", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page", - "type": "string", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "updated_after", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/cost_centers", - }, - "name": "hris_list_cost_center_groups", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,distribution_percentage,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids", - "nullable": true, - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "nullable": true, - "type": "string", - }, - "page": { - "description": "The page number of the results to fetch", - "nullable": true, - "type": "string", - }, - "page_size": { - "default": "25", - "description": "The number of results per page", - "nullable": true, - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "updated_after": { - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_department_groups": { - "description": "List Department Groups", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page", - "type": "string", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "updated_after", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/departments", - }, - "name": "hris_list_department_groups", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name", - "nullable": true, - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "nullable": true, - "type": "string", - }, - "page": { - "description": "The page number of the results to fetch", - "nullable": true, - "type": "string", - }, - "page_size": { - "default": "25", - "description": "The number of results per page", - "nullable": true, - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "updated_after": { - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_employee_categories": { - "description": "List Employee Document Categories", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page", - "type": "string", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "updated_after", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/documents/employee_categories", - }, - "name": "hris_list_employee_categories", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,active", - "nullable": true, - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "nullable": true, - "type": "string", - }, - "page": { - "description": "The page number of the results to fetch", - "nullable": true, - "type": "string", - }, - "page_size": { - "default": "25", - "description": "The number of results per page", - "nullable": true, - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "updated_after": { - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_employee_custom_field_definitions": { - "description": "List employee Custom Field Definitions", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page", - "type": "string", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "updated_after", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/custom_field_definitions/employees", - }, - "name": "hris_list_employee_custom_field_definitions", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,description,type,options", - "nullable": true, - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "nullable": true, - "type": "string", - }, - "page": { - "description": "The page number of the results to fetch", - "nullable": true, - "type": "string", - }, - "page_size": { - "default": "25", - "description": "The number of results per page", - "nullable": true, - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "updated_after": { - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_employee_documents": { - "description": "List Employee Documents", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page", - "type": "string", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "updated_after", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/documents", - }, - "name": "hris_list_employee_documents", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,path,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format", - "nullable": true, - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "next": { - "description": "The unified cursor", - "nullable": true, - "type": "string", - }, - "page": { - "description": "The page number of the results to fetch", - "nullable": true, - "type": "string", - }, - "page_size": { - "default": "25", - "description": "The number of results per page", - "nullable": true, - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "updated_after": { - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_list_employee_employments": { - "description": "List Employee Employments", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page", - "type": "string", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "updated_after", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/employments", - }, - "name": "hris_list_employee_employments", - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "groups", - "nullable": true, - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,job_title,pay_rate,pay_period,pay_frequency,pay_currency,effective_date,employment_type,employment_contract_type,time_worked,created_at,updated_at,start_date,end_date,active,department,team,cost_center,cost_centers,division,job,type,contract_type,manager", - "nullable": true, - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "next": { - "description": "The unified cursor", - "nullable": true, - "type": "string", - }, - "page": { - "description": "The page number of the results to fetch", - "nullable": true, - "type": "string", - }, - "page_size": { - "default": "25", - "description": "The number of results per page", - "nullable": true, - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "updated_after": { - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_list_employee_skills": { - "description": "List Employee Skills", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page", - "type": "string", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "updated_after", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/skills", - }, - "name": "hris_list_employee_skills", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,active,language,maximum_proficiency,minimum_proficiency", - "nullable": true, - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "next": { - "description": "The unified cursor", - "nullable": true, - "type": "string", - }, - "page": { - "description": "The page number of the results to fetch", - "nullable": true, - "type": "string", - }, - "page_size": { - "default": "25", - "description": "The number of results per page", - "nullable": true, - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "updated_after": { - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_list_employee_time_off_balances": { - "description": "List Employee Time Off Balances", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page", - "type": "string", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "updated_after", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off_balances", - }, - "name": "hris_list_employee_time_off_balances", - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "policy", - "nullable": true, - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,policy_id,remote_policy_id,policy,current_balance,initial_balance,balance_unit,balance_start_date,balance_expiry_date,updated_at", - "nullable": true, - "type": "string", - }, - "filter": { - "description": "HRIS Time Off Balance filters", - "nullable": true, - "properties": { - "policy_ids": { - "additionalProperties": false, - "description": "List of policy ids to filter time off balances by.", - "items": { - "type": "string", - }, - "nullable": true, - "required": false, - "type": "array", - }, - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "next": { - "description": "The unified cursor", - "nullable": true, - "type": "string", - }, - "page": { - "description": "The page number of the results to fetch", - "nullable": true, - "type": "string", - }, - "page_size": { - "default": "25", - "description": "The number of results per page", - "nullable": true, - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "updated_after": { - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_list_employee_time_off_requests": { - "description": "List Employee Time Off Requests", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page", - "type": "string", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "updated_after", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off", - }, - "name": "hris_list_employee_time_off_requests", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,duration,created_at,updated_at", - "nullable": true, - "type": "string", - }, - "filter": { - "description": "HRIS Time Off filters", - "nullable": true, - "properties": { - "type_ids": { - "description": "List of time off type ids to filter by.", - "items": { - "type": "string", - }, - "nullable": true, - "type": "array", - }, - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "next": { - "description": "The unified cursor", - "nullable": true, - "type": "string", - }, - "page": { - "description": "The page number of the results to fetch", - "nullable": true, - "type": "string", - }, - "page_size": { - "default": "25", - "description": "The number of results per page", - "nullable": true, - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "updated_after": { - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_list_employee_work_eligibility": { - "description": "List Employee Work Eligibility", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page", - "type": "string", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "updated_after", - "type": "string", - }, - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/work_eligibility", - }, - "name": "hris_list_employee_work_eligibility", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,type,sub_type,document,valid_from,valid_to,issued_by,number", - "nullable": true, - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "next": { - "description": "The unified cursor", - "nullable": true, - "type": "string", - }, - "page": { - "description": "The page number of the results to fetch", - "nullable": true, - "type": "string", - }, - "page_size": { - "default": "25", - "description": "The number of results per page", - "nullable": true, - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "updated_after": { - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_list_employees": { - "description": "List Employees", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page", - "type": "string", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "updated_after", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - { - "location": "query", - "name": "include", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees", - }, - "name": "hris_list_employees", - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "company,employments,work_location,home_location,groups,skills", - "nullable": true, - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,first_name,last_name,name,display_name,gender,ethnicity,date_of_birth,birthday,marital_status,avatar_url,avatar,personal_email,personal_phone_number,work_email,work_phone_number,job_id,remote_job_id,job_title,job_description,department_id,remote_department_id,department,cost_centers,benefits,company,manager_id,remote_manager_id,hire_date,start_date,tenure,work_anniversary,employment_type,employment_contract_type,employment_status,termination_date,company_name,company_id,remote_company_id,preferred_language,citizenships,home_location,work_location,employments,custom_fields,documents,created_at,updated_at,employee_number,national_identity_number,national_identity_numbers", - "nullable": true, - "type": "string", - }, - "filter": { - "description": "HRIS Employees filters", - "nullable": true, - "properties": { - "email": { - "description": "Filter to select employees by email", - "nullable": true, - "type": "string", - }, - "employee_number": { - "description": "Filter to select employees by employee_number", - "nullable": true, - "type": "string", - }, - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "include": { - "description": "The comma separated list of fields that will be included in the response", - "example": "avatar_url,avatar,custom_fields,job_description,benefits", - "nullable": true, - "type": "string", - }, - "next": { - "description": "The unified cursor", - "nullable": true, - "type": "string", - }, - "page": { - "description": "The page number of the results to fetch", - "nullable": true, - "type": "string", - }, - "page_size": { - "default": "25", - "description": "The number of results per page", - "nullable": true, - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "updated_after": { - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_employments": { - "description": "List Employments", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page", - "type": "string", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "updated_after", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employments", - }, - "name": "hris_list_employments", - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "groups", - "nullable": true, - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,job_title,pay_rate,pay_period,pay_frequency,pay_currency,effective_date,employment_type,employment_contract_type,time_worked,created_at,updated_at,start_date,end_date,active,department,team,cost_center,cost_centers,division,job,type,contract_type,manager", - "nullable": true, - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "nullable": true, - "type": "string", - }, - "page": { - "description": "The page number of the results to fetch", - "nullable": true, - "type": "string", - }, - "page_size": { - "default": "25", - "description": "The number of results per page", - "nullable": true, - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "updated_after": { - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_groups": { - "description": "List Groups", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page", - "type": "string", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "updated_after", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups", - }, - "name": "hris_list_groups", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids", - "nullable": true, - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "nullable": true, - "type": "string", - }, - "page": { - "description": "The page number of the results to fetch", - "nullable": true, - "type": "string", - }, - "page_size": { - "default": "25", - "description": "The number of results per page", - "nullable": true, - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "updated_after": { - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_jobs": { - "description": "List Jobs", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page", - "type": "string", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "updated_after", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/jobs", - }, - "name": "hris_list_jobs", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids", - "nullable": true, - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "nullable": true, - "type": "string", - }, - "page": { - "description": "The page number of the results to fetch", - "nullable": true, - "type": "string", - }, - "page_size": { - "default": "25", - "description": "The number of results per page", - "nullable": true, - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "updated_after": { - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_locations": { - "description": "List locations", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page", - "type": "string", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "updated_after", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/locations", - }, - "name": "hris_list_locations", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,name,phone_number,street_1,street_2,city,state,zip_code,country,location_type,created_at,updated_at", - "nullable": true, - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "nullable": true, - "type": "string", - }, - "page": { - "description": "The page number of the results to fetch", - "nullable": true, - "type": "string", - }, - "page_size": { - "default": "25", - "description": "The number of results per page", - "nullable": true, - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "updated_after": { - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_team_groups": { - "description": "List Team Groups", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page", - "type": "string", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "updated_after", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/teams", - }, - "name": "hris_list_team_groups", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids", - "nullable": true, - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "nullable": true, - "type": "string", - }, - "page": { - "description": "The page number of the results to fetch", - "nullable": true, - "type": "string", - }, - "page_size": { - "default": "25", - "description": "The number of results per page", - "nullable": true, - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "updated_after": { - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_time_entries": { - "description": "List Time Entries", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page", - "type": "string", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "updated_after", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_entries", - }, - "name": "hris_list_time_entries", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,start_time,end_time,hours_worked,break_duration,labor_type,location,status,created_at,updated_at", - "nullable": true, - "type": "string", - }, - "filter": { - "description": "HRIS Time Entries filters", - "nullable": true, - "properties": { - "employee_id": { - "additionalProperties": false, - "description": "Filter to select time entries by employee_id", - "nullable": true, - "type": "string", - }, - "end_time": { - "additionalProperties": false, - "description": "Filter to select time entries before a given time", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - "start_time": { - "additionalProperties": false, - "description": "Filter to select time entries after a given time", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "nullable": true, - "type": "string", - }, - "page": { - "description": "The page number of the results to fetch", - "nullable": true, - "type": "string", - }, - "page_size": { - "default": "25", - "description": "The number of results per page", - "nullable": true, - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "updated_after": { - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_time_off_policies": { - "description": "List Time Off Policies", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page", - "type": "string", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "updated_after", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_off_policies", - }, - "name": "hris_list_time_off_policies", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,description,type,updated_at,created_at", - "nullable": true, - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "nullable": true, - "type": "string", - }, - "page": { - "description": "The page number of the results to fetch", - "nullable": true, - "type": "string", - }, - "page_size": { - "default": "25", - "description": "The number of results per page", - "nullable": true, - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "updated_after": { - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_time_off_requests": { - "description": "List time off requests", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page", - "type": "string", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "updated_after", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_off", - }, - "name": "hris_list_time_off_requests", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,duration,created_at,updated_at", - "nullable": true, - "type": "string", - }, - "filter": { - "description": "HRIS Time Off filters", - "nullable": true, - "properties": { - "type_ids": { - "description": "List of time off type ids to filter by.", - "items": { - "type": "string", - }, - "nullable": true, - "type": "array", - }, - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "nullable": true, - "type": "string", - }, - "page": { - "description": "The page number of the results to fetch", - "nullable": true, - "type": "string", - }, - "page_size": { - "default": "25", - "description": "The number of results per page", - "nullable": true, - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "updated_after": { - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_list_time_off_types": { - "description": "List time off types", - "execute": { - "bodyType": "json", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page", - "type": "string", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "updated_after", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_off_types", - }, - "name": "hris_list_time_off_types", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,active", - "nullable": true, - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "nullable": true, - "type": "string", - }, - "page": { - "description": "The page number of the results to fetch", - "nullable": true, - "type": "string", - }, - "page_size": { - "default": "25", - "description": "The number of results per page", - "nullable": true, - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "nullable": true, - "type": "object", - }, - "raw": { - "default": false, - "description": "Indicates that the raw request result is returned", - "nullable": true, - "type": "boolean", - }, - "updated_after": { - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": undefined, - "type": "object", - }, - }, - "hris_update_employee": { - "description": "Updates an employee", - "execute": { - "bodyType": "json", - "method": "PATCH", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "body", - "name": "first_name", - "type": "string", - }, - { - "location": "body", - "name": "last_name", - "type": "string", - }, - { - "location": "body", - "name": "name", - "type": "string", - }, - { - "location": "body", - "name": "display_name", - "type": "string", - }, - { - "location": "body", - "name": "avatar_url", - "type": "string", - }, - { - "location": "body", - "name": "personal_email", - "type": "string", - }, - { - "location": "body", - "name": "personal_phone_number", - "type": "string", - }, - { - "location": "body", - "name": "work_email", - "type": "string", - }, - { - "location": "body", - "name": "work_phone_number", - "type": "string", - }, - { - "location": "body", - "name": "job_id", - "type": "string", - }, - { - "location": "body", - "name": "job_title", - "type": "string", - }, - { - "location": "body", - "name": "department_id", - "type": "string", - }, - { - "location": "body", - "name": "department", - "type": "string", - }, - { - "location": "body", - "name": "manager_id", - "type": "string", - }, - { - "location": "body", - "name": "gender", - "type": "object", - }, - { - "location": "body", - "name": "preferred_language", - "type": "object", - }, - { - "location": "body", - "name": "ethnicity", - "type": "object", - }, - { - "location": "body", - "name": "date_of_birth", - "type": "string", - }, - { - "location": "body", - "name": "birthday", - "type": "string", - }, - { - "location": "body", - "name": "marital_status", - "type": "object", - }, - { - "location": "body", - "name": "avatar", - "type": "object", - }, - { - "location": "body", - "name": "hire_date", - "type": "string", - }, - { - "location": "body", - "name": "start_date", - "type": "string", - }, - { - "location": "body", - "name": "tenure", - "type": "number", - }, - { - "location": "body", - "name": "work_anniversary", - "type": "string", - }, - { - "location": "body", - "name": "employment_type", - "type": "object", - }, - { - "location": "body", - "name": "employment_contract_type", - "type": "object", - }, - { - "location": "body", - "name": "employment_status", - "type": "object", - }, - { - "location": "body", - "name": "termination_date", - "type": "string", - }, - { - "location": "body", - "name": "company_name", - "type": "string", - }, - { - "location": "body", - "name": "company_id", - "type": "string", - }, - { - "location": "body", - "name": "citizenships", - "type": "array", - }, - { - "location": "body", - "name": "custom_fields", - "type": "array", - }, - { - "location": "body", - "name": "benefits", - "type": "array", - }, - { - "location": "body", - "name": "employee_number", - "type": "string", - }, - { - "location": "body", - "name": "national_identity_number", - "type": "object", - }, - { - "location": "body", - "name": "national_identity_numbers", - "type": "array", - }, - { - "location": "body", - "name": "home_location", - "type": "object", - }, - { - "location": "body", - "name": "work_location", - "type": "object", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}", - }, - "name": "hris_update_employee", - "parameters": { - "properties": { - "avatar": { - "description": "The employee avatar", - "example": "https://example.com/avatar.png", - "nullable": true, - "properties": { - "base64": { - "nullable": true, - "type": "string", - }, - "url": { - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "avatar_url": { - "description": "The employee avatar Url", - "example": "https://example.com/avatar.png", - "nullable": true, - "type": "string", - }, - "benefits": { - "description": "Current benefits of the employee", - "items": { - "properties": { - "benefit_type": { - "description": "The type of the benefit", - "nullable": true, - "properties": { - "value": { - "description": "The type of the benefit", - "enum": [ - "retirement_savings", - "health_savings", - "other", - "health_insurance", - "insurance", - "unmapped_value", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "created_at": { - "description": "The date and time the benefit was created", - "example": "2021-01-01T00:00:00Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - "description": { - "description": "The description of the benefit", - "example": "Health insurance for employees", - "nullable": true, - "type": "string", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string", - }, - "name": { - "description": "The name of the benefit", - "example": "Health Insurance", - "nullable": true, - "type": "string", - }, - "provider": { - "description": "The provider of the benefit", - "example": "Aetna", - "nullable": true, - "type": "string", - }, - "updated_at": { - "description": "The date and time the benefit was last updated", - "example": "2021-01-01T00:00:00Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "nullable": true, - "type": "array", - }, - "birthday": { - "description": "The employee birthday", - "example": "2021-01-01T00:00:00Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - "citizenships": { - "description": "The citizenships of the Employee", - "items": { - "properties": { - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "nullable": true, - "type": "array", - }, - "company_id": { - "description": "The employee company id", - "example": "1234567890", - "nullable": true, - "type": "string", - }, - "company_name": { - "deprecated": true, - "description": "The employee company name", - "example": "Example Corp", - "nullable": true, - "type": "string", - }, - "custom_fields": { - "description": "The employee custom fields", - "items": { - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string", - }, - "name": { - "description": "The name of the custom field.", - "example": "Training Completion Status", - "nullable": true, - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string", - }, - "remote_value_id": { - "description": "Provider's unique identifier for the value of the custom field.", - "example": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", - "nullable": true, - "type": "string", - }, - "value": { - "description": "The value associated with the custom field.", - "example": "Completed", - "nullable": true, - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - ], - }, - "value_id": { - "description": "The unique identifier for the value of the custom field.", - "example": "value_456", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "nullable": true, - "type": "array", - }, - "date_of_birth": { - "description": "The employee date_of_birth", - "example": "1990-01-01T00:00.000Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - "department": { - "description": "The employee department", - "example": "Physics", - "nullable": true, - "type": "string", - }, - "department_id": { - "description": "The employee department id", - "example": "3093", - "nullable": true, - "type": "string", - }, - "display_name": { - "description": "The employee display name", - "example": "Sir Issac Newton", - "nullable": true, - "type": "string", - }, - "employee_number": { - "description": "The assigned employee number", - "example": "125", - "nullable": true, - "type": "string", - }, - "employment_contract_type": { - "description": "The employment work schedule type (e.g., full-time, part-time)", - "example": "full_time", - "nullable": true, - "properties": { - "value": { - "enum": [ - "full_time", - "shifts", - "part_time", - "unmapped_value", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "employment_status": { - "description": "The employee employment status", - "example": "active", - "nullable": true, - "properties": { - "value": { - "enum": [ - "active", - "pending", - "terminated", - "leave", - "inactive", - "unknown", - "unmapped_value", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "employment_type": { - "description": "The employee employment type", - "example": "full_time", - "nullable": true, - "properties": { - "value": { - "enum": [ - "contractor", - "intern", - "permanent", - "apprentice", - "freelance", - "terminated", - "temporary", - "seasonal", - "volunteer", - "probation", - "internal", - "external", - "expatriate", - "employer_of_record", - "casual", - "Programme", - "unmapped_value", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "ethnicity": { - "description": "The employee ethnicity", - "example": "white", - "nullable": true, - "properties": { - "value": { - "enum": [ - "white", - "black_or_african_american", - "asian", - "hispanic_or_latino", - "american_indian_or_alaska_native", - "native_hawaiian_or_pacific_islander", - "two_or_more_races", - "not_disclosed", - "other", - "unmapped_value", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "first_name": { - "description": "The employee first name", - "example": "Issac", - "nullable": true, - "type": "string", - }, - "gender": { - "description": "The employee gender", - "example": "male", - "nullable": true, - "properties": { - "value": { - "enum": [ - "male", - "female", - "non_binary", - "other", - "not_disclosed", - "diverse", - "unmapped_value", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "hire_date": { - "description": "The employee hire date", - "example": "2021-01-01T00:00.000Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - "home_location": { - "description": "The employee home location", - "nullable": true, - "properties": { - "city": { - "description": "The city where the location is situated", - "example": "Grantham", - "nullable": true, - "type": "string", - }, - "country": { - "description": "The country code", - "nullable": true, - "properties": { - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string", - }, - "name": { - "description": "The name of the location", - "example": "Woolsthorpe Manor", - "nullable": true, - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "nullable": true, - "type": "object", - }, - "phone_number": { - "description": "The phone number of the location", - "example": "+44 1476 860 364", - "nullable": true, - "type": "string", - }, - "state": { - "description": "The ISO3166-2 sub division where the location is situated", - "example": "GB-LIN", - "nullable": true, - "properties": { - "value": { - "enum": [ - "AD-07", - "AD-02", - "AD-03", - "AD-08", - "AD-04", - "AD-05", - "AD-06", - "AE-AJ", - "AE-AZ", - "AE-FU", - "AE-SH", - "AE-DU", - "AE-RK", - "AE-UQ", - "AF-BDS", - "AF-BDG", - "AF-BGL", - "AF-BAL", - "AF-BAM", - "AF-DAY", - "AF-FRA", - "AF-FYB", - "AF-GHA", - "AF-GHO", - "AF-HEL", - "AF-HER", - "AF-JOW", - "AF-KAB", - "AF-KAN", - "AF-KAP", - "AF-KHO", - "AF-KDZ", - "AF-LAG", - "AF-LOG", - "AF-NAN", - "AF-NIM", - "AF-PIA", - "AF-PAR", - "AF-SAR", - "AF-TAK", - "AF-URU", - "AG-11", - "AG-03", - "AG-04", - "AG-06", - "AG-07", - "AG-08", - "AI-XX-1", - "AL-01", - "AL-09", - "AL-02", - "AL-03", - "AL-04", - "AL-05", - "AL-06", - "AL-07", - "AL-08", - "AL-10", - "AL-11", - "AL-12", - "AM-AG", - "AM-AR", - "AM-AV", - "AM-ER", - "AM-GR", - "AM-KT", - "AM-LO", - "AM-SH", - "AM-SU", - "AM-TV", - "AM-VD", - "AO-BGO", - "AO-BGU", - "AO-BIE", - "AO-CAB", - "AO-CCU", - "AO-CNO", - "AO-CUS", - "AO-CNN", - "AO-HUA", - "AO-HUI", - "AO-LUA", - "AO-LNO", - "AO-LSU", - "AO-MAL", - "AO-MOX", - "AO-NAM", - "AO-UIG", - "AO-ZAI", - "AQ-XX-1", - "AR-B", - "AR-K", - "AR-H", - "AR-U", - "AR-C", - "AR-X", - "AR-W", - "AR-E", - "AR-P", - "AR-Y", - "AR-L", - "AR-F", - "AR-M", - "AR-N", - "AR-Q", - "AR-R", - "AR-A", - "AR-J", - "AR-D", - "AR-Z", - "AR-S", - "AR-G", - "AR-V", - "AR-T", - "AS-XX-1", - "AS-XX-2", - "AT-1", - "AT-2", - "AT-3", - "AT-4", - "AT-5", - "AT-6", - "AT-7", - "AT-8", - "AT-9", - "AU-ACT", - "AU-NSW", - "AU-NT", - "AU-QLD", - "AU-SA", - "AU-TAS", - "AU-VIC", - "AU-WA", - "AW-XX-1", - "AX-XX-1", - "AX-XX-2", - "AX-XX-3", - "AX-XX-4", - "AX-XX-5", - "AX-XX-6", - "AX-XX-7", - "AX-XX-8", - "AZ-ABS", - "AZ-AGC", - "AZ-AGU", - "AZ-AST", - "AZ-BA", - "AZ-BAL", - "AZ-BAR", - "AZ-BEY", - "AZ-BIL", - "AZ-CAL", - "AZ-FUZ", - "AZ-GAD", - "AZ-GA", - "AZ-GOR", - "AZ-GOY", - "AZ-GYG", - "AZ-IMI", - "AZ-ISM", - "AZ-KUR", - "AZ-LA", - "AZ-MAS", - "AZ-MI", - "AZ-NA", - "AZ-NX", - "AZ-NEF", - "AZ-OGU", - "AZ-QAB", - "AZ-QAX", - "AZ-QAZ", - "AZ-QBA", - "AZ-QUS", - "AZ-SAT", - "AZ-SAB", - "AZ-SAK", - "AZ-SAL", - "AZ-SMI", - "AZ-SKR", - "AZ-SMX", - "AZ-SR", - "AZ-SM", - "AZ-TAR", - "AZ-UCA", - "AZ-XAC", - "AZ-XVD", - "AZ-YAR", - "AZ-YEV", - "AZ-ZAQ", - "AZ-ZAR", - "BA-BRC", - "BA-BIH", - "BA-SRP", - "BB-01", - "BB-02", - "BB-03", - "BB-04", - "BB-05", - "BB-07", - "BB-08", - "BB-09", - "BB-10", - "BB-11", - "BD-A", - "BD-B", - "BD-C", - "BD-D", - "BD-E", - "BD-F", - "BD-G", - "BE-VAN", - "BE-WBR", - "BE-BRU", - "BE-WHT", - "BE-WLG", - "BE-VLI", - "BE-WLX", - "BE-WNA", - "BE-VOV", - "BE-VBR", - "BE-VWV", - "BF-BAM", - "BF-BAZ", - "BF-BLG", - "BF-BLK", - "BF-COM", - "BF-GAN", - "BF-GNA", - "BF-GOU", - "BF-HOU", - "BF-IOB", - "BF-KAD", - "BF-KEN", - "BF-KMP", - "BF-KOS", - "BF-KOT", - "BF-KOW", - "BF-LER", - "BF-LOR", - "BF-MOU", - "BF-NAO", - "BF-NAM", - "BF-NAY", - "BF-OUB", - "BF-OUD", - "BF-PAS", - "BF-PON", - "BF-SNG", - "BF-SMT", - "BF-SEN", - "BF-SIS", - "BF-SOM", - "BF-SOR", - "BF-TAP", - "BF-TUI", - "BF-YAT", - "BF-ZIR", - "BF-ZON", - "BF-ZOU", - "BG-01", - "BG-02", - "BG-08", - "BG-07", - "BG-26", - "BG-09", - "BG-10", - "BG-11", - "BG-12", - "BG-13", - "BG-14", - "BG-15", - "BG-16", - "BG-17", - "BG-18", - "BG-27", - "BG-19", - "BG-20", - "BG-21", - "BG-23", - "BG-22", - "BG-24", - "BG-25", - "BG-03", - "BG-04", - "BG-05", - "BG-06", - "BG-28", - "BH-13", - "BH-14", - "BH-15", - "BH-17", - "BI-BM", - "BI-CI", - "BI-GI", - "BI-KR", - "BI-KI", - "BI-MW", - "BI-NG", - "BI-RM", - "BI-RT", - "BI-RY", - "BJ-AK", - "BJ-AQ", - "BJ-BO", - "BJ-CO", - "BJ-DO", - "BJ-LI", - "BJ-MO", - "BJ-OU", - "BJ-PL", - "BJ-ZO", - "BL-XX-1", - "BM-XX-1", - "BM-XX-2", - "BN-BE", - "BN-BM", - "BN-TE", - "BN-TU", - "BO-H", - "BO-C", - "BO-B", - "BO-L", - "BO-O", - "BO-N", - "BO-P", - "BO-S", - "BO-T", - "BQ-BO", - "BQ-SA", - "BQ-SE", - "BR-AC", - "BR-AL", - "BR-AP", - "BR-AM", - "BR-BA", - "BR-CE", - "BR-DF", - "BR-ES", - "BR-GO", - "BR-MA", - "BR-MT", - "BR-MS", - "BR-MG", - "BR-PA", - "BR-PB", - "BR-PR", - "BR-PE", - "BR-PI", - "BR-RN", - "BR-RS", - "BR-RJ", - "BR-RO", - "BR-RR", - "BR-SC", - "BR-SP", - "BR-SE", - "BR-TO", - "BS-BP", - "BS-CO", - "BS-FP", - "BS-EG", - "BS-HI", - "BS-LI", - "BS-NP", - "BS-NO", - "BS-NS", - "BS-NE", - "BS-SE", - "BS-WG", - "BT-33", - "BT-12", - "BT-22", - "BT-GA", - "BT-44", - "BT-42", - "BT-11", - "BT-43", - "BT-23", - "BT-45", - "BT-14", - "BT-31", - "BT-15", - "BT-41", - "BT-32", - "BT-21", - "BT-24", - "BV-XX-1", - "BW-CE", - "BW-CH", - "BW-GH", - "BW-KG", - "BW-KL", - "BW-KW", - "BW-NE", - "BW-NW", - "BW-SE", - "BW-SO", - "BY-BR", - "BY-HO", - "BY-HM", - "BY-HR", - "BY-MA", - "BY-MI", - "BY-VI", - "BZ-BZ", - "BZ-CY", - "BZ-CZL", - "BZ-OW", - "BZ-SC", - "BZ-TOL", - "CA-AB", - "CA-BC", - "CA-MB", - "CA-NB", - "CA-NL", - "CA-NT", - "CA-NS", - "CA-NU", - "CA-ON", - "CA-PE", - "CA-QC", - "CA-SK", - "CA-YT", - "CC-XX-1", - "CD-EQ", - "CD-HK", - "CD-HL", - "CD-IT", - "CD-KC", - "CD-KE", - "CD-KN", - "CD-BC", - "CD-KG", - "CD-KL", - "CD-LU", - "CD-NK", - "CD-SA", - "CD-SK", - "CD-TA", - "CD-TO", - "CD-TU", - "CF-BB", - "CF-BGF", - "CF-KB", - "CF-HM", - "CF-KG", - "CF-NM", - "CF-UK", - "CF-AC", - "CF-OP", - "CF-VK", - "CG-11", - "CG-BZV", - "CG-8", - "CG-9", - "CG-16", - "CG-13", - "CH-AG", - "CH-AR", - "CH-AI", - "CH-BL", - "CH-BS", - "CH-BE", - "CH-FR", - "CH-GE", - "CH-GL", - "CH-GR", - "CH-JU", - "CH-LU", - "CH-NE", - "CH-NW", - "CH-OW", - "CH-SG", - "CH-SH", - "CH-SZ", - "CH-SO", - "CH-TG", - "CH-TI", - "CH-UR", - "CH-VS", - "CH-VD", - "CH-ZG", - "CH-ZH", - "CI-AB", - "CI-BS", - "CI-CM", - "CI-DN", - "CI-GD", - "CI-LC", - "CI-LG", - "CI-MG", - "CI-SM", - "CI-SV", - "CI-VB", - "CI-WR", - "CI-YM", - "CI-ZZ", - "CK-XX-1", - "CL-AI", - "CL-AN", - "CL-AP", - "CL-AT", - "CL-BI", - "CL-CO", - "CL-AR", - "CL-LI", - "CL-LL", - "CL-LR", - "CL-MA", - "CL-ML", - "CL-NB", - "CL-RM", - "CL-TA", - "CL-VS", - "CM-AD", - "CM-CE", - "CM-ES", - "CM-EN", - "CM-LT", - "CM-NO", - "CM-NW", - "CM-OU", - "CM-SU", - "CM-SW", - "CN-AH", - "CN-BJ", - "CN-CQ", - "CN-FJ", - "CN-GS", - "CN-GD", - "CN-GX", - "CN-GZ", - "CN-HI", - "CN-HE", - "CN-HL", - "CN-HA", - "CN-HB", - "CN-HN", - "CN-JS", - "CN-JX", - "CN-JL", - "CN-LN", - "CN-NM", - "CN-NX", - "CN-QH", - "CN-SN", - "CN-SD", - "CN-SH", - "CN-SX", - "CN-SC", - "CN-TJ", - "CN-XJ", - "CN-XZ", - "CN-YN", - "CN-ZJ", - "CO-AMA", - "CO-ANT", - "CO-ARA", - "CO-ATL", - "CO-BOL", - "CO-BOY", - "CO-CAL", - "CO-CAQ", - "CO-CAS", - "CO-CAU", - "CO-CES", - "CO-CHO", - "CO-COR", - "CO-CUN", - "CO-DC", - "CO-GUA", - "CO-GUV", - "CO-HUI", - "CO-LAG", - "CO-MAG", - "CO-MET", - "CO-NAR", - "CO-NSA", - "CO-PUT", - "CO-QUI", - "CO-RIS", - "CO-SAP", - "CO-SAN", - "CO-SUC", - "CO-TOL", - "CO-VAC", - "CO-VID", - "CR-A", - "CR-C", - "CR-G", - "CR-H", - "CR-L", - "CR-P", - "CR-SJ", - "CU-15", - "CU-09", - "CU-08", - "CU-06", - "CU-12", - "CU-14", - "CU-11", - "CU-03", - "CU-10", - "CU-04", - "CU-16", - "CU-01", - "CU-07", - "CU-13", - "CU-05", - "CV-BV", - "CV-BR", - "CV-MO", - "CV-PN", - "CV-PR", - "CV-RS", - "CV-SL", - "CV-CR", - "CV-SD", - "CV-SO", - "CV-SV", - "CV-TA", - "CV-TS", - "CW-XX-1", - "CX-XX-1", - "CY-04", - "CY-06", - "CY-03", - "CY-01", - "CY-02", - "CY-05", - "CZ-31", - "CZ-64", - "CZ-41", - "CZ-63", - "CZ-52", - "CZ-51", - "CZ-80", - "CZ-71", - "CZ-53", - "CZ-32", - "CZ-10", - "CZ-20", - "CZ-42", - "CZ-72", - "DE-BW", - "DE-BY", - "DE-BE", - "DE-BB", - "DE-HB", - "DE-HH", - "DE-HE", - "DE-MV", - "DE-NI", - "DE-NW", - "DE-RP", - "DE-SL", - "DE-SN", - "DE-ST", - "DE-SH", - "DE-TH", - "DJ-AR", - "DJ-DJ", - "DK-84", - "DK-82", - "DK-81", - "DK-85", - "DK-83", - "DM-02", - "DM-04", - "DM-05", - "DM-06", - "DM-07", - "DM-09", - "DM-10", - "DO-02", - "DO-03", - "DO-04", - "DO-05", - "DO-01", - "DO-06", - "DO-08", - "DO-07", - "DO-09", - "DO-30", - "DO-19", - "DO-10", - "DO-11", - "DO-12", - "DO-13", - "DO-14", - "DO-28", - "DO-15", - "DO-29", - "DO-17", - "DO-18", - "DO-20", - "DO-21", - "DO-31", - "DO-22", - "DO-23", - "DO-24", - "DO-25", - "DO-26", - "DO-27", - "DZ-01", - "DZ-44", - "DZ-46", - "DZ-16", - "DZ-23", - "DZ-05", - "DZ-08", - "DZ-06", - "DZ-07", - "DZ-09", - "DZ-34", - "DZ-10", - "DZ-35", - "DZ-02", - "DZ-25", - "DZ-17", - "DZ-32", - "DZ-39", - "DZ-36", - "DZ-47", - "DZ-24", - "DZ-33", - "DZ-18", - "DZ-40", - "DZ-03", - "DZ-28", - "DZ-29", - "DZ-26", - "DZ-43", - "DZ-27", - "DZ-45", - "DZ-31", - "DZ-30", - "DZ-04", - "DZ-48", - "DZ-20", - "DZ-19", - "DZ-22", - "DZ-21", - "DZ-41", - "DZ-11", - "DZ-12", - "DZ-14", - "DZ-37", - "DZ-42", - "DZ-38", - "DZ-15", - "DZ-13", - "EC-A", - "EC-B", - "EC-F", - "EC-C", - "EC-H", - "EC-X", - "EC-O", - "EC-E", - "EC-W", - "EC-G", - "EC-I", - "EC-L", - "EC-R", - "EC-M", - "EC-S", - "EC-N", - "EC-D", - "EC-Y", - "EC-P", - "EC-SE", - "EC-SD", - "EC-U", - "EC-T", - "EC-Z", - "EE-37", - "EE-39", - "EE-45", - "EE-52", - "EE-50", - "EE-60", - "EE-56", - "EE-68", - "EE-64", - "EE-71", - "EE-74", - "EE-79", - "EE-81", - "EE-84", - "EE-87", - "EG-DK", - "EG-BA", - "EG-BH", - "EG-FYM", - "EG-GH", - "EG-ALX", - "EG-IS", - "EG-GZ", - "EG-MNF", - "EG-MN", - "EG-C", - "EG-KB", - "EG-LX", - "EG-WAD", - "EG-SUZ", - "EG-SHR", - "EG-ASN", - "EG-AST", - "EG-BNS", - "EG-PTS", - "EG-DT", - "EG-JS", - "EG-KFS", - "EG-MT", - "EG-KN", - "EG-SIN", - "EG-SHG", - "EH-XX-1", - "ER-MA", - "ER-DK", - "ER-SK", - "ES-AN", - "ES-AR", - "ES-AS", - "ES-CN", - "ES-CB", - "ES-CL", - "ES-CM", - "ES-CT", - "ES-CE", - "ES-EX", - "ES-GA", - "ES-IB", - "ES-RI", - "ES-MD", - "ES-ML", - "ES-MC", - "ES-NC", - "ES-PV", - "ES-VC", - "ET-AA", - "ET-AF", - "ET-AM", - "ET-BE", - "ET-DD", - "ET-GA", - "ET-HA", - "ET-OR", - "ET-SO", - "ET-TI", - "ET-SN", - "FI-02", - "FI-03", - "FI-04", - "FI-05", - "FI-06", - "FI-07", - "FI-08", - "FI-09", - "FI-10", - "FI-16", - "FI-11", - "FI-12", - "FI-13", - "FI-14", - "FI-15", - "FI-17", - "FI-18", - "FI-19", - "FJ-C", - "FJ-E", - "FJ-N", - "FJ-R", - "FJ-W", - "FK-XX-1", - "FM-TRK", - "FM-KSA", - "FM-PNI", - "FM-YAP", - "FO-XX-1", - "FO-XX-2", - "FO-XX-3", - "FO-XX-4", - "FO-XX-5", - "FR-ARA", - "FR-BFC", - "FR-BRE", - "FR-CVL", - "FR-20R", - "FR-GES", - "FR-HDF", - "FR-IDF", - "FR-NOR", - "FR-NAQ", - "FR-OCC", - "FR-PDL", - "FR-PAC", - "GA-1", - "GA-2", - "GA-4", - "GA-5", - "GA-8", - "GA-9", - "GB-ENG", - "GB-NIR", - "GB-SCT", - "GB-WLS", - "GB-CAM", - "GB-CMA", - "GB-DBY", - "GB-DEV", - "GB-DOR", - "GB-ESX", - "GB-ESS", - "GB-GLS", - "GB-HAM", - "GB-HRT", - "GB-KEN", - "GB-LAN", - "GB-LEC", - "GB-LIN", - "GB-NFK", - "GB-NYK", - "GB-NTT", - "GB-OXF", - "GB-SOM", - "GB-STS", - "GB-SFK", - "GB-SRY", - "GB-WAR", - "GB-WSX", - "GB-WOR", - "GB-LND", - "GB-BDG", - "GB-BNE", - "GB-BEX", - "GB-BEN", - "GB-BRY", - "GB-CMD", - "GB-CRY", - "GB-EAL", - "GB-ENF", - "GB-GRE", - "GB-HCK", - "GB-HMF", - "GB-HRY", - "GB-HRW", - "GB-HAV", - "GB-HIL", - "GB-HNS", - "GB-ISL", - "GB-KEC", - "GB-KTT", - "GB-LBH", - "GB-LEW", - "GB-MRT", - "GB-NWM", - "GB-RDB", - "GB-RIC", - "GB-SWK", - "GB-STN", - "GB-TWH", - "GB-WFT", - "GB-WND", - "GB-WSM", - "GB-BNS", - "GB-BIR", - "GB-BOL", - "GB-BRD", - "GB-BUR", - "GB-CLD", - "GB-COV", - "GB-DNC", - "GB-DUD", - "GB-GAT", - "GB-KIR", - "GB-KWL", - "GB-LDS", - "GB-LIV", - "GB-MAN", - "GB-NET", - "GB-NTY", - "GB-OLD", - "GB-RCH", - "GB-ROT", - "GB-SHN", - "GB-SLF", - "GB-SAW", - "GB-SFT", - "GB-SHF", - "GB-SOL", - "GB-STY", - "GB-SKP", - "GB-SND", - "GB-TAM", - "GB-TRF", - "GB-WKF", - "GB-WLL", - "GB-WGN", - "GB-WRL", - "GB-WLV", - "GB-BAS", - "GB-BDF", - "GB-BBD", - "GB-BPL", - "GB-BCP", - "GB-BRC", - "GB-BNH", - "GB-BST", - "GB-BKM", - "GB-CBF", - "GB-CHE", - "GB-CHW", - "GB-CON", - "GB-DAL", - "GB-DER", - "GB-DUR", - "GB-ERY", - "GB-HAL", - "GB-HPL", - "GB-HEF", - "GB-IOW", - "GB-IOS", - "GB-KHL", - "GB-LCE", - "GB-LUT", - "GB-MDW", - "GB-MDB", - "GB-MIK", - "GB-NEL", - "GB-NLN", - "GB-NNH", - "GB-NSM", - "GB-NBL", - "GB-NGM", - "GB-PTE", - "GB-PLY", - "GB-POR", - "GB-RDG", - "GB-RCC", - "GB-RUT", - "GB-SHR", - "GB-SLG", - "GB-SGC", - "GB-STH", - "GB-SOS", - "GB-STT", - "GB-STE", - "GB-SWD", - "GB-TFW", - "GB-THR", - "GB-TOB", - "GB-WRT", - "GB-WBK", - "GB-WNH", - "GB-WIL", - "GB-WNM", - "GB-WOK", - "GB-YOR", - "GB-ANN", - "GB-AND", - "GB-ABC", - "GB-BFS", - "GB-CCG", - "GB-DRS", - "GB-FMO", - "GB-LBC", - "GB-MEA", - "GB-MUL", - "GB-NMD", - "GB-ABE", - "GB-ABD", - "GB-ANS", - "GB-AGB", - "GB-CLK", - "GB-DGY", - "GB-DND", - "GB-EAY", - "GB-EDU", - "GB-ELN", - "GB-ERW", - "GB-EDH", - "GB-ELS", - "GB-FAL", - "GB-FIF", - "GB-GLG", - "GB-HLD", - "GB-IVC", - "GB-MLN", - "GB-MRY", - "GB-NAY", - "GB-NLK", - "GB-ORK", - "GB-PKN", - "GB-RFW", - "GB-SCB", - "GB-ZET", - "GB-SAY", - "GB-SLK", - "GB-STG", - "GB-WDU", - "GB-WLN", - "GB-BGW", - "GB-BGE", - "GB-CAY", - "GB-CRF", - "GB-CMN", - "GB-CGN", - "GB-CWY", - "GB-DEN", - "GB-FLN", - "GB-GWN", - "GB-AGY", - "GB-MTY", - "GB-MON", - "GB-NTL", - "GB-NWP", - "GB-PEM", - "GB-POW", - "GB-RCT", - "GB-SWA", - "GB-TOF", - "GB-VGL", - "GB-WRX", - "GD-01", - "GD-02", - "GD-03", - "GD-04", - "GD-05", - "GD-06", - "GD-10", - "GE-AB", - "GE-AJ", - "GE-GU", - "GE-IM", - "GE-KA", - "GE-KK", - "GE-MM", - "GE-RL", - "GE-SZ", - "GE-SJ", - "GE-SK", - "GE-TB", - "GF-XX-1", - "GG-XX-1", - "GH-AF", - "GH-AH", - "GH-BO", - "GH-BE", - "GH-CP", - "GH-EP", - "GH-AA", - "GH-NP", - "GH-UE", - "GH-UW", - "GH-TV", - "GH-WP", - "GI-XX-1", - "GL-AV", - "GL-KU", - "GL-QT", - "GL-SM", - "GL-QE", - "GM-B", - "GM-M", - "GM-L", - "GM-N", - "GM-U", - "GM-W", - "GN-BF", - "GN-B", - "GN-C", - "GN-CO", - "GN-DB", - "GN-DU", - "GN-K", - "GN-L", - "GN-LA", - "GN-MC", - "GN-N", - "GN-SI", - "GP-XX-1", - "GQ-BN", - "GQ-KN", - "GQ-LI", - "GQ-WN", - "GR-A", - "GR-I", - "GR-G", - "GR-C", - "GR-F", - "GR-D", - "GR-B", - "GR-M", - "GR-L", - "GR-J", - "GR-H", - "GR-E", - "GR-K", - "GS-XX-1", - "GT-16", - "GT-15", - "GT-04", - "GT-20", - "GT-02", - "GT-05", - "GT-01", - "GT-13", - "GT-18", - "GT-21", - "GT-22", - "GT-17", - "GT-09", - "GT-14", - "GT-11", - "GT-03", - "GT-12", - "GT-06", - "GT-07", - "GT-10", - "GT-08", - "GT-19", - "GU-XX-1", - "GU-XX-2", - "GU-XX-3", - "GU-XX-4", - "GU-XX-5", - "GU-XX-6", - "GU-XX-7", - "GU-XX-8", - "GU-XX-9", - "GU-XX-10", - "GU-XX-11", - "GU-XX-12", - "GU-XX-13", - "GU-XX-14", - "GU-XX-15", - "GU-XX-16", - "GW-BS", - "GW-GA", - "GY-CU", - "GY-DE", - "GY-EB", - "GY-ES", - "GY-MA", - "GY-PT", - "GY-UD", - "HK-XX-1", - "HM-XX-1", - "HN-AT", - "HN-CH", - "HN-CL", - "HN-CM", - "HN-CP", - "HN-CR", - "HN-EP", - "HN-FM", - "HN-GD", - "HN-IN", - "HN-IB", - "HN-LP", - "HN-LE", - "HN-OC", - "HN-OL", - "HN-SB", - "HN-VA", - "HN-YO", - "HR-07", - "HR-12", - "HR-19", - "HR-21", - "HR-18", - "HR-04", - "HR-06", - "HR-02", - "HR-09", - "HR-20", - "HR-14", - "HR-11", - "HR-08", - "HR-15", - "HR-03", - "HR-17", - "HR-05", - "HR-10", - "HR-16", - "HR-13", - "HR-01", - "HT-AR", - "HT-CE", - "HT-GA", - "HT-NI", - "HT-ND", - "HT-OU", - "HT-SD", - "HT-SE", - "HU-BK", - "HU-BA", - "HU-BE", - "HU-BZ", - "HU-BU", - "HU-CS", - "HU-FE", - "HU-GS", - "HU-HB", - "HU-HE", - "HU-JN", - "HU-KE", - "HU-NO", - "HU-PE", - "HU-SO", - "HU-SZ", - "HU-TO", - "HU-VA", - "HU-VE", - "HU-ZA", - "ID-AC", - "ID-BA", - "ID-BT", - "ID-BE", - "ID-GO", - "ID-JK", - "ID-JA", - "ID-JB", - "ID-JT", - "ID-JI", - "ID-KB", - "ID-KS", - "ID-KT", - "ID-KI", - "ID-KU", - "ID-BB", - "ID-KR", - "ID-LA", - "ID-ML", - "ID-MU", - "ID-NB", - "ID-NT", - "ID-PP", - "ID-PB", - "ID-RI", - "ID-SR", - "ID-SN", - "ID-ST", - "ID-SG", - "ID-SA", - "ID-SB", - "ID-SS", - "ID-SU", - "ID-YO", - "IE-CW", - "IE-CN", - "IE-CE", - "IE-CO", - "IE-DL", - "IE-D", - "IE-G", - "IE-KY", - "IE-KE", - "IE-KK", - "IE-LS", - "IE-LM", - "IE-LK", - "IE-LD", - "IE-LH", - "IE-MO", - "IE-MH", - "IE-MN", - "IE-OY", - "IE-RN", - "IE-SO", - "IE-TA", - "IE-WD", - "IE-WH", - "IE-WX", - "IE-WW", - "IL-D", - "IL-M", - "IL-Z", - "IL-HA", - "IL-TA", - "IL-JM", - "IM-XX-1", - "IN-AN", - "IN-AP", - "IN-AR", - "IN-AS", - "IN-BR", - "IN-CH", - "IN-CT", - "IN-DN", - "IN-DH", - "IN-DL", - "IN-GA", - "IN-GJ", - "IN-HR", - "IN-HP", - "IN-JK", - "IN-JH", - "IN-KA", - "IN-KL", - "IN-LD", - "IN-MP", - "IN-MH", - "IN-MN", - "IN-ML", - "IN-MZ", - "IN-NL", - "IN-OR", - "IN-PY", - "IN-PB", - "IN-RJ", - "IN-SK", - "IN-TN", - "IN-TG", - "IN-TR", - "IN-UP", - "IN-UT", - "IN-WB", - "IO-XX-1", - "IQ-AN", - "IQ-BA", - "IQ-MU", - "IQ-QA", - "IQ-NA", - "IQ-AR", - "IQ-SU", - "IQ-BB", - "IQ-BG", - "IQ-DA", - "IQ-DQ", - "IQ-DI", - "IQ-KA", - "IQ-KI", - "IQ-MA", - "IQ-NI", - "IQ-SD", - "IQ-WA", - "IR-30", - "IR-24", - "IR-04", - "IR-03", - "IR-18", - "IR-14", - "IR-10", - "IR-07", - "IR-01", - "IR-27", - "IR-13", - "IR-22", - "IR-16", - "IR-08", - "IR-05", - "IR-29", - "IR-09", - "IR-28", - "IR-06", - "IR-17", - "IR-12", - "IR-15", - "IR-00", - "IR-02", - "IR-26", - "IR-25", - "IR-20", - "IR-11", - "IR-23", - "IR-21", - "IR-19", - "IS-7", - "IS-1", - "IS-6", - "IS-5", - "IS-8", - "IS-2", - "IS-4", - "IS-3", - "IT-65", - "IT-77", - "IT-78", - "IT-72", - "IT-45", - "IT-36", - "IT-62", - "IT-42", - "IT-25", - "IT-57", - "IT-67", - "IT-21", - "IT-75", - "IT-88", - "IT-82", - "IT-52", - "IT-32", - "IT-55", - "IT-23", - "IT-34", - "JE-XX-1", - "JM-13", - "JM-09", - "JM-01", - "JM-12", - "JM-04", - "JM-02", - "JM-06", - "JM-14", - "JM-11", - "JM-08", - "JM-05", - "JM-03", - "JM-07", - "JM-10", - "JO-AJ", - "JO-AQ", - "JO-AM", - "JO-BA", - "JO-KA", - "JO-MA", - "JO-AT", - "JO-AZ", - "JO-IR", - "JO-JA", - "JO-MN", - "JO-MD", - "JP-23", - "JP-05", - "JP-02", - "JP-12", - "JP-38", - "JP-18", - "JP-40", - "JP-07", - "JP-21", - "JP-10", - "JP-34", - "JP-01", - "JP-28", - "JP-08", - "JP-17", - "JP-03", - "JP-37", - "JP-46", - "JP-14", - "JP-39", - "JP-43", - "JP-26", - "JP-24", - "JP-04", - "JP-45", - "JP-20", - "JP-42", - "JP-29", - "JP-15", - "JP-44", - "JP-33", - "JP-47", - "JP-27", - "JP-41", - "JP-11", - "JP-25", - "JP-32", - "JP-22", - "JP-09", - "JP-36", - "JP-13", - "JP-31", - "JP-16", - "JP-30", - "JP-06", - "JP-35", - "JP-19", - "KE-01", - "KE-02", - "KE-03", - "KE-04", - "KE-05", - "KE-06", - "KE-07", - "KE-08", - "KE-09", - "KE-10", - "KE-11", - "KE-12", - "KE-13", - "KE-14", - "KE-15", - "KE-16", - "KE-17", - "KE-18", - "KE-19", - "KE-20", - "KE-21", - "KE-22", - "KE-23", - "KE-24", - "KE-25", - "KE-26", - "KE-27", - "KE-28", - "KE-29", - "KE-30", - "KE-31", - "KE-32", - "KE-33", - "KE-34", - "KE-35", - "KE-36", - "KE-37", - "KE-38", - "KE-39", - "KE-40", - "KE-41", - "KE-42", - "KE-43", - "KE-44", - "KE-45", - "KE-46", - "KE-47", - "KG-B", - "KG-GB", - "KG-C", - "KG-J", - "KG-N", - "KG-GO", - "KG-T", - "KG-Y", - "KH-2", - "KH-1", - "KH-23", - "KH-3", - "KH-4", - "KH-5", - "KH-6", - "KH-7", - "KH-8", - "KH-10", - "KH-11", - "KH-24", - "KH-12", - "KH-15", - "KH-18", - "KH-14", - "KH-16", - "KH-17", - "KH-19", - "KH-20", - "KH-21", - "KI-G", - "KM-G", - "KM-M", - "KN-01", - "KN-02", - "KN-03", - "KN-05", - "KN-06", - "KN-07", - "KN-08", - "KN-09", - "KN-10", - "KN-11", - "KN-12", - "KN-13", - "KN-15", - "KP-01", - "KR-26", - "KR-43", - "KR-44", - "KR-27", - "KR-30", - "KR-42", - "KR-29", - "KR-41", - "KR-47", - "KR-48", - "KR-28", - "KR-49", - "KR-45", - "KR-46", - "KR-11", - "KR-31", - "KW-KU", - "KW-AH", - "KW-FA", - "KW-JA", - "KW-HA", - "KW-MU", - "KY-XX-1", - "KZ-ALA", - "KZ-ALM", - "KZ-AKM", - "KZ-AKT", - "KZ-ATY", - "KZ-ZAP", - "KZ-MAN", - "KZ-AST", - "KZ-YUZ", - "KZ-PAV", - "KZ-KAR", - "KZ-KUS", - "KZ-KZY", - "KZ-VOS", - "KZ-SHY", - "KZ-SEV", - "KZ-ZHA", - "LA-AT", - "LA-BL", - "LA-CH", - "LA-HO", - "LA-KH", - "LA-OU", - "LA-PH", - "LA-SV", - "LA-VI", - "LA-XA", - "LA-XE", - "LA-XI", - "LB-AK", - "LB-BH", - "LB-BI", - "LB-BA", - "LB-AS", - "LB-JA", - "LB-JL", - "LB-NA", - "LC-01", - "LC-02", - "LC-03", - "LC-05", - "LC-06", - "LC-07", - "LC-08", - "LC-10", - "LC-11", - "LI-01", - "LI-02", - "LI-03", - "LI-04", - "LI-05", - "LI-06", - "LI-07", - "LI-09", - "LI-10", - "LI-11", - "LK-2", - "LK-5", - "LK-7", - "LK-6", - "LK-4", - "LK-9", - "LK-3", - "LK-8", - "LK-1", - "LR-BM", - "LR-GB", - "LR-GG", - "LR-MG", - "LR-MO", - "LR-NI", - "LR-SI", - "LS-D", - "LS-B", - "LS-C", - "LS-E", - "LS-A", - "LS-F", - "LS-J", - "LS-H", - "LS-G", - "LS-K", - "LT-AL", - "LT-KU", - "LT-KL", - "LT-MR", - "LT-PN", - "LT-SA", - "LT-TA", - "LT-TE", - "LT-UT", - "LT-VL", - "LU-CA", - "LU-CL", - "LU-DI", - "LU-EC", - "LU-ES", - "LU-GR", - "LU-LU", - "LU-ME", - "LU-RD", - "LU-RM", - "LU-VD", - "LU-WI", - "LV-011", - "LV-002", - "LV-007", - "LV-111", - "LV-015", - "LV-016", - "LV-022", - "LV-DGV", - "LV-112", - "LV-026", - "LV-033", - "LV-042", - "LV-JEL", - "LV-041", - "LV-JUR", - "LV-052", - "LV-047", - "LV-050", - "LV-LPX", - "LV-054", - "LV-056", - "LV-058", - "LV-059", - "LV-062", - "LV-067", - "LV-068", - "LV-073", - "LV-077", - "LV-RIX", - "LV-080", - "LV-087", - "LV-088", - "LV-089", - "LV-091", - "LV-094", - "LV-097", - "LV-099", - "LV-101", - "LV-113", - "LV-102", - "LV-106", - "LY-BU", - "LY-JA", - "LY-JG", - "LY-JI", - "LY-JU", - "LY-KF", - "LY-MJ", - "LY-MB", - "LY-WA", - "LY-NQ", - "LY-ZA", - "LY-BA", - "LY-DR", - "LY-MI", - "LY-NL", - "LY-SB", - "LY-SR", - "LY-TB", - "LY-WS", - "MA-05", - "MA-06", - "MA-08", - "MA-03", - "MA-10", - "MA-02", - "MA-11", - "MA-07", - "MA-04", - "MA-09", - "MA-01", - "MC-FO", - "MC-CO", - "MC-MO", - "MC-MC", - "MC-SR", - "MD-AN", - "MD-BA", - "MD-BS", - "MD-BD", - "MD-BR", - "MD-CA", - "MD-CL", - "MD-CT", - "MD-CS", - "MD-CU", - "MD-CM", - "MD-CR", - "MD-DO", - "MD-DR", - "MD-DU", - "MD-ED", - "MD-FA", - "MD-FL", - "MD-GA", - "MD-GL", - "MD-HI", - "MD-IA", - "MD-LE", - "MD-NI", - "MD-OC", - "MD-OR", - "MD-RE", - "MD-RI", - "MD-SI", - "MD-SD", - "MD-SO", - "MD-SV", - "MD-SN", - "MD-ST", - "MD-TA", - "MD-TE", - "MD-UN", - "ME-01", - "ME-02", - "ME-03", - "ME-04", - "ME-05", - "ME-06", - "ME-07", - "ME-08", - "ME-10", - "ME-12", - "ME-13", - "ME-14", - "ME-15", - "ME-16", - "ME-17", - "ME-19", - "ME-24", - "ME-20", - "ME-21", - "MF-XX-1", - "MG-T", - "MG-D", - "MG-F", - "MG-M", - "MG-A", - "MG-U", - "MH-KWA", - "MH-MAJ", - "MK-802", - "MK-201", - "MK-501", - "MK-401", - "MK-601", - "MK-402", - "MK-602", - "MK-803", - "MK-109", - "MK-814", - "MK-210", - "MK-816", - "MK-303", - "MK-203", - "MK-502", - "MK-406", - "MK-503", - "MK-804", - "MK-405", - "MK-604", - "MK-102", - "MK-807", - "MK-606", - "MK-205", - "MK-104", - "MK-307", - "MK-809", - "MK-206", - "MK-701", - "MK-702", - "MK-505", - "MK-703", - "MK-704", - "MK-105", - "MK-207", - "MK-308", - "MK-607", - "MK-506", - "MK-106", - "MK-507", - "MK-408", - "MK-310", - "MK-208", - "MK-810", - "MK-311", - "MK-508", - "MK-209", - "MK-409", - "MK-705", - "MK-509", - "MK-107", - "MK-811", - "MK-812", - "MK-211", - "MK-312", - "MK-410", - "MK-813", - "MK-108", - "MK-608", - "MK-609", - "MK-403", - "MK-404", - "MK-101", - "MK-301", - "MK-202", - "MK-603", - "MK-806", - "MK-605", - "ML-BKO", - "ML-7", - "ML-1", - "ML-8", - "ML-2", - "ML-5", - "ML-4", - "ML-3", - "ML-6", - "MM-07", - "MM-02", - "MM-14", - "MM-11", - "MM-12", - "MM-13", - "MM-03", - "MM-04", - "MM-15", - "MM-18", - "MM-16", - "MM-01", - "MM-17", - "MM-05", - "MM-06", - "MN-071", - "MN-037", - "MN-061", - "MN-063", - "MN-065", - "MN-043", - "MN-035", - "MN-055", - "MN-049", - "MN-047", - "MN-1", - "MO-XX-1", - "MP-XX-1", - "MQ-XX-1", - "MR-07", - "MR-03", - "MR-05", - "MR-08", - "MR-04", - "MR-10", - "MR-01", - "MR-02", - "MR-12", - "MR-13", - "MR-09", - "MR-11", - "MR-06", - "MS-XX-1", - "MS-XX-2", - "MT-01", - "MT-02", - "MT-03", - "MT-04", - "MT-05", - "MT-06", - "MT-07", - "MT-08", - "MT-09", - "MT-10", - "MT-14", - "MT-15", - "MT-16", - "MT-17", - "MT-11", - "MT-12", - "MT-18", - "MT-19", - "MT-20", - "MT-21", - "MT-22", - "MT-23", - "MT-24", - "MT-25", - "MT-26", - "MT-27", - "MT-28", - "MT-29", - "MT-30", - "MT-31", - "MT-32", - "MT-33", - "MT-34", - "MT-35", - "MT-36", - "MT-37", - "MT-38", - "MT-39", - "MT-40", - "MT-41", - "MT-42", - "MT-43", - "MT-45", - "MT-46", - "MT-49", - "MT-48", - "MT-53", - "MT-51", - "MT-52", - "MT-54", - "MT-55", - "MT-56", - "MT-57", - "MT-58", - "MT-59", - "MT-60", - "MT-61", - "MT-62", - "MT-63", - "MT-64", - "MT-65", - "MT-67", - "MT-68", - "MU-BL", - "MU-FL", - "MU-GP", - "MU-MO", - "MU-PA", - "MU-PW", - "MU-PL", - "MU-RR", - "MU-RO", - "MU-SA", - "MV-01", - "MV-03", - "MV-04", - "MV-05", - "MV-MLE", - "MV-12", - "MV-13", - "MV-00", - "MV-28", - "MV-20", - "MV-25", - "MV-17", - "MW-BA", - "MW-BL", - "MW-CK", - "MW-CR", - "MW-DE", - "MW-DO", - "MW-KR", - "MW-LI", - "MW-MH", - "MW-MG", - "MW-MW", - "MW-MZ", - "MW-NE", - "MW-NK", - "MW-PH", - "MW-SA", - "MW-TH", - "MW-ZO", - "MX-AGU", - "MX-BCN", - "MX-BCS", - "MX-CAM", - "MX-CHP", - "MX-CHH", - "MX-CMX", - "MX-COA", - "MX-COL", - "MX-DUR", - "MX-GUA", - "MX-GRO", - "MX-HID", - "MX-JAL", - "MX-MEX", - "MX-MIC", - "MX-MOR", - "MX-NAY", - "MX-NLE", - "MX-OAX", - "MX-PUE", - "MX-QUE", - "MX-ROO", - "MX-SLP", - "MX-SIN", - "MX-SON", - "MX-TAB", - "MX-TAM", - "MX-TLA", - "MX-VER", - "MX-YUC", - "MX-ZAC", - "MY-01", - "MY-02", - "MY-03", - "MY-04", - "MY-05", - "MY-06", - "MY-08", - "MY-09", - "MY-07", - "MY-12", - "MY-13", - "MY-10", - "MY-11", - "MY-14", - "MY-15", - "MY-16", - "MZ-P", - "MZ-G", - "MZ-I", - "MZ-B", - "MZ-L", - "MZ-N", - "MZ-A", - "MZ-S", - "MZ-T", - "MZ-Q", - "NA-ER", - "NA-HA", - "NA-KA", - "NA-KE", - "NA-KW", - "NA-KH", - "NA-KU", - "NA-OW", - "NA-OH", - "NA-OS", - "NA-ON", - "NA-OT", - "NA-OD", - "NA-CA", - "NC-XX-1", - "NC-XX-2", - "NE-1", - "NE-2", - "NE-3", - "NE-8", - "NE-5", - "NE-6", - "NE-7", - "NF-XX-1", - "NG-AB", - "NG-FC", - "NG-AD", - "NG-AK", - "NG-AN", - "NG-BA", - "NG-BY", - "NG-BE", - "NG-BO", - "NG-CR", - "NG-DE", - "NG-EB", - "NG-ED", - "NG-EK", - "NG-EN", - "NG-GO", - "NG-IM", - "NG-JI", - "NG-KD", - "NG-KN", - "NG-KT", - "NG-KE", - "NG-KO", - "NG-KW", - "NG-LA", - "NG-NA", - "NG-NI", - "NG-OG", - "NG-ON", - "NG-OS", - "NG-OY", - "NG-PL", - "NG-RI", - "NG-SO", - "NG-TA", - "NG-YO", - "NG-ZA", - "NI-BO", - "NI-CA", - "NI-CI", - "NI-CO", - "NI-AN", - "NI-AS", - "NI-ES", - "NI-GR", - "NI-JI", - "NI-LE", - "NI-MD", - "NI-MN", - "NI-MS", - "NI-MT", - "NI-NS", - "NI-SJ", - "NI-RI", - "NL-DR", - "NL-FL", - "NL-FR", - "NL-GE", - "NL-GR", - "NL-LI", - "NL-NB", - "NL-NH", - "NL-OV", - "NL-UT", - "NL-ZE", - "NL-ZH", - "NO-42", - "NO-34", - "NO-15", - "NO-18", - "NO-03", - "NO-11", - "NO-54", - "NO-50", - "NO-38", - "NO-46", - "NO-30", - "NP-BA", - "NP-BH", - "NP-DH", - "NP-GA", - "NP-JA", - "NP-KA", - "NP-KO", - "NP-LU", - "NP-MA", - "NP-ME", - "NP-NA", - "NP-RA", - "NP-SA", - "NP-SE", - "NR-01", - "NR-03", - "NR-14", - "NU-XX-1", - "NZ-AUK", - "NZ-BOP", - "NZ-CAN", - "NZ-CIT", - "NZ-GIS", - "NZ-HKB", - "NZ-MWT", - "NZ-MBH", - "NZ-NSN", - "NZ-NTL", - "NZ-OTA", - "NZ-STL", - "NZ-TKI", - "NZ-TAS", - "NZ-WKO", - "NZ-WGN", - "NZ-WTC", - "OM-DA", - "OM-BU", - "OM-WU", - "OM-ZA", - "OM-BJ", - "OM-SJ", - "OM-MA", - "OM-MU", - "OM-BS", - "OM-SS", - "OM-ZU", - "PA-1", - "PA-4", - "PA-2", - "PA-3", - "PA-5", - "PA-KY", - "PA-6", - "PA-7", - "PA-NB", - "PA-8", - "PA-9", - "PE-AMA", - "PE-ANC", - "PE-APU", - "PE-ARE", - "PE-AYA", - "PE-CAJ", - "PE-CUS", - "PE-CAL", - "PE-HUV", - "PE-HUC", - "PE-ICA", - "PE-JUN", - "PE-LAL", - "PE-LAM", - "PE-LIM", - "PE-LOR", - "PE-MDD", - "PE-MOQ", - "PE-PAS", - "PE-PIU", - "PE-PUN", - "PE-SAM", - "PE-TAC", - "PE-TUM", - "PE-UCA", - "PF-XX-1", - "PF-XX-2", - "PF-XX-3", - "PF-XX-4", - "PF-XX-5", - "PG-NSB", - "PG-CPM", - "PG-CPK", - "PG-EBR", - "PG-EHG", - "PG-ESW", - "PG-MPM", - "PG-MRL", - "PG-MBA", - "PG-MPL", - "PG-NCD", - "PG-SHM", - "PG-WBK", - "PG-SAN", - "PG-WPD", - "PG-WHM", - "PH-ABR", - "PH-AGN", - "PH-AGS", - "PH-AKL", - "PH-ALB", - "PH-ANT", - "PH-APA", - "PH-AUR", - "PH-BAS", - "PH-BAN", - "PH-BTN", - "PH-BTG", - "PH-BEN", - "PH-BIL", - "PH-BOH", - "PH-BUK", - "PH-BUL", - "PH-CAG", - "PH-CAN", - "PH-CAS", - "PH-CAM", - "PH-CAP", - "PH-CAT", - "PH-CAV", - "PH-CEB", - "PH-NCO", - "PH-DAO", - "PH-COM", - "PH-DAV", - "PH-DAS", - "PH-DIN", - "PH-EAS", - "PH-GUI", - "PH-IFU", - "PH-ILN", - "PH-ILS", - "PH-ILI", - "PH-ISA", - "PH-KAL", - "PH-LUN", - "PH-LAG", - "PH-LAN", - "PH-LAS", - "PH-LEY", - "PH-MAG", - "PH-MAD", - "PH-MAS", - "PH-MDC", - "PH-MDR", - "PH-MSC", - "PH-MSR", - "PH-MOU", - "PH-00", - "PH-NEC", - "PH-NER", - "PH-NSA", - "PH-NUE", - "PH-NUV", - "PH-PLW", - "PH-PAM", - "PH-PAN", - "PH-QUE", - "PH-QUI", - "PH-RIZ", - "PH-ROM", - "PH-WSA", - "PH-SAR", - "PH-SIG", - "PH-SOR", - "PH-SCO", - "PH-SLE", - "PH-SUK", - "PH-SLU", - "PH-SUN", - "PH-SUR", - "PH-TAR", - "PH-TAW", - "PH-ZMB", - "PH-ZSI", - "PH-ZAN", - "PH-ZAS", - "PK-JK", - "PK-BA", - "PK-GB", - "PK-IS", - "PK-KP", - "PK-PB", - "PK-SD", - "PL-02", - "PL-04", - "PL-10", - "PL-06", - "PL-08", - "PL-12", - "PL-14", - "PL-16", - "PL-18", - "PL-20", - "PL-22", - "PL-24", - "PL-26", - "PL-28", - "PL-30", - "PL-32", - "PM-XX-1", - "PN-XX-1", - "PR-XX-1", - "PR-XX-2", - "PR-XX-3", - "PR-XX-4", - "PR-XX-5", - "PR-XX-6", - "PR-XX-7", - "PR-XX-8", - "PR-XX-9", - "PR-XX-10", - "PR-XX-11", - "PR-XX-12", - "PR-XX-13", - "PR-XX-14", - "PR-XX-15", - "PR-XX-16", - "PR-XX-17", - "PR-XX-18", - "PR-XX-19", - "PR-XX-20", - "PR-XX-21", - "PR-XX-22", - "PR-XX-23", - "PR-XX-24", - "PR-XX-25", - "PR-XX-26", - "PR-XX-27", - "PR-XX-28", - "PR-XX-29", - "PR-XX-30", - "PR-XX-31", - "PR-XX-32", - "PR-XX-33", - "PR-XX-34", - "PR-XX-35", - "PR-XX-36", - "PR-XX-37", - "PR-XX-38", - "PR-XX-39", - "PR-XX-40", - "PR-XX-41", - "PR-XX-42", - "PR-XX-43", - "PR-XX-44", - "PR-XX-45", - "PR-XX-46", - "PR-XX-47", - "PR-XX-48", - "PR-XX-49", - "PR-XX-50", - "PR-XX-51", - "PR-XX-52", - "PR-XX-53", - "PR-XX-54", - "PR-XX-55", - "PR-XX-56", - "PR-XX-57", - "PR-XX-58", - "PR-XX-59", - "PR-XX-60", - "PR-XX-61", - "PR-XX-62", - "PR-XX-63", - "PR-XX-64", - "PR-XX-65", - "PR-XX-66", - "PR-XX-67", - "PR-XX-68", - "PR-XX-69", - "PR-XX-70", - "PR-XX-71", - "PR-XX-72", - "PR-XX-73", - "PR-XX-74", - "PR-XX-75", - "PR-XX-76", - "PS-BTH", - "PS-DEB", - "PS-GZA", - "PS-HBN", - "PS-JEN", - "PS-JRH", - "PS-JEM", - "PS-KYS", - "PS-NBS", - "PS-QQA", - "PS-RFH", - "PS-RBH", - "PS-SLT", - "PS-TBS", - "PS-TKM", - "PT-01", - "PT-02", - "PT-03", - "PT-04", - "PT-05", - "PT-06", - "PT-07", - "PT-08", - "PT-09", - "PT-10", - "PT-11", - "PT-12", - "PT-13", - "PT-30", - "PT-20", - "PT-14", - "PT-15", - "PT-16", - "PT-17", - "PT-18", - "PW-004", - "PW-100", - "PW-150", - "PW-212", - "PW-214", - "PW-222", - "PY-10", - "PY-13", - "PY-ASU", - "PY-19", - "PY-5", - "PY-6", - "PY-14", - "PY-11", - "PY-1", - "PY-3", - "PY-4", - "PY-7", - "PY-8", - "PY-12", - "PY-9", - "PY-15", - "PY-2", - "QA-DA", - "QA-KH", - "QA-WA", - "QA-RA", - "QA-MS", - "QA-ZA", - "QA-US", - "RE-XX-1", - "RO-AB", - "RO-AR", - "RO-AG", - "RO-BC", - "RO-BH", - "RO-BN", - "RO-BT", - "RO-BR", - "RO-BV", - "RO-B", - "RO-BZ", - "RO-CL", - "RO-CS", - "RO-CJ", - "RO-CT", - "RO-CV", - "RO-DB", - "RO-DJ", - "RO-GL", - "RO-GR", - "RO-GJ", - "RO-HR", - "RO-HD", - "RO-IL", - "RO-IS", - "RO-IF", - "RO-MM", - "RO-MH", - "RO-MS", - "RO-NT", - "RO-OT", - "RO-PH", - "RO-SJ", - "RO-SM", - "RO-SB", - "RO-SV", - "RO-TR", - "RO-TM", - "RO-TL", - "RO-VL", - "RO-VS", - "RO-VN", - "RS-00", - "RS-14", - "RS-11", - "RS-23", - "RS-06", - "RS-04", - "RS-09", - "RS-28", - "RS-08", - "RS-17", - "RS-20", - "RS-24", - "RS-26", - "RS-22", - "RS-10", - "RS-13", - "RS-27", - "RS-19", - "RS-18", - "RS-01", - "RS-03", - "RS-02", - "RS-07", - "RS-12", - "RS-21", - "RS-15", - "RS-05", - "RS-16", - "RU-AD", - "RU-AL", - "RU-ALT", - "RU-AMU", - "RU-ARK", - "RU-AST", - "RU-BA", - "RU-BEL", - "RU-BRY", - "RU-BU", - "RU-CE", - "RU-CHE", - "RU-CHU", - "RU-CU", - "RU-DA", - "RU-IN", - "RU-IRK", - "RU-IVA", - "RU-KB", - "RU-KGD", - "RU-KL", - "RU-KLU", - "RU-KAM", - "RU-KC", - "RU-KR", - "RU-KEM", - "RU-KHA", - "RU-KK", - "RU-KHM", - "RU-KIR", - "RU-KO", - "RU-KOS", - "RU-KDA", - "RU-KYA", - "RU-KGN", - "RU-KRS", - "RU-LEN", - "RU-LIP", - "RU-MAG", - "RU-ME", - "RU-MO", - "RU-MOS", - "RU-MOW", - "RU-MUR", - "RU-NEN", - "RU-NIZ", - "RU-NGR", - "RU-NVS", - "RU-OMS", - "RU-ORE", - "RU-ORL", - "RU-PNZ", - "RU-PER", - "RU-PRI", - "RU-PSK", - "RU-ROS", - "RU-RYA", - "RU-SA", - "RU-SAK", - "RU-SAM", - "RU-SPE", - "RU-SAR", - "RU-SE", - "RU-SMO", - "RU-STA", - "RU-SVE", - "RU-TAM", - "RU-TA", - "RU-TOM", - "RU-TUL", - "RU-TVE", - "RU-TYU", - "RU-TY", - "RU-UD", - "RU-ULY", - "RU-VLA", - "RU-VGG", - "RU-VLG", - "RU-VOR", - "RU-YAN", - "RU-YAR", - "RU-YEV", - "RU-ZAB", - "RW-02", - "RW-03", - "RW-04", - "RW-05", - "RW-01", - "SA-14", - "SA-11", - "SA-08", - "SA-12", - "SA-03", - "SA-05", - "SA-01", - "SA-04", - "SA-06", - "SA-09", - "SA-02", - "SA-10", - "SA-07", - "SB-CH", - "SB-GU", - "SB-WE", - "SC-02", - "SC-05", - "SC-01", - "SC-06", - "SC-07", - "SC-08", - "SC-10", - "SC-11", - "SC-16", - "SC-13", - "SC-14", - "SC-15", - "SC-20", - "SC-23", - "SD-NB", - "SD-DC", - "SD-GD", - "SD-GZ", - "SD-KA", - "SD-KH", - "SD-DN", - "SD-KN", - "SD-NO", - "SD-RS", - "SD-NR", - "SD-SI", - "SD-DS", - "SD-KS", - "SD-DW", - "SD-GK", - "SD-NW", - "SE-K", - "SE-W", - "SE-X", - "SE-I", - "SE-N", - "SE-Z", - "SE-F", - "SE-H", - "SE-G", - "SE-BD", - "SE-T", - "SE-E", - "SE-M", - "SE-D", - "SE-AB", - "SE-C", - "SE-S", - "SE-AC", - "SE-Y", - "SE-U", - "SE-O", - "SG-XX-1", - "SH-HL", - "SI-001", - "SI-213", - "SI-195", - "SI-002", - "SI-148", - "SI-149", - "SI-003", - "SI-150", - "SI-004", - "SI-005", - "SI-006", - "SI-151", - "SI-007", - "SI-009", - "SI-008", - "SI-152", - "SI-011", - "SI-012", - "SI-013", - "SI-014", - "SI-196", - "SI-015", - "SI-017", - "SI-018", - "SI-019", - "SI-154", - "SI-020", - "SI-155", - "SI-021", - "SI-156", - "SI-023", - "SI-024", - "SI-025", - "SI-026", - "SI-207", - "SI-029", - "SI-031", - "SI-158", - "SI-032", - "SI-159", - "SI-160", - "SI-161", - "SI-162", - "SI-034", - "SI-035", - "SI-036", - "SI-037", - "SI-038", - "SI-039", - "SI-040", - "SI-041", - "SI-042", - "SI-043", - "SI-044", - "SI-045", - "SI-046", - "SI-047", - "SI-048", - "SI-049", - "SI-164", - "SI-050", - "SI-197", - "SI-165", - "SI-052", - "SI-053", - "SI-166", - "SI-054", - "SI-055", - "SI-056", - "SI-057", - "SI-058", - "SI-059", - "SI-060", - "SI-061", - "SI-063", - "SI-208", - "SI-064", - "SI-065", - "SI-066", - "SI-167", - "SI-067", - "SI-068", - "SI-069", - "SI-198", - "SI-070", - "SI-168", - "SI-071", - "SI-072", - "SI-073", - "SI-074", - "SI-169", - "SI-075", - "SI-212", - "SI-170", - "SI-076", - "SI-199", - "SI-077", - "SI-079", - "SI-080", - "SI-081", - "SI-082", - "SI-083", - "SI-084", - "SI-085", - "SI-086", - "SI-171", - "SI-087", - "SI-090", - "SI-091", - "SI-092", - "SI-172", - "SI-200", - "SI-173", - "SI-094", - "SI-174", - "SI-095", - "SI-175", - "SI-096", - "SI-097", - "SI-098", - "SI-099", - "SI-100", - "SI-101", - "SI-102", - "SI-103", - "SI-176", - "SI-209", - "SI-201", - "SI-104", - "SI-106", - "SI-105", - "SI-108", - "SI-033", - "SI-109", - "SI-183", - "SI-117", - "SI-118", - "SI-119", - "SI-120", - "SI-211", - "SI-110", - "SI-111", - "SI-121", - "SI-122", - "SI-123", - "SI-112", - "SI-113", - "SI-114", - "SI-124", - "SI-206", - "SI-125", - "SI-194", - "SI-179", - "SI-180", - "SI-126", - "SI-115", - "SI-127", - "SI-203", - "SI-204", - "SI-182", - "SI-116", - "SI-210", - "SI-205", - "SI-184", - "SI-010", - "SI-128", - "SI-129", - "SI-130", - "SI-185", - "SI-131", - "SI-186", - "SI-132", - "SI-133", - "SI-187", - "SI-134", - "SI-188", - "SI-135", - "SI-136", - "SI-137", - "SI-138", - "SI-139", - "SI-189", - "SI-140", - "SI-141", - "SI-142", - "SI-190", - "SI-143", - "SI-146", - "SI-191", - "SI-147", - "SI-144", - "SI-193", - "SJ-XX-1", - "SK-BC", - "SK-BL", - "SK-KI", - "SK-NI", - "SK-PV", - "SK-TC", - "SK-TA", - "SK-ZI", - "SL-E", - "SL-N", - "SL-S", - "SL-W", - "SM-07", - "SM-03", - "SM-04", - "SM-09", - "SN-DK", - "SN-DB", - "SN-FK", - "SN-KA", - "SN-KL", - "SN-KE", - "SN-KD", - "SN-LG", - "SN-MT", - "SN-SL", - "SN-SE", - "SN-TC", - "SN-TH", - "SN-ZG", - "SO-AW", - "SO-BN", - "SO-BR", - "SO-GA", - "SO-JH", - "SO-MU", - "SO-NU", - "SO-SH", - "SO-TO", - "SO-WO", - "SR-BR", - "SR-CM", - "SR-NI", - "SR-PR", - "SR-PM", - "SR-SI", - "SR-WA", - "SS-EC", - "SS-EE", - "SS-JG", - "SS-LK", - "SS-BN", - "SS-NU", - "SS-EW", - "ST-01", - "SV-AH", - "SV-CA", - "SV-CH", - "SV-CU", - "SV-LI", - "SV-PA", - "SV-UN", - "SV-MO", - "SV-SM", - "SV-SS", - "SV-SV", - "SV-SA", - "SV-SO", - "SV-US", - "SX-XX-1", - "SY-HA", - "SY-LA", - "SY-QU", - "SY-RA", - "SY-SU", - "SY-DR", - "SY-DY", - "SY-DI", - "SY-HL", - "SY-HM", - "SY-HI", - "SY-ID", - "SY-RD", - "SY-TA", - "SZ-HH", - "SZ-LU", - "SZ-MA", - "TC-XX-1", - "TD-BG", - "TD-CB", - "TD-GR", - "TD-LO", - "TD-ME", - "TD-OD", - "TD-ND", - "TF-XX-1", - "TG-C", - "TG-K", - "TG-M", - "TG-P", - "TH-37", - "TH-15", - "TH-38", - "TH-31", - "TH-24", - "TH-18", - "TH-36", - "TH-22", - "TH-50", - "TH-57", - "TH-20", - "TH-86", - "TH-46", - "TH-62", - "TH-71", - "TH-40", - "TH-81", - "TH-10", - "TH-52", - "TH-51", - "TH-42", - "TH-16", - "TH-58", - "TH-44", - "TH-49", - "TH-26", - "TH-73", - "TH-48", - "TH-30", - "TH-60", - "TH-80", - "TH-55", - "TH-96", - "TH-39", - "TH-43", - "TH-12", - "TH-13", - "TH-94", - "TH-82", - "TH-93", - "TH-56", - "TH-67", - "TH-76", - "TH-66", - "TH-65", - "TH-14", - "TH-54", - "TH-83", - "TH-25", - "TH-77", - "TH-85", - "TH-70", - "TH-21", - "TH-45", - "TH-27", - "TH-47", - "TH-11", - "TH-74", - "TH-75", - "TH-19", - "TH-91", - "TH-33", - "TH-17", - "TH-90", - "TH-64", - "TH-72", - "TH-84", - "TH-32", - "TH-63", - "TH-92", - "TH-23", - "TH-34", - "TH-41", - "TH-61", - "TH-53", - "TH-95", - "TH-35", - "TJ-DU", - "TJ-KT", - "TJ-RA", - "TJ-SU", - "TK-XX-1", - "TL-AN", - "TL-BO", - "TL-CO", - "TL-DI", - "TL-LI", - "TM-A", - "TM-B", - "TM-D", - "TM-L", - "TM-M", - "TN-31", - "TN-13", - "TN-23", - "TN-81", - "TN-71", - "TN-32", - "TN-41", - "TN-42", - "TN-73", - "TN-12", - "TN-14", - "TN-33", - "TN-53", - "TN-82", - "TN-52", - "TN-21", - "TN-61", - "TN-43", - "TN-34", - "TN-51", - "TN-83", - "TN-72", - "TN-11", - "TN-22", - "TO-02", - "TO-03", - "TO-04", - "TR-01", - "TR-02", - "TR-03", - "TR-04", - "TR-68", - "TR-05", - "TR-06", - "TR-07", - "TR-75", - "TR-08", - "TR-09", - "TR-10", - "TR-74", - "TR-72", - "TR-69", - "TR-11", - "TR-12", - "TR-13", - "TR-14", - "TR-15", - "TR-16", - "TR-17", - "TR-18", - "TR-19", - "TR-20", - "TR-21", - "TR-81", - "TR-22", - "TR-23", - "TR-24", - "TR-25", - "TR-26", - "TR-27", - "TR-28", - "TR-29", - "TR-30", - "TR-31", - "TR-76", - "TR-32", - "TR-34", - "TR-35", - "TR-46", - "TR-78", - "TR-70", - "TR-36", - "TR-37", - "TR-38", - "TR-79", - "TR-71", - "TR-39", - "TR-40", - "TR-41", - "TR-42", - "TR-43", - "TR-44", - "TR-45", - "TR-47", - "TR-33", - "TR-48", - "TR-49", - "TR-50", - "TR-51", - "TR-52", - "TR-80", - "TR-53", - "TR-54", - "TR-55", - "TR-63", - "TR-56", - "TR-57", - "TR-73", - "TR-58", - "TR-59", - "TR-60", - "TR-61", - "TR-62", - "TR-64", - "TR-65", - "TR-77", - "TR-66", - "TR-67", - "TT-ARI", - "TT-CHA", - "TT-CTT", - "TT-DMN", - "TT-MRC", - "TT-PED", - "TT-PTF", - "TT-POS", - "TT-PRT", - "TT-SFO", - "TT-SJL", - "TT-SGE", - "TT-SIP", - "TT-TOB", - "TT-TUP", - "TV-FUN", - "TW-CHA", - "TW-CYQ", - "TW-HSQ", - "TW-HUA", - "TW-KHH", - "TW-KEE", - "TW-KIN", - "TW-LIE", - "TW-MIA", - "TW-NAN", - "TW-NWT", - "TW-PEN", - "TW-PIF", - "TW-TXG", - "TW-TNN", - "TW-TPE", - "TW-TTT", - "TW-TAO", - "TW-ILA", - "TW-YUN", - "TZ-01", - "TZ-02", - "TZ-03", - "TZ-27", - "TZ-04", - "TZ-05", - "TZ-06", - "TZ-07", - "TZ-28", - "TZ-08", - "TZ-09", - "TZ-11", - "TZ-12", - "TZ-26", - "TZ-13", - "TZ-14", - "TZ-15", - "TZ-16", - "TZ-17", - "TZ-18", - "TZ-29", - "TZ-19", - "TZ-20", - "TZ-21", - "TZ-22", - "TZ-30", - "TZ-23", - "TZ-31", - "TZ-24", - "TZ-25", - "UA-43", - "UA-71", - "UA-74", - "UA-77", - "UA-12", - "UA-14", - "UA-26", - "UA-63", - "UA-65", - "UA-68", - "UA-35", - "UA-30", - "UA-32", - "UA-09", - "UA-46", - "UA-48", - "UA-51", - "UA-53", - "UA-56", - "UA-40", - "UA-59", - "UA-61", - "UA-05", - "UA-07", - "UA-21", - "UA-23", - "UA-18", - "UG-314", - "UG-301", - "UG-322", - "UG-323", - "UG-315", - "UG-324", - "UG-216", - "UG-316", - "UG-302", - "UG-303", - "UG-217", - "UG-218", - "UG-201", - "UG-420", - "UG-117", - "UG-219", - "UG-118", - "UG-220", - "UG-225", - "UG-401", - "UG-402", - "UG-202", - "UG-221", - "UG-120", - "UG-226", - "UG-317", - "UG-121", - "UG-304", - "UG-403", - "UG-417", - "UG-203", - "UG-418", - "UG-204", - "UG-318", - "UG-404", - "UG-405", - "UG-213", - "UG-101", - "UG-222", - "UG-122", - "UG-102", - "UG-205", - "UG-413", - "UG-206", - "UG-406", - "UG-207", - "UG-112", - "UG-407", - "UG-103", - "UG-227", - "UG-419", - "UG-421", - "UG-408", - "UG-305", - "UG-319", - "UG-306", - "UG-208", - "UG-228", - "UG-123", - "UG-422", - "UG-415", - "UG-326", - "UG-307", - "UG-229", - "UG-104", - "UG-124", - "UG-114", - "UG-223", - "UG-105", - "UG-409", - "UG-214", - "UG-209", - "UG-410", - "UG-423", - "UG-115", - "UG-308", - "UG-309", - "UG-106", - "UG-107", - "UG-108", - "UG-311", - "UG-116", - "UG-109", - "UG-230", - "UG-224", - "UG-327", - "UG-310", - "UG-231", - "UG-411", - "UG-328", - "UG-321", - "UG-312", - "UG-210", - "UG-110", - "UG-425", - "UG-412", - "UG-111", - "UG-232", - "UG-426", - "UG-215", - "UG-211", - "UG-212", - "UG-113", - "UG-313", - "UG-330", - "UM-95", - "US-AL", - "US-AK", - "US-AZ", - "US-AR", - "US-CA", - "US-CO", - "US-CT", - "US-DE", - "US-DC", - "US-FL", - "US-GA", - "US-HI", - "US-ID", - "US-IL", - "US-IN", - "US-IA", - "US-KS", - "US-KY", - "US-LA", - "US-ME", - "US-MD", - "US-MA", - "US-MI", - "US-MN", - "US-MS", - "US-MO", - "US-MT", - "US-NE", - "US-NV", - "US-NH", - "US-NJ", - "US-NM", - "US-NY", - "US-NC", - "US-ND", - "US-OH", - "US-OK", - "US-OR", - "US-PA", - "US-RI", - "US-SC", - "US-SD", - "US-TN", - "US-TX", - "US-UT", - "US-VT", - "US-VA", - "US-WA", - "US-WV", - "US-WI", - "US-WY", - "UY-AR", - "UY-CA", - "UY-CL", - "UY-CO", - "UY-DU", - "UY-FS", - "UY-FD", - "UY-LA", - "UY-MA", - "UY-MO", - "UY-PA", - "UY-RN", - "UY-RV", - "UY-RO", - "UY-SA", - "UY-SJ", - "UY-SO", - "UY-TA", - "UY-TT", - "UZ-AN", - "UZ-BU", - "UZ-FA", - "UZ-JI", - "UZ-NG", - "UZ-NW", - "UZ-QA", - "UZ-QR", - "UZ-SA", - "UZ-SI", - "UZ-SU", - "UZ-TK", - "UZ-XO", - "VA-XX-1", - "VC-01", - "VC-06", - "VC-04", - "VC-05", - "VE-Z", - "VE-B", - "VE-C", - "VE-D", - "VE-E", - "VE-F", - "VE-G", - "VE-H", - "VE-Y", - "VE-A", - "VE-I", - "VE-J", - "VE-X", - "VE-K", - "VE-L", - "VE-M", - "VE-N", - "VE-O", - "VE-P", - "VE-R", - "VE-S", - "VE-T", - "VE-U", - "VE-V", - "VG-XX-1", - "VI-XX-1", - "VN-44", - "VN-43", - "VN-54", - "VN-53", - "VN-55", - "VN-56", - "VN-50", - "VN-31", - "VN-57", - "VN-58", - "VN-40", - "VN-59", - "VN-CT", - "VN-04", - "VN-DN", - "VN-33", - "VN-72", - "VN-71", - "VN-39", - "VN-45", - "VN-30", - "VN-03", - "VN-63", - "VN-HN", - "VN-23", - "VN-61", - "VN-HP", - "VN-73", - "VN-SG", - "VN-14", - "VN-66", - "VN-34", - "VN-47", - "VN-28", - "VN-01", - "VN-35", - "VN-09", - "VN-02", - "VN-41", - "VN-67", - "VN-22", - "VN-18", - "VN-36", - "VN-68", - "VN-32", - "VN-24", - "VN-27", - "VN-29", - "VN-13", - "VN-25", - "VN-52", - "VN-05", - "VN-37", - "VN-20", - "VN-69", - "VN-21", - "VN-26", - "VN-46", - "VN-51", - "VN-07", - "VN-49", - "VN-70", - "VN-06", - "VU-SEE", - "VU-TAE", - "VU-TOB", - "WF-SG", - "WF-UV", - "WS-AT", - "WS-FA", - "WS-TU", - "YE-AD", - "YE-AM", - "YE-AB", - "YE-DA", - "YE-BA", - "YE-HU", - "YE-SA", - "YE-DH", - "YE-HD", - "YE-HJ", - "YE-IB", - "YE-LA", - "YE-MA", - "YE-SD", - "YE-SN", - "YE-SH", - "YE-TA", - "YT-XX-1", - "YT-XX-2", - "YT-XX-3", - "YT-XX-4", - "YT-XX-5", - "YT-XX-6", - "ZA-EC", - "ZA-FS", - "ZA-GP", - "ZA-KZN", - "ZA-LP", - "ZA-MP", - "ZA-NW", - "ZA-NC", - "ZA-WC", - "ZM-02", - "ZM-08", - "ZM-03", - "ZM-04", - "ZM-09", - "ZM-10", - "ZM-06", - "ZM-05", - "ZM-07", - "ZM-01", - "ZW-BU", - "ZW-HA", - "ZW-MA", - "ZW-MC", - "ZW-ME", - "ZW-MW", - "ZW-MV", - "ZW-MN", - "ZW-MS", - "ZW-MI", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "street_1": { - "description": "The first line of the address", - "example": "Water Lane", - "nullable": true, - "type": "string", - }, - "street_2": { - "description": "The second line of the address", - "example": "Woolsthorpe by Colsterworth", - "nullable": true, - "type": "string", - }, - "zip_code": { - "description": "The ZIP code/Postal code of the location", - "example": "NG33 5NR", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "job_id": { - "description": "The employee job id", - "example": "R-6789", - "nullable": true, - "type": "string", - }, - "job_title": { - "description": "The employee job title", - "example": "Physicist", - "nullable": true, - "type": "string", - }, - "last_name": { - "description": "The employee last name", - "example": "Newton", - "nullable": true, - "type": "string", - }, - "manager_id": { - "description": "The employee manager ID", - "example": "67890", - "nullable": true, - "type": "string", - }, - "marital_status": { - "description": "The employee marital status", - "example": "single", - "nullable": true, - "properties": { - "value": { - "enum": [ - "single", - "married", - "common_law", - "divorced", - "widowed", - "domestic_partnership", - "separated", - "other", - "not_disclosed", - "unmapped_value", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "name": { - "description": "The employee name", - "example": "Issac Newton", - "nullable": true, - "type": "string", - }, - "national_identity_number": { - "deprecated": true, - "description": "The national identity number", - "nullable": true, - "properties": { - "country": { - "description": "The country code", - "nullable": true, - "properties": { - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "type": { - "nullable": true, - "properties": { - "value": { - "description": "The type of the national identity number", - "enum": [ - "ssn", - "nin", - "sin", - "nid", - "pin", - "pn", - "umcn", - "pic", - "ric", - "idnum", - "cid", - "nidnr", - "pan", - "aadhaar", - "epic", - "ptn", - "itin", - "tin", - "uprc", - "pcode", - "ssi", - "cedula", - "passport", - "voterid", - "ntin", - "bn", - "fnr", - "mva", - "civil_id", - "cnic", - "nric", - "fin", - "uen", - "registrationnumber", - "nic", - "personnummer", - "ahv", - "id", - "eid", - "va", - "pid", - "nrt", - "nipt", - "cbu", - "cuit", - "dni", - "businessid", - "vnr", - "abn", - "acn", - "tfn", - "jmbg", - "bis", - "insz", - "nn", - "egn", - "pnf", - "vat", - "cnpj", - "unp", - "gst", - "pst", - "qst", - "ni", - "dic", - "rc", - "uid", - "rut", - "uscc", - "cpf", - "cpj", - "cr", - "stnr", - "svnr", - "ncf", - "rnc", - "nif", - "ci", - "ik", - "kmkr", - "registrikood", - "tn", - "ruc", - "nit", - "alv", - "hetu", - "ytunnus", - "vn", - "utr", - "nifp", - "amka", - "cui", - "nir", - "siren", - "siret", - "tva", - "oib", - "hkid", - "anum", - "kennitala", - "vsk", - "npwp", - "pps", - "gstin", - "idnr", - "hr", - "aic", - "codicefiscale", - "iva", - "peid", - "asmens", - "pvm", - "ctps", - "vrn", - "vtk", - "int", - "tk", - "pas", - "rne", - "rg", - "nci", - "crnm", - "pis", - "insee", - "tax", - "mpf", - "epfo", - "esi", - "pran", - "uan", - "idk", - "bsn", - "mid", - "sss", - "nie", - "nss", - "arc", - "curp", - "imss", - "rfc", - "ein", - "other", - "unknown", - null, - ], - "example": "ssn", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "value": { - "example": "123456789", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "national_identity_numbers": { - "description": "The national identity numbers", - "items": { - "properties": { - "country": { - "description": "The country code", - "nullable": true, - "properties": { - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "type": { - "nullable": true, - "properties": { - "value": { - "description": "The type of the national identity number", - "enum": [ - "ssn", - "nin", - "sin", - "nid", - "pin", - "pn", - "umcn", - "pic", - "ric", - "idnum", - "cid", - "nidnr", - "pan", - "aadhaar", - "epic", - "ptn", - "itin", - "tin", - "uprc", - "pcode", - "ssi", - "cedula", - "passport", - "voterid", - "ntin", - "bn", - "fnr", - "mva", - "civil_id", - "cnic", - "nric", - "fin", - "uen", - "registrationnumber", - "nic", - "personnummer", - "ahv", - "id", - "eid", - "va", - "pid", - "nrt", - "nipt", - "cbu", - "cuit", - "dni", - "businessid", - "vnr", - "abn", - "acn", - "tfn", - "jmbg", - "bis", - "insz", - "nn", - "egn", - "pnf", - "vat", - "cnpj", - "unp", - "gst", - "pst", - "qst", - "ni", - "dic", - "rc", - "uid", - "rut", - "uscc", - "cpf", - "cpj", - "cr", - "stnr", - "svnr", - "ncf", - "rnc", - "nif", - "ci", - "ik", - "kmkr", - "registrikood", - "tn", - "ruc", - "nit", - "alv", - "hetu", - "ytunnus", - "vn", - "utr", - "nifp", - "amka", - "cui", - "nir", - "siren", - "siret", - "tva", - "oib", - "hkid", - "anum", - "kennitala", - "vsk", - "npwp", - "pps", - "gstin", - "idnr", - "hr", - "aic", - "codicefiscale", - "iva", - "peid", - "asmens", - "pvm", - "ctps", - "vrn", - "vtk", - "int", - "tk", - "pas", - "rne", - "rg", - "nci", - "crnm", - "pis", - "insee", - "tax", - "mpf", - "epfo", - "esi", - "pran", - "uan", - "idk", - "bsn", - "mid", - "sss", - "nie", - "nss", - "arc", - "curp", - "imss", - "rfc", - "ein", - "other", - "unknown", - null, - ], - "example": "ssn", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "value": { - "example": "123456789", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "nullable": true, - "type": "array", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "nullable": true, - "type": "object", - }, - "personal_email": { - "description": "The employee personal email", - "example": "isaac.newton@example.com", - "nullable": true, - "type": "string", - }, - "personal_phone_number": { - "description": "The employee personal phone number", - "example": "+1234567890", - "nullable": true, - "type": "string", - }, - "preferred_language": { - "description": "The employee preferred language", - "example": "en_US", - "nullable": true, - "properties": { - "value": { - "description": "The ISO639-2 Code of the language", - "enum": [ - "aar", - "afr", - "amh", - "ara", - "aym", - "aze", - "bel", - "bul", - "bis", - "ben", - "bos", - "byn", - "cat", - "cha", - "ces", - "deu", - "div", - "dzo", - "ell", - "eng", - "spa", - "est", - "fas", - "fan", - "ful", - "fin", - "fij", - "fao", - "fra", - "gle", - "grn", - "glv", - "heb", - "hin", - "hrv", - "hat", - "hun", - "hye", - "ind", - "isl", - "ita", - "jpn", - "kat", - "kon", - "kaz", - "kal", - "khm", - "kor", - "kur", - "kir", - "lat", - "ltz", - "lin", - "lao", - "lit", - "lub", - "lav", - "mlg", - "mah", - "mri", - "mkd", - "msa", - "mlt", - "mya", - "nob", - "nep", - "nld", - "nno", - "nor", - "nbl", - "nya", - "pan", - "pol", - "pus", - "por", - "rar", - "roh", - "rup", - "ron", - "rus", - "kin", - "sag", - "sin", - "slk", - "smo", - "sna", - "som", - "sqi", - "srp", - "ssw", - "swe", - "swa", - "tam", - "tgk", - "tha", - "tir", - "tig", - "zho", - "unmapped_value", - null, - ], - "example": "eng", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "start_date": { - "description": "The employee start date", - "example": "2021-01-01T00:00.000Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - "tenure": { - "description": "The employee tenure", - "example": 2, - "nullable": true, - "type": "number", - }, - "termination_date": { - "description": "The employee termination date", - "example": "2021-01-01T00:00:00Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - "work_anniversary": { - "description": "The employee work anniversary", - "example": "2021-01-01T00:00:00Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - "work_email": { - "description": "The employee work email", - "example": "newton@example.com", - "nullable": true, - "type": "string", - }, - "work_location": { - "description": "The employee work location", - "nullable": true, - "properties": { - "city": { - "description": "The city where the location is situated", - "example": "Grantham", - "nullable": true, - "type": "string", - }, - "country": { - "description": "The country code", - "nullable": true, - "properties": { - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string", - }, - "name": { - "description": "The name of the location", - "example": "Woolsthorpe Manor", - "nullable": true, - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "nullable": true, - "type": "object", - }, - "phone_number": { - "description": "The phone number of the location", - "example": "+44 1476 860 364", - "nullable": true, - "type": "string", - }, - "state": { - "description": "The ISO3166-2 sub division where the location is situated", - "example": "GB-LIN", - "nullable": true, - "properties": { - "value": { - "enum": [ - "AD-07", - "AD-02", - "AD-03", - "AD-08", - "AD-04", - "AD-05", - "AD-06", - "AE-AJ", - "AE-AZ", - "AE-FU", - "AE-SH", - "AE-DU", - "AE-RK", - "AE-UQ", - "AF-BDS", - "AF-BDG", - "AF-BGL", - "AF-BAL", - "AF-BAM", - "AF-DAY", - "AF-FRA", - "AF-FYB", - "AF-GHA", - "AF-GHO", - "AF-HEL", - "AF-HER", - "AF-JOW", - "AF-KAB", - "AF-KAN", - "AF-KAP", - "AF-KHO", - "AF-KDZ", - "AF-LAG", - "AF-LOG", - "AF-NAN", - "AF-NIM", - "AF-PIA", - "AF-PAR", - "AF-SAR", - "AF-TAK", - "AF-URU", - "AG-11", - "AG-03", - "AG-04", - "AG-06", - "AG-07", - "AG-08", - "AI-XX-1", - "AL-01", - "AL-09", - "AL-02", - "AL-03", - "AL-04", - "AL-05", - "AL-06", - "AL-07", - "AL-08", - "AL-10", - "AL-11", - "AL-12", - "AM-AG", - "AM-AR", - "AM-AV", - "AM-ER", - "AM-GR", - "AM-KT", - "AM-LO", - "AM-SH", - "AM-SU", - "AM-TV", - "AM-VD", - "AO-BGO", - "AO-BGU", - "AO-BIE", - "AO-CAB", - "AO-CCU", - "AO-CNO", - "AO-CUS", - "AO-CNN", - "AO-HUA", - "AO-HUI", - "AO-LUA", - "AO-LNO", - "AO-LSU", - "AO-MAL", - "AO-MOX", - "AO-NAM", - "AO-UIG", - "AO-ZAI", - "AQ-XX-1", - "AR-B", - "AR-K", - "AR-H", - "AR-U", - "AR-C", - "AR-X", - "AR-W", - "AR-E", - "AR-P", - "AR-Y", - "AR-L", - "AR-F", - "AR-M", - "AR-N", - "AR-Q", - "AR-R", - "AR-A", - "AR-J", - "AR-D", - "AR-Z", - "AR-S", - "AR-G", - "AR-V", - "AR-T", - "AS-XX-1", - "AS-XX-2", - "AT-1", - "AT-2", - "AT-3", - "AT-4", - "AT-5", - "AT-6", - "AT-7", - "AT-8", - "AT-9", - "AU-ACT", - "AU-NSW", - "AU-NT", - "AU-QLD", - "AU-SA", - "AU-TAS", - "AU-VIC", - "AU-WA", - "AW-XX-1", - "AX-XX-1", - "AX-XX-2", - "AX-XX-3", - "AX-XX-4", - "AX-XX-5", - "AX-XX-6", - "AX-XX-7", - "AX-XX-8", - "AZ-ABS", - "AZ-AGC", - "AZ-AGU", - "AZ-AST", - "AZ-BA", - "AZ-BAL", - "AZ-BAR", - "AZ-BEY", - "AZ-BIL", - "AZ-CAL", - "AZ-FUZ", - "AZ-GAD", - "AZ-GA", - "AZ-GOR", - "AZ-GOY", - "AZ-GYG", - "AZ-IMI", - "AZ-ISM", - "AZ-KUR", - "AZ-LA", - "AZ-MAS", - "AZ-MI", - "AZ-NA", - "AZ-NX", - "AZ-NEF", - "AZ-OGU", - "AZ-QAB", - "AZ-QAX", - "AZ-QAZ", - "AZ-QBA", - "AZ-QUS", - "AZ-SAT", - "AZ-SAB", - "AZ-SAK", - "AZ-SAL", - "AZ-SMI", - "AZ-SKR", - "AZ-SMX", - "AZ-SR", - "AZ-SM", - "AZ-TAR", - "AZ-UCA", - "AZ-XAC", - "AZ-XVD", - "AZ-YAR", - "AZ-YEV", - "AZ-ZAQ", - "AZ-ZAR", - "BA-BRC", - "BA-BIH", - "BA-SRP", - "BB-01", - "BB-02", - "BB-03", - "BB-04", - "BB-05", - "BB-07", - "BB-08", - "BB-09", - "BB-10", - "BB-11", - "BD-A", - "BD-B", - "BD-C", - "BD-D", - "BD-E", - "BD-F", - "BD-G", - "BE-VAN", - "BE-WBR", - "BE-BRU", - "BE-WHT", - "BE-WLG", - "BE-VLI", - "BE-WLX", - "BE-WNA", - "BE-VOV", - "BE-VBR", - "BE-VWV", - "BF-BAM", - "BF-BAZ", - "BF-BLG", - "BF-BLK", - "BF-COM", - "BF-GAN", - "BF-GNA", - "BF-GOU", - "BF-HOU", - "BF-IOB", - "BF-KAD", - "BF-KEN", - "BF-KMP", - "BF-KOS", - "BF-KOT", - "BF-KOW", - "BF-LER", - "BF-LOR", - "BF-MOU", - "BF-NAO", - "BF-NAM", - "BF-NAY", - "BF-OUB", - "BF-OUD", - "BF-PAS", - "BF-PON", - "BF-SNG", - "BF-SMT", - "BF-SEN", - "BF-SIS", - "BF-SOM", - "BF-SOR", - "BF-TAP", - "BF-TUI", - "BF-YAT", - "BF-ZIR", - "BF-ZON", - "BF-ZOU", - "BG-01", - "BG-02", - "BG-08", - "BG-07", - "BG-26", - "BG-09", - "BG-10", - "BG-11", - "BG-12", - "BG-13", - "BG-14", - "BG-15", - "BG-16", - "BG-17", - "BG-18", - "BG-27", - "BG-19", - "BG-20", - "BG-21", - "BG-23", - "BG-22", - "BG-24", - "BG-25", - "BG-03", - "BG-04", - "BG-05", - "BG-06", - "BG-28", - "BH-13", - "BH-14", - "BH-15", - "BH-17", - "BI-BM", - "BI-CI", - "BI-GI", - "BI-KR", - "BI-KI", - "BI-MW", - "BI-NG", - "BI-RM", - "BI-RT", - "BI-RY", - "BJ-AK", - "BJ-AQ", - "BJ-BO", - "BJ-CO", - "BJ-DO", - "BJ-LI", - "BJ-MO", - "BJ-OU", - "BJ-PL", - "BJ-ZO", - "BL-XX-1", - "BM-XX-1", - "BM-XX-2", - "BN-BE", - "BN-BM", - "BN-TE", - "BN-TU", - "BO-H", - "BO-C", - "BO-B", - "BO-L", - "BO-O", - "BO-N", - "BO-P", - "BO-S", - "BO-T", - "BQ-BO", - "BQ-SA", - "BQ-SE", - "BR-AC", - "BR-AL", - "BR-AP", - "BR-AM", - "BR-BA", - "BR-CE", - "BR-DF", - "BR-ES", - "BR-GO", - "BR-MA", - "BR-MT", - "BR-MS", - "BR-MG", - "BR-PA", - "BR-PB", - "BR-PR", - "BR-PE", - "BR-PI", - "BR-RN", - "BR-RS", - "BR-RJ", - "BR-RO", - "BR-RR", - "BR-SC", - "BR-SP", - "BR-SE", - "BR-TO", - "BS-BP", - "BS-CO", - "BS-FP", - "BS-EG", - "BS-HI", - "BS-LI", - "BS-NP", - "BS-NO", - "BS-NS", - "BS-NE", - "BS-SE", - "BS-WG", - "BT-33", - "BT-12", - "BT-22", - "BT-GA", - "BT-44", - "BT-42", - "BT-11", - "BT-43", - "BT-23", - "BT-45", - "BT-14", - "BT-31", - "BT-15", - "BT-41", - "BT-32", - "BT-21", - "BT-24", - "BV-XX-1", - "BW-CE", - "BW-CH", - "BW-GH", - "BW-KG", - "BW-KL", - "BW-KW", - "BW-NE", - "BW-NW", - "BW-SE", - "BW-SO", - "BY-BR", - "BY-HO", - "BY-HM", - "BY-HR", - "BY-MA", - "BY-MI", - "BY-VI", - "BZ-BZ", - "BZ-CY", - "BZ-CZL", - "BZ-OW", - "BZ-SC", - "BZ-TOL", - "CA-AB", - "CA-BC", - "CA-MB", - "CA-NB", - "CA-NL", - "CA-NT", - "CA-NS", - "CA-NU", - "CA-ON", - "CA-PE", - "CA-QC", - "CA-SK", - "CA-YT", - "CC-XX-1", - "CD-EQ", - "CD-HK", - "CD-HL", - "CD-IT", - "CD-KC", - "CD-KE", - "CD-KN", - "CD-BC", - "CD-KG", - "CD-KL", - "CD-LU", - "CD-NK", - "CD-SA", - "CD-SK", - "CD-TA", - "CD-TO", - "CD-TU", - "CF-BB", - "CF-BGF", - "CF-KB", - "CF-HM", - "CF-KG", - "CF-NM", - "CF-UK", - "CF-AC", - "CF-OP", - "CF-VK", - "CG-11", - "CG-BZV", - "CG-8", - "CG-9", - "CG-16", - "CG-13", - "CH-AG", - "CH-AR", - "CH-AI", - "CH-BL", - "CH-BS", - "CH-BE", - "CH-FR", - "CH-GE", - "CH-GL", - "CH-GR", - "CH-JU", - "CH-LU", - "CH-NE", - "CH-NW", - "CH-OW", - "CH-SG", - "CH-SH", - "CH-SZ", - "CH-SO", - "CH-TG", - "CH-TI", - "CH-UR", - "CH-VS", - "CH-VD", - "CH-ZG", - "CH-ZH", - "CI-AB", - "CI-BS", - "CI-CM", - "CI-DN", - "CI-GD", - "CI-LC", - "CI-LG", - "CI-MG", - "CI-SM", - "CI-SV", - "CI-VB", - "CI-WR", - "CI-YM", - "CI-ZZ", - "CK-XX-1", - "CL-AI", - "CL-AN", - "CL-AP", - "CL-AT", - "CL-BI", - "CL-CO", - "CL-AR", - "CL-LI", - "CL-LL", - "CL-LR", - "CL-MA", - "CL-ML", - "CL-NB", - "CL-RM", - "CL-TA", - "CL-VS", - "CM-AD", - "CM-CE", - "CM-ES", - "CM-EN", - "CM-LT", - "CM-NO", - "CM-NW", - "CM-OU", - "CM-SU", - "CM-SW", - "CN-AH", - "CN-BJ", - "CN-CQ", - "CN-FJ", - "CN-GS", - "CN-GD", - "CN-GX", - "CN-GZ", - "CN-HI", - "CN-HE", - "CN-HL", - "CN-HA", - "CN-HB", - "CN-HN", - "CN-JS", - "CN-JX", - "CN-JL", - "CN-LN", - "CN-NM", - "CN-NX", - "CN-QH", - "CN-SN", - "CN-SD", - "CN-SH", - "CN-SX", - "CN-SC", - "CN-TJ", - "CN-XJ", - "CN-XZ", - "CN-YN", - "CN-ZJ", - "CO-AMA", - "CO-ANT", - "CO-ARA", - "CO-ATL", - "CO-BOL", - "CO-BOY", - "CO-CAL", - "CO-CAQ", - "CO-CAS", - "CO-CAU", - "CO-CES", - "CO-CHO", - "CO-COR", - "CO-CUN", - "CO-DC", - "CO-GUA", - "CO-GUV", - "CO-HUI", - "CO-LAG", - "CO-MAG", - "CO-MET", - "CO-NAR", - "CO-NSA", - "CO-PUT", - "CO-QUI", - "CO-RIS", - "CO-SAP", - "CO-SAN", - "CO-SUC", - "CO-TOL", - "CO-VAC", - "CO-VID", - "CR-A", - "CR-C", - "CR-G", - "CR-H", - "CR-L", - "CR-P", - "CR-SJ", - "CU-15", - "CU-09", - "CU-08", - "CU-06", - "CU-12", - "CU-14", - "CU-11", - "CU-03", - "CU-10", - "CU-04", - "CU-16", - "CU-01", - "CU-07", - "CU-13", - "CU-05", - "CV-BV", - "CV-BR", - "CV-MO", - "CV-PN", - "CV-PR", - "CV-RS", - "CV-SL", - "CV-CR", - "CV-SD", - "CV-SO", - "CV-SV", - "CV-TA", - "CV-TS", - "CW-XX-1", - "CX-XX-1", - "CY-04", - "CY-06", - "CY-03", - "CY-01", - "CY-02", - "CY-05", - "CZ-31", - "CZ-64", - "CZ-41", - "CZ-63", - "CZ-52", - "CZ-51", - "CZ-80", - "CZ-71", - "CZ-53", - "CZ-32", - "CZ-10", - "CZ-20", - "CZ-42", - "CZ-72", - "DE-BW", - "DE-BY", - "DE-BE", - "DE-BB", - "DE-HB", - "DE-HH", - "DE-HE", - "DE-MV", - "DE-NI", - "DE-NW", - "DE-RP", - "DE-SL", - "DE-SN", - "DE-ST", - "DE-SH", - "DE-TH", - "DJ-AR", - "DJ-DJ", - "DK-84", - "DK-82", - "DK-81", - "DK-85", - "DK-83", - "DM-02", - "DM-04", - "DM-05", - "DM-06", - "DM-07", - "DM-09", - "DM-10", - "DO-02", - "DO-03", - "DO-04", - "DO-05", - "DO-01", - "DO-06", - "DO-08", - "DO-07", - "DO-09", - "DO-30", - "DO-19", - "DO-10", - "DO-11", - "DO-12", - "DO-13", - "DO-14", - "DO-28", - "DO-15", - "DO-29", - "DO-17", - "DO-18", - "DO-20", - "DO-21", - "DO-31", - "DO-22", - "DO-23", - "DO-24", - "DO-25", - "DO-26", - "DO-27", - "DZ-01", - "DZ-44", - "DZ-46", - "DZ-16", - "DZ-23", - "DZ-05", - "DZ-08", - "DZ-06", - "DZ-07", - "DZ-09", - "DZ-34", - "DZ-10", - "DZ-35", - "DZ-02", - "DZ-25", - "DZ-17", - "DZ-32", - "DZ-39", - "DZ-36", - "DZ-47", - "DZ-24", - "DZ-33", - "DZ-18", - "DZ-40", - "DZ-03", - "DZ-28", - "DZ-29", - "DZ-26", - "DZ-43", - "DZ-27", - "DZ-45", - "DZ-31", - "DZ-30", - "DZ-04", - "DZ-48", - "DZ-20", - "DZ-19", - "DZ-22", - "DZ-21", - "DZ-41", - "DZ-11", - "DZ-12", - "DZ-14", - "DZ-37", - "DZ-42", - "DZ-38", - "DZ-15", - "DZ-13", - "EC-A", - "EC-B", - "EC-F", - "EC-C", - "EC-H", - "EC-X", - "EC-O", - "EC-E", - "EC-W", - "EC-G", - "EC-I", - "EC-L", - "EC-R", - "EC-M", - "EC-S", - "EC-N", - "EC-D", - "EC-Y", - "EC-P", - "EC-SE", - "EC-SD", - "EC-U", - "EC-T", - "EC-Z", - "EE-37", - "EE-39", - "EE-45", - "EE-52", - "EE-50", - "EE-60", - "EE-56", - "EE-68", - "EE-64", - "EE-71", - "EE-74", - "EE-79", - "EE-81", - "EE-84", - "EE-87", - "EG-DK", - "EG-BA", - "EG-BH", - "EG-FYM", - "EG-GH", - "EG-ALX", - "EG-IS", - "EG-GZ", - "EG-MNF", - "EG-MN", - "EG-C", - "EG-KB", - "EG-LX", - "EG-WAD", - "EG-SUZ", - "EG-SHR", - "EG-ASN", - "EG-AST", - "EG-BNS", - "EG-PTS", - "EG-DT", - "EG-JS", - "EG-KFS", - "EG-MT", - "EG-KN", - "EG-SIN", - "EG-SHG", - "EH-XX-1", - "ER-MA", - "ER-DK", - "ER-SK", - "ES-AN", - "ES-AR", - "ES-AS", - "ES-CN", - "ES-CB", - "ES-CL", - "ES-CM", - "ES-CT", - "ES-CE", - "ES-EX", - "ES-GA", - "ES-IB", - "ES-RI", - "ES-MD", - "ES-ML", - "ES-MC", - "ES-NC", - "ES-PV", - "ES-VC", - "ET-AA", - "ET-AF", - "ET-AM", - "ET-BE", - "ET-DD", - "ET-GA", - "ET-HA", - "ET-OR", - "ET-SO", - "ET-TI", - "ET-SN", - "FI-02", - "FI-03", - "FI-04", - "FI-05", - "FI-06", - "FI-07", - "FI-08", - "FI-09", - "FI-10", - "FI-16", - "FI-11", - "FI-12", - "FI-13", - "FI-14", - "FI-15", - "FI-17", - "FI-18", - "FI-19", - "FJ-C", - "FJ-E", - "FJ-N", - "FJ-R", - "FJ-W", - "FK-XX-1", - "FM-TRK", - "FM-KSA", - "FM-PNI", - "FM-YAP", - "FO-XX-1", - "FO-XX-2", - "FO-XX-3", - "FO-XX-4", - "FO-XX-5", - "FR-ARA", - "FR-BFC", - "FR-BRE", - "FR-CVL", - "FR-20R", - "FR-GES", - "FR-HDF", - "FR-IDF", - "FR-NOR", - "FR-NAQ", - "FR-OCC", - "FR-PDL", - "FR-PAC", - "GA-1", - "GA-2", - "GA-4", - "GA-5", - "GA-8", - "GA-9", - "GB-ENG", - "GB-NIR", - "GB-SCT", - "GB-WLS", - "GB-CAM", - "GB-CMA", - "GB-DBY", - "GB-DEV", - "GB-DOR", - "GB-ESX", - "GB-ESS", - "GB-GLS", - "GB-HAM", - "GB-HRT", - "GB-KEN", - "GB-LAN", - "GB-LEC", - "GB-LIN", - "GB-NFK", - "GB-NYK", - "GB-NTT", - "GB-OXF", - "GB-SOM", - "GB-STS", - "GB-SFK", - "GB-SRY", - "GB-WAR", - "GB-WSX", - "GB-WOR", - "GB-LND", - "GB-BDG", - "GB-BNE", - "GB-BEX", - "GB-BEN", - "GB-BRY", - "GB-CMD", - "GB-CRY", - "GB-EAL", - "GB-ENF", - "GB-GRE", - "GB-HCK", - "GB-HMF", - "GB-HRY", - "GB-HRW", - "GB-HAV", - "GB-HIL", - "GB-HNS", - "GB-ISL", - "GB-KEC", - "GB-KTT", - "GB-LBH", - "GB-LEW", - "GB-MRT", - "GB-NWM", - "GB-RDB", - "GB-RIC", - "GB-SWK", - "GB-STN", - "GB-TWH", - "GB-WFT", - "GB-WND", - "GB-WSM", - "GB-BNS", - "GB-BIR", - "GB-BOL", - "GB-BRD", - "GB-BUR", - "GB-CLD", - "GB-COV", - "GB-DNC", - "GB-DUD", - "GB-GAT", - "GB-KIR", - "GB-KWL", - "GB-LDS", - "GB-LIV", - "GB-MAN", - "GB-NET", - "GB-NTY", - "GB-OLD", - "GB-RCH", - "GB-ROT", - "GB-SHN", - "GB-SLF", - "GB-SAW", - "GB-SFT", - "GB-SHF", - "GB-SOL", - "GB-STY", - "GB-SKP", - "GB-SND", - "GB-TAM", - "GB-TRF", - "GB-WKF", - "GB-WLL", - "GB-WGN", - "GB-WRL", - "GB-WLV", - "GB-BAS", - "GB-BDF", - "GB-BBD", - "GB-BPL", - "GB-BCP", - "GB-BRC", - "GB-BNH", - "GB-BST", - "GB-BKM", - "GB-CBF", - "GB-CHE", - "GB-CHW", - "GB-CON", - "GB-DAL", - "GB-DER", - "GB-DUR", - "GB-ERY", - "GB-HAL", - "GB-HPL", - "GB-HEF", - "GB-IOW", - "GB-IOS", - "GB-KHL", - "GB-LCE", - "GB-LUT", - "GB-MDW", - "GB-MDB", - "GB-MIK", - "GB-NEL", - "GB-NLN", - "GB-NNH", - "GB-NSM", - "GB-NBL", - "GB-NGM", - "GB-PTE", - "GB-PLY", - "GB-POR", - "GB-RDG", - "GB-RCC", - "GB-RUT", - "GB-SHR", - "GB-SLG", - "GB-SGC", - "GB-STH", - "GB-SOS", - "GB-STT", - "GB-STE", - "GB-SWD", - "GB-TFW", - "GB-THR", - "GB-TOB", - "GB-WRT", - "GB-WBK", - "GB-WNH", - "GB-WIL", - "GB-WNM", - "GB-WOK", - "GB-YOR", - "GB-ANN", - "GB-AND", - "GB-ABC", - "GB-BFS", - "GB-CCG", - "GB-DRS", - "GB-FMO", - "GB-LBC", - "GB-MEA", - "GB-MUL", - "GB-NMD", - "GB-ABE", - "GB-ABD", - "GB-ANS", - "GB-AGB", - "GB-CLK", - "GB-DGY", - "GB-DND", - "GB-EAY", - "GB-EDU", - "GB-ELN", - "GB-ERW", - "GB-EDH", - "GB-ELS", - "GB-FAL", - "GB-FIF", - "GB-GLG", - "GB-HLD", - "GB-IVC", - "GB-MLN", - "GB-MRY", - "GB-NAY", - "GB-NLK", - "GB-ORK", - "GB-PKN", - "GB-RFW", - "GB-SCB", - "GB-ZET", - "GB-SAY", - "GB-SLK", - "GB-STG", - "GB-WDU", - "GB-WLN", - "GB-BGW", - "GB-BGE", - "GB-CAY", - "GB-CRF", - "GB-CMN", - "GB-CGN", - "GB-CWY", - "GB-DEN", - "GB-FLN", - "GB-GWN", - "GB-AGY", - "GB-MTY", - "GB-MON", - "GB-NTL", - "GB-NWP", - "GB-PEM", - "GB-POW", - "GB-RCT", - "GB-SWA", - "GB-TOF", - "GB-VGL", - "GB-WRX", - "GD-01", - "GD-02", - "GD-03", - "GD-04", - "GD-05", - "GD-06", - "GD-10", - "GE-AB", - "GE-AJ", - "GE-GU", - "GE-IM", - "GE-KA", - "GE-KK", - "GE-MM", - "GE-RL", - "GE-SZ", - "GE-SJ", - "GE-SK", - "GE-TB", - "GF-XX-1", - "GG-XX-1", - "GH-AF", - "GH-AH", - "GH-BO", - "GH-BE", - "GH-CP", - "GH-EP", - "GH-AA", - "GH-NP", - "GH-UE", - "GH-UW", - "GH-TV", - "GH-WP", - "GI-XX-1", - "GL-AV", - "GL-KU", - "GL-QT", - "GL-SM", - "GL-QE", - "GM-B", - "GM-M", - "GM-L", - "GM-N", - "GM-U", - "GM-W", - "GN-BF", - "GN-B", - "GN-C", - "GN-CO", - "GN-DB", - "GN-DU", - "GN-K", - "GN-L", - "GN-LA", - "GN-MC", - "GN-N", - "GN-SI", - "GP-XX-1", - "GQ-BN", - "GQ-KN", - "GQ-LI", - "GQ-WN", - "GR-A", - "GR-I", - "GR-G", - "GR-C", - "GR-F", - "GR-D", - "GR-B", - "GR-M", - "GR-L", - "GR-J", - "GR-H", - "GR-E", - "GR-K", - "GS-XX-1", - "GT-16", - "GT-15", - "GT-04", - "GT-20", - "GT-02", - "GT-05", - "GT-01", - "GT-13", - "GT-18", - "GT-21", - "GT-22", - "GT-17", - "GT-09", - "GT-14", - "GT-11", - "GT-03", - "GT-12", - "GT-06", - "GT-07", - "GT-10", - "GT-08", - "GT-19", - "GU-XX-1", - "GU-XX-2", - "GU-XX-3", - "GU-XX-4", - "GU-XX-5", - "GU-XX-6", - "GU-XX-7", - "GU-XX-8", - "GU-XX-9", - "GU-XX-10", - "GU-XX-11", - "GU-XX-12", - "GU-XX-13", - "GU-XX-14", - "GU-XX-15", - "GU-XX-16", - "GW-BS", - "GW-GA", - "GY-CU", - "GY-DE", - "GY-EB", - "GY-ES", - "GY-MA", - "GY-PT", - "GY-UD", - "HK-XX-1", - "HM-XX-1", - "HN-AT", - "HN-CH", - "HN-CL", - "HN-CM", - "HN-CP", - "HN-CR", - "HN-EP", - "HN-FM", - "HN-GD", - "HN-IN", - "HN-IB", - "HN-LP", - "HN-LE", - "HN-OC", - "HN-OL", - "HN-SB", - "HN-VA", - "HN-YO", - "HR-07", - "HR-12", - "HR-19", - "HR-21", - "HR-18", - "HR-04", - "HR-06", - "HR-02", - "HR-09", - "HR-20", - "HR-14", - "HR-11", - "HR-08", - "HR-15", - "HR-03", - "HR-17", - "HR-05", - "HR-10", - "HR-16", - "HR-13", - "HR-01", - "HT-AR", - "HT-CE", - "HT-GA", - "HT-NI", - "HT-ND", - "HT-OU", - "HT-SD", - "HT-SE", - "HU-BK", - "HU-BA", - "HU-BE", - "HU-BZ", - "HU-BU", - "HU-CS", - "HU-FE", - "HU-GS", - "HU-HB", - "HU-HE", - "HU-JN", - "HU-KE", - "HU-NO", - "HU-PE", - "HU-SO", - "HU-SZ", - "HU-TO", - "HU-VA", - "HU-VE", - "HU-ZA", - "ID-AC", - "ID-BA", - "ID-BT", - "ID-BE", - "ID-GO", - "ID-JK", - "ID-JA", - "ID-JB", - "ID-JT", - "ID-JI", - "ID-KB", - "ID-KS", - "ID-KT", - "ID-KI", - "ID-KU", - "ID-BB", - "ID-KR", - "ID-LA", - "ID-ML", - "ID-MU", - "ID-NB", - "ID-NT", - "ID-PP", - "ID-PB", - "ID-RI", - "ID-SR", - "ID-SN", - "ID-ST", - "ID-SG", - "ID-SA", - "ID-SB", - "ID-SS", - "ID-SU", - "ID-YO", - "IE-CW", - "IE-CN", - "IE-CE", - "IE-CO", - "IE-DL", - "IE-D", - "IE-G", - "IE-KY", - "IE-KE", - "IE-KK", - "IE-LS", - "IE-LM", - "IE-LK", - "IE-LD", - "IE-LH", - "IE-MO", - "IE-MH", - "IE-MN", - "IE-OY", - "IE-RN", - "IE-SO", - "IE-TA", - "IE-WD", - "IE-WH", - "IE-WX", - "IE-WW", - "IL-D", - "IL-M", - "IL-Z", - "IL-HA", - "IL-TA", - "IL-JM", - "IM-XX-1", - "IN-AN", - "IN-AP", - "IN-AR", - "IN-AS", - "IN-BR", - "IN-CH", - "IN-CT", - "IN-DN", - "IN-DH", - "IN-DL", - "IN-GA", - "IN-GJ", - "IN-HR", - "IN-HP", - "IN-JK", - "IN-JH", - "IN-KA", - "IN-KL", - "IN-LD", - "IN-MP", - "IN-MH", - "IN-MN", - "IN-ML", - "IN-MZ", - "IN-NL", - "IN-OR", - "IN-PY", - "IN-PB", - "IN-RJ", - "IN-SK", - "IN-TN", - "IN-TG", - "IN-TR", - "IN-UP", - "IN-UT", - "IN-WB", - "IO-XX-1", - "IQ-AN", - "IQ-BA", - "IQ-MU", - "IQ-QA", - "IQ-NA", - "IQ-AR", - "IQ-SU", - "IQ-BB", - "IQ-BG", - "IQ-DA", - "IQ-DQ", - "IQ-DI", - "IQ-KA", - "IQ-KI", - "IQ-MA", - "IQ-NI", - "IQ-SD", - "IQ-WA", - "IR-30", - "IR-24", - "IR-04", - "IR-03", - "IR-18", - "IR-14", - "IR-10", - "IR-07", - "IR-01", - "IR-27", - "IR-13", - "IR-22", - "IR-16", - "IR-08", - "IR-05", - "IR-29", - "IR-09", - "IR-28", - "IR-06", - "IR-17", - "IR-12", - "IR-15", - "IR-00", - "IR-02", - "IR-26", - "IR-25", - "IR-20", - "IR-11", - "IR-23", - "IR-21", - "IR-19", - "IS-7", - "IS-1", - "IS-6", - "IS-5", - "IS-8", - "IS-2", - "IS-4", - "IS-3", - "IT-65", - "IT-77", - "IT-78", - "IT-72", - "IT-45", - "IT-36", - "IT-62", - "IT-42", - "IT-25", - "IT-57", - "IT-67", - "IT-21", - "IT-75", - "IT-88", - "IT-82", - "IT-52", - "IT-32", - "IT-55", - "IT-23", - "IT-34", - "JE-XX-1", - "JM-13", - "JM-09", - "JM-01", - "JM-12", - "JM-04", - "JM-02", - "JM-06", - "JM-14", - "JM-11", - "JM-08", - "JM-05", - "JM-03", - "JM-07", - "JM-10", - "JO-AJ", - "JO-AQ", - "JO-AM", - "JO-BA", - "JO-KA", - "JO-MA", - "JO-AT", - "JO-AZ", - "JO-IR", - "JO-JA", - "JO-MN", - "JO-MD", - "JP-23", - "JP-05", - "JP-02", - "JP-12", - "JP-38", - "JP-18", - "JP-40", - "JP-07", - "JP-21", - "JP-10", - "JP-34", - "JP-01", - "JP-28", - "JP-08", - "JP-17", - "JP-03", - "JP-37", - "JP-46", - "JP-14", - "JP-39", - "JP-43", - "JP-26", - "JP-24", - "JP-04", - "JP-45", - "JP-20", - "JP-42", - "JP-29", - "JP-15", - "JP-44", - "JP-33", - "JP-47", - "JP-27", - "JP-41", - "JP-11", - "JP-25", - "JP-32", - "JP-22", - "JP-09", - "JP-36", - "JP-13", - "JP-31", - "JP-16", - "JP-30", - "JP-06", - "JP-35", - "JP-19", - "KE-01", - "KE-02", - "KE-03", - "KE-04", - "KE-05", - "KE-06", - "KE-07", - "KE-08", - "KE-09", - "KE-10", - "KE-11", - "KE-12", - "KE-13", - "KE-14", - "KE-15", - "KE-16", - "KE-17", - "KE-18", - "KE-19", - "KE-20", - "KE-21", - "KE-22", - "KE-23", - "KE-24", - "KE-25", - "KE-26", - "KE-27", - "KE-28", - "KE-29", - "KE-30", - "KE-31", - "KE-32", - "KE-33", - "KE-34", - "KE-35", - "KE-36", - "KE-37", - "KE-38", - "KE-39", - "KE-40", - "KE-41", - "KE-42", - "KE-43", - "KE-44", - "KE-45", - "KE-46", - "KE-47", - "KG-B", - "KG-GB", - "KG-C", - "KG-J", - "KG-N", - "KG-GO", - "KG-T", - "KG-Y", - "KH-2", - "KH-1", - "KH-23", - "KH-3", - "KH-4", - "KH-5", - "KH-6", - "KH-7", - "KH-8", - "KH-10", - "KH-11", - "KH-24", - "KH-12", - "KH-15", - "KH-18", - "KH-14", - "KH-16", - "KH-17", - "KH-19", - "KH-20", - "KH-21", - "KI-G", - "KM-G", - "KM-M", - "KN-01", - "KN-02", - "KN-03", - "KN-05", - "KN-06", - "KN-07", - "KN-08", - "KN-09", - "KN-10", - "KN-11", - "KN-12", - "KN-13", - "KN-15", - "KP-01", - "KR-26", - "KR-43", - "KR-44", - "KR-27", - "KR-30", - "KR-42", - "KR-29", - "KR-41", - "KR-47", - "KR-48", - "KR-28", - "KR-49", - "KR-45", - "KR-46", - "KR-11", - "KR-31", - "KW-KU", - "KW-AH", - "KW-FA", - "KW-JA", - "KW-HA", - "KW-MU", - "KY-XX-1", - "KZ-ALA", - "KZ-ALM", - "KZ-AKM", - "KZ-AKT", - "KZ-ATY", - "KZ-ZAP", - "KZ-MAN", - "KZ-AST", - "KZ-YUZ", - "KZ-PAV", - "KZ-KAR", - "KZ-KUS", - "KZ-KZY", - "KZ-VOS", - "KZ-SHY", - "KZ-SEV", - "KZ-ZHA", - "LA-AT", - "LA-BL", - "LA-CH", - "LA-HO", - "LA-KH", - "LA-OU", - "LA-PH", - "LA-SV", - "LA-VI", - "LA-XA", - "LA-XE", - "LA-XI", - "LB-AK", - "LB-BH", - "LB-BI", - "LB-BA", - "LB-AS", - "LB-JA", - "LB-JL", - "LB-NA", - "LC-01", - "LC-02", - "LC-03", - "LC-05", - "LC-06", - "LC-07", - "LC-08", - "LC-10", - "LC-11", - "LI-01", - "LI-02", - "LI-03", - "LI-04", - "LI-05", - "LI-06", - "LI-07", - "LI-09", - "LI-10", - "LI-11", - "LK-2", - "LK-5", - "LK-7", - "LK-6", - "LK-4", - "LK-9", - "LK-3", - "LK-8", - "LK-1", - "LR-BM", - "LR-GB", - "LR-GG", - "LR-MG", - "LR-MO", - "LR-NI", - "LR-SI", - "LS-D", - "LS-B", - "LS-C", - "LS-E", - "LS-A", - "LS-F", - "LS-J", - "LS-H", - "LS-G", - "LS-K", - "LT-AL", - "LT-KU", - "LT-KL", - "LT-MR", - "LT-PN", - "LT-SA", - "LT-TA", - "LT-TE", - "LT-UT", - "LT-VL", - "LU-CA", - "LU-CL", - "LU-DI", - "LU-EC", - "LU-ES", - "LU-GR", - "LU-LU", - "LU-ME", - "LU-RD", - "LU-RM", - "LU-VD", - "LU-WI", - "LV-011", - "LV-002", - "LV-007", - "LV-111", - "LV-015", - "LV-016", - "LV-022", - "LV-DGV", - "LV-112", - "LV-026", - "LV-033", - "LV-042", - "LV-JEL", - "LV-041", - "LV-JUR", - "LV-052", - "LV-047", - "LV-050", - "LV-LPX", - "LV-054", - "LV-056", - "LV-058", - "LV-059", - "LV-062", - "LV-067", - "LV-068", - "LV-073", - "LV-077", - "LV-RIX", - "LV-080", - "LV-087", - "LV-088", - "LV-089", - "LV-091", - "LV-094", - "LV-097", - "LV-099", - "LV-101", - "LV-113", - "LV-102", - "LV-106", - "LY-BU", - "LY-JA", - "LY-JG", - "LY-JI", - "LY-JU", - "LY-KF", - "LY-MJ", - "LY-MB", - "LY-WA", - "LY-NQ", - "LY-ZA", - "LY-BA", - "LY-DR", - "LY-MI", - "LY-NL", - "LY-SB", - "LY-SR", - "LY-TB", - "LY-WS", - "MA-05", - "MA-06", - "MA-08", - "MA-03", - "MA-10", - "MA-02", - "MA-11", - "MA-07", - "MA-04", - "MA-09", - "MA-01", - "MC-FO", - "MC-CO", - "MC-MO", - "MC-MC", - "MC-SR", - "MD-AN", - "MD-BA", - "MD-BS", - "MD-BD", - "MD-BR", - "MD-CA", - "MD-CL", - "MD-CT", - "MD-CS", - "MD-CU", - "MD-CM", - "MD-CR", - "MD-DO", - "MD-DR", - "MD-DU", - "MD-ED", - "MD-FA", - "MD-FL", - "MD-GA", - "MD-GL", - "MD-HI", - "MD-IA", - "MD-LE", - "MD-NI", - "MD-OC", - "MD-OR", - "MD-RE", - "MD-RI", - "MD-SI", - "MD-SD", - "MD-SO", - "MD-SV", - "MD-SN", - "MD-ST", - "MD-TA", - "MD-TE", - "MD-UN", - "ME-01", - "ME-02", - "ME-03", - "ME-04", - "ME-05", - "ME-06", - "ME-07", - "ME-08", - "ME-10", - "ME-12", - "ME-13", - "ME-14", - "ME-15", - "ME-16", - "ME-17", - "ME-19", - "ME-24", - "ME-20", - "ME-21", - "MF-XX-1", - "MG-T", - "MG-D", - "MG-F", - "MG-M", - "MG-A", - "MG-U", - "MH-KWA", - "MH-MAJ", - "MK-802", - "MK-201", - "MK-501", - "MK-401", - "MK-601", - "MK-402", - "MK-602", - "MK-803", - "MK-109", - "MK-814", - "MK-210", - "MK-816", - "MK-303", - "MK-203", - "MK-502", - "MK-406", - "MK-503", - "MK-804", - "MK-405", - "MK-604", - "MK-102", - "MK-807", - "MK-606", - "MK-205", - "MK-104", - "MK-307", - "MK-809", - "MK-206", - "MK-701", - "MK-702", - "MK-505", - "MK-703", - "MK-704", - "MK-105", - "MK-207", - "MK-308", - "MK-607", - "MK-506", - "MK-106", - "MK-507", - "MK-408", - "MK-310", - "MK-208", - "MK-810", - "MK-311", - "MK-508", - "MK-209", - "MK-409", - "MK-705", - "MK-509", - "MK-107", - "MK-811", - "MK-812", - "MK-211", - "MK-312", - "MK-410", - "MK-813", - "MK-108", - "MK-608", - "MK-609", - "MK-403", - "MK-404", - "MK-101", - "MK-301", - "MK-202", - "MK-603", - "MK-806", - "MK-605", - "ML-BKO", - "ML-7", - "ML-1", - "ML-8", - "ML-2", - "ML-5", - "ML-4", - "ML-3", - "ML-6", - "MM-07", - "MM-02", - "MM-14", - "MM-11", - "MM-12", - "MM-13", - "MM-03", - "MM-04", - "MM-15", - "MM-18", - "MM-16", - "MM-01", - "MM-17", - "MM-05", - "MM-06", - "MN-071", - "MN-037", - "MN-061", - "MN-063", - "MN-065", - "MN-043", - "MN-035", - "MN-055", - "MN-049", - "MN-047", - "MN-1", - "MO-XX-1", - "MP-XX-1", - "MQ-XX-1", - "MR-07", - "MR-03", - "MR-05", - "MR-08", - "MR-04", - "MR-10", - "MR-01", - "MR-02", - "MR-12", - "MR-13", - "MR-09", - "MR-11", - "MR-06", - "MS-XX-1", - "MS-XX-2", - "MT-01", - "MT-02", - "MT-03", - "MT-04", - "MT-05", - "MT-06", - "MT-07", - "MT-08", - "MT-09", - "MT-10", - "MT-14", - "MT-15", - "MT-16", - "MT-17", - "MT-11", - "MT-12", - "MT-18", - "MT-19", - "MT-20", - "MT-21", - "MT-22", - "MT-23", - "MT-24", - "MT-25", - "MT-26", - "MT-27", - "MT-28", - "MT-29", - "MT-30", - "MT-31", - "MT-32", - "MT-33", - "MT-34", - "MT-35", - "MT-36", - "MT-37", - "MT-38", - "MT-39", - "MT-40", - "MT-41", - "MT-42", - "MT-43", - "MT-45", - "MT-46", - "MT-49", - "MT-48", - "MT-53", - "MT-51", - "MT-52", - "MT-54", - "MT-55", - "MT-56", - "MT-57", - "MT-58", - "MT-59", - "MT-60", - "MT-61", - "MT-62", - "MT-63", - "MT-64", - "MT-65", - "MT-67", - "MT-68", - "MU-BL", - "MU-FL", - "MU-GP", - "MU-MO", - "MU-PA", - "MU-PW", - "MU-PL", - "MU-RR", - "MU-RO", - "MU-SA", - "MV-01", - "MV-03", - "MV-04", - "MV-05", - "MV-MLE", - "MV-12", - "MV-13", - "MV-00", - "MV-28", - "MV-20", - "MV-25", - "MV-17", - "MW-BA", - "MW-BL", - "MW-CK", - "MW-CR", - "MW-DE", - "MW-DO", - "MW-KR", - "MW-LI", - "MW-MH", - "MW-MG", - "MW-MW", - "MW-MZ", - "MW-NE", - "MW-NK", - "MW-PH", - "MW-SA", - "MW-TH", - "MW-ZO", - "MX-AGU", - "MX-BCN", - "MX-BCS", - "MX-CAM", - "MX-CHP", - "MX-CHH", - "MX-CMX", - "MX-COA", - "MX-COL", - "MX-DUR", - "MX-GUA", - "MX-GRO", - "MX-HID", - "MX-JAL", - "MX-MEX", - "MX-MIC", - "MX-MOR", - "MX-NAY", - "MX-NLE", - "MX-OAX", - "MX-PUE", - "MX-QUE", - "MX-ROO", - "MX-SLP", - "MX-SIN", - "MX-SON", - "MX-TAB", - "MX-TAM", - "MX-TLA", - "MX-VER", - "MX-YUC", - "MX-ZAC", - "MY-01", - "MY-02", - "MY-03", - "MY-04", - "MY-05", - "MY-06", - "MY-08", - "MY-09", - "MY-07", - "MY-12", - "MY-13", - "MY-10", - "MY-11", - "MY-14", - "MY-15", - "MY-16", - "MZ-P", - "MZ-G", - "MZ-I", - "MZ-B", - "MZ-L", - "MZ-N", - "MZ-A", - "MZ-S", - "MZ-T", - "MZ-Q", - "NA-ER", - "NA-HA", - "NA-KA", - "NA-KE", - "NA-KW", - "NA-KH", - "NA-KU", - "NA-OW", - "NA-OH", - "NA-OS", - "NA-ON", - "NA-OT", - "NA-OD", - "NA-CA", - "NC-XX-1", - "NC-XX-2", - "NE-1", - "NE-2", - "NE-3", - "NE-8", - "NE-5", - "NE-6", - "NE-7", - "NF-XX-1", - "NG-AB", - "NG-FC", - "NG-AD", - "NG-AK", - "NG-AN", - "NG-BA", - "NG-BY", - "NG-BE", - "NG-BO", - "NG-CR", - "NG-DE", - "NG-EB", - "NG-ED", - "NG-EK", - "NG-EN", - "NG-GO", - "NG-IM", - "NG-JI", - "NG-KD", - "NG-KN", - "NG-KT", - "NG-KE", - "NG-KO", - "NG-KW", - "NG-LA", - "NG-NA", - "NG-NI", - "NG-OG", - "NG-ON", - "NG-OS", - "NG-OY", - "NG-PL", - "NG-RI", - "NG-SO", - "NG-TA", - "NG-YO", - "NG-ZA", - "NI-BO", - "NI-CA", - "NI-CI", - "NI-CO", - "NI-AN", - "NI-AS", - "NI-ES", - "NI-GR", - "NI-JI", - "NI-LE", - "NI-MD", - "NI-MN", - "NI-MS", - "NI-MT", - "NI-NS", - "NI-SJ", - "NI-RI", - "NL-DR", - "NL-FL", - "NL-FR", - "NL-GE", - "NL-GR", - "NL-LI", - "NL-NB", - "NL-NH", - "NL-OV", - "NL-UT", - "NL-ZE", - "NL-ZH", - "NO-42", - "NO-34", - "NO-15", - "NO-18", - "NO-03", - "NO-11", - "NO-54", - "NO-50", - "NO-38", - "NO-46", - "NO-30", - "NP-BA", - "NP-BH", - "NP-DH", - "NP-GA", - "NP-JA", - "NP-KA", - "NP-KO", - "NP-LU", - "NP-MA", - "NP-ME", - "NP-NA", - "NP-RA", - "NP-SA", - "NP-SE", - "NR-01", - "NR-03", - "NR-14", - "NU-XX-1", - "NZ-AUK", - "NZ-BOP", - "NZ-CAN", - "NZ-CIT", - "NZ-GIS", - "NZ-HKB", - "NZ-MWT", - "NZ-MBH", - "NZ-NSN", - "NZ-NTL", - "NZ-OTA", - "NZ-STL", - "NZ-TKI", - "NZ-TAS", - "NZ-WKO", - "NZ-WGN", - "NZ-WTC", - "OM-DA", - "OM-BU", - "OM-WU", - "OM-ZA", - "OM-BJ", - "OM-SJ", - "OM-MA", - "OM-MU", - "OM-BS", - "OM-SS", - "OM-ZU", - "PA-1", - "PA-4", - "PA-2", - "PA-3", - "PA-5", - "PA-KY", - "PA-6", - "PA-7", - "PA-NB", - "PA-8", - "PA-9", - "PE-AMA", - "PE-ANC", - "PE-APU", - "PE-ARE", - "PE-AYA", - "PE-CAJ", - "PE-CUS", - "PE-CAL", - "PE-HUV", - "PE-HUC", - "PE-ICA", - "PE-JUN", - "PE-LAL", - "PE-LAM", - "PE-LIM", - "PE-LOR", - "PE-MDD", - "PE-MOQ", - "PE-PAS", - "PE-PIU", - "PE-PUN", - "PE-SAM", - "PE-TAC", - "PE-TUM", - "PE-UCA", - "PF-XX-1", - "PF-XX-2", - "PF-XX-3", - "PF-XX-4", - "PF-XX-5", - "PG-NSB", - "PG-CPM", - "PG-CPK", - "PG-EBR", - "PG-EHG", - "PG-ESW", - "PG-MPM", - "PG-MRL", - "PG-MBA", - "PG-MPL", - "PG-NCD", - "PG-SHM", - "PG-WBK", - "PG-SAN", - "PG-WPD", - "PG-WHM", - "PH-ABR", - "PH-AGN", - "PH-AGS", - "PH-AKL", - "PH-ALB", - "PH-ANT", - "PH-APA", - "PH-AUR", - "PH-BAS", - "PH-BAN", - "PH-BTN", - "PH-BTG", - "PH-BEN", - "PH-BIL", - "PH-BOH", - "PH-BUK", - "PH-BUL", - "PH-CAG", - "PH-CAN", - "PH-CAS", - "PH-CAM", - "PH-CAP", - "PH-CAT", - "PH-CAV", - "PH-CEB", - "PH-NCO", - "PH-DAO", - "PH-COM", - "PH-DAV", - "PH-DAS", - "PH-DIN", - "PH-EAS", - "PH-GUI", - "PH-IFU", - "PH-ILN", - "PH-ILS", - "PH-ILI", - "PH-ISA", - "PH-KAL", - "PH-LUN", - "PH-LAG", - "PH-LAN", - "PH-LAS", - "PH-LEY", - "PH-MAG", - "PH-MAD", - "PH-MAS", - "PH-MDC", - "PH-MDR", - "PH-MSC", - "PH-MSR", - "PH-MOU", - "PH-00", - "PH-NEC", - "PH-NER", - "PH-NSA", - "PH-NUE", - "PH-NUV", - "PH-PLW", - "PH-PAM", - "PH-PAN", - "PH-QUE", - "PH-QUI", - "PH-RIZ", - "PH-ROM", - "PH-WSA", - "PH-SAR", - "PH-SIG", - "PH-SOR", - "PH-SCO", - "PH-SLE", - "PH-SUK", - "PH-SLU", - "PH-SUN", - "PH-SUR", - "PH-TAR", - "PH-TAW", - "PH-ZMB", - "PH-ZSI", - "PH-ZAN", - "PH-ZAS", - "PK-JK", - "PK-BA", - "PK-GB", - "PK-IS", - "PK-KP", - "PK-PB", - "PK-SD", - "PL-02", - "PL-04", - "PL-10", - "PL-06", - "PL-08", - "PL-12", - "PL-14", - "PL-16", - "PL-18", - "PL-20", - "PL-22", - "PL-24", - "PL-26", - "PL-28", - "PL-30", - "PL-32", - "PM-XX-1", - "PN-XX-1", - "PR-XX-1", - "PR-XX-2", - "PR-XX-3", - "PR-XX-4", - "PR-XX-5", - "PR-XX-6", - "PR-XX-7", - "PR-XX-8", - "PR-XX-9", - "PR-XX-10", - "PR-XX-11", - "PR-XX-12", - "PR-XX-13", - "PR-XX-14", - "PR-XX-15", - "PR-XX-16", - "PR-XX-17", - "PR-XX-18", - "PR-XX-19", - "PR-XX-20", - "PR-XX-21", - "PR-XX-22", - "PR-XX-23", - "PR-XX-24", - "PR-XX-25", - "PR-XX-26", - "PR-XX-27", - "PR-XX-28", - "PR-XX-29", - "PR-XX-30", - "PR-XX-31", - "PR-XX-32", - "PR-XX-33", - "PR-XX-34", - "PR-XX-35", - "PR-XX-36", - "PR-XX-37", - "PR-XX-38", - "PR-XX-39", - "PR-XX-40", - "PR-XX-41", - "PR-XX-42", - "PR-XX-43", - "PR-XX-44", - "PR-XX-45", - "PR-XX-46", - "PR-XX-47", - "PR-XX-48", - "PR-XX-49", - "PR-XX-50", - "PR-XX-51", - "PR-XX-52", - "PR-XX-53", - "PR-XX-54", - "PR-XX-55", - "PR-XX-56", - "PR-XX-57", - "PR-XX-58", - "PR-XX-59", - "PR-XX-60", - "PR-XX-61", - "PR-XX-62", - "PR-XX-63", - "PR-XX-64", - "PR-XX-65", - "PR-XX-66", - "PR-XX-67", - "PR-XX-68", - "PR-XX-69", - "PR-XX-70", - "PR-XX-71", - "PR-XX-72", - "PR-XX-73", - "PR-XX-74", - "PR-XX-75", - "PR-XX-76", - "PS-BTH", - "PS-DEB", - "PS-GZA", - "PS-HBN", - "PS-JEN", - "PS-JRH", - "PS-JEM", - "PS-KYS", - "PS-NBS", - "PS-QQA", - "PS-RFH", - "PS-RBH", - "PS-SLT", - "PS-TBS", - "PS-TKM", - "PT-01", - "PT-02", - "PT-03", - "PT-04", - "PT-05", - "PT-06", - "PT-07", - "PT-08", - "PT-09", - "PT-10", - "PT-11", - "PT-12", - "PT-13", - "PT-30", - "PT-20", - "PT-14", - "PT-15", - "PT-16", - "PT-17", - "PT-18", - "PW-004", - "PW-100", - "PW-150", - "PW-212", - "PW-214", - "PW-222", - "PY-10", - "PY-13", - "PY-ASU", - "PY-19", - "PY-5", - "PY-6", - "PY-14", - "PY-11", - "PY-1", - "PY-3", - "PY-4", - "PY-7", - "PY-8", - "PY-12", - "PY-9", - "PY-15", - "PY-2", - "QA-DA", - "QA-KH", - "QA-WA", - "QA-RA", - "QA-MS", - "QA-ZA", - "QA-US", - "RE-XX-1", - "RO-AB", - "RO-AR", - "RO-AG", - "RO-BC", - "RO-BH", - "RO-BN", - "RO-BT", - "RO-BR", - "RO-BV", - "RO-B", - "RO-BZ", - "RO-CL", - "RO-CS", - "RO-CJ", - "RO-CT", - "RO-CV", - "RO-DB", - "RO-DJ", - "RO-GL", - "RO-GR", - "RO-GJ", - "RO-HR", - "RO-HD", - "RO-IL", - "RO-IS", - "RO-IF", - "RO-MM", - "RO-MH", - "RO-MS", - "RO-NT", - "RO-OT", - "RO-PH", - "RO-SJ", - "RO-SM", - "RO-SB", - "RO-SV", - "RO-TR", - "RO-TM", - "RO-TL", - "RO-VL", - "RO-VS", - "RO-VN", - "RS-00", - "RS-14", - "RS-11", - "RS-23", - "RS-06", - "RS-04", - "RS-09", - "RS-28", - "RS-08", - "RS-17", - "RS-20", - "RS-24", - "RS-26", - "RS-22", - "RS-10", - "RS-13", - "RS-27", - "RS-19", - "RS-18", - "RS-01", - "RS-03", - "RS-02", - "RS-07", - "RS-12", - "RS-21", - "RS-15", - "RS-05", - "RS-16", - "RU-AD", - "RU-AL", - "RU-ALT", - "RU-AMU", - "RU-ARK", - "RU-AST", - "RU-BA", - "RU-BEL", - "RU-BRY", - "RU-BU", - "RU-CE", - "RU-CHE", - "RU-CHU", - "RU-CU", - "RU-DA", - "RU-IN", - "RU-IRK", - "RU-IVA", - "RU-KB", - "RU-KGD", - "RU-KL", - "RU-KLU", - "RU-KAM", - "RU-KC", - "RU-KR", - "RU-KEM", - "RU-KHA", - "RU-KK", - "RU-KHM", - "RU-KIR", - "RU-KO", - "RU-KOS", - "RU-KDA", - "RU-KYA", - "RU-KGN", - "RU-KRS", - "RU-LEN", - "RU-LIP", - "RU-MAG", - "RU-ME", - "RU-MO", - "RU-MOS", - "RU-MOW", - "RU-MUR", - "RU-NEN", - "RU-NIZ", - "RU-NGR", - "RU-NVS", - "RU-OMS", - "RU-ORE", - "RU-ORL", - "RU-PNZ", - "RU-PER", - "RU-PRI", - "RU-PSK", - "RU-ROS", - "RU-RYA", - "RU-SA", - "RU-SAK", - "RU-SAM", - "RU-SPE", - "RU-SAR", - "RU-SE", - "RU-SMO", - "RU-STA", - "RU-SVE", - "RU-TAM", - "RU-TA", - "RU-TOM", - "RU-TUL", - "RU-TVE", - "RU-TYU", - "RU-TY", - "RU-UD", - "RU-ULY", - "RU-VLA", - "RU-VGG", - "RU-VLG", - "RU-VOR", - "RU-YAN", - "RU-YAR", - "RU-YEV", - "RU-ZAB", - "RW-02", - "RW-03", - "RW-04", - "RW-05", - "RW-01", - "SA-14", - "SA-11", - "SA-08", - "SA-12", - "SA-03", - "SA-05", - "SA-01", - "SA-04", - "SA-06", - "SA-09", - "SA-02", - "SA-10", - "SA-07", - "SB-CH", - "SB-GU", - "SB-WE", - "SC-02", - "SC-05", - "SC-01", - "SC-06", - "SC-07", - "SC-08", - "SC-10", - "SC-11", - "SC-16", - "SC-13", - "SC-14", - "SC-15", - "SC-20", - "SC-23", - "SD-NB", - "SD-DC", - "SD-GD", - "SD-GZ", - "SD-KA", - "SD-KH", - "SD-DN", - "SD-KN", - "SD-NO", - "SD-RS", - "SD-NR", - "SD-SI", - "SD-DS", - "SD-KS", - "SD-DW", - "SD-GK", - "SD-NW", - "SE-K", - "SE-W", - "SE-X", - "SE-I", - "SE-N", - "SE-Z", - "SE-F", - "SE-H", - "SE-G", - "SE-BD", - "SE-T", - "SE-E", - "SE-M", - "SE-D", - "SE-AB", - "SE-C", - "SE-S", - "SE-AC", - "SE-Y", - "SE-U", - "SE-O", - "SG-XX-1", - "SH-HL", - "SI-001", - "SI-213", - "SI-195", - "SI-002", - "SI-148", - "SI-149", - "SI-003", - "SI-150", - "SI-004", - "SI-005", - "SI-006", - "SI-151", - "SI-007", - "SI-009", - "SI-008", - "SI-152", - "SI-011", - "SI-012", - "SI-013", - "SI-014", - "SI-196", - "SI-015", - "SI-017", - "SI-018", - "SI-019", - "SI-154", - "SI-020", - "SI-155", - "SI-021", - "SI-156", - "SI-023", - "SI-024", - "SI-025", - "SI-026", - "SI-207", - "SI-029", - "SI-031", - "SI-158", - "SI-032", - "SI-159", - "SI-160", - "SI-161", - "SI-162", - "SI-034", - "SI-035", - "SI-036", - "SI-037", - "SI-038", - "SI-039", - "SI-040", - "SI-041", - "SI-042", - "SI-043", - "SI-044", - "SI-045", - "SI-046", - "SI-047", - "SI-048", - "SI-049", - "SI-164", - "SI-050", - "SI-197", - "SI-165", - "SI-052", - "SI-053", - "SI-166", - "SI-054", - "SI-055", - "SI-056", - "SI-057", - "SI-058", - "SI-059", - "SI-060", - "SI-061", - "SI-063", - "SI-208", - "SI-064", - "SI-065", - "SI-066", - "SI-167", - "SI-067", - "SI-068", - "SI-069", - "SI-198", - "SI-070", - "SI-168", - "SI-071", - "SI-072", - "SI-073", - "SI-074", - "SI-169", - "SI-075", - "SI-212", - "SI-170", - "SI-076", - "SI-199", - "SI-077", - "SI-079", - "SI-080", - "SI-081", - "SI-082", - "SI-083", - "SI-084", - "SI-085", - "SI-086", - "SI-171", - "SI-087", - "SI-090", - "SI-091", - "SI-092", - "SI-172", - "SI-200", - "SI-173", - "SI-094", - "SI-174", - "SI-095", - "SI-175", - "SI-096", - "SI-097", - "SI-098", - "SI-099", - "SI-100", - "SI-101", - "SI-102", - "SI-103", - "SI-176", - "SI-209", - "SI-201", - "SI-104", - "SI-106", - "SI-105", - "SI-108", - "SI-033", - "SI-109", - "SI-183", - "SI-117", - "SI-118", - "SI-119", - "SI-120", - "SI-211", - "SI-110", - "SI-111", - "SI-121", - "SI-122", - "SI-123", - "SI-112", - "SI-113", - "SI-114", - "SI-124", - "SI-206", - "SI-125", - "SI-194", - "SI-179", - "SI-180", - "SI-126", - "SI-115", - "SI-127", - "SI-203", - "SI-204", - "SI-182", - "SI-116", - "SI-210", - "SI-205", - "SI-184", - "SI-010", - "SI-128", - "SI-129", - "SI-130", - "SI-185", - "SI-131", - "SI-186", - "SI-132", - "SI-133", - "SI-187", - "SI-134", - "SI-188", - "SI-135", - "SI-136", - "SI-137", - "SI-138", - "SI-139", - "SI-189", - "SI-140", - "SI-141", - "SI-142", - "SI-190", - "SI-143", - "SI-146", - "SI-191", - "SI-147", - "SI-144", - "SI-193", - "SJ-XX-1", - "SK-BC", - "SK-BL", - "SK-KI", - "SK-NI", - "SK-PV", - "SK-TC", - "SK-TA", - "SK-ZI", - "SL-E", - "SL-N", - "SL-S", - "SL-W", - "SM-07", - "SM-03", - "SM-04", - "SM-09", - "SN-DK", - "SN-DB", - "SN-FK", - "SN-KA", - "SN-KL", - "SN-KE", - "SN-KD", - "SN-LG", - "SN-MT", - "SN-SL", - "SN-SE", - "SN-TC", - "SN-TH", - "SN-ZG", - "SO-AW", - "SO-BN", - "SO-BR", - "SO-GA", - "SO-JH", - "SO-MU", - "SO-NU", - "SO-SH", - "SO-TO", - "SO-WO", - "SR-BR", - "SR-CM", - "SR-NI", - "SR-PR", - "SR-PM", - "SR-SI", - "SR-WA", - "SS-EC", - "SS-EE", - "SS-JG", - "SS-LK", - "SS-BN", - "SS-NU", - "SS-EW", - "ST-01", - "SV-AH", - "SV-CA", - "SV-CH", - "SV-CU", - "SV-LI", - "SV-PA", - "SV-UN", - "SV-MO", - "SV-SM", - "SV-SS", - "SV-SV", - "SV-SA", - "SV-SO", - "SV-US", - "SX-XX-1", - "SY-HA", - "SY-LA", - "SY-QU", - "SY-RA", - "SY-SU", - "SY-DR", - "SY-DY", - "SY-DI", - "SY-HL", - "SY-HM", - "SY-HI", - "SY-ID", - "SY-RD", - "SY-TA", - "SZ-HH", - "SZ-LU", - "SZ-MA", - "TC-XX-1", - "TD-BG", - "TD-CB", - "TD-GR", - "TD-LO", - "TD-ME", - "TD-OD", - "TD-ND", - "TF-XX-1", - "TG-C", - "TG-K", - "TG-M", - "TG-P", - "TH-37", - "TH-15", - "TH-38", - "TH-31", - "TH-24", - "TH-18", - "TH-36", - "TH-22", - "TH-50", - "TH-57", - "TH-20", - "TH-86", - "TH-46", - "TH-62", - "TH-71", - "TH-40", - "TH-81", - "TH-10", - "TH-52", - "TH-51", - "TH-42", - "TH-16", - "TH-58", - "TH-44", - "TH-49", - "TH-26", - "TH-73", - "TH-48", - "TH-30", - "TH-60", - "TH-80", - "TH-55", - "TH-96", - "TH-39", - "TH-43", - "TH-12", - "TH-13", - "TH-94", - "TH-82", - "TH-93", - "TH-56", - "TH-67", - "TH-76", - "TH-66", - "TH-65", - "TH-14", - "TH-54", - "TH-83", - "TH-25", - "TH-77", - "TH-85", - "TH-70", - "TH-21", - "TH-45", - "TH-27", - "TH-47", - "TH-11", - "TH-74", - "TH-75", - "TH-19", - "TH-91", - "TH-33", - "TH-17", - "TH-90", - "TH-64", - "TH-72", - "TH-84", - "TH-32", - "TH-63", - "TH-92", - "TH-23", - "TH-34", - "TH-41", - "TH-61", - "TH-53", - "TH-95", - "TH-35", - "TJ-DU", - "TJ-KT", - "TJ-RA", - "TJ-SU", - "TK-XX-1", - "TL-AN", - "TL-BO", - "TL-CO", - "TL-DI", - "TL-LI", - "TM-A", - "TM-B", - "TM-D", - "TM-L", - "TM-M", - "TN-31", - "TN-13", - "TN-23", - "TN-81", - "TN-71", - "TN-32", - "TN-41", - "TN-42", - "TN-73", - "TN-12", - "TN-14", - "TN-33", - "TN-53", - "TN-82", - "TN-52", - "TN-21", - "TN-61", - "TN-43", - "TN-34", - "TN-51", - "TN-83", - "TN-72", - "TN-11", - "TN-22", - "TO-02", - "TO-03", - "TO-04", - "TR-01", - "TR-02", - "TR-03", - "TR-04", - "TR-68", - "TR-05", - "TR-06", - "TR-07", - "TR-75", - "TR-08", - "TR-09", - "TR-10", - "TR-74", - "TR-72", - "TR-69", - "TR-11", - "TR-12", - "TR-13", - "TR-14", - "TR-15", - "TR-16", - "TR-17", - "TR-18", - "TR-19", - "TR-20", - "TR-21", - "TR-81", - "TR-22", - "TR-23", - "TR-24", - "TR-25", - "TR-26", - "TR-27", - "TR-28", - "TR-29", - "TR-30", - "TR-31", - "TR-76", - "TR-32", - "TR-34", - "TR-35", - "TR-46", - "TR-78", - "TR-70", - "TR-36", - "TR-37", - "TR-38", - "TR-79", - "TR-71", - "TR-39", - "TR-40", - "TR-41", - "TR-42", - "TR-43", - "TR-44", - "TR-45", - "TR-47", - "TR-33", - "TR-48", - "TR-49", - "TR-50", - "TR-51", - "TR-52", - "TR-80", - "TR-53", - "TR-54", - "TR-55", - "TR-63", - "TR-56", - "TR-57", - "TR-73", - "TR-58", - "TR-59", - "TR-60", - "TR-61", - "TR-62", - "TR-64", - "TR-65", - "TR-77", - "TR-66", - "TR-67", - "TT-ARI", - "TT-CHA", - "TT-CTT", - "TT-DMN", - "TT-MRC", - "TT-PED", - "TT-PTF", - "TT-POS", - "TT-PRT", - "TT-SFO", - "TT-SJL", - "TT-SGE", - "TT-SIP", - "TT-TOB", - "TT-TUP", - "TV-FUN", - "TW-CHA", - "TW-CYQ", - "TW-HSQ", - "TW-HUA", - "TW-KHH", - "TW-KEE", - "TW-KIN", - "TW-LIE", - "TW-MIA", - "TW-NAN", - "TW-NWT", - "TW-PEN", - "TW-PIF", - "TW-TXG", - "TW-TNN", - "TW-TPE", - "TW-TTT", - "TW-TAO", - "TW-ILA", - "TW-YUN", - "TZ-01", - "TZ-02", - "TZ-03", - "TZ-27", - "TZ-04", - "TZ-05", - "TZ-06", - "TZ-07", - "TZ-28", - "TZ-08", - "TZ-09", - "TZ-11", - "TZ-12", - "TZ-26", - "TZ-13", - "TZ-14", - "TZ-15", - "TZ-16", - "TZ-17", - "TZ-18", - "TZ-29", - "TZ-19", - "TZ-20", - "TZ-21", - "TZ-22", - "TZ-30", - "TZ-23", - "TZ-31", - "TZ-24", - "TZ-25", - "UA-43", - "UA-71", - "UA-74", - "UA-77", - "UA-12", - "UA-14", - "UA-26", - "UA-63", - "UA-65", - "UA-68", - "UA-35", - "UA-30", - "UA-32", - "UA-09", - "UA-46", - "UA-48", - "UA-51", - "UA-53", - "UA-56", - "UA-40", - "UA-59", - "UA-61", - "UA-05", - "UA-07", - "UA-21", - "UA-23", - "UA-18", - "UG-314", - "UG-301", - "UG-322", - "UG-323", - "UG-315", - "UG-324", - "UG-216", - "UG-316", - "UG-302", - "UG-303", - "UG-217", - "UG-218", - "UG-201", - "UG-420", - "UG-117", - "UG-219", - "UG-118", - "UG-220", - "UG-225", - "UG-401", - "UG-402", - "UG-202", - "UG-221", - "UG-120", - "UG-226", - "UG-317", - "UG-121", - "UG-304", - "UG-403", - "UG-417", - "UG-203", - "UG-418", - "UG-204", - "UG-318", - "UG-404", - "UG-405", - "UG-213", - "UG-101", - "UG-222", - "UG-122", - "UG-102", - "UG-205", - "UG-413", - "UG-206", - "UG-406", - "UG-207", - "UG-112", - "UG-407", - "UG-103", - "UG-227", - "UG-419", - "UG-421", - "UG-408", - "UG-305", - "UG-319", - "UG-306", - "UG-208", - "UG-228", - "UG-123", - "UG-422", - "UG-415", - "UG-326", - "UG-307", - "UG-229", - "UG-104", - "UG-124", - "UG-114", - "UG-223", - "UG-105", - "UG-409", - "UG-214", - "UG-209", - "UG-410", - "UG-423", - "UG-115", - "UG-308", - "UG-309", - "UG-106", - "UG-107", - "UG-108", - "UG-311", - "UG-116", - "UG-109", - "UG-230", - "UG-224", - "UG-327", - "UG-310", - "UG-231", - "UG-411", - "UG-328", - "UG-321", - "UG-312", - "UG-210", - "UG-110", - "UG-425", - "UG-412", - "UG-111", - "UG-232", - "UG-426", - "UG-215", - "UG-211", - "UG-212", - "UG-113", - "UG-313", - "UG-330", - "UM-95", - "US-AL", - "US-AK", - "US-AZ", - "US-AR", - "US-CA", - "US-CO", - "US-CT", - "US-DE", - "US-DC", - "US-FL", - "US-GA", - "US-HI", - "US-ID", - "US-IL", - "US-IN", - "US-IA", - "US-KS", - "US-KY", - "US-LA", - "US-ME", - "US-MD", - "US-MA", - "US-MI", - "US-MN", - "US-MS", - "US-MO", - "US-MT", - "US-NE", - "US-NV", - "US-NH", - "US-NJ", - "US-NM", - "US-NY", - "US-NC", - "US-ND", - "US-OH", - "US-OK", - "US-OR", - "US-PA", - "US-RI", - "US-SC", - "US-SD", - "US-TN", - "US-TX", - "US-UT", - "US-VT", - "US-VA", - "US-WA", - "US-WV", - "US-WI", - "US-WY", - "UY-AR", - "UY-CA", - "UY-CL", - "UY-CO", - "UY-DU", - "UY-FS", - "UY-FD", - "UY-LA", - "UY-MA", - "UY-MO", - "UY-PA", - "UY-RN", - "UY-RV", - "UY-RO", - "UY-SA", - "UY-SJ", - "UY-SO", - "UY-TA", - "UY-TT", - "UZ-AN", - "UZ-BU", - "UZ-FA", - "UZ-JI", - "UZ-NG", - "UZ-NW", - "UZ-QA", - "UZ-QR", - "UZ-SA", - "UZ-SI", - "UZ-SU", - "UZ-TK", - "UZ-XO", - "VA-XX-1", - "VC-01", - "VC-06", - "VC-04", - "VC-05", - "VE-Z", - "VE-B", - "VE-C", - "VE-D", - "VE-E", - "VE-F", - "VE-G", - "VE-H", - "VE-Y", - "VE-A", - "VE-I", - "VE-J", - "VE-X", - "VE-K", - "VE-L", - "VE-M", - "VE-N", - "VE-O", - "VE-P", - "VE-R", - "VE-S", - "VE-T", - "VE-U", - "VE-V", - "VG-XX-1", - "VI-XX-1", - "VN-44", - "VN-43", - "VN-54", - "VN-53", - "VN-55", - "VN-56", - "VN-50", - "VN-31", - "VN-57", - "VN-58", - "VN-40", - "VN-59", - "VN-CT", - "VN-04", - "VN-DN", - "VN-33", - "VN-72", - "VN-71", - "VN-39", - "VN-45", - "VN-30", - "VN-03", - "VN-63", - "VN-HN", - "VN-23", - "VN-61", - "VN-HP", - "VN-73", - "VN-SG", - "VN-14", - "VN-66", - "VN-34", - "VN-47", - "VN-28", - "VN-01", - "VN-35", - "VN-09", - "VN-02", - "VN-41", - "VN-67", - "VN-22", - "VN-18", - "VN-36", - "VN-68", - "VN-32", - "VN-24", - "VN-27", - "VN-29", - "VN-13", - "VN-25", - "VN-52", - "VN-05", - "VN-37", - "VN-20", - "VN-69", - "VN-21", - "VN-26", - "VN-46", - "VN-51", - "VN-07", - "VN-49", - "VN-70", - "VN-06", - "VU-SEE", - "VU-TAE", - "VU-TOB", - "WF-SG", - "WF-UV", - "WS-AT", - "WS-FA", - "WS-TU", - "YE-AD", - "YE-AM", - "YE-AB", - "YE-DA", - "YE-BA", - "YE-HU", - "YE-SA", - "YE-DH", - "YE-HD", - "YE-HJ", - "YE-IB", - "YE-LA", - "YE-MA", - "YE-SD", - "YE-SN", - "YE-SH", - "YE-TA", - "YT-XX-1", - "YT-XX-2", - "YT-XX-3", - "YT-XX-4", - "YT-XX-5", - "YT-XX-6", - "ZA-EC", - "ZA-FS", - "ZA-GP", - "ZA-KZN", - "ZA-LP", - "ZA-MP", - "ZA-NW", - "ZA-NC", - "ZA-WC", - "ZM-02", - "ZM-08", - "ZM-03", - "ZM-04", - "ZM-09", - "ZM-10", - "ZM-06", - "ZM-05", - "ZM-07", - "ZM-01", - "ZW-BU", - "ZW-HA", - "ZW-MA", - "ZW-MC", - "ZW-ME", - "ZW-MW", - "ZW-MV", - "ZW-MN", - "ZW-MS", - "ZW-MI", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "street_1": { - "description": "The first line of the address", - "example": "Water Lane", - "nullable": true, - "type": "string", - }, - "street_2": { - "description": "The second line of the address", - "example": "Woolsthorpe by Colsterworth", - "nullable": true, - "type": "string", - }, - "zip_code": { - "description": "The ZIP code/Postal code of the location", - "example": "NG33 5NR", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "work_phone_number": { - "description": "The employee work phone number", - "example": "+1234567890", - "nullable": true, - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_update_employee_employment": { - "description": "Update Employee Employment", - "execute": { - "bodyType": "json", - "method": "PATCH", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "body", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "body", - "name": "unified_custom_fields", - "type": "object", - }, - { - "location": "body", - "name": "employee_id", - "type": "string", - }, - { - "location": "body", - "name": "job_title", - "type": "string", - }, - { - "location": "body", - "name": "pay_rate", - "type": "string", - }, - { - "location": "body", - "name": "pay_period", - "type": "object", - }, - { - "location": "body", - "name": "pay_frequency", - "type": "object", - }, - { - "location": "body", - "name": "pay_currency", - "type": "string", - }, - { - "location": "body", - "name": "effective_date", - "type": "string", - }, - { - "location": "body", - "name": "employment_type", - "type": "object", - }, - { - "location": "body", - "name": "employment_contract_type", - "type": "object", - }, - { - "location": "body", - "name": "time_worked", - "type": "string", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/employments/{subResourceId}", - }, - "name": "hris_update_employee_employment", - "parameters": { - "properties": { - "effective_date": { - "description": "The effective date of the employment contract", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - "employee_id": { - "description": "The employee ID associated with this employment", - "example": "1687-3", - "nullable": true, - "type": "string", - }, - "employment_contract_type": { - "description": "The employment work schedule type (e.g., full-time, part-time)", - "example": "full_time", - "nullable": true, - "properties": { - "value": { - "enum": [ - "full_time", - "shifts", - "part_time", - "unmapped_value", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "employment_type": { - "description": "The type of employment (e.g., contractor, permanent)", - "example": "permanent", - "nullable": true, - "properties": { - "value": { - "enum": [ - "contractor", - "intern", - "permanent", - "apprentice", - "freelance", - "terminated", - "temporary", - "seasonal", - "volunteer", - "probation", - "internal", - "external", - "expatriate", - "employer_of_record", - "casual", - "Programme", - "unmapped_value", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string", - }, - "job_title": { - "description": "The job title of the employee", - "example": "Software Engineer", - "nullable": true, - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "nullable": true, - "type": "object", - }, - "pay_currency": { - "description": "The currency used for pay", - "example": "USD", - "nullable": true, - "type": "string", - }, - "pay_frequency": { - "description": "The pay frequency", - "example": "hourly", - "nullable": true, - "properties": { - "value": { - "enum": [ - "hourly", - "weekly", - "bi_weekly", - "four_weekly", - "semi_monthly", - "monthly", - "bi_monthly", - "quarterly", - "semi_annually", - "yearly", - "thirteen_monthly", - "pro_rata", - "unmapped_value", - "half_yearly", - "daily", - "fixed", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "pay_period": { - "description": "The pay period", - "example": "monthly", - "nullable": true, - "properties": { - "value": { - "enum": [ - "hour", - "day", - "week", - "every_two_weeks", - "month", - "quarter", - "every_six_months", - "year", - "unmapped_value", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "pay_rate": { - "description": "The pay rate for the employee", - "example": "40.00", - "nullable": true, - "type": "string", - }, - "subResourceId": { - "type": "string", - }, - "time_worked": { - "description": "The time worked for the employee in ISO 8601 duration format", - "example": "P0Y0M0DT8H0M0S", - "format": "duration", - "nullable": true, - "type": "string", - }, - "unified_custom_fields": { - "additionalProperties": true, - "description": "Custom Unified Fields configured in your StackOne project", - "example": { - "my_project_custom_field_1": "REF-1236", - "my_project_custom_field_2": "some other value", - }, - "nullable": true, - "type": "object", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - }, - "hris_update_employee_work_eligibility_request": { - "description": "Update Employee Work Eligibility Request", - "execute": { - "bodyType": "json", - "method": "PATCH", - "params": [ - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "body", - "name": "document", - "type": "object", - }, - { - "location": "body", - "name": "issued_by", - "type": "object", - }, - { - "location": "body", - "name": "number", - "type": "string", - }, - { - "location": "body", - "name": "sub_type", - "type": "string", - }, - { - "location": "body", - "name": "type", - "type": "object", - }, - { - "location": "body", - "name": "valid_from", - "type": "string", - }, - { - "location": "body", - "name": "valid_to", - "type": "string", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/work_eligibility/{subResourceId}", - }, - "name": "hris_update_employee_work_eligibility_request", - "parameters": { - "properties": { - "document": { - "nullable": true, - "properties": { - "category": { - "description": "The category of the file", - "example": "templates, forms, backups, etc.", - "nullable": true, - "properties": { - "value": { - "description": "The category of the file", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "category_id": { - "description": "The categoryId of the documents", - "example": "6530", - "nullable": true, - "type": "string", - }, - "contents": { - "deprecated": true, - "description": "The content of the file. Deprecated, use \`url\` and \`file_format\` one level up instead", - "items": { - "properties": { - "file_format": { - "description": "The file format of the file", - "nullable": true, - "properties": { - "value": { - "description": "The file format of the file, expressed as a file extension", - "enum": [ - "unmapped_value", - "ez", - "aw", - "atom", - "atomcat", - "atomdeleted", - "atomsvc", - "dwd", - "held", - "rsat", - "bdoc", - "xcs", - "ccxml", - "cdfx", - "cdmia", - "cdmic", - "cdmid", - "cdmio", - "cdmiq", - "cu", - "mpd", - "davmount", - "dbk", - "dssc", - "xdssc", - "es", - "ecma", - "emma", - "emotionml", - "epub", - "exi", - "exp", - "fdt", - "pfr", - "geojson", - "gml", - "gpx", - "gxf", - "gz", - "hjson", - "stk", - "ink", - "inkml", - "ipfix", - "its", - "jar", - "war", - "ear", - "ser", - "class", - "js", - "mjs", - "json", - "map", - "json5", - "jsonml", - "jsonld", - "lgr", - "lostxml", - "hqx", - "cpt", - "mads", - "webmanifest", - "mrc", - "mrcx", - "ma", - "nb", - "mb", - "mathml", - "mbox", - "mscml", - "metalink", - "meta4", - "mets", - "maei", - "musd", - "mods", - "m21", - "mp21", - "mp4s", - "m4p", - "doc", - "dot", - "mxf", - "nq", - "nt", - "cjs", - "bin", - "dms", - "lrf", - "mar", - "so", - "dist", - "distz", - "pkg", - "bpk", - "dump", - "elc", - "deploy", - "exe", - "dll", - "deb", - "dmg", - "iso", - "img", - "msi", - "msp", - "msm", - "buffer", - "oda", - "opf", - "ogx", - "omdoc", - "onetoc", - "onetoc2", - "onetmp", - "onepkg", - "oxps", - "relo", - "xer", - "pdf", - "pgp", - "asc", - "sig", - "prf", - "p10", - "p7m", - "p7c", - "p7s", - "p8", - "ac", - "cer", - "crl", - "pkipath", - "pki", - "pls", - "ai", - "eps", - "ps", - "provx", - "pskcxml", - "raml", - "rdf", - "owl", - "rif", - "rnc", - "rl", - "rld", - "rs", - "rapd", - "sls", - "rusd", - "gbr", - "mft", - "roa", - "rsd", - "rss", - "rtf", - "sbml", - "scq", - "scs", - "spq", - "spp", - "sdp", - "senmlx", - "sensmlx", - "setpay", - "setreg", - "shf", - "siv", - "sieve", - "smi", - "smil", - "rq", - "srx", - "gram", - "grxml", - "sru", - "ssdl", - "ssml", - "swidtag", - "tei", - "teicorpus", - "tfi", - "tsd", - "toml", - "trig", - "ttml", - "ubj", - "rsheet", - "td", - "vxml", - "wasm", - "wgt", - "hlp", - "wsdl", - "wspolicy", - "xaml", - "xav", - "xca", - "xdf", - "xel", - "xns", - "xenc", - "xhtml", - "xht", - "xlf", - "xml", - "xsl", - "xsd", - "rng", - "dtd", - "xop", - "xpl", - "*xsl", - "xslt", - "xspf", - "mxml", - "xhvml", - "xvml", - "xvm", - "yang", - "yin", - "zip", - "*3gpp", - "adp", - "amr", - "au", - "snd", - "mid", - "midi", - "kar", - "rmi", - "mxmf", - "*mp3", - "m4a", - "mp4a", - "mpga", - "mp2", - "mp2a", - "mp3", - "m2a", - "m3a", - "oga", - "ogg", - "spx", - "opus", - "s3m", - "sil", - "wav", - "*wav", - "weba", - "xm", - "ttc", - "otf", - "ttf", - "woff", - "woff2", - "exr", - "apng", - "avif", - "bmp", - "cgm", - "drle", - "emf", - "fits", - "g3", - "gif", - "heic", - "heics", - "heif", - "heifs", - "hej2", - "hsj2", - "ief", - "jls", - "jp2", - "jpg2", - "jpeg", - "jpg", - "jpe", - "jph", - "jhc", - "jpm", - "jpx", - "jpf", - "jxr", - "jxra", - "jxrs", - "jxs", - "jxsc", - "jxsi", - "jxss", - "ktx", - "ktx2", - "png", - "sgi", - "svg", - "svgz", - "t38", - "tif", - "tiff", - "tfx", - "webp", - "wmf", - "disposition-notification", - "u8msg", - "u8dsn", - "u8mdn", - "u8hdr", - "eml", - "mime", - "3mf", - "gltf", - "glb", - "igs", - "iges", - "msh", - "mesh", - "silo", - "mtl", - "obj", - "stpx", - "stpz", - "stpxz", - "stl", - "wrl", - "vrml", - "*x3db", - "x3dbz", - "x3db", - "*x3dv", - "x3dvz", - "x3d", - "x3dz", - "x3dv", - "appcache", - "manifest", - "ics", - "ifb", - "coffee", - "litcoffee", - "css", - "csv", - "html", - "htm", - "shtml", - "jade", - "jsx", - "less", - "markdown", - "md", - "mml", - "mdx", - "n3", - "txt", - "text", - "conf", - "def", - "list", - "log", - "in", - "ini", - "rtx", - "*rtf", - "sgml", - "sgm", - "shex", - "slim", - "slm", - "spdx", - "stylus", - "styl", - "tsv", - "t", - "tr", - "roff", - "man", - "me", - "ms", - "ttl", - "uri", - "uris", - "urls", - "vcard", - "vtt", - "*xml", - "yaml", - "yml", - "3gp", - "3gpp", - "3g2", - "h261", - "h263", - "h264", - "m4s", - "jpgv", - "*jpm", - "jpgm", - "mj2", - "mjp2", - "ts", - "mp4", - "mp4v", - "mpg4", - "mpeg", - "mpg", - "mpe", - "m1v", - "m2v", - "ogv", - "qt", - "mov", - "webm", - "cww", - "1km", - "plb", - "psb", - "pvb", - "tcap", - "pwn", - "aso", - "imp", - "acu", - "atc", - "acutc", - "air", - "fcdt", - "fxp", - "fxpl", - "xdp", - "xfdf", - "ahead", - "azf", - "azs", - "azw", - "acc", - "ami", - "apk", - "cii", - "fti", - "atx", - "mpkg", - "key", - "m3u8", - "numbers", - "pages", - "pkpass", - "swi", - "iota", - "aep", - "bmml", - "mpm", - "bmi", - "rep", - "cdxml", - "mmd", - "cdy", - "csl", - "cla", - "rp9", - "c4g", - "c4d", - "c4f", - "c4p", - "c4u", - "c11amc", - "c11amz", - "csp", - "cdbcmsg", - "cmc", - "clkx", - "clkk", - "clkp", - "clkt", - "clkw", - "wbs", - "pml", - "ppd", - "car", - "pcurl", - "dart", - "rdz", - "dbf", - "uvf", - "uvvf", - "uvd", - "uvvd", - "uvt", - "uvvt", - "uvx", - "uvvx", - "uvz", - "uvvz", - "fe_launch", - "dna", - "mlp", - "mle", - "dpg", - "dfac", - "kpxx", - "ait", - "svc", - "geo", - "mag", - "nml", - "esf", - "msf", - "qam", - "slt", - "ssf", - "es3", - "et3", - "ez2", - "ez3", - "fdf", - "mseed", - "seed", - "dataless", - "gph", - "ftc", - "fm", - "frame", - "maker", - "book", - "fnc", - "ltf", - "fsc", - "oas", - "oa2", - "oa3", - "fg5", - "bh2", - "ddd", - "xdw", - "xbd", - "fzs", - "txd", - "ggb", - "ggt", - "gex", - "gre", - "gxt", - "g2w", - "g3w", - "gmx", - "gdoc", - "gslides", - "gsheet", - "kml", - "kmz", - "gqf", - "gqs", - "gac", - "ghf", - "gim", - "grv", - "gtm", - "tpl", - "vcg", - "hal", - "zmm", - "hbci", - "les", - "hpgl", - "hpid", - "hps", - "jlt", - "pcl", - "pclxl", - "sfd-hdstx", - "mpy", - "afp", - "listafp", - "list3820", - "irm", - "sc", - "icc", - "icm", - "igl", - "ivp", - "ivu", - "igm", - "xpw", - "xpx", - "i2g", - "qbo", - "qfx", - "rcprofile", - "irp", - "xpr", - "fcs", - "jam", - "rms", - "jisp", - "joda", - "ktz", - "ktr", - "karbon", - "chrt", - "kfo", - "flw", - "kon", - "kpr", - "kpt", - "ksp", - "kwd", - "kwt", - "htke", - "kia", - "kne", - "knp", - "skp", - "skd", - "skt", - "skm", - "sse", - "lasxml", - "lbd", - "lbe", - "apr", - "pre", - "nsf", - "org", - "scm", - "lwp", - "portpkg", - "mvt", - "mcd", - "mc1", - "cdkey", - "mwf", - "mfm", - "flo", - "igx", - "mif", - "daf", - "dis", - "mbk", - "mqy", - "msl", - "plc", - "txf", - "mpn", - "mpc", - "xul", - "cil", - "cab", - "xls", - "xlm", - "xla", - "xlc", - "xlt", - "xlw", - "xlam", - "xlsb", - "xlsm", - "xltm", - "eot", - "chm", - "ims", - "lrm", - "thmx", - "msg", - "cat", - "*stl", - "ppt", - "pps", - "pot", - "ppam", - "pptm", - "sldm", - "ppsm", - "potm", - "mpp", - "mpt", - "docm", - "dotm", - "wps", - "wks", - "wcm", - "wdb", - "wpl", - "xps", - "mseq", - "mus", - "msty", - "taglet", - "nlu", - "ntf", - "nitf", - "nnd", - "nns", - "nnw", - "*ac", - "ngdat", - "n-gage", - "rpst", - "rpss", - "edm", - "edx", - "ext", - "odc", - "otc", - "odb", - "odf", - "odft", - "odg", - "otg", - "odi", - "oti", - "odp", - "otp", - "ods", - "ots", - "odt", - "odm", - "ott", - "oth", - "xo", - "dd2", - "obgx", - "oxt", - "osm", - "pptx", - "sldx", - "ppsx", - "potx", - "xlsx", - "xltx", - "docx", - "dotx", - "mgp", - "dp", - "esa", - "pdb", - "pqa", - "oprc", - "paw", - "str", - "ei6", - "efif", - "wg", - "plf", - "pbd", - "box", - "mgz", - "qps", - "ptid", - "qxd", - "qxt", - "qwd", - "qwt", - "qxl", - "qxb", - "rar", - "bed", - "mxl", - "musicxml", - "cryptonote", - "cod", - "rm", - "rmvb", - "link66", - "st", - "see", - "sema", - "semd", - "semf", - "ifm", - "itp", - "iif", - "ipk", - "twd", - "twds", - "mmf", - "teacher", - "fo", - "sdkm", - "sdkd", - "dxp", - "sfs", - "sdc", - "sda", - "sdd", - "smf", - "sdw", - "vor", - "sgl", - "smzip", - "sm", - "wadl", - "sxc", - "stc", - "sxd", - "std", - "sxi", - "sti", - "sxm", - "sxw", - "sxg", - "stw", - "sus", - "susp", - "svd", - "sis", - "sisx", - "xsm", - "bdm", - "xdm", - "ddf", - "tao", - "pcap", - "cap", - "dmp", - "tmo", - "tpt", - "mxs", - "tra", - "ufd", - "ufdl", - "utz", - "umj", - "unityweb", - "uoml", - "vcx", - "vsd", - "vst", - "vss", - "vsw", - "vis", - "vsf", - "wbxml", - "wmlc", - "wmlsc", - "wtb", - "nbp", - "wpd", - "wqd", - "stf", - "xar", - "xfdl", - "hvd", - "hvs", - "hvp", - "osf", - "osfpvg", - "saf", - "spf", - "cmp", - "zir", - "zirz", - "zaz", - "7z", - "abw", - "ace", - "*dmg", - "arj", - "aab", - "x32", - "u32", - "vox", - "aam", - "aas", - "bcpio", - "*bdoc", - "torrent", - "blb", - "blorb", - "bz", - "bz2", - "boz", - "cbr", - "cba", - "cbt", - "cbz", - "cb7", - "vcd", - "cfs", - "chat", - "pgn", - "crx", - "cco", - "nsc", - "cpio", - "csh", - "*deb", - "udeb", - "dgc", - "dir", - "dcr", - "dxr", - "cst", - "cct", - "cxt", - "w3d", - "fgd", - "swa", - "wad", - "ncx", - "dtb", - "res", - "dvi", - "evy", - "eva", - "bdf", - "gsf", - "psf", - "pcf", - "snf", - "pfa", - "pfb", - "pfm", - "afm", - "arc", - "spl", - "gca", - "ulx", - "gnumeric", - "gramps", - "gtar", - "hdf", - "php", - "install", - "*iso", - "*key", - "*numbers", - "*pages", - "jardiff", - "jnlp", - "kdbx", - "latex", - "luac", - "lzh", - "lha", - "run", - "mie", - "prc", - "mobi", - "application", - "lnk", - "wmd", - "wmz", - "xbap", - "mdb", - "obd", - "crd", - "clp", - "*exe", - "*dll", - "com", - "bat", - "*msi", - "mvb", - "m13", - "m14", - "*wmf", - "*wmz", - "*emf", - "emz", - "mny", - "pub", - "scd", - "trm", - "wri", - "nc", - "cdf", - "pac", - "nzb", - "pl", - "pm", - "*prc", - "*pdb", - "p12", - "pfx", - "p7b", - "spc", - "p7r", - "*rar", - "rpm", - "ris", - "sea", - "sh", - "shar", - "swf", - "xap", - "sql", - "sit", - "sitx", - "srt", - "sv4cpio", - "sv4crc", - "t3", - "gam", - "tar", - "tcl", - "tk", - "tex", - "tfm", - "texinfo", - "texi", - "*obj", - "ustar", - "hdd", - "ova", - "ovf", - "vbox", - "vbox-extpack", - "vdi", - "vhd", - "vmdk", - "src", - "webapp", - "der", - "crt", - "pem", - "fig", - "*xlf", - "xpi", - "xz", - "z1", - "z2", - "z3", - "z4", - "z5", - "z6", - "z7", - "z8", - "uva", - "uvva", - "eol", - "dra", - "dts", - "dtshd", - "lvp", - "pya", - "ecelp4800", - "ecelp7470", - "ecelp9600", - "rip", - "aac", - "aif", - "aiff", - "aifc", - "caf", - "flac", - "*m4a", - "mka", - "m3u", - "wax", - "wma", - "ram", - "ra", - "rmp", - "*ra", - "cdx", - "cif", - "cmdf", - "cml", - "csml", - "xyz", - "btif", - "pti", - "psd", - "azv", - "uvi", - "uvvi", - "uvg", - "uvvg", - "djvu", - "djv", - "*sub", - "dwg", - "dxf", - "fbs", - "fpx", - "fst", - "mmr", - "rlc", - "ico", - "dds", - "mdi", - "wdp", - "npx", - "b16", - "tap", - "vtf", - "wbmp", - "xif", - "pcx", - "3ds", - "ras", - "cmx", - "fh", - "fhc", - "fh4", - "fh5", - "fh7", - "*ico", - "jng", - "sid", - "*bmp", - "*pcx", - "pic", - "pct", - "pnm", - "pbm", - "pgm", - "ppm", - "rgb", - "tga", - "xbm", - "xpm", - "xwd", - "wsc", - "dae", - "dwf", - "gdl", - "gtw", - "mts", - "ogex", - "x_b", - "x_t", - "vds", - "usdz", - "bsp", - "vtu", - "dsc", - "curl", - "dcurl", - "mcurl", - "scurl", - "sub", - "fly", - "flx", - "gv", - "3dml", - "spot", - "jad", - "wml", - "wmls", - "s", - "asm", - "c", - "cc", - "cxx", - "cpp", - "h", - "hh", - "dic", - "htc", - "f", - "for", - "f77", - "f90", - "hbs", - "java", - "lua", - "mkd", - "nfo", - "opml", - "*org", - "p", - "pas", - "pde", - "sass", - "scss", - "etx", - "sfv", - "ymp", - "uu", - "vcs", - "vcf", - "uvh", - "uvvh", - "uvm", - "uvvm", - "uvp", - "uvvp", - "uvs", - "uvvs", - "uvv", - "uvvv", - "dvb", - "fvt", - "mxu", - "m4u", - "pyv", - "uvu", - "uvvu", - "viv", - "f4v", - "fli", - "flv", - "m4v", - "mkv", - "mk3d", - "mks", - "mng", - "asf", - "asx", - "vob", - "wm", - "wmv", - "wmx", - "wvx", - "avi", - "movie", - "smv", - "ice", - "mht", - null, - ], - "example": "pdf", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "unified_url": { - "description": "Unified download URL for retrieving file content.", - "example": "https://api.stackone.com/unified/hris/employees/12345/documents/67890/download", - "nullable": true, - "type": "string", - }, - "url": { - "description": "URL where the file content is located", - "example": "https://example.com/file.pdf", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "nullable": true, - "type": "array", - }, - "created_at": { - "description": "The creation date of the file", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - "file_format": { - "description": "The file format of the file", - "nullable": true, - "properties": { - "value": { - "description": "The file format of the file, expressed as a file extension", - "enum": [ - "unmapped_value", - "ez", - "aw", - "atom", - "atomcat", - "atomdeleted", - "atomsvc", - "dwd", - "held", - "rsat", - "bdoc", - "xcs", - "ccxml", - "cdfx", - "cdmia", - "cdmic", - "cdmid", - "cdmio", - "cdmiq", - "cu", - "mpd", - "davmount", - "dbk", - "dssc", - "xdssc", - "es", - "ecma", - "emma", - "emotionml", - "epub", - "exi", - "exp", - "fdt", - "pfr", - "geojson", - "gml", - "gpx", - "gxf", - "gz", - "hjson", - "stk", - "ink", - "inkml", - "ipfix", - "its", - "jar", - "war", - "ear", - "ser", - "class", - "js", - "mjs", - "json", - "map", - "json5", - "jsonml", - "jsonld", - "lgr", - "lostxml", - "hqx", - "cpt", - "mads", - "webmanifest", - "mrc", - "mrcx", - "ma", - "nb", - "mb", - "mathml", - "mbox", - "mscml", - "metalink", - "meta4", - "mets", - "maei", - "musd", - "mods", - "m21", - "mp21", - "mp4s", - "m4p", - "doc", - "dot", - "mxf", - "nq", - "nt", - "cjs", - "bin", - "dms", - "lrf", - "mar", - "so", - "dist", - "distz", - "pkg", - "bpk", - "dump", - "elc", - "deploy", - "exe", - "dll", - "deb", - "dmg", - "iso", - "img", - "msi", - "msp", - "msm", - "buffer", - "oda", - "opf", - "ogx", - "omdoc", - "onetoc", - "onetoc2", - "onetmp", - "onepkg", - "oxps", - "relo", - "xer", - "pdf", - "pgp", - "asc", - "sig", - "prf", - "p10", - "p7m", - "p7c", - "p7s", - "p8", - "ac", - "cer", - "crl", - "pkipath", - "pki", - "pls", - "ai", - "eps", - "ps", - "provx", - "pskcxml", - "raml", - "rdf", - "owl", - "rif", - "rnc", - "rl", - "rld", - "rs", - "rapd", - "sls", - "rusd", - "gbr", - "mft", - "roa", - "rsd", - "rss", - "rtf", - "sbml", - "scq", - "scs", - "spq", - "spp", - "sdp", - "senmlx", - "sensmlx", - "setpay", - "setreg", - "shf", - "siv", - "sieve", - "smi", - "smil", - "rq", - "srx", - "gram", - "grxml", - "sru", - "ssdl", - "ssml", - "swidtag", - "tei", - "teicorpus", - "tfi", - "tsd", - "toml", - "trig", - "ttml", - "ubj", - "rsheet", - "td", - "vxml", - "wasm", - "wgt", - "hlp", - "wsdl", - "wspolicy", - "xaml", - "xav", - "xca", - "xdf", - "xel", - "xns", - "xenc", - "xhtml", - "xht", - "xlf", - "xml", - "xsl", - "xsd", - "rng", - "dtd", - "xop", - "xpl", - "*xsl", - "xslt", - "xspf", - "mxml", - "xhvml", - "xvml", - "xvm", - "yang", - "yin", - "zip", - "*3gpp", - "adp", - "amr", - "au", - "snd", - "mid", - "midi", - "kar", - "rmi", - "mxmf", - "*mp3", - "m4a", - "mp4a", - "mpga", - "mp2", - "mp2a", - "mp3", - "m2a", - "m3a", - "oga", - "ogg", - "spx", - "opus", - "s3m", - "sil", - "wav", - "*wav", - "weba", - "xm", - "ttc", - "otf", - "ttf", - "woff", - "woff2", - "exr", - "apng", - "avif", - "bmp", - "cgm", - "drle", - "emf", - "fits", - "g3", - "gif", - "heic", - "heics", - "heif", - "heifs", - "hej2", - "hsj2", - "ief", - "jls", - "jp2", - "jpg2", - "jpeg", - "jpg", - "jpe", - "jph", - "jhc", - "jpm", - "jpx", - "jpf", - "jxr", - "jxra", - "jxrs", - "jxs", - "jxsc", - "jxsi", - "jxss", - "ktx", - "ktx2", - "png", - "sgi", - "svg", - "svgz", - "t38", - "tif", - "tiff", - "tfx", - "webp", - "wmf", - "disposition-notification", - "u8msg", - "u8dsn", - "u8mdn", - "u8hdr", - "eml", - "mime", - "3mf", - "gltf", - "glb", - "igs", - "iges", - "msh", - "mesh", - "silo", - "mtl", - "obj", - "stpx", - "stpz", - "stpxz", - "stl", - "wrl", - "vrml", - "*x3db", - "x3dbz", - "x3db", - "*x3dv", - "x3dvz", - "x3d", - "x3dz", - "x3dv", - "appcache", - "manifest", - "ics", - "ifb", - "coffee", - "litcoffee", - "css", - "csv", - "html", - "htm", - "shtml", - "jade", - "jsx", - "less", - "markdown", - "md", - "mml", - "mdx", - "n3", - "txt", - "text", - "conf", - "def", - "list", - "log", - "in", - "ini", - "rtx", - "*rtf", - "sgml", - "sgm", - "shex", - "slim", - "slm", - "spdx", - "stylus", - "styl", - "tsv", - "t", - "tr", - "roff", - "man", - "me", - "ms", - "ttl", - "uri", - "uris", - "urls", - "vcard", - "vtt", - "*xml", - "yaml", - "yml", - "3gp", - "3gpp", - "3g2", - "h261", - "h263", - "h264", - "m4s", - "jpgv", - "*jpm", - "jpgm", - "mj2", - "mjp2", - "ts", - "mp4", - "mp4v", - "mpg4", - "mpeg", - "mpg", - "mpe", - "m1v", - "m2v", - "ogv", - "qt", - "mov", - "webm", - "cww", - "1km", - "plb", - "psb", - "pvb", - "tcap", - "pwn", - "aso", - "imp", - "acu", - "atc", - "acutc", - "air", - "fcdt", - "fxp", - "fxpl", - "xdp", - "xfdf", - "ahead", - "azf", - "azs", - "azw", - "acc", - "ami", - "apk", - "cii", - "fti", - "atx", - "mpkg", - "key", - "m3u8", - "numbers", - "pages", - "pkpass", - "swi", - "iota", - "aep", - "bmml", - "mpm", - "bmi", - "rep", - "cdxml", - "mmd", - "cdy", - "csl", - "cla", - "rp9", - "c4g", - "c4d", - "c4f", - "c4p", - "c4u", - "c11amc", - "c11amz", - "csp", - "cdbcmsg", - "cmc", - "clkx", - "clkk", - "clkp", - "clkt", - "clkw", - "wbs", - "pml", - "ppd", - "car", - "pcurl", - "dart", - "rdz", - "dbf", - "uvf", - "uvvf", - "uvd", - "uvvd", - "uvt", - "uvvt", - "uvx", - "uvvx", - "uvz", - "uvvz", - "fe_launch", - "dna", - "mlp", - "mle", - "dpg", - "dfac", - "kpxx", - "ait", - "svc", - "geo", - "mag", - "nml", - "esf", - "msf", - "qam", - "slt", - "ssf", - "es3", - "et3", - "ez2", - "ez3", - "fdf", - "mseed", - "seed", - "dataless", - "gph", - "ftc", - "fm", - "frame", - "maker", - "book", - "fnc", - "ltf", - "fsc", - "oas", - "oa2", - "oa3", - "fg5", - "bh2", - "ddd", - "xdw", - "xbd", - "fzs", - "txd", - "ggb", - "ggt", - "gex", - "gre", - "gxt", - "g2w", - "g3w", - "gmx", - "gdoc", - "gslides", - "gsheet", - "kml", - "kmz", - "gqf", - "gqs", - "gac", - "ghf", - "gim", - "grv", - "gtm", - "tpl", - "vcg", - "hal", - "zmm", - "hbci", - "les", - "hpgl", - "hpid", - "hps", - "jlt", - "pcl", - "pclxl", - "sfd-hdstx", - "mpy", - "afp", - "listafp", - "list3820", - "irm", - "sc", - "icc", - "icm", - "igl", - "ivp", - "ivu", - "igm", - "xpw", - "xpx", - "i2g", - "qbo", - "qfx", - "rcprofile", - "irp", - "xpr", - "fcs", - "jam", - "rms", - "jisp", - "joda", - "ktz", - "ktr", - "karbon", - "chrt", - "kfo", - "flw", - "kon", - "kpr", - "kpt", - "ksp", - "kwd", - "kwt", - "htke", - "kia", - "kne", - "knp", - "skp", - "skd", - "skt", - "skm", - "sse", - "lasxml", - "lbd", - "lbe", - "apr", - "pre", - "nsf", - "org", - "scm", - "lwp", - "portpkg", - "mvt", - "mcd", - "mc1", - "cdkey", - "mwf", - "mfm", - "flo", - "igx", - "mif", - "daf", - "dis", - "mbk", - "mqy", - "msl", - "plc", - "txf", - "mpn", - "mpc", - "xul", - "cil", - "cab", - "xls", - "xlm", - "xla", - "xlc", - "xlt", - "xlw", - "xlam", - "xlsb", - "xlsm", - "xltm", - "eot", - "chm", - "ims", - "lrm", - "thmx", - "msg", - "cat", - "*stl", - "ppt", - "pps", - "pot", - "ppam", - "pptm", - "sldm", - "ppsm", - "potm", - "mpp", - "mpt", - "docm", - "dotm", - "wps", - "wks", - "wcm", - "wdb", - "wpl", - "xps", - "mseq", - "mus", - "msty", - "taglet", - "nlu", - "ntf", - "nitf", - "nnd", - "nns", - "nnw", - "*ac", - "ngdat", - "n-gage", - "rpst", - "rpss", - "edm", - "edx", - "ext", - "odc", - "otc", - "odb", - "odf", - "odft", - "odg", - "otg", - "odi", - "oti", - "odp", - "otp", - "ods", - "ots", - "odt", - "odm", - "ott", - "oth", - "xo", - "dd2", - "obgx", - "oxt", - "osm", - "pptx", - "sldx", - "ppsx", - "potx", - "xlsx", - "xltx", - "docx", - "dotx", - "mgp", - "dp", - "esa", - "pdb", - "pqa", - "oprc", - "paw", - "str", - "ei6", - "efif", - "wg", - "plf", - "pbd", - "box", - "mgz", - "qps", - "ptid", - "qxd", - "qxt", - "qwd", - "qwt", - "qxl", - "qxb", - "rar", - "bed", - "mxl", - "musicxml", - "cryptonote", - "cod", - "rm", - "rmvb", - "link66", - "st", - "see", - "sema", - "semd", - "semf", - "ifm", - "itp", - "iif", - "ipk", - "twd", - "twds", - "mmf", - "teacher", - "fo", - "sdkm", - "sdkd", - "dxp", - "sfs", - "sdc", - "sda", - "sdd", - "smf", - "sdw", - "vor", - "sgl", - "smzip", - "sm", - "wadl", - "sxc", - "stc", - "sxd", - "std", - "sxi", - "sti", - "sxm", - "sxw", - "sxg", - "stw", - "sus", - "susp", - "svd", - "sis", - "sisx", - "xsm", - "bdm", - "xdm", - "ddf", - "tao", - "pcap", - "cap", - "dmp", - "tmo", - "tpt", - "mxs", - "tra", - "ufd", - "ufdl", - "utz", - "umj", - "unityweb", - "uoml", - "vcx", - "vsd", - "vst", - "vss", - "vsw", - "vis", - "vsf", - "wbxml", - "wmlc", - "wmlsc", - "wtb", - "nbp", - "wpd", - "wqd", - "stf", - "xar", - "xfdl", - "hvd", - "hvs", - "hvp", - "osf", - "osfpvg", - "saf", - "spf", - "cmp", - "zir", - "zirz", - "zaz", - "7z", - "abw", - "ace", - "*dmg", - "arj", - "aab", - "x32", - "u32", - "vox", - "aam", - "aas", - "bcpio", - "*bdoc", - "torrent", - "blb", - "blorb", - "bz", - "bz2", - "boz", - "cbr", - "cba", - "cbt", - "cbz", - "cb7", - "vcd", - "cfs", - "chat", - "pgn", - "crx", - "cco", - "nsc", - "cpio", - "csh", - "*deb", - "udeb", - "dgc", - "dir", - "dcr", - "dxr", - "cst", - "cct", - "cxt", - "w3d", - "fgd", - "swa", - "wad", - "ncx", - "dtb", - "res", - "dvi", - "evy", - "eva", - "bdf", - "gsf", - "psf", - "pcf", - "snf", - "pfa", - "pfb", - "pfm", - "afm", - "arc", - "spl", - "gca", - "ulx", - "gnumeric", - "gramps", - "gtar", - "hdf", - "php", - "install", - "*iso", - "*key", - "*numbers", - "*pages", - "jardiff", - "jnlp", - "kdbx", - "latex", - "luac", - "lzh", - "lha", - "run", - "mie", - "prc", - "mobi", - "application", - "lnk", - "wmd", - "wmz", - "xbap", - "mdb", - "obd", - "crd", - "clp", - "*exe", - "*dll", - "com", - "bat", - "*msi", - "mvb", - "m13", - "m14", - "*wmf", - "*wmz", - "*emf", - "emz", - "mny", - "pub", - "scd", - "trm", - "wri", - "nc", - "cdf", - "pac", - "nzb", - "pl", - "pm", - "*prc", - "*pdb", - "p12", - "pfx", - "p7b", - "spc", - "p7r", - "*rar", - "rpm", - "ris", - "sea", - "sh", - "shar", - "swf", - "xap", - "sql", - "sit", - "sitx", - "srt", - "sv4cpio", - "sv4crc", - "t3", - "gam", - "tar", - "tcl", - "tk", - "tex", - "tfm", - "texinfo", - "texi", - "*obj", - "ustar", - "hdd", - "ova", - "ovf", - "vbox", - "vbox-extpack", - "vdi", - "vhd", - "vmdk", - "src", - "webapp", - "der", - "crt", - "pem", - "fig", - "*xlf", - "xpi", - "xz", - "z1", - "z2", - "z3", - "z4", - "z5", - "z6", - "z7", - "z8", - "uva", - "uvva", - "eol", - "dra", - "dts", - "dtshd", - "lvp", - "pya", - "ecelp4800", - "ecelp7470", - "ecelp9600", - "rip", - "aac", - "aif", - "aiff", - "aifc", - "caf", - "flac", - "*m4a", - "mka", - "m3u", - "wax", - "wma", - "ram", - "ra", - "rmp", - "*ra", - "cdx", - "cif", - "cmdf", - "cml", - "csml", - "xyz", - "btif", - "pti", - "psd", - "azv", - "uvi", - "uvvi", - "uvg", - "uvvg", - "djvu", - "djv", - "*sub", - "dwg", - "dxf", - "fbs", - "fpx", - "fst", - "mmr", - "rlc", - "ico", - "dds", - "mdi", - "wdp", - "npx", - "b16", - "tap", - "vtf", - "wbmp", - "xif", - "pcx", - "3ds", - "ras", - "cmx", - "fh", - "fhc", - "fh4", - "fh5", - "fh7", - "*ico", - "jng", - "sid", - "*bmp", - "*pcx", - "pic", - "pct", - "pnm", - "pbm", - "pgm", - "ppm", - "rgb", - "tga", - "xbm", - "xpm", - "xwd", - "wsc", - "dae", - "dwf", - "gdl", - "gtw", - "mts", - "ogex", - "x_b", - "x_t", - "vds", - "usdz", - "bsp", - "vtu", - "dsc", - "curl", - "dcurl", - "mcurl", - "scurl", - "sub", - "fly", - "flx", - "gv", - "3dml", - "spot", - "jad", - "wml", - "wmls", - "s", - "asm", - "c", - "cc", - "cxx", - "cpp", - "h", - "hh", - "dic", - "htc", - "f", - "for", - "f77", - "f90", - "hbs", - "java", - "lua", - "mkd", - "nfo", - "opml", - "*org", - "p", - "pas", - "pde", - "sass", - "scss", - "etx", - "sfv", - "ymp", - "uu", - "vcs", - "vcf", - "uvh", - "uvvh", - "uvm", - "uvvm", - "uvp", - "uvvp", - "uvs", - "uvvs", - "uvv", - "uvvv", - "dvb", - "fvt", - "mxu", - "m4u", - "pyv", - "uvu", - "uvvu", - "viv", - "f4v", - "fli", - "flv", - "m4v", - "mkv", - "mk3d", - "mks", - "mng", - "asf", - "asx", - "vob", - "wm", - "wmv", - "wmx", - "wvx", - "avi", - "movie", - "smv", - "ice", - "mht", - null, - ], - "example": "pdf", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string", - }, - "name": { - "description": "The name of the file", - "example": "My Document", - "nullable": true, - "type": "string", - }, - "path": { - "description": "The path where the file is stored", - "example": "/path/to/file", - "nullable": true, - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string", - }, - "remote_url": { - "description": "URL where the file content is located", - "example": "https://example.com/file.pdf", - "nullable": true, - "type": "string", - }, - "updated_at": { - "description": "The update date of the file", - "example": "2021-01-02T01:01:01.000Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "issued_by": { - "description": "The country code of the issued by authority", - "nullable": true, - "properties": { - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "number": { - "example": "1234567890", - "nullable": true, - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "nullable": true, - "type": "object", - }, - "subResourceId": { - "type": "string", - }, - "sub_type": { - "example": "H1B", - "nullable": true, - "type": "string", - }, - "type": { - "example": "visa", - "nullable": true, - "properties": { - "value": { - "enum": [ - "visa", - "passport", - "driver_license", - "birth_certificate", - "other", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "valid_from": { - "example": "2021-01-01T00:00.000Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - "valid_to": { - "example": "2021-01-01T00:00.000Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - }, - "hris_update_time_off_request": { - "description": "Update time off request", - "execute": { - "bodyType": "json", - "method": "PATCH", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "body", - "name": "employee_id", - "type": "string", - }, - { - "location": "body", - "name": "approver_id", - "type": "string", - }, - { - "location": "body", - "name": "status", - "type": "object", - }, - { - "location": "body", - "name": "type", - "type": "object", - }, - { - "location": "body", - "name": "start_date", - "type": "string", - }, - { - "location": "body", - "name": "end_date", - "type": "string", - }, - { - "location": "body", - "name": "start_half_day", - "type": "string", - }, - { - "location": "body", - "name": "end_half_day", - "type": "string", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_off/{id}", - }, - "name": "hris_update_time_off_request", - "parameters": { - "properties": { - "approver_id": { - "description": "The approver ID", - "example": "1687-4", - "nullable": true, - "type": "string", - }, - "employee_id": { - "description": "The employee ID", - "example": "1687-3", - "nullable": true, - "type": "string", - }, - "end_date": { - "description": "The end date of the time off request", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - "end_half_day": { - "description": "True if the end of the time off request ends half way through the day", - "example": true, - "nullable": true, - "oneOf": [ - { - "type": "boolean", - }, - { - "enum": [ - "true", - "false", - ], - "type": "string", - }, - ], - }, - "id": { - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "nullable": true, - "type": "object", - }, - "start_date": { - "description": "The start date of the time off request", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "nullable": true, - "type": "string", - }, - "start_half_day": { - "description": "True if the start of the time off request begins half way through the day", - "example": true, - "nullable": true, - "oneOf": [ - { - "type": "boolean", - }, - { - "enum": [ - "true", - "false", - ], - "type": "string", - }, - ], - }, - "status": { - "description": "The status of the time off request", - "nullable": true, - "properties": { - "value": { - "enum": [ - "approved", - "cancelled", - "rejected", - "pending", - "unmapped_value", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "type": { - "description": "The type of the time off request", - "nullable": true, - "properties": { - "value": { - "enum": [ - "sick", - "unmapped_value", - "vacation", - "long_term_disability", - "short_term_disability", - "absent", - "comp_time", - "training", - "annual_leave", - "leave_of_absence", - "break", - "child_care_leave", - "maternity_leave", - "jury_duty", - "bereavement_leave", - "sabbatical", - "accident", - null, - ], - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - ], - "type": "object", - }, - }, - "hris_upload_employee_document": { - "description": "Upload Employee Document", - "execute": { - "bodyType": "json", - "method": "POST", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "derivedFrom": "file_path", - "location": "body", - "name": "name", - "type": "string", - }, - { - "derivedFrom": "file_path", - "location": "body", - "name": "file_format", - "type": "object", - }, - { - "derivedFrom": "file_path", - "location": "body", - "name": "content", - "type": "string", - }, - { - "location": "body", - "name": "category_id", - "type": "string", - }, - { - "location": "body", - "name": "path", - "type": "string", - }, - { - "location": "body", - "name": "category", - "type": "object", - }, - { - "location": "body", - "name": "confidential", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/documents/upload", - }, - "name": "hris_upload_employee_document", - "parameters": { - "properties": { - "category": { - "description": "The category to be associated with the file to be uploaded. Id will take precedence over name.", - "example": { - "id": "550e8400-e29b-41d4-a716-446655440000", - "name": "reports", - }, - "nullable": true, - "properties": { - "value": { - "description": "The category name to associate with the file", - "enum": [ - "application", - "academic", - "contract", - "certificates", - "visa", - "passport", - "driver_license", - "payslip", - "payroll", - "appraisal", - "resume", - "policy", - "cover_letter", - "offer_letter", - "policy_agreement", - "home_address", - "national_id", - "confidential", - "signed", - "shared", - "other", - "benefit", - "id_verification", - "background_check", - "unmapped_value", - null, - ], - "example": "reports", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "category_id": { - "description": "The categoryId of the documents", - "example": "6530", - "nullable": true, - "type": "string", - }, - "confidential": { - "description": "The confidentiality level of the file to be uploaded", - "nullable": true, - "properties": { - "value": { - "description": "Whether the file is confidential or not", - "enum": [ - "true", - "false", - null, - ], - "example": "true", - "nullable": true, - "type": "string", - }, - }, - "type": "object", - }, - "file_path": { - "description": "Path to the file to upload. The filename and format will be automatically extracted from the path.", - "type": "string", - }, - "id": { - "type": "string", - }, - "path": { - "description": "The path for the file to be uploaded to", - "example": "/path/to/file", - "nullable": true, - "type": "string", - }, - "x-account-id": { - "description": "The account identifier", - "type": "string", - }, - }, - "required": [ - "id", - "file_path", - ], - "type": "object", - }, - }, -} -`; diff --git a/src/tests/exports.spec.ts b/src/tests/exports.spec.ts index d70c8806..361e08d5 100644 --- a/src/tests/exports.spec.ts +++ b/src/tests/exports.spec.ts @@ -7,6 +7,7 @@ describe('Module Exports', () => { expect(StackOneAI.StackOneTool).toBeDefined(); expect(StackOneAI.Tools).toBeDefined(); expect(StackOneAI.StackOneToolSet).toBeDefined(); + expect(StackOneAI.BaseTool).toBeDefined(); // Check errors expect(StackOneAI.StackOneError).toBeDefined(); @@ -15,9 +16,7 @@ describe('Module Exports', () => { expect(StackOneAI.ToolSetConfigError).toBeDefined(); expect(StackOneAI.ToolSetLoadError).toBeDefined(); - // Check OpenAPI classes - expect(StackOneAI.OpenAPIToolSet).toBeDefined(); - expect(StackOneAI.OpenAPILoader).toBeDefined(); - expect(StackOneAI.OpenAPIParser).toBeDefined(); + // Check feedback tool + expect(StackOneAI.createFeedbackTool).toBeDefined(); }); }); diff --git a/src/toolsets/base.ts b/src/toolsets/base.ts index 82d21274..e89d29f0 100644 --- a/src/toolsets/base.ts +++ b/src/toolsets/base.ts @@ -4,7 +4,6 @@ import { createMCPClient } from '../mcp'; import { BaseTool, Tools } from '../tool'; import type { ExecuteOptions, - Experimental_ToolCreationOptions, JsonDict, JsonSchemaProperties, RpcExecuteConfig, @@ -67,7 +66,6 @@ export interface BaseToolSetConfig { baseUrl?: string; authentication?: AuthenticationConfig; headers?: Record; - _oasUrl?: string; stackOneClient?: StackOne; } @@ -79,10 +77,9 @@ export abstract class ToolSet { protected authentication?: AuthenticationConfig; protected headers: Record; protected stackOneClient?: StackOne; - protected tools: BaseTool[] = []; /** - * Initialize a toolset with optional configuration + * Initialise a toolset with optional configuration * @param config Optional configuration object */ constructor(config?: BaseToolSetConfig) { @@ -166,90 +163,7 @@ export abstract class ToolSet { } /** - * Get tools matching a filter pattern - * @param filterPattern Optional glob pattern or array of patterns to filter tools - * (e.g. "hris_*", ["crm_*", "ats_*"]) - * @param headers Optional account ID or headers to apply to the tools - * @returns Collection of tools matching the filter pattern - */ - getTools(filterPattern?: string | string[], headers?: Record): Tools { - if (!filterPattern) { - console.warn( - 'No filter pattern provided. Loading all tools may exceed context windows in ' + - 'AI applications.' - ); - } - - // Create merged headers from instance headers and provided headers - const mergedHeaders = { ...this.headers, ...headers }; - - // Filter tools based on pattern - const filteredTools = this.tools.filter((tool) => { - // If headers are provided, apply them to the tool - if (mergedHeaders && tool.setHeaders) { - tool.setHeaders(mergedHeaders); - } - - return !filterPattern || this._matchesFilter(tool.name, filterPattern); - }); - - // Create a new Tools instance with the filtered tools - return new Tools(filteredTools); - } - - /** - * Get a tool by name - * @param name Tool name - * @param headers Optional headers to apply to the tool - * @returns Tool instance - */ - getTool(name: string, headers?: Record): BaseTool; - getTool(name: string, options: Experimental_ToolCreationOptions): BaseTool; - getTool( - name: string, - headersOrOptions?: Record | Experimental_ToolCreationOptions - ): BaseTool { - const tool = this.tools.find((tool) => tool.name === name); - if (!tool) { - throw new ToolSetError(`Tool with name ${name} not found`); - } - - // Determine if the second parameter is headers or experimental options - const isExperimentalOptions = - headersOrOptions && - ('experimental_schemaOverride' in headersOrOptions || - 'experimental_preExecute' in headersOrOptions); - - if (isExperimentalOptions) { - const options = headersOrOptions as Experimental_ToolCreationOptions; - - // Get the tools collection and use its getTool method with experimental options - const toolsCollection = new Tools([tool]); - const experimentalTool = toolsCollection.getTool(name, options); - - if (!experimentalTool) { - throw new ToolSetError(`Tool with name ${name} not found`); - } - - // Apply instance headers to the tool - if (this.headers && experimentalTool.setHeaders) { - experimentalTool.setHeaders(this.headers); - } - - return experimentalTool; - } - - // Traditional headers-based approach - const headers = headersOrOptions as Record | undefined; - const mergedHeaders = { ...this.headers, ...headers }; - if (mergedHeaders && tool.setHeaders) { - tool.setHeaders(mergedHeaders); - } - return tool; - } - - /** - * Fetch tool definitions from MCP (if applicable) + * Fetch tool definitions from MCP */ async fetchTools(): Promise { if (!this.baseUrl) { diff --git a/src/toolsets/index.ts b/src/toolsets/index.ts index b32525f3..4545723f 100644 --- a/src/toolsets/index.ts +++ b/src/toolsets/index.ts @@ -10,10 +10,3 @@ export { // Export StackOne toolset export { StackOneToolSet, type StackOneToolSetConfig } from './stackone'; - -// Export OpenAPI toolset -export { - OpenAPIToolSet, - type OpenAPIToolSetConfigFromFilePath, - type OpenAPIToolSetConfigFromUrl, -} from './openapi'; diff --git a/src/toolsets/openapi.ts b/src/toolsets/openapi.ts deleted file mode 100644 index e6800502..00000000 --- a/src/toolsets/openapi.ts +++ /dev/null @@ -1,136 +0,0 @@ -import * as OpenAPILoader from '../openapi/loader'; -import { BaseTool } from '../tool'; -import type { ToolDefinition } from '../types'; -import { type BaseToolSetConfig, ToolSet, ToolSetConfigError, ToolSetLoadError } from './base'; - -/** - * Configuration for OpenAPI toolset from file path - */ -export interface OpenAPIToolSetConfigFromFilePath extends BaseToolSetConfig { - /** - * Path to the OpenAPI spec file - */ - filePath: string; -} - -/** - * Configuration for OpenAPI toolset from URL - */ -export interface OpenAPIToolSetConfigFromUrl extends BaseToolSetConfig { - /** - * URL to the OpenAPI spec - */ - url: string; -} - -/** - * Class for parsing OpenAPI specs from a file path or URL - */ -export class OpenAPIToolSet extends ToolSet { - /** - * Initialize OpenAPI toolset with spec source and optional authentication - * @param config Configuration object containing filePath and optional authentication - * @throws ToolSetConfigError If neither filePath nor url is provided - * @throws ToolSetLoadError If there is an error loading the tools from the file - */ - constructor(config: OpenAPIToolSetConfigFromFilePath | Omit) { - // Initialize base class - super({ - baseUrl: config?.baseUrl, - authentication: config?.authentication, - headers: config?.headers, - }); - - if ('filePath' in config) { - this.loadToolsFromFile(config.filePath); - } else if ('url' in config) { - throw new ToolSetConfigError('url must be provided in the OpenAPIToolSet.fromUrl() method.'); - } else if (!('_oasUrl' in config) && !('filePath' in config)) { - throw new ToolSetConfigError('Either filePath or url must be provided'); - } - } - - /** - * Create an OpenAPIToolSet instance from a URL - * @param config Configuration object containing url and optional authentication - * @returns Promise resolving to a new OpenAPIToolSet instance - * @throws ToolSetConfigError If URL is not provided - * @throws ToolSetLoadError If there is an error loading the tools from the URL - */ - public static async fromUrl(config: OpenAPIToolSetConfigFromUrl): Promise { - if (!config.url) { - throw new ToolSetConfigError('URL must be provided'); - } - - const toolset = new OpenAPIToolSet({ - baseUrl: config.baseUrl, - authentication: config.authentication, - headers: config.headers, - _oasUrl: config.url, - }); - - await toolset.loadToolsFromUrl(config.url); - - return toolset; - } - - /** - * Load tools from a file - * @param filePath Path to the OpenAPI spec file - * @throws ToolSetLoadError If there is an error loading the tools from the file - */ - private loadToolsFromFile(filePath: string): void { - try { - // Load tools from the file - const tools = OpenAPILoader.loadFromFile(filePath, this.baseUrl); - - // Process each tool - for (const [toolName, toolDef] of Object.entries(tools)) { - // Create tool - const tool = this.createTool(toolName, toolDef); - - // Add tool to the list - this.tools.push(tool); - } - } catch (error) { - throw new ToolSetLoadError('Error loading tools from file', { cause: error }); - } - } - - /** - * Load tools from a URL - * @param url URL of the OpenAPI spec - * @throws ToolSetLoadError If there is an error loading the tools from the URL - */ - private async loadToolsFromUrl(url: string): Promise { - try { - // Load tools from the URL - const tools = await OpenAPILoader.loadFromUrl(url, this.baseUrl); - - // Process each tool - for (const [toolName, toolDef] of Object.entries(tools)) { - // Create tool - const tool = this.createTool(toolName, toolDef); - - // Add tool to the list - this.tools.push(tool); - } - } catch (error) { - throw new ToolSetLoadError('Error loading tools from URL', { cause: error }); - } - } - - /** - * Create a tool from a tool definition - * @param toolName Name of the tool - * @param toolDef Tool definition - * @returns Tool instance - */ - private createTool(toolName: string, toolDef: ToolDefinition): BaseTool { - // Create tool - const { description, parameters, execute } = toolDef; - const tool = new BaseTool(toolName, description, parameters, execute, this.headers); - - return tool; - } -} diff --git a/src/toolsets/stackone.ts b/src/toolsets/stackone.ts index a592d5f9..33478a4c 100644 --- a/src/toolsets/stackone.ts +++ b/src/toolsets/stackone.ts @@ -1,8 +1,5 @@ -import { loadStackOneSpecs } from '../openapi/loader'; -import { StackOneTool, Tools } from '../tool'; +import { type StackOneTool, Tools } from '../tool'; import { createFeedbackTool } from '../tools/feedback'; -import type { ToolDefinition } from '../types'; -import { removeJsonSchemaProperty } from '../utils/schema'; import { type BaseToolSetConfig, ToolSet, ToolSetConfigError } from './base'; /** @@ -12,7 +9,6 @@ export interface StackOneToolSetConfig extends BaseToolSetConfig { apiKey?: string; accountId?: string; strict?: boolean; - removedParams?: string[]; // List of parameters to remove from all tools } /** @@ -53,7 +49,7 @@ export interface WorkflowConfig { } /** - * Class for loading StackOne tools from the OAS directory + * Class for loading StackOne tools via MCP */ export class StackOneToolSet extends ToolSet { /** @@ -61,10 +57,9 @@ export class StackOneToolSet extends ToolSet { */ private accountId?: string; private accountIds: string[] = []; - private readonly _removedParams: string[]; /** - * Initialize StackOne toolset with API key and optional account ID + * Initialise StackOne toolset with API key and optional account ID * @param config Configuration object containing API key and optional account ID */ constructor(config?: StackOneToolSetConfig) { @@ -97,7 +92,7 @@ export class StackOneToolSet extends ToolSet { ...(accountId ? { 'x-account-id': accountId } : {}), }; - // Initialize base class + // Initialise base class super({ baseUrl: config?.baseUrl, authentication, @@ -105,29 +100,6 @@ export class StackOneToolSet extends ToolSet { }); this.accountId = accountId; - this._removedParams = ['source_value']; - - // Load tools - this.loadTools(); - } - - /** - * Get StackOne tools matching a filter pattern - * @param filterPattern Optional glob pattern or array of patterns to filter tools - * @param accountId Optional account ID to use for the tools - * @returns Collection of tools matching the filter pattern - */ - getStackOneTools(filterPattern?: string | string[], accountId?: string): Tools { - // Use provided account ID or fall back to the instance account ID - const effectiveAccountId = accountId || this.accountId; - - // Create headers with account ID if provided - const headers: Record = effectiveAccountId - ? { 'x-account-id': effectiveAccountId } - : {}; - - // Get tools with headers - return this.getTools(filterPattern, headers); } /** @@ -179,7 +151,13 @@ export class StackOneToolSet extends ToolSet { } // Apply provider and action filters - return this.filterTools(tools, options); + const filteredTools = this.filterTools(tools, options); + + // Add feedback tool + const feedbackTool = createFeedbackTool(undefined, this.accountId, this.baseUrl); + const toolsWithFeedback = new Tools([...filteredTools.toArray(), feedbackTool]); + + return toolsWithFeedback; } /** @@ -219,55 +197,4 @@ export class StackOneToolSet extends ToolSet { plan(_: WorkflowConfig): Promise { throw new Error('Not implemented yet'); } - - /** - * Load tools from the OAS directory - */ - private loadTools(): void { - const specs = loadStackOneSpecs(this.baseUrl, this._removedParams); - - // Process each vertical - for (const [_, tools] of Object.entries(specs)) { - // Process each tool - for (const [toolName, toolDef] of Object.entries(tools)) { - // Remove account ID parameter if not provided - if (!this.accountId) { - this.removeAccountIdParameter(toolDef); - } - - // Create tool - const tool = new StackOneTool( - toolName, - toolDef.description, - toolDef.parameters, - toolDef.execute, - this.headers - ); - - // Add tool to the list - this.tools.push(tool); - } - } - - // Add feedback collection meta tool - this.tools.push(createFeedbackTool(undefined, this.accountId, this.baseUrl)); - } - - /** - * Remove account ID parameter from a tool definition - * @param toolDef Tool definition to modify - */ - private removeAccountIdParameter(toolDef: ToolDefinition): void { - // Remove from parameters - if (toolDef.parameters.properties && 'x-account-id' in toolDef.parameters.properties) { - removeJsonSchemaProperty(toolDef.parameters.properties, 'x-account-id'); - } - - // Remove from required parameters - if (toolDef.parameters.required) { - toolDef.parameters.required = toolDef.parameters.required.filter( - (param) => param !== 'x-account-id' - ); - } - } } diff --git a/src/toolsets/tests/__snapshots__/stackone.spec.ts.snap b/src/toolsets/tests/__snapshots__/stackone.spec.ts.snap deleted file mode 100644 index bd0103b6..00000000 --- a/src/toolsets/tests/__snapshots__/stackone.spec.ts.snap +++ /dev/null @@ -1,20912 +0,0 @@ -// Bun Snapshot v1, https://bun.sh/docs/test/snapshots - -exports[`StackOneToolSet Snapshot Tests should parse the all the oas files correctly 1`] = ` -Tools { - "tools": [ - StackOneTool { - "description": "List Companies", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/companies", - }, - "experimental_preExecute": undefined, - "name": "hris_list_companies", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,full_name,display_name,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": undefined, - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/companies", - }, - }, - StackOneTool { - "description": "Get Company", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/companies/{id}", - }, - "experimental_preExecute": undefined, - "name": "hris_get_company", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,full_name,display_name,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/companies/{id}", - }, - }, - StackOneTool { - "description": "List employee Custom Field Definitions", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/custom_field_definitions/employees", - }, - "experimental_preExecute": undefined, - "name": "hris_list_employee_custom_field_definitions", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,description,type,options,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": undefined, - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/custom_field_definitions/employees", - }, - }, - StackOneTool { - "description": "Get employee Custom Field Definition", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/custom_field_definitions/employees/{id}", - }, - "experimental_preExecute": undefined, - "name": "hris_get_employee_custom_field_definition", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,description,type,options,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/custom_field_definitions/employees/{id}", - }, - }, - StackOneTool { - "description": "List Employees", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - { - "location": "query", - "name": "include", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees", - }, - "experimental_preExecute": undefined, - "name": "hris_list_employees", - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "company,employments,work_location,home_location,groups,skills", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,title,first_name,last_name,name,display_name,gender,ethnicity,date_of_birth,birthday,marital_status,avatar_url,avatar,personal_email,personal_phone_number,work_email,work_phone_number,job_id,remote_job_id,job_title,job_description,department_id,remote_department_id,department,cost_centers,company,manager_id,remote_manager_id,hire_date,start_date,tenure,work_anniversary,employment_type,employment_contract_type,employment_status,termination_date,company_name,company_id,remote_company_id,preferred_language,citizenships,home_location,work_location,employments,custom_fields,created_at,updated_at,benefits,employee_number,national_identity_number,national_identity_numbers,bank_details,skills,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "HRIS Employees filters", - "properties": { - "email": { - "description": "Filter to select employees by email", - "type": "string", - }, - "employee_number": { - "description": "Filter to select employees by employee_number", - "type": "string", - }, - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "include": { - "description": "The comma separated list of fields that will be included in the response", - "example": "avatar_url,avatar,custom_fields,job_description,benefits,bank_details", - "type": "string", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": undefined, - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - { - "location": "query", - "name": "include", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees", - }, - }, - StackOneTool { - "description": "Create Employee", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "POST", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "body", - "name": "title", - "type": "string", - }, - { - "location": "body", - "name": "first_name", - "type": "string", - }, - { - "location": "body", - "name": "last_name", - "type": "string", - }, - { - "location": "body", - "name": "name", - "type": "string", - }, - { - "location": "body", - "name": "display_name", - "type": "string", - }, - { - "location": "body", - "name": "avatar_url", - "type": "string", - }, - { - "location": "body", - "name": "personal_email", - "type": "string", - }, - { - "location": "body", - "name": "personal_phone_number", - "type": "string", - }, - { - "location": "body", - "name": "work_email", - "type": "string", - }, - { - "location": "body", - "name": "work_phone_number", - "type": "string", - }, - { - "location": "body", - "name": "job_title", - "type": "string", - }, - { - "location": "body", - "name": "department_id", - "type": "string", - }, - { - "location": "body", - "name": "team_id", - "type": "string", - }, - { - "location": "body", - "name": "department", - "type": "string", - }, - { - "location": "body", - "name": "manager_id", - "type": "string", - }, - { - "location": "body", - "name": "gender", - "type": "object", - }, - { - "location": "body", - "name": "preferred_language", - "type": "object", - }, - { - "location": "body", - "name": "ethnicity", - "type": "object", - }, - { - "location": "body", - "name": "date_of_birth", - "type": "string", - }, - { - "location": "body", - "name": "birthday", - "type": "string", - }, - { - "location": "body", - "name": "marital_status", - "type": "object", - }, - { - "location": "body", - "name": "avatar", - "type": "object", - }, - { - "location": "body", - "name": "hire_date", - "type": "string", - }, - { - "location": "body", - "name": "start_date", - "type": "string", - }, - { - "location": "body", - "name": "employment_status", - "type": "object", - }, - { - "location": "body", - "name": "termination_date", - "type": "string", - }, - { - "location": "body", - "name": "company_id", - "type": "string", - }, - { - "location": "body", - "name": "citizenships", - "type": "array", - }, - { - "location": "body", - "name": "employment", - "type": "object", - }, - { - "location": "body", - "name": "custom_fields", - "type": "array", - }, - { - "location": "body", - "name": "benefits", - "type": "array", - }, - { - "location": "body", - "name": "employee_number", - "type": "string", - }, - { - "location": "body", - "name": "national_identity_numbers", - "type": "array", - }, - { - "location": "body", - "name": "home_location", - "type": "object", - }, - { - "location": "body", - "name": "work_location", - "type": "object", - }, - { - "location": "body", - "name": "cost_centers", - "type": "array", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees", - }, - "experimental_preExecute": undefined, - "name": "hris_create_employee", - "parameters": { - "properties": { - "avatar": { - "description": "The employee avatar", - "example": "https://example.com/avatar.png", - "properties": { - "base64": { - "type": "string", - }, - "url": { - "type": "string", - }, - }, - "type": "object", - }, - "avatar_url": { - "description": "The employee avatar Url", - "example": "https://example.com/avatar.png", - "type": "string", - }, - "benefits": { - "description": "Current benefits of the employee", - "items": { - "properties": { - "benefit_type": { - "description": "The type of the benefit", - "properties": { - "value": { - "description": "The type of the benefit", - "enum": [ - "retirement_savings", - "health_savings", - "other", - "health_insurance", - "insurance", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "created_at": { - "description": "The date and time the benefit was created", - "example": "2021-01-01T00:00:00Z", - "format": "date-time", - "type": "string", - }, - "description": { - "description": "The description of the benefit", - "example": "Health insurance for employees", - "type": "string", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "name": { - "description": "The name of the benefit", - "example": "Health Insurance", - "type": "string", - }, - "provider": { - "description": "The provider of the benefit", - "example": "Aetna", - "type": "string", - }, - "updated_at": { - "description": "The date and time the benefit was last updated", - "example": "2021-01-01T00:00:00Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "type": "array", - }, - "birthday": { - "description": "The next birthday of the employee (upcoming birthday)", - "example": "2021-01-01T00:00:00Z", - "format": "date-time", - "type": "string", - }, - "citizenships": { - "description": "The citizenships of the Employee", - "items": { - "properties": { - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "type": "string", - }, - }, - "type": "object", - }, - "type": "array", - }, - "company_id": { - "description": "The employee company id", - "example": "1234567890", - "type": "string", - }, - "cost_centers": { - "description": "The employee cost centers", - "items": { - "properties": { - "distribution_percentage": { - "example": 100, - "type": "number", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "name": { - "example": "R&D", - "type": "string", - }, - }, - "type": "object", - }, - "type": "array", - }, - "custom_fields": { - "description": "The employee custom fields", - "items": { - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "name": { - "description": "The name of the custom field.", - "example": "Training Completion Status", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "remote_value_id": { - "description": "Provider's unique identifier for the value of the custom field.", - "example": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", - "type": "string", - }, - "value": { - "description": "The value associated with the custom field.", - "example": "Completed", - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - { - "format": "date-time", - "type": "string", - }, - ], - }, - "value_id": { - "description": "The unique identifier for the value of the custom field.", - "example": "value_456", - "type": "string", - }, - }, - "type": "object", - }, - "type": "array", - }, - "date_of_birth": { - "description": "The date when the employee was born", - "example": "1990-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "department": { - "description": "The employee department", - "example": "Physics", - "type": "string", - }, - "department_id": { - "description": "The employee department id", - "example": "3093", - "type": "string", - }, - "display_name": { - "description": "The employee display name", - "example": "Sir Isaac Newton", - "type": "string", - }, - "employee_number": { - "description": "The assigned employee number", - "example": "125", - "type": "string", - }, - "employment": { - "description": "The employee employment", - "properties": { - "contract_type": { - "description": "The employment work schedule type", - "properties": { - "contract_type": { - "description": "The employment work schedule type (e.g., full-time, part-time)", - "example": "full_time", - "properties": { - "value": { - "enum": [ - "full_time", - "shifts", - "part_time", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "label": { - "description": "The label of the employment type", - "example": "Full-Time", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - }, - "type": "object", - }, - "end_date": { - "description": "The end date of employment", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "type": "string", - }, - "grade": { - "description": "Represents the employeeโ€™s position within the organizational hierarchy.", - "properties": { - "description": { - "description": "description of the grade", - "example": "Mid-level employee demonstrating proficiency and autonomy.", - "type": "string", - }, - "id": { - "description": "The reference id", - "example": "1687-3", - "type": "string", - }, - "name": { - "description": "The reference name", - "example": "1687-4", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - }, - "type": "object", - }, - "job_title": { - "description": "The job title of the employee", - "example": "Software Engineer", - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "type": "object", - }, - "pay_currency": { - "description": "The currency used for pay", - "example": "USD", - "type": "string", - }, - "pay_frequency": { - "description": "How often the employee is paid", - "example": "hourly", - "properties": { - "value": { - "enum": [ - "hourly", - "weekly", - "bi_weekly", - "four_weekly", - "semi_monthly", - "monthly", - "bi_monthly", - "quarterly", - "semi_annually", - "yearly", - "thirteen_monthly", - "pro_rata", - "unmapped_value", - "half_yearly", - "daily", - "fixed", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "pay_period": { - "description": "The time period over which the pay rate is calculated", - "example": "monthly", - "properties": { - "value": { - "enum": [ - "hour", - "day", - "week", - "every_two_weeks", - "month", - "quarter", - "every_six_months", - "year", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "pay_rate": { - "description": "The amount of compensation for the employee", - "example": "40.00", - "type": "string", - }, - "payroll_code": { - "description": "The payroll code of the employee", - "example": "PC1", - "type": "string", - }, - "type": { - "description": "The type of employment", - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "label": { - "description": "The label of the employment type", - "example": "Permanent", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "type": { - "description": "The type of employment (e.g., contractor, permanent)", - "example": "permanent", - "properties": { - "value": { - "enum": [ - "contractor", - "intern", - "permanent", - "apprentice", - "freelance", - "terminated", - "temporary", - "seasonal", - "volunteer", - "probation", - "internal", - "external", - "expatriate", - "employer_of_record", - "casual", - "Programme", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - }, - "type": "object", - }, - "unified_custom_fields": { - "additionalProperties": true, - "description": "Custom Unified Fields configured in your StackOne project", - "example": { - "my_project_custom_field_1": "REF-1236", - "my_project_custom_field_2": "some other value", - }, - "type": "object", - }, - "work_time": { - "properties": { - "duration": { - "description": "The work time duration in ISO 8601 duration format", - "example": "P0Y0M0DT8H0M0S", - "format": "duration", - "type": "string", - }, - "period": { - "description": "The period of the work time", - "example": "month", - "properties": { - "value": { - "description": "The unified value for the period.", - "enum": [ - "day", - "week", - "month", - "year", - "unmapped_value", - null, - ], - "example": "month", - "type": "string", - }, - }, - "type": "object", - }, - }, - "type": "object", - }, - }, - "type": "object", - }, - "employment_status": { - "description": "The employee employment status", - "example": "active", - "properties": { - "value": { - "enum": [ - "active", - "pending", - "terminated", - "leave", - "inactive", - "unknown", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "ethnicity": { - "description": "The employee ethnicity", - "example": "white", - "properties": { - "value": { - "enum": [ - "white", - "black_or_african_american", - "asian", - "hispanic_or_latino", - "american_indian_or_alaska_native", - "native_hawaiian_or_pacific_islander", - "two_or_more_races", - "not_disclosed", - "other", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "first_name": { - "description": "The employee first name", - "example": "Isaac", - "type": "string", - }, - "gender": { - "description": "The employee gender", - "example": "male", - "properties": { - "value": { - "enum": [ - "male", - "female", - "non_binary", - "other", - "not_disclosed", - "diverse", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "hire_date": { - "description": "The employee hire date", - "example": "2021-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "home_location": { - "description": "The employee home location", - "properties": { - "city": { - "description": "The city where the location is situated", - "example": "Grantham", - "type": "string", - }, - "country": { - "description": "The country code", - "properties": { - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "name": { - "description": "The name of the location", - "example": "Woolsthorpe Manor", - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "type": "object", - }, - "phone_number": { - "description": "The phone number of the location", - "example": "+44 1476 860 364", - "type": "string", - }, - "state": { - "description": "The ISO3166-2 sub division where the location is situated", - "example": "GB-LIN", - "properties": { - "value": { - "description": "state (ISO3166-2 Sub Division Code) - value must be a valid enum value", - "type": "string", - }, - }, - "type": "object", - }, - "street_1": { - "description": "The first line of the address", - "example": "Water Lane", - "type": "string", - }, - "street_2": { - "description": "The second line of the address", - "example": "Woolsthorpe by Colsterworth", - "type": "string", - }, - "zip_code": { - "description": "The ZIP code/Postal code of the location", - "example": "NG33 5NR", - "type": "string", - }, - }, - "type": "object", - }, - "job_title": { - "description": "If the source of the job_title is the Employee's current Employment, and that Employment pertains exclusively to this Employee, then the active Employment job_title will also be written", - "example": "Physicist", - "type": "string", - }, - "last_name": { - "description": "The employee last name", - "example": "Newton", - "type": "string", - }, - "manager_id": { - "description": "The employee manager ID", - "example": "67890", - "type": "string", - }, - "marital_status": { - "description": "The employee marital status", - "example": "single", - "properties": { - "value": { - "enum": [ - "single", - "married", - "common_law", - "divorced", - "widowed", - "domestic_partnership", - "separated", - "other", - "not_disclosed", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "name": { - "description": "The employee name", - "example": "Isaac Newton", - "type": "string", - }, - "national_identity_numbers": { - "description": "The national identity numbers", - "items": { - "properties": { - "country": { - "description": "The country code", - "properties": { - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "type": "string", - }, - }, - "type": "object", - }, - "type": { - "properties": { - "value": { - "description": "The type of the national identity number", - "enum": [ - "ssn", - "nin", - "sin", - "nid", - "pin", - "pn", - "umcn", - "pic", - "ric", - "idnum", - "cid", - "nidnr", - "pan", - "aadhaar", - "epic", - "ptn", - "itin", - "tin", - "uprc", - "pcode", - "ssi", - "cedula", - "passport", - "voterid", - "ntin", - "bn", - "fnr", - "mva", - "civil_id", - "cnic", - "nric", - "fin", - "uen", - "registrationnumber", - "nic", - "personnummer", - "ahv", - "id", - "eid", - "va", - "pid", - "nrt", - "nipt", - "cbu", - "cuit", - "dni", - "businessid", - "vnr", - "abn", - "acn", - "tfn", - "jmbg", - "bis", - "insz", - "nn", - "egn", - "pnf", - "vat", - "cnpj", - "unp", - "gst", - "pst", - "qst", - "ni", - "dic", - "rc", - "uid", - "rut", - "uscc", - "cpf", - "cpj", - "cr", - "stnr", - "svnr", - "ncf", - "rnc", - "nif", - "ci", - "ik", - "kmkr", - "registrikood", - "tn", - "ruc", - "nit", - "alv", - "hetu", - "ytunnus", - "vn", - "utr", - "nifp", - "amka", - "cui", - "nir", - "siren", - "siret", - "tva", - "oib", - "hkid", - "anum", - "kennitala", - "vsk", - "npwp", - "pps", - "gstin", - "idnr", - "hr", - "aic", - "codicefiscale", - "iva", - "peid", - "asmens", - "pvm", - "ctps", - "vrn", - "vtk", - "int", - "tk", - "pas", - "rne", - "rg", - "nci", - "crnm", - "pis", - "insee", - "tax", - "mpf", - "epfo", - "esi", - "pran", - "uan", - "idk", - "bsn", - "mid", - "sss", - "nie", - "nss", - "arc", - "curp", - "imss", - "rfc", - "ein", - "other", - "unknown", - "unmapped_value", - null, - ], - "example": "ssn", - "type": "string", - }, - }, - "type": "object", - }, - "value": { - "example": "123456789", - "type": "string", - }, - }, - "type": "object", - }, - "type": "array", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "type": "object", - }, - "personal_email": { - "description": "The employee personal email", - "example": "isaac.newton@example.com", - "type": "string", - }, - "personal_phone_number": { - "description": "The employee personal phone number", - "example": "+1234567890", - "type": "string", - }, - "preferred_language": { - "description": "The employee preferred language", - "example": "eng", - "properties": { - "value": { - "description": "The ISO639-2 Code of the language", - "enum": [ - "aar", - "afr", - "amh", - "ara", - "aym", - "aze", - "bel", - "bul", - "bis", - "ben", - "bos", - "byn", - "cat", - "cha", - "ces", - "dan", - "deu", - "div", - "dzo", - "ell", - "eng", - "spa", - "est", - "fas", - "fan", - "ful", - "fin", - "fij", - "fao", - "fra", - "gle", - "grn", - "guj", - "glv", - "heb", - "hin", - "hrv", - "hat", - "hun", - "hye", - "ind", - "isl", - "ita", - "jpn", - "kat", - "kon", - "kaz", - "kal", - "khm", - "kor", - "kur", - "kir", - "lat", - "ltz", - "lin", - "lao", - "lit", - "lub", - "lav", - "mlg", - "mah", - "mri", - "mkd", - "mon", - "mar", - "msa", - "mlt", - "mya", - "nob", - "nep", - "nld", - "nno", - "nor", - "nbl", - "nya", - "pan", - "pol", - "pus", - "por", - "que", - "rar", - "roh", - "rup", - "ron", - "rus", - "kin", - "sme", - "sag", - "sin", - "slk", - "slv", - "smo", - "sna", - "som", - "sqi", - "srp", - "ssw", - "swe", - "swa", - "tam", - "tel", - "tgk", - "tha", - "tir", - "tig", - "tuk", - "tsn", - "ton", - "tur", - "tso", - "ukr", - "urd", - "uzb", - "ven", - "vie", - "xho", - "zho", - "zul", - "unmapped_value", - null, - ], - "example": "eng", - "type": "string", - }, - }, - "type": "object", - }, - "start_date": { - "description": "The employee start date", - "example": "2021-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "team_id": { - "description": "The employee team id", - "example": "2913", - "type": "string", - }, - "termination_date": { - "description": "The employee termination date", - "example": "2021-01-01T00:00:00Z", - "format": "date-time", - "type": "string", - }, - "title": { - "description": "The prefix of the employee's name (e.g., Mr, Ms, Dr)", - "example": "Mr", - "type": "string", - }, - "work_email": { - "description": "The employee work email", - "example": "newton@example.com", - "type": "string", - }, - "work_location": { - "description": "The employee work location", - "properties": { - "city": { - "description": "The city where the location is situated", - "example": "Grantham", - "type": "string", - }, - "country": { - "description": "The country code", - "properties": { - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "name": { - "description": "The name of the location", - "example": "Woolsthorpe Manor", - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "type": "object", - }, - "phone_number": { - "description": "The phone number of the location", - "example": "+44 1476 860 364", - "type": "string", - }, - "state": { - "description": "The ISO3166-2 sub division where the location is situated", - "example": "GB-LIN", - "properties": { - "value": { - "description": "state (ISO3166-2 Sub Division Code) - value must be a valid enum value", - "type": "string", - }, - }, - "type": "object", - }, - "street_1": { - "description": "The first line of the address", - "example": "Water Lane", - "type": "string", - }, - "street_2": { - "description": "The second line of the address", - "example": "Woolsthorpe by Colsterworth", - "type": "string", - }, - "zip_code": { - "description": "The ZIP code/Postal code of the location", - "example": "NG33 5NR", - "type": "string", - }, - }, - "type": "object", - }, - "work_phone_number": { - "description": "The employee work phone number", - "example": "+1234567890", - "type": "string", - }, - "x-account-id": undefined, - }, - "required": undefined, - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "POST", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "body", - "name": "title", - "type": "string", - }, - { - "location": "body", - "name": "first_name", - "type": "string", - }, - { - "location": "body", - "name": "last_name", - "type": "string", - }, - { - "location": "body", - "name": "name", - "type": "string", - }, - { - "location": "body", - "name": "display_name", - "type": "string", - }, - { - "location": "body", - "name": "avatar_url", - "type": "string", - }, - { - "location": "body", - "name": "personal_email", - "type": "string", - }, - { - "location": "body", - "name": "personal_phone_number", - "type": "string", - }, - { - "location": "body", - "name": "work_email", - "type": "string", - }, - { - "location": "body", - "name": "work_phone_number", - "type": "string", - }, - { - "location": "body", - "name": "job_title", - "type": "string", - }, - { - "location": "body", - "name": "department_id", - "type": "string", - }, - { - "location": "body", - "name": "team_id", - "type": "string", - }, - { - "location": "body", - "name": "department", - "type": "string", - }, - { - "location": "body", - "name": "manager_id", - "type": "string", - }, - { - "location": "body", - "name": "gender", - "type": "object", - }, - { - "location": "body", - "name": "preferred_language", - "type": "object", - }, - { - "location": "body", - "name": "ethnicity", - "type": "object", - }, - { - "location": "body", - "name": "date_of_birth", - "type": "string", - }, - { - "location": "body", - "name": "birthday", - "type": "string", - }, - { - "location": "body", - "name": "marital_status", - "type": "object", - }, - { - "location": "body", - "name": "avatar", - "type": "object", - }, - { - "location": "body", - "name": "hire_date", - "type": "string", - }, - { - "location": "body", - "name": "start_date", - "type": "string", - }, - { - "location": "body", - "name": "employment_status", - "type": "object", - }, - { - "location": "body", - "name": "termination_date", - "type": "string", - }, - { - "location": "body", - "name": "company_id", - "type": "string", - }, - { - "location": "body", - "name": "citizenships", - "type": "array", - }, - { - "location": "body", - "name": "employment", - "type": "object", - }, - { - "location": "body", - "name": "custom_fields", - "type": "array", - }, - { - "location": "body", - "name": "benefits", - "type": "array", - }, - { - "location": "body", - "name": "employee_number", - "type": "string", - }, - { - "location": "body", - "name": "national_identity_numbers", - "type": "array", - }, - { - "location": "body", - "name": "home_location", - "type": "object", - }, - { - "location": "body", - "name": "work_location", - "type": "object", - }, - { - "location": "body", - "name": "cost_centers", - "type": "array", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees", - }, - }, - StackOneTool { - "description": "Get Employee", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - { - "location": "query", - "name": "include", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}", - }, - "experimental_preExecute": undefined, - "name": "hris_get_employee", - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "company,employments,work_location,home_location,groups,skills", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,title,first_name,last_name,name,display_name,gender,ethnicity,date_of_birth,birthday,marital_status,avatar_url,avatar,personal_email,personal_phone_number,work_email,work_phone_number,job_id,remote_job_id,job_title,job_description,department_id,remote_department_id,department,cost_centers,company,manager_id,remote_manager_id,hire_date,start_date,tenure,work_anniversary,employment_type,employment_contract_type,employment_status,termination_date,company_name,company_id,remote_company_id,preferred_language,citizenships,home_location,work_location,employments,custom_fields,created_at,updated_at,benefits,employee_number,national_identity_number,national_identity_numbers,bank_details,skills,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "include": { - "description": "The comma separated list of fields that will be included in the response", - "example": "avatar_url,avatar,custom_fields,job_description,benefits,bank_details", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - { - "location": "query", - "name": "include", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}", - }, - }, - StackOneTool { - "description": "Update Employee", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "PATCH", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "body", - "name": "title", - "type": "string", - }, - { - "location": "body", - "name": "first_name", - "type": "string", - }, - { - "location": "body", - "name": "last_name", - "type": "string", - }, - { - "location": "body", - "name": "name", - "type": "string", - }, - { - "location": "body", - "name": "display_name", - "type": "string", - }, - { - "location": "body", - "name": "avatar_url", - "type": "string", - }, - { - "location": "body", - "name": "personal_email", - "type": "string", - }, - { - "location": "body", - "name": "personal_phone_number", - "type": "string", - }, - { - "location": "body", - "name": "work_email", - "type": "string", - }, - { - "location": "body", - "name": "work_phone_number", - "type": "string", - }, - { - "location": "body", - "name": "job_title", - "type": "string", - }, - { - "location": "body", - "name": "department_id", - "type": "string", - }, - { - "location": "body", - "name": "team_id", - "type": "string", - }, - { - "location": "body", - "name": "department", - "type": "string", - }, - { - "location": "body", - "name": "manager_id", - "type": "string", - }, - { - "location": "body", - "name": "gender", - "type": "object", - }, - { - "location": "body", - "name": "preferred_language", - "type": "object", - }, - { - "location": "body", - "name": "ethnicity", - "type": "object", - }, - { - "location": "body", - "name": "date_of_birth", - "type": "string", - }, - { - "location": "body", - "name": "birthday", - "type": "string", - }, - { - "location": "body", - "name": "marital_status", - "type": "object", - }, - { - "location": "body", - "name": "avatar", - "type": "object", - }, - { - "location": "body", - "name": "hire_date", - "type": "string", - }, - { - "location": "body", - "name": "start_date", - "type": "string", - }, - { - "location": "body", - "name": "employment_status", - "type": "object", - }, - { - "location": "body", - "name": "termination_date", - "type": "string", - }, - { - "location": "body", - "name": "company_id", - "type": "string", - }, - { - "location": "body", - "name": "citizenships", - "type": "array", - }, - { - "location": "body", - "name": "employment", - "type": "object", - }, - { - "location": "body", - "name": "custom_fields", - "type": "array", - }, - { - "location": "body", - "name": "benefits", - "type": "array", - }, - { - "location": "body", - "name": "employee_number", - "type": "string", - }, - { - "location": "body", - "name": "national_identity_numbers", - "type": "array", - }, - { - "location": "body", - "name": "home_location", - "type": "object", - }, - { - "location": "body", - "name": "work_location", - "type": "object", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}", - }, - "experimental_preExecute": undefined, - "name": "hris_update_employee", - "parameters": { - "properties": { - "avatar": { - "description": "The employee avatar", - "example": "https://example.com/avatar.png", - "properties": { - "base64": { - "type": "string", - }, - "url": { - "type": "string", - }, - }, - "type": "object", - }, - "avatar_url": { - "description": "The employee avatar Url", - "example": "https://example.com/avatar.png", - "type": "string", - }, - "benefits": { - "description": "Current benefits of the employee", - "items": { - "properties": { - "benefit_type": { - "description": "The type of the benefit", - "properties": { - "value": { - "description": "The type of the benefit", - "enum": [ - "retirement_savings", - "health_savings", - "other", - "health_insurance", - "insurance", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "created_at": { - "description": "The date and time the benefit was created", - "example": "2021-01-01T00:00:00Z", - "format": "date-time", - "type": "string", - }, - "description": { - "description": "The description of the benefit", - "example": "Health insurance for employees", - "type": "string", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "name": { - "description": "The name of the benefit", - "example": "Health Insurance", - "type": "string", - }, - "provider": { - "description": "The provider of the benefit", - "example": "Aetna", - "type": "string", - }, - "updated_at": { - "description": "The date and time the benefit was last updated", - "example": "2021-01-01T00:00:00Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "type": "array", - }, - "birthday": { - "description": "The next birthday of the employee (upcoming birthday)", - "example": "2021-01-01T00:00:00Z", - "format": "date-time", - "type": "string", - }, - "citizenships": { - "description": "The citizenships of the Employee", - "items": { - "properties": { - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "type": "string", - }, - }, - "type": "object", - }, - "type": "array", - }, - "company_id": { - "description": "The employee company id", - "example": "1234567890", - "type": "string", - }, - "custom_fields": { - "description": "The employee custom fields", - "items": { - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "name": { - "description": "The name of the custom field.", - "example": "Training Completion Status", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "remote_value_id": { - "description": "Provider's unique identifier for the value of the custom field.", - "example": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", - "type": "string", - }, - "value": { - "description": "The value associated with the custom field.", - "example": "Completed", - "oneOf": [ - { - "type": "string", - }, - { - "type": "number", - }, - { - "type": "boolean", - }, - { - "type": "object", - }, - { - "items": {}, - "type": "array", - }, - { - "format": "date-time", - "type": "string", - }, - ], - }, - "value_id": { - "description": "The unique identifier for the value of the custom field.", - "example": "value_456", - "type": "string", - }, - }, - "type": "object", - }, - "type": "array", - }, - "date_of_birth": { - "description": "The date when the employee was born", - "example": "1990-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "department": { - "description": "The employee department", - "example": "Physics", - "type": "string", - }, - "department_id": { - "description": "The employee department id", - "example": "3093", - "type": "string", - }, - "display_name": { - "description": "The employee display name", - "example": "Sir Isaac Newton", - "type": "string", - }, - "employee_number": { - "description": "The assigned employee number", - "example": "125", - "type": "string", - }, - "employment": { - "description": "The employee employment", - "properties": { - "contract_type": { - "description": "The employment work schedule type", - "properties": { - "contract_type": { - "description": "The employment work schedule type (e.g., full-time, part-time)", - "example": "full_time", - "properties": { - "value": { - "enum": [ - "full_time", - "shifts", - "part_time", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "label": { - "description": "The label of the employment type", - "example": "Full-Time", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - }, - "type": "object", - }, - "end_date": { - "description": "The end date of employment", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "type": "string", - }, - "grade": { - "description": "Represents the employeeโ€™s position within the organizational hierarchy.", - "properties": { - "description": { - "description": "description of the grade", - "example": "Mid-level employee demonstrating proficiency and autonomy.", - "type": "string", - }, - "id": { - "description": "The reference id", - "example": "1687-3", - "type": "string", - }, - "name": { - "description": "The reference name", - "example": "1687-4", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - }, - "type": "object", - }, - "job_title": { - "description": "The job title of the employee", - "example": "Software Engineer", - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "type": "object", - }, - "pay_currency": { - "description": "The currency used for pay", - "example": "USD", - "type": "string", - }, - "pay_frequency": { - "description": "How often the employee is paid", - "example": "hourly", - "properties": { - "value": { - "enum": [ - "hourly", - "weekly", - "bi_weekly", - "four_weekly", - "semi_monthly", - "monthly", - "bi_monthly", - "quarterly", - "semi_annually", - "yearly", - "thirteen_monthly", - "pro_rata", - "unmapped_value", - "half_yearly", - "daily", - "fixed", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "pay_period": { - "description": "The time period over which the pay rate is calculated", - "example": "monthly", - "properties": { - "value": { - "enum": [ - "hour", - "day", - "week", - "every_two_weeks", - "month", - "quarter", - "every_six_months", - "year", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "pay_rate": { - "description": "The amount of compensation for the employee", - "example": "40.00", - "type": "string", - }, - "payroll_code": { - "description": "The payroll code of the employee", - "example": "PC1", - "type": "string", - }, - "type": { - "description": "The type of employment", - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "label": { - "description": "The label of the employment type", - "example": "Permanent", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "type": { - "description": "The type of employment (e.g., contractor, permanent)", - "example": "permanent", - "properties": { - "value": { - "enum": [ - "contractor", - "intern", - "permanent", - "apprentice", - "freelance", - "terminated", - "temporary", - "seasonal", - "volunteer", - "probation", - "internal", - "external", - "expatriate", - "employer_of_record", - "casual", - "Programme", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - }, - "type": "object", - }, - "unified_custom_fields": { - "additionalProperties": true, - "description": "Custom Unified Fields configured in your StackOne project", - "example": { - "my_project_custom_field_1": "REF-1236", - "my_project_custom_field_2": "some other value", - }, - "type": "object", - }, - "work_time": { - "properties": { - "duration": { - "description": "The work time duration in ISO 8601 duration format", - "example": "P0Y0M0DT8H0M0S", - "format": "duration", - "type": "string", - }, - "period": { - "description": "The period of the work time", - "example": "month", - "properties": { - "value": { - "description": "The unified value for the period.", - "enum": [ - "day", - "week", - "month", - "year", - "unmapped_value", - null, - ], - "example": "month", - "type": "string", - }, - }, - "type": "object", - }, - }, - "type": "object", - }, - }, - "type": "object", - }, - "employment_status": { - "description": "The employee employment status", - "example": "active", - "properties": { - "value": { - "enum": [ - "active", - "pending", - "terminated", - "leave", - "inactive", - "unknown", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "ethnicity": { - "description": "The employee ethnicity", - "example": "white", - "properties": { - "value": { - "enum": [ - "white", - "black_or_african_american", - "asian", - "hispanic_or_latino", - "american_indian_or_alaska_native", - "native_hawaiian_or_pacific_islander", - "two_or_more_races", - "not_disclosed", - "other", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "first_name": { - "description": "The employee first name", - "example": "Isaac", - "type": "string", - }, - "gender": { - "description": "The employee gender", - "example": "male", - "properties": { - "value": { - "enum": [ - "male", - "female", - "non_binary", - "other", - "not_disclosed", - "diverse", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "hire_date": { - "description": "The employee hire date", - "example": "2021-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "home_location": { - "description": "The employee home location", - "properties": { - "city": { - "description": "The city where the location is situated", - "example": "Grantham", - "type": "string", - }, - "country": { - "description": "The country code", - "properties": { - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "name": { - "description": "The name of the location", - "example": "Woolsthorpe Manor", - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "type": "object", - }, - "phone_number": { - "description": "The phone number of the location", - "example": "+44 1476 860 364", - "type": "string", - }, - "state": { - "description": "The ISO3166-2 sub division where the location is situated", - "example": "GB-LIN", - "properties": { - "value": { - "description": "state (ISO3166-2 Sub Division Code) - value must be a valid enum value", - "type": "string", - }, - }, - "type": "object", - }, - "street_1": { - "description": "The first line of the address", - "example": "Water Lane", - "type": "string", - }, - "street_2": { - "description": "The second line of the address", - "example": "Woolsthorpe by Colsterworth", - "type": "string", - }, - "zip_code": { - "description": "The ZIP code/Postal code of the location", - "example": "NG33 5NR", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "job_title": { - "description": "If the source of the job_title is the Employee's current Employment, and that Employment pertains exclusively to this Employee, then the active Employment job_title will also be written", - "example": "Physicist", - "type": "string", - }, - "last_name": { - "description": "The employee last name", - "example": "Newton", - "type": "string", - }, - "manager_id": { - "description": "The employee manager ID", - "example": "67890", - "type": "string", - }, - "marital_status": { - "description": "The employee marital status", - "example": "single", - "properties": { - "value": { - "enum": [ - "single", - "married", - "common_law", - "divorced", - "widowed", - "domestic_partnership", - "separated", - "other", - "not_disclosed", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "name": { - "description": "The employee name", - "example": "Isaac Newton", - "type": "string", - }, - "national_identity_numbers": { - "description": "The national identity numbers", - "items": { - "properties": { - "country": { - "description": "The country code", - "properties": { - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "type": "string", - }, - }, - "type": "object", - }, - "type": { - "properties": { - "value": { - "description": "The type of the national identity number", - "enum": [ - "ssn", - "nin", - "sin", - "nid", - "pin", - "pn", - "umcn", - "pic", - "ric", - "idnum", - "cid", - "nidnr", - "pan", - "aadhaar", - "epic", - "ptn", - "itin", - "tin", - "uprc", - "pcode", - "ssi", - "cedula", - "passport", - "voterid", - "ntin", - "bn", - "fnr", - "mva", - "civil_id", - "cnic", - "nric", - "fin", - "uen", - "registrationnumber", - "nic", - "personnummer", - "ahv", - "id", - "eid", - "va", - "pid", - "nrt", - "nipt", - "cbu", - "cuit", - "dni", - "businessid", - "vnr", - "abn", - "acn", - "tfn", - "jmbg", - "bis", - "insz", - "nn", - "egn", - "pnf", - "vat", - "cnpj", - "unp", - "gst", - "pst", - "qst", - "ni", - "dic", - "rc", - "uid", - "rut", - "uscc", - "cpf", - "cpj", - "cr", - "stnr", - "svnr", - "ncf", - "rnc", - "nif", - "ci", - "ik", - "kmkr", - "registrikood", - "tn", - "ruc", - "nit", - "alv", - "hetu", - "ytunnus", - "vn", - "utr", - "nifp", - "amka", - "cui", - "nir", - "siren", - "siret", - "tva", - "oib", - "hkid", - "anum", - "kennitala", - "vsk", - "npwp", - "pps", - "gstin", - "idnr", - "hr", - "aic", - "codicefiscale", - "iva", - "peid", - "asmens", - "pvm", - "ctps", - "vrn", - "vtk", - "int", - "tk", - "pas", - "rne", - "rg", - "nci", - "crnm", - "pis", - "insee", - "tax", - "mpf", - "epfo", - "esi", - "pran", - "uan", - "idk", - "bsn", - "mid", - "sss", - "nie", - "nss", - "arc", - "curp", - "imss", - "rfc", - "ein", - "other", - "unknown", - "unmapped_value", - null, - ], - "example": "ssn", - "type": "string", - }, - }, - "type": "object", - }, - "value": { - "example": "123456789", - "type": "string", - }, - }, - "type": "object", - }, - "type": "array", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "type": "object", - }, - "personal_email": { - "description": "The employee personal email", - "example": "isaac.newton@example.com", - "type": "string", - }, - "personal_phone_number": { - "description": "The employee personal phone number", - "example": "+1234567890", - "type": "string", - }, - "preferred_language": { - "description": "The employee preferred language", - "example": "eng", - "properties": { - "value": { - "description": "The ISO639-2 Code of the language", - "enum": [ - "aar", - "afr", - "amh", - "ara", - "aym", - "aze", - "bel", - "bul", - "bis", - "ben", - "bos", - "byn", - "cat", - "cha", - "ces", - "dan", - "deu", - "div", - "dzo", - "ell", - "eng", - "spa", - "est", - "fas", - "fan", - "ful", - "fin", - "fij", - "fao", - "fra", - "gle", - "grn", - "guj", - "glv", - "heb", - "hin", - "hrv", - "hat", - "hun", - "hye", - "ind", - "isl", - "ita", - "jpn", - "kat", - "kon", - "kaz", - "kal", - "khm", - "kor", - "kur", - "kir", - "lat", - "ltz", - "lin", - "lao", - "lit", - "lub", - "lav", - "mlg", - "mah", - "mri", - "mkd", - "mon", - "mar", - "msa", - "mlt", - "mya", - "nob", - "nep", - "nld", - "nno", - "nor", - "nbl", - "nya", - "pan", - "pol", - "pus", - "por", - "que", - "rar", - "roh", - "rup", - "ron", - "rus", - "kin", - "sme", - "sag", - "sin", - "slk", - "slv", - "smo", - "sna", - "som", - "sqi", - "srp", - "ssw", - "swe", - "swa", - "tam", - "tel", - "tgk", - "tha", - "tir", - "tig", - "tuk", - "tsn", - "ton", - "tur", - "tso", - "ukr", - "urd", - "uzb", - "ven", - "vie", - "xho", - "zho", - "zul", - "unmapped_value", - null, - ], - "example": "eng", - "type": "string", - }, - }, - "type": "object", - }, - "start_date": { - "description": "The employee start date", - "example": "2021-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "team_id": { - "description": "The employee team id", - "example": "2913", - "type": "string", - }, - "termination_date": { - "description": "The employee termination date", - "example": "2021-01-01T00:00:00Z", - "format": "date-time", - "type": "string", - }, - "title": { - "description": "The prefix of the employee's name (e.g., Mr, Ms, Dr)", - "example": "Mr", - "type": "string", - }, - "work_email": { - "description": "The employee work email", - "example": "newton@example.com", - "type": "string", - }, - "work_location": { - "description": "The employee work location", - "properties": { - "city": { - "description": "The city where the location is situated", - "example": "Grantham", - "type": "string", - }, - "country": { - "description": "The country code", - "properties": { - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "name": { - "description": "The name of the location", - "example": "Woolsthorpe Manor", - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "type": "object", - }, - "phone_number": { - "description": "The phone number of the location", - "example": "+44 1476 860 364", - "type": "string", - }, - "state": { - "description": "The ISO3166-2 sub division where the location is situated", - "example": "GB-LIN", - "properties": { - "value": { - "description": "state (ISO3166-2 Sub Division Code) - value must be a valid enum value", - "type": "string", - }, - }, - "type": "object", - }, - "street_1": { - "description": "The first line of the address", - "example": "Water Lane", - "type": "string", - }, - "street_2": { - "description": "The second line of the address", - "example": "Woolsthorpe by Colsterworth", - "type": "string", - }, - "zip_code": { - "description": "The ZIP code/Postal code of the location", - "example": "NG33 5NR", - "type": "string", - }, - }, - "type": "object", - }, - "work_phone_number": { - "description": "The employee work phone number", - "example": "+1234567890", - "type": "string", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "PATCH", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "body", - "name": "title", - "type": "string", - }, - { - "location": "body", - "name": "first_name", - "type": "string", - }, - { - "location": "body", - "name": "last_name", - "type": "string", - }, - { - "location": "body", - "name": "name", - "type": "string", - }, - { - "location": "body", - "name": "display_name", - "type": "string", - }, - { - "location": "body", - "name": "avatar_url", - "type": "string", - }, - { - "location": "body", - "name": "personal_email", - "type": "string", - }, - { - "location": "body", - "name": "personal_phone_number", - "type": "string", - }, - { - "location": "body", - "name": "work_email", - "type": "string", - }, - { - "location": "body", - "name": "work_phone_number", - "type": "string", - }, - { - "location": "body", - "name": "job_title", - "type": "string", - }, - { - "location": "body", - "name": "department_id", - "type": "string", - }, - { - "location": "body", - "name": "team_id", - "type": "string", - }, - { - "location": "body", - "name": "department", - "type": "string", - }, - { - "location": "body", - "name": "manager_id", - "type": "string", - }, - { - "location": "body", - "name": "gender", - "type": "object", - }, - { - "location": "body", - "name": "preferred_language", - "type": "object", - }, - { - "location": "body", - "name": "ethnicity", - "type": "object", - }, - { - "location": "body", - "name": "date_of_birth", - "type": "string", - }, - { - "location": "body", - "name": "birthday", - "type": "string", - }, - { - "location": "body", - "name": "marital_status", - "type": "object", - }, - { - "location": "body", - "name": "avatar", - "type": "object", - }, - { - "location": "body", - "name": "hire_date", - "type": "string", - }, - { - "location": "body", - "name": "start_date", - "type": "string", - }, - { - "location": "body", - "name": "employment_status", - "type": "object", - }, - { - "location": "body", - "name": "termination_date", - "type": "string", - }, - { - "location": "body", - "name": "company_id", - "type": "string", - }, - { - "location": "body", - "name": "citizenships", - "type": "array", - }, - { - "location": "body", - "name": "employment", - "type": "object", - }, - { - "location": "body", - "name": "custom_fields", - "type": "array", - }, - { - "location": "body", - "name": "benefits", - "type": "array", - }, - { - "location": "body", - "name": "employee_number", - "type": "string", - }, - { - "location": "body", - "name": "national_identity_numbers", - "type": "array", - }, - { - "location": "body", - "name": "home_location", - "type": "object", - }, - { - "location": "body", - "name": "work_location", - "type": "object", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}", - }, - }, - StackOneTool { - "description": "Invite Employee", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "POST", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/invite", - }, - "experimental_preExecute": undefined, - "name": "hris_invite_employee", - "parameters": { - "properties": { - "id": { - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "type": "object", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "POST", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/invite", - }, - }, - StackOneTool { - "description": "List Employee Shifts", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/shifts", - }, - "experimental_preExecute": undefined, - "name": "hris_list_employee_shifts", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields to return in the response (if empty, all fields are returned)", - "type": "string", - }, - "filter": { - "description": "HRIS Employee Shifts filters", - "properties": { - "ends_before": { - "description": "Filter shifts that end before this date", - "example": "2024-01-15T17:00", - "format": "datetime-local", - "type": "string", - }, - "starts_after": { - "description": "Filter shifts that start after this date", - "example": "2024-01-15T09:00", - "format": "datetime-local", - "type": "string", - }, - "status": { - "description": "Filter to select shifts by status", - "enum": [ - "draft", - "published", - "confirmed", - "cancelled", - "unmapped_value", - ], - "type": "string", - }, - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/shifts", - }, - }, - StackOneTool { - "description": "Get Employee Shift", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/shifts/{subResourceId}", - }, - "experimental_preExecute": undefined, - "name": "hris_get_employee_shift", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields to return in the response (if empty, all fields are returned)", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "subResourceId": { - "type": "string", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/shifts/{subResourceId}", - }, - }, - StackOneTool { - "description": "List Employee Time Off Requests", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off", - }, - "experimental_preExecute": undefined, - "name": "hris_list_employee_time_off_requests", - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "policy", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,time_off_policy_id,remote_time_off_policy_id,reason,comment,duration,created_at,updated_at,policy,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "HRIS Time Off filters", - "properties": { - "end_date": { - "additionalProperties": false, - "description": "Filter to include time off requests that end on or before this date.", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "policy_ids": { - "additionalProperties": false, - "description": "List of time off policy ids to filter by.", - "items": { - "type": "string", - }, - "type": "array", - }, - "start_date": { - "additionalProperties": false, - "description": "Filter to include time off requests that start on or after this date.", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off", - }, - }, - StackOneTool { - "description": "Create Employee Time Off Request", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "POST", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "body", - "name": "approver_id", - "type": "string", - }, - { - "location": "body", - "name": "status", - "type": "object", - }, - { - "location": "body", - "name": "start_date", - "type": "string", - }, - { - "location": "body", - "name": "end_date", - "type": "string", - }, - { - "location": "body", - "name": "start_half_day", - "type": "string", - }, - { - "location": "body", - "name": "end_half_day", - "type": "string", - }, - { - "location": "body", - "name": "time_off_policy_id", - "type": "string", - }, - { - "location": "body", - "name": "reason", - "type": "object", - }, - { - "location": "body", - "name": "comment", - "type": "string", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off", - }, - "experimental_preExecute": undefined, - "name": "hris_create_employee_time_off_request", - "parameters": { - "properties": { - "approver_id": { - "description": "The approver ID", - "example": "1687-4", - "type": "string", - }, - "comment": { - "description": "Allows users to provide additional context or notes for their time off request", - "example": "Taking a day off for personal reasons", - "type": "string", - }, - "end_date": { - "description": "Inclusive end date of the time off request (ISO8601 date-time without timezone). The time off includes this day", - "example": "2021-01-01T01:01:01.000", - "format": "datetime-local", - "type": "string", - }, - "end_half_day": { - "description": "True if the end of the time off request ends half way through the day", - "example": true, - "oneOf": [ - { - "type": "boolean", - }, - { - "enum": [ - "true", - "false", - ], - "type": "string", - }, - ], - }, - "id": { - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "type": "object", - }, - "reason": { - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "name": { - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - }, - "type": "object", - }, - "start_date": { - "description": "The start date of the time off request (ISO8601 date-time without timezone)", - "example": "2021-01-01T01:01:01.000", - "format": "datetime-local", - "type": "string", - }, - "start_half_day": { - "description": "True if the start of the time off request begins half way through the day", - "example": true, - "oneOf": [ - { - "type": "boolean", - }, - { - "enum": [ - "true", - "false", - ], - "type": "string", - }, - ], - }, - "status": { - "description": "The status of the time off request", - "properties": { - "value": { - "enum": [ - "approved", - "cancelled", - "rejected", - "pending", - "deleted", - "draft", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "time_off_policy_id": { - "description": "The time off policy id associated with this time off request", - "example": "cx280928933", - "type": "string", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "POST", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "body", - "name": "approver_id", - "type": "string", - }, - { - "location": "body", - "name": "status", - "type": "object", - }, - { - "location": "body", - "name": "start_date", - "type": "string", - }, - { - "location": "body", - "name": "end_date", - "type": "string", - }, - { - "location": "body", - "name": "start_half_day", - "type": "string", - }, - { - "location": "body", - "name": "end_half_day", - "type": "string", - }, - { - "location": "body", - "name": "time_off_policy_id", - "type": "string", - }, - { - "location": "body", - "name": "reason", - "type": "object", - }, - { - "location": "body", - "name": "comment", - "type": "string", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off", - }, - }, - StackOneTool { - "description": "Get Employees Time Off Request", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off/{subResourceId}", - }, - "experimental_preExecute": undefined, - "name": "hris_get_employees_time_off_request", - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "policy", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,time_off_policy_id,remote_time_off_policy_id,reason,comment,duration,created_at,updated_at,policy,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "subResourceId": { - "type": "string", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off/{subResourceId}", - }, - }, - StackOneTool { - "description": "Cancel Employee Time Off Request", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "DELETE", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off/{subResourceId}", - }, - "experimental_preExecute": undefined, - "name": "hris_cancel_employee_time_off_request", - "parameters": { - "properties": { - "id": { - "type": "string", - }, - "subResourceId": { - "type": "string", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "DELETE", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off/{subResourceId}", - }, - }, - StackOneTool { - "description": "Update Employee Time Off Request", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "PATCH", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "body", - "name": "approver_id", - "type": "string", - }, - { - "location": "body", - "name": "status", - "type": "object", - }, - { - "location": "body", - "name": "start_date", - "type": "string", - }, - { - "location": "body", - "name": "end_date", - "type": "string", - }, - { - "location": "body", - "name": "start_half_day", - "type": "string", - }, - { - "location": "body", - "name": "end_half_day", - "type": "string", - }, - { - "location": "body", - "name": "time_off_policy_id", - "type": "string", - }, - { - "location": "body", - "name": "reason", - "type": "object", - }, - { - "location": "body", - "name": "comment", - "type": "string", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off/{subResourceId}", - }, - "experimental_preExecute": undefined, - "name": "hris_update_employee_time_off_request", - "parameters": { - "properties": { - "approver_id": { - "description": "The approver ID", - "example": "1687-4", - "type": "string", - }, - "comment": { - "description": "Allows users to provide additional context or notes for their time off request", - "example": "Taking a day off for personal reasons", - "type": "string", - }, - "end_date": { - "description": "Inclusive end date of the time off request (ISO8601 date-time without timezone). The time off includes this day", - "example": "2021-01-01T01:01:01.000", - "format": "datetime-local", - "type": "string", - }, - "end_half_day": { - "description": "True if the end of the time off request ends half way through the day", - "example": true, - "oneOf": [ - { - "type": "boolean", - }, - { - "enum": [ - "true", - "false", - ], - "type": "string", - }, - ], - }, - "id": { - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "type": "object", - }, - "reason": { - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "name": { - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - }, - "type": "object", - }, - "start_date": { - "description": "The start date of the time off request (ISO8601 date-time without timezone)", - "example": "2021-01-01T01:01:01.000", - "format": "datetime-local", - "type": "string", - }, - "start_half_day": { - "description": "True if the start of the time off request begins half way through the day", - "example": true, - "oneOf": [ - { - "type": "boolean", - }, - { - "enum": [ - "true", - "false", - ], - "type": "string", - }, - ], - }, - "status": { - "description": "The status of the time off request", - "properties": { - "value": { - "enum": [ - "approved", - "cancelled", - "rejected", - "pending", - "deleted", - "draft", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "subResourceId": { - "type": "string", - }, - "time_off_policy_id": { - "description": "The time off policy id associated with this time off request", - "example": "cx280928933", - "type": "string", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "PATCH", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "body", - "name": "approver_id", - "type": "string", - }, - { - "location": "body", - "name": "status", - "type": "object", - }, - { - "location": "body", - "name": "start_date", - "type": "string", - }, - { - "location": "body", - "name": "end_date", - "type": "string", - }, - { - "location": "body", - "name": "start_half_day", - "type": "string", - }, - { - "location": "body", - "name": "end_half_day", - "type": "string", - }, - { - "location": "body", - "name": "time_off_policy_id", - "type": "string", - }, - { - "location": "body", - "name": "reason", - "type": "object", - }, - { - "location": "body", - "name": "comment", - "type": "string", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off/{subResourceId}", - }, - }, - StackOneTool { - "description": "Batch Upload Employee Document", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "POST", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "body", - "name": "items", - "type": "array", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/documents/upload/batch", - }, - "experimental_preExecute": undefined, - "name": "hris_batch_upload_employee_document", - "parameters": { - "properties": { - "id": { - "type": "string", - }, - "items": { - "description": "The batch of items to create", - "items": { - "properties": { - "category": { - "description": "The category to be associated with the file to be uploaded. Id will take precedence over name.", - "example": { - "id": "550e8400-e29b-41d4-a716-446655440000", - "name": "reports", - }, - "properties": { - "value": { - "description": "The category name to associate with the file", - "enum": [ - "application", - "academic", - "contract", - "certificates", - "visa", - "passport", - "driver_license", - "payslip", - "payroll", - "appraisal", - "resume", - "policy", - "cover_letter", - "offer_letter", - "policy_agreement", - "home_address", - "national_id", - "confidential", - "signed", - "shared", - "other", - "benefit", - "id_verification", - "background_check", - "unmapped_value", - null, - ], - "example": "reports", - "type": "string", - }, - }, - "type": "object", - }, - "category_id": { - "description": "The categoryId of the documents", - "example": "6530", - "type": "string", - }, - "confidential": { - "description": "The confidentiality level of the file to be uploaded", - "properties": { - "value": { - "description": "Whether the file is confidential or not", - "enum": [ - "true", - "false", - "unmapped_value", - null, - ], - "example": "true", - "type": "string", - }, - }, - "type": "object", - }, - "content": { - "description": "The base64 encoded content of the file to upload", - "example": "VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE", - "type": "string", - }, - "file_format": { - "description": "The file format of the file", - "properties": { - "value": { - "description": "The file format of the file, expressed as a file extension", - "enum": [ - "unmapped_value", - "ez", - "aw", - "atom", - "atomcat", - "atomdeleted", - "atomsvc", - "dwd", - "held", - "rsat", - "bdoc", - "xcs", - "ccxml", - "cdfx", - "cdmia", - "cdmic", - "cdmid", - "cdmio", - "cdmiq", - "cu", - "mpd", - "davmount", - "dbk", - "dssc", - "xdssc", - "es", - "ecma", - "emma", - "emotionml", - "epub", - "exi", - "exp", - "fdt", - "pfr", - "geojson", - "gml", - "gpx", - "gxf", - "gz", - "hjson", - "stk", - "ink", - "inkml", - "ipfix", - "its", - "jar", - "war", - "ear", - "ser", - "class", - "js", - "mjs", - "json", - "map", - "json5", - "jsonml", - "jsonld", - "lgr", - "lostxml", - "hqx", - "cpt", - "mads", - "webmanifest", - "mrc", - "mrcx", - "ma", - "nb", - "mb", - "mathml", - "mbox", - "mscml", - "metalink", - "meta4", - "mets", - "maei", - "musd", - "mods", - "m21", - "mp21", - "mp4s", - "m4p", - "doc", - "dot", - "mxf", - "nq", - "nt", - "cjs", - "bin", - "dms", - "lrf", - "mar", - "so", - "dist", - "distz", - "pkg", - "bpk", - "dump", - "elc", - "deploy", - "exe", - "dll", - "deb", - "dmg", - "iso", - "img", - "msi", - "msp", - "msm", - "buffer", - "oda", - "opf", - "ogx", - "omdoc", - "onetoc", - "onetoc2", - "onetmp", - "onepkg", - "oxps", - "relo", - "xer", - "pdf", - "pgp", - "asc", - "sig", - "prf", - "p10", - "p7m", - "p7c", - "p7s", - "p8", - "ac", - "cer", - "crl", - "pkipath", - "pki", - "pls", - "ai", - "eps", - "ps", - "provx", - "pskcxml", - "raml", - "rdf", - "owl", - "rif", - "rnc", - "rl", - "rld", - "rs", - "rapd", - "sls", - "rusd", - "gbr", - "mft", - "roa", - "rsd", - "rss", - "rtf", - "sbml", - "scq", - "scs", - "spq", - "spp", - "sdp", - "senmlx", - "sensmlx", - "setpay", - "setreg", - "shf", - "siv", - "sieve", - "smi", - "smil", - "rq", - "srx", - "gram", - "grxml", - "sru", - "ssdl", - "ssml", - "swidtag", - "tei", - "teicorpus", - "tfi", - "tsd", - "toml", - "trig", - "ttml", - "ubj", - "rsheet", - "td", - "vxml", - "wasm", - "wgt", - "hlp", - "wsdl", - "wspolicy", - "xaml", - "xav", - "xca", - "xdf", - "xel", - "xns", - "xenc", - "xhtml", - "xht", - "xlf", - "xml", - "xsl", - "xsd", - "rng", - "dtd", - "xop", - "xpl", - "*xsl", - "xslt", - "xspf", - "mxml", - "xhvml", - "xvml", - "xvm", - "yang", - "yin", - "zip", - "*3gpp", - "adp", - "amr", - "au", - "snd", - "mid", - "midi", - "kar", - "rmi", - "mxmf", - "*mp3", - "m4a", - "mp4a", - "mpga", - "mp2", - "mp2a", - "mp3", - "m2a", - "m3a", - "oga", - "ogg", - "spx", - "opus", - "s3m", - "sil", - "wav", - "*wav", - "weba", - "xm", - "ttc", - "otf", - "ttf", - "woff", - "woff2", - "exr", - "apng", - "avif", - "bmp", - "cgm", - "drle", - "emf", - "fits", - "g3", - "gif", - "heic", - "heics", - "heif", - "heifs", - "hej2", - "hsj2", - "ief", - "jls", - "jp2", - "jpg2", - "jpeg", - "jpg", - "jpe", - "jph", - "jhc", - "jpm", - "jpx", - "jpf", - "jxr", - "jxra", - "jxrs", - "jxs", - "jxsc", - "jxsi", - "jxss", - "ktx", - "ktx2", - "png", - "sgi", - "svg", - "svgz", - "t38", - "tif", - "tiff", - "tfx", - "webp", - "wmf", - "disposition-notification", - "u8msg", - "u8dsn", - "u8mdn", - "u8hdr", - "eml", - "mime", - "3mf", - "gltf", - "glb", - "igs", - "iges", - "msh", - "mesh", - "silo", - "mtl", - "obj", - "stpx", - "stpz", - "stpxz", - "stl", - "wrl", - "vrml", - "*x3db", - "x3dbz", - "x3db", - "*x3dv", - "x3dvz", - "x3d", - "x3dz", - "x3dv", - "appcache", - "manifest", - "ics", - "ifb", - "coffee", - "litcoffee", - "css", - "csv", - "html", - "htm", - "shtml", - "jade", - "jsx", - "less", - "markdown", - "md", - "mml", - "mdx", - "n3", - "txt", - "text", - "conf", - "def", - "list", - "log", - "in", - "ini", - "rtx", - "*rtf", - "sgml", - "sgm", - "shex", - "slim", - "slm", - "spdx", - "stylus", - "styl", - "tsv", - "t", - "tr", - "roff", - "man", - "me", - "ms", - "ttl", - "uri", - "uris", - "urls", - "vcard", - "vtt", - "*xml", - "yaml", - "yml", - "3gp", - "3gpp", - "3g2", - "h261", - "h263", - "h264", - "m4s", - "jpgv", - "*jpm", - "jpgm", - "mj2", - "mjp2", - "ts", - "mp4", - "mp4v", - "mpg4", - "mpeg", - "mpg", - "mpe", - "m1v", - "m2v", - "ogv", - "qt", - "mov", - "webm", - "cww", - "1km", - "plb", - "psb", - "pvb", - "tcap", - "pwn", - "aso", - "imp", - "acu", - "atc", - "acutc", - "air", - "fcdt", - "fxp", - "fxpl", - "xdp", - "xfdf", - "ahead", - "azf", - "azs", - "azw", - "acc", - "ami", - "apk", - "cii", - "fti", - "atx", - "mpkg", - "key", - "m3u8", - "numbers", - "pages", - "pkpass", - "swi", - "iota", - "aep", - "bmml", - "mpm", - "bmi", - "rep", - "cdxml", - "mmd", - "cdy", - "csl", - "cla", - "rp9", - "c4g", - "c4d", - "c4f", - "c4p", - "c4u", - "c11amc", - "c11amz", - "csp", - "cdbcmsg", - "cmc", - "clkx", - "clkk", - "clkp", - "clkt", - "clkw", - "wbs", - "pml", - "ppd", - "car", - "pcurl", - "dart", - "rdz", - "dbf", - "uvf", - "uvvf", - "uvd", - "uvvd", - "uvt", - "uvvt", - "uvx", - "uvvx", - "uvz", - "uvvz", - "fe_launch", - "dna", - "mlp", - "mle", - "dpg", - "dfac", - "kpxx", - "ait", - "svc", - "geo", - "mag", - "nml", - "esf", - "msf", - "qam", - "slt", - "ssf", - "es3", - "et3", - "ez2", - "ez3", - "fdf", - "mseed", - "seed", - "dataless", - "gph", - "ftc", - "fm", - "frame", - "maker", - "book", - "fnc", - "ltf", - "fsc", - "oas", - "oa2", - "oa3", - "fg5", - "bh2", - "ddd", - "xdw", - "xbd", - "fzs", - "txd", - "ggb", - "ggt", - "gex", - "gre", - "gxt", - "g2w", - "g3w", - "gmx", - "gdoc", - "gslides", - "gsheet", - "kml", - "kmz", - "gqf", - "gqs", - "gac", - "ghf", - "gim", - "grv", - "gtm", - "tpl", - "vcg", - "hal", - "zmm", - "hbci", - "les", - "hpgl", - "hpid", - "hps", - "jlt", - "pcl", - "pclxl", - "sfd-hdstx", - "mpy", - "afp", - "listafp", - "list3820", - "irm", - "sc", - "icc", - "icm", - "igl", - "ivp", - "ivu", - "igm", - "xpw", - "xpx", - "i2g", - "qbo", - "qfx", - "rcprofile", - "irp", - "xpr", - "fcs", - "jam", - "rms", - "jisp", - "joda", - "ktz", - "ktr", - "karbon", - "chrt", - "kfo", - "flw", - "kon", - "kpr", - "kpt", - "ksp", - "kwd", - "kwt", - "htke", - "kia", - "kne", - "knp", - "skp", - "skd", - "skt", - "skm", - "sse", - "lasxml", - "lbd", - "lbe", - "apr", - "pre", - "nsf", - "org", - "scm", - "lwp", - "portpkg", - "mvt", - "mcd", - "mc1", - "cdkey", - "mwf", - "mfm", - "flo", - "igx", - "mif", - "daf", - "dis", - "mbk", - "mqy", - "msl", - "plc", - "txf", - "mpn", - "mpc", - "xul", - "cil", - "cab", - "xls", - "xlm", - "xla", - "xlc", - "xlt", - "xlw", - "xlam", - "xlsb", - "xlsm", - "xltm", - "eot", - "chm", - "ims", - "lrm", - "thmx", - "msg", - "cat", - "*stl", - "ppt", - "pps", - "pot", - "ppam", - "pptm", - "sldm", - "ppsm", - "potm", - "mpp", - "mpt", - "docm", - "dotm", - "wps", - "wks", - "wcm", - "wdb", - "wpl", - "xps", - "mseq", - "mus", - "msty", - "taglet", - "nlu", - "ntf", - "nitf", - "nnd", - "nns", - "nnw", - "*ac", - "ngdat", - "n-gage", - "rpst", - "rpss", - "edm", - "edx", - "ext", - "odc", - "otc", - "odb", - "odf", - "odft", - "odg", - "otg", - "odi", - "oti", - "odp", - "otp", - "ods", - "ots", - "odt", - "odm", - "ott", - "oth", - "xo", - "dd2", - "obgx", - "oxt", - "osm", - "pptx", - "sldx", - "ppsx", - "potx", - "xlsx", - "xltx", - "docx", - "dotx", - "mgp", - "dp", - "esa", - "pdb", - "pqa", - "oprc", - "paw", - "str", - "ei6", - "efif", - "wg", - "plf", - "pbd", - "box", - "mgz", - "qps", - "ptid", - "qxd", - "qxt", - "qwd", - "qwt", - "qxl", - "qxb", - "rar", - "bed", - "mxl", - "musicxml", - "cryptonote", - "cod", - "rm", - "rmvb", - "link66", - "st", - "see", - "sema", - "semd", - "semf", - "ifm", - "itp", - "iif", - "ipk", - "twd", - "twds", - "mmf", - "teacher", - "fo", - "sdkm", - "sdkd", - "dxp", - "sfs", - "sdc", - "sda", - "sdd", - "smf", - "sdw", - "vor", - "sgl", - "smzip", - "sm", - "wadl", - "sxc", - "stc", - "sxd", - "std", - "sxi", - "sti", - "sxm", - "sxw", - "sxg", - "stw", - "sus", - "susp", - "svd", - "sis", - "sisx", - "xsm", - "bdm", - "xdm", - "ddf", - "tao", - "pcap", - "cap", - "dmp", - "tmo", - "tpt", - "mxs", - "tra", - "ufd", - "ufdl", - "utz", - "umj", - "unityweb", - "uoml", - "vcx", - "vsd", - "vst", - "vss", - "vsw", - "vis", - "vsf", - "wbxml", - "wmlc", - "wmlsc", - "wtb", - "nbp", - "wpd", - "wqd", - "stf", - "xar", - "xfdl", - "hvd", - "hvs", - "hvp", - "osf", - "osfpvg", - "saf", - "spf", - "cmp", - "zir", - "zirz", - "zaz", - "7z", - "abw", - "ace", - "*dmg", - "arj", - "aab", - "x32", - "u32", - "vox", - "aam", - "aas", - "bcpio", - "*bdoc", - "torrent", - "blb", - "blorb", - "bz", - "bz2", - "boz", - "cbr", - "cba", - "cbt", - "cbz", - "cb7", - "vcd", - "cfs", - "chat", - "pgn", - "crx", - "cco", - "nsc", - "cpio", - "csh", - "*deb", - "udeb", - "dgc", - "dir", - "dcr", - "dxr", - "cst", - "cct", - "cxt", - "w3d", - "fgd", - "swa", - "wad", - "ncx", - "dtb", - "res", - "dvi", - "evy", - "eva", - "bdf", - "gsf", - "psf", - "pcf", - "snf", - "pfa", - "pfb", - "pfm", - "afm", - "arc", - "spl", - "gca", - "ulx", - "gnumeric", - "gramps", - "gtar", - "hdf", - "php", - "install", - "*iso", - "*key", - "*numbers", - "*pages", - "jardiff", - "jnlp", - "kdbx", - "latex", - "luac", - "lzh", - "lha", - "run", - "mie", - "prc", - "mobi", - "application", - "lnk", - "wmd", - "wmz", - "xbap", - "mdb", - "obd", - "crd", - "clp", - "*exe", - "*dll", - "com", - "bat", - "*msi", - "mvb", - "m13", - "m14", - "*wmf", - "*wmz", - "*emf", - "emz", - "mny", - "pub", - "scd", - "trm", - "wri", - "nc", - "cdf", - "pac", - "nzb", - "pl", - "pm", - "*prc", - "*pdb", - "p12", - "pfx", - "p7b", - "spc", - "p7r", - "*rar", - "rpm", - "ris", - "sea", - "sh", - "shar", - "swf", - "xap", - "sql", - "sit", - "sitx", - "srt", - "sv4cpio", - "sv4crc", - "t3", - "gam", - "tar", - "tcl", - "tk", - "tex", - "tfm", - "texinfo", - "texi", - "*obj", - "ustar", - "hdd", - "ova", - "ovf", - "vbox", - "vbox-extpack", - "vdi", - "vhd", - "vmdk", - "src", - "webapp", - "der", - "crt", - "pem", - "fig", - "*xlf", - "xpi", - "xz", - "z1", - "z2", - "z3", - "z4", - "z5", - "z6", - "z7", - "z8", - "uva", - "uvva", - "eol", - "dra", - "dts", - "dtshd", - "lvp", - "pya", - "ecelp4800", - "ecelp7470", - "ecelp9600", - "rip", - "aac", - "aif", - "aiff", - "aifc", - "caf", - "flac", - "*m4a", - "mka", - "m3u", - "wax", - "wma", - "ram", - "ra", - "rmp", - "*ra", - "cdx", - "cif", - "cmdf", - "cml", - "csml", - "xyz", - "btif", - "pti", - "psd", - "azv", - "uvi", - "uvvi", - "uvg", - "uvvg", - "djvu", - "djv", - "*sub", - "dwg", - "dxf", - "fbs", - "fpx", - "fst", - "mmr", - "rlc", - "ico", - "dds", - "mdi", - "wdp", - "npx", - "b16", - "tap", - "vtf", - "wbmp", - "xif", - "pcx", - "3ds", - "ras", - "cmx", - "fh", - "fhc", - "fh4", - "fh5", - "fh7", - "*ico", - "jng", - "sid", - "*bmp", - "*pcx", - "pic", - "pct", - "pnm", - "pbm", - "pgm", - "ppm", - "rgb", - "tga", - "xbm", - "xpm", - "xwd", - "wsc", - "dae", - "dwf", - "gdl", - "gtw", - "mts", - "ogex", - "x_b", - "x_t", - "vds", - "usdz", - "bsp", - "vtu", - "dsc", - "curl", - "dcurl", - "mcurl", - "scurl", - "sub", - "fly", - "flx", - "gv", - "3dml", - "spot", - "jad", - "wml", - "wmls", - "s", - "asm", - "c", - "cc", - "cxx", - "cpp", - "h", - "hh", - "dic", - "htc", - "f", - "for", - "f77", - "f90", - "hbs", - "java", - "lua", - "mkd", - "nfo", - "opml", - "*org", - "p", - "pas", - "pde", - "sass", - "scss", - "etx", - "sfv", - "ymp", - "uu", - "vcs", - "vcf", - "uvh", - "uvvh", - "uvm", - "uvvm", - "uvp", - "uvvp", - "uvs", - "uvvs", - "uvv", - "uvvv", - "dvb", - "fvt", - "mxu", - "m4u", - "pyv", - "uvu", - "uvvu", - "viv", - "f4v", - "fli", - "flv", - "m4v", - "mkv", - "mk3d", - "mks", - "mng", - "asf", - "asx", - "vob", - "wm", - "wmv", - "wmx", - "wvx", - "avi", - "movie", - "smv", - "ice", - "mht", - null, - ], - "example": "pdf", - "type": "string", - }, - }, - "type": "object", - }, - "name": { - "description": "The filename of the file to upload", - "example": "weather-forecast", - "type": "string", - }, - "path": { - "description": "The path for the file to be uploaded to", - "example": "/path/to/file", - "type": "string", - }, - }, - "type": "object", - }, - "type": "array", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - "items", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "POST", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "body", - "name": "items", - "type": "array", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/documents/upload/batch", - }, - }, - StackOneTool { - "description": "Upload Employee Document", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "POST", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "body", - "name": "name", - "type": "string", - }, - { - "location": "body", - "name": "file_format", - "type": "object", - }, - { - "location": "body", - "name": "content", - "type": "string", - }, - { - "location": "body", - "name": "category_id", - "type": "string", - }, - { - "location": "body", - "name": "path", - "type": "string", - }, - { - "location": "body", - "name": "confidential", - "type": "object", - }, - { - "location": "body", - "name": "category", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/documents/upload", - }, - "experimental_preExecute": undefined, - "name": "hris_upload_employee_document", - "parameters": { - "properties": { - "category": { - "description": "The category to be associated with the file to be uploaded. Id will take precedence over name.", - "example": { - "id": "550e8400-e29b-41d4-a716-446655440000", - "name": "reports", - }, - "properties": { - "value": { - "description": "The category name to associate with the file", - "enum": [ - "application", - "academic", - "contract", - "certificates", - "visa", - "passport", - "driver_license", - "payslip", - "payroll", - "appraisal", - "resume", - "policy", - "cover_letter", - "offer_letter", - "policy_agreement", - "home_address", - "national_id", - "confidential", - "signed", - "shared", - "other", - "benefit", - "id_verification", - "background_check", - "unmapped_value", - null, - ], - "example": "reports", - "type": "string", - }, - }, - "type": "object", - }, - "category_id": { - "description": "The categoryId of the documents", - "example": "6530", - "type": "string", - }, - "confidential": { - "description": "The confidentiality level of the file to be uploaded", - "properties": { - "value": { - "description": "Whether the file is confidential or not", - "enum": [ - "true", - "false", - "unmapped_value", - null, - ], - "example": "true", - "type": "string", - }, - }, - "type": "object", - }, - "content": { - "description": "The base64 encoded content of the file to upload", - "example": "VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE", - "type": "string", - }, - "file_format": { - "description": "The file format of the file", - "properties": { - "value": { - "description": "The file format of the file, expressed as a file extension", - "enum": [ - "unmapped_value", - "ez", - "aw", - "atom", - "atomcat", - "atomdeleted", - "atomsvc", - "dwd", - "held", - "rsat", - "bdoc", - "xcs", - "ccxml", - "cdfx", - "cdmia", - "cdmic", - "cdmid", - "cdmio", - "cdmiq", - "cu", - "mpd", - "davmount", - "dbk", - "dssc", - "xdssc", - "es", - "ecma", - "emma", - "emotionml", - "epub", - "exi", - "exp", - "fdt", - "pfr", - "geojson", - "gml", - "gpx", - "gxf", - "gz", - "hjson", - "stk", - "ink", - "inkml", - "ipfix", - "its", - "jar", - "war", - "ear", - "ser", - "class", - "js", - "mjs", - "json", - "map", - "json5", - "jsonml", - "jsonld", - "lgr", - "lostxml", - "hqx", - "cpt", - "mads", - "webmanifest", - "mrc", - "mrcx", - "ma", - "nb", - "mb", - "mathml", - "mbox", - "mscml", - "metalink", - "meta4", - "mets", - "maei", - "musd", - "mods", - "m21", - "mp21", - "mp4s", - "m4p", - "doc", - "dot", - "mxf", - "nq", - "nt", - "cjs", - "bin", - "dms", - "lrf", - "mar", - "so", - "dist", - "distz", - "pkg", - "bpk", - "dump", - "elc", - "deploy", - "exe", - "dll", - "deb", - "dmg", - "iso", - "img", - "msi", - "msp", - "msm", - "buffer", - "oda", - "opf", - "ogx", - "omdoc", - "onetoc", - "onetoc2", - "onetmp", - "onepkg", - "oxps", - "relo", - "xer", - "pdf", - "pgp", - "asc", - "sig", - "prf", - "p10", - "p7m", - "p7c", - "p7s", - "p8", - "ac", - "cer", - "crl", - "pkipath", - "pki", - "pls", - "ai", - "eps", - "ps", - "provx", - "pskcxml", - "raml", - "rdf", - "owl", - "rif", - "rnc", - "rl", - "rld", - "rs", - "rapd", - "sls", - "rusd", - "gbr", - "mft", - "roa", - "rsd", - "rss", - "rtf", - "sbml", - "scq", - "scs", - "spq", - "spp", - "sdp", - "senmlx", - "sensmlx", - "setpay", - "setreg", - "shf", - "siv", - "sieve", - "smi", - "smil", - "rq", - "srx", - "gram", - "grxml", - "sru", - "ssdl", - "ssml", - "swidtag", - "tei", - "teicorpus", - "tfi", - "tsd", - "toml", - "trig", - "ttml", - "ubj", - "rsheet", - "td", - "vxml", - "wasm", - "wgt", - "hlp", - "wsdl", - "wspolicy", - "xaml", - "xav", - "xca", - "xdf", - "xel", - "xns", - "xenc", - "xhtml", - "xht", - "xlf", - "xml", - "xsl", - "xsd", - "rng", - "dtd", - "xop", - "xpl", - "*xsl", - "xslt", - "xspf", - "mxml", - "xhvml", - "xvml", - "xvm", - "yang", - "yin", - "zip", - "*3gpp", - "adp", - "amr", - "au", - "snd", - "mid", - "midi", - "kar", - "rmi", - "mxmf", - "*mp3", - "m4a", - "mp4a", - "mpga", - "mp2", - "mp2a", - "mp3", - "m2a", - "m3a", - "oga", - "ogg", - "spx", - "opus", - "s3m", - "sil", - "wav", - "*wav", - "weba", - "xm", - "ttc", - "otf", - "ttf", - "woff", - "woff2", - "exr", - "apng", - "avif", - "bmp", - "cgm", - "drle", - "emf", - "fits", - "g3", - "gif", - "heic", - "heics", - "heif", - "heifs", - "hej2", - "hsj2", - "ief", - "jls", - "jp2", - "jpg2", - "jpeg", - "jpg", - "jpe", - "jph", - "jhc", - "jpm", - "jpx", - "jpf", - "jxr", - "jxra", - "jxrs", - "jxs", - "jxsc", - "jxsi", - "jxss", - "ktx", - "ktx2", - "png", - "sgi", - "svg", - "svgz", - "t38", - "tif", - "tiff", - "tfx", - "webp", - "wmf", - "disposition-notification", - "u8msg", - "u8dsn", - "u8mdn", - "u8hdr", - "eml", - "mime", - "3mf", - "gltf", - "glb", - "igs", - "iges", - "msh", - "mesh", - "silo", - "mtl", - "obj", - "stpx", - "stpz", - "stpxz", - "stl", - "wrl", - "vrml", - "*x3db", - "x3dbz", - "x3db", - "*x3dv", - "x3dvz", - "x3d", - "x3dz", - "x3dv", - "appcache", - "manifest", - "ics", - "ifb", - "coffee", - "litcoffee", - "css", - "csv", - "html", - "htm", - "shtml", - "jade", - "jsx", - "less", - "markdown", - "md", - "mml", - "mdx", - "n3", - "txt", - "text", - "conf", - "def", - "list", - "log", - "in", - "ini", - "rtx", - "*rtf", - "sgml", - "sgm", - "shex", - "slim", - "slm", - "spdx", - "stylus", - "styl", - "tsv", - "t", - "tr", - "roff", - "man", - "me", - "ms", - "ttl", - "uri", - "uris", - "urls", - "vcard", - "vtt", - "*xml", - "yaml", - "yml", - "3gp", - "3gpp", - "3g2", - "h261", - "h263", - "h264", - "m4s", - "jpgv", - "*jpm", - "jpgm", - "mj2", - "mjp2", - "ts", - "mp4", - "mp4v", - "mpg4", - "mpeg", - "mpg", - "mpe", - "m1v", - "m2v", - "ogv", - "qt", - "mov", - "webm", - "cww", - "1km", - "plb", - "psb", - "pvb", - "tcap", - "pwn", - "aso", - "imp", - "acu", - "atc", - "acutc", - "air", - "fcdt", - "fxp", - "fxpl", - "xdp", - "xfdf", - "ahead", - "azf", - "azs", - "azw", - "acc", - "ami", - "apk", - "cii", - "fti", - "atx", - "mpkg", - "key", - "m3u8", - "numbers", - "pages", - "pkpass", - "swi", - "iota", - "aep", - "bmml", - "mpm", - "bmi", - "rep", - "cdxml", - "mmd", - "cdy", - "csl", - "cla", - "rp9", - "c4g", - "c4d", - "c4f", - "c4p", - "c4u", - "c11amc", - "c11amz", - "csp", - "cdbcmsg", - "cmc", - "clkx", - "clkk", - "clkp", - "clkt", - "clkw", - "wbs", - "pml", - "ppd", - "car", - "pcurl", - "dart", - "rdz", - "dbf", - "uvf", - "uvvf", - "uvd", - "uvvd", - "uvt", - "uvvt", - "uvx", - "uvvx", - "uvz", - "uvvz", - "fe_launch", - "dna", - "mlp", - "mle", - "dpg", - "dfac", - "kpxx", - "ait", - "svc", - "geo", - "mag", - "nml", - "esf", - "msf", - "qam", - "slt", - "ssf", - "es3", - "et3", - "ez2", - "ez3", - "fdf", - "mseed", - "seed", - "dataless", - "gph", - "ftc", - "fm", - "frame", - "maker", - "book", - "fnc", - "ltf", - "fsc", - "oas", - "oa2", - "oa3", - "fg5", - "bh2", - "ddd", - "xdw", - "xbd", - "fzs", - "txd", - "ggb", - "ggt", - "gex", - "gre", - "gxt", - "g2w", - "g3w", - "gmx", - "gdoc", - "gslides", - "gsheet", - "kml", - "kmz", - "gqf", - "gqs", - "gac", - "ghf", - "gim", - "grv", - "gtm", - "tpl", - "vcg", - "hal", - "zmm", - "hbci", - "les", - "hpgl", - "hpid", - "hps", - "jlt", - "pcl", - "pclxl", - "sfd-hdstx", - "mpy", - "afp", - "listafp", - "list3820", - "irm", - "sc", - "icc", - "icm", - "igl", - "ivp", - "ivu", - "igm", - "xpw", - "xpx", - "i2g", - "qbo", - "qfx", - "rcprofile", - "irp", - "xpr", - "fcs", - "jam", - "rms", - "jisp", - "joda", - "ktz", - "ktr", - "karbon", - "chrt", - "kfo", - "flw", - "kon", - "kpr", - "kpt", - "ksp", - "kwd", - "kwt", - "htke", - "kia", - "kne", - "knp", - "skp", - "skd", - "skt", - "skm", - "sse", - "lasxml", - "lbd", - "lbe", - "apr", - "pre", - "nsf", - "org", - "scm", - "lwp", - "portpkg", - "mvt", - "mcd", - "mc1", - "cdkey", - "mwf", - "mfm", - "flo", - "igx", - "mif", - "daf", - "dis", - "mbk", - "mqy", - "msl", - "plc", - "txf", - "mpn", - "mpc", - "xul", - "cil", - "cab", - "xls", - "xlm", - "xla", - "xlc", - "xlt", - "xlw", - "xlam", - "xlsb", - "xlsm", - "xltm", - "eot", - "chm", - "ims", - "lrm", - "thmx", - "msg", - "cat", - "*stl", - "ppt", - "pps", - "pot", - "ppam", - "pptm", - "sldm", - "ppsm", - "potm", - "mpp", - "mpt", - "docm", - "dotm", - "wps", - "wks", - "wcm", - "wdb", - "wpl", - "xps", - "mseq", - "mus", - "msty", - "taglet", - "nlu", - "ntf", - "nitf", - "nnd", - "nns", - "nnw", - "*ac", - "ngdat", - "n-gage", - "rpst", - "rpss", - "edm", - "edx", - "ext", - "odc", - "otc", - "odb", - "odf", - "odft", - "odg", - "otg", - "odi", - "oti", - "odp", - "otp", - "ods", - "ots", - "odt", - "odm", - "ott", - "oth", - "xo", - "dd2", - "obgx", - "oxt", - "osm", - "pptx", - "sldx", - "ppsx", - "potx", - "xlsx", - "xltx", - "docx", - "dotx", - "mgp", - "dp", - "esa", - "pdb", - "pqa", - "oprc", - "paw", - "str", - "ei6", - "efif", - "wg", - "plf", - "pbd", - "box", - "mgz", - "qps", - "ptid", - "qxd", - "qxt", - "qwd", - "qwt", - "qxl", - "qxb", - "rar", - "bed", - "mxl", - "musicxml", - "cryptonote", - "cod", - "rm", - "rmvb", - "link66", - "st", - "see", - "sema", - "semd", - "semf", - "ifm", - "itp", - "iif", - "ipk", - "twd", - "twds", - "mmf", - "teacher", - "fo", - "sdkm", - "sdkd", - "dxp", - "sfs", - "sdc", - "sda", - "sdd", - "smf", - "sdw", - "vor", - "sgl", - "smzip", - "sm", - "wadl", - "sxc", - "stc", - "sxd", - "std", - "sxi", - "sti", - "sxm", - "sxw", - "sxg", - "stw", - "sus", - "susp", - "svd", - "sis", - "sisx", - "xsm", - "bdm", - "xdm", - "ddf", - "tao", - "pcap", - "cap", - "dmp", - "tmo", - "tpt", - "mxs", - "tra", - "ufd", - "ufdl", - "utz", - "umj", - "unityweb", - "uoml", - "vcx", - "vsd", - "vst", - "vss", - "vsw", - "vis", - "vsf", - "wbxml", - "wmlc", - "wmlsc", - "wtb", - "nbp", - "wpd", - "wqd", - "stf", - "xar", - "xfdl", - "hvd", - "hvs", - "hvp", - "osf", - "osfpvg", - "saf", - "spf", - "cmp", - "zir", - "zirz", - "zaz", - "7z", - "abw", - "ace", - "*dmg", - "arj", - "aab", - "x32", - "u32", - "vox", - "aam", - "aas", - "bcpio", - "*bdoc", - "torrent", - "blb", - "blorb", - "bz", - "bz2", - "boz", - "cbr", - "cba", - "cbt", - "cbz", - "cb7", - "vcd", - "cfs", - "chat", - "pgn", - "crx", - "cco", - "nsc", - "cpio", - "csh", - "*deb", - "udeb", - "dgc", - "dir", - "dcr", - "dxr", - "cst", - "cct", - "cxt", - "w3d", - "fgd", - "swa", - "wad", - "ncx", - "dtb", - "res", - "dvi", - "evy", - "eva", - "bdf", - "gsf", - "psf", - "pcf", - "snf", - "pfa", - "pfb", - "pfm", - "afm", - "arc", - "spl", - "gca", - "ulx", - "gnumeric", - "gramps", - "gtar", - "hdf", - "php", - "install", - "*iso", - "*key", - "*numbers", - "*pages", - "jardiff", - "jnlp", - "kdbx", - "latex", - "luac", - "lzh", - "lha", - "run", - "mie", - "prc", - "mobi", - "application", - "lnk", - "wmd", - "wmz", - "xbap", - "mdb", - "obd", - "crd", - "clp", - "*exe", - "*dll", - "com", - "bat", - "*msi", - "mvb", - "m13", - "m14", - "*wmf", - "*wmz", - "*emf", - "emz", - "mny", - "pub", - "scd", - "trm", - "wri", - "nc", - "cdf", - "pac", - "nzb", - "pl", - "pm", - "*prc", - "*pdb", - "p12", - "pfx", - "p7b", - "spc", - "p7r", - "*rar", - "rpm", - "ris", - "sea", - "sh", - "shar", - "swf", - "xap", - "sql", - "sit", - "sitx", - "srt", - "sv4cpio", - "sv4crc", - "t3", - "gam", - "tar", - "tcl", - "tk", - "tex", - "tfm", - "texinfo", - "texi", - "*obj", - "ustar", - "hdd", - "ova", - "ovf", - "vbox", - "vbox-extpack", - "vdi", - "vhd", - "vmdk", - "src", - "webapp", - "der", - "crt", - "pem", - "fig", - "*xlf", - "xpi", - "xz", - "z1", - "z2", - "z3", - "z4", - "z5", - "z6", - "z7", - "z8", - "uva", - "uvva", - "eol", - "dra", - "dts", - "dtshd", - "lvp", - "pya", - "ecelp4800", - "ecelp7470", - "ecelp9600", - "rip", - "aac", - "aif", - "aiff", - "aifc", - "caf", - "flac", - "*m4a", - "mka", - "m3u", - "wax", - "wma", - "ram", - "ra", - "rmp", - "*ra", - "cdx", - "cif", - "cmdf", - "cml", - "csml", - "xyz", - "btif", - "pti", - "psd", - "azv", - "uvi", - "uvvi", - "uvg", - "uvvg", - "djvu", - "djv", - "*sub", - "dwg", - "dxf", - "fbs", - "fpx", - "fst", - "mmr", - "rlc", - "ico", - "dds", - "mdi", - "wdp", - "npx", - "b16", - "tap", - "vtf", - "wbmp", - "xif", - "pcx", - "3ds", - "ras", - "cmx", - "fh", - "fhc", - "fh4", - "fh5", - "fh7", - "*ico", - "jng", - "sid", - "*bmp", - "*pcx", - "pic", - "pct", - "pnm", - "pbm", - "pgm", - "ppm", - "rgb", - "tga", - "xbm", - "xpm", - "xwd", - "wsc", - "dae", - "dwf", - "gdl", - "gtw", - "mts", - "ogex", - "x_b", - "x_t", - "vds", - "usdz", - "bsp", - "vtu", - "dsc", - "curl", - "dcurl", - "mcurl", - "scurl", - "sub", - "fly", - "flx", - "gv", - "3dml", - "spot", - "jad", - "wml", - "wmls", - "s", - "asm", - "c", - "cc", - "cxx", - "cpp", - "h", - "hh", - "dic", - "htc", - "f", - "for", - "f77", - "f90", - "hbs", - "java", - "lua", - "mkd", - "nfo", - "opml", - "*org", - "p", - "pas", - "pde", - "sass", - "scss", - "etx", - "sfv", - "ymp", - "uu", - "vcs", - "vcf", - "uvh", - "uvvh", - "uvm", - "uvvm", - "uvp", - "uvvp", - "uvs", - "uvvs", - "uvv", - "uvvv", - "dvb", - "fvt", - "mxu", - "m4u", - "pyv", - "uvu", - "uvvu", - "viv", - "f4v", - "fli", - "flv", - "m4v", - "mkv", - "mk3d", - "mks", - "mng", - "asf", - "asx", - "vob", - "wm", - "wmv", - "wmx", - "wvx", - "avi", - "movie", - "smv", - "ice", - "mht", - null, - ], - "example": "pdf", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "name": { - "description": "The filename of the file to upload", - "example": "weather-forecast", - "type": "string", - }, - "path": { - "description": "The path for the file to be uploaded to", - "example": "/path/to/file", - "type": "string", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "POST", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "body", - "name": "name", - "type": "string", - }, - { - "location": "body", - "name": "file_format", - "type": "object", - }, - { - "location": "body", - "name": "content", - "type": "string", - }, - { - "location": "body", - "name": "category_id", - "type": "string", - }, - { - "location": "body", - "name": "path", - "type": "string", - }, - { - "location": "body", - "name": "confidential", - "type": "object", - }, - { - "location": "body", - "name": "category", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/documents/upload", - }, - }, - StackOneTool { - "description": "Download Employee Document", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "format", - "type": "string", - }, - { - "location": "query", - "name": "export_format", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/documents/{subResourceId}/download", - }, - "experimental_preExecute": undefined, - "name": "hris_download_employee_document", - "parameters": { - "properties": { - "export_format": { - "description": "The export format of the file", - "example": "text/plain", - "type": "string", - }, - "format": { - "description": "The format to download the file in", - "example": "base64", - "type": "string", - }, - "id": { - "type": "string", - }, - "subResourceId": { - "type": "string", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "format", - "type": "string", - }, - { - "location": "query", - "name": "export_format", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/documents/{subResourceId}/download", - }, - }, - StackOneTool { - "description": "List Employee Documents", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/documents", - }, - "experimental_preExecute": undefined, - "name": "hris_list_employee_documents", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/documents", - }, - }, - StackOneTool { - "description": "Get Employee Document", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/documents/{subResourceId}", - }, - "experimental_preExecute": undefined, - "name": "hris_get_employee_document", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "subResourceId": { - "type": "string", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/documents/{subResourceId}", - }, - }, - StackOneTool { - "description": "List Employee Document Categories", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/documents/employee_categories", - }, - "experimental_preExecute": undefined, - "name": "hris_list_employee_categories", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,active,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": undefined, - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/documents/employee_categories", - }, - }, - StackOneTool { - "description": "Get Employee Document Category", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/documents/employee_categories/{id}", - }, - "experimental_preExecute": undefined, - "name": "hris_get_employee_document_category", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,active,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/documents/employee_categories/{id}", - }, - }, - StackOneTool { - "description": "List Employee Work Eligibility", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/work_eligibility", - }, - "experimental_preExecute": undefined, - "name": "hris_list_employee_work_eligibility", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,type,sub_type,document,valid_from,valid_to,issued_by,number,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/work_eligibility", - }, - }, - StackOneTool { - "description": "Create Employee Work Eligibility Request", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "POST", - "params": [ - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "body", - "name": "document", - "type": "object", - }, - { - "location": "body", - "name": "issued_by", - "type": "object", - }, - { - "location": "body", - "name": "number", - "type": "string", - }, - { - "location": "body", - "name": "sub_type", - "type": "string", - }, - { - "location": "body", - "name": "type", - "type": "object", - }, - { - "location": "body", - "name": "valid_from", - "type": "string", - }, - { - "location": "body", - "name": "valid_to", - "type": "string", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/work_eligibility", - }, - "experimental_preExecute": undefined, - "name": "hris_create_employee_work_eligibility_request", - "parameters": { - "properties": { - "document": { - "properties": { - "category": { - "description": "The category of the file", - "example": "templates, forms, backups, etc.", - "properties": { - "value": { - "description": "The category of the file", - "type": "string", - }, - }, - "type": "object", - }, - "category_id": { - "description": "The categoryId of the documents", - "example": "6530", - "type": "string", - }, - "created_at": { - "description": "The creation date of the file", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "type": "string", - }, - "file_format": { - "description": "The file format of the file", - "properties": { - "value": { - "description": "The file format of the file, expressed as a file extension", - "enum": [ - "unmapped_value", - "ez", - "aw", - "atom", - "atomcat", - "atomdeleted", - "atomsvc", - "dwd", - "held", - "rsat", - "bdoc", - "xcs", - "ccxml", - "cdfx", - "cdmia", - "cdmic", - "cdmid", - "cdmio", - "cdmiq", - "cu", - "mpd", - "davmount", - "dbk", - "dssc", - "xdssc", - "es", - "ecma", - "emma", - "emotionml", - "epub", - "exi", - "exp", - "fdt", - "pfr", - "geojson", - "gml", - "gpx", - "gxf", - "gz", - "hjson", - "stk", - "ink", - "inkml", - "ipfix", - "its", - "jar", - "war", - "ear", - "ser", - "class", - "js", - "mjs", - "json", - "map", - "json5", - "jsonml", - "jsonld", - "lgr", - "lostxml", - "hqx", - "cpt", - "mads", - "webmanifest", - "mrc", - "mrcx", - "ma", - "nb", - "mb", - "mathml", - "mbox", - "mscml", - "metalink", - "meta4", - "mets", - "maei", - "musd", - "mods", - "m21", - "mp21", - "mp4s", - "m4p", - "doc", - "dot", - "mxf", - "nq", - "nt", - "cjs", - "bin", - "dms", - "lrf", - "mar", - "so", - "dist", - "distz", - "pkg", - "bpk", - "dump", - "elc", - "deploy", - "exe", - "dll", - "deb", - "dmg", - "iso", - "img", - "msi", - "msp", - "msm", - "buffer", - "oda", - "opf", - "ogx", - "omdoc", - "onetoc", - "onetoc2", - "onetmp", - "onepkg", - "oxps", - "relo", - "xer", - "pdf", - "pgp", - "asc", - "sig", - "prf", - "p10", - "p7m", - "p7c", - "p7s", - "p8", - "ac", - "cer", - "crl", - "pkipath", - "pki", - "pls", - "ai", - "eps", - "ps", - "provx", - "pskcxml", - "raml", - "rdf", - "owl", - "rif", - "rnc", - "rl", - "rld", - "rs", - "rapd", - "sls", - "rusd", - "gbr", - "mft", - "roa", - "rsd", - "rss", - "rtf", - "sbml", - "scq", - "scs", - "spq", - "spp", - "sdp", - "senmlx", - "sensmlx", - "setpay", - "setreg", - "shf", - "siv", - "sieve", - "smi", - "smil", - "rq", - "srx", - "gram", - "grxml", - "sru", - "ssdl", - "ssml", - "swidtag", - "tei", - "teicorpus", - "tfi", - "tsd", - "toml", - "trig", - "ttml", - "ubj", - "rsheet", - "td", - "vxml", - "wasm", - "wgt", - "hlp", - "wsdl", - "wspolicy", - "xaml", - "xav", - "xca", - "xdf", - "xel", - "xns", - "xenc", - "xhtml", - "xht", - "xlf", - "xml", - "xsl", - "xsd", - "rng", - "dtd", - "xop", - "xpl", - "*xsl", - "xslt", - "xspf", - "mxml", - "xhvml", - "xvml", - "xvm", - "yang", - "yin", - "zip", - "*3gpp", - "adp", - "amr", - "au", - "snd", - "mid", - "midi", - "kar", - "rmi", - "mxmf", - "*mp3", - "m4a", - "mp4a", - "mpga", - "mp2", - "mp2a", - "mp3", - "m2a", - "m3a", - "oga", - "ogg", - "spx", - "opus", - "s3m", - "sil", - "wav", - "*wav", - "weba", - "xm", - "ttc", - "otf", - "ttf", - "woff", - "woff2", - "exr", - "apng", - "avif", - "bmp", - "cgm", - "drle", - "emf", - "fits", - "g3", - "gif", - "heic", - "heics", - "heif", - "heifs", - "hej2", - "hsj2", - "ief", - "jls", - "jp2", - "jpg2", - "jpeg", - "jpg", - "jpe", - "jph", - "jhc", - "jpm", - "jpx", - "jpf", - "jxr", - "jxra", - "jxrs", - "jxs", - "jxsc", - "jxsi", - "jxss", - "ktx", - "ktx2", - "png", - "sgi", - "svg", - "svgz", - "t38", - "tif", - "tiff", - "tfx", - "webp", - "wmf", - "disposition-notification", - "u8msg", - "u8dsn", - "u8mdn", - "u8hdr", - "eml", - "mime", - "3mf", - "gltf", - "glb", - "igs", - "iges", - "msh", - "mesh", - "silo", - "mtl", - "obj", - "stpx", - "stpz", - "stpxz", - "stl", - "wrl", - "vrml", - "*x3db", - "x3dbz", - "x3db", - "*x3dv", - "x3dvz", - "x3d", - "x3dz", - "x3dv", - "appcache", - "manifest", - "ics", - "ifb", - "coffee", - "litcoffee", - "css", - "csv", - "html", - "htm", - "shtml", - "jade", - "jsx", - "less", - "markdown", - "md", - "mml", - "mdx", - "n3", - "txt", - "text", - "conf", - "def", - "list", - "log", - "in", - "ini", - "rtx", - "*rtf", - "sgml", - "sgm", - "shex", - "slim", - "slm", - "spdx", - "stylus", - "styl", - "tsv", - "t", - "tr", - "roff", - "man", - "me", - "ms", - "ttl", - "uri", - "uris", - "urls", - "vcard", - "vtt", - "*xml", - "yaml", - "yml", - "3gp", - "3gpp", - "3g2", - "h261", - "h263", - "h264", - "m4s", - "jpgv", - "*jpm", - "jpgm", - "mj2", - "mjp2", - "ts", - "mp4", - "mp4v", - "mpg4", - "mpeg", - "mpg", - "mpe", - "m1v", - "m2v", - "ogv", - "qt", - "mov", - "webm", - "cww", - "1km", - "plb", - "psb", - "pvb", - "tcap", - "pwn", - "aso", - "imp", - "acu", - "atc", - "acutc", - "air", - "fcdt", - "fxp", - "fxpl", - "xdp", - "xfdf", - "ahead", - "azf", - "azs", - "azw", - "acc", - "ami", - "apk", - "cii", - "fti", - "atx", - "mpkg", - "key", - "m3u8", - "numbers", - "pages", - "pkpass", - "swi", - "iota", - "aep", - "bmml", - "mpm", - "bmi", - "rep", - "cdxml", - "mmd", - "cdy", - "csl", - "cla", - "rp9", - "c4g", - "c4d", - "c4f", - "c4p", - "c4u", - "c11amc", - "c11amz", - "csp", - "cdbcmsg", - "cmc", - "clkx", - "clkk", - "clkp", - "clkt", - "clkw", - "wbs", - "pml", - "ppd", - "car", - "pcurl", - "dart", - "rdz", - "dbf", - "uvf", - "uvvf", - "uvd", - "uvvd", - "uvt", - "uvvt", - "uvx", - "uvvx", - "uvz", - "uvvz", - "fe_launch", - "dna", - "mlp", - "mle", - "dpg", - "dfac", - "kpxx", - "ait", - "svc", - "geo", - "mag", - "nml", - "esf", - "msf", - "qam", - "slt", - "ssf", - "es3", - "et3", - "ez2", - "ez3", - "fdf", - "mseed", - "seed", - "dataless", - "gph", - "ftc", - "fm", - "frame", - "maker", - "book", - "fnc", - "ltf", - "fsc", - "oas", - "oa2", - "oa3", - "fg5", - "bh2", - "ddd", - "xdw", - "xbd", - "fzs", - "txd", - "ggb", - "ggt", - "gex", - "gre", - "gxt", - "g2w", - "g3w", - "gmx", - "gdoc", - "gslides", - "gsheet", - "kml", - "kmz", - "gqf", - "gqs", - "gac", - "ghf", - "gim", - "grv", - "gtm", - "tpl", - "vcg", - "hal", - "zmm", - "hbci", - "les", - "hpgl", - "hpid", - "hps", - "jlt", - "pcl", - "pclxl", - "sfd-hdstx", - "mpy", - "afp", - "listafp", - "list3820", - "irm", - "sc", - "icc", - "icm", - "igl", - "ivp", - "ivu", - "igm", - "xpw", - "xpx", - "i2g", - "qbo", - "qfx", - "rcprofile", - "irp", - "xpr", - "fcs", - "jam", - "rms", - "jisp", - "joda", - "ktz", - "ktr", - "karbon", - "chrt", - "kfo", - "flw", - "kon", - "kpr", - "kpt", - "ksp", - "kwd", - "kwt", - "htke", - "kia", - "kne", - "knp", - "skp", - "skd", - "skt", - "skm", - "sse", - "lasxml", - "lbd", - "lbe", - "apr", - "pre", - "nsf", - "org", - "scm", - "lwp", - "portpkg", - "mvt", - "mcd", - "mc1", - "cdkey", - "mwf", - "mfm", - "flo", - "igx", - "mif", - "daf", - "dis", - "mbk", - "mqy", - "msl", - "plc", - "txf", - "mpn", - "mpc", - "xul", - "cil", - "cab", - "xls", - "xlm", - "xla", - "xlc", - "xlt", - "xlw", - "xlam", - "xlsb", - "xlsm", - "xltm", - "eot", - "chm", - "ims", - "lrm", - "thmx", - "msg", - "cat", - "*stl", - "ppt", - "pps", - "pot", - "ppam", - "pptm", - "sldm", - "ppsm", - "potm", - "mpp", - "mpt", - "docm", - "dotm", - "wps", - "wks", - "wcm", - "wdb", - "wpl", - "xps", - "mseq", - "mus", - "msty", - "taglet", - "nlu", - "ntf", - "nitf", - "nnd", - "nns", - "nnw", - "*ac", - "ngdat", - "n-gage", - "rpst", - "rpss", - "edm", - "edx", - "ext", - "odc", - "otc", - "odb", - "odf", - "odft", - "odg", - "otg", - "odi", - "oti", - "odp", - "otp", - "ods", - "ots", - "odt", - "odm", - "ott", - "oth", - "xo", - "dd2", - "obgx", - "oxt", - "osm", - "pptx", - "sldx", - "ppsx", - "potx", - "xlsx", - "xltx", - "docx", - "dotx", - "mgp", - "dp", - "esa", - "pdb", - "pqa", - "oprc", - "paw", - "str", - "ei6", - "efif", - "wg", - "plf", - "pbd", - "box", - "mgz", - "qps", - "ptid", - "qxd", - "qxt", - "qwd", - "qwt", - "qxl", - "qxb", - "rar", - "bed", - "mxl", - "musicxml", - "cryptonote", - "cod", - "rm", - "rmvb", - "link66", - "st", - "see", - "sema", - "semd", - "semf", - "ifm", - "itp", - "iif", - "ipk", - "twd", - "twds", - "mmf", - "teacher", - "fo", - "sdkm", - "sdkd", - "dxp", - "sfs", - "sdc", - "sda", - "sdd", - "smf", - "sdw", - "vor", - "sgl", - "smzip", - "sm", - "wadl", - "sxc", - "stc", - "sxd", - "std", - "sxi", - "sti", - "sxm", - "sxw", - "sxg", - "stw", - "sus", - "susp", - "svd", - "sis", - "sisx", - "xsm", - "bdm", - "xdm", - "ddf", - "tao", - "pcap", - "cap", - "dmp", - "tmo", - "tpt", - "mxs", - "tra", - "ufd", - "ufdl", - "utz", - "umj", - "unityweb", - "uoml", - "vcx", - "vsd", - "vst", - "vss", - "vsw", - "vis", - "vsf", - "wbxml", - "wmlc", - "wmlsc", - "wtb", - "nbp", - "wpd", - "wqd", - "stf", - "xar", - "xfdl", - "hvd", - "hvs", - "hvp", - "osf", - "osfpvg", - "saf", - "spf", - "cmp", - "zir", - "zirz", - "zaz", - "7z", - "abw", - "ace", - "*dmg", - "arj", - "aab", - "x32", - "u32", - "vox", - "aam", - "aas", - "bcpio", - "*bdoc", - "torrent", - "blb", - "blorb", - "bz", - "bz2", - "boz", - "cbr", - "cba", - "cbt", - "cbz", - "cb7", - "vcd", - "cfs", - "chat", - "pgn", - "crx", - "cco", - "nsc", - "cpio", - "csh", - "*deb", - "udeb", - "dgc", - "dir", - "dcr", - "dxr", - "cst", - "cct", - "cxt", - "w3d", - "fgd", - "swa", - "wad", - "ncx", - "dtb", - "res", - "dvi", - "evy", - "eva", - "bdf", - "gsf", - "psf", - "pcf", - "snf", - "pfa", - "pfb", - "pfm", - "afm", - "arc", - "spl", - "gca", - "ulx", - "gnumeric", - "gramps", - "gtar", - "hdf", - "php", - "install", - "*iso", - "*key", - "*numbers", - "*pages", - "jardiff", - "jnlp", - "kdbx", - "latex", - "luac", - "lzh", - "lha", - "run", - "mie", - "prc", - "mobi", - "application", - "lnk", - "wmd", - "wmz", - "xbap", - "mdb", - "obd", - "crd", - "clp", - "*exe", - "*dll", - "com", - "bat", - "*msi", - "mvb", - "m13", - "m14", - "*wmf", - "*wmz", - "*emf", - "emz", - "mny", - "pub", - "scd", - "trm", - "wri", - "nc", - "cdf", - "pac", - "nzb", - "pl", - "pm", - "*prc", - "*pdb", - "p12", - "pfx", - "p7b", - "spc", - "p7r", - "*rar", - "rpm", - "ris", - "sea", - "sh", - "shar", - "swf", - "xap", - "sql", - "sit", - "sitx", - "srt", - "sv4cpio", - "sv4crc", - "t3", - "gam", - "tar", - "tcl", - "tk", - "tex", - "tfm", - "texinfo", - "texi", - "*obj", - "ustar", - "hdd", - "ova", - "ovf", - "vbox", - "vbox-extpack", - "vdi", - "vhd", - "vmdk", - "src", - "webapp", - "der", - "crt", - "pem", - "fig", - "*xlf", - "xpi", - "xz", - "z1", - "z2", - "z3", - "z4", - "z5", - "z6", - "z7", - "z8", - "uva", - "uvva", - "eol", - "dra", - "dts", - "dtshd", - "lvp", - "pya", - "ecelp4800", - "ecelp7470", - "ecelp9600", - "rip", - "aac", - "aif", - "aiff", - "aifc", - "caf", - "flac", - "*m4a", - "mka", - "m3u", - "wax", - "wma", - "ram", - "ra", - "rmp", - "*ra", - "cdx", - "cif", - "cmdf", - "cml", - "csml", - "xyz", - "btif", - "pti", - "psd", - "azv", - "uvi", - "uvvi", - "uvg", - "uvvg", - "djvu", - "djv", - "*sub", - "dwg", - "dxf", - "fbs", - "fpx", - "fst", - "mmr", - "rlc", - "ico", - "dds", - "mdi", - "wdp", - "npx", - "b16", - "tap", - "vtf", - "wbmp", - "xif", - "pcx", - "3ds", - "ras", - "cmx", - "fh", - "fhc", - "fh4", - "fh5", - "fh7", - "*ico", - "jng", - "sid", - "*bmp", - "*pcx", - "pic", - "pct", - "pnm", - "pbm", - "pgm", - "ppm", - "rgb", - "tga", - "xbm", - "xpm", - "xwd", - "wsc", - "dae", - "dwf", - "gdl", - "gtw", - "mts", - "ogex", - "x_b", - "x_t", - "vds", - "usdz", - "bsp", - "vtu", - "dsc", - "curl", - "dcurl", - "mcurl", - "scurl", - "sub", - "fly", - "flx", - "gv", - "3dml", - "spot", - "jad", - "wml", - "wmls", - "s", - "asm", - "c", - "cc", - "cxx", - "cpp", - "h", - "hh", - "dic", - "htc", - "f", - "for", - "f77", - "f90", - "hbs", - "java", - "lua", - "mkd", - "nfo", - "opml", - "*org", - "p", - "pas", - "pde", - "sass", - "scss", - "etx", - "sfv", - "ymp", - "uu", - "vcs", - "vcf", - "uvh", - "uvvh", - "uvm", - "uvvm", - "uvp", - "uvvp", - "uvs", - "uvvs", - "uvv", - "uvvv", - "dvb", - "fvt", - "mxu", - "m4u", - "pyv", - "uvu", - "uvvu", - "viv", - "f4v", - "fli", - "flv", - "m4v", - "mkv", - "mk3d", - "mks", - "mng", - "asf", - "asx", - "vob", - "wm", - "wmv", - "wmx", - "wvx", - "avi", - "movie", - "smv", - "ice", - "mht", - null, - ], - "example": "pdf", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "name": { - "description": "The name of the file", - "example": "My Document", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "remote_url": { - "description": "URL where the file content is located", - "example": "https://example.com/file.pdf", - "type": "string", - }, - "updated_at": { - "description": "The update date of the file", - "example": "2021-01-02T01:01:01.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "issued_by": { - "description": "The country code of the issued by authority", - "properties": { - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "type": "string", - }, - }, - "type": "object", - }, - "number": { - "example": "1234567890", - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "type": "object", - }, - "sub_type": { - "example": "H1B", - "type": "string", - }, - "type": { - "example": "visa", - "properties": { - "value": { - "enum": [ - "visa", - "passport", - "driver_license", - "birth_certificate", - "other", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "valid_from": { - "example": "2021-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "valid_to": { - "example": "2021-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "POST", - "params": [ - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "body", - "name": "document", - "type": "object", - }, - { - "location": "body", - "name": "issued_by", - "type": "object", - }, - { - "location": "body", - "name": "number", - "type": "string", - }, - { - "location": "body", - "name": "sub_type", - "type": "string", - }, - { - "location": "body", - "name": "type", - "type": "object", - }, - { - "location": "body", - "name": "valid_from", - "type": "string", - }, - { - "location": "body", - "name": "valid_to", - "type": "string", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/work_eligibility", - }, - }, - StackOneTool { - "description": "Get Employees Work Eligibility", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/work_eligibility/{subResourceId}", - }, - "experimental_preExecute": undefined, - "name": "hris_get_employees_work_eligibility", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,type,sub_type,document,valid_from,valid_to,issued_by,number,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "subResourceId": { - "type": "string", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/work_eligibility/{subResourceId}", - }, - }, - StackOneTool { - "description": "Update Employee Work Eligibility Request", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "PATCH", - "params": [ - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "body", - "name": "document", - "type": "object", - }, - { - "location": "body", - "name": "issued_by", - "type": "object", - }, - { - "location": "body", - "name": "number", - "type": "string", - }, - { - "location": "body", - "name": "sub_type", - "type": "string", - }, - { - "location": "body", - "name": "type", - "type": "object", - }, - { - "location": "body", - "name": "valid_from", - "type": "string", - }, - { - "location": "body", - "name": "valid_to", - "type": "string", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/work_eligibility/{subResourceId}", - }, - "experimental_preExecute": undefined, - "name": "hris_update_employee_work_eligibility_request", - "parameters": { - "properties": { - "document": { - "properties": { - "category": { - "description": "The category of the file", - "example": "templates, forms, backups, etc.", - "properties": { - "value": { - "description": "The category of the file", - "type": "string", - }, - }, - "type": "object", - }, - "category_id": { - "description": "The categoryId of the documents", - "example": "6530", - "type": "string", - }, - "created_at": { - "description": "The creation date of the file", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "type": "string", - }, - "file_format": { - "description": "The file format of the file", - "properties": { - "value": { - "description": "The file format of the file, expressed as a file extension", - "enum": [ - "unmapped_value", - "ez", - "aw", - "atom", - "atomcat", - "atomdeleted", - "atomsvc", - "dwd", - "held", - "rsat", - "bdoc", - "xcs", - "ccxml", - "cdfx", - "cdmia", - "cdmic", - "cdmid", - "cdmio", - "cdmiq", - "cu", - "mpd", - "davmount", - "dbk", - "dssc", - "xdssc", - "es", - "ecma", - "emma", - "emotionml", - "epub", - "exi", - "exp", - "fdt", - "pfr", - "geojson", - "gml", - "gpx", - "gxf", - "gz", - "hjson", - "stk", - "ink", - "inkml", - "ipfix", - "its", - "jar", - "war", - "ear", - "ser", - "class", - "js", - "mjs", - "json", - "map", - "json5", - "jsonml", - "jsonld", - "lgr", - "lostxml", - "hqx", - "cpt", - "mads", - "webmanifest", - "mrc", - "mrcx", - "ma", - "nb", - "mb", - "mathml", - "mbox", - "mscml", - "metalink", - "meta4", - "mets", - "maei", - "musd", - "mods", - "m21", - "mp21", - "mp4s", - "m4p", - "doc", - "dot", - "mxf", - "nq", - "nt", - "cjs", - "bin", - "dms", - "lrf", - "mar", - "so", - "dist", - "distz", - "pkg", - "bpk", - "dump", - "elc", - "deploy", - "exe", - "dll", - "deb", - "dmg", - "iso", - "img", - "msi", - "msp", - "msm", - "buffer", - "oda", - "opf", - "ogx", - "omdoc", - "onetoc", - "onetoc2", - "onetmp", - "onepkg", - "oxps", - "relo", - "xer", - "pdf", - "pgp", - "asc", - "sig", - "prf", - "p10", - "p7m", - "p7c", - "p7s", - "p8", - "ac", - "cer", - "crl", - "pkipath", - "pki", - "pls", - "ai", - "eps", - "ps", - "provx", - "pskcxml", - "raml", - "rdf", - "owl", - "rif", - "rnc", - "rl", - "rld", - "rs", - "rapd", - "sls", - "rusd", - "gbr", - "mft", - "roa", - "rsd", - "rss", - "rtf", - "sbml", - "scq", - "scs", - "spq", - "spp", - "sdp", - "senmlx", - "sensmlx", - "setpay", - "setreg", - "shf", - "siv", - "sieve", - "smi", - "smil", - "rq", - "srx", - "gram", - "grxml", - "sru", - "ssdl", - "ssml", - "swidtag", - "tei", - "teicorpus", - "tfi", - "tsd", - "toml", - "trig", - "ttml", - "ubj", - "rsheet", - "td", - "vxml", - "wasm", - "wgt", - "hlp", - "wsdl", - "wspolicy", - "xaml", - "xav", - "xca", - "xdf", - "xel", - "xns", - "xenc", - "xhtml", - "xht", - "xlf", - "xml", - "xsl", - "xsd", - "rng", - "dtd", - "xop", - "xpl", - "*xsl", - "xslt", - "xspf", - "mxml", - "xhvml", - "xvml", - "xvm", - "yang", - "yin", - "zip", - "*3gpp", - "adp", - "amr", - "au", - "snd", - "mid", - "midi", - "kar", - "rmi", - "mxmf", - "*mp3", - "m4a", - "mp4a", - "mpga", - "mp2", - "mp2a", - "mp3", - "m2a", - "m3a", - "oga", - "ogg", - "spx", - "opus", - "s3m", - "sil", - "wav", - "*wav", - "weba", - "xm", - "ttc", - "otf", - "ttf", - "woff", - "woff2", - "exr", - "apng", - "avif", - "bmp", - "cgm", - "drle", - "emf", - "fits", - "g3", - "gif", - "heic", - "heics", - "heif", - "heifs", - "hej2", - "hsj2", - "ief", - "jls", - "jp2", - "jpg2", - "jpeg", - "jpg", - "jpe", - "jph", - "jhc", - "jpm", - "jpx", - "jpf", - "jxr", - "jxra", - "jxrs", - "jxs", - "jxsc", - "jxsi", - "jxss", - "ktx", - "ktx2", - "png", - "sgi", - "svg", - "svgz", - "t38", - "tif", - "tiff", - "tfx", - "webp", - "wmf", - "disposition-notification", - "u8msg", - "u8dsn", - "u8mdn", - "u8hdr", - "eml", - "mime", - "3mf", - "gltf", - "glb", - "igs", - "iges", - "msh", - "mesh", - "silo", - "mtl", - "obj", - "stpx", - "stpz", - "stpxz", - "stl", - "wrl", - "vrml", - "*x3db", - "x3dbz", - "x3db", - "*x3dv", - "x3dvz", - "x3d", - "x3dz", - "x3dv", - "appcache", - "manifest", - "ics", - "ifb", - "coffee", - "litcoffee", - "css", - "csv", - "html", - "htm", - "shtml", - "jade", - "jsx", - "less", - "markdown", - "md", - "mml", - "mdx", - "n3", - "txt", - "text", - "conf", - "def", - "list", - "log", - "in", - "ini", - "rtx", - "*rtf", - "sgml", - "sgm", - "shex", - "slim", - "slm", - "spdx", - "stylus", - "styl", - "tsv", - "t", - "tr", - "roff", - "man", - "me", - "ms", - "ttl", - "uri", - "uris", - "urls", - "vcard", - "vtt", - "*xml", - "yaml", - "yml", - "3gp", - "3gpp", - "3g2", - "h261", - "h263", - "h264", - "m4s", - "jpgv", - "*jpm", - "jpgm", - "mj2", - "mjp2", - "ts", - "mp4", - "mp4v", - "mpg4", - "mpeg", - "mpg", - "mpe", - "m1v", - "m2v", - "ogv", - "qt", - "mov", - "webm", - "cww", - "1km", - "plb", - "psb", - "pvb", - "tcap", - "pwn", - "aso", - "imp", - "acu", - "atc", - "acutc", - "air", - "fcdt", - "fxp", - "fxpl", - "xdp", - "xfdf", - "ahead", - "azf", - "azs", - "azw", - "acc", - "ami", - "apk", - "cii", - "fti", - "atx", - "mpkg", - "key", - "m3u8", - "numbers", - "pages", - "pkpass", - "swi", - "iota", - "aep", - "bmml", - "mpm", - "bmi", - "rep", - "cdxml", - "mmd", - "cdy", - "csl", - "cla", - "rp9", - "c4g", - "c4d", - "c4f", - "c4p", - "c4u", - "c11amc", - "c11amz", - "csp", - "cdbcmsg", - "cmc", - "clkx", - "clkk", - "clkp", - "clkt", - "clkw", - "wbs", - "pml", - "ppd", - "car", - "pcurl", - "dart", - "rdz", - "dbf", - "uvf", - "uvvf", - "uvd", - "uvvd", - "uvt", - "uvvt", - "uvx", - "uvvx", - "uvz", - "uvvz", - "fe_launch", - "dna", - "mlp", - "mle", - "dpg", - "dfac", - "kpxx", - "ait", - "svc", - "geo", - "mag", - "nml", - "esf", - "msf", - "qam", - "slt", - "ssf", - "es3", - "et3", - "ez2", - "ez3", - "fdf", - "mseed", - "seed", - "dataless", - "gph", - "ftc", - "fm", - "frame", - "maker", - "book", - "fnc", - "ltf", - "fsc", - "oas", - "oa2", - "oa3", - "fg5", - "bh2", - "ddd", - "xdw", - "xbd", - "fzs", - "txd", - "ggb", - "ggt", - "gex", - "gre", - "gxt", - "g2w", - "g3w", - "gmx", - "gdoc", - "gslides", - "gsheet", - "kml", - "kmz", - "gqf", - "gqs", - "gac", - "ghf", - "gim", - "grv", - "gtm", - "tpl", - "vcg", - "hal", - "zmm", - "hbci", - "les", - "hpgl", - "hpid", - "hps", - "jlt", - "pcl", - "pclxl", - "sfd-hdstx", - "mpy", - "afp", - "listafp", - "list3820", - "irm", - "sc", - "icc", - "icm", - "igl", - "ivp", - "ivu", - "igm", - "xpw", - "xpx", - "i2g", - "qbo", - "qfx", - "rcprofile", - "irp", - "xpr", - "fcs", - "jam", - "rms", - "jisp", - "joda", - "ktz", - "ktr", - "karbon", - "chrt", - "kfo", - "flw", - "kon", - "kpr", - "kpt", - "ksp", - "kwd", - "kwt", - "htke", - "kia", - "kne", - "knp", - "skp", - "skd", - "skt", - "skm", - "sse", - "lasxml", - "lbd", - "lbe", - "apr", - "pre", - "nsf", - "org", - "scm", - "lwp", - "portpkg", - "mvt", - "mcd", - "mc1", - "cdkey", - "mwf", - "mfm", - "flo", - "igx", - "mif", - "daf", - "dis", - "mbk", - "mqy", - "msl", - "plc", - "txf", - "mpn", - "mpc", - "xul", - "cil", - "cab", - "xls", - "xlm", - "xla", - "xlc", - "xlt", - "xlw", - "xlam", - "xlsb", - "xlsm", - "xltm", - "eot", - "chm", - "ims", - "lrm", - "thmx", - "msg", - "cat", - "*stl", - "ppt", - "pps", - "pot", - "ppam", - "pptm", - "sldm", - "ppsm", - "potm", - "mpp", - "mpt", - "docm", - "dotm", - "wps", - "wks", - "wcm", - "wdb", - "wpl", - "xps", - "mseq", - "mus", - "msty", - "taglet", - "nlu", - "ntf", - "nitf", - "nnd", - "nns", - "nnw", - "*ac", - "ngdat", - "n-gage", - "rpst", - "rpss", - "edm", - "edx", - "ext", - "odc", - "otc", - "odb", - "odf", - "odft", - "odg", - "otg", - "odi", - "oti", - "odp", - "otp", - "ods", - "ots", - "odt", - "odm", - "ott", - "oth", - "xo", - "dd2", - "obgx", - "oxt", - "osm", - "pptx", - "sldx", - "ppsx", - "potx", - "xlsx", - "xltx", - "docx", - "dotx", - "mgp", - "dp", - "esa", - "pdb", - "pqa", - "oprc", - "paw", - "str", - "ei6", - "efif", - "wg", - "plf", - "pbd", - "box", - "mgz", - "qps", - "ptid", - "qxd", - "qxt", - "qwd", - "qwt", - "qxl", - "qxb", - "rar", - "bed", - "mxl", - "musicxml", - "cryptonote", - "cod", - "rm", - "rmvb", - "link66", - "st", - "see", - "sema", - "semd", - "semf", - "ifm", - "itp", - "iif", - "ipk", - "twd", - "twds", - "mmf", - "teacher", - "fo", - "sdkm", - "sdkd", - "dxp", - "sfs", - "sdc", - "sda", - "sdd", - "smf", - "sdw", - "vor", - "sgl", - "smzip", - "sm", - "wadl", - "sxc", - "stc", - "sxd", - "std", - "sxi", - "sti", - "sxm", - "sxw", - "sxg", - "stw", - "sus", - "susp", - "svd", - "sis", - "sisx", - "xsm", - "bdm", - "xdm", - "ddf", - "tao", - "pcap", - "cap", - "dmp", - "tmo", - "tpt", - "mxs", - "tra", - "ufd", - "ufdl", - "utz", - "umj", - "unityweb", - "uoml", - "vcx", - "vsd", - "vst", - "vss", - "vsw", - "vis", - "vsf", - "wbxml", - "wmlc", - "wmlsc", - "wtb", - "nbp", - "wpd", - "wqd", - "stf", - "xar", - "xfdl", - "hvd", - "hvs", - "hvp", - "osf", - "osfpvg", - "saf", - "spf", - "cmp", - "zir", - "zirz", - "zaz", - "7z", - "abw", - "ace", - "*dmg", - "arj", - "aab", - "x32", - "u32", - "vox", - "aam", - "aas", - "bcpio", - "*bdoc", - "torrent", - "blb", - "blorb", - "bz", - "bz2", - "boz", - "cbr", - "cba", - "cbt", - "cbz", - "cb7", - "vcd", - "cfs", - "chat", - "pgn", - "crx", - "cco", - "nsc", - "cpio", - "csh", - "*deb", - "udeb", - "dgc", - "dir", - "dcr", - "dxr", - "cst", - "cct", - "cxt", - "w3d", - "fgd", - "swa", - "wad", - "ncx", - "dtb", - "res", - "dvi", - "evy", - "eva", - "bdf", - "gsf", - "psf", - "pcf", - "snf", - "pfa", - "pfb", - "pfm", - "afm", - "arc", - "spl", - "gca", - "ulx", - "gnumeric", - "gramps", - "gtar", - "hdf", - "php", - "install", - "*iso", - "*key", - "*numbers", - "*pages", - "jardiff", - "jnlp", - "kdbx", - "latex", - "luac", - "lzh", - "lha", - "run", - "mie", - "prc", - "mobi", - "application", - "lnk", - "wmd", - "wmz", - "xbap", - "mdb", - "obd", - "crd", - "clp", - "*exe", - "*dll", - "com", - "bat", - "*msi", - "mvb", - "m13", - "m14", - "*wmf", - "*wmz", - "*emf", - "emz", - "mny", - "pub", - "scd", - "trm", - "wri", - "nc", - "cdf", - "pac", - "nzb", - "pl", - "pm", - "*prc", - "*pdb", - "p12", - "pfx", - "p7b", - "spc", - "p7r", - "*rar", - "rpm", - "ris", - "sea", - "sh", - "shar", - "swf", - "xap", - "sql", - "sit", - "sitx", - "srt", - "sv4cpio", - "sv4crc", - "t3", - "gam", - "tar", - "tcl", - "tk", - "tex", - "tfm", - "texinfo", - "texi", - "*obj", - "ustar", - "hdd", - "ova", - "ovf", - "vbox", - "vbox-extpack", - "vdi", - "vhd", - "vmdk", - "src", - "webapp", - "der", - "crt", - "pem", - "fig", - "*xlf", - "xpi", - "xz", - "z1", - "z2", - "z3", - "z4", - "z5", - "z6", - "z7", - "z8", - "uva", - "uvva", - "eol", - "dra", - "dts", - "dtshd", - "lvp", - "pya", - "ecelp4800", - "ecelp7470", - "ecelp9600", - "rip", - "aac", - "aif", - "aiff", - "aifc", - "caf", - "flac", - "*m4a", - "mka", - "m3u", - "wax", - "wma", - "ram", - "ra", - "rmp", - "*ra", - "cdx", - "cif", - "cmdf", - "cml", - "csml", - "xyz", - "btif", - "pti", - "psd", - "azv", - "uvi", - "uvvi", - "uvg", - "uvvg", - "djvu", - "djv", - "*sub", - "dwg", - "dxf", - "fbs", - "fpx", - "fst", - "mmr", - "rlc", - "ico", - "dds", - "mdi", - "wdp", - "npx", - "b16", - "tap", - "vtf", - "wbmp", - "xif", - "pcx", - "3ds", - "ras", - "cmx", - "fh", - "fhc", - "fh4", - "fh5", - "fh7", - "*ico", - "jng", - "sid", - "*bmp", - "*pcx", - "pic", - "pct", - "pnm", - "pbm", - "pgm", - "ppm", - "rgb", - "tga", - "xbm", - "xpm", - "xwd", - "wsc", - "dae", - "dwf", - "gdl", - "gtw", - "mts", - "ogex", - "x_b", - "x_t", - "vds", - "usdz", - "bsp", - "vtu", - "dsc", - "curl", - "dcurl", - "mcurl", - "scurl", - "sub", - "fly", - "flx", - "gv", - "3dml", - "spot", - "jad", - "wml", - "wmls", - "s", - "asm", - "c", - "cc", - "cxx", - "cpp", - "h", - "hh", - "dic", - "htc", - "f", - "for", - "f77", - "f90", - "hbs", - "java", - "lua", - "mkd", - "nfo", - "opml", - "*org", - "p", - "pas", - "pde", - "sass", - "scss", - "etx", - "sfv", - "ymp", - "uu", - "vcs", - "vcf", - "uvh", - "uvvh", - "uvm", - "uvvm", - "uvp", - "uvvp", - "uvs", - "uvvs", - "uvv", - "uvvv", - "dvb", - "fvt", - "mxu", - "m4u", - "pyv", - "uvu", - "uvvu", - "viv", - "f4v", - "fli", - "flv", - "m4v", - "mkv", - "mk3d", - "mks", - "mng", - "asf", - "asx", - "vob", - "wm", - "wmv", - "wmx", - "wvx", - "avi", - "movie", - "smv", - "ice", - "mht", - null, - ], - "example": "pdf", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "name": { - "description": "The name of the file", - "example": "My Document", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "remote_url": { - "description": "URL where the file content is located", - "example": "https://example.com/file.pdf", - "type": "string", - }, - "updated_at": { - "description": "The update date of the file", - "example": "2021-01-02T01:01:01.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "issued_by": { - "description": "The country code of the issued by authority", - "properties": { - "value": { - "description": "The ISO3166-1 Alpha2 Code of the Country", - "enum": [ - "AF", - "AL", - "DZ", - "AS", - "AD", - "AO", - "AI", - "AQ", - "AG", - "AR", - "AM", - "AW", - "AU", - "AT", - "AZ", - "BS", - "BH", - "BD", - "BB", - "BY", - "BE", - "BZ", - "BJ", - "BM", - "BT", - "BO", - "BQ", - "BA", - "BW", - "BV", - "BR", - "IO", - "BN", - "BG", - "BF", - "BI", - "KH", - "CM", - "CA", - "CV", - "KY", - "CF", - "TD", - "CL", - "CN", - "CX", - "CC", - "CO", - "KM", - "CG", - "CD", - "CK", - "CR", - "HR", - "CU", - "CW", - "CY", - "CZ", - "CI", - "DK", - "DJ", - "DM", - "DO", - "EC", - "EG", - "SV", - "GQ", - "ER", - "EE", - "ET", - "FK", - "FO", - "FJ", - "FI", - "FR", - "GF", - "PF", - "TF", - "GA", - "GM", - "GE", - "DE", - "GH", - "GI", - "GR", - "GL", - "GD", - "GP", - "GU", - "GT", - "GG", - "GN", - "GW", - "GY", - "HT", - "HM", - "VA", - "HN", - "HK", - "HU", - "IS", - "IN", - "ID", - "IR", - "IQ", - "IE", - "IM", - "IL", - "IT", - "JM", - "JP", - "JE", - "JO", - "KZ", - "KE", - "KI", - "KP", - "KR", - "KW", - "KG", - "LA", - "LV", - "LB", - "LS", - "LR", - "LY", - "LI", - "LT", - "LU", - "MO", - "MK", - "MG", - "MW", - "MY", - "MV", - "ML", - "MT", - "MH", - "MQ", - "MR", - "MU", - "YT", - "MX", - "FM", - "MD", - "MC", - "MN", - "ME", - "MS", - "MA", - "MZ", - "MM", - "NA", - "NR", - "NP", - "NL", - "NC", - "NZ", - "NI", - "NE", - "NG", - "NU", - "NF", - "MP", - "NO", - "OM", - "PK", - "PW", - "PS", - "PA", - "PG", - "PY", - "PE", - "PH", - "PN", - "PL", - "PT", - "PR", - "QA", - "RO", - "RU", - "RW", - "RE", - "BL", - "SH", - "KN", - "LC", - "MF", - "PM", - "VC", - "WS", - "SM", - "ST", - "SA", - "SN", - "RS", - "SC", - "SL", - "SG", - "SX", - "SK", - "SI", - "SB", - "SO", - "ZA", - "GS", - "SS", - "ES", - "LK", - "SD", - "SR", - "SJ", - "SZ", - "SE", - "CH", - "SY", - "TW", - "TJ", - "TZ", - "TH", - "TL", - "TG", - "TK", - "TO", - "TT", - "TN", - "TR", - "TM", - "TC", - "TV", - "UG", - "UA", - "AE", - "GB", - "US", - "UM", - "UY", - "UZ", - "VU", - "VE", - "VN", - "VG", - "VI", - "WF", - "EH", - "YE", - "ZM", - "ZW", - "unmapped_value", - null, - ], - "example": "US", - "type": "string", - }, - }, - "type": "object", - }, - "number": { - "example": "1234567890", - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "type": "object", - }, - "subResourceId": { - "type": "string", - }, - "sub_type": { - "example": "H1B", - "type": "string", - }, - "type": { - "example": "visa", - "properties": { - "value": { - "enum": [ - "visa", - "passport", - "driver_license", - "birth_certificate", - "other", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "valid_from": { - "example": "2021-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "valid_to": { - "example": "2021-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "PATCH", - "params": [ - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "body", - "name": "document", - "type": "object", - }, - { - "location": "body", - "name": "issued_by", - "type": "object", - }, - { - "location": "body", - "name": "number", - "type": "string", - }, - { - "location": "body", - "name": "sub_type", - "type": "string", - }, - { - "location": "body", - "name": "type", - "type": "object", - }, - { - "location": "body", - "name": "valid_from", - "type": "string", - }, - { - "location": "body", - "name": "valid_to", - "type": "string", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/work_eligibility/{subResourceId}", - }, - }, - StackOneTool { - "description": "List Employee Time Off Balances", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off_balances", - }, - "experimental_preExecute": undefined, - "name": "hris_list_employee_time_off_balances", - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "policy", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,policy_id,remote_policy_id,policy,current_balance,initial_balance,balance_unit,balance_start_date,balance_expiry_date,is_unlimited,updated_at,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "HRIS Time Off Balance filters", - "properties": { - "policy_ids": { - "additionalProperties": false, - "description": "List of policy ids to filter time off balances by.", - "items": { - "type": "string", - }, - "type": "array", - }, - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off_balances", - }, - }, - StackOneTool { - "description": "Get Employee Time Off Balance", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off_balances/{subResourceId}", - }, - "experimental_preExecute": undefined, - "name": "hris_get_employee_time_off_balance", - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "policy", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,policy_id,remote_policy_id,policy,current_balance,initial_balance,balance_unit,balance_start_date,balance_expiry_date,is_unlimited,updated_at,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "subResourceId": { - "type": "string", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off_balances/{subResourceId}", - }, - }, - StackOneTool { - "description": "List Employments", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employments", - }, - "experimental_preExecute": undefined, - "name": "hris_list_employments", - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "groups", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,job_title,pay_rate,pay_period,pay_frequency,pay_currency,effective_date,end_date,employment_type,employment_contract_type,type,contract_type,change_reason,grade,work_time,payroll_code,fte,created_at,updated_at,start_date,active,department,team,cost_center,cost_centers,division,job,manager,groups,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": undefined, - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employments", - }, - }, - StackOneTool { - "description": "Get Employment", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employments/{id}", - }, - "experimental_preExecute": undefined, - "name": "hris_get_employment", - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "groups", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,job_title,pay_rate,pay_period,pay_frequency,pay_currency,effective_date,end_date,employment_type,employment_contract_type,type,contract_type,change_reason,grade,work_time,payroll_code,fte,created_at,updated_at,start_date,active,department,team,cost_center,cost_centers,division,job,manager,groups,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employments/{id}", - }, - }, - StackOneTool { - "description": "List Employee Employments", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/employments", - }, - "experimental_preExecute": undefined, - "name": "hris_list_employee_employments", - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "groups", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,job_title,pay_rate,pay_period,pay_frequency,pay_currency,effective_date,end_date,employment_type,employment_contract_type,type,contract_type,change_reason,grade,work_time,payroll_code,fte,created_at,updated_at,start_date,active,department,team,cost_center,cost_centers,division,job,manager,groups,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/employments", - }, - }, - StackOneTool { - "description": "Create Employee Employment", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "POST", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "body", - "name": "unified_custom_fields", - "type": "object", - }, - { - "location": "body", - "name": "job_title", - "type": "string", - }, - { - "location": "body", - "name": "pay_rate", - "type": "string", - }, - { - "location": "body", - "name": "pay_period", - "type": "object", - }, - { - "location": "body", - "name": "pay_frequency", - "type": "object", - }, - { - "location": "body", - "name": "pay_currency", - "type": "string", - }, - { - "location": "body", - "name": "effective_date", - "type": "string", - }, - { - "location": "body", - "name": "end_date", - "type": "string", - }, - { - "location": "body", - "name": "grade", - "type": "object", - }, - { - "location": "body", - "name": "type", - "type": "object", - }, - { - "location": "body", - "name": "contract_type", - "type": "object", - }, - { - "location": "body", - "name": "work_time", - "type": "object", - }, - { - "location": "body", - "name": "payroll_code", - "type": "string", - }, - { - "location": "body", - "name": "job_id", - "type": "string", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/employments", - }, - "experimental_preExecute": undefined, - "name": "hris_create_employee_employment", - "parameters": { - "properties": { - "contract_type": { - "description": "The employment work schedule type", - "properties": { - "contract_type": { - "description": "The employment work schedule type (e.g., full-time, part-time)", - "example": "full_time", - "properties": { - "value": { - "enum": [ - "full_time", - "shifts", - "part_time", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "label": { - "description": "The label of the employment type", - "example": "Full-Time", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - }, - "type": "object", - }, - "effective_date": { - "description": "The effective date of the employment contract", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "type": "string", - }, - "end_date": { - "description": "The end date of employment", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "type": "string", - }, - "grade": { - "description": "Represents the employeeโ€™s position within the organizational hierarchy.", - "properties": { - "description": { - "description": "description of the grade", - "example": "Mid-level employee demonstrating proficiency and autonomy.", - "type": "string", - }, - "id": { - "description": "The reference id", - "example": "1687-3", - "type": "string", - }, - "name": { - "description": "The reference name", - "example": "1687-4", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "job_id": { - "description": "The employee job id", - "example": "5290", - "type": "string", - }, - "job_title": { - "description": "The job title of the employee", - "example": "Software Engineer", - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "type": "object", - }, - "pay_currency": { - "description": "The currency used for pay", - "example": "USD", - "type": "string", - }, - "pay_frequency": { - "description": "How often the employee is paid", - "example": "hourly", - "properties": { - "value": { - "enum": [ - "hourly", - "weekly", - "bi_weekly", - "four_weekly", - "semi_monthly", - "monthly", - "bi_monthly", - "quarterly", - "semi_annually", - "yearly", - "thirteen_monthly", - "pro_rata", - "unmapped_value", - "half_yearly", - "daily", - "fixed", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "pay_period": { - "description": "The time period over which the pay rate is calculated", - "example": "monthly", - "properties": { - "value": { - "enum": [ - "hour", - "day", - "week", - "every_two_weeks", - "month", - "quarter", - "every_six_months", - "year", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "pay_rate": { - "description": "The amount of compensation for the employee", - "example": "40.00", - "type": "string", - }, - "payroll_code": { - "description": "The payroll code of the employee", - "example": "PC1", - "type": "string", - }, - "type": { - "description": "The type of employment", - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "label": { - "description": "The label of the employment type", - "example": "Permanent", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "type": { - "description": "The type of employment (e.g., contractor, permanent)", - "example": "permanent", - "properties": { - "value": { - "enum": [ - "contractor", - "intern", - "permanent", - "apprentice", - "freelance", - "terminated", - "temporary", - "seasonal", - "volunteer", - "probation", - "internal", - "external", - "expatriate", - "employer_of_record", - "casual", - "Programme", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - }, - "type": "object", - }, - "unified_custom_fields": { - "additionalProperties": true, - "description": "Custom Unified Fields configured in your StackOne project", - "example": { - "my_project_custom_field_1": "REF-1236", - "my_project_custom_field_2": "some other value", - }, - "type": "object", - }, - "work_time": { - "properties": { - "duration": { - "description": "The work time duration in ISO 8601 duration format", - "example": "P0Y0M0DT8H0M0S", - "format": "duration", - "type": "string", - }, - "period": { - "description": "The period of the work time", - "example": "month", - "properties": { - "value": { - "description": "The unified value for the period.", - "enum": [ - "day", - "week", - "month", - "year", - "unmapped_value", - null, - ], - "example": "month", - "type": "string", - }, - }, - "type": "object", - }, - }, - "type": "object", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "POST", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "body", - "name": "unified_custom_fields", - "type": "object", - }, - { - "location": "body", - "name": "job_title", - "type": "string", - }, - { - "location": "body", - "name": "pay_rate", - "type": "string", - }, - { - "location": "body", - "name": "pay_period", - "type": "object", - }, - { - "location": "body", - "name": "pay_frequency", - "type": "object", - }, - { - "location": "body", - "name": "pay_currency", - "type": "string", - }, - { - "location": "body", - "name": "effective_date", - "type": "string", - }, - { - "location": "body", - "name": "end_date", - "type": "string", - }, - { - "location": "body", - "name": "grade", - "type": "object", - }, - { - "location": "body", - "name": "type", - "type": "object", - }, - { - "location": "body", - "name": "contract_type", - "type": "object", - }, - { - "location": "body", - "name": "work_time", - "type": "object", - }, - { - "location": "body", - "name": "payroll_code", - "type": "string", - }, - { - "location": "body", - "name": "job_id", - "type": "string", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/employments", - }, - }, - StackOneTool { - "description": "Get Employee Employment", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/employments/{subResourceId}", - }, - "experimental_preExecute": undefined, - "name": "hris_get_employee_employment", - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "groups", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,job_title,pay_rate,pay_period,pay_frequency,pay_currency,effective_date,end_date,employment_type,employment_contract_type,type,contract_type,change_reason,grade,work_time,payroll_code,fte,created_at,updated_at,start_date,active,department,team,cost_center,cost_centers,division,job,manager,groups,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "subResourceId": { - "type": "string", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/employments/{subResourceId}", - }, - }, - StackOneTool { - "description": "Update Employee Employment", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "PATCH", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "body", - "name": "unified_custom_fields", - "type": "object", - }, - { - "location": "body", - "name": "job_title", - "type": "string", - }, - { - "location": "body", - "name": "pay_rate", - "type": "string", - }, - { - "location": "body", - "name": "pay_period", - "type": "object", - }, - { - "location": "body", - "name": "pay_frequency", - "type": "object", - }, - { - "location": "body", - "name": "pay_currency", - "type": "string", - }, - { - "location": "body", - "name": "effective_date", - "type": "string", - }, - { - "location": "body", - "name": "end_date", - "type": "string", - }, - { - "location": "body", - "name": "grade", - "type": "object", - }, - { - "location": "body", - "name": "type", - "type": "object", - }, - { - "location": "body", - "name": "contract_type", - "type": "object", - }, - { - "location": "body", - "name": "work_time", - "type": "object", - }, - { - "location": "body", - "name": "payroll_code", - "type": "string", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/employments/{subResourceId}", - }, - "experimental_preExecute": undefined, - "name": "hris_update_employee_employment", - "parameters": { - "properties": { - "contract_type": { - "description": "The employment work schedule type", - "properties": { - "contract_type": { - "description": "The employment work schedule type (e.g., full-time, part-time)", - "example": "full_time", - "properties": { - "value": { - "enum": [ - "full_time", - "shifts", - "part_time", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "label": { - "description": "The label of the employment type", - "example": "Full-Time", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - }, - "type": "object", - }, - "effective_date": { - "description": "The effective date of the employment contract", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "type": "string", - }, - "end_date": { - "description": "The end date of employment", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "type": "string", - }, - "grade": { - "description": "Represents the employeeโ€™s position within the organizational hierarchy.", - "properties": { - "description": { - "description": "description of the grade", - "example": "Mid-level employee demonstrating proficiency and autonomy.", - "type": "string", - }, - "id": { - "description": "The reference id", - "example": "1687-3", - "type": "string", - }, - "name": { - "description": "The reference name", - "example": "1687-4", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "job_title": { - "description": "The job title of the employee", - "example": "Software Engineer", - "type": "string", - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe", - }, - "type": "object", - }, - "pay_currency": { - "description": "The currency used for pay", - "example": "USD", - "type": "string", - }, - "pay_frequency": { - "description": "How often the employee is paid", - "example": "hourly", - "properties": { - "value": { - "enum": [ - "hourly", - "weekly", - "bi_weekly", - "four_weekly", - "semi_monthly", - "monthly", - "bi_monthly", - "quarterly", - "semi_annually", - "yearly", - "thirteen_monthly", - "pro_rata", - "unmapped_value", - "half_yearly", - "daily", - "fixed", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "pay_period": { - "description": "The time period over which the pay rate is calculated", - "example": "monthly", - "properties": { - "value": { - "enum": [ - "hour", - "day", - "week", - "every_two_weeks", - "month", - "quarter", - "every_six_months", - "year", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "pay_rate": { - "description": "The amount of compensation for the employee", - "example": "40.00", - "type": "string", - }, - "payroll_code": { - "description": "The payroll code of the employee", - "example": "PC1", - "type": "string", - }, - "subResourceId": { - "type": "string", - }, - "type": { - "description": "The type of employment", - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "label": { - "description": "The label of the employment type", - "example": "Permanent", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "type": { - "description": "The type of employment (e.g., contractor, permanent)", - "example": "permanent", - "properties": { - "value": { - "enum": [ - "contractor", - "intern", - "permanent", - "apprentice", - "freelance", - "terminated", - "temporary", - "seasonal", - "volunteer", - "probation", - "internal", - "external", - "expatriate", - "employer_of_record", - "casual", - "Programme", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - }, - "type": "object", - }, - "unified_custom_fields": { - "additionalProperties": true, - "description": "Custom Unified Fields configured in your StackOne project", - "example": { - "my_project_custom_field_1": "REF-1236", - "my_project_custom_field_2": "some other value", - }, - "type": "object", - }, - "work_time": { - "properties": { - "duration": { - "description": "The work time duration in ISO 8601 duration format", - "example": "P0Y0M0DT8H0M0S", - "format": "duration", - "type": "string", - }, - "period": { - "description": "The period of the work time", - "example": "month", - "properties": { - "value": { - "description": "The unified value for the period.", - "enum": [ - "day", - "week", - "month", - "year", - "unmapped_value", - null, - ], - "example": "month", - "type": "string", - }, - }, - "type": "object", - }, - }, - "type": "object", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "PATCH", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "body", - "name": "unified_custom_fields", - "type": "object", - }, - { - "location": "body", - "name": "job_title", - "type": "string", - }, - { - "location": "body", - "name": "pay_rate", - "type": "string", - }, - { - "location": "body", - "name": "pay_period", - "type": "object", - }, - { - "location": "body", - "name": "pay_frequency", - "type": "object", - }, - { - "location": "body", - "name": "pay_currency", - "type": "string", - }, - { - "location": "body", - "name": "effective_date", - "type": "string", - }, - { - "location": "body", - "name": "end_date", - "type": "string", - }, - { - "location": "body", - "name": "grade", - "type": "object", - }, - { - "location": "body", - "name": "type", - "type": "object", - }, - { - "location": "body", - "name": "contract_type", - "type": "object", - }, - { - "location": "body", - "name": "work_time", - "type": "object", - }, - { - "location": "body", - "name": "payroll_code", - "type": "string", - }, - { - "location": "body", - "name": "passthrough", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/employments/{subResourceId}", - }, - }, - StackOneTool { - "description": "List Groups", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups", - }, - "experimental_preExecute": undefined, - "name": "hris_list_groups", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": undefined, - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups", - }, - }, - StackOneTool { - "description": "List Department Groups", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/departments", - }, - "experimental_preExecute": undefined, - "name": "hris_list_department_groups", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": undefined, - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/departments", - }, - }, - StackOneTool { - "description": "List Cost Center Groups", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/cost_centers", - }, - "experimental_preExecute": undefined, - "name": "hris_list_cost_center_groups", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,distribution_percentage,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": undefined, - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/cost_centers", - }, - }, - StackOneTool { - "description": "List Team Groups", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/teams", - }, - "experimental_preExecute": undefined, - "name": "hris_list_team_groups", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": undefined, - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/teams", - }, - }, - StackOneTool { - "description": "List Division Groups", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/divisions", - }, - "experimental_preExecute": undefined, - "name": "hris_list_division_groups", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": undefined, - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/divisions", - }, - }, - StackOneTool { - "description": "List Companies Groups", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/companies", - }, - "experimental_preExecute": undefined, - "name": "hris_list_companies_groups", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,full_name,display_name,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": undefined, - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/companies", - }, - }, - StackOneTool { - "description": "Get Group", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/{id}", - }, - "experimental_preExecute": undefined, - "name": "hris_get_group", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/{id}", - }, - }, - StackOneTool { - "description": "Get Department Group", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/departments/{id}", - }, - "experimental_preExecute": undefined, - "name": "hris_get_department_group", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/departments/{id}", - }, - }, - StackOneTool { - "description": "Get Cost Center Group", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/cost_centers/{id}", - }, - "experimental_preExecute": undefined, - "name": "hris_get_cost_center_group", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,distribution_percentage,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/cost_centers/{id}", - }, - }, - StackOneTool { - "description": "Get Team Group", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/teams/{id}", - }, - "experimental_preExecute": undefined, - "name": "hris_get_team_group", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/teams/{id}", - }, - }, - StackOneTool { - "description": "Get Division Group", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/divisions/{id}", - }, - "experimental_preExecute": undefined, - "name": "hris_get_division_group", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids,company_id,remote_company_id,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/divisions/{id}", - }, - }, - StackOneTool { - "description": "Get Company Group", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/companies/{id}", - }, - "experimental_preExecute": undefined, - "name": "hris_get_company_group", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,full_name,display_name,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/groups/companies/{id}", - }, - }, - StackOneTool { - "description": "List Jobs", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/jobs", - }, - "experimental_preExecute": undefined, - "name": "hris_list_jobs", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,code,title,description,status,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": undefined, - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/jobs", - }, - }, - StackOneTool { - "description": "Get Job", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/jobs/{id}", - }, - "experimental_preExecute": undefined, - "name": "hris_get_job", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,code,title,description,status,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/jobs/{id}", - }, - }, - StackOneTool { - "description": "List Work Locations", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/locations", - }, - "experimental_preExecute": undefined, - "name": "hris_list_locations", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,name,phone_number,street_1,street_2,city,state,zip_code,country,location_type,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": undefined, - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/locations", - }, - }, - StackOneTool { - "description": "Get Work Location", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/locations/{id}", - }, - "experimental_preExecute": undefined, - "name": "hris_get_location", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,name,phone_number,street_1,street_2,city,state,zip_code,country,location_type,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/locations/{id}", - }, - }, - StackOneTool { - "description": "List Positions", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "status", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/positions", - }, - "experimental_preExecute": undefined, - "name": "hris_list_positions", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields to return in the response (if empty, all fields are returned)", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "status": { - "description": "Filter positions by status", - "enum": [ - "open", - "draft", - "closed", - "paused", - "unmapped_value", - null, - ], - "example": "open", - "type": "string", - }, - "x-account-id": undefined, - }, - "required": undefined, - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "status", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/positions", - }, - }, - StackOneTool { - "description": "Get Position", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/positions/{id}", - }, - "experimental_preExecute": undefined, - "name": "hris_get_position", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields to return in the response (if empty, all fields are returned)", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/positions/{id}", - }, - }, - StackOneTool { - "description": "List Time Entries", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_entries", - }, - "experimental_preExecute": undefined, - "name": "hris_list_time_entries", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,start_time,end_time,hours_worked,break_duration,labor_type,location,status,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "HRIS Time Entries filters", - "properties": { - "employee_id": { - "additionalProperties": false, - "description": "Filter to select time entries by employee_id", - "type": "string", - }, - "end_time": { - "additionalProperties": false, - "description": "Filter to select time entries before a given time", - "example": "2020-01-01T00:00:00.000Z", - "type": "string", - }, - "start_time": { - "additionalProperties": false, - "description": "Filter to select time entries after a given time", - "example": "2020-01-01T00:00:00.000Z", - "type": "string", - }, - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": undefined, - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_entries", - }, - }, - StackOneTool { - "description": "Get Time Entry", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_entries/{id}", - }, - "experimental_preExecute": undefined, - "name": "hris_get_time_entries", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,start_time,end_time,hours_worked,break_duration,labor_type,location,status,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_entries/{id}", - }, - }, - StackOneTool { - "description": "List time off requests", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_off", - }, - "experimental_preExecute": undefined, - "name": "hris_list_time_off_requests", - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "policy", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,time_off_policy_id,remote_time_off_policy_id,reason,comment,duration,created_at,updated_at,policy,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "HRIS Time Off filters", - "properties": { - "end_date": { - "additionalProperties": false, - "description": "Filter to include time off requests that end on or before this date.", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "policy_ids": { - "additionalProperties": false, - "description": "List of time off policy ids to filter by.", - "items": { - "type": "string", - }, - "type": "array", - }, - "start_date": { - "additionalProperties": false, - "description": "Filter to include time off requests that start on or after this date.", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": undefined, - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_off", - }, - }, - StackOneTool { - "description": "Get time off request", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_off/{id}", - }, - "experimental_preExecute": undefined, - "name": "hris_get_time_off_request", - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "policy", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,approver_id,remote_approver_id,status,type,start_date,end_date,start_half_day,end_half_day,time_off_policy_id,remote_time_off_policy_id,reason,comment,duration,created_at,updated_at,policy,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_off/{id}", - }, - }, - StackOneTool { - "description": "List Shifts", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/shifts", - }, - "experimental_preExecute": undefined, - "name": "hris_list_shifts", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields to return in the response (if empty, all fields are returned)", - "type": "string", - }, - "filter": { - "description": "HRIS Shifts filters", - "properties": { - "ends_before": { - "description": "Filter shifts that end before this date", - "example": "2024-01-15T17:00", - "format": "datetime-local", - "type": "string", - }, - "starts_after": { - "description": "Filter shifts that start after this date", - "example": "2024-01-15T09:00", - "format": "datetime-local", - "type": "string", - }, - "status": { - "description": "Filter to select shifts by status", - "enum": [ - "draft", - "published", - "confirmed", - "cancelled", - "unmapped_value", - ], - "type": "string", - }, - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": undefined, - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/shifts", - }, - }, - StackOneTool { - "description": "Get Shift", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/shifts/{id}", - }, - "experimental_preExecute": undefined, - "name": "hris_get_shift", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields to return in the response (if empty, all fields are returned)", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/shifts/{id}", - }, - }, - StackOneTool { - "description": "List time off types", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_off_types", - }, - "experimental_preExecute": undefined, - "name": "hris_list_time_off_types", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,active,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": undefined, - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_off_types", - }, - }, - StackOneTool { - "description": "Get time off type", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_off_types/{id}", - }, - "experimental_preExecute": undefined, - "name": "hris_get_time_off_type", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,active,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_off_types/{id}", - }, - }, - StackOneTool { - "description": "List Time Off Policies", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_off_policies", - }, - "experimental_preExecute": undefined, - "name": "hris_list_time_off_policies", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,description,type,duration_unit,reasons,updated_at,created_at,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "HRIS Time-Off Policies filters", - "properties": { - "type": { - "description": "Filter to select time-off policies by type", - "enum": [ - "sick", - "unmapped_value", - "vacation", - "long_term_disability", - "short_term_disability", - "absent", - "comp_time", - "training", - "annual_leave", - "leave_of_absence", - "break", - "child_care_leave", - "maternity_leave", - "jury_duty", - "sabbatical", - "accident", - "paid", - "unpaid", - "holiday", - "personal", - "in_lieu", - "bereavement", - "other", - null, - ], - "type": "string", - }, - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": undefined, - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_off_policies", - }, - }, - StackOneTool { - "description": "Get Time Off Policy", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_off_policies/{id}", - }, - "experimental_preExecute": undefined, - "name": "hris_get_time_off_policy", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,description,type,duration_unit,reasons,updated_at,created_at,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/time_off_policies/{id}", - }, - }, - StackOneTool { - "description": "List Assigned Time Off Policies", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off_policies", - }, - "experimental_preExecute": undefined, - "name": "hris_list_employee_time_off_policies", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,description,type,duration_unit,reasons,updated_at,created_at,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "HRIS Time-Off Policies filters", - "properties": { - "type": { - "description": "Filter to select time-off policies by type", - "enum": [ - "sick", - "unmapped_value", - "vacation", - "long_term_disability", - "short_term_disability", - "absent", - "comp_time", - "training", - "annual_leave", - "leave_of_absence", - "break", - "child_care_leave", - "maternity_leave", - "jury_duty", - "sabbatical", - "accident", - "paid", - "unpaid", - "holiday", - "personal", - "in_lieu", - "bereavement", - "other", - null, - ], - "type": "string", - }, - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off_policies", - }, - }, - StackOneTool { - "description": "List benefits", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/benefits", - }, - "experimental_preExecute": undefined, - "name": "hris_list_benefits", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,benefit_type,provider,description,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": undefined, - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/benefits", - }, - }, - StackOneTool { - "description": "Get Benefit", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/benefits/{id}", - }, - "experimental_preExecute": undefined, - "name": "hris_get_benefit", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,benefit_type,provider,description,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/benefits/{id}", - }, - }, - StackOneTool { - "description": "List Employee Skills", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/skills", - }, - "experimental_preExecute": undefined, - "name": "hris_list_employee_skills", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,active,language,maximum_proficiency,minimum_proficiency,unified_custom_fields", - "type": "string", - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "updated_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/skills", - }, - }, - StackOneTool { - "description": "Create Employee Skill", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "POST", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "body", - "name": "id", - "type": "string", - }, - { - "location": "body", - "name": "name", - "type": "string", - }, - { - "location": "body", - "name": "maximum_proficiency", - "type": "object", - }, - { - "location": "body", - "name": "minimum_proficiency", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/skills", - }, - "experimental_preExecute": undefined, - "name": "hris_create_employee_skill", - "parameters": { - "properties": { - "id": { - "description": "The ID associated with this skill", - "example": "16873-IT345", - "type": "string", - }, - "maximum_proficiency": { - "description": "The proficiency level of the skill", - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "name": { - "description": "The name associated with this proficiency", - "example": "Expert", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "value": { - "enum": [ - "1", - "2", - "3", - "4", - "5", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "minimum_proficiency": { - "description": "The proficiency level of the skill", - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "name": { - "description": "The name associated with this proficiency", - "example": "Expert", - "type": "string", - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "type": "string", - }, - "value": { - "enum": [ - "1", - "2", - "3", - "4", - "5", - "unmapped_value", - null, - ], - "type": "string", - }, - }, - "type": "object", - }, - "name": { - "description": "The name associated with this skill", - "example": "Information-Technology", - "type": "string", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "POST", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "body", - "name": "id", - "type": "string", - }, - { - "location": "body", - "name": "name", - "type": "string", - }, - { - "location": "body", - "name": "maximum_proficiency", - "type": "object", - }, - { - "location": "body", - "name": "minimum_proficiency", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/skills", - }, - }, - StackOneTool { - "description": "Get Employee Skill", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/skills/{subResourceId}", - }, - "experimental_preExecute": undefined, - "name": "hris_get_employee_skill", - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,name,active,language,maximum_proficiency,minimum_proficiency,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "subResourceId": { - "type": "string", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/skills/{subResourceId}", - }, - }, - StackOneTool { - "description": "List Employee Tasks", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/tasks", - }, - "experimental_preExecute": undefined, - "name": "hris_list_employee_tasks", - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "attachments", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,name,description,type,status,due_date,completion_date,assigned_by_employee_id,remote_assigned_by_employee_id,assigned_by_employee_name,link_to_task,extracted_links,next_task_id,remote_next_task_id,parent_process_name,comments,attachments,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "filter": { - "additionalProperties": false, - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "created_after": { - "description": "Use a string with a date to only select results created after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "updated_after": { - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "id": { - "type": "string", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/tasks", - }, - }, - StackOneTool { - "description": "Get Employee Task", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/tasks/{subResourceId}", - }, - "experimental_preExecute": undefined, - "name": "hris_get_employee_task", - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "attachments", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,name,description,type,status,due_date,completion_date,assigned_by_employee_id,remote_assigned_by_employee_id,assigned_by_employee_name,link_to_task,extracted_links,next_task_id,remote_next_task_id,parent_process_name,comments,attachments,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "subResourceId": { - "type": "string", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/tasks/{subResourceId}", - }, - }, - StackOneTool { - "description": "Update Employee Task", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "PATCH", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "body", - "name": "comment", - "type": "string", - }, - { - "location": "body", - "name": "status", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/tasks/{subResourceId}", - }, - "experimental_preExecute": undefined, - "name": "hris_update_employee_task", - "parameters": { - "properties": { - "comment": { - "description": "Comment or note about the task update", - "example": "All required documents have been submitted", - "type": "string", - }, - "id": { - "type": "string", - }, - "status": { - "default": "completed", - "description": "The status to apply to this Task", - "example": "blocked", - "properties": { - "value": { - "description": "The unified value for the status of the task. If the provider does not specify this status, the value will be set to UnmappedValue", - "enum": [ - "open", - "in_progress", - "blocked", - "completed", - "cancelled", - "unmapped_value", - null, - ], - "example": "open", - "type": "string", - }, - }, - "type": "object", - }, - "subResourceId": { - "type": "string", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - "subResourceId", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "PATCH", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "path", - "name": "subResourceId", - "type": "string", - }, - { - "location": "body", - "name": "comment", - "type": "string", - }, - { - "location": "body", - "name": "status", - "type": "object", - }, - ], - "url": "https://api.stackone.com/unified/hris/employees/{id}/tasks/{subResourceId}", - }, - }, - StackOneTool { - "description": "List Tasks", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/tasks", - }, - "experimental_preExecute": undefined, - "name": "hris_list_tasks", - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "attachments", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,name,description,type,status,due_date,completion_date,assigned_by_employee_id,remote_assigned_by_employee_id,assigned_by_employee_name,link_to_task,extracted_links,next_task_id,remote_next_task_id,parent_process_name,comments,attachments,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "filter": { - "additionalProperties": false, - "description": "Filter parameters that allow greater customisation of the list response", - "properties": { - "created_after": { - "description": "Use a string with a date to only select results created after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - "updated_after": { - "description": "Use a string with a date to only select results updated after that given date", - "example": "2020-01-01T00:00:00.000Z", - "format": "date-time", - "type": "string", - }, - }, - "type": "object", - }, - "next": { - "description": "The unified cursor", - "type": "string", - }, - "page_size": { - "description": "The number of results per page (default value is 25)", - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": undefined, - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "filter", - "type": "object", - }, - { - "location": "query", - "name": "page_size", - "type": "string", - }, - { - "location": "query", - "name": "next", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/tasks", - }, - }, - StackOneTool { - "description": "Get Task", - "executeConfig": { - "bodyType": "json", - "kind": "http", - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/tasks/{id}", - }, - "experimental_preExecute": undefined, - "name": "hris_get_task", - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "attachments", - "type": "string", - }, - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "example": "id,remote_id,employee_id,remote_employee_id,name,description,type,status,due_date,completion_date,assigned_by_employee_id,remote_assigned_by_employee_id,assigned_by_employee_name,link_to_task,extracted_links,next_task_id,remote_next_task_id,parent_process_name,comments,attachments,created_at,updated_at,unified_custom_fields", - "type": "string", - }, - "id": { - "type": "string", - }, - "proxy": { - "additionalProperties": true, - "description": "Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key", - "type": "object", - }, - "raw": { - "description": "Indicates that the raw request result should be returned in addition to the mapped result (default value is false)", - "type": "boolean", - }, - "x-account-id": undefined, - }, - "required": [ - "id", - ], - "type": "object", - }, - "requestBuilder": RequestBuilder { - "bodyType": "json", - "headers": { - "Authorization": "Basic dGVzdF9rZXk6", - }, - "method": "GET", - "params": [ - { - "location": "header", - "name": "x-account-id", - "type": "string", - }, - { - "location": "path", - "name": "id", - "type": "string", - }, - { - "location": "query", - "name": "raw", - "type": "boolean", - }, - { - "location": "query", - "name": "proxy", - "type": "object", - }, - { - "location": "query", - "name": "fields", - "type": "string", - }, - { - "location": "query", - "name": "expand", - "type": "string", - }, - ], - "url": "https://api.stackone.com/unified/hris/tasks/{id}", - }, - }, - ], -} -`; diff --git a/src/toolsets/tests/base.spec.ts b/src/toolsets/tests/base.spec.ts index 2f567799..dc4445ed 100644 --- a/src/toolsets/tests/base.spec.ts +++ b/src/toolsets/tests/base.spec.ts @@ -1,6 +1,4 @@ import { describe, expect, it } from 'bun:test'; -import { BaseTool } from '../../tool'; -import { ParameterLocation } from '../../types'; import { ToolSet } from '../base'; // Create a concrete implementation of the abstract ToolSet class for testing @@ -13,20 +11,15 @@ class TestToolSet extends ToolSet { public matchGlob(str: string, pattern: string): boolean { return this._matchGlob(str, pattern); } - - // Add a tool for testing - public addTool(tool: BaseTool): void { - this.tools.push(tool); - } } describe('ToolSet', () => { - it('should initialize with default values', () => { + it('should initialise with default values', () => { const toolset = new TestToolSet(); expect(toolset).toBeDefined(); }); - it('should initialize with custom values', () => { + it('should initialise with custom values', () => { const baseUrl = 'https://api.example.com'; const headers = { 'X-Custom-Header': 'test' }; @@ -66,74 +59,54 @@ describe('ToolSet', () => { expect(toolset.matchesFilter('hris_get_employee', ['*', '!hris_*'])).toBe(false); }); - it('should get tools with a filter pattern', () => { - const toolset = new TestToolSet(); + describe('Authentication', () => { + it('should set basic auth headers when provided', () => { + const toolset = new TestToolSet({ + authentication: { + type: 'basic', + credentials: { + username: 'testuser', + password: 'testpass', + }, + }, + }); + + // @ts-ignore - Accessing protected properties for testing + const expectedAuthValue = `Basic ${Buffer.from('testuser:testpass').toString('base64')}`; + // @ts-ignore - Accessing protected properties for testing + expect(toolset.headers.Authorization).toBe(expectedAuthValue); + }); - // Create mock tools - const tool1 = new BaseTool( - 'hris_get_employee', - 'Get employee details', - { - type: 'object', - properties: { id: { type: 'string' } }, - }, - { - kind: 'http', - method: 'GET', - url: 'https://api.example.com/hris/employees/{id}', - bodyType: 'json', - params: [ - { - name: 'id', - location: ParameterLocation.PATH, - type: 'string', + it('should set bearer auth headers when provided', () => { + const toolset = new TestToolSet({ + authentication: { + type: 'bearer', + credentials: { + token: 'test-token', }, - ], - } - ); - - const tool2 = new BaseTool( - 'crm_get_contact', - 'Get contact details', - { - type: 'object', - properties: { id: { type: 'string' } }, - }, - { - kind: 'http', - method: 'GET', - url: 'https://api.example.com/crm/contacts/{id}', - bodyType: 'json', - params: [ - { - name: 'id', - location: ParameterLocation.PATH, - type: 'string', + }, + }); + + // @ts-ignore - Accessing protected properties for testing + expect(toolset.headers.Authorization).toBe('Bearer test-token'); + }); + + it('should not override existing Authorization header', () => { + const toolset = new TestToolSet({ + headers: { + Authorization: 'Custom auth', + }, + authentication: { + type: 'basic', + credentials: { + username: 'testuser', + password: 'testpass', }, - ], - } - ); - - // Add tools to the toolset - toolset.addTool(tool1); - toolset.addTool(tool2); - - // Test with no filter (should return all tools) - const allTools = toolset.getTools(); - expect(allTools.length).toBe(2); - - // Test with HRIS filter - const hrisTools = toolset.getTools('hris_*'); - expect(hrisTools.length).toBe(1); - expect(hrisTools.toArray()[0].name).toBe('hris_get_employee'); - - // Test with CRM filter - const crmTools = toolset.getTools('crm_*'); - expect(crmTools.length).toBe(1); - expect(crmTools.toArray()[0].name).toBe('crm_get_contact'); - - // Test with non-matching filter - const nonMatchingTools = toolset.getTools('non_existent_*'); - expect(nonMatchingTools.length).toBe(0); + }, + }); + + // @ts-ignore - Accessing protected properties for testing + expect(toolset.headers.Authorization).toBe('Custom auth'); + }); }); }); diff --git a/src/toolsets/tests/fixtures/petstore.json b/src/toolsets/tests/fixtures/petstore.json deleted file mode 100644 index 84740ded..00000000 --- a/src/toolsets/tests/fixtures/petstore.json +++ /dev/null @@ -1,144 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "title": "Swagger Petstore", - "description": "This is a sample server Petstore server.", - "version": "1.0.0" - }, - "servers": [ - { - "url": "https://petstore.swagger.io/v2" - } - ], - "paths": { - "/pet/{petId}": { - "get": { - "summary": "Find pet by ID", - "description": "Returns a single pet", - "operationId": "getPetById", - "parameters": [ - { - "name": "petId", - "in": "path", - "description": "ID of pet to return", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Pet" - } - } - } - }, - "400": { - "description": "Invalid ID supplied" - }, - "404": { - "description": "Pet not found" - } - } - } - }, - "/pet": { - "post": { - "summary": "Add a new pet to the store", - "description": "Add a new pet to the store", - "operationId": "addPet", - "requestBody": { - "description": "Pet object that needs to be added to the store", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Pet" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Pet" - } - } - } - }, - "405": { - "description": "Invalid input" - } - } - } - } - }, - "components": { - "schemas": { - "Pet": { - "type": "object", - "required": ["name", "photoUrls"], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 10 - }, - "name": { - "type": "string", - "example": "doggie" - }, - "category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "name": { - "type": "string", - "example": "Dogs" - } - } - }, - "photoUrls": { - "type": "array", - "items": { - "type": "string" - } - }, - "tags": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - } - }, - "status": { - "type": "string", - "description": "pet status in the store", - "enum": ["available", "pending", "sold"] - } - } - } - } - } -} diff --git a/src/toolsets/tests/openapi.spec.ts b/src/toolsets/tests/openapi.spec.ts deleted file mode 100644 index 9af7e4a2..00000000 --- a/src/toolsets/tests/openapi.spec.ts +++ /dev/null @@ -1,178 +0,0 @@ -import { afterEach, beforeEach, describe, expect, it, spyOn } from 'bun:test'; -import path from 'node:path'; -import { http, HttpResponse } from 'msw'; -import { server } from '../../../mocks/node.ts'; -import * as OpenAPILoader from '../../openapi/loader'; -import { ParameterLocation } from '../../types'; -import type { AuthenticationConfig } from '../base'; -import { OpenAPIToolSet, type OpenAPIToolSetConfigFromUrl } from '../openapi'; - -describe('OpenAPIToolSet', () => { - const fixturesPath = path.join(import.meta.dir, 'fixtures'); - const petstoreJsonPath = path.join(fixturesPath, 'petstore.json'); - - let loadFromFileSpy: ReturnType; - const recordRequests = () => { - const recordedRequests: Request[] = []; - const listener = ({ request }: { request: Request }) => { - recordedRequests.push(request); - }; - server.events.on('request:start', listener); - return recordedRequests; - }; - - beforeEach(() => { - loadFromFileSpy = spyOn(OpenAPILoader, 'loadFromFile').mockImplementation(() => ({ - pet_findById: { - name: 'pet_findById', - description: 'Find pet by ID', - parameters: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'ID of pet to return', - }, - }, - required: ['id'], - }, - execute: { - kind: 'http', - method: 'GET', - url: 'https://petstore.swagger.io/v2/pet/{id}', - bodyType: 'json', - params: [ - { - name: 'id', - location: ParameterLocation.PATH, - type: 'string', - }, - ], - }, - }, - })); - }); - - afterEach(() => { - loadFromFileSpy.mockRestore(); - server.events.removeAllListeners('request:start'); - }); - - it('should initialize with a file path', () => { - // Create an instance of OpenAPIToolSet - const toolset = new OpenAPIToolSet({ - filePath: petstoreJsonPath, - }); - - // Verify the toolset was initialized - expect(toolset).toBeDefined(); - expect(loadFromFileSpy).toHaveBeenCalledWith(petstoreJsonPath, undefined); - }); - - it('should throw error if neither filePath nor url is provided', () => { - // Attempt to create an instance without filePath or url - expect(() => new OpenAPIToolSet({})).toThrow(); - }); - - it('should throw error if url is provided in constructor instead of fromUrl', () => { - // Attempt to create an instance with url in constructor - expect( - () => - new OpenAPIToolSet({ - // @ts-expect-error - Testing invalid input - url: 'https://example.com/openapi.json', - }) - ).toThrow(); - }); - - it('should create an instance from a URL', async () => { - server.use( - http.get('https://example.com/openapi.json', () => - HttpResponse.json({ - paths: {}, - }) - ) - ); - - const recordedRequests = recordRequests(); - - // Create an instance from a URL - const toolset = await OpenAPIToolSet.fromUrl({ - url: 'https://example.com/openapi.json', - }); - - // Verify the toolset was initialized - expect(toolset).toBeDefined(); - expect(recordedRequests).toHaveLength(1); - expect(recordedRequests[0]?.url).toBe('https://example.com/openapi.json'); - }); - - it('should throw error if URL is not provided to fromUrl', async () => { - // Attempt to create an instance without URL - await expect(OpenAPIToolSet.fromUrl({} as OpenAPIToolSetConfigFromUrl)).rejects.toThrow(); - }); - - it('should set headers on tools', () => { - // Create an instance with headers - const toolset = new OpenAPIToolSet({ - filePath: petstoreJsonPath, - headers: { - 'X-Test-Header': 'test-value', - }, - }); - - // Get the tool - const tool = toolset.getTool('pet_findById'); - - // Verify the header was set - const headers = tool.getHeaders(); - expect(headers).toHaveProperty('X-Test-Header', 'test-value'); - }); - - it('should use basic authentication', () => { - // Create an instance of OpenAPIToolSet with basic auth - const auth: AuthenticationConfig = { - type: 'basic', - credentials: { - username: 'testuser', - password: 'testpass', - }, - }; - - const toolset = new OpenAPIToolSet({ - filePath: petstoreJsonPath, - authentication: auth, - }); - // @ts-expect-error - Accessing protected property for testing - expect(toolset.authentication).toEqual(auth); - - const tool = toolset.getTool('pet_findById'); - const headers = tool.getHeaders(); - - const expectedAuthValue = `Basic ${Buffer.from('testuser:testpass').toString('base64')}`; - expect(headers.Authorization).toBe(expectedAuthValue); - }); - - it('should use bearer authentication', () => { - // Create an instance of OpenAPIToolSet with bearer auth - const auth: AuthenticationConfig = { - type: 'bearer', - credentials: { - token: 'test-token', - }, - }; - - const toolset = new OpenAPIToolSet({ - filePath: petstoreJsonPath, - authentication: auth, - }); - - // @ts-expect-error - Accessing protected property for testing - expect(toolset.authentication).toEqual(auth); - - const tool = toolset.getTool('pet_findById'); - const headers = tool.getHeaders(); - - expect(headers.Authorization).toBe('Bearer test-token'); - }); -}); diff --git a/src/toolsets/tests/stackone.mcp-fetch.spec.ts b/src/toolsets/tests/stackone.mcp-fetch.spec.ts index cb79a72f..60b13e5a 100644 --- a/src/toolsets/tests/stackone.mcp-fetch.spec.ts +++ b/src/toolsets/tests/stackone.mcp-fetch.spec.ts @@ -239,10 +239,12 @@ describe('StackOneToolSet account filtering', () => { }); const tools = await toolset.fetchTools(); - expect(tools.length).toBe(2); + // 2 default tools + 1 feedback tool + expect(tools.length).toBe(3); const toolNames = tools.toArray().map((t) => t.name); expect(toolNames).toContain('default_tool_1'); expect(toolNames).toContain('default_tool_2'); + expect(toolNames).toContain('meta_collect_tool_feedback'); }); it('uses x-account-id header when fetching tools with accountIds', async () => { @@ -260,10 +262,12 @@ describe('StackOneToolSet account filtering', () => { // Fetch tools for acc1 const tools = await toolset.fetchTools({ accountIds: ['acc1'] }); - expect(tools.length).toBe(2); + // 2 acc1 tools + 1 feedback tool + expect(tools.length).toBe(3); const toolNames = tools.toArray().map((t) => t.name); expect(toolNames).toContain('acc1_tool_1'); expect(toolNames).toContain('acc1_tool_2'); + expect(toolNames).toContain('meta_collect_tool_feedback'); }); it('uses setAccounts when no accountIds provided in fetchTools', async () => { @@ -286,13 +290,14 @@ describe('StackOneToolSet account filtering', () => { const tools = await toolset.fetchTools(); // Should fetch tools for 2 accounts from setAccounts - // acc1 has 2 tools, acc2 has 2 tools, so total should be 4 - expect(tools.length).toBe(4); + // acc1 has 2 tools, acc2 has 2 tools, + 1 feedback tool = 5 + expect(tools.length).toBe(5); const toolNames = tools.toArray().map((t) => t.name); expect(toolNames).toContain('acc1_tool_1'); expect(toolNames).toContain('acc1_tool_2'); expect(toolNames).toContain('acc2_tool_1'); expect(toolNames).toContain('acc2_tool_2'); + expect(toolNames).toContain('meta_collect_tool_feedback'); }); it('overrides setAccounts when accountIds provided in fetchTools', async () => { @@ -314,10 +319,11 @@ describe('StackOneToolSet account filtering', () => { // Fetch with accountIds - should override setAccounts const tools = await toolset.fetchTools({ accountIds: ['acc3'] }); - // Should fetch tools only for acc3 (ignoring acc1, acc2) - expect(tools.length).toBe(1); + // Should fetch tools only for acc3 (ignoring acc1, acc2) + 1 feedback tool + expect(tools.length).toBe(2); const toolNames = tools.toArray().map((t) => t.name); expect(toolNames).toContain('acc3_tool_1'); + expect(toolNames).toContain('meta_collect_tool_feedback'); }); }); @@ -386,13 +392,15 @@ describe('StackOneToolSet provider and action filtering', () => { // Filter by providers const tools = await toolset.fetchTools({ providers: ['hibob', 'bamboohr'] }); - expect(tools.length).toBe(4); + // 4 filtered tools + 1 feedback tool + expect(tools.length).toBe(5); const toolNames = tools.toArray().map((t) => t.name); expect(toolNames).toContain('hibob_list_employees'); expect(toolNames).toContain('hibob_create_employees'); expect(toolNames).toContain('bamboohr_list_employees'); expect(toolNames).toContain('bamboohr_get_employee'); expect(toolNames).not.toContain('workday_list_employees'); + expect(toolNames).toContain('meta_collect_tool_feedback'); }); it('filters tools by actions with exact match', async () => { @@ -413,10 +421,12 @@ describe('StackOneToolSet provider and action filtering', () => { actions: ['hibob_list_employees', 'hibob_create_employees'], }); - expect(tools.length).toBe(2); + // 2 filtered tools + 1 feedback tool + expect(tools.length).toBe(3); const toolNames = tools.toArray().map((t) => t.name); expect(toolNames).toContain('hibob_list_employees'); expect(toolNames).toContain('hibob_create_employees'); + expect(toolNames).toContain('meta_collect_tool_feedback'); }); it('filters tools by actions with glob pattern', async () => { @@ -435,13 +445,15 @@ describe('StackOneToolSet provider and action filtering', () => { // Filter by glob pattern const tools = await toolset.fetchTools({ actions: ['*_list_employees'] }); - expect(tools.length).toBe(3); + // 3 filtered tools + 1 feedback tool + expect(tools.length).toBe(4); const toolNames = tools.toArray().map((t) => t.name); expect(toolNames).toContain('hibob_list_employees'); expect(toolNames).toContain('bamboohr_list_employees'); expect(toolNames).toContain('workday_list_employees'); expect(toolNames).not.toContain('hibob_create_employees'); expect(toolNames).not.toContain('bamboohr_get_employee'); + expect(toolNames).toContain('meta_collect_tool_feedback'); }); it('combines accountIds and actions filters', async () => { @@ -494,12 +506,14 @@ describe('StackOneToolSet provider and action filtering', () => { actions: ['*_list_employees'], }); - expect(tools.length).toBe(2); + // 2 filtered tools + 1 feedback tool + expect(tools.length).toBe(3); const toolNames = tools.toArray().map((t) => t.name); expect(toolNames).toContain('hibob_list_employees'); expect(toolNames).toContain('bamboohr_list_employees'); expect(toolNames).not.toContain('hibob_create_employees'); expect(toolNames).not.toContain('bamboohr_get_employee'); + expect(toolNames).toContain('meta_collect_tool_feedback'); server.close(); }); @@ -546,10 +560,11 @@ describe('StackOneToolSet provider and action filtering', () => { actions: ['*_list_*'], }); - // Should only return hibob_list_employees (matches all filters) - expect(tools.length).toBe(1); + // Should only return hibob_list_employees (matches all filters) + 1 feedback tool + expect(tools.length).toBe(2); const toolNames = tools.toArray().map((t) => t.name); expect(toolNames).toContain('hibob_list_employees'); + expect(toolNames).toContain('meta_collect_tool_feedback'); server.close(); }); diff --git a/src/toolsets/tests/stackone.spec.ts b/src/toolsets/tests/stackone.spec.ts index 43fd5d70..7b2b2cbf 100644 --- a/src/toolsets/tests/stackone.spec.ts +++ b/src/toolsets/tests/stackone.spec.ts @@ -1,4 +1,4 @@ -import { describe, expect, it, spyOn } from 'bun:test'; +import { describe, expect, it } from 'bun:test'; import { env } from 'bun'; import { ToolSetConfigError } from '../base'; import { StackOneToolSet } from '../stackone'; @@ -8,17 +8,6 @@ env.STACKONE_API_KEY = 'test_key'; env.STACKONE_ACCOUNT_ID = undefined; describe('StackOneToolSet', () => { - // Snapshot tests - describe('Snapshot Tests', () => { - it('should parse the all the oas files correctly', () => { - const toolset = new StackOneToolSet(); - const hrisTools = toolset.getStackOneTools('hris_*'); - - expect(Object.keys(hrisTools).length).toBeGreaterThan(0); - - expect(hrisTools).toMatchSnapshot(); - }); - }); describe('Authentication Configuration', () => { it('should configure basic auth with API key from constructor', () => { const toolset = new StackOneToolSet({ apiKey: 'custom_key' }); @@ -59,19 +48,6 @@ describe('StackOneToolSet', () => { env.STACKONE_API_KEY = originalKey; }); - it('should properly apply authentication to tools', () => { - const toolset = new StackOneToolSet({ apiKey: 'custom_key' }); - const tools = toolset.getStackOneTools(); - - // Get a tool and check its headers - const tool = tools.getTool('hris_get_employee'); - if (!tool) return; - - const headers = tool.getHeaders(); - const expectedAuthValue = `Basic ${Buffer.from('custom_key:').toString('base64')}`; - expect(headers.Authorization).toBe(expectedAuthValue); - }); - it('should not override custom headers with authentication', () => { const customHeaders = { 'Custom-Header': 'test-value', @@ -87,121 +63,22 @@ describe('StackOneToolSet', () => { expect(toolset.headers).toEqual(customHeaders); }); - it('should properly combine authentication and account ID headers', () => { - const toolset = new StackOneToolSet({ - apiKey: 'custom_key', - accountId: 'test_account', - }); - - const tools = toolset.getStackOneTools(); - const tool = tools.getTool('hris_get_employee'); - if (!tool) return; - - const headers = tool.getHeaders(); - const expectedAuthValue = `Basic ${Buffer.from('custom_key:').toString('base64')}`; - expect(headers.Authorization).toBe(expectedAuthValue); - expect(headers['x-account-id']).toBe('test_account'); - }); - }); - - describe('Authentication Headers', () => { - it('should send correct basic auth header in request', async () => { - const toolset = new StackOneToolSet({ apiKey: 'custom_key' }); - const tools = toolset.getStackOneTools(); - const tool = tools.getTool('hris_get_employee'); - if (!tool) throw new Error('Tool not found'); - - // Use dryRun to check the actual request headers - const request = (await tool.execute({ id: '123' }, { dryRun: true })) as { - headers: Record; - url: string; - method: string; - }; - const expectedAuthValue = `Basic ${Buffer.from('custom_key:').toString('base64')}`; - expect(request.headers.Authorization).toBe(expectedAuthValue); - }); - - it('should send correct account ID header in request', async () => { - const toolset = new StackOneToolSet({ - apiKey: 'custom_key', - accountId: 'test_account', - }); - const tools = toolset.getStackOneTools(); - const tool = tools.getTool('hris_get_employee'); - if (!tool) throw new Error('Tool not found'); - - // Use dryRun to check the actual request headers - const request = (await tool.execute({ id: '123' }, { dryRun: true })) as { - headers: Record; - url: string; - method: string; - }; - expect(request.headers['x-account-id']).toBe('test_account'); - }); - - it('should override account ID in request when provided to getStackOneTools', async () => { - const toolset = new StackOneToolSet({ - apiKey: 'custom_key', - accountId: 'default_account', - }); - const tools = toolset.getStackOneTools(undefined, 'override_account'); - const tool = tools.getTool('hris_get_employee'); - if (!tool) throw new Error('Tool not found'); - - // Use dryRun to check the actual request headers - const request = (await tool.execute({ id: '123' }, { dryRun: true })) as { - headers: Record; - url: string; - method: string; - }; - expect(request.headers['x-account-id']).toBe('override_account'); - }); - - it('should respect custom headers while maintaining auth headers', async () => { - const customHeaders = { - 'Custom-Header': 'test-value', - }; - + it('should combine authentication and account ID headers', () => { const toolset = new StackOneToolSet({ apiKey: 'custom_key', accountId: 'test_account', - headers: customHeaders, }); - const tools = toolset.getStackOneTools(); - const tool = tools.getTool('hris_get_employee'); - if (!tool) throw new Error('Tool not found'); - - // Use dryRun to check the actual request headers - const request = (await tool.execute({ id: '123' }, { dryRun: true })) as { - headers: Record; - url: string; - method: string; - }; + // @ts-expect-error - Accessing protected property for testing const expectedAuthValue = `Basic ${Buffer.from('custom_key:').toString('base64')}`; - - expect(request.headers.Authorization).toBe(expectedAuthValue); - expect(request.headers['x-account-id']).toBe('test_account'); - expect(request.headers['Custom-Header']).toBe('test-value'); - }); - - it('should not send account ID header if not provided', async () => { - const toolset = new StackOneToolSet({ apiKey: 'custom_key' }); - const tools = toolset.getStackOneTools(); - const tool = tools.getTool('hris_get_employee'); - if (!tool) throw new Error('Tool not found'); - - // Use dryRun to check the actual request headers - const request = (await tool.execute({ id: '123' }, { dryRun: true })) as { - headers: Record; - url: string; - method: string; - }; - expect(request.headers['x-account-id']).toBeUndefined(); + // @ts-expect-error - Accessing protected property for testing + expect(toolset.headers.Authorization).toBe(expectedAuthValue); + // @ts-expect-error - Accessing protected property for testing + expect(toolset.headers['x-account-id']).toBe('test_account'); }); }); - it('should initialize with API key from constructor', () => { + it('should initialise with API key from constructor', () => { const toolset = new StackOneToolSet({ apiKey: 'custom_key' }); expect(toolset).toBeDefined(); @@ -209,7 +86,7 @@ describe('StackOneToolSet', () => { expect(toolset.authentication?.credentials?.username).toBe('custom_key'); }); - it('should initialize with API key from environment', () => { + it('should initialise with API key from environment', () => { const toolset = new StackOneToolSet(); expect(toolset).toBeDefined(); @@ -230,41 +107,29 @@ describe('StackOneToolSet', () => { accountId: 'test_account', }); - // Verify account ID is stored in the instance - // @ts-expect-error - Accessing private property for testing - expect(toolset.accountId).toBe('test_account'); - - // The account ID should be applied when getting tools - // We can't directly check headers here, but we can verify the account ID is used - // when calling getTools - const getToolsSpy = spyOn(toolset, 'getTools'); - toolset.getStackOneTools(); - expect(getToolsSpy).toHaveBeenCalledWith(undefined, { 'x-account-id': 'test_account' }); + // Verify account ID is stored in the headers + // @ts-expect-error - Accessing protected property for testing + expect(toolset.headers['x-account-id']).toBe('test_account'); }); - it('should get tools with account ID override', () => { + it('should allow setting account IDs via setAccounts', () => { const toolset = new StackOneToolSet({ apiKey: 'custom_key' }); - // Mock the getTools method - const getToolsSpy = spyOn(toolset, 'getTools'); - - // Call getStackOneTools with account ID - toolset.getStackOneTools('hris_*', 'override_account'); + const result = toolset.setAccounts(['account-1', 'account-2']); - // Verify getTools was called with the correct parameters - expect(getToolsSpy).toHaveBeenCalledWith('hris_*', { 'x-account-id': 'override_account' }); + // Should return this for chaining + expect(result).toBe(toolset); + // @ts-expect-error - Accessing private property for testing + expect(toolset.accountIds).toEqual(['account-1', 'account-2']); }); - it('should get tools without account ID if not provided', () => { - const toolset = new StackOneToolSet({ apiKey: 'custom_key' }); - - // Mock the getTools method - const getToolsSpy = spyOn(toolset, 'getTools'); - - // Call getStackOneTools without account ID - toolset.getStackOneTools('hris_*'); + it('should set baseUrl from config', () => { + const toolset = new StackOneToolSet({ + apiKey: 'custom_key', + baseUrl: 'https://api.example.com', + }); - // Verify getTools was called with the correct parameters - expect(getToolsSpy).toHaveBeenCalledWith('hris_*', {}); + // @ts-expect-error - Accessing protected property for testing + expect(toolset.baseUrl).toBe('https://api.example.com'); }); }); diff --git a/tsdown.config.ts b/tsdown.config.ts index e09cdf20..2825633d 100644 --- a/tsdown.config.ts +++ b/tsdown.config.ts @@ -1,4 +1,4 @@ -import { $, env } from 'bun'; +import { env } from 'bun'; import { defineConfig } from 'tsdown'; export default defineConfig({ @@ -18,10 +18,4 @@ export default defineConfig({ exports: { devExports: !env.RELEASE, }, - hooks: { - 'build:done': async () => { - // sourcemap files for generated code are not needed - await $`rm -rf ./dist/openapi/generated/*.map`; - }, - }, });