diff --git a/.cursor/rules/no-relative-imports.mdc b/.cursor/rules/no-relative-imports.mdc index b361b74..0d4d132 100644 --- a/.cursor/rules/no-relative-imports.mdc +++ b/.cursor/rules/no-relative-imports.mdc @@ -24,12 +24,12 @@ actions: 1. Always use absolute imports: ```python # Good - from stackone_ai.tools import ToolDefinition - from stackone_ai.constants import OAS_DIR - + from stackone_ai.models import ToolDefinition + from stackone_ai.constants import DEFAULT_HYBRID_ALPHA + # Bad - from .tools import ToolDefinition - from ..constants import OAS_DIR + from .models import ToolDefinition + from ..constants import DEFAULT_HYBRID_ALPHA ``` 2. Guidelines: @@ -40,12 +40,12 @@ actions: examples: - input: | # Bad: Using relative imports - from .tools import ToolDefinition - from ..constants import OAS_DIR + from .models import ToolDefinition + from ..constants import DEFAULT_HYBRID_ALPHA # Good: Using absolute imports - from stackone_ai.tools import ToolDefinition - from stackone_ai.constants import OAS_DIR + from stackone_ai.models import ToolDefinition + from stackone_ai.constants import DEFAULT_HYBRID_ALPHA output: "Correctly formatted absolute imports" metadata: diff --git a/CLAUDE.md b/CLAUDE.md index 1bf16e7..778f133 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -44,7 +44,7 @@ make mcp-inspector # Run MCP server inspector for debugging 1. **StackOneToolSet** (`stackone_ai/toolset.py`): Main entry point - Handles authentication (API key + optional account ID) - - Manages tool loading with glob pattern filtering + - Fetches tools dynamically via MCP endpoint - Provides format converters for OpenAI/LangChain 2. **Models** (`stackone_ai/models.py`): Data structures @@ -52,26 +52,21 @@ make mcp-inspector # Run MCP server inspector for debugging - `Tools`: Container for managing multiple tools - Format converters for different AI frameworks -3. **OpenAPI Parser** (`stackone_ai/specs/parser.py`): Spec conversion - - Converts OpenAPI specs to tool definitions - - Handles file upload detection (`format: binary` → `type: file`) - - Resolves schema references - -4. **MCP Server** (`stackone_ai/server.py`): Protocol implementation +3. **MCP Server** (`stackone_ai/server.py`): Protocol implementation - Async tool execution - CLI interface via `stackmcp` command -### OpenAPI Specifications - -All tool definitions are generated from OpenAPI specs in `stackone_ai/oas/`: -- `core.json`, `ats.json`, `crm.json`, `documents.json`, `hris.json`, `iam.json`, `lms.json`, `marketing.json` - ## Key Development Patterns -### Tool Filtering +### Tool Fetching ```python -# Use glob patterns for tool selection -tools = StackOneToolSet(include_tools=["hris_*", "!hris_create_*"]) +# Fetch tools dynamically from MCP endpoint +toolset = StackOneToolSet(api_key="your-api-key") +tools = toolset.fetch_tools( + account_ids=["account-1"], + providers=["hibob"], + actions=["*_list_*"] +) ``` ### Authentication @@ -89,7 +84,6 @@ toolset = StackOneToolSet( - Use generics for better IDE support ### Testing -- Snapshot testing for tool parsing (`tests/snapshots/`) - Async tests use `pytest-asyncio` - Example validation: See @./.cursor/rules/examples-standards @@ -99,20 +93,13 @@ toolset = StackOneToolSet( 2. **Pre-commit**: Hooks configured for ruff and mypy - run on all commits 3. **Python Version**: Requires Python >=3.11 4. **Error Handling**: Custom exceptions (`StackOneError`, `StackOneAPIError`) -5. **File Uploads**: Binary parameters auto-detected from OpenAPI specs -6. **Context Window**: Tool loading warns when loading all tools (large context) ## Common Tasks -### Adding New SaaS Integration -1. Add OpenAPI spec to `stackone_ai/oas/` -2. Parser automatically converts to tool definitions -3. Test with `make test-tools` - ### Modifying Tool Behavior - Core execution logic in `StackOneTool.execute()` method - HTTP configuration via `ExecuteConfig` class -- Response handling in `_process_response()` +- RPC tool execution via `_StackOneRpcTool` class ### Updating Documentation - Examples requirements: See @./.cursor/rules/examples-standards diff --git a/scripts/pull_oas.py b/scripts/pull_oas.py deleted file mode 100644 index 7d57e80..0000000 --- a/scripts/pull_oas.py +++ /dev/null @@ -1,89 +0,0 @@ -# /// script -# requires-python = ">=3.8" -# dependencies = [ -# "httpx", -# "pyyaml", -# "requests", -# "beautifulsoup4" -# ] -# /// - -import asyncio -import json -from pathlib import Path - -import httpx -import requests -import yaml -from bs4 import BeautifulSoup - -STACKONE_DOCS_BASE = "https://docs.stackone.com" -STACKONE_DOCS_URL = f"{STACKONE_DOCS_BASE}/openapi" -OAS_DIR = Path("stackone_ai/oas") - - -def get_api_specs() -> dict[str, str]: - """Scrape OpenAPI spec URLs and their IDs from the documentation page""" - response = requests.get(STACKONE_DOCS_URL) - response.raise_for_status() - - soup = BeautifulSoup(response.text, "html.parser") - - specs = {} - for a in soup.find_all("a", href=True): - href = a["href"] - if href.startswith("/openapi/"): - # Extract the ID and name from the link - spec_id = href.split("/")[-1] - # Parse the name from the link text (e.g., "CRM - v1.0" -> "crm") - name = a.text.split("-")[0].strip().lower() - if name == "stackone": - name = "core" - specs[name] = spec_id - - return specs - - -async def fetch_oas_spec(client: httpx.AsyncClient, spec_id: str) -> dict: - """Fetch OpenAPI spec using its ID""" - url = f"{STACKONE_DOCS_BASE}/openapi/{spec_id}" - response = await client.get(url) - response.raise_for_status() - - # Try both JSON and YAML parsing since specs can be in either format - try: - return response.json() - except json.JSONDecodeError: - return yaml.safe_load(response.text) - - -async def main() -> None: - # Create output directory if it doesn't exist - OAS_DIR.mkdir(parents=True, exist_ok=True) - - # add .gitignore - (OAS_DIR / ".gitignore").write_text("*") - - # Get specs and their IDs from the documentation page - specs = get_api_specs() - print(f"Found {len(specs)} API specs to download:") - for name, spec_id in specs.items(): - print(f" - {name} ({spec_id})") - - async with httpx.AsyncClient() as client: - for name, spec_id in specs.items(): - try: - spec = await fetch_oas_spec(client, spec_id) - - # Save only as JSON since we're bundling with package - json_path = OAS_DIR / f"{name}.json" - json_path.write_text(json.dumps(spec, indent=2)) - - print(f"✓ Downloaded {name} spec") - - except Exception as e: - print(f"✗ Failed to download {name} spec: {str(e)}") - - -if __name__ == "__main__": - asyncio.run(main()) diff --git a/stackone_ai/constants.py b/stackone_ai/constants.py index 30a6ee0..a33428d 100644 --- a/stackone_ai/constants.py +++ b/stackone_ai/constants.py @@ -1,9 +1,3 @@ -import importlib.resources -from pathlib import Path - -# Use bundled specs directly -OAS_DIR = Path(str(importlib.resources.files("stackone_ai") / "oas")) - # Hybrid search default weight for BM25 vs TF-IDF # alpha=0.2 means: 20% BM25 + 80% TF-IDF # This value was optimized through validation testing and provides diff --git a/stackone_ai/oas/ats.json b/stackone_ai/oas/ats.json deleted file mode 100644 index 0fb432a..0000000 --- a/stackone_ai/oas/ats.json +++ /dev/null @@ -1,18632 +0,0 @@ -{ - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,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", - "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", - "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", - "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 stage and sub-stage", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,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", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Update an 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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,status,offer_status,salary,currency,created_at,updated_at,offer_history", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "List Application Offers", - "tags": [ - "Applications" - ], - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,status,offer_status,salary,currency,created_at,updated_at,offer_history", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Get Application Offer", - "tags": [ - "Applications" - ], - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "List Application Scorecards", - "tags": [ - "Applications" - ], - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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}/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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "List Application Notes", - "tags": [ - "Applications" - ], - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Create Application Note", - "tags": [ - "Applications" - ], - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Get Application Note", - "tags": [ - "Applications" - ], - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Update an Application Note", - "tags": [ - "Applications" - ], - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "List Applications scheduled interviews", - "tags": [ - "Applications" - ], - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,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", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Get Applications scheduled interview", - "tags": [ - "Applications" - ], - "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/UnifiedUploadRequestDto" - } - } - } - }, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Upload Application Document", - "tags": [ - "Applications" - ], - "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" - } - } - ], - "responses": { - "200": { - "description": "The document related to the application with the given identifiers was retrieved.", - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Download Application Document", - "tags": [ - "Applications" - ], - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,path,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "List Application Documents", - "tags": [ - "Applications" - ], - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,path,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Get Application Document", - "tags": [ - "Applications" - ], - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,created_at,updated_at", - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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": { - "200": { - "description": "The candidate was successfully created.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateResult" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,created_at,updated_at", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "List Candidate Notes", - "tags": [ - "Candidates" - ], - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Create Candidate Note", - "tags": [ - "Candidates" - ], - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Get Candidate Note", - "tags": [ - "Candidates" - ], - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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": "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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": "string" - } - } - ], - "responses": { - "200": { - "description": "The department with the given identifier was retrieved.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DepartmentResult" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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": { - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "List Interview Stages", - "tags": [ - "Interview 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": { - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Get Interview Stage", - "tags": [ - "Interview Stages" - ], - "x-speakeasy-group": "ats", - "x-speakeasy-name-override": "get_interview_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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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/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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,status,job_status,department_ids,remote_department_ids,location_ids,remote_location_ids,hiring_team,interview_stages,confidential,custom_fields,created_at,updated_at", - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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/JobsPaginated" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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": { - "200": { - "description": "The job was successfully created.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateResult" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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}": { - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,status,job_status,department_ids,remote_department_ids,location_ids,remote_location_ids,hiring_team,interview_stages,confidential,custom_fields,created_at,updated_at", - "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/JobResult" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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/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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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": "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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": "string" - } - } - ], - "responses": { - "200": { - "description": "The location with the given identifier was retrieved.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ATSLocationResult" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,updated_at,created_at", - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,updated_at,created_at", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,status,offer_status,salary,currency,created_at,updated_at,offer_history", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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": { - "200": { - "description": "The offer was created successfully.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateResult" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Creates an 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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,status,offer_status,salary,currency,created_at,updated_at,offer_history", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "List Assessments Packages", - "tags": [ - "Assessments" - ], - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Get Assessments Package", - "tags": [ - "Assessments" - ], - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Order Assessments Request", - "tags": [ - "Assessments" - ], - "x-speakeasy-group": "ats", - "x-speakeasy-name-override": "order_assessments_request", - "x-speakeasy-retries": { - "statusCodes": [ - 429, - 408 - ], - "strategy": "backoff" - } - } - }, - "/unified/ats/assessments/orders/{id}": { - "get": { - "operationId": "ats_get_assessments_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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,package,application,job,candidate,requester,results_update_url", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The assessments order with the given identifier was retrieved.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AssessmentOrderResult" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Get Assessments Requests", - "tags": [ - "Assessments" - ], - "x-speakeasy-group": "ats", - "x-speakeasy-name-override": "get_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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Update Assessments Result", - "tags": [ - "Assessments" - ], - "x-speakeasy-group": "ats", - "x-speakeasy-name-override": "update_assessments_result", - "x-speakeasy-retries": { - "statusCodes": [ - 429, - 408 - ], - "strategy": "backoff" - } - } - }, - "/unified/ats/assessments/orders/{id}/results": { - "get": { - "operationId": "ats_get_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" - } - }, - { - "name": "raw", - "required": false, - "in": "query", - "description": "Indicates that the raw request result is returned", - "schema": { - "nullable": true, - "default": false, - "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,score,start_date,submission_date,summary,result,result_url,attachments", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The assessments result with the given identifier was retrieved.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AssessmentResultsResult" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Get Assessments Results", - "tags": [ - "Assessments" - ], - "x-speakeasy-group": "ats", - "x-speakeasy-name-override": "get_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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "List Background Check Packages", - "tags": [ - "Background Checks" - ], - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Create Background Check Package", - "tags": [ - "Background Checks" - ], - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Get Background Check Package", - "tags": [ - "Background Checks" - ], - "x-speakeasy-group": "ats", - "x-speakeasy-name-override": "get_background_check_package", - "x-speakeasy-retries": { - "statusCodes": [ - 429, - 408 - ], - "strategy": "backoff" - } - } - }, - "/unified/ats/background_checks/orders": { - "get": { - "operationId": "ats_list_background_check_request", - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,package,application,job,candidate,requester,results_update_url", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "nullable": true, - "example": "2020-01-01T00:00:00.000Z", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The list of background check requests was retrieved.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BackgroundCheckOrderPaginated" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "List Background Check Request", - "tags": [ - "Background Checks" - ], - "x-speakeasy-group": "ats", - "x-speakeasy-name-override": "list_background_check_request", - "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_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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Order Background Check Request", - "tags": [ - "Background Checks" - ], - "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}": { - "get": { - "operationId": "ats_get_background_check_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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,package,application,job,candidate,requester,results_update_url", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The background check order with the given identifier was retrieved.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BackgroundCheckOrderResult" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Get Background Check Request", - "tags": [ - "Background Checks" - ], - "x-speakeasy-group": "ats", - "x-speakeasy-name-override": "get_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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Update Background Check Result", - "tags": [ - "Background Checks" - ], - "x-speakeasy-group": "ats", - "x-speakeasy-name-override": "update_background_check_result", - "x-speakeasy-retries": { - "statusCodes": [ - 429, - 408 - ], - "strategy": "backoff" - } - } - }, - "/unified/ats/background_checks/orders/{id}/results": { - "get": { - "operationId": "ats_get_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" - } - }, - { - "name": "raw", - "required": false, - "in": "query", - "description": "Indicates that the raw request result is returned", - "schema": { - "nullable": true, - "default": false, - "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,score,start_date,submission_date,summary,result,result_url,attachments", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The background check result with the given identifier was retrieved.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BackgroundCheckResultsResult" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Get Background Check Results", - "tags": [ - "Background Checks" - ], - "x-speakeasy-group": "ats", - "x-speakeasy-name-override": "get_background_check_result", - "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": "Applications", - "description": "" - }, - { - "name": "Assessments", - "description": "" - }, - { - "name": "Background Checks", - "description": "" - }, - { - "name": "Candidates", - "description": "" - }, - { - "name": "Custom Field Definitions", - "description": "" - }, - { - "name": "Departments", - "description": "" - }, - { - "name": "Interview Stages", - "description": "" - }, - { - "name": "Interviews", - "description": "" - }, - { - "name": "Job Postings", - "description": "" - }, - { - "name": "Jobs", - "description": "" - }, - { - "name": "Lists", - "description": "" - }, - { - "name": "Locations", - "description": "" - }, - { - "name": "Offers", - "description": "" - }, - { - "name": "Rejected Reasons", - "description": "" - }, - { - "name": "Users", - "description": "" - } - ], - "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", - 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": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/InterviewStage" - } - ] - }, - "interview_stage_id": { - "type": "string", - "description": "Unique identifier of the interview stage", - "example": "18bcbb1b-3cbc-4198-a999-460861d19480", - "nullable": true - }, - "remote_interview_stage_id": { - "type": "string", - "description": "Provider's unique identifier of the interview 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", - "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 - } - } - }, - "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" - ] - }, - "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 - } - } - }, - "AssessmentOrder": { - "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 - }, - "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 - } - } - }, - "AssessmentOrderResult": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AssessmentOrder" - }, - "raw": { - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/RawResponse" - } - } - }, - "required": [ - "data" - ] - }, - "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" - ] - }, - "AssessmentResult": { - "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 - }, - "candidate": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/ResultCandidateApiModel" - } - ] - }, - "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" - } - } - } - }, - "AssessmentResultsResult": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AssessmentResult" - }, - "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", - 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" - } - ] - } - } - }, - "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", - "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 - }, - "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 - }, - "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/JobStatusEnum" - } - ] - }, - "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/JobHiringTeam" - } - }, - "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", - 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 - }, - "path": { - "type": "string", - "description": "The path where the file is stored", - "example": "/path/to/file", - "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" - ] - }, - "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 - } - } - }, - "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" - } - ] - } - } - }, - "AtsUpdateBackgroundCheckResultRequestDto": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true - }, - "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": { - "id": { - "type": "string", - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true - }, - "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 - }, - "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/JobStatusEnum" - } - ] - }, - "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/JobHiringTeam" - } - }, - "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", - 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", - "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 - } - } - }, - "BackgroundCheckOrder": { - "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" - } - ] - } - } - }, - "BackgroundCheckOrderPaginated": { - "type": "object", - "properties": { - "next_page": { - "type": "string", - "deprecated": true, - "nullable": true - }, - "next": { - "type": "string", - "nullable": true - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/BackgroundCheckOrder" - } - }, - "raw": { - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/RawResponse" - } - } - }, - "required": [ - "data" - ] - }, - "BackgroundCheckOrderResult": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/BackgroundCheckOrder" - }, - "raw": { - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/RawResponse" - } - } - }, - "required": [ - "data" - ] - }, - "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" - ] - }, - "BackgroundCheckResult": { - "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 - }, - "candidate": { - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/ResultCandidateApiModel" - } - ] - }, - "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" - } - } - } - }, - "BackgroundCheckResultsResult": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/BackgroundCheckResult" - }, - "raw": { - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/RawResponse" - } - } - }, - "required": [ - "data" - ] - }, - "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" - } - }, - "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" - ] - }, - "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", - 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", - 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 - } - } - }, - "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", - "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 - }, - "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": [ - "Not Started", - "In Progress", - "Completed", - "Overdue" - ], - "nullable": true, - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "type": "array", - "items": {} - } - ] - } - } - } - }, - "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" - ] - }, - "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": {} - } - ], - "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", - null - ], - "x-speakeasy-unknown-values": "allow", - "nullable": true - }, - "source_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "type": "array", - "items": {} - } - ], - "nullable": true - } - } - }, - "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" - ] - }, - "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": "abc", - "nullable": true - } - } - }, - "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 - } - } - }, - "Job": { - "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 - }, - "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/JobStatusEnum" - } - ] - }, - "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/JobHiringTeam" - } - }, - "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", - 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 - } - } - }, - "JobHiringTeam": { - "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 - } - } - }, - "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", - 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_posting_id": { - "type": "string", - "description": "Provider's unique identifier of the job posting", - "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": [ - { - "name": "Base Salary", - "type": "salary", - "pay_period": "month", - "pay_frequency": "yearly", - "currency": "USD", - "value": "50000", - "min_value": "45000", - "max_value": "55000" - }, - { - "name": "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 favorite 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" - } - }, - "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": { - "name": { - "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": { - "type": "string", - "nullable": true - }, - "max_value": { - "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 - } - } - }, - "JobResult": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Job" - }, - "raw": { - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/RawResponse" - } - } - }, - "required": [ - "data" - ] - }, - "JobsPaginated": { - "type": "object", - "properties": { - "next_page": { - "type": "string", - "deprecated": true, - "nullable": true - }, - "next": { - "type": "string", - "nullable": true - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Job" - } - }, - "raw": { - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/RawResponse" - } - } - }, - "required": [ - "data" - ] - }, - "JobStatusEnum": { - "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 - } - } - }, - "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", - 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 - } - } - }, - "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/JobHiringTeam" - } - }, - "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", - null - ], - "x-speakeasy-unknown-values": "allow", - "nullable": true - }, - "phone": { - "type": "string", - "description": "Phone number string", - "example": "+447700112233", - "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", - 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": { - "type": "string", - "nullable": true - }, - "response": { - "type": "object", - "additionalProperties": true, - "nullable": true - } - }, - "required": [ - "method", - "url" - ] - }, - "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 - } - } - }, - "ResultCandidateApiModel": { - "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 - }, - "profile_url": { - "type": "string", - "description": "Candidate profile url", - "example": "https://exmaple.com/candidate?id=xyz", - "nullable": true - } - } - }, - "ResultEnum": { - "type": "object", - "properties": { - "value": { - "type": "string", - "enum": [ - "cancelled", - "completed", - "expired", - "failed", - "passed", - 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.000Z", - "format": "date-time", - "nullable": true - }, - "updated_at": { - "type": "string", - "description": "The update date of the scorecard", - "example": "2021-01-01T00: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 - } - } - }, - "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 - } - } - }, - "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" - } - } - } - } - } - }, - "x-readme": { - "explorer-enabled": true, - "proxy-enabled": true - } -} \ No newline at end of file diff --git a/stackone_ai/oas/core.json b/stackone_ai/oas/core.json deleted file mode 100644 index a6478ce..0000000 --- a/stackone_ai/oas/core.json +++ /dev/null @@ -1,1479 +0,0 @@ -{ - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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": "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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." - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "The account with the given identifier does not exist" - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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." - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "The account with the given identifier does not exist" - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Get meta information of the account", - "tags": [ - "Accounts" - ], - "x-speakeasy-name-override": "get_account_meta_info", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "List Connectors Meta Information for all providers", - "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." - }, - "403": { - "description": "Forbidden." - }, - "404": { - "description": "No connector with the given provider key exist" - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Get Connector Meta information for the given provider key", - "tags": [ - "Connectors" - ], - "x-speakeasy-name-override": "get_connector_meta", - "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." - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Proxy Request", - "tags": [ - "Proxy" - ], - "x-speakeasy-name-override": "proxy_request", - "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": "AI", - "description": "" - }, - { - "name": "Accounts", - "description": "" - }, - { - "name": "Connect Sessions", - "description": "" - }, - { - "name": "Connectors", - "description": "" - }, - { - "name": "Proxy", - "description": "" - } - ], - "servers": [ - { - "url": "https://api.stackone.com" - } - ], - "components": { - "securitySchemes": { - "basic": { - "type": "http", - "scheme": "basic" - } - }, - "schemas": { - "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" - ], - "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" - ], - "x-speakeasy-unknown-values": "allow", - "nullable": true, - "items": { - "type": "string", - "enum": [ - "ats", - "hris", - "hris-legacy", - "crm", - "iam", - "marketing", - "lms", - "stackone", - "documents", - 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" - } - }, - "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" - ], - "x-speakeasy-unknown-values": "allow", - "nullable": true, - "items": { - "type": "string", - "enum": [ - "ats", - "hris", - "hris-legacy", - "crm", - "iam", - "marketing", - "lms", - "stackone", - "documents", - null - ] - } - }, - "provider": { - "type": "string", - "description": "The provider 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 - } - }, - "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" - ], - "x-speakeasy-unknown-values": "allow", - "nullable": true, - "items": { - "type": "string", - "enum": [ - "ats", - "hris", - "hris-legacy", - "crm", - "iam", - "marketing", - "lms", - "stackone", - "documents", - 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" - }, - "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" - ] - }, - "LinkedAccount": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "provider": { - "type": "string" - }, - "provider_name": { - "type": "string", - "nullable": true - }, - "status": { - "type": "string", - "enum": [ - "active", - "inactive", - "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", - "nullable": true - }, - "label": { - "type": "string", - "nullable": true - }, - "created_at": { - "format": "date-time", - "type": "string" - }, - "updated_at": { - "format": "date-time", - "type": "string" - } - }, - "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" - ], - "x-speakeasy-unknown-values": "allow" - }, - "models": { - "type": "object", - "additionalProperties": true - } - }, - "required": [ - "provider", - "category", - "models" - ] - }, - "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 - } - } - }, - "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", - "x-speakeasy-unknown-values": "allow", - "nullable": true - }, - "path": { - "type": "string", - "description": "The path of the request including any query paramters", - "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 - } - } - }, - "StatusReason": { - "type": "object", - "properties": { - "code": { - "type": "string", - "nullable": true - }, - "description": { - "type": "string", - "nullable": true - }, - "timestamp": { - "format": "date-time", - "type": "string" - } - }, - "required": [ - "timestamp" - ] - } - } - }, - "x-readme": { - "explorer-enabled": true, - "proxy-enabled": true - } -} \ No newline at end of file diff --git a/stackone_ai/oas/crm.json b/stackone_ai/oas/crm.json deleted file mode 100644 index 41c3e6e..0000000 --- a/stackone_ai/oas/crm.json +++ /dev/null @@ -1,2602 +0,0 @@ -{ - "openapi": "3.0.0", - "paths": { - "/unified/crm/contacts": { - "get": { - "operationId": "crm_list_contacts", - "x-speakeasy-group": "crm", - "x-speakeasy-name-override": "list_contacts", - "summary": "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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", - "example": "2020-01-01T00:00:00.000Z", - "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", - "example": "custom_fields", - "schema": { - "nullable": true, - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The list of contacts was retrieved.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ContactsPaginated" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Contacts" - ], - "security": [ - { - "basic": [] - } - ] - }, - "post": { - "operationId": "crm_create_contact", - "x-speakeasy-group": "crm", - "x-speakeasy-name-override": "create_contact", - "summary": "Creates a new 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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Contacts" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/crm/contacts/{id}": { - "get": { - "operationId": "crm_get_contact", - "x-speakeasy-group": "crm", - "x-speakeasy-name-override": "get_contact", - "summary": "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "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", - "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", - "example": "custom_fields", - "schema": { - "nullable": true, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Contacts" - ], - "security": [ - { - "basic": [] - } - ] - }, - "patch": { - "operationId": "crm_update_contact", - "x-speakeasy-group": "crm", - "x-speakeasy-name-override": "update_contact", - "summary": "Update Contact (early access)", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Contacts" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/crm/accounts": { - "get": { - "operationId": "crm_list_accounts", - "x-speakeasy-group": "crm", - "x-speakeasy-name-override": "list_accounts", - "summary": "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "example": "id,remote_id,owner_id,remote_owner_id,name,description,industries,annual_revenue,website,addresses,phone_numbers,created_at,updated_at", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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", - "example": "2020-01-01T00:00:00.000Z", - "deprecated": true, - "schema": { - "nullable": true, - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The list of accounts was retrieved.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AccountsPaginated" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Accounts" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/crm/accounts/{id}": { - "get": { - "operationId": "crm_get_account", - "x-speakeasy-group": "crm", - "x-speakeasy-name-override": "get_account", - "summary": "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "example": "id,remote_id,owner_id,remote_owner_id,name,description,industries,annual_revenue,website,addresses,phone_numbers,created_at,updated_at", - "schema": { - "nullable": true, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Accounts" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/crm/lists": { - "get": { - "operationId": "crm_list_lists", - "x-speakeasy-group": "crm", - "x-speakeasy-name-override": "list_lists", - "summary": "Get all 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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "example": "id,remote_id,name,created_at,updated_at,items,type", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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", - "example": "2020-01-01T00:00:00.000Z", - "deprecated": true, - "schema": { - "nullable": true, - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The collection of lists was retrieved.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ListsPaginated" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Lists" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/crm/lists/{id}": { - "get": { - "operationId": "crm_get_list", - "x-speakeasy-group": "crm", - "x-speakeasy-name-override": "get_list", - "summary": "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "example": "id,remote_id,name,created_at,updated_at,items,type", - "schema": { - "nullable": true, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Lists" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/crm/custom_field_definitions/contacts": { - "get": { - "operationId": "crm_list_contact_custom_field_definitions", - "x-speakeasy-group": "crm", - "x-speakeasy-name-override": "list_contact_custom_field_definitions", - "summary": "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "example": "id,remote_id,name,description,type,options", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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", - "example": "2020-01-01T00:00:00.000Z", - "deprecated": true, - "schema": { - "nullable": true, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Custom Field Definitions" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/crm/custom_field_definitions/contacts/{id}": { - "get": { - "operationId": "crm_get_contact_custom_field_definition", - "x-speakeasy-group": "crm", - "x-speakeasy-name-override": "get_contact_custom_field_definition", - "summary": "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "example": "id,remote_id,name,description,type,options", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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", - "example": "2020-01-01T00:00:00.000Z", - "deprecated": true, - "schema": { - "nullable": true, - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The contact custom field definition was retrieved.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomFieldDefinitionResultApiModel" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Custom Field Definitions" - ], - "security": [ - { - "basic": [] - } - ] - } - } - }, - "info": { - "title": "CRM", - "description": "The documentation for the StackOne Unified API - CRM", - "version": "1.0.0", - "contact": {} - }, - "tags": [ - { - "name": "Accounts", - "description": "" - }, - { - "name": "Contacts", - "description": "" - }, - { - "name": "Custom Field Definitions", - "description": "" - }, - { - "name": "Lists", - "description": "" - } - ], - "servers": [ - { - "url": "https://api.stackone.com" - } - ], - "components": { - "securitySchemes": { - "basic": { - "type": "http", - "scheme": "basic" - } - }, - "schemas": { - "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": {} - } - ], - "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 - } - } - }, - "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 - } - } - }, - "RawResponse": { - "type": "object", - "properties": { - "method": { - "type": "string" - }, - "url": { - "type": "string" - }, - "body": { - "type": "string", - "nullable": true - }, - "response": { - "type": "object", - "additionalProperties": true, - "nullable": true - } - }, - "required": [ - "method", - "url" - ] - }, - "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" - ] - }, - "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 - } - } - }, - "ContactResult": { - "type": "object", - "properties": { - "data": { - "$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", - 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 - } - } - }, - "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 - } - } - }, - "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" - } - ] - } - } - }, - "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 - } - } - }, - "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" - ] - }, - "AccountResult": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Account" - }, - "raw": { - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/RawResponse" - } - } - }, - "required": [ - "data" - ] - }, - "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 - } - } - }, - "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 - } - } - }, - "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" - } - ] - } - } - }, - "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" - ] - }, - "ListResult": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/List" - }, - "raw": { - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/RawResponse" - } - } - }, - "required": [ - "data" - ] - }, - "CustomFieldTypeEnum": { - "type": "object", - "properties": { - "value": { - "type": "string", - "enum": [ - "date", - "float", - "integer", - "list", - "checkbox", - "text", - "boolean", - "single_select", - "multi_select", - "url", - "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 - } - } - }, - "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": [ - "Not Started", - "In Progress", - "Completed", - "Overdue" - ], - "nullable": true, - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "type": "array", - "items": {} - } - ] - } - } - } - }, - "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" - ] - }, - "CustomFieldDefinitionResultApiModel": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomFieldDefinition" - }, - "raw": { - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/RawResponse" - } - } - }, - "required": [ - "data" - ] - } - } - }, - "x-readme": { - "explorer-enabled": true, - "proxy-enabled": true - } -} \ No newline at end of file diff --git a/stackone_ai/oas/documents.json b/stackone_ai/oas/documents.json deleted file mode 100644 index 2335185..0000000 --- a/stackone_ai/oas/documents.json +++ /dev/null @@ -1,2870 +0,0 @@ -{ - "openapi": "3.0.0", - "paths": { - "/unified/documents/files/{id}/download": { - "get": { - "operationId": "documents_download_file", - "x-speakeasy-group": "documents", - "x-speakeasy-name-override": "download_file", - "summary": "Download File", - "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": "format", - "required": false, - "in": "query", - "description": "The format to download the file in", - "example": "base64", - "schema": { - "nullable": true, - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The file with the given identifiers was retrieved.", - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Files" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/documents/files/upload": { - "post": { - "operationId": "documents_upload_file", - "x-speakeasy-group": "documents", - "x-speakeasy-name-override": "upload_file", - "summary": "Upload File", - "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/UnifiedUploadRequestDto" - } - } - } - }, - "responses": { - "201": { - "description": "The file was uploaded.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WriteResultApiModel" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Files" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/documents/files": { - "get": { - "operationId": "documents_list_files", - "x-speakeasy-group": "documents", - "x-speakeasy-name-override": "list_files", - "summary": "List Files", - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "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,created_at,updated_at", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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", - "example": "2020-01-01T00:00:00.000Z", - "deprecated": true, - "schema": { - "nullable": true, - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The list of files was retrieved.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FilesPaginated" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Files" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/documents/files/{id}": { - "get": { - "operationId": "documents_get_file", - "x-speakeasy-group": "documents", - "x-speakeasy-name-override": "get_file", - "summary": "Get File", - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "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,created_at,updated_at", - "schema": { - "nullable": true, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Files" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/documents/folders": { - "get": { - "operationId": "documents_list_folders", - "x-speakeasy-group": "documents", - "x-speakeasy-name-override": "list_folders", - "summary": "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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", - "example": "2020-01-01T00:00:00.000Z", - "deprecated": true, - "schema": { - "nullable": true, - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The list of folders was retrieved.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FoldersPaginated" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Folders" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/documents/folders/{id}": { - "get": { - "operationId": "documents_get_folder", - "x-speakeasy-group": "documents", - "x-speakeasy-name-override": "get_folder", - "summary": "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "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", - "schema": { - "nullable": true, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Folders" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/documents/drives": { - "get": { - "operationId": "documents_list_drives", - "x-speakeasy-group": "documents", - "x-speakeasy-name-override": "list_drives", - "summary": "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "example": "id,remote_id,name,description,url,created_at,updated_at", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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", - "example": "2020-01-01T00:00:00.000Z", - "deprecated": true, - "schema": { - "nullable": true, - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The list of drives was retrieved.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DrivesPaginated" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Drives" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/documents/drives/{id}": { - "get": { - "operationId": "documents_get_drive", - "x-speakeasy-group": "documents", - "x-speakeasy-name-override": "get_drive", - "summary": "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "example": "id,remote_id,name,description,url,created_at,updated_at", - "schema": { - "nullable": true, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Drives" - ], - "security": [ - { - "basic": [] - } - ] - } - } - }, - "info": { - "title": "Documents", - "description": "The documentation for the StackOne Unified API - DOCUMENTS", - "version": "1.0.0", - "contact": {} - }, - "tags": [ - { - "name": "Files", - "description": "" - }, - { - "name": "Folders", - "description": "" - }, - { - "name": "Drives", - "description": "" - } - ], - "servers": [ - { - "url": "https://api.stackone.com" - } - ], - "components": { - "securitySchemes": { - "basic": { - "type": "http", - "scheme": "basic" - } - }, - "schemas": { - "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": "abc", - "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 - } - } - }, - "ConfidentialEnumApiModel": { - "type": "object", - "properties": { - "value": { - "type": "string", - "description": "Whether the file is confidential or not", - "enum": [ - "true", - "false", - 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 - } - } - }, - "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" - } - ] - } - } - }, - "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 - } - } - }, - "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" - } - } - } - }, - "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 - }, - "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 - } - } - }, - "RawResponse": { - "type": "object", - "properties": { - "method": { - "type": "string" - }, - "url": { - "type": "string" - }, - "body": { - "type": "string", - "nullable": true - }, - "response": { - "type": "object", - "additionalProperties": true, - "nullable": true - } - }, - "required": [ - "method", - "url" - ] - }, - "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" - ] - }, - "FileResult": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Files" - }, - "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 - } - } - }, - "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" - ] - }, - "FolderResult": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Folders" - }, - "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" - ] - }, - "DriveResult": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Drives" - }, - "raw": { - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/RawResponse" - } - } - }, - "required": [ - "data" - ] - } - } - }, - "x-readme": { - "explorer-enabled": true, - "proxy-enabled": true - } -} \ No newline at end of file diff --git a/stackone_ai/oas/hris.json b/stackone_ai/oas/hris.json deleted file mode 100644 index 47f2e83..0000000 --- a/stackone_ai/oas/hris.json +++ /dev/null @@ -1,19947 +0,0 @@ -{ - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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-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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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", - "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", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The list of employees was retrieved.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EmployeesPaginated" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Creates an 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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,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", - "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", - "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", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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/UpdateEmployeeApiModel" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Updates an 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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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}/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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,duration,created_at,updated_at", - "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", - "nullable": true, - "additionalProperties": false - }, - "type": { - "description": "List of time off type ids to filter by.", - "nullable": true, - "type": "array", - "items": { - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "nullable": true, - "example": "2020-01-01T00:00:00.000Z", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "List Employee Time Off Requests", - "tags": [ - "Employees" - ], - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Create Employee Time Off Request", - "tags": [ - "Employees" - ], - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,duration,created_at,updated_at", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Get Employees Time Off Request", - "tags": [ - "Employees" - ], - "x-speakeasy-group": "hris", - "x-speakeasy-name-override": "get_employees_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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Batch Upload Employee Document", - "tags": [ - "Employees" - ], - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Upload Employee Document", - "tags": [ - "Employees" - ], - "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" - } - } - ], - "responses": { - "200": { - "description": "The document related to the employee with the given identifiers was retrieved.", - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Download Employee Document", - "tags": [ - "Employees" - ], - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,path,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "List Employee Documents", - "tags": [ - "Employees" - ], - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,path,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Get Employee Document", - "tags": [ - "Employees" - ], - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "List Employee Work Eligibility", - "tags": [ - "Employees" - ], - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Create Employee Work Eligibility Request", - "tags": [ - "Employees" - ], - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Get Employees Work Eligibility", - "tags": [ - "Employees" - ], - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Update Employee Work Eligibility Request", - "tags": [ - "Employees" - ], - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,updated_at", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "List Employee Time Off Balances", - "tags": [ - "Employees" - ], - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,updated_at", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Get Employee Time Off Balance", - "tags": [ - "Employees" - ], - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,employment_type,employment_contract_type,time_worked,created_at,updated_at,start_date,end_date,active,department,team,cost_center,division,job,type,contract_type,manager", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,employment_type,employment_contract_type,time_worked,created_at,updated_at,start_date,end_date,active,department,team,cost_center,division,job,type,contract_type,manager", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,employment_type,employment_contract_type,time_worked,created_at,updated_at,start_date,end_date,active,department,team,cost_center,division,job,type,contract_type,manager", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "List Employee Employments", - "tags": [ - "Employees" - ], - "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/EmploymentResult" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Create Employee Employment", - "tags": [ - "Employees" - ], - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,employment_type,employment_contract_type,time_worked,created_at,updated_at,start_date,end_date,active,department,team,cost_center,division,job,type,contract_type,manager", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Get Employee Employment", - "tags": [ - "Employees" - ], - "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/HrisCreateEmploymentRequestDto" - } - } - } - }, - "responses": { - "200": { - "description": "The employee employment was updated successfully.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EmploymentResult" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Update Employee Employment", - "tags": [ - "Employees" - ], - "x-speakeasy-group": "hris", - "x-speakeasy-name-override": "update_employee_employment", - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "nullable": true, - "example": "2020-01-01T00:00:00.000Z", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The list of Locations was retrieved.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HRISLocationsPaginated" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "List 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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The Location with the given identifier was retrieved.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HRISLocationResult" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Get Location", - "tags": [ - "Locations" - ], - "x-speakeasy-group": "hris", - "x-speakeasy-name-override": "get_location", - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,duration,created_at,updated_at", - "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", - "nullable": true, - "additionalProperties": false - }, - "type": { - "description": "List of time off type ids to filter by.", - "nullable": true, - "type": "array", - "items": { - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "nullable": true, - "example": "2020-01-01T00:00:00.000Z", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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" - } - }, - "post": { - "operationId": "hris_create_time_off_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/HrisCreateTimeOffRequestDto" - } - } - } - }, - "responses": { - "201": { - "description": "The time off request was created successfully.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateResult" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Creates a time off request", - "tags": [ - "Time Off" - ], - "x-speakeasy-group": "hris", - "x-speakeasy-name-override": "create_time_off_request", - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,duration,created_at,updated_at", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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" - } - }, - "patch": { - "operationId": "hris_update_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": { - "200": { - "description": "Record updated successfully", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateResult" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Update time off request", - "tags": [ - "Time Off" - ], - "x-speakeasy-group": "hris", - "x-speakeasy-name-override": "update_time_off_request", - "x-speakeasy-retries": { - "statusCodes": [ - 429, - 408 - ], - "strategy": "backoff" - } - } - }, - "/unified/hris/time_off_types": { - "get": { - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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": { - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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_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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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/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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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/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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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": "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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/{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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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": "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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": { - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "List Team Groups", - "tags": [ - "Groups" - ], - "x-speakeasy-group": "hris", - "x-speakeasy-name-override": "list_team_groups", - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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/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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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/JobsPaginated" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The job with the given identifier was retrieved.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JobResult" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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/employees/{id}/skills": { - "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/HrisSkillsCreateRequestDto" - } - } - } - }, - "responses": { - "201": { - "description": "The skill was created successfully.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateResult" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Create Employee Skill", - "tags": [ - "Employees" - ], - "x-speakeasy-group": "hris", - "x-speakeasy-name-override": "create_employee_skill", - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,updated_at,created_at", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,updated_at,created_at", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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" - } - } - } - }, - "info": { - "title": "HRIS", - "description": "The documentation for the StackOne Unified API - HRIS", - "version": "1.0.0", - "contact": {} - }, - "tags": [ - { - "name": "Benefits", - "description": "" - }, - { - "name": "Companies", - "description": "" - }, - { - "name": "Custom Field Definitions", - "description": "" - }, - { - "name": "Documents", - "description": "" - }, - { - "name": "Employees", - "description": "" - }, - { - "name": "Employments", - "description": "" - }, - { - "name": "Groups", - "description": "" - }, - { - "name": "Jobs", - "description": "" - }, - { - "name": "Locations", - "description": "" - }, - { - "name": "Time Entries", - "description": "" - }, - { - "name": "Time Off", - "description": "" - }, - { - "name": "Time Off Policies", - "description": "" - } - ], - "servers": [ - { - "url": "https://api.stackone.com" - } - ], - "components": { - "securitySchemes": { - "basic": { - "type": "http", - "scheme": "basic" - } - }, - "schemas": { - "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", - null - ], - "x-speakeasy-unknown-values": "allow", - "nullable": true - }, - "source_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "type": "array", - "items": {} - } - ], - "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 - }, - "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", - 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 - } - } - }, - "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 - } - } - }, - "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": { - "id": { - "type": "string", - "description": "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 employment", - "example": "1687-3", - "nullable": true - }, - "job_title": { - "type": "string", - "description": "The job title of the employee", - "example": "Software Engineer", - "nullable": true - }, - "pay_rate": { - "type": "string", - "description": "The pay rate for the employee", - "example": "40.00", - "nullable": true - }, - "pay_period": { - "description": "The pay period", - "example": "monthly", - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/PayPeriodEnum" - } - ] - }, - "pay_frequency": { - "description": "The pay frequency", - "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 - }, - "employment_type": { - "description": "The type of employment (e.g., contractor, permanent)", - "example": "permanent", - "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", - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/EmploymentScheduleTypeEnum" - } - ] - }, - "time_worked": { - "type": "string", - "description": "The time worked for the employee in ISO 8601 duration format", - "example": "P0Y0M0DT8H0M0S", - "format": "duration", - "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 - } - } - }, - "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": [ - "Not Started", - "In Progress", - "Completed", - "Overdue" - ], - "nullable": true, - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "type": "array", - "items": {} - } - ] - } - } - } - }, - "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" - ] - }, - "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": {} - } - ], - "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", - null - ], - "x-speakeasy-unknown-values": "allow", - "nullable": true - }, - "source_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "type": "array", - "items": {} - } - ], - "nullable": true - } - } - }, - "DepartmentTypeEnum": { - "type": "object", - "properties": { - "value": { - "type": "string", - "enum": [ - "department", - "company", - "division", - "group", - "project", - 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 - } - } - }, - "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 - }, - "first_name": { - "type": "string", - "description": "The employee first name", - "example": "Issac", - "nullable": true - }, - "last_name": { - "type": "string", - "description": "The employee last name", - "example": "Newton", - "nullable": true - }, - "name": { - "type": "string", - "description": "The employee name", - "example": "Issac Newton", - "nullable": true - }, - "display_name": { - "type": "string", - "description": "The employee display name", - "example": "Sir Issac 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", - "deprecated": true, - "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", - "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 employee date_of_birth", - "example": "1990-01-01T00:00.000Z", - "format": "date-time", - "nullable": true - }, - "birthday": { - "type": "string", - "description": "The employee 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.000Z", - "format": "date-time", - "nullable": true - }, - "start_date": { - "type": "string", - "description": "The employee start date", - "example": "2021-01-01T00:00.000Z", - "format": "date-time", - "deprecated": true, - "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 - }, - "national_identity_number": { - "description": "The national identity number", - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/NationalIdentityNumberApiModel" - } - ] - }, - "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 - }, - "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 - }, - "job_title": { - "type": "string", - "description": "The job title of the employee", - "example": "Software Engineer", - "deprecated": true, - "nullable": true - }, - "pay_rate": { - "type": "string", - "description": "The pay rate for the employee", - "example": "40.00", - "nullable": true - }, - "pay_period": { - "description": "The pay period", - "example": "monthly", - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/PayPeriodEnum" - } - ] - }, - "pay_frequency": { - "description": "The pay frequency", - "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 - }, - "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" - } - ] - }, - "time_worked": { - "type": "string", - "description": "The time worked for the employee in ISO 8601 duration format", - "example": "P0Y0M0DT8H0M0S", - "format": "duration", - "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", - "nullable": true - }, - "end_date": { - "type": "string", - "description": "The end_date of employment", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "nullable": true - }, - "active": { - "type": "boolean", - "description": "The employment active status", - "example": true, - "nullable": true - }, - "department": { - "description": "The employee department", - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/HRISBaseGroup" - } - ] - }, - "cost_center": { - "description": "The employee cost_center", - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/HRISBaseGroup" - } - ] - }, - "division": { - "description": "The employee division", - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/HRISBaseGroup" - } - ] - }, - "job": { - "description": "The job of employee", - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/EmploymentJobApiModel" - } - ] - }, - "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" - } - ] - }, - "manager": { - "description": "The employee manager", - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/EmploymentManagerApiModel" - } - } - } - }, - "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 - }, - "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 - } - } - }, - "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 - }, - "path": { - "type": "string", - "description": "The path where the file is stored", - "example": "/path/to/file", - "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": "abc", - "nullable": true - } - } - }, - "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 - } - } - }, - "HRISBaseGroup": { - "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" - } - } - } - }, - "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" - } - }, - "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": { - "first_name": { - "type": "string", - "description": "The employee first name", - "example": "Issac", - "nullable": true - }, - "last_name": { - "type": "string", - "description": "The employee last name", - "example": "Newton", - "nullable": true - }, - "name": { - "type": "string", - "description": "The employee name", - "example": "Issac Newton", - "nullable": true - }, - "display_name": { - "type": "string", - "description": "The employee display name", - "example": "Sir Issac 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", - "nullable": true - }, - "job_title": { - "type": "string", - "description": "The employee job title", - "example": "Physicist", - "nullable": true - }, - "department_id": { - "type": "string", - "description": "The employee department id", - "example": "3093", - "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": "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 employee date_of_birth", - "example": "1990-01-01T00:00.000Z", - "format": "date-time", - "nullable": true - }, - "birthday": { - "type": "string", - "description": "The employee 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.000Z", - "format": "date-time", - "nullable": true - }, - "start_date": { - "type": "string", - "description": "The employee start date", - "example": "2021-01-01T00: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", - "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", - "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", - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/CreateEmploymentApiModel" - } - }, - "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", - "nullable": true, - "allOf": [ - { - "$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": { - "id": { - "type": "string", - "description": "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 employment", - "example": "1687-3", - "nullable": true - }, - "job_title": { - "type": "string", - "description": "The job title of the employee", - "example": "Software Engineer", - "nullable": true - }, - "pay_rate": { - "type": "string", - "description": "The pay rate for the employee", - "example": "40.00", - "nullable": true - }, - "pay_period": { - "description": "The pay period", - "example": "monthly", - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/PayPeriodEnum" - } - ] - }, - "pay_frequency": { - "description": "The pay frequency", - "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 - }, - "employment_type": { - "description": "The type of employment (e.g., contractor, permanent)", - "example": "permanent", - "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", - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/EmploymentScheduleTypeEnum" - } - ] - }, - "time_worked": { - "type": "string", - "description": "The time worked for the employee in ISO 8601 duration format", - "example": "P0Y0M0DT8H0M0S", - "format": "duration", - "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": { - "employee_id": { - "type": "string", - "description": "The employee ID", - "example": "1687-3", - "nullable": true - }, - "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", - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/TimeOffTypeEnum" - } - ] - }, - "start_date": { - "type": "string", - "description": "The start date of the time off request", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "nullable": true - }, - "end_date": { - "type": "string", - "description": "The end date of the time off request", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "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 - }, - "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.000Z", - "format": "date-time", - "nullable": true - }, - "valid_to": { - "type": "string", - "example": "2021-01-01T00: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" - } - }, - "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" - ] - }, - "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 - }, - "path": { - "type": "string", - "description": "The path where the file is stored", - "example": "/path/to/file", - "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", - "example": "reports", - "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": { - "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 - }, - "category": { - "description": "The category to be associated with the file to be uploaded. Id will take precedence over name.", - "nullable": true, - "example": { - "name": "reports", - "id": "550e8400-e29b-41d4-a716-446655440000" - }, - "allOf": [ - { - "$ref": "#/components/schemas/HrisDocumentsUploadCategoryEnumApiModel" - } - ] - }, - "confidential": { - "description": "The confidentiality level of the file to be uploaded", - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/ConfidentialEnumApiModel" - } - ] - } - } - }, - "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" - } - }, - "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 - } - } - }, - "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" - ] - }, - "HrisSkillsCreateRequestDto": { - "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 - } - } - }, - "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" - } - }, - "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": { - "first_name": { - "type": "string", - "description": "The employee first name", - "example": "Issac", - "nullable": true - }, - "last_name": { - "type": "string", - "description": "The employee last name", - "example": "Newton", - "nullable": true - }, - "name": { - "type": "string", - "description": "The employee name", - "example": "Issac Newton", - "nullable": true - }, - "display_name": { - "type": "string", - "description": "The employee display name", - "example": "Sir Issac 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", - "nullable": true - }, - "job_title": { - "type": "string", - "description": "The employee job title", - "example": "Physicist", - "nullable": true - }, - "department_id": { - "type": "string", - "description": "The employee department id", - "example": "3093", - "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": "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 employee date_of_birth", - "example": "1990-01-01T00:00.000Z", - "format": "date-time", - "nullable": true - }, - "birthday": { - "type": "string", - "description": "The employee 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.000Z", - "format": "date-time", - "nullable": true - }, - "start_date": { - "type": "string", - "description": "The employee start date", - "example": "2021-01-01T00: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", - "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", - "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" - } - }, - "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", - "nullable": true, - "allOf": [ - { - "$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 - } - } - }, - "Image": { - "type": "object", - "properties": { - "url": { - "type": "string", - "nullable": true - }, - "base64": { - "type": "string", - "nullable": true - } - } - }, - "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", - "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 - ], - "x-speakeasy-unknown-values": "allow", - "nullable": true - }, - "source_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "type": "array", - "items": {} - } - ], - "nullable": true - } - } - }, - "Job": { - "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 - }, - "status": { - "description": "Status of the job", - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/JobStatusEnum" - } - ] - }, - "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 - } - } - }, - "JobDescriptionApiModel": { - "type": "object", - "properties": { - "text": { - "type": "string", - "example": "Testing the laws of motion", - "nullable": true - } - } - }, - "JobResult": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Job" - }, - "raw": { - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/RawResponse" - } - } - }, - "required": [ - "data" - ] - }, - "JobsPaginated": { - "type": "object", - "properties": { - "next_page": { - "type": "string", - "deprecated": true, - "nullable": true - }, - "next": { - "type": "string", - "nullable": true - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Job" - } - }, - "raw": { - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/RawResponse" - } - } - }, - "required": [ - "data" - ] - }, - "JobStatusEnum": { - "type": "object", - "properties": { - "value": { - "type": "string", - "enum": [ - "draft", - "pending", - "archived", - "closed", - "open", - "deleted", - null - ], - "description": "The status of the job.", - "example": "active", - "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 - } - } - }, - "LaborTypeApiModel": { - "type": "object", - "properties": { - "code": { - "type": "string", - "example": "ABC123", - "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", - 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 - } - } - }, - "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 - } - } - }, - "PreferredLanguageEnum": { - "type": "object", - "properties": { - "value": { - "type": "string", - "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", - "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 - } - } - }, - "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": { - "type": "string", - "nullable": true - }, - "response": { - "type": "object", - "additionalProperties": true, - "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" - ] - }, - "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 - } - } - }, - "TeamTypeEnum": { - "type": "object", - "properties": { - "value": { - "type": "string", - "enum": [ - "team", - 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 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 - }, - "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 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", - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/TimeOffTypeEnum" - } - ] - }, - "start_date": { - "type": "string", - "description": "The start date of the time off request", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "nullable": true - }, - "end_date": { - "type": "string", - "description": "The end date of the time off request", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "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 - }, - "created_date": { - "type": "string", - "description": "The created date of the time off request", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "nullable": true - }, - "updated_date": { - "type": "string", - "description": "The updated date of the time off request", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "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 - }, - "policy_id": { - "type": "string", - "description": "The time off policy id associated with this balance", - "example": "cx280928937", - "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 - }, - "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", - null - ], - "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", - "example": "holiday", - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/TimeOffPolicyTypeEnum" - } - ] - }, - "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": [ - "paid", - "unpaid", - "holiday", - "vacation", - "sick", - "personal", - "in_lieu", - "bereavement", - "jury_duty", - "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 - } - } - }, - "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", - "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", - "bereavement_leave", - "sabbatical", - "accident", - null - ], - "x-speakeasy-unknown-values": "allow", - "nullable": true - }, - "source_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "type": "array", - "items": {} - } - ], - "nullable": true - } - } - }, - "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 - } - } - }, - "UnifiedWarningApiModel": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "The provided field type is not supported in the current model.", - "nullable": true - } - } - }, - "UpdateEmployeeApiModel": { - "type": "object", - "properties": { - "first_name": { - "type": "string", - "description": "The employee first name", - "example": "Issac", - "nullable": true - }, - "last_name": { - "type": "string", - "description": "The employee last name", - "example": "Newton", - "nullable": true - }, - "name": { - "type": "string", - "description": "The employee name", - "example": "Issac Newton", - "nullable": true - }, - "display_name": { - "type": "string", - "description": "The employee display name", - "example": "Sir Issac 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", - "nullable": true - }, - "job_title": { - "type": "string", - "description": "The employee job title", - "example": "Physicist", - "nullable": true - }, - "department_id": { - "type": "string", - "description": "The employee department id", - "example": "3093", - "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": "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 employee date_of_birth", - "example": "1990-01-01T00:00.000Z", - "format": "date-time", - "nullable": true - }, - "birthday": { - "type": "string", - "description": "The employee 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.000Z", - "format": "date-time", - "nullable": true - }, - "start_date": { - "type": "string", - "description": "The employee start date", - "example": "2021-01-01T00: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", - "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", - "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" - } - }, - "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", - "nullable": true, - "allOf": [ - { - "$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" - } - ] - } - } - }, - "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.000Z", - "format": "date-time", - "nullable": true - }, - "valid_to": { - "type": "string", - "example": "2021-01-01T00: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", - null - ], - "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" - } - } - } - } - } - }, - "x-readme": { - "explorer-enabled": true, - "proxy-enabled": true - } -} \ No newline at end of file diff --git a/stackone_ai/oas/iam.json b/stackone_ai/oas/iam.json deleted file mode 100644 index 013015b..0000000 --- a/stackone_ai/oas/iam.json +++ /dev/null @@ -1,3441 +0,0 @@ -{ - "openapi": "3.0.0", - "paths": { - "/unified/iam/users": { - "get": { - "operationId": "iam_list_users", - "x-speakeasy-group": "iam", - "x-speakeasy-name-override": "list_users", - "summary": "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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", - "example": "2020-01-01T00:00:00.000Z", - "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", - "example": "roles,groups", - "schema": { - "nullable": true, - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The list of users was retrieved.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IamUsersPaginated" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Users" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/iam/users/{id}": { - "get": { - "operationId": "iam_get_user", - "x-speakeasy-group": "iam", - "x-speakeasy-name-override": "get_user", - "summary": "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "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", - "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", - "example": "roles,groups", - "schema": { - "nullable": true, - "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." - }, - "403": { - "description": "Forbidden." - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Users" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/iam/roles": { - "get": { - "operationId": "iam_list_roles", - "x-speakeasy-group": "iam", - "x-speakeasy-name-override": "list_roles", - "summary": "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "example": "id,remote_id,name,type,policies,description,created_at,updated_at", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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", - "example": "2020-01-01T00:00:00.000Z", - "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", - "example": "policies", - "schema": { - "nullable": true, - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The list of roles was retrieved.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IamRolesPaginated" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Roles" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/iam/roles/{id}": { - "get": { - "operationId": "iam_get_role", - "x-speakeasy-group": "iam", - "x-speakeasy-name-override": "get_role", - "summary": "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "example": "id,remote_id,name,type,policies,description,created_at,updated_at", - "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", - "example": "policies", - "schema": { - "nullable": true, - "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." - }, - "403": { - "description": "Forbidden." - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Roles" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/iam/groups": { - "get": { - "operationId": "iam_list_groups", - "x-speakeasy-group": "iam", - "x-speakeasy-name-override": "list_groups", - "summary": "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "example": "id,remote_id,parent_id,remote_parent_id,name,description,roles,type,created_at,updated_at", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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", - "example": "2020-01-01T00:00:00.000Z", - "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", - "example": "roles", - "schema": { - "nullable": true, - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The list of groups was retrieved.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IamGroupsPaginated" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Groups" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/iam/groups/{id}": { - "get": { - "operationId": "iam_get_group", - "x-speakeasy-group": "iam", - "x-speakeasy-name-override": "get_group", - "summary": "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "example": "id,remote_id,parent_id,remote_parent_id,name,description,roles,type,created_at,updated_at", - "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", - "example": "roles", - "schema": { - "nullable": true, - "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." - }, - "403": { - "description": "Forbidden." - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Groups" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/iam/policies": { - "get": { - "operationId": "iam_list_policies", - "x-speakeasy-group": "iam", - "x-speakeasy-name-override": "list_policies", - "summary": "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "example": "id,remote_id,name,permissions,description,created_at,updated_at", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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", - "example": "2020-01-01T00:00:00.000Z", - "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", - "example": "permissions", - "schema": { - "nullable": true, - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The list of policies was retrieved.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IamPoliciesPaginated" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Policies" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/iam/policies/{id}": { - "get": { - "operationId": "iam_get_policy", - "x-speakeasy-group": "iam", - "x-speakeasy-name-override": "get_policy", - "summary": "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "example": "id,remote_id,name,permissions,description,created_at,updated_at", - "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", - "example": "permissions", - "schema": { - "nullable": true, - "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." - }, - "403": { - "description": "Forbidden." - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Policies" - ], - "security": [ - { - "basic": [] - } - ] - } - } - }, - "info": { - "title": "IAM", - "description": "The documentation for the StackOne Unified API - IAM", - "version": "1.0.0", - "contact": {} - }, - "tags": [ - { - "name": "Users", - "description": "" - }, - { - "name": "Roles", - "description": "" - }, - { - "name": "Groups", - "description": "" - }, - { - "name": "Policies", - "description": "" - }, - { - "name": "Permissions", - "description": "" - }, - { - "name": "Resources", - "description": "" - } - ], - "servers": [ - { - "url": "https://api.stackone.com" - } - ], - "components": { - "securitySchemes": { - "basic": { - "type": "http", - "scheme": "basic" - } - }, - "schemas": { - "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 - } - } - }, - "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 - } - } - }, - "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 - } - } - }, - "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 - } - } - }, - "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 - } - } - }, - "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 - } - } - }, - "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 - } - } - }, - "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 - } - } - }, - "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 - } - } - }, - "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 - } - } - }, - "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": "abc", - "nullable": true - } - } - }, - "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" - } - ] - } - } - }, - "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 - }, - "path": { - "type": "string", - "description": "The path where the file is stored", - "example": "/path/to/file", - "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" - } - ] - } - } - }, - "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" - } - ] - } - } - }, - "RawResponse": { - "type": "object", - "properties": { - "method": { - "type": "string" - }, - "url": { - "type": "string" - }, - "body": { - "type": "string", - "nullable": true - }, - "response": { - "type": "object", - "additionalProperties": true, - "nullable": true - } - }, - "required": [ - "method", - "url" - ] - }, - "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" - ] - }, - "IamUserResult": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/IamUser" - }, - "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" - ] - }, - "IamRoleResult": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/IamRole" - }, - "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" - ] - }, - "IamGroupResult": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/IamGroup" - }, - "raw": { - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/RawResponse" - } - } - }, - "required": [ - "data" - ] - }, - "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" - ] - }, - "IamPolicyResult": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/IamPolicy" - }, - "raw": { - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/RawResponse" - } - } - }, - "required": [ - "data" - ] - } - } - }, - "x-readme": { - "explorer-enabled": true, - "proxy-enabled": true - } -} \ No newline at end of file diff --git a/stackone_ai/oas/lms.json b/stackone_ai/oas/lms.json deleted file mode 100644 index ad4d26e..0000000 --- a/stackone_ai/oas/lms.json +++ /dev/null @@ -1,6319 +0,0 @@ -{ - "openapi": "3.1.0", - "paths": { - "/unified/lms/courses/batch": { - "post": { - "operationId": "lms_batch_upsert_course", - "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/LmsBatchUpsertCourseRequestDto" - } - } - } - }, - "responses": { - "202": { - "description": "Batch operation accepted", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BatchResultApiModel" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Batch Upsert Course", - "tags": [ - "Courses" - ], - "x-speakeasy-group": "lms", - "x-speakeasy-name-override": "batch_upsert_course", - "x-speakeasy-retries": { - "statusCodes": [ - 429, - 408 - ], - "strategy": "backoff" - } - } - }, - "/unified/lms/courses": { - "get": { - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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" - } - }, - "put": { - "operationId": "lms_upsert_course", - "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/LmsUpsertCourseRequestDto" - } - } - } - }, - "responses": { - "201": { - "description": "The course was upserted successfully.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpsertResult" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Upsert Course", - "tags": [ - "Courses" - ], - "x-speakeasy-group": "lms", - "x-speakeasy-name-override": "upsert_course", - "x-speakeasy-retries": { - "statusCodes": [ - 429, - 408 - ], - "strategy": "backoff" - } - } - }, - "/unified/lms/courses/{id}": { - "get": { - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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": { - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference", - "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", - "nullable": true, - "additionalProperties": false - }, - "status": { - "description": "Filter to select assignment by status", - "type": "string", - "enum": [ - "pending", - "in_progress", - "completed", - 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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "List User Assignments", - "tags": [ - "Users" - ], - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Create User Assignment", - "tags": [ - "Users" - ], - "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": { - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Get User Assignment", - "tags": [ - "Users" - ], - "x-speakeasy-group": "lms", - "x-speakeasy-name-override": "get_user_assignment", - "x-speakeasy-retries": { - "statusCodes": [ - 429, - 408 - ], - "strategy": "backoff" - } - } - }, - "/unified/lms/content/batch": { - "post": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Batch Upsert Content", - "tags": [ - "Content" - ], - "x-speakeasy-group": "lms", - "x-speakeasy-name-override": "batch_upsert_content", - "x-speakeasy-retries": { - "statusCodes": [ - 429, - 408 - ], - "strategy": "backoff" - } - } - }, - "/unified/lms/content": { - "get": { - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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" - } - }, - "put": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Upsert Content", - "tags": [ - "Content" - ], - "x-speakeasy-group": "lms", - "x-speakeasy-name-override": "upsert_content", - "x-speakeasy-retries": { - "statusCodes": [ - 429, - 408 - ], - "strategy": "backoff" - } - } - }, - "/unified/lms/content/{id}": { - "get": { - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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": { - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "List User Completions", - "tags": [ - "Users" - ], - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Create User Completion", - "tags": [ - "Users" - ], - "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": { - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Get User Completion", - "tags": [ - "Users" - ], - "x-speakeasy-group": "lms", - "x-speakeasy-name-override": "get_user_completion", - "x-speakeasy-retries": { - "statusCodes": [ - 429, - 408 - ], - "strategy": "backoff" - } - }, - "delete": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Delete User Completion", - "tags": [ - "Users" - ], - "x-speakeasy-group": "lms", - "x-speakeasy-name-override": "delete_user_completion", - "x-speakeasy-retries": { - "statusCodes": [ - 429, - 408 - ], - "strategy": "backoff" - } - } - }, - "/unified/lms/completions": { - "get": { - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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": { - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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", - "nullable": true, - "additionalProperties": false - }, - "email": { - "description": "Filter to select users 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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,level,language,hierarchy,proficiency", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,level,language,hierarchy,proficiency", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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": { - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference", - "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", - "nullable": true, - "additionalProperties": false - }, - "status": { - "description": "Filter to select assignment by status", - "type": "string", - "enum": [ - "pending", - "in_progress", - "completed", - 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", - "schema": { - "nullable": true, - "default": "25", - "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": { - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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": { - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "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" - } - } - }, - "/unified/lms/collections": { - "post": { - "operationId": "lms_create_collection", - "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/LmsCreateCollectionRequestDto" - } - } - } - }, - "responses": { - "201": { - "description": "The collection was created successfully.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateResult" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Create Collection", - "tags": [ - "Collections" - ], - "x-speakeasy-group": "lms", - "x-speakeasy-name-override": "create_collection", - "x-speakeasy-retries": { - "statusCodes": [ - 429, - 408 - ], - "strategy": "backoff" - } - } - }, - "/unified/lms/collections/{id}": { - "patch": { - "operationId": "lms_update_collection", - "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/LmsCreateCollectionRequestDto" - } - } - } - }, - "responses": { - "201": { - "description": "The collection was updated successfully.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateResult" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "security": [ - { - "basic": [] - } - ], - "summary": "Update Collection", - "tags": [ - "Collections" - ], - "x-speakeasy-group": "lms", - "x-speakeasy-name-override": "update_collection", - "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": "" - }, - { - "name": "Content", - "description": "" - }, - { - "name": "Categories", - "description": "" - }, - { - "name": "Users", - "description": "" - }, - { - "name": "Skills", - "description": "" - }, - { - "name": "Assignments", - "description": "" - }, - { - "name": "Completions", - "description": "" - }, - { - "name": "Collections", - "description": "" - } - ], - "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", - "nullable": true - }, - "created_at": { - "type": "string", - "description": "The date the assignment was created", - "example": "2021-07-21T14:00:00.000Z", - "nullable": true - }, - "due_date": { - "type": "string", - "description": "The date the assignment is due to be completed", - "example": "2021-07-21T14:00:00.000Z", - "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 - }, - "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", - null - ], - "example": "in-progress", - "x-speakeasy-unknown-values": "allow", - "nullable": true - }, - "source_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "type": "array", - "items": {} - } - ], - "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 - } - } - }, - "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": { - "type": "boolean", - "description": "Whether the category is active and therefore available for use", - "example": true, - "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", - null - ], - "x-speakeasy-unknown-values": "allow", - "nullable": true - }, - "source_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "type": "array", - "items": {} - } - ], - "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 - }, - "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", - "nullable": true - }, - "created_at": { - "type": "string", - "description": "The created date of the completion", - "example": "2021-07-21T14:00:00.000Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "description": "The updated date of the completion", - "example": "2021-07-21T14:00:00.000Z", - "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 - }, - "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 - }, - "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 - }, - "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 - } - } - }, - "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" - ] - }, - "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 - }, - "additional_data": { - "description": "The additional_data associated with this content", - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/AdditionalData" - } - }, - "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": { - "type": "boolean", - "description": "Whether the content is active and available for users.", - "example": true, - "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 - } - } - }, - "ContentPaginated": { - "type": "object", - "properties": { - "next_page": { - "type": "string", - "deprecated": true, - "nullable": true - }, - "next": { - "type": "string", - "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", - null - ], - "x-speakeasy-unknown-values": "allow", - "nullable": true - }, - "source_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "type": "array", - "items": {} - } - ], - "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": { - "type": "boolean", - "description": "Whether the course is active and available for users.", - "example": true, - "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 - }, - "updated_at": { - "type": "string", - "description": "The date on which the course was last updated.", - "example": "2021-07-21T14:00:00.000Z", - "nullable": true - }, - "created_at": { - "type": "string", - "description": "The date on which the course was created.", - "example": "2021-07-21T14:00:00.000Z", - "nullable": true - } - } - }, - "CoursePaginated": { - "type": "object", - "properties": { - "next_page": { - "type": "string", - "deprecated": true, - "nullable": true - }, - "next": { - "type": "string", - "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" - } - ] - } - } - }, - "CreateContentApiModel": { - "type": "object", - "properties": { - "external_reference": { - "type": "string", - "description": "The external ID associated with this content", - "example": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", - "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 - }, - "content_url": { - "type": "string", - "description": "The external URL of the content", - "example": "https://www.youtube.com/watch?v=16873", - "nullable": true - }, - "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 - } - } - }, - "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" - } - ] - }, - "proficiency": { - "description": "The user proficiency level of the skill ranked out of 5", - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/SkillProficiencyLevelEnum" - } - ] - }, - "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" - ] - }, - "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", - 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 - } - } - }, - "LearningObjectTypeEnum": { - "type": "object", - "properties": { - "value": { - "type": "string", - "enum": [ - "content", - "course", - "collection", - null - ], - "x-speakeasy-unknown-values": "allow", - "nullable": true - }, - "source_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "type": "array", - "items": {} - } - ], - "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" - ] - }, - "LmsBatchUpsertCourseRequestDto": { - "type": "object", - "properties": { - "items": { - "description": "The batch of items to upsert", - "nullable": false, - "type": "array", - "items": { - "$ref": "#/components/schemas/LmsUpsertCourseRequestDto" - } - } - }, - "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 - }, - "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 - }, - "created_at": { - "type": "string", - "description": "The date the assignment was created", - "example": "2021-07-21T14:00:00.000Z", - "nullable": true - }, - "due_date": { - "type": "string", - "description": "The date the assignment is due to be completed", - "example": "2021-07-21T14:00:00.000Z", - "nullable": true - }, - "status": { - "description": "The status of the assignment", - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/AssignmentStatusEnum" - } - ] - } - } - }, - "LmsCreateCollectionRequestDto": { - "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 - }, - "external_reference": { - "type": "string", - "description": "The external ID associated with this collection", - "example": "SOFTWARE-ENG-LV1-TRAINING-collection-1", - "nullable": true - }, - "learning_object_ids": { - "description": "The child ID/IDs associated with this collection", - "example": [ - "16873-SOFTWARE-ENG-COURSE", - "16874-SOFTWARE-ENG-COURSE" - ], - "nullable": true, - "type": "array", - "items": { - "type": "string" - } - }, - "remote_learning_object_ids": { - "description": "Provider's unique identifiers of the child ID/IDs associated with this collection", - "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 collection", - "example": "Software Engineer Lv 1 Collection", - "nullable": true - }, - "description": { - "type": "string", - "description": "The description of the collection", - "example": "This collection acts as learning pathway for software engineers.", - "nullable": true - }, - "languages": { - "description": "The languages associated with this collection", - "nullable": true, - "type": "array", - "items": { - "type": "string" - } - }, - "cover_url": { - "type": "string", - "description": "The URL of the thumbnail image associated with the collection.", - "example": "https://www.googledrive.com/?v=16873", - "nullable": true - }, - "categories": { - "description": "The categories associated with this content", - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/CreateCategoriesApiModel" - } - }, - "skills": { - "description": "The skills associated with this content", - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/CreateSkillsApiModel" - } - } - } - }, - "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", - "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 - }, - "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 - }, - "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 - } - } - }, - "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 - }, - "external_reference": { - "type": "string", - "description": "The external ID associated with this content", - "example": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", - "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 - }, - "additional_data": { - "description": "The additional_data associated with this content", - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/AdditionalData" - } - }, - "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": { - "type": "boolean", - "description": "Whether the content is active and available for users.", - "example": true, - "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 - }, - "categories": { - "description": "The categories associated with this content", - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/CreateCategoriesApiModel" - } - } - } - }, - "LmsUpsertCourseRequestDto": { - "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 - }, - "external_reference": { - "type": "string", - "description": "The external ID associated with this course", - "example": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", - "nullable": true - }, - "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": { - "type": "boolean", - "description": "Whether the course is active and available for users.", - "example": true, - "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 content", - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/CreateCategoriesApiModel" - } - }, - "skills": { - "description": "The skills associated with this content", - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/CreateSkillsApiModel" - } - }, - "content": { - "description": "The content associated with this course", - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/CreateContentApiModel" - } - } - } - }, - "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": { - "type": "boolean", - "description": "The user active status", - "example": true, - "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 - } - } - }, - "RawResponse": { - "type": "object", - "properties": { - "method": { - "type": "string" - }, - "url": { - "type": "string" - }, - "body": { - "type": "string", - "nullable": true - }, - "response": { - "type": "object", - "additionalProperties": true, - "nullable": true - } - }, - "required": [ - "method", - "url" - ] - }, - "ResultStatusEnum": { - "type": "object", - "properties": { - "value": { - "type": "string", - "enum": [ - "Pass", - "Fail", - null - ], - "x-speakeasy-unknown-values": "allow", - "nullable": true - }, - "source_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "type": "array", - "items": {} - } - ], - "nullable": true - } - } - }, - "SkillLevelEnum": { - "type": "object", - "properties": { - "value": { - "type": "string", - "enum": [ - "primary", - "secondary", - "tertiary", - null - ], - "x-speakeasy-unknown-values": "allow", - "nullable": true - }, - "source_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "type": "array", - "items": {} - } - ], - "nullable": true - } - } - }, - "SkillProficiencyLevelEnum": { - "type": "object", - "properties": { - "value": { - "type": "string", - "enum": [ - "1", - "2", - "3", - "4", - "5", - null - ], - "x-speakeasy-unknown-values": "allow", - "nullable": true - }, - "source_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "type": "array", - "items": {} - } - ], - "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": { - "type": "boolean", - "description": "Whether the skill is active and therefore available for use", - "example": true, - "nullable": true - }, - "hierarchy": { - "description": "The hierarchal level of the skill", - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/SkillLevelEnum" - } - ] - }, - "proficiency": { - "description": "The user proficiency level of the skill ranked out of 5", - "nullable": true, - "allOf": [ - { - "$ref": "#/components/schemas/SkillProficiencyLevelEnum" - } - ] - }, - "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" - ] - }, - "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" - ] - }, - "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" - ] - } - } - }, - "x-readme": { - "explorer-enabled": true, - "proxy-enabled": true - } -} \ No newline at end of file diff --git a/stackone_ai/oas/marketing.json b/stackone_ai/oas/marketing.json deleted file mode 100644 index a92408b..0000000 --- a/stackone_ai/oas/marketing.json +++ /dev/null @@ -1,4521 +0,0 @@ -{ - "openapi": "3.0.0", - "paths": { - "/unified/marketing/templates/email": { - "get": { - "operationId": "marketing_list_email_templates", - "x-speakeasy-group": "marketing", - "x-speakeasy-name-override": "list_email_templates", - "summary": "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "example": "id,remote_id,name,messages,created_at,updated_at,tags", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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", - "example": "2020-01-01T00:00:00.000Z", - "deprecated": true, - "schema": { - "nullable": true, - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The list of email templates was retrieved.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EmailTemplatesPaginated" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Templates" - ], - "security": [ - { - "basic": [] - } - ] - }, - "post": { - "operationId": "marketing_create_email_template", - "x-speakeasy-group": "marketing", - "x-speakeasy-name-override": "create_email_template", - "summary": "Create Email Templates", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Templates" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/marketing/templates/email/{id}": { - "get": { - "operationId": "marketing_get_email_template", - "x-speakeasy-group": "marketing", - "x-speakeasy-name-override": "get_email_template", - "summary": "Get Email Templates", - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "example": "id,remote_id,name,messages,created_at,updated_at,tags", - "schema": { - "nullable": true, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Templates" - ], - "security": [ - { - "basic": [] - } - ] - }, - "patch": { - "operationId": "marketing_update_email_template", - "x-speakeasy-group": "marketing", - "x-speakeasy-name-override": "update_email_template", - "summary": "Update Email Templates", - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Templates" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/marketing/templates/in_app": { - "get": { - "operationId": "marketing_list_in_app_templates", - "x-speakeasy-group": "marketing", - "x-speakeasy-name-override": "list_in_app_templates", - "summary": "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "example": "id,remote_id,name,messages,created_at,updated_at,tags", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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", - "example": "2020-01-01T00:00:00.000Z", - "deprecated": true, - "schema": { - "nullable": true, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Templates" - ], - "security": [ - { - "basic": [] - } - ] - }, - "post": { - "operationId": "marketing_create_in_app_template", - "x-speakeasy-group": "marketing", - "x-speakeasy-name-override": "create_in_app_template", - "summary": "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Templates" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/marketing/templates/in_app/{id}": { - "get": { - "operationId": "marketing_get_in_app_template", - "x-speakeasy-group": "marketing", - "x-speakeasy-name-override": "get_in_app_template", - "summary": "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "example": "id,remote_id,name,messages,created_at,updated_at,tags", - "schema": { - "nullable": true, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Templates" - ], - "security": [ - { - "basic": [] - } - ] - }, - "patch": { - "operationId": "marketing_update_in_app_template", - "x-speakeasy-group": "marketing", - "x-speakeasy-name-override": "update_in_app_template", - "summary": "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Templates" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/marketing/templates/sms": { - "get": { - "operationId": "marketing_list_sms_templates", - "x-speakeasy-group": "marketing", - "x-speakeasy-name-override": "list_sms_templates", - "summary": "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "example": "id,remote_id,name,messages,created_at,updated_at,tags", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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", - "example": "2020-01-01T00:00:00.000Z", - "deprecated": true, - "schema": { - "nullable": true, - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The list of SMS templates was retrieved.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SmsTemplatesPaginated" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Templates" - ], - "security": [ - { - "basic": [] - } - ] - }, - "post": { - "operationId": "marketing_create_sms_template", - "x-speakeasy-group": "marketing", - "x-speakeasy-name-override": "create_sms_template", - "summary": "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Templates" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/marketing/templates/sms/{id}": { - "get": { - "operationId": "marketing_get_sms_template", - "x-speakeasy-group": "marketing", - "x-speakeasy-name-override": "get_sms_template", - "summary": "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "example": "id,remote_id,name,messages,created_at,updated_at,tags", - "schema": { - "nullable": true, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Templates" - ], - "security": [ - { - "basic": [] - } - ] - }, - "patch": { - "operationId": "marketing_update_sms_template", - "x-speakeasy-group": "marketing", - "x-speakeasy-name-override": "update_sms_template", - "summary": "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Templates" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/marketing/templates/omni_channel": { - "get": { - "operationId": "marketing_list_omni_channel_templates", - "x-speakeasy-group": "marketing", - "x-speakeasy-name-override": "list_omni_channel_templates", - "summary": "List Omni-Channel Templates", - "deprecated": true, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "example": "id,remote_id,name,messages,created_at,updated_at,tags", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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", - "example": "2020-01-01T00:00:00.000Z", - "deprecated": true, - "schema": { - "nullable": true, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Templates" - ], - "security": [ - { - "basic": [] - } - ] - }, - "post": { - "operationId": "marketing_create_omni_channel_template", - "x-speakeasy-group": "marketing", - "x-speakeasy-name-override": "create_omni_channel_template", - "summary": "Create Omni-Channel Template", - "deprecated": true, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Templates" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/marketing/templates/omni_channel/{id}": { - "get": { - "operationId": "marketing_get_omni_channel_template", - "x-speakeasy-group": "marketing", - "x-speakeasy-name-override": "get_omni_channel_template", - "summary": "Get Omni-Channel Template", - "deprecated": true, - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "example": "id,remote_id,name,messages,created_at,updated_at,tags", - "schema": { - "nullable": true, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Templates" - ], - "security": [ - { - "basic": [] - } - ] - }, - "patch": { - "operationId": "marketing_update_omni_channel_template", - "x-speakeasy-group": "marketing", - "x-speakeasy-name-override": "update_omni_channel_template", - "summary": "Update Omni-Channel Template", - "deprecated": true, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Templates" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/marketing/templates/push": { - "get": { - "operationId": "marketing_list_push_templates", - "x-speakeasy-group": "marketing", - "x-speakeasy-name-override": "list_push_templates", - "summary": "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "example": "id,remote_id,name,messages,created_at,updated_at,tags", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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", - "example": "2020-01-01T00:00:00.000Z", - "deprecated": true, - "schema": { - "nullable": true, - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The list of push templates was retrieved.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PushTemplatesPaginated" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Templates" - ], - "security": [ - { - "basic": [] - } - ] - }, - "post": { - "operationId": "marketing_create_push_template", - "x-speakeasy-group": "marketing", - "x-speakeasy-name-override": "create_push_template", - "summary": "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Templates" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/marketing/templates/push/{id}": { - "get": { - "operationId": "marketing_get_push_template", - "x-speakeasy-group": "marketing", - "x-speakeasy-name-override": "get_push_template", - "summary": "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "example": "id,remote_id,name,messages,created_at,updated_at,tags", - "schema": { - "nullable": true, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Templates" - ], - "security": [ - { - "basic": [] - } - ] - }, - "patch": { - "operationId": "marketing_update_push_template", - "x-speakeasy-group": "marketing", - "x-speakeasy-name-override": "update_push_template", - "summary": "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Templates" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/marketing/campaigns": { - "get": { - "operationId": "marketing_list_campaigns", - "x-speakeasy-group": "marketing", - "x-speakeasy-name-override": "list_campaigns", - "summary": "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "example": "id,remote_id,name,created_at,updated_at,description,schedule_type,status,channels,first_sent_at,last_sent_at,tags,messages", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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", - "example": "2020-01-01T00:00:00.000Z", - "deprecated": true, - "schema": { - "nullable": true, - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The list of campaigns was retrieved.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CampaignsPaginated" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Campaigns" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/marketing/campaigns/{id}": { - "get": { - "operationId": "marketing_get_campaign", - "x-speakeasy-group": "marketing", - "x-speakeasy-name-override": "get_campaign", - "summary": "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "example": "id,remote_id,name,created_at,updated_at,description,schedule_type,status,channels,first_sent_at,last_sent_at,tags,messages", - "schema": { - "nullable": true, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Campaigns" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/marketing/content_blocks": { - "get": { - "operationId": "marketing_list_content_blocks", - "x-speakeasy-group": "marketing", - "x-speakeasy-name-override": "list_content_blocks", - "summary": "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "example": "id,remote_id,name,type,content,status,tags,created_at,updated_at", - "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", - "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", - "schema": { - "nullable": true, - "default": "25", - "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", - "example": "2020-01-01T00:00:00.000Z", - "deprecated": true, - "schema": { - "nullable": true, - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The list of Content Blocks was retrieved.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ContentBlocksPaginated" - } - } - } - }, - "400": { - "description": "Invalid request." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Content Blocks" - ], - "security": [ - { - "basic": [] - } - ] - }, - "post": { - "operationId": "marketing_create_content_block", - "x-speakeasy-group": "marketing", - "x-speakeasy-name-override": "create_content_block", - "summary": "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Content Blocks" - ], - "security": [ - { - "basic": [] - } - ] - } - }, - "/unified/marketing/content_blocks/{id}": { - "get": { - "operationId": "marketing_get_content_block", - "x-speakeasy-group": "marketing", - "x-speakeasy-name-override": "get_content_block", - "summary": "Get Content Blocks", - "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 is returned", - "schema": { - "nullable": true, - "default": false, - "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)", - "example": "id,remote_id,name,type,content,status,tags,created_at,updated_at", - "schema": { - "nullable": true, - "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Content Blocks" - ], - "security": [ - { - "basic": [] - } - ] - }, - "patch": { - "operationId": "marketing_update_content_block", - "x-speakeasy-group": "marketing", - "x-speakeasy-name-override": "update_content_block", - "summary": "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." - }, - "403": { - "description": "Forbidden." - }, - "408": { - "description": "The request has timed out.", - "headers": { - "Retry-After": { - "description": "A time in seconds after which the request can be retried.", - "schema": { - "type": "string" - } - } - } - }, - "412": { - "description": "Precondition failed: linked account belongs to a disabled integration." - }, - "429": { - "description": "Too many requests." - }, - "500": { - "description": "Server error while executing the request." - }, - "501": { - "description": "This functionality is not implemented." - } - }, - "tags": [ - "Content Blocks" - ], - "security": [ - { - "basic": [] - } - ] - } - } - }, - "info": { - "title": "Marketing", - "description": "The documentation for the StackOne Unified API - MARKETING", - "version": "1.0.0", - "contact": {} - }, - "tags": [ - { - "name": "Campaigns", - "description": "" - }, - { - "name": "Content Blocks", - "description": "" - }, - { - "name": "Templates", - "description": "" - } - ], - "servers": [ - { - "url": "https://api.stackone.com" - } - ], - "components": { - "securitySchemes": { - "basic": { - "type": "http", - "scheme": "basic" - } - }, - "schemas": { - "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 - } - } - }, - "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" - } - }, - "messages": { - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/EmailMessages" - } - } - } - }, - "RawResponse": { - "type": "object", - "properties": { - "method": { - "type": "string" - }, - "url": { - "type": "string" - }, - "body": { - "type": "string", - "nullable": true - }, - "response": { - "type": "object", - "additionalProperties": true, - "nullable": true - } - }, - "required": [ - "method", - "url" - ] - }, - "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" - ] - }, - "EmailTemplateResult": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/EmailTemplate" - }, - "raw": { - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/RawResponse" - } - } - }, - "required": [ - "data" - ] - }, - "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 - } - } - }, - "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 - } - } - }, - "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" - ] - }, - "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" - } - }, - "messages": { - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/InAppMessages" - } - } - } - }, - "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" - ] - }, - "InAppTemplateResult": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/InAppTemplate" - }, - "raw": { - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/RawResponse" - } - } - }, - "required": [ - "data" - ] - }, - "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 - } - } - }, - "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" - } - }, - "messages": { - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/SmsMessages" - } - } - } - }, - "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" - ] - }, - "SmsTemplateResult": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SmsTemplate" - }, - "raw": { - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/RawResponse" - } - } - }, - "required": [ - "data" - ] - }, - "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 - } - } - }, - "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 - } - } - }, - "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" - ] - }, - "TemplateResult": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Template" - }, - "raw": { - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/RawResponse" - } - } - }, - "required": [ - "data" - ] - }, - "PushMessageContents": { - "type": "object", - "properties": { - "title": { - "type": "string", - "nullable": true - }, - "subtitle": { - "type": "string", - "nullable": true - }, - "body": { - "type": "string", - "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 - } - } - }, - "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 - } - } - }, - "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" - } - }, - "messages": { - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/PushMessages" - } - } - } - }, - "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" - ] - }, - "PushTemplateResult": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PushTemplate" - }, - "raw": { - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/RawResponse" - } - } - }, - "required": [ - "data" - ] - }, - "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 - } - } - }, - "ScheduleTypeEnum": { - "type": "object", - "properties": { - "value": { - "type": "string", - "enum": [ - "immediate", - "scheduled", - "recurring", - "custom", - "triggered", - 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 - } - } - }, - "StatusEnum": { - "type": "object", - "properties": { - "value": { - "type": "string", - "enum": [ - "draft", - "archived", - "live", - 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 - } - } - }, - "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 - } - } - }, - "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 - } - } - }, - "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" - } - } - } - }, - "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" - ] - }, - "CampaignResult": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Campaign" - }, - "raw": { - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/RawResponse" - } - } - }, - "required": [ - "data" - ] - }, - "ContentBlockTypeEnumApiModel": { - "type": "object", - "properties": { - "value": { - "type": "string", - "enum": [ - "text", - "html", - "image", - "code-snippet", - 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 - } - } - }, - "ContentBlockStatusEnumApiModel": { - "type": "object", - "properties": { - "value": { - "type": "string", - "enum": [ - "draft", - "live", - "archived", - 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 - } - } - }, - "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 - } - } - }, - "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" - ] - }, - "ContentBlockResult": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ContentBlock" - }, - "raw": { - "nullable": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/RawResponse" - } - } - }, - "required": [ - "data" - ] - }, - "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 - } - } - } - } - }, - "x-readme": { - "explorer-enabled": true, - "proxy-enabled": true - } -} \ No newline at end of file diff --git a/stackone_ai/server.py b/stackone_ai/server.py index 4071f5b..e0d61b4 100644 --- a/stackone_ai/server.py +++ b/stackone_ai/server.py @@ -70,7 +70,7 @@ async def list_tools() -> list[Tool]: try: mcp_tools: list[Tool] = [] - tools = toolset.get_tools() + tools = toolset.fetch_tools() # Convert to a list if it's not already iterable in the expected way tool_list = list(tools.tools) if hasattr(tools, "tools") else [] @@ -129,7 +129,16 @@ async def call_tool( ) try: - tool = toolset.get_tool(name) + # Get account_id from arguments if provided + account_id = arguments.pop("account_id", None) + + # Fetch tools with the specific action filter to get the right tool + tools = toolset.fetch_tools( + account_ids=[account_id] if account_id else None, + actions=[name], + ) + tool = tools.get_tool(name) + if not tool: logger.warning(f"Tool not found: {name}") raise McpError( @@ -139,9 +148,6 @@ async def call_tool( ) ) - if "account_id" in arguments: - tool.set_account_id(arguments.pop("account_id")) - if tool_needs_account_id(name) and tool.get_account_id() is None: logger.warning(f"Tool {name} needs account_id but none provided") raise McpError( diff --git a/stackone_ai/specs/loader.py b/stackone_ai/specs/loader.py deleted file mode 100644 index ab70372..0000000 --- a/stackone_ai/specs/loader.py +++ /dev/null @@ -1,20 +0,0 @@ -from stackone_ai.constants import OAS_DIR -from stackone_ai.models import ToolDefinition -from stackone_ai.specs.parser import OpenAPIParser - - -def load_specs() -> dict[str, dict[str, ToolDefinition]]: - """ - Load all OpenAPI specs from the .stackone/oas directory - - Returns: - Dict mapping vertical names to their tool definitions - """ - tools = {} - - for spec_file in OAS_DIR.glob("*.json"): - vertical = spec_file.stem - parser = OpenAPIParser(spec_file) - tools[vertical] = parser.parse_tools() - - return tools diff --git a/stackone_ai/specs/parser.py b/stackone_ai/specs/parser.py deleted file mode 100644 index 9453712..0000000 --- a/stackone_ai/specs/parser.py +++ /dev/null @@ -1,231 +0,0 @@ -# TODO: Remove when Python 3.9 support is dropped -from __future__ import annotations - -import json -from pathlib import Path -from typing import Any - -from stackone_ai.models import ExecuteConfig, ToolDefinition, ToolParameters - - -class OpenAPIParser: - def __init__(self, spec_path: Path, base_url: str | None = None): - self.spec_path = spec_path - with open(spec_path) as f: - self.spec = json.load(f) - # Get base URL from servers array or default to stackone API - servers = self.spec.get("servers", [{"url": "https://api.stackone.com"}]) - default_url = servers[0]["url"] if isinstance(servers, list) else "https://api.stackone.com" - # Use provided base_url if available, otherwise use the default from the spec - self.base_url = base_url or default_url - - def _is_file_type(self, schema: dict[str, Any]) -> bool: - """Check if a schema represents a file upload.""" - return schema.get("type") == "string" and schema.get("format") == "binary" - - def _convert_to_file_type(self, schema: dict[str, Any]) -> None: - """Convert a binary string schema to a file type.""" - if self._is_file_type(schema): - schema["type"] = "file" - - def _handle_file_properties(self, schema: dict[str, Any]) -> None: - """Process schema properties to handle file uploads.""" - if "properties" not in schema: - return - - for prop_schema in schema["properties"].values(): - # Handle direct file uploads - self._convert_to_file_type(prop_schema) - - # Handle array of files - if prop_schema.get("type") == "array" and "items" in prop_schema: - self._convert_to_file_type(prop_schema["items"]) - - def _resolve_schema_ref( - self, ref: str, visited: set[str] | None = None - ) -> dict[str, Any] | list[Any] | str: - """ - Resolve a JSON schema reference in the OpenAPI spec - """ - if not ref.startswith("#/"): - raise ValueError(f"Only local references are supported: {ref}") - - if visited is None: - visited = set() - - if ref in visited: - raise ValueError(f"Circular reference detected: {ref}") - - visited.add(ref) - - parts = ref.split("/")[1:] # Skip the '#' - current = self.spec - for part in parts: - current = current[part] - - # After getting the referenced schema, resolve it fully - return self._resolve_schema(current, visited) - - def _resolve_schema( - self, schema: dict[str, Any] | list[Any] | str, visited: set[str] | None = None - ) -> dict[str, Any] | list[Any] | str: - """ - Resolve all references in a schema, preserving structure - """ - if visited is None: - visited = set() - - # Handle primitive types (str, int, etc) - if not isinstance(schema, (dict, list)): - return schema - - if isinstance(schema, list): - return [self._resolve_schema(item, visited.copy()) for item in schema] - - # Now we know schema is a dict - # Handle direct reference - if "$ref" in schema: - resolved = self._resolve_schema_ref(schema["$ref"], visited) - if not isinstance(resolved, dict): - return resolved - # Merge any additional properties from the original schema - return {**resolved, **{k: v for k, v in schema.items() if k != "$ref"}} - - # Handle allOf combinations - if "allOf" in schema: - merged_schema = {k: v for k, v in schema.items() if k != "allOf"} - - # Merge all schemas in allOf array - for sub_schema in schema["allOf"]: - resolved = self._resolve_schema(sub_schema, visited.copy()) - if not isinstance(resolved, dict): - continue - - # Merge properties - if "properties" in resolved: - if "properties" not in merged_schema: - merged_schema["properties"] = {} - merged_schema["properties"].update(resolved["properties"]) - - # Merge type and other fields - for key, value in resolved.items(): - if key != "properties" and key not in merged_schema: - merged_schema[key] = value - - return merged_schema - - # Recursively resolve all nested dictionaries and arrays - resolved = {} - for key, value in schema.items(): - if isinstance(value, dict): - resolved[key] = self._resolve_schema(value, visited.copy()) - elif isinstance(value, list): - resolved[key] = [self._resolve_schema(item, visited.copy()) for item in value] - else: - resolved[key] = value - - return resolved - - def _parse_content_schema( - self, content_type: str, content: dict[str, Any] - ) -> tuple[dict[str, Any] | None, str | None]: - """Parse schema from content object for a specific content type.""" - if content_type not in content: - return None, None - - type_content = content[content_type] - if not isinstance(type_content, dict): - return None, None - - schema = type_content.get("schema", {}) - resolved = self._resolve_schema(schema) - - if not isinstance(resolved, dict): - return None, None - - return resolved, content_type.split("/")[-1] - - def _parse_request_body(self, operation: dict) -> tuple[dict[str, Any] | None, str | None]: - """Parse request body schema and content type from operation""" - request_body = operation.get("requestBody", {}) - if not request_body: - return None, None - - content = request_body.get("content", {}) - - # Try JSON first - schema, body_type = self._parse_content_schema("application/json", content) - if schema: - return schema, body_type - - # Try multipart form-data (file uploads) - schema, _ = self._parse_content_schema("multipart/form-data", content) - if schema: - self._handle_file_properties(schema) - return schema, "multipart" - - # Try form-urlencoded - schema, body_type = self._parse_content_schema("application/x-www-form-urlencoded", content) - if schema: - return schema, "form" - - return None, None - - def _get_parameter_location(self, prop_schema: dict[str, Any]) -> str: - """Determine the parameter location based on schema type.""" - if prop_schema.get("type") == "file": - return "file" - if prop_schema.get("type") == "array" and prop_schema.get("items", {}).get("type") == "file": - return "file" - return "body" - - def parse_tools(self) -> dict[str, ToolDefinition]: - """Parse OpenAPI spec into tool definitions""" - tools = {} - - for path, path_item in self.spec.get("paths", {}).items(): - for method, operation in path_item.items(): - name = operation.get("operationId") - if not name: - raise ValueError(f"Operation ID is required for tool parsing: {operation}") - - # Parse request body if present - request_body_schema, body_type = self._parse_request_body(operation) - - # Track parameter locations and properties - parameter_locations = {} - properties = {} - - # Parse parameters - for param in operation.get("parameters", []): - param_name = param["name"] - param_location = param["in"] # header, query, path, cookie - parameter_locations[param_name] = param_location - - # Add to properties for tool parameters - schema = param.get("schema", {}).copy() - if "description" in param: - schema["description"] = param["description"] - properties[param_name] = self._resolve_schema(schema) - - # Add request body properties if present - if request_body_schema and isinstance(request_body_schema, dict): - body_props = request_body_schema.get("properties", {}) - for prop_name, prop_schema in body_props.items(): - properties[prop_name] = prop_schema - parameter_locations[prop_name] = self._get_parameter_location(prop_schema) - - # Create tool definition - tools[name] = ToolDefinition( - description=operation.get("summary", ""), - parameters=ToolParameters(type="object", properties=properties), - execute=ExecuteConfig( - method=method.upper(), - url=f"{self.base_url}{path}", - name=name, - parameter_locations=parameter_locations, - body_type=body_type, - ), - ) - - return tools diff --git a/stackone_ai/toolset.py b/stackone_ai/toolset.py index 26a5b0e..8b17da4 100644 --- a/stackone_ai/toolset.py +++ b/stackone_ai/toolset.py @@ -7,13 +7,11 @@ import json import os import threading -import warnings from collections.abc import Coroutine from dataclasses import dataclass from importlib import metadata from typing import Any, TypeVar -from stackone_ai.constants import OAS_DIR from stackone_ai.models import ( ExecuteConfig, ParameterLocation, @@ -21,7 +19,6 @@ ToolParameters, Tools, ) -from stackone_ai.specs.parser import OpenAPIParser try: _SDK_VERSION = metadata.version("stackone-ai") @@ -240,7 +237,7 @@ def __init__( Args: api_key: Optional API key. If not provided, will try to get from STACKONE_API_KEY env var account_id: Optional account ID - base_url: Optional base URL override for API requests. If not provided, uses the URL from the OAS + base_url: Optional base URL override for API requests Raises: ToolsetConfigError: If no API key is provided or found in environment @@ -256,26 +253,6 @@ def __init__( self.base_url = base_url or DEFAULT_BASE_URL self._account_ids: list[str] = [] - def _parse_parameters(self, parameters: list[dict[str, Any]]) -> dict[str, dict[str, str]]: - """Parse OpenAPI parameters into tool properties - - Args: - parameters: List of OpenAPI parameter objects - - Returns: - Dict of parameter properties with name as key and schema details as value - """ - properties: dict[str, dict[str, str]] = {} - for param in parameters: - if param["in"] == "path": - # Ensure we only include string values in the nested dict - param_schema = param["schema"] - properties[param["name"]] = { - "type": str(param_schema["type"]), - "description": str(param.get("description", "")), - } - return properties - def _matches_filter(self, tool_name: str, filter_pattern: str | list[str]) -> bool: """Check if a tool name matches the filter pattern @@ -465,83 +442,3 @@ def _normalize_schema_properties(self, schema: dict[str, Any]) -> dict[str, Any] normalized[str(name)] = prop return normalized - - def get_tool(self, name: str, *, account_id: str | None = None) -> StackOneTool | None: - """Get a specific tool by name - - Args: - name: Name of the tool to retrieve - account_id: Optional account ID override. If not provided, uses the one from initialization - - Returns: - The tool if found, None otherwise - - Raises: - ToolsetLoadError: If there is an error loading the tools - """ - tools = self.get_tools(name, account_id=account_id) - return tools.get_tool(name) - - def get_tools( - self, filter_pattern: str | list[str] | None = None, *, account_id: str | None = None - ) -> Tools: - """Get tools matching the specified filter pattern - - Args: - filter_pattern: Optional glob pattern or list of patterns to filter tools - (e.g. "hris_*", ["crm_*", "ats_*"]) - account_id: Optional account ID override. If not provided, uses the one from initialization - - Returns: - Collection of tools matching the filter pattern - - Raises: - ToolsetLoadError: If there is an error loading the tools - """ - if filter_pattern is None: - warnings.warn( - "No filter pattern provided. Loading all tools may exceed context windows in " - "AI applications.", - UserWarning, - stacklevel=2, - ) - - try: - all_tools: list[StackOneTool] = [] - effective_account_id = account_id or self.account_id - - # Load all available specs - for spec_file in OAS_DIR.glob("*.json"): - parser = OpenAPIParser(spec_file, base_url=self.base_url) - tool_definitions = parser.parse_tools() - - # Create tools and filter if pattern is provided - for _, tool_def in tool_definitions.items(): - if filter_pattern is None or self._matches_filter(tool_def.execute.name, filter_pattern): - tool = StackOneTool( - description=tool_def.description, - parameters=tool_def.parameters, - _execute_config=tool_def.execute, - _api_key=self.api_key, - _account_id=effective_account_id, - ) - all_tools.append(tool) - - # Add feedback collection meta tool - from .feedback import create_feedback_tool - - feedback_tool_name = "meta_collect_tool_feedback" - if filter_pattern is None or self._matches_filter(feedback_tool_name, filter_pattern): - feedback_tool = create_feedback_tool( - api_key=self.api_key, - account_id=effective_account_id, - base_url=self.base_url or "https://api.stackone.com", - ) - all_tools.append(feedback_tool) - - return Tools(all_tools) - - except Exception as e: - if isinstance(e, ToolsetError): - raise - raise ToolsetLoadError(f"Error loading tools: {e}") from e diff --git a/tests/snapshots/test_parser/test_parse_all_oas_specs/ats_tools.json b/tests/snapshots/test_parser/test_parse_all_oas_specs/ats_tools.json deleted file mode 100644 index 0df3dbe..0000000 --- a/tests/snapshots/test_parser/test_parse_all_oas_specs/ats_tools.json +++ /dev/null @@ -1,8634 +0,0 @@ -{ - "ats_create_application": { - "description": "Create Application", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "ats_create_application", - "parameter_locations": { - "application_status": "body", - "candidate": "body", - "candidate_id": "body", - "job_id": "body", - "job_posting_id": "body", - "location_id": "body", - "passthrough": "body", - "questionnaires": "body", - "source": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/applications" - }, - "parameters": { - "properties": { - "application_status": { - "nullable": true, - "properties": { - "source_value": { - "description": "The source value of the application status.", - "example": "Hired", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The status of the application.", - "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 - ], - "example": "hired", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "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, - "properties": { - "company": { - "description": "Candidate company", - "example": "Company Inc.", - "nullable": true, - "type": "string" - }, - "country": { - "description": "Candidate country", - "example": "United States", - "nullable": true, - "type": "string" - }, - "custom_fields": { - "description": "The candidate 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" - }, - "email": { - "description": "Candidate email", - "example": "sestier.romain123@gmail.com", - "nullable": true, - "type": "string" - }, - "first_name": { - "description": "Candidate first name", - "example": "Romain", - "nullable": true, - "type": "string" - }, - "hired_at": { - "description": "Candidate hired date", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "last_name": { - "description": "Candidate last name", - "example": "Sestier", - "nullable": true, - "type": "string" - }, - "name": { - "description": "Candidate name", - "example": "Romain Sestier", - "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 candidate personal phone number", - "example": "+1234567890", - "nullable": true, - "type": "string" - }, - "social_links": { - "description": "List of candidate social links", - "items": { - "properties": { - "type": { - "description": "Type of the social link", - "example": "linkedin", - "nullable": true, - "type": "string" - }, - "url": { - "description": "URL of the social link", - "example": "https://www.linkedin.com/in/romainsestier/", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "title": { - "description": "Candidate title", - "example": "Software Engineer", - "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" - }, - "candidate_id": { - "description": "Unique identifier of the candidate. Provide this OR candidate, but not both.", - "example": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", - "nullable": true, - "type": "string" - }, - "job_id": { - "description": "Unique identifier of the job", - "example": "4071538b-3cac-4fbf-ac76-f78ed250ffdd", - "nullable": true, - "type": "string" - }, - "job_posting_id": { - "description": "Unique identifier of the job posting that is associated with application", - "example": "1c702a20-8de8-4d03-ac18-cbf4ac42eb51", - "nullable": true, - "type": "string" - }, - "location_id": { - "description": "Unique identifier of the location", - "example": "dd8d41d1-5eb8-4408-9c87-9ba44604eae4", - "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" - }, - "questionnaires": { - "description": "Questionnaires associated with the application", - "example": { - "answers": [ - { - "id": "answer1", - "type": "text", - "values": [ - "Yes" - ] - } - ], - "id": "right_to_work" - }, - "items": { - "properties": { - "answers": { - "items": { - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Type of the answer", - "nullable": true, - "properties": { - "source_value": { - "description": "The source value of the answer type.", - "example": "Short Text", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The type of the answer.", - "enum": [ - "short_text", - "long_text", - "attachment", - "multi_select", - "single_select", - "boolean", - "number", - "date", - "video", - null - ], - "example": "short_text", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "values": { - "description": "Values of the answer", - "example": [ - "Yes", - "No Travel", - "It sounds pretty cool.", - "Excel", - "Power Point" - ], - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "source": { - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - }, - "name": { - "description": "The source of the application", - "example": "LinkedIn", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "ats_create_application_note": { - "description": "Create Application Note", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "ats_create_application_note", - "parameter_locations": { - "author_id": "body", - "content": "body", - "id": "path", - "passthrough": "body", - "visibility": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/applications/{id}/notes" - }, - "parameters": { - "properties": { - "author_id": { - "description": "Unique identifier of the author", - "example": "1234567890", - "nullable": true, - "type": "string" - }, - "content": { - "items": { - "properties": { - "body": { - "description": "Body of the note", - "example": "This candidate seems like a good fit for the role", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "id": { - "type": "string" - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe" - }, - "nullable": true, - "type": "object" - }, - "visibility": { - "description": "Visibility of the note", - "example": "public", - "nullable": true, - "properties": { - "source_value": { - "description": "The source value of the notes visibility.", - "example": "Public", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The visibility of the notes.", - "enum": [ - "private", - "public", - null - ], - "example": "public", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "ats_create_background_check_package": { - "description": "Create Background Check Package", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "ats_create_background_check_package", - "parameter_locations": { - "description": "body", - "name": "body", - "passthrough": "body", - "tests": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/background_checks/packages" - }, - "parameters": { - "properties": { - "description": { - "description": "Package description", - "example": "Skills test to gauge a candidate's proficiency in job-specific skills", - "nullable": true, - "type": "string" - }, - "name": { - "description": "Package name", - "example": "Test 1", - "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" - }, - "tests": { - "description": "Package tests", - "items": { - "properties": { - "description": { - "description": "Package description", - "example": "Skills test to gauge a candidate's proficiency in job-specific skills", - "nullable": true, - "type": "string" - }, - "name": { - "description": "Package name", - "example": "Test 1", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "ats_create_candidate": { - "description": "Create Candidate", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "ats_create_candidate", - "parameter_locations": { - "company": "body", - "country": "body", - "custom_fields": "body", - "email": "body", - "first_name": "body", - "hired_at": "body", - "last_name": "body", - "name": "body", - "passthrough": "body", - "phone_number": "body", - "social_links": "body", - "title": "body", - "unified_custom_fields": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/candidates" - }, - "parameters": { - "properties": { - "company": { - "description": "Candidate company", - "example": "Company Inc.", - "nullable": true, - "type": "string" - }, - "country": { - "description": "Candidate country", - "example": "United States", - "nullable": true, - "type": "string" - }, - "custom_fields": { - "description": "The candidate 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" - }, - "email": { - "description": "Candidate email", - "example": "sestier.romain123@gmail.com", - "nullable": true, - "type": "string" - }, - "first_name": { - "description": "Candidate first name", - "example": "Romain", - "nullable": true, - "type": "string" - }, - "hired_at": { - "description": "Candidate hired date", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "last_name": { - "description": "Candidate last name", - "example": "Sestier", - "nullable": true, - "type": "string" - }, - "name": { - "description": "Candidate name", - "example": "Romain Sestier", - "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 candidate personal phone number", - "example": "+1234567890", - "nullable": true, - "type": "string" - }, - "social_links": { - "description": "List of candidate social links", - "items": { - "properties": { - "type": { - "description": "Type of the social link", - "example": "linkedin", - "nullable": true, - "type": "string" - }, - "url": { - "description": "URL of the social link", - "example": "https://www.linkedin.com/in/romainsestier/", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "title": { - "description": "Candidate title", - "example": "Software Engineer", - "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" - } - }, - "type": "object" - } - }, - "ats_create_candidate_note": { - "description": "Create Candidate Note", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "ats_create_candidate_note", - "parameter_locations": { - "author_id": "body", - "content": "body", - "id": "path", - "passthrough": "body", - "visibility": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/candidates/{id}/notes" - }, - "parameters": { - "properties": { - "author_id": { - "description": "Unique identifier of the author", - "example": "1234567890", - "nullable": true, - "type": "string" - }, - "content": { - "items": { - "properties": { - "body": { - "description": "Body of the note", - "example": "This candidate seems like a good fit for the role", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "id": { - "type": "string" - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe" - }, - "nullable": true, - "type": "object" - }, - "visibility": { - "description": "Visibility of the note", - "example": "public", - "nullable": true, - "properties": { - "source_value": { - "description": "The source value of the notes visibility.", - "example": "Public", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The visibility of the notes.", - "enum": [ - "private", - "public", - null - ], - "example": "public", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "ats_create_job": { - "description": "Create Job", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "ats_create_job", - "parameter_locations": { - "code": "body", - "confidential": "body", - "custom_fields": "body", - "department_ids": "body", - "hiring_team": "body", - "interview_stages": "body", - "job_status": "body", - "location_ids": "body", - "passthrough": "body", - "status": "body", - "title": "body", - "unified_custom_fields": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/jobs" - }, - "parameters": { - "properties": { - "code": { - "description": "Code of the job", - "example": "184919", - "nullable": true, - "type": "string" - }, - "confidential": { - "description": "Confidential status of the job", - "enum": [ - "true", - "false", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - }, - "custom_fields": { - "description": "The job 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" - }, - "department_ids": { - "description": "Department ids of the job", - "example": [ - "308570", - "308571", - "308572" - ], - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "hiring_team": { - "description": "Hiring team for the job.", - "items": { - "properties": { - "email": { - "description": "Email of the hiring team member.", - "example": "john.doe@gmail.com", - "nullable": true, - "type": "string" - }, - "first_name": { - "description": "First name of the hiring team member.", - "example": "John", - "nullable": true, - "type": "string" - }, - "last_name": { - "description": "Last name of the hiring team member.", - "example": "Doe", - "nullable": true, - "type": "string" - }, - "remote_user_id": { - "description": "Provider's unique identifier of the user", - "example": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", - "nullable": true, - "type": "string" - }, - "role": { - "description": "Role of the hiring team member.", - "example": "Software Engineer", - "nullable": true, - "type": "string" - }, - "user_id": { - "description": "User ID of the hiring team member.", - "example": "123456", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "interview_stages": { - "description": "Interview stages for the job.", - "items": { - "properties": { - "created_at": { - "description": "Interview Stage created date", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - }, - "name": { - "nullable": true, - "type": "string" - }, - "order": { - "nullable": true, - "type": "number" - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "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" - }, - "updated_at": { - "description": "Interview Stage updated date", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "job_status": { - "description": "Status of the job", - "nullable": true, - "properties": { - "source_value": { - "description": "The source value of the job status.", - "example": "Published", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The status of the job.", - "enum": [ - "published", - "draft", - "pending", - "internal", - "archived", - "closed", - "open", - "deleted", - "on_hold", - "unmapped_value", - null - ], - "example": "published", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "location_ids": { - "description": "Location ids of the job", - "example": [ - "668570", - "678571", - "688572" - ], - "items": { - "type": "string" - }, - "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" - }, - "status": { - "deprecated": true, - "description": "Status of the job", - "example": "archived", - "nullable": true, - "type": "string" - }, - "title": { - "description": "Title of the job", - "example": "Software Engineer", - "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" - } - }, - "type": "object" - } - }, - "ats_create_offer": { - "description": "Creates an offer", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "ats_create_offer", - "parameter_locations": { - "application_id": "body", - "currency": "body", - "offer_history": "body", - "offer_status": "body", - "passthrough": "body", - "salary": "body", - "start_date": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/offers" - }, - "parameters": { - "properties": { - "application_id": { - "nullable": true, - "type": "string" - }, - "currency": { - "nullable": true, - "type": "string" - }, - "offer_history": { - "items": { - "properties": { - "created_at": { - "description": "Date of creation", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "currency": { - "nullable": true, - "type": "string" - }, - "salary": { - "nullable": true, - "type": "number" - }, - "start_date": { - "description": "Start Date of the offer", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "updated_at": { - "description": "Date of last update", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "offer_status": { - "nullable": true, - "properties": { - "source_value": { - "description": "The source value of the offer status.", - "example": "Pending", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The status of the offer.", - "enum": [ - "pending", - "retracted", - "accepted", - "rejected", - "created", - "approved", - "not_approved", - "unmapped_value", - null - ], - "example": "pending", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe" - }, - "nullable": true, - "type": "object" - }, - "salary": { - "nullable": true, - "type": "number" - }, - "start_date": { - "description": "Date of creation", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "ats_download_application_document": { - "description": "Download Application Document", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_download_application_document", - "parameter_locations": { - "format": "query", - "id": "path", - "subResourceId": "path", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/applications/{id}/documents/{subResourceId}/download" - }, - "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" - } - }, - "type": "object" - } - }, - "ats_get_application": { - "description": "Get Application", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_get_application", - "parameter_locations": { - "expand": "query", - "fields": "query", - "id": "path", - "include": "query", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/applications/{id}" - }, - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "documents", - "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,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,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", - "nullable": true, - "type": "string" - }, - "id": { - "type": "string" - }, - "include": { - "description": "The comma separated list of fields that will be included in the response", - "example": "attachments,custom_fields", - "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" - } - }, - "type": "object" - } - }, - "ats_get_application_custom_field_definition": { - "description": "Get Application Custom Field Definition", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_get_application_custom_field_definition", - "parameter_locations": { - "fields": "query", - "filter": "query", - "id": "path", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/custom_field_definitions/applications/{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", - "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" - } - }, - "type": "object" - } - }, - "ats_get_application_document": { - "description": "Get Application Document", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_get_application_document", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "subResourceId": "path", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/applications/{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,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" - } - }, - "type": "object" - } - }, - "ats_get_application_note": { - "description": "Get Application Note", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_get_application_note", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "subResourceId": "path", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/applications/{id}/notes/{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,content,author_id,remote_author_id,visibility,created_at,updated_at,deleted_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" - } - }, - "type": "object" - } - }, - "ats_get_application_offer": { - "description": "Get Application Offer", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_get_application_offer", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "subResourceId": "path", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/applications/{id}/offers/{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,application_id,remote_application_id,start_date,status,offer_status,salary,currency,created_at,updated_at,offer_history", - "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" - } - }, - "type": "object" - } - }, - "ats_get_application_scheduled_interview": { - "description": "Get Applications scheduled interview", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_get_application_scheduled_interview", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "subResourceId": "path", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/applications/{id}/scheduled_interviews/{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,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,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", - "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" - } - }, - "type": "object" - } - }, - "ats_get_application_scorecard": { - "description": "Get Application Scorecard", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_get_application_scorecard", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "subResourceId": "path", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/applications/{id}/scorecards/{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,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", - "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" - } - }, - "type": "object" - } - }, - "ats_get_assessments_package": { - "description": "Get Assessments Package", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_get_assessments_package", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/assessments/packages/{id}" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields to return in the response (if empty, all fields are returned)", - "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" - } - }, - "type": "object" - } - }, - "ats_get_assessments_request": { - "description": "Get Assessments Requests", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_get_assessments_request", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/assessments/orders/{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,package,application,job,candidate,requester,results_update_url", - "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" - } - }, - "type": "object" - } - }, - "ats_get_assessments_result": { - "description": "Get Assessments Results", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_get_assessments_result", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/assessments/orders/{id}/results" - }, - "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,candidate,score,start_date,submission_date,summary,result,result_url,attachments", - "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" - } - }, - "type": "object" - } - }, - "ats_get_background_check_package": { - "description": "Get Background Check Package", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_get_background_check_package", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/background_checks/packages/{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,tests", - "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" - } - }, - "type": "object" - } - }, - "ats_get_background_check_request": { - "description": "Get Background Check Request", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_get_background_check_request", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/background_checks/orders/{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,package,application,job,candidate,requester,results_update_url", - "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" - } - }, - "type": "object" - } - }, - "ats_get_background_check_result": { - "description": "Get Background Check Results", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_get_background_check_result", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/background_checks/orders/{id}/results" - }, - "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,candidate,score,start_date,submission_date,summary,result,result_url,attachments", - "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" - } - }, - "type": "object" - } - }, - "ats_get_candidate": { - "description": "Get Candidate", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_get_candidate", - "parameter_locations": { - "fields": "query", - "id": "path", - "include": "query", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/candidates/{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,first_name,last_name,email,emails,social_links,phone,phone_numbers,company,country,title,application_ids,remote_application_ids,hired_at,custom_fields,created_at,updated_at", - "nullable": true, - "type": "string" - }, - "id": { - "type": "string" - }, - "include": { - "description": "The comma separated list of fields that will be included in the response", - "example": "custom_fields", - "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" - } - }, - "type": "object" - } - }, - "ats_get_candidate_custom_field_definition": { - "description": "Get Candidate Custom Field Definition", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_get_candidate_custom_field_definition", - "parameter_locations": { - "fields": "query", - "filter": "query", - "id": "path", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/custom_field_definitions/candidates/{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", - "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" - } - }, - "type": "object" - } - }, - "ats_get_candidate_note": { - "description": "Get Candidate Note", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_get_candidate_note", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "subResourceId": "path", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/candidates/{id}/notes/{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,content,author_id,remote_author_id,visibility,created_at,updated_at,deleted_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" - } - }, - "type": "object" - } - }, - "ats_get_department": { - "description": "Get Department", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_get_department", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/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", - "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" - } - }, - "type": "object" - } - }, - "ats_get_interview": { - "description": "Get Interview", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_get_interview", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/interviews/{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,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", - "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" - } - }, - "type": "object" - } - }, - "ats_get_interview_stage": { - "description": "Get Interview Stage", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_get_interview_stage", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/interview_stages/{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,order,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" - } - }, - "type": "object" - } - }, - "ats_get_job": { - "description": "Get Job", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_get_job", - "parameter_locations": { - "expand": "query", - "fields": "query", - "id": "path", - "include": "query", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/jobs/{id}" - }, - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "job_postings,interview_stages", - "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,code,title,status,job_status,department_ids,remote_department_ids,location_ids,remote_location_ids,hiring_team,interview_stages,confidential,custom_fields,created_at,updated_at", - "nullable": true, - "type": "string" - }, - "id": { - "type": "string" - }, - "include": { - "description": "The comma separated list of fields that will be included in the response", - "example": "custom_fields", - "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" - } - }, - "type": "object" - } - }, - "ats_get_job_custom_field_definition": { - "description": "Get Job Custom Field Definition", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_get_job_custom_field_definition", - "parameter_locations": { - "fields": "query", - "filter": "query", - "id": "path", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/custom_field_definitions/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,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" - } - }, - "type": "object" - } - }, - "ats_get_job_posting": { - "description": "Get Job Posting", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_get_job_posting", - "parameter_locations": { - "fields": "query", - "id": "path", - "include": "query", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/job_postings/{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,title,locations,internal,status,job_id,remote_job_id,content,compensation,employment_type,employment_contract_type,external_url,external_apply_url,questionnaires,updated_at,created_at", - "nullable": true, - "type": "string" - }, - "id": { - "type": "string" - }, - "include": { - "description": "The comma separated list of fields that will be included in the response", - "example": "questionnaires", - "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" - } - }, - "type": "object" - } - }, - "ats_get_list": { - "description": "Get List", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_get_list", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/lists/{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,created_at,updated_at,items,type", - "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" - } - }, - "type": "object" - } - }, - "ats_get_location": { - "description": "Get Location", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_get_location", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/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,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" - } - }, - "type": "object" - } - }, - "ats_get_offer": { - "description": "Get Offer", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_get_offer", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/offers/{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,application_id,remote_application_id,start_date,status,offer_status,salary,currency,created_at,updated_at,offer_history", - "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" - } - }, - "type": "object" - } - }, - "ats_get_rejected_reason": { - "description": "Get Rejected Reason", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_get_rejected_reason", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/rejected_reasons/{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,label,type,rejected_reason_type", - "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" - } - }, - "type": "object" - } - }, - "ats_get_user": { - "description": "Get User", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_get_user", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/users/{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,first_name,last_name,name,email", - "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" - } - }, - "type": "object" - } - }, - "ats_list_application_custom_field_definitions": { - "description": "List Application Custom Field Definitions", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_list_application_custom_field_definitions", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/custom_field_definitions/applications" - }, - "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" - } - }, - "type": "object" - } - }, - "ats_list_application_documents": { - "description": "List Application Documents", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_list_application_documents", - "parameter_locations": { - "fields": "query", - "filter": "query", - "id": "path", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "sync_token": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/applications/{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,path,type,category,category_id,remote_category_id,contents,created_at,updated_at,remote_url,file_format", - "nullable": true, - "type": "string" - }, - "filter": { - "description": "ATS Document Filter", - "nullable": true, - "properties": { - "type": { - "description": "Filter to select documents by type", - "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" - }, - "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" - }, - "sync_token": { - "description": "The sync token to select the only updated results", - "nullable": true, - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "ats_list_application_notes": { - "description": "List Application Notes", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_list_application_notes", - "parameter_locations": { - "fields": "query", - "filter": "query", - "id": "path", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "sync_token": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/applications/{id}/notes" - }, - "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,content,author_id,remote_author_id,visibility,created_at,updated_at,deleted_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" - }, - "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" - }, - "sync_token": { - "description": "The sync token to select the only updated results", - "nullable": true, - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "ats_list_application_scorecards": { - "description": "List Application Scorecards", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_list_application_scorecards", - "parameter_locations": { - "fields": "query", - "filter": "query", - "id": "path", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "sync_token": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/applications/{id}/scorecards" - }, - "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,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", - "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" - }, - "sync_token": { - "description": "The sync token to select the only updated results", - "nullable": true, - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "ats_list_applications": { - "description": "List Applications", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_list_applications", - "parameter_locations": { - "expand": "query", - "fields": "query", - "filter": "query", - "include": "query", - "job_id": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "sync_token": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/applications" - }, - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "documents", - "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,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,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", - "nullable": true, - "type": "string" - }, - "filter": { - "description": "ATS Application Filter", - "nullable": true, - "properties": { - "created_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results created after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string" - }, - "job_id": { - "description": "Filter to select applications by job_id", - "nullable": true, - "type": "string" - }, - "stage": { - "description": "Filter to select applications by stage and sub-stage", - "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": "attachments,custom_fields", - "nullable": true, - "type": "string" - }, - "job_id": { - "description": "Filter for job ID to retrieve a list of applications related to this job", - "example": "cxQiyiuasdFKfdsYfer", - "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" - }, - "sync_token": { - "description": "The sync token to select the only updated results", - "nullable": true, - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "ats_list_applications_offers": { - "description": "List Application Offers", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_list_applications_offers", - "parameter_locations": { - "fields": "query", - "filter": "query", - "id": "path", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "sync_token": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/applications/{id}/offers" - }, - "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,application_id,remote_application_id,start_date,status,offer_status,salary,currency,created_at,updated_at,offer_history", - "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" - }, - "sync_token": { - "description": "The sync token to select the only updated results", - "nullable": true, - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "ats_list_applications_scheduled_interviews": { - "description": "List Applications scheduled interviews", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_list_applications_scheduled_interviews", - "parameter_locations": { - "fields": "query", - "filter": "query", - "id": "path", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "sync_token": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/applications/{id}/scheduled_interviews" - }, - "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,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", - "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" - }, - "sync_token": { - "description": "The sync token to select the only updated results", - "nullable": true, - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "ats_list_assessments_packages": { - "description": "List Assessments Packages", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_list_assessments_packages", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/assessments/packages" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields to return in the response (if empty, all fields are returned)", - "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" - } - }, - "type": "object" - } - }, - "ats_list_background_check_packages": { - "description": "List Background Check Packages", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_list_background_check_packages", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/background_checks/packages" - }, - "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,tests", - "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" - } - }, - "type": "object" - } - }, - "ats_list_background_check_request": { - "description": "List Background Check Request", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_list_background_check_request", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/background_checks/orders" - }, - "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,package,application,job,candidate,requester,results_update_url", - "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" - } - }, - "type": "object" - } - }, - "ats_list_candidate_custom_field_definitions": { - "description": "List Candidate Custom Field Definitions", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_list_candidate_custom_field_definitions", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/custom_field_definitions/candidates" - }, - "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" - } - }, - "type": "object" - } - }, - "ats_list_candidate_notes": { - "description": "List Candidate Notes", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_list_candidate_notes", - "parameter_locations": { - "fields": "query", - "filter": "query", - "id": "path", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "sync_token": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/candidates/{id}/notes" - }, - "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,content,author_id,remote_author_id,visibility,created_at,updated_at,deleted_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" - }, - "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" - }, - "sync_token": { - "description": "The sync token to select the only updated results", - "nullable": true, - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "ats_list_candidates": { - "description": "List Candidates", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_list_candidates", - "parameter_locations": { - "fields": "query", - "filter": "query", - "include": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "sync_token": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/candidates" - }, - "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,first_name,last_name,email,emails,social_links,phone,phone_numbers,company,country,title,application_ids,remote_application_ids,hired_at,custom_fields,created_at,updated_at", - "nullable": true, - "type": "string" - }, - "filter": { - "description": "ATS Candidate Filter", - "nullable": true, - "properties": { - "created_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results created after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string" - }, - "email": { - "description": "Filter to select candidates by email", - "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": "custom_fields", - "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" - }, - "sync_token": { - "description": "The sync token to select the only updated results", - "nullable": true, - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "ats_list_departments": { - "description": "List Departments", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_list_departments", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "sync_token": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/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", - "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" - }, - "sync_token": { - "description": "The sync token to select the only updated results", - "nullable": true, - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "ats_list_interview_stages": { - "description": "List Interview Stages", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_list_interview_stages", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "sync_token": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/interview_stages" - }, - "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,order,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" - }, - "sync_token": { - "description": "The sync token to select the only updated results", - "nullable": true, - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "ats_list_interviews": { - "description": "List Interviews", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_list_interviews", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "sync_token": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/interviews" - }, - "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,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", - "nullable": true, - "type": "string" - }, - "filter": { - "description": "ATS Interviews Filter", - "nullable": true, - "properties": { - "created_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results created after that given date", - "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" - }, - "sync_token": { - "description": "The sync token to select the only updated results", - "nullable": true, - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "ats_list_job_custom_field_definitions": { - "description": "List Job Custom Field Definitions", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_list_job_custom_field_definitions", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/custom_field_definitions/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,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" - } - }, - "type": "object" - } - }, - "ats_list_job_postings": { - "description": "List Job Postings", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_list_job_postings", - "parameter_locations": { - "fields": "query", - "filter": "query", - "include": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "sync_token": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/job_postings" - }, - "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,title,locations,internal,status,job_id,remote_job_id,content,compensation,employment_type,employment_contract_type,external_url,external_apply_url,questionnaires,updated_at,created_at", - "nullable": true, - "type": "string" - }, - "filter": { - "description": "ATS Job Postings Filter", - "nullable": true, - "properties": { - "created_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results created after that given date", - "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" - }, - "include": { - "description": "The comma separated list of fields that will be included in the response", - "example": "questionnaires", - "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" - }, - "sync_token": { - "description": "The sync token to select the only updated results", - "nullable": true, - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "ats_list_jobs": { - "description": "List Jobs", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_list_jobs", - "parameter_locations": { - "expand": "query", - "fields": "query", - "filter": "query", - "include": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "sync_token": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/jobs" - }, - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "example": "job_postings,interview_stages", - "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,code,title,status,job_status,department_ids,remote_department_ids,location_ids,remote_location_ids,hiring_team,interview_stages,confidential,custom_fields,created_at,updated_at", - "nullable": true, - "type": "string" - }, - "filter": { - "description": "ATS Jobs filters", - "nullable": true, - "properties": { - "created_after": { - "additionalProperties": false, - "description": "Use a string with a date to only select results created after that given date", - "example": "2020-01-01T00:00:00.000Z", - "nullable": true, - "type": "string" - }, - "job_status": { - "description": "The job_status of the job", - "enum": [ - "open", - "draft", - null - ], - "nullable": true, - "type": "string" - }, - "status": { - "deprecated": true, - "description": "The status of the job", - "enum": [ - "open", - "draft", - null - ], - "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": "custom_fields", - "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" - }, - "sync_token": { - "description": "The sync token to select the only updated results", - "nullable": true, - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "ats_list_lists": { - "description": "Get all Lists", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_list_lists", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/lists" - }, - "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,created_at,updated_at,items,type", - "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" - } - }, - "type": "object" - } - }, - "ats_list_locations": { - "description": "List locations", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_list_locations", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "sync_token": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/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,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" - }, - "sync_token": { - "description": "The sync token to select the only updated results", - "nullable": true, - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "ats_list_offers": { - "description": "List Offers", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_list_offers", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "sync_token": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/offers" - }, - "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,application_id,remote_application_id,start_date,status,offer_status,salary,currency,created_at,updated_at,offer_history", - "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" - }, - "sync_token": { - "description": "The sync token to select the only updated results", - "nullable": true, - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "ats_list_rejected_reasons": { - "description": "List Rejected Reasons", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_list_rejected_reasons", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "sync_token": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/rejected_reasons" - }, - "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,label,type,rejected_reason_type", - "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" - }, - "sync_token": { - "description": "The sync token to select the only updated results", - "nullable": true, - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "ats_list_users": { - "description": "List Users", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "ats_list_users", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "sync_token": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/users" - }, - "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,first_name,last_name,name,email", - "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" - }, - "sync_token": { - "description": "The sync token to select the only updated results", - "nullable": true, - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "ats_move_application": { - "description": "Move Application", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "ats_move_application", - "parameter_locations": { - "id": "path", - "interview_stage_id": "body", - "passthrough": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/applications/{id}/move" - }, - "parameters": { - "properties": { - "id": { - "type": "string" - }, - "interview_stage_id": { - "description": "Unique identifier of the application stage.", - "example": "f223d7f6-908b-48f0-9237-b201c307f609", - "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" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "ats_order_assessments_request": { - "description": "Order Assessments Request", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "ats_order_assessments_request", - "parameter_locations": { - "application": "body", - "candidate": "body", - "id": "body", - "job": "body", - "package": "body", - "passthrough": "body", - "requester": "body", - "results_update_url": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/assessments/orders" - }, - "parameters": { - "properties": { - "application": { - "nullable": true, - "properties": { - "application_status": { - "nullable": true, - "properties": { - "source_value": { - "description": "The source value of the application status.", - "example": "Hired", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The status of the application.", - "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 - ], - "example": "hired", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "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" - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "candidate": { - "nullable": true, - "properties": { - "emails": { - "description": "List of candidate emails", - "items": { - "properties": { - "type": { - "description": "Type of the email", - "example": "personal", - "nullable": true, - "type": "string" - }, - "value": { - "description": "Email value", - "example": "sestier.romain123@gmail.com", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "first_name": { - "description": "Candidate first name", - "example": "Romain", - "nullable": true, - "type": "string" - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - }, - "last_name": { - "description": "Candidate last name", - "example": "Sestier", - "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" - }, - "profile_url": { - "description": "Candidate profile url", - "example": "https://exmaple.com/candidate?id=xyz", - "nullable": true, - "type": "string" - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - }, - "job": { - "nullable": true, - "properties": { - "hiring_team": { - "description": "Hiring team for the job.", - "items": { - "properties": { - "email": { - "description": "Email of the hiring team member.", - "example": "john.doe@gmail.com", - "nullable": true, - "type": "string" - }, - "first_name": { - "description": "First name of the hiring team member.", - "example": "John", - "nullable": true, - "type": "string" - }, - "last_name": { - "description": "Last name of the hiring team member.", - "example": "Doe", - "nullable": true, - "type": "string" - }, - "remote_user_id": { - "description": "Provider's unique identifier of the user", - "example": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", - "nullable": true, - "type": "string" - }, - "role": { - "description": "Role of the hiring team member.", - "example": "Software Engineer", - "nullable": true, - "type": "string" - }, - "user_id": { - "description": "User ID of the hiring team member.", - "example": "123456", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "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" - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - }, - "title": { - "description": "Title of the job", - "example": "Software Engineer", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "package": { - "nullable": true, - "properties": { - "description": { - "description": "Package description", - "example": "Skills test to gauge a candidate's proficiency in job-specific skills", - "nullable": true, - "type": "string" - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - }, - "name": { - "description": "Package name", - "example": "Test 1", - "nullable": true, - "type": "string" - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe" - }, - "nullable": true, - "type": "object" - }, - "requester": { - "nullable": true, - "properties": { - "email": { - "description": "Email of the hiring team member.", - "example": "john.doe@gmail.com", - "nullable": true, - "type": "string" - }, - "first_name": { - "description": "First name of the hiring team member.", - "example": "John", - "nullable": true, - "type": "string" - }, - "last_name": { - "description": "Last name of the hiring team member.", - "example": "Doe", - "nullable": true, - "type": "string" - }, - "remote_user_id": { - "description": "Provider's unique identifier of the user", - "example": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", - "nullable": true, - "type": "string" - }, - "role": { - "description": "Role of the hiring team member.", - "example": "Software Engineer", - "nullable": true, - "type": "string" - }, - "user_id": { - "description": "User ID of the hiring team member.", - "example": "123456", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "results_update_url": { - "description": "Results update url", - "example": "https://exmaple.com/integrations/results/update", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "ats_order_background_check_request": { - "description": "Order Background Check Request", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "ats_order_background_check_request", - "parameter_locations": { - "application": "body", - "candidate": "body", - "id": "body", - "job": "body", - "package": "body", - "passthrough": "body", - "remote_id": "body", - "requester": "body", - "results_update_url": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/background_checks/orders" - }, - "parameters": { - "properties": { - "application": { - "nullable": true, - "properties": { - "application_status": { - "nullable": true, - "properties": { - "source_value": { - "description": "The source value of the application status.", - "example": "Hired", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The status of the application.", - "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 - ], - "example": "hired", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "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" - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "candidate": { - "nullable": true, - "properties": { - "emails": { - "description": "List of candidate emails", - "items": { - "properties": { - "type": { - "description": "Type of the email", - "example": "personal", - "nullable": true, - "type": "string" - }, - "value": { - "description": "Email value", - "example": "sestier.romain123@gmail.com", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "first_name": { - "description": "Candidate first name", - "example": "Romain", - "nullable": true, - "type": "string" - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - }, - "last_name": { - "description": "Candidate last name", - "example": "Sestier", - "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" - }, - "profile_url": { - "description": "Candidate profile url", - "example": "https://exmaple.com/candidate?id=xyz", - "nullable": true, - "type": "string" - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - }, - "job": { - "nullable": true, - "properties": { - "hiring_team": { - "description": "Hiring team for the job.", - "items": { - "properties": { - "email": { - "description": "Email of the hiring team member.", - "example": "john.doe@gmail.com", - "nullable": true, - "type": "string" - }, - "first_name": { - "description": "First name of the hiring team member.", - "example": "John", - "nullable": true, - "type": "string" - }, - "last_name": { - "description": "Last name of the hiring team member.", - "example": "Doe", - "nullable": true, - "type": "string" - }, - "remote_user_id": { - "description": "Provider's unique identifier of the user", - "example": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", - "nullable": true, - "type": "string" - }, - "role": { - "description": "Role of the hiring team member.", - "example": "Software Engineer", - "nullable": true, - "type": "string" - }, - "user_id": { - "description": "User ID of the hiring team member.", - "example": "123456", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "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" - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - }, - "title": { - "description": "Title of the job", - "example": "Software Engineer", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "package": { - "nullable": true, - "properties": { - "description": { - "description": "Package description", - "example": "Skills test to gauge a candidate's proficiency in job-specific skills", - "nullable": true, - "type": "string" - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - }, - "name": { - "description": "Package name", - "example": "Test 1", - "nullable": true, - "type": "string" - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - }, - "tests": { - "description": "Package tests", - "items": { - "properties": { - "description": { - "description": "Package description", - "example": "Skills test to gauge a candidate's proficiency in job-specific skills", - "nullable": true, - "type": "string" - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - }, - "name": { - "description": "Package name", - "example": "Test 1", - "nullable": true, - "type": "string" - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - } - }, - "type": "object" - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe" - }, - "nullable": true, - "type": "object" - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - }, - "requester": { - "nullable": true, - "properties": { - "email": { - "description": "Email of the hiring team member.", - "example": "john.doe@gmail.com", - "nullable": true, - "type": "string" - }, - "first_name": { - "description": "First name of the hiring team member.", - "example": "John", - "nullable": true, - "type": "string" - }, - "last_name": { - "description": "Last name of the hiring team member.", - "example": "Doe", - "nullable": true, - "type": "string" - }, - "remote_user_id": { - "description": "Provider's unique identifier of the user", - "example": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", - "nullable": true, - "type": "string" - }, - "role": { - "description": "Role of the hiring team member.", - "example": "Software Engineer", - "nullable": true, - "type": "string" - }, - "user_id": { - "description": "User ID of the hiring team member.", - "example": "123456", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "results_update_url": { - "description": "Results update url", - "example": "https://exmaple.com/integrations/results/update", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "ats_reject_application": { - "description": "Reject Application", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "ats_reject_application", - "parameter_locations": { - "id": "path", - "passthrough": "body", - "rejected_reason_id": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/applications/{id}/reject" - }, - "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" - }, - "rejected_reason_id": { - "description": "Unique identifier of the rejection reason", - "example": "f223d7f6-908b-48f0-9237-b201c307f609", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "ats_update_application": { - "description": "Update an Application", - "execute": { - "body_type": "json", - "headers": {}, - "method": "PATCH", - "name": "ats_update_application", - "parameter_locations": { - "application_status": "body", - "custom_fields": "body", - "id": "path", - "passthrough": "body", - "source": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/applications/{id}" - }, - "parameters": { - "properties": { - "application_status": { - "nullable": true, - "properties": { - "source_value": { - "description": "The source value of the application status.", - "example": "Hired", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The status of the application.", - "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 - ], - "example": "hired", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "custom_fields": { - "description": "The application 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" - }, - "id": { - "type": "string" - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe" - }, - "nullable": true, - "type": "object" - }, - "source": { - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - }, - "name": { - "description": "The source of the application", - "example": "LinkedIn", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "ats_update_application_note": { - "description": "Update an Application Note", - "execute": { - "body_type": "json", - "headers": {}, - "method": "PATCH", - "name": "ats_update_application_note", - "parameter_locations": { - "author_id": "body", - "content": "body", - "id": "path", - "passthrough": "body", - "subResourceId": "path", - "visibility": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/applications/{id}/notes/{subResourceId}" - }, - "parameters": { - "properties": { - "author_id": { - "description": "Unique identifier of the author", - "example": "1234567890", - "nullable": true, - "type": "string" - }, - "content": { - "items": { - "properties": { - "body": { - "description": "Body of the note", - "example": "This candidate seems like a good fit for the role", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "id": { - "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" - }, - "visibility": { - "description": "Visibility of the note", - "example": "public", - "nullable": true, - "properties": { - "source_value": { - "description": "The source value of the notes visibility.", - "example": "Public", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The visibility of the notes.", - "enum": [ - "private", - "public", - null - ], - "example": "public", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "ats_update_assessments_result": { - "description": "Update Assessments Result", - "execute": { - "body_type": "json", - "headers": {}, - "method": "PATCH", - "name": "ats_update_assessments_result", - "parameter_locations": { - "attachments": "body", - "candidate": "body", - "id": "body", - "passthrough": "body", - "result": "body", - "result_url": "body", - "score": "body", - "start_date": "body", - "submission_date": "body", - "summary": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/assessments/orders/{id}/result" - }, - "parameters": { - "properties": { - "attachments": { - "items": { - "properties": { - "content_type": { - "nullable": true, - "properties": { - "source_value": { - "description": "The source value of the content type.", - "example": "Text", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The content type of the attachment.", - "enum": [ - "text", - "unmapped_value", - null - ], - "example": "text", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "url": { - "description": "The URL of the attachment.", - "example": "http://example.com/resume.pdf", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "candidate": { - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - }, - "profile_url": { - "description": "Candidate profile url", - "example": "https://exmaple.com/candidate?id=xyz", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "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" - }, - "result": { - "nullable": true, - "properties": { - "source_value": { - "description": "The source value of the test result.", - "example": "Passed", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The result of the test.", - "enum": [ - "cancelled", - "completed", - "expired", - "failed", - "passed", - null - ], - "example": "passed", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "result_url": { - "description": "The test`s result url", - "example": "https://exmaple.com/result?id=xyz", - "nullable": true, - "type": "string" - }, - "score": { - "nullable": true, - "properties": { - "label": { - "description": "The label of the score", - "example": "Percentage", - "nullable": true, - "type": "string" - }, - "max": { - "description": "The maximum value of the score", - "example": "100", - "nullable": true, - "type": "string" - }, - "min": { - "description": "The minimum value of the score", - "example": "0", - "nullable": true, - "type": "string" - }, - "value": { - "description": "The value is the actual score", - "example": "80", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "start_date": { - "description": "The start date of the candidate test", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "submission_date": { - "description": "The submission date of the candidate test", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "summary": { - "description": "The summary about the result of the test", - "example": "Test is passed", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "ats_update_background_check_result": { - "description": "Update Background Check Result", - "execute": { - "body_type": "json", - "headers": {}, - "method": "PATCH", - "name": "ats_update_background_check_result", - "parameter_locations": { - "attachments": "body", - "candidate": "body", - "id": "body", - "passthrough": "body", - "result": "body", - "result_url": "body", - "score": "body", - "start_date": "body", - "submission_date": "body", - "summary": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/background_checks/orders/{id}/result" - }, - "parameters": { - "properties": { - "attachments": { - "items": { - "properties": { - "content_type": { - "nullable": true, - "properties": { - "source_value": { - "description": "The source value of the content type.", - "example": "Text", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The content type of the attachment.", - "enum": [ - "text", - "unmapped_value", - null - ], - "example": "text", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "url": { - "description": "The URL of the attachment.", - "example": "http://example.com/resume.pdf", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "candidate": { - "nullable": true, - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - }, - "profile_url": { - "description": "Candidate profile url", - "example": "https://exmaple.com/candidate?id=xyz", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "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" - }, - "result": { - "nullable": true, - "properties": { - "source_value": { - "description": "The source value of the test result.", - "example": "Passed", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The result of the test.", - "enum": [ - "cancelled", - "completed", - "expired", - "failed", - "passed", - null - ], - "example": "passed", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "result_url": { - "description": "The test`s result url", - "example": "https://exmaple.com/result?id=xyz", - "nullable": true, - "type": "string" - }, - "score": { - "nullable": true, - "properties": { - "label": { - "description": "The label of the score", - "example": "Percentage", - "nullable": true, - "type": "string" - }, - "max": { - "description": "The maximum value of the score", - "example": "100", - "nullable": true, - "type": "string" - }, - "min": { - "description": "The minimum value of the score", - "example": "0", - "nullable": true, - "type": "string" - }, - "value": { - "description": "The value is the actual score", - "example": "80", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "start_date": { - "description": "The start date of the candidate test", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "submission_date": { - "description": "The submission date of the candidate test", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "summary": { - "description": "The summary about the result of the test", - "example": "Test is passed", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "ats_update_candidate": { - "description": "Update Candidate", - "execute": { - "body_type": "json", - "headers": {}, - "method": "PATCH", - "name": "ats_update_candidate", - "parameter_locations": { - "application_ids": "body", - "company": "body", - "country": "body", - "custom_fields": "body", - "email": "body", - "emails": "body", - "first_name": "body", - "hired_at": "body", - "id": "path", - "last_name": "body", - "name": "body", - "passthrough": "body", - "phone": "body", - "phone_numbers": "body", - "social_links": "body", - "title": "body", - "unified_custom_fields": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/candidates/{id}" - }, - "parameters": { - "properties": { - "application_ids": { - "description": "List of candidate application IDs", - "example": [ - "123e4567-e89b-12d3-a456-426614174000", - "523e1234-e89b-fdd2-a456-762545121101" - ], - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "company": { - "description": "Candidate company", - "example": "Company Inc.", - "nullable": true, - "type": "string" - }, - "country": { - "description": "Candidate country", - "example": "United States", - "nullable": true, - "type": "string" - }, - "custom_fields": { - "description": "The candidate 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" - }, - "email": { - "description": "Candidate email", - "example": "sestier.romain123@gmail.com", - "nullable": true, - "type": "string" - }, - "emails": { - "description": "List of candidate emails", - "items": { - "properties": { - "type": { - "description": "Type of the email", - "example": "personal", - "nullable": true, - "type": "string" - }, - "value": { - "description": "Email value", - "example": "sestier.romain123@gmail.com", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "first_name": { - "description": "Candidate first name", - "example": "Romain", - "nullable": true, - "type": "string" - }, - "hired_at": { - "description": "Candidate hired date", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "id": { - "type": "string" - }, - "last_name": { - "description": "Candidate last name", - "example": "Sestier", - "nullable": true, - "type": "string" - }, - "name": { - "description": "Candidate name", - "example": "Romain Sestier", - "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": { - "deprecated": true, - "description": "Candidate phone number", - "example": "+16178294093", - "nullable": true, - "type": "string" - }, - "phone_numbers": { - "description": "List of candidate phone numbers including the type of the number when available", - "items": { - "properties": { - "phone": { - "description": "Phone number string", - "example": "+447700112233", - "nullable": true, - "type": "string" - }, - "type": { - "description": "Type of phone number", - "enum": [ - "personal", - "work", - "mobile", - "home", - "unknown", - "other", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "social_links": { - "description": "List of candidate social links", - "items": { - "properties": { - "type": { - "description": "Type of the social link", - "example": "linkedin", - "nullable": true, - "type": "string" - }, - "url": { - "description": "URL of the social link", - "example": "https://www.linkedin.com/in/romainsestier/", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "title": { - "description": "Candidate title", - "example": "Software Engineer", - "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" - } - }, - "type": "object" - } - }, - "ats_update_job": { - "description": "Update Job", - "execute": { - "body_type": "json", - "headers": {}, - "method": "PATCH", - "name": "ats_update_job", - "parameter_locations": { - "code": "body", - "confidential": "body", - "custom_fields": "body", - "department_ids": "body", - "hiring_team": "body", - "id": "path", - "interview_stages": "body", - "job_status": "body", - "location_ids": "body", - "passthrough": "body", - "status": "body", - "title": "body", - "unified_custom_fields": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/jobs/{id}" - }, - "parameters": { - "properties": { - "code": { - "description": "Code of the job", - "example": "184919", - "nullable": true, - "type": "string" - }, - "confidential": { - "description": "Confidential status of the job", - "enum": [ - "true", - "false", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - }, - "custom_fields": { - "description": "The job 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" - }, - "department_ids": { - "description": "Department ids of the job", - "example": [ - "308570", - "308571", - "308572" - ], - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "hiring_team": { - "description": "Hiring team for the job.", - "items": { - "properties": { - "email": { - "description": "Email of the hiring team member.", - "example": "john.doe@gmail.com", - "nullable": true, - "type": "string" - }, - "first_name": { - "description": "First name of the hiring team member.", - "example": "John", - "nullable": true, - "type": "string" - }, - "last_name": { - "description": "Last name of the hiring team member.", - "example": "Doe", - "nullable": true, - "type": "string" - }, - "remote_user_id": { - "description": "Provider's unique identifier of the user", - "example": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", - "nullable": true, - "type": "string" - }, - "role": { - "description": "Role of the hiring team member.", - "example": "Software Engineer", - "nullable": true, - "type": "string" - }, - "user_id": { - "description": "User ID of the hiring team member.", - "example": "123456", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "id": { - "type": "string" - }, - "interview_stages": { - "description": "Interview stages for the job.", - "items": { - "properties": { - "created_at": { - "description": "Interview Stage created date", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "nullable": true, - "type": "string" - }, - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - }, - "name": { - "nullable": true, - "type": "string" - }, - "order": { - "nullable": true, - "type": "number" - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "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" - }, - "updated_at": { - "description": "Interview Stage updated date", - "example": "2021-01-01T01:01:01.000Z", - "format": "date-time", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "job_status": { - "description": "Status of the job", - "nullable": true, - "properties": { - "source_value": { - "description": "The source value of the job status.", - "example": "Published", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The status of the job.", - "enum": [ - "published", - "draft", - "pending", - "internal", - "archived", - "closed", - "open", - "deleted", - "on_hold", - "unmapped_value", - null - ], - "example": "published", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "location_ids": { - "description": "Location ids of the job", - "example": [ - "668570", - "678571", - "688572" - ], - "items": { - "type": "string" - }, - "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" - }, - "status": { - "deprecated": true, - "description": "Status of the job", - "example": "archived", - "nullable": true, - "type": "string" - }, - "title": { - "description": "Title of the job", - "example": "Software Engineer", - "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" - } - }, - "type": "object" - } - }, - "ats_upload_application_document": { - "description": "Upload Application Document", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "ats_upload_application_document", - "parameter_locations": { - "category": "body", - "category_id": "body", - "confidential": "body", - "content": "body", - "file_format": "body", - "id": "path", - "name": "body", - "path": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/ats/applications/{id}/documents/upload" - }, - "parameters": { - "properties": { - "category": { - "description": "The category object for associating uploaded files. If both an ID and a name are provided, the ID takes precedence.", - "nullable": true, - "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, CUSTOM_CATEGORY_NAME", - "nullable": true, - "type": "string" - }, - "value": { - "description": "The category name for associating uploaded files.", - "example": "reports, resumes", - "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": { - "source_value": { - "example": "public", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "Whether the file is confidential or not", - "enum": [ - "true", - "false", - null - ], - "example": "true", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "example": "abc", - "nullable": true, - "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", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "id": { - "type": "string" - }, - "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" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - } -} \ No newline at end of file diff --git a/tests/snapshots/test_parser/test_parse_all_oas_specs/core_tools.json b/tests/snapshots/test_parser/test_parse_all_oas_specs/core_tools.json deleted file mode 100644 index 157d7f4..0000000 --- a/tests/snapshots/test_parser/test_parse_all_oas_specs/core_tools.json +++ /dev/null @@ -1,452 +0,0 @@ -{ - "stackone_authenticate_connect_session": { - "description": "Authenticate Connect Session", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "stackone_authenticate_connect_session", - "parameter_locations": { - "token": "body" - }, - "url": "https://api.stackone.com/connect_sessions/authenticate" - }, - "parameters": { - "properties": { - "token": { - "description": "The token to authenticate with", - "type": "string" - } - }, - "type": "object" - } - }, - "stackone_create_connect_session": { - "description": "Create Connect Session", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "stackone_create_connect_session", - "parameter_locations": { - "account_id": "body", - "categories": "body", - "expires_in": "body", - "label": "body", - "metadata": "body", - "multiple": "body", - "origin_owner_id": "body", - "origin_owner_name": "body", - "origin_username": "body", - "provider": "body" - }, - "url": "https://api.stackone.com/connect_sessions" - }, - "parameters": { - "properties": { - "account_id": { - "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, - "type": "string" - }, - "categories": { - "description": "The categories of the provider to connect to", - "example": [ - "ats", - "hris", - "hrisLegacy", - "crm", - "iam", - "marketing", - "lms", - "stackOne", - "documents" - ], - "items": { - "enum": [ - "ats", - "hris", - "hris-legacy", - "crm", - "iam", - "marketing", - "lms", - "stackone", - "documents", - null - ], - "type": "string" - }, - "nullable": true, - "type": "array", - "x-speakeasy-unknown-values": "allow" - }, - "expires_in": { - "default": 1800, - "description": "How long the session should be valid for in seconds", - "nullable": true, - "type": "number" - }, - "label": { - "description": "The label to be applied to the account associated with this connect session.", - "nullable": true, - "type": "string" - }, - "metadata": { - "description": "The metadata for the connection", - "nullable": true, - "type": "object" - }, - "multiple": { - "default": false, - "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.", - "nullable": true, - "type": "boolean" - }, - "origin_owner_id": { - "description": "The origin owner identifier", - "type": "string" - }, - "origin_owner_name": { - "description": "The origin owner name", - "type": "string" - }, - "origin_username": { - "description": "The origin username", - "nullable": true, - "type": "string" - }, - "provider": { - "description": "The provider to connect to", - "nullable": true, - "type": "string" - } - }, - "type": "object" - } - }, - "stackone_delete_account": { - "description": "Delete Account", - "execute": { - "body_type": null, - "headers": {}, - "method": "DELETE", - "name": "stackone_delete_account", - "parameter_locations": { - "id": "path" - }, - "url": "https://api.stackone.com/accounts/{id}" - }, - "parameters": { - "properties": { - "id": { - "type": "string" - } - }, - "type": "object" - } - }, - "stackone_get_account": { - "description": "Get Account", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "stackone_get_account", - "parameter_locations": { - "id": "path" - }, - "url": "https://api.stackone.com/accounts/{id}" - }, - "parameters": { - "properties": { - "id": { - "type": "string" - } - }, - "type": "object" - } - }, - "stackone_get_account_meta_info": { - "description": "Get meta information of the account", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "stackone_get_account_meta_info", - "parameter_locations": { - "id": "path" - }, - "url": "https://api.stackone.com/accounts/{id}/meta" - }, - "parameters": { - "properties": { - "id": { - "type": "string" - } - }, - "type": "object" - } - }, - "stackone_get_connector_meta": { - "description": "Get Connector Meta information for the given provider key", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "stackone_get_connector_meta", - "parameter_locations": { - "include": "query", - "provider": "path" - }, - "url": "https://api.stackone.com/connectors/meta/{provider}" - }, - "parameters": { - "properties": { - "include": { - "description": "The comma separated list of data that will be included in the response", - "example": "field_path,unmapped_fields,resources,inactive,webhooks,static_fields", - "nullable": true, - "type": "string" - }, - "provider": { - "type": "string" - } - }, - "type": "object" - } - }, - "stackone_list_connectors_meta": { - "description": "List Connectors Meta Information for all providers", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "stackone_list_connectors_meta", - "parameter_locations": { - "include": "query" - }, - "url": "https://api.stackone.com/connectors/meta" - }, - "parameters": { - "properties": { - "include": { - "description": "The comma separated list of data that will be included in the response", - "example": "field_path,unmapped_fields,resources,inactive,webhooks,static_fields", - "nullable": true, - "type": "string" - } - }, - "type": "object" - } - }, - "stackone_list_linked_accounts": { - "description": "List Accounts", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "stackone_list_linked_accounts", - "parameter_locations": { - "account_ids": "query", - "origin_owner_id": "query", - "page": "query", - "page_size": "query", - "provider": "query", - "providers": "query", - "status": "query" - }, - "url": "https://api.stackone.com/accounts" - }, - "parameters": { - "properties": { - "account_ids": { - "description": "The providers list of the results to fetch", - "items": { - "type": "string" - }, - "type": "array" - }, - "origin_owner_id": { - "description": "The origin owner identifier of the results to fetch", - "nullable": true, - "type": "string" - }, - "page": { - "description": "The page number of the results to fetch", - "nullable": true, - "type": "number" - }, - "page_size": { - "default": 25, - "description": "The number of results per page", - "nullable": true, - "type": "number" - }, - "provider": { - "description": "The provider of the results to fetch", - "nullable": true, - "type": "string" - }, - "providers": { - "description": "The providers list of the results to fetch", - "items": { - "type": "string" - }, - "type": "array" - }, - "status": { - "description": "The status of the results to fetch", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - } - }, - "stackone_proxy_request": { - "description": "Proxy Request", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "stackone_proxy_request", - "parameter_locations": { - "body": "body", - "headers": "body", - "method": "body", - "path": "body", - "url": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/proxy" - }, - "parameters": { - "properties": { - "body": { - "additionalProperties": true, - "description": "The body of the request", - "nullable": true, - "type": "object" - }, - "headers": { - "additionalProperties": true, - "description": "The headers to send in the request", - "example": { - "Content-Type": "application/json" - }, - "nullable": true, - "type": "object" - }, - "method": { - "default": "get", - "description": "The method of the request", - "enum": [ - "get", - "post", - "put", - "delete", - "patch", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - }, - "path": { - "description": "The path of the request including any query paramters", - "example": "/employees/directory", - "nullable": true, - "type": "string" - }, - "url": { - "description": "The base url of the request", - "example": "https://api.sample-integration.com/v1", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "stackone_update_account": { - "description": "Update Account", - "execute": { - "body_type": "json", - "headers": {}, - "method": "PATCH", - "name": "stackone_update_account", - "parameter_locations": { - "authentication_config_key": "body", - "credentials": "body", - "environment": "body", - "id": "path", - "label": "body", - "origin_owner_id": "body", - "origin_owner_name": "body", - "origin_username": "body", - "provider": "body", - "secrets": "body", - "setup_information": "body" - }, - "url": "https://api.stackone.com/accounts/{id}" - }, - "parameters": { - "properties": { - "authentication_config_key": { - "nullable": true, - "type": "string" - }, - "credentials": { - "additionalProperties": false, - "nullable": true, - "type": "object" - }, - "environment": { - "nullable": true, - "type": "string" - }, - "id": { - "type": "string" - }, - "label": { - "nullable": true, - "type": "object" - }, - "origin_owner_id": { - "nullable": true, - "type": "string" - }, - "origin_owner_name": { - "nullable": true, - "type": "string" - }, - "origin_username": { - "nullable": true, - "type": "string" - }, - "provider": { - "nullable": true, - "type": "string" - }, - "secrets": { - "additionalProperties": false, - "nullable": true, - "type": "object" - }, - "setup_information": { - "additionalProperties": false, - "nullable": true, - "type": "object" - } - }, - "type": "object" - } - } -} \ No newline at end of file diff --git a/tests/snapshots/test_parser/test_parse_all_oas_specs/crm_tools.json b/tests/snapshots/test_parser/test_parse_all_oas_specs/crm_tools.json deleted file mode 100644 index 7c8141e..0000000 --- a/tests/snapshots/test_parser/test_parse_all_oas_specs/crm_tools.json +++ /dev/null @@ -1,899 +0,0 @@ -{ - "crm_create_contact": { - "description": "Creates a new Contact", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "crm_create_contact", - "parameter_locations": { - "account_ids": "body", - "company_name": "body", - "custom_fields": "body", - "deal_ids": "body", - "emails": "body", - "first_name": "body", - "last_name": "body", - "passthrough": "body", - "phone_numbers": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/crm/contacts" - }, - "parameters": { - "properties": { - "account_ids": { - "description": "List of associated account IDs", - "example": [ - "account-123", - "account-456" - ], - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "company_name": { - "description": "The contact company name", - "example": "Apple Inc.", - "nullable": true, - "type": "string" - }, - "custom_fields": { - "description": "Contact 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" - }, - "deal_ids": { - "description": "List of associated deal IDs", - "example": [ - "deal-001", - "deal-002" - ], - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "emails": { - "description": "List of contact email addresses", - "example": [ - "steve@apple.com" - ], - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "first_name": { - "description": "The contact first name", - "example": "Steve", - "nullable": true, - "type": "string" - }, - "last_name": { - "description": "The contact last name", - "example": "Wozniak", - "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_numbers": { - "description": "List of contact phone numbers", - "example": [ - "123-456-7890" - ], - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "crm_get_account": { - "description": "Get Account", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "crm_get_account", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/crm/accounts/{id}" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "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" - } - }, - "type": "object" - } - }, - "crm_get_contact": { - "description": "Get Contact", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "crm_get_contact", - "parameter_locations": { - "fields": "query", - "id": "path", - "include": "query", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/crm/contacts/{id}" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "nullable": true, - "type": "string" - }, - "id": { - "type": "string" - }, - "include": { - "description": "The comma separated list of fields that will be included in the response", - "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" - } - }, - "type": "object" - } - }, - "crm_get_contact_custom_field_definition": { - "description": "Get Contact Custom Field Definition", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "crm_get_contact_custom_field_definition", - "parameter_locations": { - "fields": "query", - "filter": "query", - "id": "path", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/crm/custom_field_definitions/contacts/{id}" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "nullable": true, - "type": "string" - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "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", - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "crm_get_list": { - "description": "Get List", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "crm_get_list", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/crm/lists/{id}" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "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" - } - }, - "type": "object" - } - }, - "crm_list_accounts": { - "description": "List Accounts", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "crm_list_accounts", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/crm/accounts" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "nullable": true, - "type": "string" - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "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", - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "crm_list_contact_custom_field_definitions": { - "description": "List Contact Custom Field Definitions", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "crm_list_contact_custom_field_definitions", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/crm/custom_field_definitions/contacts" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "nullable": true, - "type": "string" - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "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", - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "crm_list_contacts": { - "description": "List Contacts", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "crm_list_contacts", - "parameter_locations": { - "fields": "query", - "filter": "query", - "include": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/crm/contacts" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "nullable": true, - "type": "string" - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "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", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "include": { - "description": "The comma separated list of fields that will be included in the response", - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "crm_list_lists": { - "description": "Get all Lists", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "crm_list_lists", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/crm/lists" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "nullable": true, - "type": "string" - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "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", - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "crm_update_contact": { - "description": "Update Contact (early access)", - "execute": { - "body_type": "json", - "headers": {}, - "method": "PATCH", - "name": "crm_update_contact", - "parameter_locations": { - "account_ids": "body", - "company_name": "body", - "custom_fields": "body", - "deal_ids": "body", - "emails": "body", - "first_name": "body", - "id": "path", - "last_name": "body", - "passthrough": "body", - "phone_numbers": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/crm/contacts/{id}" - }, - "parameters": { - "properties": { - "account_ids": { - "description": "List of associated account IDs", - "example": [ - "account-123", - "account-456" - ], - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "company_name": { - "description": "The contact company name", - "example": "Apple Inc.", - "nullable": true, - "type": "string" - }, - "custom_fields": { - "description": "Contact 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" - }, - "deal_ids": { - "description": "List of associated deal IDs", - "example": [ - "deal-001", - "deal-002" - ], - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "emails": { - "description": "List of contact email addresses", - "example": [ - "steve@apple.com" - ], - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "first_name": { - "description": "The contact first name", - "example": "Steve", - "nullable": true, - "type": "string" - }, - "id": { - "type": "string" - }, - "last_name": { - "description": "The contact last name", - "example": "Wozniak", - "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_numbers": { - "description": "List of contact phone numbers", - "example": [ - "123-456-7890" - ], - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - } -} \ No newline at end of file diff --git a/tests/snapshots/test_parser/test_parse_all_oas_specs/documents_tools.json b/tests/snapshots/test_parser/test_parse_all_oas_specs/documents_tools.json deleted file mode 100644 index 7ecce5e..0000000 --- a/tests/snapshots/test_parser/test_parse_all_oas_specs/documents_tools.json +++ /dev/null @@ -1,1778 +0,0 @@ -{ - "documents_download_file": { - "description": "Download File", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "documents_download_file", - "parameter_locations": { - "format": "query", - "id": "path", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/documents/files/{id}/download" - }, - "parameters": { - "properties": { - "format": { - "description": "The format to download the file in", - "nullable": true, - "type": "string" - }, - "id": { - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "documents_get_drive": { - "description": "Get Drive", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "documents_get_drive", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/documents/drives/{id}" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "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" - } - }, - "type": "object" - } - }, - "documents_get_file": { - "description": "Get File", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "documents_get_file", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/documents/files/{id}" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "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" - } - }, - "type": "object" - } - }, - "documents_get_folder": { - "description": "Get Folder", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "documents_get_folder", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/documents/folders/{id}" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "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" - } - }, - "type": "object" - } - }, - "documents_list_drives": { - "description": "List Drives", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "documents_list_drives", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/documents/drives" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "nullable": true, - "type": "string" - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "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", - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "documents_list_files": { - "description": "List Files", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "documents_list_files", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/documents/files" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "nullable": true, - "type": "string" - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "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", - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "documents_list_folders": { - "description": "List Folders", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "documents_list_folders", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/documents/folders" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "nullable": true, - "type": "string" - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "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", - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "documents_upload_file": { - "description": "Upload File", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "documents_upload_file", - "parameter_locations": { - "category": "body", - "category_id": "body", - "confidential": "body", - "content": "body", - "file_format": "body", - "name": "body", - "path": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/documents/files/upload" - }, - "parameters": { - "properties": { - "category": { - "description": "The category object for associating uploaded files. If both an ID and a name are provided, the ID takes precedence.", - "nullable": true, - "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, CUSTOM_CATEGORY_NAME", - "nullable": true, - "type": "string" - }, - "value": { - "description": "The category name for associating uploaded files.", - "example": "reports, resumes", - "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": { - "source_value": { - "example": "public", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "Whether the file is confidential or not", - "enum": [ - "true", - "false", - null - ], - "example": "true", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "example": "abc", - "nullable": true, - "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", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - } -} \ No newline at end of file diff --git a/tests/snapshots/test_parser/test_parse_all_oas_specs/hris_tools.json b/tests/snapshots/test_parser/test_parse_all_oas_specs/hris_tools.json deleted file mode 100644 index d2b92ca..0000000 --- a/tests/snapshots/test_parser/test_parse_all_oas_specs/hris_tools.json +++ /dev/null @@ -1,33327 +0,0 @@ -{ - "hris_batch_upload_employee_document": { - "description": "Batch Upload Employee Document", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "hris_batch_upload_employee_document", - "parameter_locations": { - "id": "path", - "items": "body", - "x-account-id": "header" - }, - "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" - }, - "nullable": true, - "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", - "nullable": true, - "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", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "example": "public", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "Whether the file is confidential or not", - "enum": [ - "true", - "false", - null - ], - "example": "true", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "example": "abc", - "nullable": true, - "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", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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" - } - }, - "type": "object" - } - }, - "hris_create_employee": { - "description": "Creates an employee", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "hris_create_employee", - "parameter_locations": { - "avatar": "body", - "avatar_url": "body", - "benefits": "body", - "birthday": "body", - "citizenships": "body", - "company_id": "body", - "company_name": "body", - "cost_centers": "body", - "custom_fields": "body", - "date_of_birth": "body", - "department": "body", - "department_id": "body", - "display_name": "body", - "employee_number": "body", - "employment_contract_type": "body", - "employment_status": "body", - "employment_type": "body", - "employments": "body", - "ethnicity": "body", - "first_name": "body", - "gender": "body", - "hire_date": "body", - "home_location": "body", - "job_id": "body", - "job_title": "body", - "last_name": "body", - "manager_id": "body", - "marital_status": "body", - "name": "body", - "national_identity_number": "body", - "passthrough": "body", - "personal_email": "body", - "personal_phone_number": "body", - "preferred_language": "body", - "start_date": "body", - "tenure": "body", - "termination_date": "body", - "work_anniversary": "body", - "work_email": "body", - "work_location": "body", - "work_phone_number": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/hris/employees" - }, - "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": { - "source_value": { - "nullable": true, - "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", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "nullable": true, - "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", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "full_time", - "shifts", - "part_time", - "unmapped_value", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "employment_status": { - "description": "The employee employment status", - "example": "active", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "active", - "pending", - "terminated", - "leave", - "inactive", - "unknown", - "unmapped_value", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "employment_type": { - "description": "The employee employment type", - "example": "full_time", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "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 - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "full_time", - "shifts", - "part_time", - "unmapped_value", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "employment_type": { - "description": "The type of employment (e.g., contractor, permanent)", - "example": "permanent", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "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 - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "nullable": true, - "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 - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "pay_period": { - "description": "The pay period", - "example": "monthly", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "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 - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "nullable": true, - "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 - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "nullable": true, - "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 - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "nullable": true, - "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", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "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", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "nullable": true, - "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 - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "name": { - "description": "The employee name", - "example": "Issac Newton", - "nullable": true, - "type": "string" - }, - "national_identity_number": { - "description": "The national identity number", - "nullable": true, - "properties": { - "country": { - "description": "The country code", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "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", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "type": { - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "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", - null - ], - "example": "ssn", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "value": { - "example": "123456789", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "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": { - "source_value": { - "nullable": true, - "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", - "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", - "unmapped_value", - null - ], - "example": "eng", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "nullable": true, - "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", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "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", - "x-speakeasy-unknown-values": "allow" - } - }, - "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" - } - }, - "type": "object" - } - }, - "hris_create_employee_employment": { - "description": "Create Employee Employment", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "hris_create_employee_employment", - "parameter_locations": { - "effective_date": "body", - "employee_id": "body", - "employment_contract_type": "body", - "employment_type": "body", - "id": "body", - "job_title": "body", - "passthrough": "body", - "pay_currency": "body", - "pay_frequency": "body", - "pay_period": "body", - "pay_rate": "body", - "time_worked": "body", - "unified_custom_fields": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/hris/employees/{id}/employments" - }, - "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": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "full_time", - "shifts", - "part_time", - "unmapped_value", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "employment_type": { - "description": "The type of employment (e.g., contractor, permanent)", - "example": "permanent", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "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 - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "nullable": true, - "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 - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "pay_period": { - "description": "The pay period", - "example": "monthly", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "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 - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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" - } - }, - "type": "object" - } - }, - "hris_create_employee_skill": { - "description": "Create Employee Skill", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "hris_create_employee_skill", - "parameter_locations": { - "id": "body", - "name": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/hris/employees/{id}/skills" - }, - "parameters": { - "properties": { - "id": { - "description": "The ID associated with this skill", - "example": "16873-IT345", - "nullable": true, - "type": "string" - }, - "name": { - "description": "The name associated with this skill", - "example": "Information-Technology", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "hris_create_employee_time_off_request": { - "description": "Create Employee Time Off Request", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "hris_create_employee_time_off_request", - "parameter_locations": { - "approver_id": "body", - "employee_id": "body", - "end_date": "body", - "end_half_day": "body", - "id": "path", - "passthrough": "body", - "start_date": "body", - "start_half_day": "body", - "status": "body", - "type": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off" - }, - "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": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "approved", - "cancelled", - "rejected", - "pending", - "unmapped_value", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "type": { - "description": "The type of the time off request", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "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", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "hris_create_employee_work_eligibility_request": { - "description": "Create Employee Work Eligibility Request", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "hris_create_employee_work_eligibility_request", - "parameter_locations": { - "document": "body", - "id": "path", - "issued_by": "body", - "number": "body", - "passthrough": "body", - "sub_type": "body", - "type": "body", - "valid_from": "body", - "valid_to": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/hris/employees/{id}/work_eligibility" - }, - "parameters": { - "properties": { - "document": { - "nullable": true, - "properties": { - "category": { - "description": "The category of the file", - "example": "templates, forms, backups, etc.", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "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": { - "source_value": { - "example": "abc", - "nullable": true, - "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", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "example": "abc", - "nullable": true, - "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", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "nullable": true, - "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", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "visa", - "passport", - "driver_license", - "birth_certificate", - "other", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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" - } - }, - "type": "object" - } - }, - "hris_create_time_off_request": { - "description": "Creates a time off request", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "hris_create_time_off_request", - "parameter_locations": { - "approver_id": "body", - "employee_id": "body", - "end_date": "body", - "end_half_day": "body", - "passthrough": "body", - "start_date": "body", - "start_half_day": "body", - "status": "body", - "type": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/hris/time_off" - }, - "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": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "approved", - "cancelled", - "rejected", - "pending", - "unmapped_value", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "type": { - "description": "The type of the time off request", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "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", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "hris_download_employee_document": { - "description": "Download Employee Document", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_download_employee_document", - "parameter_locations": { - "format": "query", - "id": "path", - "subResourceId": "path", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/hris/employees/{id}/documents/{subResourceId}/download" - }, - "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" - } - }, - "type": "object" - } - }, - "hris_get_benefit": { - "description": "Get Benefit", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_get_benefit", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "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", - "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" - } - }, - "type": "object" - } - }, - "hris_get_company": { - "description": "Get Company", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_get_company", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "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", - "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" - } - }, - "type": "object" - } - }, - "hris_get_cost_center_group": { - "description": "Get Cost Center Group", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_get_cost_center_group", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "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,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" - } - }, - "type": "object" - } - }, - "hris_get_department_group": { - "description": "Get Department Group", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_get_department_group", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "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", - "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" - } - }, - "type": "object" - } - }, - "hris_get_employee": { - "description": "Get Employee", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_get_employee", - "parameter_locations": { - "expand": "query", - "fields": "query", - "id": "path", - "include": "query", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "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", - "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", - "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" - } - }, - "type": "object" - } - }, - "hris_get_employee_custom_field_definition": { - "description": "Get employee Custom Field Definition", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_get_employee_custom_field_definition", - "parameter_locations": { - "fields": "query", - "filter": "query", - "id": "path", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "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", - "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" - } - }, - "type": "object" - } - }, - "hris_get_employee_document": { - "description": "Get Employee Document", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_get_employee_document", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "subResourceId": "path", - "x-account-id": "header" - }, - "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,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" - } - }, - "type": "object" - } - }, - "hris_get_employee_document_category": { - "description": "Get Employee Document Category", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_get_employee_document_category", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "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", - "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" - } - }, - "type": "object" - } - }, - "hris_get_employee_employment": { - "description": "Get Employee Employment", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_get_employee_employment", - "parameter_locations": { - "expand": "query", - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "subResourceId": "path", - "x-account-id": "header" - }, - "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", - "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,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" - } - }, - "type": "object" - } - }, - "hris_get_employee_time_off_balance": { - "description": "Get Employee Time Off Balance", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_get_employee_time_off_balance", - "parameter_locations": { - "expand": "query", - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "subResourceId": "path", - "x-account-id": "header" - }, - "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", - "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" - } - }, - "type": "object" - } - }, - "hris_get_employees_time_off_request": { - "description": "Get Employees Time Off Request", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_get_employees_time_off_request", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "subResourceId": "path", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off/{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,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" - } - }, - "type": "object" - } - }, - "hris_get_employees_work_eligibility": { - "description": "Get Employees Work Eligibility", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_get_employees_work_eligibility", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "subResourceId": "path", - "x-account-id": "header" - }, - "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", - "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" - } - }, - "type": "object" - } - }, - "hris_get_employment": { - "description": "Get Employment", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_get_employment", - "parameter_locations": { - "expand": "query", - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "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", - "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,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" - } - }, - "type": "object" - } - }, - "hris_get_group": { - "description": "Get Group", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_get_group", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "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", - "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" - } - }, - "type": "object" - } - }, - "hris_get_job": { - "description": "Get Job", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_get_job", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "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,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" - } - }, - "type": "object" - } - }, - "hris_get_location": { - "description": "Get Location", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_get_location", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "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", - "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" - } - }, - "type": "object" - } - }, - "hris_get_team_group": { - "description": "Get Team Group", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_get_team_group", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "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", - "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" - } - }, - "type": "object" - } - }, - "hris_get_time_entries": { - "description": "Get Time Entry", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_get_time_entries", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "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", - "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" - } - }, - "type": "object" - } - }, - "hris_get_time_off_policy": { - "description": "Get Time Off Policy", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_get_time_off_policy", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "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,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" - } - }, - "type": "object" - } - }, - "hris_get_time_off_request": { - "description": "Get time off request", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_get_time_off_request", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/hris/time_off/{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,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" - } - }, - "type": "object" - } - }, - "hris_get_time_off_type": { - "description": "Get time off type", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_get_time_off_type", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "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", - "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" - } - }, - "type": "object" - } - }, - "hris_invite_employee": { - "description": "Invite Employee", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "hris_invite_employee", - "parameter_locations": { - "id": "path", - "passthrough": "body", - "x-account-id": "header" - }, - "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" - }, - "nullable": true, - "type": "object" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "hris_list_benefits": { - "description": "List benefits", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_list_benefits", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "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", - "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" - } - }, - "type": "object" - } - }, - "hris_list_companies": { - "description": "List Companies", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_list_companies", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "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", - "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" - } - }, - "type": "object" - } - }, - "hris_list_cost_center_groups": { - "description": "List Cost Center Groups", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_list_cost_center_groups", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "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,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" - } - }, - "type": "object" - } - }, - "hris_list_department_groups": { - "description": "List Department Groups", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_list_department_groups", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "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", - "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" - } - }, - "type": "object" - } - }, - "hris_list_employee_categories": { - "description": "List Employee Document Categories", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_list_employee_categories", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "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", - "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" - } - }, - "type": "object" - } - }, - "hris_list_employee_custom_field_definitions": { - "description": "List employee Custom Field Definitions", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_list_employee_custom_field_definitions", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "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", - "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" - } - }, - "type": "object" - } - }, - "hris_list_employee_documents": { - "description": "List Employee Documents", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_list_employee_documents", - "parameter_locations": { - "fields": "query", - "filter": "query", - "id": "path", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "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,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" - } - }, - "type": "object" - } - }, - "hris_list_employee_employments": { - "description": "List Employee Employments", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_list_employee_employments", - "parameter_locations": { - "expand": "query", - "fields": "query", - "filter": "query", - "id": "path", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "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", - "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,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" - } - }, - "type": "object" - } - }, - "hris_list_employee_time_off_balances": { - "description": "List Employee Time Off Balances", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_list_employee_time_off_balances", - "parameter_locations": { - "expand": "query", - "fields": "query", - "filter": "query", - "id": "path", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "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", - "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" - } - }, - "type": "object" - } - }, - "hris_list_employee_time_off_requests": { - "description": "List Employee Time Off Requests", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_list_employee_time_off_requests", - "parameter_locations": { - "fields": "query", - "filter": "query", - "id": "path", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/hris/employees/{id}/time_off" - }, - "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": { - "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" - } - }, - "type": "object" - } - }, - "hris_list_employee_work_eligibility": { - "description": "List Employee Work Eligibility", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_list_employee_work_eligibility", - "parameter_locations": { - "fields": "query", - "filter": "query", - "id": "path", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "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", - "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" - } - }, - "type": "object" - } - }, - "hris_list_employees": { - "description": "List Employees", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_list_employees", - "parameter_locations": { - "expand": "query", - "fields": "query", - "filter": "query", - "include": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "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", - "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", - "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" - } - }, - "type": "object" - } - }, - "hris_list_employments": { - "description": "List Employments", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_list_employments", - "parameter_locations": { - "expand": "query", - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "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", - "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,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" - } - }, - "type": "object" - } - }, - "hris_list_groups": { - "description": "List Groups", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_list_groups", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "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", - "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" - } - }, - "type": "object" - } - }, - "hris_list_jobs": { - "description": "List Jobs", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_list_jobs", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "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,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" - } - }, - "type": "object" - } - }, - "hris_list_locations": { - "description": "List locations", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_list_locations", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "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", - "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" - } - }, - "type": "object" - } - }, - "hris_list_team_groups": { - "description": "List Team Groups", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_list_team_groups", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "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", - "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" - } - }, - "type": "object" - } - }, - "hris_list_time_entries": { - "description": "List Time Entries", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_list_time_entries", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "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", - "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" - } - }, - "type": "object" - } - }, - "hris_list_time_off_policies": { - "description": "List Time Off Policies", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_list_time_off_policies", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "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,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" - } - }, - "type": "object" - } - }, - "hris_list_time_off_requests": { - "description": "List time off requests", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_list_time_off_requests", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/hris/time_off" - }, - "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": { - "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" - } - }, - "type": "object" - } - }, - "hris_list_time_off_types": { - "description": "List time off types", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "hris_list_time_off_types", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "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", - "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" - } - }, - "type": "object" - } - }, - "hris_update_employee": { - "description": "Updates an employee", - "execute": { - "body_type": "json", - "headers": {}, - "method": "PATCH", - "name": "hris_update_employee", - "parameter_locations": { - "avatar": "body", - "avatar_url": "body", - "benefits": "body", - "birthday": "body", - "citizenships": "body", - "company_id": "body", - "company_name": "body", - "custom_fields": "body", - "date_of_birth": "body", - "department": "body", - "department_id": "body", - "display_name": "body", - "employee_number": "body", - "employment_contract_type": "body", - "employment_status": "body", - "employment_type": "body", - "ethnicity": "body", - "first_name": "body", - "gender": "body", - "hire_date": "body", - "home_location": "body", - "id": "path", - "job_id": "body", - "job_title": "body", - "last_name": "body", - "manager_id": "body", - "marital_status": "body", - "name": "body", - "national_identity_number": "body", - "passthrough": "body", - "personal_email": "body", - "personal_phone_number": "body", - "preferred_language": "body", - "start_date": "body", - "tenure": "body", - "termination_date": "body", - "work_anniversary": "body", - "work_email": "body", - "work_location": "body", - "work_phone_number": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/hris/employees/{id}" - }, - "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": { - "source_value": { - "nullable": true, - "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", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "nullable": true, - "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", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "full_time", - "shifts", - "part_time", - "unmapped_value", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "employment_status": { - "description": "The employee employment status", - "example": "active", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "active", - "pending", - "terminated", - "leave", - "inactive", - "unknown", - "unmapped_value", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "employment_type": { - "description": "The employee employment type", - "example": "full_time", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "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 - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "ethnicity": { - "description": "The employee ethnicity", - "example": "white", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "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 - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "nullable": true, - "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 - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "nullable": true, - "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", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "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", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "nullable": true, - "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 - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "name": { - "description": "The employee name", - "example": "Issac Newton", - "nullable": true, - "type": "string" - }, - "national_identity_number": { - "description": "The national identity number", - "nullable": true, - "properties": { - "country": { - "description": "The country code", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "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", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "type": { - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "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", - null - ], - "example": "ssn", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "value": { - "example": "123456789", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "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": { - "source_value": { - "nullable": true, - "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", - "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", - "unmapped_value", - null - ], - "example": "eng", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "nullable": true, - "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", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "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", - "x-speakeasy-unknown-values": "allow" - } - }, - "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" - } - }, - "type": "object" - } - }, - "hris_update_employee_employment": { - "description": "Update Employee Employment", - "execute": { - "body_type": "json", - "headers": {}, - "method": "PATCH", - "name": "hris_update_employee_employment", - "parameter_locations": { - "effective_date": "body", - "employee_id": "body", - "employment_contract_type": "body", - "employment_type": "body", - "id": "body", - "job_title": "body", - "passthrough": "body", - "pay_currency": "body", - "pay_frequency": "body", - "pay_period": "body", - "pay_rate": "body", - "subResourceId": "path", - "time_worked": "body", - "unified_custom_fields": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/hris/employees/{id}/employments/{subResourceId}" - }, - "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": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "full_time", - "shifts", - "part_time", - "unmapped_value", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "employment_type": { - "description": "The type of employment (e.g., contractor, permanent)", - "example": "permanent", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "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 - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "nullable": true, - "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 - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "pay_period": { - "description": "The pay period", - "example": "monthly", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "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 - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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" - } - }, - "type": "object" - } - }, - "hris_update_employee_work_eligibility_request": { - "description": "Update Employee Work Eligibility Request", - "execute": { - "body_type": "json", - "headers": {}, - "method": "PATCH", - "name": "hris_update_employee_work_eligibility_request", - "parameter_locations": { - "document": "body", - "id": "path", - "issued_by": "body", - "number": "body", - "passthrough": "body", - "subResourceId": "path", - "sub_type": "body", - "type": "body", - "valid_from": "body", - "valid_to": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/hris/employees/{id}/work_eligibility/{subResourceId}" - }, - "parameters": { - "properties": { - "document": { - "nullable": true, - "properties": { - "category": { - "description": "The category of the file", - "example": "templates, forms, backups, etc.", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "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": { - "source_value": { - "example": "abc", - "nullable": true, - "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", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "example": "abc", - "nullable": true, - "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", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "nullable": true, - "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", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "visa", - "passport", - "driver_license", - "birth_certificate", - "other", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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" - } - }, - "type": "object" - } - }, - "hris_update_time_off_request": { - "description": "Update time off request", - "execute": { - "body_type": "json", - "headers": {}, - "method": "PATCH", - "name": "hris_update_time_off_request", - "parameter_locations": { - "approver_id": "body", - "employee_id": "body", - "end_date": "body", - "end_half_day": "body", - "id": "path", - "passthrough": "body", - "start_date": "body", - "start_half_day": "body", - "status": "body", - "type": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/hris/time_off/{id}" - }, - "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": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "approved", - "cancelled", - "rejected", - "pending", - "unmapped_value", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "type": { - "description": "The type of the time off request", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "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", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "hris_upload_employee_document": { - "description": "Upload Employee Document", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "hris_upload_employee_document", - "parameter_locations": { - "category": "body", - "category_id": "body", - "confidential": "body", - "content": "body", - "file_format": "body", - "id": "path", - "name": "body", - "path": "body", - "x-account-id": "header" - }, - "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" - }, - "nullable": true, - "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", - "nullable": true, - "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", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "example": "public", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "Whether the file is confidential or not", - "enum": [ - "true", - "false", - null - ], - "example": "true", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "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": { - "source_value": { - "example": "abc", - "nullable": true, - "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", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "id": { - "type": "string" - }, - "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" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - } -} \ No newline at end of file diff --git a/tests/snapshots/test_parser/test_parse_all_oas_specs/iam_tools.json b/tests/snapshots/test_parser/test_parse_all_oas_specs/iam_tools.json deleted file mode 100644 index bf5797a..0000000 --- a/tests/snapshots/test_parser/test_parse_all_oas_specs/iam_tools.json +++ /dev/null @@ -1,558 +0,0 @@ -{ - "iam_get_group": { - "description": "Get Group", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "iam_get_group", - "parameter_locations": { - "expand": "query", - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/iam/groups/{id}" - }, - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "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)", - "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" - } - }, - "type": "object" - } - }, - "iam_get_policy": { - "description": "Get Policy", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "iam_get_policy", - "parameter_locations": { - "expand": "query", - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/iam/policies/{id}" - }, - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "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)", - "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" - } - }, - "type": "object" - } - }, - "iam_get_role": { - "description": "Get Role", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "iam_get_role", - "parameter_locations": { - "expand": "query", - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/iam/roles/{id}" - }, - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "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)", - "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" - } - }, - "type": "object" - } - }, - "iam_get_user": { - "description": "Get User", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "iam_get_user", - "parameter_locations": { - "expand": "query", - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/iam/users/{id}" - }, - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "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)", - "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" - } - }, - "type": "object" - } - }, - "iam_list_groups": { - "description": "List Groups", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "iam_list_groups", - "parameter_locations": { - "expand": "query", - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/iam/groups" - }, - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "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)", - "nullable": true, - "type": "string" - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "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", - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "iam_list_policies": { - "description": "List Policies", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "iam_list_policies", - "parameter_locations": { - "expand": "query", - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/iam/policies" - }, - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "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)", - "nullable": true, - "type": "string" - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "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", - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "iam_list_roles": { - "description": "List Roles", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "iam_list_roles", - "parameter_locations": { - "expand": "query", - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/iam/roles" - }, - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "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)", - "nullable": true, - "type": "string" - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "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", - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "iam_list_users": { - "description": "List Users", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "iam_list_users", - "parameter_locations": { - "expand": "query", - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/iam/users" - }, - "parameters": { - "properties": { - "expand": { - "description": "The comma separated list of fields that will be expanded in the response", - "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)", - "nullable": true, - "type": "string" - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "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", - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - } -} \ No newline at end of file diff --git a/tests/snapshots/test_parser/test_parse_all_oas_specs/lms_tools.json b/tests/snapshots/test_parser/test_parse_all_oas_specs/lms_tools.json deleted file mode 100644 index f63dbcf..0000000 --- a/tests/snapshots/test_parser/test_parse_all_oas_specs/lms_tools.json +++ /dev/null @@ -1,11046 +0,0 @@ -{ - "lms_batch_upsert_content": { - "description": "Batch Upsert Content", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "lms_batch_upsert_content", - "parameter_locations": { - "items": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/lms/content/batch" - }, - "parameters": { - "properties": { - "items": { - "description": "The batch of items to upsert", - "items": { - "properties": { - "active": { - "description": "Whether the content is active and available for users.", - "example": true, - "nullable": true, - "type": "boolean" - }, - "additional_data": { - "description": "The additional_data associated with this content", - "items": { - "properties": { - "id": { - "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, - "type": "string" - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - }, - "value": { - "description": "The value of the additional data", - "example": "This is additional data", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ] - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "categories": { - "description": "The categories associated with this content", - "items": { - "properties": { - "hierarchy": { - "description": "The hierarchal level of the category", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "primary", - "secondary", - "tertiary", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "id": { - "description": "The ID associated with this category", - "example": "16873-IT345", - "nullable": true, - "type": "string" - }, - "language": { - "description": "The language associated with this category", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The Locale Code of the language", - "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", - null - ], - "example": "en_GB", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "level": { - "deprecated": true, - "description": "The hierarchal level of the category", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "primary", - "secondary", - "tertiary", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "name": { - "description": "The name associated with this category", - "example": "Information-Technology", - "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" - }, - "content_type": { - "description": "The type of content", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "video", - "quiz", - "document", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "content_url": { - "description": "The external URL of the content", - "example": "https://www.youtube.com/watch?v=16873", - "nullable": true, - "type": "string" - }, - "cover_url": { - "description": "The URL of the thumbnail image associated with the content.", - "example": "https://www.googledrive.com/?v=16873", - "nullable": true, - "type": "string" - }, - "description": { - "description": "The description of the content", - "example": "This video acts as learning content for software engineers.", - "nullable": true, - "type": "string" - }, - "duration": { - "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, - "type": "string" - }, - "external_reference": { - "description": "The external ID associated with this content", - "example": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", - "nullable": true, - "type": "string" - }, - "languages": { - "description": "The languages associated with this content", - "items": { - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The Locale Code of the language", - "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", - null - ], - "example": "en_GB", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "mobile_launch_content_url": { - "description": "The mobile friendly URL of the content", - "example": "https://www.mobile.youtube.com/watch?v=16873", - "nullable": true, - "type": "string" - }, - "order": { - "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, - "type": "number" - }, - "short_description": { - "deprecated": true, - "description": "A short description or summary for the content", - "example": "This course is a valuable resource and acts as learning content for...", - "nullable": true, - "type": "string" - }, - "skills": { - "description": "The skills associated with this content", - "example": [ - { - "id": "12345", - "name": "Sales Techniques" - } - ], - "items": { - "properties": { - "hierarchy": { - "description": "The hierarchal level of the skill", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "primary", - "secondary", - "tertiary", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "id": { - "description": "The ID associated with this skill", - "example": "16873-IT345", - "nullable": true, - "type": "string" - }, - "language": { - "description": "The language associated with this skill", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The Locale Code of the language", - "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", - null - ], - "example": "en_GB", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "level": { - "deprecated": true, - "description": "The hierarchal level of the skill", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "primary", - "secondary", - "tertiary", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "name": { - "description": "The name associated with this skill", - "example": "Information-Technology", - "nullable": true, - "type": "string" - }, - "proficiency": { - "description": "The user proficiency level of the skill ranked out of 5", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "1", - "2", - "3", - "4", - "5", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "title": { - "description": "The title of the content", - "example": "Software Engineer Lv 1", - "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": false, - "type": "array" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "lms_batch_upsert_course": { - "description": "Batch Upsert Course", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "lms_batch_upsert_course", - "parameter_locations": { - "items": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/lms/courses/batch" - }, - "parameters": { - "properties": { - "items": { - "description": "The batch of items to upsert", - "items": { - "properties": { - "active": { - "description": "Whether the course is active and available for users.", - "example": true, - "nullable": true, - "type": "boolean" - }, - "categories": { - "description": "The categories associated with this content", - "items": { - "properties": { - "hierarchy": { - "description": "The hierarchal level of the category", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "primary", - "secondary", - "tertiary", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "id": { - "description": "The ID associated with this category", - "example": "16873-IT345", - "nullable": true, - "type": "string" - }, - "language": { - "description": "The language associated with this category", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The Locale Code of the language", - "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", - null - ], - "example": "en_GB", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "level": { - "deprecated": true, - "description": "The hierarchal level of the category", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "primary", - "secondary", - "tertiary", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "name": { - "description": "The name associated with this category", - "example": "Information-Technology", - "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" - }, - "content": { - "description": "The content associated with this course", - "items": { - "properties": { - "content_url": { - "description": "The external URL of the content", - "example": "https://www.youtube.com/watch?v=16873", - "nullable": true, - "type": "string" - }, - "description": { - "description": "The description of the content", - "example": "This video acts as learning content for software engineers.", - "nullable": true, - "type": "string" - }, - "external_reference": { - "description": "The external ID associated with this content", - "example": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", - "nullable": true, - "type": "string" - }, - "order": { - "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, - "type": "number" - }, - "title": { - "description": "The title of the content", - "example": "Software Engineer Lv 1", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "cover_url": { - "description": "The URL of the thumbnail image associated with the course.", - "example": "https://www.googledrive.com/?v=16873", - "nullable": true, - "type": "string" - }, - "description": { - "description": "The description of the course", - "example": "This course acts as learning content for software engineers.", - "nullable": true, - "type": "string" - }, - "duration": { - "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, - "type": "string" - }, - "external_reference": { - "description": "The external ID associated with this course", - "example": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", - "nullable": true, - "type": "string" - }, - "languages": { - "description": "The languages associated with this course", - "items": { - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The Locale Code of the language", - "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", - null - ], - "example": "en_GB", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "skills": { - "description": "The skills associated with this content", - "items": { - "properties": { - "hierarchy": { - "description": "The hierarchal level of the skill", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "primary", - "secondary", - "tertiary", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "id": { - "description": "The ID associated with this skill", - "example": "16873-IT345", - "nullable": true, - "type": "string" - }, - "language": { - "description": "The language associated with this skill", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The Locale Code of the language", - "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", - null - ], - "example": "en_GB", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "level": { - "deprecated": true, - "description": "The hierarchal level of the skill", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "primary", - "secondary", - "tertiary", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "name": { - "description": "The name associated with this skill", - "example": "Information-Technology", - "nullable": true, - "type": "string" - }, - "proficiency": { - "description": "The user proficiency level of the skill ranked out of 5", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "1", - "2", - "3", - "4", - "5", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "title": { - "description": "The title of the course", - "example": "Software Engineer Lv 1", - "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" - }, - "url": { - "description": "The redirect URL of the course.", - "example": "https://www.linkedinlearning.com/?v=16873", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": false, - "type": "array" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "lms_create_collection": { - "description": "Create Collection", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "lms_create_collection", - "parameter_locations": { - "categories": "body", - "cover_url": "body", - "description": "body", - "external_reference": "body", - "languages": "body", - "learning_object_ids": "body", - "remote_learning_object_ids": "body", - "skills": "body", - "title": "body", - "unified_custom_fields": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/lms/collections" - }, - "parameters": { - "properties": { - "categories": { - "description": "The categories associated with this content", - "items": { - "properties": { - "hierarchy": { - "description": "The hierarchal level of the category", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "primary", - "secondary", - "tertiary", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "id": { - "description": "The ID associated with this category", - "example": "16873-IT345", - "nullable": true, - "type": "string" - }, - "language": { - "description": "The language associated with this category", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The Locale Code of the language", - "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", - null - ], - "example": "en_GB", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "level": { - "deprecated": true, - "description": "The hierarchal level of the category", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "primary", - "secondary", - "tertiary", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "name": { - "description": "The name associated with this category", - "example": "Information-Technology", - "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" - }, - "cover_url": { - "description": "The URL of the thumbnail image associated with the collection.", - "example": "https://www.googledrive.com/?v=16873", - "nullable": true, - "type": "string" - }, - "description": { - "description": "The description of the collection", - "example": "This collection acts as learning pathway for software engineers.", - "nullable": true, - "type": "string" - }, - "external_reference": { - "description": "The external ID associated with this collection", - "example": "SOFTWARE-ENG-LV1-TRAINING-collection-1", - "nullable": true, - "type": "string" - }, - "languages": { - "description": "The languages associated with this collection", - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "learning_object_ids": { - "description": "The child ID/IDs associated with this collection", - "example": [ - "16873-SOFTWARE-ENG-COURSE", - "16874-SOFTWARE-ENG-COURSE" - ], - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "remote_learning_object_ids": { - "description": "Provider's unique identifiers of the child ID/IDs associated with this collection", - "example": [ - "e3cb75bf-aa84-466e-a6c1-b8322b257a48", - "e3cb75bf-aa84-466e-a6c1-b8322b257a49" - ], - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "skills": { - "description": "The skills associated with this content", - "items": { - "properties": { - "hierarchy": { - "description": "The hierarchal level of the skill", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "primary", - "secondary", - "tertiary", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "id": { - "description": "The ID associated with this skill", - "example": "16873-IT345", - "nullable": true, - "type": "string" - }, - "language": { - "description": "The language associated with this skill", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The Locale Code of the language", - "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", - null - ], - "example": "en_GB", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "level": { - "deprecated": true, - "description": "The hierarchal level of the skill", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "primary", - "secondary", - "tertiary", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "name": { - "description": "The name associated with this skill", - "example": "Information-Technology", - "nullable": true, - "type": "string" - }, - "proficiency": { - "description": "The user proficiency level of the skill ranked out of 5", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "1", - "2", - "3", - "4", - "5", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "title": { - "description": "The title of the collection", - "example": "Software Engineer Lv 1 Collection", - "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" - } - }, - "type": "object" - } - }, - "lms_create_user_assignment": { - "description": "Create User Assignment", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "lms_create_user_assignment", - "parameter_locations": { - "created_at": "body", - "due_date": "body", - "external_reference": "body", - "id": "path", - "learning_object_external_reference": "body", - "learning_object_id": "body", - "passthrough": "body", - "progress": "body", - "status": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/lms/users/{id}/assignments" - }, - "parameters": { - "properties": { - "created_at": { - "description": "The date the assignment was created", - "example": "2021-07-21T14:00:00.000Z", - "nullable": true, - "type": "string" - }, - "due_date": { - "description": "The date the assignment is due to be completed", - "example": "2021-07-21T14:00:00.000Z", - "nullable": true, - "type": "string" - }, - "external_reference": { - "deprecated": true, - "description": "The external reference associated with this assignment", - "example": "e3gd34-23tr21-er234-345er56", - "nullable": true, - "type": "string" - }, - "id": { - "type": "string" - }, - "learning_object_external_reference": { - "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, - "type": "string" - }, - "learning_object_id": { - "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, - "type": "string" - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe" - }, - "nullable": true, - "type": "object" - }, - "progress": { - "description": "The progress associated with this assigment", - "example": "40", - "nullable": true, - "type": "number" - }, - "status": { - "description": "The status of the assignment", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "pending", - "in_progress", - "completed", - null - ], - "example": "in-progress", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "lms_create_user_completion": { - "description": "Create User Completion", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "lms_create_user_completion", - "parameter_locations": { - "completed_at": "body", - "content_external_reference": "body", - "content_id": "body", - "id": "path", - "learning_object_external_reference": "body", - "learning_object_id": "body", - "passthrough": "body", - "result": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/lms/users/{id}/completions" - }, - "parameters": { - "properties": { - "completed_at": { - "description": "The date the content was completed", - "example": "2021-07-21T14:00:00.000Z", - "nullable": true, - "type": "string" - }, - "content_external_reference": { - "deprecated": true, - "description": "The external reference associated with this content", - "example": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-CONTENT", - "nullable": true, - "type": "string" - }, - "content_id": { - "deprecated": true, - "description": "The content ID associated with this completion", - "example": "16873-ENG-VIDEO-1", - "nullable": true, - "type": "string" - }, - "id": { - "type": "string" - }, - "learning_object_external_reference": { - "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, - "type": "string" - }, - "learning_object_id": { - "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, - "type": "string" - }, - "passthrough": { - "additionalProperties": true, - "description": "Value to pass through to the provider", - "example": { - "other_known_names": "John Doe" - }, - "nullable": true, - "type": "object" - }, - "result": { - "description": "The result of the completion", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "Pass", - "Fail", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "lms_delete_user_completion": { - "description": "Delete User Completion", - "execute": { - "body_type": null, - "headers": {}, - "method": "DELETE", - "name": "lms_delete_user_completion", - "parameter_locations": { - "id": "path", - "subResourceId": "path", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/lms/users/{id}/completions/{subResourceId}" - }, - "parameters": { - "properties": { - "id": { - "type": "string" - }, - "subResourceId": { - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "lms_get_assignment": { - "description": "Get Assignment", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "lms_get_assignment", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/lms/assignments/{id}" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields to return in the response (if empty, all fields are returned)", - "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" - } - }, - "type": "object" - } - }, - "lms_get_category": { - "description": "Get Category", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "lms_get_category", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/lms/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,hierarchy,level,language", - "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" - } - }, - "type": "object" - } - }, - "lms_get_completion": { - "description": "Get Completion", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "lms_get_completion", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/lms/completions/{id}" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields to return in the response (if empty, all fields are returned)", - "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" - } - }, - "type": "object" - } - }, - "lms_get_content": { - "description": "Get Content", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "lms_get_content", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/lms/content/{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,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", - "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" - } - }, - "type": "object" - } - }, - "lms_get_course": { - "description": "Get Course", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "lms_get_course", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/lms/courses/{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,external_reference,content_ids,remote_content_ids,title,description,languages,cover_url,url,active,duration,categories,skills,updated_at,created_at,content,provider", - "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" - } - }, - "type": "object" - } - }, - "lms_get_skill": { - "description": "Get Skill", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "lms_get_skill", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/lms/skills/{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,level,language,hierarchy,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" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "lms_get_user": { - "description": "Get User", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "lms_get_user", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/lms/users/{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,external_reference,active,email,phone_number,created_at,updated_at,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" - } - }, - "type": "object" - } - }, - "lms_get_user_assignment": { - "description": "Get User Assignment", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "lms_get_user_assignment", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "subResourceId": "path", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/lms/users/{id}/assignments/{subResourceId}" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields to return in the response (if empty, all fields are returned)", - "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" - } - }, - "type": "object" - } - }, - "lms_get_user_completion": { - "description": "Get User Completion", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "lms_get_user_completion", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "subResourceId": "path", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/lms/users/{id}/completions/{subResourceId}" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields to return in the response (if empty, all fields are returned)", - "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" - } - }, - "type": "object" - } - }, - "lms_list_assignments": { - "description": "List Assignments", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "lms_list_assignments", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "remote_user_id": "query", - "updated_after": "query", - "user_id": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/lms/assignments" - }, - "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,external_reference,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference", - "nullable": true, - "type": "string" - }, - "filter": { - "description": "LMS Assignment Filter", - "nullable": true, - "properties": { - "status": { - "description": "Filter to select assignment by status", - "enum": [ - "pending", - "in_progress", - "completed", - null - ], - "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" - }, - "remote_user_id": { - "description": "Provider's unique identifier of the user related to the assignment", - "example": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", - "nullable": true, - "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", - "nullable": true, - "type": "string" - }, - "user_id": { - "description": "The user ID associated with this assignment", - "example": "c28xyrc55866bvuv", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "lms_list_categories": { - "description": "List Categories", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "lms_list_categories", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/lms/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,hierarchy,level,language", - "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" - } - }, - "type": "object" - } - }, - "lms_list_completions": { - "description": "List Completions", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "lms_list_completions", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/lms/completions" - }, - "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,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", - "nullable": true, - "type": "string" - }, - "filter": { - "description": "LMS Completions Filter", - "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" - } - }, - "type": "object" - } - }, - "lms_list_content": { - "description": "List Content", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "lms_list_content", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/lms/content" - }, - "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,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", - "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" - } - }, - "type": "object" - } - }, - "lms_list_courses": { - "description": "List Courses", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "lms_list_courses", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/lms/courses" - }, - "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,external_reference,content_ids,remote_content_ids,title,description,languages,cover_url,url,active,duration,categories,skills,updated_at,created_at,content,provider", - "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" - } - }, - "type": "object" - } - }, - "lms_list_skills": { - "description": "List Skills", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "lms_list_skills", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/lms/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,level,language,hierarchy,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" - }, - "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" - } - }, - "type": "object" - } - }, - "lms_list_user_assignments": { - "description": "List User Assignments", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "lms_list_user_assignments", - "parameter_locations": { - "fields": "query", - "filter": "query", - "id": "path", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "remote_user_id": "query", - "updated_after": "query", - "user_id": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/lms/users/{id}/assignments" - }, - "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,external_reference,user_id,remote_user_id,course_id,remote_course_id,updated_at,created_at,due_date,status,progress,learning_object_type,learning_object_id,remote_learning_object_id,learning_object_external_reference", - "nullable": true, - "type": "string" - }, - "filter": { - "description": "LMS Assignment Filter", - "nullable": true, - "properties": { - "status": { - "description": "Filter to select assignment by status", - "enum": [ - "pending", - "in_progress", - "completed", - null - ], - "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" - }, - "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" - }, - "remote_user_id": { - "description": "Provider's unique identifier of the user related to the assignment", - "example": "e3cb75bf-aa84-466e-a6c1-b8322b257a48", - "nullable": true, - "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", - "nullable": true, - "type": "string" - }, - "user_id": { - "description": "The user ID associated with this assignment", - "example": "c28xyrc55866bvuv", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "lms_list_user_completions": { - "description": "List User Completions", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "lms_list_user_completions", - "parameter_locations": { - "fields": "query", - "filter": "query", - "id": "path", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/lms/users/{id}/completions" - }, - "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,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", - "nullable": true, - "type": "string" - }, - "filter": { - "description": "LMS Completions Filter", - "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" - } - }, - "type": "object" - } - }, - "lms_list_users": { - "description": "List Users", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "lms_list_users", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/lms/users" - }, - "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,external_reference,active,email,phone_number,created_at,updated_at,name", - "nullable": true, - "type": "string" - }, - "filter": { - "description": "LMS Users Filter", - "nullable": true, - "properties": { - "email": { - "description": "Filter to select users by email", - "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" - } - }, - "type": "object" - } - }, - "lms_update_collection": { - "description": "Update Collection", - "execute": { - "body_type": "json", - "headers": {}, - "method": "PATCH", - "name": "lms_update_collection", - "parameter_locations": { - "categories": "body", - "cover_url": "body", - "description": "body", - "external_reference": "body", - "id": "path", - "languages": "body", - "learning_object_ids": "body", - "remote_learning_object_ids": "body", - "skills": "body", - "title": "body", - "unified_custom_fields": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/lms/collections/{id}" - }, - "parameters": { - "properties": { - "categories": { - "description": "The categories associated with this content", - "items": { - "properties": { - "hierarchy": { - "description": "The hierarchal level of the category", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "primary", - "secondary", - "tertiary", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "id": { - "description": "The ID associated with this category", - "example": "16873-IT345", - "nullable": true, - "type": "string" - }, - "language": { - "description": "The language associated with this category", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The Locale Code of the language", - "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", - null - ], - "example": "en_GB", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "level": { - "deprecated": true, - "description": "The hierarchal level of the category", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "primary", - "secondary", - "tertiary", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "name": { - "description": "The name associated with this category", - "example": "Information-Technology", - "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" - }, - "cover_url": { - "description": "The URL of the thumbnail image associated with the collection.", - "example": "https://www.googledrive.com/?v=16873", - "nullable": true, - "type": "string" - }, - "description": { - "description": "The description of the collection", - "example": "This collection acts as learning pathway for software engineers.", - "nullable": true, - "type": "string" - }, - "external_reference": { - "description": "The external ID associated with this collection", - "example": "SOFTWARE-ENG-LV1-TRAINING-collection-1", - "nullable": true, - "type": "string" - }, - "id": { - "type": "string" - }, - "languages": { - "description": "The languages associated with this collection", - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "learning_object_ids": { - "description": "The child ID/IDs associated with this collection", - "example": [ - "16873-SOFTWARE-ENG-COURSE", - "16874-SOFTWARE-ENG-COURSE" - ], - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "remote_learning_object_ids": { - "description": "Provider's unique identifiers of the child ID/IDs associated with this collection", - "example": [ - "e3cb75bf-aa84-466e-a6c1-b8322b257a48", - "e3cb75bf-aa84-466e-a6c1-b8322b257a49" - ], - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "skills": { - "description": "The skills associated with this content", - "items": { - "properties": { - "hierarchy": { - "description": "The hierarchal level of the skill", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "primary", - "secondary", - "tertiary", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "id": { - "description": "The ID associated with this skill", - "example": "16873-IT345", - "nullable": true, - "type": "string" - }, - "language": { - "description": "The language associated with this skill", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The Locale Code of the language", - "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", - null - ], - "example": "en_GB", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "level": { - "deprecated": true, - "description": "The hierarchal level of the skill", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "primary", - "secondary", - "tertiary", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "name": { - "description": "The name associated with this skill", - "example": "Information-Technology", - "nullable": true, - "type": "string" - }, - "proficiency": { - "description": "The user proficiency level of the skill ranked out of 5", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "1", - "2", - "3", - "4", - "5", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "title": { - "description": "The title of the collection", - "example": "Software Engineer Lv 1 Collection", - "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" - } - }, - "type": "object" - } - }, - "lms_upsert_content": { - "description": "Upsert Content", - "execute": { - "body_type": "json", - "headers": {}, - "method": "PUT", - "name": "lms_upsert_content", - "parameter_locations": { - "active": "body", - "additional_data": "body", - "categories": "body", - "content_type": "body", - "content_url": "body", - "cover_url": "body", - "description": "body", - "duration": "body", - "external_reference": "body", - "languages": "body", - "mobile_launch_content_url": "body", - "order": "body", - "short_description": "body", - "skills": "body", - "title": "body", - "unified_custom_fields": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/lms/content" - }, - "parameters": { - "properties": { - "active": { - "description": "Whether the content is active and available for users.", - "example": true, - "nullable": true, - "type": "boolean" - }, - "additional_data": { - "description": "The additional_data associated with this content", - "items": { - "properties": { - "id": { - "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, - "type": "string" - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - }, - "value": { - "description": "The value of the additional data", - "example": "This is additional data", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ] - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "categories": { - "description": "The categories associated with this content", - "items": { - "properties": { - "hierarchy": { - "description": "The hierarchal level of the category", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "primary", - "secondary", - "tertiary", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "id": { - "description": "The ID associated with this category", - "example": "16873-IT345", - "nullable": true, - "type": "string" - }, - "language": { - "description": "The language associated with this category", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The Locale Code of the language", - "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", - null - ], - "example": "en_GB", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "level": { - "deprecated": true, - "description": "The hierarchal level of the category", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "primary", - "secondary", - "tertiary", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "name": { - "description": "The name associated with this category", - "example": "Information-Technology", - "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" - }, - "content_type": { - "description": "The type of content", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "video", - "quiz", - "document", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "content_url": { - "description": "The external URL of the content", - "example": "https://www.youtube.com/watch?v=16873", - "nullable": true, - "type": "string" - }, - "cover_url": { - "description": "The URL of the thumbnail image associated with the content.", - "example": "https://www.googledrive.com/?v=16873", - "nullable": true, - "type": "string" - }, - "description": { - "description": "The description of the content", - "example": "This video acts as learning content for software engineers.", - "nullable": true, - "type": "string" - }, - "duration": { - "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, - "type": "string" - }, - "external_reference": { - "description": "The external ID associated with this content", - "example": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", - "nullable": true, - "type": "string" - }, - "languages": { - "description": "The languages associated with this content", - "items": { - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The Locale Code of the language", - "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", - null - ], - "example": "en_GB", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "mobile_launch_content_url": { - "description": "The mobile friendly URL of the content", - "example": "https://www.mobile.youtube.com/watch?v=16873", - "nullable": true, - "type": "string" - }, - "order": { - "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, - "type": "number" - }, - "short_description": { - "deprecated": true, - "description": "A short description or summary for the content", - "example": "This course is a valuable resource and acts as learning content for...", - "nullable": true, - "type": "string" - }, - "skills": { - "description": "The skills associated with this content", - "example": [ - { - "id": "12345", - "name": "Sales Techniques" - } - ], - "items": { - "properties": { - "hierarchy": { - "description": "The hierarchal level of the skill", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "primary", - "secondary", - "tertiary", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "id": { - "description": "The ID associated with this skill", - "example": "16873-IT345", - "nullable": true, - "type": "string" - }, - "language": { - "description": "The language associated with this skill", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The Locale Code of the language", - "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", - null - ], - "example": "en_GB", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "level": { - "deprecated": true, - "description": "The hierarchal level of the skill", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "primary", - "secondary", - "tertiary", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "name": { - "description": "The name associated with this skill", - "example": "Information-Technology", - "nullable": true, - "type": "string" - }, - "proficiency": { - "description": "The user proficiency level of the skill ranked out of 5", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "1", - "2", - "3", - "4", - "5", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "title": { - "description": "The title of the content", - "example": "Software Engineer Lv 1", - "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" - } - }, - "type": "object" - } - }, - "lms_upsert_course": { - "description": "Upsert Course", - "execute": { - "body_type": "json", - "headers": {}, - "method": "PUT", - "name": "lms_upsert_course", - "parameter_locations": { - "active": "body", - "categories": "body", - "content": "body", - "cover_url": "body", - "description": "body", - "duration": "body", - "external_reference": "body", - "languages": "body", - "skills": "body", - "title": "body", - "unified_custom_fields": "body", - "url": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/lms/courses" - }, - "parameters": { - "properties": { - "active": { - "description": "Whether the course is active and available for users.", - "example": true, - "nullable": true, - "type": "boolean" - }, - "categories": { - "description": "The categories associated with this content", - "items": { - "properties": { - "hierarchy": { - "description": "The hierarchal level of the category", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "primary", - "secondary", - "tertiary", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "id": { - "description": "The ID associated with this category", - "example": "16873-IT345", - "nullable": true, - "type": "string" - }, - "language": { - "description": "The language associated with this category", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The Locale Code of the language", - "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", - null - ], - "example": "en_GB", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "level": { - "deprecated": true, - "description": "The hierarchal level of the category", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "primary", - "secondary", - "tertiary", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "name": { - "description": "The name associated with this category", - "example": "Information-Technology", - "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" - }, - "content": { - "description": "The content associated with this course", - "items": { - "properties": { - "content_url": { - "description": "The external URL of the content", - "example": "https://www.youtube.com/watch?v=16873", - "nullable": true, - "type": "string" - }, - "description": { - "description": "The description of the content", - "example": "This video acts as learning content for software engineers.", - "nullable": true, - "type": "string" - }, - "external_reference": { - "description": "The external ID associated with this content", - "example": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", - "nullable": true, - "type": "string" - }, - "order": { - "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, - "type": "number" - }, - "title": { - "description": "The title of the content", - "example": "Software Engineer Lv 1", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "cover_url": { - "description": "The URL of the thumbnail image associated with the course.", - "example": "https://www.googledrive.com/?v=16873", - "nullable": true, - "type": "string" - }, - "description": { - "description": "The description of the course", - "example": "This course acts as learning content for software engineers.", - "nullable": true, - "type": "string" - }, - "duration": { - "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, - "type": "string" - }, - "external_reference": { - "description": "The external ID associated with this course", - "example": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1", - "nullable": true, - "type": "string" - }, - "languages": { - "description": "The languages associated with this course", - "items": { - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The Locale Code of the language", - "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", - null - ], - "example": "en_GB", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "skills": { - "description": "The skills associated with this content", - "items": { - "properties": { - "hierarchy": { - "description": "The hierarchal level of the skill", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "primary", - "secondary", - "tertiary", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "id": { - "description": "The ID associated with this skill", - "example": "16873-IT345", - "nullable": true, - "type": "string" - }, - "language": { - "description": "The language associated with this skill", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The Locale Code of the language", - "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", - null - ], - "example": "en_GB", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "level": { - "deprecated": true, - "description": "The hierarchal level of the skill", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "primary", - "secondary", - "tertiary", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "name": { - "description": "The name associated with this skill", - "example": "Information-Technology", - "nullable": true, - "type": "string" - }, - "proficiency": { - "description": "The user proficiency level of the skill ranked out of 5", - "nullable": true, - "properties": { - "source_value": { - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "enum": [ - "1", - "2", - "3", - "4", - "5", - null - ], - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "title": { - "description": "The title of the course", - "example": "Software Engineer Lv 1", - "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" - }, - "url": { - "description": "The redirect URL of the course.", - "example": "https://www.linkedinlearning.com/?v=16873", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - } -} \ No newline at end of file diff --git a/tests/snapshots/test_parser/test_parse_all_oas_specs/marketing_tools.json b/tests/snapshots/test_parser/test_parse_all_oas_specs/marketing_tools.json deleted file mode 100644 index 83af563..0000000 --- a/tests/snapshots/test_parser/test_parse_all_oas_specs/marketing_tools.json +++ /dev/null @@ -1,2571 +0,0 @@ -{ - "marketing_create_content_block": { - "description": "Create Content Block", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "marketing_create_content_block", - "parameter_locations": { - "content": "body", - "name": "body", - "passthrough": "body", - "tags": "body", - "type": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/marketing/content_blocks" - }, - "parameters": { - "properties": { - "content": { - "nullable": true, - "type": "string" - }, - "name": { - "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" - }, - "tags": { - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "type": { - "description": "Stackone enum identifying the type of content block.", - "nullable": true, - "properties": { - "source_value": { - "description": "The source value of the type.", - "example": "text", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The type of the content blocks.", - "enum": [ - "text", - "html", - "image", - "code-snippet", - null - ], - "example": "html", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "marketing_create_email_template": { - "description": "Create Email Templates", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "marketing_create_email_template", - "parameter_locations": { - "messages": "body", - "name": "body", - "passthrough": "body", - "tags": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/marketing/templates/email" - }, - "parameters": { - "properties": { - "messages": { - "items": { - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - }, - "message_content": { - "nullable": true, - "properties": { - "body": { - "nullable": true, - "type": "string" - }, - "from": { - "nullable": true, - "type": "string" - }, - "preheader": { - "nullable": true, - "type": "string" - }, - "reply-to": { - "nullable": true, - "type": "string" - }, - "subject": { - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "message_type": { - "nullable": true, - "properties": { - "source_value": { - "description": "The original value from the provider used to derive the unified message type.", - "example": "Email", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The unified message type.", - "enum": [ - "email", - "sms", - "push", - "web_push", - "ios_push", - "android_push", - "app_push", - "omni_channel", - "content_block", - "in_app", - "unknown", - "unmapped_value", - null - ], - "example": "email", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "name": { - "nullable": true, - "type": "string" - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "name": { - "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" - }, - "tags": { - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "marketing_create_in_app_template": { - "description": "Create In-App Template", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "marketing_create_in_app_template", - "parameter_locations": { - "messages": "body", - "name": "body", - "passthrough": "body", - "tags": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/marketing/templates/in_app" - }, - "parameters": { - "properties": { - "messages": { - "items": { - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - }, - "message_content": { - "nullable": true, - "properties": { - "body": { - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "message_type": { - "nullable": true, - "properties": { - "source_value": { - "description": "The original value from the provider used to derive the unified message type.", - "example": "Email", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The unified message type.", - "enum": [ - "email", - "sms", - "push", - "web_push", - "ios_push", - "android_push", - "app_push", - "omni_channel", - "content_block", - "in_app", - "unknown", - "unmapped_value", - null - ], - "example": "email", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "name": { - "nullable": true, - "type": "string" - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "name": { - "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" - }, - "tags": { - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "marketing_create_omni_channel_template": { - "description": "Create Omni-Channel Template", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "marketing_create_omni_channel_template", - "parameter_locations": { - "messages": "body", - "name": "body", - "passthrough": "body", - "tags": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/marketing/templates/omni_channel" - }, - "parameters": { - "properties": { - "messages": { - "items": { - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - }, - "message_content": { - "nullable": true, - "oneOf": [ - { - "properties": { - "body": { - "nullable": true, - "type": "string" - }, - "from": { - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - { - "properties": { - "body": { - "nullable": true, - "type": "string" - }, - "from": { - "nullable": true, - "type": "string" - }, - "preheader": { - "nullable": true, - "type": "string" - }, - "reply-to": { - "nullable": true, - "type": "string" - }, - "subject": { - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - { - "properties": { - "body": { - "nullable": true, - "type": "string" - }, - "subtitle": { - "nullable": true, - "type": "string" - }, - "title": { - "nullable": true, - "type": "string" - } - }, - "type": "object" - } - ] - }, - "message_type": { - "description": "Stackone enum identifying the type of message associated with the content.", - "nullable": true, - "properties": { - "source_value": { - "description": "The original value from the provider used to derive the unified message type.", - "example": "Email", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The unified message type.", - "enum": [ - "email", - "sms", - "push", - "web_push", - "ios_push", - "android_push", - "app_push", - "omni_channel", - "content_block", - "in_app", - "unknown", - "unmapped_value", - null - ], - "example": "email", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "name": { - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "name": { - "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" - }, - "tags": { - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "marketing_create_push_template": { - "description": "Create Push Template", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "marketing_create_push_template", - "parameter_locations": { - "messages": "body", - "name": "body", - "passthrough": "body", - "tags": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/marketing/templates/push" - }, - "parameters": { - "properties": { - "messages": { - "items": { - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - }, - "message_content": { - "nullable": true, - "properties": { - "body": { - "nullable": true, - "type": "string" - }, - "subtitle": { - "nullable": true, - "type": "string" - }, - "title": { - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "message_type": { - "nullable": true, - "properties": { - "source_value": { - "description": "The original value from the provider used to derive the unified message type.", - "example": "Email", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The unified message type.", - "enum": [ - "email", - "sms", - "push", - "web_push", - "ios_push", - "android_push", - "app_push", - "omni_channel", - "content_block", - "in_app", - "unknown", - "unmapped_value", - null - ], - "example": "email", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "name": { - "nullable": true, - "type": "string" - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "name": { - "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" - }, - "tags": { - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "marketing_create_sms_template": { - "description": "Create SMS Template", - "execute": { - "body_type": "json", - "headers": {}, - "method": "POST", - "name": "marketing_create_sms_template", - "parameter_locations": { - "messages": "body", - "name": "body", - "passthrough": "body", - "tags": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/marketing/templates/sms" - }, - "parameters": { - "properties": { - "messages": { - "items": { - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - }, - "message_content": { - "nullable": true, - "properties": { - "body": { - "nullable": true, - "type": "string" - }, - "from": { - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "message_type": { - "nullable": true, - "properties": { - "source_value": { - "description": "The original value from the provider used to derive the unified message type.", - "example": "Email", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The unified message type.", - "enum": [ - "email", - "sms", - "push", - "web_push", - "ios_push", - "android_push", - "app_push", - "omni_channel", - "content_block", - "in_app", - "unknown", - "unmapped_value", - null - ], - "example": "email", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "name": { - "nullable": true, - "type": "string" - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "name": { - "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" - }, - "tags": { - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "marketing_get_campaign": { - "description": "Get campaign", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "marketing_get_campaign", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/marketing/campaigns/{id}" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "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" - } - }, - "type": "object" - } - }, - "marketing_get_content_block": { - "description": "Get Content Blocks", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "marketing_get_content_block", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/marketing/content_blocks/{id}" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "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" - } - }, - "type": "object" - } - }, - "marketing_get_email_template": { - "description": "Get Email Templates", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "marketing_get_email_template", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/marketing/templates/email/{id}" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "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" - } - }, - "type": "object" - } - }, - "marketing_get_in_app_template": { - "description": "Get In-App Template", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "marketing_get_in_app_template", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/marketing/templates/in_app/{id}" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "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" - } - }, - "type": "object" - } - }, - "marketing_get_omni_channel_template": { - "description": "Get Omni-Channel Template", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "marketing_get_omni_channel_template", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/marketing/templates/omni_channel/{id}" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "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" - } - }, - "type": "object" - } - }, - "marketing_get_push_template": { - "description": "Get Push Template", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "marketing_get_push_template", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/marketing/templates/push/{id}" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "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" - } - }, - "type": "object" - } - }, - "marketing_get_sms_template": { - "description": "Get SMS Template", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "marketing_get_sms_template", - "parameter_locations": { - "fields": "query", - "id": "path", - "proxy": "query", - "raw": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/marketing/templates/sms/{id}" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "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" - } - }, - "type": "object" - } - }, - "marketing_list_campaigns": { - "description": "List campaigns", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "marketing_list_campaigns", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/marketing/campaigns" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "nullable": true, - "type": "string" - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "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", - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "marketing_list_content_blocks": { - "description": "List Content Blocks", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "marketing_list_content_blocks", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/marketing/content_blocks" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "nullable": true, - "type": "string" - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "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", - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "marketing_list_email_templates": { - "description": "List Email Templates", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "marketing_list_email_templates", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/marketing/templates/email" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "nullable": true, - "type": "string" - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "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", - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "marketing_list_in_app_templates": { - "description": "List In-App Templates", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "marketing_list_in_app_templates", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/marketing/templates/in_app" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "nullable": true, - "type": "string" - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "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", - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "marketing_list_omni_channel_templates": { - "description": "List Omni-Channel Templates", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "marketing_list_omni_channel_templates", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/marketing/templates/omni_channel" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "nullable": true, - "type": "string" - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "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", - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "marketing_list_push_templates": { - "description": "List Push Templates", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "marketing_list_push_templates", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/marketing/templates/push" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "nullable": true, - "type": "string" - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "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", - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "marketing_list_sms_templates": { - "description": "List SMS Templates", - "execute": { - "body_type": null, - "headers": {}, - "method": "GET", - "name": "marketing_list_sms_templates", - "parameter_locations": { - "fields": "query", - "filter": "query", - "next": "query", - "page": "query", - "page_size": "query", - "proxy": "query", - "raw": "query", - "updated_after": "query", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/marketing/templates/sms" - }, - "parameters": { - "properties": { - "fields": { - "description": "The comma separated list of fields that will be returned in the response (if empty, all fields are returned)", - "nullable": true, - "type": "string" - }, - "filter": { - "description": "Filter parameters that allow greater customisation of the list response", - "nullable": true, - "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", - "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", - "nullable": true, - "type": "string" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "marketing_update_content_block": { - "description": "Update Content Block", - "execute": { - "body_type": "json", - "headers": {}, - "method": "PATCH", - "name": "marketing_update_content_block", - "parameter_locations": { - "content": "body", - "id": "path", - "name": "body", - "passthrough": "body", - "tags": "body", - "type": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/marketing/content_blocks/{id}" - }, - "parameters": { - "properties": { - "content": { - "nullable": true, - "type": "string" - }, - "id": { - "type": "string" - }, - "name": { - "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" - }, - "tags": { - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "type": { - "description": "Stackone enum identifying the type of content block.", - "nullable": true, - "properties": { - "source_value": { - "description": "The source value of the type.", - "example": "text", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The type of the content blocks.", - "enum": [ - "text", - "html", - "image", - "code-snippet", - null - ], - "example": "html", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "marketing_update_email_template": { - "description": "Update Email Templates", - "execute": { - "body_type": "json", - "headers": {}, - "method": "PATCH", - "name": "marketing_update_email_template", - "parameter_locations": { - "id": "path", - "messages": "body", - "name": "body", - "passthrough": "body", - "tags": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/marketing/templates/email/{id}" - }, - "parameters": { - "properties": { - "id": { - "type": "string" - }, - "messages": { - "items": { - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - }, - "message_content": { - "nullable": true, - "properties": { - "body": { - "nullable": true, - "type": "string" - }, - "from": { - "nullable": true, - "type": "string" - }, - "preheader": { - "nullable": true, - "type": "string" - }, - "reply-to": { - "nullable": true, - "type": "string" - }, - "subject": { - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "message_type": { - "nullable": true, - "properties": { - "source_value": { - "description": "The original value from the provider used to derive the unified message type.", - "example": "Email", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The unified message type.", - "enum": [ - "email", - "sms", - "push", - "web_push", - "ios_push", - "android_push", - "app_push", - "omni_channel", - "content_block", - "in_app", - "unknown", - "unmapped_value", - null - ], - "example": "email", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "name": { - "nullable": true, - "type": "string" - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "name": { - "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" - }, - "tags": { - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "marketing_update_in_app_template": { - "description": "Update In-App Template", - "execute": { - "body_type": "json", - "headers": {}, - "method": "PATCH", - "name": "marketing_update_in_app_template", - "parameter_locations": { - "id": "path", - "messages": "body", - "name": "body", - "passthrough": "body", - "tags": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/marketing/templates/in_app/{id}" - }, - "parameters": { - "properties": { - "id": { - "type": "string" - }, - "messages": { - "items": { - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - }, - "message_content": { - "nullable": true, - "properties": { - "body": { - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "message_type": { - "nullable": true, - "properties": { - "source_value": { - "description": "The original value from the provider used to derive the unified message type.", - "example": "Email", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The unified message type.", - "enum": [ - "email", - "sms", - "push", - "web_push", - "ios_push", - "android_push", - "app_push", - "omni_channel", - "content_block", - "in_app", - "unknown", - "unmapped_value", - null - ], - "example": "email", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "name": { - "nullable": true, - "type": "string" - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "name": { - "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" - }, - "tags": { - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "marketing_update_omni_channel_template": { - "description": "Update Omni-Channel Template", - "execute": { - "body_type": "json", - "headers": {}, - "method": "PATCH", - "name": "marketing_update_omni_channel_template", - "parameter_locations": { - "id": "path", - "messages": "body", - "name": "body", - "passthrough": "body", - "tags": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/marketing/templates/omni_channel/{id}" - }, - "parameters": { - "properties": { - "id": { - "type": "string" - }, - "messages": { - "items": { - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - }, - "message_content": { - "nullable": true, - "oneOf": [ - { - "properties": { - "body": { - "nullable": true, - "type": "string" - }, - "from": { - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - { - "properties": { - "body": { - "nullable": true, - "type": "string" - }, - "from": { - "nullable": true, - "type": "string" - }, - "preheader": { - "nullable": true, - "type": "string" - }, - "reply-to": { - "nullable": true, - "type": "string" - }, - "subject": { - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - { - "properties": { - "body": { - "nullable": true, - "type": "string" - }, - "subtitle": { - "nullable": true, - "type": "string" - }, - "title": { - "nullable": true, - "type": "string" - } - }, - "type": "object" - } - ] - }, - "message_type": { - "description": "Stackone enum identifying the type of message associated with the content.", - "nullable": true, - "properties": { - "source_value": { - "description": "The original value from the provider used to derive the unified message type.", - "example": "Email", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The unified message type.", - "enum": [ - "email", - "sms", - "push", - "web_push", - "ios_push", - "android_push", - "app_push", - "omni_channel", - "content_block", - "in_app", - "unknown", - "unmapped_value", - null - ], - "example": "email", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "name": { - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "name": { - "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" - }, - "tags": { - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "marketing_update_push_template": { - "description": "Update Push Template", - "execute": { - "body_type": "json", - "headers": {}, - "method": "PATCH", - "name": "marketing_update_push_template", - "parameter_locations": { - "id": "path", - "messages": "body", - "name": "body", - "passthrough": "body", - "tags": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/marketing/templates/push/{id}" - }, - "parameters": { - "properties": { - "id": { - "type": "string" - }, - "messages": { - "items": { - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - }, - "message_content": { - "nullable": true, - "properties": { - "body": { - "nullable": true, - "type": "string" - }, - "subtitle": { - "nullable": true, - "type": "string" - }, - "title": { - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "message_type": { - "nullable": true, - "properties": { - "source_value": { - "description": "The original value from the provider used to derive the unified message type.", - "example": "Email", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The unified message type.", - "enum": [ - "email", - "sms", - "push", - "web_push", - "ios_push", - "android_push", - "app_push", - "omni_channel", - "content_block", - "in_app", - "unknown", - "unmapped_value", - null - ], - "example": "email", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "name": { - "nullable": true, - "type": "string" - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "name": { - "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" - }, - "tags": { - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - }, - "marketing_update_sms_template": { - "description": "Update SMS Template", - "execute": { - "body_type": "json", - "headers": {}, - "method": "PATCH", - "name": "marketing_update_sms_template", - "parameter_locations": { - "id": "path", - "messages": "body", - "name": "body", - "passthrough": "body", - "tags": "body", - "x-account-id": "header" - }, - "url": "https://api.stackone.com/unified/marketing/templates/sms/{id}" - }, - "parameters": { - "properties": { - "id": { - "type": "string" - }, - "messages": { - "items": { - "properties": { - "id": { - "description": "Unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - }, - "message_content": { - "nullable": true, - "properties": { - "body": { - "nullable": true, - "type": "string" - }, - "from": { - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "message_type": { - "nullable": true, - "properties": { - "source_value": { - "description": "The original value from the provider used to derive the unified message type.", - "example": "Email", - "nullable": true, - "oneOf": [ - { - "type": "string" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, - { - "type": "object" - }, - { - "items": {}, - "type": "array" - } - ] - }, - "value": { - "description": "The unified message type.", - "enum": [ - "email", - "sms", - "push", - "web_push", - "ios_push", - "android_push", - "app_push", - "omni_channel", - "content_block", - "in_app", - "unknown", - "unmapped_value", - null - ], - "example": "email", - "nullable": true, - "type": "string", - "x-speakeasy-unknown-values": "allow" - } - }, - "type": "object" - }, - "name": { - "nullable": true, - "type": "string" - }, - "remote_id": { - "description": "Provider's unique identifier", - "example": "8187e5da-dc77-475e-9949-af0f1fa4e4e3", - "nullable": true, - "type": "string" - } - }, - "type": "object" - }, - "nullable": true, - "type": "array" - }, - "name": { - "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" - }, - "tags": { - "items": { - "type": "string" - }, - "nullable": true, - "type": "array" - }, - "x-account-id": { - "description": "The account identifier", - "type": "string" - } - }, - "type": "object" - } - } -} \ No newline at end of file diff --git a/tests/test_feedback.py b/tests/test_feedback.py index 49856df..b60113e 100644 --- a/tests/test_feedback.py +++ b/tests/test_feedback.py @@ -217,13 +217,10 @@ def mock_request_side_effect(*args, **kwargs): def test_tool_integration(self) -> None: """Test that feedback tool integrates properly with toolset.""" - from stackone_ai import StackOneToolSet + from stackone_ai.feedback import create_feedback_tool with patch.dict("os.environ", {"STACKONE_API_KEY": "test_key"}): - toolset = StackOneToolSet() - tools = toolset.get_tools("meta_collect_tool_feedback") - - feedback_tool = tools.get_tool("meta_collect_tool_feedback") + feedback_tool = create_feedback_tool(api_key="test_key") assert feedback_tool is not None assert feedback_tool.name == "meta_collect_tool_feedback" assert "feedback" in feedback_tool.description.lower() @@ -242,17 +239,15 @@ def test_live_feedback_submission() -> None: """Submit feedback to the live API and assert a successful response.""" import uuid + from stackone_ai.feedback import create_feedback_tool + api_key = os.getenv("STACKONE_API_KEY") if not api_key: pytest.skip("STACKONE_API_KEY env var required for live feedback test") base_url = os.getenv("STACKONE_BASE_URL", "https://api.stackone.com") - from stackone_ai import StackOneToolSet - - toolset = StackOneToolSet(api_key=api_key, base_url=base_url) - tools = toolset.get_tools("meta_collect_tool_feedback") - feedback_tool = tools.get_tool("meta_collect_tool_feedback") + feedback_tool = create_feedback_tool(api_key=api_key, base_url=base_url) assert feedback_tool is not None, "Feedback tool must be available" feedback_token = uuid.uuid4().hex[:8] diff --git a/tests/test_parser.py b/tests/test_parser.py deleted file mode 100644 index a5417f6..0000000 --- a/tests/test_parser.py +++ /dev/null @@ -1,731 +0,0 @@ -import json -from pathlib import Path -from typing import Any - -import pytest - -from stackone_ai.specs.parser import OpenAPIParser - - -@pytest.fixture -def sample_openapi_spec() -> dict[str, Any]: - return { - "openapi": "3.0.0", - "servers": [{"url": "https://api.test.com"}], - "paths": { - "/employees/{id}": { - "get": { - "operationId": "get_employee", - "summary": "Get employee details", - "parameters": [ - { - "name": "id", - "in": "path", - "required": True, - "schema": {"type": "string"}, - }, - { - "name": "x-api-version", - "in": "header", - "schema": {"type": "string"}, - "description": "API Version", - }, - { - "name": "include", - "in": "query", - "schema": {"type": "string"}, - "description": "Fields to include", - }, - ], - } - }, - "/employees": { - "post": { - "operationId": "create_employee", - "summary": "Create new employee", - "parameters": [ - { - "name": "x-idempotency-key", - "in": "header", - "schema": {"type": "string"}, - "description": "Idempotency Key", - } - ], - "requestBody": { - "required": True, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Employee name", - }, - "email": { - "type": "string", - "description": "Employee email", - }, - }, - } - } - }, - }, - } - }, - "/employees/{id}/documents": { - "post": { - "operationId": "upload_document", - "description": "Upload employee document", - "parameters": [ - { - "name": "id", - "in": "path", - "required": True, - "schema": {"type": "string"}, - } - ], - "requestBody": { - "required": True, - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "document_type": {"type": "string"}, - "file": {"type": "string", "format": "binary"}, - }, - } - } - }, - }, - } - }, - }, - "components": { - "schemas": { - "Employee": { - "type": "object", - "properties": { - "id": {"type": "string"}, - "name": {"type": "string"}, - "email": {"type": "string"}, - }, - } - } - }, - } - - -@pytest.fixture -def parser(tmp_path: Path, sample_openapi_spec: dict[str, Any]) -> OpenAPIParser: - """Parser for test OpenAPI spec""" - spec_file = tmp_path / "test_spec.json" - spec_file.write_text(json.dumps(sample_openapi_spec)) - return OpenAPIParser(spec_file) - - -def test_parser_initialization(parser: OpenAPIParser) -> None: - """Test parser initialization and base URL handling""" - assert parser.base_url == "https://api.test.com" - - -def test_resolve_schema_ref(parser: OpenAPIParser) -> None: - """Test schema reference resolution""" - ref = "#/components/schemas/Employee" - resolved = parser._resolve_schema_ref(ref) - - assert resolved == { - "type": "object", - "properties": { - "id": {"type": "string"}, - "name": {"type": "string"}, - "email": {"type": "string"}, - }, - } - - -def test_resolve_schema_ref_invalid(parser: OpenAPIParser) -> None: - """Test invalid schema reference handling""" - with pytest.raises(ValueError, match="Only local references are supported"): - parser._resolve_schema_ref("https://external.com/schema.json#/definitions/Type") - - -def test_parse_request_body_json(parser: OpenAPIParser) -> None: - """Test JSON request body parsing""" - operation = parser.spec["paths"]["/employees"]["post"] - schema, body_type = parser._parse_request_body(operation) - - assert body_type == "json" - assert schema == { - "type": "object", - "properties": { - "name": {"type": "string", "description": "Employee name"}, - "email": {"type": "string", "description": "Employee email"}, - }, - } - - -def test_parse_request_body_form(parser: OpenAPIParser) -> None: - """Test form request body parsing""" - operation = parser.spec["paths"]["/employees/{id}/documents"]["post"] - schema, body_type = parser._parse_request_body(operation) - - assert body_type == "form" - assert schema == { - "type": "object", - "properties": { - "document_type": {"type": "string"}, - "file": {"type": "string", "format": "binary"}, - }, - } - - -def test_parse_request_body_none(parser: OpenAPIParser) -> None: - """Test parsing operation without request body""" - operation = parser.spec["paths"]["/employees/{id}"]["get"] - schema, body_type = parser._parse_request_body(operation) - - assert schema is None - assert body_type is None - - -def test_parse_tools(parser: OpenAPIParser) -> None: - """Test parsing complete tools from OpenAPI spec""" - tools = parser.parse_tools() - - # Check get_employee tool - get_employee = tools["get_employee"] - assert get_employee.description == "Get employee details" - assert get_employee.execute.method == "GET" - assert get_employee.execute.url == "https://api.test.com/employees/{id}" - - # Check parameter locations - assert get_employee.execute.parameter_locations == { - "id": "path", - "x-api-version": "header", - "include": "query", - } - - # Check create_employee tool - create_employee = tools["create_employee"] - assert create_employee.execute.body_type == "json" - assert "name" in create_employee.parameters.properties - assert "email" in create_employee.parameters.properties - - # Check upload_document tool - upload_document = tools["upload_document"] - assert upload_document.execute.body_type == "form" - assert "document_type" in upload_document.parameters.properties - assert "file" in upload_document.parameters.properties - - -def test_parse_tools_empty_spec(tmp_path: Path) -> None: - """Test parsing empty OpenAPI spec""" - empty_spec = {"openapi": "3.0.0", "paths": {}} - spec_file = tmp_path / "empty_spec.json" - spec_file.write_text(json.dumps(empty_spec)) - - parser = OpenAPIParser(spec_file) - tools = parser.parse_tools() - - assert len(tools) == 0 - - -def test_operation_id_required(parser: OpenAPIParser) -> None: - """Test that operationId is required for all operations""" - # Remove operationId from a path - del parser.spec["paths"]["/employees/{id}"]["get"]["operationId"] - - # Attempt to parse tools should raise ValueError - with pytest.raises(ValueError, match="Operation ID is required for tool parsing"): - parser.parse_tools() - - # Verify error contains useful operation details - try: - parser.parse_tools() - except ValueError as e: - assert "Get employee details" in str(e), "Error should contain operation description" - assert "parameters" in str(e), "Error should contain operation details" - - -@pytest.fixture -def nested_components_spec() -> dict[str, Any]: - return { - "openapi": "3.0.0", - "servers": [{"url": "https://api.test.com"}], - "paths": { - "/employees": { - "post": { - "operationId": "create_employee", - "summary": "Create new employee", - "requestBody": { - "required": True, - "content": { - "application/json": { - "schema": {"$ref": "#/components/schemas/CreateEmployeeRequest"} - } - }, - }, - } - } - }, - "components": { - "schemas": { - "CreateEmployeeRequest": { - "type": "object", - "properties": { - "personal_info": {"$ref": "#/components/schemas/PersonalInfo"}, - "employment": {"$ref": "#/components/schemas/Employment"}, - }, - }, - "PersonalInfo": { - "type": "object", - "properties": { - "first_name": {"type": "string", "description": "First name of employee"}, - "last_name": {"type": "string", "description": "Last name of employee"}, - "contact": {"$ref": "#/components/schemas/Contact"}, - }, - }, - "Contact": { - "type": "object", - "properties": { - "email": {"type": "string", "description": "Email address"}, - "phone": {"type": "string", "description": "Phone number"}, - }, - }, - "Employment": { - "type": "object", - "properties": { - "department": {"type": "string", "description": "Department name"}, - "position": {"type": "string", "description": "Job position"}, - }, - }, - } - }, - } - - -@pytest.fixture -def nested_parser(tmp_path: Path, nested_components_spec: dict[str, Any]) -> OpenAPIParser: - spec_file = tmp_path / "nested_spec.json" - spec_file.write_text(json.dumps(nested_components_spec)) - return OpenAPIParser(spec_file) - - -def test_nested_schema_resolution(nested_parser: OpenAPIParser) -> None: - """Test resolution of nested schema references""" - tools = nested_parser.parse_tools() - - create_employee = tools["create_employee"] - properties = create_employee.parameters.properties - - # Check top level properties are resolved - assert "personal_info" in properties - assert "employment" in properties - - # Check nested properties structure - personal_info = properties["personal_info"] - assert personal_info["type"] == "object" - assert "first_name" in personal_info["properties"] - assert "last_name" in personal_info["properties"] - assert "contact" in personal_info["properties"] - - # Check deeply nested properties - contact = personal_info["properties"]["contact"] - assert contact["type"] == "object" - assert "email" in contact["properties"] - assert "phone" in contact["properties"] - - # Check employment properties - employment = properties["employment"] - assert employment["type"] == "object" - assert "department" in employment["properties"] - assert "position" in employment["properties"] - - # Verify property types and descriptions are preserved - assert personal_info["properties"]["first_name"]["type"] == "string" - assert "First name of employee" in personal_info["properties"]["first_name"]["description"] - - -def test_circular_reference_detection(nested_parser: OpenAPIParser) -> None: - """Test detection of circular references in schemas""" - # Add a circular reference - nested_parser.spec["components"]["schemas"]["Contact"]["properties"]["employee"] = { - "$ref": "#/components/schemas/CreateEmployeeRequest" - } - - with pytest.raises(ValueError, match="Circular reference detected"): - nested_parser.parse_tools() - - -@pytest.fixture -def oas_specs() -> list[tuple[str, dict[str, Any]]]: - """Load all OpenAPI specs from the oas directory""" - oas_dir = Path("stackone_ai/oas") - specs = [] - - for spec_file in oas_dir.glob("*.json"): - if spec_file.name == ".gitignore": - continue - with open(spec_file) as f: - specs.append((spec_file.stem, json.load(f))) - - return specs - - -def test_parse_all_oas_specs(tmp_path: Path, oas_specs: list[tuple[str, dict[str, Any]]], snapshot) -> None: - """Test parsing all OpenAPI specs with separate snapshots for each spec""" - - for name, spec in oas_specs: - # Create temporary file for each spec - spec_file = tmp_path / f"{name}_spec.json" - spec_file.write_text(json.dumps(spec)) - - parser = OpenAPIParser(spec_file) - tools = parser.parse_tools() - - # Basic validation of parsed tools - assert tools, f"No tools parsed from {name} spec" - for tool_name, tool in tools.items(): - assert tool.description, f"Tool {tool_name} in {name} spec has no description" - assert tool.execute.method, f"Tool {tool_name} in {name} spec has no HTTP method" - assert tool.execute.url, f"Tool {tool_name} in {name} spec has no URL" - assert tool.parameters.properties, f"Tool {tool_name} in {name} spec has no parameters" - - # Convert tools to serializable format for snapshot - serialized_tools = { - tool_name: { - "description": tool.description, - "parameters": tool.parameters.model_dump(), - "execute": tool.execute.model_dump(), - } - for tool_name, tool in tools.items() - } - - # Create separate snapshot for each spec - snapshot_json = json.dumps(serialized_tools, indent=2, sort_keys=True) - snapshot.assert_match(snapshot_json, f"{name}_tools.json") - - -def test_resolve_schema_with_allof(tmp_path: Path) -> None: - """Test resolving schema with allOf references""" - - # Create a minimal OpenAPI spec with nested component references - spec = { - "openapi": "3.0.0", - "info": {"title": "Test API", "version": "1.0.0"}, - "components": { - "schemas": { - "ApplicationStatusEnum": {"type": "string", "enum": ["pending", "accepted", "rejected"]}, - "BaseCandidate": { - "type": "object", - "properties": {"name": {"type": "string"}, "email": {"type": "string"}}, - }, - "CreateCandidate": { - "allOf": [ - {"$ref": "#/components/schemas/BaseCandidate"}, - { - "type": "object", - "properties": {"phone": {"type": "string"}}, - }, - ], - "description": "Extended candidate model", - }, - } - }, - "paths": { - "/test": { - "post": { - "operationId": "test_operation", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "application_status": { - "allOf": [{"$ref": "#/components/schemas/ApplicationStatusEnum"}], - "nullable": True, - }, - "candidate": { - "allOf": [{"$ref": "#/components/schemas/CreateCandidate"}], - "description": "Candidate Properties", - "nullable": True, - }, - }, - } - } - } - }, - } - } - }, - } - - # Write spec to temporary file - spec_file = tmp_path / "test_spec.json" - spec_file.write_text(json.dumps(spec)) - - # Parse the spec - parser = OpenAPIParser(spec_file) - tools = parser.parse_tools() - - # Get the resolved schema for our test operation - tool = tools["test_operation"] - - # Verify application_status schema - status_schema = tool.parameters.properties["application_status"] - assert status_schema["type"] == "string" - assert status_schema["enum"] == ["pending", "accepted", "rejected"] - assert status_schema["nullable"] is True - - # Verify candidate schema with nested references - candidate_schema = tool.parameters.properties["candidate"] - assert candidate_schema["type"] == "object" - assert "name" in candidate_schema["properties"] - assert "email" in candidate_schema["properties"] - assert "phone" in candidate_schema["properties"] # From CreateCandidate extension - assert candidate_schema["description"] == "Candidate Properties" - assert candidate_schema["nullable"] is True - - -@pytest.fixture -def temp_spec_file(tmp_path: Path) -> Path: - """Create a temporary OpenAPI spec file for testing.""" - - def write_spec(spec: dict[str, Any]) -> Path: - spec_file = tmp_path / "test_spec.json" - with open(spec_file, "w") as f: - json.dump(spec, f) - return spec_file - - return write_spec - - -def test_parse_file_upload(temp_spec_file: Path) -> None: - """Test parsing an OpenAPI spec with file upload endpoints.""" - spec = { - "openapi": "3.0.0", - "info": {"title": "Test API", "version": "1.0.0"}, - "paths": { - "/upload": { - "post": { - "operationId": "uploadFile", - "summary": "Upload a file", - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "file": { - "type": "string", - "format": "binary", - "description": "The file to upload", - }, - "description": {"type": "string", "description": "File description"}, - }, - "required": ["file"], - } - } - } - }, - } - } - }, - } - - parser = OpenAPIParser(temp_spec_file(spec)) - tools = parser.parse_tools() - - assert "uploadFile" in tools - tool = tools["uploadFile"] - - # Check file parameter is correctly marked - assert "file" in tool.parameters.properties - assert tool.parameters.properties["file"]["type"] == "file" - assert tool.execute.parameter_locations["file"] == "file" - - # Check non-file parameter - assert "description" in tool.parameters.properties - assert tool.parameters.properties["description"]["type"] == "string" - assert tool.execute.parameter_locations["description"] == "body" - - # Check body type - assert tool.execute.body_type == "multipart" - - -def test_parse_multiple_files(temp_spec_file: Path) -> None: - """Test parsing an endpoint that accepts multiple files.""" - spec = { - "openapi": "3.0.0", - "info": {"title": "Test API", "version": "1.0.0"}, - "paths": { - "/upload-multiple": { - "post": { - "operationId": "uploadMultipleFiles", - "summary": "Upload multiple files", - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "files": { - "type": "array", - "items": {"type": "string", "format": "binary"}, - "description": "Multiple files to upload", - }, - "metadata": { - "type": "object", - "properties": {"category": {"type": "string"}}, - }, - }, - } - } - } - }, - } - } - }, - } - - parser = OpenAPIParser(temp_spec_file(spec)) - tools = parser.parse_tools() - - assert "uploadMultipleFiles" in tools - tool = tools["uploadMultipleFiles"] - - # Check array of files - assert "files" in tool.parameters.properties - assert tool.parameters.properties["files"]["type"] == "array" - assert tool.parameters.properties["files"]["items"]["type"] == "file" - assert tool.execute.parameter_locations["files"] == "file" - - # Check nested object parameter - assert "metadata" in tool.parameters.properties - assert tool.parameters.properties["metadata"]["type"] == "object" - assert tool.execute.parameter_locations["metadata"] == "body" - - -def test_mixed_parameter_types(temp_spec_file: Path) -> None: - """Test parsing an endpoint with mixed parameter types (path, query, file).""" - spec = { - "openapi": "3.0.0", - "info": {"title": "Test API", "version": "1.0.0"}, - "paths": { - "/users/{userId}/files": { - "post": { - "operationId": "uploadUserFile", - "summary": "Upload a user file", - "parameters": [ - {"name": "userId", "in": "path", "required": True, "schema": {"type": "string"}}, - {"name": "overwrite", "in": "query", "schema": {"type": "boolean"}}, - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": {"file": {"type": "string", "format": "binary"}}, - } - } - } - }, - } - } - }, - } - - parser = OpenAPIParser(temp_spec_file(spec)) - tools = parser.parse_tools() - - assert "uploadUserFile" in tools - tool = tools["uploadUserFile"] - - # Check path parameter - assert tool.execute.parameter_locations["userId"] == "path" - assert tool.parameters.properties["userId"]["type"] == "string" - - # Check query parameter - assert tool.execute.parameter_locations["overwrite"] == "query" - assert tool.parameters.properties["overwrite"]["type"] == "boolean" - - # Check file parameter - assert tool.execute.parameter_locations["file"] == "file" - assert tool.parameters.properties["file"]["type"] == "file" - - # Check body type - assert tool.execute.body_type == "multipart" - - -def test_form_data_without_files(temp_spec_file: Path) -> None: - """Test parsing form data without file uploads.""" - spec = { - "openapi": "3.0.0", - "info": {"title": "Test API", "version": "1.0.0"}, - "paths": { - "/submit-form": { - "post": { - "operationId": "submitForm", - "summary": "Submit a form", - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": {"name": {"type": "string"}, "age": {"type": "integer"}}, - } - } - } - }, - } - } - }, - } - - parser = OpenAPIParser(temp_spec_file(spec)) - tools = parser.parse_tools() - - assert "submitForm" in tools - tool = tools["submitForm"] - - # Check form parameters - assert tool.execute.parameter_locations["name"] == "body" - assert tool.execute.parameter_locations["age"] == "body" - assert tool.parameters.properties["name"]["type"] == "string" - assert tool.parameters.properties["age"]["type"] == "integer" - - # Check body type - assert tool.execute.body_type == "form" - - -def test_parser_with_base_url_override(tmp_path: Path, sample_openapi_spec: dict[str, Any]) -> None: - """Test that the parser uses the provided base_url instead of the one from the spec.""" - # Write the spec to a temporary file - spec_file = tmp_path / "test_spec.json" - with open(spec_file, "w") as f: - json.dump(sample_openapi_spec, f) - - # Create parser with default base_url - default_parser = OpenAPIParser(spec_file) - assert default_parser.base_url == "https://api.test.com" - - # Create parser with development base_url - dev_parser = OpenAPIParser(spec_file, base_url="https://api.example-dev.com") - assert dev_parser.base_url == "https://api.example-dev.com" - - # Create parser with experimental base_url - exp_parser = OpenAPIParser(spec_file, base_url="https://api.example-exp.com") - assert exp_parser.base_url == "https://api.example-exp.com" - - # Verify the base_url is used in the tool definitions for development environment - dev_tools = dev_parser.parse_tools() - assert dev_tools["get_employee"].execute.url.startswith("https://api.example-dev.com") - assert not dev_tools["get_employee"].execute.url.startswith("https://api.test.com") - - # Verify the base_url is used in the tool definitions for experimental environment - exp_tools = exp_parser.parse_tools() - assert exp_tools["get_employee"].execute.url.startswith("https://api.example-exp.com") - assert not exp_tools["get_employee"].execute.url.startswith("https://api.test.com") diff --git a/tests/test_toolset.py b/tests/test_toolset.py deleted file mode 100644 index 858ad82..0000000 --- a/tests/test_toolset.py +++ /dev/null @@ -1,273 +0,0 @@ -from unittest.mock import MagicMock, patch - -from stackone_ai.models import ExecuteConfig, ToolDefinition, ToolParameters -from stackone_ai.toolset import StackOneToolSet - - -def test_toolset_initialization(): - """Test StackOneToolSet initialization and tool creation""" - mock_spec_content = { - "paths": { - "/employee/{id}": { - "get": { - "operationId": "hris_get_employee", - "summary": "Get employee details", - "parameters": [ - { - "in": "path", - "name": "id", - "schema": {"type": "string"}, - "description": "Employee ID", - } - ], - } - } - } - } - - # Create mock tool definition - mock_tool_def = ToolDefinition( - description="Get employee details", - parameters=ToolParameters( - type="object", - properties={ - "id": { - "type": "string", - "description": "Employee ID", - } - }, - ), - execute=ExecuteConfig( - method="GET", - url="https://api.stackone.com/employee/{id}", - name="hris_get_employee", - headers={}, - parameter_locations={"id": "path"}, - ), - ) - - # Mock the OpenAPIParser and file operations - with ( - patch("stackone_ai.toolset.OAS_DIR") as mock_dir, - patch("stackone_ai.toolset.OpenAPIParser") as mock_parser_class, - ): - # Setup mocks - mock_path = MagicMock() - mock_path.exists.return_value = True - mock_dir.__truediv__.return_value = mock_path - mock_dir.glob.return_value = [mock_path] - - # Setup parser mock - mock_parser = MagicMock() - mock_parser.spec = mock_spec_content - mock_parser.parse_tools.return_value = {"hris_get_employee": mock_tool_def} - mock_parser_class.return_value = mock_parser - - # Create and test toolset - toolset = StackOneToolSet(api_key="test_key") - tools = toolset.get_tools(filter_pattern="hris_*", account_id="test_account") - - # Verify results - assert len(tools) == 1 - tool = tools.get_tool("hris_get_employee") - assert tool is not None - assert tool.description == "Get employee details" - assert tool._api_key == "test_key" - assert tool._account_id == "test_account" - - # Verify the tool parameters - assert tool.parameters.properties["id"]["type"] == "string" - assert tool.parameters.properties["id"]["description"] == "Employee ID" - - -def test_empty_filter_result(): - """Test getting tools with a filter pattern that matches nothing""" - toolset = StackOneToolSet(api_key="test_key") - tools = toolset.get_tools(filter_pattern="unknown_*") - assert len(tools) == 0 - - -def test_toolset_with_base_url(): - """Test StackOneToolSet with a custom base_url""" - mock_spec_content = { - "paths": { - "/employee/{id}": { - "get": { - "operationId": "hris_get_employee", - "summary": "Get employee details", - "parameters": [ - { - "in": "path", - "name": "id", - "schema": {"type": "string"}, - "description": "Employee ID", - } - ], - } - } - } - } - - # Create mock tool definition with default URL - mock_tool_def = ToolDefinition( - description="Get employee details", - parameters=ToolParameters( - type="object", - properties={ - "id": { - "type": "string", - "description": "Employee ID", - } - }, - ), - execute=ExecuteConfig( - method="GET", - url="https://api.stackone.com/employee/{id}", - name="hris_get_employee", - headers={}, - parameter_locations={"id": "path"}, - ), - ) - - # Create mock tool definition with development URL - mock_tool_def_dev = ToolDefinition( - description="Get employee details", - parameters=ToolParameters( - type="object", - properties={ - "id": { - "type": "string", - "description": "Employee ID", - } - }, - ), - execute=ExecuteConfig( - method="GET", - url="https://api.example-dev.com/employee/{id}", - name="hris_get_employee", - headers={}, - parameter_locations={"id": "path"}, - ), - ) - - # Create mock tool definition with experimental URL - mock_tool_def_exp = ToolDefinition( - description="Get employee details", - parameters=ToolParameters( - type="object", - properties={ - "id": { - "type": "string", - "description": "Employee ID", - } - }, - ), - execute=ExecuteConfig( - method="GET", - url="https://api.example-exp.com/employee/{id}", - name="hris_get_employee", - headers={}, - parameter_locations={"id": "path"}, - ), - ) - - # Mock the OpenAPIParser and file operations - with ( - patch("stackone_ai.toolset.OAS_DIR") as mock_dir, - patch("stackone_ai.toolset.OpenAPIParser") as mock_parser_class, - ): - # Setup mocks - mock_path = MagicMock() - mock_path.exists.return_value = True - mock_dir.__truediv__.return_value = mock_path - mock_dir.glob.return_value = [mock_path] - - # Setup parser mock for default URL - mock_parser = MagicMock() - mock_parser.spec = mock_spec_content - mock_parser.parse_tools.return_value = {"hris_get_employee": mock_tool_def} - - # Setup parser mock for development URL - mock_parser_dev = MagicMock() - mock_parser_dev.spec = mock_spec_content - mock_parser_dev.parse_tools.return_value = {"hris_get_employee": mock_tool_def_dev} - - # Setup parser mock for experimental URL - mock_parser_exp = MagicMock() - mock_parser_exp.spec = mock_spec_content - mock_parser_exp.parse_tools.return_value = {"hris_get_employee": mock_tool_def_exp} - - # Configure the mock parser class to return different instances based on base_url - def get_parser(spec_path, base_url=None): - if base_url == "https://api.example-dev.com": - return mock_parser_dev - elif base_url == "https://api.example-exp.com": - return mock_parser_exp - return mock_parser - - mock_parser_class.side_effect = get_parser - - # Test with default URL - toolset = StackOneToolSet(api_key="test_key") - tools = toolset.get_tools(filter_pattern="hris_*") - tool = tools.get_tool("hris_get_employee") - assert tool is not None - assert tool._execute_config.url == "https://api.stackone.com/employee/{id}" - - # Test with development URL - toolset_dev = StackOneToolSet(api_key="test_key", base_url="https://api.example-dev.com") - tools_dev = toolset_dev.get_tools(filter_pattern="hris_*") - tool_dev = tools_dev.get_tool("hris_get_employee") - assert tool_dev is not None - assert tool_dev._execute_config.url == "https://api.example-dev.com/employee/{id}" - - # Test with experimental URL - toolset_exp = StackOneToolSet(api_key="test_key", base_url="https://api.example-exp.com") - tools_exp = toolset_exp.get_tools(filter_pattern="hris_*") - tool_exp = tools_exp.get_tool("hris_get_employee") - assert tool_exp is not None - assert tool_exp._execute_config.url == "https://api.example-exp.com/employee/{id}" - - -def test_set_accounts(): - """Test setting account IDs for filtering""" - toolset = StackOneToolSet(api_key="test_key") - result = toolset.set_accounts(["acc1", "acc2"]) - - # Should return self for chaining - assert result is toolset - assert toolset._account_ids == ["acc1", "acc2"] - - -def test_filter_by_provider(): - """Test provider filtering""" - toolset = StackOneToolSet(api_key="test_key") - - # Test matching providers - assert toolset._filter_by_provider("hris_list_employees", ["hris", "ats"]) - assert toolset._filter_by_provider("ats_create_job", ["hris", "ats"]) - - # Test non-matching providers - assert not toolset._filter_by_provider("crm_list_contacts", ["hris", "ats"]) - - # Test case-insensitive matching - assert toolset._filter_by_provider("HRIS_list_employees", ["hris"]) - assert toolset._filter_by_provider("hris_list_employees", ["HRIS"]) - - -def test_filter_by_action(): - """Test action filtering with glob patterns""" - toolset = StackOneToolSet(api_key="test_key") - - # Test exact match - assert toolset._filter_by_action("hris_list_employees", ["hris_list_employees"]) - - # Test glob pattern - assert toolset._filter_by_action("hris_list_employees", ["*_list_employees"]) - assert toolset._filter_by_action("ats_list_employees", ["*_list_employees"]) - assert toolset._filter_by_action("hris_list_employees", ["hris_*"]) - assert toolset._filter_by_action("hris_create_employee", ["hris_*"]) - - # Test non-matching patterns - assert not toolset._filter_by_action("crm_list_contacts", ["*_list_employees"]) - assert not toolset._filter_by_action("ats_create_job", ["hris_*"])