diff --git a/.env_example b/.env_example index 5907c3c..8e27673 100644 --- a/.env_example +++ b/.env_example @@ -1,3 +1,2 @@ STACKONE_API_KEY=your_stackone_api_key -STACKONE_ACCOUNT_ID=your_stackone_account_id OPENAI_API_KEY=your_openai_api_key diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index f30b8e8..d857840 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -4,9 +4,6 @@ on: push: branches: - main - pull_request: - branches: - - main permissions: contents: write diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 81e47cc..52b2754 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -18,7 +18,7 @@ jobs: enable-cache: true - name: Install dependencies - run: uv sync + run: uv sync --all-extras - name: Run Ruff uses: astral-sh/ruff-action@v3 diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 3e3a3d6..a6118c5 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -8,7 +8,9 @@ on: jobs: test: runs-on: ubuntu-latest - + env: + STACKONE_API_KEY: ${{ secrets.STACKONE_API_KEY }} + OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }} steps: - uses: actions/checkout@v4 @@ -19,10 +21,7 @@ jobs: enable-cache: true - name: Install dependencies - run: uv sync + run: uv sync --all-extras - name: Run tests run: uv run pytest - - - name: Run type checks - run: uv run mypy packages/stackone-core/ diff --git a/examples/api_reference.py b/examples/api_reference.py deleted file mode 100644 index 2c5c61e..0000000 --- a/examples/api_reference.py +++ /dev/null @@ -1,118 +0,0 @@ -""" -## StackOneToolSet - -The main class for accessing StackOne tools. - -### Constructor - -```python -StackOneToolSet( - api_key: str | None = None, - account_id: str | None = None -) -``` - -**Parameters:** -- `api_key`: Optional API key. If not provided, uses `STACKONE_API_KEY` env variable -- `account_id`: Optional account ID. If not provided, uses `STACKONE_ACCOUNT_ID` env variable - -### Methods - -#### get_tools - -```python -def get_tools( - vertical: str, - account_id: str | None = None -) -> Tools -``` - -Get tools for a specific vertical. - -**Parameters:** -- `vertical`: The vertical to get tools for (e.g. "hris", "crm") -- `account_id`: Optional account ID override. If not provided, uses the one from initialization - -**Returns:** -- `Tools` instance containing available tools - -## Tools - -Container for Tool instances. - -### Methods - -#### get_tool - -```python -def get_tool(name: str) -> BaseTool | None -``` - -Get a tool by its name. - -**Parameters:** -- `name`: Name of the tool to get - -**Returns:** -- `BaseTool` instance if found, None otherwise - -#### to_openai - -```python -def to_openai() -> list[dict] -``` - -Convert all tools to OpenAI function format. - -**Returns:** -- List of tools in OpenAI function format - -## BaseTool - -Base class for individual tools. - -### Methods - -#### execute - -```python -def execute(arguments: str | dict) -> dict[str, Any] -``` - -Execute the tool with the given parameters. - -**Parameters:** -- `arguments`: Either a JSON string or dict of arguments - -**Returns:** -- Tool execution results - -#### to_openai_function - -```python -def to_openai_function() -> dict -``` - -Convert this tool to OpenAI's function format. - -**Returns:** -- Tool definition in OpenAI function format -""" - -# Example usage of the API -from stackone_ai import StackOneToolSet - -# Initialize with environment variables -toolset = StackOneToolSet() - -# Get tools for HRIS vertical -tools = toolset.get_tools(vertical="hris") - -# Get a specific tool -employee_tool = tools.get_tool("get_employee") -if employee_tool: - # Execute the tool - result = employee_tool.execute({"id": "employee123"}) - - # Convert to OpenAI format - openai_function = employee_tool.to_openai_function() diff --git a/examples/available_tools.py b/examples/available_tools.py new file mode 100644 index 0000000..ee58a0c --- /dev/null +++ b/examples/available_tools.py @@ -0,0 +1,16 @@ +""" +Get available tools from your StackOne organisation based on the account id. + +```bash +uv run examples/available_tools.py +``` +""" + + +# TODO: Add examples +def get_available_tools(): + print("Getting available tools") + + +if __name__ == "__main__": + print(get_available_tools()) diff --git a/examples/basic_tool_usage.py b/examples/basic_tool_usage.py deleted file mode 100644 index 6944a48..0000000 --- a/examples/basic_tool_usage.py +++ /dev/null @@ -1,53 +0,0 @@ -""" -This example shows how to use StackOne tools. - -## Requirements -- STACKONE_API_KEY -- STACKONE_ACCOUNT_ID -""" - -import os - -from dotenv import load_dotenv -from stackone_ai import StackOneToolSet - - -def main(): - # Load environment variables from .env - load_dotenv() - - api_key = os.getenv("STACKONE_API_KEY") - account_id = os.getenv("STACKONE_ACCOUNT_ID") - - if not api_key or not account_id: - raise ValueError("STACKONE_API_KEY or STACKONE_ACCOUNT_ID not found in .env file") - - # Initialize the toolset with your API key - toolset = StackOneToolSet(api_key=api_key) - - """ - ## Using Tools - - Once initialized, you can get tools for specific verticals: - """ - - # Get HRIS tools - tools = toolset.get_tools(vertical="hris", account_id=account_id) - - """ - Then use specific tools by name: - """ - - # Example: Get an employee by ID - try: - # The tool name comes from the x-speakeasy-name-override in the OpenAPI spec - employee_tool = tools.get_tool("get_employee") - if employee_tool: - employees = employee_tool.execute({"id": "c28xIQaWQ6MzM5MzczMDA2NzMzMzkwNzIwNA"}) - print("Employees retrieved:", employees) - except Exception as e: - print(f"Error getting employee: {e}") - - -if __name__ == "__main__": - main() diff --git a/examples/crewai_integration.py b/examples/crewai_integration.py new file mode 100644 index 0000000..a23f11c --- /dev/null +++ b/examples/crewai_integration.py @@ -0,0 +1,49 @@ +""" +This example demonstrates how to use StackOne tools with CrewAI. + +CrewAI uses LangChain tools natively. + +```bash +uv run examples/crewai_integration.py +``` +""" + +from crewai import Agent, Crew, Task +from stackone_ai import StackOneToolSet + +account_id = "45072196112816593343" +employee_id = "c28xIQaWQ6MzM5MzczMDA2NzMzMzkwNzIwNA" + + +def crewai_integration(): + toolset = StackOneToolSet() + tools = toolset.get_tools( + vertical="hris", + account_id=account_id, + ) + + # CrewAI uses LangChain tools natively + langchain_tools = tools.to_langchain() + + agent = Agent( + role="HR Manager", + goal=f"What is the employee with the id {employee_id}?", + backstory="With over 10 years of experience in HR and employee management, " + "you excel at finding patterns in complex datasets.", + llm="gpt-4o-mini", + tools=langchain_tools, + max_iter=2, + ) + + task = Task( + description="What is the employee with the id c28xIQaWQ6MzM5MzczMDA2NzMzMzkwNzIwNA?", + agent=agent, + expected_output="A JSON object containing the employee's information", + ) + + crew = Crew(agents=[agent], tasks=[task]) + print(crew.kickoff()) + + +if __name__ == "__main__": + crewai_integration() diff --git a/examples/error_handling.py b/examples/error_handling.py index ad5d227..1202efe 100644 --- a/examples/error_handling.py +++ b/examples/error_handling.py @@ -1,50 +1,39 @@ -import os - from dotenv import load_dotenv from stackone_ai import StackOneToolSet +load_dotenv() -def demonstrate_error_handling(): - # Load environment variables from root .env - load_dotenv() - - api_key = os.getenv("STACKONE_API_KEY") - account_id = os.getenv("STACKONE_ACCOUNT_ID") - if not api_key: - raise ValueError("STACKONE_API_KEY not found in .env file") - - toolset = StackOneToolSet(api_key=api_key) +def error_handling() -> None: + toolset = StackOneToolSet() # Example 1: Handle unknown vertical - try: - tools = toolset.get_tools(vertical="unknown_vertical") - print("Tools for unknown vertical:", tools) # Will print empty dict - except Exception as e: - print(f"Error getting tools: {e}") + tools = toolset.get_tools(vertical="unknown_vertical") + print("Tools for unknown vertical:", tools._tool_map) + # {} # Example 2: Handle API errors with account_id - tools = toolset.get_tools(vertical="crm", account_id=account_id) - - # Example of handling various API errors + tools = toolset.get_tools(vertical="crm", account_id="test_id") try: # Try with invalid ID - contacts_tool = tools.get_tool("get_contacts") + contacts_tool = tools.get_tool("get_contact") if contacts_tool: result = contacts_tool.execute({"id": "invalid_id"}) except Exception as e: print(f"API Error: {e}") + # 400 Client Error: Bad Request for url: https://api.stackone.com/unified/crm/contacts/invalid_id # Example 3: Handle missing account ID - tools_no_account = toolset.get_tools(vertical="crm") # No account_id + tools_no_account = toolset.get_tools(vertical="crm", account_id=None) try: - contacts_tool = tools_no_account.get_tool("get_contacts") - if contacts_tool: - result = contacts_tool.execute({"id": "123"}) + list_contacts_tool = tools_no_account.get_tool("list_contacts") + if list_contacts_tool: + result = list_contacts_tool.execute() print("Result without account ID:", result) except Exception as e: print(f"Error when account ID is missing: {e}") + # 501 Server Error: Not Implemented for url: https://api.stackone.com/unified/crm/contacts if __name__ == "__main__": - demonstrate_error_handling() + error_handling() diff --git a/examples/index.py b/examples/index.py index cf54ebb..c28b091 100644 --- a/examples/index.py +++ b/examples/index.py @@ -5,8 +5,6 @@ ## Installation -Install StackOne AI using pip: - ```bash pip install stackone-ai ``` @@ -14,48 +12,61 @@ ## Quick Start -Here's a simple example to get you started: +Here's a simple example. All examples are complete and runnable. """ -import os - from dotenv import load_dotenv from stackone_ai import StackOneToolSet +""" +## Authenticate with StackOne -def quickstart(): - # Load environment variables - load_dotenv() +```bash +export STACKONE_API_KEY= +``` - api_key = os.getenv("STACKONE_API_KEY") - account_id = os.getenv("STACKONE_ACCOUNT_ID") +or load from a .env file: +""" - # Initialize the toolset - toolset = StackOneToolSet(api_key=api_key) +load_dotenv() - # Get HRIS tools +""" +## Account IDs + +StackOne uses account IDs to identify different integrations. +See the example [stackone_account_ids.py](stackone_account_ids.py) for more details. +This example will hardcode the account ID. +""" + +account_id = "45072196112816593343" +employee_id = "c28xIQaWQ6MzM5MzczMDA2NzMzMzkwNzIwNA" + + +def quickstart(): + toolset = StackOneToolSet() + + # Filter by vertical and add the account ID tools = toolset.get_tools(vertical="hris", account_id=account_id) # Use a specific tool employee_tool = tools.get_tool("get_employee") if employee_tool: - employee = employee_tool.execute({"id": "employee_id"}) + employee = employee_tool.execute({"id": employee_id}) print(employee) -""" -## Authentication - -StackOne AI requires two key pieces of information: -- `STACKONE_API_KEY`: Your API key from StackOne -- `STACKONE_ACCOUNT_ID`: Your account ID - -You can set these as environment variables or pass them directly to the StackOneToolSet constructor. +if __name__ == "__main__": + quickstart() +""" ## Next Steps Check out some examples: -- [Basic Tool Usage](basic-tool-usage.md) - [Error Handling](error-handling.md) +- [StackOne Account IDs](stackone_account_ids.md) +- [Available Tools](available_tools.md) - [OpenAI Integration](openai-integration.md) +- [LangChain Integration](langchain-integration.md) +- [CrewAI Integration](crewai-integration.md) +- [LangGraph Tool Node](langgraph-tool-node.md) """ diff --git a/examples/langchain_integration.py b/examples/langchain_integration.py new file mode 100644 index 0000000..72ec071 --- /dev/null +++ b/examples/langchain_integration.py @@ -0,0 +1,38 @@ +""" +This example demonstrates how to use StackOne tools with LangChain. + +```bash +uv run examples/langchain_integration.py +``` +""" + +from dotenv import load_dotenv +from langchain_openai import ChatOpenAI +from stackone_ai import StackOneToolSet + +load_dotenv() + +account_id = "45072196112816593343" +employee_id = "c28xIQaWQ6MzM5MzczMDA2NzMzMzkwNzIwNA" + + +def langchain_integration() -> None: + toolset = StackOneToolSet() + tools = toolset.get_tools(vertical="hris", account_id=account_id) + + langchain_tools = tools.to_langchain() + + model = ChatOpenAI(model="gpt-4o-mini") + model_with_tools = model.bind_tools(langchain_tools) + + result = model_with_tools.invoke(f"Can you get me information about employee with ID: {employee_id}?") + + if result.tool_calls: + for tool_call in result.tool_calls: + tool = tools.get_tool(tool_call["name"]) + if tool: + print(tool.execute(tool_call["args"])) + + +if __name__ == "__main__": + langchain_integration() diff --git a/examples/langgraph_tool_node.py b/examples/langgraph_tool_node.py new file mode 100644 index 0000000..95c0ac0 --- /dev/null +++ b/examples/langgraph_tool_node.py @@ -0,0 +1,16 @@ +""" +This example demonstrates how to use StackOne tools with LangGraph. + +```bash +uv run examples/langgraph_tool_node.py +``` +""" + + +# TODO: Add examples +def langgraph_tool_node() -> None: + print("LangGraph tool node") + + +if __name__ == "__main__": + langgraph_tool_node() diff --git a/examples/openai_integration.py b/examples/openai_integration.py index 464181e..9538355 100644 --- a/examples/openai_integration.py +++ b/examples/openai_integration.py @@ -1,173 +1,72 @@ -import asyncio -import os - -from dotenv import load_dotenv -from openai import OpenAI -from openai.types.chat import ChatCompletionMessage -from stackone_ai import StackOneToolSet -from stackone_ai.models import Tools - """ This example demonstrates how to use StackOne tools with OpenAI's function calling. -The example shows: -1. Setting up StackOne tools for use with OpenAI -2. Converting tools to OpenAI's function format -3. Making chat completions with function calling -4. Handling tool execution results -5. Managing conversation context - -Example OpenAI function format: -{ - "type": "function", - "function": { - "name": "get_weather", - "description": "Get current temperature for a given location.", - "parameters": { - "type": "object", - "properties": { - "location": { - "type": "string", - "description": "City and country e.g. Bogotá, Colombia" - } - }, - "required": ["location"], - "additionalProperties": False - }, - "strict": True - } -} - -Example tool call output: -[ - { - "id": "call_12345xyz", - "type": "function", - "function": { - "name": "get_weather", - "arguments": "{\"location\":\"Paris, France\"}" - } - } -] +```bash +uv run examples/openai_integration.py +``` """ +from dotenv import load_dotenv +from openai import OpenAI +from stackone_ai import StackOneToolSet -async def handle_tool_calls(tools: Tools, tool_calls: list) -> list[dict]: - """ - Execute tool calls and return results +load_dotenv() - Args: - tools: Tools instance containing available tools - tool_calls: List of OpenAI tool calls +account_id = "45072196112816593343" +employee_id = "c28xIQaWQ6MzM5MzczMDA2NzMzMzkwNzIwNA" - Returns: - List of tool execution results - """ + +def handle_tool_calls(tools, tool_calls) -> list[dict]: results = [] for tool_call in tool_calls: tool = tools.get_tool(tool_call.function.name) - if not tool: - print(f"Warning: Tool {tool_call.function.name} not found") - continue - - result = tool.execute(tool_call.function.arguments) - results.append(result) + if tool: + results.append(tool.execute(tool_call.function.arguments)) return results -async def process_chat_response( - client: OpenAI, - tools: Tools, - message: ChatCompletionMessage, - messages: list[dict], -) -> str: - """ - Process chat completion response and handle any tool calls - - Args: - client: OpenAI client - tools: Tools instance containing available tools - message: Message from chat completion - messages: List of conversation messages - - Returns: - Final response text - """ - if message.tool_calls: - # Execute the tool calls - results = await handle_tool_calls(tools, message.tool_calls) - - if not results: - return "Sorry, I couldn't find the appropriate tools to help with that." +def openai_integration() -> None: + client = OpenAI() + toolset = StackOneToolSet() + tools = toolset.get_tools(vertical="hris", account_id=account_id) + openai_tools = tools.to_openai() - # Add results to conversation - messages.append({"role": "assistant", "content": None, "tool_calls": message.tool_calls}) - messages.append( - { - "role": "tool", - "tool_call_id": message.tool_calls[0].id, - "content": str(results[0]), - } - ) - - # Get final response - final_response = client.chat.completions.create( - model="gpt-4", - messages=messages, - ) - return final_response.choices[0].message.content - - return message.content - - -async def main() -> None: - # Load environment variables - load_dotenv() - - api_key = os.getenv("STACKONE_API_KEY") - account_id = os.getenv("STACKONE_ACCOUNT_ID") - openai_api_key = os.getenv("OPENAI_API_KEY") - - if not all([api_key, account_id, openai_api_key]): - raise ValueError( - "Missing required environment variables." - + "Please set STACKONE_API_KEY, STACKONE_ACCOUNT_ID, and OPENAI_API_KEY" - ) - - try: - # Initialize OpenAI and StackOne clients - client = OpenAI(api_key=openai_api_key) - toolset = StackOneToolSet(api_key=api_key) - - # Get HRIS tools and convert to OpenAI format - tools = toolset.get_tools(vertical="hris", account_id=account_id) - openai_tools = tools.to_openai() - - # Example chat completion with tools - messages = [ - {"role": "system", "content": "You are a helpful HR assistant."}, - { - "role": "user", - "content": "Can you get me information about employee with ID:" - + "c28xIQaWQ6MzM5MzczMDA2NzMzMzkwNzIwNA?", - }, - ] + messages = [ + {"role": "system", "content": "You are a helpful HR assistant."}, + { + "role": "user", + "content": f"Can you get me information about employee with ID: {employee_id}?", + }, + ] + while True: response = client.chat.completions.create( model="gpt-4o-mini", messages=messages, tools=openai_tools, - tool_choice="auto", # Let the model choose when to use tools + tool_choice="auto", ) - # Handle the response - result = await process_chat_response(client, tools, response.choices[0].message, messages) - print("Response:", result) + if not response.choices[0].message.tool_calls: + print("Response:", response.choices[0].message.content) + break - except Exception as e: - print(f"Error: {e}") - raise + results = handle_tool_calls(tools, response.choices[0].message.tool_calls) + if not results: + print("Error: Failed to execute tools") + break + + messages.extend( + [ + {"role": "assistant", "content": None, "tool_calls": response.choices[0].message.tool_calls}, + { + "role": "tool", + "tool_call_id": response.choices[0].message.tool_calls[0].id, + "content": str(results[0]), + }, + ] + ) if __name__ == "__main__": - asyncio.run(main()) + openai_integration() diff --git a/examples/stackone_account_ids.py b/examples/stackone_account_ids.py new file mode 100644 index 0000000..4a5d9ef --- /dev/null +++ b/examples/stackone_account_ids.py @@ -0,0 +1,33 @@ +""" +Handling StackOne account IDs with the StackOne Tools. + +```bash +uv run examples/stackone_account_ids.py +``` +""" + +from dotenv import load_dotenv +from stackone_ai import StackOneToolSet + +load_dotenv() + + +def stackone_account_ids(): + toolset = StackOneToolSet() + + # Filter by vertical and set the account ID + tools = toolset.get_tools(vertical="hris", account_id="test_id") + + # You can over write the account ID here.. + tools.set_account_id("a_different_id") + + employee_tool = tools.get_tool("get_employee") + if employee_tool: + # You can even set the account ID on a per-tool basis + employee_tool.set_account_id("again_another_id") + + print(employee_tool.get_account_id()) + + +if __name__ == "__main__": + stackone_account_ids() diff --git a/examples/test_examples.py b/examples/test_examples.py new file mode 100644 index 0000000..70575ef --- /dev/null +++ b/examples/test_examples.py @@ -0,0 +1,39 @@ +import subprocess +import sys +from pathlib import Path + +import pytest + + +def get_example_files() -> list[str]: + """Get all example files from the directory""" + examples_dir = Path(__file__).parent + examples = [] + + for file in examples_dir.glob("*.py"): + # Skip __init__.py and test files + if file.name.startswith("__") or file.name.startswith("test_"): + continue + examples.append(file.name) + + return examples + + +EXAMPLES = get_example_files() + + +def test_example_files_exist(): + """Verify that we found example files to test""" + assert len(EXAMPLES) > 0, "No example files found" + print(f"Found {len(EXAMPLES)} examples") + + +@pytest.mark.parametrize("example_file", EXAMPLES) +def test_run_example(example_file): + """Run each example file directly using python""" + example_path = Path(__file__).parent / example_file + result = subprocess.run([sys.executable, str(example_path)], capture_output=True, text=True) + if result.returncode != 0: + print(f"stdout: {result.stdout}") + print(f"stderr: {result.stderr}") + pytest.fail(f"Example {example_file} failed with return code {result.returncode}") diff --git a/packages/stackone-ai/pyproject.toml b/packages/stackone-ai/pyproject.toml index 7a8a436..d9353d0 100644 --- a/packages/stackone-ai/pyproject.toml +++ b/packages/stackone-ai/pyproject.toml @@ -7,9 +7,9 @@ requires-python = ">=3.11" dependencies = [ "pydantic>=2.10.6", "requests>=2.32.3", + "langchain-core>=0.1.0", ] - [build-system] requires = ["hatchling"] build-backend = "hatchling.build" diff --git a/packages/stackone-ai/stackone_ai/__init__.py b/packages/stackone-ai/stackone_ai/__init__.py index f5cea36..ea67c0a 100644 --- a/packages/stackone-ai/stackone_ai/__init__.py +++ b/packages/stackone-ai/stackone_ai/__init__.py @@ -1,5 +1,5 @@ """StackOne AI SDK""" -from .tools import StackOneToolSet +from .toolset import StackOneToolSet __all__ = ["StackOneToolSet"] diff --git a/packages/stackone-ai/stackone_ai/models.py b/packages/stackone-ai/stackone_ai/models.py index 66e666e..006dcce 100644 --- a/packages/stackone-ai/stackone_ai/models.py +++ b/packages/stackone-ai/stackone_ai/models.py @@ -1,16 +1,19 @@ -import base64 -import json +from collections.abc import Sequence from typing import Any -import requests -from pydantic import BaseModel, PrivateAttr +from langchain_core.tools import BaseTool +from pydantic import BaseModel, Field class ExecuteConfig(BaseModel): - headers: dict + headers: dict = Field(default_factory=dict) # Keep this with default empty dict method: str url: str name: str + body_type: str | None = None + parameter_locations: dict[str, str] = Field( + default_factory=dict + ) # Maps param name to location (header, query, path) class ToolParameters(BaseModel): @@ -24,112 +27,72 @@ class ToolDefinition(BaseModel): execute: ExecuteConfig -class BaseTool(BaseModel): - """Base Tool model with Pydantic validation""" +class Tool(BaseModel): + """Base Tool model""" + name: str description: str parameters: ToolParameters - # Private attributes in Pydantic v2 - _execute_config: ExecuteConfig = PrivateAttr() - _api_key: str = PrivateAttr() - _account_id: str | None = PrivateAttr(default=None) - - def __init__(self, **data: Any) -> None: - super().__init__(**data) - execute_config = data.get("_execute_config") - api_key = data.get("_api_key") - - if not isinstance(execute_config, ExecuteConfig): - raise ValueError("_execute_config must be an ExecuteConfig instance") - if not isinstance(api_key, str): - raise ValueError("_api_key must be a string") - - self._execute_config = execute_config - self._api_key = api_key - self._account_id = data.get("_account_id") - - def execute(self, arguments: str | dict) -> dict[str, Any]: - """ - Execute the tool with the given parameters - - Args: - arguments: Either a JSON string or dict of arguments - """ - # Handle both string and dict arguments - if isinstance(arguments, str): - kwargs = json.loads(arguments) - else: - kwargs = arguments - - url = self._execute_config.url - - # Replace URL parameters - for key, value in kwargs.items(): - url = url.replace(f"{{{key}}}", str(value)) - - # Create basic auth header with API key as username - auth_string = base64.b64encode(f"{self._api_key}:".encode()).decode() - - headers = { - "Authorization": f"Basic {auth_string}", - "User-Agent": "stackone-python/1.0.0", - } + def execute(self, arguments: str | dict | None = None) -> dict[str, Any]: + """Execute the tool with the given parameters""" + raise NotImplementedError - if self._account_id: - headers["x-account-id"] = self._account_id - - headers.update(self._execute_config.headers) - - response = requests.request(method=self._execute_config.method, url=url, headers=headers) + def to_openai_function(self) -> dict: + """Convert this tool to OpenAI's function format""" + raise NotImplementedError - response.raise_for_status() + def set_account_id(self, account_id: str | None) -> None: + """Set the account ID for this tool.""" + raise NotImplementedError - # Explicitly type the return value - result: dict[str, Any] = response.json() - return result + def get_account_id(self) -> str | None: + """Get the current account ID for this tool.""" + raise NotImplementedError - def to_openai_function(self) -> dict: - """Convert this tool to OpenAI's function format""" - return { - "type": "function", - "function": { - "name": self._execute_config.name, - "description": self.description, - "parameters": { - "type": self.parameters.type, - "properties": self.parameters.properties, - "required": list(self.parameters.properties.keys()), - "additionalProperties": False, - }, - "strict": True, - }, - } - - @property - def name(self) -> str: - """Get the tool's name""" - return self._execute_config.name + def to_langchain(self) -> Any: + """Convert this tool to LangChain format""" + raise NotImplementedError class Tools: """Container for Tool instances""" - def __init__(self, tools: list[BaseTool]): + def __init__(self, tools: list[Tool]): self.tools = tools - # Create a name -> tool mapping for faster lookups self._tool_map = {tool.name: tool for tool in tools} - def __getitem__(self, index: int) -> BaseTool: + def __getitem__(self, index: int) -> Tool: return self.tools[index] def __len__(self) -> int: return len(self.tools) - def get_tool(self, name: str) -> BaseTool | None: + def get_tool(self, name: str) -> Tool | None: """Get a tool by its name""" return self._tool_map.get(name) + def set_account_id(self, account_id: str | None) -> None: + """Set the account ID for all tools in this collection. + + Args: + account_id: The account ID to use, or None to clear it + """ + for tool in self.tools: + tool.set_account_id(account_id) + + def get_account_id(self) -> str | None: + """Get the current account ID for this tool.""" + for tool in self.tools: + account_id = tool.get_account_id() + if isinstance(account_id, str): # Type guard to ensure we return str | None + return account_id + return None + def to_openai(self) -> list[dict]: """Convert all tools to OpenAI function format""" return [tool.to_openai_function() for tool in self.tools] + + def to_langchain(self) -> Sequence[BaseTool]: + """Convert all tools to LangChain format""" + return [tool.to_langchain() for tool in self.tools] diff --git a/packages/stackone-ai/stackone_ai/oas/ats.json b/packages/stackone-ai/stackone_ai/oas/ats.json new file mode 100644 index 0000000..0fb432a --- /dev/null +++ b/packages/stackone-ai/stackone_ai/oas/ats.json @@ -0,0 +1,18632 @@ +{ + "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/packages/stackone-ai/stackone_ai/oas/core.json b/packages/stackone-ai/stackone_ai/oas/core.json new file mode 100644 index 0000000..a6478ce --- /dev/null +++ b/packages/stackone-ai/stackone_ai/oas/core.json @@ -0,0 +1,1479 @@ +{ + "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/packages/stackone-ai/stackone_ai/oas/crm.json b/packages/stackone-ai/stackone_ai/oas/crm.json new file mode 100644 index 0000000..41c3e6e --- /dev/null +++ b/packages/stackone-ai/stackone_ai/oas/crm.json @@ -0,0 +1,2602 @@ +{ + "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/packages/stackone-ai/stackone_ai/oas/documents.json b/packages/stackone-ai/stackone_ai/oas/documents.json new file mode 100644 index 0000000..2335185 --- /dev/null +++ b/packages/stackone-ai/stackone_ai/oas/documents.json @@ -0,0 +1,2870 @@ +{ + "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/packages/stackone-ai/stackone_ai/oas/hris.json b/packages/stackone-ai/stackone_ai/oas/hris.json new file mode 100644 index 0000000..47f2e83 --- /dev/null +++ b/packages/stackone-ai/stackone_ai/oas/hris.json @@ -0,0 +1,19947 @@ +{ + "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/packages/stackone-ai/stackone_ai/oas/iam.json b/packages/stackone-ai/stackone_ai/oas/iam.json new file mode 100644 index 0000000..013015b --- /dev/null +++ b/packages/stackone-ai/stackone_ai/oas/iam.json @@ -0,0 +1,3441 @@ +{ + "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/packages/stackone-ai/stackone_ai/oas/lms.json b/packages/stackone-ai/stackone_ai/oas/lms.json new file mode 100644 index 0000000..ad4d26e --- /dev/null +++ b/packages/stackone-ai/stackone_ai/oas/lms.json @@ -0,0 +1,6319 @@ +{ + "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/packages/stackone-ai/stackone_ai/oas/marketing.json b/packages/stackone-ai/stackone_ai/oas/marketing.json new file mode 100644 index 0000000..a92408b --- /dev/null +++ b/packages/stackone-ai/stackone_ai/oas/marketing.json @@ -0,0 +1,4521 @@ +{ + "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/packages/stackone-ai/stackone_ai/specs/parser.py b/packages/stackone-ai/stackone_ai/specs/parser.py index 4233ad0..1f72b9b 100644 --- a/packages/stackone-ai/stackone_ai/specs/parser.py +++ b/packages/stackone-ai/stackone_ai/specs/parser.py @@ -1,5 +1,6 @@ import json from pathlib import Path +from typing import Any from stackone_ai.models import ExecuteConfig, ToolDefinition, ToolParameters @@ -10,10 +11,125 @@ def __init__(self, spec_path: 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_ai.com"}]) - self.base_url = ( - servers[0]["url"] if isinstance(servers, list) else "https://api.stackone.com" - ) + servers = self.spec.get("servers", [{"url": "https://api.stackone.com"}]) + self.base_url = servers[0]["url"] if isinstance(servers, list) else "https://api.stackone.com" + + 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_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", {}) + + # Handle application/json + if "application/json" in content: + json_content = content["application/json"] + if isinstance(json_content, dict): + schema = json_content.get("schema", {}) + resolved = self._resolve_schema(schema) + # Ensure we only return dict for request body + if isinstance(resolved, dict): + return resolved, "json" + return None, None + + # Handle form data + if "application/x-www-form-urlencoded" in content: + form_content = content["application/x-www-form-urlencoded"] + if isinstance(form_content, dict): + schema = form_content.get("schema", {}) + resolved = self._resolve_schema(schema) + # Ensure we only return dict for request body + if isinstance(resolved, dict): + return resolved, "form" + return None, None + + return None, None def parse_tools(self) -> dict[str, ToolDefinition]: """Parse OpenAPI spec into tool definitions""" @@ -21,34 +137,49 @@ def parse_tools(self) -> dict[str, ToolDefinition]: for path, path_item in self.spec.get("paths", {}).items(): for method, operation in path_item.items(): - # Get the tool name from x-speakeasy-name-override or generate from path - name = operation.get("x-speakeasy-name-override") or path.strip("/").replace( - "/", "_" - ) + 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", {}) + properties.update(body_props) + # Mark all body parameters + for prop_name in body_props: + parameter_locations[prop_name] = "body" # Create tool definition tools[name] = ToolDefinition( - description=operation.get("description", ""), - parameters=self._parse_parameters(operation), + description=operation.get("summary", ""), + parameters=ToolParameters(type="object", properties=properties), execute=ExecuteConfig( - headers={}, method=method.upper(), url=f"{self.base_url}{path}", name=name, + parameter_locations=parameter_locations, + body_type=body_type, ), ) return tools - - def _parse_parameters(self, operation: dict) -> ToolParameters: - """Parse OpenAPI parameters into ToolParameters""" - properties = {} - - for param in operation.get("parameters", []): - if param["in"] == "path": - properties[param["name"]] = { - "type": param["schema"]["type"], - "description": param.get("description", ""), - } - - return ToolParameters(type="object", properties=properties) diff --git a/packages/stackone-ai/stackone_ai/tools.py b/packages/stackone-ai/stackone_ai/tools.py index bad818e..92e609b 100644 --- a/packages/stackone-ai/stackone_ai/tools.py +++ b/packages/stackone-ai/stackone_ai/tools.py @@ -1,91 +1,194 @@ +import base64 import json -import os -from typing import Any +from typing import Annotated, Any -from stackone_ai.constants import OAS_DIR -from stackone_ai.models import BaseTool, ToolDefinition, Tools +import requests +from langchain_core.tools import BaseTool +from pydantic import BaseModel, Field, PrivateAttr +from stackone_ai.models import ( + ExecuteConfig, + ToolParameters, +) +from stackone_ai.models import ( + Tool as StackOneBaseTool, +) -class StackOneToolSet: - """Main class for accessing StackOne tools""" + +class StackOneTool(StackOneBaseTool): + """Concrete implementation of StackOne Tool""" + + name: str = Field(description="Tool name") + description: str = Field(description="Tool description") + parameters: ToolParameters = Field(description="Tool parameters") + _execute_config: ExecuteConfig = PrivateAttr() + _api_key: str = PrivateAttr() + _account_id: str | None = PrivateAttr(default=None) def __init__( self, - api_key: str | None = None, - account_id: str | None = None, + description: str, + parameters: ToolParameters, + _execute_config: ExecuteConfig, + _api_key: str, + _account_id: str | None = None, ) -> None: - """Initialize StackOne tools with authentication. + super().__init__( + name=_execute_config.name, + description=description, + parameters=parameters, + ) + self._execute_config = _execute_config + self._api_key = _api_key + self._account_id = _account_id + + def execute(self, arguments: str | dict | None = None) -> dict[str, Any]: + """Execute the tool with the given parameters""" + # Handle both string and dict arguments + if isinstance(arguments, str): + kwargs = json.loads(arguments) + else: + kwargs = arguments or {} + + # Create basic auth header with API key as username + auth_string = base64.b64encode(f"{self._api_key}:".encode()).decode() + + headers = { + "Authorization": f"Basic {auth_string}", + "User-Agent": "stackone-python/1.0.0", + } + + if self._account_id: + headers["x-account-id"] = self._account_id + + # Add predefined headers + headers.update(self._execute_config.headers) + + url = self._execute_config.url + body_params = {} + query_params = {} + + # Handle parameters based on their location + for key, value in kwargs.items(): + param_location = self._execute_config.parameter_locations.get(key) + + if param_location == "path": + url = url.replace(f"{{{key}}}", str(value)) + elif param_location == "query": + query_params[key] = value + elif param_location == "body": + body_params[key] = value + else: + # Default behavior + if f"{{{key}}}" in url: + url = url.replace(f"{{{key}}}", str(value)) + elif self._execute_config.method.upper() in ["GET", "DELETE"]: + query_params[key] = value + else: + body_params[key] = value + + request_kwargs: dict[str, Any] = { + "method": self._execute_config.method, + "url": url, + "headers": headers, + } + + if body_params: + body_type = self._execute_config.body_type or "json" + if body_type == "json": + request_kwargs["json"] = body_params + elif body_type == "form": + request_kwargs["data"] = body_params + + if query_params: + request_kwargs["params"] = query_params + + response = requests.request(**request_kwargs) + response.raise_for_status() + + # Ensure we return a dict + result = response.json() + if not isinstance(result, dict): + return {"result": result} + return result + + def to_openai_function(self) -> dict: + """Convert this tool to OpenAI's function format""" + return { + "type": "function", + "function": { + "name": self.name, + "description": self.description, + "parameters": { + "type": self.parameters.type, + "properties": self.parameters.properties, + "required": list(self.parameters.properties.keys()), + "additionalProperties": False, + }, + "strict": True, + }, + } + + def to_langchain(self) -> BaseTool: + """Convert this tool to LangChain format""" + tool_self = self # Capture self reference for inner class + + # Create properly annotated schema for the tool + schema_props: dict[str, Any] = {} + annotations: dict[str, Any] = {} + + for name, details in self.parameters.properties.items(): + python_type: type = str # Default to str + if isinstance(details, dict): + type_str = details.get("type", "string") + if type_str == "number": + python_type = float + elif type_str == "integer": + python_type = int + elif type_str == "boolean": + python_type = bool + + field = Field(description=details.get("description", "")) + else: + field = Field(description="") + + schema_props[name] = field + annotations[name] = Annotated[python_type, field] + + # Create the schema class with proper annotations + schema_class = type( + f"{self.name.title()}Args", + (BaseModel,), + { + "__annotations__": annotations, + "__module__": __name__, + **schema_props, + }, + ) + + class StackOneLangChainTool(BaseTool): + name: str = tool_self.name + description: str = tool_self.description + args_schema: type[BaseModel] = schema_class + return_direct: bool = True + func = staticmethod(tool_self.execute) + + def _run(self, **kwargs: Any) -> Any: + return tool_self.execute(kwargs) + + async def _arun(self, **kwargs: Any) -> Any: + return self._run(**kwargs) + + return StackOneLangChainTool() + + def set_account_id(self, account_id: str | None) -> None: + """Set the account ID for this tool. Args: - api_key: Optional API key. If not provided, will try to get from STACKONE_API_KEY env var - account_id: Optional account ID. If not provided, will try to get from STACKONE_ACCOUNT_ID env var + account_id: The account ID to use, or None to clear it """ - self.api_key = api_key or os.getenv("STACKONE_API_KEY") - if not self.api_key: - raise ValueError( - "API key must be provided either through api_key parameter or " - "STACKONE_API_KEY environment variable" - ) - - self.account_id = account_id or os.getenv("STACKONE_ACCOUNT_ID") + self._account_id = account_id - def get_tools(self, vertical: str, account_id: str | None = None) -> Tools: - """Get tools for a specific vertical. - - Args: - vertical: The vertical to get tools for (e.g. "hris", "crm") - account_id: Optional account ID override. If not provided, uses the one from initialization - """ - spec_path = OAS_DIR / f"{vertical}.json" - if not spec_path.exists(): - return Tools([]) # Return empty tools list for unknown vertical - - # Use account_id parameter if provided, otherwise use the one from initialization - effective_account_id = account_id or self.account_id - - with open(spec_path) as f: - spec = json.load(f) - - tools: list[BaseTool] = [] - paths = spec.get("paths", {}) - - for path, methods in paths.items(): - for method, details in methods.items(): - # Skip if no x-speakeasy-name-override (indicates not a tool endpoint) - if "x-speakeasy-name-override" not in details: - continue - - name = details["x-speakeasy-name-override"] - description = details.get("description", "") - parameters = details.get("parameters", []) - - # Convert OpenAPI parameters to JSON Schema - properties: dict[str, Any] = {} - for param in parameters: - if param["in"] == "path": - properties[param["name"]] = { - "type": param["schema"]["type"], - "description": param.get("description", ""), - } - - tool_def = ToolDefinition( - description=description, - parameters={"type": "object", "properties": properties}, - execute={ - "headers": {}, - "method": method.upper(), - "url": f"https://api.stackone.com{path}", - "name": name, - }, - ) - - tool = BaseTool( - description=tool_def.description, - parameters=tool_def.parameters, - _execute_config=tool_def.execute, - _api_key=self.api_key, - _account_id=effective_account_id, - ) - tools.append(tool) - - return Tools(tools) + def get_account_id(self) -> str | None: + """Get the current account ID for this tool.""" + return self._account_id diff --git a/packages/stackone-ai/stackone_ai/toolset.py b/packages/stackone-ai/stackone_ai/toolset.py new file mode 100644 index 0000000..bc1da4d --- /dev/null +++ b/packages/stackone-ai/stackone_ai/toolset.py @@ -0,0 +1,100 @@ +import json +import os +from typing import Any + +from stackone_ai.constants import OAS_DIR +from stackone_ai.models import ( + ExecuteConfig, + ToolDefinition, + ToolParameters, + Tools, +) +from stackone_ai.models import ( + Tool as StackOneBaseTool, +) +from stackone_ai.tools import StackOneTool + + +class StackOneToolSet: + """Main class for accessing StackOne tools""" + + def __init__( + self, + api_key: str | None = None, + account_id: str | None = None, + ) -> None: + """Initialize StackOne tools with authentication. + + Args: + api_key: Optional API key. If not provided, will try to get from STACKONE_API_KEY env var + account_id: Optional account ID. If not provided, will try to get from STACKONE_ACCOUNT_ID env var + """ + api_key_value = api_key or os.getenv("STACKONE_API_KEY") + if not api_key_value: + raise ValueError( + "API key must be provided either through api_key parameter or " + "STACKONE_API_KEY environment variable" + ) + self.api_key: str = api_key_value # Type annotation ensures it's a string + self.account_id = account_id or os.getenv("STACKONE_ACCOUNT_ID") + + def get_tools(self, vertical: str, account_id: str | None = None) -> Tools: + """Get tools for a specific vertical. + + Args: + vertical: The vertical to get tools for (e.g. "hris", "crm") + account_id: Optional account ID override. If not provided, uses the one from initialization + """ + spec_path = OAS_DIR / f"{vertical}.json" + if not spec_path.exists(): + return Tools([]) # Return empty tools list for unknown vertical + + # Use account_id parameter if provided, otherwise use the one from initialization + effective_account_id = account_id or self.account_id + + with open(spec_path) as f: + spec = json.load(f) + + tools: list[StackOneBaseTool] = [] + paths = spec.get("paths", {}) + + for path, methods in paths.items(): + for method, details in methods.items(): + # Skip if no x-speakeasy-name-override (indicates not a tool endpoint) + if "x-speakeasy-name-override" not in details: + continue + + name = details["x-speakeasy-name-override"] + description = details.get("description", "") + parameters = details.get("parameters", []) + + # Convert OpenAPI parameters to JSON Schema + properties: dict[str, Any] = {} + for param in parameters: + if param["in"] == "path": + properties[param["name"]] = { + "type": param["schema"]["type"], + "description": param.get("description", ""), + } + + tool_def = ToolDefinition( + description=description, + parameters=ToolParameters(type="object", properties=properties), + execute=ExecuteConfig( + headers={}, + method=method.upper(), + url=f"https://api.stackone.com{path}", + name=name, + ), + ) + + 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, + ) + tools.append(tool) + + return Tools(tools) diff --git a/packages/stackone-ai/tests/snapshots/test_parser/test_parse_all_oas_specs/ats_tools.json b/packages/stackone-ai/tests/snapshots/test_parser/test_parse_all_oas_specs/ats_tools.json new file mode 100644 index 0000000..0df3dbe --- /dev/null +++ b/packages/stackone-ai/tests/snapshots/test_parser/test_parse_all_oas_specs/ats_tools.json @@ -0,0 +1,8634 @@ +{ + "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/packages/stackone-ai/tests/snapshots/test_parser/test_parse_all_oas_specs/core_tools.json b/packages/stackone-ai/tests/snapshots/test_parser/test_parse_all_oas_specs/core_tools.json new file mode 100644 index 0000000..157d7f4 --- /dev/null +++ b/packages/stackone-ai/tests/snapshots/test_parser/test_parse_all_oas_specs/core_tools.json @@ -0,0 +1,452 @@ +{ + "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/packages/stackone-ai/tests/snapshots/test_parser/test_parse_all_oas_specs/crm_tools.json b/packages/stackone-ai/tests/snapshots/test_parser/test_parse_all_oas_specs/crm_tools.json new file mode 100644 index 0000000..7c8141e --- /dev/null +++ b/packages/stackone-ai/tests/snapshots/test_parser/test_parse_all_oas_specs/crm_tools.json @@ -0,0 +1,899 @@ +{ + "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/packages/stackone-ai/tests/snapshots/test_parser/test_parse_all_oas_specs/documents_tools.json b/packages/stackone-ai/tests/snapshots/test_parser/test_parse_all_oas_specs/documents_tools.json new file mode 100644 index 0000000..7ecce5e --- /dev/null +++ b/packages/stackone-ai/tests/snapshots/test_parser/test_parse_all_oas_specs/documents_tools.json @@ -0,0 +1,1778 @@ +{ + "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/packages/stackone-ai/tests/snapshots/test_parser/test_parse_all_oas_specs/hris_tools.json b/packages/stackone-ai/tests/snapshots/test_parser/test_parse_all_oas_specs/hris_tools.json new file mode 100644 index 0000000..d2b92ca --- /dev/null +++ b/packages/stackone-ai/tests/snapshots/test_parser/test_parse_all_oas_specs/hris_tools.json @@ -0,0 +1,33327 @@ +{ + "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/packages/stackone-ai/tests/snapshots/test_parser/test_parse_all_oas_specs/iam_tools.json b/packages/stackone-ai/tests/snapshots/test_parser/test_parse_all_oas_specs/iam_tools.json new file mode 100644 index 0000000..bf5797a --- /dev/null +++ b/packages/stackone-ai/tests/snapshots/test_parser/test_parse_all_oas_specs/iam_tools.json @@ -0,0 +1,558 @@ +{ + "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/packages/stackone-ai/tests/snapshots/test_parser/test_parse_all_oas_specs/lms_tools.json b/packages/stackone-ai/tests/snapshots/test_parser/test_parse_all_oas_specs/lms_tools.json new file mode 100644 index 0000000..f63dbcf --- /dev/null +++ b/packages/stackone-ai/tests/snapshots/test_parser/test_parse_all_oas_specs/lms_tools.json @@ -0,0 +1,11046 @@ +{ + "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/packages/stackone-ai/tests/snapshots/test_parser/test_parse_all_oas_specs/marketing_tools.json b/packages/stackone-ai/tests/snapshots/test_parser/test_parse_all_oas_specs/marketing_tools.json new file mode 100644 index 0000000..83af563 --- /dev/null +++ b/packages/stackone-ai/tests/snapshots/test_parser/test_parse_all_oas_specs/marketing_tools.json @@ -0,0 +1,2571 @@ +{ + "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/packages/stackone-ai/tests/test_parser.py b/packages/stackone-ai/tests/test_parser.py new file mode 100644 index 0000000..cbf4961 --- /dev/null +++ b/packages/stackone-ai/tests/test_parser.py @@ -0,0 +1,489 @@ +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("packages/stackone-ai/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 diff --git a/packages/stackone-ai/tests/test_tools.py b/packages/stackone-ai/tests/test_tools.py index f6af4c6..f2e12f7 100644 --- a/packages/stackone-ai/tests/test_tools.py +++ b/packages/stackone-ai/tests/test_tools.py @@ -1,20 +1,21 @@ +from collections.abc import Sequence from unittest.mock import MagicMock, patch import pytest +from langchain_core.tools import BaseTool as LangChainBaseTool from stackone_ai.models import ( - BaseTool, ExecuteConfig, ToolDefinition, ToolParameters, Tools, ) -from stackone_ai.tools import StackOneToolSet +from stackone_ai.tools import StackOneTool @pytest.fixture -def mock_tool() -> BaseTool: +def mock_tool() -> StackOneTool: """Create a mock tool for testing""" - return BaseTool( + return StackOneTool( description="Test tool", parameters=ToolParameters( type="object", @@ -78,55 +79,6 @@ def test_tool_execution_with_string_args(mock_tool): mock_request.assert_called_once() -def test_toolset_initialization(mock_specs): - """Test StackOneToolSet initialization and tool creation""" - mock_spec_content = { - "paths": { - "/employee/{id}": { - "get": { - "x-speakeasy-name-override": "get_employee", - "description": "Get employee details", - "parameters": [ - { - "in": "path", - "name": "id", - "schema": {"type": "string"}, - "description": "Employee ID", - } - ], - } - } - } - } - - # Mock the file operations instead of load_specs - with ( - patch("stackone_ai.tools.OAS_DIR") as mock_dir, - patch("json.load") as mock_json, - ): - # Setup mocks - mock_path = MagicMock() - mock_path.exists.return_value = True - mock_dir.__truediv__.return_value = mock_path - mock_json.return_value = mock_spec_content - - # Create and test toolset - toolset = StackOneToolSet(api_key="test_key") - tools = toolset.get_tools(vertical="hris", account_id="test_account") - - # Verify results - assert len(tools) == 1 - tool = tools.get_tool("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_tool_openai_function_conversion(mock_tool): """Test conversion of tool to OpenAI function format""" openai_format = mock_tool.to_openai_function() @@ -139,13 +91,6 @@ def test_tool_openai_function_conversion(mock_tool): assert "id" in openai_format["function"]["parameters"]["properties"] -def test_unknown_vertical(): - """Test getting tools for unknown vertical""" - toolset = StackOneToolSet(api_key="test_key") - tools = toolset.get_tools(vertical="unknown") - assert len(tools) == 0 - - def test_tools_container_methods(mock_tool): """Test Tools container class methods""" tools = [mock_tool] @@ -159,3 +104,84 @@ def test_tools_container_methods(mock_tool): openai_tools = tools_container.to_openai() assert len(openai_tools) == 1 assert openai_tools[0]["type"] == "function" + + +def test_to_langchain_conversion(mock_tool): + """Test conversion of tools to LangChain format""" + tools = Tools(tools=[mock_tool]) + langchain_tools = tools.to_langchain() + + # Check return type + assert isinstance(langchain_tools, Sequence) + assert len(langchain_tools) == 1 + + # Check converted tool + langchain_tool = langchain_tools[0] + assert isinstance(langchain_tool, LangChainBaseTool) + assert langchain_tool.name == mock_tool.name + assert langchain_tool.description == mock_tool.description + + # Check args schema + assert hasattr(langchain_tool, "args_schema") + # Just check the field names match + assert set(langchain_tool.args_schema.__annotations__.keys()) == set( + mock_tool.parameters.properties.keys() + ) + + +@pytest.mark.asyncio +async def test_langchain_tool_execution(mock_tool): + """Test execution of converted LangChain tools""" + tools = Tools(tools=[mock_tool]) + langchain_tools = tools.to_langchain() + langchain_tool = langchain_tools[0] + + # Mock the HTTP request + with patch("requests.request") as mock_request: + mock_response = MagicMock() + mock_response.json.return_value = {"id": "test_value", "name": "Test User"} + mock_request.return_value = mock_response + + # Test sync execution with correct parameter name + test_args = {"id": "test_value"} + result = langchain_tool._run(**test_args) + + assert result == {"id": "test_value", "name": "Test User"} + mock_request.assert_called_once() + + +def test_to_langchain_empty_tools(): + """Test conversion of empty tools list to LangChain format""" + tools = Tools(tools=[]) + langchain_tools = tools.to_langchain() + + assert isinstance(langchain_tools, Sequence) + assert len(langchain_tools) == 0 + + +def test_to_langchain_multiple_tools(mock_tool): + """Test conversion of multiple tools to LangChain format""" + # Create a second mock tool with different parameters + second_tool = mock_tool.__class__( + description="Second test tool", + parameters=ToolParameters(type="object", properties={"other_param": "string"}), + _execute_config=ExecuteConfig( + headers={}, method="GET", url="https://test.com/api/v2", name="second_test_tool" + ), + _api_key="test_key", + ) + + tools = Tools(tools=[mock_tool, second_tool]) + langchain_tools = tools.to_langchain() + + assert len(langchain_tools) == 2 + assert langchain_tools[0].name == mock_tool.name + assert langchain_tools[1].name == second_tool.name + + # Verify each tool has correct schema + assert set(langchain_tools[0].args_schema.__annotations__.keys()) == set( + mock_tool.parameters.properties.keys() + ) + assert set(langchain_tools[1].args_schema.__annotations__.keys()) == set( + second_tool.parameters.properties.keys() + ) diff --git a/packages/stackone-ai/tests/test_toolset.py b/packages/stackone-ai/tests/test_toolset.py new file mode 100644 index 0000000..5238804 --- /dev/null +++ b/packages/stackone-ai/tests/test_toolset.py @@ -0,0 +1,59 @@ +from unittest.mock import MagicMock, patch + +from stackone_ai.toolset import StackOneToolSet + + +def test_toolset_initialization(): + """Test StackOneToolSet initialization and tool creation""" + mock_spec_content = { + "paths": { + "/employee/{id}": { + "get": { + "x-speakeasy-name-override": "get_employee", + "description": "Get employee details", + "parameters": [ + { + "in": "path", + "name": "id", + "schema": {"type": "string"}, + "description": "Employee ID", + } + ], + } + } + } + } + + # Mock the file operations instead of load_specs + with ( + patch("stackone_ai.toolset.OAS_DIR") as mock_dir, + patch("json.load") as mock_json, + ): + # Setup mocks + mock_path = MagicMock() + mock_path.exists.return_value = True + mock_dir.__truediv__.return_value = mock_path + mock_json.return_value = mock_spec_content + + # Create and test toolset + toolset = StackOneToolSet(api_key="test_key") + tools = toolset.get_tools(vertical="hris", account_id="test_account") + + # Verify results + assert len(tools) == 1 + tool = tools.get_tool("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_unknown_vertical(): + """Test getting tools for unknown vertical""" + toolset = StackOneToolSet(api_key="test_key") + tools = toolset.get_tools(vertical="unknown") + assert len(tools) == 0 diff --git a/pyproject.toml b/pyproject.toml index 394f5f2..a565084 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,6 +7,8 @@ requires-python = ">=3.11" [project.optional-dependencies] examples = [ + "crewai>=0.102.0", + "langchain-openai>=0.3.6", "openai>=1.63.2", "python-dotenv>=1.0.1", ] @@ -28,14 +30,23 @@ dev = [ "mypy>=1.15.0", "pre-commit>=4.1.0", "pytest>=8.3.4", + "pytest-asyncio>=0.25.3", + "pytest-cov>=6.0.0", + "pytest-snapshot>=0.9.0", "ruff>=0.9.6", - "stackone-ai" + "stackone-ai", + "types-requests>=2.31.0.20240311", ] [tool.pytest.ini_options] pythonpath = [ "packages/stackone-ai", ] +asyncio_mode = "strict" +asyncio_default_fixture_loop_scope = "function" +markers = [ + "asyncio: mark test as async", +] [tool.ruff.lint.per-file-ignores] "bin/**.py" = ["T201", "T203"] diff --git a/scripts/build_docs.py b/scripts/build_docs.py index 80e22ef..a6163b5 100644 --- a/scripts/build_docs.py +++ b/scripts/build_docs.py @@ -67,6 +67,8 @@ def main() -> None: # Process all Python files in examples directory for py_file in EXAMPLES_DIR.glob("*.py"): + if py_file.stem.startswith("test_"): + continue create_markdown_file(py_file) diff --git a/uv.lock b/uv.lock index bab5a6d..8079d2a 100644 --- a/uv.lock +++ b/uv.lock @@ -1,5 +1,10 @@ version = 1 +revision = 1 requires-python = ">=3.11" +resolution-markers = [ + "python_full_version >= '3.12.4'", + "python_full_version < '3.12.4'", +] [manifest] members = [ @@ -7,6 +12,92 @@ members = [ "stackone-ai-python", ] +[[package]] +name = "aiohappyeyeballs" +version = "2.4.6" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/08/07/508f9ebba367fc3370162e53a3cfd12f5652ad79f0e0bfdf9f9847c6f159/aiohappyeyeballs-2.4.6.tar.gz", hash = "sha256:9b05052f9042985d32ecbe4b59a77ae19c006a78f1344d7fdad69d28ded3d0b0", size = 21726 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/44/4c/03fb05f56551828ec67ceb3665e5dc51638042d204983a03b0a1541475b6/aiohappyeyeballs-2.4.6-py3-none-any.whl", hash = "sha256:147ec992cf873d74f5062644332c539fcd42956dc69453fe5204195e560517e1", size = 14543 }, +] + +[[package]] +name = "aiohttp" +version = "3.11.12" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "aiohappyeyeballs" }, + { name = "aiosignal" }, + { name = "attrs" }, + { name = "frozenlist" }, + { name = "multidict" }, + { name = "propcache" }, + { name = "yarl" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/37/4b/952d49c73084fb790cb5c6ead50848c8e96b4980ad806cf4d2ad341eaa03/aiohttp-3.11.12.tar.gz", hash = "sha256:7603ca26d75b1b86160ce1bbe2787a0b706e592af5b2504e12caa88a217767b0", size = 7673175 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/9c/38/35311e70196b6a63cfa033a7f741f800aa8a93f57442991cbe51da2394e7/aiohttp-3.11.12-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:87a2e00bf17da098d90d4145375f1d985a81605267e7f9377ff94e55c5d769eb", size = 708797 }, + { url = "https://files.pythonhosted.org/packages/44/3e/46c656e68cbfc4f3fc7cb5d2ba4da6e91607fe83428208028156688f6201/aiohttp-3.11.12-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:b34508f1cd928ce915ed09682d11307ba4b37d0708d1f28e5774c07a7674cac9", size = 468669 }, + { url = "https://files.pythonhosted.org/packages/a0/d6/2088fb4fd1e3ac2bfb24bc172223babaa7cdbb2784d33c75ec09e66f62f8/aiohttp-3.11.12-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:936d8a4f0f7081327014742cd51d320296b56aa6d324461a13724ab05f4b2933", size = 455739 }, + { url = "https://files.pythonhosted.org/packages/e7/dc/c443a6954a56f4a58b5efbfdf23cc6f3f0235e3424faf5a0c56264d5c7bb/aiohttp-3.11.12-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2de1378f72def7dfb5dbd73d86c19eda0ea7b0a6873910cc37d57e80f10d64e1", size = 1685858 }, + { url = "https://files.pythonhosted.org/packages/25/67/2d5b3aaade1d5d01c3b109aa76e3aa9630531252cda10aa02fb99b0b11a1/aiohttp-3.11.12-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:b9d45dbb3aaec05cf01525ee1a7ac72de46a8c425cb75c003acd29f76b1ffe94", size = 1743829 }, + { url = "https://files.pythonhosted.org/packages/90/9b/9728fe9a3e1b8521198455d027b0b4035522be18f504b24c5d38d59e7278/aiohttp-3.11.12-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:930ffa1925393381e1e0a9b82137fa7b34c92a019b521cf9f41263976666a0d6", size = 1785587 }, + { url = "https://files.pythonhosted.org/packages/ce/cf/28fbb43d4ebc1b4458374a3c7b6db3b556a90e358e9bbcfe6d9339c1e2b6/aiohttp-3.11.12-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8340def6737118f5429a5df4e88f440746b791f8f1c4ce4ad8a595f42c980bd5", size = 1675319 }, + { url = "https://files.pythonhosted.org/packages/e5/d2/006c459c11218cabaa7bca401f965c9cc828efbdea7e1615d4644eaf23f7/aiohttp-3.11.12-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4016e383f91f2814e48ed61e6bda7d24c4d7f2402c75dd28f7e1027ae44ea204", size = 1619982 }, + { url = "https://files.pythonhosted.org/packages/9d/83/ca425891ebd37bee5d837110f7fddc4d808a7c6c126a7d1b5c3ad72fc6ba/aiohttp-3.11.12-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:3c0600bcc1adfaaac321422d615939ef300df81e165f6522ad096b73439c0f58", size = 1654176 }, + { url = "https://files.pythonhosted.org/packages/25/df/047b1ce88514a1b4915d252513640184b63624e7914e41d846668b8edbda/aiohttp-3.11.12-cp311-cp311-musllinux_1_2_armv7l.whl", hash = "sha256:0450ada317a65383b7cce9576096150fdb97396dcfe559109b403c7242faffef", size = 1660198 }, + { url = "https://files.pythonhosted.org/packages/d3/cc/6ecb8e343f0902528620b9dbd567028a936d5489bebd7dbb0dd0914f4fdb/aiohttp-3.11.12-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:850ff6155371fd802a280f8d369d4e15d69434651b844bde566ce97ee2277420", size = 1650186 }, + { url = "https://files.pythonhosted.org/packages/f8/f8/453df6dd69256ca8c06c53fc8803c9056e2b0b16509b070f9a3b4bdefd6c/aiohttp-3.11.12-cp311-cp311-musllinux_1_2_ppc64le.whl", hash = "sha256:8fd12d0f989c6099e7b0f30dc6e0d1e05499f3337461f0b2b0dadea6c64b89df", size = 1733063 }, + { url = "https://files.pythonhosted.org/packages/55/f8/540160787ff3000391de0e5d0d1d33be4c7972f933c21991e2ea105b2d5e/aiohttp-3.11.12-cp311-cp311-musllinux_1_2_s390x.whl", hash = "sha256:76719dd521c20a58a6c256d058547b3a9595d1d885b830013366e27011ffe804", size = 1755306 }, + { url = "https://files.pythonhosted.org/packages/30/7d/49f3bfdfefd741576157f8f91caa9ff61a6f3d620ca6339268327518221b/aiohttp-3.11.12-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:97fe431f2ed646a3b56142fc81d238abcbaff08548d6912acb0b19a0cadc146b", size = 1692909 }, + { url = "https://files.pythonhosted.org/packages/40/9c/8ce00afd6f6112ce9a2309dc490fea376ae824708b94b7b5ea9cba979d1d/aiohttp-3.11.12-cp311-cp311-win32.whl", hash = "sha256:e10c440d142fa8b32cfdb194caf60ceeceb3e49807072e0dc3a8887ea80e8c16", size = 416584 }, + { url = "https://files.pythonhosted.org/packages/35/97/4d3c5f562f15830de472eb10a7a222655d750839943e0e6d915ef7e26114/aiohttp-3.11.12-cp311-cp311-win_amd64.whl", hash = "sha256:246067ba0cf5560cf42e775069c5d80a8989d14a7ded21af529a4e10e3e0f0e6", size = 442674 }, + { url = "https://files.pythonhosted.org/packages/4d/d0/94346961acb476569fca9a644cc6f9a02f97ef75961a6b8d2b35279b8d1f/aiohttp-3.11.12-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:e392804a38353900c3fd8b7cacbea5132888f7129f8e241915e90b85f00e3250", size = 704837 }, + { url = "https://files.pythonhosted.org/packages/a9/af/05c503f1cc8f97621f199ef4b8db65fb88b8bc74a26ab2adb74789507ad3/aiohttp-3.11.12-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:8fa1510b96c08aaad49303ab11f8803787c99222288f310a62f493faf883ede1", size = 464218 }, + { url = "https://files.pythonhosted.org/packages/f2/48/b9949eb645b9bd699153a2ec48751b985e352ab3fed9d98c8115de305508/aiohttp-3.11.12-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:dc065a4285307607df3f3686363e7f8bdd0d8ab35f12226362a847731516e42c", size = 456166 }, + { url = "https://files.pythonhosted.org/packages/14/fb/980981807baecb6f54bdd38beb1bd271d9a3a786e19a978871584d026dcf/aiohttp-3.11.12-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:cddb31f8474695cd61fc9455c644fc1606c164b93bff2490390d90464b4655df", size = 1682528 }, + { url = "https://files.pythonhosted.org/packages/90/cb/77b1445e0a716914e6197b0698b7a3640590da6c692437920c586764d05b/aiohttp-3.11.12-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:9dec0000d2d8621d8015c293e24589d46fa218637d820894cb7356c77eca3259", size = 1737154 }, + { url = "https://files.pythonhosted.org/packages/ff/24/d6fb1f4cede9ccbe98e4def6f3ed1e1efcb658871bbf29f4863ec646bf38/aiohttp-3.11.12-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:e3552fe98e90fdf5918c04769f338a87fa4f00f3b28830ea9b78b1bdc6140e0d", size = 1793435 }, + { url = "https://files.pythonhosted.org/packages/17/e2/9f744cee0861af673dc271a3351f59ebd5415928e20080ab85be25641471/aiohttp-3.11.12-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6dfe7f984f28a8ae94ff3a7953cd9678550dbd2a1f9bda5dd9c5ae627744c78e", size = 1692010 }, + { url = "https://files.pythonhosted.org/packages/90/c4/4a1235c1df544223eb57ba553ce03bc706bdd065e53918767f7fa1ff99e0/aiohttp-3.11.12-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a481a574af914b6e84624412666cbfbe531a05667ca197804ecc19c97b8ab1b0", size = 1619481 }, + { url = "https://files.pythonhosted.org/packages/60/70/cf12d402a94a33abda86dd136eb749b14c8eb9fec1e16adc310e25b20033/aiohttp-3.11.12-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:1987770fb4887560363b0e1a9b75aa303e447433c41284d3af2840a2f226d6e0", size = 1641578 }, + { url = "https://files.pythonhosted.org/packages/1b/25/7211973fda1f5e833fcfd98ccb7f9ce4fbfc0074e3e70c0157a751d00db8/aiohttp-3.11.12-cp312-cp312-musllinux_1_2_armv7l.whl", hash = "sha256:a4ac6a0f0f6402854adca4e3259a623f5c82ec3f0c049374133bcb243132baf9", size = 1684463 }, + { url = "https://files.pythonhosted.org/packages/93/60/b5905b4d0693f6018b26afa9f2221fefc0dcbd3773fe2dff1a20fb5727f1/aiohttp-3.11.12-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:c96a43822f1f9f69cc5c3706af33239489a6294be486a0447fb71380070d4d5f", size = 1646691 }, + { url = "https://files.pythonhosted.org/packages/b4/fc/ba1b14d6fdcd38df0b7c04640794b3683e949ea10937c8a58c14d697e93f/aiohttp-3.11.12-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:a5e69046f83c0d3cb8f0d5bd9b8838271b1bc898e01562a04398e160953e8eb9", size = 1702269 }, + { url = "https://files.pythonhosted.org/packages/5e/39/18c13c6f658b2ba9cc1e0c6fb2d02f98fd653ad2addcdf938193d51a9c53/aiohttp-3.11.12-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:68d54234c8d76d8ef74744f9f9fc6324f1508129e23da8883771cdbb5818cbef", size = 1734782 }, + { url = "https://files.pythonhosted.org/packages/9f/d2/ccc190023020e342419b265861877cd8ffb75bec37b7ddd8521dd2c6deb8/aiohttp-3.11.12-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:c9fd9dcf9c91affe71654ef77426f5cf8489305e1c66ed4816f5a21874b094b9", size = 1694740 }, + { url = "https://files.pythonhosted.org/packages/3f/54/186805bcada64ea90ea909311ffedcd74369bfc6e880d39d2473314daa36/aiohttp-3.11.12-cp312-cp312-win32.whl", hash = "sha256:0ed49efcd0dc1611378beadbd97beb5d9ca8fe48579fc04a6ed0844072261b6a", size = 411530 }, + { url = "https://files.pythonhosted.org/packages/3d/63/5eca549d34d141bcd9de50d4e59b913f3641559460c739d5e215693cb54a/aiohttp-3.11.12-cp312-cp312-win_amd64.whl", hash = "sha256:54775858c7f2f214476773ce785a19ee81d1294a6bedc5cc17225355aab74802", size = 437860 }, + { url = "https://files.pythonhosted.org/packages/c3/9b/cea185d4b543ae08ee478373e16653722c19fcda10d2d0646f300ce10791/aiohttp-3.11.12-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:413ad794dccb19453e2b97c2375f2ca3cdf34dc50d18cc2693bd5aed7d16f4b9", size = 698148 }, + { url = "https://files.pythonhosted.org/packages/91/5c/80d47fe7749fde584d1404a68ade29bcd7e58db8fa11fa38e8d90d77e447/aiohttp-3.11.12-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:4a93d28ed4b4b39e6f46fd240896c29b686b75e39cc6992692e3922ff6982b4c", size = 460831 }, + { url = "https://files.pythonhosted.org/packages/8e/f9/de568f8a8ca6b061d157c50272620c53168d6e3eeddae78dbb0f7db981eb/aiohttp-3.11.12-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:d589264dbba3b16e8951b6f145d1e6b883094075283dafcab4cdd564a9e353a0", size = 453122 }, + { url = "https://files.pythonhosted.org/packages/8b/fd/b775970a047543bbc1d0f66725ba72acef788028fce215dc959fd15a8200/aiohttp-3.11.12-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e5148ca8955affdfeb864aca158ecae11030e952b25b3ae15d4e2b5ba299bad2", size = 1665336 }, + { url = "https://files.pythonhosted.org/packages/82/9b/aff01d4f9716245a1b2965f02044e4474fadd2bcfe63cf249ca788541886/aiohttp-3.11.12-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:525410e0790aab036492eeea913858989c4cb070ff373ec3bc322d700bdf47c1", size = 1718111 }, + { url = "https://files.pythonhosted.org/packages/e0/a9/166fd2d8b2cc64f08104aa614fad30eee506b563154081bf88ce729bc665/aiohttp-3.11.12-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:9bd8695be2c80b665ae3f05cb584093a1e59c35ecb7d794d1edd96e8cc9201d7", size = 1775293 }, + { url = "https://files.pythonhosted.org/packages/13/c5/0d3c89bd9e36288f10dc246f42518ce8e1c333f27636ac78df091c86bb4a/aiohttp-3.11.12-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f0203433121484b32646a5f5ea93ae86f3d9559d7243f07e8c0eab5ff8e3f70e", size = 1677338 }, + { url = "https://files.pythonhosted.org/packages/72/b2/017db2833ef537be284f64ead78725984db8a39276c1a9a07c5c7526e238/aiohttp-3.11.12-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:40cd36749a1035c34ba8d8aaf221b91ca3d111532e5ccb5fa8c3703ab1b967ed", size = 1603365 }, + { url = "https://files.pythonhosted.org/packages/fc/72/b66c96a106ec7e791e29988c222141dd1219d7793ffb01e72245399e08d2/aiohttp-3.11.12-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:a7442662afebbf7b4c6d28cb7aab9e9ce3a5df055fc4116cc7228192ad6cb484", size = 1618464 }, + { url = "https://files.pythonhosted.org/packages/3f/50/e68a40f267b46a603bab569d48d57f23508801614e05b3369898c5b2910a/aiohttp-3.11.12-cp313-cp313-musllinux_1_2_armv7l.whl", hash = "sha256:8a2fb742ef378284a50766e985804bd6adb5adb5aa781100b09befdbfa757b65", size = 1657827 }, + { url = "https://files.pythonhosted.org/packages/c5/1d/aafbcdb1773d0ba7c20793ebeedfaba1f3f7462f6fc251f24983ed738aa7/aiohttp-3.11.12-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:2cee3b117a8d13ab98b38d5b6bdcd040cfb4181068d05ce0c474ec9db5f3c5bb", size = 1616700 }, + { url = "https://files.pythonhosted.org/packages/b0/5e/6cd9724a2932f36e2a6b742436a36d64784322cfb3406ca773f903bb9a70/aiohttp-3.11.12-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:f6a19bcab7fbd8f8649d6595624856635159a6527861b9cdc3447af288a00c00", size = 1685643 }, + { url = "https://files.pythonhosted.org/packages/8b/38/ea6c91d5c767fd45a18151675a07c710ca018b30aa876a9f35b32fa59761/aiohttp-3.11.12-cp313-cp313-musllinux_1_2_s390x.whl", hash = "sha256:e4cecdb52aaa9994fbed6b81d4568427b6002f0a91c322697a4bfcc2b2363f5a", size = 1715487 }, + { url = "https://files.pythonhosted.org/packages/8e/24/e9edbcb7d1d93c02e055490348df6f955d675e85a028c33babdcaeda0853/aiohttp-3.11.12-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:30f546358dfa0953db92ba620101fefc81574f87b2346556b90b5f3ef16e55ce", size = 1672948 }, + { url = "https://files.pythonhosted.org/packages/25/be/0b1fb737268e003198f25c3a68c2135e76e4754bf399a879b27bd508a003/aiohttp-3.11.12-cp313-cp313-win32.whl", hash = "sha256:ce1bb21fc7d753b5f8a5d5a4bae99566386b15e716ebdb410154c16c91494d7f", size = 410396 }, + { url = "https://files.pythonhosted.org/packages/68/fd/677def96a75057b0a26446b62f8fbb084435b20a7d270c99539c26573bfd/aiohttp-3.11.12-cp313-cp313-win_amd64.whl", hash = "sha256:f7914ab70d2ee8ab91c13e5402122edbc77821c66d2758abb53aabe87f013287", size = 436234 }, +] + +[[package]] +name = "aiosignal" +version = "1.3.2" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "frozenlist" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/ba/b5/6d55e80f6d8a08ce22b982eafa278d823b541c925f11ee774b0b9c43473d/aiosignal-1.3.2.tar.gz", hash = "sha256:a8c255c66fafb1e499c9351d0bf32ff2d8a0321595ebac3b93713656d2436f54", size = 19424 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/ec/6a/bc7e17a3e87a2985d3e8f4da4cd0f481060eb78fb08596c42be62c90a4d9/aiosignal-1.3.2-py2.py3-none-any.whl", hash = "sha256:45cde58e409a301715980c2b01d0c28bdde3770d8290b5eb2173759d9acb31a5", size = 7597 }, +] + [[package]] name = "annotated-types" version = "0.7.0" @@ -30,6 +121,58 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/46/eb/e7f063ad1fec6b3178a3cd82d1a3c4de82cccf283fc42746168188e1cdd5/anyio-4.8.0-py3-none-any.whl", hash = "sha256:b5011f270ab5eb0abf13385f851315585cc37ef330dd88e27ec3d34d651fd47a", size = 96041 }, ] +[[package]] +name = "appdirs" +version = "1.4.4" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/d7/d8/05696357e0311f5b5c316d7b95f46c669dd9c15aaeecbb48c7d0aeb88c40/appdirs-1.4.4.tar.gz", hash = "sha256:7d5d0167b2b1ba821647616af46a749d1c653740dd0d2415100fe26e27afdf41", size = 13470 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/3b/00/2344469e2084fb287c2e0b57b72910309874c3245463acd6cf5e3db69324/appdirs-1.4.4-py2.py3-none-any.whl", hash = "sha256:a841dacd6b99318a741b166adb07e19ee71a274450e68237b4650ca1055ab128", size = 9566 }, +] + +[[package]] +name = "asgiref" +version = "3.8.1" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/29/38/b3395cc9ad1b56d2ddac9970bc8f4141312dbaec28bc7c218b0dfafd0f42/asgiref-3.8.1.tar.gz", hash = "sha256:c343bd80a0bec947a9860adb4c432ffa7db769836c64238fc34bdc3fec84d590", size = 35186 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/39/e3/893e8757be2612e6c266d9bb58ad2e3651524b5b40cf56761e985a28b13e/asgiref-3.8.1-py3-none-any.whl", hash = "sha256:3e1e3ecc849832fe52ccf2cb6686b7a55f82bb1d6aee72a58826471390335e47", size = 23828 }, +] + +[[package]] +name = "asttokens" +version = "3.0.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/4a/e7/82da0a03e7ba5141f05cce0d302e6eed121ae055e0456ca228bf693984bc/asttokens-3.0.0.tar.gz", hash = "sha256:0dcd8baa8d62b0c1d118b399b2ddba3c4aff271d0d7a9e0d4c1681c79035bbc7", size = 61978 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/25/8a/c46dcc25341b5bce5472c718902eb3d38600a903b14fa6aeecef3f21a46f/asttokens-3.0.0-py3-none-any.whl", hash = "sha256:e3078351a059199dd5138cb1c706e6430c05eff2ff136af5eb4790f9d28932e2", size = 26918 }, +] + +[[package]] +name = "attrs" +version = "25.1.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/49/7c/fdf464bcc51d23881d110abd74b512a42b3d5d376a55a831b44c603ae17f/attrs-25.1.0.tar.gz", hash = "sha256:1c97078a80c814273a76b2a298a932eb681c87415c11dee0a6921de7f1b02c3e", size = 810562 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/fc/30/d4986a882011f9df997a55e6becd864812ccfcd821d64aac8570ee39f719/attrs-25.1.0-py3-none-any.whl", hash = "sha256:c75a69e28a550a7e93789579c22aa26b0f5b83b75dc4e08fe092980051e1090a", size = 63152 }, +] + +[[package]] +name = "auth0-python" +version = "4.8.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "aiohttp" }, + { name = "cryptography" }, + { name = "pyjwt" }, + { name = "requests" }, + { name = "urllib3" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/bd/2e/3a65963a7bc6c91eabef9fd6c58b0319eb98999897778be6b7ff62fc1c8d/auth0_python-4.8.0.tar.gz", hash = "sha256:c1a47de68303c56999b5c0e0954fab3e62b57a1ef65a45322dbadbecf34b64a4", size = 74585 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/a6/7d/88054ff3934e7d04c5b3fe67d8158ae3beb7b01621c34640b5f75e7db994/auth0_python-4.8.0-py3-none-any.whl", hash = "sha256:3d3fa18819a98025cc977d4809ad52b14dbe8b73da3ad56d98e4992d3f7e5bbd", size = 134035 }, +] + [[package]] name = "babel" version = "2.17.0" @@ -39,6 +182,77 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/b7/b8/3fe70c75fe32afc4bb507f75563d39bc5642255d1d94f1f23604725780bf/babel-2.17.0-py3-none-any.whl", hash = "sha256:4d0b53093fdfb4b21c92b5213dba5a1b23885afa8383709427046b21c366e5f2", size = 10182537 }, ] +[[package]] +name = "backoff" +version = "2.2.1" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/47/d7/5bbeb12c44d7c4f2fb5b56abce497eb5ed9f34d85701de869acedd602619/backoff-2.2.1.tar.gz", hash = "sha256:03f829f5bb1923180821643f8753b0502c3b682293992485b0eef2807afa5cba", size = 17001 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/df/73/b6e24bd22e6720ca8ee9a85a0c4a2971af8497d8f3193fa05390cbd46e09/backoff-2.2.1-py3-none-any.whl", hash = "sha256:63579f9a0628e06278f7e47b7d7d5b6ce20dc65c5e96a6f3ca99a6adca0396e8", size = 15148 }, +] + +[[package]] +name = "bcrypt" +version = "4.2.1" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/56/8c/dd696962612e4cd83c40a9e6b3db77bfe65a830f4b9af44098708584686c/bcrypt-4.2.1.tar.gz", hash = "sha256:6765386e3ab87f569b276988742039baab087b2cdb01e809d74e74503c2faafe", size = 24427 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/bc/ca/e17b08c523adb93d5f07a226b2bd45a7c6e96b359e31c1e99f9db58cb8c3/bcrypt-4.2.1-cp37-abi3-macosx_10_12_universal2.whl", hash = "sha256:1340411a0894b7d3ef562fb233e4b6ed58add185228650942bdc885362f32c17", size = 489982 }, + { url = "https://files.pythonhosted.org/packages/6a/be/e7c6e0fd6087ee8fc6d77d8d9e817e9339d879737509019b9a9012a1d96f/bcrypt-4.2.1-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:b1ee315739bc8387aa36ff127afc99120ee452924e0df517a8f3e4c0187a0f5f", size = 273108 }, + { url = "https://files.pythonhosted.org/packages/d6/53/ac084b7d985aee1a5f2b086d501f550862596dbf73220663b8c17427e7f2/bcrypt-4.2.1-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8dbd0747208912b1e4ce730c6725cb56c07ac734b3629b60d4398f082ea718ad", size = 278733 }, + { url = "https://files.pythonhosted.org/packages/8e/ab/b8710a3d6231c587e575ead0b1c45bb99f5454f9f579c9d7312c17b069cc/bcrypt-4.2.1-cp37-abi3-manylinux_2_28_aarch64.whl", hash = "sha256:aaa2e285be097050dba798d537b6efd9b698aa88eef52ec98d23dcd6d7cf6fea", size = 273856 }, + { url = "https://files.pythonhosted.org/packages/9d/e5/2fd1ea6395358ffdfd4afe370d5b52f71408f618f781772a48971ef3b92b/bcrypt-4.2.1-cp37-abi3-manylinux_2_28_x86_64.whl", hash = "sha256:76d3e352b32f4eeb34703370e370997065d28a561e4a18afe4fef07249cb4396", size = 279067 }, + { url = "https://files.pythonhosted.org/packages/4e/ef/f2cb7a0f7e1ed800a604f8ab256fb0afcf03c1540ad94ff771ce31e794aa/bcrypt-4.2.1-cp37-abi3-musllinux_1_1_aarch64.whl", hash = "sha256:b7703ede632dc945ed1172d6f24e9f30f27b1b1a067f32f68bf169c5f08d0425", size = 306851 }, + { url = "https://files.pythonhosted.org/packages/de/cb/578b0023c6a5ca16a177b9044ba6bd6032277bd3ef020fb863eccd22e49b/bcrypt-4.2.1-cp37-abi3-musllinux_1_1_x86_64.whl", hash = "sha256:89df2aea2c43be1e1fa066df5f86c8ce822ab70a30e4c210968669565c0f4685", size = 310793 }, + { url = "https://files.pythonhosted.org/packages/98/bc/9d501ee9d754f63d4b1086b64756c284facc3696de9b556c146279a124a5/bcrypt-4.2.1-cp37-abi3-musllinux_1_2_aarch64.whl", hash = "sha256:04e56e3fe8308a88b77e0afd20bec516f74aecf391cdd6e374f15cbed32783d6", size = 320957 }, + { url = "https://files.pythonhosted.org/packages/a1/25/2ec4ce5740abc43182bfc064b9acbbf5a493991246985e8b2bfe231ead64/bcrypt-4.2.1-cp37-abi3-musllinux_1_2_x86_64.whl", hash = "sha256:cfdf3d7530c790432046c40cda41dfee8c83e29482e6a604f8930b9930e94139", size = 339958 }, + { url = "https://files.pythonhosted.org/packages/6d/64/fd67788f64817727897d31e9cdeeeba3941eaad8540733c05c7eac4aa998/bcrypt-4.2.1-cp37-abi3-win32.whl", hash = "sha256:adadd36274510a01f33e6dc08f5824b97c9580583bd4487c564fc4617b328005", size = 160912 }, + { url = "https://files.pythonhosted.org/packages/00/8f/fe834eaa54abbd7cab8607e5020fa3a0557e929555b9e4ca404b4adaab06/bcrypt-4.2.1-cp37-abi3-win_amd64.whl", hash = "sha256:8c458cd103e6c5d1d85cf600e546a639f234964d0228909d8f8dbeebff82d526", size = 152981 }, + { url = "https://files.pythonhosted.org/packages/4a/57/23b46933206daf5384b5397d9878746d2249fe9d45efaa8e1467c87d3048/bcrypt-4.2.1-cp39-abi3-macosx_10_12_universal2.whl", hash = "sha256:8ad2f4528cbf0febe80e5a3a57d7a74e6635e41af1ea5675282a33d769fba413", size = 489842 }, + { url = "https://files.pythonhosted.org/packages/fd/28/3ea8a39ddd4938b6c6b6136816d72ba5e659e2d82b53d843c8c53455ac4d/bcrypt-4.2.1-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:909faa1027900f2252a9ca5dfebd25fc0ef1417943824783d1c8418dd7d6df4a", size = 272500 }, + { url = "https://files.pythonhosted.org/packages/77/7f/b43622999f5d4de06237a195ac5501ac83516adf571b907228cd14bac8fe/bcrypt-4.2.1-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:cde78d385d5e93ece5479a0a87f73cd6fa26b171c786a884f955e165032b262c", size = 278368 }, + { url = "https://files.pythonhosted.org/packages/50/68/f2e3959014b4d8874c747e6e171d46d3e63a3a39aaca8417a8d837eda0a8/bcrypt-4.2.1-cp39-abi3-manylinux_2_28_aarch64.whl", hash = "sha256:533e7f3bcf2f07caee7ad98124fab7499cb3333ba2274f7a36cf1daee7409d99", size = 273335 }, + { url = "https://files.pythonhosted.org/packages/d6/c3/4b4bad4da852924427c651589d464ad1aa624f94dd904ddda8493b0a35e5/bcrypt-4.2.1-cp39-abi3-manylinux_2_28_x86_64.whl", hash = "sha256:687cf30e6681eeda39548a93ce9bfbb300e48b4d445a43db4298d2474d2a1e54", size = 278614 }, + { url = "https://files.pythonhosted.org/packages/6e/5a/ee107961e84c41af2ac201d0460f962b6622ff391255ffd46429e9e09dc1/bcrypt-4.2.1-cp39-abi3-musllinux_1_1_aarch64.whl", hash = "sha256:041fa0155c9004eb98a232d54da05c0b41d4b8e66b6fc3cb71b4b3f6144ba837", size = 306464 }, + { url = "https://files.pythonhosted.org/packages/5c/72/916e14fa12d2b1d1fc6c26ea195337419da6dd23d0bf53ac61ef3739e5c5/bcrypt-4.2.1-cp39-abi3-musllinux_1_1_x86_64.whl", hash = "sha256:f85b1ffa09240c89aa2e1ae9f3b1c687104f7b2b9d2098da4e923f1b7082d331", size = 310674 }, + { url = "https://files.pythonhosted.org/packages/97/92/3dc76d8bfa23300591eec248e950f85bd78eb608c96bd4747ce4cc06acdb/bcrypt-4.2.1-cp39-abi3-musllinux_1_2_aarch64.whl", hash = "sha256:c6f5fa3775966cca251848d4d5393ab016b3afed251163c1436fefdec3b02c84", size = 320577 }, + { url = "https://files.pythonhosted.org/packages/5d/ab/a6c0da5c2cf86600f74402a72b06dfe365e1a1d30783b1bbeec460fd57d1/bcrypt-4.2.1-cp39-abi3-musllinux_1_2_x86_64.whl", hash = "sha256:807261df60a8b1ccd13e6599c779014a362ae4e795f5c59747f60208daddd96d", size = 339836 }, + { url = "https://files.pythonhosted.org/packages/b4/b4/e75b6e9a72a030a04362034022ebe317c5b735d04db6ad79237101ae4a5c/bcrypt-4.2.1-cp39-abi3-win32.whl", hash = "sha256:b588af02b89d9fad33e5f98f7838bf590d6d692df7153647724a7f20c186f6bf", size = 160911 }, + { url = "https://files.pythonhosted.org/packages/76/b9/d51d34e6cd6d887adddb28a8680a1d34235cc45b9d6e238ce39b98199ca0/bcrypt-4.2.1-cp39-abi3-win_amd64.whl", hash = "sha256:e84e0e6f8e40a242b11bce56c313edc2be121cec3e0ec2d76fce01f6af33c07c", size = 153078 }, +] + +[[package]] +name = "blinker" +version = "1.9.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/21/28/9b3f50ce0e048515135495f198351908d99540d69bfdc8c1d15b73dc55ce/blinker-1.9.0.tar.gz", hash = "sha256:b4ce2265a7abece45e7cc896e98dbebe6cead56bcf805a3d23136d145f5445bf", size = 22460 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/10/cb/f2ad4230dc2eb1a74edf38f1a38b9b52277f75bef262d8908e60d957e13c/blinker-1.9.0-py3-none-any.whl", hash = "sha256:ba0efaa9080b619ff2f3459d1d500c57bddea4a6b424b60a91141db6fd2f08bc", size = 8458 }, +] + +[[package]] +name = "build" +version = "1.2.2.post1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "colorama", marker = "os_name == 'nt'" }, + { name = "packaging" }, + { name = "pyproject-hooks" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/7d/46/aeab111f8e06793e4f0e421fcad593d547fb8313b50990f31681ee2fb1ad/build-1.2.2.post1.tar.gz", hash = "sha256:b36993e92ca9375a219c99e606a122ff365a760a2d4bba0caa09bd5278b608b7", size = 46701 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/84/c2/80633736cd183ee4a62107413def345f7e6e3c01563dbca1417363cf957e/build-1.2.2.post1-py3-none-any.whl", hash = "sha256:1d61c0887fa860c01971625baae8bdd338e517b836a2f70dd1f7aa3a6b2fc5b5", size = 22950 }, +] + +[[package]] +name = "cachetools" +version = "5.5.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/6c/81/3747dad6b14fa2cf53fcf10548cf5aea6913e96fab41a3c198676f8948a5/cachetools-5.5.2.tar.gz", hash = "sha256:1a661caa9175d26759571b2e19580f9d6393969e5dfca11fdb1f947a23e640d4", size = 28380 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/72/76/20fa66124dbe6be5cafeb312ece67de6b61dd91a0247d1ea13db4ebb33c2/cachetools-5.5.2-py3-none-any.whl", hash = "sha256:d26a22bcc62eb95c3beabd9f1ee5e820d3d2704fe2967cbe350e20c8ffcd3f0a", size = 10080 }, +] + [[package]] name = "certifi" version = "2025.1.31" @@ -48,6 +262,51 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/38/fc/bce832fd4fd99766c04d1ee0eead6b0ec6486fb100ae5e74c1d91292b982/certifi-2025.1.31-py3-none-any.whl", hash = "sha256:ca78db4565a652026a4db2bcdf68f2fb589ea80d0be70e03929ed730746b84fe", size = 166393 }, ] +[[package]] +name = "cffi" +version = "1.17.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "pycparser" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/fc/97/c783634659c2920c3fc70419e3af40972dbaf758daa229a7d6ea6135c90d/cffi-1.17.1.tar.gz", hash = "sha256:1c39c6016c32bc48dd54561950ebd6836e1670f2ae46128f67cf49e789c52824", size = 516621 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/6b/f4/927e3a8899e52a27fa57a48607ff7dc91a9ebe97399b357b85a0c7892e00/cffi-1.17.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:a45e3c6913c5b87b3ff120dcdc03f6131fa0065027d0ed7ee6190736a74cd401", size = 182264 }, + { url = "https://files.pythonhosted.org/packages/6c/f5/6c3a8efe5f503175aaddcbea6ad0d2c96dad6f5abb205750d1b3df44ef29/cffi-1.17.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:30c5e0cb5ae493c04c8b42916e52ca38079f1b235c2f8ae5f4527b963c401caf", size = 178651 }, + { url = "https://files.pythonhosted.org/packages/94/dd/a3f0118e688d1b1a57553da23b16bdade96d2f9bcda4d32e7d2838047ff7/cffi-1.17.1-cp311-cp311-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f75c7ab1f9e4aca5414ed4d8e5c0e303a34f4421f8a0d47a4d019ceff0ab6af4", size = 445259 }, + { url = "https://files.pythonhosted.org/packages/2e/ea/70ce63780f096e16ce8588efe039d3c4f91deb1dc01e9c73a287939c79a6/cffi-1.17.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a1ed2dd2972641495a3ec98445e09766f077aee98a1c896dcb4ad0d303628e41", size = 469200 }, + { url = "https://files.pythonhosted.org/packages/1c/a0/a4fa9f4f781bda074c3ddd57a572b060fa0df7655d2a4247bbe277200146/cffi-1.17.1-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:46bf43160c1a35f7ec506d254e5c890f3c03648a4dbac12d624e4490a7046cd1", size = 477235 }, + { url = "https://files.pythonhosted.org/packages/62/12/ce8710b5b8affbcdd5c6e367217c242524ad17a02fe5beec3ee339f69f85/cffi-1.17.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:a24ed04c8ffd54b0729c07cee15a81d964e6fee0e3d4d342a27b020d22959dc6", size = 459721 }, + { url = "https://files.pythonhosted.org/packages/ff/6b/d45873c5e0242196f042d555526f92aa9e0c32355a1be1ff8c27f077fd37/cffi-1.17.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:610faea79c43e44c71e1ec53a554553fa22321b65fae24889706c0a84d4ad86d", size = 467242 }, + { url = "https://files.pythonhosted.org/packages/1a/52/d9a0e523a572fbccf2955f5abe883cfa8bcc570d7faeee06336fbd50c9fc/cffi-1.17.1-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:a9b15d491f3ad5d692e11f6b71f7857e7835eb677955c00cc0aefcd0669adaf6", size = 477999 }, + { url = "https://files.pythonhosted.org/packages/44/74/f2a2460684a1a2d00ca799ad880d54652841a780c4c97b87754f660c7603/cffi-1.17.1-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:de2ea4b5833625383e464549fec1bc395c1bdeeb5f25c4a3a82b5a8c756ec22f", size = 454242 }, + { url = "https://files.pythonhosted.org/packages/f8/4a/34599cac7dfcd888ff54e801afe06a19c17787dfd94495ab0c8d35fe99fb/cffi-1.17.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:fc48c783f9c87e60831201f2cce7f3b2e4846bf4d8728eabe54d60700b318a0b", size = 478604 }, + { url = "https://files.pythonhosted.org/packages/34/33/e1b8a1ba29025adbdcda5fb3a36f94c03d771c1b7b12f726ff7fef2ebe36/cffi-1.17.1-cp311-cp311-win32.whl", hash = "sha256:85a950a4ac9c359340d5963966e3e0a94a676bd6245a4b55bc43949eee26a655", size = 171727 }, + { url = "https://files.pythonhosted.org/packages/3d/97/50228be003bb2802627d28ec0627837ac0bf35c90cf769812056f235b2d1/cffi-1.17.1-cp311-cp311-win_amd64.whl", hash = "sha256:caaf0640ef5f5517f49bc275eca1406b0ffa6aa184892812030f04c2abf589a0", size = 181400 }, + { url = "https://files.pythonhosted.org/packages/5a/84/e94227139ee5fb4d600a7a4927f322e1d4aea6fdc50bd3fca8493caba23f/cffi-1.17.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:805b4371bf7197c329fcb3ead37e710d1bca9da5d583f5073b799d5c5bd1eee4", size = 183178 }, + { url = "https://files.pythonhosted.org/packages/da/ee/fb72c2b48656111c4ef27f0f91da355e130a923473bf5ee75c5643d00cca/cffi-1.17.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:733e99bc2df47476e3848417c5a4540522f234dfd4ef3ab7fafdf555b082ec0c", size = 178840 }, + { url = "https://files.pythonhosted.org/packages/cc/b6/db007700f67d151abadf508cbfd6a1884f57eab90b1bb985c4c8c02b0f28/cffi-1.17.1-cp312-cp312-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:1257bdabf294dceb59f5e70c64a3e2f462c30c7ad68092d01bbbfb1c16b1ba36", size = 454803 }, + { url = "https://files.pythonhosted.org/packages/1a/df/f8d151540d8c200eb1c6fba8cd0dfd40904f1b0682ea705c36e6c2e97ab3/cffi-1.17.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:da95af8214998d77a98cc14e3a3bd00aa191526343078b530ceb0bd710fb48a5", size = 478850 }, + { url = "https://files.pythonhosted.org/packages/28/c0/b31116332a547fd2677ae5b78a2ef662dfc8023d67f41b2a83f7c2aa78b1/cffi-1.17.1-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:d63afe322132c194cf832bfec0dc69a99fb9bb6bbd550f161a49e9e855cc78ff", size = 485729 }, + { url = "https://files.pythonhosted.org/packages/91/2b/9a1ddfa5c7f13cab007a2c9cc295b70fbbda7cb10a286aa6810338e60ea1/cffi-1.17.1-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:f79fc4fc25f1c8698ff97788206bb3c2598949bfe0fef03d299eb1b5356ada99", size = 471256 }, + { url = "https://files.pythonhosted.org/packages/b2/d5/da47df7004cb17e4955df6a43d14b3b4ae77737dff8bf7f8f333196717bf/cffi-1.17.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b62ce867176a75d03a665bad002af8e6d54644fad99a3c70905c543130e39d93", size = 479424 }, + { url = "https://files.pythonhosted.org/packages/0b/ac/2a28bcf513e93a219c8a4e8e125534f4f6db03e3179ba1c45e949b76212c/cffi-1.17.1-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:386c8bf53c502fff58903061338ce4f4950cbdcb23e2902d86c0f722b786bbe3", size = 484568 }, + { url = "https://files.pythonhosted.org/packages/d4/38/ca8a4f639065f14ae0f1d9751e70447a261f1a30fa7547a828ae08142465/cffi-1.17.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:4ceb10419a9adf4460ea14cfd6bc43d08701f0835e979bf821052f1805850fe8", size = 488736 }, + { url = "https://files.pythonhosted.org/packages/86/c5/28b2d6f799ec0bdecf44dced2ec5ed43e0eb63097b0f58c293583b406582/cffi-1.17.1-cp312-cp312-win32.whl", hash = "sha256:a08d7e755f8ed21095a310a693525137cfe756ce62d066e53f502a83dc550f65", size = 172448 }, + { url = "https://files.pythonhosted.org/packages/50/b9/db34c4755a7bd1cb2d1603ac3863f22bcecbd1ba29e5ee841a4bc510b294/cffi-1.17.1-cp312-cp312-win_amd64.whl", hash = "sha256:51392eae71afec0d0c8fb1a53b204dbb3bcabcb3c9b807eedf3e1e6ccf2de903", size = 181976 }, + { url = "https://files.pythonhosted.org/packages/8d/f8/dd6c246b148639254dad4d6803eb6a54e8c85c6e11ec9df2cffa87571dbe/cffi-1.17.1-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:f3a2b4222ce6b60e2e8b337bb9596923045681d71e5a082783484d845390938e", size = 182989 }, + { url = "https://files.pythonhosted.org/packages/8b/f1/672d303ddf17c24fc83afd712316fda78dc6fce1cd53011b839483e1ecc8/cffi-1.17.1-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:0984a4925a435b1da406122d4d7968dd861c1385afe3b45ba82b750f229811e2", size = 178802 }, + { url = "https://files.pythonhosted.org/packages/0e/2d/eab2e858a91fdff70533cab61dcff4a1f55ec60425832ddfdc9cd36bc8af/cffi-1.17.1-cp313-cp313-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:d01b12eeeb4427d3110de311e1774046ad344f5b1a7403101878976ecd7a10f3", size = 454792 }, + { url = "https://files.pythonhosted.org/packages/75/b2/fbaec7c4455c604e29388d55599b99ebcc250a60050610fadde58932b7ee/cffi-1.17.1-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:706510fe141c86a69c8ddc029c7910003a17353970cff3b904ff0686a5927683", size = 478893 }, + { url = "https://files.pythonhosted.org/packages/4f/b7/6e4a2162178bf1935c336d4da8a9352cccab4d3a5d7914065490f08c0690/cffi-1.17.1-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:de55b766c7aa2e2a3092c51e0483d700341182f08e67c63630d5b6f200bb28e5", size = 485810 }, + { url = "https://files.pythonhosted.org/packages/c7/8a/1d0e4a9c26e54746dc08c2c6c037889124d4f59dffd853a659fa545f1b40/cffi-1.17.1-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:c59d6e989d07460165cc5ad3c61f9fd8f1b4796eacbd81cee78957842b834af4", size = 471200 }, + { url = "https://files.pythonhosted.org/packages/26/9f/1aab65a6c0db35f43c4d1b4f580e8df53914310afc10ae0397d29d697af4/cffi-1.17.1-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:dd398dbc6773384a17fe0d3e7eeb8d1a21c2200473ee6806bb5e6a8e62bb73dd", size = 479447 }, + { url = "https://files.pythonhosted.org/packages/5f/e4/fb8b3dd8dc0e98edf1135ff067ae070bb32ef9d509d6cb0f538cd6f7483f/cffi-1.17.1-cp313-cp313-musllinux_1_1_aarch64.whl", hash = "sha256:3edc8d958eb099c634dace3c7e16560ae474aa3803a5df240542b305d14e14ed", size = 484358 }, + { url = "https://files.pythonhosted.org/packages/f1/47/d7145bf2dc04684935d57d67dff9d6d795b2ba2796806bb109864be3a151/cffi-1.17.1-cp313-cp313-musllinux_1_1_x86_64.whl", hash = "sha256:72e72408cad3d5419375fc87d289076ee319835bdfa2caad331e377589aebba9", size = 488469 }, + { url = "https://files.pythonhosted.org/packages/bf/ee/f94057fa6426481d663b88637a9a10e859e492c73d0384514a17d78ee205/cffi-1.17.1-cp313-cp313-win32.whl", hash = "sha256:e03eab0a8677fa80d646b5ddece1cbeaf556c313dcfac435ba11f107ba117b5d", size = 172475 }, + { url = "https://files.pythonhosted.org/packages/7c/fc/6a8cb64e5f0324877d503c854da15d76c1e50eb722e320b15345c4d0c6de/cffi-1.17.1-cp313-cp313-win_amd64.whl", hash = "sha256:f6a16c31041f09ead72d69f583767292f750d24913dadacf5756b966aacb3f1a", size = 182009 }, +] + [[package]] name = "cfgv" version = "3.4.0" @@ -105,6 +364,65 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/0e/f6/65ecc6878a89bb1c23a086ea335ad4bf21a588990c3f535a227b9eea9108/charset_normalizer-3.4.1-py3-none-any.whl", hash = "sha256:d98b1668f06378c6dbefec3b92299716b931cd4e6061f3c875a71ced1780ab85", size = 49767 }, ] +[[package]] +name = "chroma-hnswlib" +version = "0.7.6" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "numpy" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/73/09/10d57569e399ce9cbc5eee2134996581c957f63a9addfa6ca657daf006b8/chroma_hnswlib-0.7.6.tar.gz", hash = "sha256:4dce282543039681160259d29fcde6151cc9106c6461e0485f57cdccd83059b7", size = 32256 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/f5/af/d15fdfed2a204c0f9467ad35084fbac894c755820b203e62f5dcba2d41f1/chroma_hnswlib-0.7.6-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:81181d54a2b1e4727369486a631f977ffc53c5533d26e3d366dda243fb0998ca", size = 196911 }, + { url = "https://files.pythonhosted.org/packages/0d/19/aa6f2139f1ff7ad23a690ebf2a511b2594ab359915d7979f76f3213e46c4/chroma_hnswlib-0.7.6-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:4b4ab4e11f1083dd0a11ee4f0e0b183ca9f0f2ed63ededba1935b13ce2b3606f", size = 185000 }, + { url = "https://files.pythonhosted.org/packages/79/b1/1b269c750e985ec7d40b9bbe7d66d0a890e420525187786718e7f6b07913/chroma_hnswlib-0.7.6-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:53db45cd9173d95b4b0bdccb4dbff4c54a42b51420599c32267f3abbeb795170", size = 2377289 }, + { url = "https://files.pythonhosted.org/packages/c7/2d/d5663e134436e5933bc63516a20b5edc08b4c1b1588b9680908a5f1afd04/chroma_hnswlib-0.7.6-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5c093f07a010b499c00a15bc9376036ee4800d335360570b14f7fe92badcdcf9", size = 2411755 }, + { url = "https://files.pythonhosted.org/packages/3e/79/1bce519cf186112d6d5ce2985392a89528c6e1e9332d680bf752694a4cdf/chroma_hnswlib-0.7.6-cp311-cp311-win_amd64.whl", hash = "sha256:0540b0ac96e47d0aa39e88ea4714358ae05d64bbe6bf33c52f316c664190a6a3", size = 151888 }, + { url = "https://files.pythonhosted.org/packages/93/ac/782b8d72de1c57b64fdf5cb94711540db99a92768d93d973174c62d45eb8/chroma_hnswlib-0.7.6-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:e87e9b616c281bfbe748d01705817c71211613c3b063021f7ed5e47173556cb7", size = 197804 }, + { url = "https://files.pythonhosted.org/packages/32/4e/fd9ce0764228e9a98f6ff46af05e92804090b5557035968c5b4198bc7af9/chroma_hnswlib-0.7.6-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:ec5ca25bc7b66d2ecbf14502b5729cde25f70945d22f2aaf523c2d747ea68912", size = 185421 }, + { url = "https://files.pythonhosted.org/packages/d9/3d/b59a8dedebd82545d873235ef2d06f95be244dfece7ee4a1a6044f080b18/chroma_hnswlib-0.7.6-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:305ae491de9d5f3c51e8bd52d84fdf2545a4a2bc7af49765cda286b7bb30b1d4", size = 2389672 }, + { url = "https://files.pythonhosted.org/packages/74/1e/80a033ea4466338824974a34f418e7b034a7748bf906f56466f5caa434b0/chroma_hnswlib-0.7.6-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:822ede968d25a2c88823ca078a58f92c9b5c4142e38c7c8b4c48178894a0a3c5", size = 2436986 }, +] + +[[package]] +name = "chromadb" +version = "0.6.3" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "bcrypt" }, + { name = "build" }, + { name = "chroma-hnswlib" }, + { name = "fastapi" }, + { name = "grpcio" }, + { name = "httpx" }, + { name = "importlib-resources" }, + { name = "kubernetes" }, + { name = "mmh3" }, + { name = "numpy" }, + { name = "onnxruntime" }, + { name = "opentelemetry-api" }, + { name = "opentelemetry-exporter-otlp-proto-grpc" }, + { name = "opentelemetry-instrumentation-fastapi" }, + { name = "opentelemetry-sdk" }, + { name = "orjson" }, + { name = "overrides" }, + { name = "posthog" }, + { name = "pydantic" }, + { name = "pypika" }, + { name = "pyyaml" }, + { name = "rich" }, + { name = "tenacity" }, + { name = "tokenizers" }, + { name = "tqdm" }, + { name = "typer" }, + { name = "typing-extensions" }, + { name = "uvicorn", extra = ["standard"] }, +] +sdist = { url = "https://files.pythonhosted.org/packages/39/cd/f0f2de3f466ff514fb6b58271c14f6d22198402bb5b71b8d890231265946/chromadb-0.6.3.tar.gz", hash = "sha256:c8f34c0b704b9108b04491480a36d42e894a960429f87c6516027b5481d59ed3", size = 29297929 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/28/8e/5c186c77bf749b6fe0528385e507e463f1667543328d76fd00a49e1a4e6a/chromadb-0.6.3-py3-none-any.whl", hash = "sha256:4851258489a3612b558488d98d09ae0fe0a28d5cad6bd1ba64b96fdc419dc0e5", size = 611129 }, +] + [[package]] name = "click" version = "8.1.8" @@ -126,6 +444,162 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/d1/d6/3965ed04c63042e047cb6a3e6ed1a63a35087b6a609aa3a15ed8ac56c221/colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6", size = 25335 }, ] +[[package]] +name = "coloredlogs" +version = "15.0.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "humanfriendly" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/cc/c7/eed8f27100517e8c0e6b923d5f0845d0cb99763da6fdee00478f91db7325/coloredlogs-15.0.1.tar.gz", hash = "sha256:7c991aa71a4577af2f82600d8f8f3a89f936baeaf9b50a9c197da014e5bf16b0", size = 278520 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/a7/06/3d6badcf13db419e25b07041d9c7b4a2c331d3f4e7134445ec5df57714cd/coloredlogs-15.0.1-py2.py3-none-any.whl", hash = "sha256:612ee75c546f53e92e70049c9dbfcc18c935a2b9a53b66085ce9ef6a6e5c0934", size = 46018 }, +] + +[[package]] +name = "coverage" +version = "7.6.12" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/0c/d6/2b53ab3ee99f2262e6f0b8369a43f6d66658eab45510331c0b3d5c8c4272/coverage-7.6.12.tar.gz", hash = "sha256:48cfc4641d95d34766ad41d9573cc0f22a48aa88d22657a1fe01dca0dbae4de2", size = 805941 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/64/2d/da78abbfff98468c91fd63a73cccdfa0e99051676ded8dd36123e3a2d4d5/coverage-7.6.12-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:e18aafdfb3e9ec0d261c942d35bd7c28d031c5855dadb491d2723ba54f4c3015", size = 208464 }, + { url = "https://files.pythonhosted.org/packages/31/f2/c269f46c470bdabe83a69e860c80a82e5e76840e9f4bbd7f38f8cebbee2f/coverage-7.6.12-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:66fe626fd7aa5982cdebad23e49e78ef7dbb3e3c2a5960a2b53632f1f703ea45", size = 208893 }, + { url = "https://files.pythonhosted.org/packages/47/63/5682bf14d2ce20819998a49c0deadb81e608a59eed64d6bc2191bc8046b9/coverage-7.6.12-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0ef01d70198431719af0b1f5dcbefc557d44a190e749004042927b2a3fed0702", size = 241545 }, + { url = "https://files.pythonhosted.org/packages/6a/b6/6b6631f1172d437e11067e1c2edfdb7238b65dff965a12bce3b6d1bf2be2/coverage-7.6.12-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:07e92ae5a289a4bc4c0aae710c0948d3c7892e20fd3588224ebe242039573bf0", size = 239230 }, + { url = "https://files.pythonhosted.org/packages/c7/01/9cd06cbb1be53e837e16f1b4309f6357e2dfcbdab0dd7cd3b1a50589e4e1/coverage-7.6.12-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e695df2c58ce526eeab11a2e915448d3eb76f75dffe338ea613c1201b33bab2f", size = 241013 }, + { url = "https://files.pythonhosted.org/packages/4b/26/56afefc03c30871326e3d99709a70d327ac1f33da383cba108c79bd71563/coverage-7.6.12-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:d74c08e9aaef995f8c4ef6d202dbd219c318450fe2a76da624f2ebb9c8ec5d9f", size = 239750 }, + { url = "https://files.pythonhosted.org/packages/dd/ea/88a1ff951ed288f56aa561558ebe380107cf9132facd0b50bced63ba7238/coverage-7.6.12-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:e995b3b76ccedc27fe4f477b349b7d64597e53a43fc2961db9d3fbace085d69d", size = 238462 }, + { url = "https://files.pythonhosted.org/packages/6e/d4/1d9404566f553728889409eff82151d515fbb46dc92cbd13b5337fa0de8c/coverage-7.6.12-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:b1f097878d74fe51e1ddd1be62d8e3682748875b461232cf4b52ddc6e6db0bba", size = 239307 }, + { url = "https://files.pythonhosted.org/packages/12/c1/e453d3b794cde1e232ee8ac1d194fde8e2ba329c18bbf1b93f6f5eef606b/coverage-7.6.12-cp311-cp311-win32.whl", hash = "sha256:1f7ffa05da41754e20512202c866d0ebfc440bba3b0ed15133070e20bf5aeb5f", size = 211117 }, + { url = "https://files.pythonhosted.org/packages/d5/db/829185120c1686fa297294f8fcd23e0422f71070bf85ef1cc1a72ecb2930/coverage-7.6.12-cp311-cp311-win_amd64.whl", hash = "sha256:e216c5c45f89ef8971373fd1c5d8d1164b81f7f5f06bbf23c37e7908d19e8558", size = 212019 }, + { url = "https://files.pythonhosted.org/packages/e2/7f/4af2ed1d06ce6bee7eafc03b2ef748b14132b0bdae04388e451e4b2c529b/coverage-7.6.12-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:b172f8e030e8ef247b3104902cc671e20df80163b60a203653150d2fc204d1ad", size = 208645 }, + { url = "https://files.pythonhosted.org/packages/dc/60/d19df912989117caa95123524d26fc973f56dc14aecdec5ccd7d0084e131/coverage-7.6.12-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:641dfe0ab73deb7069fb972d4d9725bf11c239c309ce694dd50b1473c0f641c3", size = 208898 }, + { url = "https://files.pythonhosted.org/packages/bd/10/fecabcf438ba676f706bf90186ccf6ff9f6158cc494286965c76e58742fa/coverage-7.6.12-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0e549f54ac5f301e8e04c569dfdb907f7be71b06b88b5063ce9d6953d2d58574", size = 242987 }, + { url = "https://files.pythonhosted.org/packages/4c/53/4e208440389e8ea936f5f2b0762dcd4cb03281a7722def8e2bf9dc9c3d68/coverage-7.6.12-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:959244a17184515f8c52dcb65fb662808767c0bd233c1d8a166e7cf74c9ea985", size = 239881 }, + { url = "https://files.pythonhosted.org/packages/c4/47/2ba744af8d2f0caa1f17e7746147e34dfc5f811fb65fc153153722d58835/coverage-7.6.12-cp312-cp312-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bda1c5f347550c359f841d6614fb8ca42ae5cb0b74d39f8a1e204815ebe25750", size = 242142 }, + { url = "https://files.pythonhosted.org/packages/e9/90/df726af8ee74d92ee7e3bf113bf101ea4315d71508952bd21abc3fae471e/coverage-7.6.12-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:1ceeb90c3eda1f2d8c4c578c14167dbd8c674ecd7d38e45647543f19839dd6ea", size = 241437 }, + { url = "https://files.pythonhosted.org/packages/f6/af/995263fd04ae5f9cf12521150295bf03b6ba940d0aea97953bb4a6db3e2b/coverage-7.6.12-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:0f16f44025c06792e0fb09571ae454bcc7a3ec75eeb3c36b025eccf501b1a4c3", size = 239724 }, + { url = "https://files.pythonhosted.org/packages/1c/8e/5bb04f0318805e190984c6ce106b4c3968a9562a400180e549855d8211bd/coverage-7.6.12-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:b076e625396e787448d27a411aefff867db2bffac8ed04e8f7056b07024eed5a", size = 241329 }, + { url = "https://files.pythonhosted.org/packages/9e/9d/fa04d9e6c3f6459f4e0b231925277cfc33d72dfab7fa19c312c03e59da99/coverage-7.6.12-cp312-cp312-win32.whl", hash = "sha256:00b2086892cf06c7c2d74983c9595dc511acca00665480b3ddff749ec4fb2a95", size = 211289 }, + { url = "https://files.pythonhosted.org/packages/53/40/53c7ffe3c0c3fff4d708bc99e65f3d78c129110d6629736faf2dbd60ad57/coverage-7.6.12-cp312-cp312-win_amd64.whl", hash = "sha256:7ae6eabf519bc7871ce117fb18bf14e0e343eeb96c377667e3e5dd12095e0288", size = 212079 }, + { url = "https://files.pythonhosted.org/packages/76/89/1adf3e634753c0de3dad2f02aac1e73dba58bc5a3a914ac94a25b2ef418f/coverage-7.6.12-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:488c27b3db0ebee97a830e6b5a3ea930c4a6e2c07f27a5e67e1b3532e76b9ef1", size = 208673 }, + { url = "https://files.pythonhosted.org/packages/ce/64/92a4e239d64d798535c5b45baac6b891c205a8a2e7c9cc8590ad386693dc/coverage-7.6.12-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:5d1095bbee1851269f79fd8e0c9b5544e4c00c0c24965e66d8cba2eb5bb535fd", size = 208945 }, + { url = "https://files.pythonhosted.org/packages/b4/d0/4596a3ef3bca20a94539c9b1e10fd250225d1dec57ea78b0867a1cf9742e/coverage-7.6.12-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0533adc29adf6a69c1baa88c3d7dbcaadcffa21afbed3ca7a225a440e4744bf9", size = 242484 }, + { url = "https://files.pythonhosted.org/packages/1c/ef/6fd0d344695af6718a38d0861408af48a709327335486a7ad7e85936dc6e/coverage-7.6.12-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:53c56358d470fa507a2b6e67a68fd002364d23c83741dbc4c2e0680d80ca227e", size = 239525 }, + { url = "https://files.pythonhosted.org/packages/0c/4b/373be2be7dd42f2bcd6964059fd8fa307d265a29d2b9bcf1d044bcc156ed/coverage-7.6.12-cp313-cp313-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:64cbb1a3027c79ca6310bf101014614f6e6e18c226474606cf725238cf5bc2d4", size = 241545 }, + { url = "https://files.pythonhosted.org/packages/a6/7d/0e83cc2673a7790650851ee92f72a343827ecaaea07960587c8f442b5cd3/coverage-7.6.12-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:79cac3390bfa9836bb795be377395f28410811c9066bc4eefd8015258a7578c6", size = 241179 }, + { url = "https://files.pythonhosted.org/packages/ff/8c/566ea92ce2bb7627b0900124e24a99f9244b6c8c92d09ff9f7633eb7c3c8/coverage-7.6.12-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:9b148068e881faa26d878ff63e79650e208e95cf1c22bd3f77c3ca7b1d9821a3", size = 239288 }, + { url = "https://files.pythonhosted.org/packages/7d/e4/869a138e50b622f796782d642c15fb5f25a5870c6d0059a663667a201638/coverage-7.6.12-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:8bec2ac5da793c2685ce5319ca9bcf4eee683b8a1679051f8e6ec04c4f2fd7dc", size = 241032 }, + { url = "https://files.pythonhosted.org/packages/ae/28/a52ff5d62a9f9e9fe9c4f17759b98632edd3a3489fce70154c7d66054dd3/coverage-7.6.12-cp313-cp313-win32.whl", hash = "sha256:200e10beb6ddd7c3ded322a4186313d5ca9e63e33d8fab4faa67ef46d3460af3", size = 211315 }, + { url = "https://files.pythonhosted.org/packages/bc/17/ab849b7429a639f9722fa5628364c28d675c7ff37ebc3268fe9840dda13c/coverage-7.6.12-cp313-cp313-win_amd64.whl", hash = "sha256:2b996819ced9f7dbb812c701485d58f261bef08f9b85304d41219b1496b591ef", size = 212099 }, + { url = "https://files.pythonhosted.org/packages/d2/1c/b9965bf23e171d98505eb5eb4fb4d05c44efd256f2e0f19ad1ba8c3f54b0/coverage-7.6.12-cp313-cp313t-macosx_10_13_x86_64.whl", hash = "sha256:299cf973a7abff87a30609879c10df0b3bfc33d021e1adabc29138a48888841e", size = 209511 }, + { url = "https://files.pythonhosted.org/packages/57/b3/119c201d3b692d5e17784fee876a9a78e1b3051327de2709392962877ca8/coverage-7.6.12-cp313-cp313t-macosx_11_0_arm64.whl", hash = "sha256:4b467a8c56974bf06e543e69ad803c6865249d7a5ccf6980457ed2bc50312703", size = 209729 }, + { url = "https://files.pythonhosted.org/packages/52/4e/a7feb5a56b266304bc59f872ea07b728e14d5a64f1ad3a2cc01a3259c965/coverage-7.6.12-cp313-cp313t-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2458f275944db8129f95d91aee32c828a408481ecde3b30af31d552c2ce284a0", size = 253988 }, + { url = "https://files.pythonhosted.org/packages/65/19/069fec4d6908d0dae98126aa7ad08ce5130a6decc8509da7740d36e8e8d2/coverage-7.6.12-cp313-cp313t-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:0a9d8be07fb0832636a0f72b80d2a652fe665e80e720301fb22b191c3434d924", size = 249697 }, + { url = "https://files.pythonhosted.org/packages/1c/da/5b19f09ba39df7c55f77820736bf17bbe2416bbf5216a3100ac019e15839/coverage-7.6.12-cp313-cp313t-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:14d47376a4f445e9743f6c83291e60adb1b127607a3618e3185bbc8091f0467b", size = 252033 }, + { url = "https://files.pythonhosted.org/packages/1e/89/4c2750df7f80a7872267f7c5fe497c69d45f688f7b3afe1297e52e33f791/coverage-7.6.12-cp313-cp313t-musllinux_1_2_aarch64.whl", hash = "sha256:b95574d06aa9d2bd6e5cc35a5bbe35696342c96760b69dc4287dbd5abd4ad51d", size = 251535 }, + { url = "https://files.pythonhosted.org/packages/78/3b/6d3ae3c1cc05f1b0460c51e6f6dcf567598cbd7c6121e5ad06643974703c/coverage-7.6.12-cp313-cp313t-musllinux_1_2_i686.whl", hash = "sha256:ecea0c38c9079570163d663c0433a9af4094a60aafdca491c6a3d248c7432827", size = 249192 }, + { url = "https://files.pythonhosted.org/packages/6e/8e/c14a79f535ce41af7d436bbad0d3d90c43d9e38ec409b4770c894031422e/coverage-7.6.12-cp313-cp313t-musllinux_1_2_x86_64.whl", hash = "sha256:2251fabcfee0a55a8578a9d29cecfee5f2de02f11530e7d5c5a05859aa85aee9", size = 250627 }, + { url = "https://files.pythonhosted.org/packages/cb/79/b7cee656cfb17a7f2c1b9c3cee03dd5d8000ca299ad4038ba64b61a9b044/coverage-7.6.12-cp313-cp313t-win32.whl", hash = "sha256:eb5507795caabd9b2ae3f1adc95f67b1104971c22c624bb354232d65c4fc90b3", size = 212033 }, + { url = "https://files.pythonhosted.org/packages/b6/c3/f7aaa3813f1fa9a4228175a7bd368199659d392897e184435a3b66408dd3/coverage-7.6.12-cp313-cp313t-win_amd64.whl", hash = "sha256:f60a297c3987c6c02ffb29effc70eadcbb412fe76947d394a1091a3615948e2f", size = 213240 }, + { url = "https://files.pythonhosted.org/packages/fb/b2/f655700e1024dec98b10ebaafd0cedbc25e40e4abe62a3c8e2ceef4f8f0a/coverage-7.6.12-py3-none-any.whl", hash = "sha256:eb8668cfbc279a536c633137deeb9435d2962caec279c3f8cf8b91fff6ff8953", size = 200552 }, +] + +[package.optional-dependencies] +toml = [ + { name = "tomli", marker = "python_full_version <= '3.11'" }, +] + +[[package]] +name = "crewai" +version = "0.102.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "appdirs" }, + { name = "auth0-python" }, + { name = "blinker" }, + { name = "chromadb" }, + { name = "click" }, + { name = "instructor" }, + { name = "json-repair" }, + { name = "json5" }, + { name = "jsonref" }, + { name = "litellm" }, + { name = "openai" }, + { name = "openpyxl" }, + { name = "opentelemetry-api" }, + { name = "opentelemetry-exporter-otlp-proto-http" }, + { name = "opentelemetry-sdk" }, + { name = "pdfplumber" }, + { name = "pydantic" }, + { name = "python-dotenv" }, + { name = "pyvis" }, + { name = "regex" }, + { name = "tomli" }, + { name = "tomli-w" }, + { name = "uv" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/a1/c8/9605444f3a2025537b54b044572925fb381fdfd3595a77306cc175b23f68/crewai-0.102.0.tar.gz", hash = "sha256:da3c10a126d1176265e1a649a00c2c462e947c91090595d05bd6b7d04e56bc74", size = 25259089 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/b0/15/47cb5ff6d5eb286377b312d8d9ed0a3c1472bef41ec90bafffaf285b80e3/crewai-0.102.0-py3-none-any.whl", hash = "sha256:af9ce144fa48cb0314946b509b0d415f01af3066fa2cfb42f27e05df3fb6539e", size = 240224 }, +] + +[[package]] +name = "cryptography" +version = "44.0.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "cffi", marker = "platform_python_implementation != 'PyPy'" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/c7/67/545c79fe50f7af51dbad56d16b23fe33f63ee6a5d956b3cb68ea110cbe64/cryptography-44.0.1.tar.gz", hash = "sha256:f51f5705ab27898afda1aaa430f34ad90dc117421057782022edf0600bec5f14", size = 710819 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/72/27/5e3524053b4c8889da65cf7814a9d0d8514a05194a25e1e34f46852ee6eb/cryptography-44.0.1-cp37-abi3-macosx_10_9_universal2.whl", hash = "sha256:bf688f615c29bfe9dfc44312ca470989279f0e94bb9f631f85e3459af8efc009", size = 6642022 }, + { url = "https://files.pythonhosted.org/packages/34/b9/4d1fa8d73ae6ec350012f89c3abfbff19fc95fe5420cf972e12a8d182986/cryptography-44.0.1-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:dd7c7e2d71d908dc0f8d2027e1604102140d84b155e658c20e8ad1304317691f", size = 3943865 }, + { url = "https://files.pythonhosted.org/packages/6e/57/371a9f3f3a4500807b5fcd29fec77f418ba27ffc629d88597d0d1049696e/cryptography-44.0.1-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:887143b9ff6bad2b7570da75a7fe8bbf5f65276365ac259a5d2d5147a73775f2", size = 4162562 }, + { url = "https://files.pythonhosted.org/packages/c5/1d/5b77815e7d9cf1e3166988647f336f87d5634a5ccecec2ffbe08ef8dd481/cryptography-44.0.1-cp37-abi3-manylinux_2_28_aarch64.whl", hash = "sha256:322eb03ecc62784536bc173f1483e76747aafeb69c8728df48537eb431cd1911", size = 3951923 }, + { url = "https://files.pythonhosted.org/packages/28/01/604508cd34a4024467cd4105887cf27da128cba3edd435b54e2395064bfb/cryptography-44.0.1-cp37-abi3-manylinux_2_28_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:21377472ca4ada2906bc313168c9dc7b1d7ca417b63c1c3011d0c74b7de9ae69", size = 3685194 }, + { url = "https://files.pythonhosted.org/packages/c6/3d/d3c55d4f1d24580a236a6753902ef6d8aafd04da942a1ee9efb9dc8fd0cb/cryptography-44.0.1-cp37-abi3-manylinux_2_28_x86_64.whl", hash = "sha256:df978682c1504fc93b3209de21aeabf2375cb1571d4e61907b3e7a2540e83026", size = 4187790 }, + { url = "https://files.pythonhosted.org/packages/ea/a6/44d63950c8588bfa8594fd234d3d46e93c3841b8e84a066649c566afb972/cryptography-44.0.1-cp37-abi3-manylinux_2_34_aarch64.whl", hash = "sha256:eb3889330f2a4a148abead555399ec9a32b13b7c8ba969b72d8e500eb7ef84cd", size = 3951343 }, + { url = "https://files.pythonhosted.org/packages/c1/17/f5282661b57301204cbf188254c1a0267dbd8b18f76337f0a7ce1038888c/cryptography-44.0.1-cp37-abi3-manylinux_2_34_x86_64.whl", hash = "sha256:8e6a85a93d0642bd774460a86513c5d9d80b5c002ca9693e63f6e540f1815ed0", size = 4187127 }, + { url = "https://files.pythonhosted.org/packages/f3/68/abbae29ed4f9d96596687f3ceea8e233f65c9645fbbec68adb7c756bb85a/cryptography-44.0.1-cp37-abi3-musllinux_1_2_aarch64.whl", hash = "sha256:6f76fdd6fd048576a04c5210d53aa04ca34d2ed63336d4abd306d0cbe298fddf", size = 4070666 }, + { url = "https://files.pythonhosted.org/packages/0f/10/cf91691064a9e0a88ae27e31779200b1505d3aee877dbe1e4e0d73b4f155/cryptography-44.0.1-cp37-abi3-musllinux_1_2_x86_64.whl", hash = "sha256:6c8acf6f3d1f47acb2248ec3ea261171a671f3d9428e34ad0357148d492c7864", size = 4288811 }, + { url = "https://files.pythonhosted.org/packages/38/78/74ea9eb547d13c34e984e07ec8a473eb55b19c1451fe7fc8077c6a4b0548/cryptography-44.0.1-cp37-abi3-win32.whl", hash = "sha256:24979e9f2040c953a94bf3c6782e67795a4c260734e5264dceea65c8f4bae64a", size = 2771882 }, + { url = "https://files.pythonhosted.org/packages/cf/6c/3907271ee485679e15c9f5e93eac6aa318f859b0aed8d369afd636fafa87/cryptography-44.0.1-cp37-abi3-win_amd64.whl", hash = "sha256:fd0ee90072861e276b0ff08bd627abec29e32a53b2be44e41dbcdf87cbee2b00", size = 3206989 }, + { url = "https://files.pythonhosted.org/packages/9f/f1/676e69c56a9be9fd1bffa9bc3492366901f6e1f8f4079428b05f1414e65c/cryptography-44.0.1-cp39-abi3-macosx_10_9_universal2.whl", hash = "sha256:a2d8a7045e1ab9b9f803f0d9531ead85f90c5f2859e653b61497228b18452008", size = 6643714 }, + { url = "https://files.pythonhosted.org/packages/ba/9f/1775600eb69e72d8f9931a104120f2667107a0ee478f6ad4fe4001559345/cryptography-44.0.1-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:b8272f257cf1cbd3f2e120f14c68bff2b6bdfcc157fafdee84a1b795efd72862", size = 3943269 }, + { url = "https://files.pythonhosted.org/packages/25/ba/e00d5ad6b58183829615be7f11f55a7b6baa5a06910faabdc9961527ba44/cryptography-44.0.1-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:1e8d181e90a777b63f3f0caa836844a1182f1f265687fac2115fcf245f5fbec3", size = 4166461 }, + { url = "https://files.pythonhosted.org/packages/b3/45/690a02c748d719a95ab08b6e4decb9d81e0ec1bac510358f61624c86e8a3/cryptography-44.0.1-cp39-abi3-manylinux_2_28_aarch64.whl", hash = "sha256:436df4f203482f41aad60ed1813811ac4ab102765ecae7a2bbb1dbb66dcff5a7", size = 3950314 }, + { url = "https://files.pythonhosted.org/packages/e6/50/bf8d090911347f9b75adc20f6f6569ed6ca9b9bff552e6e390f53c2a1233/cryptography-44.0.1-cp39-abi3-manylinux_2_28_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:4f422e8c6a28cf8b7f883eb790695d6d45b0c385a2583073f3cec434cc705e1a", size = 3686675 }, + { url = "https://files.pythonhosted.org/packages/e1/e7/cfb18011821cc5f9b21efb3f94f3241e3a658d267a3bf3a0f45543858ed8/cryptography-44.0.1-cp39-abi3-manylinux_2_28_x86_64.whl", hash = "sha256:72198e2b5925155497a5a3e8c216c7fb3e64c16ccee11f0e7da272fa93b35c4c", size = 4190429 }, + { url = "https://files.pythonhosted.org/packages/07/ef/77c74d94a8bfc1a8a47b3cafe54af3db537f081742ee7a8a9bd982b62774/cryptography-44.0.1-cp39-abi3-manylinux_2_34_aarch64.whl", hash = "sha256:2a46a89ad3e6176223b632056f321bc7de36b9f9b93b2cc1cccf935a3849dc62", size = 3950039 }, + { url = "https://files.pythonhosted.org/packages/6d/b9/8be0ff57c4592382b77406269b1e15650c9f1a167f9e34941b8515b97159/cryptography-44.0.1-cp39-abi3-manylinux_2_34_x86_64.whl", hash = "sha256:53f23339864b617a3dfc2b0ac8d5c432625c80014c25caac9082314e9de56f41", size = 4189713 }, + { url = "https://files.pythonhosted.org/packages/78/e1/4b6ac5f4100545513b0847a4d276fe3c7ce0eacfa73e3b5ebd31776816ee/cryptography-44.0.1-cp39-abi3-musllinux_1_2_aarch64.whl", hash = "sha256:888fcc3fce0c888785a4876ca55f9f43787f4c5c1cc1e2e0da71ad481ff82c5b", size = 4071193 }, + { url = "https://files.pythonhosted.org/packages/3d/cb/afff48ceaed15531eab70445abe500f07f8f96af2bb35d98af6bfa89ebd4/cryptography-44.0.1-cp39-abi3-musllinux_1_2_x86_64.whl", hash = "sha256:00918d859aa4e57db8299607086f793fa7813ae2ff5a4637e318a25ef82730f7", size = 4289566 }, + { url = "https://files.pythonhosted.org/packages/30/6f/4eca9e2e0f13ae459acd1ca7d9f0257ab86e68f44304847610afcb813dc9/cryptography-44.0.1-cp39-abi3-win32.whl", hash = "sha256:9b336599e2cb77b1008cb2ac264b290803ec5e8e89d618a5e978ff5eb6f715d9", size = 2772371 }, + { url = "https://files.pythonhosted.org/packages/d2/05/5533d30f53f10239616a357f080892026db2d550a40c393d0a8a7af834a9/cryptography-44.0.1-cp39-abi3-win_amd64.whl", hash = "sha256:e403f7f766ded778ecdb790da786b418a9f2394f36e8cc8b796cc056ab05f44f", size = 3207303 }, +] + +[[package]] +name = "decorator" +version = "5.1.1" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/66/0c/8d907af351aa16b42caae42f9d6aa37b900c67308052d10fdce809f8d952/decorator-5.1.1.tar.gz", hash = "sha256:637996211036b6385ef91435e4fae22989472f9d571faba8927ba8253acbc330", size = 35016 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/d5/50/83c593b07763e1161326b3b8c6686f0f4b0f24d5526546bee538c89837d6/decorator-5.1.1-py3-none-any.whl", hash = "sha256:b8c3f85900b9dc423225913c5aace94729fe1fa9763b38939a95226f02d37186", size = 9073 }, +] + +[[package]] +name = "deprecated" +version = "1.2.18" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "wrapt" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/98/97/06afe62762c9a8a86af0cfb7bfdab22a43ad17138b07af5b1a58442690a2/deprecated-1.2.18.tar.gz", hash = "sha256:422b6f6d859da6f2ef57857761bfb392480502a64c3028ca9bbe86085d72115d", size = 2928744 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/6e/c6/ac0b6c1e2d138f1002bcf799d330bd6d85084fece321e662a14223794041/Deprecated-1.2.18-py2.py3-none-any.whl", hash = "sha256:bd5011788200372a32418f888e326a09ff80d0214bd961147cfed01b5c018eec", size = 9998 }, +] + [[package]] name = "distlib" version = "0.3.9" @@ -144,6 +618,56 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/12/b3/231ffd4ab1fc9d679809f356cebee130ac7daa00d6d6f3206dd4fd137e9e/distro-1.9.0-py3-none-any.whl", hash = "sha256:7bffd925d65168f85027d8da9af6bddab658135b840670a223589bc0c8ef02b2", size = 20277 }, ] +[[package]] +name = "docstring-parser" +version = "0.16" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/08/12/9c22a58c0b1e29271051222d8906257616da84135af9ed167c9e28f85cb3/docstring_parser-0.16.tar.gz", hash = "sha256:538beabd0af1e2db0146b6bd3caa526c35a34d61af9fd2887f3a8a27a739aa6e", size = 26565 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/d5/7c/e9fcff7623954d86bdc17782036cbf715ecab1bec4847c008557affe1ca8/docstring_parser-0.16-py3-none-any.whl", hash = "sha256:bf0a1387354d3691d102edef7ec124f219ef639982d096e26e3b60aeffa90637", size = 36533 }, +] + +[[package]] +name = "durationpy" +version = "0.9" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/31/e9/f49c4e7fccb77fa5c43c2480e09a857a78b41e7331a75e128ed5df45c56b/durationpy-0.9.tar.gz", hash = "sha256:fd3feb0a69a0057d582ef643c355c40d2fa1c942191f914d12203b1a01ac722a", size = 3186 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/4c/a3/ac312faeceffd2d8f86bc6dcb5c401188ba5a01bc88e69bed97578a0dfcd/durationpy-0.9-py3-none-any.whl", hash = "sha256:e65359a7af5cedad07fb77a2dd3f390f8eb0b74cb845589fa6c057086834dd38", size = 3461 }, +] + +[[package]] +name = "et-xmlfile" +version = "2.0.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/d3/38/af70d7ab1ae9d4da450eeec1fa3918940a5fafb9055e934af8d6eb0c2313/et_xmlfile-2.0.0.tar.gz", hash = "sha256:dab3f4764309081ce75662649be815c4c9081e88f0837825f90fd28317d4da54", size = 17234 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/c1/8b/5fe2cc11fee489817272089c4203e679c63b570a5aaeb18d852ae3cbba6a/et_xmlfile-2.0.0-py3-none-any.whl", hash = "sha256:7a91720bc756843502c3b7504c77b8fe44217c85c537d85037f0f536151b2caa", size = 18059 }, +] + +[[package]] +name = "executing" +version = "2.2.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/91/50/a9d80c47ff289c611ff12e63f7c5d13942c65d68125160cefd768c73e6e4/executing-2.2.0.tar.gz", hash = "sha256:5d108c028108fe2551d1a7b2e8b713341e2cb4fc0aa7dcf966fa4327a5226755", size = 978693 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/7b/8f/c4d9bafc34ad7ad5d8dc16dd1347ee0e507a52c3adb6bfa8887e1c6a26ba/executing-2.2.0-py2.py3-none-any.whl", hash = "sha256:11387150cad388d62750327a53d3339fad4888b39a6fe233c3afbb54ecffd3aa", size = 26702 }, +] + +[[package]] +name = "fastapi" +version = "0.115.8" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "pydantic" }, + { name = "starlette" }, + { name = "typing-extensions" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/a2/b2/5a5dc4affdb6661dea100324e19a7721d5dc524b464fe8e366c093fd7d87/fastapi-0.115.8.tar.gz", hash = "sha256:0ce9111231720190473e222cdf0f07f7206ad7e53ea02beb1d2dc36e2f0741e9", size = 295403 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/8f/7d/2d6ce181d7a5f51dedb8c06206cbf0ec026a99bf145edd309f9e17c3282f/fastapi-0.115.8-py3-none-any.whl", hash = "sha256:753a96dd7e036b34eeef8babdfcfe3f28ff79648f86551eb36bfc1b0bf4a8cbf", size = 94814 }, +] + [[package]] name = "filelock" version = "3.17.0" @@ -153,6 +677,78 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/89/ec/00d68c4ddfedfe64159999e5f8a98fb8442729a63e2077eb9dcd89623d27/filelock-3.17.0-py3-none-any.whl", hash = "sha256:533dc2f7ba78dc2f0f531fc6c4940addf7b70a481e269a5a3b93be94ffbe8338", size = 16164 }, ] +[[package]] +name = "flatbuffers" +version = "25.2.10" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/e4/30/eb5dce7994fc71a2f685d98ec33cc660c0a5887db5610137e60d8cbc4489/flatbuffers-25.2.10.tar.gz", hash = "sha256:97e451377a41262f8d9bd4295cc836133415cc03d8cb966410a4af92eb00d26e", size = 22170 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/b8/25/155f9f080d5e4bc0082edfda032ea2bc2b8fab3f4d25d46c1e9dd22a1a89/flatbuffers-25.2.10-py2.py3-none-any.whl", hash = "sha256:ebba5f4d5ea615af3f7fd70fc310636fbb2bbd1f566ac0a23d98dd412de50051", size = 30953 }, +] + +[[package]] +name = "frozenlist" +version = "1.5.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/8f/ed/0f4cec13a93c02c47ec32d81d11c0c1efbadf4a471e3f3ce7cad366cbbd3/frozenlist-1.5.0.tar.gz", hash = "sha256:81d5af29e61b9c8348e876d442253723928dce6433e0e76cd925cd83f1b4b817", size = 39930 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/79/43/0bed28bf5eb1c9e4301003b74453b8e7aa85fb293b31dde352aac528dafc/frozenlist-1.5.0-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:fd74520371c3c4175142d02a976aee0b4cb4a7cc912a60586ffd8d5929979b30", size = 94987 }, + { url = "https://files.pythonhosted.org/packages/bb/bf/b74e38f09a246e8abbe1e90eb65787ed745ccab6eaa58b9c9308e052323d/frozenlist-1.5.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:2f3f7a0fbc219fb4455264cae4d9f01ad41ae6ee8524500f381de64ffaa077d5", size = 54584 }, + { url = "https://files.pythonhosted.org/packages/2c/31/ab01375682f14f7613a1ade30149f684c84f9b8823a4391ed950c8285656/frozenlist-1.5.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:f47c9c9028f55a04ac254346e92977bf0f166c483c74b4232bee19a6697e4778", size = 52499 }, + { url = "https://files.pythonhosted.org/packages/98/a8/d0ac0b9276e1404f58fec3ab6e90a4f76b778a49373ccaf6a563f100dfbc/frozenlist-1.5.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0996c66760924da6e88922756d99b47512a71cfd45215f3570bf1e0b694c206a", size = 276357 }, + { url = "https://files.pythonhosted.org/packages/ad/c9/c7761084fa822f07dac38ac29f841d4587570dd211e2262544aa0b791d21/frozenlist-1.5.0-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a2fe128eb4edeabe11896cb6af88fca5346059f6c8d807e3b910069f39157869", size = 287516 }, + { url = "https://files.pythonhosted.org/packages/a1/ff/cd7479e703c39df7bdab431798cef89dc75010d8aa0ca2514c5b9321db27/frozenlist-1.5.0-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:1a8ea951bbb6cacd492e3948b8da8c502a3f814f5d20935aae74b5df2b19cf3d", size = 283131 }, + { url = "https://files.pythonhosted.org/packages/59/a0/370941beb47d237eca4fbf27e4e91389fd68699e6f4b0ebcc95da463835b/frozenlist-1.5.0-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:de537c11e4aa01d37db0d403b57bd6f0546e71a82347a97c6a9f0dcc532b3a45", size = 261320 }, + { url = "https://files.pythonhosted.org/packages/b8/5f/c10123e8d64867bc9b4f2f510a32042a306ff5fcd7e2e09e5ae5100ee333/frozenlist-1.5.0-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9c2623347b933fcb9095841f1cc5d4ff0b278addd743e0e966cb3d460278840d", size = 274877 }, + { url = "https://files.pythonhosted.org/packages/fa/79/38c505601ae29d4348f21706c5d89755ceded02a745016ba2f58bd5f1ea6/frozenlist-1.5.0-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:cee6798eaf8b1416ef6909b06f7dc04b60755206bddc599f52232606e18179d3", size = 269592 }, + { url = "https://files.pythonhosted.org/packages/19/e2/39f3a53191b8204ba9f0bb574b926b73dd2efba2a2b9d2d730517e8f7622/frozenlist-1.5.0-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:f5f9da7f5dbc00a604fe74aa02ae7c98bcede8a3b8b9666f9f86fc13993bc71a", size = 265934 }, + { url = "https://files.pythonhosted.org/packages/d5/c9/3075eb7f7f3a91f1a6b00284af4de0a65a9ae47084930916f5528144c9dd/frozenlist-1.5.0-cp311-cp311-musllinux_1_2_ppc64le.whl", hash = "sha256:90646abbc7a5d5c7c19461d2e3eeb76eb0b204919e6ece342feb6032c9325ae9", size = 283859 }, + { url = "https://files.pythonhosted.org/packages/05/f5/549f44d314c29408b962fa2b0e69a1a67c59379fb143b92a0a065ffd1f0f/frozenlist-1.5.0-cp311-cp311-musllinux_1_2_s390x.whl", hash = "sha256:bdac3c7d9b705d253b2ce370fde941836a5f8b3c5c2b8fd70940a3ea3af7f4f2", size = 287560 }, + { url = "https://files.pythonhosted.org/packages/9d/f8/cb09b3c24a3eac02c4c07a9558e11e9e244fb02bf62c85ac2106d1eb0c0b/frozenlist-1.5.0-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:03d33c2ddbc1816237a67f66336616416e2bbb6beb306e5f890f2eb22b959cdf", size = 277150 }, + { url = "https://files.pythonhosted.org/packages/37/48/38c2db3f54d1501e692d6fe058f45b6ad1b358d82cd19436efab80cfc965/frozenlist-1.5.0-cp311-cp311-win32.whl", hash = "sha256:237f6b23ee0f44066219dae14c70ae38a63f0440ce6750f868ee08775073f942", size = 45244 }, + { url = "https://files.pythonhosted.org/packages/ca/8c/2ddffeb8b60a4bce3b196c32fcc30d8830d4615e7b492ec2071da801b8ad/frozenlist-1.5.0-cp311-cp311-win_amd64.whl", hash = "sha256:0cc974cc93d32c42e7b0f6cf242a6bd941c57c61b618e78b6c0a96cb72788c1d", size = 51634 }, + { url = "https://files.pythonhosted.org/packages/79/73/fa6d1a96ab7fd6e6d1c3500700963eab46813847f01ef0ccbaa726181dd5/frozenlist-1.5.0-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:31115ba75889723431aa9a4e77d5f398f5cf976eea3bdf61749731f62d4a4a21", size = 94026 }, + { url = "https://files.pythonhosted.org/packages/ab/04/ea8bf62c8868b8eada363f20ff1b647cf2e93377a7b284d36062d21d81d1/frozenlist-1.5.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:7437601c4d89d070eac8323f121fcf25f88674627505334654fd027b091db09d", size = 54150 }, + { url = "https://files.pythonhosted.org/packages/d0/9a/8e479b482a6f2070b26bda572c5e6889bb3ba48977e81beea35b5ae13ece/frozenlist-1.5.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:7948140d9f8ece1745be806f2bfdf390127cf1a763b925c4a805c603df5e697e", size = 51927 }, + { url = "https://files.pythonhosted.org/packages/e3/12/2aad87deb08a4e7ccfb33600871bbe8f0e08cb6d8224371387f3303654d7/frozenlist-1.5.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:feeb64bc9bcc6b45c6311c9e9b99406660a9c05ca8a5b30d14a78555088b0b3a", size = 282647 }, + { url = "https://files.pythonhosted.org/packages/77/f2/07f06b05d8a427ea0060a9cef6e63405ea9e0d761846b95ef3fb3be57111/frozenlist-1.5.0-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:683173d371daad49cffb8309779e886e59c2f369430ad28fe715f66d08d4ab1a", size = 289052 }, + { url = "https://files.pythonhosted.org/packages/bd/9f/8bf45a2f1cd4aa401acd271b077989c9267ae8463e7c8b1eb0d3f561b65e/frozenlist-1.5.0-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:7d57d8f702221405a9d9b40f9da8ac2e4a1a8b5285aac6100f3393675f0a85ee", size = 291719 }, + { url = "https://files.pythonhosted.org/packages/41/d1/1f20fd05a6c42d3868709b7604c9f15538a29e4f734c694c6bcfc3d3b935/frozenlist-1.5.0-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:30c72000fbcc35b129cb09956836c7d7abf78ab5416595e4857d1cae8d6251a6", size = 267433 }, + { url = "https://files.pythonhosted.org/packages/af/f2/64b73a9bb86f5a89fb55450e97cd5c1f84a862d4ff90d9fd1a73ab0f64a5/frozenlist-1.5.0-cp312-cp312-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:000a77d6034fbad9b6bb880f7ec073027908f1b40254b5d6f26210d2dab1240e", size = 283591 }, + { url = "https://files.pythonhosted.org/packages/29/e2/ffbb1fae55a791fd6c2938dd9ea779509c977435ba3940b9f2e8dc9d5316/frozenlist-1.5.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:5d7f5a50342475962eb18b740f3beecc685a15b52c91f7d975257e13e029eca9", size = 273249 }, + { url = "https://files.pythonhosted.org/packages/2e/6e/008136a30798bb63618a114b9321b5971172a5abddff44a100c7edc5ad4f/frozenlist-1.5.0-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:87f724d055eb4785d9be84e9ebf0f24e392ddfad00b3fe036e43f489fafc9039", size = 271075 }, + { url = "https://files.pythonhosted.org/packages/ae/f0/4e71e54a026b06724cec9b6c54f0b13a4e9e298cc8db0f82ec70e151f5ce/frozenlist-1.5.0-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:6e9080bb2fb195a046e5177f10d9d82b8a204c0736a97a153c2466127de87784", size = 285398 }, + { url = "https://files.pythonhosted.org/packages/4d/36/70ec246851478b1c0b59f11ef8ade9c482ff447c1363c2bd5fad45098b12/frozenlist-1.5.0-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:9b93d7aaa36c966fa42efcaf716e6b3900438632a626fb09c049f6a2f09fc631", size = 294445 }, + { url = "https://files.pythonhosted.org/packages/37/e0/47f87544055b3349b633a03c4d94b405956cf2437f4ab46d0928b74b7526/frozenlist-1.5.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:52ef692a4bc60a6dd57f507429636c2af8b6046db8b31b18dac02cbc8f507f7f", size = 280569 }, + { url = "https://files.pythonhosted.org/packages/f9/7c/490133c160fb6b84ed374c266f42800e33b50c3bbab1652764e6e1fc498a/frozenlist-1.5.0-cp312-cp312-win32.whl", hash = "sha256:29d94c256679247b33a3dc96cce0f93cbc69c23bf75ff715919332fdbb6a32b8", size = 44721 }, + { url = "https://files.pythonhosted.org/packages/b1/56/4e45136ffc6bdbfa68c29ca56ef53783ef4c2fd395f7cbf99a2624aa9aaa/frozenlist-1.5.0-cp312-cp312-win_amd64.whl", hash = "sha256:8969190d709e7c48ea386db202d708eb94bdb29207a1f269bab1196ce0dcca1f", size = 51329 }, + { url = "https://files.pythonhosted.org/packages/da/3b/915f0bca8a7ea04483622e84a9bd90033bab54bdf485479556c74fd5eaf5/frozenlist-1.5.0-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:7a1a048f9215c90973402e26c01d1cff8a209e1f1b53f72b95c13db61b00f953", size = 91538 }, + { url = "https://files.pythonhosted.org/packages/c7/d1/a7c98aad7e44afe5306a2b068434a5830f1470675f0e715abb86eb15f15b/frozenlist-1.5.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:dd47a5181ce5fcb463b5d9e17ecfdb02b678cca31280639255ce9d0e5aa67af0", size = 52849 }, + { url = "https://files.pythonhosted.org/packages/3a/c8/76f23bf9ab15d5f760eb48701909645f686f9c64fbb8982674c241fbef14/frozenlist-1.5.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:1431d60b36d15cda188ea222033eec8e0eab488f39a272461f2e6d9e1a8e63c2", size = 50583 }, + { url = "https://files.pythonhosted.org/packages/1f/22/462a3dd093d11df623179d7754a3b3269de3b42de2808cddef50ee0f4f48/frozenlist-1.5.0-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6482a5851f5d72767fbd0e507e80737f9c8646ae7fd303def99bfe813f76cf7f", size = 265636 }, + { url = "https://files.pythonhosted.org/packages/80/cf/e075e407fc2ae7328155a1cd7e22f932773c8073c1fc78016607d19cc3e5/frozenlist-1.5.0-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:44c49271a937625619e862baacbd037a7ef86dd1ee215afc298a417ff3270608", size = 270214 }, + { url = "https://files.pythonhosted.org/packages/a1/58/0642d061d5de779f39c50cbb00df49682832923f3d2ebfb0fedf02d05f7f/frozenlist-1.5.0-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:12f78f98c2f1c2429d42e6a485f433722b0061d5c0b0139efa64f396efb5886b", size = 273905 }, + { url = "https://files.pythonhosted.org/packages/ab/66/3fe0f5f8f2add5b4ab7aa4e199f767fd3b55da26e3ca4ce2cc36698e50c4/frozenlist-1.5.0-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ce3aa154c452d2467487765e3adc730a8c153af77ad84096bc19ce19a2400840", size = 250542 }, + { url = "https://files.pythonhosted.org/packages/f6/b8/260791bde9198c87a465224e0e2bb62c4e716f5d198fc3a1dacc4895dbd1/frozenlist-1.5.0-cp313-cp313-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9b7dc0c4338e6b8b091e8faf0db3168a37101943e687f373dce00959583f7439", size = 267026 }, + { url = "https://files.pythonhosted.org/packages/2e/a4/3d24f88c527f08f8d44ade24eaee83b2627793fa62fa07cbb7ff7a2f7d42/frozenlist-1.5.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:45e0896250900b5aa25180f9aec243e84e92ac84bd4a74d9ad4138ef3f5c97de", size = 257690 }, + { url = "https://files.pythonhosted.org/packages/de/9a/d311d660420b2beeff3459b6626f2ab4fb236d07afbdac034a4371fe696e/frozenlist-1.5.0-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:561eb1c9579d495fddb6da8959fd2a1fca2c6d060d4113f5844b433fc02f2641", size = 253893 }, + { url = "https://files.pythonhosted.org/packages/c6/23/e491aadc25b56eabd0f18c53bb19f3cdc6de30b2129ee0bc39cd387cd560/frozenlist-1.5.0-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:df6e2f325bfee1f49f81aaac97d2aa757c7646534a06f8f577ce184afe2f0a9e", size = 267006 }, + { url = "https://files.pythonhosted.org/packages/08/c4/ab918ce636a35fb974d13d666dcbe03969592aeca6c3ab3835acff01f79c/frozenlist-1.5.0-cp313-cp313-musllinux_1_2_s390x.whl", hash = "sha256:140228863501b44b809fb39ec56b5d4071f4d0aa6d216c19cbb08b8c5a7eadb9", size = 276157 }, + { url = "https://files.pythonhosted.org/packages/c0/29/3b7a0bbbbe5a34833ba26f686aabfe982924adbdcafdc294a7a129c31688/frozenlist-1.5.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:7707a25d6a77f5d27ea7dc7d1fc608aa0a478193823f88511ef5e6b8a48f9d03", size = 264642 }, + { url = "https://files.pythonhosted.org/packages/ab/42/0595b3dbffc2e82d7fe658c12d5a5bafcd7516c6bf2d1d1feb5387caa9c1/frozenlist-1.5.0-cp313-cp313-win32.whl", hash = "sha256:31a9ac2b38ab9b5a8933b693db4939764ad3f299fcaa931a3e605bc3460e693c", size = 44914 }, + { url = "https://files.pythonhosted.org/packages/17/c4/b7db1206a3fea44bf3b838ca61deb6f74424a8a5db1dd53ecb21da669be6/frozenlist-1.5.0-cp313-cp313-win_amd64.whl", hash = "sha256:11aabdd62b8b9c4b84081a3c246506d1cddd2dd93ff0ad53ede5defec7886b28", size = 51167 }, + { url = "https://files.pythonhosted.org/packages/c6/c8/a5be5b7550c10858fcf9b0ea054baccab474da77d37f1e828ce043a3a5d4/frozenlist-1.5.0-py3-none-any.whl", hash = "sha256:d994863bba198a4a518b467bb971c56e1db3f180a25c6cf7bb1949c267f748c3", size = 11901 }, +] + +[[package]] +name = "fsspec" +version = "2025.2.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/b5/79/68612ed99700e6413de42895aa725463e821a6b3be75c87fcce1b4af4c70/fsspec-2025.2.0.tar.gz", hash = "sha256:1c24b16eaa0a1798afa0337aa0db9b256718ab2a89c425371f5628d22c3b6afd", size = 292283 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/e2/94/758680531a00d06e471ef649e4ec2ed6bf185356a7f9fbfbb7368a40bd49/fsspec-2025.2.0-py3-none-any.whl", hash = "sha256:9de2ad9ce1f85e1931858535bc882543171d197001a0a5eb2ddc04f1781ab95b", size = 184484 }, +] + [[package]] name = "ghp-import" version = "2.1.0" @@ -165,6 +761,67 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/f7/ec/67fbef5d497f86283db54c22eec6f6140243aae73265799baaaa19cd17fb/ghp_import-2.1.0-py3-none-any.whl", hash = "sha256:8337dd7b50877f163d4c0289bc1f1c7f127550241988d568c1db512c4324a619", size = 11034 }, ] +[[package]] +name = "google-auth" +version = "2.38.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "cachetools" }, + { name = "pyasn1-modules" }, + { name = "rsa" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/c6/eb/d504ba1daf190af6b204a9d4714d457462b486043744901a6eeea711f913/google_auth-2.38.0.tar.gz", hash = "sha256:8285113607d3b80a3f1543b75962447ba8a09fe85783432a784fdeef6ac094c4", size = 270866 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/9d/47/603554949a37bca5b7f894d51896a9c534b9eab808e2520a748e081669d0/google_auth-2.38.0-py2.py3-none-any.whl", hash = "sha256:e7dae6694313f434a2727bf2906f27ad259bae090d7aa896590d86feec3d9d4a", size = 210770 }, +] + +[[package]] +name = "googleapis-common-protos" +version = "1.68.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "protobuf" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/54/d2/c08f0d9f94b45faca68e355771329cba2411c777c8713924dd1baee0e09c/googleapis_common_protos-1.68.0.tar.gz", hash = "sha256:95d38161f4f9af0d9423eed8fb7b64ffd2568c3464eb542ff02c5bfa1953ab3c", size = 57367 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/3f/85/c99a157ee99d67cc6c9ad123abb8b1bfb476fab32d2f3511c59314548e4f/googleapis_common_protos-1.68.0-py2.py3-none-any.whl", hash = "sha256:aaf179b2f81df26dfadac95def3b16a95064c76a5f45f07e4c68a21bb371c4ac", size = 164985 }, +] + +[[package]] +name = "grpcio" +version = "1.70.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/69/e1/4b21b5017c33f3600dcc32b802bb48fe44a4d36d6c066f52650c7c2690fa/grpcio-1.70.0.tar.gz", hash = "sha256:8d1584a68d5922330025881e63a6c1b54cc8117291d382e4fa69339b6d914c56", size = 12788932 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/65/c4/1f67d23d6bcadd2fd61fb460e5969c52b3390b4a4e254b5e04a6d1009e5e/grpcio-1.70.0-cp311-cp311-linux_armv7l.whl", hash = "sha256:17325b0be0c068f35770f944124e8839ea3185d6d54862800fc28cc2ffad205a", size = 5229017 }, + { url = "https://files.pythonhosted.org/packages/e4/bd/cc36811c582d663a740fb45edf9f99ddbd99a10b6ba38267dc925e1e193a/grpcio-1.70.0-cp311-cp311-macosx_10_14_universal2.whl", hash = "sha256:dbe41ad140df911e796d4463168e33ef80a24f5d21ef4d1e310553fcd2c4a386", size = 11472027 }, + { url = "https://files.pythonhosted.org/packages/7e/32/8538bb2ace5cd72da7126d1c9804bf80b4fe3be70e53e2d55675c24961a8/grpcio-1.70.0-cp311-cp311-manylinux_2_17_aarch64.whl", hash = "sha256:5ea67c72101d687d44d9c56068328da39c9ccba634cabb336075fae2eab0d04b", size = 5707785 }, + { url = "https://files.pythonhosted.org/packages/ce/5c/a45f85f2a0dfe4a6429dee98717e0e8bd7bd3f604315493c39d9679ca065/grpcio-1.70.0-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:cb5277db254ab7586769e490b7b22f4ddab3876c490da0a1a9d7c695ccf0bf77", size = 6331599 }, + { url = "https://files.pythonhosted.org/packages/9f/e5/5316b239380b8b2ad30373eb5bb25d9fd36c0375e94a98a0a60ea357d254/grpcio-1.70.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e7831a0fc1beeeb7759f737f5acd9fdcda520e955049512d68fda03d91186eea", size = 5940834 }, + { url = "https://files.pythonhosted.org/packages/05/33/dbf035bc6d167068b4a9f2929dfe0b03fb763f0f861ecb3bb1709a14cb65/grpcio-1.70.0-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:27cc75e22c5dba1fbaf5a66c778e36ca9b8ce850bf58a9db887754593080d839", size = 6641191 }, + { url = "https://files.pythonhosted.org/packages/4c/c4/684d877517e5bfd6232d79107e5a1151b835e9f99051faef51fed3359ec4/grpcio-1.70.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:d63764963412e22f0491d0d32833d71087288f4e24cbcddbae82476bfa1d81fd", size = 6198744 }, + { url = "https://files.pythonhosted.org/packages/e9/43/92fe5eeaf340650a7020cfb037402c7b9209e7a0f3011ea1626402219034/grpcio-1.70.0-cp311-cp311-win32.whl", hash = "sha256:bb491125103c800ec209d84c9b51f1c60ea456038e4734688004f377cfacc113", size = 3617111 }, + { url = "https://files.pythonhosted.org/packages/55/15/b6cf2c9515c028aff9da6984761a3ab484a472b0dc6435fcd07ced42127d/grpcio-1.70.0-cp311-cp311-win_amd64.whl", hash = "sha256:d24035d49e026353eb042bf7b058fb831db3e06d52bee75c5f2f3ab453e71aca", size = 4304604 }, + { url = "https://files.pythonhosted.org/packages/4c/a4/ddbda79dd176211b518f0f3795af78b38727a31ad32bc149d6a7b910a731/grpcio-1.70.0-cp312-cp312-linux_armv7l.whl", hash = "sha256:ef4c14508299b1406c32bdbb9fb7b47612ab979b04cf2b27686ea31882387cff", size = 5198135 }, + { url = "https://files.pythonhosted.org/packages/30/5c/60eb8a063ea4cb8d7670af8fac3f2033230fc4b75f62669d67c66ac4e4b0/grpcio-1.70.0-cp312-cp312-macosx_10_14_universal2.whl", hash = "sha256:aa47688a65643afd8b166928a1da6247d3f46a2784d301e48ca1cc394d2ffb40", size = 11447529 }, + { url = "https://files.pythonhosted.org/packages/fb/b9/1bf8ab66729f13b44e8f42c9de56417d3ee6ab2929591cfee78dce749b57/grpcio-1.70.0-cp312-cp312-manylinux_2_17_aarch64.whl", hash = "sha256:880bfb43b1bb8905701b926274eafce5c70a105bc6b99e25f62e98ad59cb278e", size = 5664484 }, + { url = "https://files.pythonhosted.org/packages/d1/06/2f377d6906289bee066d96e9bdb91e5e96d605d173df9bb9856095cccb57/grpcio-1.70.0-cp312-cp312-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:9e654c4b17d07eab259d392e12b149c3a134ec52b11ecdc6a515b39aceeec898", size = 6303739 }, + { url = "https://files.pythonhosted.org/packages/ae/50/64c94cfc4db8d9ed07da71427a936b5a2bd2b27c66269b42fbda82c7c7a4/grpcio-1.70.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2394e3381071045a706ee2eeb6e08962dd87e8999b90ac15c55f56fa5a8c9597", size = 5910417 }, + { url = "https://files.pythonhosted.org/packages/53/89/8795dfc3db4389c15554eb1765e14cba8b4c88cc80ff828d02f5572965af/grpcio-1.70.0-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:b3c76701428d2df01964bc6479422f20e62fcbc0a37d82ebd58050b86926ef8c", size = 6626797 }, + { url = "https://files.pythonhosted.org/packages/9c/b2/6a97ac91042a2c59d18244c479ee3894e7fb6f8c3a90619bb5a7757fa30c/grpcio-1.70.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:ac073fe1c4cd856ebcf49e9ed6240f4f84d7a4e6ee95baa5d66ea05d3dd0df7f", size = 6190055 }, + { url = "https://files.pythonhosted.org/packages/86/2b/28db55c8c4d156053a8c6f4683e559cd0a6636f55a860f87afba1ac49a51/grpcio-1.70.0-cp312-cp312-win32.whl", hash = "sha256:cd24d2d9d380fbbee7a5ac86afe9787813f285e684b0271599f95a51bce33528", size = 3600214 }, + { url = "https://files.pythonhosted.org/packages/17/c3/a7a225645a965029ed432e5b5e9ed959a574e62100afab553eef58be0e37/grpcio-1.70.0-cp312-cp312-win_amd64.whl", hash = "sha256:0495c86a55a04a874c7627fd33e5beaee771917d92c0e6d9d797628ac40e7655", size = 4292538 }, + { url = "https://files.pythonhosted.org/packages/68/38/66d0f32f88feaf7d83f8559cd87d899c970f91b1b8a8819b58226de0a496/grpcio-1.70.0-cp313-cp313-linux_armv7l.whl", hash = "sha256:aa573896aeb7d7ce10b1fa425ba263e8dddd83d71530d1322fd3a16f31257b4a", size = 5199218 }, + { url = "https://files.pythonhosted.org/packages/c1/96/947df763a0b18efb5cc6c2ae348e56d97ca520dc5300c01617b234410173/grpcio-1.70.0-cp313-cp313-macosx_10_14_universal2.whl", hash = "sha256:d405b005018fd516c9ac529f4b4122342f60ec1cee181788249372524e6db429", size = 11445983 }, + { url = "https://files.pythonhosted.org/packages/fd/5b/f3d4b063e51b2454bedb828e41f3485800889a3609c49e60f2296cc8b8e5/grpcio-1.70.0-cp313-cp313-manylinux_2_17_aarch64.whl", hash = "sha256:f32090238b720eb585248654db8e3afc87b48d26ac423c8dde8334a232ff53c9", size = 5663954 }, + { url = "https://files.pythonhosted.org/packages/bd/0b/dab54365fcedf63e9f358c1431885478e77d6f190d65668936b12dd38057/grpcio-1.70.0-cp313-cp313-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:dfa089a734f24ee5f6880c83d043e4f46bf812fcea5181dcb3a572db1e79e01c", size = 6304323 }, + { url = "https://files.pythonhosted.org/packages/76/a8/8f965a7171ddd336ce32946e22954aa1bbc6f23f095e15dadaa70604ba20/grpcio-1.70.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f19375f0300b96c0117aca118d400e76fede6db6e91f3c34b7b035822e06c35f", size = 5910939 }, + { url = "https://files.pythonhosted.org/packages/1b/05/0bbf68be8b17d1ed6f178435a3c0c12e665a1e6054470a64ce3cb7896596/grpcio-1.70.0-cp313-cp313-musllinux_1_1_i686.whl", hash = "sha256:7c73c42102e4a5ec76608d9b60227d917cea46dff4d11d372f64cbeb56d259d0", size = 6631405 }, + { url = "https://files.pythonhosted.org/packages/79/6a/5df64b6df405a1ed1482cb6c10044b06ec47fd28e87c2232dbcf435ecb33/grpcio-1.70.0-cp313-cp313-musllinux_1_1_x86_64.whl", hash = "sha256:0a5c78d5198a1f0aa60006cd6eb1c912b4a1520b6a3968e677dbcba215fabb40", size = 6190982 }, + { url = "https://files.pythonhosted.org/packages/42/aa/aeaac87737e6d25d1048c53b8ec408c056d3ed0c922e7c5efad65384250c/grpcio-1.70.0-cp313-cp313-win32.whl", hash = "sha256:fe9dbd916df3b60e865258a8c72ac98f3ac9e2a9542dcb72b7a34d236242a5ce", size = 3598359 }, + { url = "https://files.pythonhosted.org/packages/1f/79/8edd2442d2de1431b4a3de84ef91c37002f12de0f9b577fb07b452989dbc/grpcio-1.70.0-cp313-cp313-win_amd64.whl", hash = "sha256:4119fed8abb7ff6c32e3d2255301e59c316c22d31ab812b3fbcbaf3d0d87cc68", size = 4293938 }, +] + [[package]] name = "h11" version = "0.14.0" @@ -187,19 +844,79 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/87/f5/72347bc88306acb359581ac4d52f23c0ef445b57157adedb9aee0cd689d2/httpcore-1.0.7-py3-none-any.whl", hash = "sha256:a3fff8f43dc260d5bd363d9f9cf1830fa3a458b332856f34282de498ed420edd", size = 78551 }, ] +[[package]] +name = "httptools" +version = "0.6.4" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/a7/9a/ce5e1f7e131522e6d3426e8e7a490b3a01f39a6696602e1c4f33f9e94277/httptools-0.6.4.tar.gz", hash = "sha256:4e93eee4add6493b59a5c514da98c939b244fce4a0d8879cd3f466562f4b7d5c", size = 240639 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/7b/26/bb526d4d14c2774fe07113ca1db7255737ffbb119315839af2065abfdac3/httptools-0.6.4-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:f47f8ed67cc0ff862b84a1189831d1d33c963fb3ce1ee0c65d3b0cbe7b711069", size = 199029 }, + { url = "https://files.pythonhosted.org/packages/a6/17/3e0d3e9b901c732987a45f4f94d4e2c62b89a041d93db89eafb262afd8d5/httptools-0.6.4-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:0614154d5454c21b6410fdf5262b4a3ddb0f53f1e1721cfd59d55f32138c578a", size = 103492 }, + { url = "https://files.pythonhosted.org/packages/b7/24/0fe235d7b69c42423c7698d086d4db96475f9b50b6ad26a718ef27a0bce6/httptools-0.6.4-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f8787367fbdfccae38e35abf7641dafc5310310a5987b689f4c32cc8cc3ee975", size = 462891 }, + { url = "https://files.pythonhosted.org/packages/b1/2f/205d1f2a190b72da6ffb5f41a3736c26d6fa7871101212b15e9b5cd8f61d/httptools-0.6.4-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:40b0f7fe4fd38e6a507bdb751db0379df1e99120c65fbdc8ee6c1d044897a636", size = 459788 }, + { url = "https://files.pythonhosted.org/packages/6e/4c/d09ce0eff09057a206a74575ae8f1e1e2f0364d20e2442224f9e6612c8b9/httptools-0.6.4-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:40a5ec98d3f49904b9fe36827dcf1aadfef3b89e2bd05b0e35e94f97c2b14721", size = 433214 }, + { url = "https://files.pythonhosted.org/packages/3e/d2/84c9e23edbccc4a4c6f96a1b8d99dfd2350289e94f00e9ccc7aadde26fb5/httptools-0.6.4-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:dacdd3d10ea1b4ca9df97a0a303cbacafc04b5cd375fa98732678151643d4988", size = 434120 }, + { url = "https://files.pythonhosted.org/packages/d0/46/4d8e7ba9581416de1c425b8264e2cadd201eb709ec1584c381f3e98f51c1/httptools-0.6.4-cp311-cp311-win_amd64.whl", hash = "sha256:288cd628406cc53f9a541cfaf06041b4c71d751856bab45e3702191f931ccd17", size = 88565 }, + { url = "https://files.pythonhosted.org/packages/bb/0e/d0b71465c66b9185f90a091ab36389a7352985fe857e352801c39d6127c8/httptools-0.6.4-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:df017d6c780287d5c80601dafa31f17bddb170232d85c066604d8558683711a2", size = 200683 }, + { url = "https://files.pythonhosted.org/packages/e2/b8/412a9bb28d0a8988de3296e01efa0bd62068b33856cdda47fe1b5e890954/httptools-0.6.4-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:85071a1e8c2d051b507161f6c3e26155b5c790e4e28d7f236422dbacc2a9cc44", size = 104337 }, + { url = "https://files.pythonhosted.org/packages/9b/01/6fb20be3196ffdc8eeec4e653bc2a275eca7f36634c86302242c4fbb2760/httptools-0.6.4-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:69422b7f458c5af875922cdb5bd586cc1f1033295aa9ff63ee196a87519ac8e1", size = 508796 }, + { url = "https://files.pythonhosted.org/packages/f7/d8/b644c44acc1368938317d76ac991c9bba1166311880bcc0ac297cb9d6bd7/httptools-0.6.4-cp312-cp312-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:16e603a3bff50db08cd578d54f07032ca1631450ceb972c2f834c2b860c28ea2", size = 510837 }, + { url = "https://files.pythonhosted.org/packages/52/d8/254d16a31d543073a0e57f1c329ca7378d8924e7e292eda72d0064987486/httptools-0.6.4-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:ec4f178901fa1834d4a060320d2f3abc5c9e39766953d038f1458cb885f47e81", size = 485289 }, + { url = "https://files.pythonhosted.org/packages/5f/3c/4aee161b4b7a971660b8be71a92c24d6c64372c1ab3ae7f366b3680df20f/httptools-0.6.4-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:f9eb89ecf8b290f2e293325c646a211ff1c2493222798bb80a530c5e7502494f", size = 489779 }, + { url = "https://files.pythonhosted.org/packages/12/b7/5cae71a8868e555f3f67a50ee7f673ce36eac970f029c0c5e9d584352961/httptools-0.6.4-cp312-cp312-win_amd64.whl", hash = "sha256:db78cb9ca56b59b016e64b6031eda5653be0589dba2b1b43453f6e8b405a0970", size = 88634 }, + { url = "https://files.pythonhosted.org/packages/94/a3/9fe9ad23fd35f7de6b91eeb60848986058bd8b5a5c1e256f5860a160cc3e/httptools-0.6.4-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:ade273d7e767d5fae13fa637f4d53b6e961fb7fd93c7797562663f0171c26660", size = 197214 }, + { url = "https://files.pythonhosted.org/packages/ea/d9/82d5e68bab783b632023f2fa31db20bebb4e89dfc4d2293945fd68484ee4/httptools-0.6.4-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:856f4bc0478ae143bad54a4242fccb1f3f86a6e1be5548fecfd4102061b3a083", size = 102431 }, + { url = "https://files.pythonhosted.org/packages/96/c1/cb499655cbdbfb57b577734fde02f6fa0bbc3fe9fb4d87b742b512908dff/httptools-0.6.4-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:322d20ea9cdd1fa98bd6a74b77e2ec5b818abdc3d36695ab402a0de8ef2865a3", size = 473121 }, + { url = "https://files.pythonhosted.org/packages/af/71/ee32fd358f8a3bb199b03261f10921716990808a675d8160b5383487a317/httptools-0.6.4-cp313-cp313-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4d87b29bd4486c0093fc64dea80231f7c7f7eb4dc70ae394d70a495ab8436071", size = 473805 }, + { url = "https://files.pythonhosted.org/packages/8a/0a/0d4df132bfca1507114198b766f1737d57580c9ad1cf93c1ff673e3387be/httptools-0.6.4-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:342dd6946aa6bda4b8f18c734576106b8a31f2fe31492881a9a160ec84ff4bd5", size = 448858 }, + { url = "https://files.pythonhosted.org/packages/1e/6a/787004fdef2cabea27bad1073bf6a33f2437b4dbd3b6fb4a9d71172b1c7c/httptools-0.6.4-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:4b36913ba52008249223042dca46e69967985fb4051951f94357ea681e1f5dc0", size = 452042 }, + { url = "https://files.pythonhosted.org/packages/4d/dc/7decab5c404d1d2cdc1bb330b1bf70e83d6af0396fd4fc76fc60c0d522bf/httptools-0.6.4-cp313-cp313-win_amd64.whl", hash = "sha256:28908df1b9bb8187393d5b5db91435ccc9c8e891657f9cbb42a2541b44c82fc8", size = 87682 }, +] + [[package]] name = "httpx" -version = "0.28.1" +version = "0.27.2" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "anyio" }, { name = "certifi" }, { name = "httpcore" }, { name = "idna" }, + { name = "sniffio" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/78/82/08f8c936781f67d9e6b9eeb8a0c8b4e406136ea4c3d1f89a5db71d42e0e6/httpx-0.27.2.tar.gz", hash = "sha256:f7c2be1d2f3c3c3160d441802406b206c2b76f5947b11115e6df10c6c65e66c2", size = 144189 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/56/95/9377bcb415797e44274b51d46e3249eba641711cf3348050f76ee7b15ffc/httpx-0.27.2-py3-none-any.whl", hash = "sha256:7bb2708e112d8fdd7829cd4243970f0c223274051cb35ee80c03301ee29a3df0", size = 76395 }, +] + +[[package]] +name = "huggingface-hub" +version = "0.29.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "filelock" }, + { name = "fsspec" }, + { name = "packaging" }, + { name = "pyyaml" }, + { name = "requests" }, + { name = "tqdm" }, + { name = "typing-extensions" }, ] -sdist = { url = "https://files.pythonhosted.org/packages/b1/df/48c586a5fe32a0f01324ee087459e112ebb7224f646c0b5023f5e79e9956/httpx-0.28.1.tar.gz", hash = "sha256:75e98c5f16b0f35b567856f597f06ff2270a374470a5c2392242528e3e3e42fc", size = 141406 } +sdist = { url = "https://files.pythonhosted.org/packages/22/37/797d6476f13e5ef6af5fc48a5d641d32b39c37e166ccf40c3714c5854a85/huggingface_hub-0.29.1.tar.gz", hash = "sha256:9524eae42077b8ff4fc459ceb7a514eca1c1232b775276b009709fe2a084f250", size = 389776 } wheels = [ - { url = "https://files.pythonhosted.org/packages/2a/39/e50c7c3a983047577ee07d2a9e53faf5a69493943ec3f6a384bdc792deb2/httpx-0.28.1-py3-none-any.whl", hash = "sha256:d909fcccc110f8c7faf814ca82a9a4d816bc5a6dbfea25d6591d6985b8ba59ad", size = 73517 }, + { url = "https://files.pythonhosted.org/packages/ae/05/75b90de9093de0aadafc868bb2fa7c57651fd8f45384adf39bd77f63980d/huggingface_hub-0.29.1-py3-none-any.whl", hash = "sha256:352f69caf16566c7b6de84b54a822f6238e17ddd8ae3da4f8f2272aea5b198d5", size = 468049 }, +] + +[[package]] +name = "humanfriendly" +version = "10.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "pyreadline3", marker = "sys_platform == 'win32'" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/cc/3f/2c29224acb2e2df4d2046e4c73ee2662023c58ff5b113c4c1adac0886c43/humanfriendly-10.0.tar.gz", hash = "sha256:6b0b831ce8f15f7300721aa49829fc4e83921a9a301cc7f606be6686a2288ddc", size = 360702 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/f0/0f/310fb31e39e2d734ccaa2c0fb981ee41f7bd5056ce9bc29b2248bd569169/humanfriendly-10.0-py2.py3-none-any.whl", hash = "sha256:1697e1a8a8f550fd43c2865cd84542fc175a61dcb779b6fee18cf6b6ccba1477", size = 86794 }, ] [[package]] @@ -220,6 +937,27 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/76/c6/c88e154df9c4e1a2a66ccf0005a88dfb2650c1dffb6f5ce603dfbd452ce3/idna-3.10-py3-none-any.whl", hash = "sha256:946d195a0d259cbba61165e88e65941f16e9b36ea6ddb97f00452bae8b1287d3", size = 70442 }, ] +[[package]] +name = "importlib-metadata" +version = "8.5.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "zipp" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/cd/12/33e59336dca5be0c398a7482335911a33aa0e20776128f038019f1a95f1b/importlib_metadata-8.5.0.tar.gz", hash = "sha256:71522656f0abace1d072b9e5481a48f07c138e00f079c38c8f883823f9c26bd7", size = 55304 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/a0/d9/a1e041c5e7caa9a05c925f4bdbdfb7f006d1f74996af53467bc394c97be7/importlib_metadata-8.5.0-py3-none-any.whl", hash = "sha256:45e54197d28b7a7f1559e60b95e7c567032b602131fbd588f1497f47880aa68b", size = 26514 }, +] + +[[package]] +name = "importlib-resources" +version = "6.5.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/cf/8c/f834fbf984f691b4f7ff60f50b514cc3de5cc08abfc3295564dd89c5e2e7/importlib_resources-6.5.2.tar.gz", hash = "sha256:185f87adef5bcc288449d98fb4fba07cea78bc036455dd44c5fc4a2fe78fed2c", size = 44693 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/a4/ed/1f1afb2e9e7f38a545d628f864d562a5ae64fe6f7a10e28ffb9b185b4e89/importlib_resources-6.5.2-py3-none-any.whl", hash = "sha256:789cfdc3ed28c78b67a06acb8126751ced69a3d5f79c095a98298cd8a760ccec", size = 37461 }, +] + [[package]] name = "iniconfig" version = "2.0.0" @@ -229,6 +967,61 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/ef/a6/62565a6e1cf69e10f5727360368e451d4b7f58beeac6173dc9db836a5b46/iniconfig-2.0.0-py3-none-any.whl", hash = "sha256:b6a85871a79d2e3b22d2d1b94ac2824226a63c6b741c88f7ae975f18b6778374", size = 5892 }, ] +[[package]] +name = "instructor" +version = "1.7.2" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "aiohttp" }, + { name = "docstring-parser" }, + { name = "jinja2" }, + { name = "jiter" }, + { name = "openai" }, + { name = "pydantic" }, + { name = "pydantic-core" }, + { name = "requests" }, + { name = "rich" }, + { name = "tenacity" }, + { name = "typer" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/63/ba/692739c76959191aa7e5f0fccda871b36548355f4a09c8733687e64e62b0/instructor-1.7.2.tar.gz", hash = "sha256:6c01b2b159766df24865dc81f7bf8457cbda88a3c0bbc810da3467d19b185ed2", size = 66200177 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/c5/82/fd319382c1a33d7021cf151007b4cbd5daddf09d9ca5fb670e476668f9fc/instructor-1.7.2-py3-none-any.whl", hash = "sha256:cb43d27f6d7631c31762b936b2fcb44d2a3f9d8a020430a0f4d3484604ffb95b", size = 71353 }, +] + +[[package]] +name = "ipython" +version = "8.32.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "colorama", marker = "sys_platform == 'win32'" }, + { name = "decorator" }, + { name = "jedi" }, + { name = "matplotlib-inline" }, + { name = "pexpect", marker = "sys_platform != 'emscripten' and sys_platform != 'win32'" }, + { name = "prompt-toolkit" }, + { name = "pygments" }, + { name = "stack-data" }, + { name = "traitlets" }, + { name = "typing-extensions", marker = "python_full_version < '3.12'" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/36/80/4d2a072e0db7d250f134bc11676517299264ebe16d62a8619d49a78ced73/ipython-8.32.0.tar.gz", hash = "sha256:be2c91895b0b9ea7ba49d33b23e2040c352b33eb6a519cca7ce6e0c743444251", size = 5507441 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/e7/e1/f4474a7ecdb7745a820f6f6039dc43c66add40f1bcc66485607d93571af6/ipython-8.32.0-py3-none-any.whl", hash = "sha256:cae85b0c61eff1fc48b0a8002de5958b6528fa9c8defb1894da63f42613708aa", size = 825524 }, +] + +[[package]] +name = "jedi" +version = "0.19.2" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "parso" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/72/3a/79a912fbd4d8dd6fbb02bf69afd3bb72cf0c729bb3063c6f4498603db17a/jedi-0.19.2.tar.gz", hash = "sha256:4770dc3de41bde3966b02eb84fbcf557fb33cce26ad23da12c742fb50ecb11f0", size = 1231287 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/c0/5a/9cac0c82afec3d09ccd97c8b6502d48f165f9124db81b4bcb90b4af974ee/jedi-0.19.2-py2.py3-none-any.whl", hash = "sha256:a8ef22bde8490f57fe5c7681a3c83cb58874daf72b4784de3cce5b6ef6edb5b9", size = 1572278 }, +] + [[package]] name = "jinja2" version = "3.1.5" @@ -288,6 +1081,183 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/91/61/c80ef80ed8a0a21158e289ef70dac01e351d929a1c30cb0f49be60772547/jiter-0.8.2-cp313-cp313t-win_amd64.whl", hash = "sha256:3ac9f578c46f22405ff7f8b1f5848fb753cc4b8377fbec8470a7dc3997ca7566", size = 202374 }, ] +[[package]] +name = "json-repair" +version = "0.39.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/64/85/fa2ce65badf050ca26ffcd28bf8b9747933344184aaad66ff7c2e1e3431b/json_repair-0.39.0.tar.gz", hash = "sha256:d6fb9817e60d923d887814a78b5c174250b542c4b03ea548071b5acdfa8c1408", size = 30032 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/21/41/63020f3e888cc3792f3e88c837526a0fa0bc85b2327764426589369b9631/json_repair-0.39.0-py3-none-any.whl", hash = "sha256:a17838801dc2cbaa967ef3ee69ea8b0379819fec320e7e53fd062fda55080e76", size = 20712 }, +] + +[[package]] +name = "json5" +version = "0.10.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/85/3d/bbe62f3d0c05a689c711cff57b2e3ac3d3e526380adb7c781989f075115c/json5-0.10.0.tar.gz", hash = "sha256:e66941c8f0a02026943c52c2eb34ebeb2a6f819a0be05920a6f5243cd30fd559", size = 48202 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/aa/42/797895b952b682c3dafe23b1834507ee7f02f4d6299b65aaa61425763278/json5-0.10.0-py3-none-any.whl", hash = "sha256:19b23410220a7271e8377f81ba8aacba2fdd56947fbb137ee5977cbe1f5e8dfa", size = 34049 }, +] + +[[package]] +name = "jsonpatch" +version = "1.33" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "jsonpointer" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/42/78/18813351fe5d63acad16aec57f94ec2b70a09e53ca98145589e185423873/jsonpatch-1.33.tar.gz", hash = "sha256:9fcd4009c41e6d12348b4a0ff2563ba56a2923a7dfee731d004e212e1ee5030c", size = 21699 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/73/07/02e16ed01e04a374e644b575638ec7987ae846d25ad97bcc9945a3ee4b0e/jsonpatch-1.33-py2.py3-none-any.whl", hash = "sha256:0ae28c0cd062bbd8b8ecc26d7d164fbbea9652a1a3693f3b956c1eae5145dade", size = 12898 }, +] + +[[package]] +name = "jsonpickle" +version = "4.0.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/2c/6f/e73cb91f774ad1077929a29b3a4af6e5603beb446cb99a55debe240664c3/jsonpickle-4.0.2.tar.gz", hash = "sha256:3e650b9853adcdab9d9d62a88412b6d36e9a59ba423b01cacf0cd4ee80733aca", size = 315121 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/5e/c8/e9dc0af97ce006616abbd7f522d0b45ac322a77f72bb29d901b5114a49ba/jsonpickle-4.0.2-py3-none-any.whl", hash = "sha256:cd3c90d32a68dcaa7f0e4b918bda7d4bb61f3c03b182d82dae2caf9ded0ab6b3", size = 46325 }, +] + +[[package]] +name = "jsonpointer" +version = "3.0.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/6a/0a/eebeb1fa92507ea94016a2a790b93c2ae41a7e18778f85471dc54475ed25/jsonpointer-3.0.0.tar.gz", hash = "sha256:2b2d729f2091522d61c3b31f82e11870f60b68f43fbc705cb76bf4b832af59ef", size = 9114 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/71/92/5e77f98553e9e75130c78900d000368476aed74276eb8ae8796f65f00918/jsonpointer-3.0.0-py2.py3-none-any.whl", hash = "sha256:13e088adc14fca8b6aa8177c044e12701e6ad4b28ff10e65f2267a90109c9942", size = 7595 }, +] + +[[package]] +name = "jsonref" +version = "1.1.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/aa/0d/c1f3277e90ccdb50d33ed5ba1ec5b3f0a242ed8c1b1a85d3afeb68464dca/jsonref-1.1.0.tar.gz", hash = "sha256:32fe8e1d85af0fdefbebce950af85590b22b60f9e95443176adbde4e1ecea552", size = 8814 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/0c/ec/e1db9922bceb168197a558a2b8c03a7963f1afe93517ddd3cf99f202f996/jsonref-1.1.0-py3-none-any.whl", hash = "sha256:590dc7773df6c21cbf948b5dac07a72a251db28b0238ceecce0a2abfa8ec30a9", size = 9425 }, +] + +[[package]] +name = "jsonschema" +version = "4.23.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "attrs" }, + { name = "jsonschema-specifications" }, + { name = "referencing" }, + { name = "rpds-py" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/38/2e/03362ee4034a4c917f697890ccd4aec0800ccf9ded7f511971c75451deec/jsonschema-4.23.0.tar.gz", hash = "sha256:d71497fef26351a33265337fa77ffeb82423f3ea21283cd9467bb03999266bc4", size = 325778 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/69/4a/4f9dbeb84e8850557c02365a0eee0649abe5eb1d84af92a25731c6c0f922/jsonschema-4.23.0-py3-none-any.whl", hash = "sha256:fbadb6f8b144a8f8cf9f0b89ba94501d143e50411a1278633f56a7acf7fd5566", size = 88462 }, +] + +[[package]] +name = "jsonschema-specifications" +version = "2024.10.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "referencing" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/10/db/58f950c996c793472e336ff3655b13fbcf1e3b359dcf52dcf3ed3b52c352/jsonschema_specifications-2024.10.1.tar.gz", hash = "sha256:0f38b83639958ce1152d02a7f062902c41c8fd20d558b0c34344292d417ae272", size = 15561 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/d1/0f/8910b19ac0670a0f80ce1008e5e751c4a57e14d2c4c13a482aa6079fa9d6/jsonschema_specifications-2024.10.1-py3-none-any.whl", hash = "sha256:a09a0680616357d9a0ecf05c12ad234479f549239d0f5b55f3deea67475da9bf", size = 18459 }, +] + +[[package]] +name = "kubernetes" +version = "32.0.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "certifi" }, + { name = "durationpy" }, + { name = "google-auth" }, + { name = "oauthlib" }, + { name = "python-dateutil" }, + { name = "pyyaml" }, + { name = "requests" }, + { name = "requests-oauthlib" }, + { name = "six" }, + { name = "urllib3" }, + { name = "websocket-client" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/b7/e8/0598f0e8b4af37cd9b10d8b87386cf3173cb8045d834ab5f6ec347a758b3/kubernetes-32.0.1.tar.gz", hash = "sha256:42f43d49abd437ada79a79a16bd48a604d3471a117a8347e87db693f2ba0ba28", size = 946691 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/08/10/9f8af3e6f569685ce3af7faab51c8dd9d93b9c38eba339ca31c746119447/kubernetes-32.0.1-py2.py3-none-any.whl", hash = "sha256:35282ab8493b938b08ab5526c7ce66588232df00ef5e1dbe88a419107dc10998", size = 1988070 }, +] + +[[package]] +name = "langchain-core" +version = "0.3.37" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "jsonpatch" }, + { name = "langsmith" }, + { name = "packaging" }, + { name = "pydantic" }, + { name = "pyyaml" }, + { name = "tenacity" }, + { name = "typing-extensions" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/86/1d/692541c2ff9d8d7c847638f1244bddbb773c984fbfbe1728ad5f100222b7/langchain_core-0.3.37.tar.gz", hash = "sha256:cda8786e616caa2f68f7cc9e811b9b50e3b63fb2094333318b348e5961a7ea01", size = 527209 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/6a/f5/9ce2a94bc49b64c0bf53b17524d5fc5c926070e911b11d489979d47d5491/langchain_core-0.3.37-py3-none-any.whl", hash = "sha256:8202fd6506ce139a3a1b1c4c3006216b1c7fffa40bdd1779f7d2c67f75eb5f79", size = 413717 }, +] + +[[package]] +name = "langchain-openai" +version = "0.3.6" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "langchain-core" }, + { name = "openai" }, + { name = "tiktoken" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/72/67/4c2f371315bd1dd1163f3d1d48d271649e5c4b81b1982c38db3761b883a5/langchain_openai-0.3.6.tar.gz", hash = "sha256:7daf92e1cd98865ab5213ec5bec2cbd6c28f011e250714978b3a99c7e4fc88ce", size = 255792 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/b5/49/302754c09f955e4a240efe83e48f4e79149d50ca52b3f4731365f1be94b1/langchain_openai-0.3.6-py3-none-any.whl", hash = "sha256:05f0869f6cc963e2ec9e2e54ea1038d9c2af784c67f0e217040dfc918b31649a", size = 54930 }, +] + +[[package]] +name = "langsmith" +version = "0.3.9" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "httpx" }, + { name = "orjson", marker = "platform_python_implementation != 'PyPy'" }, + { name = "pydantic" }, + { name = "requests" }, + { name = "requests-toolbelt" }, + { name = "zstandard" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/1f/71/9ea14534d991f6c428472be8786b9916b9ccb52a853eaac3b798f9af9f68/langsmith-0.3.9.tar.gz", hash = "sha256:460e70d349282cf8d7d503cdf16684db58061d12a6a512daf626257a3218e0fb", size = 321625 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/87/23/b1e5545c863348f81a9f6d8b12c8bacb17f1ec0e09be3e46481f24ae3d3c/langsmith-0.3.9-py3-none-any.whl", hash = "sha256:0e250cca50d1142d8bb00528da573c83bef1c41d78de43b2c032f8d11a308d04", size = 333002 }, +] + +[[package]] +name = "litellm" +version = "1.60.2" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "aiohttp" }, + { name = "click" }, + { name = "httpx" }, + { name = "importlib-metadata" }, + { name = "jinja2" }, + { name = "jsonschema" }, + { name = "openai" }, + { name = "pydantic" }, + { name = "python-dotenv" }, + { name = "tiktoken" }, + { name = "tokenizers" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/94/8f/704cdb0fdbdd49dc5062a39ae5f1a8f308ae0ffd746df6e0137fc1776b8a/litellm-1.60.2.tar.gz", hash = "sha256:a8170584fcfd6f5175201d869e61ccd8a40ffe3264fc5e53c5b805ddf8a6e05a", size = 6447447 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/8a/ba/0eaec9aee9f99fdf46ef1c0bddcfe7f5720b182f84f6ed27f13145d5ded2/litellm-1.60.2-py3-none-any.whl", hash = "sha256:1cb08cda04bf8c5ef3e690171a779979e4b16a5e3a24cd8dc1f198e7f198d5c4", size = 6746809 }, +] + [[package]] name = "markdown" version = "3.7" @@ -297,6 +1267,18 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/3f/08/83871f3c50fc983b88547c196d11cf8c3340e37c32d2e9d6152abe2c61f7/Markdown-3.7-py3-none-any.whl", hash = "sha256:7eb6df5690b81a1d7942992c97fad2938e956e79df20cbc6186e9c3a77b1c803", size = 106349 }, ] +[[package]] +name = "markdown-it-py" +version = "3.0.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "mdurl" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/38/71/3b932df36c1a044d397a1f92d1cf91ee0a503d91e470cbd670aa66b07ed0/markdown-it-py-3.0.0.tar.gz", hash = "sha256:e3f60a94fa066dc52ec76661e37c851cb232d92f9886b15cb560aaada2df8feb", size = 74596 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/42/d7/1ec15b46af6af88f19b8e5ffea08fa375d433c998b8a7639e76935c14f1f/markdown_it_py-3.0.0-py3-none-any.whl", hash = "sha256:355216845c60bd96232cd8d8c40e8f9765cc86f46880e43a8fd22dc1a1a8cab1", size = 87528 }, +] + [[package]] name = "markupsafe" version = "3.0.2" @@ -345,6 +1327,27 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/4f/65/6079a46068dfceaeabb5dcad6d674f5f5c61a6fa5673746f42a9f4c233b3/MarkupSafe-3.0.2-cp313-cp313t-win_amd64.whl", hash = "sha256:e444a31f8db13eb18ada366ab3cf45fd4b31e4db1236a4448f68778c1d1a5a2f", size = 15739 }, ] +[[package]] +name = "matplotlib-inline" +version = "0.1.7" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "traitlets" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/99/5b/a36a337438a14116b16480db471ad061c36c3694df7c2084a0da7ba538b7/matplotlib_inline-0.1.7.tar.gz", hash = "sha256:8423b23ec666be3d16e16b60bdd8ac4e86e840ebd1dd11a30b9f117f2fa0ab90", size = 8159 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/8f/8e/9ad090d3553c280a8060fbf6e24dc1c0c29704ee7d1c372f0c174aa59285/matplotlib_inline-0.1.7-py3-none-any.whl", hash = "sha256:df192d39a4ff8f21b1895d72e6a13f5fcc5099f00fa84384e0ea28c2cc0653ca", size = 9899 }, +] + +[[package]] +name = "mdurl" +version = "0.1.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/d6/54/cfe61301667036ec958cb99bd3efefba235e65cdeb9c84d24a8293ba1d90/mdurl-0.1.2.tar.gz", hash = "sha256:bb413d29f5eea38f31dd4754dd7377d4465116fb207585f97bf925588687c1ba", size = 8729 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/b3/38/89ba8ad64ae25be8de66a6d463314cf1eb366222074cfda9ee839c56a4b4/mdurl-0.1.2-py3-none-any.whl", hash = "sha256:84008a41e51615a49fc9966191ff91509e3c40b939176e643fd50a5c2196b8f8", size = 9979 }, +] + [[package]] name = "mergedeep" version = "1.3.4" @@ -423,6 +1426,134 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/5b/54/662a4743aa81d9582ee9339d4ffa3c8fd40a4965e033d77b9da9774d3960/mkdocs_material_extensions-1.3.1-py3-none-any.whl", hash = "sha256:adff8b62700b25cb77b53358dad940f3ef973dd6db797907c49e3c2ef3ab4e31", size = 8728 }, ] +[[package]] +name = "mmh3" +version = "5.1.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/47/1b/1fc6888c74cbd8abad1292dde2ddfcf8fc059e114c97dd6bf16d12f36293/mmh3-5.1.0.tar.gz", hash = "sha256:136e1e670500f177f49ec106a4ebf0adf20d18d96990cc36ea492c651d2b406c", size = 33728 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/56/09/fda7af7fe65928262098382e3bf55950cfbf67d30bf9e47731bf862161e9/mmh3-5.1.0-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:0b529dcda3f951ff363a51d5866bc6d63cf57f1e73e8961f864ae5010647079d", size = 56098 }, + { url = "https://files.pythonhosted.org/packages/0c/ab/84c7bc3f366d6f3bd8b5d9325a10c367685bc17c26dac4c068e2001a4671/mmh3-5.1.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:4db1079b3ace965e562cdfc95847312f9273eb2ad3ebea983435c8423e06acd7", size = 40513 }, + { url = "https://files.pythonhosted.org/packages/4f/21/25ea58ca4a652bdc83d1528bec31745cce35802381fb4fe3c097905462d2/mmh3-5.1.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:22d31e3a0ff89b8eb3b826d6fc8e19532998b2aa6b9143698043a1268da413e1", size = 40112 }, + { url = "https://files.pythonhosted.org/packages/bd/78/4f12f16ae074ddda6f06745254fdb50f8cf3c85b0bbf7eaca58bed84bf58/mmh3-5.1.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2139bfbd354cd6cb0afed51c4b504f29bcd687a3b1460b7e89498329cc28a894", size = 102632 }, + { url = "https://files.pythonhosted.org/packages/48/11/8f09dc999cf2a09b6138d8d7fc734efb7b7bfdd9adb9383380941caadff0/mmh3-5.1.0-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:8c8105c6a435bc2cd6ea2ef59558ab1a2976fd4a4437026f562856d08996673a", size = 108884 }, + { url = "https://files.pythonhosted.org/packages/bd/91/e59a66538a3364176f6c3f7620eee0ab195bfe26f89a95cbcc7a1fb04b28/mmh3-5.1.0-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:57730067174a7f36fcd6ce012fe359bd5510fdaa5fe067bc94ed03e65dafb769", size = 106835 }, + { url = "https://files.pythonhosted.org/packages/25/14/b85836e21ab90e5cddb85fe79c494ebd8f81d96a87a664c488cc9277668b/mmh3-5.1.0-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:bde80eb196d7fdc765a318604ded74a4378f02c5b46c17aa48a27d742edaded2", size = 93688 }, + { url = "https://files.pythonhosted.org/packages/ac/aa/8bc964067df9262740c95e4cde2d19f149f2224f426654e14199a9e47df6/mmh3-5.1.0-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e9c8eddcb441abddeb419c16c56fd74b3e2df9e57f7aa2903221996718435c7a", size = 101569 }, + { url = "https://files.pythonhosted.org/packages/70/b6/1fb163cbf919046a64717466c00edabebece3f95c013853fec76dbf2df92/mmh3-5.1.0-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:99e07e4acafbccc7a28c076a847fb060ffc1406036bc2005acb1b2af620e53c3", size = 98483 }, + { url = "https://files.pythonhosted.org/packages/70/49/ba64c050dd646060f835f1db6b2cd60a6485f3b0ea04976e7a29ace7312e/mmh3-5.1.0-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:9e25ba5b530e9a7d65f41a08d48f4b3fedc1e89c26486361166a5544aa4cad33", size = 96496 }, + { url = "https://files.pythonhosted.org/packages/9e/07/f2751d6a0b535bb865e1066e9c6b80852571ef8d61bce7eb44c18720fbfc/mmh3-5.1.0-cp311-cp311-musllinux_1_2_ppc64le.whl", hash = "sha256:bb9bf7475b4d99156ce2f0cf277c061a17560c8c10199c910a680869a278ddc7", size = 105109 }, + { url = "https://files.pythonhosted.org/packages/b7/02/30360a5a66f7abba44596d747cc1e6fb53136b168eaa335f63454ab7bb79/mmh3-5.1.0-cp311-cp311-musllinux_1_2_s390x.whl", hash = "sha256:2a1b0878dd281ea3003368ab53ff6f568e175f1b39f281df1da319e58a19c23a", size = 98231 }, + { url = "https://files.pythonhosted.org/packages/8c/60/8526b0c750ff4d7ae1266e68b795f14b97758a1d9fcc19f6ecabf9c55656/mmh3-5.1.0-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:25f565093ac8b8aefe0f61f8f95c9a9d11dd69e6a9e9832ff0d293511bc36258", size = 97548 }, + { url = "https://files.pythonhosted.org/packages/6d/4c/26e1222aca65769280d5427a1ce5875ef4213449718c8f03958d0bf91070/mmh3-5.1.0-cp311-cp311-win32.whl", hash = "sha256:1e3554d8792387eac73c99c6eaea0b3f884e7130eb67986e11c403e4f9b6d372", size = 40810 }, + { url = "https://files.pythonhosted.org/packages/98/d5/424ba95062d1212ea615dc8debc8d57983f2242d5e6b82e458b89a117a1e/mmh3-5.1.0-cp311-cp311-win_amd64.whl", hash = "sha256:8ad777a48197882492af50bf3098085424993ce850bdda406a358b6ab74be759", size = 41476 }, + { url = "https://files.pythonhosted.org/packages/bd/08/0315ccaf087ba55bb19a6dd3b1e8acd491e74ce7f5f9c4aaa06a90d66441/mmh3-5.1.0-cp311-cp311-win_arm64.whl", hash = "sha256:f29dc4efd99bdd29fe85ed6c81915b17b2ef2cf853abf7213a48ac6fb3eaabe1", size = 38880 }, + { url = "https://files.pythonhosted.org/packages/f4/47/e5f452bdf16028bfd2edb4e2e35d0441e4a4740f30e68ccd4cfd2fb2c57e/mmh3-5.1.0-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:45712987367cb9235026e3cbf4334670522a97751abfd00b5bc8bfa022c3311d", size = 56152 }, + { url = "https://files.pythonhosted.org/packages/60/38/2132d537dc7a7fdd8d2e98df90186c7fcdbd3f14f95502a24ba443c92245/mmh3-5.1.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:b1020735eb35086ab24affbea59bb9082f7f6a0ad517cb89f0fc14f16cea4dae", size = 40564 }, + { url = "https://files.pythonhosted.org/packages/c0/2a/c52cf000581bfb8d94794f58865658e7accf2fa2e90789269d4ae9560b16/mmh3-5.1.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:babf2a78ce5513d120c358722a2e3aa7762d6071cd10cede026f8b32452be322", size = 40104 }, + { url = "https://files.pythonhosted.org/packages/83/33/30d163ce538c54fc98258db5621447e3ab208d133cece5d2577cf913e708/mmh3-5.1.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d4f47f58cd5cbef968c84a7c1ddc192fef0a36b48b0b8a3cb67354531aa33b00", size = 102634 }, + { url = "https://files.pythonhosted.org/packages/94/5c/5a18acb6ecc6852be2d215c3d811aa61d7e425ab6596be940877355d7f3e/mmh3-5.1.0-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:2044a601c113c981f2c1e14fa33adc9b826c9017034fe193e9eb49a6882dbb06", size = 108888 }, + { url = "https://files.pythonhosted.org/packages/1f/f6/11c556324c64a92aa12f28e221a727b6e082e426dc502e81f77056f6fc98/mmh3-5.1.0-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:c94d999c9f2eb2da44d7c2826d3fbffdbbbbcde8488d353fee7c848ecc42b968", size = 106968 }, + { url = "https://files.pythonhosted.org/packages/5d/61/ca0c196a685aba7808a5c00246f17b988a9c4f55c594ee0a02c273e404f3/mmh3-5.1.0-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a015dcb24fa0c7a78f88e9419ac74f5001c1ed6a92e70fd1803f74afb26a4c83", size = 93771 }, + { url = "https://files.pythonhosted.org/packages/b4/55/0927c33528710085ee77b808d85bbbafdb91a1db7c8eaa89cac16d6c513e/mmh3-5.1.0-cp312-cp312-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:457da019c491a2d20e2022c7d4ce723675e4c081d9efc3b4d8b9f28a5ea789bd", size = 101726 }, + { url = "https://files.pythonhosted.org/packages/49/39/a92c60329fa470f41c18614a93c6cd88821412a12ee78c71c3f77e1cfc2d/mmh3-5.1.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:71408579a570193a4ac9c77344d68ddefa440b00468a0b566dcc2ba282a9c559", size = 98523 }, + { url = "https://files.pythonhosted.org/packages/81/90/26adb15345af8d9cf433ae1b6adcf12e0a4cad1e692de4fa9f8e8536c5ae/mmh3-5.1.0-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:8b3a04bc214a6e16c81f02f855e285c6df274a2084787eeafaa45f2fbdef1b63", size = 96628 }, + { url = "https://files.pythonhosted.org/packages/8a/4d/340d1e340df972a13fd4ec84c787367f425371720a1044220869c82364e9/mmh3-5.1.0-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:832dae26a35514f6d3c1e267fa48e8de3c7b978afdafa0529c808ad72e13ada3", size = 105190 }, + { url = "https://files.pythonhosted.org/packages/d3/7c/65047d1cccd3782d809936db446430fc7758bda9def5b0979887e08302a2/mmh3-5.1.0-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:bf658a61fc92ef8a48945ebb1076ef4ad74269e353fffcb642dfa0890b13673b", size = 98439 }, + { url = "https://files.pythonhosted.org/packages/72/d2/3c259d43097c30f062050f7e861075099404e8886b5d4dd3cebf180d6e02/mmh3-5.1.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:3313577453582b03383731b66447cdcdd28a68f78df28f10d275d7d19010c1df", size = 97780 }, + { url = "https://files.pythonhosted.org/packages/29/29/831ea8d4abe96cdb3e28b79eab49cac7f04f9c6b6e36bfc686197ddba09d/mmh3-5.1.0-cp312-cp312-win32.whl", hash = "sha256:1d6508504c531ab86c4424b5a5ff07c1132d063863339cf92f6657ff7a580f76", size = 40835 }, + { url = "https://files.pythonhosted.org/packages/12/dd/7cbc30153b73f08eeac43804c1dbc770538a01979b4094edbe1a4b8eb551/mmh3-5.1.0-cp312-cp312-win_amd64.whl", hash = "sha256:aa75981fcdf3f21759d94f2c81b6a6e04a49dfbcdad88b152ba49b8e20544776", size = 41509 }, + { url = "https://files.pythonhosted.org/packages/80/9d/627375bab4c90dd066093fc2c9a26b86f87e26d980dbf71667b44cbee3eb/mmh3-5.1.0-cp312-cp312-win_arm64.whl", hash = "sha256:a4c1a76808dfea47f7407a0b07aaff9087447ef6280716fd0783409b3088bb3c", size = 38888 }, + { url = "https://files.pythonhosted.org/packages/05/06/a098a42870db16c0a54a82c56a5bdc873de3165218cd5b3ca59dbc0d31a7/mmh3-5.1.0-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:7a523899ca29cfb8a5239618474a435f3d892b22004b91779fcb83504c0d5b8c", size = 56165 }, + { url = "https://files.pythonhosted.org/packages/5a/65/eaada79a67fde1f43e1156d9630e2fb70655e1d3f4e8f33d7ffa31eeacfd/mmh3-5.1.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:17cef2c3a6ca2391ca7171a35ed574b5dab8398163129a3e3a4c05ab85a4ff40", size = 40569 }, + { url = "https://files.pythonhosted.org/packages/36/7e/2b6c43ed48be583acd68e34d16f19209a9f210e4669421b0321e326d8554/mmh3-5.1.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:52e12895b30110f3d89dae59a888683cc886ed0472dd2eca77497edef6161997", size = 40104 }, + { url = "https://files.pythonhosted.org/packages/11/2b/1f9e962fdde8e41b0f43d22c8ba719588de8952f9376df7d73a434827590/mmh3-5.1.0-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e0d6719045cda75c3f40397fc24ab67b18e0cb8f69d3429ab4c39763c4c608dd", size = 102497 }, + { url = "https://files.pythonhosted.org/packages/46/94/d6c5c3465387ba077cccdc028ab3eec0d86eed1eebe60dcf4d15294056be/mmh3-5.1.0-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:d19fa07d303a91f8858982c37e6939834cb11893cb3ff20e6ee6fa2a7563826a", size = 108834 }, + { url = "https://files.pythonhosted.org/packages/34/1e/92c212bb81796b69dddfd50a8a8f4b26ab0d38fdaf1d3e8628a67850543b/mmh3-5.1.0-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:31b47a620d622fbde8ca1ca0435c5d25de0ac57ab507209245e918128e38e676", size = 106936 }, + { url = "https://files.pythonhosted.org/packages/f4/41/f2f494bbff3aad5ffd2085506255049de76cde51ddac84058e32768acc79/mmh3-5.1.0-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:00f810647c22c179b6821079f7aa306d51953ac893587ee09cf1afb35adf87cb", size = 93709 }, + { url = "https://files.pythonhosted.org/packages/9e/a9/a2cc4a756d73d9edf4fb85c76e16fd56b0300f8120fd760c76b28f457730/mmh3-5.1.0-cp313-cp313-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f6128b610b577eed1e89ac7177ab0c33d06ade2aba93f5c89306032306b5f1c6", size = 101623 }, + { url = "https://files.pythonhosted.org/packages/5e/6f/b9d735533b6a56b2d56333ff89be6a55ac08ba7ff33465feb131992e33eb/mmh3-5.1.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:1e550a45d2ff87a1c11b42015107f1778c93f4c6f8e731bf1b8fa770321b8cc4", size = 98521 }, + { url = "https://files.pythonhosted.org/packages/99/47/dff2b54fac0d421c1e6ecbd2d9c85b2d0e6f6ee0d10b115d9364116a511e/mmh3-5.1.0-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:785ae09276342f79fd8092633e2d52c0f7c44d56e8cfda8274ccc9b76612dba2", size = 96696 }, + { url = "https://files.pythonhosted.org/packages/be/43/9e205310f47c43ddf1575bb3a1769c36688f30f1ac105e0f0c878a29d2cd/mmh3-5.1.0-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:0f4be3703a867ef976434afd3661a33884abe73ceb4ee436cac49d3b4c2aaa7b", size = 105234 }, + { url = "https://files.pythonhosted.org/packages/6b/44/90b11fd2b67dcb513f5bfe9b476eb6ca2d5a221c79b49884dc859100905e/mmh3-5.1.0-cp313-cp313-musllinux_1_2_s390x.whl", hash = "sha256:e513983830c4ff1f205ab97152a0050cf7164f1b4783d702256d39c637b9d107", size = 98449 }, + { url = "https://files.pythonhosted.org/packages/f0/d0/25c4b0c7b8e49836541059b28e034a4cccd0936202800d43a1cc48495ecb/mmh3-5.1.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:b9135c300535c828c0bae311b659f33a31c941572eae278568d1a953c4a57b59", size = 97796 }, + { url = "https://files.pythonhosted.org/packages/23/fa/cbbb7fcd0e287a715f1cd28a10de94c0535bd94164e38b852abc18da28c6/mmh3-5.1.0-cp313-cp313-win32.whl", hash = "sha256:c65dbd12885a5598b70140d24de5839551af5a99b29f9804bb2484b29ef07692", size = 40828 }, + { url = "https://files.pythonhosted.org/packages/09/33/9fb90ef822f7b734955a63851907cf72f8a3f9d8eb3c5706bfa6772a2a77/mmh3-5.1.0-cp313-cp313-win_amd64.whl", hash = "sha256:10db7765201fc65003fa998faa067417ef6283eb5f9bba8f323c48fd9c33e91f", size = 41504 }, + { url = "https://files.pythonhosted.org/packages/16/71/4ad9a42f2772793a03cb698f0fc42499f04e6e8d2560ba2f7da0fb059a8e/mmh3-5.1.0-cp313-cp313-win_arm64.whl", hash = "sha256:b22fe2e54be81f6c07dcb36b96fa250fb72effe08aa52fbb83eade6e1e2d5fd7", size = 38890 }, +] + +[[package]] +name = "monotonic" +version = "1.6" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/ea/ca/8e91948b782ddfbd194f323e7e7d9ba12e5877addf04fb2bf8fca38e86ac/monotonic-1.6.tar.gz", hash = "sha256:3a55207bcfed53ddd5c5bae174524062935efed17792e9de2ad0205ce9ad63f7", size = 7615 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/9a/67/7e8406a29b6c45be7af7740456f7f37025f0506ae2e05fb9009a53946860/monotonic-1.6-py2.py3-none-any.whl", hash = "sha256:68687e19a14f11f26d140dd5c86f3dba4bf5df58003000ed467e0e2a69bca96c", size = 8154 }, +] + +[[package]] +name = "mpmath" +version = "1.3.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/e0/47/dd32fa426cc72114383ac549964eecb20ecfd886d1e5ccf5340b55b02f57/mpmath-1.3.0.tar.gz", hash = "sha256:7a28eb2a9774d00c7bc92411c19a89209d5da7c4c9a9e227be8330a23a25b91f", size = 508106 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/43/e3/7d92a15f894aa0c9c4b49b8ee9ac9850d6e63b03c9c32c0367a13ae62209/mpmath-1.3.0-py3-none-any.whl", hash = "sha256:a0b2b9fe80bbcd81a6647ff13108738cfb482d481d826cc0e02f5b35e5c88d2c", size = 536198 }, +] + +[[package]] +name = "multidict" +version = "6.1.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/d6/be/504b89a5e9ca731cd47487e91c469064f8ae5af93b7259758dcfc2b9c848/multidict-6.1.0.tar.gz", hash = "sha256:22ae2ebf9b0c69d206c003e2f6a914ea33f0a932d4aa16f236afc049d9958f4a", size = 64002 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/93/13/df3505a46d0cd08428e4c8169a196131d1b0c4b515c3649829258843dde6/multidict-6.1.0-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:3efe2c2cb5763f2f1b275ad2bf7a287d3f7ebbef35648a9726e3b69284a4f3d6", size = 48570 }, + { url = "https://files.pythonhosted.org/packages/f0/e1/a215908bfae1343cdb72f805366592bdd60487b4232d039c437fe8f5013d/multidict-6.1.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:c7053d3b0353a8b9de430a4f4b4268ac9a4fb3481af37dfe49825bf45ca24156", size = 29316 }, + { url = "https://files.pythonhosted.org/packages/70/0f/6dc70ddf5d442702ed74f298d69977f904960b82368532c88e854b79f72b/multidict-6.1.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:27e5fc84ccef8dfaabb09d82b7d179c7cf1a3fbc8a966f8274fcb4ab2eb4cadb", size = 29640 }, + { url = "https://files.pythonhosted.org/packages/d8/6d/9c87b73a13d1cdea30b321ef4b3824449866bd7f7127eceed066ccb9b9ff/multidict-6.1.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0e2b90b43e696f25c62656389d32236e049568b39320e2735d51f08fd362761b", size = 131067 }, + { url = "https://files.pythonhosted.org/packages/cc/1e/1b34154fef373371fd6c65125b3d42ff5f56c7ccc6bfff91b9b3c60ae9e0/multidict-6.1.0-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:d83a047959d38a7ff552ff94be767b7fd79b831ad1cd9920662db05fec24fe72", size = 138507 }, + { url = "https://files.pythonhosted.org/packages/fb/e0/0bc6b2bac6e461822b5f575eae85da6aae76d0e2a79b6665d6206b8e2e48/multidict-6.1.0-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:d1a9dd711d0877a1ece3d2e4fea11a8e75741ca21954c919406b44e7cf971304", size = 133905 }, + { url = "https://files.pythonhosted.org/packages/ba/af/73d13b918071ff9b2205fcf773d316e0f8fefb4ec65354bbcf0b10908cc6/multidict-6.1.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ec2abea24d98246b94913b76a125e855eb5c434f7c46546046372fe60f666351", size = 129004 }, + { url = "https://files.pythonhosted.org/packages/74/21/23960627b00ed39643302d81bcda44c9444ebcdc04ee5bedd0757513f259/multidict-6.1.0-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4867cafcbc6585e4b678876c489b9273b13e9fff9f6d6d66add5e15d11d926cb", size = 121308 }, + { url = "https://files.pythonhosted.org/packages/8b/5c/cf282263ffce4a596ed0bb2aa1a1dddfe1996d6a62d08842a8d4b33dca13/multidict-6.1.0-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:5b48204e8d955c47c55b72779802b219a39acc3ee3d0116d5080c388970b76e3", size = 132608 }, + { url = "https://files.pythonhosted.org/packages/d7/3e/97e778c041c72063f42b290888daff008d3ab1427f5b09b714f5a8eff294/multidict-6.1.0-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:d8fff389528cad1618fb4b26b95550327495462cd745d879a8c7c2115248e399", size = 127029 }, + { url = "https://files.pythonhosted.org/packages/47/ac/3efb7bfe2f3aefcf8d103e9a7162572f01936155ab2f7ebcc7c255a23212/multidict-6.1.0-cp311-cp311-musllinux_1_2_ppc64le.whl", hash = "sha256:a7a9541cd308eed5e30318430a9c74d2132e9a8cb46b901326272d780bf2d423", size = 137594 }, + { url = "https://files.pythonhosted.org/packages/42/9b/6c6e9e8dc4f915fc90a9b7798c44a30773dea2995fdcb619870e705afe2b/multidict-6.1.0-cp311-cp311-musllinux_1_2_s390x.whl", hash = "sha256:da1758c76f50c39a2efd5e9859ce7d776317eb1dd34317c8152ac9251fc574a3", size = 134556 }, + { url = "https://files.pythonhosted.org/packages/1d/10/8e881743b26aaf718379a14ac58572a240e8293a1c9d68e1418fb11c0f90/multidict-6.1.0-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:c943a53e9186688b45b323602298ab727d8865d8c9ee0b17f8d62d14b56f0753", size = 130993 }, + { url = "https://files.pythonhosted.org/packages/45/84/3eb91b4b557442802d058a7579e864b329968c8d0ea57d907e7023c677f2/multidict-6.1.0-cp311-cp311-win32.whl", hash = "sha256:90f8717cb649eea3504091e640a1b8568faad18bd4b9fcd692853a04475a4b80", size = 26405 }, + { url = "https://files.pythonhosted.org/packages/9f/0b/ad879847ecbf6d27e90a6eabb7eff6b62c129eefe617ea45eae7c1f0aead/multidict-6.1.0-cp311-cp311-win_amd64.whl", hash = "sha256:82176036e65644a6cc5bd619f65f6f19781e8ec2e5330f51aa9ada7504cc1926", size = 28795 }, + { url = "https://files.pythonhosted.org/packages/fd/16/92057c74ba3b96d5e211b553895cd6dc7cc4d1e43d9ab8fafc727681ef71/multidict-6.1.0-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:b04772ed465fa3cc947db808fa306d79b43e896beb677a56fb2347ca1a49c1fa", size = 48713 }, + { url = "https://files.pythonhosted.org/packages/94/3d/37d1b8893ae79716179540b89fc6a0ee56b4a65fcc0d63535c6f5d96f217/multidict-6.1.0-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:6180c0ae073bddeb5a97a38c03f30c233e0a4d39cd86166251617d1bbd0af436", size = 29516 }, + { url = "https://files.pythonhosted.org/packages/a2/12/adb6b3200c363062f805275b4c1e656be2b3681aada66c80129932ff0bae/multidict-6.1.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:071120490b47aa997cca00666923a83f02c7fbb44f71cf7f136df753f7fa8761", size = 29557 }, + { url = "https://files.pythonhosted.org/packages/47/e9/604bb05e6e5bce1e6a5cf80a474e0f072e80d8ac105f1b994a53e0b28c42/multidict-6.1.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:50b3a2710631848991d0bf7de077502e8994c804bb805aeb2925a981de58ec2e", size = 130170 }, + { url = "https://files.pythonhosted.org/packages/7e/13/9efa50801785eccbf7086b3c83b71a4fb501a4d43549c2f2f80b8787d69f/multidict-6.1.0-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:b58c621844d55e71c1b7f7c498ce5aa6985d743a1a59034c57a905b3f153c1ef", size = 134836 }, + { url = "https://files.pythonhosted.org/packages/bf/0f/93808b765192780d117814a6dfcc2e75de6dcc610009ad408b8814dca3ba/multidict-6.1.0-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:55b6d90641869892caa9ca42ff913f7ff1c5ece06474fbd32fb2cf6834726c95", size = 133475 }, + { url = "https://files.pythonhosted.org/packages/d3/c8/529101d7176fe7dfe1d99604e48d69c5dfdcadb4f06561f465c8ef12b4df/multidict-6.1.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4b820514bfc0b98a30e3d85462084779900347e4d49267f747ff54060cc33925", size = 131049 }, + { url = "https://files.pythonhosted.org/packages/ca/0c/fc85b439014d5a58063e19c3a158a889deec399d47b5269a0f3b6a2e28bc/multidict-6.1.0-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:10a9b09aba0c5b48c53761b7c720aaaf7cf236d5fe394cd399c7ba662d5f9966", size = 120370 }, + { url = "https://files.pythonhosted.org/packages/db/46/d4416eb20176492d2258fbd47b4abe729ff3b6e9c829ea4236f93c865089/multidict-6.1.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:1e16bf3e5fc9f44632affb159d30a437bfe286ce9e02754759be5536b169b305", size = 125178 }, + { url = "https://files.pythonhosted.org/packages/5b/46/73697ad7ec521df7de5531a32780bbfd908ded0643cbe457f981a701457c/multidict-6.1.0-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:76f364861c3bfc98cbbcbd402d83454ed9e01a5224bb3a28bf70002a230f73e2", size = 119567 }, + { url = "https://files.pythonhosted.org/packages/cd/ed/51f060e2cb0e7635329fa6ff930aa5cffa17f4c7f5c6c3ddc3500708e2f2/multidict-6.1.0-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:820c661588bd01a0aa62a1283f20d2be4281b086f80dad9e955e690c75fb54a2", size = 129822 }, + { url = "https://files.pythonhosted.org/packages/df/9e/ee7d1954b1331da3eddea0c4e08d9142da5f14b1321c7301f5014f49d492/multidict-6.1.0-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:0e5f362e895bc5b9e67fe6e4ded2492d8124bdf817827f33c5b46c2fe3ffaca6", size = 128656 }, + { url = "https://files.pythonhosted.org/packages/77/00/8538f11e3356b5d95fa4b024aa566cde7a38aa7a5f08f4912b32a037c5dc/multidict-6.1.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:3ec660d19bbc671e3a6443325f07263be452c453ac9e512f5eb935e7d4ac28b3", size = 125360 }, + { url = "https://files.pythonhosted.org/packages/be/05/5d334c1f2462d43fec2363cd00b1c44c93a78c3925d952e9a71caf662e96/multidict-6.1.0-cp312-cp312-win32.whl", hash = "sha256:58130ecf8f7b8112cdb841486404f1282b9c86ccb30d3519faf301b2e5659133", size = 26382 }, + { url = "https://files.pythonhosted.org/packages/a3/bf/f332a13486b1ed0496d624bcc7e8357bb8053823e8cd4b9a18edc1d97e73/multidict-6.1.0-cp312-cp312-win_amd64.whl", hash = "sha256:188215fc0aafb8e03341995e7c4797860181562380f81ed0a87ff455b70bf1f1", size = 28529 }, + { url = "https://files.pythonhosted.org/packages/22/67/1c7c0f39fe069aa4e5d794f323be24bf4d33d62d2a348acdb7991f8f30db/multidict-6.1.0-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:d569388c381b24671589335a3be6e1d45546c2988c2ebe30fdcada8457a31008", size = 48771 }, + { url = "https://files.pythonhosted.org/packages/3c/25/c186ee7b212bdf0df2519eacfb1981a017bda34392c67542c274651daf23/multidict-6.1.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:052e10d2d37810b99cc170b785945421141bf7bb7d2f8799d431e7db229c385f", size = 29533 }, + { url = "https://files.pythonhosted.org/packages/67/5e/04575fd837e0958e324ca035b339cea174554f6f641d3fb2b4f2e7ff44a2/multidict-6.1.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:f90c822a402cb865e396a504f9fc8173ef34212a342d92e362ca498cad308e28", size = 29595 }, + { url = "https://files.pythonhosted.org/packages/d3/b2/e56388f86663810c07cfe4a3c3d87227f3811eeb2d08450b9e5d19d78876/multidict-6.1.0-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:b225d95519a5bf73860323e633a664b0d85ad3d5bede6d30d95b35d4dfe8805b", size = 130094 }, + { url = "https://files.pythonhosted.org/packages/6c/ee/30ae9b4186a644d284543d55d491fbd4239b015d36b23fea43b4c94f7052/multidict-6.1.0-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:23bfd518810af7de1116313ebd9092cb9aa629beb12f6ed631ad53356ed6b86c", size = 134876 }, + { url = "https://files.pythonhosted.org/packages/84/c7/70461c13ba8ce3c779503c70ec9d0345ae84de04521c1f45a04d5f48943d/multidict-6.1.0-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:5c09fcfdccdd0b57867577b719c69e347a436b86cd83747f179dbf0cc0d4c1f3", size = 133500 }, + { url = "https://files.pythonhosted.org/packages/4a/9f/002af221253f10f99959561123fae676148dd730e2daa2cd053846a58507/multidict-6.1.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bf6bea52ec97e95560af5ae576bdac3aa3aae0b6758c6efa115236d9e07dae44", size = 131099 }, + { url = "https://files.pythonhosted.org/packages/82/42/d1c7a7301d52af79d88548a97e297f9d99c961ad76bbe6f67442bb77f097/multidict-6.1.0-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:57feec87371dbb3520da6192213c7d6fc892d5589a93db548331954de8248fd2", size = 120403 }, + { url = "https://files.pythonhosted.org/packages/68/f3/471985c2c7ac707547553e8f37cff5158030d36bdec4414cb825fbaa5327/multidict-6.1.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:0c3f390dc53279cbc8ba976e5f8035eab997829066756d811616b652b00a23a3", size = 125348 }, + { url = "https://files.pythonhosted.org/packages/67/2c/e6df05c77e0e433c214ec1d21ddd203d9a4770a1f2866a8ca40a545869a0/multidict-6.1.0-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:59bfeae4b25ec05b34f1956eaa1cb38032282cd4dfabc5056d0a1ec4d696d3aa", size = 119673 }, + { url = "https://files.pythonhosted.org/packages/c5/cd/bc8608fff06239c9fb333f9db7743a1b2eafe98c2666c9a196e867a3a0a4/multidict-6.1.0-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:b2f59caeaf7632cc633b5cf6fc449372b83bbdf0da4ae04d5be36118e46cc0aa", size = 129927 }, + { url = "https://files.pythonhosted.org/packages/44/8e/281b69b7bc84fc963a44dc6e0bbcc7150e517b91df368a27834299a526ac/multidict-6.1.0-cp313-cp313-musllinux_1_2_s390x.whl", hash = "sha256:37bb93b2178e02b7b618893990941900fd25b6b9ac0fa49931a40aecdf083fe4", size = 128711 }, + { url = "https://files.pythonhosted.org/packages/12/a4/63e7cd38ed29dd9f1881d5119f272c898ca92536cdb53ffe0843197f6c85/multidict-6.1.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:4e9f48f58c2c523d5a06faea47866cd35b32655c46b443f163d08c6d0ddb17d6", size = 125519 }, + { url = "https://files.pythonhosted.org/packages/38/e0/4f5855037a72cd8a7a2f60a3952d9aa45feedb37ae7831642102604e8a37/multidict-6.1.0-cp313-cp313-win32.whl", hash = "sha256:3a37ffb35399029b45c6cc33640a92bef403c9fd388acce75cdc88f58bd19a81", size = 26426 }, + { url = "https://files.pythonhosted.org/packages/7e/a5/17ee3a4db1e310b7405f5d25834460073a8ccd86198ce044dfaf69eac073/multidict-6.1.0-cp313-cp313-win_amd64.whl", hash = "sha256:e9aa71e15d9d9beaad2c6b9319edcdc0a49a43ef5c0a4c8265ca9ee7d6c67774", size = 28531 }, + { url = "https://files.pythonhosted.org/packages/99/b7/b9e70fde2c0f0c9af4cc5277782a89b66d35948ea3369ec9f598358c3ac5/multidict-6.1.0-py3-none-any.whl", hash = "sha256:48e171e52d1c4d33888e529b999e5900356b9ae588c2f09a52dcefb158b27506", size = 10051 }, +] + [[package]] name = "mypy" version = "1.15.0" @@ -463,6 +1594,15 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/2a/e2/5d3f6ada4297caebe1a2add3b126fe800c96f56dbe5d1988a2cbe0b267aa/mypy_extensions-1.0.0-py3-none-any.whl", hash = "sha256:4392f6c0eb8a5668a69e23d168ffa70f0be9ccfd32b5cc2d26a34ae5b844552d", size = 4695 }, ] +[[package]] +name = "networkx" +version = "3.4.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/fd/1d/06475e1cd5264c0b870ea2cc6fdb3e37177c1e565c43f56ff17a10e3937f/networkx-3.4.2.tar.gz", hash = "sha256:307c3669428c5362aab27c8a1260aa8f47c4e91d3891f48be0141738d8d053e1", size = 2151368 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/b9/54/dd730b32ea14ea797530a4479b2ed46a6fb250f682a9cfb997e968bf0261/networkx-3.4.2-py3-none-any.whl", hash = "sha256:df5d4365b724cf81b8c6a7312509d0c22386097011ad1abe274afd5e9d3bbc5f", size = 1723263 }, +] + [[package]] name = "nodeenv" version = "1.9.1" @@ -472,6 +1612,94 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/d2/1d/1b658dbd2b9fa9c4c9f32accbfc0205d532c8c6194dc0f2a4c0428e7128a/nodeenv-1.9.1-py2.py3-none-any.whl", hash = "sha256:ba11c9782d29c27c70ffbdda2d7415098754709be8a7056d79a737cd901155c9", size = 22314 }, ] +[[package]] +name = "numpy" +version = "2.2.3" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/fb/90/8956572f5c4ae52201fdec7ba2044b2c882832dcec7d5d0922c9e9acf2de/numpy-2.2.3.tar.gz", hash = "sha256:dbdc15f0c81611925f382dfa97b3bd0bc2c1ce19d4fe50482cb0ddc12ba30020", size = 20262700 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/96/86/453aa3949eab6ff54e2405f9cb0c01f756f031c3dc2a6d60a1d40cba5488/numpy-2.2.3-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:16372619ee728ed67a2a606a614f56d3eabc5b86f8b615c79d01957062826ca8", size = 21237256 }, + { url = "https://files.pythonhosted.org/packages/20/c3/93ecceadf3e155d6a9e4464dd2392d8d80cf436084c714dc8535121c83e8/numpy-2.2.3-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:5521a06a3148686d9269c53b09f7d399a5725c47bbb5b35747e1cb76326b714b", size = 14408049 }, + { url = "https://files.pythonhosted.org/packages/8d/29/076999b69bd9264b8df5e56f2be18da2de6b2a2d0e10737e5307592e01de/numpy-2.2.3-cp311-cp311-macosx_14_0_arm64.whl", hash = "sha256:7c8dde0ca2f77828815fd1aedfdf52e59071a5bae30dac3b4da2a335c672149a", size = 5408655 }, + { url = "https://files.pythonhosted.org/packages/e2/a7/b14f0a73eb0fe77cb9bd5b44534c183b23d4229c099e339c522724b02678/numpy-2.2.3-cp311-cp311-macosx_14_0_x86_64.whl", hash = "sha256:77974aba6c1bc26e3c205c2214f0d5b4305bdc719268b93e768ddb17e3fdd636", size = 6949996 }, + { url = "https://files.pythonhosted.org/packages/72/2f/8063da0616bb0f414b66dccead503bd96e33e43685c820e78a61a214c098/numpy-2.2.3-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d42f9c36d06440e34226e8bd65ff065ca0963aeecada587b937011efa02cdc9d", size = 14355789 }, + { url = "https://files.pythonhosted.org/packages/e6/d7/3cd47b00b8ea95ab358c376cf5602ad21871410950bc754cf3284771f8b6/numpy-2.2.3-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f2712c5179f40af9ddc8f6727f2bd910ea0eb50206daea75f58ddd9fa3f715bb", size = 16411356 }, + { url = "https://files.pythonhosted.org/packages/27/c0/a2379e202acbb70b85b41483a422c1e697ff7eee74db642ca478de4ba89f/numpy-2.2.3-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:c8b0451d2ec95010d1db8ca733afc41f659f425b7f608af569711097fd6014e2", size = 15576770 }, + { url = "https://files.pythonhosted.org/packages/bc/63/a13ee650f27b7999e5b9e1964ae942af50bb25606d088df4229283eda779/numpy-2.2.3-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:d9b4a8148c57ecac25a16b0e11798cbe88edf5237b0df99973687dd866f05e1b", size = 18200483 }, + { url = "https://files.pythonhosted.org/packages/4c/87/e71f89935e09e8161ac9c590c82f66d2321eb163893a94af749dfa8a3cf8/numpy-2.2.3-cp311-cp311-win32.whl", hash = "sha256:1f45315b2dc58d8a3e7754fe4e38b6fce132dab284a92851e41b2b344f6441c5", size = 6588415 }, + { url = "https://files.pythonhosted.org/packages/b9/c6/cd4298729826af9979c5f9ab02fcaa344b82621e7c49322cd2d210483d3f/numpy-2.2.3-cp311-cp311-win_amd64.whl", hash = "sha256:9f48ba6f6c13e5e49f3d3efb1b51c8193215c42ac82610a04624906a9270be6f", size = 12929604 }, + { url = "https://files.pythonhosted.org/packages/43/ec/43628dcf98466e087812142eec6d1c1a6c6bdfdad30a0aa07b872dc01f6f/numpy-2.2.3-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:12c045f43b1d2915eca6b880a7f4a256f59d62df4f044788c8ba67709412128d", size = 20929458 }, + { url = "https://files.pythonhosted.org/packages/9b/c0/2f4225073e99a5c12350954949ed19b5d4a738f541d33e6f7439e33e98e4/numpy-2.2.3-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:87eed225fd415bbae787f93a457af7f5990b92a334e346f72070bf569b9c9c95", size = 14115299 }, + { url = "https://files.pythonhosted.org/packages/ca/fa/d2c5575d9c734a7376cc1592fae50257ec95d061b27ee3dbdb0b3b551eb2/numpy-2.2.3-cp312-cp312-macosx_14_0_arm64.whl", hash = "sha256:712a64103d97c404e87d4d7c47fb0c7ff9acccc625ca2002848e0d53288b90ea", size = 5145723 }, + { url = "https://files.pythonhosted.org/packages/eb/dc/023dad5b268a7895e58e791f28dc1c60eb7b6c06fcbc2af8538ad069d5f3/numpy-2.2.3-cp312-cp312-macosx_14_0_x86_64.whl", hash = "sha256:a5ae282abe60a2db0fd407072aff4599c279bcd6e9a2475500fc35b00a57c532", size = 6678797 }, + { url = "https://files.pythonhosted.org/packages/3f/19/bcd641ccf19ac25abb6fb1dcd7744840c11f9d62519d7057b6ab2096eb60/numpy-2.2.3-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5266de33d4c3420973cf9ae3b98b54a2a6d53a559310e3236c4b2b06b9c07d4e", size = 14067362 }, + { url = "https://files.pythonhosted.org/packages/39/04/78d2e7402fb479d893953fb78fa7045f7deb635ec095b6b4f0260223091a/numpy-2.2.3-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3b787adbf04b0db1967798dba8da1af07e387908ed1553a0d6e74c084d1ceafe", size = 16116679 }, + { url = "https://files.pythonhosted.org/packages/d0/a1/e90f7aa66512be3150cb9d27f3d9995db330ad1b2046474a13b7040dfd92/numpy-2.2.3-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:34c1b7e83f94f3b564b35f480f5652a47007dd91f7c839f404d03279cc8dd021", size = 15264272 }, + { url = "https://files.pythonhosted.org/packages/dc/b6/50bd027cca494de4fa1fc7bf1662983d0ba5f256fa0ece2c376b5eb9b3f0/numpy-2.2.3-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:4d8335b5f1b6e2bce120d55fb17064b0262ff29b459e8493d1785c18ae2553b8", size = 17880549 }, + { url = "https://files.pythonhosted.org/packages/96/30/f7bf4acb5f8db10a96f73896bdeed7a63373137b131ca18bd3dab889db3b/numpy-2.2.3-cp312-cp312-win32.whl", hash = "sha256:4d9828d25fb246bedd31e04c9e75714a4087211ac348cb39c8c5f99dbb6683fe", size = 6293394 }, + { url = "https://files.pythonhosted.org/packages/42/6e/55580a538116d16ae7c9aa17d4edd56e83f42126cb1dfe7a684da7925d2c/numpy-2.2.3-cp312-cp312-win_amd64.whl", hash = "sha256:83807d445817326b4bcdaaaf8e8e9f1753da04341eceec705c001ff342002e5d", size = 12626357 }, + { url = "https://files.pythonhosted.org/packages/0e/8b/88b98ed534d6a03ba8cddb316950fe80842885709b58501233c29dfa24a9/numpy-2.2.3-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:7bfdb06b395385ea9b91bf55c1adf1b297c9fdb531552845ff1d3ea6e40d5aba", size = 20916001 }, + { url = "https://files.pythonhosted.org/packages/d9/b4/def6ec32c725cc5fbd8bdf8af80f616acf075fe752d8a23e895da8c67b70/numpy-2.2.3-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:23c9f4edbf4c065fddb10a4f6e8b6a244342d95966a48820c614891e5059bb50", size = 14130721 }, + { url = "https://files.pythonhosted.org/packages/20/60/70af0acc86495b25b672d403e12cb25448d79a2b9658f4fc45e845c397a8/numpy-2.2.3-cp313-cp313-macosx_14_0_arm64.whl", hash = "sha256:a0c03b6be48aaf92525cccf393265e02773be8fd9551a2f9adbe7db1fa2b60f1", size = 5130999 }, + { url = "https://files.pythonhosted.org/packages/2e/69/d96c006fb73c9a47bcb3611417cf178049aae159afae47c48bd66df9c536/numpy-2.2.3-cp313-cp313-macosx_14_0_x86_64.whl", hash = "sha256:2376e317111daa0a6739e50f7ee2a6353f768489102308b0d98fcf4a04f7f3b5", size = 6665299 }, + { url = "https://files.pythonhosted.org/packages/5a/3f/d8a877b6e48103733ac224ffa26b30887dc9944ff95dffdfa6c4ce3d7df3/numpy-2.2.3-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8fb62fe3d206d72fe1cfe31c4a1106ad2b136fcc1606093aeab314f02930fdf2", size = 14064096 }, + { url = "https://files.pythonhosted.org/packages/e4/43/619c2c7a0665aafc80efca465ddb1f260287266bdbdce517396f2f145d49/numpy-2.2.3-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:52659ad2534427dffcc36aac76bebdd02b67e3b7a619ac67543bc9bfe6b7cdb1", size = 16114758 }, + { url = "https://files.pythonhosted.org/packages/d9/79/ee4fe4f60967ccd3897aa71ae14cdee9e3c097e3256975cc9575d393cb42/numpy-2.2.3-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:1b416af7d0ed3271cad0f0a0d0bee0911ed7eba23e66f8424d9f3dfcdcae1304", size = 15259880 }, + { url = "https://files.pythonhosted.org/packages/fb/c8/8b55cf05db6d85b7a7d414b3d1bd5a740706df00bfa0824a08bf041e52ee/numpy-2.2.3-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:1402da8e0f435991983d0a9708b779f95a8c98c6b18a171b9f1be09005e64d9d", size = 17876721 }, + { url = "https://files.pythonhosted.org/packages/21/d6/b4c2f0564b7dcc413117b0ffbb818d837e4b29996b9234e38b2025ed24e7/numpy-2.2.3-cp313-cp313-win32.whl", hash = "sha256:136553f123ee2951bfcfbc264acd34a2fc2f29d7cdf610ce7daf672b6fbaa693", size = 6290195 }, + { url = "https://files.pythonhosted.org/packages/97/e7/7d55a86719d0de7a6a597949f3febefb1009435b79ba510ff32f05a8c1d7/numpy-2.2.3-cp313-cp313-win_amd64.whl", hash = "sha256:5b732c8beef1d7bc2d9e476dbba20aaff6167bf205ad9aa8d30913859e82884b", size = 12619013 }, + { url = "https://files.pythonhosted.org/packages/a6/1f/0b863d5528b9048fd486a56e0b97c18bf705e88736c8cea7239012119a54/numpy-2.2.3-cp313-cp313t-macosx_10_13_x86_64.whl", hash = "sha256:435e7a933b9fda8126130b046975a968cc2d833b505475e588339e09f7672890", size = 20944621 }, + { url = "https://files.pythonhosted.org/packages/aa/99/b478c384f7a0a2e0736177aafc97dc9152fc036a3fdb13f5a3ab225f1494/numpy-2.2.3-cp313-cp313t-macosx_11_0_arm64.whl", hash = "sha256:7678556eeb0152cbd1522b684dcd215250885993dd00adb93679ec3c0e6e091c", size = 14142502 }, + { url = "https://files.pythonhosted.org/packages/fb/61/2d9a694a0f9cd0a839501d362de2a18de75e3004576a3008e56bdd60fcdb/numpy-2.2.3-cp313-cp313t-macosx_14_0_arm64.whl", hash = "sha256:2e8da03bd561504d9b20e7a12340870dfc206c64ea59b4cfee9fceb95070ee94", size = 5176293 }, + { url = "https://files.pythonhosted.org/packages/33/35/51e94011b23e753fa33f891f601e5c1c9a3d515448659b06df9d40c0aa6e/numpy-2.2.3-cp313-cp313t-macosx_14_0_x86_64.whl", hash = "sha256:c9aa4496fd0e17e3843399f533d62857cef5900facf93e735ef65aa4bbc90ef0", size = 6691874 }, + { url = "https://files.pythonhosted.org/packages/ff/cf/06e37619aad98a9d03bd8d65b8e3041c3a639be0f5f6b0a0e2da544538d4/numpy-2.2.3-cp313-cp313t-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f4ca91d61a4bf61b0f2228f24bbfa6a9facd5f8af03759fe2a655c50ae2c6610", size = 14036826 }, + { url = "https://files.pythonhosted.org/packages/0c/93/5d7d19955abd4d6099ef4a8ee006f9ce258166c38af259f9e5558a172e3e/numpy-2.2.3-cp313-cp313t-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:deaa09cd492e24fd9b15296844c0ad1b3c976da7907e1c1ed3a0ad21dded6f76", size = 16096567 }, + { url = "https://files.pythonhosted.org/packages/af/53/d1c599acf7732d81f46a93621dab6aa8daad914b502a7a115b3f17288ab2/numpy-2.2.3-cp313-cp313t-musllinux_1_2_aarch64.whl", hash = "sha256:246535e2f7496b7ac85deffe932896a3577be7af8fb7eebe7146444680297e9a", size = 15242514 }, + { url = "https://files.pythonhosted.org/packages/53/43/c0f5411c7b3ea90adf341d05ace762dad8cb9819ef26093e27b15dd121ac/numpy-2.2.3-cp313-cp313t-musllinux_1_2_x86_64.whl", hash = "sha256:daf43a3d1ea699402c5a850e5313680ac355b4adc9770cd5cfc2940e7861f1bf", size = 17872920 }, + { url = "https://files.pythonhosted.org/packages/5b/57/6dbdd45ab277aff62021cafa1e15f9644a52f5b5fc840bc7591b4079fb58/numpy-2.2.3-cp313-cp313t-win32.whl", hash = "sha256:cf802eef1f0134afb81fef94020351be4fe1d6681aadf9c5e862af6602af64ef", size = 6346584 }, + { url = "https://files.pythonhosted.org/packages/97/9b/484f7d04b537d0a1202a5ba81c6f53f1846ae6c63c2127f8df869ed31342/numpy-2.2.3-cp313-cp313t-win_amd64.whl", hash = "sha256:aee2512827ceb6d7f517c8b85aa5d3923afe8fc7a57d028cffcd522f1c6fd082", size = 12706784 }, +] + +[[package]] +name = "oauthlib" +version = "3.2.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/6d/fa/fbf4001037904031639e6bfbfc02badfc7e12f137a8afa254df6c4c8a670/oauthlib-3.2.2.tar.gz", hash = "sha256:9859c40929662bec5d64f34d01c99e093149682a3f38915dc0655d5a633dd918", size = 177352 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/7e/80/cab10959dc1faead58dc8384a781dfbf93cb4d33d50988f7a69f1b7c9bbe/oauthlib-3.2.2-py3-none-any.whl", hash = "sha256:8139f29aac13e25d502680e9e19963e83f16838d48a0d71c287fe40e7067fbca", size = 151688 }, +] + +[[package]] +name = "onnxruntime" +version = "1.20.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "coloredlogs" }, + { name = "flatbuffers" }, + { name = "numpy" }, + { name = "packaging" }, + { name = "protobuf" }, + { name = "sympy" }, +] +wheels = [ + { url = "https://files.pythonhosted.org/packages/95/8d/2634e2959b34aa8a0037989f4229e9abcfa484e9c228f99633b3241768a6/onnxruntime-1.20.1-cp311-cp311-macosx_13_0_universal2.whl", hash = "sha256:06bfbf02ca9ab5f28946e0f912a562a5f005301d0c419283dc57b3ed7969bb7b", size = 30998725 }, + { url = "https://files.pythonhosted.org/packages/a5/da/c44bf9bd66cd6d9018a921f053f28d819445c4d84b4dd4777271b0fe52a2/onnxruntime-1.20.1-cp311-cp311-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:f6243e34d74423bdd1edf0ae9596dd61023b260f546ee17d701723915f06a9f7", size = 11955227 }, + { url = "https://files.pythonhosted.org/packages/11/ac/4120dfb74c8e45cce1c664fc7f7ce010edd587ba67ac41489f7432eb9381/onnxruntime-1.20.1-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:5eec64c0269dcdb8d9a9a53dc4d64f87b9e0c19801d9321246a53b7eb5a7d1bc", size = 13331703 }, + { url = "https://files.pythonhosted.org/packages/12/f1/cefacac137f7bb7bfba57c50c478150fcd3c54aca72762ac2c05ce0532c1/onnxruntime-1.20.1-cp311-cp311-win32.whl", hash = "sha256:a19bc6e8c70e2485a1725b3d517a2319603acc14c1f1a017dda0afe6d4665b41", size = 9813977 }, + { url = "https://files.pythonhosted.org/packages/2c/2d/2d4d202c0bcfb3a4cc2b171abb9328672d7f91d7af9ea52572722c6d8d96/onnxruntime-1.20.1-cp311-cp311-win_amd64.whl", hash = "sha256:8508887eb1c5f9537a4071768723ec7c30c28eb2518a00d0adcd32c89dea3221", size = 11329895 }, + { url = "https://files.pythonhosted.org/packages/e5/39/9335e0874f68f7d27103cbffc0e235e32e26759202df6085716375c078bb/onnxruntime-1.20.1-cp312-cp312-macosx_13_0_universal2.whl", hash = "sha256:22b0655e2bf4f2161d52706e31f517a0e54939dc393e92577df51808a7edc8c9", size = 31007580 }, + { url = "https://files.pythonhosted.org/packages/c5/9d/a42a84e10f1744dd27c6f2f9280cc3fb98f869dd19b7cd042e391ee2ab61/onnxruntime-1.20.1-cp312-cp312-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:f1f56e898815963d6dc4ee1c35fc6c36506466eff6d16f3cb9848cea4e8c8172", size = 11952833 }, + { url = "https://files.pythonhosted.org/packages/47/42/2f71f5680834688a9c81becbe5c5bb996fd33eaed5c66ae0606c3b1d6a02/onnxruntime-1.20.1-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:bb71a814f66517a65628c9e4a2bb530a6edd2cd5d87ffa0af0f6f773a027d99e", size = 13333903 }, + { url = "https://files.pythonhosted.org/packages/c8/f1/aabfdf91d013320aa2fc46cf43c88ca0182860ff15df872b4552254a9680/onnxruntime-1.20.1-cp312-cp312-win32.whl", hash = "sha256:bd386cc9ee5f686ee8a75ba74037750aca55183085bf1941da8efcfe12d5b120", size = 9814562 }, + { url = "https://files.pythonhosted.org/packages/dd/80/76979e0b744307d488c79e41051117634b956612cc731f1028eb17ee7294/onnxruntime-1.20.1-cp312-cp312-win_amd64.whl", hash = "sha256:19c2d843eb074f385e8bbb753a40df780511061a63f9def1b216bf53860223fb", size = 11331482 }, + { url = "https://files.pythonhosted.org/packages/f7/71/c5d980ac4189589267a06f758bd6c5667d07e55656bed6c6c0580733ad07/onnxruntime-1.20.1-cp313-cp313-macosx_13_0_universal2.whl", hash = "sha256:cc01437a32d0042b606f462245c8bbae269e5442797f6213e36ce61d5abdd8cc", size = 31007574 }, + { url = "https://files.pythonhosted.org/packages/81/0d/13bbd9489be2a6944f4a940084bfe388f1100472f38c07080a46fbd4ab96/onnxruntime-1.20.1-cp313-cp313-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:fb44b08e017a648924dbe91b82d89b0c105b1adcfe31e90d1dc06b8677ad37be", size = 11951459 }, + { url = "https://files.pythonhosted.org/packages/c0/ea/4454ae122874fd52bbb8a961262de81c5f932edeb1b72217f594c700d6ef/onnxruntime-1.20.1-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:bda6aebdf7917c1d811f21d41633df00c58aff2bef2f598f69289c1f1dabc4b3", size = 13331620 }, + { url = "https://files.pythonhosted.org/packages/d8/e0/50db43188ca1c945decaa8fc2a024c33446d31afed40149897d4f9de505f/onnxruntime-1.20.1-cp313-cp313-win_amd64.whl", hash = "sha256:d30367df7e70f1d9fc5a6a68106f5961686d39b54d3221f760085524e8d38e16", size = 11331758 }, + { url = "https://files.pythonhosted.org/packages/d8/55/3821c5fd60b52a6c82a00bba18531793c93c4addfe64fbf061e235c5617a/onnxruntime-1.20.1-cp313-cp313t-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:c9158465745423b2b5d97ed25aa7740c7d38d2993ee2e5c3bfacb0c4145c49d8", size = 11950342 }, + { url = "https://files.pythonhosted.org/packages/14/56/fd990ca222cef4f9f4a9400567b9a15b220dee2eafffb16b2adbc55c8281/onnxruntime-1.20.1-cp313-cp313t-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:0df6f2df83d61f46e842dbcde610ede27218947c33e994545a22333491e72a3b", size = 13337040 }, +] + [[package]] name = "openai" version = "1.63.2" @@ -491,6 +1719,230 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/15/64/db3462b358072387b8e93e6e6a38d3c741a17b4a84171ef01d6c85c63f25/openai-1.63.2-py3-none-any.whl", hash = "sha256:1f38b27b5a40814c2b7d8759ec78110df58c4a614c25f182809ca52b080ff4d4", size = 472282 }, ] +[[package]] +name = "openpyxl" +version = "3.1.5" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "et-xmlfile" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/3d/f9/88d94a75de065ea32619465d2f77b29a0469500e99012523b91cc4141cd1/openpyxl-3.1.5.tar.gz", hash = "sha256:cf0e3cf56142039133628b5acffe8ef0c12bc902d2aadd3e0fe5878dc08d1050", size = 186464 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/c0/da/977ded879c29cbd04de313843e76868e6e13408a94ed6b987245dc7c8506/openpyxl-3.1.5-py2.py3-none-any.whl", hash = "sha256:5282c12b107bffeef825f4617dc029afaf41d0ea60823bbb665ef3079dc79de2", size = 250910 }, +] + +[[package]] +name = "opentelemetry-api" +version = "1.30.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "deprecated" }, + { name = "importlib-metadata" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/2b/6d/bbbf879826b7f3c89a45252010b5796fb1f1a0d45d9dc4709db0ef9a06c8/opentelemetry_api-1.30.0.tar.gz", hash = "sha256:375893400c1435bf623f7dfb3bcd44825fe6b56c34d0667c542ea8257b1a1240", size = 63703 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/36/0a/eea862fae6413d8181b23acf8e13489c90a45f17986ee9cf4eab8a0b9ad9/opentelemetry_api-1.30.0-py3-none-any.whl", hash = "sha256:d5f5284890d73fdf47f843dda3210edf37a38d66f44f2b5aedc1e89ed455dc09", size = 64955 }, +] + +[[package]] +name = "opentelemetry-exporter-otlp-proto-common" +version = "1.30.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "opentelemetry-proto" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/a2/d7/44098bf1ef89fc5810cdbda05faa2ae9322a0dbda4921cdc965dc68a9856/opentelemetry_exporter_otlp_proto_common-1.30.0.tar.gz", hash = "sha256:ddbfbf797e518411857d0ca062c957080279320d6235a279f7b64ced73c13897", size = 19640 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/ee/54/f4b3de49f8d7d3a78fd6e6e1a6fd27dd342eb4d82c088b9078c6a32c3808/opentelemetry_exporter_otlp_proto_common-1.30.0-py3-none-any.whl", hash = "sha256:5468007c81aa9c44dc961ab2cf368a29d3475977df83b4e30aeed42aa7bc3b38", size = 18747 }, +] + +[[package]] +name = "opentelemetry-exporter-otlp-proto-grpc" +version = "1.30.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "deprecated" }, + { name = "googleapis-common-protos" }, + { name = "grpcio" }, + { name = "opentelemetry-api" }, + { name = "opentelemetry-exporter-otlp-proto-common" }, + { name = "opentelemetry-proto" }, + { name = "opentelemetry-sdk" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/86/3e/c7246df92c25e6ce95c349ad21597b4471b01ec9471e95d5261f1629fe92/opentelemetry_exporter_otlp_proto_grpc-1.30.0.tar.gz", hash = "sha256:d0f10f0b9b9a383b7d04a144d01cb280e70362cccc613987e234183fd1f01177", size = 26256 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/5e/35/d9f63fd84c2ed8dbd407bcbb933db4ed6e1b08e7fbdaca080b9ac309b927/opentelemetry_exporter_otlp_proto_grpc-1.30.0-py3-none-any.whl", hash = "sha256:2906bcae3d80acc54fd1ffcb9e44d324e8631058b502ebe4643ca71d1ff30830", size = 18550 }, +] + +[[package]] +name = "opentelemetry-exporter-otlp-proto-http" +version = "1.30.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "deprecated" }, + { name = "googleapis-common-protos" }, + { name = "opentelemetry-api" }, + { name = "opentelemetry-exporter-otlp-proto-common" }, + { name = "opentelemetry-proto" }, + { name = "opentelemetry-sdk" }, + { name = "requests" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/04/f9/abb9191d536e6a2e2b7903f8053bf859a76bf784e3ca19a5749550ef19e4/opentelemetry_exporter_otlp_proto_http-1.30.0.tar.gz", hash = "sha256:c3ae75d4181b1e34a60662a6814d0b94dd33b628bee5588a878bed92cee6abdc", size = 15073 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/e1/3c/cdf34bc459613f2275aff9b258f35acdc4c4938dad161d17437de5d4c034/opentelemetry_exporter_otlp_proto_http-1.30.0-py3-none-any.whl", hash = "sha256:9578e790e579931c5ffd50f1e6975cbdefb6a0a0a5dea127a6ae87df10e0a589", size = 17245 }, +] + +[[package]] +name = "opentelemetry-instrumentation" +version = "0.51b0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "opentelemetry-api" }, + { name = "opentelemetry-semantic-conventions" }, + { name = "packaging" }, + { name = "wrapt" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/ec/5a/4c7f02235ac1269b48f3855f6be1afc641f31d4888d28b90b732fbce7141/opentelemetry_instrumentation-0.51b0.tar.gz", hash = "sha256:4ca266875e02f3988536982467f7ef8c32a38b8895490ddce9ad9604649424fa", size = 27760 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/40/2c/48fa93f1acca9f79a06da0df7bfe916632ecc7fce1971067b3e46bcae55b/opentelemetry_instrumentation-0.51b0-py3-none-any.whl", hash = "sha256:c6de8bd26b75ec8b0e54dff59e198946e29de6a10ec65488c357d4b34aa5bdcf", size = 30923 }, +] + +[[package]] +name = "opentelemetry-instrumentation-asgi" +version = "0.51b0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "asgiref" }, + { name = "opentelemetry-api" }, + { name = "opentelemetry-instrumentation" }, + { name = "opentelemetry-semantic-conventions" }, + { name = "opentelemetry-util-http" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/9e/67/8aa6e1129f641f0f3f8786e6c5d18c1f2bbe490bd4b0e91a6879e85154d2/opentelemetry_instrumentation_asgi-0.51b0.tar.gz", hash = "sha256:b3fe97c00f0bfa934371a69674981d76591c68d937b6422a5716ca21081b4148", size = 24201 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/54/7e/0a95ab37302729543631a789ba8e71dea75c520495739dbbbdfdc580b401/opentelemetry_instrumentation_asgi-0.51b0-py3-none-any.whl", hash = "sha256:e8072993db47303b633c6ec1bc74726ba4d32bd0c46c28dfadf99f79521a324c", size = 16340 }, +] + +[[package]] +name = "opentelemetry-instrumentation-fastapi" +version = "0.51b0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "opentelemetry-api" }, + { name = "opentelemetry-instrumentation" }, + { name = "opentelemetry-instrumentation-asgi" }, + { name = "opentelemetry-semantic-conventions" }, + { name = "opentelemetry-util-http" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/2d/dc/8db4422b5084177d1ef6c7855c69bf2e9e689f595a4a9b59e60588e0d427/opentelemetry_instrumentation_fastapi-0.51b0.tar.gz", hash = "sha256:1624e70f2f4d12ceb792d8a0c331244cd6723190ccee01336273b4559bc13abc", size = 19249 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/55/1c/ec2d816b78edf2404d7b3df6d09eefb690b70bfd191b7da06f76634f1bdc/opentelemetry_instrumentation_fastapi-0.51b0-py3-none-any.whl", hash = "sha256:10513bbc11a1188adb9c1d2c520695f7a8f2b5f4de14e8162098035901cd6493", size = 12117 }, +] + +[[package]] +name = "opentelemetry-proto" +version = "1.30.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "protobuf" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/31/6e/c1ff2e3b0cd3a189a6be03fd4d63441d73d7addd9117ab5454e667b9b6c7/opentelemetry_proto-1.30.0.tar.gz", hash = "sha256:afe5c9c15e8b68d7c469596e5b32e8fc085eb9febdd6fb4e20924a93a0389179", size = 34362 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/56/d7/85de6501f7216995295f7ec11e470142e6a6e080baacec1753bbf272e007/opentelemetry_proto-1.30.0-py3-none-any.whl", hash = "sha256:c6290958ff3ddacc826ca5abbeb377a31c2334387352a259ba0df37c243adc11", size = 55854 }, +] + +[[package]] +name = "opentelemetry-sdk" +version = "1.30.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "opentelemetry-api" }, + { name = "opentelemetry-semantic-conventions" }, + { name = "typing-extensions" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/93/ee/d710062e8a862433d1be0b85920d0c653abe318878fef2d14dfe2c62ff7b/opentelemetry_sdk-1.30.0.tar.gz", hash = "sha256:c9287a9e4a7614b9946e933a67168450b9ab35f08797eb9bc77d998fa480fa18", size = 158633 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/97/28/64d781d6adc6bda2260067ce2902bd030cf45aec657e02e28c5b4480b976/opentelemetry_sdk-1.30.0-py3-none-any.whl", hash = "sha256:14fe7afc090caad881addb6926cec967129bd9260c4d33ae6a217359f6b61091", size = 118717 }, +] + +[[package]] +name = "opentelemetry-semantic-conventions" +version = "0.51b0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "deprecated" }, + { name = "opentelemetry-api" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/1e/c0/0f9ef4605fea7f2b83d55dd0b0d7aebe8feead247cd6facd232b30907b4f/opentelemetry_semantic_conventions-0.51b0.tar.gz", hash = "sha256:3fabf47f35d1fd9aebcdca7e6802d86bd5ebc3bc3408b7e3248dde6e87a18c47", size = 107191 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/2e/75/d7bdbb6fd8630b4cafb883482b75c4fc276b6426619539d266e32ac53266/opentelemetry_semantic_conventions-0.51b0-py3-none-any.whl", hash = "sha256:fdc777359418e8d06c86012c3dc92c88a6453ba662e941593adb062e48c2eeae", size = 177416 }, +] + +[[package]] +name = "opentelemetry-util-http" +version = "0.51b0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/58/64/32510c0a803465eb6ef1f5bd514d0f5627f8abc9444ed94f7240faf6fcaa/opentelemetry_util_http-0.51b0.tar.gz", hash = "sha256:05edd19ca1cc3be3968b1e502fd94816901a365adbeaab6b6ddb974384d3a0b9", size = 8043 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/48/dd/c371eeb9cc78abbdad231a27ce1a196a37ef96328d876ccbb381dea4c8ee/opentelemetry_util_http-0.51b0-py3-none-any.whl", hash = "sha256:0561d7a6e9c422b9ef9ae6e77eafcfcd32a2ab689f5e801475cbb67f189efa20", size = 7304 }, +] + +[[package]] +name = "orjson" +version = "3.10.15" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/ae/f9/5dea21763eeff8c1590076918a446ea3d6140743e0e36f58f369928ed0f4/orjson-3.10.15.tar.gz", hash = "sha256:05ca7fe452a2e9d8d9d706a2984c95b9c2ebc5db417ce0b7a49b91d50642a23e", size = 5282482 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/7a/a2/21b25ce4a2c71dbb90948ee81bd7a42b4fbfc63162e57faf83157d5540ae/orjson-3.10.15-cp311-cp311-macosx_10_15_x86_64.macosx_11_0_arm64.macosx_10_15_universal2.whl", hash = "sha256:c4cc83960ab79a4031f3119cc4b1a1c627a3dc09df125b27c4201dff2af7eaa6", size = 249533 }, + { url = "https://files.pythonhosted.org/packages/b2/85/2076fc12d8225698a51278009726750c9c65c846eda741e77e1761cfef33/orjson-3.10.15-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ddbeef2481d895ab8be5185f2432c334d6dec1f5d1933a9c83014d188e102cef", size = 125230 }, + { url = "https://files.pythonhosted.org/packages/06/df/a85a7955f11274191eccf559e8481b2be74a7c6d43075d0a9506aa80284d/orjson-3.10.15-cp311-cp311-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:9e590a0477b23ecd5b0ac865b1b907b01b3c5535f5e8a8f6ab0e503efb896334", size = 150148 }, + { url = "https://files.pythonhosted.org/packages/37/b3/94c55625a29b8767c0eed194cb000b3787e3c23b4cdd13be17bae6ccbb4b/orjson-3.10.15-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a6be38bd103d2fd9bdfa31c2720b23b5d47c6796bcb1d1b598e3924441b4298d", size = 139749 }, + { url = "https://files.pythonhosted.org/packages/53/ba/c608b1e719971e8ddac2379f290404c2e914cf8e976369bae3cad88768b1/orjson-3.10.15-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:ff4f6edb1578960ed628a3b998fa54d78d9bb3e2eb2cfc5c2a09732431c678d0", size = 154558 }, + { url = "https://files.pythonhosted.org/packages/b2/c4/c1fb835bb23ad788a39aa9ebb8821d51b1c03588d9a9e4ca7de5b354fdd5/orjson-3.10.15-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b0482b21d0462eddd67e7fce10b89e0b6ac56570424662b685a0d6fccf581e13", size = 130349 }, + { url = "https://files.pythonhosted.org/packages/78/14/bb2b48b26ab3c570b284eb2157d98c1ef331a8397f6c8bd983b270467f5c/orjson-3.10.15-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:bb5cc3527036ae3d98b65e37b7986a918955f85332c1ee07f9d3f82f3a6899b5", size = 138513 }, + { url = "https://files.pythonhosted.org/packages/4a/97/d5b353a5fe532e92c46467aa37e637f81af8468aa894cd77d2ec8a12f99e/orjson-3.10.15-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:d569c1c462912acdd119ccbf719cf7102ea2c67dd03b99edcb1a3048651ac96b", size = 130942 }, + { url = "https://files.pythonhosted.org/packages/b5/5d/a067bec55293cca48fea8b9928cfa84c623be0cce8141d47690e64a6ca12/orjson-3.10.15-cp311-cp311-musllinux_1_2_armv7l.whl", hash = "sha256:1e6d33efab6b71d67f22bf2962895d3dc6f82a6273a965fab762e64fa90dc399", size = 414717 }, + { url = "https://files.pythonhosted.org/packages/6f/9a/1485b8b05c6b4c4db172c438cf5db5dcfd10e72a9bc23c151a1137e763e0/orjson-3.10.15-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:c33be3795e299f565681d69852ac8c1bc5c84863c0b0030b2b3468843be90388", size = 141033 }, + { url = "https://files.pythonhosted.org/packages/f8/d2/fc67523656e43a0c7eaeae9007c8b02e86076b15d591e9be11554d3d3138/orjson-3.10.15-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:eea80037b9fae5339b214f59308ef0589fc06dc870578b7cce6d71eb2096764c", size = 129720 }, + { url = "https://files.pythonhosted.org/packages/79/42/f58c7bd4e5b54da2ce2ef0331a39ccbbaa7699b7f70206fbf06737c9ed7d/orjson-3.10.15-cp311-cp311-win32.whl", hash = "sha256:d5ac11b659fd798228a7adba3e37c010e0152b78b1982897020a8e019a94882e", size = 142473 }, + { url = "https://files.pythonhosted.org/packages/00/f8/bb60a4644287a544ec81df1699d5b965776bc9848d9029d9f9b3402ac8bb/orjson-3.10.15-cp311-cp311-win_amd64.whl", hash = "sha256:cf45e0214c593660339ef63e875f32ddd5aa3b4adc15e662cdb80dc49e194f8e", size = 133570 }, + { url = "https://files.pythonhosted.org/packages/66/85/22fe737188905a71afcc4bf7cc4c79cd7f5bbe9ed1fe0aac4ce4c33edc30/orjson-3.10.15-cp312-cp312-macosx_10_15_x86_64.macosx_11_0_arm64.macosx_10_15_universal2.whl", hash = "sha256:9d11c0714fc85bfcf36ada1179400862da3288fc785c30e8297844c867d7505a", size = 249504 }, + { url = "https://files.pythonhosted.org/packages/48/b7/2622b29f3afebe938a0a9037e184660379797d5fd5234e5998345d7a5b43/orjson-3.10.15-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:dba5a1e85d554e3897fa9fe6fbcff2ed32d55008973ec9a2b992bd9a65d2352d", size = 125080 }, + { url = "https://files.pythonhosted.org/packages/ce/8f/0b72a48f4403d0b88b2a41450c535b3e8989e8a2d7800659a967efc7c115/orjson-3.10.15-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:7723ad949a0ea502df656948ddd8b392780a5beaa4c3b5f97e525191b102fff0", size = 150121 }, + { url = "https://files.pythonhosted.org/packages/06/ec/acb1a20cd49edb2000be5a0404cd43e3c8aad219f376ac8c60b870518c03/orjson-3.10.15-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:6fd9bc64421e9fe9bd88039e7ce8e58d4fead67ca88e3a4014b143cec7684fd4", size = 139796 }, + { url = "https://files.pythonhosted.org/packages/33/e1/f7840a2ea852114b23a52a1c0b2bea0a1ea22236efbcdb876402d799c423/orjson-3.10.15-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:dadba0e7b6594216c214ef7894c4bd5f08d7c0135f4dd0145600be4fbcc16767", size = 154636 }, + { url = "https://files.pythonhosted.org/packages/fa/da/31543337febd043b8fa80a3b67de627669b88c7b128d9ad4cc2ece005b7a/orjson-3.10.15-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b48f59114fe318f33bbaee8ebeda696d8ccc94c9e90bc27dbe72153094e26f41", size = 130621 }, + { url = "https://files.pythonhosted.org/packages/ed/78/66115dc9afbc22496530d2139f2f4455698be444c7c2475cb48f657cefc9/orjson-3.10.15-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:035fb83585e0f15e076759b6fedaf0abb460d1765b6a36f48018a52858443514", size = 138516 }, + { url = "https://files.pythonhosted.org/packages/22/84/cd4f5fb5427ffcf823140957a47503076184cb1ce15bcc1165125c26c46c/orjson-3.10.15-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:d13b7fe322d75bf84464b075eafd8e7dd9eae05649aa2a5354cfa32f43c59f17", size = 130762 }, + { url = "https://files.pythonhosted.org/packages/93/1f/67596b711ba9f56dd75d73b60089c5c92057f1130bb3a25a0f53fb9a583b/orjson-3.10.15-cp312-cp312-musllinux_1_2_armv7l.whl", hash = "sha256:7066b74f9f259849629e0d04db6609db4cf5b973248f455ba5d3bd58a4daaa5b", size = 414700 }, + { url = "https://files.pythonhosted.org/packages/7c/0c/6a3b3271b46443d90efb713c3e4fe83fa8cd71cda0d11a0f69a03f437c6e/orjson-3.10.15-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:88dc3f65a026bd3175eb157fea994fca6ac7c4c8579fc5a86fc2114ad05705b7", size = 141077 }, + { url = "https://files.pythonhosted.org/packages/3b/9b/33c58e0bfc788995eccd0d525ecd6b84b40d7ed182dd0751cd4c1322ac62/orjson-3.10.15-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:b342567e5465bd99faa559507fe45e33fc76b9fb868a63f1642c6bc0735ad02a", size = 129898 }, + { url = "https://files.pythonhosted.org/packages/01/c1/d577ecd2e9fa393366a1ea0a9267f6510d86e6c4bb1cdfb9877104cac44c/orjson-3.10.15-cp312-cp312-win32.whl", hash = "sha256:0a4f27ea5617828e6b58922fdbec67b0aa4bb844e2d363b9244c47fa2180e665", size = 142566 }, + { url = "https://files.pythonhosted.org/packages/ed/eb/a85317ee1732d1034b92d56f89f1de4d7bf7904f5c8fb9dcdd5b1c83917f/orjson-3.10.15-cp312-cp312-win_amd64.whl", hash = "sha256:ef5b87e7aa9545ddadd2309efe6824bd3dd64ac101c15dae0f2f597911d46eaa", size = 133732 }, + { url = "https://files.pythonhosted.org/packages/06/10/fe7d60b8da538e8d3d3721f08c1b7bff0491e8fa4dd3bf11a17e34f4730e/orjson-3.10.15-cp313-cp313-macosx_10_15_x86_64.macosx_11_0_arm64.macosx_10_15_universal2.whl", hash = "sha256:bae0e6ec2b7ba6895198cd981b7cca95d1487d0147c8ed751e5632ad16f031a6", size = 249399 }, + { url = "https://files.pythonhosted.org/packages/6b/83/52c356fd3a61abd829ae7e4366a6fe8e8863c825a60d7ac5156067516edf/orjson-3.10.15-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f93ce145b2db1252dd86af37d4165b6faa83072b46e3995ecc95d4b2301b725a", size = 125044 }, + { url = "https://files.pythonhosted.org/packages/55/b2/d06d5901408e7ded1a74c7c20d70e3a127057a6d21355f50c90c0f337913/orjson-3.10.15-cp313-cp313-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:7c203f6f969210128af3acae0ef9ea6aab9782939f45f6fe02d05958fe761ef9", size = 150066 }, + { url = "https://files.pythonhosted.org/packages/75/8c/60c3106e08dc593a861755781c7c675a566445cc39558677d505878d879f/orjson-3.10.15-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:8918719572d662e18b8af66aef699d8c21072e54b6c82a3f8f6404c1f5ccd5e0", size = 139737 }, + { url = "https://files.pythonhosted.org/packages/6a/8c/ae00d7d0ab8a4490b1efeb01ad4ab2f1982e69cc82490bf8093407718ff5/orjson-3.10.15-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:f71eae9651465dff70aa80db92586ad5b92df46a9373ee55252109bb6b703307", size = 154804 }, + { url = "https://files.pythonhosted.org/packages/22/86/65dc69bd88b6dd254535310e97bc518aa50a39ef9c5a2a5d518e7a223710/orjson-3.10.15-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e117eb299a35f2634e25ed120c37c641398826c2f5a3d3cc39f5993b96171b9e", size = 130583 }, + { url = "https://files.pythonhosted.org/packages/bb/00/6fe01ededb05d52be42fabb13d93a36e51f1fd9be173bd95707d11a8a860/orjson-3.10.15-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:13242f12d295e83c2955756a574ddd6741c81e5b99f2bef8ed8d53e47a01e4b7", size = 138465 }, + { url = "https://files.pythonhosted.org/packages/db/2f/4cc151c4b471b0cdc8cb29d3eadbce5007eb0475d26fa26ed123dca93b33/orjson-3.10.15-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:7946922ada8f3e0b7b958cc3eb22cfcf6c0df83d1fe5521b4a100103e3fa84c8", size = 130742 }, + { url = "https://files.pythonhosted.org/packages/9f/13/8a6109e4b477c518498ca37963d9c0eb1508b259725553fb53d53b20e2ea/orjson-3.10.15-cp313-cp313-musllinux_1_2_armv7l.whl", hash = "sha256:b7155eb1623347f0f22c38c9abdd738b287e39b9982e1da227503387b81b34ca", size = 414669 }, + { url = "https://files.pythonhosted.org/packages/22/7b/1d229d6d24644ed4d0a803de1b0e2df832032d5beda7346831c78191b5b2/orjson-3.10.15-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:208beedfa807c922da4e81061dafa9c8489c6328934ca2a562efa707e049e561", size = 141043 }, + { url = "https://files.pythonhosted.org/packages/cc/d3/6dc91156cf12ed86bed383bcb942d84d23304a1e57b7ab030bf60ea130d6/orjson-3.10.15-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:eca81f83b1b8c07449e1d6ff7074e82e3fd6777e588f1a6632127f286a968825", size = 129826 }, + { url = "https://files.pythonhosted.org/packages/b3/38/c47c25b86f6996f1343be721b6ea4367bc1c8bc0fc3f6bbcd995d18cb19d/orjson-3.10.15-cp313-cp313-win32.whl", hash = "sha256:c03cd6eea1bd3b949d0d007c8d57049aa2b39bd49f58b4b2af571a5d3833d890", size = 142542 }, + { url = "https://files.pythonhosted.org/packages/27/f1/1d7ec15b20f8ce9300bc850de1e059132b88990e46cd0ccac29cbf11e4f9/orjson-3.10.15-cp313-cp313-win_amd64.whl", hash = "sha256:fd56a26a04f6ba5fb2045b0acc487a63162a958ed837648c5781e1fe3316cfbf", size = 133444 }, +] + +[[package]] +name = "overrides" +version = "7.7.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/36/86/b585f53236dec60aba864e050778b25045f857e17f6e5ea0ae95fe80edd2/overrides-7.7.0.tar.gz", hash = "sha256:55158fa3d93b98cc75299b1e67078ad9003ca27945c76162c1c0766d6f91820a", size = 22812 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/2c/ab/fc8290c6a4c722e5514d80f62b2dc4c4df1a68a41d1364e625c35990fcf3/overrides-7.7.0-py3-none-any.whl", hash = "sha256:c7ed9d062f78b8e4c1a7b70bd8796b35ead4d9f510227ef9c5dc7626c60d7e49", size = 17832 }, +] + [[package]] name = "packaging" version = "24.2" @@ -509,6 +1961,15 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/90/96/04b8e52da071d28f5e21a805b19cb9390aa17a47462ac87f5e2696b9566d/paginate-0.5.7-py2.py3-none-any.whl", hash = "sha256:b885e2af73abcf01d9559fd5216b57ef722f8c42affbb63942377668e35c7591", size = 13746 }, ] +[[package]] +name = "parso" +version = "0.8.4" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/66/94/68e2e17afaa9169cf6412ab0f28623903be73d1b32e208d9e8e541bb086d/parso-0.8.4.tar.gz", hash = "sha256:eb3a7b58240fb99099a345571deecc0f9540ea5f4dd2fe14c2a99d6b281ab92d", size = 400609 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/c6/ac/dac4a63f978e4dcb3c6d3a78c4d8e0192a113d288502a1216950c41b1027/parso-0.8.4-py2.py3-none-any.whl", hash = "sha256:a418670a20291dacd2dddc80c377c5c3791378ee1e8d12bffc35420643d43f18", size = 103650 }, +] + [[package]] name = "pathspec" version = "0.12.1" @@ -518,6 +1979,94 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/cc/20/ff623b09d963f88bfde16306a54e12ee5ea43e9b597108672ff3a408aad6/pathspec-0.12.1-py3-none-any.whl", hash = "sha256:a0d503e138a4c123b27490a4f7beda6a01c6f288df0e4a8b79c7eb0dc7b4cc08", size = 31191 }, ] +[[package]] +name = "pdfminer-six" +version = "20231228" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "charset-normalizer" }, + { name = "cryptography" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/31/b1/a43e3bd872ded4deea4f8efc7aff1703fca8c5455d0c06e20506a06a44ff/pdfminer.six-20231228.tar.gz", hash = "sha256:6004da3ad1a7a4d45930cb950393df89b068e73be365a6ff64a838d37bcb08c4", size = 7362505 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/eb/9c/e46fe7502b32d7db6af6e36a9105abb93301fa1ec475b5ddcba8b35ae23a/pdfminer.six-20231228-py3-none-any.whl", hash = "sha256:e8d3c3310e6fbc1fe414090123ab01351634b4ecb021232206c4c9a8ca3e3b8f", size = 5614515 }, +] + +[[package]] +name = "pdfplumber" +version = "0.11.5" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "pdfminer-six" }, + { name = "pillow" }, + { name = "pypdfium2" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/28/55/33d265185b4e7e6ac81e64478750ea26310055b1b5b278851b981a1c57e5/pdfplumber-0.11.5.tar.gz", hash = "sha256:dadd81b62a0b23e078cdd89de26e013850d4daf5690fcf46dec396b07e6737d6", size = 114626 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/18/fe/eebf169301bd1c1c69d639e81ba226d333d35c5ad105b7cd3cfc40a44862/pdfplumber-0.11.5-py3-none-any.whl", hash = "sha256:a6e0921a57e0ef7356001a0fd811250b0e37a0b42630a922ee48f55cdd534070", size = 59515 }, +] + +[[package]] +name = "pexpect" +version = "4.9.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "ptyprocess" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/42/92/cc564bf6381ff43ce1f4d06852fc19a2f11d180f23dc32d9588bee2f149d/pexpect-4.9.0.tar.gz", hash = "sha256:ee7d41123f3c9911050ea2c2dac107568dc43b2d3b0c7557a33212c398ead30f", size = 166450 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/9e/c3/059298687310d527a58bb01f3b1965787ee3b40dce76752eda8b44e9a2c5/pexpect-4.9.0-py2.py3-none-any.whl", hash = "sha256:7236d1e080e4936be2dc3e326cec0af72acf9212a7e1d060210e70a47e253523", size = 63772 }, +] + +[[package]] +name = "pillow" +version = "11.1.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/f3/af/c097e544e7bd278333db77933e535098c259609c4eb3b85381109602fb5b/pillow-11.1.0.tar.gz", hash = "sha256:368da70808b36d73b4b390a8ffac11069f8a5c85f29eff1f1b01bcf3ef5b2a20", size = 46742715 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/dd/d6/2000bfd8d5414fb70cbbe52c8332f2283ff30ed66a9cde42716c8ecbe22c/pillow-11.1.0-cp311-cp311-macosx_10_10_x86_64.whl", hash = "sha256:e06695e0326d05b06833b40b7ef477e475d0b1ba3a6d27da1bb48c23209bf457", size = 3229968 }, + { url = "https://files.pythonhosted.org/packages/d9/45/3fe487010dd9ce0a06adf9b8ff4f273cc0a44536e234b0fad3532a42c15b/pillow-11.1.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:96f82000e12f23e4f29346e42702b6ed9a2f2fea34a740dd5ffffcc8c539eb35", size = 3101806 }, + { url = "https://files.pythonhosted.org/packages/e3/72/776b3629c47d9d5f1c160113158a7a7ad177688d3a1159cd3b62ded5a33a/pillow-11.1.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a3cd561ded2cf2bbae44d4605837221b987c216cff94f49dfeed63488bb228d2", size = 4322283 }, + { url = "https://files.pythonhosted.org/packages/e4/c2/e25199e7e4e71d64eeb869f5b72c7ddec70e0a87926398785ab944d92375/pillow-11.1.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f189805c8be5ca5add39e6f899e6ce2ed824e65fb45f3c28cb2841911da19070", size = 4402945 }, + { url = "https://files.pythonhosted.org/packages/c1/ed/51d6136c9d5911f78632b1b86c45241c712c5a80ed7fa7f9120a5dff1eba/pillow-11.1.0-cp311-cp311-manylinux_2_28_aarch64.whl", hash = "sha256:dd0052e9db3474df30433f83a71b9b23bd9e4ef1de13d92df21a52c0303b8ab6", size = 4361228 }, + { url = "https://files.pythonhosted.org/packages/48/a4/fbfe9d5581d7b111b28f1d8c2762dee92e9821bb209af9fa83c940e507a0/pillow-11.1.0-cp311-cp311-manylinux_2_28_x86_64.whl", hash = "sha256:837060a8599b8f5d402e97197d4924f05a2e0d68756998345c829c33186217b1", size = 4484021 }, + { url = "https://files.pythonhosted.org/packages/39/db/0b3c1a5018117f3c1d4df671fb8e47d08937f27519e8614bbe86153b65a5/pillow-11.1.0-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:aa8dd43daa836b9a8128dbe7d923423e5ad86f50a7a14dc688194b7be5c0dea2", size = 4287449 }, + { url = "https://files.pythonhosted.org/packages/d9/58/bc128da7fea8c89fc85e09f773c4901e95b5936000e6f303222490c052f3/pillow-11.1.0-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:0a2f91f8a8b367e7a57c6e91cd25af510168091fb89ec5146003e424e1558a96", size = 4419972 }, + { url = "https://files.pythonhosted.org/packages/5f/bb/58f34379bde9fe197f51841c5bbe8830c28bbb6d3801f16a83b8f2ad37df/pillow-11.1.0-cp311-cp311-win32.whl", hash = "sha256:c12fc111ef090845de2bb15009372175d76ac99969bdf31e2ce9b42e4b8cd88f", size = 2291201 }, + { url = "https://files.pythonhosted.org/packages/3a/c6/fce9255272bcf0c39e15abd2f8fd8429a954cf344469eaceb9d0d1366913/pillow-11.1.0-cp311-cp311-win_amd64.whl", hash = "sha256:fbd43429d0d7ed6533b25fc993861b8fd512c42d04514a0dd6337fb3ccf22761", size = 2625686 }, + { url = "https://files.pythonhosted.org/packages/c8/52/8ba066d569d932365509054859f74f2a9abee273edcef5cd75e4bc3e831e/pillow-11.1.0-cp311-cp311-win_arm64.whl", hash = "sha256:f7955ecf5609dee9442cbface754f2c6e541d9e6eda87fad7f7a989b0bdb9d71", size = 2375194 }, + { url = "https://files.pythonhosted.org/packages/95/20/9ce6ed62c91c073fcaa23d216e68289e19d95fb8188b9fb7a63d36771db8/pillow-11.1.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:2062ffb1d36544d42fcaa277b069c88b01bb7298f4efa06731a7fd6cc290b81a", size = 3226818 }, + { url = "https://files.pythonhosted.org/packages/b9/d8/f6004d98579a2596c098d1e30d10b248798cceff82d2b77aa914875bfea1/pillow-11.1.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:a85b653980faad27e88b141348707ceeef8a1186f75ecc600c395dcac19f385b", size = 3101662 }, + { url = "https://files.pythonhosted.org/packages/08/d9/892e705f90051c7a2574d9f24579c9e100c828700d78a63239676f960b74/pillow-11.1.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:9409c080586d1f683df3f184f20e36fb647f2e0bc3988094d4fd8c9f4eb1b3b3", size = 4329317 }, + { url = "https://files.pythonhosted.org/packages/8c/aa/7f29711f26680eab0bcd3ecdd6d23ed6bce180d82e3f6380fb7ae35fcf3b/pillow-11.1.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7fdadc077553621911f27ce206ffcbec7d3f8d7b50e0da39f10997e8e2bb7f6a", size = 4412999 }, + { url = "https://files.pythonhosted.org/packages/c8/c4/8f0fe3b9e0f7196f6d0bbb151f9fba323d72a41da068610c4c960b16632a/pillow-11.1.0-cp312-cp312-manylinux_2_28_aarch64.whl", hash = "sha256:93a18841d09bcdd774dcdc308e4537e1f867b3dec059c131fde0327899734aa1", size = 4368819 }, + { url = "https://files.pythonhosted.org/packages/38/0d/84200ed6a871ce386ddc82904bfadc0c6b28b0c0ec78176871a4679e40b3/pillow-11.1.0-cp312-cp312-manylinux_2_28_x86_64.whl", hash = "sha256:9aa9aeddeed452b2f616ff5507459e7bab436916ccb10961c4a382cd3e03f47f", size = 4496081 }, + { url = "https://files.pythonhosted.org/packages/84/9c/9bcd66f714d7e25b64118e3952d52841a4babc6d97b6d28e2261c52045d4/pillow-11.1.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:3cdcdb0b896e981678eee140d882b70092dac83ac1cdf6b3a60e2216a73f2b91", size = 4296513 }, + { url = "https://files.pythonhosted.org/packages/db/61/ada2a226e22da011b45f7104c95ebda1b63dcbb0c378ad0f7c2a710f8fd2/pillow-11.1.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:36ba10b9cb413e7c7dfa3e189aba252deee0602c86c309799da5a74009ac7a1c", size = 4431298 }, + { url = "https://files.pythonhosted.org/packages/e7/c4/fc6e86750523f367923522014b821c11ebc5ad402e659d8c9d09b3c9d70c/pillow-11.1.0-cp312-cp312-win32.whl", hash = "sha256:cfd5cd998c2e36a862d0e27b2df63237e67273f2fc78f47445b14e73a810e7e6", size = 2291630 }, + { url = "https://files.pythonhosted.org/packages/08/5c/2104299949b9d504baf3f4d35f73dbd14ef31bbd1ddc2c1b66a5b7dfda44/pillow-11.1.0-cp312-cp312-win_amd64.whl", hash = "sha256:a697cd8ba0383bba3d2d3ada02b34ed268cb548b369943cd349007730c92bddf", size = 2626369 }, + { url = "https://files.pythonhosted.org/packages/37/f3/9b18362206b244167c958984b57c7f70a0289bfb59a530dd8af5f699b910/pillow-11.1.0-cp312-cp312-win_arm64.whl", hash = "sha256:4dd43a78897793f60766563969442020e90eb7847463eca901e41ba186a7d4a5", size = 2375240 }, + { url = "https://files.pythonhosted.org/packages/b3/31/9ca79cafdce364fd5c980cd3416c20ce1bebd235b470d262f9d24d810184/pillow-11.1.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:ae98e14432d458fc3de11a77ccb3ae65ddce70f730e7c76140653048c71bfcbc", size = 3226640 }, + { url = "https://files.pythonhosted.org/packages/ac/0f/ff07ad45a1f172a497aa393b13a9d81a32e1477ef0e869d030e3c1532521/pillow-11.1.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:cc1331b6d5a6e144aeb5e626f4375f5b7ae9934ba620c0ac6b3e43d5e683a0f0", size = 3101437 }, + { url = "https://files.pythonhosted.org/packages/08/2f/9906fca87a68d29ec4530be1f893149e0cb64a86d1f9f70a7cfcdfe8ae44/pillow-11.1.0-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:758e9d4ef15d3560214cddbc97b8ef3ef86ce04d62ddac17ad39ba87e89bd3b1", size = 4326605 }, + { url = "https://files.pythonhosted.org/packages/b0/0f/f3547ee15b145bc5c8b336401b2d4c9d9da67da9dcb572d7c0d4103d2c69/pillow-11.1.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b523466b1a31d0dcef7c5be1f20b942919b62fd6e9a9be199d035509cbefc0ec", size = 4411173 }, + { url = "https://files.pythonhosted.org/packages/b1/df/bf8176aa5db515c5de584c5e00df9bab0713548fd780c82a86cba2c2fedb/pillow-11.1.0-cp313-cp313-manylinux_2_28_aarch64.whl", hash = "sha256:9044b5e4f7083f209c4e35aa5dd54b1dd5b112b108648f5c902ad586d4f945c5", size = 4369145 }, + { url = "https://files.pythonhosted.org/packages/de/7c/7433122d1cfadc740f577cb55526fdc39129a648ac65ce64db2eb7209277/pillow-11.1.0-cp313-cp313-manylinux_2_28_x86_64.whl", hash = "sha256:3764d53e09cdedd91bee65c2527815d315c6b90d7b8b79759cc48d7bf5d4f114", size = 4496340 }, + { url = "https://files.pythonhosted.org/packages/25/46/dd94b93ca6bd555588835f2504bd90c00d5438fe131cf01cfa0c5131a19d/pillow-11.1.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:31eba6bbdd27dde97b0174ddf0297d7a9c3a507a8a1480e1e60ef914fe23d352", size = 4296906 }, + { url = "https://files.pythonhosted.org/packages/a8/28/2f9d32014dfc7753e586db9add35b8a41b7a3b46540e965cb6d6bc607bd2/pillow-11.1.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:b5d658fbd9f0d6eea113aea286b21d3cd4d3fd978157cbf2447a6035916506d3", size = 4431759 }, + { url = "https://files.pythonhosted.org/packages/33/48/19c2cbe7403870fbe8b7737d19eb013f46299cdfe4501573367f6396c775/pillow-11.1.0-cp313-cp313-win32.whl", hash = "sha256:f86d3a7a9af5d826744fabf4afd15b9dfef44fe69a98541f666f66fbb8d3fef9", size = 2291657 }, + { url = "https://files.pythonhosted.org/packages/3b/ad/285c556747d34c399f332ba7c1a595ba245796ef3e22eae190f5364bb62b/pillow-11.1.0-cp313-cp313-win_amd64.whl", hash = "sha256:593c5fd6be85da83656b93ffcccc2312d2d149d251e98588b14fbc288fd8909c", size = 2626304 }, + { url = "https://files.pythonhosted.org/packages/e5/7b/ef35a71163bf36db06e9c8729608f78dedf032fc8313d19bd4be5c2588f3/pillow-11.1.0-cp313-cp313-win_arm64.whl", hash = "sha256:11633d58b6ee5733bde153a8dafd25e505ea3d32e261accd388827ee987baf65", size = 2375117 }, + { url = "https://files.pythonhosted.org/packages/79/30/77f54228401e84d6791354888549b45824ab0ffde659bafa67956303a09f/pillow-11.1.0-cp313-cp313t-macosx_10_13_x86_64.whl", hash = "sha256:70ca5ef3b3b1c4a0812b5c63c57c23b63e53bc38e758b37a951e5bc466449861", size = 3230060 }, + { url = "https://files.pythonhosted.org/packages/ce/b1/56723b74b07dd64c1010fee011951ea9c35a43d8020acd03111f14298225/pillow-11.1.0-cp313-cp313t-macosx_11_0_arm64.whl", hash = "sha256:8000376f139d4d38d6851eb149b321a52bb8893a88dae8ee7d95840431977081", size = 3106192 }, + { url = "https://files.pythonhosted.org/packages/e1/cd/7bf7180e08f80a4dcc6b4c3a0aa9e0b0ae57168562726a05dc8aa8fa66b0/pillow-11.1.0-cp313-cp313t-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9ee85f0696a17dd28fbcfceb59f9510aa71934b483d1f5601d1030c3c8304f3c", size = 4446805 }, + { url = "https://files.pythonhosted.org/packages/97/42/87c856ea30c8ed97e8efbe672b58c8304dee0573f8c7cab62ae9e31db6ae/pillow-11.1.0-cp313-cp313t-manylinux_2_28_x86_64.whl", hash = "sha256:dd0e081319328928531df7a0e63621caf67652c8464303fd102141b785ef9547", size = 4530623 }, + { url = "https://files.pythonhosted.org/packages/ff/41/026879e90c84a88e33fb00cc6bd915ac2743c67e87a18f80270dfe3c2041/pillow-11.1.0-cp313-cp313t-musllinux_1_2_x86_64.whl", hash = "sha256:e63e4e5081de46517099dc30abe418122f54531a6ae2ebc8680bcd7096860eab", size = 4465191 }, + { url = "https://files.pythonhosted.org/packages/e5/fb/a7960e838bc5df57a2ce23183bfd2290d97c33028b96bde332a9057834d3/pillow-11.1.0-cp313-cp313t-win32.whl", hash = "sha256:dda60aa465b861324e65a78c9f5cf0f4bc713e4309f83bc387be158b077963d9", size = 2295494 }, + { url = "https://files.pythonhosted.org/packages/d7/6c/6ec83ee2f6f0fda8d4cf89045c6be4b0373ebfc363ba8538f8c999f63fcd/pillow-11.1.0-cp313-cp313t-win_amd64.whl", hash = "sha256:ad5db5781c774ab9a9b2c4302bbf0c1014960a0a7be63278d13ae6fdf88126fe", size = 2631595 }, + { url = "https://files.pythonhosted.org/packages/cf/6c/41c21c6c8af92b9fea313aa47c75de49e2f9a467964ee33eb0135d47eb64/pillow-11.1.0-cp313-cp313t-win_arm64.whl", hash = "sha256:67cd427c68926108778a9005f2a04adbd5e67c442ed21d95389fe1d595458756", size = 2377651 }, +] + [[package]] name = "platformdirs" version = "4.3.6" @@ -536,6 +2085,22 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/88/5f/e351af9a41f866ac3f1fac4ca0613908d9a41741cfcf2228f4ad853b697d/pluggy-1.5.0-py3-none-any.whl", hash = "sha256:44e1ad92c8ca002de6377e165f3e0f1be63266ab4d554740532335b9d75ea669", size = 20556 }, ] +[[package]] +name = "posthog" +version = "3.14.2" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "backoff" }, + { name = "monotonic" }, + { name = "python-dateutil" }, + { name = "requests" }, + { name = "six" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/b2/34/6f7b96f29143506c95c1a3c50b83f085828432ca97d5aa2a427df180877c/posthog-3.14.2.tar.gz", hash = "sha256:b9794aa5b316767cc7f8685292f8ff3e0df8b01fcaf2905afe2efa9696cb5c77", size = 63157 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/7b/4d/a293066f66bce78bd57bbc9cb0efd227d427d62cf1a323b5bcad6f508cac/posthog-3.14.2-py2.py3-none-any.whl", hash = "sha256:f50d41dfe116ace4971b304518de57e0de34a936cdfdff84efed0dd993dfbcda", size = 73854 }, +] + [[package]] name = "pre-commit" version = "4.1.0" @@ -549,7 +2114,154 @@ dependencies = [ ] sdist = { url = "https://files.pythonhosted.org/packages/2a/13/b62d075317d8686071eb843f0bb1f195eb332f48869d3c31a4c6f1e063ac/pre_commit-4.1.0.tar.gz", hash = "sha256:ae3f018575a588e30dfddfab9a05448bfbd6b73d78709617b5a2b853549716d4", size = 193330 } wheels = [ - { url = "https://files.pythonhosted.org/packages/43/b3/df14c580d82b9627d173ceea305ba898dca135feb360b6d84019d0803d3b/pre_commit-4.1.0-py2.py3-none-any.whl", hash = "sha256:d29e7cb346295bcc1cc75fc3e92e343495e3ea0196c9ec6ba53f49f10ab6ae7b", size = 220560 }, + { url = "https://files.pythonhosted.org/packages/43/b3/df14c580d82b9627d173ceea305ba898dca135feb360b6d84019d0803d3b/pre_commit-4.1.0-py2.py3-none-any.whl", hash = "sha256:d29e7cb346295bcc1cc75fc3e92e343495e3ea0196c9ec6ba53f49f10ab6ae7b", size = 220560 }, +] + +[[package]] +name = "prompt-toolkit" +version = "3.0.50" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "wcwidth" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/a1/e1/bd15cb8ffdcfeeb2bdc215de3c3cffca11408d829e4b8416dcfe71ba8854/prompt_toolkit-3.0.50.tar.gz", hash = "sha256:544748f3860a2623ca5cd6d2795e7a14f3d0e1c3c9728359013f79877fc89bab", size = 429087 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/e4/ea/d836f008d33151c7a1f62caf3d8dd782e4d15f6a43897f64480c2b8de2ad/prompt_toolkit-3.0.50-py3-none-any.whl", hash = "sha256:9b6427eb19e479d98acff65196a307c555eb567989e6d88ebbb1b509d9779198", size = 387816 }, +] + +[[package]] +name = "propcache" +version = "0.3.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/92/76/f941e63d55c0293ff7829dd21e7cf1147e90a526756869a9070f287a68c9/propcache-0.3.0.tar.gz", hash = "sha256:a8fd93de4e1d278046345f49e2238cdb298589325849b2645d4a94c53faeffc5", size = 42722 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/45/c9/cf09ff7e6d09f14149094f7cd50d2dec032b24e61af21fc4540da2b17bfb/propcache-0.3.0-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:9ddd49258610499aab83b4f5b61b32e11fce873586282a0e972e5ab3bcadee51", size = 79568 }, + { url = "https://files.pythonhosted.org/packages/c8/32/2424d89da88cd81b7d148e0d2b3131461b570a02aa9d84a2e567509adb0d/propcache-0.3.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:2578541776769b500bada3f8a4eeaf944530516b6e90c089aa368266ed70c49e", size = 45895 }, + { url = "https://files.pythonhosted.org/packages/f6/91/ee5b6aa7aa31754fefcf0c5180e09223cac380ef195c4ddc8c266eb641ea/propcache-0.3.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:d8074c5dd61c8a3e915fa8fc04754fa55cfa5978200d2daa1e2d4294c1f136aa", size = 45427 }, + { url = "https://files.pythonhosted.org/packages/bf/73/38f0128462b8b616181d8c53bd5d04eac41c50c449b07615c65d56ba0a9b/propcache-0.3.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:b58229a844931bca61b3a20efd2be2a2acb4ad1622fc026504309a6883686fbf", size = 232427 }, + { url = "https://files.pythonhosted.org/packages/59/82/f3d4e84f4539dcfc9c3d338282b9e915f5b63c921986ecfdf7af2d12f87c/propcache-0.3.0-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e45377d5d6fefe1677da2a2c07b024a6dac782088e37c0b1efea4cfe2b1be19b", size = 239985 }, + { url = "https://files.pythonhosted.org/packages/42/e8/029f58cccbae83c9969a7ee7a06558d5b83a93dfc54e0f4f70234bbaea1b/propcache-0.3.0-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:ec5060592d83454e8063e487696ac3783cc48c9a329498bafae0d972bc7816c9", size = 238827 }, + { url = "https://files.pythonhosted.org/packages/8b/a2/c373561777c0cb9b9e7b9b9a10b9b3a7b6bde75a2535b962231cecc8fdb8/propcache-0.3.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:15010f29fbed80e711db272909a074dc79858c6d28e2915704cfc487a8ac89c6", size = 231348 }, + { url = "https://files.pythonhosted.org/packages/d7/d2/4673f715beedf6038b485bcd976813149231d9df5bb6196cb69a09c185c9/propcache-0.3.0-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a254537b9b696ede293bfdbc0a65200e8e4507bc9f37831e2a0318a9b333c85c", size = 220426 }, + { url = "https://files.pythonhosted.org/packages/e0/f6/1da65f900927bafd4675a16e890618ec7643f2f922bf0e4d84bb38645618/propcache-0.3.0-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:2b975528998de037dfbc10144b8aed9b8dd5a99ec547f14d1cb7c5665a43f075", size = 220294 }, + { url = "https://files.pythonhosted.org/packages/ff/86/620451bdc02e91b1712cd71890c17077ee97e2a28493836a87e47b8e70ff/propcache-0.3.0-cp311-cp311-musllinux_1_2_armv7l.whl", hash = "sha256:19d36bb351ad5554ff20f2ae75f88ce205b0748c38b146c75628577020351e3c", size = 212492 }, + { url = "https://files.pythonhosted.org/packages/6e/1b/e8f86921ed4016da80faf3b8f515f7829decabdbff106736bfff353bceba/propcache-0.3.0-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:6032231d4a5abd67c7f71168fd64a47b6b451fbcb91c8397c2f7610e67683810", size = 215113 }, + { url = "https://files.pythonhosted.org/packages/1a/95/a61d86cc49aa0945f6c06f3a4614fc543e311a50558c92861f5e9691a37c/propcache-0.3.0-cp311-cp311-musllinux_1_2_ppc64le.whl", hash = "sha256:6985a593417cdbc94c7f9c3403747335e450c1599da1647a5af76539672464d3", size = 228330 }, + { url = "https://files.pythonhosted.org/packages/8f/7d/10dbae48ff2bb189e92c2b3487a48f3229146a25941ad0d485934d1104d4/propcache-0.3.0-cp311-cp311-musllinux_1_2_s390x.whl", hash = "sha256:6a1948df1bb1d56b5e7b0553c0fa04fd0e320997ae99689488201f19fa90d2e7", size = 231942 }, + { url = "https://files.pythonhosted.org/packages/39/ce/82d16aec96c5513ae7db13ab901a65a1e54c915292fb5b2390e33275b61d/propcache-0.3.0-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:8319293e85feadbbfe2150a5659dbc2ebc4afdeaf7d98936fb9a2f2ba0d4c35c", size = 223077 }, + { url = "https://files.pythonhosted.org/packages/c8/e0/cb077e8e7a583c733df7f53327fcbdb92e42be59b976ce60bf1d904a0efe/propcache-0.3.0-cp311-cp311-win32.whl", hash = "sha256:63f26258a163c34542c24808f03d734b338da66ba91f410a703e505c8485791d", size = 40455 }, + { url = "https://files.pythonhosted.org/packages/d8/35/57abeb6146fe3c19081eeaf3d9d4cfea256f87f1e5101acf80d3332c1820/propcache-0.3.0-cp311-cp311-win_amd64.whl", hash = "sha256:cacea77ef7a2195f04f9279297684955e3d1ae4241092ff0cfcef532bb7a1c32", size = 44705 }, + { url = "https://files.pythonhosted.org/packages/8d/2c/921f15dc365796ec23975b322b0078eae72995c7b4d49eba554c6a308d70/propcache-0.3.0-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:e53d19c2bf7d0d1e6998a7e693c7e87300dd971808e6618964621ccd0e01fe4e", size = 79867 }, + { url = "https://files.pythonhosted.org/packages/11/a5/4a6cc1a559d1f2fb57ea22edc4245158cdffae92f7f92afcee2913f84417/propcache-0.3.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:a61a68d630e812b67b5bf097ab84e2cd79b48c792857dc10ba8a223f5b06a2af", size = 46109 }, + { url = "https://files.pythonhosted.org/packages/e1/6d/28bfd3af3a567ad7d667348e7f46a520bda958229c4d545ba138a044232f/propcache-0.3.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:fb91d20fa2d3b13deea98a690534697742029f4fb83673a3501ae6e3746508b5", size = 45635 }, + { url = "https://files.pythonhosted.org/packages/73/20/d75b42eaffe5075eac2f4e168f6393d21c664c91225288811d85451b2578/propcache-0.3.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:67054e47c01b7b349b94ed0840ccae075449503cf1fdd0a1fdd98ab5ddc2667b", size = 242159 }, + { url = "https://files.pythonhosted.org/packages/a5/fb/4b537dd92f9fd4be68042ec51c9d23885ca5fafe51ec24c58d9401034e5f/propcache-0.3.0-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:997e7b8f173a391987df40f3b52c423e5850be6f6df0dcfb5376365440b56667", size = 248163 }, + { url = "https://files.pythonhosted.org/packages/e7/af/8a9db04ac596d531ca0ef7dde518feaadfcdabef7b17d6a5ec59ee3effc2/propcache-0.3.0-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:8d663fd71491dde7dfdfc899d13a067a94198e90695b4321084c6e450743b8c7", size = 248794 }, + { url = "https://files.pythonhosted.org/packages/9d/c4/ecfc988879c0fd9db03228725b662d76cf484b6b46f7e92fee94e4b52490/propcache-0.3.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8884ba1a0fe7210b775106b25850f5e5a9dc3c840d1ae9924ee6ea2eb3acbfe7", size = 243912 }, + { url = "https://files.pythonhosted.org/packages/04/a2/298dd27184faa8b7d91cc43488b578db218b3cc85b54d912ed27b8c5597a/propcache-0.3.0-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:aa806bbc13eac1ab6291ed21ecd2dd426063ca5417dd507e6be58de20e58dfcf", size = 229402 }, + { url = "https://files.pythonhosted.org/packages/be/0d/efe7fec316ca92dbf4bc4a9ba49ca889c43ca6d48ab1d6fa99fc94e5bb98/propcache-0.3.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:6f4d7a7c0aff92e8354cceca6fe223973ddf08401047920df0fcb24be2bd5138", size = 226896 }, + { url = "https://files.pythonhosted.org/packages/60/63/72404380ae1d9c96d96e165aa02c66c2aae6072d067fc4713da5cde96762/propcache-0.3.0-cp312-cp312-musllinux_1_2_armv7l.whl", hash = "sha256:9be90eebc9842a93ef8335291f57b3b7488ac24f70df96a6034a13cb58e6ff86", size = 221447 }, + { url = "https://files.pythonhosted.org/packages/9d/18/b8392cab6e0964b67a30a8f4dadeaff64dc7022b5a34bb1d004ea99646f4/propcache-0.3.0-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:bf15fc0b45914d9d1b706f7c9c4f66f2b7b053e9517e40123e137e8ca8958b3d", size = 222440 }, + { url = "https://files.pythonhosted.org/packages/6f/be/105d9ceda0f97eff8c06bac1673448b2db2a497444de3646464d3f5dc881/propcache-0.3.0-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:5a16167118677d94bb48bfcd91e420088854eb0737b76ec374b91498fb77a70e", size = 234104 }, + { url = "https://files.pythonhosted.org/packages/cb/c9/f09a4ec394cfcce4053d8b2a04d622b5f22d21ba9bb70edd0cad061fa77b/propcache-0.3.0-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:41de3da5458edd5678b0f6ff66691507f9885f5fe6a0fb99a5d10d10c0fd2d64", size = 239086 }, + { url = "https://files.pythonhosted.org/packages/ea/aa/96f7f9ed6def82db67c972bdb7bd9f28b95d7d98f7e2abaf144c284bf609/propcache-0.3.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:728af36011bb5d344c4fe4af79cfe186729efb649d2f8b395d1572fb088a996c", size = 230991 }, + { url = "https://files.pythonhosted.org/packages/5a/11/bee5439de1307d06fad176f7143fec906e499c33d7aff863ea8428b8e98b/propcache-0.3.0-cp312-cp312-win32.whl", hash = "sha256:6b5b7fd6ee7b54e01759f2044f936dcf7dea6e7585f35490f7ca0420fe723c0d", size = 40337 }, + { url = "https://files.pythonhosted.org/packages/e4/17/e5789a54a0455a61cb9efc4ca6071829d992220c2998a27c59aeba749f6f/propcache-0.3.0-cp312-cp312-win_amd64.whl", hash = "sha256:2d15bc27163cd4df433e75f546b9ac31c1ba7b0b128bfb1b90df19082466ff57", size = 44404 }, + { url = "https://files.pythonhosted.org/packages/3a/0f/a79dd23a0efd6ee01ab0dc9750d8479b343bfd0c73560d59d271eb6a99d4/propcache-0.3.0-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:a2b9bf8c79b660d0ca1ad95e587818c30ccdb11f787657458d6f26a1ea18c568", size = 77287 }, + { url = "https://files.pythonhosted.org/packages/b8/51/76675703c90de38ac75adb8deceb3f3ad99b67ff02a0fa5d067757971ab8/propcache-0.3.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:b0c1a133d42c6fc1f5fbcf5c91331657a1ff822e87989bf4a6e2e39b818d0ee9", size = 44923 }, + { url = "https://files.pythonhosted.org/packages/01/9b/fd5ddbee66cf7686e73c516227c2fd9bf471dbfed0f48329d095ea1228d3/propcache-0.3.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:bb2f144c6d98bb5cbc94adeb0447cfd4c0f991341baa68eee3f3b0c9c0e83767", size = 44325 }, + { url = "https://files.pythonhosted.org/packages/13/1c/6961f11eb215a683b34b903b82bde486c606516c1466bf1fa67f26906d51/propcache-0.3.0-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d1323cd04d6e92150bcc79d0174ce347ed4b349d748b9358fd2e497b121e03c8", size = 225116 }, + { url = "https://files.pythonhosted.org/packages/ef/ea/f8410c40abcb2e40dffe9adeed017898c930974650a63e5c79b886aa9f73/propcache-0.3.0-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:3b812b3cb6caacd072276ac0492d249f210006c57726b6484a1e1805b3cfeea0", size = 229905 }, + { url = "https://files.pythonhosted.org/packages/ef/5a/a9bf90894001468bf8e6ea293bb00626cc9ef10f8eb7996e9ec29345c7ed/propcache-0.3.0-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:742840d1d0438eb7ea4280f3347598f507a199a35a08294afdcc560c3739989d", size = 233221 }, + { url = "https://files.pythonhosted.org/packages/dd/ce/fffdddd9725b690b01d345c1156b4c2cc6dca09ab5c23a6d07b8f37d6e2f/propcache-0.3.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7c6e7e4f9167fddc438cd653d826f2222222564daed4116a02a184b464d3ef05", size = 227627 }, + { url = "https://files.pythonhosted.org/packages/58/ae/45c89a5994a334735a3032b48e8e4a98c05d9536ddee0719913dc27da548/propcache-0.3.0-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a94ffc66738da99232ddffcf7910e0f69e2bbe3a0802e54426dbf0714e1c2ffe", size = 214217 }, + { url = "https://files.pythonhosted.org/packages/01/84/bc60188c3290ff8f5f4a92b9ca2d93a62e449c8daf6fd11ad517ad136926/propcache-0.3.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:3c6ec957025bf32b15cbc6b67afe233c65b30005e4c55fe5768e4bb518d712f1", size = 212921 }, + { url = "https://files.pythonhosted.org/packages/14/b3/39d60224048feef7a96edabb8217dc3f75415457e5ebbef6814f8b2a27b5/propcache-0.3.0-cp313-cp313-musllinux_1_2_armv7l.whl", hash = "sha256:549722908de62aa0b47a78b90531c022fa6e139f9166be634f667ff45632cc92", size = 208200 }, + { url = "https://files.pythonhosted.org/packages/9d/b3/0a6720b86791251273fff8a01bc8e628bc70903513bd456f86cde1e1ef84/propcache-0.3.0-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:5d62c4f6706bff5d8a52fd51fec6069bef69e7202ed481486c0bc3874912c787", size = 208400 }, + { url = "https://files.pythonhosted.org/packages/e9/4f/bb470f3e687790547e2e78105fb411f54e0cdde0d74106ccadd2521c6572/propcache-0.3.0-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:24c04f8fbf60094c531667b8207acbae54146661657a1b1be6d3ca7773b7a545", size = 218116 }, + { url = "https://files.pythonhosted.org/packages/34/71/277f7f9add469698ac9724c199bfe06f85b199542121a71f65a80423d62a/propcache-0.3.0-cp313-cp313-musllinux_1_2_s390x.whl", hash = "sha256:7c5f5290799a3f6539cc5e6f474c3e5c5fbeba74a5e1e5be75587746a940d51e", size = 222911 }, + { url = "https://files.pythonhosted.org/packages/92/e3/a7b9782aef5a2fc765b1d97da9ec7aed2f25a4e985703608e73232205e3f/propcache-0.3.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:4fa0e7c9c3cf7c276d4f6ab9af8adddc127d04e0fcabede315904d2ff76db626", size = 216563 }, + { url = "https://files.pythonhosted.org/packages/ab/76/0583ca2c551aa08ffcff87b2c6849c8f01c1f6fb815a5226f0c5c202173e/propcache-0.3.0-cp313-cp313-win32.whl", hash = "sha256:ee0bd3a7b2e184e88d25c9baa6a9dc609ba25b76daae942edfb14499ac7ec374", size = 39763 }, + { url = "https://files.pythonhosted.org/packages/80/ec/c6a84f9a36f608379b95f0e786c111d5465926f8c62f12be8cdadb02b15c/propcache-0.3.0-cp313-cp313-win_amd64.whl", hash = "sha256:1c8f7d896a16da9455f882870a507567d4f58c53504dc2d4b1e1d386dfe4588a", size = 43650 }, + { url = "https://files.pythonhosted.org/packages/ee/95/7d32e3560f5bf83fc2f2a4c1b0c181d327d53d5f85ebd045ab89d4d97763/propcache-0.3.0-cp313-cp313t-macosx_10_13_universal2.whl", hash = "sha256:e560fd75aaf3e5693b91bcaddd8b314f4d57e99aef8a6c6dc692f935cc1e6bbf", size = 82140 }, + { url = "https://files.pythonhosted.org/packages/86/89/752388f12e6027a5e63f5d075f15291ded48e2d8311314fff039da5a9b11/propcache-0.3.0-cp313-cp313t-macosx_10_13_x86_64.whl", hash = "sha256:65a37714b8ad9aba5780325228598a5b16c47ba0f8aeb3dc0514701e4413d7c0", size = 47296 }, + { url = "https://files.pythonhosted.org/packages/1b/4c/b55c98d586c69180d3048984a57a5ea238bdeeccf82dbfcd598e935e10bb/propcache-0.3.0-cp313-cp313t-macosx_11_0_arm64.whl", hash = "sha256:07700939b2cbd67bfb3b76a12e1412405d71019df00ca5697ce75e5ef789d829", size = 46724 }, + { url = "https://files.pythonhosted.org/packages/0f/b6/67451a437aed90c4e951e320b5b3d7eb584ade1d5592f6e5e8f678030989/propcache-0.3.0-cp313-cp313t-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:7c0fdbdf6983526e269e5a8d53b7ae3622dd6998468821d660d0daf72779aefa", size = 291499 }, + { url = "https://files.pythonhosted.org/packages/ee/ff/e4179facd21515b24737e1e26e02615dfb5ed29416eed4cf5bc6ac5ce5fb/propcache-0.3.0-cp313-cp313t-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:794c3dd744fad478b6232289c866c25406ecdfc47e294618bdf1697e69bd64a6", size = 293911 }, + { url = "https://files.pythonhosted.org/packages/76/8d/94a8585992a064a23bd54f56c5e58c3b8bf0c0a06ae10e56f2353ae16c3d/propcache-0.3.0-cp313-cp313t-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:4544699674faf66fb6b4473a1518ae4999c1b614f0b8297b1cef96bac25381db", size = 293301 }, + { url = "https://files.pythonhosted.org/packages/b0/b8/2c860c92b4134f68c7716c6f30a0d723973f881c32a6d7a24c4ddca05fdf/propcache-0.3.0-cp313-cp313t-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fddb8870bdb83456a489ab67c6b3040a8d5a55069aa6f72f9d872235fbc52f54", size = 281947 }, + { url = "https://files.pythonhosted.org/packages/cd/72/b564be7411b525d11757b713c757c21cd4dc13b6569c3b2b8f6d3c96fd5e/propcache-0.3.0-cp313-cp313t-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f857034dc68d5ceb30fb60afb6ff2103087aea10a01b613985610e007053a121", size = 268072 }, + { url = "https://files.pythonhosted.org/packages/37/68/d94649e399e8d7fc051e5a4f2334efc567993525af083db145a70690a121/propcache-0.3.0-cp313-cp313t-musllinux_1_2_aarch64.whl", hash = "sha256:02df07041e0820cacc8f739510078f2aadcfd3fc57eaeeb16d5ded85c872c89e", size = 275190 }, + { url = "https://files.pythonhosted.org/packages/d8/3c/446e125f5bbbc1922964dd67cb541c01cdb678d811297b79a4ff6accc843/propcache-0.3.0-cp313-cp313t-musllinux_1_2_armv7l.whl", hash = "sha256:f47d52fd9b2ac418c4890aad2f6d21a6b96183c98021f0a48497a904199f006e", size = 254145 }, + { url = "https://files.pythonhosted.org/packages/f4/80/fd3f741483dc8e59f7ba7e05eaa0f4e11677d7db2077522b92ff80117a2a/propcache-0.3.0-cp313-cp313t-musllinux_1_2_i686.whl", hash = "sha256:9ff4e9ecb6e4b363430edf2c6e50173a63e0820e549918adef70515f87ced19a", size = 257163 }, + { url = "https://files.pythonhosted.org/packages/dc/cf/6292b5ce6ed0017e6a89024a827292122cc41b6259b30ada0c6732288513/propcache-0.3.0-cp313-cp313t-musllinux_1_2_ppc64le.whl", hash = "sha256:ecc2920630283e0783c22e2ac94427f8cca29a04cfdf331467d4f661f4072dac", size = 280249 }, + { url = "https://files.pythonhosted.org/packages/e8/f0/fd9b8247b449fe02a4f96538b979997e229af516d7462b006392badc59a1/propcache-0.3.0-cp313-cp313t-musllinux_1_2_s390x.whl", hash = "sha256:c441c841e82c5ba7a85ad25986014be8d7849c3cfbdb6004541873505929a74e", size = 288741 }, + { url = "https://files.pythonhosted.org/packages/64/71/cf831fdc2617f86cfd7f414cfc487d018e722dac8acc098366ce9bba0941/propcache-0.3.0-cp313-cp313t-musllinux_1_2_x86_64.whl", hash = "sha256:6c929916cbdb540d3407c66f19f73387f43e7c12fa318a66f64ac99da601bcdf", size = 277061 }, + { url = "https://files.pythonhosted.org/packages/42/78/9432542a35d944abeca9e02927a0de38cd7a298466d8ffa171536e2381c3/propcache-0.3.0-cp313-cp313t-win32.whl", hash = "sha256:0c3e893c4464ebd751b44ae76c12c5f5c1e4f6cbd6fbf67e3783cd93ad221863", size = 42252 }, + { url = "https://files.pythonhosted.org/packages/6f/45/960365f4f8978f48ebb56b1127adf33a49f2e69ecd46ac1f46d6cf78a79d/propcache-0.3.0-cp313-cp313t-win_amd64.whl", hash = "sha256:75e872573220d1ee2305b35c9813626e620768248425f58798413e9c39741f46", size = 46425 }, + { url = "https://files.pythonhosted.org/packages/b5/35/6c4c6fc8774a9e3629cd750dc24a7a4fb090a25ccd5c3246d127b70f9e22/propcache-0.3.0-py3-none-any.whl", hash = "sha256:67dda3c7325691c2081510e92c561f465ba61b975f481735aefdfc845d2cd043", size = 12101 }, +] + +[[package]] +name = "protobuf" +version = "5.29.3" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/f7/d1/e0a911544ca9993e0f17ce6d3cc0932752356c1b0a834397f28e63479344/protobuf-5.29.3.tar.gz", hash = "sha256:5da0f41edaf117bde316404bad1a486cb4ededf8e4a54891296f648e8e076620", size = 424945 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/dc/7a/1e38f3cafa022f477ca0f57a1f49962f21ad25850c3ca0acd3b9d0091518/protobuf-5.29.3-cp310-abi3-win32.whl", hash = "sha256:3ea51771449e1035f26069c4c7fd51fba990d07bc55ba80701c78f886bf9c888", size = 422708 }, + { url = "https://files.pythonhosted.org/packages/61/fa/aae8e10512b83de633f2646506a6d835b151edf4b30d18d73afd01447253/protobuf-5.29.3-cp310-abi3-win_amd64.whl", hash = "sha256:a4fa6f80816a9a0678429e84973f2f98cbc218cca434abe8db2ad0bffc98503a", size = 434508 }, + { url = "https://files.pythonhosted.org/packages/dd/04/3eaedc2ba17a088961d0e3bd396eac764450f431621b58a04ce898acd126/protobuf-5.29.3-cp38-abi3-macosx_10_9_universal2.whl", hash = "sha256:a8434404bbf139aa9e1300dbf989667a83d42ddda9153d8ab76e0d5dcaca484e", size = 417825 }, + { url = "https://files.pythonhosted.org/packages/4f/06/7c467744d23c3979ce250397e26d8ad8eeb2bea7b18ca12ad58313c1b8d5/protobuf-5.29.3-cp38-abi3-manylinux2014_aarch64.whl", hash = "sha256:daaf63f70f25e8689c072cfad4334ca0ac1d1e05a92fc15c54eb9cf23c3efd84", size = 319573 }, + { url = "https://files.pythonhosted.org/packages/a8/45/2ebbde52ad2be18d3675b6bee50e68cd73c9e0654de77d595540b5129df8/protobuf-5.29.3-cp38-abi3-manylinux2014_x86_64.whl", hash = "sha256:c027e08a08be10b67c06bf2370b99c811c466398c357e615ca88c91c07f0910f", size = 319672 }, + { url = "https://files.pythonhosted.org/packages/fd/b2/ab07b09e0f6d143dfb839693aa05765257bceaa13d03bf1a696b78323e7a/protobuf-5.29.3-py3-none-any.whl", hash = "sha256:0a18ed4a24198528f2333802eb075e59dea9d679ab7a6c5efb017a59004d849f", size = 172550 }, +] + +[[package]] +name = "ptyprocess" +version = "0.7.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/20/e5/16ff212c1e452235a90aeb09066144d0c5a6a8c0834397e03f5224495c4e/ptyprocess-0.7.0.tar.gz", hash = "sha256:5c5d0a3b48ceee0b48485e0c26037c0acd7d29765ca3fbb5cb3831d347423220", size = 70762 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/22/a6/858897256d0deac81a172289110f31629fc4cee19b6f01283303e18c8db3/ptyprocess-0.7.0-py2.py3-none-any.whl", hash = "sha256:4b41f3967fce3af57cc7e94b888626c18bf37a083e3651ca8feeb66d492fef35", size = 13993 }, +] + +[[package]] +name = "pure-eval" +version = "0.2.3" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/cd/05/0a34433a064256a578f1783a10da6df098ceaa4a57bbeaa96a6c0352786b/pure_eval-0.2.3.tar.gz", hash = "sha256:5f4e983f40564c576c7c8635ae88db5956bb2229d7e9237d03b3c0b0190eaf42", size = 19752 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/8e/37/efad0257dc6e593a18957422533ff0f87ede7c9c6ea010a2177d738fb82f/pure_eval-0.2.3-py3-none-any.whl", hash = "sha256:1db8e35b67b3d218d818ae653e27f06c3aa420901fa7b081ca98cbedc874e0d0", size = 11842 }, +] + +[[package]] +name = "pyasn1" +version = "0.6.1" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/ba/e9/01f1a64245b89f039897cb0130016d79f77d52669aae6ee7b159a6c4c018/pyasn1-0.6.1.tar.gz", hash = "sha256:6f580d2bdd84365380830acf45550f2511469f673cb4a5ae3857a3170128b034", size = 145322 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/c8/f1/d6a797abb14f6283c0ddff96bbdd46937f64122b8c925cab503dd37f8214/pyasn1-0.6.1-py3-none-any.whl", hash = "sha256:0d632f46f2ba09143da3a8afe9e33fb6f92fa2320ab7e886e2d0f7672af84629", size = 83135 }, +] + +[[package]] +name = "pyasn1-modules" +version = "0.4.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "pyasn1" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/1d/67/6afbf0d507f73c32d21084a79946bfcfca5fbc62a72057e9c23797a737c9/pyasn1_modules-0.4.1.tar.gz", hash = "sha256:c28e2dbf9c06ad61c71a075c7e0f9fd0f1b0bb2d2ad4377f240d33ac2ab60a7c", size = 310028 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/77/89/bc88a6711935ba795a679ea6ebee07e128050d6382eaa35a0a47c8032bdc/pyasn1_modules-0.4.1-py3-none-any.whl", hash = "sha256:49bfa96b45a292b711e986f222502c1c9a5e1f4e568fc30e2574a6c7d07838fd", size = 181537 }, +] + +[[package]] +name = "pycparser" +version = "2.22" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/1d/b2/31537cf4b1ca988837256c910a668b553fceb8f069bedc4b1c826024b52c/pycparser-2.22.tar.gz", hash = "sha256:491c8be9c040f5390f5bf44a5b07752bd07f56edf992381b05c701439eec10f6", size = 172736 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/13/a3/a812df4e2dd5696d1f351d58b8fe16a405b234ad2886a0dab9183fb78109/pycparser-2.22-py3-none-any.whl", hash = "sha256:c3702b6d3dd8c7abc1afa565d7e63d53a1d0bd86cdc24edd75470f4de499cfcc", size = 117552 }, ] [[package]] @@ -628,6 +2340,15 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/8a/0b/9fcc47d19c48b59121088dd6da2488a49d5f72dacf8262e2790a1d2c7d15/pygments-2.19.1-py3-none-any.whl", hash = "sha256:9ea1544ad55cecf4b8242fab6dd35a93bbce657034b0611ee383099054ab6d8c", size = 1225293 }, ] +[[package]] +name = "pyjwt" +version = "2.10.1" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/e7/46/bd74733ff231675599650d3e47f361794b22ef3e3770998dda30d3b63726/pyjwt-2.10.1.tar.gz", hash = "sha256:3cc5772eb20009233caf06e9d8a0577824723b44e6648ee0a2aedb6cf9381953", size = 87785 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/61/ad/689f02752eeec26aed679477e80e632ef1b682313be70793d798c1d5fc8f/PyJWT-2.10.1-py3-none-any.whl", hash = "sha256:dcdd193e30abefd5debf142f9adfcdd2b58004e644f25406ffaebd50bd98dacb", size = 22997 }, +] + [[package]] name = "pymdown-extensions" version = "10.14.3" @@ -641,6 +2362,50 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/eb/f5/b9e2a42aa8f9e34d52d66de87941ecd236570c7ed2e87775ed23bbe4e224/pymdown_extensions-10.14.3-py3-none-any.whl", hash = "sha256:05e0bee73d64b9c71a4ae17c72abc2f700e8bc8403755a00580b49a4e9f189e9", size = 264467 }, ] +[[package]] +name = "pypdfium2" +version = "4.30.1" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/55/d4/905e621c62598a08168c272b42fc00136c8861cfce97afb2a1ecbd99487a/pypdfium2-4.30.1.tar.gz", hash = "sha256:5f5c7c6d03598e107d974f66b220a49436aceb191da34cda5f692be098a814ce", size = 164854 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/30/8e/3ce0856b3af0f058dd3655ce57d31d1dbde4d4bd0e172022ffbf1b58a4b9/pypdfium2-4.30.1-py3-none-macosx_10_13_x86_64.whl", hash = "sha256:e07c47633732cc18d890bb7e965ad28a9c5a932e548acb928596f86be2e5ae37", size = 2889836 }, + { url = "https://files.pythonhosted.org/packages/c2/6a/f6995b21f9c6c155487ce7df70632a2df1ba49efcb291b9943ea45f28b15/pypdfium2-4.30.1-py3-none-macosx_11_0_arm64.whl", hash = "sha256:5ea2d44e96d361123b67b00f527017aa9c847c871b5714e013c01c3eb36a79fe", size = 2769232 }, + { url = "https://files.pythonhosted.org/packages/53/91/79060923148e6d380b8a299b32bba46d70aac5fe1cd4f04320bcbd1a48d3/pypdfium2-4.30.1-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1de7a3a36803171b3f66911131046d65a732f9e7834438191cb58235e6163c4e", size = 2847531 }, + { url = "https://files.pythonhosted.org/packages/a8/6c/93507f87c159e747eaab54352c0fccbaec3f1b3749d0bb9085a47899f898/pypdfium2-4.30.1-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:b8a4231efb13170354f568c722d6540b8d5b476b08825586d48ef70c40d16e03", size = 2636266 }, + { url = "https://files.pythonhosted.org/packages/24/dc/d56f74a092f2091e328d6485f16562e2fc51cffb0ad6d5c616d80c1eb53c/pypdfium2-4.30.1-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:6f434a4934e8244aa95343ffcf24e9ad9f120dbb4785f631bb40a88c39292493", size = 2919296 }, + { url = "https://files.pythonhosted.org/packages/be/d9/a2f1ee03d47fbeb48bcfde47ed7155772739622cfadf7135a84ba6a97824/pypdfium2-4.30.1-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f454032a0bc7681900170f67d8711b3942824531e765f91c2f5ce7937f999794", size = 2866119 }, + { url = "https://files.pythonhosted.org/packages/01/47/6aa019c32aa39d3f33347c458c0c5887e84096cbe444456402bc97e66704/pypdfium2-4.30.1-py3-none-musllinux_1_1_aarch64.whl", hash = "sha256:bbf9130a72370ee9d602e39949b902db669a2a1c24746a91e5586eb829055d9f", size = 6228684 }, + { url = "https://files.pythonhosted.org/packages/4c/07/2954c15b3f7c85ceb80cad36757fd41b3aba0dd14e68f4bed9ce3f2e7e74/pypdfium2-4.30.1-py3-none-musllinux_1_1_i686.whl", hash = "sha256:5cb52884b1583b96e94fd78542c63bb42e06df5e8f9e52f8f31f5ad5a1e53367", size = 6231815 }, + { url = "https://files.pythonhosted.org/packages/b4/9b/b4667e95754624f4af5a912001abba90c046e1c80d4a4e887f0af664ffec/pypdfium2-4.30.1-py3-none-musllinux_1_1_x86_64.whl", hash = "sha256:1a9e372bd4867ff223cc8c338e33fe11055dad12f22885950fc27646cc8d9122", size = 6313429 }, + { url = "https://files.pythonhosted.org/packages/43/38/f9e77cf55ba5546a39fa659404b78b97de2ca344848271e7731efb0954cd/pypdfium2-4.30.1-py3-none-win32.whl", hash = "sha256:421f1cf205e213e07c1f2934905779547f4f4a2ff2f59dde29da3d511d3fc806", size = 2834989 }, + { url = "https://files.pythonhosted.org/packages/a4/f3/8d3a350efb4286b5ebdabcf6736f51d8e3b10dbe68804c6930b00f5cf329/pypdfium2-4.30.1-py3-none-win_amd64.whl", hash = "sha256:598a7f20264ab5113853cba6d86c4566e4356cad037d7d1f849c8c9021007e05", size = 2960157 }, + { url = "https://files.pythonhosted.org/packages/e1/6b/2706497c86e8d69fb76afe5ea857fe1794621aa0f3b1d863feb953fe0f22/pypdfium2-4.30.1-py3-none-win_arm64.whl", hash = "sha256:c2b6d63f6d425d9416c08d2511822b54b8e3ac38e639fc41164b1d75584b3a8c", size = 2814810 }, +] + +[[package]] +name = "pypika" +version = "0.48.9" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/c7/2c/94ed7b91db81d61d7096ac8f2d325ec562fc75e35f3baea8749c85b28784/PyPika-0.48.9.tar.gz", hash = "sha256:838836a61747e7c8380cd1b7ff638694b7a7335345d0f559b04b2cd832ad5378", size = 67259 } + +[[package]] +name = "pyproject-hooks" +version = "1.2.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/e7/82/28175b2414effca1cdac8dc99f76d660e7a4fb0ceefa4b4ab8f5f6742925/pyproject_hooks-1.2.0.tar.gz", hash = "sha256:1e859bd5c40fae9448642dd871adf459e5e2084186e8d2c2a79a824c970da1f8", size = 19228 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/bd/24/12818598c362d7f300f18e74db45963dbcb85150324092410c8b49405e42/pyproject_hooks-1.2.0-py3-none-any.whl", hash = "sha256:9e5c6bfa8dcc30091c74b0cf803c81fdd29d94f01992a7707bc97babb1141913", size = 10216 }, +] + +[[package]] +name = "pyreadline3" +version = "3.5.4" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/0f/49/4cea918a08f02817aabae639e3d0ac046fef9f9180518a3ad394e22da148/pyreadline3-3.5.4.tar.gz", hash = "sha256:8d57d53039a1c75adba8e50dd3d992b28143480816187ea5efbd5c78e6c885b7", size = 99839 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/5a/dc/491b7661614ab97483abf2056be1deee4dc2490ecbf7bff9ab5cdbac86e1/pyreadline3-3.5.4-py3-none-any.whl", hash = "sha256:eaf8e6cc3c49bcccf145fc6067ba8643d1df34d604a1ec0eccbf7a18e6d3fae6", size = 83178 }, +] + [[package]] name = "pytest" version = "8.3.4" @@ -656,6 +2421,43 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/11/92/76a1c94d3afee238333bc0a42b82935dd8f9cf8ce9e336ff87ee14d9e1cf/pytest-8.3.4-py3-none-any.whl", hash = "sha256:50e16d954148559c9a74109af1eaf0c945ba2d8f30f0a3d3335edde19788b6f6", size = 343083 }, ] +[[package]] +name = "pytest-asyncio" +version = "0.25.3" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "pytest" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/f2/a8/ecbc8ede70921dd2f544ab1cadd3ff3bf842af27f87bbdea774c7baa1d38/pytest_asyncio-0.25.3.tar.gz", hash = "sha256:fc1da2cf9f125ada7e710b4ddad05518d4cee187ae9412e9ac9271003497f07a", size = 54239 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/67/17/3493c5624e48fd97156ebaec380dcaafee9506d7e2c46218ceebbb57d7de/pytest_asyncio-0.25.3-py3-none-any.whl", hash = "sha256:9e89518e0f9bd08928f97a3482fdc4e244df17529460bc038291ccaf8f85c7c3", size = 19467 }, +] + +[[package]] +name = "pytest-cov" +version = "6.0.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "coverage", extra = ["toml"] }, + { name = "pytest" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/be/45/9b538de8cef30e17c7b45ef42f538a94889ed6a16f2387a6c89e73220651/pytest-cov-6.0.0.tar.gz", hash = "sha256:fde0b595ca248bb8e2d76f020b465f3b107c9632e6a1d1705f17834c89dcadc0", size = 66945 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/36/3b/48e79f2cd6a61dbbd4807b4ed46cb564b4fd50a76166b1c4ea5c1d9e2371/pytest_cov-6.0.0-py3-none-any.whl", hash = "sha256:eee6f1b9e61008bd34975a4d5bab25801eb31898b032dd55addc93e96fcaaa35", size = 22949 }, +] + +[[package]] +name = "pytest-snapshot" +version = "0.9.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "pytest" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/9b/7b/ab8f1fc1e687218aa66acec1c3674d9c443f6a2dc8cb6a50f464548ffa34/pytest-snapshot-0.9.0.tar.gz", hash = "sha256:c7013c3abc3e860f9feff899f8b4debe3708650d8d8242a61bf2625ff64db7f3", size = 19877 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/cb/29/518f32faf6edad9f56d6e0107217f7de6b79f297a47170414a2bd4be7f01/pytest_snapshot-0.9.0-py3-none-any.whl", hash = "sha256:4b9fe1c21c868fe53a545e4e3184d36bc1c88946e3f5c1d9dd676962a9b3d4ab", size = 10715 }, +] + [[package]] name = "python-dateutil" version = "2.9.0.post0" @@ -677,6 +2479,20 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/6a/3e/b68c118422ec867fa7ab88444e1274aa40681c606d59ac27de5a5588f082/python_dotenv-1.0.1-py3-none-any.whl", hash = "sha256:f7b63ef50f1b690dddf550d03497b66d609393b40b564ed0d674909a68ebf16a", size = 19863 }, ] +[[package]] +name = "pyvis" +version = "0.3.2" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "ipython" }, + { name = "jinja2" }, + { name = "jsonpickle" }, + { name = "networkx" }, +] +wheels = [ + { url = "https://files.pythonhosted.org/packages/ab/4b/e37e4e5d5ee1179694917b445768bdbfb084f5a59ecd38089d3413d4c70f/pyvis-0.3.2-py3-none-any.whl", hash = "sha256:5720c4ca8161dc5d9ab352015723abb7a8bb8fb443edeb07f7a322db34a97555", size = 756038 }, +] + [[package]] name = "pyyaml" version = "6.0.2" @@ -724,6 +2540,20 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/5a/66/bbb1dd374f5c870f59c5bb1db0e18cbe7fa739415a24cbd95b2d1f5ae0c4/pyyaml_env_tag-0.1-py3-none-any.whl", hash = "sha256:af31106dec8a4d68c60207c1886031cbf839b68aa7abccdb19868200532c2069", size = 3911 }, ] +[[package]] +name = "referencing" +version = "0.36.2" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "attrs" }, + { name = "rpds-py" }, + { name = "typing-extensions", marker = "python_full_version < '3.13'" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/2f/db/98b5c277be99dd18bfd91dd04e1b759cad18d1a338188c936e92f921c7e2/referencing-0.36.2.tar.gz", hash = "sha256:df2e89862cd09deabbdba16944cc3f10feb6b3e6f18e902f7cc25609a34775aa", size = 74744 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/c1/b1/3baf80dc6d2b7bc27a95a67752d0208e410351e3feb4eb78de5f77454d8d/referencing-0.36.2-py3-none-any.whl", hash = "sha256:e8699adbbf8b5c7de96d8ffa0eb5c158b3beafce084968e2ea8bb08c6794dcd0", size = 26775 }, +] + [[package]] name = "regex" version = "2024.11.6" @@ -792,6 +2622,116 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/f9/9b/335f9764261e915ed497fcdeb11df5dfd6f7bf257d4a6a2a686d80da4d54/requests-2.32.3-py3-none-any.whl", hash = "sha256:70761cfe03c773ceb22aa2f671b4757976145175cdfca038c02654d061d6dcc6", size = 64928 }, ] +[[package]] +name = "requests-oauthlib" +version = "2.0.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "oauthlib" }, + { name = "requests" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/42/f2/05f29bc3913aea15eb670be136045bf5c5bbf4b99ecb839da9b422bb2c85/requests-oauthlib-2.0.0.tar.gz", hash = "sha256:b3dffaebd884d8cd778494369603a9e7b58d29111bf6b41bdc2dcd87203af4e9", size = 55650 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/3b/5d/63d4ae3b9daea098d5d6f5da83984853c1bbacd5dc826764b249fe119d24/requests_oauthlib-2.0.0-py2.py3-none-any.whl", hash = "sha256:7dd8a5c40426b779b0868c404bdef9768deccf22749cde15852df527e6269b36", size = 24179 }, +] + +[[package]] +name = "requests-toolbelt" +version = "1.0.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "requests" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/f3/61/d7545dafb7ac2230c70d38d31cbfe4cc64f7144dc41f6e4e4b78ecd9f5bb/requests-toolbelt-1.0.0.tar.gz", hash = "sha256:7681a0a3d047012b5bdc0ee37d7f8f07ebe76ab08caeccfc3921ce23c88d5bc6", size = 206888 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/3f/51/d4db610ef29373b879047326cbf6fa98b6c1969d6f6dc423279de2b1be2c/requests_toolbelt-1.0.0-py2.py3-none-any.whl", hash = "sha256:cccfdd665f0a24fcf4726e690f65639d272bb0637b9b92dfd91a5568ccf6bd06", size = 54481 }, +] + +[[package]] +name = "rich" +version = "13.9.4" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "markdown-it-py" }, + { name = "pygments" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/ab/3a/0316b28d0761c6734d6bc14e770d85506c986c85ffb239e688eeaab2c2bc/rich-13.9.4.tar.gz", hash = "sha256:439594978a49a09530cff7ebc4b5c7103ef57baf48d5ea3184f21d9a2befa098", size = 223149 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/19/71/39c7c0d87f8d4e6c020a393182060eaefeeae6c01dab6a84ec346f2567df/rich-13.9.4-py3-none-any.whl", hash = "sha256:6049d5e6ec054bf2779ab3358186963bac2ea89175919d699e378b99738c2a90", size = 242424 }, +] + +[[package]] +name = "rpds-py" +version = "0.23.1" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/0a/79/2ce611b18c4fd83d9e3aecb5cba93e1917c050f556db39842889fa69b79f/rpds_py-0.23.1.tar.gz", hash = "sha256:7f3240dcfa14d198dba24b8b9cb3b108c06b68d45b7babd9eefc1038fdf7e707", size = 26806 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/1c/67/6e5d4234bb9dee062ffca2a5f3c7cd38716317d6760ec235b175eed4de2c/rpds_py-0.23.1-cp311-cp311-macosx_10_12_x86_64.whl", hash = "sha256:b79f5ced71efd70414a9a80bbbfaa7160da307723166f09b69773153bf17c590", size = 372264 }, + { url = "https://files.pythonhosted.org/packages/a7/0a/3dedb2daee8e783622427f5064e2d112751d8276ee73aa5409f000a132f4/rpds_py-0.23.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:c9e799dac1ffbe7b10c1fd42fe4cd51371a549c6e108249bde9cd1200e8f59b4", size = 356883 }, + { url = "https://files.pythonhosted.org/packages/ed/fc/e1acef44f9c24b05fe5434b235f165a63a52959ac655e3f7a55726cee1a4/rpds_py-0.23.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:721f9c4011b443b6e84505fc00cc7aadc9d1743f1c988e4c89353e19c4a968ee", size = 385624 }, + { url = "https://files.pythonhosted.org/packages/97/0a/a05951f6465d01622720c03ef6ef31adfbe865653e05ed7c45837492f25e/rpds_py-0.23.1-cp311-cp311-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:f88626e3f5e57432e6191cd0c5d6d6b319b635e70b40be2ffba713053e5147dd", size = 391500 }, + { url = "https://files.pythonhosted.org/packages/ea/2e/cca0583ec0690ea441dceae23c0673b99755710ea22f40bccf1e78f41481/rpds_py-0.23.1-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:285019078537949cecd0190f3690a0b0125ff743d6a53dfeb7a4e6787af154f5", size = 444869 }, + { url = "https://files.pythonhosted.org/packages/cc/e6/95cda68b33a6d814d1e96b0e406d231ed16629101460d1740e92f03365e6/rpds_py-0.23.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b92f5654157de1379c509b15acec9d12ecf6e3bc1996571b6cb82a4302060447", size = 444930 }, + { url = "https://files.pythonhosted.org/packages/5f/a7/e94cdb73411ae9c11414d3c7c9a6ad75d22ad4a8d094fb45a345ba9e3018/rpds_py-0.23.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e768267cbe051dd8d1c5305ba690bb153204a09bf2e3de3ae530de955f5b5580", size = 386254 }, + { url = "https://files.pythonhosted.org/packages/dd/c5/a4a943d90a39e85efd1e04b1ad5129936786f9a9aa27bb7be8fc5d9d50c9/rpds_py-0.23.1-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:c5334a71f7dc1160382d45997e29f2637c02f8a26af41073189d79b95d3321f1", size = 417090 }, + { url = "https://files.pythonhosted.org/packages/0c/a0/80d0013b12428d1fce0ab4e71829400b0a32caec12733c79e6109f843342/rpds_py-0.23.1-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:d6adb81564af0cd428910f83fa7da46ce9ad47c56c0b22b50872bc4515d91966", size = 557639 }, + { url = "https://files.pythonhosted.org/packages/a6/92/ec2e6980afb964a2cd7a99cbdef1f6c01116abe94b42cbe336ac93dd11c2/rpds_py-0.23.1-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:cafa48f2133d4daa028473ede7d81cd1b9f9e6925e9e4003ebdf77010ee02f35", size = 584572 }, + { url = "https://files.pythonhosted.org/packages/3d/ce/75b6054db34a390789a82523790717b27c1bd735e453abb429a87c4f0f26/rpds_py-0.23.1-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:0fced9fd4a07a1ded1bac7e961ddd9753dd5d8b755ba8e05acba54a21f5f1522", size = 553028 }, + { url = "https://files.pythonhosted.org/packages/cc/24/f45abe0418c06a5cba0f846e967aa27bac765acd927aabd857c21319b8cc/rpds_py-0.23.1-cp311-cp311-win32.whl", hash = "sha256:243241c95174b5fb7204c04595852fe3943cc41f47aa14c3828bc18cd9d3b2d6", size = 220862 }, + { url = "https://files.pythonhosted.org/packages/2d/a6/3c0880e8bbfc36451ef30dc416266f6d2934705e468db5d21c8ba0ab6400/rpds_py-0.23.1-cp311-cp311-win_amd64.whl", hash = "sha256:11dd60b2ffddba85715d8a66bb39b95ddbe389ad2cfcf42c833f1bcde0878eaf", size = 232953 }, + { url = "https://files.pythonhosted.org/packages/f3/8c/d17efccb9f5b9137ddea706664aebae694384ae1d5997c0202093e37185a/rpds_py-0.23.1-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:3902df19540e9af4cc0c3ae75974c65d2c156b9257e91f5101a51f99136d834c", size = 364369 }, + { url = "https://files.pythonhosted.org/packages/6e/c0/ab030f696b5c573107115a88d8d73d80f03309e60952b64c584c70c659af/rpds_py-0.23.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:66f8d2a17e5838dd6fb9be6baaba8e75ae2f5fa6b6b755d597184bfcd3cb0eba", size = 349965 }, + { url = "https://files.pythonhosted.org/packages/b3/55/b40170f5a079c4fb0b6a82b299689e66e744edca3c3375a8b160fb797660/rpds_py-0.23.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:112b8774b0b4ee22368fec42749b94366bd9b536f8f74c3d4175d4395f5cbd31", size = 389064 }, + { url = "https://files.pythonhosted.org/packages/ab/1c/b03a912c59ec7c1e16b26e587b9dfa8ddff3b07851e781e8c46e908a365a/rpds_py-0.23.1-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:e0df046f2266e8586cf09d00588302a32923eb6386ced0ca5c9deade6af9a149", size = 397741 }, + { url = "https://files.pythonhosted.org/packages/52/6f/151b90792b62fb6f87099bcc9044c626881fdd54e31bf98541f830b15cea/rpds_py-0.23.1-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:0f3288930b947cbebe767f84cf618d2cbe0b13be476e749da0e6a009f986248c", size = 448784 }, + { url = "https://files.pythonhosted.org/packages/71/2a/6de67c0c97ec7857e0e9e5cd7c52405af931b303eb1e5b9eff6c50fd9a2e/rpds_py-0.23.1-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:ce473a2351c018b06dd8d30d5da8ab5a0831056cc53b2006e2a8028172c37ce5", size = 440203 }, + { url = "https://files.pythonhosted.org/packages/db/5e/e759cd1c276d98a4b1f464b17a9bf66c65d29f8f85754e27e1467feaa7c3/rpds_py-0.23.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d550d7e9e7d8676b183b37d65b5cd8de13676a738973d330b59dc8312df9c5dc", size = 391611 }, + { url = "https://files.pythonhosted.org/packages/1c/1e/2900358efcc0d9408c7289769cba4c0974d9db314aa884028ed7f7364f61/rpds_py-0.23.1-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:e14f86b871ea74c3fddc9a40e947d6a5d09def5adc2076ee61fb910a9014fb35", size = 423306 }, + { url = "https://files.pythonhosted.org/packages/23/07/6c177e6d059f5d39689352d6c69a926ee4805ffdb6f06203570234d3d8f7/rpds_py-0.23.1-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:1bf5be5ba34e19be579ae873da515a2836a2166d8d7ee43be6ff909eda42b72b", size = 562323 }, + { url = "https://files.pythonhosted.org/packages/70/e4/f9097fd1c02b516fff9850792161eb9fc20a2fd54762f3c69eae0bdb67cb/rpds_py-0.23.1-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:d7031d493c4465dbc8d40bd6cafefef4bd472b17db0ab94c53e7909ee781b9ef", size = 588351 }, + { url = "https://files.pythonhosted.org/packages/87/39/5db3c6f326bfbe4576ae2af6435bd7555867d20ae690c786ff33659f293b/rpds_py-0.23.1-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:55ff4151cfd4bc635e51cfb1c59ac9f7196b256b12e3a57deb9e5742e65941ad", size = 557252 }, + { url = "https://files.pythonhosted.org/packages/fd/14/2d5ad292f144fa79bafb78d2eb5b8a3a91c358b6065443cb9c49b5d1fedf/rpds_py-0.23.1-cp312-cp312-win32.whl", hash = "sha256:a9d3b728f5a5873d84cba997b9d617c6090ca5721caaa691f3b1a78c60adc057", size = 222181 }, + { url = "https://files.pythonhosted.org/packages/a3/4f/0fce63e0f5cdd658e71e21abd17ac1bc9312741ebb8b3f74eeed2ebdf771/rpds_py-0.23.1-cp312-cp312-win_amd64.whl", hash = "sha256:b03a8d50b137ee758e4c73638b10747b7c39988eb8e6cd11abb7084266455165", size = 237426 }, + { url = "https://files.pythonhosted.org/packages/13/9d/b8b2c0edffb0bed15be17b6d5ab06216f2f47f9ee49259c7e96a3ad4ca42/rpds_py-0.23.1-cp313-cp313-macosx_10_12_x86_64.whl", hash = "sha256:4caafd1a22e5eaa3732acb7672a497123354bef79a9d7ceed43387d25025e935", size = 363672 }, + { url = "https://files.pythonhosted.org/packages/bd/c2/5056fa29e6894144d7ba4c938b9b0445f75836b87d2dd00ed4999dc45a8c/rpds_py-0.23.1-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:178f8a60fc24511c0eb756af741c476b87b610dba83270fce1e5a430204566a4", size = 349602 }, + { url = "https://files.pythonhosted.org/packages/b0/bc/33779a1bb0ee32d8d706b173825aab75c628521d23ce72a7c1e6a6852f86/rpds_py-0.23.1-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c632419c3870507ca20a37c8f8f5352317aca097639e524ad129f58c125c61c6", size = 388746 }, + { url = "https://files.pythonhosted.org/packages/62/0b/71db3e36b7780a619698ec82a9c87ab44ad7ca7f5480913e8a59ff76f050/rpds_py-0.23.1-cp313-cp313-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:698a79d295626ee292d1730bc2ef6e70a3ab135b1d79ada8fde3ed0047b65a10", size = 397076 }, + { url = "https://files.pythonhosted.org/packages/bb/2e/494398f613edf77ba10a916b1ddea2acce42ab0e3b62e2c70ffc0757ce00/rpds_py-0.23.1-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:271fa2184cf28bdded86bb6217c8e08d3a169fe0bbe9be5e8d96e8476b707122", size = 448399 }, + { url = "https://files.pythonhosted.org/packages/dd/53/4bd7f5779b1f463243ee5fdc83da04dd58a08f86e639dbffa7a35f969a84/rpds_py-0.23.1-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b91cceb5add79ee563bd1f70b30896bd63bc5f78a11c1f00a1e931729ca4f1f4", size = 439764 }, + { url = "https://files.pythonhosted.org/packages/f6/55/b3c18c04a460d951bf8e91f2abf46ce5b6426fb69784166a6a25827cb90a/rpds_py-0.23.1-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f3a6cb95074777f1ecda2ca4fa7717caa9ee6e534f42b7575a8f0d4cb0c24013", size = 390662 }, + { url = "https://files.pythonhosted.org/packages/2a/65/cc463044a3cbd616029b2aa87a651cdee8288d2fdd7780b2244845e934c1/rpds_py-0.23.1-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:50fb62f8d8364978478b12d5f03bf028c6bc2af04082479299139dc26edf4c64", size = 422680 }, + { url = "https://files.pythonhosted.org/packages/fa/8e/1fa52990c7836d72e8d70cd7753f2362c72fbb0a49c1462e8c60e7176d0b/rpds_py-0.23.1-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:c8f7e90b948dc9dcfff8003f1ea3af08b29c062f681c05fd798e36daa3f7e3e8", size = 561792 }, + { url = "https://files.pythonhosted.org/packages/57/b8/fe3b612979b1a29d0c77f8585903d8b3a292604b26d4b300e228b8ac6360/rpds_py-0.23.1-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:5b98b6c953e5c2bda51ab4d5b4f172617d462eebc7f4bfdc7c7e6b423f6da957", size = 588127 }, + { url = "https://files.pythonhosted.org/packages/44/2d/fde474de516bbc4b9b230f43c98e7f8acc5da7fc50ceed8e7af27553d346/rpds_py-0.23.1-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:2893d778d4671ee627bac4037a075168b2673c57186fb1a57e993465dbd79a93", size = 556981 }, + { url = "https://files.pythonhosted.org/packages/18/57/767deeb27b81370bbab8f74ef6e68d26c4ea99018f3c71a570e506fede85/rpds_py-0.23.1-cp313-cp313-win32.whl", hash = "sha256:2cfa07c346a7ad07019c33fb9a63cf3acb1f5363c33bc73014e20d9fe8b01cdd", size = 221936 }, + { url = "https://files.pythonhosted.org/packages/7d/6c/3474cfdd3cafe243f97ab8474ea8949236eb2a1a341ca55e75ce00cd03da/rpds_py-0.23.1-cp313-cp313-win_amd64.whl", hash = "sha256:3aaf141d39f45322e44fc2c742e4b8b4098ead5317e5f884770c8df0c332da70", size = 237145 }, + { url = "https://files.pythonhosted.org/packages/ec/77/e985064c624230f61efa0423759bb066da56ebe40c654f8b5ba225bd5d63/rpds_py-0.23.1-cp313-cp313t-macosx_10_12_x86_64.whl", hash = "sha256:759462b2d0aa5a04be5b3e37fb8183615f47014ae6b116e17036b131985cb731", size = 359623 }, + { url = "https://files.pythonhosted.org/packages/62/d9/a33dcbf62b29e40559e012d525bae7d516757cf042cc9234bd34ca4b6aeb/rpds_py-0.23.1-cp313-cp313t-macosx_11_0_arm64.whl", hash = "sha256:3e9212f52074fc9d72cf242a84063787ab8e21e0950d4d6709886fb62bcb91d5", size = 345900 }, + { url = "https://files.pythonhosted.org/packages/92/eb/f81a4be6397861adb2cb868bb6a28a33292c2dcac567d1dc575226055e55/rpds_py-0.23.1-cp313-cp313t-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:9e9f3a3ac919406bc0414bbbd76c6af99253c507150191ea79fab42fdb35982a", size = 386426 }, + { url = "https://files.pythonhosted.org/packages/09/47/1f810c9b5e83be005341201b5389f1d240dfa440346ea7189f9b3fd6961d/rpds_py-0.23.1-cp313-cp313t-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:c04ca91dda8a61584165825907f5c967ca09e9c65fe8966ee753a3f2b019fe1e", size = 392314 }, + { url = "https://files.pythonhosted.org/packages/83/bd/bc95831432fd6c46ed8001f01af26de0763a059d6d7e6d69e3c5bf02917a/rpds_py-0.23.1-cp313-cp313t-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:4ab923167cfd945abb9b51a407407cf19f5bee35001221f2911dc85ffd35ff4f", size = 447706 }, + { url = "https://files.pythonhosted.org/packages/19/3e/567c04c226b1802dc6dc82cad3d53e1fa0a773258571c74ac5d8fbde97ed/rpds_py-0.23.1-cp313-cp313t-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:ed6f011bedca8585787e5082cce081bac3d30f54520097b2411351b3574e1219", size = 437060 }, + { url = "https://files.pythonhosted.org/packages/fe/77/a77d2c6afe27ae7d0d55fc32f6841502648070dc8d549fcc1e6d47ff8975/rpds_py-0.23.1-cp313-cp313t-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6959bb9928c5c999aba4a3f5a6799d571ddc2c59ff49917ecf55be2bbb4e3722", size = 389347 }, + { url = "https://files.pythonhosted.org/packages/3f/47/6b256ff20a74cfebeac790ab05586e0ac91f88e331125d4740a6c86fc26f/rpds_py-0.23.1-cp313-cp313t-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:1ed7de3c86721b4e83ac440751329ec6a1102229aa18163f84c75b06b525ad7e", size = 415554 }, + { url = "https://files.pythonhosted.org/packages/fc/29/d4572469a245bc9fc81e35166dca19fc5298d5c43e1a6dd64bf145045193/rpds_py-0.23.1-cp313-cp313t-musllinux_1_2_aarch64.whl", hash = "sha256:5fb89edee2fa237584e532fbf78f0ddd1e49a47c7c8cfa153ab4849dc72a35e6", size = 557418 }, + { url = "https://files.pythonhosted.org/packages/9c/0a/68cf7228895b1a3f6f39f51b15830e62456795e61193d2c8b87fd48c60db/rpds_py-0.23.1-cp313-cp313t-musllinux_1_2_i686.whl", hash = "sha256:7e5413d2e2d86025e73f05510ad23dad5950ab8417b7fc6beaad99be8077138b", size = 583033 }, + { url = "https://files.pythonhosted.org/packages/14/18/017ab41dcd6649ad5db7d00155b4c212b31ab05bd857d5ba73a1617984eb/rpds_py-0.23.1-cp313-cp313t-musllinux_1_2_x86_64.whl", hash = "sha256:d31ed4987d72aabdf521eddfb6a72988703c091cfc0064330b9e5f8d6a042ff5", size = 554880 }, + { url = "https://files.pythonhosted.org/packages/2e/dd/17de89431268da8819d8d51ce67beac28d9b22fccf437bc5d6d2bcd1acdb/rpds_py-0.23.1-cp313-cp313t-win32.whl", hash = "sha256:f3429fb8e15b20961efca8c8b21432623d85db2228cc73fe22756c6637aa39e7", size = 219743 }, + { url = "https://files.pythonhosted.org/packages/68/15/6d22d07e063ce5e9bfbd96db9ec2fbb4693591b4503e3a76996639474d02/rpds_py-0.23.1-cp313-cp313t-win_amd64.whl", hash = "sha256:d6f6512a90bd5cd9030a6237f5346f046c6f0e40af98657568fa45695d4de59d", size = 235415 }, +] + +[[package]] +name = "rsa" +version = "4.9" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "pyasn1" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/aa/65/7d973b89c4d2351d7fb232c2e452547ddfa243e93131e7cfa766da627b52/rsa-4.9.tar.gz", hash = "sha256:e38464a49c6c85d7f1351b0126661487a7e0a14a50f1675ec50eb34d4f20ef21", size = 29711 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/49/97/fa78e3d2f65c02c8e1268b9aba606569fe97f6c8f7c2d74394553347c145/rsa-4.9-py3-none-any.whl", hash = "sha256:90260d9058e514786967344d0ef75fa8727eed8a7d2e43ce9f4bcf1b536174f7", size = 34315 }, +] + [[package]] name = "ruff" version = "0.9.6" @@ -817,6 +2757,15 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/e8/a8/d71f44b93e3aa86ae232af1f2126ca7b95c0f515ec135462b3e1f351441c/ruff-0.9.6-py3-none-win_arm64.whl", hash = "sha256:0e2bb706a2be7ddfea4a4af918562fdc1bcb16df255e5fa595bbd800ce322a5a", size = 10177499 }, ] +[[package]] +name = "shellingham" +version = "1.5.4" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/58/15/8b3609fd3830ef7b27b655beb4b4e9c62313a4e8da8c676e142cc210d58e/shellingham-1.5.4.tar.gz", hash = "sha256:8dbca0739d487e5bd35ab3ca4b36e11c4078f3a234bfce294b0a0291363404de", size = 10310 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/e0/f9/0595336914c5619e5f28a1fb793285925a8cd4b432c9da0a987836c7f822/shellingham-1.5.4-py2.py3-none-any.whl", hash = "sha256:7ecfff8f2fd72616f7481040475a65b2bf8af90a56c89140852d1120324e8686", size = 9755 }, +] + [[package]] name = "six" version = "1.17.0" @@ -835,17 +2784,33 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/e9/44/75a9c9421471a6c4805dbf2356f7c181a29c1879239abab1ea2cc8f38b40/sniffio-1.3.1-py3-none-any.whl", hash = "sha256:2f6da418d1f1e0fddd844478f41680e794e6051915791a034ff65e5f100525a2", size = 10235 }, ] +[[package]] +name = "stack-data" +version = "0.6.3" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "asttokens" }, + { name = "executing" }, + { name = "pure-eval" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/28/e3/55dcc2cfbc3ca9c29519eb6884dd1415ecb53b0e934862d3559ddcb7e20b/stack_data-0.6.3.tar.gz", hash = "sha256:836a778de4fec4dcd1dcd89ed8abff8a221f58308462e1c4aa2a3cf30148f0b9", size = 44707 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/f1/7b/ce1eafaf1a76852e2ec9b22edecf1daa58175c090266e9f6c64afcd81d91/stack_data-0.6.3-py3-none-any.whl", hash = "sha256:d5558e0c25a4cb0853cddad3d77da9891a08cb85dd9f9f91b9f8cd66e511e695", size = 24521 }, +] + [[package]] name = "stackone-ai" version = "0.0.1" source = { editable = "packages/stackone-ai" } dependencies = [ + { name = "langchain-core" }, { name = "pydantic" }, { name = "requests" }, ] [package.metadata] requires-dist = [ + { name = "langchain-core", specifier = ">=0.1.0" }, { name = "pydantic", specifier = ">=2.10.6" }, { name = "requests", specifier = ">=2.32.3" }, ] @@ -860,6 +2825,8 @@ docs = [ { name = "mkdocs-material" }, ] examples = [ + { name = "crewai" }, + { name = "langchain-openai" }, { name = "openai" }, { name = "python-dotenv" }, ] @@ -872,25 +2839,172 @@ dev = [ { name = "mypy" }, { name = "pre-commit" }, { name = "pytest" }, + { name = "pytest-asyncio" }, + { name = "pytest-cov" }, + { name = "pytest-snapshot" }, { name = "ruff" }, { name = "stackone-ai" }, + { name = "types-requests" }, ] [package.metadata] requires-dist = [ + { name = "crewai", marker = "extra == 'examples'", specifier = ">=0.102.0" }, + { name = "langchain-openai", marker = "extra == 'examples'", specifier = ">=0.3.6" }, { name = "mkdocs-material", marker = "extra == 'docs'", specifier = ">=9.6.4" }, { name = "mkdocs-material", marker = "extra == 'pymdown-extensions'", specifier = ">=9.6.4" }, { name = "openai", marker = "extra == 'examples'", specifier = ">=1.63.2" }, { name = "python-dotenv", marker = "extra == 'examples'", specifier = ">=1.0.1" }, ] +provides-extras = ["examples", "docs", "pymdown-extensions"] [package.metadata.requires-dev] dev = [ { name = "mypy", specifier = ">=1.15.0" }, { name = "pre-commit", specifier = ">=4.1.0" }, { name = "pytest", specifier = ">=8.3.4" }, + { name = "pytest-asyncio", specifier = ">=0.25.3" }, + { name = "pytest-cov", specifier = ">=6.0.0" }, + { name = "pytest-snapshot", specifier = ">=0.9.0" }, { name = "ruff", specifier = ">=0.9.6" }, { name = "stackone-ai", editable = "packages/stackone-ai" }, + { name = "types-requests", specifier = ">=2.31.0.20240311" }, +] + +[[package]] +name = "starlette" +version = "0.45.3" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "anyio" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/ff/fb/2984a686808b89a6781526129a4b51266f678b2d2b97ab2d325e56116df8/starlette-0.45.3.tar.gz", hash = "sha256:2cbcba2a75806f8a41c722141486f37c28e30a0921c5f6fe4346cb0dcee1302f", size = 2574076 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/d9/61/f2b52e107b1fc8944b33ef56bf6ac4ebbe16d91b94d2b87ce013bf63fb84/starlette-0.45.3-py3-none-any.whl", hash = "sha256:dfb6d332576f136ec740296c7e8bb8c8a7125044e7c6da30744718880cdd059d", size = 71507 }, +] + +[[package]] +name = "sympy" +version = "1.13.3" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "mpmath" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/11/8a/5a7fd6284fa8caac23a26c9ddf9c30485a48169344b4bd3b0f02fef1890f/sympy-1.13.3.tar.gz", hash = "sha256:b27fd2c6530e0ab39e275fc9b683895367e51d5da91baa8d3d64db2565fec4d9", size = 7533196 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/99/ff/c87e0622b1dadea79d2fb0b25ade9ed98954c9033722eb707053d310d4f3/sympy-1.13.3-py3-none-any.whl", hash = "sha256:54612cf55a62755ee71824ce692986f23c88ffa77207b30c1368eda4a7060f73", size = 6189483 }, +] + +[[package]] +name = "tenacity" +version = "9.0.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/cd/94/91fccdb4b8110642462e653d5dcb27e7b674742ad68efd146367da7bdb10/tenacity-9.0.0.tar.gz", hash = "sha256:807f37ca97d62aa361264d497b0e31e92b8027044942bfa756160d908320d73b", size = 47421 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/b6/cb/b86984bed139586d01532a587464b5805f12e397594f19f931c4c2fbfa61/tenacity-9.0.0-py3-none-any.whl", hash = "sha256:93de0c98785b27fcf659856aa9f54bfbd399e29969b0621bc7f762bd441b4539", size = 28169 }, +] + +[[package]] +name = "tiktoken" +version = "0.9.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "regex" }, + { name = "requests" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/ea/cf/756fedf6981e82897f2d570dd25fa597eb3f4459068ae0572d7e888cfd6f/tiktoken-0.9.0.tar.gz", hash = "sha256:d02a5ca6a938e0490e1ff957bc48c8b078c88cb83977be1625b1fd8aac792c5d", size = 35991 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/4d/ae/4613a59a2a48e761c5161237fc850eb470b4bb93696db89da51b79a871f1/tiktoken-0.9.0-cp311-cp311-macosx_10_12_x86_64.whl", hash = "sha256:f32cc56168eac4851109e9b5d327637f15fd662aa30dd79f964b7c39fbadd26e", size = 1065987 }, + { url = "https://files.pythonhosted.org/packages/3f/86/55d9d1f5b5a7e1164d0f1538a85529b5fcba2b105f92db3622e5d7de6522/tiktoken-0.9.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:45556bc41241e5294063508caf901bf92ba52d8ef9222023f83d2483a3055348", size = 1009155 }, + { url = "https://files.pythonhosted.org/packages/03/58/01fb6240df083b7c1916d1dcb024e2b761213c95d576e9f780dfb5625a76/tiktoken-0.9.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:03935988a91d6d3216e2ec7c645afbb3d870b37bcb67ada1943ec48678e7ee33", size = 1142898 }, + { url = "https://files.pythonhosted.org/packages/b1/73/41591c525680cd460a6becf56c9b17468d3711b1df242c53d2c7b2183d16/tiktoken-0.9.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8b3d80aad8d2c6b9238fc1a5524542087c52b860b10cbf952429ffb714bc1136", size = 1197535 }, + { url = "https://files.pythonhosted.org/packages/7d/7c/1069f25521c8f01a1a182f362e5c8e0337907fae91b368b7da9c3e39b810/tiktoken-0.9.0-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:b2a21133be05dc116b1d0372af051cd2c6aa1d2188250c9b553f9fa49301b336", size = 1259548 }, + { url = "https://files.pythonhosted.org/packages/6f/07/c67ad1724b8e14e2b4c8cca04b15da158733ac60136879131db05dda7c30/tiktoken-0.9.0-cp311-cp311-win_amd64.whl", hash = "sha256:11a20e67fdf58b0e2dea7b8654a288e481bb4fc0289d3ad21291f8d0849915fb", size = 893895 }, + { url = "https://files.pythonhosted.org/packages/cf/e5/21ff33ecfa2101c1bb0f9b6df750553bd873b7fb532ce2cb276ff40b197f/tiktoken-0.9.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:e88f121c1c22b726649ce67c089b90ddda8b9662545a8aeb03cfef15967ddd03", size = 1065073 }, + { url = "https://files.pythonhosted.org/packages/8e/03/a95e7b4863ee9ceec1c55983e4cc9558bcfd8f4f80e19c4f8a99642f697d/tiktoken-0.9.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:a6600660f2f72369acb13a57fb3e212434ed38b045fd8cc6cdd74947b4b5d210", size = 1008075 }, + { url = "https://files.pythonhosted.org/packages/40/10/1305bb02a561595088235a513ec73e50b32e74364fef4de519da69bc8010/tiktoken-0.9.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:95e811743b5dfa74f4b227927ed86cbc57cad4df859cb3b643be797914e41794", size = 1140754 }, + { url = "https://files.pythonhosted.org/packages/1b/40/da42522018ca496432ffd02793c3a72a739ac04c3794a4914570c9bb2925/tiktoken-0.9.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:99376e1370d59bcf6935c933cb9ba64adc29033b7e73f5f7569f3aad86552b22", size = 1196678 }, + { url = "https://files.pythonhosted.org/packages/5c/41/1e59dddaae270ba20187ceb8aa52c75b24ffc09f547233991d5fd822838b/tiktoken-0.9.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:badb947c32739fb6ddde173e14885fb3de4d32ab9d8c591cbd013c22b4c31dd2", size = 1259283 }, + { url = "https://files.pythonhosted.org/packages/5b/64/b16003419a1d7728d0d8c0d56a4c24325e7b10a21a9dd1fc0f7115c02f0a/tiktoken-0.9.0-cp312-cp312-win_amd64.whl", hash = "sha256:5a62d7a25225bafed786a524c1b9f0910a1128f4232615bf3f8257a73aaa3b16", size = 894897 }, + { url = "https://files.pythonhosted.org/packages/7a/11/09d936d37f49f4f494ffe660af44acd2d99eb2429d60a57c71318af214e0/tiktoken-0.9.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:2b0e8e05a26eda1249e824156d537015480af7ae222ccb798e5234ae0285dbdb", size = 1064919 }, + { url = "https://files.pythonhosted.org/packages/80/0e/f38ba35713edb8d4197ae602e80837d574244ced7fb1b6070b31c29816e0/tiktoken-0.9.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:27d457f096f87685195eea0165a1807fae87b97b2161fe8c9b1df5bd74ca6f63", size = 1007877 }, + { url = "https://files.pythonhosted.org/packages/fe/82/9197f77421e2a01373e27a79dd36efdd99e6b4115746ecc553318ecafbf0/tiktoken-0.9.0-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2cf8ded49cddf825390e36dd1ad35cd49589e8161fdcb52aa25f0583e90a3e01", size = 1140095 }, + { url = "https://files.pythonhosted.org/packages/f2/bb/4513da71cac187383541facd0291c4572b03ec23c561de5811781bbd988f/tiktoken-0.9.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:cc156cb314119a8bb9748257a2eaebd5cc0753b6cb491d26694ed42fc7cb3139", size = 1195649 }, + { url = "https://files.pythonhosted.org/packages/fa/5c/74e4c137530dd8504e97e3a41729b1103a4ac29036cbfd3250b11fd29451/tiktoken-0.9.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:cd69372e8c9dd761f0ab873112aba55a0e3e506332dd9f7522ca466e817b1b7a", size = 1258465 }, + { url = "https://files.pythonhosted.org/packages/de/a8/8f499c179ec900783ffe133e9aab10044481679bb9aad78436d239eee716/tiktoken-0.9.0-cp313-cp313-win_amd64.whl", hash = "sha256:5ea0edb6f83dc56d794723286215918c1cde03712cbbafa0348b33448faf5b95", size = 894669 }, +] + +[[package]] +name = "tokenizers" +version = "0.21.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "huggingface-hub" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/20/41/c2be10975ca37f6ec40d7abd7e98a5213bb04f284b869c1a24e6504fd94d/tokenizers-0.21.0.tar.gz", hash = "sha256:ee0894bf311b75b0c03079f33859ae4b2334d675d4e93f5a4132e1eae2834fe4", size = 343021 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/b0/5c/8b09607b37e996dc47e70d6a7b6f4bdd4e4d5ab22fe49d7374565c7fefaf/tokenizers-0.21.0-cp39-abi3-macosx_10_12_x86_64.whl", hash = "sha256:3c4c93eae637e7d2aaae3d376f06085164e1660f89304c0ab2b1d08a406636b2", size = 2647461 }, + { url = "https://files.pythonhosted.org/packages/22/7a/88e58bb297c22633ed1c9d16029316e5b5ac5ee44012164c2edede599a5e/tokenizers-0.21.0-cp39-abi3-macosx_11_0_arm64.whl", hash = "sha256:f53ea537c925422a2e0e92a24cce96f6bc5046bbef24a1652a5edc8ba975f62e", size = 2563639 }, + { url = "https://files.pythonhosted.org/packages/f7/14/83429177c19364df27d22bc096d4c2e431e0ba43e56c525434f1f9b0fd00/tokenizers-0.21.0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6b177fb54c4702ef611de0c069d9169f0004233890e0c4c5bd5508ae05abf193", size = 2903304 }, + { url = "https://files.pythonhosted.org/packages/7e/db/3433eab42347e0dc5452d8fcc8da03f638c9accffefe5a7c78146666964a/tokenizers-0.21.0-cp39-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:6b43779a269f4629bebb114e19c3fca0223296ae9fea8bb9a7a6c6fb0657ff8e", size = 2804378 }, + { url = "https://files.pythonhosted.org/packages/57/8b/7da5e6f89736c2ade02816b4733983fca1c226b0c42980b1ae9dc8fcf5cc/tokenizers-0.21.0-cp39-abi3-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:9aeb255802be90acfd363626753fda0064a8df06031012fe7d52fd9a905eb00e", size = 3095488 }, + { url = "https://files.pythonhosted.org/packages/4d/f6/5ed6711093dc2c04a4e03f6461798b12669bc5a17c8be7cce1240e0b5ce8/tokenizers-0.21.0-cp39-abi3-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:d8b09dbeb7a8d73ee204a70f94fc06ea0f17dcf0844f16102b9f414f0b7463ba", size = 3121410 }, + { url = "https://files.pythonhosted.org/packages/81/42/07600892d48950c5e80505b81411044a2d969368cdc0d929b1c847bf6697/tokenizers-0.21.0-cp39-abi3-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:400832c0904f77ce87c40f1a8a27493071282f785724ae62144324f171377273", size = 3388821 }, + { url = "https://files.pythonhosted.org/packages/22/06/69d7ce374747edaf1695a4f61b83570d91cc8bbfc51ccfecf76f56ab4aac/tokenizers-0.21.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e84ca973b3a96894d1707e189c14a774b701596d579ffc7e69debfc036a61a04", size = 3008868 }, + { url = "https://files.pythonhosted.org/packages/c8/69/54a0aee4d576045b49a0eb8bffdc495634309c823bf886042e6f46b80058/tokenizers-0.21.0-cp39-abi3-musllinux_1_2_aarch64.whl", hash = "sha256:eb7202d231b273c34ec67767378cd04c767e967fda12d4a9e36208a34e2f137e", size = 8975831 }, + { url = "https://files.pythonhosted.org/packages/f7/f3/b776061e4f3ebf2905ba1a25d90380aafd10c02d406437a8ba22d1724d76/tokenizers-0.21.0-cp39-abi3-musllinux_1_2_armv7l.whl", hash = "sha256:089d56db6782a73a27fd8abf3ba21779f5b85d4a9f35e3b493c7bbcbbf0d539b", size = 8920746 }, + { url = "https://files.pythonhosted.org/packages/d8/ee/ce83d5ec8b6844ad4c3ecfe3333d58ecc1adc61f0878b323a15355bcab24/tokenizers-0.21.0-cp39-abi3-musllinux_1_2_i686.whl", hash = "sha256:c87ca3dc48b9b1222d984b6b7490355a6fdb411a2d810f6f05977258400ddb74", size = 9161814 }, + { url = "https://files.pythonhosted.org/packages/18/07/3e88e65c0ed28fa93aa0c4d264988428eef3df2764c3126dc83e243cb36f/tokenizers-0.21.0-cp39-abi3-musllinux_1_2_x86_64.whl", hash = "sha256:4145505a973116f91bc3ac45988a92e618a6f83eb458f49ea0790df94ee243ff", size = 9357138 }, + { url = "https://files.pythonhosted.org/packages/15/b0/dc4572ca61555fc482ebc933f26cb407c6aceb3dc19c301c68184f8cad03/tokenizers-0.21.0-cp39-abi3-win32.whl", hash = "sha256:eb1702c2f27d25d9dd5b389cc1f2f51813e99f8ca30d9e25348db6585a97e24a", size = 2202266 }, + { url = "https://files.pythonhosted.org/packages/44/69/d21eb253fa91622da25585d362a874fa4710be600f0ea9446d8d0217cec1/tokenizers-0.21.0-cp39-abi3-win_amd64.whl", hash = "sha256:87841da5a25a3a5f70c102de371db120f41873b854ba65e52bccd57df5a3780c", size = 2389192 }, +] + +[[package]] +name = "tomli" +version = "2.2.1" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/18/87/302344fed471e44a87289cf4967697d07e532f2421fdaf868a303cbae4ff/tomli-2.2.1.tar.gz", hash = "sha256:cd45e1dc79c835ce60f7404ec8119f2eb06d38b1deba146f07ced3bbc44505ff", size = 17175 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/43/ca/75707e6efa2b37c77dadb324ae7d9571cb424e61ea73fad7c56c2d14527f/tomli-2.2.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:678e4fa69e4575eb77d103de3df8a895e1591b48e740211bd1067378c69e8249", size = 131077 }, + { url = "https://files.pythonhosted.org/packages/c7/16/51ae563a8615d472fdbffc43a3f3d46588c264ac4f024f63f01283becfbb/tomli-2.2.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:023aa114dd824ade0100497eb2318602af309e5a55595f76b626d6d9f3b7b0a6", size = 123429 }, + { url = "https://files.pythonhosted.org/packages/f1/dd/4f6cd1e7b160041db83c694abc78e100473c15d54620083dbd5aae7b990e/tomli-2.2.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ece47d672db52ac607a3d9599a9d48dcb2f2f735c6c2d1f34130085bb12b112a", size = 226067 }, + { url = "https://files.pythonhosted.org/packages/a9/6b/c54ede5dc70d648cc6361eaf429304b02f2871a345bbdd51e993d6cdf550/tomli-2.2.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6972ca9c9cc9f0acaa56a8ca1ff51e7af152a9f87fb64623e31d5c83700080ee", size = 236030 }, + { url = "https://files.pythonhosted.org/packages/1f/47/999514fa49cfaf7a92c805a86c3c43f4215621855d151b61c602abb38091/tomli-2.2.1-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:c954d2250168d28797dd4e3ac5cf812a406cd5a92674ee4c8f123c889786aa8e", size = 240898 }, + { url = "https://files.pythonhosted.org/packages/73/41/0a01279a7ae09ee1573b423318e7934674ce06eb33f50936655071d81a24/tomli-2.2.1-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:8dd28b3e155b80f4d54beb40a441d366adcfe740969820caf156c019fb5c7ec4", size = 229894 }, + { url = "https://files.pythonhosted.org/packages/55/18/5d8bc5b0a0362311ce4d18830a5d28943667599a60d20118074ea1b01bb7/tomli-2.2.1-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:e59e304978767a54663af13c07b3d1af22ddee3bb2fb0618ca1593e4f593a106", size = 245319 }, + { url = "https://files.pythonhosted.org/packages/92/a3/7ade0576d17f3cdf5ff44d61390d4b3febb8a9fc2b480c75c47ea048c646/tomli-2.2.1-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:33580bccab0338d00994d7f16f4c4ec25b776af3ffaac1ed74e0b3fc95e885a8", size = 238273 }, + { url = "https://files.pythonhosted.org/packages/72/6f/fa64ef058ac1446a1e51110c375339b3ec6be245af9d14c87c4a6412dd32/tomli-2.2.1-cp311-cp311-win32.whl", hash = "sha256:465af0e0875402f1d226519c9904f37254b3045fc5084697cefb9bdde1ff99ff", size = 98310 }, + { url = "https://files.pythonhosted.org/packages/6a/1c/4a2dcde4a51b81be3530565e92eda625d94dafb46dbeb15069df4caffc34/tomli-2.2.1-cp311-cp311-win_amd64.whl", hash = "sha256:2d0f2fdd22b02c6d81637a3c95f8cd77f995846af7414c5c4b8d0545afa1bc4b", size = 108309 }, + { url = "https://files.pythonhosted.org/packages/52/e1/f8af4c2fcde17500422858155aeb0d7e93477a0d59a98e56cbfe75070fd0/tomli-2.2.1-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:4a8f6e44de52d5e6c657c9fe83b562f5f4256d8ebbfe4ff922c495620a7f6cea", size = 132762 }, + { url = "https://files.pythonhosted.org/packages/03/b8/152c68bb84fc00396b83e7bbddd5ec0bd3dd409db4195e2a9b3e398ad2e3/tomli-2.2.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:8d57ca8095a641b8237d5b079147646153d22552f1c637fd3ba7f4b0b29167a8", size = 123453 }, + { url = "https://files.pythonhosted.org/packages/c8/d6/fc9267af9166f79ac528ff7e8c55c8181ded34eb4b0e93daa767b8841573/tomli-2.2.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4e340144ad7ae1533cb897d406382b4b6fede8890a03738ff1683af800d54192", size = 233486 }, + { url = "https://files.pythonhosted.org/packages/5c/51/51c3f2884d7bab89af25f678447ea7d297b53b5a3b5730a7cb2ef6069f07/tomli-2.2.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:db2b95f9de79181805df90bedc5a5ab4c165e6ec3fe99f970d0e302f384ad222", size = 242349 }, + { url = "https://files.pythonhosted.org/packages/ab/df/bfa89627d13a5cc22402e441e8a931ef2108403db390ff3345c05253935e/tomli-2.2.1-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:40741994320b232529c802f8bc86da4e1aa9f413db394617b9a256ae0f9a7f77", size = 252159 }, + { url = "https://files.pythonhosted.org/packages/9e/6e/fa2b916dced65763a5168c6ccb91066f7639bdc88b48adda990db10c8c0b/tomli-2.2.1-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:400e720fe168c0f8521520190686ef8ef033fb19fc493da09779e592861b78c6", size = 237243 }, + { url = "https://files.pythonhosted.org/packages/b4/04/885d3b1f650e1153cbb93a6a9782c58a972b94ea4483ae4ac5cedd5e4a09/tomli-2.2.1-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:02abe224de6ae62c19f090f68da4e27b10af2b93213d36cf44e6e1c5abd19fdd", size = 259645 }, + { url = "https://files.pythonhosted.org/packages/9c/de/6b432d66e986e501586da298e28ebeefd3edc2c780f3ad73d22566034239/tomli-2.2.1-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:b82ebccc8c8a36f2094e969560a1b836758481f3dc360ce9a3277c65f374285e", size = 244584 }, + { url = "https://files.pythonhosted.org/packages/1c/9a/47c0449b98e6e7d1be6cbac02f93dd79003234ddc4aaab6ba07a9a7482e2/tomli-2.2.1-cp312-cp312-win32.whl", hash = "sha256:889f80ef92701b9dbb224e49ec87c645ce5df3fa2cc548664eb8a25e03127a98", size = 98875 }, + { url = "https://files.pythonhosted.org/packages/ef/60/9b9638f081c6f1261e2688bd487625cd1e660d0a85bd469e91d8db969734/tomli-2.2.1-cp312-cp312-win_amd64.whl", hash = "sha256:7fc04e92e1d624a4a63c76474610238576942d6b8950a2d7f908a340494e67e4", size = 109418 }, + { url = "https://files.pythonhosted.org/packages/04/90/2ee5f2e0362cb8a0b6499dc44f4d7d48f8fff06d28ba46e6f1eaa61a1388/tomli-2.2.1-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:f4039b9cbc3048b2416cc57ab3bda989a6fcf9b36cf8937f01a6e731b64f80d7", size = 132708 }, + { url = "https://files.pythonhosted.org/packages/c0/ec/46b4108816de6b385141f082ba99e315501ccd0a2ea23db4a100dd3990ea/tomli-2.2.1-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:286f0ca2ffeeb5b9bd4fcc8d6c330534323ec51b2f52da063b11c502da16f30c", size = 123582 }, + { url = "https://files.pythonhosted.org/packages/a0/bd/b470466d0137b37b68d24556c38a0cc819e8febe392d5b199dcd7f578365/tomli-2.2.1-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a92ef1a44547e894e2a17d24e7557a5e85a9e1d0048b0b5e7541f76c5032cb13", size = 232543 }, + { url = "https://files.pythonhosted.org/packages/d9/e5/82e80ff3b751373f7cead2815bcbe2d51c895b3c990686741a8e56ec42ab/tomli-2.2.1-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9316dc65bed1684c9a98ee68759ceaed29d229e985297003e494aa825ebb0281", size = 241691 }, + { url = "https://files.pythonhosted.org/packages/05/7e/2a110bc2713557d6a1bfb06af23dd01e7dde52b6ee7dadc589868f9abfac/tomli-2.2.1-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:e85e99945e688e32d5a35c1ff38ed0b3f41f43fad8df0bdf79f72b2ba7bc5272", size = 251170 }, + { url = "https://files.pythonhosted.org/packages/64/7b/22d713946efe00e0adbcdfd6d1aa119ae03fd0b60ebed51ebb3fa9f5a2e5/tomli-2.2.1-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:ac065718db92ca818f8d6141b5f66369833d4a80a9d74435a268c52bdfa73140", size = 236530 }, + { url = "https://files.pythonhosted.org/packages/38/31/3a76f67da4b0cf37b742ca76beaf819dca0ebef26d78fc794a576e08accf/tomli-2.2.1-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:d920f33822747519673ee656a4b6ac33e382eca9d331c87770faa3eef562aeb2", size = 258666 }, + { url = "https://files.pythonhosted.org/packages/07/10/5af1293da642aded87e8a988753945d0cf7e00a9452d3911dd3bb354c9e2/tomli-2.2.1-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:a198f10c4d1b1375d7687bc25294306e551bf1abfa4eace6650070a5c1ae2744", size = 243954 }, + { url = "https://files.pythonhosted.org/packages/5b/b9/1ed31d167be802da0fc95020d04cd27b7d7065cc6fbefdd2f9186f60d7bd/tomli-2.2.1-cp313-cp313-win32.whl", hash = "sha256:d3f5614314d758649ab2ab3a62d4f2004c825922f9e370b29416484086b264ec", size = 98724 }, + { url = "https://files.pythonhosted.org/packages/c7/32/b0963458706accd9afcfeb867c0f9175a741bf7b19cd424230714d722198/tomli-2.2.1-cp313-cp313-win_amd64.whl", hash = "sha256:a38aa0308e754b0e3c67e344754dff64999ff9b513e691d0e786265c93583c69", size = 109383 }, + { url = "https://files.pythonhosted.org/packages/6e/c2/61d3e0f47e2b74ef40a68b9e6ad5984f6241a942f7cd3bbfbdbd03861ea9/tomli-2.2.1-py3-none-any.whl", hash = "sha256:cb55c73c5f4408779d0cf3eef9f762b9c9f147a77de7b258bef0a5628adc85cc", size = 14257 }, +] + +[[package]] +name = "tomli-w" +version = "1.2.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/19/75/241269d1da26b624c0d5e110e8149093c759b7a286138f4efd61a60e75fe/tomli_w-1.2.0.tar.gz", hash = "sha256:2dd14fac5a47c27be9cd4c976af5a12d87fb1f0b4512f81d69cce3b35ae25021", size = 7184 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/c7/18/c86eb8e0202e32dd3df50d43d7ff9854f8e0603945ff398974c1d91ac1ef/tomli_w-1.2.0-py3-none-any.whl", hash = "sha256:188306098d013b691fcadc011abd66727d3c414c571bb01b1a174ba8c983cf90", size = 6675 }, ] [[package]] @@ -905,6 +3019,42 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/d0/30/dc54f88dd4a2b5dc8a0279bdd7270e735851848b762aeb1c1184ed1f6b14/tqdm-4.67.1-py3-none-any.whl", hash = "sha256:26445eca388f82e72884e0d580d5464cd801a3ea01e63e5601bdff9ba6a48de2", size = 78540 }, ] +[[package]] +name = "traitlets" +version = "5.14.3" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/eb/79/72064e6a701c2183016abbbfedaba506d81e30e232a68c9f0d6f6fcd1574/traitlets-5.14.3.tar.gz", hash = "sha256:9ed0579d3502c94b4b3732ac120375cda96f923114522847de4b3bb98b96b6b7", size = 161621 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/00/c0/8f5d070730d7836adc9c9b6408dec68c6ced86b304a9b26a14df072a6e8c/traitlets-5.14.3-py3-none-any.whl", hash = "sha256:b74e89e397b1ed28cc831db7aea759ba6640cb3de13090ca145426688ff1ac4f", size = 85359 }, +] + +[[package]] +name = "typer" +version = "0.15.1" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "click" }, + { name = "rich" }, + { name = "shellingham" }, + { name = "typing-extensions" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/cb/ce/dca7b219718afd37a0068f4f2530a727c2b74a8b6e8e0c0080a4c0de4fcd/typer-0.15.1.tar.gz", hash = "sha256:a0588c0a7fa68a1978a069818657778f86abe6ff5ea6abf472f940a08bfe4f0a", size = 99789 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/d0/cc/0a838ba5ca64dc832aa43f727bd586309846b0ffb2ce52422543e6075e8a/typer-0.15.1-py3-none-any.whl", hash = "sha256:7994fb7b8155b64d3402518560648446072864beefd44aa2dc36972a5972e847", size = 44908 }, +] + +[[package]] +name = "types-requests" +version = "2.32.0.20241016" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "urllib3" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/fa/3c/4f2a430c01a22abd49a583b6b944173e39e7d01b688190a5618bd59a2e22/types-requests-2.32.0.20241016.tar.gz", hash = "sha256:0d9cad2f27515d0e3e3da7134a1b6f28fb97129d86b867f24d9c726452634d95", size = 18065 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/d7/01/485b3026ff90e5190b5e24f1711522e06c79f4a56c8f4b95848ac072e20f/types_requests-2.32.0.20241016-py3-none-any.whl", hash = "sha256:4195d62d6d3e043a4eaaf08ff8a62184584d2e8684e9d2aa178c7915a7da3747", size = 15836 }, +] + [[package]] name = "typing-extensions" version = "4.12.2" @@ -923,6 +3073,81 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/c8/19/4ec628951a74043532ca2cf5d97b7b14863931476d117c471e8e2b1eb39f/urllib3-2.3.0-py3-none-any.whl", hash = "sha256:1cee9ad369867bfdbbb48b7dd50374c0967a0bb7710050facf0dd6911440e3df", size = 128369 }, ] +[[package]] +name = "uv" +version = "0.6.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/6d/05/118e10d91981b85f47b27d089782a6598a9584ff607bffb8e2f6be1f1245/uv-0.6.2.tar.gz", hash = "sha256:d696a4f3d4a3ac1b305255e8814ae3a147ea3428a977bb3b4335a339941799bc", size = 3066291 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/a1/cf/9c3c9a427c7ecc37be238c4433188614b3d342191c0299c632f512d493ff/uv-0.6.2-py3-none-linux_armv6l.whl", hash = "sha256:d501ae16fb33969b12a64ac7b9c49d672b8c3964026c5dcaee3b1dcd50a6a22c", size = 15513992 }, + { url = "https://files.pythonhosted.org/packages/86/01/1e1f88826d92d11f2232f96eef190574a4edb470546a141bba652cd37240/uv-0.6.2-py3-none-macosx_10_12_x86_64.whl", hash = "sha256:2c13ca920d87dc00721a86ac3d19667cff5435b369d21e3d6df76b373d8fa8df", size = 15659547 }, + { url = "https://files.pythonhosted.org/packages/ee/40/59e9c03431d4c82420e081f92719e5784db8f1c92a25b2abdfe6ac645b7e/uv-0.6.2-py3-none-macosx_11_0_arm64.whl", hash = "sha256:f24e119d338bae32b5a604585b7b518036fba556e2c2d9dbd2d7cf1411213b57", size = 14589044 }, + { url = "https://files.pythonhosted.org/packages/11/8b/5d9f9f4e3969d6a2c9ce9a0b4a85ecb8ca89bf5c00e9ec097cf472abb2a2/uv-0.6.2-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.musllinux_1_1_aarch64.whl", hash = "sha256:1db90b728a173926e2018b89df776a373b1e50520466f61e0dbf05f9a64a6db5", size = 15034328 }, + { url = "https://files.pythonhosted.org/packages/f3/ba/f31fd6af8f70b21d9e0b7cca0241a8f10e03d24862f49f93fbc5ff1e4fce/uv-0.6.2-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:d23fb9cd41aecb31845e884d0bfde243e04e763abeab3532138321b4ebe7437c", size = 15275180 }, + { url = "https://files.pythonhosted.org/packages/aa/3b/358cfea4265a0966fafa7934ed0f9f1fb031d7ebbe8a15e02a308afff6ad/uv-0.6.2-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:df0a1d95fd1539c05de434259fafcee0b6852900d4178e94b3b6b6b06438b60c", size = 15969503 }, + { url = "https://files.pythonhosted.org/packages/57/f5/840d8fb46c1cf723e1b7168832de52e58d86764aa625c2100b35a27261af/uv-0.6.2-py3-none-manylinux_2_17_ppc64.manylinux2014_ppc64.whl", hash = "sha256:f2f0dc9a0564b31d4efdee317c176a23bbe7e61aec6d281a331ba6ae32f828ff", size = 16950563 }, + { url = "https://files.pythonhosted.org/packages/f6/37/75c5ff09db56c34f0f5d3d55dd4188e52d09219ef76bfe176dae58ed5f4a/uv-0.6.2-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:326aff8c4fb8153e2384e79904c27b1c9d4c3a5879b53a6fbc2da3283fda321d", size = 16631562 }, + { url = "https://files.pythonhosted.org/packages/9d/5f/91bfae5ecf9f6c5f4754aa794159acc77245a53233a966865ae4974e5cdf/uv-0.6.2-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b8763f310a473f46c0226f5e08a876bd34de121ac370cc7294a5397a13a18d8a", size = 20994598 }, + { url = "https://files.pythonhosted.org/packages/8d/39/17f77b4b5f1a1e579d9ce94859aada9418c9ebcaa227b54b10648218bafa/uv-0.6.2-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9e2e421947ef889e6c8913992c560d611826464eabc78f8f702a5eff824aabc7", size = 16367280 }, + { url = "https://files.pythonhosted.org/packages/a7/6b/fbd9794e1344b299e02993322f44b500f4d66ecdb83860e2fcf35d8cac2c/uv-0.6.2-py3-none-manylinux_2_28_aarch64.whl", hash = "sha256:7dd26dabd918e5648ecf94fb7c0787db954237e34ea3bdd944b98d007b44c3a5", size = 15317824 }, + { url = "https://files.pythonhosted.org/packages/51/a0/9249a55365c2f9781243a7f35c3a01864b19aa9a62b1fc50b7231793346e/uv-0.6.2-py3-none-musllinux_1_1_armv7l.whl", hash = "sha256:f3719da2e59403783eab634a6238b90051fc65379e02c10b9ca1b32b26d35f77", size = 15228644 }, + { url = "https://files.pythonhosted.org/packages/27/76/790b3d9c0b9ecd9ab6c1b7e904c36d470685c70d0b21a134b026452e0fcc/uv-0.6.2-py3-none-musllinux_1_1_i686.whl", hash = "sha256:b435687e5c26a64858ea842fbb4b35ced8e8741a99d1b75d0c0143462e956db9", size = 15608612 }, + { url = "https://files.pythonhosted.org/packages/05/b6/79961374b2318461b4dfc0e565d63281bf788fea93fc81b2d1738847aec2/uv-0.6.2-py3-none-musllinux_1_1_x86_64.whl", hash = "sha256:0f1e8e15c92607862e72e0467a31947af7b9aef93924072e9b4d5dcb5633d374", size = 16480962 }, + { url = "https://files.pythonhosted.org/packages/68/20/df7788bde9d114c501cd8ebb60235be07ff0fb0dc26fa1e7e99ada251d73/uv-0.6.2-py3-none-win32.whl", hash = "sha256:52b7452f4c523b9875de53ba73df87acd1cdea36640281d0d80c8074eda42f16", size = 15717804 }, + { url = "https://files.pythonhosted.org/packages/e1/0a/fc966f859b6252050c71e1afcdce116c8ef3513f8b423bb3ca05fb13485d/uv-0.6.2-py3-none-win_amd64.whl", hash = "sha256:5337cdb6ecc604d0cf36fe6799dd0479111b606009e6c29685d213c74eb40373", size = 17017798 }, + { url = "https://files.pythonhosted.org/packages/03/82/4318c4874c8dd59a0386e2bf0f4d09fc5bb4900349238828153235d387eb/uv-0.6.2-py3-none-win_arm64.whl", hash = "sha256:27ecb8f6ef796220062f31a12e2dc5dc7a14704aa1df0da2dfa3530346c7e3cc", size = 15923484 }, +] + +[[package]] +name = "uvicorn" +version = "0.34.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "click" }, + { name = "h11" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/4b/4d/938bd85e5bf2edeec766267a5015ad969730bb91e31b44021dfe8b22df6c/uvicorn-0.34.0.tar.gz", hash = "sha256:404051050cd7e905de2c9a7e61790943440b3416f49cb409f965d9dcd0fa73e9", size = 76568 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/61/14/33a3a1352cfa71812a3a21e8c9bfb83f60b0011f5e36f2b1399d51928209/uvicorn-0.34.0-py3-none-any.whl", hash = "sha256:023dc038422502fa28a09c7a30bf2b6991512da7dcdb8fd35fe57cfc154126f4", size = 62315 }, +] + +[package.optional-dependencies] +standard = [ + { name = "colorama", marker = "sys_platform == 'win32'" }, + { name = "httptools" }, + { name = "python-dotenv" }, + { name = "pyyaml" }, + { name = "uvloop", marker = "platform_python_implementation != 'PyPy' and sys_platform != 'cygwin' and sys_platform != 'win32'" }, + { name = "watchfiles" }, + { name = "websockets" }, +] + +[[package]] +name = "uvloop" +version = "0.21.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/af/c0/854216d09d33c543f12a44b393c402e89a920b1a0a7dc634c42de91b9cf6/uvloop-0.21.0.tar.gz", hash = "sha256:3bf12b0fda68447806a7ad847bfa591613177275d35b6724b1ee573faa3704e3", size = 2492741 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/57/a7/4cf0334105c1160dd6819f3297f8700fda7fc30ab4f61fbf3e725acbc7cc/uvloop-0.21.0-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:c0f3fa6200b3108919f8bdabb9a7f87f20e7097ea3c543754cabc7d717d95cf8", size = 1447410 }, + { url = "https://files.pythonhosted.org/packages/8c/7c/1517b0bbc2dbe784b563d6ab54f2ef88c890fdad77232c98ed490aa07132/uvloop-0.21.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:0878c2640cf341b269b7e128b1a5fed890adc4455513ca710d77d5e93aa6d6a0", size = 805476 }, + { url = "https://files.pythonhosted.org/packages/ee/ea/0bfae1aceb82a503f358d8d2fa126ca9dbdb2ba9c7866974faec1cb5875c/uvloop-0.21.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:b9fb766bb57b7388745d8bcc53a359b116b8a04c83a2288069809d2b3466c37e", size = 3960855 }, + { url = "https://files.pythonhosted.org/packages/8a/ca/0864176a649838b838f36d44bf31c451597ab363b60dc9e09c9630619d41/uvloop-0.21.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8a375441696e2eda1c43c44ccb66e04d61ceeffcd76e4929e527b7fa401b90fb", size = 3973185 }, + { url = "https://files.pythonhosted.org/packages/30/bf/08ad29979a936d63787ba47a540de2132169f140d54aa25bc8c3df3e67f4/uvloop-0.21.0-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:baa0e6291d91649c6ba4ed4b2f982f9fa165b5bbd50a9e203c416a2797bab3c6", size = 3820256 }, + { url = "https://files.pythonhosted.org/packages/da/e2/5cf6ef37e3daf2f06e651aae5ea108ad30df3cb269102678b61ebf1fdf42/uvloop-0.21.0-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:4509360fcc4c3bd2c70d87573ad472de40c13387f5fda8cb58350a1d7475e58d", size = 3937323 }, + { url = "https://files.pythonhosted.org/packages/8c/4c/03f93178830dc7ce8b4cdee1d36770d2f5ebb6f3d37d354e061eefc73545/uvloop-0.21.0-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:359ec2c888397b9e592a889c4d72ba3d6befba8b2bb01743f72fffbde663b59c", size = 1471284 }, + { url = "https://files.pythonhosted.org/packages/43/3e/92c03f4d05e50f09251bd8b2b2b584a2a7f8fe600008bcc4523337abe676/uvloop-0.21.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:f7089d2dc73179ce5ac255bdf37c236a9f914b264825fdaacaded6990a7fb4c2", size = 821349 }, + { url = "https://files.pythonhosted.org/packages/a6/ef/a02ec5da49909dbbfb1fd205a9a1ac4e88ea92dcae885e7c961847cd51e2/uvloop-0.21.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:baa4dcdbd9ae0a372f2167a207cd98c9f9a1ea1188a8a526431eef2f8116cc8d", size = 4580089 }, + { url = "https://files.pythonhosted.org/packages/06/a7/b4e6a19925c900be9f98bec0a75e6e8f79bb53bdeb891916609ab3958967/uvloop-0.21.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:86975dca1c773a2c9864f4c52c5a55631038e387b47eaf56210f873887b6c8dc", size = 4693770 }, + { url = "https://files.pythonhosted.org/packages/ce/0c/f07435a18a4b94ce6bd0677d8319cd3de61f3a9eeb1e5f8ab4e8b5edfcb3/uvloop-0.21.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:461d9ae6660fbbafedd07559c6a2e57cd553b34b0065b6550685f6653a98c1cb", size = 4451321 }, + { url = "https://files.pythonhosted.org/packages/8f/eb/f7032be105877bcf924709c97b1bf3b90255b4ec251f9340cef912559f28/uvloop-0.21.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:183aef7c8730e54c9a3ee3227464daed66e37ba13040bb3f350bc2ddc040f22f", size = 4659022 }, + { url = "https://files.pythonhosted.org/packages/3f/8d/2cbef610ca21539f0f36e2b34da49302029e7c9f09acef0b1c3b5839412b/uvloop-0.21.0-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:bfd55dfcc2a512316e65f16e503e9e450cab148ef11df4e4e679b5e8253a5281", size = 1468123 }, + { url = "https://files.pythonhosted.org/packages/93/0d/b0038d5a469f94ed8f2b2fce2434a18396d8fbfb5da85a0a9781ebbdec14/uvloop-0.21.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:787ae31ad8a2856fc4e7c095341cccc7209bd657d0e71ad0dc2ea83c4a6fa8af", size = 819325 }, + { url = "https://files.pythonhosted.org/packages/50/94/0a687f39e78c4c1e02e3272c6b2ccdb4e0085fda3b8352fecd0410ccf915/uvloop-0.21.0-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5ee4d4ef48036ff6e5cfffb09dd192c7a5027153948d85b8da7ff705065bacc6", size = 4582806 }, + { url = "https://files.pythonhosted.org/packages/d2/19/f5b78616566ea68edd42aacaf645adbf71fbd83fc52281fba555dc27e3f1/uvloop-0.21.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f3df876acd7ec037a3d005b3ab85a7e4110422e4d9c1571d4fc89b0fc41b6816", size = 4701068 }, + { url = "https://files.pythonhosted.org/packages/47/57/66f061ee118f413cd22a656de622925097170b9380b30091b78ea0c6ea75/uvloop-0.21.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:bd53ecc9a0f3d87ab847503c2e1552b690362e005ab54e8a48ba97da3924c0dc", size = 4454428 }, + { url = "https://files.pythonhosted.org/packages/63/9a/0962b05b308494e3202d3f794a6e85abe471fe3cafdbcf95c2e8c713aabd/uvloop-0.21.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:a5c39f217ab3c663dc699c04cbd50c13813e31d917642d459fdcec07555cc553", size = 4660018 }, +] + [[package]] name = "virtualenv" version = "20.29.2" @@ -963,3 +3188,295 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/db/d9/c495884c6e548fce18a8f40568ff120bc3a4b7b99813081c8ac0c936fa64/watchdog-6.0.0-py3-none-win_amd64.whl", hash = "sha256:cbafb470cf848d93b5d013e2ecb245d4aa1c8fd0504e863ccefa32445359d680", size = 79070 }, { url = "https://files.pythonhosted.org/packages/33/e8/e40370e6d74ddba47f002a32919d91310d6074130fe4e17dabcafc15cbf1/watchdog-6.0.0-py3-none-win_ia64.whl", hash = "sha256:a1914259fa9e1454315171103c6a30961236f508b9b623eae470268bbcc6a22f", size = 79067 }, ] + +[[package]] +name = "watchfiles" +version = "1.0.4" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "anyio" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/f5/26/c705fc77d0a9ecdb9b66f1e2976d95b81df3cae518967431e7dbf9b5e219/watchfiles-1.0.4.tar.gz", hash = "sha256:6ba473efd11062d73e4f00c2b730255f9c1bdd73cd5f9fe5b5da8dbd4a717205", size = 94625 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/0f/bb/8461adc4b1fed009546fb797fc0d5698dcfe5e289cb37e1b8f16a93cdc30/watchfiles-1.0.4-cp311-cp311-macosx_10_12_x86_64.whl", hash = "sha256:2a9f93f8439639dc244c4d2902abe35b0279102bca7bbcf119af964f51d53c19", size = 394869 }, + { url = "https://files.pythonhosted.org/packages/55/88/9ebf36b3547176d1709c320de78c1fa3263a46be31b5b1267571d9102686/watchfiles-1.0.4-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:9eea33ad8c418847dd296e61eb683cae1c63329b6d854aefcd412e12d94ee235", size = 384905 }, + { url = "https://files.pythonhosted.org/packages/03/8a/04335ce23ef78d8c69f0913e8b20cf7d9233e3986543aeef95ef2d6e43d2/watchfiles-1.0.4-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:31f1a379c9dcbb3f09cf6be1b7e83b67c0e9faabed0471556d9438a4a4e14202", size = 449944 }, + { url = "https://files.pythonhosted.org/packages/17/4e/c8d5dcd14fe637f4633616dabea8a4af0a10142dccf3b43e0f081ba81ab4/watchfiles-1.0.4-cp311-cp311-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:ab594e75644421ae0a2484554832ca5895f8cab5ab62de30a1a57db460ce06c6", size = 456020 }, + { url = "https://files.pythonhosted.org/packages/5e/74/3e91e09e1861dd7fbb1190ce7bd786700dc0fbc2ccd33bb9fff5de039229/watchfiles-1.0.4-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:fc2eb5d14a8e0d5df7b36288979176fbb39672d45184fc4b1c004d7c3ce29317", size = 482983 }, + { url = "https://files.pythonhosted.org/packages/a1/3d/e64de2d1ce4eb6a574fd78ce3a28c279da263be9ef3cfcab6f708df192f2/watchfiles-1.0.4-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:3f68d8e9d5a321163ddacebe97091000955a1b74cd43724e346056030b0bacee", size = 520320 }, + { url = "https://files.pythonhosted.org/packages/2c/bd/52235f7063b57240c66a991696ed27e2a18bd6fcec8a1ea5a040b70d0611/watchfiles-1.0.4-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:f9ce064e81fe79faa925ff03b9f4c1a98b0bbb4a1b8c1b015afa93030cb21a49", size = 500988 }, + { url = "https://files.pythonhosted.org/packages/3a/b0/ff04194141a5fe650c150400dd9e42667916bc0f52426e2e174d779b8a74/watchfiles-1.0.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b77d5622ac5cc91d21ae9c2b284b5d5c51085a0bdb7b518dba263d0af006132c", size = 452573 }, + { url = "https://files.pythonhosted.org/packages/3d/9d/966164332c5a178444ae6d165082d4f351bd56afd9c3ec828eecbf190e6a/watchfiles-1.0.4-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:1941b4e39de9b38b868a69b911df5e89dc43767feeda667b40ae032522b9b5f1", size = 615114 }, + { url = "https://files.pythonhosted.org/packages/94/df/f569ae4c1877f96ad4086c153a8eee5a19a3b519487bf5c9454a3438c341/watchfiles-1.0.4-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:4f8c4998506241dedf59613082d1c18b836e26ef2a4caecad0ec41e2a15e4226", size = 613076 }, + { url = "https://files.pythonhosted.org/packages/15/ae/8ce5f29e65d5fa5790e3c80c289819c55e12be2e1b9f5b6a0e55e169b97d/watchfiles-1.0.4-cp311-cp311-win32.whl", hash = "sha256:4ebbeca9360c830766b9f0df3640b791be569d988f4be6c06d6fae41f187f105", size = 271013 }, + { url = "https://files.pythonhosted.org/packages/a4/c6/79dc4a7c598a978e5fafa135090aaf7bbb03b8dec7bada437dfbe578e7ed/watchfiles-1.0.4-cp311-cp311-win_amd64.whl", hash = "sha256:05d341c71f3d7098920f8551d4df47f7b57ac5b8dad56558064c3431bdfc0b74", size = 284229 }, + { url = "https://files.pythonhosted.org/packages/37/3d/928633723211753f3500bfb138434f080363b87a1b08ca188b1ce54d1e05/watchfiles-1.0.4-cp311-cp311-win_arm64.whl", hash = "sha256:32b026a6ab64245b584acf4931fe21842374da82372d5c039cba6bf99ef722f3", size = 276824 }, + { url = "https://files.pythonhosted.org/packages/5b/1a/8f4d9a1461709756ace48c98f07772bc6d4519b1e48b5fa24a4061216256/watchfiles-1.0.4-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:229e6ec880eca20e0ba2f7e2249c85bae1999d330161f45c78d160832e026ee2", size = 391345 }, + { url = "https://files.pythonhosted.org/packages/bc/d2/6750b7b3527b1cdaa33731438432e7238a6c6c40a9924049e4cebfa40805/watchfiles-1.0.4-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:5717021b199e8353782dce03bd8a8f64438832b84e2885c4a645f9723bf656d9", size = 381515 }, + { url = "https://files.pythonhosted.org/packages/4e/17/80500e42363deef1e4b4818729ed939aaddc56f82f4e72b2508729dd3c6b/watchfiles-1.0.4-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0799ae68dfa95136dde7c472525700bd48777875a4abb2ee454e3ab18e9fc712", size = 449767 }, + { url = "https://files.pythonhosted.org/packages/10/37/1427fa4cfa09adbe04b1e97bced19a29a3462cc64c78630787b613a23f18/watchfiles-1.0.4-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:43b168bba889886b62edb0397cab5b6490ffb656ee2fcb22dec8bfeb371a9e12", size = 455677 }, + { url = "https://files.pythonhosted.org/packages/c5/7a/39e9397f3a19cb549a7d380412fd9e507d4854eddc0700bfad10ef6d4dba/watchfiles-1.0.4-cp312-cp312-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:fb2c46e275fbb9f0c92e7654b231543c7bbfa1df07cdc4b99fa73bedfde5c844", size = 482219 }, + { url = "https://files.pythonhosted.org/packages/45/2d/7113931a77e2ea4436cad0c1690c09a40a7f31d366f79c6f0a5bc7a4f6d5/watchfiles-1.0.4-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:857f5fc3aa027ff5e57047da93f96e908a35fe602d24f5e5d8ce64bf1f2fc733", size = 518830 }, + { url = "https://files.pythonhosted.org/packages/f9/1b/50733b1980fa81ef3c70388a546481ae5fa4c2080040100cd7bf3bf7b321/watchfiles-1.0.4-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:55ccfd27c497b228581e2838d4386301227fc0cb47f5a12923ec2fe4f97b95af", size = 497997 }, + { url = "https://files.pythonhosted.org/packages/2b/b4/9396cc61b948ef18943e7c85ecfa64cf940c88977d882da57147f62b34b1/watchfiles-1.0.4-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5c11ea22304d17d4385067588123658e9f23159225a27b983f343fcffc3e796a", size = 452249 }, + { url = "https://files.pythonhosted.org/packages/fb/69/0c65a5a29e057ad0dc691c2fa6c23b2983c7dabaa190ba553b29ac84c3cc/watchfiles-1.0.4-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:74cb3ca19a740be4caa18f238298b9d472c850f7b2ed89f396c00a4c97e2d9ff", size = 614412 }, + { url = "https://files.pythonhosted.org/packages/7f/b9/319fcba6eba5fad34327d7ce16a6b163b39741016b1996f4a3c96b8dd0e1/watchfiles-1.0.4-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:c7cce76c138a91e720d1df54014a047e680b652336e1b73b8e3ff3158e05061e", size = 611982 }, + { url = "https://files.pythonhosted.org/packages/f1/47/143c92418e30cb9348a4387bfa149c8e0e404a7c5b0585d46d2f7031b4b9/watchfiles-1.0.4-cp312-cp312-win32.whl", hash = "sha256:b045c800d55bc7e2cadd47f45a97c7b29f70f08a7c2fa13241905010a5493f94", size = 271822 }, + { url = "https://files.pythonhosted.org/packages/ea/94/b0165481bff99a64b29e46e07ac2e0df9f7a957ef13bec4ceab8515f44e3/watchfiles-1.0.4-cp312-cp312-win_amd64.whl", hash = "sha256:c2acfa49dd0ad0bf2a9c0bb9a985af02e89345a7189be1efc6baa085e0f72d7c", size = 285441 }, + { url = "https://files.pythonhosted.org/packages/11/de/09fe56317d582742d7ca8c2ca7b52a85927ebb50678d9b0fa8194658f536/watchfiles-1.0.4-cp312-cp312-win_arm64.whl", hash = "sha256:22bb55a7c9e564e763ea06c7acea24fc5d2ee5dfc5dafc5cfbedfe58505e9f90", size = 277141 }, + { url = "https://files.pythonhosted.org/packages/08/98/f03efabec64b5b1fa58c0daab25c68ef815b0f320e54adcacd0d6847c339/watchfiles-1.0.4-cp313-cp313-macosx_10_12_x86_64.whl", hash = "sha256:8012bd820c380c3d3db8435e8cf7592260257b378b649154a7948a663b5f84e9", size = 390954 }, + { url = "https://files.pythonhosted.org/packages/16/09/4dd49ba0a32a45813debe5fb3897955541351ee8142f586303b271a02b40/watchfiles-1.0.4-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:aa216f87594f951c17511efe5912808dfcc4befa464ab17c98d387830ce07b60", size = 381133 }, + { url = "https://files.pythonhosted.org/packages/76/59/5aa6fc93553cd8d8ee75c6247763d77c02631aed21551a97d94998bf1dae/watchfiles-1.0.4-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:62c9953cf85529c05b24705639ffa390f78c26449e15ec34d5339e8108c7c407", size = 449516 }, + { url = "https://files.pythonhosted.org/packages/4c/aa/df4b6fe14b6317290b91335b23c96b488d365d65549587434817e06895ea/watchfiles-1.0.4-cp313-cp313-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:7cf684aa9bba4cd95ecb62c822a56de54e3ae0598c1a7f2065d51e24637a3c5d", size = 454820 }, + { url = "https://files.pythonhosted.org/packages/5e/71/185f8672f1094ce48af33252c73e39b48be93b761273872d9312087245f6/watchfiles-1.0.4-cp313-cp313-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f44a39aee3cbb9b825285ff979ab887a25c5d336e5ec3574f1506a4671556a8d", size = 481550 }, + { url = "https://files.pythonhosted.org/packages/85/d7/50ebba2c426ef1a5cb17f02158222911a2e005d401caf5d911bfca58f4c4/watchfiles-1.0.4-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a38320582736922be8c865d46520c043bff350956dfc9fbaee3b2df4e1740a4b", size = 518647 }, + { url = "https://files.pythonhosted.org/packages/f0/7a/4c009342e393c545d68987e8010b937f72f47937731225b2b29b7231428f/watchfiles-1.0.4-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:39f4914548b818540ef21fd22447a63e7be6e24b43a70f7642d21f1e73371590", size = 497547 }, + { url = "https://files.pythonhosted.org/packages/0f/7c/1cf50b35412d5c72d63b2bf9a4fffee2e1549a245924960dd087eb6a6de4/watchfiles-1.0.4-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f12969a3765909cf5dc1e50b2436eb2c0e676a3c75773ab8cc3aa6175c16e902", size = 452179 }, + { url = "https://files.pythonhosted.org/packages/d6/a9/3db1410e1c1413735a9a472380e4f431ad9a9e81711cda2aaf02b7f62693/watchfiles-1.0.4-cp313-cp313-musllinux_1_1_aarch64.whl", hash = "sha256:0986902677a1a5e6212d0c49b319aad9cc48da4bd967f86a11bde96ad9676ca1", size = 614125 }, + { url = "https://files.pythonhosted.org/packages/f2/e1/0025d365cf6248c4d1ee4c3d2e3d373bdd3f6aff78ba4298f97b4fad2740/watchfiles-1.0.4-cp313-cp313-musllinux_1_1_x86_64.whl", hash = "sha256:308ac265c56f936636e3b0e3f59e059a40003c655228c131e1ad439957592303", size = 611911 }, + { url = "https://files.pythonhosted.org/packages/55/55/035838277d8c98fc8c917ac9beeb0cd6c59d675dc2421df5f9fcf44a0070/watchfiles-1.0.4-cp313-cp313-win32.whl", hash = "sha256:aee397456a29b492c20fda2d8961e1ffb266223625346ace14e4b6d861ba9c80", size = 271152 }, + { url = "https://files.pythonhosted.org/packages/f0/e5/96b8e55271685ddbadc50ce8bc53aa2dff278fb7ac4c2e473df890def2dc/watchfiles-1.0.4-cp313-cp313-win_amd64.whl", hash = "sha256:d6097538b0ae5c1b88c3b55afa245a66793a8fec7ada6755322e465fb1a0e8cc", size = 285216 }, +] + +[[package]] +name = "wcwidth" +version = "0.2.13" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/6c/63/53559446a878410fc5a5974feb13d31d78d752eb18aeba59c7fef1af7598/wcwidth-0.2.13.tar.gz", hash = "sha256:72ea0c06399eb286d978fdedb6923a9eb47e1c486ce63e9b4e64fc18303972b5", size = 101301 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/fd/84/fd2ba7aafacbad3c4201d395674fc6348826569da3c0937e75505ead3528/wcwidth-0.2.13-py2.py3-none-any.whl", hash = "sha256:3da69048e4540d84af32131829ff948f1e022c1c6bdb8d6102117aac784f6859", size = 34166 }, +] + +[[package]] +name = "websocket-client" +version = "1.8.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/e6/30/fba0d96b4b5fbf5948ed3f4681f7da2f9f64512e1d303f94b4cc174c24a5/websocket_client-1.8.0.tar.gz", hash = "sha256:3239df9f44da632f96012472805d40a23281a991027ce11d2f45a6f24ac4c3da", size = 54648 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/5a/84/44687a29792a70e111c5c477230a72c4b957d88d16141199bf9acb7537a3/websocket_client-1.8.0-py3-none-any.whl", hash = "sha256:17b44cc997f5c498e809b22cdf2d9c7a9e71c02c8cc2b6c56e7c2d1239bfa526", size = 58826 }, +] + +[[package]] +name = "websockets" +version = "15.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/2e/7a/8bc4d15af7ff30f7ba34f9a172063bfcee9f5001d7cef04bee800a658f33/websockets-15.0.tar.gz", hash = "sha256:ca36151289a15b39d8d683fd8b7abbe26fc50be311066c5f8dcf3cb8cee107ab", size = 175574 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/ee/16/81a7403c8c0a33383de647e89c07824ea6a654e3877d6ff402cbae298cb8/websockets-15.0-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:dd24c4d256558429aeeb8d6c24ebad4e982ac52c50bc3670ae8646c181263965", size = 174702 }, + { url = "https://files.pythonhosted.org/packages/ef/40/4629202386a3bf1195db9fe41baeb1d6dfd8d72e651d9592d81dae7fdc7c/websockets-15.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:f83eca8cbfd168e424dfa3b3b5c955d6c281e8fc09feb9d870886ff8d03683c7", size = 172359 }, + { url = "https://files.pythonhosted.org/packages/7b/33/dfb650e822bc7912d8c542c452497867af91dec81e7b5bf96aca5b419d58/websockets-15.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:4095a1f2093002c2208becf6f9a178b336b7572512ee0a1179731acb7788e8ad", size = 172604 }, + { url = "https://files.pythonhosted.org/packages/2e/52/666743114513fcffd43ee5df261a1eb5d41f8e9861b7a190b730732c19ba/websockets-15.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:fb915101dfbf318486364ce85662bb7b020840f68138014972c08331458d41f3", size = 182145 }, + { url = "https://files.pythonhosted.org/packages/9c/63/5273f146b13aa4a057a95ab0855d9990f3a1ced63693f4365135d1abfacc/websockets-15.0-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:45d464622314973d78f364689d5dbb9144e559f93dca11b11af3f2480b5034e1", size = 181152 }, + { url = "https://files.pythonhosted.org/packages/0f/ae/075697f3f97de7c26b73ae96d952e13fa36393e0db3f028540b28954e0a9/websockets-15.0-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ace960769d60037ca9625b4c578a6f28a14301bd2a1ff13bb00e824ac9f73e55", size = 181523 }, + { url = "https://files.pythonhosted.org/packages/25/87/06d091bbcbe01903bed3dad3bb4a1a3c516f61e611ec31fffb28abe4974b/websockets-15.0-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:c7cd4b1015d2f60dfe539ee6c95bc968d5d5fad92ab01bb5501a77393da4f596", size = 181791 }, + { url = "https://files.pythonhosted.org/packages/77/08/5063b6cc1b2aa1fba2ee3b578b777db22fde7145f121d07fd878811e983b/websockets-15.0-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:4f7290295794b5dec470867c7baa4a14182b9732603fd0caf2a5bf1dc3ccabf3", size = 181231 }, + { url = "https://files.pythonhosted.org/packages/86/ff/af23084df0a7405bb2add12add8c17d6192a8de9480f1b90d12352ba2b7d/websockets-15.0-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:3abd670ca7ce230d5a624fd3d55e055215d8d9b723adee0a348352f5d8d12ff4", size = 181191 }, + { url = "https://files.pythonhosted.org/packages/21/ce/b2bdfcf49201dee0b899edc6a814755763ec03d74f2714923d38453a9e8d/websockets-15.0-cp311-cp311-win32.whl", hash = "sha256:110a847085246ab8d4d119632145224d6b49e406c64f1bbeed45c6f05097b680", size = 175666 }, + { url = "https://files.pythonhosted.org/packages/8d/7b/444edcd5365538c226b631897975a65bbf5ccf27c77102e17d8f12a306ea/websockets-15.0-cp311-cp311-win_amd64.whl", hash = "sha256:8d7bbbe2cd6ed80aceef2a14e9f1c1b61683194c216472ed5ff33b700e784e37", size = 176105 }, + { url = "https://files.pythonhosted.org/packages/22/1e/92c4547d7b2a93f848aedaf37e9054111bc00dc11bff4385ca3f80dbb412/websockets-15.0-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:cccc18077acd34c8072578394ec79563664b1c205f7a86a62e94fafc7b59001f", size = 174709 }, + { url = "https://files.pythonhosted.org/packages/9f/37/eae4830a28061ba552516d84478686b637cd9e57d6a90b45ad69e89cb0af/websockets-15.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:d4c22992e24f12de340ca5f824121a5b3e1a37ad4360b4e1aaf15e9d1c42582d", size = 172372 }, + { url = "https://files.pythonhosted.org/packages/46/2f/b409f8b8aa9328d5a47f7a301a43319d540d70cf036d1e6443675978a988/websockets-15.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:1206432cc6c644f6fc03374b264c5ff805d980311563202ed7fef91a38906276", size = 172607 }, + { url = "https://files.pythonhosted.org/packages/d6/81/d7e2e4542d4b4df849b0110df1b1f94f2647b71ab4b65d672090931ad2bb/websockets-15.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5d3cc75ef3e17490042c47e0523aee1bcc4eacd2482796107fd59dd1100a44bc", size = 182422 }, + { url = "https://files.pythonhosted.org/packages/b6/91/3b303160938d123eea97f58be363f7dbec76e8c59d587e07b5bc257dd584/websockets-15.0-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:b89504227a5311610e4be16071465885a0a3d6b0e82e305ef46d9b064ce5fb72", size = 181362 }, + { url = "https://files.pythonhosted.org/packages/f2/8b/df6807f1ca339c567aba9a7ab03bfdb9a833f625e8d2b4fc7529e4c701de/websockets-15.0-cp312-cp312-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:56e3efe356416bc67a8e093607315951d76910f03d2b3ad49c4ade9207bf710d", size = 181787 }, + { url = "https://files.pythonhosted.org/packages/21/37/e6d3d5ebb0ebcaf98ae84904205c9dcaf3e0fe93e65000b9f08631ed7309/websockets-15.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:0f2205cdb444a42a7919690238fb5979a05439b9dbb73dd47c863d39640d85ab", size = 182058 }, + { url = "https://files.pythonhosted.org/packages/c9/df/6aca296f2be4c638ad20908bb3d7c94ce7afc8d9b4b2b0780d1fc59b359c/websockets-15.0-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:aea01f40995fa0945c020228ab919b8dfc93fc8a9f2d3d705ab5b793f32d9e99", size = 181434 }, + { url = "https://files.pythonhosted.org/packages/88/f1/75717a982bab39bbe63c83f9df0e7753e5c98bab907eb4fb5d97fe5c8c11/websockets-15.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:a9f8e33747b1332db11cf7fcf4a9512bef9748cb5eb4d3f7fbc8c30d75dc6ffc", size = 181431 }, + { url = "https://files.pythonhosted.org/packages/e7/15/cee9e63ed9ac5bfc1a3ae8fc6c02c41745023c21eed622eef142d8fdd749/websockets-15.0-cp312-cp312-win32.whl", hash = "sha256:32e02a2d83f4954aa8c17e03fe8ec6962432c39aca4be7e8ee346b05a3476904", size = 175678 }, + { url = "https://files.pythonhosted.org/packages/4e/00/993974c60f40faabb725d4dbae8b072ef73b4c4454bd261d3b1d34ace41f/websockets-15.0-cp312-cp312-win_amd64.whl", hash = "sha256:ffc02b159b65c05f2ed9ec176b715b66918a674bd4daed48a9a7a590dd4be1aa", size = 176119 }, + { url = "https://files.pythonhosted.org/packages/12/23/be28dc1023707ac51768f848d28a946443041a348ee3a54abdf9f6283372/websockets-15.0-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:d2244d8ab24374bed366f9ff206e2619345f9cd7fe79aad5225f53faac28b6b1", size = 174714 }, + { url = "https://files.pythonhosted.org/packages/8f/ff/02b5e9fbb078e7666bf3d25c18c69b499747a12f3e7f2776063ef3fb7061/websockets-15.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:3a302241fbe825a3e4fe07666a2ab513edfdc6d43ce24b79691b45115273b5e7", size = 172374 }, + { url = "https://files.pythonhosted.org/packages/8e/61/901c8d4698e0477eff4c3c664d53f898b601fa83af4ce81946650ec2a4cb/websockets-15.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:10552fed076757a70ba2c18edcbc601c7637b30cdfe8c24b65171e824c7d6081", size = 172605 }, + { url = "https://files.pythonhosted.org/packages/d2/4b/dc47601a80dff317aecf8da7b4ab278d11d3494b2c373b493e4887561f90/websockets-15.0-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c53f97032b87a406044a1c33d1e9290cc38b117a8062e8a8b285175d7e2f99c9", size = 182380 }, + { url = "https://files.pythonhosted.org/packages/83/f7/b155d2b38f05ed47a0b8de1c9ea245fcd7fc625d89f35a37eccba34b42de/websockets-15.0-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:1caf951110ca757b8ad9c4974f5cac7b8413004d2f29707e4d03a65d54cedf2b", size = 181325 }, + { url = "https://files.pythonhosted.org/packages/d3/ff/040a20c01c294695cac0e361caf86f33347acc38f164f6d2be1d3e007d9f/websockets-15.0-cp313-cp313-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8bf1ab71f9f23b0a1d52ec1682a3907e0c208c12fef9c3e99d2b80166b17905f", size = 181763 }, + { url = "https://files.pythonhosted.org/packages/cb/6a/af23e93678fda8341ac8775e85123425e45c608389d3514863c702896ea5/websockets-15.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:bfcd3acc1a81f106abac6afd42327d2cf1e77ec905ae11dc1d9142a006a496b6", size = 182097 }, + { url = "https://files.pythonhosted.org/packages/7e/3e/1069e159c30129dc03c01513b5830237e576f47cedb888777dd885cae583/websockets-15.0-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:c8c5c8e1bac05ef3c23722e591ef4f688f528235e2480f157a9cfe0a19081375", size = 181485 }, + { url = "https://files.pythonhosted.org/packages/9a/a7/c91c47103f1cd941b576bbc452601e9e01f67d5c9be3e0a9abe726491ab5/websockets-15.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:86bfb52a9cfbcc09aba2b71388b0a20ea5c52b6517c0b2e316222435a8cdab72", size = 181466 }, + { url = "https://files.pythonhosted.org/packages/16/32/a4ca6e3d56c24aac46b0cf5c03b841379f6409d07fc2044b244f90f54105/websockets-15.0-cp313-cp313-win32.whl", hash = "sha256:26ba70fed190708551c19a360f9d7eca8e8c0f615d19a574292b7229e0ae324c", size = 175673 }, + { url = "https://files.pythonhosted.org/packages/c0/31/25a417a23e985b61ffa5544f9facfe4a118cb64d664c886f1244a8baeca5/websockets-15.0-cp313-cp313-win_amd64.whl", hash = "sha256:ae721bcc8e69846af00b7a77a220614d9b2ec57d25017a6bbde3a99473e41ce8", size = 176115 }, + { url = "https://files.pythonhosted.org/packages/e8/b2/31eec524b53f01cd8343f10a8e429730c52c1849941d1f530f8253b6d934/websockets-15.0-py3-none-any.whl", hash = "sha256:51ffd53c53c4442415b613497a34ba0aa7b99ac07f1e4a62db5dcd640ae6c3c3", size = 169023 }, +] + +[[package]] +name = "wrapt" +version = "1.17.2" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/c3/fc/e91cc220803d7bc4db93fb02facd8461c37364151b8494762cc88b0fbcef/wrapt-1.17.2.tar.gz", hash = "sha256:41388e9d4d1522446fe79d3213196bd9e3b301a336965b9e27ca2788ebd122f3", size = 55531 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/cd/f7/a2aab2cbc7a665efab072344a8949a71081eed1d2f451f7f7d2b966594a2/wrapt-1.17.2-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:ff04ef6eec3eee8a5efef2401495967a916feaa353643defcc03fc74fe213b58", size = 53308 }, + { url = "https://files.pythonhosted.org/packages/50/ff/149aba8365fdacef52b31a258c4dc1c57c79759c335eff0b3316a2664a64/wrapt-1.17.2-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:4db983e7bca53819efdbd64590ee96c9213894272c776966ca6306b73e4affda", size = 38488 }, + { url = "https://files.pythonhosted.org/packages/65/46/5a917ce85b5c3b490d35c02bf71aedaa9f2f63f2d15d9949cc4ba56e8ba9/wrapt-1.17.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:9abc77a4ce4c6f2a3168ff34b1da9b0f311a8f1cfd694ec96b0603dff1c79438", size = 38776 }, + { url = "https://files.pythonhosted.org/packages/ca/74/336c918d2915a4943501c77566db41d1bd6e9f4dbc317f356b9a244dfe83/wrapt-1.17.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0b929ac182f5ace000d459c59c2c9c33047e20e935f8e39371fa6e3b85d56f4a", size = 83776 }, + { url = "https://files.pythonhosted.org/packages/09/99/c0c844a5ccde0fe5761d4305485297f91d67cf2a1a824c5f282e661ec7ff/wrapt-1.17.2-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f09b286faeff3c750a879d336fb6d8713206fc97af3adc14def0cdd349df6000", size = 75420 }, + { url = "https://files.pythonhosted.org/packages/b4/b0/9fc566b0fe08b282c850063591a756057c3247b2362b9286429ec5bf1721/wrapt-1.17.2-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:1a7ed2d9d039bd41e889f6fb9364554052ca21ce823580f6a07c4ec245c1f5d6", size = 83199 }, + { url = "https://files.pythonhosted.org/packages/9d/4b/71996e62d543b0a0bd95dda485219856def3347e3e9380cc0d6cf10cfb2f/wrapt-1.17.2-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:129a150f5c445165ff941fc02ee27df65940fcb8a22a61828b1853c98763a64b", size = 82307 }, + { url = "https://files.pythonhosted.org/packages/39/35/0282c0d8789c0dc9bcc738911776c762a701f95cfe113fb8f0b40e45c2b9/wrapt-1.17.2-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:1fb5699e4464afe5c7e65fa51d4f99e0b2eadcc176e4aa33600a3df7801d6662", size = 75025 }, + { url = "https://files.pythonhosted.org/packages/4f/6d/90c9fd2c3c6fee181feecb620d95105370198b6b98a0770cba090441a828/wrapt-1.17.2-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:9a2bce789a5ea90e51a02dfcc39e31b7f1e662bc3317979aa7e5538e3a034f72", size = 81879 }, + { url = "https://files.pythonhosted.org/packages/8f/fa/9fb6e594f2ce03ef03eddbdb5f4f90acb1452221a5351116c7c4708ac865/wrapt-1.17.2-cp311-cp311-win32.whl", hash = "sha256:4afd5814270fdf6380616b321fd31435a462019d834f83c8611a0ce7484c7317", size = 36419 }, + { url = "https://files.pythonhosted.org/packages/47/f8/fb1773491a253cbc123c5d5dc15c86041f746ed30416535f2a8df1f4a392/wrapt-1.17.2-cp311-cp311-win_amd64.whl", hash = "sha256:acc130bc0375999da18e3d19e5a86403667ac0c4042a094fefb7eec8ebac7cf3", size = 38773 }, + { url = "https://files.pythonhosted.org/packages/a1/bd/ab55f849fd1f9a58ed7ea47f5559ff09741b25f00c191231f9f059c83949/wrapt-1.17.2-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:d5e2439eecc762cd85e7bd37161d4714aa03a33c5ba884e26c81559817ca0925", size = 53799 }, + { url = "https://files.pythonhosted.org/packages/53/18/75ddc64c3f63988f5a1d7e10fb204ffe5762bc663f8023f18ecaf31a332e/wrapt-1.17.2-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:3fc7cb4c1c744f8c05cd5f9438a3caa6ab94ce8344e952d7c45a8ed59dd88392", size = 38821 }, + { url = "https://files.pythonhosted.org/packages/48/2a/97928387d6ed1c1ebbfd4efc4133a0633546bec8481a2dd5ec961313a1c7/wrapt-1.17.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:8fdbdb757d5390f7c675e558fd3186d590973244fab0c5fe63d373ade3e99d40", size = 38919 }, + { url = "https://files.pythonhosted.org/packages/73/54/3bfe5a1febbbccb7a2f77de47b989c0b85ed3a6a41614b104204a788c20e/wrapt-1.17.2-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5bb1d0dbf99411f3d871deb6faa9aabb9d4e744d67dcaaa05399af89d847a91d", size = 88721 }, + { url = "https://files.pythonhosted.org/packages/25/cb/7262bc1b0300b4b64af50c2720ef958c2c1917525238d661c3e9a2b71b7b/wrapt-1.17.2-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:d18a4865f46b8579d44e4fe1e2bcbc6472ad83d98e22a26c963d46e4c125ef0b", size = 80899 }, + { url = "https://files.pythonhosted.org/packages/2a/5a/04cde32b07a7431d4ed0553a76fdb7a61270e78c5fd5a603e190ac389f14/wrapt-1.17.2-cp312-cp312-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bc570b5f14a79734437cb7b0500376b6b791153314986074486e0b0fa8d71d98", size = 89222 }, + { url = "https://files.pythonhosted.org/packages/09/28/2e45a4f4771fcfb109e244d5dbe54259e970362a311b67a965555ba65026/wrapt-1.17.2-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:6d9187b01bebc3875bac9b087948a2bccefe464a7d8f627cf6e48b1bbae30f82", size = 86707 }, + { url = "https://files.pythonhosted.org/packages/c6/d2/dcb56bf5f32fcd4bd9aacc77b50a539abdd5b6536872413fd3f428b21bed/wrapt-1.17.2-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:9e8659775f1adf02eb1e6f109751268e493c73716ca5761f8acb695e52a756ae", size = 79685 }, + { url = "https://files.pythonhosted.org/packages/80/4e/eb8b353e36711347893f502ce91c770b0b0929f8f0bed2670a6856e667a9/wrapt-1.17.2-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:e8b2816ebef96d83657b56306152a93909a83f23994f4b30ad4573b00bd11bb9", size = 87567 }, + { url = "https://files.pythonhosted.org/packages/17/27/4fe749a54e7fae6e7146f1c7d914d28ef599dacd4416566c055564080fe2/wrapt-1.17.2-cp312-cp312-win32.whl", hash = "sha256:468090021f391fe0056ad3e807e3d9034e0fd01adcd3bdfba977b6fdf4213ea9", size = 36672 }, + { url = "https://files.pythonhosted.org/packages/15/06/1dbf478ea45c03e78a6a8c4be4fdc3c3bddea5c8de8a93bc971415e47f0f/wrapt-1.17.2-cp312-cp312-win_amd64.whl", hash = "sha256:ec89ed91f2fa8e3f52ae53cd3cf640d6feff92ba90d62236a81e4e563ac0e991", size = 38865 }, + { url = "https://files.pythonhosted.org/packages/ce/b9/0ffd557a92f3b11d4c5d5e0c5e4ad057bd9eb8586615cdaf901409920b14/wrapt-1.17.2-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:6ed6ffac43aecfe6d86ec5b74b06a5be33d5bb9243d055141e8cabb12aa08125", size = 53800 }, + { url = "https://files.pythonhosted.org/packages/c0/ef/8be90a0b7e73c32e550c73cfb2fa09db62234227ece47b0e80a05073b375/wrapt-1.17.2-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:35621ae4c00e056adb0009f8e86e28eb4a41a4bfa8f9bfa9fca7d343fe94f998", size = 38824 }, + { url = "https://files.pythonhosted.org/packages/36/89/0aae34c10fe524cce30fe5fc433210376bce94cf74d05b0d68344c8ba46e/wrapt-1.17.2-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:a604bf7a053f8362d27eb9fefd2097f82600b856d5abe996d623babd067b1ab5", size = 38920 }, + { url = "https://files.pythonhosted.org/packages/3b/24/11c4510de906d77e0cfb5197f1b1445d4fec42c9a39ea853d482698ac681/wrapt-1.17.2-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5cbabee4f083b6b4cd282f5b817a867cf0b1028c54d445b7ec7cfe6505057cf8", size = 88690 }, + { url = "https://files.pythonhosted.org/packages/71/d7/cfcf842291267bf455b3e266c0c29dcb675b5540ee8b50ba1699abf3af45/wrapt-1.17.2-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:49703ce2ddc220df165bd2962f8e03b84c89fee2d65e1c24a7defff6f988f4d6", size = 80861 }, + { url = "https://files.pythonhosted.org/packages/d5/66/5d973e9f3e7370fd686fb47a9af3319418ed925c27d72ce16b791231576d/wrapt-1.17.2-cp313-cp313-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8112e52c5822fc4253f3901b676c55ddf288614dc7011634e2719718eaa187dc", size = 89174 }, + { url = "https://files.pythonhosted.org/packages/a7/d3/8e17bb70f6ae25dabc1aaf990f86824e4fd98ee9cadf197054e068500d27/wrapt-1.17.2-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:9fee687dce376205d9a494e9c121e27183b2a3df18037f89d69bd7b35bcf59e2", size = 86721 }, + { url = "https://files.pythonhosted.org/packages/6f/54/f170dfb278fe1c30d0ff864513cff526d624ab8de3254b20abb9cffedc24/wrapt-1.17.2-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:18983c537e04d11cf027fbb60a1e8dfd5190e2b60cc27bc0808e653e7b218d1b", size = 79763 }, + { url = "https://files.pythonhosted.org/packages/4a/98/de07243751f1c4a9b15c76019250210dd3486ce098c3d80d5f729cba029c/wrapt-1.17.2-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:703919b1633412ab54bcf920ab388735832fdcb9f9a00ae49387f0fe67dad504", size = 87585 }, + { url = "https://files.pythonhosted.org/packages/f9/f0/13925f4bd6548013038cdeb11ee2cbd4e37c30f8bfd5db9e5a2a370d6e20/wrapt-1.17.2-cp313-cp313-win32.whl", hash = "sha256:abbb9e76177c35d4e8568e58650aa6926040d6a9f6f03435b7a522bf1c487f9a", size = 36676 }, + { url = "https://files.pythonhosted.org/packages/bf/ae/743f16ef8c2e3628df3ddfd652b7d4c555d12c84b53f3d8218498f4ade9b/wrapt-1.17.2-cp313-cp313-win_amd64.whl", hash = "sha256:69606d7bb691b50a4240ce6b22ebb319c1cfb164e5f6569835058196e0f3a845", size = 38871 }, + { url = "https://files.pythonhosted.org/packages/3d/bc/30f903f891a82d402ffb5fda27ec1d621cc97cb74c16fea0b6141f1d4e87/wrapt-1.17.2-cp313-cp313t-macosx_10_13_universal2.whl", hash = "sha256:4a721d3c943dae44f8e243b380cb645a709ba5bd35d3ad27bc2ed947e9c68192", size = 56312 }, + { url = "https://files.pythonhosted.org/packages/8a/04/c97273eb491b5f1c918857cd26f314b74fc9b29224521f5b83f872253725/wrapt-1.17.2-cp313-cp313t-macosx_10_13_x86_64.whl", hash = "sha256:766d8bbefcb9e00c3ac3b000d9acc51f1b399513f44d77dfe0eb026ad7c9a19b", size = 40062 }, + { url = "https://files.pythonhosted.org/packages/4e/ca/3b7afa1eae3a9e7fefe499db9b96813f41828b9fdb016ee836c4c379dadb/wrapt-1.17.2-cp313-cp313t-macosx_11_0_arm64.whl", hash = "sha256:e496a8ce2c256da1eb98bd15803a79bee00fc351f5dfb9ea82594a3f058309e0", size = 40155 }, + { url = "https://files.pythonhosted.org/packages/89/be/7c1baed43290775cb9030c774bc53c860db140397047cc49aedaf0a15477/wrapt-1.17.2-cp313-cp313t-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:40d615e4fe22f4ad3528448c193b218e077656ca9ccb22ce2cb20db730f8d306", size = 113471 }, + { url = "https://files.pythonhosted.org/packages/32/98/4ed894cf012b6d6aae5f5cc974006bdeb92f0241775addad3f8cd6ab71c8/wrapt-1.17.2-cp313-cp313t-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a5aaeff38654462bc4b09023918b7f21790efb807f54c000a39d41d69cf552cb", size = 101208 }, + { url = "https://files.pythonhosted.org/packages/ea/fd/0c30f2301ca94e655e5e057012e83284ce8c545df7661a78d8bfca2fac7a/wrapt-1.17.2-cp313-cp313t-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9a7d15bbd2bc99e92e39f49a04653062ee6085c0e18b3b7512a4f2fe91f2d681", size = 109339 }, + { url = "https://files.pythonhosted.org/packages/75/56/05d000de894c4cfcb84bcd6b1df6214297b8089a7bd324c21a4765e49b14/wrapt-1.17.2-cp313-cp313t-musllinux_1_2_aarch64.whl", hash = "sha256:e3890b508a23299083e065f435a492b5435eba6e304a7114d2f919d400888cc6", size = 110232 }, + { url = "https://files.pythonhosted.org/packages/53/f8/c3f6b2cf9b9277fb0813418e1503e68414cd036b3b099c823379c9575e6d/wrapt-1.17.2-cp313-cp313t-musllinux_1_2_i686.whl", hash = "sha256:8c8b293cd65ad716d13d8dd3624e42e5a19cc2a2f1acc74b30c2c13f15cb61a6", size = 100476 }, + { url = "https://files.pythonhosted.org/packages/a7/b1/0bb11e29aa5139d90b770ebbfa167267b1fc548d2302c30c8f7572851738/wrapt-1.17.2-cp313-cp313t-musllinux_1_2_x86_64.whl", hash = "sha256:4c82b8785d98cdd9fed4cac84d765d234ed3251bd6afe34cb7ac523cb93e8b4f", size = 106377 }, + { url = "https://files.pythonhosted.org/packages/6a/e1/0122853035b40b3f333bbb25f1939fc1045e21dd518f7f0922b60c156f7c/wrapt-1.17.2-cp313-cp313t-win32.whl", hash = "sha256:13e6afb7fe71fe7485a4550a8844cc9ffbe263c0f1a1eea569bc7091d4898555", size = 37986 }, + { url = "https://files.pythonhosted.org/packages/09/5e/1655cf481e079c1f22d0cabdd4e51733679932718dc23bf2db175f329b76/wrapt-1.17.2-cp313-cp313t-win_amd64.whl", hash = "sha256:eaf675418ed6b3b31c7a989fd007fa7c3be66ce14e5c3b27336383604c9da85c", size = 40750 }, + { url = "https://files.pythonhosted.org/packages/2d/82/f56956041adef78f849db6b289b282e72b55ab8045a75abad81898c28d19/wrapt-1.17.2-py3-none-any.whl", hash = "sha256:b18f2d1533a71f069c7f82d524a52599053d4c7166e9dd374ae2136b7f40f7c8", size = 23594 }, +] + +[[package]] +name = "yarl" +version = "1.18.3" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "idna" }, + { name = "multidict" }, + { name = "propcache" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/b7/9d/4b94a8e6d2b51b599516a5cb88e5bc99b4d8d4583e468057eaa29d5f0918/yarl-1.18.3.tar.gz", hash = "sha256:ac1801c45cbf77b6c99242eeff4fffb5e4e73a800b5c4ad4fc0be5def634d2e1", size = 181062 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/40/93/282b5f4898d8e8efaf0790ba6d10e2245d2c9f30e199d1a85cae9356098c/yarl-1.18.3-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:8503ad47387b8ebd39cbbbdf0bf113e17330ffd339ba1144074da24c545f0069", size = 141555 }, + { url = "https://files.pythonhosted.org/packages/6d/9c/0a49af78df099c283ca3444560f10718fadb8a18dc8b3edf8c7bd9fd7d89/yarl-1.18.3-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:02ddb6756f8f4517a2d5e99d8b2f272488e18dd0bfbc802f31c16c6c20f22193", size = 94351 }, + { url = "https://files.pythonhosted.org/packages/5a/a1/205ab51e148fdcedad189ca8dd587794c6f119882437d04c33c01a75dece/yarl-1.18.3-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:67a283dd2882ac98cc6318384f565bffc751ab564605959df4752d42483ad889", size = 92286 }, + { url = "https://files.pythonhosted.org/packages/ed/fe/88b690b30f3f59275fb674f5f93ddd4a3ae796c2b62e5bb9ece8a4914b83/yarl-1.18.3-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d980e0325b6eddc81331d3f4551e2a333999fb176fd153e075c6d1c2530aa8a8", size = 340649 }, + { url = "https://files.pythonhosted.org/packages/07/eb/3b65499b568e01f36e847cebdc8d7ccb51fff716dbda1ae83c3cbb8ca1c9/yarl-1.18.3-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:b643562c12680b01e17239be267bc306bbc6aac1f34f6444d1bded0c5ce438ca", size = 356623 }, + { url = "https://files.pythonhosted.org/packages/33/46/f559dc184280b745fc76ec6b1954de2c55595f0ec0a7614238b9ebf69618/yarl-1.18.3-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:c017a3b6df3a1bd45b9fa49a0f54005e53fbcad16633870104b66fa1a30a29d8", size = 354007 }, + { url = "https://files.pythonhosted.org/packages/af/ba/1865d85212351ad160f19fb99808acf23aab9a0f8ff31c8c9f1b4d671fc9/yarl-1.18.3-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:75674776d96d7b851b6498f17824ba17849d790a44d282929c42dbb77d4f17ae", size = 344145 }, + { url = "https://files.pythonhosted.org/packages/94/cb/5c3e975d77755d7b3d5193e92056b19d83752ea2da7ab394e22260a7b824/yarl-1.18.3-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ccaa3a4b521b780a7e771cc336a2dba389a0861592bbce09a476190bb0c8b4b3", size = 336133 }, + { url = "https://files.pythonhosted.org/packages/19/89/b77d3fd249ab52a5c40859815765d35c91425b6bb82e7427ab2f78f5ff55/yarl-1.18.3-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:2d06d3005e668744e11ed80812e61efd77d70bb7f03e33c1598c301eea20efbb", size = 347967 }, + { url = "https://files.pythonhosted.org/packages/35/bd/f6b7630ba2cc06c319c3235634c582a6ab014d52311e7d7c22f9518189b5/yarl-1.18.3-cp311-cp311-musllinux_1_2_armv7l.whl", hash = "sha256:9d41beda9dc97ca9ab0b9888cb71f7539124bc05df02c0cff6e5acc5a19dcc6e", size = 346397 }, + { url = "https://files.pythonhosted.org/packages/18/1a/0b4e367d5a72d1f095318344848e93ea70da728118221f84f1bf6c1e39e7/yarl-1.18.3-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:ba23302c0c61a9999784e73809427c9dbedd79f66a13d84ad1b1943802eaaf59", size = 350206 }, + { url = "https://files.pythonhosted.org/packages/b5/cf/320fff4367341fb77809a2d8d7fe75b5d323a8e1b35710aafe41fdbf327b/yarl-1.18.3-cp311-cp311-musllinux_1_2_ppc64le.whl", hash = "sha256:6748dbf9bfa5ba1afcc7556b71cda0d7ce5f24768043a02a58846e4a443d808d", size = 362089 }, + { url = "https://files.pythonhosted.org/packages/57/cf/aadba261d8b920253204085268bad5e8cdd86b50162fcb1b10c10834885a/yarl-1.18.3-cp311-cp311-musllinux_1_2_s390x.whl", hash = "sha256:0b0cad37311123211dc91eadcb322ef4d4a66008d3e1bdc404808992260e1a0e", size = 366267 }, + { url = "https://files.pythonhosted.org/packages/54/58/fb4cadd81acdee6dafe14abeb258f876e4dd410518099ae9a35c88d8097c/yarl-1.18.3-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:0fb2171a4486bb075316ee754c6d8382ea6eb8b399d4ec62fde2b591f879778a", size = 359141 }, + { url = "https://files.pythonhosted.org/packages/9a/7a/4c571597589da4cd5c14ed2a0b17ac56ec9ee7ee615013f74653169e702d/yarl-1.18.3-cp311-cp311-win32.whl", hash = "sha256:61b1a825a13bef4a5f10b1885245377d3cd0bf87cba068e1d9a88c2ae36880e1", size = 84402 }, + { url = "https://files.pythonhosted.org/packages/ae/7b/8600250b3d89b625f1121d897062f629883c2f45339623b69b1747ec65fa/yarl-1.18.3-cp311-cp311-win_amd64.whl", hash = "sha256:b9d60031cf568c627d028239693fd718025719c02c9f55df0a53e587aab951b5", size = 91030 }, + { url = "https://files.pythonhosted.org/packages/33/85/bd2e2729752ff4c77338e0102914897512e92496375e079ce0150a6dc306/yarl-1.18.3-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:1dd4bdd05407ced96fed3d7f25dbbf88d2ffb045a0db60dbc247f5b3c5c25d50", size = 142644 }, + { url = "https://files.pythonhosted.org/packages/ff/74/1178322cc0f10288d7eefa6e4a85d8d2e28187ccab13d5b844e8b5d7c88d/yarl-1.18.3-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:7c33dd1931a95e5d9a772d0ac5e44cac8957eaf58e3c8da8c1414de7dd27c576", size = 94962 }, + { url = "https://files.pythonhosted.org/packages/be/75/79c6acc0261e2c2ae8a1c41cf12265e91628c8c58ae91f5ff59e29c0787f/yarl-1.18.3-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:25b411eddcfd56a2f0cd6a384e9f4f7aa3efee14b188de13048c25b5e91f1640", size = 92795 }, + { url = "https://files.pythonhosted.org/packages/6b/32/927b2d67a412c31199e83fefdce6e645247b4fb164aa1ecb35a0f9eb2058/yarl-1.18.3-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:436c4fc0a4d66b2badc6c5fc5ef4e47bb10e4fd9bf0c79524ac719a01f3607c2", size = 332368 }, + { url = "https://files.pythonhosted.org/packages/19/e5/859fca07169d6eceeaa4fde1997c91d8abde4e9a7c018e371640c2da2b71/yarl-1.18.3-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e35ef8683211db69ffe129a25d5634319a677570ab6b2eba4afa860f54eeaf75", size = 342314 }, + { url = "https://files.pythonhosted.org/packages/08/75/76b63ccd91c9e03ab213ef27ae6add2e3400e77e5cdddf8ed2dbc36e3f21/yarl-1.18.3-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:84b2deecba4a3f1a398df819151eb72d29bfeb3b69abb145a00ddc8d30094512", size = 341987 }, + { url = "https://files.pythonhosted.org/packages/1a/e1/a097d5755d3ea8479a42856f51d97eeff7a3a7160593332d98f2709b3580/yarl-1.18.3-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:00e5a1fea0fd4f5bfa7440a47eff01d9822a65b4488f7cff83155a0f31a2ecba", size = 336914 }, + { url = "https://files.pythonhosted.org/packages/0b/42/e1b4d0e396b7987feceebe565286c27bc085bf07d61a59508cdaf2d45e63/yarl-1.18.3-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:d0e883008013c0e4aef84dcfe2a0b172c4d23c2669412cf5b3371003941f72bb", size = 325765 }, + { url = "https://files.pythonhosted.org/packages/7e/18/03a5834ccc9177f97ca1bbb245b93c13e58e8225276f01eedc4cc98ab820/yarl-1.18.3-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:5a3f356548e34a70b0172d8890006c37be92995f62d95a07b4a42e90fba54272", size = 344444 }, + { url = "https://files.pythonhosted.org/packages/c8/03/a713633bdde0640b0472aa197b5b86e90fbc4c5bc05b727b714cd8a40e6d/yarl-1.18.3-cp312-cp312-musllinux_1_2_armv7l.whl", hash = "sha256:ccd17349166b1bee6e529b4add61727d3f55edb7babbe4069b5764c9587a8cc6", size = 340760 }, + { url = "https://files.pythonhosted.org/packages/eb/99/f6567e3f3bbad8fd101886ea0276c68ecb86a2b58be0f64077396cd4b95e/yarl-1.18.3-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:b958ddd075ddba5b09bb0be8a6d9906d2ce933aee81100db289badbeb966f54e", size = 346484 }, + { url = "https://files.pythonhosted.org/packages/8e/a9/84717c896b2fc6cb15bd4eecd64e34a2f0a9fd6669e69170c73a8b46795a/yarl-1.18.3-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:c7d79f7d9aabd6011004e33b22bc13056a3e3fb54794d138af57f5ee9d9032cb", size = 359864 }, + { url = "https://files.pythonhosted.org/packages/1e/2e/d0f5f1bef7ee93ed17e739ec8dbcb47794af891f7d165fa6014517b48169/yarl-1.18.3-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:4891ed92157e5430874dad17b15eb1fda57627710756c27422200c52d8a4e393", size = 364537 }, + { url = "https://files.pythonhosted.org/packages/97/8a/568d07c5d4964da5b02621a517532adb8ec5ba181ad1687191fffeda0ab6/yarl-1.18.3-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:ce1af883b94304f493698b00d0f006d56aea98aeb49d75ec7d98cd4a777e9285", size = 357861 }, + { url = "https://files.pythonhosted.org/packages/7d/e3/924c3f64b6b3077889df9a1ece1ed8947e7b61b0a933f2ec93041990a677/yarl-1.18.3-cp312-cp312-win32.whl", hash = "sha256:f91c4803173928a25e1a55b943c81f55b8872f0018be83e3ad4938adffb77dd2", size = 84097 }, + { url = "https://files.pythonhosted.org/packages/34/45/0e055320daaabfc169b21ff6174567b2c910c45617b0d79c68d7ab349b02/yarl-1.18.3-cp312-cp312-win_amd64.whl", hash = "sha256:7e2ee16578af3b52ac2f334c3b1f92262f47e02cc6193c598502bd46f5cd1477", size = 90399 }, + { url = "https://files.pythonhosted.org/packages/30/c7/c790513d5328a8390be8f47be5d52e141f78b66c6c48f48d241ca6bd5265/yarl-1.18.3-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:90adb47ad432332d4f0bc28f83a5963f426ce9a1a8809f5e584e704b82685dcb", size = 140789 }, + { url = "https://files.pythonhosted.org/packages/30/aa/a2f84e93554a578463e2edaaf2300faa61c8701f0898725842c704ba5444/yarl-1.18.3-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:913829534200eb0f789d45349e55203a091f45c37a2674678744ae52fae23efa", size = 94144 }, + { url = "https://files.pythonhosted.org/packages/c6/fc/d68d8f83714b221a85ce7866832cba36d7c04a68fa6a960b908c2c84f325/yarl-1.18.3-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:ef9f7768395923c3039055c14334ba4d926f3baf7b776c923c93d80195624782", size = 91974 }, + { url = "https://files.pythonhosted.org/packages/56/4e/d2563d8323a7e9a414b5b25341b3942af5902a2263d36d20fb17c40411e2/yarl-1.18.3-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:88a19f62ff30117e706ebc9090b8ecc79aeb77d0b1f5ec10d2d27a12bc9f66d0", size = 333587 }, + { url = "https://files.pythonhosted.org/packages/25/c9/cfec0bc0cac8d054be223e9f2c7909d3e8442a856af9dbce7e3442a8ec8d/yarl-1.18.3-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e17c9361d46a4d5addf777c6dd5eab0715a7684c2f11b88c67ac37edfba6c482", size = 344386 }, + { url = "https://files.pythonhosted.org/packages/ab/5d/4c532190113b25f1364d25f4c319322e86232d69175b91f27e3ebc2caf9a/yarl-1.18.3-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:1a74a13a4c857a84a845505fd2d68e54826a2cd01935a96efb1e9d86c728e186", size = 345421 }, + { url = "https://files.pythonhosted.org/packages/23/d1/6cdd1632da013aa6ba18cee4d750d953104a5e7aac44e249d9410a972bf5/yarl-1.18.3-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:41f7ce59d6ee7741af71d82020346af364949314ed3d87553763a2df1829cc58", size = 339384 }, + { url = "https://files.pythonhosted.org/packages/9a/c4/6b3c39bec352e441bd30f432cda6ba51681ab19bb8abe023f0d19777aad1/yarl-1.18.3-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f52a265001d830bc425f82ca9eabda94a64a4d753b07d623a9f2863fde532b53", size = 326689 }, + { url = "https://files.pythonhosted.org/packages/23/30/07fb088f2eefdc0aa4fc1af4e3ca4eb1a3aadd1ce7d866d74c0f124e6a85/yarl-1.18.3-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:82123d0c954dc58db301f5021a01854a85bf1f3bb7d12ae0c01afc414a882ca2", size = 345453 }, + { url = "https://files.pythonhosted.org/packages/63/09/d54befb48f9cd8eec43797f624ec37783a0266855f4930a91e3d5c7717f8/yarl-1.18.3-cp313-cp313-musllinux_1_2_armv7l.whl", hash = "sha256:2ec9bbba33b2d00999af4631a3397d1fd78290c48e2a3e52d8dd72db3a067ac8", size = 341872 }, + { url = "https://files.pythonhosted.org/packages/91/26/fd0ef9bf29dd906a84b59f0cd1281e65b0c3e08c6aa94b57f7d11f593518/yarl-1.18.3-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:fbd6748e8ab9b41171bb95c6142faf068f5ef1511935a0aa07025438dd9a9bc1", size = 347497 }, + { url = "https://files.pythonhosted.org/packages/d9/b5/14ac7a256d0511b2ac168d50d4b7d744aea1c1aa20c79f620d1059aab8b2/yarl-1.18.3-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:877d209b6aebeb5b16c42cbb377f5f94d9e556626b1bfff66d7b0d115be88d0a", size = 359981 }, + { url = "https://files.pythonhosted.org/packages/ca/b3/d493221ad5cbd18bc07e642894030437e405e1413c4236dd5db6e46bcec9/yarl-1.18.3-cp313-cp313-musllinux_1_2_s390x.whl", hash = "sha256:b464c4ab4bfcb41e3bfd3f1c26600d038376c2de3297760dfe064d2cb7ea8e10", size = 366229 }, + { url = "https://files.pythonhosted.org/packages/04/56/6a3e2a5d9152c56c346df9b8fb8edd2c8888b1e03f96324d457e5cf06d34/yarl-1.18.3-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:8d39d351e7faf01483cc7ff7c0213c412e38e5a340238826be7e0e4da450fdc8", size = 360383 }, + { url = "https://files.pythonhosted.org/packages/fd/b7/4b3c7c7913a278d445cc6284e59b2e62fa25e72758f888b7a7a39eb8423f/yarl-1.18.3-cp313-cp313-win32.whl", hash = "sha256:61ee62ead9b68b9123ec24bc866cbef297dd266175d53296e2db5e7f797f902d", size = 310152 }, + { url = "https://files.pythonhosted.org/packages/f5/d5/688db678e987c3e0fb17867970700b92603cadf36c56e5fb08f23e822a0c/yarl-1.18.3-cp313-cp313-win_amd64.whl", hash = "sha256:578e281c393af575879990861823ef19d66e2b1d0098414855dd367e234f5b3c", size = 315723 }, + { url = "https://files.pythonhosted.org/packages/f5/4b/a06e0ec3d155924f77835ed2d167ebd3b211a7b0853da1cf8d8414d784ef/yarl-1.18.3-py3-none-any.whl", hash = "sha256:b57f4f58099328dfb26c6a771d09fb20dbbae81d20cfb66141251ea063bd101b", size = 45109 }, +] + +[[package]] +name = "zipp" +version = "3.21.0" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/3f/50/bad581df71744867e9468ebd0bcd6505de3b275e06f202c2cb016e3ff56f/zipp-3.21.0.tar.gz", hash = "sha256:2c9958f6430a2040341a52eb608ed6dd93ef4392e02ffe219417c1b28b5dd1f4", size = 24545 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/b7/1a/7e4798e9339adc931158c9d69ecc34f5e6791489d469f5e50ec15e35f458/zipp-3.21.0-py3-none-any.whl", hash = "sha256:ac1bbe05fd2991f160ebce24ffbac5f6d11d83dc90891255885223d42b3cd931", size = 9630 }, +] + +[[package]] +name = "zstandard" +version = "0.23.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "cffi", marker = "platform_python_implementation == 'PyPy'" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/ed/f6/2ac0287b442160a89d726b17a9184a4c615bb5237db763791a7fd16d9df1/zstandard-0.23.0.tar.gz", hash = "sha256:b2d8c62d08e7255f68f7a740bae85b3c9b8e5466baa9cbf7f57f1cde0ac6bc09", size = 681701 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/9e/40/f67e7d2c25a0e2dc1744dd781110b0b60306657f8696cafb7ad7579469bd/zstandard-0.23.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:34895a41273ad33347b2fc70e1bff4240556de3c46c6ea430a7ed91f9042aa4e", size = 788699 }, + { url = "https://files.pythonhosted.org/packages/e8/46/66d5b55f4d737dd6ab75851b224abf0afe5774976fe511a54d2eb9063a41/zstandard-0.23.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:77ea385f7dd5b5676d7fd943292ffa18fbf5c72ba98f7d09fc1fb9e819b34c23", size = 633681 }, + { url = "https://files.pythonhosted.org/packages/63/b6/677e65c095d8e12b66b8f862b069bcf1f1d781b9c9c6f12eb55000d57583/zstandard-0.23.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:983b6efd649723474f29ed42e1467f90a35a74793437d0bc64a5bf482bedfa0a", size = 4944328 }, + { url = "https://files.pythonhosted.org/packages/59/cc/e76acb4c42afa05a9d20827116d1f9287e9c32b7ad58cc3af0721ce2b481/zstandard-0.23.0-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:80a539906390591dd39ebb8d773771dc4db82ace6372c4d41e2d293f8e32b8db", size = 5311955 }, + { url = "https://files.pythonhosted.org/packages/78/e4/644b8075f18fc7f632130c32e8f36f6dc1b93065bf2dd87f03223b187f26/zstandard-0.23.0-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:445e4cb5048b04e90ce96a79b4b63140e3f4ab5f662321975679b5f6360b90e2", size = 5344944 }, + { url = "https://files.pythonhosted.org/packages/76/3f/dbafccf19cfeca25bbabf6f2dd81796b7218f768ec400f043edc767015a6/zstandard-0.23.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fd30d9c67d13d891f2360b2a120186729c111238ac63b43dbd37a5a40670b8ca", size = 5442927 }, + { url = "https://files.pythonhosted.org/packages/0c/c3/d24a01a19b6733b9f218e94d1a87c477d523237e07f94899e1c10f6fd06c/zstandard-0.23.0-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:d20fd853fbb5807c8e84c136c278827b6167ded66c72ec6f9a14b863d809211c", size = 4864910 }, + { url = "https://files.pythonhosted.org/packages/1c/a9/cf8f78ead4597264f7618d0875be01f9bc23c9d1d11afb6d225b867cb423/zstandard-0.23.0-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:ed1708dbf4d2e3a1c5c69110ba2b4eb6678262028afd6c6fbcc5a8dac9cda68e", size = 4935544 }, + { url = "https://files.pythonhosted.org/packages/2c/96/8af1e3731b67965fb995a940c04a2c20997a7b3b14826b9d1301cf160879/zstandard-0.23.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:be9b5b8659dff1f913039c2feee1aca499cfbc19e98fa12bc85e037c17ec6ca5", size = 5467094 }, + { url = "https://files.pythonhosted.org/packages/ff/57/43ea9df642c636cb79f88a13ab07d92d88d3bfe3e550b55a25a07a26d878/zstandard-0.23.0-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:65308f4b4890aa12d9b6ad9f2844b7ee42c7f7a4fd3390425b242ffc57498f48", size = 4860440 }, + { url = "https://files.pythonhosted.org/packages/46/37/edb78f33c7f44f806525f27baa300341918fd4c4af9472fbc2c3094be2e8/zstandard-0.23.0-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:98da17ce9cbf3bfe4617e836d561e433f871129e3a7ac16d6ef4c680f13a839c", size = 4700091 }, + { url = "https://files.pythonhosted.org/packages/c1/f1/454ac3962671a754f3cb49242472df5c2cced4eb959ae203a377b45b1a3c/zstandard-0.23.0-cp311-cp311-musllinux_1_2_ppc64le.whl", hash = "sha256:8ed7d27cb56b3e058d3cf684d7200703bcae623e1dcc06ed1e18ecda39fee003", size = 5208682 }, + { url = "https://files.pythonhosted.org/packages/85/b2/1734b0fff1634390b1b887202d557d2dd542de84a4c155c258cf75da4773/zstandard-0.23.0-cp311-cp311-musllinux_1_2_s390x.whl", hash = "sha256:b69bb4f51daf461b15e7b3db033160937d3ff88303a7bc808c67bbc1eaf98c78", size = 5669707 }, + { url = "https://files.pythonhosted.org/packages/52/5a/87d6971f0997c4b9b09c495bf92189fb63de86a83cadc4977dc19735f652/zstandard-0.23.0-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:034b88913ecc1b097f528e42b539453fa82c3557e414b3de9d5632c80439a473", size = 5201792 }, + { url = "https://files.pythonhosted.org/packages/79/02/6f6a42cc84459d399bd1a4e1adfc78d4dfe45e56d05b072008d10040e13b/zstandard-0.23.0-cp311-cp311-win32.whl", hash = "sha256:f2d4380bf5f62daabd7b751ea2339c1a21d1c9463f1feb7fc2bdcea2c29c3160", size = 430586 }, + { url = "https://files.pythonhosted.org/packages/be/a2/4272175d47c623ff78196f3c10e9dc7045c1b9caf3735bf041e65271eca4/zstandard-0.23.0-cp311-cp311-win_amd64.whl", hash = "sha256:62136da96a973bd2557f06ddd4e8e807f9e13cbb0bfb9cc06cfe6d98ea90dfe0", size = 495420 }, + { url = "https://files.pythonhosted.org/packages/7b/83/f23338c963bd9de687d47bf32efe9fd30164e722ba27fb59df33e6b1719b/zstandard-0.23.0-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:b4567955a6bc1b20e9c31612e615af6b53733491aeaa19a6b3b37f3b65477094", size = 788713 }, + { url = "https://files.pythonhosted.org/packages/5b/b3/1a028f6750fd9227ee0b937a278a434ab7f7fdc3066c3173f64366fe2466/zstandard-0.23.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:1e172f57cd78c20f13a3415cc8dfe24bf388614324d25539146594c16d78fcc8", size = 633459 }, + { url = "https://files.pythonhosted.org/packages/26/af/36d89aae0c1f95a0a98e50711bc5d92c144939efc1f81a2fcd3e78d7f4c1/zstandard-0.23.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:b0e166f698c5a3e914947388c162be2583e0c638a4703fc6a543e23a88dea3c1", size = 4945707 }, + { url = "https://files.pythonhosted.org/packages/cd/2e/2051f5c772f4dfc0aae3741d5fc72c3dcfe3aaeb461cc231668a4db1ce14/zstandard-0.23.0-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:12a289832e520c6bd4dcaad68e944b86da3bad0d339ef7989fb7e88f92e96072", size = 5306545 }, + { url = "https://files.pythonhosted.org/packages/0a/9e/a11c97b087f89cab030fa71206963090d2fecd8eb83e67bb8f3ffb84c024/zstandard-0.23.0-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:d50d31bfedd53a928fed6707b15a8dbeef011bb6366297cc435accc888b27c20", size = 5337533 }, + { url = "https://files.pythonhosted.org/packages/fc/79/edeb217c57fe1bf16d890aa91a1c2c96b28c07b46afed54a5dcf310c3f6f/zstandard-0.23.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:72c68dda124a1a138340fb62fa21b9bf4848437d9ca60bd35db36f2d3345f373", size = 5436510 }, + { url = "https://files.pythonhosted.org/packages/81/4f/c21383d97cb7a422ddf1ae824b53ce4b51063d0eeb2afa757eb40804a8ef/zstandard-0.23.0-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:53dd9d5e3d29f95acd5de6802e909ada8d8d8cfa37a3ac64836f3bc4bc5512db", size = 4859973 }, + { url = "https://files.pythonhosted.org/packages/ab/15/08d22e87753304405ccac8be2493a495f529edd81d39a0870621462276ef/zstandard-0.23.0-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:6a41c120c3dbc0d81a8e8adc73312d668cd34acd7725f036992b1b72d22c1772", size = 4936968 }, + { url = "https://files.pythonhosted.org/packages/eb/fa/f3670a597949fe7dcf38119a39f7da49a8a84a6f0b1a2e46b2f71a0ab83f/zstandard-0.23.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:40b33d93c6eddf02d2c19f5773196068d875c41ca25730e8288e9b672897c105", size = 5467179 }, + { url = "https://files.pythonhosted.org/packages/4e/a9/dad2ab22020211e380adc477a1dbf9f109b1f8d94c614944843e20dc2a99/zstandard-0.23.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:9206649ec587e6b02bd124fb7799b86cddec350f6f6c14bc82a2b70183e708ba", size = 4848577 }, + { url = "https://files.pythonhosted.org/packages/08/03/dd28b4484b0770f1e23478413e01bee476ae8227bbc81561f9c329e12564/zstandard-0.23.0-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:76e79bc28a65f467e0409098fa2c4376931fd3207fbeb6b956c7c476d53746dd", size = 4693899 }, + { url = "https://files.pythonhosted.org/packages/2b/64/3da7497eb635d025841e958bcd66a86117ae320c3b14b0ae86e9e8627518/zstandard-0.23.0-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:66b689c107857eceabf2cf3d3fc699c3c0fe8ccd18df2219d978c0283e4c508a", size = 5199964 }, + { url = "https://files.pythonhosted.org/packages/43/a4/d82decbab158a0e8a6ebb7fc98bc4d903266bce85b6e9aaedea1d288338c/zstandard-0.23.0-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:9c236e635582742fee16603042553d276cca506e824fa2e6489db04039521e90", size = 5655398 }, + { url = "https://files.pythonhosted.org/packages/f2/61/ac78a1263bc83a5cf29e7458b77a568eda5a8f81980691bbc6eb6a0d45cc/zstandard-0.23.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:a8fffdbd9d1408006baaf02f1068d7dd1f016c6bcb7538682622c556e7b68e35", size = 5191313 }, + { url = "https://files.pythonhosted.org/packages/e7/54/967c478314e16af5baf849b6ee9d6ea724ae5b100eb506011f045d3d4e16/zstandard-0.23.0-cp312-cp312-win32.whl", hash = "sha256:dc1d33abb8a0d754ea4763bad944fd965d3d95b5baef6b121c0c9013eaf1907d", size = 430877 }, + { url = "https://files.pythonhosted.org/packages/75/37/872d74bd7739639c4553bf94c84af7d54d8211b626b352bc57f0fd8d1e3f/zstandard-0.23.0-cp312-cp312-win_amd64.whl", hash = "sha256:64585e1dba664dc67c7cdabd56c1e5685233fbb1fc1966cfba2a340ec0dfff7b", size = 495595 }, + { url = "https://files.pythonhosted.org/packages/80/f1/8386f3f7c10261fe85fbc2c012fdb3d4db793b921c9abcc995d8da1b7a80/zstandard-0.23.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:576856e8594e6649aee06ddbfc738fec6a834f7c85bf7cadd1c53d4a58186ef9", size = 788975 }, + { url = "https://files.pythonhosted.org/packages/16/e8/cbf01077550b3e5dc86089035ff8f6fbbb312bc0983757c2d1117ebba242/zstandard-0.23.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:38302b78a850ff82656beaddeb0bb989a0322a8bbb1bf1ab10c17506681d772a", size = 633448 }, + { url = "https://files.pythonhosted.org/packages/06/27/4a1b4c267c29a464a161aeb2589aff212b4db653a1d96bffe3598f3f0d22/zstandard-0.23.0-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d2240ddc86b74966c34554c49d00eaafa8200a18d3a5b6ffbf7da63b11d74ee2", size = 4945269 }, + { url = "https://files.pythonhosted.org/packages/7c/64/d99261cc57afd9ae65b707e38045ed8269fbdae73544fd2e4a4d50d0ed83/zstandard-0.23.0-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:2ef230a8fd217a2015bc91b74f6b3b7d6522ba48be29ad4ea0ca3a3775bf7dd5", size = 5306228 }, + { url = "https://files.pythonhosted.org/packages/7a/cf/27b74c6f22541f0263016a0fd6369b1b7818941de639215c84e4e94b2a1c/zstandard-0.23.0-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:774d45b1fac1461f48698a9d4b5fa19a69d47ece02fa469825b442263f04021f", size = 5336891 }, + { url = "https://files.pythonhosted.org/packages/fa/18/89ac62eac46b69948bf35fcd90d37103f38722968e2981f752d69081ec4d/zstandard-0.23.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6f77fa49079891a4aab203d0b1744acc85577ed16d767b52fc089d83faf8d8ed", size = 5436310 }, + { url = "https://files.pythonhosted.org/packages/a8/a8/5ca5328ee568a873f5118d5b5f70d1f36c6387716efe2e369010289a5738/zstandard-0.23.0-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ac184f87ff521f4840e6ea0b10c0ec90c6b1dcd0bad2f1e4a9a1b4fa177982ea", size = 4859912 }, + { url = "https://files.pythonhosted.org/packages/ea/ca/3781059c95fd0868658b1cf0440edd832b942f84ae60685d0cfdb808bca1/zstandard-0.23.0-cp313-cp313-musllinux_1_1_aarch64.whl", hash = "sha256:c363b53e257246a954ebc7c488304b5592b9c53fbe74d03bc1c64dda153fb847", size = 4936946 }, + { url = "https://files.pythonhosted.org/packages/ce/11/41a58986f809532742c2b832c53b74ba0e0a5dae7e8ab4642bf5876f35de/zstandard-0.23.0-cp313-cp313-musllinux_1_1_x86_64.whl", hash = "sha256:e7792606d606c8df5277c32ccb58f29b9b8603bf83b48639b7aedf6df4fe8171", size = 5466994 }, + { url = "https://files.pythonhosted.org/packages/83/e3/97d84fe95edd38d7053af05159465d298c8b20cebe9ccb3d26783faa9094/zstandard-0.23.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:a0817825b900fcd43ac5d05b8b3079937073d2b1ff9cf89427590718b70dd840", size = 4848681 }, + { url = "https://files.pythonhosted.org/packages/6e/99/cb1e63e931de15c88af26085e3f2d9af9ce53ccafac73b6e48418fd5a6e6/zstandard-0.23.0-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:9da6bc32faac9a293ddfdcb9108d4b20416219461e4ec64dfea8383cac186690", size = 4694239 }, + { url = "https://files.pythonhosted.org/packages/ab/50/b1e703016eebbc6501fc92f34db7b1c68e54e567ef39e6e59cf5fb6f2ec0/zstandard-0.23.0-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:fd7699e8fd9969f455ef2926221e0233f81a2542921471382e77a9e2f2b57f4b", size = 5200149 }, + { url = "https://files.pythonhosted.org/packages/aa/e0/932388630aaba70197c78bdb10cce2c91fae01a7e553b76ce85471aec690/zstandard-0.23.0-cp313-cp313-musllinux_1_2_s390x.whl", hash = "sha256:d477ed829077cd945b01fc3115edd132c47e6540ddcd96ca169facff28173057", size = 5655392 }, + { url = "https://files.pythonhosted.org/packages/02/90/2633473864f67a15526324b007a9f96c96f56d5f32ef2a56cc12f9548723/zstandard-0.23.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:fa6ce8b52c5987b3e34d5674b0ab529a4602b632ebab0a93b07bfb4dfc8f8a33", size = 5191299 }, + { url = "https://files.pythonhosted.org/packages/b0/4c/315ca5c32da7e2dc3455f3b2caee5c8c2246074a61aac6ec3378a97b7136/zstandard-0.23.0-cp313-cp313-win32.whl", hash = "sha256:a9b07268d0c3ca5c170a385a0ab9fb7fdd9f5fd866be004c4ea39e44edce47dd", size = 430862 }, + { url = "https://files.pythonhosted.org/packages/a2/bf/c6aaba098e2d04781e8f4f7c0ba3c7aa73d00e4c436bcc0cf059a66691d1/zstandard-0.23.0-cp313-cp313-win_amd64.whl", hash = "sha256:f3513916e8c645d0610815c257cbfd3242adfd5c4cfa78be514e5a3ebb42a41b", size = 495578 }, +]