From eb252a14302517dfce34fccccd5727cc1aa0bb84 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 17 Apr 2026 19:53:49 +0000 Subject: [PATCH 01/14] chore(tests): bump steady to v0.22.1 --- scripts/mock | 6 +++--- scripts/test | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/scripts/mock b/scripts/mock index 886f2ffc..04d29019 100755 --- a/scripts/mock +++ b/scripts/mock @@ -22,9 +22,9 @@ echo "==> Starting mock server with URL ${URL}" # Run steady mock on the given spec if [ "$1" == "--daemon" ]; then # Pre-install the package so the download doesn't eat into the startup timeout - npm exec --package=@stdy/cli@0.20.2 -- steady --version + npm exec --package=@stdy/cli@0.22.1 -- steady --version - npm exec --package=@stdy/cli@0.20.2 -- steady --host 127.0.0.1 -p 4010 --validator-query-array-format=brackets --validator-form-array-format=brackets --validator-query-object-format=brackets --validator-form-object-format=brackets "$URL" &> .stdy.log & + npm exec --package=@stdy/cli@0.22.1 -- steady --host 127.0.0.1 -p 4010 --validator-query-array-format=brackets --validator-form-array-format=brackets --validator-query-object-format=brackets --validator-form-object-format=brackets "$URL" &> .stdy.log & # Wait for server to come online via health endpoint (max 30s) echo -n "Waiting for server" @@ -48,5 +48,5 @@ if [ "$1" == "--daemon" ]; then echo else - npm exec --package=@stdy/cli@0.20.2 -- steady --host 127.0.0.1 -p 4010 --validator-query-array-format=brackets --validator-form-array-format=brackets --validator-query-object-format=brackets --validator-form-object-format=brackets "$URL" + npm exec --package=@stdy/cli@0.22.1 -- steady --host 127.0.0.1 -p 4010 --validator-query-array-format=brackets --validator-form-array-format=brackets --validator-query-object-format=brackets --validator-form-object-format=brackets "$URL" fi diff --git a/scripts/test b/scripts/test index 85b88e14..5ee573cf 100755 --- a/scripts/test +++ b/scripts/test @@ -43,7 +43,7 @@ elif ! steady_is_running ; then echo -e "To run the server, pass in the path or url of your OpenAPI" echo -e "spec to the steady command:" echo - echo -e " \$ ${YELLOW}npm exec --package=@stdy/cli@0.20.2 -- steady path/to/your.openapi.yml --host 127.0.0.1 -p 4010 --validator-query-array-format=brackets --validator-form-array-format=brackets --validator-query-object-format=brackets --validator-form-object-format=brackets${NC}" + echo -e " \$ ${YELLOW}npm exec --package=@stdy/cli@0.22.1 -- steady path/to/your.openapi.yml --host 127.0.0.1 -p 4010 --validator-query-array-format=brackets --validator-form-array-format=brackets --validator-query-object-format=brackets --validator-form-object-format=brackets${NC}" echo exit 1 From acb12fa8891902545beec8cf7d34015a24a53b98 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 22 Apr 2026 10:27:52 +0000 Subject: [PATCH 02/14] chore(internal): update docs ordering --- packages/mcp-server/src/local-docs-search.ts | 24 ++++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/packages/mcp-server/src/local-docs-search.ts b/packages/mcp-server/src/local-docs-search.ts index 75533d00..86ebac7d 100644 --- a/packages/mcp-server/src/local-docs-search.ts +++ b/packages/mcp-server/src/local-docs-search.ts @@ -2496,34 +2496,34 @@ const EMBEDDED_METHODS: MethodEntry[] = [ const EMBEDDED_READMES: { language: string; content: string }[] = [ { - language: 'python', + language: 'go', content: - '# Finch Python API library\n\n\n[![PyPI version](https://img.shields.io/pypi/v/finch-api.svg?label=pypi%20(stable))](https://pypi.org/project/finch-api/)\n\nThe Finch Python library provides convenient access to the Finch REST API from any Python 3.9+\napplication. The library includes type definitions for all request params and response fields,\nand offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).\n\n\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Documentation\n\nThe REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/). The full API of this library can be found in [api.md](api.md).\n\n## Installation\n\n```sh\n# install from PyPI\npip install finch-api\n```\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n```python\nfrom finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\n\npage = client.hris.directory.list()\nprint(page.individuals)\n```\n\n\n\n## Async usage\n\nSimply import `AsyncFinch` instead of `Finch` and use `await` with each API call:\n\n```python\nimport asyncio\nfrom finch import AsyncFinch\n\nclient = AsyncFinch(\n access_token="My Access Token",\n)\n\nasync def main() -> None:\n page = await client.hris.directory.list()\n print(page.individuals)\n\nasyncio.run(main())\n```\n\nFunctionality between the synchronous and asynchronous clients is otherwise identical.\n\n### With aiohttp\n\nBy default, the async client uses `httpx` for HTTP requests. However, for improved concurrency performance you may also use `aiohttp` as the HTTP backend.\n\nYou can enable this by installing `aiohttp`:\n\n```sh\n# install from PyPI\npip install finch-api[aiohttp]\n```\n\nThen you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:\n\n```python\nimport asyncio\nfrom finch import DefaultAioHttpClient\nfrom finch import AsyncFinch\n\nasync def main() -> None:\n async with AsyncFinch(\n access_token="My Access Token",\n http_client=DefaultAioHttpClient(),\n) as client:\n page = await client.hris.directory.list()\n print(page.individuals)\n\nasyncio.run(main())\n```\n\n\n\n## Using types\n\nNested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:\n\n- Serializing back into JSON, `model.to_json()`\n- Converting to a dictionary, `model.to_dict()`\n\nTyped requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.\n\n## Pagination\n\nList methods in the Finch API are paginated.\n\nThis library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:\n\n```python\nfrom finch import Finch\n\nclient = Finch()\n\nall_directories = []\n# Automatically fetches more pages as needed.\nfor directory in client.hris.directory.list():\n # Do something with directory here\n all_directories.append(directory)\nprint(all_directories)\n```\n\nOr, asynchronously:\n\n```python\nimport asyncio\nfrom finch import AsyncFinch\n\nclient = AsyncFinch()\n\nasync def main() -> None:\n all_directories = []\n # Iterate through items across all pages, issuing requests as needed.\n async for directory in client.hris.directory.list():\n all_directories.append(directory)\n print(all_directories)\n\nasyncio.run(main())\n```\n\nAlternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:\n\n```python\nfirst_page = await client.hris.directory.list()\nif first_page.has_next_page():\n print(f"will fetch next page using these details: {first_page.next_page_info()}")\n next_page = await first_page.get_next_page()\n print(f"number of items we just fetched: {len(next_page.individuals)}")\n\n# Remove `await` for non-async usage.\n```\n\nOr just work directly with the returned data:\n\n```python\nfirst_page = await client.hris.directory.list()\n\nprint(f"the current start offset for this page: {first_page.paging.offset}") # => "the current start offset for this page: 1"\nfor directory in first_page.individuals:\n print(directory.id)\n\n# Remove `await` for non-async usage.\n```\n\n\n\n\n\n## Handling errors\n\nWhen the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `finch.APIConnectionError` is raised.\n\nWhen the API returns a non-success status code (that is, 4xx or 5xx\nresponse), a subclass of `finch.APIStatusError` is raised, containing `status_code` and `response` properties.\n\nAll errors inherit from `finch.APIError`.\n\n```python\nimport finch\nfrom finch import Finch\n\nclient = Finch()\n\ntry:\n client.hris.company.retrieve()\nexcept finch.APIConnectionError as e:\n print("The server could not be reached")\n print(e.__cause__) # an underlying Exception, likely raised within httpx.\nexcept finch.RateLimitError as e:\n print("A 429 status code was received; we should back off a bit.")\nexcept finch.APIStatusError as e:\n print("Another non-200-range status code was received")\n print(e.status_code)\n print(e.response)\n```\n\nError codes are as follows:\n\n| Status Code | Error Type |\n| ----------- | -------------------------- |\n| 400 | `BadRequestError` |\n| 401 | `AuthenticationError` |\n| 403 | `PermissionDeniedError` |\n| 404 | `NotFoundError` |\n| 422 | `UnprocessableEntityError` |\n| 429 | `RateLimitError` |\n| >=500 | `InternalServerError` |\n| N/A | `APIConnectionError` |\n\n### Retries\n\nCertain errors are automatically retried 2 times by default, with a short exponential backoff.\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,\n429 Rate Limit, and >=500 Internal errors are all retried by default.\n\nYou can use the `max_retries` option to configure or disable retry settings:\n\n```python\nfrom finch import Finch\n\n# Configure the default for all requests:\nclient = Finch(\n # default is 2\n max_retries=0,\n)\n\n# Or, configure per-request:\nclient.with_options(max_retries = 5).hris.directory.list()\n```\n\n### Timeouts\n\nBy default requests time out after 1 minute. You can configure this with a `timeout` option,\nwhich accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object:\n\n```python\nfrom finch import Finch\n\n# Configure the default for all requests:\nclient = Finch(\n # 20 seconds (default is 1 minute)\n timeout=20.0,\n)\n\n# More granular control:\nclient = Finch(\n timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),\n)\n\n# Override per-request:\nclient.with_options(timeout = 5.0).hris.directory.list()\n```\n\nOn timeout, an `APITimeoutError` is thrown.\n\nNote that requests that time out are [retried twice by default](#retries).\n\n## Default Headers\n\nWe automatically send the `Finch-API-Version` header set to `2020-09-17`.\n\nIf you need to, you can override it by setting default headers per-request or on the client object.\n\nBe aware that doing so may result in incorrect types and other unexpected or undefined behavior in the SDK.\n\n```python\nfrom finch import Finch\n\nclient = Finch(\n default_headers={\n "Finch-API-Version": "My-Custom-Value"\n },\n)\n```\n\n## Advanced\n\n### Logging\n\nWe use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.\n\nYou can enable logging by setting the environment variable `FINCH_LOG` to `info`.\n\n```shell\n$ export FINCH_LOG=info\n```\n\nOr to `debug` for more verbose logging.\n\n### How to tell whether `None` means `null` or missing\n\nIn an API response, a field may be explicitly `null`, or missing entirely; in either case, its value is `None` in this library. You can differentiate the two cases with `.model_fields_set`:\n\n```py\nif response.my_field is None:\n if \'my_field\' not in response.model_fields_set:\n print(\'Got json like {}, without a "my_field" key present at all.\')\n else:\n print(\'Got json like {"my_field": null}.\')\n```\n\n### Accessing raw response data (e.g. headers)\n\nThe "raw" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,\n\n```py\nfrom finch import Finch\n\nclient = Finch()\nresponse = client.hris.directory.with_raw_response.list()\nprint(response.headers.get(\'X-My-Header\'))\n\ndirectory = response.parse() # get the object that `hris.directory.list()` would have returned\nprint(directory.id)\n```\n\nThese methods return a [`LegacyAPIResponse`](https://github.com/Finch-API/finch-api-python/tree/main/src/finch/_legacy_response.py) object. This is a legacy class as we\'re changing it slightly in the next major version.\n\nFor the sync client this will mostly be the same with the exception\nof `content` & `text` will be methods instead of properties. In the\nasync client, all methods will be async.\n\nA migration script will be provided & the migration in general should\nbe smooth.\n\n#### `.with_streaming_response`\n\nThe above interface eagerly reads the full response body when you make the request, which may not always be what you want.\n\nTo stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.\n\nAs such, `.with_streaming_response` methods return a different [`APIResponse`](https://github.com/Finch-API/finch-api-python/tree/main/src/finch/_response.py) object, and the async client returns an [`AsyncAPIResponse`](https://github.com/Finch-API/finch-api-python/tree/main/src/finch/_response.py) object.\n\n```python\nwith client.hris.directory.with_streaming_response.list() as response :\n print(response.headers.get(\'X-My-Header\'))\n\n for line in response.iter_lines():\n print(line)\n```\n\nThe context manager is required so that the response will reliably be closed.\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API.\n\nIf you need to access undocumented endpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can make requests using `client.get`, `client.post`, and other\nhttp verbs. Options on the client will be respected (such as retries) when making this request.\n\n```py\nimport httpx\n\nresponse = client.post(\n "/foo",\n cast_to=httpx.Response,\n body={"my_param": True},\n)\n\nprint(response.headers.get("x-foo"))\n```\n\n#### Undocumented request params\n\nIf you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request\noptions.\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You\ncan also get all the extra fields on the Pydantic model as a dict with\n[`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra).\n\n### Configuring the HTTP client\n\nYou can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including:\n\n- Support for [proxies](https://www.python-httpx.org/advanced/proxies/)\n- Custom [transports](https://www.python-httpx.org/advanced/transports/)\n- Additional [advanced](https://www.python-httpx.org/advanced/clients/) functionality\n\n```python\nimport httpx\nfrom finch import Finch, DefaultHttpxClient\n\nclient = Finch(\n # Or use the `FINCH_BASE_URL` env var\n base_url="http://my.test.server.example.com:8083",\n http_client=DefaultHttpxClient(proxy="http://my.test.proxy.example.com", transport=httpx.HTTPTransport(local_address="0.0.0.0")),\n)\n```\n\nYou can also customize the client on a per-request basis by using `with_options()`:\n\n```python\nclient.with_options(http_client=DefaultHttpxClient(...))\n```\n\n### Managing HTTP resources\n\nBy default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.\n\n```py\nfrom finch import Finch\n\nwith Finch() as client:\n # make requests here\n ...\n\n# HTTP client is now closed\n```\n\n## Versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes that only affect static types, without breaking runtime behavior.\n2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n3. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Finch-API/finch-api-python/issues) with questions, bugs, or suggestions.\n\n### Determining the installed version\n\nIf you\'ve upgraded to the latest version but aren\'t seeing any new features you were expecting then your python environment is likely still using an older version.\n\nYou can determine the version that is being used at runtime with:\n\n```py\nimport finch\nprint(finch.__version__)\n```\n\n## Requirements\n\nPython 3.9 or higher.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n', + '# Finch Go API Library\n\nGo Reference\n\nThe Finch Go library provides convenient access to the [Finch REST API](https://developer.tryfinch.com/)\nfrom applications written in Go.\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Installation\n\n\n\n```go\nimport (\n\t"github.com/Finch-API/finch-api-go" // imported as SDK_PackageName\n)\n```\n\n\n\nOr to pin the version:\n\n\n\n```sh\ngo get -u \'github.com/Finch-API/finch-api-go@v0.0.1\'\n```\n\n\n\n## Requirements\n\nThis library requires Go 1.22+.\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n```go\npackage main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Directory.List(context.TODO(), finchgo.HRISDirectoryListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n\n```\n\n### Request fields\n\nAll request parameters are wrapped in a generic `Field` type,\nwhich we use to distinguish zero values from null or omitted fields.\n\nThis prevents accidentally sending a zero value if you forget a required parameter,\nand enables explicitly sending `null`, `false`, `\'\'`, or `0` on optional parameters.\nAny field not specified is not sent.\n\nTo construct fields with values, use the helpers `String()`, `Int()`, `Float()`, or most commonly, the generic `F[T]()`.\nTo send a null, use `Null[T]()`, and to send a nonconforming value, use `Raw[T](any)`. For example:\n\n```go\nparams := FooParams{\n\tName: SDK_PackageName.F("hello"),\n\n\t// Explicitly send `"description": null`\n\tDescription: SDK_PackageName.Null[string](),\n\n\tPoint: SDK_PackageName.F(SDK_PackageName.Point{\n\t\tX: SDK_PackageName.Int(0),\n\t\tY: SDK_PackageName.Int(1),\n\n\t\t// In cases where the API specifies a given type,\n\t\t// but you want to send something else, use `Raw`:\n\t\tZ: SDK_PackageName.Raw[int64](0.01), // sends a float\n\t}),\n}\n```\n\n### Response objects\n\nAll fields in response structs are value types (not pointers or wrappers).\n\nIf a given field is `null`, not present, or invalid, the corresponding field\nwill simply be its zero value.\n\nAll response structs also include a special `JSON` field, containing more detailed\ninformation about each property, which you can use like so:\n\n```go\nif res.Name == "" {\n\t// true if `"name"` is either not present or explicitly null\n\tres.JSON.Name.IsNull()\n\n\t// true if the `"name"` key was not present in the response JSON at all\n\tres.JSON.Name.IsMissing()\n\n\t// When the API returns data that cannot be coerced to the expected type:\n\tif res.JSON.Name.IsInvalid() {\n\t\traw := res.JSON.Name.Raw()\n\n\t\tlegacyName := struct{\n\t\t\tFirst string `json:"first"`\n\t\t\tLast string `json:"last"`\n\t\t}{}\n\t\tjson.Unmarshal([]byte(raw), &legacyName)\n\t\tname = legacyName.First + " " + legacyName.Last\n\t}\n}\n```\n\nThese `.JSON` structs also include an `Extras` map containing\nany properties in the json response that were not specified\nin the struct. This can be useful for API features not yet\npresent in the SDK.\n\n```go\nbody := res.JSON.ExtraFields["my_unexpected_field"].Raw()\n```\n\n### RequestOptions\n\nThis library uses the functional options pattern. Functions defined in the\n`SDK_PackageOptionName` package return a `RequestOption`, which is a closure that mutates a\n`RequestConfig`. These options can be supplied to the client or at individual\nrequests. For example:\n\n```go\nclient := SDK_PackageName.SDK_ClientInitializerName(\n\t// Adds a header to every request made by the client\n\tSDK_PackageOptionName.WithHeader("X-Some-Header", "custom_header_info"),\n)\n\nclient.HRIS.Directory.List(context.TODO(), ...,\n\t// Override the header\n\tSDK_PackageOptionName.WithHeader("X-Some-Header", "some_other_custom_header_info"),\n\t// Add an undocumented field to the request body, using sjson syntax\n\tSDK_PackageOptionName.WithJSONSet("some.json.path", map[string]string{"my": "object"}),\n)\n```\n\nSee the [full list of request options](https://pkg.go.dev/github.com/Finch-API/finch-api-go/SDK_PackageOptionName).\n\n### Pagination\n\nThis library provides some conveniences for working with paginated list endpoints.\n\nYou can use `.ListAutoPaging()` methods to iterate through items across all pages:\n\n```go\niter := client.HRIS.Directory.ListAutoPaging(context.TODO(), finchgo.HRISDirectoryListParams{})\n// Automatically fetches more pages as needed.\nfor iter.Next() {\n\tindividualInDirectory := iter.Current()\n\tfmt.Printf("%+v\\n", individualInDirectory)\n}\nif err := iter.Err(); err != nil {\n\tpanic(err.Error())\n}\n```\n\nOr you can use simple `.List()` methods to fetch a single page and receive a standard response object\nwith additional helper methods like `.GetNextPage()`, e.g.:\n\n```go\npage, err := client.HRIS.Directory.List(context.TODO(), finchgo.HRISDirectoryListParams{})\nfor page != nil {\n\tfor _, directory := range page.Individuals {\n\t\tfmt.Printf("%+v\\n", directory)\n\t}\n\tpage, err = page.GetNextPage()\n}\nif err != nil {\n\tpanic(err.Error())\n}\n```\n\n### Errors\n\nWhen the API returns a non-success status code, we return an error with type\n`*SDK_PackageName.Error`. This contains the `StatusCode`, `*http.Request`, and\n`*http.Response` values of the request, as well as the JSON of the error body\n(much like other response objects in the SDK).\n\nTo handle errors, we recommend that you use the `errors.As` pattern:\n\n```go\n_, err := client.HRIS.Company.Get(context.TODO(), finchgo.HRISCompanyGetParams{})\nif err != nil {\n\tvar apierr *finchgo.Error\n\tif errors.As(err, &apierr) {\n\t\tprintln(string(apierr.DumpRequest(true))) // Prints the serialized HTTP request\n\t\tprintln(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response\n\t}\n\tpanic(err.Error()) // GET "/employer/company": 400 Bad Request { ... }\n}\n```\n\nWhen other errors occur, they are returned unwrapped; for example,\nif HTTP transport fails, you might receive `*url.Error` wrapping `*net.OpError`.\n\n### Timeouts\n\nRequests do not time out by default; use context to configure a timeout for a request lifecycle.\n\nNote that if a request is [retried](#retries), the context timeout does not start over.\nTo set a per-retry timeout, use `SDK_PackageOptionName.WithRequestTimeout()`.\n\n```go\n// This sets the timeout for the request, including all the retries.\nctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)\ndefer cancel()\nclient.HRIS.Directory.List(\n\tctx,\n\tfinchgo.HRISDirectoryListParams{},\n\t// This sets the per-retry timeout\n\toption.WithRequestTimeout(20*time.Second),\n)\n```\n\n### File uploads\n\nRequest parameters that correspond to file uploads in multipart requests are typed as\n`param.Field[io.Reader]`. The contents of the `io.Reader` will by default be sent as a multipart form\npart with the file name of "anonymous_file" and content-type of "application/octet-stream".\n\nThe file name and content-type can be customized by implementing `Name() string` or `ContentType()\nstring` on the run-time type of `io.Reader`. Note that `os.File` implements `Name() string`, so a\nfile returned by `os.Open` will be sent with the file name on disk.\n\nWe also provide a helper `SDK_PackageName.FileParam(reader io.Reader, filename string, contentType string)`\nwhich can be used to wrap any `io.Reader` with the appropriate file name and content type.\n\n\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\nWe retry by default all connection errors, 408 Request Timeout, 409 Conflict, 429 Rate Limit,\nand >=500 Internal errors.\n\nYou can use the `WithMaxRetries` option to configure or disable this:\n\n```go\n// Configure the default for all requests:\nclient := finchgo.NewClient(\n\toption.WithMaxRetries(0), // default is 2\n)\n\n// Override per-request:\nclient.HRIS.Directory.List(\n\tcontext.TODO(),\n\tfinchgo.HRISDirectoryListParams{},\n\toption.WithMaxRetries(5),\n)\n```\n\n\n### Accessing raw response data (e.g. response headers)\n\nYou can access the raw HTTP response data by using the `option.WithResponseInto()` request option. This is useful when\nyou need to examine response headers, status codes, or other details.\n\n```go\n// Create a variable to store the HTTP response\nvar response *http.Response\npage, err := client.HRIS.Directory.List(\n\tcontext.TODO(),\n\tfinchgo.HRISDirectoryListParams{},\n\toption.WithResponseInto(&response),\n)\nif err != nil {\n\t// handle error\n}\nfmt.Printf("%+v\\n", page)\n\nfmt.Printf("Status Code: %d\\n", response.StatusCode)\nfmt.Printf("Headers: %+#v\\n", response.Header)\n```\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API. If you need to access undocumented\nendpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can use `client.Get`, `client.Post`, and other HTTP verbs.\n`RequestOptions` on the client, such as retries, will be respected when making these requests.\n\n```go\nvar (\n // params can be an io.Reader, a []byte, an encoding/json serializable object,\n // or a "…Params" struct defined in this library.\n params map[string]interface{}\n\n // result can be an []byte, *http.Response, a encoding/json deserializable object,\n // or a model defined in this library.\n result *http.Response\n)\nerr := client.Post(context.Background(), "/unspecified", params, &result)\nif err != nil {\n …\n}\n```\n\n#### Undocumented request params\n\nTo make requests using undocumented parameters, you may use either the `SDK_PackageOptionName.WithQuerySet()`\nor the `SDK_PackageOptionName.WithJSONSet()` methods.\n\n```go\nparams := FooNewParams{\n ID: SDK_PackageName.F("id_xxxx"),\n Data: SDK_PackageName.F(FooNewParamsData{\n FirstName: SDK_PackageName.F("John"),\n }),\n}\nclient.Foo.New(context.Background(), params, SDK_PackageOptionName.WithJSONSet("data.last_name", "Doe"))\n```\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you may either access the raw JSON of the response as a string\nwith `result.JSON.RawJSON()`, or get the raw JSON of a particular field on the result with\n`result.JSON.Foo.Raw()`.\n\nAny fields that are not present on the response struct will be saved and can be accessed by `result.JSON.ExtraFields()` which returns the extra fields as a `map[string]Field`.\n\n### Middleware\n\nWe provide `SDK_PackageOptionName.WithMiddleware` which applies the given\nmiddleware to requests.\n\n```go\nfunc Logger(req *http.Request, next SDK_PackageOptionName.MiddlewareNext) (res *http.Response, err error) {\n\t// Before the request\n\tstart := time.Now()\n\tLogReq(req)\n\n\t// Forward the request to the next handler\n\tres, err = next(req)\n\n\t// Handle stuff after the request\n\tend := time.Now()\n\tLogRes(res, err, start - end)\n\n return res, err\n}\n\nclient := SDK_PackageName.SDK_ClientInitializerName(\n\tSDK_PackageOptionName.WithMiddleware(Logger),\n)\n```\n\nWhen multiple middlewares are provided as variadic arguments, the middlewares\nare applied left to right. If `SDK_PackageOptionName.WithMiddleware` is given\nmultiple times, for example first in the client then the method, the\nmiddleware in the client will run first and the middleware given in the method\nwill run next.\n\nYou may also replace the default `http.Client` with\n`SDK_PackageOptionName.WithHTTPClient(client)`. Only one http client is\naccepted (this overwrites any previous client) and receives requests after any\nmiddleware has been applied.\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n2. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Finch-API/finch-api-go/issues) with questions, bugs, or suggestions.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n', }, { - language: 'go', + language: 'java', content: - '# Finch Go API Library\n\nGo Reference\n\nThe Finch Go library provides convenient access to the [Finch REST API](https://developer.tryfinch.com/)\nfrom applications written in Go.\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Installation\n\n\n\n```go\nimport (\n\t"github.com/Finch-API/finch-api-go" // imported as SDK_PackageName\n)\n```\n\n\n\nOr to pin the version:\n\n\n\n```sh\ngo get -u \'github.com/Finch-API/finch-api-go@v0.0.1\'\n```\n\n\n\n## Requirements\n\nThis library requires Go 1.22+.\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n```go\npackage main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Directory.List(context.TODO(), finchgo.HRISDirectoryListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n\n```\n\n### Request fields\n\nAll request parameters are wrapped in a generic `Field` type,\nwhich we use to distinguish zero values from null or omitted fields.\n\nThis prevents accidentally sending a zero value if you forget a required parameter,\nand enables explicitly sending `null`, `false`, `\'\'`, or `0` on optional parameters.\nAny field not specified is not sent.\n\nTo construct fields with values, use the helpers `String()`, `Int()`, `Float()`, or most commonly, the generic `F[T]()`.\nTo send a null, use `Null[T]()`, and to send a nonconforming value, use `Raw[T](any)`. For example:\n\n```go\nparams := FooParams{\n\tName: SDK_PackageName.F("hello"),\n\n\t// Explicitly send `"description": null`\n\tDescription: SDK_PackageName.Null[string](),\n\n\tPoint: SDK_PackageName.F(SDK_PackageName.Point{\n\t\tX: SDK_PackageName.Int(0),\n\t\tY: SDK_PackageName.Int(1),\n\n\t\t// In cases where the API specifies a given type,\n\t\t// but you want to send something else, use `Raw`:\n\t\tZ: SDK_PackageName.Raw[int64](0.01), // sends a float\n\t}),\n}\n```\n\n### Response objects\n\nAll fields in response structs are value types (not pointers or wrappers).\n\nIf a given field is `null`, not present, or invalid, the corresponding field\nwill simply be its zero value.\n\nAll response structs also include a special `JSON` field, containing more detailed\ninformation about each property, which you can use like so:\n\n```go\nif res.Name == "" {\n\t// true if `"name"` is either not present or explicitly null\n\tres.JSON.Name.IsNull()\n\n\t// true if the `"name"` key was not present in the response JSON at all\n\tres.JSON.Name.IsMissing()\n\n\t// When the API returns data that cannot be coerced to the expected type:\n\tif res.JSON.Name.IsInvalid() {\n\t\traw := res.JSON.Name.Raw()\n\n\t\tlegacyName := struct{\n\t\t\tFirst string `json:"first"`\n\t\t\tLast string `json:"last"`\n\t\t}{}\n\t\tjson.Unmarshal([]byte(raw), &legacyName)\n\t\tname = legacyName.First + " " + legacyName.Last\n\t}\n}\n```\n\nThese `.JSON` structs also include an `Extras` map containing\nany properties in the json response that were not specified\nin the struct. This can be useful for API features not yet\npresent in the SDK.\n\n```go\nbody := res.JSON.ExtraFields["my_unexpected_field"].Raw()\n```\n\n### RequestOptions\n\nThis library uses the functional options pattern. Functions defined in the\n`SDK_PackageOptionName` package return a `RequestOption`, which is a closure that mutates a\n`RequestConfig`. These options can be supplied to the client or at individual\nrequests. For example:\n\n```go\nclient := SDK_PackageName.SDK_ClientInitializerName(\n\t// Adds a header to every request made by the client\n\tSDK_PackageOptionName.WithHeader("X-Some-Header", "custom_header_info"),\n)\n\nclient.HRIS.Directory.List(context.TODO(), ...,\n\t// Override the header\n\tSDK_PackageOptionName.WithHeader("X-Some-Header", "some_other_custom_header_info"),\n\t// Add an undocumented field to the request body, using sjson syntax\n\tSDK_PackageOptionName.WithJSONSet("some.json.path", map[string]string{"my": "object"}),\n)\n```\n\nSee the [full list of request options](https://pkg.go.dev/github.com/Finch-API/finch-api-go/SDK_PackageOptionName).\n\n### Pagination\n\nThis library provides some conveniences for working with paginated list endpoints.\n\nYou can use `.ListAutoPaging()` methods to iterate through items across all pages:\n\n```go\niter := client.HRIS.Directory.ListAutoPaging(context.TODO(), finchgo.HRISDirectoryListParams{})\n// Automatically fetches more pages as needed.\nfor iter.Next() {\n\tindividualInDirectory := iter.Current()\n\tfmt.Printf("%+v\\n", individualInDirectory)\n}\nif err := iter.Err(); err != nil {\n\tpanic(err.Error())\n}\n```\n\nOr you can use simple `.List()` methods to fetch a single page and receive a standard response object\nwith additional helper methods like `.GetNextPage()`, e.g.:\n\n```go\npage, err := client.HRIS.Directory.List(context.TODO(), finchgo.HRISDirectoryListParams{})\nfor page != nil {\n\tfor _, directory := range page.Individuals {\n\t\tfmt.Printf("%+v\\n", directory)\n\t}\n\tpage, err = page.GetNextPage()\n}\nif err != nil {\n\tpanic(err.Error())\n}\n```\n\n### Errors\n\nWhen the API returns a non-success status code, we return an error with type\n`*SDK_PackageName.Error`. This contains the `StatusCode`, `*http.Request`, and\n`*http.Response` values of the request, as well as the JSON of the error body\n(much like other response objects in the SDK).\n\nTo handle errors, we recommend that you use the `errors.As` pattern:\n\n```go\n_, err := client.HRIS.Company.Get(context.TODO(), finchgo.HRISCompanyGetParams{})\nif err != nil {\n\tvar apierr *finchgo.Error\n\tif errors.As(err, &apierr) {\n\t\tprintln(string(apierr.DumpRequest(true))) // Prints the serialized HTTP request\n\t\tprintln(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response\n\t}\n\tpanic(err.Error()) // GET "/employer/company": 400 Bad Request { ... }\n}\n```\n\nWhen other errors occur, they are returned unwrapped; for example,\nif HTTP transport fails, you might receive `*url.Error` wrapping `*net.OpError`.\n\n### Timeouts\n\nRequests do not time out by default; use context to configure a timeout for a request lifecycle.\n\nNote that if a request is [retried](#retries), the context timeout does not start over.\nTo set a per-retry timeout, use `SDK_PackageOptionName.WithRequestTimeout()`.\n\n```go\n// This sets the timeout for the request, including all the retries.\nctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)\ndefer cancel()\nclient.HRIS.Directory.List(\n\tctx,\n\tfinchgo.HRISDirectoryListParams{},\n\t// This sets the per-retry timeout\n\toption.WithRequestTimeout(20*time.Second),\n)\n```\n\n### File uploads\n\nRequest parameters that correspond to file uploads in multipart requests are typed as\n`param.Field[io.Reader]`. The contents of the `io.Reader` will by default be sent as a multipart form\npart with the file name of "anonymous_file" and content-type of "application/octet-stream".\n\nThe file name and content-type can be customized by implementing `Name() string` or `ContentType()\nstring` on the run-time type of `io.Reader`. Note that `os.File` implements `Name() string`, so a\nfile returned by `os.Open` will be sent with the file name on disk.\n\nWe also provide a helper `SDK_PackageName.FileParam(reader io.Reader, filename string, contentType string)`\nwhich can be used to wrap any `io.Reader` with the appropriate file name and content type.\n\n\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\nWe retry by default all connection errors, 408 Request Timeout, 409 Conflict, 429 Rate Limit,\nand >=500 Internal errors.\n\nYou can use the `WithMaxRetries` option to configure or disable this:\n\n```go\n// Configure the default for all requests:\nclient := finchgo.NewClient(\n\toption.WithMaxRetries(0), // default is 2\n)\n\n// Override per-request:\nclient.HRIS.Directory.List(\n\tcontext.TODO(),\n\tfinchgo.HRISDirectoryListParams{},\n\toption.WithMaxRetries(5),\n)\n```\n\n\n### Accessing raw response data (e.g. response headers)\n\nYou can access the raw HTTP response data by using the `option.WithResponseInto()` request option. This is useful when\nyou need to examine response headers, status codes, or other details.\n\n```go\n// Create a variable to store the HTTP response\nvar response *http.Response\npage, err := client.HRIS.Directory.List(\n\tcontext.TODO(),\n\tfinchgo.HRISDirectoryListParams{},\n\toption.WithResponseInto(&response),\n)\nif err != nil {\n\t// handle error\n}\nfmt.Printf("%+v\\n", page)\n\nfmt.Printf("Status Code: %d\\n", response.StatusCode)\nfmt.Printf("Headers: %+#v\\n", response.Header)\n```\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API. If you need to access undocumented\nendpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can use `client.Get`, `client.Post`, and other HTTP verbs.\n`RequestOptions` on the client, such as retries, will be respected when making these requests.\n\n```go\nvar (\n // params can be an io.Reader, a []byte, an encoding/json serializable object,\n // or a "…Params" struct defined in this library.\n params map[string]interface{}\n\n // result can be an []byte, *http.Response, a encoding/json deserializable object,\n // or a model defined in this library.\n result *http.Response\n)\nerr := client.Post(context.Background(), "/unspecified", params, &result)\nif err != nil {\n …\n}\n```\n\n#### Undocumented request params\n\nTo make requests using undocumented parameters, you may use either the `SDK_PackageOptionName.WithQuerySet()`\nor the `SDK_PackageOptionName.WithJSONSet()` methods.\n\n```go\nparams := FooNewParams{\n ID: SDK_PackageName.F("id_xxxx"),\n Data: SDK_PackageName.F(FooNewParamsData{\n FirstName: SDK_PackageName.F("John"),\n }),\n}\nclient.Foo.New(context.Background(), params, SDK_PackageOptionName.WithJSONSet("data.last_name", "Doe"))\n```\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you may either access the raw JSON of the response as a string\nwith `result.JSON.RawJSON()`, or get the raw JSON of a particular field on the result with\n`result.JSON.Foo.Raw()`.\n\nAny fields that are not present on the response struct will be saved and can be accessed by `result.JSON.ExtraFields()` which returns the extra fields as a `map[string]Field`.\n\n### Middleware\n\nWe provide `SDK_PackageOptionName.WithMiddleware` which applies the given\nmiddleware to requests.\n\n```go\nfunc Logger(req *http.Request, next SDK_PackageOptionName.MiddlewareNext) (res *http.Response, err error) {\n\t// Before the request\n\tstart := time.Now()\n\tLogReq(req)\n\n\t// Forward the request to the next handler\n\tres, err = next(req)\n\n\t// Handle stuff after the request\n\tend := time.Now()\n\tLogRes(res, err, start - end)\n\n return res, err\n}\n\nclient := SDK_PackageName.SDK_ClientInitializerName(\n\tSDK_PackageOptionName.WithMiddleware(Logger),\n)\n```\n\nWhen multiple middlewares are provided as variadic arguments, the middlewares\nare applied left to right. If `SDK_PackageOptionName.WithMiddleware` is given\nmultiple times, for example first in the client then the method, the\nmiddleware in the client will run first and the middleware given in the method\nwill run next.\n\nYou may also replace the default `http.Client` with\n`SDK_PackageOptionName.WithHTTPClient(client)`. Only one http client is\naccepted (this overwrites any previous client) and receives requests after any\nmiddleware has been applied.\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n2. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Finch-API/finch-api-go/issues) with questions, bugs, or suggestions.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n', + '# Finch Java API Library\n\n\n[![Maven Central](https://img.shields.io/maven-central/v/com.tryfinch.api/finch-java)](https://central.sonatype.com/artifact/com.tryfinch.api/finch-java/0.0.1)\n[![javadoc](https://javadoc.io/badge2/com.tryfinch.api/finch-java/0.0.1/javadoc.svg)](https://javadoc.io/doc/com.tryfinch.api/finch-java/0.0.1)\n\n\nThe Finch Java SDK provides convenient access to the [Finch REST API](https://developer.tryfinch.com/) from applications written in Java.\n\nThe Finch Java SDK is similar to the Finch Kotlin SDK but with minor differences that make it more ergonomic for use in Java, such as `Optional` instead of nullable values, `Stream` instead of `Sequence`, and `CompletableFuture` instead of suspend functions.\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n\n\nThe REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/). Javadocs are available on [javadoc.io](https://javadoc.io/doc/com.tryfinch.api/finch-java/0.0.1).\n\n\n\n## Installation\n\n\n\n### Gradle\n\n~~~kotlin\nimplementation("com.tryfinch.api:finch-java:0.0.1")\n~~~\n\n### Maven\n\n~~~xml\n\n com.tryfinch.api\n finch-java\n 0.0.1\n\n~~~\n\n\n\n## Requirements\n\nThis library requires Java 8 or later.\n\n## Usage\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisDirectoryListPage;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\nFinchClient client = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\nHrisDirectoryListPage page = client.hris().directory().list();\n```\n\n## Client configuration\n\nConfigure the client using system properties or environment variables:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n```\n\nOr manually:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n .accessToken("My Access Token")\n .build();\n```\n\nOr using a combination of the two approaches:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n```\n\nSee this table for the available options:\n\n| Setter | System property | Environment variable | Required | Default value |\n| --------------- | --------------------- | ---------------------- | -------- | ---------------------------- |\n| `clientId` | `finch.clientId` | `FINCH_CLIENT_ID` | false | - |\n| `clientSecret` | `finch.clientSecret` | `FINCH_CLIENT_SECRET` | false | - |\n| `webhookSecret` | `finch.webhookSecret` | `FINCH_WEBHOOK_SECRET` | false | - |\n| `baseUrl` | `finch.baseUrl` | `FINCH_BASE_URL` | true | `"https://api.tryfinch.com"` |\n\nSystem properties take precedence over environment variables.\n\n> [!TIP]\n> Don\'t create more than one client in the same application. Each client has a connection pool and\n> thread pools, which are more efficient to share between requests.\n\n### Modifying configuration\n\nTo temporarily use a modified client configuration, while reusing the same connection and thread pools, call `withOptions()` on any client or service:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\n\nFinchClient clientWithOptions = client.withOptions(optionsBuilder -> {\n optionsBuilder.baseUrl("https://example.com");\n optionsBuilder.maxRetries(42);\n});\n```\n\nThe `withOptions()` method does not affect the original client or service.\n\n## Requests and responses\n\nTo send a request to the Finch API, build an instance of some `Params` class and pass it to the corresponding client method. When the response is received, it will be deserialized into an instance of a Java class.\n\nFor example, `client.hris().directory().list(...)` should be called with an instance of `HrisDirectoryListParams`, and it will return an instance of `HrisDirectoryListPage`.\n\n## Immutability\n\nEach class in the SDK has an associated [builder](https://blogs.oracle.com/javamagazine/post/exploring-joshua-blochs-builder-design-pattern-in-java) or factory method for constructing it.\n\nEach class is [immutable](https://docs.oracle.com/javase/tutorial/essential/concurrency/immutable.html) once constructed. If the class has an associated builder, then it has a `toBuilder()` method, which can be used to convert it back to a builder for making a modified copy.\n\nBecause each class is immutable, builder modification will _never_ affect already built class instances.\n\n## Asynchronous execution\n\nThe default client is synchronous. To switch to asynchronous execution, call the `async()` method:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\nimport java.util.concurrent.CompletableFuture;\n\nFinchClient client = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\nCompletableFuture page = client.async().hris().directory().list();\n```\n\nOr create an asynchronous client from the beginning:\n\n```java\nimport com.tryfinch.api.client.FinchClientAsync;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClientAsync;\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\nimport java.util.concurrent.CompletableFuture;\n\nFinchClientAsync client = FinchOkHttpClientAsync.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\nCompletableFuture page = client.hris().directory().list();\n```\n\nThe asynchronous client supports the same options as the synchronous one, except most methods return `CompletableFuture`s.\n\n\n\n\n\n\n\n## Raw responses\n\nThe SDK defines methods that deserialize responses into instances of Java classes. However, these methods don\'t provide access to the response headers, status code, or the raw response body.\n\nTo access this data, prefix any HTTP method call on a client or service with `withRawResponse()`:\n\n```java\nimport com.tryfinch.api.core.http.Headers;\nimport com.tryfinch.api.core.http.HttpResponseFor;\nimport com.tryfinch.api.models.HrisDirectoryListPage;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\nHttpResponseFor page = client.hris().directory().withRawResponse().list();\n\nint statusCode = page.statusCode();\nHeaders headers = page.headers();\n```\n\nYou can still deserialize the response into an instance of a Java class if needed:\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListPage;\n\nHrisDirectoryListPage parsedPage = page.parse();\n```\n\n## Error handling\n\nThe SDK throws custom unchecked exception types:\n\n- [`FinchServiceException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchServiceException.kt): Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:\n\n | Status | Exception |\n | ------ | -------------------------------------------------- |\n | 400 | [`BadRequestException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/BadRequestException.kt) |\n | 401 | [`UnauthorizedException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/UnauthorizedException.kt) |\n | 403 | [`PermissionDeniedException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/PermissionDeniedException.kt) |\n | 404 | [`NotFoundException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/NotFoundException.kt) |\n | 422 | [`UnprocessableEntityException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/UnprocessableEntityException.kt) |\n | 429 | [`RateLimitException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/RateLimitException.kt) |\n | 5xx | [`InternalServerException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/InternalServerException.kt) |\n | others | [`UnexpectedStatusCodeException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/UnexpectedStatusCodeException.kt) |\n\n- [`FinchIoException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchIoException.kt): I/O networking errors.\n\n- [`FinchRetryableException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchRetryableException.kt): Generic error indicating a failure that could be retried by the client.\n\n- [`FinchInvalidDataException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchInvalidDataException.kt): Failure to interpret successfully parsed data. For example, when accessing a property that\'s supposed to be required, but the API unexpectedly omitted it from the response.\n\n- [`FinchException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchException.kt): Base class for all exceptions. Most errors will result in one of the previously mentioned ones, but completely generic errors may be thrown using the base class.\n\n## Pagination\n\nThe SDK defines methods that return a paginated lists of results. It provides convenient ways to access the results either one page at a time or item-by-item across all pages.\n\n### Auto-pagination\n\nTo iterate through all results across all pages, use the `autoPager()` method, which automatically fetches more pages as needed.\n\nWhen using the synchronous client, the method returns an [`Iterable`](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html)\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListPage;\nimport com.tryfinch.api.models.IndividualInDirectory;\n\nHrisDirectoryListPage page = client.hris().directory().list();\n\n// Process as an Iterable\nfor (IndividualInDirectory directory : page.autoPager()) {\n System.out.println(directory);\n}\n\n// Process as a Stream\npage.autoPager()\n .stream()\n .limit(50)\n .forEach(directory -> System.out.println(directory));\n```\n\nWhen using the asynchronous client, the method returns an [`AsyncStreamResponse`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/http/AsyncStreamResponse.kt):\n\n```java\nimport com.tryfinch.api.core.http.AsyncStreamResponse;\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync;\nimport com.tryfinch.api.models.IndividualInDirectory;\nimport java.util.Optional;\nimport java.util.concurrent.CompletableFuture;\n\nCompletableFuture pageFuture = client.async().hris().directory().list();\n\npageFuture.thenRun(page -> page.autoPager().subscribe(directory -> {\n System.out.println(directory);\n}));\n\n// If you need to handle errors or completion of the stream\npageFuture.thenRun(page -> page.autoPager().subscribe(new AsyncStreamResponse.Handler<>() {\n @Override\n public void onNext(IndividualInDirectory directory) {\n System.out.println(directory);\n }\n\n @Override\n public void onComplete(Optional error) {\n if (error.isPresent()) {\n System.out.println("Something went wrong!");\n throw new RuntimeException(error.get());\n } else {\n System.out.println("No more!");\n }\n }\n}));\n\n// Or use futures\npageFuture.thenRun(page -> page.autoPager()\n .subscribe(directory -> {\n System.out.println(directory);\n })\n .onCompleteFuture()\n .whenComplete((unused, error) -> {\n if (error != null) {\n System.out.println("Something went wrong!");\n throw new RuntimeException(error);\n } else {\n System.out.println("No more!");\n }\n }));\n```\n\n### Manual pagination\n\nTo access individual page items and manually request the next page, use the `items()`,\n`hasNextPage()`, and `nextPage()` methods:\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListPage;\nimport com.tryfinch.api.models.IndividualInDirectory;\n\nHrisDirectoryListPage page = client.hris().directory().list();\nwhile (true) {\n for (IndividualInDirectory directory : page.items()) {\n System.out.println(directory);\n }\n\n if (!page.hasNextPage()) {\n break;\n }\n\n page = page.nextPage();\n}\n```\n\n## Logging\n\nThe SDK uses the standard [OkHttp logging interceptor](https://github.com/square/okhttp/tree/master/okhttp-logging-interceptor).\n\nEnable logging by setting the `FINCH_LOG` environment variable to `info`:\n\n```sh\nexport FINCH_LOG=info\n```\n\nOr to `debug` for more verbose logging:\n\n```sh\nexport FINCH_LOG=debug\n```\n\n## ProGuard and R8\n\nAlthough the SDK uses reflection, it is still usable with [ProGuard](https://github.com/Guardsquare/proguard) and [R8](https://developer.android.com/topic/performance/app-optimization/enable-app-optimization) because `finch-java-core` is published with a [configuration file](finch-java-core/src/main/resources/META-INF/proguard/finch-java-core.pro) containing [keep rules](https://www.guardsquare.com/manual/configuration/usage).\n\nProGuard and R8 should automatically detect and use the published rules, but you can also manually copy the keep rules if necessary.\n\n\n\n\n\n## Jackson\n\nThe SDK depends on [Jackson](https://github.com/FasterXML/jackson) for JSON serialization/deserialization. It is compatible with version 2.13.4 or higher, but depends on version 2.18.2 by default.\n\nThe SDK throws an exception if it detects an incompatible Jackson version at runtime (e.g. if the default version was overridden in your Maven or Gradle config).\n\nIf the SDK threw an exception, but you\'re _certain_ the version is compatible, then disable the version check using the `checkJacksonVersionCompatibility` on [`FinchOkHttpClient`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt).\n\n> [!CAUTION]\n> We make no guarantee that the SDK works correctly when the Jackson version check is disabled.\n\nAlso note that there are bugs in older Jackson versions that can affect the SDK. We don\'t work around all Jackson bugs ([example](https://github.com/FasterXML/jackson-databind/issues/3240)) and expect users to upgrade Jackson for those instead.\n\n## Network options\n\n### Retries\n\nThe SDK automatically retries 2 times by default, with a short exponential backoff between requests.\n\nOnly the following error types are retried:\n- Connection errors (for example, due to a network connectivity problem)\n- 408 Request Timeout\n- 409 Conflict\n- 429 Rate Limit\n- 5xx Internal\n\nThe API may also explicitly instruct the SDK to retry or not retry a request.\n\nTo set a custom number of retries, configure the client using the `maxRetries` method:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .maxRetries(4)\n .accessToken("My Access Token")\n .build();\n```\n\n### Timeouts\n\nRequests time out after 1 minute by default.\n\nTo set a custom timeout, configure the method call using the `timeout` method:\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListPage;\n\nHrisDirectoryListPage page = client.hris().directory().list(RequestOptions.builder().timeout(Duration.ofSeconds(30)).build());\n```\n\nOr configure the default for all method calls at the client level:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport java.time.Duration;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .timeout(Duration.ofSeconds(30))\n .accessToken("My Access Token")\n .build();\n```\n\n### Proxies\n\nTo route requests through a proxy, configure the client using the `proxy` method:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport java.net.InetSocketAddress;\nimport java.net.Proxy;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .proxy(new Proxy(\n Proxy.Type.HTTP, new InetSocketAddress(\n "https://example.com", 8080\n )\n ))\n .accessToken("My Access Token")\n .build();\n```\n\n### Connection pooling\n\nTo customize the underlying OkHttp connection pool, configure the client using the `maxIdleConnections` and `keepAliveDuration` methods:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport java.time.Duration;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n // If `maxIdleConnections` is set, then `keepAliveDuration` must be set, and vice versa.\n .maxIdleConnections(10)\n .keepAliveDuration(Duration.ofMinutes(2))\n .accessToken("My Access Token")\n .build();\n```\n\nIf both options are unset, OkHttp\'s default connection pool settings are used.\n\n### HTTPS\n\n> [!NOTE]\n> Most applications should not call these methods, and instead use the system defaults. The defaults include\n> special optimizations that can be lost if the implementations are modified.\n\nTo configure how HTTPS connections are secured, configure the client using the `sslSocketFactory`, `trustManager`, and `hostnameVerifier` methods:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n // If `sslSocketFactory` is set, then `trustManager` must be set, and vice versa.\n .sslSocketFactory(yourSSLSocketFactory)\n .trustManager(yourTrustManager)\n .hostnameVerifier(yourHostnameVerifier)\n .accessToken("My Access Token")\n .build();\n```\n\n\n\n### Custom HTTP client\n\nThe SDK consists of three artifacts:\n- `finch-java-core`\n - Contains core SDK logic\n - Does not depend on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`FinchClient`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClient.kt), [`FinchClientAsync`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsync.kt), [`FinchClientImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt), and [`FinchClientAsyncImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), all of which can work with any HTTP client\n- `finch-java-client-okhttp`\n - Depends on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`FinchOkHttpClient`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) and [`FinchOkHttpClientAsync`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), which provide a way to construct [`FinchClientImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) and [`FinchClientAsyncImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), respectively, using OkHttp\n- `finch-java`\n - Depends on and exposes the APIs of both `finch-java-core` and `finch-java-client-okhttp`\n - Does not have its own logic\n\nThis structure allows replacing the SDK\'s default HTTP client without pulling in unnecessary dependencies.\n\n#### Customized [`OkHttpClient`](https://square.github.io/okhttp/3.x/okhttp/okhttp3/OkHttpClient.html)\n\n> [!TIP]\n> Try the available [network options](#network-options) before replacing the default client.\n\nTo use a customized `OkHttpClient`:\n\n1. Replace your [`finch-java` dependency](#installation) with `finch-java-core`\n2. Copy `finch-java-client-okhttp`\'s [`OkHttpClient`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/OkHttpClient.kt) class into your code and customize it\n3. Construct [`FinchClientImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) or [`FinchClientAsyncImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), similarly to [`FinchOkHttpClient`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), using your customized client\n\n### Completely custom HTTP client\n\nTo use a completely custom HTTP client:\n\n1. Replace your [`finch-java` dependency](#installation) with `finch-java-core`\n2. Write a class that implements the [`HttpClient`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/http/HttpClient.kt) interface\n3. Construct [`FinchClientImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) or [`FinchClientAsyncImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), similarly to [`FinchOkHttpClient`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), using your new client class\n\n## Undocumented API functionality\n\nThe SDK is typed for convenient usage of the documented API. However, it also supports working with undocumented or not yet supported parts of the API.\n\n### Parameters\n\nTo set undocumented parameters, call the `putAdditionalHeader`, `putAdditionalQueryParam`, or `putAdditionalBodyProperty` methods on any `Params` class:\n\n```java\nimport com.tryfinch.api.core.JsonValue;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\nHrisDirectoryListParams params = HrisDirectoryListParams.builder()\n .putAdditionalHeader("Secret-Header", "42")\n .putAdditionalQueryParam("secret_query_param", "42")\n .putAdditionalBodyProperty("secretProperty", JsonValue.from("42"))\n .build();\n```\n\nThese can be accessed on the built object later using the `_additionalHeaders()`, `_additionalQueryParams()`, and `_additionalBodyProperties()` methods.\n\nTo set a documented parameter or property to an undocumented or not yet supported _value_, pass a [`JsonValue`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/Values.kt) object to its setter:\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\nHrisDirectoryListParams params = HrisDirectoryListParams.builder().build();\n```\n\nThe most straightforward way to create a [`JsonValue`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/Values.kt) is using its `from(...)` method:\n\n```java\nimport com.tryfinch.api.core.JsonValue;\nimport java.util.List;\nimport java.util.Map;\n\n// Create primitive JSON values\nJsonValue nullValue = JsonValue.from(null);\nJsonValue booleanValue = JsonValue.from(true);\nJsonValue numberValue = JsonValue.from(42);\nJsonValue stringValue = JsonValue.from("Hello World!");\n\n// Create a JSON array value equivalent to `["Hello", "World"]`\nJsonValue arrayValue = JsonValue.from(List.of(\n "Hello", "World"\n));\n\n// Create a JSON object value equivalent to `{ "a": 1, "b": 2 }`\nJsonValue objectValue = JsonValue.from(Map.of(\n "a", 1,\n "b", 2\n));\n\n// Create an arbitrarily nested JSON equivalent to:\n// {\n// "a": [1, 2],\n// "b": [3, 4]\n// }\nJsonValue complexValue = JsonValue.from(Map.of(\n "a", List.of(\n 1, 2\n ),\n "b", List.of(\n 3, 4\n )\n));\n```\n\nNormally a `Builder` class\'s `build` method will throw [`IllegalStateException`](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) if any required parameter or property is unset.\n\nTo forcibly omit a required parameter or property, pass [`JsonMissing`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/Values.kt):\n\n```java\nimport com.tryfinch.api.core.JsonMissing;\nimport com.tryfinch.api.models.AccessTokenCreateParams;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\nHrisDirectoryListParams params = AccessTokenCreateParams.builder()\n .code(JsonMissing.of())\n .build();\n```\n\n### Response properties\n\nTo access undocumented response properties, call the `_additionalProperties()` method:\n\n```java\nimport com.tryfinch.api.core.JsonValue;\nimport java.util.Map;\n\nMap additionalProperties = client.accessTokens().create(params)._additionalProperties();\nJsonValue secretPropertyValue = additionalProperties.get("secretProperty");\n\nString result = secretPropertyValue.accept(new JsonValue.Visitor<>() {\n @Override\n public String visitNull() {\n return "It\'s null!";\n }\n\n @Override\n public String visitBoolean(boolean value) {\n return "It\'s a boolean!";\n }\n\n @Override\n public String visitNumber(Number value) {\n return "It\'s a number!";\n }\n\n // Other methods include `visitMissing`, `visitString`, `visitArray`, and `visitObject`\n // The default implementation of each unimplemented method delegates to `visitDefault`, which throws by default, but can also be overridden\n});\n```\n\nTo access a property\'s raw JSON value, which may be undocumented, call its `_` prefixed method:\n\n```java\nimport com.tryfinch.api.core.JsonField;\nimport java.util.Optional;\n\nJsonField code = client.accessTokens().create(params)._code();\n\nif (code.isMissing()) {\n // The property is absent from the JSON response\n} else if (code.isNull()) {\n // The property was set to literal null\n} else {\n // Check if value was provided as a string\n // Other methods include `asNumber()`, `asBoolean()`, etc.\n Optional jsonString = code.asString();\n\n // Try to deserialize into a custom type\n MyClass myObject = code.asUnknown().orElseThrow().convert(MyClass.class);\n}\n```\n\n### Response validation\n\nIn rare cases, the API may return a response that doesn\'t match the expected type. For example, the SDK may expect a property to contain a `String`, but the API could return something else.\n\nBy default, the SDK will not throw an exception in this case. It will throw [`FinchInvalidDataException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchInvalidDataException.kt) only if you directly access the property.\n\nIf you would prefer to check that the response is completely well-typed upfront, then either call `validate()`:\n\n```java\nimport com.tryfinch.api.models.CreateAccessTokenResponse;\n\nCreateAccessTokenResponse createAccessTokenResponse = client.accessTokens().create(params).validate();\n```\n\nOr configure the method call to validate the response using the `responseValidation` method:\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListPage;\n\nHrisDirectoryListPage page = client.hris().directory().list(RequestOptions.builder().responseValidation(true).build());\n```\n\nOr configure the default for all method calls at the client level:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .responseValidation(true)\n .accessToken("My Access Token")\n .build();\n```\n\n## FAQ\n\n### Why don\'t you use plain `enum` classes?\n\nJava `enum` classes are not trivially [forwards compatible](https://www.stainless.com/blog/making-java-enums-forwards-compatible). Using them in the SDK could cause runtime exceptions if the API is updated to respond with a new enum value.\n\n### Why do you represent fields using `JsonField` instead of just plain `T`?\n\nUsing `JsonField` enables a few features:\n\n- Allowing usage of [undocumented API functionality](#undocumented-api-functionality)\n- Lazily [validating the API response against the expected shape](#response-validation)\n- Representing absent vs explicitly null values\n\n### Why don\'t you use [`data` classes](https://kotlinlang.org/docs/data-classes.html)?\n\nIt is not [backwards compatible to add new fields to a data class](https://kotlinlang.org/docs/api-guidelines-backward-compatibility.html#avoid-using-data-classes-in-your-api) and we don\'t want to introduce a breaking change every time we add a field to a class.\n\n### Why don\'t you use checked exceptions?\n\nChecked exceptions are widely considered a mistake in the Java programming language. In fact, they were omitted from Kotlin for this reason.\n\nChecked exceptions:\n\n- Are verbose to handle\n- Encourage error handling at the wrong level of abstraction, where nothing can be done about the error\n- Are tedious to propagate due to the [function coloring problem](https://journal.stuffwithstuff.com/2015/02/01/what-color-is-your-function)\n- Don\'t play well with lambdas (also due to the function coloring problem)\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n2. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Finch-API/finch-api-java/issues) with questions, bugs, or suggestions.\n', }, { - language: 'typescript', + language: 'kotlin', content: - "# Finch TypeScript API Library\n\n[![NPM version](https://img.shields.io/npm/v/@tryfinch/finch-api.svg?label=npm%20(stable))](https://npmjs.org/package/@tryfinch/finch-api) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@tryfinch/finch-api)\n\nThis library provides convenient access to the Finch REST API from server-side TypeScript or JavaScript.\n\n\n\nThe REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/). The full API of this library can be found in [api.md](api.md).\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Installation\n\n```sh\nnpm install @tryfinch/finch-api\n```\n\n\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n\n```js\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst page = await client.hris.directory.list();\nconst individualInDirectory = page.individuals[0];\n\nconsole.log(individualInDirectory.id);\n```\n\n\n\n### Request & Response types\n\nThis library includes TypeScript definitions for all request params and response fields. You may import and use them like so:\n\n\n```ts\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst [individualInDirectory]: [Finch.HRIS.IndividualInDirectory] =\n await client.hris.directory.list();\n```\n\nDocumentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.\n\n\n\n\n\n## Handling errors\n\nWhen the library is unable to connect to the API,\nor if the API returns a non-success status code (i.e., 4xx or 5xx response),\na subclass of `APIError` will be thrown:\n\n\n```ts\nconst company = await client.hris.company.retrieve().catch(async (err) => {\n if (err instanceof Finch.APIError) {\n console.log(err.status); // 400\n console.log(err.name); // BadRequestError\n console.log(err.headers); // {server: 'nginx', ...}\n } else {\n throw err;\n }\n});\n```\n\nError codes are as follows:\n\n| Status Code | Error Type |\n| ----------- | -------------------------- |\n| 400 | `BadRequestError` |\n| 401 | `AuthenticationError` |\n| 403 | `PermissionDeniedError` |\n| 404 | `NotFoundError` |\n| 422 | `UnprocessableEntityError` |\n| 429 | `RateLimitError` |\n| >=500 | `InternalServerError` |\n| N/A | `APIConnectionError` |\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,\n429 Rate Limit, and >=500 Internal errors will all be retried by default.\n\nYou can use the `maxRetries` option to configure or disable this:\n\n\n```js\n// Configure the default for all requests:\nconst client = new Finch({\n maxRetries: 0, // default is 2\n});\n\n// Or, configure per-request:\nawait client.hris.directory.list({\n maxRetries: 5,\n});\n```\n\n### Timeouts\n\nRequests time out after 1 minute by default. You can configure this with a `timeout` option:\n\n\n```ts\n// Configure the default for all requests:\nconst client = new Finch({\n timeout: 20 * 1000, // 20 seconds (default is 1 minute)\n});\n\n// Override per-request:\nawait client.hris.directory.list({\n timeout: 5 * 1000,\n});\n```\n\nOn timeout, an `APIConnectionTimeoutError` is thrown.\n\nNote that requests which time out will be [retried twice by default](#retries).\n\n## Auto-pagination\n\nList methods in the Finch API are paginated.\nYou can use the `for await … of` syntax to iterate through items across all pages:\n\n```ts\nasync function fetchAllIndividualInDirectories(params) {\n const allIndividualInDirectories = [];\n // Automatically fetches more pages as needed.\n for await (const individualInDirectory of client.hris.directory.list()) {\n allIndividualInDirectories.push(individualInDirectory);\n }\n return allIndividualInDirectories;\n}\n```\n\nAlternatively, you can request a single page at a time:\n\n```ts\nlet page = await client.hris.directory.list();\nfor (const individualInDirectory of page.individuals) {\n console.log(individualInDirectory);\n}\n\n// Convenience methods are provided for manually paginating:\nwhile (page.hasNextPage()) {\n page = await page.getNextPage();\n // ...\n}\n```\n\n## Default Headers\n\nWe automatically send the `Finch-API-Version` header set to `2020-09-17`.\n\nIf you need to, you can override it by setting default headers on a per-request basis.\n\nBe aware that doing so may result in incorrect types and other unexpected or undefined behavior in the SDK.\n\n```ts\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst page = await client.hris.directory.list({\n headers: { 'Finch-API-Version': 'My-Custom-Value' },\n});\nconst individualInDirectory = page.individuals[0];\n```\n\n## Advanced Usage\n\n### Accessing raw Response data (e.g., headers)\n\nThe \"raw\" `Response` returned by `fetch()` can be accessed through the `.asResponse()` method on the `APIPromise` type that all methods return.\nThis method returns as soon as the headers for a successful response are received and does not consume the response body, so you are free to write custom parsing or streaming logic.\n\nYou can also use the `.withResponse()` method to get the raw `Response` along with the parsed data.\nUnlike `.asResponse()` this method consumes the body, returning once it is parsed.\n\n\n```ts\nconst client = new Finch();\n\nconst response = await client.hris.directory.list().asResponse();\nconsole.log(response.headers.get('X-My-Header'));\nconsole.log(response.statusText); // access the underlying Response object\n\nconst { data: page, response: raw } = await client.hris.directory.list().withResponse();\nconsole.log(raw.headers.get('X-My-Header'));\nfor await (const individualInDirectory of page) {\n console.log(individualInDirectory.id);\n}\n```\n\n### Logging\n\n> [!IMPORTANT]\n> All log messages are intended for debugging only. The format and content of log messages\n> may change between releases.\n\n#### Log levels\n\nThe log level can be configured in two ways:\n\n1. Via the `FINCH_LOG` environment variable\n2. Using the `logLevel` client option (overrides the environment variable if set)\n\n```ts\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n logLevel: 'debug', // Show all log messages\n});\n```\n\nAvailable log levels, from most to least verbose:\n\n- `'debug'` - Show debug messages, info, warnings, and errors\n- `'info'` - Show info messages, warnings, and errors\n- `'warn'` - Show warnings and errors (default)\n- `'error'` - Show only errors\n- `'off'` - Disable all logging\n\nAt the `'debug'` level, all HTTP requests and responses are logged, including headers and bodies.\nSome authentication-related headers are redacted, but sensitive data in request and response bodies\nmay still be visible.\n\n#### Custom logger\n\nBy default, this library logs to `globalThis.console`. You can also provide a custom logger.\nMost logging libraries are supported, including [pino](https://www.npmjs.com/package/pino), [winston](https://www.npmjs.com/package/winston), [bunyan](https://www.npmjs.com/package/bunyan), [consola](https://www.npmjs.com/package/consola), [signale](https://www.npmjs.com/package/signale), and [@std/log](https://jsr.io/@std/log). If your logger doesn't work, please open an issue.\n\nWhen providing a custom logger, the `logLevel` option still controls which messages are emitted, messages\nbelow the configured level will not be sent to your logger.\n\n```ts\nimport Finch from '@tryfinch/finch-api';\nimport pino from 'pino';\n\nconst logger = pino();\n\nconst client = new Finch({\n logger: logger.child({ name: 'Finch' }),\n logLevel: 'debug', // Send all messages to pino, allowing it to filter\n});\n```\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API. If you need to access undocumented\nendpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can use `client.get`, `client.post`, and other HTTP verbs.\nOptions on the client, such as retries, will be respected when making these requests.\n\n```ts\nawait client.post('/some/path', {\n body: { some_prop: 'foo' },\n query: { some_query_arg: 'bar' },\n});\n```\n\n#### Undocumented request params\n\nTo make requests using undocumented parameters, you may use `// @ts-expect-error` on the undocumented\nparameter. This library doesn't validate at runtime that the request matches the type, so any extra values you\nsend will be sent as-is.\n\n```ts\nclient.hris.directory.list({\n // ...\n // @ts-expect-error baz is not yet public\n baz: 'undocumented option',\n});\n```\n\nFor requests with the `GET` verb, any extra params will be in the query, all other requests will send the\nextra param in the body.\n\nIf you want to explicitly send an extra argument, you can do so with the `query`, `body`, and `headers` request\noptions.\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you may access the response object with `// @ts-expect-error` on\nthe response object, or cast the response object to the requisite type. Like the request params, we do not\nvalidate or strip extra properties from the response from the API.\n\n### Customizing the fetch client\n\nBy default, this library expects a global `fetch` function is defined.\n\nIf you want to use a different `fetch` function, you can either polyfill the global:\n\n```ts\nimport fetch from 'my-fetch';\n\nglobalThis.fetch = fetch;\n```\n\nOr pass it to the client:\n\n```ts\nimport Finch from '@tryfinch/finch-api';\nimport fetch from 'my-fetch';\n\nconst client = new Finch({ fetch });\n```\n\n### Fetch options\n\nIf you want to set custom `fetch` options without overriding the `fetch` function, you can provide a `fetchOptions` object when instantiating the client or making a request. (Request-specific options override client options.)\n\n```ts\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n fetchOptions: {\n // `RequestInit` options\n },\n});\n```\n\n#### Configuring proxies\n\nTo modify proxy behavior, you can provide custom `fetchOptions` that add runtime-specific proxy\noptions to requests:\n\n **Node** [[docs](https://github.com/nodejs/undici/blob/main/docs/docs/api/ProxyAgent.md#example---proxyagent-with-fetch)]\n\n```ts\nimport Finch from '@tryfinch/finch-api';\nimport * as undici from 'undici';\n\nconst proxyAgent = new undici.ProxyAgent('http://localhost:8888');\nconst client = new Finch({\n fetchOptions: {\n dispatcher: proxyAgent,\n },\n});\n```\n\n **Bun** [[docs](https://bun.sh/guides/http/proxy)]\n\n```ts\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n fetchOptions: {\n proxy: 'http://localhost:8888',\n },\n});\n```\n\n **Deno** [[docs](https://docs.deno.com/api/deno/~/Deno.createHttpClient)]\n\n```ts\nimport Finch from 'npm:@tryfinch/finch-api';\n\nconst httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });\nconst client = new Finch({\n fetchOptions: {\n client: httpClient,\n },\n});\n```\n\n## Frequently Asked Questions\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes that only affect static types, without breaking runtime behavior.\n2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n3. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Finch-API/finch-api-node/issues) with questions, bugs, or suggestions.\n\n## Requirements\n\nTypeScript >= 4.9 is supported.\n\nThe following runtimes are supported:\n\n- Node.js 20 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.\n- Deno v1.28.0 or higher.\n- Bun 1.0 or later.\n- Cloudflare Workers.\n- Vercel Edge Runtime.\n- Jest 28 or greater with the `\"node\"` environment (`\"jsdom\"` is not supported at this time).\n- Nitro v2.6 or greater.\n- Web browsers: disabled by default to avoid exposing your secret API credentials. Enable browser support by explicitly setting `dangerouslyAllowBrowser` to true'.\n
\n More explanation\n\n ### Why is this dangerous?\n Enabling the `dangerouslyAllowBrowser` option can be dangerous because it exposes your secret API credentials in the client-side code. Web browsers are inherently less secure than server environments,\n any user with access to the browser can potentially inspect, extract, and misuse these credentials. This could lead to unauthorized access using your credentials and potentially compromise sensitive data or functionality.\n ### When might this not be dangerous?\n In certain scenarios where enabling browser support might not pose significant risks:\n - Internal Tools: If the application is used solely within a controlled internal environment where the users are trusted, the risk of credential exposure can be mitigated.\n - Public APIs with Limited Scope: If your API has very limited scope and the exposed credentials do not grant access to sensitive data or critical operations, the potential impact of exposure is reduced.\n - Development or debugging purpose: Enabling this feature temporarily might be acceptable, provided the credentials are short-lived, aren't also used in production environments, or are frequently rotated.\n\n
\n\nNote that React Native is not supported at this time.\n\nIf you are interested in other runtime environments, please open or upvote an issue on GitHub.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n", + '# Finch Kotlin API Library\n\n\n[![Maven Central](https://img.shields.io/maven-central/v/com.tryfinch.api/finch-kotlin)](https://central.sonatype.com/artifact/com.tryfinch.api/finch-kotlin/0.0.1)\n[![javadoc](https://javadoc.io/badge2/com.tryfinch.api/finch-kotlin/0.0.1/javadoc.svg)](https://javadoc.io/doc/com.tryfinch.api/finch-kotlin/0.0.1)\n\n\nThe Finch Kotlin SDK provides convenient access to the [Finch REST API](https://developer.tryfinch.com/) from applications written in Kotlin.\n\nThe Finch Kotlin SDK is similar to the Finch Java SDK but with minor differences that make it more ergonomic for use in Kotlin, such as nullable values instead of `Optional`, `Sequence` instead of `Stream`, and suspend functions instead of `CompletableFuture`.\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n\n\nThe REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/). KDocs are available on [javadoc.io](https://javadoc.io/doc/com.tryfinch.api/finch-kotlin/0.0.1).\n\n\n\n## Installation\n\n\n\n### Gradle\n\n~~~kotlin\nimplementation("com.tryfinch.api:finch-kotlin:0.0.1")\n~~~\n\n### Maven\n\n~~~xml\n\n com.tryfinch.api\n finch-kotlin\n 0.0.1\n\n~~~\n\n\n\n## Requirements\n\nThis library requires Java 8 or later.\n\n## Usage\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisDirectoryListPage\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval client: FinchClient = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\nval page: HrisDirectoryListPage = client.hris().directory().list()\n```\n\n## Client configuration\n\nConfigure the client using system properties or environment variables:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n```\n\nOr manually:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .accessToken("My Access Token")\n .build()\n```\n\nOr using a combination of the two approaches:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n```\n\nSee this table for the available options:\n\n| Setter | System property | Environment variable | Required | Default value |\n| --------------- | --------------------- | ---------------------- | -------- | ---------------------------- |\n| `clientId` | `finch.clientId` | `FINCH_CLIENT_ID` | false | - |\n| `clientSecret` | `finch.clientSecret` | `FINCH_CLIENT_SECRET` | false | - |\n| `webhookSecret` | `finch.webhookSecret` | `FINCH_WEBHOOK_SECRET` | false | - |\n| `baseUrl` | `finch.baseUrl` | `FINCH_BASE_URL` | true | `"https://api.tryfinch.com"` |\n\nSystem properties take precedence over environment variables.\n\n> [!TIP]\n> Don\'t create more than one client in the same application. Each client has a connection pool and\n> thread pools, which are more efficient to share between requests.\n\n### Modifying configuration\n\nTo temporarily use a modified client configuration, while reusing the same connection and thread pools, call `withOptions()` on any client or service:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\n\nval clientWithOptions: FinchClient = client.withOptions {\n it.baseUrl("https://example.com")\n it.maxRetries(42)\n}\n```\n\nThe `withOptions()` method does not affect the original client or service.\n\n## Requests and responses\n\nTo send a request to the Finch API, build an instance of some `Params` class and pass it to the corresponding client method. When the response is received, it will be deserialized into an instance of a Kotlin class.\n\nFor example, `client.hris().directory().list(...)` should be called with an instance of `HrisDirectoryListParams`, and it will return an instance of `HrisDirectoryListPage`.\n\n## Immutability\n\nEach class in the SDK has an associated [builder](https://blogs.oracle.com/javamagazine/post/exploring-joshua-blochs-builder-design-pattern-in-java) or factory method for constructing it.\n\nEach class is [immutable](https://docs.oracle.com/javase/tutorial/essential/concurrency/immutable.html) once constructed. If the class has an associated builder, then it has a `toBuilder()` method, which can be used to convert it back to a builder for making a modified copy.\n\nBecause each class is immutable, builder modification will _never_ affect already built class instances.\n\n## Asynchronous execution\n\nThe default client is synchronous. To switch to asynchronous execution, call the `async()` method:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval client: FinchClient = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\nval page: HrisDirectoryListPageAsync = client.async().hris().directory().list()\n```\n\nOr create an asynchronous client from the beginning:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClientAsync\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClientAsync\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval client: FinchClientAsync = FinchOkHttpClientAsync.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\nval page: HrisDirectoryListPageAsync = client.hris().directory().list()\n```\n\nThe asynchronous client supports the same options as the synchronous one, except most methods are [suspending](https://kotlinlang.org/docs/coroutines-guide.html).\n\n\n\n\n\n\n\n## Raw responses\n\nThe SDK defines methods that deserialize responses into instances of Kotlin classes. However, these methods don\'t provide access to the response headers, status code, or the raw response body.\n\nTo access this data, prefix any HTTP method call on a client or service with `withRawResponse()`:\n\n```kotlin\nimport com.tryfinch.api.core.http.Headers\nimport com.tryfinch.api.core.http.HttpResponseFor\nimport com.tryfinch.api.models.HrisDirectoryListPage\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval page: HttpResponseFor = client.hris().directory().withRawResponse().list()\n\nval statusCode: Int = page.statusCode()\nval headers: Headers = page.headers()\n```\n\nYou can still deserialize the response into an instance of a Kotlin class if needed:\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPage\n\nval parsedPage: HrisDirectoryListPage = page.parse()\n```\n\n## Error handling\n\nThe SDK throws custom unchecked exception types:\n\n- [`FinchServiceException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchServiceException.kt): Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:\n\n | Status | Exception |\n | ------ | -------------------------------------------------- |\n | 400 | [`BadRequestException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/BadRequestException.kt) |\n | 401 | [`UnauthorizedException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/UnauthorizedException.kt) |\n | 403 | [`PermissionDeniedException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/PermissionDeniedException.kt) |\n | 404 | [`NotFoundException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/NotFoundException.kt) |\n | 422 | [`UnprocessableEntityException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/UnprocessableEntityException.kt) |\n | 429 | [`RateLimitException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/RateLimitException.kt) |\n | 5xx | [`InternalServerException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/InternalServerException.kt) |\n | others | [`UnexpectedStatusCodeException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/UnexpectedStatusCodeException.kt) |\n\n- [`FinchIoException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchIoException.kt): I/O networking errors.\n\n- [`FinchRetryableException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchRetryableException.kt): Generic error indicating a failure that could be retried by the client.\n\n- [`FinchInvalidDataException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchInvalidDataException.kt): Failure to interpret successfully parsed data. For example, when accessing a property that\'s supposed to be required, but the API unexpectedly omitted it from the response.\n\n- [`FinchException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchException.kt): Base class for all exceptions. Most errors will result in one of the previously mentioned ones, but completely generic errors may be thrown using the base class.\n\n## Pagination\n\nThe SDK defines methods that return a paginated lists of results. It provides convenient ways to access the results either one page at a time or item-by-item across all pages.\n\n### Auto-pagination\n\nTo iterate through all results across all pages, use the `autoPager()` method, which automatically fetches more pages as needed.\n\nWhen using the synchronous client, the method returns a [`Sequence`](https://kotlinlang.org/docs/sequences.html)\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPage\n\nval page: HrisDirectoryListPage = client.hris().directory().list()\npage.autoPager()\n .take(50)\n .forEach { directory -> println(directory) }\n```\n\nWhen using the asynchronous client, the method returns a [`Flow`](https://kotlinlang.org/docs/flow.html):\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync\n\nval page: HrisDirectoryListPageAsync = client.async().hris().directory().list()\npage.autoPager()\n .take(50)\n .forEach { directory -> println(directory) }\n```\n\n### Manual pagination\n\nTo access individual page items and manually request the next page, use the `items()`,\n`hasNextPage()`, and `nextPage()` methods:\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPage\nimport com.tryfinch.api.models.IndividualInDirectory\n\nval page: HrisDirectoryListPage = client.hris().directory().list()\nwhile (true) {\n for (directory in page.items()) {\n println(directory)\n }\n\n if (!page.hasNextPage()) {\n break\n }\n\n page = page.nextPage()\n}\n```\n\n## Logging\n\nThe SDK uses the standard [OkHttp logging interceptor](https://github.com/square/okhttp/tree/master/okhttp-logging-interceptor).\n\nEnable logging by setting the `FINCH_LOG` environment variable to `info`:\n\n```sh\nexport FINCH_LOG=info\n```\n\nOr to `debug` for more verbose logging:\n\n```sh\nexport FINCH_LOG=debug\n```\n\n## ProGuard and R8\n\nAlthough the SDK uses reflection, it is still usable with [ProGuard](https://github.com/Guardsquare/proguard) and [R8](https://developer.android.com/topic/performance/app-optimization/enable-app-optimization) because `finch-kotlin-core` is published with a [configuration file](finch-kotlin-core/src/main/resources/META-INF/proguard/finch-kotlin-core.pro) containing [keep rules](https://www.guardsquare.com/manual/configuration/usage).\n\nProGuard and R8 should automatically detect and use the published rules, but you can also manually copy the keep rules if necessary.\n\n\n\n\n\n## Jackson\n\nThe SDK depends on [Jackson](https://github.com/FasterXML/jackson) for JSON serialization/deserialization. It is compatible with version 2.13.4 or higher, but depends on version 2.18.2 by default.\n\nThe SDK throws an exception if it detects an incompatible Jackson version at runtime (e.g. if the default version was overridden in your Maven or Gradle config).\n\nIf the SDK threw an exception, but you\'re _certain_ the version is compatible, then disable the version check using the `checkJacksonVersionCompatibility` on [`FinchOkHttpClient`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt).\n\n> [!CAUTION]\n> We make no guarantee that the SDK works correctly when the Jackson version check is disabled.\n\nAlso note that there are bugs in older Jackson versions that can affect the SDK. We don\'t work around all Jackson bugs ([example](https://github.com/FasterXML/jackson-databind/issues/3240)) and expect users to upgrade Jackson for those instead.\n\n## Network options\n\n### Retries\n\nThe SDK automatically retries 2 times by default, with a short exponential backoff between requests.\n\nOnly the following error types are retried:\n- Connection errors (for example, due to a network connectivity problem)\n- 408 Request Timeout\n- 409 Conflict\n- 429 Rate Limit\n- 5xx Internal\n\nThe API may also explicitly instruct the SDK to retry or not retry a request.\n\nTo set a custom number of retries, configure the client using the `maxRetries` method:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .maxRetries(4)\n .accessToken("My Access Token")\n .build()\n```\n\n### Timeouts\n\nRequests time out after 1 minute by default.\n\nTo set a custom timeout, configure the method call using the `timeout` method:\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPage\n\nval page: HrisDirectoryListPage = client.hris().directory().list(RequestOptions.builder().timeout(Duration.ofSeconds(30)).build())\n```\n\nOr configure the default for all method calls at the client level:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport java.time.Duration\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .timeout(Duration.ofSeconds(30))\n .accessToken("My Access Token")\n .build()\n```\n\n### Proxies\n\nTo route requests through a proxy, configure the client using the `proxy` method:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport java.net.InetSocketAddress\nimport java.net.Proxy\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .proxy(Proxy(\n Proxy.Type.HTTP, InetSocketAddress(\n "https://example.com", 8080\n )\n ))\n .accessToken("My Access Token")\n .build()\n```\n\n### Connection pooling\n\nTo customize the underlying OkHttp connection pool, configure the client using the `maxIdleConnections` and `keepAliveDuration` methods:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport java.time.Duration\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n // If `maxIdleConnections` is set, then `keepAliveDuration` must be set, and vice versa.\n .maxIdleConnections(10)\n .keepAliveDuration(Duration.ofMinutes(2))\n .accessToken("My Access Token")\n .build()\n```\n\nIf both options are unset, OkHttp\'s default connection pool settings are used.\n\n### HTTPS\n\n> [!NOTE]\n> Most applications should not call these methods, and instead use the system defaults. The defaults include\n> special optimizations that can be lost if the implementations are modified.\n\nTo configure how HTTPS connections are secured, configure the client using the `sslSocketFactory`, `trustManager`, and `hostnameVerifier` methods:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n // If `sslSocketFactory` is set, then `trustManager` must be set, and vice versa.\n .sslSocketFactory(yourSSLSocketFactory)\n .trustManager(yourTrustManager)\n .hostnameVerifier(yourHostnameVerifier)\n .accessToken("My Access Token")\n .build()\n```\n\n\n\n### Custom HTTP client\n\nThe SDK consists of three artifacts:\n- `finch-kotlin-core`\n - Contains core SDK logic\n - Does not depend on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`FinchClient`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClient.kt), [`FinchClientAsync`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsync.kt), [`FinchClientImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt), and [`FinchClientAsyncImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), all of which can work with any HTTP client\n- `finch-kotlin-client-okhttp`\n - Depends on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`FinchOkHttpClient`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) and [`FinchOkHttpClientAsync`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), which provide a way to construct [`FinchClientImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) and [`FinchClientAsyncImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), respectively, using OkHttp\n- `finch-kotlin`\n - Depends on and exposes the APIs of both `finch-kotlin-core` and `finch-kotlin-client-okhttp`\n - Does not have its own logic\n\nThis structure allows replacing the SDK\'s default HTTP client without pulling in unnecessary dependencies.\n\n#### Customized [`OkHttpClient`](https://square.github.io/okhttp/3.x/okhttp/okhttp3/OkHttpClient.html)\n\n> [!TIP]\n> Try the available [network options](#network-options) before replacing the default client.\n\nTo use a customized `OkHttpClient`:\n\n1. Replace your [`finch-kotlin` dependency](#installation) with `finch-kotlin-core`\n2. Copy `finch-kotlin-client-okhttp`\'s [`OkHttpClient`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/OkHttpClient.kt) class into your code and customize it\n3. Construct [`FinchClientImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) or [`FinchClientAsyncImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), similarly to [`FinchOkHttpClient`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), using your customized client\n\n### Completely custom HTTP client\n\nTo use a completely custom HTTP client:\n\n1. Replace your [`finch-kotlin` dependency](#installation) with `finch-kotlin-core`\n2. Write a class that implements the [`HttpClient`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/core/http/HttpClient.kt) interface\n3. Construct [`FinchClientImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) or [`FinchClientAsyncImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), similarly to [`FinchOkHttpClient`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), using your new client class\n\n## Undocumented API functionality\n\nThe SDK is typed for convenient usage of the documented API. However, it also supports working with undocumented or not yet supported parts of the API.\n\n### Parameters\n\nTo set undocumented parameters, call the `putAdditionalHeader`, `putAdditionalQueryParam`, or `putAdditionalBodyProperty` methods on any `Params` class:\n\n```kotlin\nimport com.tryfinch.api.core.JsonValue\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval params: HrisDirectoryListParams = HrisDirectoryListParams.builder()\n .putAdditionalHeader("Secret-Header", "42")\n .putAdditionalQueryParam("secret_query_param", "42")\n .putAdditionalBodyProperty("secretProperty", JsonValue.from("42"))\n .build()\n```\n\nThese can be accessed on the built object later using the `_additionalHeaders()`, `_additionalQueryParams()`, and `_additionalBodyProperties()` methods.\n\nTo set a documented parameter or property to an undocumented or not yet supported _value_, pass a [`JsonValue`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/core/Values.kt) object to its setter:\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval params: HrisDirectoryListParams = HrisDirectoryListParams.builder().build()\n```\n\nThe most straightforward way to create a [`JsonValue`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/core/Values.kt) is using its `from(...)` method:\n\n```kotlin\nimport com.tryfinch.api.core.JsonValue\n\n// Create primitive JSON values\nval nullValue: JsonValue = JsonValue.from(null)\nval booleanValue: JsonValue = JsonValue.from(true)\nval numberValue: JsonValue = JsonValue.from(42)\nval stringValue: JsonValue = JsonValue.from("Hello World!")\n\n// Create a JSON array value equivalent to `["Hello", "World"]`\nval arrayValue: JsonValue = JsonValue.from(listOf(\n "Hello", "World"\n))\n\n// Create a JSON object value equivalent to `{ "a": 1, "b": 2 }`\nval objectValue: JsonValue = JsonValue.from(mapOf(\n "a" to 1, "b" to 2\n))\n\n// Create an arbitrarily nested JSON equivalent to:\n// {\n// "a": [1, 2],\n// "b": [3, 4]\n// }\nval complexValue: JsonValue = JsonValue.from(mapOf(\n "a" to listOf(\n 1, 2\n ), "b" to listOf(\n 3, 4\n )\n))\n```\n\nNormally a `Builder` class\'s `build` method will throw [`IllegalStateException`](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) if any required parameter or property is unset.\n\nTo forcibly omit a required parameter or property, pass [`JsonMissing`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/core/Values.kt):\n\n```kotlin\nimport com.tryfinch.api.core.JsonMissing\nimport com.tryfinch.api.models.AccessTokenCreateParams\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval params: HrisDirectoryListParams = AccessTokenCreateParams.builder()\n .code(JsonMissing.of())\n .build()\n```\n\n### Response properties\n\nTo access undocumented response properties, call the `_additionalProperties()` method:\n\n```kotlin\nimport com.tryfinch.api.core.JsonBoolean\nimport com.tryfinch.api.core.JsonNull\nimport com.tryfinch.api.core.JsonNumber\nimport com.tryfinch.api.core.JsonValue\n\nval additionalProperties: Map = client.accessTokens().create(params)._additionalProperties()\nval secretPropertyValue: JsonValue = additionalProperties.get("secretProperty")\n\nval result = when (secretPropertyValue) {\n is JsonNull -> "It\'s null!"\n is JsonBoolean -> "It\'s a boolean!"\n is JsonNumber -> "It\'s a number!"\n // Other types include `JsonMissing`, `JsonString`, `JsonArray`, and `JsonObject`\n else -> "It\'s something else!"\n}\n```\n\nTo access a property\'s raw JSON value, which may be undocumented, call its `_` prefixed method:\n\n```kotlin\nimport com.tryfinch.api.core.JsonField\n\nval code: JsonField = client.accessTokens().create(params)._code()\n\nif (code.isMissing()) {\n // The property is absent from the JSON response\n} else if (code.isNull()) {\n // The property was set to literal null\n} else {\n // Check if value was provided as a string\n // Other methods include `asNumber()`, `asBoolean()`, etc.\n val jsonString: String? = code.asString();\n\n // Try to deserialize into a custom type\n val myObject: MyClass = code.asUnknown()!!.convert(MyClass::class.java)\n}\n```\n\n### Response validation\n\nIn rare cases, the API may return a response that doesn\'t match the expected type. For example, the SDK may expect a property to contain a `String`, but the API could return something else.\n\nBy default, the SDK will not throw an exception in this case. It will throw [`FinchInvalidDataException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchInvalidDataException.kt) only if you directly access the property.\n\nIf you would prefer to check that the response is completely well-typed upfront, then either call `validate()`:\n\n```kotlin\nimport com.tryfinch.api.models.CreateAccessTokenResponse\n\nval createAccessTokenResponse: CreateAccessTokenResponse = client.accessTokens().create(params).validate()\n```\n\nOr configure the method call to validate the response using the `responseValidation` method:\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPage\n\nval page: HrisDirectoryListPage = client.hris().directory().list(RequestOptions.builder().responseValidation(true).build())\n```\n\nOr configure the default for all method calls at the client level:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .responseValidation(true)\n .accessToken("My Access Token")\n .build()\n```\n\n## FAQ\n\n### Why don\'t you use plain `enum` classes?\n\nKotlin `enum` classes are not trivially [forwards compatible](https://www.stainless.com/blog/making-java-enums-forwards-compatible). Using them in the SDK could cause runtime exceptions if the API is updated to respond with a new enum value.\n\n### Why do you represent fields using `JsonField` instead of just plain `T`?\n\nUsing `JsonField` enables a few features:\n\n- Allowing usage of [undocumented API functionality](#undocumented-api-functionality)\n- Lazily [validating the API response against the expected shape](#response-validation)\n- Representing absent vs explicitly null values\n\n### Why don\'t you use [`data` classes](https://kotlinlang.org/docs/data-classes.html)?\n\nIt is not [backwards compatible to add new fields to a data class](https://kotlinlang.org/docs/api-guidelines-backward-compatibility.html#avoid-using-data-classes-in-your-api) and we don\'t want to introduce a breaking change every time we add a field to a class.\n\n### Why don\'t you use checked exceptions?\n\nChecked exceptions are widely considered a mistake in the Java programming language. In fact, they were omitted from Kotlin for this reason.\n\nChecked exceptions:\n\n- Are verbose to handle\n- Encourage error handling at the wrong level of abstraction, where nothing can be done about the error\n- Are tedious to propagate due to the [function coloring problem](https://journal.stuffwithstuff.com/2015/02/01/what-color-is-your-function)\n- Don\'t play well with lambdas (also due to the function coloring problem)\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n2. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Finch-API/finch-api-kotlin/issues) with questions, bugs, or suggestions.\n', }, { - language: 'ruby', + language: 'python', content: - '# Finch Ruby API library\n\nThe Finch Ruby library provides convenient access to the Finch REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/Finch-API/finch-api-ruby#Sorbet) for usage with Sorbet. The standard library\'s `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.\n\n\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Documentation\n\nDocumentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/finch-api).\n\nThe REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/).\n\n## Installation\n\nTo use this gem, install via Bundler by adding the following to your application\'s `Gemfile`:\n\n\n\n```ruby\ngem "finch-api", "~> 0.0.1"\n```\n\n\n\n## Usage\n\n```ruby\nrequire "bundler/setup"\nrequire "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.directory.list\n\nputs(page.id)\n```\n\n\n\n### Pagination\n\nList methods in the Finch API are paginated.\n\nThis library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:\n\n```ruby\npage = finch.hris.directory.list\n\n# Fetch single item from page.\ndirectory = page.individuals[0]\nputs(directory.id)\n\n# Automatically fetches more pages as needed.\npage.auto_paging_each do |directory|\n puts(directory.id)\nend\n```\n\nAlternatively, you can use the `#next_page?` and `#next_page` methods for more granular control working with pages.\n\n```ruby\nif page.next_page?\n new_page = page.next_page\n puts(new_page.individuals[0].id)\nend\n```\n\n\n\n### Handling errors\n\nWhen the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `FinchAPI::Errors::APIError` will be thrown:\n\n```ruby\nbegin\n company = finch.hris.company.retrieve\nrescue FinchAPI::Errors::APIConnectionError => e\n puts("The server could not be reached")\n puts(e.cause) # an underlying Exception, likely raised within `net/http`\nrescue FinchAPI::Errors::RateLimitError => e\n puts("A 429 status code was received; we should back off a bit.")\nrescue FinchAPI::Errors::APIStatusError => e\n puts("Another non-200-range status code was received")\n puts(e.status)\nend\n```\n\nError codes are as follows:\n\n| Cause | Error Type |\n| ---------------- | -------------------------- |\n| HTTP 400 | `BadRequestError` |\n| HTTP 401 | `AuthenticationError` |\n| HTTP 403 | `PermissionDeniedError` |\n| HTTP 404 | `NotFoundError` |\n| HTTP 409 | `ConflictError` |\n| HTTP 422 | `UnprocessableEntityError` |\n| HTTP 429 | `RateLimitError` |\n| HTTP >= 500 | `InternalServerError` |\n| Other HTTP error | `APIStatusError` |\n| Timeout | `APITimeoutError` |\n| Network error | `APIConnectionError` |\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\n\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, >=500 Internal errors, and timeouts will all be retried by default.\n\nYou can use the `max_retries` option to configure or disable this:\n\n```ruby\n# Configure the default for all requests:\nfinch = FinchAPI::Client.new(\n max_retries: 0 # default is 2\n)\n\n# Or, configure per-request:\nfinch.hris.directory.list(request_options: {max_retries: 5})\n```\n\n### Timeouts\n\nBy default, requests will time out after 60 seconds. You can use the timeout option to configure or disable this:\n\n```ruby\n# Configure the default for all requests:\nfinch = FinchAPI::Client.new(\n timeout: nil # default is 60\n)\n\n# Or, configure per-request:\nfinch.hris.directory.list(request_options: {timeout: 5})\n```\n\nOn timeout, `FinchAPI::Errors::APITimeoutError` is raised.\n\nNote that requests that time out are retried by default.\n\n## Advanced concepts\n\n### BaseModel\n\nAll parameter and response objects inherit from `FinchAPI::Internal::Type::BaseModel`, which provides several conveniences, including:\n\n1. All fields, including unknown ones, are accessible with `obj[:prop]` syntax, and can be destructured with `obj => {prop: prop}` or pattern-matching syntax.\n\n2. Structural equivalence for equality; if two API calls return the same values, comparing the responses with == will return true.\n\n3. Both instances and the classes themselves can be pretty-printed.\n\n4. Helpers such as `#to_h`, `#deep_to_h`, `#to_json`, and `#to_yaml`.\n\n### Making custom or undocumented requests\n\n#### Undocumented properties\n\nYou can send undocumented parameters to any endpoint, and read undocumented response properties, like so:\n\nNote: the `extra_` parameters of the same name overrides the documented parameters.\n\n```ruby\npage =\n finch.hris.directory.list(\n request_options: {\n extra_query: {my_query_parameter: value},\n extra_body: {my_body_parameter: value},\n extra_headers: {"my-header": value}\n }\n )\n\nputs(page[:my_undocumented_property])\n```\n\n#### Undocumented request params\n\nIf you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request, as seen in the examples above.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints while retaining the benefit of auth, retries, and so on, you can make requests using `client.request`, like so:\n\n```ruby\nresponse = client.request(\n method: :post,\n path: \'/undocumented/endpoint\',\n query: {"dog": "woof"},\n headers: {"useful-header": "interesting-value"},\n body: {"hello": "world"}\n)\n```\n\n### Concurrency & connection pooling\n\nThe `FinchAPI::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.\n\nEach instance of `FinchAPI::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.\n\nWhen all available connections from the pool are checked out, requests wait for a new connection to become available, with queue time counting towards the request timeout.\n\nUnless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.\n\n## Sorbet\n\nThis library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitions, and has no dependency on sorbet-runtime.\n\nYou can provide typesafe request parameters like so:\n\n```ruby\nfinch.hris.directory.list \n```\n\nOr, equivalently:\n\n```ruby\n# Hashes work, but are not typesafe:\nfinch.hris.directory.list\n\n# You can also splat a full Params class:\nparams = FinchAPI::HRIS::DirectoryListParams.new\nfinch.hris.directory.list(**params)\n```\n\n### Enums\n\nSince this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:\n\n```ruby\n# :every_paycheck\nputs(FinchAPI::HRIS::BenefitFrequency::EVERY_PAYCHECK)\n\n# Revealed type: `T.all(FinchAPI::HRIS::BenefitFrequency, Symbol)`\nT.reveal_type(FinchAPI::HRIS::BenefitFrequency::EVERY_PAYCHECK)\n```\n\nEnum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:\n\n```ruby\n# Using the enum constants preserves the tagged type information:\nfinch.hris.benefits.create(\n frequency: FinchAPI::HRIS::BenefitFrequency::EVERY_PAYCHECK,\n # …\n)\n\n# Literal values are also permissible:\nfinch.hris.benefits.create(\n frequency: :every_paycheck,\n # …\n)\n```\n\n## Versioning\n\nThis package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time.\n\nThis package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` type definitions to be non-breaking changes.\n\n## Requirements\n\nRuby 3.2.0 or higher.\n\n## Contributing\n\nSee [the contributing documentation](https://github.com/Finch-API/finch-api-ruby/tree/main/CONTRIBUTING.md).\n', + '# Finch Python API library\n\n\n[![PyPI version](https://img.shields.io/pypi/v/finch-api.svg?label=pypi%20(stable))](https://pypi.org/project/finch-api/)\n\nThe Finch Python library provides convenient access to the Finch REST API from any Python 3.9+\napplication. The library includes type definitions for all request params and response fields,\nand offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).\n\n\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Documentation\n\nThe REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/). The full API of this library can be found in [api.md](api.md).\n\n## Installation\n\n```sh\n# install from PyPI\npip install finch-api\n```\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n```python\nfrom finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\n\npage = client.hris.directory.list()\nprint(page.individuals)\n```\n\n\n\n## Async usage\n\nSimply import `AsyncFinch` instead of `Finch` and use `await` with each API call:\n\n```python\nimport asyncio\nfrom finch import AsyncFinch\n\nclient = AsyncFinch(\n access_token="My Access Token",\n)\n\nasync def main() -> None:\n page = await client.hris.directory.list()\n print(page.individuals)\n\nasyncio.run(main())\n```\n\nFunctionality between the synchronous and asynchronous clients is otherwise identical.\n\n### With aiohttp\n\nBy default, the async client uses `httpx` for HTTP requests. However, for improved concurrency performance you may also use `aiohttp` as the HTTP backend.\n\nYou can enable this by installing `aiohttp`:\n\n```sh\n# install from PyPI\npip install finch-api[aiohttp]\n```\n\nThen you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:\n\n```python\nimport asyncio\nfrom finch import DefaultAioHttpClient\nfrom finch import AsyncFinch\n\nasync def main() -> None:\n async with AsyncFinch(\n access_token="My Access Token",\n http_client=DefaultAioHttpClient(),\n) as client:\n page = await client.hris.directory.list()\n print(page.individuals)\n\nasyncio.run(main())\n```\n\n\n\n## Using types\n\nNested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:\n\n- Serializing back into JSON, `model.to_json()`\n- Converting to a dictionary, `model.to_dict()`\n\nTyped requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.\n\n## Pagination\n\nList methods in the Finch API are paginated.\n\nThis library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:\n\n```python\nfrom finch import Finch\n\nclient = Finch()\n\nall_directories = []\n# Automatically fetches more pages as needed.\nfor directory in client.hris.directory.list():\n # Do something with directory here\n all_directories.append(directory)\nprint(all_directories)\n```\n\nOr, asynchronously:\n\n```python\nimport asyncio\nfrom finch import AsyncFinch\n\nclient = AsyncFinch()\n\nasync def main() -> None:\n all_directories = []\n # Iterate through items across all pages, issuing requests as needed.\n async for directory in client.hris.directory.list():\n all_directories.append(directory)\n print(all_directories)\n\nasyncio.run(main())\n```\n\nAlternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:\n\n```python\nfirst_page = await client.hris.directory.list()\nif first_page.has_next_page():\n print(f"will fetch next page using these details: {first_page.next_page_info()}")\n next_page = await first_page.get_next_page()\n print(f"number of items we just fetched: {len(next_page.individuals)}")\n\n# Remove `await` for non-async usage.\n```\n\nOr just work directly with the returned data:\n\n```python\nfirst_page = await client.hris.directory.list()\n\nprint(f"the current start offset for this page: {first_page.paging.offset}") # => "the current start offset for this page: 1"\nfor directory in first_page.individuals:\n print(directory.id)\n\n# Remove `await` for non-async usage.\n```\n\n\n\n\n\n## Handling errors\n\nWhen the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `finch.APIConnectionError` is raised.\n\nWhen the API returns a non-success status code (that is, 4xx or 5xx\nresponse), a subclass of `finch.APIStatusError` is raised, containing `status_code` and `response` properties.\n\nAll errors inherit from `finch.APIError`.\n\n```python\nimport finch\nfrom finch import Finch\n\nclient = Finch()\n\ntry:\n client.hris.company.retrieve()\nexcept finch.APIConnectionError as e:\n print("The server could not be reached")\n print(e.__cause__) # an underlying Exception, likely raised within httpx.\nexcept finch.RateLimitError as e:\n print("A 429 status code was received; we should back off a bit.")\nexcept finch.APIStatusError as e:\n print("Another non-200-range status code was received")\n print(e.status_code)\n print(e.response)\n```\n\nError codes are as follows:\n\n| Status Code | Error Type |\n| ----------- | -------------------------- |\n| 400 | `BadRequestError` |\n| 401 | `AuthenticationError` |\n| 403 | `PermissionDeniedError` |\n| 404 | `NotFoundError` |\n| 422 | `UnprocessableEntityError` |\n| 429 | `RateLimitError` |\n| >=500 | `InternalServerError` |\n| N/A | `APIConnectionError` |\n\n### Retries\n\nCertain errors are automatically retried 2 times by default, with a short exponential backoff.\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,\n429 Rate Limit, and >=500 Internal errors are all retried by default.\n\nYou can use the `max_retries` option to configure or disable retry settings:\n\n```python\nfrom finch import Finch\n\n# Configure the default for all requests:\nclient = Finch(\n # default is 2\n max_retries=0,\n)\n\n# Or, configure per-request:\nclient.with_options(max_retries = 5).hris.directory.list()\n```\n\n### Timeouts\n\nBy default requests time out after 1 minute. You can configure this with a `timeout` option,\nwhich accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object:\n\n```python\nfrom finch import Finch\n\n# Configure the default for all requests:\nclient = Finch(\n # 20 seconds (default is 1 minute)\n timeout=20.0,\n)\n\n# More granular control:\nclient = Finch(\n timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),\n)\n\n# Override per-request:\nclient.with_options(timeout = 5.0).hris.directory.list()\n```\n\nOn timeout, an `APITimeoutError` is thrown.\n\nNote that requests that time out are [retried twice by default](#retries).\n\n## Default Headers\n\nWe automatically send the `Finch-API-Version` header set to `2020-09-17`.\n\nIf you need to, you can override it by setting default headers per-request or on the client object.\n\nBe aware that doing so may result in incorrect types and other unexpected or undefined behavior in the SDK.\n\n```python\nfrom finch import Finch\n\nclient = Finch(\n default_headers={\n "Finch-API-Version": "My-Custom-Value"\n },\n)\n```\n\n## Advanced\n\n### Logging\n\nWe use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.\n\nYou can enable logging by setting the environment variable `FINCH_LOG` to `info`.\n\n```shell\n$ export FINCH_LOG=info\n```\n\nOr to `debug` for more verbose logging.\n\n### How to tell whether `None` means `null` or missing\n\nIn an API response, a field may be explicitly `null`, or missing entirely; in either case, its value is `None` in this library. You can differentiate the two cases with `.model_fields_set`:\n\n```py\nif response.my_field is None:\n if \'my_field\' not in response.model_fields_set:\n print(\'Got json like {}, without a "my_field" key present at all.\')\n else:\n print(\'Got json like {"my_field": null}.\')\n```\n\n### Accessing raw response data (e.g. headers)\n\nThe "raw" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,\n\n```py\nfrom finch import Finch\n\nclient = Finch()\nresponse = client.hris.directory.with_raw_response.list()\nprint(response.headers.get(\'X-My-Header\'))\n\ndirectory = response.parse() # get the object that `hris.directory.list()` would have returned\nprint(directory.id)\n```\n\nThese methods return a [`LegacyAPIResponse`](https://github.com/Finch-API/finch-api-python/tree/main/src/finch/_legacy_response.py) object. This is a legacy class as we\'re changing it slightly in the next major version.\n\nFor the sync client this will mostly be the same with the exception\nof `content` & `text` will be methods instead of properties. In the\nasync client, all methods will be async.\n\nA migration script will be provided & the migration in general should\nbe smooth.\n\n#### `.with_streaming_response`\n\nThe above interface eagerly reads the full response body when you make the request, which may not always be what you want.\n\nTo stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.\n\nAs such, `.with_streaming_response` methods return a different [`APIResponse`](https://github.com/Finch-API/finch-api-python/tree/main/src/finch/_response.py) object, and the async client returns an [`AsyncAPIResponse`](https://github.com/Finch-API/finch-api-python/tree/main/src/finch/_response.py) object.\n\n```python\nwith client.hris.directory.with_streaming_response.list() as response :\n print(response.headers.get(\'X-My-Header\'))\n\n for line in response.iter_lines():\n print(line)\n```\n\nThe context manager is required so that the response will reliably be closed.\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API.\n\nIf you need to access undocumented endpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can make requests using `client.get`, `client.post`, and other\nhttp verbs. Options on the client will be respected (such as retries) when making this request.\n\n```py\nimport httpx\n\nresponse = client.post(\n "/foo",\n cast_to=httpx.Response,\n body={"my_param": True},\n)\n\nprint(response.headers.get("x-foo"))\n```\n\n#### Undocumented request params\n\nIf you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request\noptions.\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You\ncan also get all the extra fields on the Pydantic model as a dict with\n[`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra).\n\n### Configuring the HTTP client\n\nYou can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including:\n\n- Support for [proxies](https://www.python-httpx.org/advanced/proxies/)\n- Custom [transports](https://www.python-httpx.org/advanced/transports/)\n- Additional [advanced](https://www.python-httpx.org/advanced/clients/) functionality\n\n```python\nimport httpx\nfrom finch import Finch, DefaultHttpxClient\n\nclient = Finch(\n # Or use the `FINCH_BASE_URL` env var\n base_url="http://my.test.server.example.com:8083",\n http_client=DefaultHttpxClient(proxy="http://my.test.proxy.example.com", transport=httpx.HTTPTransport(local_address="0.0.0.0")),\n)\n```\n\nYou can also customize the client on a per-request basis by using `with_options()`:\n\n```python\nclient.with_options(http_client=DefaultHttpxClient(...))\n```\n\n### Managing HTTP resources\n\nBy default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.\n\n```py\nfrom finch import Finch\n\nwith Finch() as client:\n # make requests here\n ...\n\n# HTTP client is now closed\n```\n\n## Versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes that only affect static types, without breaking runtime behavior.\n2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n3. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Finch-API/finch-api-python/issues) with questions, bugs, or suggestions.\n\n### Determining the installed version\n\nIf you\'ve upgraded to the latest version but aren\'t seeing any new features you were expecting then your python environment is likely still using an older version.\n\nYou can determine the version that is being used at runtime with:\n\n```py\nimport finch\nprint(finch.__version__)\n```\n\n## Requirements\n\nPython 3.9 or higher.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n', }, { - language: 'java', + language: 'ruby', content: - '# Finch Java API Library\n\n\n[![Maven Central](https://img.shields.io/maven-central/v/com.tryfinch.api/finch-java)](https://central.sonatype.com/artifact/com.tryfinch.api/finch-java/0.0.1)\n[![javadoc](https://javadoc.io/badge2/com.tryfinch.api/finch-java/0.0.1/javadoc.svg)](https://javadoc.io/doc/com.tryfinch.api/finch-java/0.0.1)\n\n\nThe Finch Java SDK provides convenient access to the [Finch REST API](https://developer.tryfinch.com/) from applications written in Java.\n\nThe Finch Java SDK is similar to the Finch Kotlin SDK but with minor differences that make it more ergonomic for use in Java, such as `Optional` instead of nullable values, `Stream` instead of `Sequence`, and `CompletableFuture` instead of suspend functions.\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n\n\nThe REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/). Javadocs are available on [javadoc.io](https://javadoc.io/doc/com.tryfinch.api/finch-java/0.0.1).\n\n\n\n## Installation\n\n\n\n### Gradle\n\n~~~kotlin\nimplementation("com.tryfinch.api:finch-java:0.0.1")\n~~~\n\n### Maven\n\n~~~xml\n\n com.tryfinch.api\n finch-java\n 0.0.1\n\n~~~\n\n\n\n## Requirements\n\nThis library requires Java 8 or later.\n\n## Usage\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisDirectoryListPage;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\nFinchClient client = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\nHrisDirectoryListPage page = client.hris().directory().list();\n```\n\n## Client configuration\n\nConfigure the client using system properties or environment variables:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n```\n\nOr manually:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n .accessToken("My Access Token")\n .build();\n```\n\nOr using a combination of the two approaches:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n```\n\nSee this table for the available options:\n\n| Setter | System property | Environment variable | Required | Default value |\n| --------------- | --------------------- | ---------------------- | -------- | ---------------------------- |\n| `clientId` | `finch.clientId` | `FINCH_CLIENT_ID` | false | - |\n| `clientSecret` | `finch.clientSecret` | `FINCH_CLIENT_SECRET` | false | - |\n| `webhookSecret` | `finch.webhookSecret` | `FINCH_WEBHOOK_SECRET` | false | - |\n| `baseUrl` | `finch.baseUrl` | `FINCH_BASE_URL` | true | `"https://api.tryfinch.com"` |\n\nSystem properties take precedence over environment variables.\n\n> [!TIP]\n> Don\'t create more than one client in the same application. Each client has a connection pool and\n> thread pools, which are more efficient to share between requests.\n\n### Modifying configuration\n\nTo temporarily use a modified client configuration, while reusing the same connection and thread pools, call `withOptions()` on any client or service:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\n\nFinchClient clientWithOptions = client.withOptions(optionsBuilder -> {\n optionsBuilder.baseUrl("https://example.com");\n optionsBuilder.maxRetries(42);\n});\n```\n\nThe `withOptions()` method does not affect the original client or service.\n\n## Requests and responses\n\nTo send a request to the Finch API, build an instance of some `Params` class and pass it to the corresponding client method. When the response is received, it will be deserialized into an instance of a Java class.\n\nFor example, `client.hris().directory().list(...)` should be called with an instance of `HrisDirectoryListParams`, and it will return an instance of `HrisDirectoryListPage`.\n\n## Immutability\n\nEach class in the SDK has an associated [builder](https://blogs.oracle.com/javamagazine/post/exploring-joshua-blochs-builder-design-pattern-in-java) or factory method for constructing it.\n\nEach class is [immutable](https://docs.oracle.com/javase/tutorial/essential/concurrency/immutable.html) once constructed. If the class has an associated builder, then it has a `toBuilder()` method, which can be used to convert it back to a builder for making a modified copy.\n\nBecause each class is immutable, builder modification will _never_ affect already built class instances.\n\n## Asynchronous execution\n\nThe default client is synchronous. To switch to asynchronous execution, call the `async()` method:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\nimport java.util.concurrent.CompletableFuture;\n\nFinchClient client = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\nCompletableFuture page = client.async().hris().directory().list();\n```\n\nOr create an asynchronous client from the beginning:\n\n```java\nimport com.tryfinch.api.client.FinchClientAsync;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClientAsync;\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\nimport java.util.concurrent.CompletableFuture;\n\nFinchClientAsync client = FinchOkHttpClientAsync.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\nCompletableFuture page = client.hris().directory().list();\n```\n\nThe asynchronous client supports the same options as the synchronous one, except most methods return `CompletableFuture`s.\n\n\n\n\n\n\n\n## Raw responses\n\nThe SDK defines methods that deserialize responses into instances of Java classes. However, these methods don\'t provide access to the response headers, status code, or the raw response body.\n\nTo access this data, prefix any HTTP method call on a client or service with `withRawResponse()`:\n\n```java\nimport com.tryfinch.api.core.http.Headers;\nimport com.tryfinch.api.core.http.HttpResponseFor;\nimport com.tryfinch.api.models.HrisDirectoryListPage;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\nHttpResponseFor page = client.hris().directory().withRawResponse().list();\n\nint statusCode = page.statusCode();\nHeaders headers = page.headers();\n```\n\nYou can still deserialize the response into an instance of a Java class if needed:\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListPage;\n\nHrisDirectoryListPage parsedPage = page.parse();\n```\n\n## Error handling\n\nThe SDK throws custom unchecked exception types:\n\n- [`FinchServiceException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchServiceException.kt): Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:\n\n | Status | Exception |\n | ------ | -------------------------------------------------- |\n | 400 | [`BadRequestException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/BadRequestException.kt) |\n | 401 | [`UnauthorizedException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/UnauthorizedException.kt) |\n | 403 | [`PermissionDeniedException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/PermissionDeniedException.kt) |\n | 404 | [`NotFoundException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/NotFoundException.kt) |\n | 422 | [`UnprocessableEntityException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/UnprocessableEntityException.kt) |\n | 429 | [`RateLimitException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/RateLimitException.kt) |\n | 5xx | [`InternalServerException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/InternalServerException.kt) |\n | others | [`UnexpectedStatusCodeException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/UnexpectedStatusCodeException.kt) |\n\n- [`FinchIoException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchIoException.kt): I/O networking errors.\n\n- [`FinchRetryableException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchRetryableException.kt): Generic error indicating a failure that could be retried by the client.\n\n- [`FinchInvalidDataException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchInvalidDataException.kt): Failure to interpret successfully parsed data. For example, when accessing a property that\'s supposed to be required, but the API unexpectedly omitted it from the response.\n\n- [`FinchException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchException.kt): Base class for all exceptions. Most errors will result in one of the previously mentioned ones, but completely generic errors may be thrown using the base class.\n\n## Pagination\n\nThe SDK defines methods that return a paginated lists of results. It provides convenient ways to access the results either one page at a time or item-by-item across all pages.\n\n### Auto-pagination\n\nTo iterate through all results across all pages, use the `autoPager()` method, which automatically fetches more pages as needed.\n\nWhen using the synchronous client, the method returns an [`Iterable`](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html)\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListPage;\nimport com.tryfinch.api.models.IndividualInDirectory;\n\nHrisDirectoryListPage page = client.hris().directory().list();\n\n// Process as an Iterable\nfor (IndividualInDirectory directory : page.autoPager()) {\n System.out.println(directory);\n}\n\n// Process as a Stream\npage.autoPager()\n .stream()\n .limit(50)\n .forEach(directory -> System.out.println(directory));\n```\n\nWhen using the asynchronous client, the method returns an [`AsyncStreamResponse`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/http/AsyncStreamResponse.kt):\n\n```java\nimport com.tryfinch.api.core.http.AsyncStreamResponse;\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync;\nimport com.tryfinch.api.models.IndividualInDirectory;\nimport java.util.Optional;\nimport java.util.concurrent.CompletableFuture;\n\nCompletableFuture pageFuture = client.async().hris().directory().list();\n\npageFuture.thenRun(page -> page.autoPager().subscribe(directory -> {\n System.out.println(directory);\n}));\n\n// If you need to handle errors or completion of the stream\npageFuture.thenRun(page -> page.autoPager().subscribe(new AsyncStreamResponse.Handler<>() {\n @Override\n public void onNext(IndividualInDirectory directory) {\n System.out.println(directory);\n }\n\n @Override\n public void onComplete(Optional error) {\n if (error.isPresent()) {\n System.out.println("Something went wrong!");\n throw new RuntimeException(error.get());\n } else {\n System.out.println("No more!");\n }\n }\n}));\n\n// Or use futures\npageFuture.thenRun(page -> page.autoPager()\n .subscribe(directory -> {\n System.out.println(directory);\n })\n .onCompleteFuture()\n .whenComplete((unused, error) -> {\n if (error != null) {\n System.out.println("Something went wrong!");\n throw new RuntimeException(error);\n } else {\n System.out.println("No more!");\n }\n }));\n```\n\n### Manual pagination\n\nTo access individual page items and manually request the next page, use the `items()`,\n`hasNextPage()`, and `nextPage()` methods:\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListPage;\nimport com.tryfinch.api.models.IndividualInDirectory;\n\nHrisDirectoryListPage page = client.hris().directory().list();\nwhile (true) {\n for (IndividualInDirectory directory : page.items()) {\n System.out.println(directory);\n }\n\n if (!page.hasNextPage()) {\n break;\n }\n\n page = page.nextPage();\n}\n```\n\n## Logging\n\nThe SDK uses the standard [OkHttp logging interceptor](https://github.com/square/okhttp/tree/master/okhttp-logging-interceptor).\n\nEnable logging by setting the `FINCH_LOG` environment variable to `info`:\n\n```sh\nexport FINCH_LOG=info\n```\n\nOr to `debug` for more verbose logging:\n\n```sh\nexport FINCH_LOG=debug\n```\n\n## ProGuard and R8\n\nAlthough the SDK uses reflection, it is still usable with [ProGuard](https://github.com/Guardsquare/proguard) and [R8](https://developer.android.com/topic/performance/app-optimization/enable-app-optimization) because `finch-java-core` is published with a [configuration file](finch-java-core/src/main/resources/META-INF/proguard/finch-java-core.pro) containing [keep rules](https://www.guardsquare.com/manual/configuration/usage).\n\nProGuard and R8 should automatically detect and use the published rules, but you can also manually copy the keep rules if necessary.\n\n\n\n\n\n## Jackson\n\nThe SDK depends on [Jackson](https://github.com/FasterXML/jackson) for JSON serialization/deserialization. It is compatible with version 2.13.4 or higher, but depends on version 2.18.2 by default.\n\nThe SDK throws an exception if it detects an incompatible Jackson version at runtime (e.g. if the default version was overridden in your Maven or Gradle config).\n\nIf the SDK threw an exception, but you\'re _certain_ the version is compatible, then disable the version check using the `checkJacksonVersionCompatibility` on [`FinchOkHttpClient`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt).\n\n> [!CAUTION]\n> We make no guarantee that the SDK works correctly when the Jackson version check is disabled.\n\nAlso note that there are bugs in older Jackson versions that can affect the SDK. We don\'t work around all Jackson bugs ([example](https://github.com/FasterXML/jackson-databind/issues/3240)) and expect users to upgrade Jackson for those instead.\n\n## Network options\n\n### Retries\n\nThe SDK automatically retries 2 times by default, with a short exponential backoff between requests.\n\nOnly the following error types are retried:\n- Connection errors (for example, due to a network connectivity problem)\n- 408 Request Timeout\n- 409 Conflict\n- 429 Rate Limit\n- 5xx Internal\n\nThe API may also explicitly instruct the SDK to retry or not retry a request.\n\nTo set a custom number of retries, configure the client using the `maxRetries` method:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .maxRetries(4)\n .accessToken("My Access Token")\n .build();\n```\n\n### Timeouts\n\nRequests time out after 1 minute by default.\n\nTo set a custom timeout, configure the method call using the `timeout` method:\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListPage;\n\nHrisDirectoryListPage page = client.hris().directory().list(RequestOptions.builder().timeout(Duration.ofSeconds(30)).build());\n```\n\nOr configure the default for all method calls at the client level:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport java.time.Duration;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .timeout(Duration.ofSeconds(30))\n .accessToken("My Access Token")\n .build();\n```\n\n### Proxies\n\nTo route requests through a proxy, configure the client using the `proxy` method:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport java.net.InetSocketAddress;\nimport java.net.Proxy;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .proxy(new Proxy(\n Proxy.Type.HTTP, new InetSocketAddress(\n "https://example.com", 8080\n )\n ))\n .accessToken("My Access Token")\n .build();\n```\n\n### Connection pooling\n\nTo customize the underlying OkHttp connection pool, configure the client using the `maxIdleConnections` and `keepAliveDuration` methods:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport java.time.Duration;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n // If `maxIdleConnections` is set, then `keepAliveDuration` must be set, and vice versa.\n .maxIdleConnections(10)\n .keepAliveDuration(Duration.ofMinutes(2))\n .accessToken("My Access Token")\n .build();\n```\n\nIf both options are unset, OkHttp\'s default connection pool settings are used.\n\n### HTTPS\n\n> [!NOTE]\n> Most applications should not call these methods, and instead use the system defaults. The defaults include\n> special optimizations that can be lost if the implementations are modified.\n\nTo configure how HTTPS connections are secured, configure the client using the `sslSocketFactory`, `trustManager`, and `hostnameVerifier` methods:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n // If `sslSocketFactory` is set, then `trustManager` must be set, and vice versa.\n .sslSocketFactory(yourSSLSocketFactory)\n .trustManager(yourTrustManager)\n .hostnameVerifier(yourHostnameVerifier)\n .accessToken("My Access Token")\n .build();\n```\n\n\n\n### Custom HTTP client\n\nThe SDK consists of three artifacts:\n- `finch-java-core`\n - Contains core SDK logic\n - Does not depend on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`FinchClient`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClient.kt), [`FinchClientAsync`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsync.kt), [`FinchClientImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt), and [`FinchClientAsyncImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), all of which can work with any HTTP client\n- `finch-java-client-okhttp`\n - Depends on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`FinchOkHttpClient`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) and [`FinchOkHttpClientAsync`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), which provide a way to construct [`FinchClientImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) and [`FinchClientAsyncImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), respectively, using OkHttp\n- `finch-java`\n - Depends on and exposes the APIs of both `finch-java-core` and `finch-java-client-okhttp`\n - Does not have its own logic\n\nThis structure allows replacing the SDK\'s default HTTP client without pulling in unnecessary dependencies.\n\n#### Customized [`OkHttpClient`](https://square.github.io/okhttp/3.x/okhttp/okhttp3/OkHttpClient.html)\n\n> [!TIP]\n> Try the available [network options](#network-options) before replacing the default client.\n\nTo use a customized `OkHttpClient`:\n\n1. Replace your [`finch-java` dependency](#installation) with `finch-java-core`\n2. Copy `finch-java-client-okhttp`\'s [`OkHttpClient`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/OkHttpClient.kt) class into your code and customize it\n3. Construct [`FinchClientImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) or [`FinchClientAsyncImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), similarly to [`FinchOkHttpClient`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), using your customized client\n\n### Completely custom HTTP client\n\nTo use a completely custom HTTP client:\n\n1. Replace your [`finch-java` dependency](#installation) with `finch-java-core`\n2. Write a class that implements the [`HttpClient`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/http/HttpClient.kt) interface\n3. Construct [`FinchClientImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) or [`FinchClientAsyncImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), similarly to [`FinchOkHttpClient`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), using your new client class\n\n## Undocumented API functionality\n\nThe SDK is typed for convenient usage of the documented API. However, it also supports working with undocumented or not yet supported parts of the API.\n\n### Parameters\n\nTo set undocumented parameters, call the `putAdditionalHeader`, `putAdditionalQueryParam`, or `putAdditionalBodyProperty` methods on any `Params` class:\n\n```java\nimport com.tryfinch.api.core.JsonValue;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\nHrisDirectoryListParams params = HrisDirectoryListParams.builder()\n .putAdditionalHeader("Secret-Header", "42")\n .putAdditionalQueryParam("secret_query_param", "42")\n .putAdditionalBodyProperty("secretProperty", JsonValue.from("42"))\n .build();\n```\n\nThese can be accessed on the built object later using the `_additionalHeaders()`, `_additionalQueryParams()`, and `_additionalBodyProperties()` methods.\n\nTo set a documented parameter or property to an undocumented or not yet supported _value_, pass a [`JsonValue`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/Values.kt) object to its setter:\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\nHrisDirectoryListParams params = HrisDirectoryListParams.builder().build();\n```\n\nThe most straightforward way to create a [`JsonValue`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/Values.kt) is using its `from(...)` method:\n\n```java\nimport com.tryfinch.api.core.JsonValue;\nimport java.util.List;\nimport java.util.Map;\n\n// Create primitive JSON values\nJsonValue nullValue = JsonValue.from(null);\nJsonValue booleanValue = JsonValue.from(true);\nJsonValue numberValue = JsonValue.from(42);\nJsonValue stringValue = JsonValue.from("Hello World!");\n\n// Create a JSON array value equivalent to `["Hello", "World"]`\nJsonValue arrayValue = JsonValue.from(List.of(\n "Hello", "World"\n));\n\n// Create a JSON object value equivalent to `{ "a": 1, "b": 2 }`\nJsonValue objectValue = JsonValue.from(Map.of(\n "a", 1,\n "b", 2\n));\n\n// Create an arbitrarily nested JSON equivalent to:\n// {\n// "a": [1, 2],\n// "b": [3, 4]\n// }\nJsonValue complexValue = JsonValue.from(Map.of(\n "a", List.of(\n 1, 2\n ),\n "b", List.of(\n 3, 4\n )\n));\n```\n\nNormally a `Builder` class\'s `build` method will throw [`IllegalStateException`](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) if any required parameter or property is unset.\n\nTo forcibly omit a required parameter or property, pass [`JsonMissing`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/Values.kt):\n\n```java\nimport com.tryfinch.api.core.JsonMissing;\nimport com.tryfinch.api.models.AccessTokenCreateParams;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\nHrisDirectoryListParams params = AccessTokenCreateParams.builder()\n .code(JsonMissing.of())\n .build();\n```\n\n### Response properties\n\nTo access undocumented response properties, call the `_additionalProperties()` method:\n\n```java\nimport com.tryfinch.api.core.JsonValue;\nimport java.util.Map;\n\nMap additionalProperties = client.accessTokens().create(params)._additionalProperties();\nJsonValue secretPropertyValue = additionalProperties.get("secretProperty");\n\nString result = secretPropertyValue.accept(new JsonValue.Visitor<>() {\n @Override\n public String visitNull() {\n return "It\'s null!";\n }\n\n @Override\n public String visitBoolean(boolean value) {\n return "It\'s a boolean!";\n }\n\n @Override\n public String visitNumber(Number value) {\n return "It\'s a number!";\n }\n\n // Other methods include `visitMissing`, `visitString`, `visitArray`, and `visitObject`\n // The default implementation of each unimplemented method delegates to `visitDefault`, which throws by default, but can also be overridden\n});\n```\n\nTo access a property\'s raw JSON value, which may be undocumented, call its `_` prefixed method:\n\n```java\nimport com.tryfinch.api.core.JsonField;\nimport java.util.Optional;\n\nJsonField code = client.accessTokens().create(params)._code();\n\nif (code.isMissing()) {\n // The property is absent from the JSON response\n} else if (code.isNull()) {\n // The property was set to literal null\n} else {\n // Check if value was provided as a string\n // Other methods include `asNumber()`, `asBoolean()`, etc.\n Optional jsonString = code.asString();\n\n // Try to deserialize into a custom type\n MyClass myObject = code.asUnknown().orElseThrow().convert(MyClass.class);\n}\n```\n\n### Response validation\n\nIn rare cases, the API may return a response that doesn\'t match the expected type. For example, the SDK may expect a property to contain a `String`, but the API could return something else.\n\nBy default, the SDK will not throw an exception in this case. It will throw [`FinchInvalidDataException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchInvalidDataException.kt) only if you directly access the property.\n\nIf you would prefer to check that the response is completely well-typed upfront, then either call `validate()`:\n\n```java\nimport com.tryfinch.api.models.CreateAccessTokenResponse;\n\nCreateAccessTokenResponse createAccessTokenResponse = client.accessTokens().create(params).validate();\n```\n\nOr configure the method call to validate the response using the `responseValidation` method:\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListPage;\n\nHrisDirectoryListPage page = client.hris().directory().list(RequestOptions.builder().responseValidation(true).build());\n```\n\nOr configure the default for all method calls at the client level:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .responseValidation(true)\n .accessToken("My Access Token")\n .build();\n```\n\n## FAQ\n\n### Why don\'t you use plain `enum` classes?\n\nJava `enum` classes are not trivially [forwards compatible](https://www.stainless.com/blog/making-java-enums-forwards-compatible). Using them in the SDK could cause runtime exceptions if the API is updated to respond with a new enum value.\n\n### Why do you represent fields using `JsonField` instead of just plain `T`?\n\nUsing `JsonField` enables a few features:\n\n- Allowing usage of [undocumented API functionality](#undocumented-api-functionality)\n- Lazily [validating the API response against the expected shape](#response-validation)\n- Representing absent vs explicitly null values\n\n### Why don\'t you use [`data` classes](https://kotlinlang.org/docs/data-classes.html)?\n\nIt is not [backwards compatible to add new fields to a data class](https://kotlinlang.org/docs/api-guidelines-backward-compatibility.html#avoid-using-data-classes-in-your-api) and we don\'t want to introduce a breaking change every time we add a field to a class.\n\n### Why don\'t you use checked exceptions?\n\nChecked exceptions are widely considered a mistake in the Java programming language. In fact, they were omitted from Kotlin for this reason.\n\nChecked exceptions:\n\n- Are verbose to handle\n- Encourage error handling at the wrong level of abstraction, where nothing can be done about the error\n- Are tedious to propagate due to the [function coloring problem](https://journal.stuffwithstuff.com/2015/02/01/what-color-is-your-function)\n- Don\'t play well with lambdas (also due to the function coloring problem)\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n2. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Finch-API/finch-api-java/issues) with questions, bugs, or suggestions.\n', + '# Finch Ruby API library\n\nThe Finch Ruby library provides convenient access to the Finch REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/Finch-API/finch-api-ruby#Sorbet) for usage with Sorbet. The standard library\'s `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.\n\n\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Documentation\n\nDocumentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/finch-api).\n\nThe REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/).\n\n## Installation\n\nTo use this gem, install via Bundler by adding the following to your application\'s `Gemfile`:\n\n\n\n```ruby\ngem "finch-api", "~> 0.0.1"\n```\n\n\n\n## Usage\n\n```ruby\nrequire "bundler/setup"\nrequire "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.directory.list\n\nputs(page.id)\n```\n\n\n\n### Pagination\n\nList methods in the Finch API are paginated.\n\nThis library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:\n\n```ruby\npage = finch.hris.directory.list\n\n# Fetch single item from page.\ndirectory = page.individuals[0]\nputs(directory.id)\n\n# Automatically fetches more pages as needed.\npage.auto_paging_each do |directory|\n puts(directory.id)\nend\n```\n\nAlternatively, you can use the `#next_page?` and `#next_page` methods for more granular control working with pages.\n\n```ruby\nif page.next_page?\n new_page = page.next_page\n puts(new_page.individuals[0].id)\nend\n```\n\n\n\n### Handling errors\n\nWhen the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `FinchAPI::Errors::APIError` will be thrown:\n\n```ruby\nbegin\n company = finch.hris.company.retrieve\nrescue FinchAPI::Errors::APIConnectionError => e\n puts("The server could not be reached")\n puts(e.cause) # an underlying Exception, likely raised within `net/http`\nrescue FinchAPI::Errors::RateLimitError => e\n puts("A 429 status code was received; we should back off a bit.")\nrescue FinchAPI::Errors::APIStatusError => e\n puts("Another non-200-range status code was received")\n puts(e.status)\nend\n```\n\nError codes are as follows:\n\n| Cause | Error Type |\n| ---------------- | -------------------------- |\n| HTTP 400 | `BadRequestError` |\n| HTTP 401 | `AuthenticationError` |\n| HTTP 403 | `PermissionDeniedError` |\n| HTTP 404 | `NotFoundError` |\n| HTTP 409 | `ConflictError` |\n| HTTP 422 | `UnprocessableEntityError` |\n| HTTP 429 | `RateLimitError` |\n| HTTP >= 500 | `InternalServerError` |\n| Other HTTP error | `APIStatusError` |\n| Timeout | `APITimeoutError` |\n| Network error | `APIConnectionError` |\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\n\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, >=500 Internal errors, and timeouts will all be retried by default.\n\nYou can use the `max_retries` option to configure or disable this:\n\n```ruby\n# Configure the default for all requests:\nfinch = FinchAPI::Client.new(\n max_retries: 0 # default is 2\n)\n\n# Or, configure per-request:\nfinch.hris.directory.list(request_options: {max_retries: 5})\n```\n\n### Timeouts\n\nBy default, requests will time out after 60 seconds. You can use the timeout option to configure or disable this:\n\n```ruby\n# Configure the default for all requests:\nfinch = FinchAPI::Client.new(\n timeout: nil # default is 60\n)\n\n# Or, configure per-request:\nfinch.hris.directory.list(request_options: {timeout: 5})\n```\n\nOn timeout, `FinchAPI::Errors::APITimeoutError` is raised.\n\nNote that requests that time out are retried by default.\n\n## Advanced concepts\n\n### BaseModel\n\nAll parameter and response objects inherit from `FinchAPI::Internal::Type::BaseModel`, which provides several conveniences, including:\n\n1. All fields, including unknown ones, are accessible with `obj[:prop]` syntax, and can be destructured with `obj => {prop: prop}` or pattern-matching syntax.\n\n2. Structural equivalence for equality; if two API calls return the same values, comparing the responses with == will return true.\n\n3. Both instances and the classes themselves can be pretty-printed.\n\n4. Helpers such as `#to_h`, `#deep_to_h`, `#to_json`, and `#to_yaml`.\n\n### Making custom or undocumented requests\n\n#### Undocumented properties\n\nYou can send undocumented parameters to any endpoint, and read undocumented response properties, like so:\n\nNote: the `extra_` parameters of the same name overrides the documented parameters.\n\n```ruby\npage =\n finch.hris.directory.list(\n request_options: {\n extra_query: {my_query_parameter: value},\n extra_body: {my_body_parameter: value},\n extra_headers: {"my-header": value}\n }\n )\n\nputs(page[:my_undocumented_property])\n```\n\n#### Undocumented request params\n\nIf you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request, as seen in the examples above.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints while retaining the benefit of auth, retries, and so on, you can make requests using `client.request`, like so:\n\n```ruby\nresponse = client.request(\n method: :post,\n path: \'/undocumented/endpoint\',\n query: {"dog": "woof"},\n headers: {"useful-header": "interesting-value"},\n body: {"hello": "world"}\n)\n```\n\n### Concurrency & connection pooling\n\nThe `FinchAPI::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.\n\nEach instance of `FinchAPI::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.\n\nWhen all available connections from the pool are checked out, requests wait for a new connection to become available, with queue time counting towards the request timeout.\n\nUnless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.\n\n## Sorbet\n\nThis library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitions, and has no dependency on sorbet-runtime.\n\nYou can provide typesafe request parameters like so:\n\n```ruby\nfinch.hris.directory.list \n```\n\nOr, equivalently:\n\n```ruby\n# Hashes work, but are not typesafe:\nfinch.hris.directory.list\n\n# You can also splat a full Params class:\nparams = FinchAPI::HRIS::DirectoryListParams.new\nfinch.hris.directory.list(**params)\n```\n\n### Enums\n\nSince this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:\n\n```ruby\n# :every_paycheck\nputs(FinchAPI::HRIS::BenefitFrequency::EVERY_PAYCHECK)\n\n# Revealed type: `T.all(FinchAPI::HRIS::BenefitFrequency, Symbol)`\nT.reveal_type(FinchAPI::HRIS::BenefitFrequency::EVERY_PAYCHECK)\n```\n\nEnum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:\n\n```ruby\n# Using the enum constants preserves the tagged type information:\nfinch.hris.benefits.create(\n frequency: FinchAPI::HRIS::BenefitFrequency::EVERY_PAYCHECK,\n # …\n)\n\n# Literal values are also permissible:\nfinch.hris.benefits.create(\n frequency: :every_paycheck,\n # …\n)\n```\n\n## Versioning\n\nThis package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time.\n\nThis package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` type definitions to be non-breaking changes.\n\n## Requirements\n\nRuby 3.2.0 or higher.\n\n## Contributing\n\nSee [the contributing documentation](https://github.com/Finch-API/finch-api-ruby/tree/main/CONTRIBUTING.md).\n', }, { - language: 'kotlin', + language: 'typescript', content: - '# Finch Kotlin API Library\n\n\n[![Maven Central](https://img.shields.io/maven-central/v/com.tryfinch.api/finch-kotlin)](https://central.sonatype.com/artifact/com.tryfinch.api/finch-kotlin/0.0.1)\n[![javadoc](https://javadoc.io/badge2/com.tryfinch.api/finch-kotlin/0.0.1/javadoc.svg)](https://javadoc.io/doc/com.tryfinch.api/finch-kotlin/0.0.1)\n\n\nThe Finch Kotlin SDK provides convenient access to the [Finch REST API](https://developer.tryfinch.com/) from applications written in Kotlin.\n\nThe Finch Kotlin SDK is similar to the Finch Java SDK but with minor differences that make it more ergonomic for use in Kotlin, such as nullable values instead of `Optional`, `Sequence` instead of `Stream`, and suspend functions instead of `CompletableFuture`.\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n\n\nThe REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/). KDocs are available on [javadoc.io](https://javadoc.io/doc/com.tryfinch.api/finch-kotlin/0.0.1).\n\n\n\n## Installation\n\n\n\n### Gradle\n\n~~~kotlin\nimplementation("com.tryfinch.api:finch-kotlin:0.0.1")\n~~~\n\n### Maven\n\n~~~xml\n\n com.tryfinch.api\n finch-kotlin\n 0.0.1\n\n~~~\n\n\n\n## Requirements\n\nThis library requires Java 8 or later.\n\n## Usage\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisDirectoryListPage\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval client: FinchClient = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\nval page: HrisDirectoryListPage = client.hris().directory().list()\n```\n\n## Client configuration\n\nConfigure the client using system properties or environment variables:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n```\n\nOr manually:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .accessToken("My Access Token")\n .build()\n```\n\nOr using a combination of the two approaches:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n```\n\nSee this table for the available options:\n\n| Setter | System property | Environment variable | Required | Default value |\n| --------------- | --------------------- | ---------------------- | -------- | ---------------------------- |\n| `clientId` | `finch.clientId` | `FINCH_CLIENT_ID` | false | - |\n| `clientSecret` | `finch.clientSecret` | `FINCH_CLIENT_SECRET` | false | - |\n| `webhookSecret` | `finch.webhookSecret` | `FINCH_WEBHOOK_SECRET` | false | - |\n| `baseUrl` | `finch.baseUrl` | `FINCH_BASE_URL` | true | `"https://api.tryfinch.com"` |\n\nSystem properties take precedence over environment variables.\n\n> [!TIP]\n> Don\'t create more than one client in the same application. Each client has a connection pool and\n> thread pools, which are more efficient to share between requests.\n\n### Modifying configuration\n\nTo temporarily use a modified client configuration, while reusing the same connection and thread pools, call `withOptions()` on any client or service:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\n\nval clientWithOptions: FinchClient = client.withOptions {\n it.baseUrl("https://example.com")\n it.maxRetries(42)\n}\n```\n\nThe `withOptions()` method does not affect the original client or service.\n\n## Requests and responses\n\nTo send a request to the Finch API, build an instance of some `Params` class and pass it to the corresponding client method. When the response is received, it will be deserialized into an instance of a Kotlin class.\n\nFor example, `client.hris().directory().list(...)` should be called with an instance of `HrisDirectoryListParams`, and it will return an instance of `HrisDirectoryListPage`.\n\n## Immutability\n\nEach class in the SDK has an associated [builder](https://blogs.oracle.com/javamagazine/post/exploring-joshua-blochs-builder-design-pattern-in-java) or factory method for constructing it.\n\nEach class is [immutable](https://docs.oracle.com/javase/tutorial/essential/concurrency/immutable.html) once constructed. If the class has an associated builder, then it has a `toBuilder()` method, which can be used to convert it back to a builder for making a modified copy.\n\nBecause each class is immutable, builder modification will _never_ affect already built class instances.\n\n## Asynchronous execution\n\nThe default client is synchronous. To switch to asynchronous execution, call the `async()` method:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval client: FinchClient = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\nval page: HrisDirectoryListPageAsync = client.async().hris().directory().list()\n```\n\nOr create an asynchronous client from the beginning:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClientAsync\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClientAsync\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval client: FinchClientAsync = FinchOkHttpClientAsync.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\nval page: HrisDirectoryListPageAsync = client.hris().directory().list()\n```\n\nThe asynchronous client supports the same options as the synchronous one, except most methods are [suspending](https://kotlinlang.org/docs/coroutines-guide.html).\n\n\n\n\n\n\n\n## Raw responses\n\nThe SDK defines methods that deserialize responses into instances of Kotlin classes. However, these methods don\'t provide access to the response headers, status code, or the raw response body.\n\nTo access this data, prefix any HTTP method call on a client or service with `withRawResponse()`:\n\n```kotlin\nimport com.tryfinch.api.core.http.Headers\nimport com.tryfinch.api.core.http.HttpResponseFor\nimport com.tryfinch.api.models.HrisDirectoryListPage\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval page: HttpResponseFor = client.hris().directory().withRawResponse().list()\n\nval statusCode: Int = page.statusCode()\nval headers: Headers = page.headers()\n```\n\nYou can still deserialize the response into an instance of a Kotlin class if needed:\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPage\n\nval parsedPage: HrisDirectoryListPage = page.parse()\n```\n\n## Error handling\n\nThe SDK throws custom unchecked exception types:\n\n- [`FinchServiceException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchServiceException.kt): Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:\n\n | Status | Exception |\n | ------ | -------------------------------------------------- |\n | 400 | [`BadRequestException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/BadRequestException.kt) |\n | 401 | [`UnauthorizedException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/UnauthorizedException.kt) |\n | 403 | [`PermissionDeniedException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/PermissionDeniedException.kt) |\n | 404 | [`NotFoundException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/NotFoundException.kt) |\n | 422 | [`UnprocessableEntityException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/UnprocessableEntityException.kt) |\n | 429 | [`RateLimitException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/RateLimitException.kt) |\n | 5xx | [`InternalServerException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/InternalServerException.kt) |\n | others | [`UnexpectedStatusCodeException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/UnexpectedStatusCodeException.kt) |\n\n- [`FinchIoException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchIoException.kt): I/O networking errors.\n\n- [`FinchRetryableException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchRetryableException.kt): Generic error indicating a failure that could be retried by the client.\n\n- [`FinchInvalidDataException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchInvalidDataException.kt): Failure to interpret successfully parsed data. For example, when accessing a property that\'s supposed to be required, but the API unexpectedly omitted it from the response.\n\n- [`FinchException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchException.kt): Base class for all exceptions. Most errors will result in one of the previously mentioned ones, but completely generic errors may be thrown using the base class.\n\n## Pagination\n\nThe SDK defines methods that return a paginated lists of results. It provides convenient ways to access the results either one page at a time or item-by-item across all pages.\n\n### Auto-pagination\n\nTo iterate through all results across all pages, use the `autoPager()` method, which automatically fetches more pages as needed.\n\nWhen using the synchronous client, the method returns a [`Sequence`](https://kotlinlang.org/docs/sequences.html)\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPage\n\nval page: HrisDirectoryListPage = client.hris().directory().list()\npage.autoPager()\n .take(50)\n .forEach { directory -> println(directory) }\n```\n\nWhen using the asynchronous client, the method returns a [`Flow`](https://kotlinlang.org/docs/flow.html):\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync\n\nval page: HrisDirectoryListPageAsync = client.async().hris().directory().list()\npage.autoPager()\n .take(50)\n .forEach { directory -> println(directory) }\n```\n\n### Manual pagination\n\nTo access individual page items and manually request the next page, use the `items()`,\n`hasNextPage()`, and `nextPage()` methods:\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPage\nimport com.tryfinch.api.models.IndividualInDirectory\n\nval page: HrisDirectoryListPage = client.hris().directory().list()\nwhile (true) {\n for (directory in page.items()) {\n println(directory)\n }\n\n if (!page.hasNextPage()) {\n break\n }\n\n page = page.nextPage()\n}\n```\n\n## Logging\n\nThe SDK uses the standard [OkHttp logging interceptor](https://github.com/square/okhttp/tree/master/okhttp-logging-interceptor).\n\nEnable logging by setting the `FINCH_LOG` environment variable to `info`:\n\n```sh\nexport FINCH_LOG=info\n```\n\nOr to `debug` for more verbose logging:\n\n```sh\nexport FINCH_LOG=debug\n```\n\n## ProGuard and R8\n\nAlthough the SDK uses reflection, it is still usable with [ProGuard](https://github.com/Guardsquare/proguard) and [R8](https://developer.android.com/topic/performance/app-optimization/enable-app-optimization) because `finch-kotlin-core` is published with a [configuration file](finch-kotlin-core/src/main/resources/META-INF/proguard/finch-kotlin-core.pro) containing [keep rules](https://www.guardsquare.com/manual/configuration/usage).\n\nProGuard and R8 should automatically detect and use the published rules, but you can also manually copy the keep rules if necessary.\n\n\n\n\n\n## Jackson\n\nThe SDK depends on [Jackson](https://github.com/FasterXML/jackson) for JSON serialization/deserialization. It is compatible with version 2.13.4 or higher, but depends on version 2.18.2 by default.\n\nThe SDK throws an exception if it detects an incompatible Jackson version at runtime (e.g. if the default version was overridden in your Maven or Gradle config).\n\nIf the SDK threw an exception, but you\'re _certain_ the version is compatible, then disable the version check using the `checkJacksonVersionCompatibility` on [`FinchOkHttpClient`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt).\n\n> [!CAUTION]\n> We make no guarantee that the SDK works correctly when the Jackson version check is disabled.\n\nAlso note that there are bugs in older Jackson versions that can affect the SDK. We don\'t work around all Jackson bugs ([example](https://github.com/FasterXML/jackson-databind/issues/3240)) and expect users to upgrade Jackson for those instead.\n\n## Network options\n\n### Retries\n\nThe SDK automatically retries 2 times by default, with a short exponential backoff between requests.\n\nOnly the following error types are retried:\n- Connection errors (for example, due to a network connectivity problem)\n- 408 Request Timeout\n- 409 Conflict\n- 429 Rate Limit\n- 5xx Internal\n\nThe API may also explicitly instruct the SDK to retry or not retry a request.\n\nTo set a custom number of retries, configure the client using the `maxRetries` method:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .maxRetries(4)\n .accessToken("My Access Token")\n .build()\n```\n\n### Timeouts\n\nRequests time out after 1 minute by default.\n\nTo set a custom timeout, configure the method call using the `timeout` method:\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPage\n\nval page: HrisDirectoryListPage = client.hris().directory().list(RequestOptions.builder().timeout(Duration.ofSeconds(30)).build())\n```\n\nOr configure the default for all method calls at the client level:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport java.time.Duration\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .timeout(Duration.ofSeconds(30))\n .accessToken("My Access Token")\n .build()\n```\n\n### Proxies\n\nTo route requests through a proxy, configure the client using the `proxy` method:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport java.net.InetSocketAddress\nimport java.net.Proxy\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .proxy(Proxy(\n Proxy.Type.HTTP, InetSocketAddress(\n "https://example.com", 8080\n )\n ))\n .accessToken("My Access Token")\n .build()\n```\n\n### Connection pooling\n\nTo customize the underlying OkHttp connection pool, configure the client using the `maxIdleConnections` and `keepAliveDuration` methods:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport java.time.Duration\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n // If `maxIdleConnections` is set, then `keepAliveDuration` must be set, and vice versa.\n .maxIdleConnections(10)\n .keepAliveDuration(Duration.ofMinutes(2))\n .accessToken("My Access Token")\n .build()\n```\n\nIf both options are unset, OkHttp\'s default connection pool settings are used.\n\n### HTTPS\n\n> [!NOTE]\n> Most applications should not call these methods, and instead use the system defaults. The defaults include\n> special optimizations that can be lost if the implementations are modified.\n\nTo configure how HTTPS connections are secured, configure the client using the `sslSocketFactory`, `trustManager`, and `hostnameVerifier` methods:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n // If `sslSocketFactory` is set, then `trustManager` must be set, and vice versa.\n .sslSocketFactory(yourSSLSocketFactory)\n .trustManager(yourTrustManager)\n .hostnameVerifier(yourHostnameVerifier)\n .accessToken("My Access Token")\n .build()\n```\n\n\n\n### Custom HTTP client\n\nThe SDK consists of three artifacts:\n- `finch-kotlin-core`\n - Contains core SDK logic\n - Does not depend on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`FinchClient`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClient.kt), [`FinchClientAsync`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsync.kt), [`FinchClientImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt), and [`FinchClientAsyncImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), all of which can work with any HTTP client\n- `finch-kotlin-client-okhttp`\n - Depends on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`FinchOkHttpClient`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) and [`FinchOkHttpClientAsync`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), which provide a way to construct [`FinchClientImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) and [`FinchClientAsyncImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), respectively, using OkHttp\n- `finch-kotlin`\n - Depends on and exposes the APIs of both `finch-kotlin-core` and `finch-kotlin-client-okhttp`\n - Does not have its own logic\n\nThis structure allows replacing the SDK\'s default HTTP client without pulling in unnecessary dependencies.\n\n#### Customized [`OkHttpClient`](https://square.github.io/okhttp/3.x/okhttp/okhttp3/OkHttpClient.html)\n\n> [!TIP]\n> Try the available [network options](#network-options) before replacing the default client.\n\nTo use a customized `OkHttpClient`:\n\n1. Replace your [`finch-kotlin` dependency](#installation) with `finch-kotlin-core`\n2. Copy `finch-kotlin-client-okhttp`\'s [`OkHttpClient`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/OkHttpClient.kt) class into your code and customize it\n3. Construct [`FinchClientImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) or [`FinchClientAsyncImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), similarly to [`FinchOkHttpClient`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), using your customized client\n\n### Completely custom HTTP client\n\nTo use a completely custom HTTP client:\n\n1. Replace your [`finch-kotlin` dependency](#installation) with `finch-kotlin-core`\n2. Write a class that implements the [`HttpClient`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/core/http/HttpClient.kt) interface\n3. Construct [`FinchClientImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) or [`FinchClientAsyncImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), similarly to [`FinchOkHttpClient`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), using your new client class\n\n## Undocumented API functionality\n\nThe SDK is typed for convenient usage of the documented API. However, it also supports working with undocumented or not yet supported parts of the API.\n\n### Parameters\n\nTo set undocumented parameters, call the `putAdditionalHeader`, `putAdditionalQueryParam`, or `putAdditionalBodyProperty` methods on any `Params` class:\n\n```kotlin\nimport com.tryfinch.api.core.JsonValue\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval params: HrisDirectoryListParams = HrisDirectoryListParams.builder()\n .putAdditionalHeader("Secret-Header", "42")\n .putAdditionalQueryParam("secret_query_param", "42")\n .putAdditionalBodyProperty("secretProperty", JsonValue.from("42"))\n .build()\n```\n\nThese can be accessed on the built object later using the `_additionalHeaders()`, `_additionalQueryParams()`, and `_additionalBodyProperties()` methods.\n\nTo set a documented parameter or property to an undocumented or not yet supported _value_, pass a [`JsonValue`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/core/Values.kt) object to its setter:\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval params: HrisDirectoryListParams = HrisDirectoryListParams.builder().build()\n```\n\nThe most straightforward way to create a [`JsonValue`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/core/Values.kt) is using its `from(...)` method:\n\n```kotlin\nimport com.tryfinch.api.core.JsonValue\n\n// Create primitive JSON values\nval nullValue: JsonValue = JsonValue.from(null)\nval booleanValue: JsonValue = JsonValue.from(true)\nval numberValue: JsonValue = JsonValue.from(42)\nval stringValue: JsonValue = JsonValue.from("Hello World!")\n\n// Create a JSON array value equivalent to `["Hello", "World"]`\nval arrayValue: JsonValue = JsonValue.from(listOf(\n "Hello", "World"\n))\n\n// Create a JSON object value equivalent to `{ "a": 1, "b": 2 }`\nval objectValue: JsonValue = JsonValue.from(mapOf(\n "a" to 1, "b" to 2\n))\n\n// Create an arbitrarily nested JSON equivalent to:\n// {\n// "a": [1, 2],\n// "b": [3, 4]\n// }\nval complexValue: JsonValue = JsonValue.from(mapOf(\n "a" to listOf(\n 1, 2\n ), "b" to listOf(\n 3, 4\n )\n))\n```\n\nNormally a `Builder` class\'s `build` method will throw [`IllegalStateException`](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) if any required parameter or property is unset.\n\nTo forcibly omit a required parameter or property, pass [`JsonMissing`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/core/Values.kt):\n\n```kotlin\nimport com.tryfinch.api.core.JsonMissing\nimport com.tryfinch.api.models.AccessTokenCreateParams\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval params: HrisDirectoryListParams = AccessTokenCreateParams.builder()\n .code(JsonMissing.of())\n .build()\n```\n\n### Response properties\n\nTo access undocumented response properties, call the `_additionalProperties()` method:\n\n```kotlin\nimport com.tryfinch.api.core.JsonBoolean\nimport com.tryfinch.api.core.JsonNull\nimport com.tryfinch.api.core.JsonNumber\nimport com.tryfinch.api.core.JsonValue\n\nval additionalProperties: Map = client.accessTokens().create(params)._additionalProperties()\nval secretPropertyValue: JsonValue = additionalProperties.get("secretProperty")\n\nval result = when (secretPropertyValue) {\n is JsonNull -> "It\'s null!"\n is JsonBoolean -> "It\'s a boolean!"\n is JsonNumber -> "It\'s a number!"\n // Other types include `JsonMissing`, `JsonString`, `JsonArray`, and `JsonObject`\n else -> "It\'s something else!"\n}\n```\n\nTo access a property\'s raw JSON value, which may be undocumented, call its `_` prefixed method:\n\n```kotlin\nimport com.tryfinch.api.core.JsonField\n\nval code: JsonField = client.accessTokens().create(params)._code()\n\nif (code.isMissing()) {\n // The property is absent from the JSON response\n} else if (code.isNull()) {\n // The property was set to literal null\n} else {\n // Check if value was provided as a string\n // Other methods include `asNumber()`, `asBoolean()`, etc.\n val jsonString: String? = code.asString();\n\n // Try to deserialize into a custom type\n val myObject: MyClass = code.asUnknown()!!.convert(MyClass::class.java)\n}\n```\n\n### Response validation\n\nIn rare cases, the API may return a response that doesn\'t match the expected type. For example, the SDK may expect a property to contain a `String`, but the API could return something else.\n\nBy default, the SDK will not throw an exception in this case. It will throw [`FinchInvalidDataException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchInvalidDataException.kt) only if you directly access the property.\n\nIf you would prefer to check that the response is completely well-typed upfront, then either call `validate()`:\n\n```kotlin\nimport com.tryfinch.api.models.CreateAccessTokenResponse\n\nval createAccessTokenResponse: CreateAccessTokenResponse = client.accessTokens().create(params).validate()\n```\n\nOr configure the method call to validate the response using the `responseValidation` method:\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPage\n\nval page: HrisDirectoryListPage = client.hris().directory().list(RequestOptions.builder().responseValidation(true).build())\n```\n\nOr configure the default for all method calls at the client level:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .responseValidation(true)\n .accessToken("My Access Token")\n .build()\n```\n\n## FAQ\n\n### Why don\'t you use plain `enum` classes?\n\nKotlin `enum` classes are not trivially [forwards compatible](https://www.stainless.com/blog/making-java-enums-forwards-compatible). Using them in the SDK could cause runtime exceptions if the API is updated to respond with a new enum value.\n\n### Why do you represent fields using `JsonField` instead of just plain `T`?\n\nUsing `JsonField` enables a few features:\n\n- Allowing usage of [undocumented API functionality](#undocumented-api-functionality)\n- Lazily [validating the API response against the expected shape](#response-validation)\n- Representing absent vs explicitly null values\n\n### Why don\'t you use [`data` classes](https://kotlinlang.org/docs/data-classes.html)?\n\nIt is not [backwards compatible to add new fields to a data class](https://kotlinlang.org/docs/api-guidelines-backward-compatibility.html#avoid-using-data-classes-in-your-api) and we don\'t want to introduce a breaking change every time we add a field to a class.\n\n### Why don\'t you use checked exceptions?\n\nChecked exceptions are widely considered a mistake in the Java programming language. In fact, they were omitted from Kotlin for this reason.\n\nChecked exceptions:\n\n- Are verbose to handle\n- Encourage error handling at the wrong level of abstraction, where nothing can be done about the error\n- Are tedious to propagate due to the [function coloring problem](https://journal.stuffwithstuff.com/2015/02/01/what-color-is-your-function)\n- Don\'t play well with lambdas (also due to the function coloring problem)\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n2. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Finch-API/finch-api-kotlin/issues) with questions, bugs, or suggestions.\n', + "# Finch TypeScript API Library\n\n[![NPM version](https://img.shields.io/npm/v/@tryfinch/finch-api.svg?label=npm%20(stable))](https://npmjs.org/package/@tryfinch/finch-api) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@tryfinch/finch-api)\n\nThis library provides convenient access to the Finch REST API from server-side TypeScript or JavaScript.\n\n\n\nThe REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/). The full API of this library can be found in [api.md](api.md).\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Installation\n\n```sh\nnpm install @tryfinch/finch-api\n```\n\n\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n\n```js\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst page = await client.hris.directory.list();\nconst individualInDirectory = page.individuals[0];\n\nconsole.log(individualInDirectory.id);\n```\n\n\n\n### Request & Response types\n\nThis library includes TypeScript definitions for all request params and response fields. You may import and use them like so:\n\n\n```ts\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst [individualInDirectory]: [Finch.HRIS.IndividualInDirectory] =\n await client.hris.directory.list();\n```\n\nDocumentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.\n\n\n\n\n\n## Handling errors\n\nWhen the library is unable to connect to the API,\nor if the API returns a non-success status code (i.e., 4xx or 5xx response),\na subclass of `APIError` will be thrown:\n\n\n```ts\nconst company = await client.hris.company.retrieve().catch(async (err) => {\n if (err instanceof Finch.APIError) {\n console.log(err.status); // 400\n console.log(err.name); // BadRequestError\n console.log(err.headers); // {server: 'nginx', ...}\n } else {\n throw err;\n }\n});\n```\n\nError codes are as follows:\n\n| Status Code | Error Type |\n| ----------- | -------------------------- |\n| 400 | `BadRequestError` |\n| 401 | `AuthenticationError` |\n| 403 | `PermissionDeniedError` |\n| 404 | `NotFoundError` |\n| 422 | `UnprocessableEntityError` |\n| 429 | `RateLimitError` |\n| >=500 | `InternalServerError` |\n| N/A | `APIConnectionError` |\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,\n429 Rate Limit, and >=500 Internal errors will all be retried by default.\n\nYou can use the `maxRetries` option to configure or disable this:\n\n\n```js\n// Configure the default for all requests:\nconst client = new Finch({\n maxRetries: 0, // default is 2\n});\n\n// Or, configure per-request:\nawait client.hris.directory.list({\n maxRetries: 5,\n});\n```\n\n### Timeouts\n\nRequests time out after 1 minute by default. You can configure this with a `timeout` option:\n\n\n```ts\n// Configure the default for all requests:\nconst client = new Finch({\n timeout: 20 * 1000, // 20 seconds (default is 1 minute)\n});\n\n// Override per-request:\nawait client.hris.directory.list({\n timeout: 5 * 1000,\n});\n```\n\nOn timeout, an `APIConnectionTimeoutError` is thrown.\n\nNote that requests which time out will be [retried twice by default](#retries).\n\n## Auto-pagination\n\nList methods in the Finch API are paginated.\nYou can use the `for await … of` syntax to iterate through items across all pages:\n\n```ts\nasync function fetchAllIndividualInDirectories(params) {\n const allIndividualInDirectories = [];\n // Automatically fetches more pages as needed.\n for await (const individualInDirectory of client.hris.directory.list()) {\n allIndividualInDirectories.push(individualInDirectory);\n }\n return allIndividualInDirectories;\n}\n```\n\nAlternatively, you can request a single page at a time:\n\n```ts\nlet page = await client.hris.directory.list();\nfor (const individualInDirectory of page.individuals) {\n console.log(individualInDirectory);\n}\n\n// Convenience methods are provided for manually paginating:\nwhile (page.hasNextPage()) {\n page = await page.getNextPage();\n // ...\n}\n```\n\n## Default Headers\n\nWe automatically send the `Finch-API-Version` header set to `2020-09-17`.\n\nIf you need to, you can override it by setting default headers on a per-request basis.\n\nBe aware that doing so may result in incorrect types and other unexpected or undefined behavior in the SDK.\n\n```ts\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst page = await client.hris.directory.list({\n headers: { 'Finch-API-Version': 'My-Custom-Value' },\n});\nconst individualInDirectory = page.individuals[0];\n```\n\n## Advanced Usage\n\n### Accessing raw Response data (e.g., headers)\n\nThe \"raw\" `Response` returned by `fetch()` can be accessed through the `.asResponse()` method on the `APIPromise` type that all methods return.\nThis method returns as soon as the headers for a successful response are received and does not consume the response body, so you are free to write custom parsing or streaming logic.\n\nYou can also use the `.withResponse()` method to get the raw `Response` along with the parsed data.\nUnlike `.asResponse()` this method consumes the body, returning once it is parsed.\n\n\n```ts\nconst client = new Finch();\n\nconst response = await client.hris.directory.list().asResponse();\nconsole.log(response.headers.get('X-My-Header'));\nconsole.log(response.statusText); // access the underlying Response object\n\nconst { data: page, response: raw } = await client.hris.directory.list().withResponse();\nconsole.log(raw.headers.get('X-My-Header'));\nfor await (const individualInDirectory of page) {\n console.log(individualInDirectory.id);\n}\n```\n\n### Logging\n\n> [!IMPORTANT]\n> All log messages are intended for debugging only. The format and content of log messages\n> may change between releases.\n\n#### Log levels\n\nThe log level can be configured in two ways:\n\n1. Via the `FINCH_LOG` environment variable\n2. Using the `logLevel` client option (overrides the environment variable if set)\n\n```ts\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n logLevel: 'debug', // Show all log messages\n});\n```\n\nAvailable log levels, from most to least verbose:\n\n- `'debug'` - Show debug messages, info, warnings, and errors\n- `'info'` - Show info messages, warnings, and errors\n- `'warn'` - Show warnings and errors (default)\n- `'error'` - Show only errors\n- `'off'` - Disable all logging\n\nAt the `'debug'` level, all HTTP requests and responses are logged, including headers and bodies.\nSome authentication-related headers are redacted, but sensitive data in request and response bodies\nmay still be visible.\n\n#### Custom logger\n\nBy default, this library logs to `globalThis.console`. You can also provide a custom logger.\nMost logging libraries are supported, including [pino](https://www.npmjs.com/package/pino), [winston](https://www.npmjs.com/package/winston), [bunyan](https://www.npmjs.com/package/bunyan), [consola](https://www.npmjs.com/package/consola), [signale](https://www.npmjs.com/package/signale), and [@std/log](https://jsr.io/@std/log). If your logger doesn't work, please open an issue.\n\nWhen providing a custom logger, the `logLevel` option still controls which messages are emitted, messages\nbelow the configured level will not be sent to your logger.\n\n```ts\nimport Finch from '@tryfinch/finch-api';\nimport pino from 'pino';\n\nconst logger = pino();\n\nconst client = new Finch({\n logger: logger.child({ name: 'Finch' }),\n logLevel: 'debug', // Send all messages to pino, allowing it to filter\n});\n```\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API. If you need to access undocumented\nendpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can use `client.get`, `client.post`, and other HTTP verbs.\nOptions on the client, such as retries, will be respected when making these requests.\n\n```ts\nawait client.post('/some/path', {\n body: { some_prop: 'foo' },\n query: { some_query_arg: 'bar' },\n});\n```\n\n#### Undocumented request params\n\nTo make requests using undocumented parameters, you may use `// @ts-expect-error` on the undocumented\nparameter. This library doesn't validate at runtime that the request matches the type, so any extra values you\nsend will be sent as-is.\n\n```ts\nclient.hris.directory.list({\n // ...\n // @ts-expect-error baz is not yet public\n baz: 'undocumented option',\n});\n```\n\nFor requests with the `GET` verb, any extra params will be in the query, all other requests will send the\nextra param in the body.\n\nIf you want to explicitly send an extra argument, you can do so with the `query`, `body`, and `headers` request\noptions.\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you may access the response object with `// @ts-expect-error` on\nthe response object, or cast the response object to the requisite type. Like the request params, we do not\nvalidate or strip extra properties from the response from the API.\n\n### Customizing the fetch client\n\nBy default, this library expects a global `fetch` function is defined.\n\nIf you want to use a different `fetch` function, you can either polyfill the global:\n\n```ts\nimport fetch from 'my-fetch';\n\nglobalThis.fetch = fetch;\n```\n\nOr pass it to the client:\n\n```ts\nimport Finch from '@tryfinch/finch-api';\nimport fetch from 'my-fetch';\n\nconst client = new Finch({ fetch });\n```\n\n### Fetch options\n\nIf you want to set custom `fetch` options without overriding the `fetch` function, you can provide a `fetchOptions` object when instantiating the client or making a request. (Request-specific options override client options.)\n\n```ts\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n fetchOptions: {\n // `RequestInit` options\n },\n});\n```\n\n#### Configuring proxies\n\nTo modify proxy behavior, you can provide custom `fetchOptions` that add runtime-specific proxy\noptions to requests:\n\n **Node** [[docs](https://github.com/nodejs/undici/blob/main/docs/docs/api/ProxyAgent.md#example---proxyagent-with-fetch)]\n\n```ts\nimport Finch from '@tryfinch/finch-api';\nimport * as undici from 'undici';\n\nconst proxyAgent = new undici.ProxyAgent('http://localhost:8888');\nconst client = new Finch({\n fetchOptions: {\n dispatcher: proxyAgent,\n },\n});\n```\n\n **Bun** [[docs](https://bun.sh/guides/http/proxy)]\n\n```ts\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n fetchOptions: {\n proxy: 'http://localhost:8888',\n },\n});\n```\n\n **Deno** [[docs](https://docs.deno.com/api/deno/~/Deno.createHttpClient)]\n\n```ts\nimport Finch from 'npm:@tryfinch/finch-api';\n\nconst httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });\nconst client = new Finch({\n fetchOptions: {\n client: httpClient,\n },\n});\n```\n\n## Frequently Asked Questions\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes that only affect static types, without breaking runtime behavior.\n2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n3. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Finch-API/finch-api-node/issues) with questions, bugs, or suggestions.\n\n## Requirements\n\nTypeScript >= 4.9 is supported.\n\nThe following runtimes are supported:\n\n- Node.js 20 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.\n- Deno v1.28.0 or higher.\n- Bun 1.0 or later.\n- Cloudflare Workers.\n- Vercel Edge Runtime.\n- Jest 28 or greater with the `\"node\"` environment (`\"jsdom\"` is not supported at this time).\n- Nitro v2.6 or greater.\n- Web browsers: disabled by default to avoid exposing your secret API credentials. Enable browser support by explicitly setting `dangerouslyAllowBrowser` to true'.\n
\n More explanation\n\n ### Why is this dangerous?\n Enabling the `dangerouslyAllowBrowser` option can be dangerous because it exposes your secret API credentials in the client-side code. Web browsers are inherently less secure than server environments,\n any user with access to the browser can potentially inspect, extract, and misuse these credentials. This could lead to unauthorized access using your credentials and potentially compromise sensitive data or functionality.\n ### When might this not be dangerous?\n In certain scenarios where enabling browser support might not pose significant risks:\n - Internal Tools: If the application is used solely within a controlled internal environment where the users are trusted, the risk of credential exposure can be mitigated.\n - Public APIs with Limited Scope: If your API has very limited scope and the exposed credentials do not grant access to sensitive data or critical operations, the potential impact of exposure is reduced.\n - Development or debugging purpose: Enabling this feature temporarily might be acceptable, provided the credentials are short-lived, aren't also used in production environments, or are frequently rotated.\n\n
\n\nNote that React Native is not supported at this time.\n\nIf you are interested in other runtime environments, please open or upvote an issue on GitHub.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n", }, ]; From 4560fc4bdad42bc154a70db139d761dcc507431c Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 22 Apr 2026 13:53:48 +0000 Subject: [PATCH 03/14] chore(internal): more robust bootstrap script --- scripts/bootstrap | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/bootstrap b/scripts/bootstrap index a8b69ff3..2e315f53 100755 --- a/scripts/bootstrap +++ b/scripts/bootstrap @@ -4,7 +4,7 @@ set -e cd "$(dirname "$0")/.." -if [ -f "Brewfile" ] && [ "$(uname -s)" = "Darwin" ] && [ "$SKIP_BREW" != "1" ] && [ -t 0 ]; then +if [ -f "Brewfile" ] && [ "$(uname -s)" = "Darwin" ] && [ "${SKIP_BREW:-}" != "1" ] && [ -t 0 ]; then brew bundle check >/dev/null 2>&1 || { echo -n "==> Install Homebrew dependencies? (y/N): " read -r response From 51aa59a567ed110144dd1fc6b20308fe026ebef0 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 23 Apr 2026 16:45:06 +0000 Subject: [PATCH 04/14] feat(api): api update --- .stats.yml | 4 ++-- src/resources/webhooks.ts | 5 +++++ 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/.stats.yml b/.stats.yml index f9692078..9d95cc59 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 46 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-b7c6baf733d255185a9767935a4eaa54f36678b641606cfb74a3050b67c59e9b.yml -openapi_spec_hash: e36cb22b7a3340ee040f8479636bb878 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-929f30a5a8ed80d2d5def22f9f52464b578a8924db0c2e37bb31f836181aa679.yml +openapi_spec_hash: 7559424a86d6c7768cee9c650d0c156c config_hash: d21a244fc073152c8dbecb8ece970209 diff --git a/src/resources/webhooks.ts b/src/resources/webhooks.ts index 6ec61a70..0e4ce25c 100644 --- a/src/resources/webhooks.ts +++ b/src/resources/webhooks.ts @@ -576,6 +576,11 @@ export interface BaseWebhookEvent { * Unique Finch ID of the connection associated with the webhook event. */ connection_id?: string; + + /** + * Unique Finch id of the entity for which data has been updated. + */ + entity_id?: string; } export interface CompanyEvent extends BaseWebhookEvent { From 5fb6a84b620902bbe6695d5bf91d98dd5b89c92b Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 24 Apr 2026 13:28:26 +0000 Subject: [PATCH 05/14] chore: restructure docs search code --- packages/mcp-server/src/local-docs-search.ts | 1026 +++++++++--------- 1 file changed, 513 insertions(+), 513 deletions(-) diff --git a/packages/mcp-server/src/local-docs-search.ts b/packages/mcp-server/src/local-docs-search.ts index 86ebac7d..e62ea746 100644 --- a/packages/mcp-server/src/local-docs-search.ts +++ b/packages/mcp-server/src/local-docs-search.ts @@ -64,14 +64,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## create\n\n`client.accessTokens.create(code: string, client_id?: string, client_secret?: string, redirect_uri?: string): { access_token: string; client_type: 'development' | 'production' | 'sandbox'; connection_id: string; connection_type: 'finch' | 'provider'; entity_ids: string[]; products: string[]; provider_id: string; token_type: string; account_id?: string; company_id?: string; customer_id?: string; customer_name?: string; }`\n\n**post** `/auth/token`\n\nExchange the authorization code for an access token\n\n### Parameters\n\n- `code: string`\n The authorization code received from the authorization server\n\n- `client_id?: string`\n The client ID for your application\n\n- `client_secret?: string`\n The client secret for your application\n\n- `redirect_uri?: string`\n The redirect URI used in the authorization request (optional)\n\n### Returns\n\n- `{ access_token: string; client_type: 'development' | 'production' | 'sandbox'; connection_id: string; connection_type: 'finch' | 'provider'; entity_ids: string[]; products: string[]; provider_id: string; token_type: string; account_id?: string; company_id?: string; customer_id?: string; customer_name?: string; }`\n\n - `access_token: string`\n - `client_type: 'development' | 'production' | 'sandbox'`\n - `connection_id: string`\n - `connection_type: 'finch' | 'provider'`\n - `entity_ids: string[]`\n - `products: string[]`\n - `provider_id: string`\n - `token_type: string`\n - `account_id?: string`\n - `company_id?: string`\n - `customer_id?: string`\n - `customer_name?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst createAccessTokenResponse = await client.accessTokens.create({ code: 'code' });\n\nconsole.log(createAccessTokenResponse);\n```", perLanguage: { - go: { - method: 'client.AccessTokens.New', + typescript: { + method: 'client.accessTokens.create', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t\toption.WithClientID("4ab15e51-11ad-49f4-acae-f343b7794375"),\n\t\toption.WithClientSecret("My Client Secret"),\n\t)\n\tcreateAccessTokenResponse, err := client.AccessTokens.New(context.TODO(), finchgo.AccessTokenNewParams{\n\t\tCode: finchgo.F("code"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", createAccessTokenResponse.ConnectionID)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst createAccessTokenResponse = await client.accessTokens.create({ code: 'code' });\n\nconsole.log(createAccessTokenResponse.connection_id);", }, - http: { + python: { + method: 'access_tokens.create', example: - 'curl https://api.tryfinch.com/auth/token \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "code": "code"\n }\'', + 'from finch import Finch\n\nclient = Finch()\ncreate_access_token_response = client.access_tokens.create(\n code="code",\n)\nprint(create_access_token_response.connection_id)', }, java: { method: 'accessTokens().create', @@ -83,20 +84,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AccessTokenCreateParams\nimport com.tryfinch.api.models.CreateAccessTokenResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val params: AccessTokenCreateParams = AccessTokenCreateParams.builder()\n .code("code")\n .build()\n val createAccessTokenResponse: CreateAccessTokenResponse = client.accessTokens().create(params)\n}', }, - python: { - method: 'access_tokens.create', + go: { + method: 'client.AccessTokens.New', example: - 'from finch import Finch\n\nclient = Finch()\ncreate_access_token_response = client.access_tokens.create(\n code="code",\n)\nprint(create_access_token_response.connection_id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t\toption.WithClientID("4ab15e51-11ad-49f4-acae-f343b7794375"),\n\t\toption.WithClientSecret("My Client Secret"),\n\t)\n\tcreateAccessTokenResponse, err := client.AccessTokens.New(context.TODO(), finchgo.AccessTokenNewParams{\n\t\tCode: finchgo.F("code"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", createAccessTokenResponse.ConnectionID)\n}\n', }, ruby: { method: 'access_tokens.create', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(\n access_token: "My Access Token",\n client_id: "4ab15e51-11ad-49f4-acae-f343b7794375",\n client_secret: "My Client Secret"\n)\n\ncreate_access_token_response = finch.access_tokens.create(code: "code")\n\nputs(create_access_token_response)', }, - typescript: { - method: 'client.accessTokens.create', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst createAccessTokenResponse = await client.accessTokens.create({ code: 'code' });\n\nconsole.log(createAccessTokenResponse.connection_id);", + 'curl https://api.tryfinch.com/auth/token \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "code": "code"\n }\'', }, }, }, @@ -114,14 +114,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## retrieve\n\n`client.hris.company.retrieve(entity_ids?: string[]): { id: string; accounts: object[]; departments: object[]; ein: string; entity: object; legal_name: string; locations: location[]; primary_email: string; primary_phone_number: string; }`\n\n**get** `/employer/company`\n\nRead basic company data\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ id: string; accounts: { account_name: string; account_number: string; account_type: 'checking' | 'savings'; institution_name: string; routing_number: string; }[]; departments: { name: string; parent: { name: string; }; }[]; ein: string; entity: { subtype: 's_corporation' | 'c_corporation' | 'b_corporation'; type: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }; legal_name: string; locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]; primary_email: string; primary_phone_number: string; }`\n\n - `id: string`\n - `accounts: { account_name: string; account_number: string; account_type: 'checking' | 'savings'; institution_name: string; routing_number: string; }[]`\n - `departments: { name: string; parent: { name: string; }; }[]`\n - `ein: string`\n - `entity: { subtype: 's_corporation' | 'c_corporation' | 'b_corporation'; type: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }`\n - `legal_name: string`\n - `locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]`\n - `primary_email: string`\n - `primary_phone_number: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst company = await client.hris.company.retrieve();\n\nconsole.log(company);\n```", perLanguage: { - go: { - method: 'client.HRIS.Company.Get', + typescript: { + method: 'client.hris.company.retrieve', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcompany, err := client.HRIS.Company.Get(context.TODO(), finchgo.HRISCompanyGetParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", company.ID)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst company = await client.hris.company.retrieve();\n\nconsole.log(company.id);", }, - http: { + python: { + method: 'hris.company.retrieve', example: - 'curl https://api.tryfinch.com/employer/company \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\ncompany = client.hris.company.retrieve()\nprint(company.id)', }, java: { method: 'hris().company().retrieve', @@ -133,20 +134,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.Company\nimport com.tryfinch.api.models.HrisCompanyRetrieveParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val company: Company = client.hris().company().retrieve()\n}', }, - python: { - method: 'hris.company.retrieve', + go: { + method: 'client.HRIS.Company.Get', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\ncompany = client.hris.company.retrieve()\nprint(company.id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcompany, err := client.HRIS.Company.Get(context.TODO(), finchgo.HRISCompanyGetParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", company.ID)\n}\n', }, ruby: { method: 'hris.company.retrieve', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\ncompany = finch.hris.company.retrieve\n\nputs(company)', }, - typescript: { - method: 'client.hris.company.retrieve', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst company = await client.hris.company.retrieve();\n\nconsole.log(company.id);", + 'curl https://api.tryfinch.com/employer/company \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -172,14 +172,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## list\n\n`client.hris.company.payStatementItem.list(categories?: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions'[], end_date?: string, entity_ids?: string[], name?: string, start_date?: string, type?: string): { attributes: object; category: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions'; name: string; }`\n\n**get** `/employer/pay-statement-item`\n\nRetrieve a list of detailed pay statement items for the access token's connection account.\n\n\n### Parameters\n\n- `categories?: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions'[]`\n Comma-delimited list of pay statement item categories to filter on. If empty, defaults to all categories.\n\n- `end_date?: string`\n The end date to retrieve pay statement items by via their last seen pay date in `YYYY-MM-DD` format.\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `name?: string`\n Case-insensitive partial match search by pay statement item name.\n\n- `start_date?: string`\n The start date to retrieve pay statement items by via their last seen pay date (inclusive) in `YYYY-MM-DD` format.\n\n- `type?: string`\n String search by pay statement item type.\n\n### Returns\n\n- `{ attributes: { metadata: object; employer?: boolean; pre_tax?: boolean; type?: string; }; category: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions'; name: string; }`\n\n - `attributes: { metadata: object; employer?: boolean; pre_tax?: boolean; type?: string; }`\n - `category: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions'`\n - `name: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const payStatementItemListResponse of client.hris.company.payStatementItem.list()) {\n console.log(payStatementItemListResponse);\n}\n```", perLanguage: { - go: { - method: 'client.HRIS.Company.PayStatementItem.List', + typescript: { + method: 'client.hris.company.payStatementItem.list', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Company.PayStatementItem.List(context.TODO(), finchgo.HRISCompanyPayStatementItemListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const payStatementItemListResponse of client.hris.company.payStatementItem.list()) {\n console.log(payStatementItemListResponse.attributes);\n}", }, - http: { + python: { + method: 'hris.company.pay_statement_item.list', example: - 'curl https://api.tryfinch.com/employer/pay-statement-item \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.company.pay_statement_item.list()\npage = page.responses[0]\nprint(page.attributes)', }, java: { method: 'hris().company().payStatementItem().list', @@ -191,20 +192,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemListPage\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val page: HrisCompanyPayStatementItemListPage = client.hris().company().payStatementItem().list()\n}', }, - python: { - method: 'hris.company.pay_statement_item.list', + go: { + method: 'client.HRIS.Company.PayStatementItem.List', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.company.pay_statement_item.list()\npage = page.responses[0]\nprint(page.attributes)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Company.PayStatementItem.List(context.TODO(), finchgo.HRISCompanyPayStatementItemListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', }, ruby: { method: 'hris.company.pay_statement_item.list', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.company.pay_statement_item.list\n\nputs(page)', }, - typescript: { - method: 'client.hris.company.payStatementItem.list', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const payStatementItemListResponse of client.hris.company.payStatementItem.list()) {\n console.log(payStatementItemListResponse.attributes);\n}", + 'curl https://api.tryfinch.com/employer/pay-statement-item \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -230,14 +230,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## create\n\n`client.hris.company.payStatementItem.rules.create(entity_ids?: string[], attributes?: { metadata?: object; }, conditions?: { field?: string; operator?: 'equals'; value?: string; }[], effective_end_date?: string, effective_start_date?: string, entity_type?: 'pay_statement_item'): { id?: string; attributes?: object; conditions?: object[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n**post** `/employer/pay-statement-item/rule`\n\nCustom rules can be created to associate specific attributes to pay statement items depending on the use case. For example, pay statement items that meet certain conditions can be labeled as a pre-tax 401k. This metadata can be retrieved where pay statement item information is available.\n\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to create the rule for.\n\n- `attributes?: { metadata?: object; }`\n Specifies the fields to be applied when the condition is met.\n - `metadata?: object`\n The metadata to be attached in the entity. It is a key-value pairs where the values can be of any type (string, number, boolean, object, array, etc.).\n\n- `conditions?: { field?: string; operator?: 'equals'; value?: string; }[]`\n\n- `effective_end_date?: string`\n Specifies when the rules should stop applying rules based on the date.\n\n- `effective_start_date?: string`\n Specifies when the rule should begin applying based on the date.\n\n- `entity_type?: 'pay_statement_item'`\n The entity type to which the rule is applied.\n\n### Returns\n\n- `{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n - `id?: string`\n - `attributes?: { metadata?: object; }`\n - `conditions?: { field?: string; operator?: 'equals'; value?: string; }[]`\n - `created_at?: string`\n - `effective_end_date?: string`\n - `effective_start_date?: string`\n - `entity_type?: 'pay_statement_item'`\n - `priority?: number`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst rule = await client.hris.company.payStatementItem.rules.create();\n\nconsole.log(rule);\n```", perLanguage: { - go: { - method: 'client.HRIS.Company.PayStatementItem.Rules.New', + typescript: { + method: 'client.hris.company.payStatementItem.rules.create', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\trule, err := client.HRIS.Company.PayStatementItem.Rules.New(context.TODO(), finchgo.HRISCompanyPayStatementItemRuleNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", rule.ID)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst rule = await client.hris.company.payStatementItem.rules.create();\n\nconsole.log(rule.id);", }, - http: { + python: { + method: 'hris.company.pay_statement_item.rules.create', example: - 'curl https://api.tryfinch.com/employer/pay-statement-item/rule \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nrule = client.hris.company.pay_statement_item.rules.create()\nprint(rule.id)', }, java: { method: 'hris().company().payStatementItem().rules().create', @@ -249,20 +250,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleCreateParams\nimport com.tryfinch.api.models.RuleCreateResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val rule: RuleCreateResponse = client.hris().company().payStatementItem().rules().create()\n}', }, - python: { - method: 'hris.company.pay_statement_item.rules.create', + go: { + method: 'client.HRIS.Company.PayStatementItem.Rules.New', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nrule = client.hris.company.pay_statement_item.rules.create()\nprint(rule.id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\trule, err := client.HRIS.Company.PayStatementItem.Rules.New(context.TODO(), finchgo.HRISCompanyPayStatementItemRuleNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", rule.ID)\n}\n', }, ruby: { method: 'hris.company.pay_statement_item.rules.create', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nrule = finch.hris.company.pay_statement_item.rules.create\n\nputs(rule)', }, - typescript: { - method: 'client.hris.company.payStatementItem.rules.create', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst rule = await client.hris.company.payStatementItem.rules.create();\n\nconsole.log(rule.id);", + 'curl https://api.tryfinch.com/employer/pay-statement-item/rule \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -280,14 +280,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## list\n\n`client.hris.company.payStatementItem.rules.list(entity_ids?: string[]): { id?: string; attributes?: object; conditions?: object[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n**get** `/employer/pay-statement-item/rule`\n\nList all rules of a connection account.\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to retrieve rules for.\n\n### Returns\n\n- `{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n - `id?: string`\n - `attributes?: { metadata?: object; }`\n - `conditions?: { field?: string; operator?: 'equals'; value?: string; }[]`\n - `created_at?: string`\n - `effective_end_date?: string`\n - `effective_start_date?: string`\n - `entity_type?: 'pay_statement_item'`\n - `priority?: number`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const ruleListResponse of client.hris.company.payStatementItem.rules.list()) {\n console.log(ruleListResponse);\n}\n```", perLanguage: { - go: { - method: 'client.HRIS.Company.PayStatementItem.Rules.List', + typescript: { + method: 'client.hris.company.payStatementItem.rules.list', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Company.PayStatementItem.Rules.List(context.TODO(), finchgo.HRISCompanyPayStatementItemRuleListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const ruleListResponse of client.hris.company.payStatementItem.rules.list()) {\n console.log(ruleListResponse.id);\n}", }, - http: { + python: { + method: 'hris.company.pay_statement_item.rules.list', example: - 'curl https://api.tryfinch.com/employer/pay-statement-item/rule \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.company.pay_statement_item.rules.list()\npage = page.responses[0]\nprint(page.id)', }, java: { method: 'hris().company().payStatementItem().rules().list', @@ -299,20 +300,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleListPage\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val page: HrisCompanyPayStatementItemRuleListPage = client.hris().company().payStatementItem().rules().list()\n}', }, - python: { - method: 'hris.company.pay_statement_item.rules.list', + go: { + method: 'client.HRIS.Company.PayStatementItem.Rules.List', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.company.pay_statement_item.rules.list()\npage = page.responses[0]\nprint(page.id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Company.PayStatementItem.Rules.List(context.TODO(), finchgo.HRISCompanyPayStatementItemRuleListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', }, ruby: { method: 'hris.company.pay_statement_item.rules.list', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.company.pay_statement_item.rules.list\n\nputs(page)', }, - typescript: { - method: 'client.hris.company.payStatementItem.rules.list', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const ruleListResponse of client.hris.company.payStatementItem.rules.list()) {\n console.log(ruleListResponse.id);\n}", + 'curl https://api.tryfinch.com/employer/pay-statement-item/rule \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -330,14 +330,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## update\n\n`client.hris.company.payStatementItem.rules.update(rule_id: string, entity_ids?: string[], optionalProperty?: object): { id?: string; attributes?: object; conditions?: object[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n**put** `/employer/pay-statement-item/rule/{rule_id}`\n\nUpdate a rule for a pay statement item.\n\n### Parameters\n\n- `rule_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to update the rule for.\n\n- `optionalProperty?: object`\n\n### Returns\n\n- `{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n - `id?: string`\n - `attributes?: { metadata?: object; }`\n - `conditions?: { field?: string; operator?: 'equals'; value?: string; }[]`\n - `created_at?: string`\n - `effective_end_date?: string`\n - `effective_start_date?: string`\n - `entity_type?: 'pay_statement_item'`\n - `priority?: number`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst rule = await client.hris.company.payStatementItem.rules.update('rule_id');\n\nconsole.log(rule);\n```", perLanguage: { - go: { - method: 'client.HRIS.Company.PayStatementItem.Rules.Update', + typescript: { + method: 'client.hris.company.payStatementItem.rules.update', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\trule, err := client.HRIS.Company.PayStatementItem.Rules.Update(\n\t\tcontext.TODO(),\n\t\t"rule_id",\n\t\tfinchgo.HRISCompanyPayStatementItemRuleUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", rule.ID)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst rule = await client.hris.company.payStatementItem.rules.update('rule_id');\n\nconsole.log(rule.id);", }, - http: { + python: { + method: 'hris.company.pay_statement_item.rules.update', example: - 'curl https://api.tryfinch.com/employer/pay-statement-item/rule/$RULE_ID \\\n -X PUT \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nrule = client.hris.company.pay_statement_item.rules.update(\n rule_id="rule_id",\n)\nprint(rule.id)', }, java: { method: 'hris().company().payStatementItem().rules().update', @@ -349,20 +350,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleUpdateParams\nimport com.tryfinch.api.models.RuleUpdateResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val rule: RuleUpdateResponse = client.hris().company().payStatementItem().rules().update("rule_id")\n}', }, - python: { - method: 'hris.company.pay_statement_item.rules.update', + go: { + method: 'client.HRIS.Company.PayStatementItem.Rules.Update', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nrule = client.hris.company.pay_statement_item.rules.update(\n rule_id="rule_id",\n)\nprint(rule.id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\trule, err := client.HRIS.Company.PayStatementItem.Rules.Update(\n\t\tcontext.TODO(),\n\t\t"rule_id",\n\t\tfinchgo.HRISCompanyPayStatementItemRuleUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", rule.ID)\n}\n', }, ruby: { method: 'hris.company.pay_statement_item.rules.update', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nrule = finch.hris.company.pay_statement_item.rules.update("rule_id")\n\nputs(rule)', }, - typescript: { - method: 'client.hris.company.payStatementItem.rules.update', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst rule = await client.hris.company.payStatementItem.rules.update('rule_id');\n\nconsole.log(rule.id);", + 'curl https://api.tryfinch.com/employer/pay-statement-item/rule/$RULE_ID \\\n -X PUT \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -380,14 +380,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## delete\n\n`client.hris.company.payStatementItem.rules.delete(rule_id: string, entity_ids?: string[]): { id?: string; attributes?: object; conditions?: object[]; created_at?: string; deleted_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n**delete** `/employer/pay-statement-item/rule/{rule_id}`\n\nDelete a rule for a pay statement item.\n\n### Parameters\n\n- `rule_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to delete the rule for.\n\n### Returns\n\n- `{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; deleted_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n - `id?: string`\n - `attributes?: { metadata?: object; }`\n - `conditions?: { field?: string; operator?: 'equals'; value?: string; }[]`\n - `created_at?: string`\n - `deleted_at?: string`\n - `effective_end_date?: string`\n - `effective_start_date?: string`\n - `entity_type?: 'pay_statement_item'`\n - `priority?: number`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst rule = await client.hris.company.payStatementItem.rules.delete('rule_id');\n\nconsole.log(rule);\n```", perLanguage: { - go: { - method: 'client.HRIS.Company.PayStatementItem.Rules.Delete', + typescript: { + method: 'client.hris.company.payStatementItem.rules.delete', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\trule, err := client.HRIS.Company.PayStatementItem.Rules.Delete(\n\t\tcontext.TODO(),\n\t\t"rule_id",\n\t\tfinchgo.HRISCompanyPayStatementItemRuleDeleteParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", rule.ID)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst rule = await client.hris.company.payStatementItem.rules.delete('rule_id');\n\nconsole.log(rule.id);", }, - http: { + python: { + method: 'hris.company.pay_statement_item.rules.delete', example: - 'curl https://api.tryfinch.com/employer/pay-statement-item/rule/$RULE_ID \\\n -X DELETE \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nrule = client.hris.company.pay_statement_item.rules.delete(\n rule_id="rule_id",\n)\nprint(rule.id)', }, java: { method: 'hris().company().payStatementItem().rules().delete', @@ -399,20 +400,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleDeleteParams\nimport com.tryfinch.api.models.RuleDeleteResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val rule: RuleDeleteResponse = client.hris().company().payStatementItem().rules().delete("rule_id")\n}', }, - python: { - method: 'hris.company.pay_statement_item.rules.delete', + go: { + method: 'client.HRIS.Company.PayStatementItem.Rules.Delete', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nrule = client.hris.company.pay_statement_item.rules.delete(\n rule_id="rule_id",\n)\nprint(rule.id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\trule, err := client.HRIS.Company.PayStatementItem.Rules.Delete(\n\t\tcontext.TODO(),\n\t\t"rule_id",\n\t\tfinchgo.HRISCompanyPayStatementItemRuleDeleteParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", rule.ID)\n}\n', }, ruby: { method: 'hris.company.pay_statement_item.rules.delete', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nrule = finch.hris.company.pay_statement_item.rules.delete("rule_id")\n\nputs(rule)', }, - typescript: { - method: 'client.hris.company.payStatementItem.rules.delete', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst rule = await client.hris.company.payStatementItem.rules.delete('rule_id');\n\nconsole.log(rule.id);", + 'curl https://api.tryfinch.com/employer/pay-statement-item/rule/$RULE_ID \\\n -X DELETE \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -430,14 +430,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## list\n\n`client.hris.directory.list(entity_ids?: string[], limit?: number, offset?: number): { id: string; department: object; first_name: string; is_active: boolean; last_name: string; manager: object; middle_name: string; }`\n\n**get** `/employer/directory`\n\nRead company directory and organization structure\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `limit?: number`\n Number of employees to return (defaults to all)\n\n- `offset?: number`\n Index to start from (defaults to 0)\n\n### Returns\n\n- `{ id: string; department: { name?: string; }; first_name: string; is_active: boolean; last_name: string; manager: { id: string; }; middle_name: string; }`\n\n - `id: string`\n - `department: { name?: string; }`\n - `first_name: string`\n - `is_active: boolean`\n - `last_name: string`\n - `manager: { id: string; }`\n - `middle_name: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const individualInDirectory of client.hris.directory.list()) {\n console.log(individualInDirectory);\n}\n```", perLanguage: { - go: { - method: 'client.HRIS.Directory.List', + typescript: { + method: 'client.hris.directory.list', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Directory.List(context.TODO(), finchgo.HRISDirectoryListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const individualInDirectory of client.hris.directory.list()) {\n console.log(individualInDirectory.id);\n}", }, - http: { + python: { + method: 'hris.directory.list', example: - 'curl https://api.tryfinch.com/employer/directory \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.directory.list()\npage = page.individuals[0]\nprint(page.id)', }, java: { method: 'hris().directory().list', @@ -449,20 +450,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisDirectoryListPage\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val page: HrisDirectoryListPage = client.hris().directory().list()\n}', }, - python: { - method: 'hris.directory.list', + go: { + method: 'client.HRIS.Directory.List', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.directory.list()\npage = page.individuals[0]\nprint(page.id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Directory.List(context.TODO(), finchgo.HRISDirectoryListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', }, ruby: { method: 'hris.directory.list', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.directory.list\n\nputs(page)', }, - typescript: { - method: 'client.hris.directory.list', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const individualInDirectory of client.hris.directory.list()) {\n console.log(individualInDirectory.id);\n}", + 'curl https://api.tryfinch.com/employer/directory \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -475,10 +475,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ stainlessPath: '(resource) hris.directory > (method) list_individuals', qualified: 'client.hris.directory.listIndividuals', perLanguage: { - go: { - method: 'client.HRIS.Directory.ListIndividuals', + typescript: { + method: 'client.hris.directory.listIndividuals', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.HRIS.Directory.ListIndividuals(context.TODO(), finchgo.HRISDirectoryListIndividualsParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response.Individuals)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.hris.directory.listIndividuals();\n\nconsole.log(response.individuals);", + }, + python: { + method: 'hris.directory.list_individuals', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nresponse = client.hris.directory.list_individuals()\nprint(response.individuals)', }, java: { method: 'hris().directory().listIndividuals', @@ -490,21 +495,16 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.DirectoryListIndividualsResponse\nimport com.tryfinch.api.models.HrisDirectoryListIndividualsParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val response: DirectoryListIndividualsResponse = client.hris().directory().listIndividuals()\n}', }, - python: { - method: 'hris.directory.list_individuals', + go: { + method: 'client.HRIS.Directory.ListIndividuals', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nresponse = client.hris.directory.list_individuals()\nprint(response.individuals)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.HRIS.Directory.ListIndividuals(context.TODO(), finchgo.HRISDirectoryListIndividualsParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response.Individuals)\n}\n', }, ruby: { method: 'hris.directory.list_individuals', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nresponse = finch.hris.directory.list_individuals\n\nputs(response)', }, - typescript: { - method: 'client.hris.directory.listIndividuals', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.hris.directory.listIndividuals();\n\nconsole.log(response.individuals);", - }, }, }, { @@ -525,14 +525,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## retrieve_many\n\n`client.hris.individuals.retrieveMany(entity_ids?: string[], options?: { include?: string[]; }, requests?: { individual_id?: string; }[]): { body: individual; code: number; individual_id: string; }`\n\n**post** `/employer/individual`\n\nRead individual data, excluding income and employment data\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `options?: { include?: string[]; }`\n - `include?: string[]`\n\n- `requests?: { individual_id?: string; }[]`\n\n### Returns\n\n- `{ body: { id: string; dob: string; ethnicity: string; first_name: string; gender: 'female' | 'male' | 'other' | 'decline_to_specify'; last_name: string; middle_name: string; phone_numbers: object[]; preferred_name: string; residence: location; emails?: object[]; encrypted_ssn?: string; ssn?: string; } | { code: number; message: string; name: string; finch_code?: string; }; code: number; individual_id: string; }`\n\n - `body: { id: string; dob: string; ethnicity: string; first_name: string; gender: 'female' | 'male' | 'other' | 'decline_to_specify'; last_name: string; middle_name: string; phone_numbers: { data: string; type: 'work' | 'personal'; }[]; preferred_name: string; residence: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; emails?: { data: string; type: 'work' | 'personal'; }[]; encrypted_ssn?: string; ssn?: string; } | { code: number; message: string; name: string; finch_code?: string; }`\n - `code: number`\n - `individual_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const individualResponse of client.hris.individuals.retrieveMany()) {\n console.log(individualResponse);\n}\n```", perLanguage: { - go: { - method: 'client.HRIS.Individuals.GetMany', + typescript: { + method: 'client.hris.individuals.retrieveMany', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Individuals.GetMany(context.TODO(), finchgo.HRISIndividualGetManyParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const individualResponse of client.hris.individuals.retrieveMany()) {\n console.log(individualResponse.individual_id);\n}", }, - http: { + python: { + method: 'hris.individuals.retrieve_many', example: - 'curl https://api.tryfinch.com/employer/individual \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.individuals.retrieve_many()\npage = page.responses[0]\nprint(page.individual_id)', }, java: { method: 'hris().individuals().retrieveMany', @@ -544,20 +545,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisIndividualRetrieveManyPage\nimport com.tryfinch.api.models.HrisIndividualRetrieveManyParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val page: HrisIndividualRetrieveManyPage = client.hris().individuals().retrieveMany()\n}', }, - python: { - method: 'hris.individuals.retrieve_many', + go: { + method: 'client.HRIS.Individuals.GetMany', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.individuals.retrieve_many()\npage = page.responses[0]\nprint(page.individual_id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Individuals.GetMany(context.TODO(), finchgo.HRISIndividualGetManyParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', }, ruby: { method: 'hris.individuals.retrieve_many', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.individuals.retrieve_many\n\nputs(page)', }, - typescript: { - method: 'client.hris.individuals.retrieveMany', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const individualResponse of client.hris.individuals.retrieveMany()) {\n console.log(individualResponse.individual_id);\n}", + 'curl https://api.tryfinch.com/employer/individual \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -575,14 +575,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## retrieve_many\n\n`client.hris.employments.retrieveMany(requests: { individual_id: string; }[], entity_ids?: string[]): { body: employment_data; code: number; individual_id: string; }`\n\n**post** `/employer/employment`\n\nRead individual employment and income data\n\n### Parameters\n\n- `requests: { individual_id: string; }[]`\n The array of batch requests.\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ body: { id: string; class_code: string; department: object; employment: object; employment_status: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; end_date: string; first_name: string; flsa_status: 'exempt' | 'non_exempt' | 'unknown'; is_active: boolean; last_name: string; latest_rehire_date: string; location: location; manager: object; middle_name: string; start_date: string; title: string; custom_fields?: object[]; income?: income; income_history?: income[]; source_id?: string; work_id?: string; } | { code: number; message: string; name: string; finch_code?: string; }; code: number; individual_id: string; }`\n\n - `body: { id: string; class_code: string; department: { name: string; }; employment: { subtype: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type: 'employee' | 'contractor'; }; employment_status: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; end_date: string; first_name: string; flsa_status: 'exempt' | 'non_exempt' | 'unknown'; is_active: boolean; last_name: string; latest_rehire_date: string; location: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; manager: { id: string; }; middle_name: string; start_date: string; title: string; custom_fields?: { name?: string; value?: string | object[] | object | number | boolean; }[]; income?: { amount: number; currency: string; effective_date: string; unit: string; }; income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]; source_id?: string; work_id?: string; } | { code: number; message: string; name: string; finch_code?: string; }`\n - `code: number`\n - `individual_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const employmentDataResponse of client.hris.employments.retrieveMany({ requests: [{ individual_id: 'individual_id' }] })) {\n console.log(employmentDataResponse);\n}\n```", perLanguage: { - go: { - method: 'client.HRIS.Employments.GetMany', + typescript: { + method: 'client.hris.employments.retrieveMany', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Employments.GetMany(context.TODO(), finchgo.HRISEmploymentGetManyParams{\n\t\tRequests: finchgo.F([]finchgo.HRISEmploymentGetManyParamsRequest{{\n\t\t\tIndividualID: finchgo.F("individual_id"),\n\t\t}}),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const employmentDataResponse of client.hris.employments.retrieveMany({\n requests: [{ individual_id: 'individual_id' }],\n})) {\n console.log(employmentDataResponse.individual_id);\n}", }, - http: { + python: { + method: 'hris.employments.retrieve_many', example: - 'curl https://api.tryfinch.com/employer/employment \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "requests": [\n {\n "individual_id": "individual_id"\n }\n ]\n }\'', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.employments.retrieve_many(\n requests=[{\n "individual_id": "individual_id"\n }],\n)\npage = page.responses[0]\nprint(page.individual_id)', }, java: { method: 'hris().employments().retrieveMany', @@ -594,20 +595,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisEmploymentRetrieveManyPage\nimport com.tryfinch.api.models.HrisEmploymentRetrieveManyParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val params: HrisEmploymentRetrieveManyParams = HrisEmploymentRetrieveManyParams.builder()\n .addRequest(HrisEmploymentRetrieveManyParams.Request.builder()\n .individualId("individual_id")\n .build())\n .build()\n val page: HrisEmploymentRetrieveManyPage = client.hris().employments().retrieveMany(params)\n}', }, - python: { - method: 'hris.employments.retrieve_many', + go: { + method: 'client.HRIS.Employments.GetMany', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.employments.retrieve_many(\n requests=[{\n "individual_id": "individual_id"\n }],\n)\npage = page.responses[0]\nprint(page.individual_id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Employments.GetMany(context.TODO(), finchgo.HRISEmploymentGetManyParams{\n\t\tRequests: finchgo.F([]finchgo.HRISEmploymentGetManyParamsRequest{{\n\t\t\tIndividualID: finchgo.F("individual_id"),\n\t\t}}),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', }, ruby: { method: 'hris.employments.retrieve_many', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.employments.retrieve_many(requests: [{individual_id: "individual_id"}])\n\nputs(page)', }, - typescript: { - method: 'client.hris.employments.retrieveMany', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const employmentDataResponse of client.hris.employments.retrieveMany({\n requests: [{ individual_id: 'individual_id' }],\n})) {\n console.log(employmentDataResponse.individual_id);\n}", + 'curl https://api.tryfinch.com/employer/employment \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "requests": [\n {\n "individual_id": "individual_id"\n }\n ]\n }\'', }, }, }, @@ -625,14 +625,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## list\n\n`client.hris.payments.list(end_date: string, start_date: string, entity_ids?: string[]): { id: string; company_debit: money; debit_date: string; employee_taxes: money; employer_taxes: money; gross_pay: money; individual_ids: string[]; net_pay: money; pay_date: string; pay_frequencies: string[]; pay_group_ids: string[]; pay_period: object; }`\n\n**get** `/employer/payment`\n\nRead payroll and contractor related payments by the company.\n\n### Parameters\n\n- `end_date: string`\n The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` format. Filters payments by their **pay_date** field.\n\n- `start_date: string`\n The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` format. Filters payments by their **pay_date** field.\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ id: string; company_debit: { amount: number; currency: string; }; debit_date: string; employee_taxes: { amount: number; currency: string; }; employer_taxes: { amount: number; currency: string; }; gross_pay: { amount: number; currency: string; }; individual_ids: string[]; net_pay: { amount: number; currency: string; }; pay_date: string; pay_frequencies: string[]; pay_group_ids: string[]; pay_period: { end_date: string; start_date: string; }; }`\n\n - `id: string`\n - `company_debit: { amount: number; currency: string; }`\n - `debit_date: string`\n - `employee_taxes: { amount: number; currency: string; }`\n - `employer_taxes: { amount: number; currency: string; }`\n - `gross_pay: { amount: number; currency: string; }`\n - `individual_ids: string[]`\n - `net_pay: { amount: number; currency: string; }`\n - `pay_date: string`\n - `pay_frequencies: string[]`\n - `pay_group_ids: string[]`\n - `pay_period: { end_date: string; start_date: string; }`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const payment of client.hris.payments.list({ end_date: '2021-01-01', start_date: '2021-01-01' })) {\n console.log(payment);\n}\n```", perLanguage: { - go: { - method: 'client.HRIS.Payments.List', + typescript: { + method: 'client.hris.payments.list', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Payments.List(context.TODO(), finchgo.HRISPaymentListParams{\n\t\tEndDate: finchgo.F(time.Now()),\n\t\tStartDate: finchgo.F(time.Now()),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const payment of client.hris.payments.list({\n end_date: '2021-01-01',\n start_date: '2021-01-01',\n})) {\n console.log(payment.id);\n}", }, - http: { + python: { + method: 'hris.payments.list', example: - 'curl https://api.tryfinch.com/employer/payment \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from datetime import date\nfrom finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.payments.list(\n end_date=date.fromisoformat("2021-01-01"),\n start_date=date.fromisoformat("2021-01-01"),\n)\npage = page.items[0]\nprint(page.id)', }, java: { method: 'hris().payments().list', @@ -644,20 +645,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisPaymentListPage\nimport com.tryfinch.api.models.HrisPaymentListParams\nimport java.time.LocalDate\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val params: HrisPaymentListParams = HrisPaymentListParams.builder()\n .endDate(LocalDate.parse("2021-01-01"))\n .startDate(LocalDate.parse("2021-01-01"))\n .build()\n val page: HrisPaymentListPage = client.hris().payments().list(params)\n}', }, - python: { - method: 'hris.payments.list', + go: { + method: 'client.HRIS.Payments.List', example: - 'from datetime import date\nfrom finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.payments.list(\n end_date=date.fromisoformat("2021-01-01"),\n start_date=date.fromisoformat("2021-01-01"),\n)\npage = page.items[0]\nprint(page.id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Payments.List(context.TODO(), finchgo.HRISPaymentListParams{\n\t\tEndDate: finchgo.F(time.Now()),\n\t\tStartDate: finchgo.F(time.Now()),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', }, ruby: { method: 'hris.payments.list', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.payments.list(end_date: "2021-01-01", start_date: "2021-01-01")\n\nputs(page)', }, - typescript: { - method: 'client.hris.payments.list', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const payment of client.hris.payments.list({\n end_date: '2021-01-01',\n start_date: '2021-01-01',\n})) {\n console.log(payment.id);\n}", + 'curl https://api.tryfinch.com/employer/payment \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -679,14 +679,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## retrieve_many\n\n`client.hris.payStatements.retrieveMany(requests: { payment_id: string; limit?: number; offset?: number; }[], entity_ids?: string[]): { body: pay_statement_response_body | object | pay_statement_data_sync_in_progress; code: number; payment_id: string; }`\n\n**post** `/employer/pay-statement`\n\nRead detailed pay statements for each individual.\n\nDeduction and contribution types are supported by the payroll systems that supports Benefits.\n\n### Parameters\n\n- `requests: { payment_id: string; limit?: number; offset?: number; }[]`\n The array of batch requests.\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ body: { paging: object; pay_statements: pay_statement[]; } | { code: number; message: string; name: string; finch_code?: string; } | { code: 202; finch_code: 'data_sync_in_progress'; message: 'The pay statements for this payment are being fetched. Please check back later.'; name: 'accepted'; }; code: number; payment_id: string; }`\n\n - `body: { paging: { offset: number; count?: number; }; pay_statements: { earnings: object[]; employee_deductions: object[]; employer_contributions: object[]; gross_pay: money; individual_id: string; net_pay: money; payment_method: 'check' | 'direct_deposit' | 'other'; taxes: object[]; total_hours: number; type: 'off_cycle_payroll' | 'one_time_payment' | 'regular_payroll'; }[]; } | { code: number; message: string; name: string; finch_code?: string; } | { code: 202; finch_code: 'data_sync_in_progress'; message: 'The pay statements for this payment are being fetched. Please check back later.'; name: 'accepted'; }`\n - `code: number`\n - `payment_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const payStatementResponse of client.hris.payStatements.retrieveMany({ requests: [{ payment_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }] })) {\n console.log(payStatementResponse);\n}\n```", perLanguage: { - go: { - method: 'client.HRIS.PayStatements.GetMany', + typescript: { + method: 'client.hris.payStatements.retrieveMany', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.PayStatements.GetMany(context.TODO(), finchgo.HRISPayStatementGetManyParams{\n\t\tRequests: finchgo.F([]finchgo.HRISPayStatementGetManyParamsRequest{{\n\t\t\tPaymentID: finchgo.F("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"),\n\t\t}}),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const payStatementResponse of client.hris.payStatements.retrieveMany({\n requests: [{ payment_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }],\n})) {\n console.log(payStatementResponse.payment_id);\n}", }, - http: { + python: { + method: 'hris.pay_statements.retrieve_many', example: - 'curl https://api.tryfinch.com/employer/pay-statement \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "requests": [\n {\n "payment_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"\n }\n ]\n }\'', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.pay_statements.retrieve_many(\n requests=[{\n "payment_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"\n }],\n)\npage = page.responses[0]\nprint(page.payment_id)', }, java: { method: 'hris().payStatements().retrieveMany', @@ -698,20 +699,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisPayStatementRetrieveManyPage\nimport com.tryfinch.api.models.HrisPayStatementRetrieveManyParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val params: HrisPayStatementRetrieveManyParams = HrisPayStatementRetrieveManyParams.builder()\n .addRequest(HrisPayStatementRetrieveManyParams.Request.builder()\n .paymentId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")\n .build())\n .build()\n val page: HrisPayStatementRetrieveManyPage = client.hris().payStatements().retrieveMany(params)\n}', }, - python: { - method: 'hris.pay_statements.retrieve_many', + go: { + method: 'client.HRIS.PayStatements.GetMany', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.pay_statements.retrieve_many(\n requests=[{\n "payment_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"\n }],\n)\npage = page.responses[0]\nprint(page.payment_id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.PayStatements.GetMany(context.TODO(), finchgo.HRISPayStatementGetManyParams{\n\t\tRequests: finchgo.F([]finchgo.HRISPayStatementGetManyParamsRequest{{\n\t\t\tPaymentID: finchgo.F("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"),\n\t\t}}),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', }, ruby: { method: 'hris.pay_statements.retrieve_many', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.pay_statements.retrieve_many(requests: [{payment_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"}])\n\nputs(page)', }, - typescript: { - method: 'client.hris.payStatements.retrieveMany', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const payStatementResponse of client.hris.payStatements.retrieveMany({\n requests: [{ payment_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }],\n})) {\n console.log(payStatementResponse.payment_id);\n}", + 'curl https://api.tryfinch.com/employer/pay-statement \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "requests": [\n {\n "payment_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"\n }\n ]\n }\'', }, }, }, @@ -736,14 +736,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## list\n\n`client.hris.documents.list(entity_ids?: string[], individual_ids?: string[], limit?: number, offset?: number, types?: 'w4_2020' | 'w4_2005'[]): { documents: document_response[]; paging: paging; }`\n\n**get** `/employer/documents`\n\n**Beta:** This endpoint is in beta and may change.\nRetrieve a list of company-wide documents.\n\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `individual_ids?: string[]`\n Comma-delimited list of stable Finch uuids for each individual. If empty, defaults to all individuals\n\n- `limit?: number`\n Number of documents to return (defaults to all)\n\n- `offset?: number`\n Index to start from (defaults to 0)\n\n- `types?: 'w4_2020' | 'w4_2005'[]`\n Comma-delimited list of document types to filter on. If empty, defaults to all types\n\n### Returns\n\n- `{ documents: { id: string; individual_id: string; type: 'w4_2020' | 'w4_2005'; url: string; year: number; }[]; paging: { offset: number; count?: number; }; }`\n\n - `documents: { id: string; individual_id: string; type: 'w4_2020' | 'w4_2005'; url: string; year: number; }[]`\n - `paging: { offset: number; count?: number; }`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst documents = await client.hris.documents.list();\n\nconsole.log(documents);\n```", perLanguage: { - go: { - method: 'client.HRIS.Documents.List', + typescript: { + method: 'client.hris.documents.list', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tdocuments, err := client.HRIS.Documents.List(context.TODO(), finchgo.HRISDocumentListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", documents.Documents)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst documents = await client.hris.documents.list();\n\nconsole.log(documents.documents);", }, - http: { + python: { + method: 'hris.documents.list', example: - 'curl https://api.tryfinch.com/employer/documents \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\ndocuments = client.hris.documents.list()\nprint(documents.documents)', }, java: { method: 'hris().documents().list', @@ -755,20 +756,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.DocumentListResponse\nimport com.tryfinch.api.models.HrisDocumentListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val documents: DocumentListResponse = client.hris().documents().list()\n}', }, - python: { - method: 'hris.documents.list', + go: { + method: 'client.HRIS.Documents.List', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\ndocuments = client.hris.documents.list()\nprint(documents.documents)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tdocuments, err := client.HRIS.Documents.List(context.TODO(), finchgo.HRISDocumentListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", documents.Documents)\n}\n', }, ruby: { method: 'hris.documents.list', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\ndocuments = finch.hris.documents.list\n\nputs(documents)', }, - typescript: { - method: 'client.hris.documents.list', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst documents = await client.hris.documents.list();\n\nconsole.log(documents.documents);", + 'curl https://api.tryfinch.com/employer/documents \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -787,14 +787,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## retreive\n\n`client.hris.documents.retreive(document_id: string, entity_ids?: string[]): object | object`\n\n**get** `/employer/documents/{document_id}`\n\n**Beta:** This endpoint is in beta and may change.\nRetrieve details of a specific document by its ID.\n\n\n### Parameters\n\n- `document_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ data: { amount_for_other_dependents: number; amount_for_qualifying_children_under_17: number; deductions: number; extra_withholding: number; filing_status: string; individual_id: string; other_income: number; total_claim_dependent_and_other_credits: number; }; type: 'w4_2020'; year: number; } | { data: { additional_withholding: number; exemption: 'exempt' | 'non_exempt'; filing_status: 'married' | 'married_but_withhold_at_higher_single_rate' | 'single'; individual_id: string; total_number_of_allowances: number; }; type: 'w4_2005'; year: number; }`\n A 2020 version of the W-4 tax form containing information on an individual's filing status, dependents, and withholding details.\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst response = await client.hris.documents.retreive('document_id');\n\nconsole.log(response);\n```", perLanguage: { - go: { - method: 'client.HRIS.Documents.Retreive', + typescript: { + method: 'client.hris.documents.retreive', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.HRIS.Documents.Retreive(\n\t\tcontext.TODO(),\n\t\t"document_id",\n\t\tfinchgo.HRISDocumentRetreiveParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.hris.documents.retreive('document_id');\n\nconsole.log(response);", }, - http: { + python: { + method: 'hris.documents.retreive', example: - 'curl https://api.tryfinch.com/employer/documents/$DOCUMENT_ID \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nresponse = client.hris.documents.retreive(\n document_id="document_id",\n)\nprint(response)', }, java: { method: 'hris().documents().retreive', @@ -806,20 +807,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.DocumentRetreiveResponse\nimport com.tryfinch.api.models.HrisDocumentRetreiveParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val response: DocumentRetreiveResponse = client.hris().documents().retreive("document_id")\n}', }, - python: { - method: 'hris.documents.retreive', + go: { + method: 'client.HRIS.Documents.Retreive', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nresponse = client.hris.documents.retreive(\n document_id="document_id",\n)\nprint(response)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.HRIS.Documents.Retreive(\n\t\tcontext.TODO(),\n\t\t"document_id",\n\t\tfinchgo.HRISDocumentRetreiveParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', }, ruby: { method: 'hris.documents.retreive', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nresponse = finch.hris.documents.retreive("document_id")\n\nputs(response)', }, - typescript: { - method: 'client.hris.documents.retreive', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.hris.documents.retreive('document_id');\n\nconsole.log(response);", + 'curl https://api.tryfinch.com/employer/documents/$DOCUMENT_ID \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -837,14 +837,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## list\n\n`client.hris.benefits.list(entity_ids?: string[]): { benefit_id: string; description: string; frequency: benefit_frequency; type: benefit_type; company_contribution?: object; }`\n\n**get** `/employer/benefits`\n\nList all company-wide deductions and contributions.\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ benefit_id: string; description: string; frequency: 'every_paycheck' | 'monthly' | 'one_time'; type: string; company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }; }`\n\n - `benefit_id: string`\n - `description: string`\n - `frequency: 'every_paycheck' | 'monthly' | 'one_time'`\n - `type: string`\n - `company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const companyBenefit of client.hris.benefits.list()) {\n console.log(companyBenefit);\n}\n```", perLanguage: { - go: { - method: 'client.HRIS.Benefits.List', + typescript: { + method: 'client.hris.benefits.list', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Benefits.List(context.TODO(), finchgo.HRISBenefitListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const companyBenefit of client.hris.benefits.list()) {\n console.log(companyBenefit.benefit_id);\n}", }, - http: { + python: { + method: 'hris.benefits.list', example: - 'curl https://api.tryfinch.com/employer/benefits \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.benefits.list()\npage = page.items[0]\nprint(page.benefit_id)', }, java: { method: 'hris().benefits().list', @@ -856,20 +857,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisBenefitListPage\nimport com.tryfinch.api.models.HrisBenefitListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val page: HrisBenefitListPage = client.hris().benefits().list()\n}', }, - python: { - method: 'hris.benefits.list', + go: { + method: 'client.HRIS.Benefits.List', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.benefits.list()\npage = page.items[0]\nprint(page.benefit_id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Benefits.List(context.TODO(), finchgo.HRISBenefitListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', }, ruby: { method: 'hris.benefits.list', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.benefits.list\n\nputs(page)', }, - typescript: { - method: 'client.hris.benefits.list', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const companyBenefit of client.hris.benefits.list()) {\n console.log(companyBenefit.benefit_id);\n}", + 'curl https://api.tryfinch.com/employer/benefits \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -893,14 +893,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## create\n\n`client.hris.benefits.create(entity_ids?: string[], company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }, description?: string, frequency?: 'every_paycheck' | 'monthly' | 'one_time', type?: string): { benefit_id: string; job_id: string; }`\n\n**post** `/employer/benefits`\n\nCreates a new company-wide deduction or contribution. Please use the `/providers` endpoint to view available types for each provider.\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }`\n The company match for this benefit.\n - `tiers: { match: number; threshold: number; }[]`\n - `type: 'match'`\n\n- `description?: string`\n Name of the benefit as it appears in the provider and pay statements. Recommend limiting this to <30 characters due to limitations in specific providers (e.g. Justworks).\n\n- `frequency?: 'every_paycheck' | 'monthly' | 'one_time'`\n The frequency of the benefit deduction/contribution.\n\n- `type?: string`\n Type of benefit.\n\n### Returns\n\n- `{ benefit_id: string; job_id: string; }`\n\n - `benefit_id: string`\n - `job_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst createCompanyBenefitsResponse = await client.hris.benefits.create();\n\nconsole.log(createCompanyBenefitsResponse);\n```", perLanguage: { - go: { - method: 'client.HRIS.Benefits.New', + typescript: { + method: 'client.hris.benefits.create', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcreateCompanyBenefitsResponse, err := client.HRIS.Benefits.New(context.TODO(), finchgo.HRISBenefitNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", createCompanyBenefitsResponse.BenefitID)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst createCompanyBenefitsResponse = await client.hris.benefits.create();\n\nconsole.log(createCompanyBenefitsResponse.benefit_id);", }, - http: { + python: { + method: 'hris.benefits.create', example: - 'curl https://api.tryfinch.com/employer/benefits \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\ncreate_company_benefits_response = client.hris.benefits.create()\nprint(create_company_benefits_response.benefit_id)', }, java: { method: 'hris().benefits().create', @@ -912,20 +913,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.CreateCompanyBenefitsResponse\nimport com.tryfinch.api.models.HrisBenefitCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val createCompanyBenefitsResponse: CreateCompanyBenefitsResponse = client.hris().benefits().create()\n}', }, - python: { - method: 'hris.benefits.create', + go: { + method: 'client.HRIS.Benefits.New', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\ncreate_company_benefits_response = client.hris.benefits.create()\nprint(create_company_benefits_response.benefit_id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcreateCompanyBenefitsResponse, err := client.HRIS.Benefits.New(context.TODO(), finchgo.HRISBenefitNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", createCompanyBenefitsResponse.BenefitID)\n}\n', }, ruby: { method: 'hris.benefits.create', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\ncreate_company_benefits_response = finch.hris.benefits.create\n\nputs(create_company_benefits_response)', }, - typescript: { - method: 'client.hris.benefits.create', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst createCompanyBenefitsResponse = await client.hris.benefits.create();\n\nconsole.log(createCompanyBenefitsResponse.benefit_id);", + 'curl https://api.tryfinch.com/employer/benefits \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -943,14 +943,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## retrieve\n\n`client.hris.benefits.retrieve(benefit_id: string, entity_ids?: string[]): { benefit_id: string; description: string; frequency: benefit_frequency; type: benefit_type; company_contribution?: object; }`\n\n**get** `/employer/benefits/{benefit_id}`\n\nLists deductions and contributions information for a given item\n\n### Parameters\n\n- `benefit_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ benefit_id: string; description: string; frequency: 'every_paycheck' | 'monthly' | 'one_time'; type: string; company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }; }`\n\n - `benefit_id: string`\n - `description: string`\n - `frequency: 'every_paycheck' | 'monthly' | 'one_time'`\n - `type: string`\n - `company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst companyBenefit = await client.hris.benefits.retrieve('benefit_id');\n\nconsole.log(companyBenefit);\n```", perLanguage: { - go: { - method: 'client.HRIS.Benefits.Get', + typescript: { + method: 'client.hris.benefits.retrieve', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcompanyBenefit, err := client.HRIS.Benefits.Get(\n\t\tcontext.TODO(),\n\t\t"benefit_id",\n\t\tfinchgo.HRISBenefitGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", companyBenefit.BenefitID)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst companyBenefit = await client.hris.benefits.retrieve('benefit_id');\n\nconsole.log(companyBenefit.benefit_id);", }, - http: { + python: { + method: 'hris.benefits.retrieve', example: - 'curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\ncompany_benefit = client.hris.benefits.retrieve(\n benefit_id="benefit_id",\n)\nprint(company_benefit.benefit_id)', }, java: { method: 'hris().benefits().retrieve', @@ -962,20 +963,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.CompanyBenefit\nimport com.tryfinch.api.models.HrisBenefitRetrieveParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val companyBenefit: CompanyBenefit = client.hris().benefits().retrieve("benefit_id")\n}', }, - python: { - method: 'hris.benefits.retrieve', + go: { + method: 'client.HRIS.Benefits.Get', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\ncompany_benefit = client.hris.benefits.retrieve(\n benefit_id="benefit_id",\n)\nprint(company_benefit.benefit_id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcompanyBenefit, err := client.HRIS.Benefits.Get(\n\t\tcontext.TODO(),\n\t\t"benefit_id",\n\t\tfinchgo.HRISBenefitGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", companyBenefit.BenefitID)\n}\n', }, ruby: { method: 'hris.benefits.retrieve', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\ncompany_benefit = finch.hris.benefits.retrieve("benefit_id")\n\nputs(company_benefit)', }, - typescript: { - method: 'client.hris.benefits.retrieve', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst companyBenefit = await client.hris.benefits.retrieve('benefit_id');\n\nconsole.log(companyBenefit.benefit_id);", + 'curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -992,14 +992,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## update\n\n`client.hris.benefits.update(benefit_id: string, entity_ids?: string[], description?: string): { benefit_id: string; job_id: string; }`\n\n**post** `/employer/benefits/{benefit_id}`\n\nUpdates an existing company-wide deduction or contribution\n\n### Parameters\n\n- `benefit_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `description?: string`\n Updated name or description.\n\n### Returns\n\n- `{ benefit_id: string; job_id: string; }`\n\n - `benefit_id: string`\n - `job_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst updateCompanyBenefitResponse = await client.hris.benefits.update('benefit_id');\n\nconsole.log(updateCompanyBenefitResponse);\n```", perLanguage: { - go: { - method: 'client.HRIS.Benefits.Update', + typescript: { + method: 'client.hris.benefits.update', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tupdateCompanyBenefitResponse, err := client.HRIS.Benefits.Update(\n\t\tcontext.TODO(),\n\t\t"benefit_id",\n\t\tfinchgo.HRISBenefitUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", updateCompanyBenefitResponse.BenefitID)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst updateCompanyBenefitResponse = await client.hris.benefits.update('benefit_id');\n\nconsole.log(updateCompanyBenefitResponse.benefit_id);", }, - http: { + python: { + method: 'hris.benefits.update', example: - 'curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nupdate_company_benefit_response = client.hris.benefits.update(\n benefit_id="benefit_id",\n)\nprint(update_company_benefit_response.benefit_id)', }, java: { method: 'hris().benefits().update', @@ -1011,20 +1012,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisBenefitUpdateParams\nimport com.tryfinch.api.models.UpdateCompanyBenefitResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val updateCompanyBenefitResponse: UpdateCompanyBenefitResponse = client.hris().benefits().update("benefit_id")\n}', }, - python: { - method: 'hris.benefits.update', + go: { + method: 'client.HRIS.Benefits.Update', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nupdate_company_benefit_response = client.hris.benefits.update(\n benefit_id="benefit_id",\n)\nprint(update_company_benefit_response.benefit_id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tupdateCompanyBenefitResponse, err := client.HRIS.Benefits.Update(\n\t\tcontext.TODO(),\n\t\t"benefit_id",\n\t\tfinchgo.HRISBenefitUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", updateCompanyBenefitResponse.BenefitID)\n}\n', }, ruby: { method: 'hris.benefits.update', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nupdate_company_benefit_response = finch.hris.benefits.update("benefit_id")\n\nputs(update_company_benefit_response)', }, - typescript: { - method: 'client.hris.benefits.update', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst updateCompanyBenefitResponse = await client.hris.benefits.update('benefit_id');\n\nconsole.log(updateCompanyBenefitResponse.benefit_id);", + 'curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -1042,14 +1042,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## list_supported_benefits\n\n`client.hris.benefits.listSupportedBenefits(entity_ids?: string[]): { annual_maximum: boolean; company_contribution: 'fixed' | 'percent' | 'tiered'[]; description: string; employee_deduction: 'fixed' | 'percent'[]; frequencies: benefit_frequency[]; catch_up?: boolean; hsa_contribution_limit?: 'family' | 'individual'[]; }`\n\n**get** `/employer/benefits/meta`\n\nGet deductions metadata\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ annual_maximum: boolean; company_contribution: 'fixed' | 'percent' | 'tiered'[]; description: string; employee_deduction: 'fixed' | 'percent'[]; frequencies: 'every_paycheck' | 'monthly' | 'one_time'[]; catch_up?: boolean; hsa_contribution_limit?: 'family' | 'individual'[]; }`\n\n - `annual_maximum: boolean`\n - `company_contribution: 'fixed' | 'percent' | 'tiered'[]`\n - `description: string`\n - `employee_deduction: 'fixed' | 'percent'[]`\n - `frequencies: 'every_paycheck' | 'monthly' | 'one_time'[]`\n - `catch_up?: boolean`\n - `hsa_contribution_limit?: 'family' | 'individual'[]`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const supportedBenefit of client.hris.benefits.listSupportedBenefits()) {\n console.log(supportedBenefit);\n}\n```", perLanguage: { - go: { - method: 'client.HRIS.Benefits.ListSupportedBenefits', + typescript: { + method: 'client.hris.benefits.listSupportedBenefits', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Benefits.ListSupportedBenefits(context.TODO(), finchgo.HRISBenefitListSupportedBenefitsParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const supportedBenefit of client.hris.benefits.listSupportedBenefits()) {\n console.log(supportedBenefit.annual_maximum);\n}", }, - http: { + python: { + method: 'hris.benefits.list_supported_benefits', example: - 'curl https://api.tryfinch.com/employer/benefits/meta \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.benefits.list_supported_benefits()\npage = page.items[0]\nprint(page.annual_maximum)', }, java: { method: 'hris().benefits().listSupportedBenefits', @@ -1061,20 +1062,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisBenefitListSupportedBenefitsPage\nimport com.tryfinch.api.models.HrisBenefitListSupportedBenefitsParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val page: HrisBenefitListSupportedBenefitsPage = client.hris().benefits().listSupportedBenefits()\n}', }, - python: { - method: 'hris.benefits.list_supported_benefits', + go: { + method: 'client.HRIS.Benefits.ListSupportedBenefits', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.benefits.list_supported_benefits()\npage = page.items[0]\nprint(page.annual_maximum)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Benefits.ListSupportedBenefits(context.TODO(), finchgo.HRISBenefitListSupportedBenefitsParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', }, ruby: { method: 'hris.benefits.list_supported_benefits', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.benefits.list_supported_benefits\n\nputs(page)', }, - typescript: { - method: 'client.hris.benefits.listSupportedBenefits', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const supportedBenefit of client.hris.benefits.listSupportedBenefits()) {\n console.log(supportedBenefit.annual_maximum);\n}", + 'curl https://api.tryfinch.com/employer/benefits/meta \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -1091,14 +1091,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## enrolled_ids\n\n`client.hris.benefits.individuals.enrolledIDs(benefit_id: string, entity_ids?: string[]): { benefit_id: string; individual_ids: string[]; }`\n\n**get** `/employer/benefits/{benefit_id}/enrolled`\n\nLists individuals currently enrolled in a given deduction.\n\n### Parameters\n\n- `benefit_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ benefit_id: string; individual_ids: string[]; }`\n\n - `benefit_id: string`\n - `individual_ids: string[]`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst response = await client.hris.benefits.individuals.enrolledIDs('benefit_id');\n\nconsole.log(response);\n```", perLanguage: { - go: { - method: 'client.HRIS.Benefits.Individuals.EnrolledIDs', + typescript: { + method: 'client.hris.benefits.individuals.enrolledIDs', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.HRIS.Benefits.Individuals.EnrolledIDs(\n\t\tcontext.TODO(),\n\t\t"benefit_id",\n\t\tfinchgo.HRISBenefitIndividualEnrolledIDsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response.BenefitID)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.hris.benefits.individuals.enrolledIDs('benefit_id');\n\nconsole.log(response.benefit_id);", }, - http: { + python: { + method: 'hris.benefits.individuals.enrolled_ids', example: - 'curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID/enrolled \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nresponse = client.hris.benefits.individuals.enrolled_ids(\n benefit_id="benefit_id",\n)\nprint(response.benefit_id)', }, java: { method: 'hris().benefits().individuals().enrolledIds', @@ -1110,20 +1111,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisBenefitIndividualEnrolledIdsParams\nimport com.tryfinch.api.models.IndividualEnrolledIdsResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val response: IndividualEnrolledIdsResponse = client.hris().benefits().individuals().enrolledIds("benefit_id")\n}', }, - python: { - method: 'hris.benefits.individuals.enrolled_ids', + go: { + method: 'client.HRIS.Benefits.Individuals.EnrolledIDs', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nresponse = client.hris.benefits.individuals.enrolled_ids(\n benefit_id="benefit_id",\n)\nprint(response.benefit_id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.HRIS.Benefits.Individuals.EnrolledIDs(\n\t\tcontext.TODO(),\n\t\t"benefit_id",\n\t\tfinchgo.HRISBenefitIndividualEnrolledIDsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response.BenefitID)\n}\n', }, ruby: { method: 'hris.benefits.individuals.enrolled_ids', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nresponse = finch.hris.benefits.individuals.enrolled_ids("benefit_id")\n\nputs(response)', }, - typescript: { - method: 'client.hris.benefits.individuals.enrolledIDs', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.hris.benefits.individuals.enrolledIDs('benefit_id');\n\nconsole.log(response.benefit_id);", + 'curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID/enrolled \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -1141,14 +1141,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## retrieve_many_benefits\n\n`client.hris.benefits.individuals.retrieveManyBenefits(benefit_id: string, entity_ids?: string[], individual_ids?: string): { body: object | object; code: number; individual_id: string; }`\n\n**get** `/employer/benefits/{benefit_id}/individuals`\n\nGet enrollment information for the given individuals.\n\n### Parameters\n\n- `benefit_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `individual_ids?: string`\n comma-delimited list of stable Finch uuids for each individual. If empty, defaults to all individuals\n\n### Returns\n\n- `{ body: { annual_maximum: number; catch_up: boolean; company_contribution: { amount: number; type: 'fixed'; } | { amount: number; type: 'percent'; } | { tiers: object[]; type: 'tiered'; }; employee_deduction: { amount: number; type: 'fixed'; } | { amount: number; type: 'percent'; }; hsa_contribution_limit?: 'individual' | 'family'; } | { code: number; message: string; name: string; finch_code?: string; }; code: number; individual_id: string; }`\n\n - `body: { annual_maximum: number; catch_up: boolean; company_contribution: { amount: number; type: 'fixed'; } | { amount: number; type: 'percent'; } | { tiers: { match: number; threshold: number; }[]; type: 'tiered'; }; employee_deduction: { amount: number; type: 'fixed'; } | { amount: number; type: 'percent'; }; hsa_contribution_limit?: 'individual' | 'family'; } | { code: number; message: string; name: string; finch_code?: string; }`\n - `code: number`\n - `individual_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const individualBenefit of client.hris.benefits.individuals.retrieveManyBenefits('benefit_id')) {\n console.log(individualBenefit);\n}\n```", perLanguage: { - go: { - method: 'client.HRIS.Benefits.Individuals.GetManyBenefits', + typescript: { + method: 'client.hris.benefits.individuals.retrieveManyBenefits', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Benefits.Individuals.GetManyBenefits(\n\t\tcontext.TODO(),\n\t\t"benefit_id",\n\t\tfinchgo.HRISBenefitIndividualGetManyBenefitsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const individualBenefit of client.hris.benefits.individuals.retrieveManyBenefits(\n 'benefit_id',\n)) {\n console.log(individualBenefit.individual_id);\n}", }, - http: { + python: { + method: 'hris.benefits.individuals.retrieve_many_benefits', example: - 'curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID/individuals \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.benefits.individuals.retrieve_many_benefits(\n benefit_id="benefit_id",\n)\npage = page.items[0]\nprint(page.individual_id)', }, java: { method: 'hris().benefits().individuals().retrieveManyBenefits', @@ -1160,20 +1161,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisBenefitIndividualRetrieveManyBenefitsPage\nimport com.tryfinch.api.models.HrisBenefitIndividualRetrieveManyBenefitsParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val page: HrisBenefitIndividualRetrieveManyBenefitsPage = client.hris().benefits().individuals().retrieveManyBenefits("benefit_id")\n}', }, - python: { - method: 'hris.benefits.individuals.retrieve_many_benefits', + go: { + method: 'client.HRIS.Benefits.Individuals.GetManyBenefits', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.benefits.individuals.retrieve_many_benefits(\n benefit_id="benefit_id",\n)\npage = page.items[0]\nprint(page.individual_id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Benefits.Individuals.GetManyBenefits(\n\t\tcontext.TODO(),\n\t\t"benefit_id",\n\t\tfinchgo.HRISBenefitIndividualGetManyBenefitsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', }, ruby: { method: 'hris.benefits.individuals.retrieve_many_benefits', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.benefits.individuals.retrieve_many_benefits("benefit_id")\n\nputs(page)', }, - typescript: { - method: 'client.hris.benefits.individuals.retrieveManyBenefits', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const individualBenefit of client.hris.benefits.individuals.retrieveManyBenefits(\n 'benefit_id',\n)) {\n console.log(individualBenefit.individual_id);\n}", + 'curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID/individuals \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -1195,9 +1195,10 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## enroll_many\n\n`client.hris.benefits.individuals.enrollMany(benefit_id: string, entity_ids?: string[], individuals?: { configuration?: { annual_contribution_limit?: 'individual' | 'family'; annual_maximum?: number; catch_up?: boolean; company_contribution?: object; effective_date?: string; employee_deduction?: object; }; individual_id?: string; }[]): { job_id: string; }`\n\n**post** `/employer/benefits/{benefit_id}/individuals`\n\nEnroll an individual into a deduction or contribution. This is an overwrite operation. If the employee is already enrolled, the enrollment amounts will be adjusted. Making the same request multiple times will not create new enrollments, but will continue to set the state of the existing enrollment.\n\n### Parameters\n\n- `benefit_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `individuals?: { configuration?: { annual_contribution_limit?: 'individual' | 'family'; annual_maximum?: number; catch_up?: boolean; company_contribution?: { amount?: number; tiers?: { match: number; threshold: number; }[]; type?: 'fixed' | 'percent' | 'tiered'; }; effective_date?: string; employee_deduction?: { amount?: number; type?: 'fixed' | 'percent'; }; }; individual_id?: string; }[]`\n Array of the individual_id to enroll and a configuration object.\n\n### Returns\n\n- `{ job_id: string; }`\n\n - `job_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst enrolledIndividualBenefitResponse = await client.hris.benefits.individuals.enrollMany('benefit_id');\n\nconsole.log(enrolledIndividualBenefitResponse);\n```", perLanguage: { - http: { + typescript: { + method: 'client.hris.benefits.individuals.enrollMany', example: - 'curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID/individuals \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst enrolledIndividualBenefitResponse = await client.hris.benefits.individuals.enrollMany(\n 'benefit_id',\n);\n\nconsole.log(enrolledIndividualBenefitResponse.job_id);", }, python: { method: 'hris.benefits.individuals.enroll_many', @@ -1209,10 +1210,9 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nenrolled_individual_benefit_response = finch.hris.benefits.individuals.enroll_many("benefit_id")\n\nputs(enrolled_individual_benefit_response)', }, - typescript: { - method: 'client.hris.benefits.individuals.enrollMany', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst enrolledIndividualBenefitResponse = await client.hris.benefits.individuals.enrollMany(\n 'benefit_id',\n);\n\nconsole.log(enrolledIndividualBenefitResponse.job_id);", + 'curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID/individuals \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -1229,14 +1229,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## unenroll_many\n\n`client.hris.benefits.individuals.unenrollMany(benefit_id: string, entity_ids?: string[], individual_ids?: string[]): { job_id: string; }`\n\n**delete** `/employer/benefits/{benefit_id}/individuals`\n\nUnenroll individuals from a deduction or contribution\n\n### Parameters\n\n- `benefit_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `individual_ids?: string[]`\n Array of individual_ids to unenroll.\n\n### Returns\n\n- `{ job_id: string; }`\n\n - `job_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst unenrolledIndividualBenefitResponse = await client.hris.benefits.individuals.unenrollMany('benefit_id');\n\nconsole.log(unenrolledIndividualBenefitResponse);\n```", perLanguage: { - go: { - method: 'client.HRIS.Benefits.Individuals.UnenrollMany', + typescript: { + method: 'client.hris.benefits.individuals.unenrollMany', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tunenrolledIndividualBenefitResponse, err := client.HRIS.Benefits.Individuals.UnenrollMany(\n\t\tcontext.TODO(),\n\t\t"benefit_id",\n\t\tfinchgo.HRISBenefitIndividualUnenrollManyParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", unenrolledIndividualBenefitResponse.JobID)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst unenrolledIndividualBenefitResponse = await client.hris.benefits.individuals.unenrollMany(\n 'benefit_id',\n);\n\nconsole.log(unenrolledIndividualBenefitResponse.job_id);", }, - http: { + python: { + method: 'hris.benefits.individuals.unenroll_many', example: - 'curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID/individuals \\\n -X DELETE \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nunenrolled_individual_benefit_response = client.hris.benefits.individuals.unenroll_many(\n benefit_id="benefit_id",\n)\nprint(unenrolled_individual_benefit_response.job_id)', }, java: { method: 'hris().benefits().individuals().unenrollMany', @@ -1248,20 +1249,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisBenefitIndividualUnenrollManyParams\nimport com.tryfinch.api.models.UnenrolledIndividualBenefitResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val unenrolledIndividualBenefitResponse: UnenrolledIndividualBenefitResponse = client.hris().benefits().individuals().unenrollMany("benefit_id")\n}', }, - python: { - method: 'hris.benefits.individuals.unenroll_many', + go: { + method: 'client.HRIS.Benefits.Individuals.UnenrollMany', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nunenrolled_individual_benefit_response = client.hris.benefits.individuals.unenroll_many(\n benefit_id="benefit_id",\n)\nprint(unenrolled_individual_benefit_response.job_id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tunenrolledIndividualBenefitResponse, err := client.HRIS.Benefits.Individuals.UnenrollMany(\n\t\tcontext.TODO(),\n\t\t"benefit_id",\n\t\tfinchgo.HRISBenefitIndividualUnenrollManyParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", unenrolledIndividualBenefitResponse.JobID)\n}\n', }, ruby: { method: 'hris.benefits.individuals.unenroll_many', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nunenrolled_individual_benefit_response = finch.hris.benefits.individuals.unenroll_many("benefit_id")\n\nputs(unenrolled_individual_benefit_response)', - }, - typescript: { - method: 'client.hris.benefits.individuals.unenrollMany', + }, + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst unenrolledIndividualBenefitResponse = await client.hris.benefits.individuals.unenrollMany(\n 'benefit_id',\n);\n\nconsole.log(unenrolledIndividualBenefitResponse.job_id);", + 'curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID/individuals \\\n -X DELETE \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -1278,13 +1278,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## list\n\n`client.providers.list(): { id: string; display_name: string; products: string[]; authentication_methods?: object[]; beta?: boolean; icon?: string; logo?: string; manual?: boolean; mfa_required?: boolean; primary_color?: string; }`\n\n**get** `/providers`\n\nReturn details on all available payroll and HR systems.\n\n### Returns\n\n- `{ id: string; display_name: string; products: string[]; authentication_methods?: { type: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth' | 'api'; benefits_support?: object; supported_fields?: object; }[]; beta?: boolean; icon?: string; logo?: string; manual?: boolean; mfa_required?: boolean; primary_color?: string; }`\n\n - `id: string`\n - `display_name: string`\n - `products: string[]`\n - `authentication_methods?: { type: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth' | 'api'; benefits_support?: object; supported_fields?: object; }[]`\n - `beta?: boolean`\n - `icon?: string`\n - `logo?: string`\n - `manual?: boolean`\n - `mfa_required?: boolean`\n - `primary_color?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const providerListResponse of client.providers.list()) {\n console.log(providerListResponse);\n}\n```", perLanguage: { - go: { - method: 'client.Providers.List', + typescript: { + method: 'client.providers.list', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient()\n\tpage, err := client.Providers.List(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const providerListResponse of client.providers.list()) {\n console.log(providerListResponse.id);\n}", }, - http: { - example: "curl https://api.tryfinch.com/providers \\\n -H 'Finch-API-Version: 2020-09-17'", + python: { + method: 'providers.list', + example: + 'from finch import Finch\n\nclient = Finch()\npage = client.providers.list()\npage = page.items[0]\nprint(page.id)', }, java: { method: 'providers().list', @@ -1296,20 +1298,18 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.ProviderListPage\nimport com.tryfinch.api.models.ProviderListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.fromEnv()\n\n val page: ProviderListPage = client.providers().list()\n}', }, - python: { - method: 'providers.list', + go: { + method: 'client.Providers.List', example: - 'from finch import Finch\n\nclient = Finch()\npage = client.providers.list()\npage = page.items[0]\nprint(page.id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient()\n\tpage, err := client.Providers.List(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', }, ruby: { method: 'providers.list', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new\n\npage = finch.providers.list\n\nputs(page)', }, - typescript: { - method: 'client.providers.list', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const providerListResponse of client.providers.list()) {\n console.log(providerListResponse.id);\n}", + http: { + example: "curl https://api.tryfinch.com/providers \\\n -H 'Finch-API-Version: 2020-09-17'", }, }, }, @@ -1326,14 +1326,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## introspect\n\n`client.account.introspect(): { id: string; client_id: string; client_type: 'development' | 'production' | 'sandbox'; connection_id: string; connection_status: object; connection_type: 'finch' | 'provider'; products: string[]; provider_id: string; account_id?: string; authentication_methods?: object[]; company_id?: string; customer_email?: string; customer_id?: string; customer_name?: string; entities?: object[]; manual?: boolean; payroll_provider_id?: string; username?: string; }`\n\n**get** `/introspect`\n\nRead account information associated with an `access_token`\n\n### Returns\n\n- `{ id: string; client_id: string; client_type: 'development' | 'production' | 'sandbox'; connection_id: string; connection_status: { status: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth'; last_successful_sync?: string | string; message?: string; }; connection_type: 'finch' | 'provider'; products: string[]; provider_id: string; account_id?: string; authentication_methods?: { type: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth'; connection_status?: { status: connection_status_type; last_successful_sync?: string | string; message?: string; }; products?: string[]; }[]; company_id?: string; customer_email?: string; customer_id?: string; customer_name?: string; entities?: { id: string; name: string; source_id: string; status: string; }[]; manual?: boolean; payroll_provider_id?: string; username?: string; }`\n\n - `id: string`\n - `client_id: string`\n - `client_type: 'development' | 'production' | 'sandbox'`\n - `connection_id: string`\n - `connection_status: { status: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth'; last_successful_sync?: string | string; message?: string; }`\n - `connection_type: 'finch' | 'provider'`\n - `products: string[]`\n - `provider_id: string`\n - `account_id?: string`\n - `authentication_methods?: { type: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth'; connection_status?: { status: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth'; last_successful_sync?: string | string; message?: string; }; products?: string[]; }[]`\n - `company_id?: string`\n - `customer_email?: string`\n - `customer_id?: string`\n - `customer_name?: string`\n - `entities?: { id: string; name: string; source_id: string; status: string; }[]`\n - `manual?: boolean`\n - `payroll_provider_id?: string`\n - `username?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst introspection = await client.account.introspect();\n\nconsole.log(introspection);\n```", perLanguage: { - go: { - method: 'client.Account.Introspect', + typescript: { + method: 'client.account.introspect', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tintrospection, err := client.Account.Introspect(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", introspection.ID)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst introspection = await client.account.introspect();\n\nconsole.log(introspection.id);", }, - http: { + python: { + method: 'account.introspect', example: - 'curl https://api.tryfinch.com/introspect \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nintrospection = client.account.introspect()\nprint(introspection.id)', }, java: { method: 'account().introspect', @@ -1345,20 +1346,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AccountIntrospectParams\nimport com.tryfinch.api.models.Introspection\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val introspection: Introspection = client.account().introspect()\n}', }, - python: { - method: 'account.introspect', + go: { + method: 'client.Account.Introspect', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nintrospection = client.account.introspect()\nprint(introspection.id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tintrospection, err := client.Account.Introspect(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", introspection.ID)\n}\n', }, ruby: { method: 'account.introspect', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nintrospection = finch.account.introspect\n\nputs(introspection)', }, - typescript: { - method: 'client.account.introspect', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst introspection = await client.account.introspect();\n\nconsole.log(introspection.id);", + 'curl https://api.tryfinch.com/introspect \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -1374,14 +1374,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## disconnect\n\n`client.account.disconnect(): { status: string; }`\n\n**post** `/disconnect`\n\nDisconnect one or more `access_token`s from your application.\n\n### Returns\n\n- `{ status: string; }`\n\n - `status: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst disconnectResponse = await client.account.disconnect();\n\nconsole.log(disconnectResponse);\n```", perLanguage: { - go: { - method: 'client.Account.Disconnect', + typescript: { + method: 'client.account.disconnect', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tdisconnectResponse, err := client.Account.Disconnect(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", disconnectResponse.Status)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst disconnectResponse = await client.account.disconnect();\n\nconsole.log(disconnectResponse.status);", }, - http: { + python: { + method: 'account.disconnect', example: - 'curl https://api.tryfinch.com/disconnect \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\ndisconnect_response = client.account.disconnect()\nprint(disconnect_response.status)', }, java: { method: 'account().disconnect', @@ -1393,20 +1394,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AccountDisconnectParams\nimport com.tryfinch.api.models.DisconnectResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val disconnectResponse: DisconnectResponse = client.account().disconnect()\n}', }, - python: { - method: 'account.disconnect', + go: { + method: 'client.Account.Disconnect', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\ndisconnect_response = client.account.disconnect()\nprint(disconnect_response.status)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tdisconnectResponse, err := client.Account.Disconnect(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", disconnectResponse.Status)\n}\n', }, ruby: { method: 'account.disconnect', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\ndisconnect_response = finch.account.disconnect\n\nputs(disconnect_response)', }, - typescript: { - method: 'client.account.disconnect', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst disconnectResponse = await client.account.disconnect();\n\nconsole.log(disconnectResponse.status);", + 'curl https://api.tryfinch.com/disconnect \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -1431,14 +1431,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## forward\n\n`client.requestForwarding.forward(method: string, route: string, data?: string, params?: object, request_headers?: object): { request: object; statusCode: number; data?: string; headers?: object; }`\n\n**post** `/forward`\n\nThe Forward API allows you to make direct requests to an employment system. If Finch's unified API\ndoesn't have a data model that cleanly fits your needs, then Forward allows you to push or pull\ndata models directly against an integration's API.\n\n### Parameters\n\n- `method: string`\n The HTTP method for the forwarded request. Valid values include: `GET` , `POST` , `PUT` , `DELETE` , and `PATCH`.\n\n- `route: string`\n The URL route path for the forwarded request. This value must begin with a forward-slash ( / ) and may only contain alphanumeric characters, hyphens, and underscores.\n\n- `data?: string`\n The body for the forwarded request. This value must be specified as either a string or a valid JSON object.\n\n- `params?: object`\n The query parameters for the forwarded request. This value must be specified as a valid JSON object rather than a query string.\n\n- `request_headers?: object`\n The HTTP headers to include on the forwarded request. This value must be specified as an object of key-value pairs. Example: `{\"Content-Type\": \"application/xml\", \"X-API-Version\": \"v1\" }`\n\n### Returns\n\n- `{ request: { method: string; route: string; data?: string | object; headers?: object; params?: object; }; statusCode: number; data?: string; headers?: object; }`\n\n - `request: { method: string; route: string; data?: string | object; headers?: object; params?: object; }`\n - `statusCode: number`\n - `data?: string`\n - `headers?: object`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst response = await client.requestForwarding.forward({ method: 'method', route: 'route' });\n\nconsole.log(response);\n```", perLanguage: { - go: { - method: 'client.RequestForwarding.Forward', + typescript: { + method: 'client.requestForwarding.forward', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.RequestForwarding.Forward(context.TODO(), finchgo.RequestForwardingForwardParams{\n\t\tMethod: finchgo.F("method"),\n\t\tRoute: finchgo.F("route"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response.Request)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.requestForwarding.forward({ method: 'method', route: 'route' });\n\nconsole.log(response.request);", }, - http: { + python: { + method: 'request_forwarding.forward', example: - 'curl https://api.tryfinch.com/forward \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "method": "method",\n "route": "route"\n }\'', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nresponse = client.request_forwarding.forward(\n method="method",\n route="route",\n)\nprint(response.request)', }, java: { method: 'requestForwarding().forward', @@ -1450,20 +1451,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.RequestForwardingForwardParams\nimport com.tryfinch.api.models.RequestForwardingForwardResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val params: RequestForwardingForwardParams = RequestForwardingForwardParams.builder()\n .method("method")\n .route("route")\n .build()\n val response: RequestForwardingForwardResponse = client.requestForwarding().forward(params)\n}', }, - python: { - method: 'request_forwarding.forward', + go: { + method: 'client.RequestForwarding.Forward', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nresponse = client.request_forwarding.forward(\n method="method",\n route="route",\n)\nprint(response.request)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.RequestForwarding.Forward(context.TODO(), finchgo.RequestForwardingForwardParams{\n\t\tMethod: finchgo.F("method"),\n\t\tRoute: finchgo.F("route"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response.Request)\n}\n', }, ruby: { method: 'request_forwarding.forward', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nresponse = finch.request_forwarding.forward(method_: "method", route: "route")\n\nputs(response)', }, - typescript: { - method: 'client.requestForwarding.forward', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.requestForwarding.forward({ method: 'method', route: 'route' });\n\nconsole.log(response.request);", + 'curl https://api.tryfinch.com/forward \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "method": "method",\n "route": "route"\n }\'', }, }, }, @@ -1482,14 +1482,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## list\n\n`client.jobs.automated.list(limit?: number, offset?: number): { data: automated_async_job[]; meta: object; }`\n\n**get** `/jobs/automated`\n\nGet all automated jobs. Automated jobs are completed by a machine. By default, jobs are sorted in descending order by submission time. For scheduled jobs such as data syncs, only the next scheduled job is shown.\n\n### Parameters\n\n- `limit?: number`\n Number of items to return\n\n- `offset?: number`\n Index to start from (defaults to 0)\n\n### Returns\n\n- `{ data: { completed_at: string; created_at: string; job_id: string; job_url: string; params: object; scheduled_at: string; started_at: string; status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'; type: 'data_sync_all' | 'w4_form_employee_sync'; }[]; meta: { quotas?: { data_sync_all?: object; }; }; }`\n\n - `data: { completed_at: string; created_at: string; job_id: string; job_url: string; params: { individual_id?: string; }; scheduled_at: string; started_at: string; status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'; type: 'data_sync_all' | 'w4_form_employee_sync'; }[]`\n - `meta: { quotas?: { data_sync_all?: { allowed_refreshes?: number; remaining_refreshes?: number; }; }; }`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst automateds = await client.jobs.automated.list();\n\nconsole.log(automateds);\n```", perLanguage: { - go: { - method: 'client.Jobs.Automated.List', + typescript: { + method: 'client.jobs.automated.list', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tautomateds, err := client.Jobs.Automated.List(context.TODO(), finchgo.JobAutomatedListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", automateds.Data)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst automateds = await client.jobs.automated.list();\n\nconsole.log(automateds.data);", }, - http: { + python: { + method: 'jobs.automated.list', example: - 'curl https://api.tryfinch.com/jobs/automated \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nautomateds = client.jobs.automated.list()\nprint(automateds.data)', }, java: { method: 'jobs().automated().list', @@ -1501,20 +1502,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AutomatedListResponse\nimport com.tryfinch.api.models.JobAutomatedListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val automateds: AutomatedListResponse = client.jobs().automated().list()\n}', }, - python: { - method: 'jobs.automated.list', + go: { + method: 'client.Jobs.Automated.List', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nautomateds = client.jobs.automated.list()\nprint(automateds.data)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tautomateds, err := client.Jobs.Automated.List(context.TODO(), finchgo.JobAutomatedListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", automateds.Data)\n}\n', }, ruby: { method: 'jobs.automated.list', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nautomateds = finch.jobs.automated.list\n\nputs(automateds)', }, - typescript: { - method: 'client.jobs.automated.list', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst automateds = await client.jobs.automated.list();\n\nconsole.log(automateds.data);", + 'curl https://api.tryfinch.com/jobs/automated \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -1533,14 +1533,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ response: '{ allowed_refreshes: number; remaining_refreshes: number; job_id?: string; job_url?: string; retry_at?: string; }', perLanguage: { - go: { - method: 'client.Jobs.Automated.New', + typescript: { + method: 'client.jobs.automated.create', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tautomated, err := client.Jobs.Automated.New(context.TODO(), finchgo.JobAutomatedNewParamsDataSyncAll{\n\t\tType: finchgo.F(finchgo.JobAutomatedNewParamsDataSyncAllTypeDataSyncAll),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", automated.JobID)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst automated = await client.jobs.automated.create({ type: 'data_sync_all' });\n\nconsole.log(automated.job_id);", }, - http: { + python: { + method: 'jobs.automated.create', example: - 'curl https://api.tryfinch.com/jobs/automated \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "type": "data_sync_all"\n }\'', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nautomated = client.jobs.automated.create(\n type="data_sync_all",\n)\nprint(automated.job_id)', }, java: { method: 'jobs().automated().create', @@ -1552,20 +1553,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.core.JsonValue\nimport com.tryfinch.api.models.AutomatedCreateResponse\nimport com.tryfinch.api.models.JobAutomatedCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val params: JobAutomatedCreateParams.Body = JobAutomatedCreateParams.Body.ofDataSyncAll()\n val automated: AutomatedCreateResponse = client.jobs().automated().create(params)\n}', }, - python: { - method: 'jobs.automated.create', + go: { + method: 'client.Jobs.Automated.New', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nautomated = client.jobs.automated.create(\n type="data_sync_all",\n)\nprint(automated.job_id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tautomated, err := client.Jobs.Automated.New(context.TODO(), finchgo.JobAutomatedNewParamsDataSyncAll{\n\t\tType: finchgo.F(finchgo.JobAutomatedNewParamsDataSyncAllTypeDataSyncAll),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", automated.JobID)\n}\n', }, ruby: { method: 'jobs.automated.create', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nautomated = finch.jobs.automated.create(body: {type: :data_sync_all})\n\nputs(automated)', }, - typescript: { - method: 'client.jobs.automated.create', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst automated = await client.jobs.automated.create({ type: 'data_sync_all' });\n\nconsole.log(automated.job_id);", + 'curl https://api.tryfinch.com/jobs/automated \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "type": "data_sync_all"\n }\'', }, }, }, @@ -1583,14 +1583,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## retrieve\n\n`client.jobs.automated.retrieve(job_id: string): { completed_at: string; created_at: string; job_id: string; job_url: string; params: object; scheduled_at: string; started_at: string; status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'; type: 'data_sync_all' | 'w4_form_employee_sync'; }`\n\n**get** `/jobs/automated/{job_id}`\n\nGet an automated job by `job_id`.\n\n### Parameters\n\n- `job_id: string`\n\n### Returns\n\n- `{ completed_at: string; created_at: string; job_id: string; job_url: string; params: { individual_id?: string; }; scheduled_at: string; started_at: string; status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'; type: 'data_sync_all' | 'w4_form_employee_sync'; }`\n\n - `completed_at: string`\n - `created_at: string`\n - `job_id: string`\n - `job_url: string`\n - `params: { individual_id?: string; }`\n - `scheduled_at: string`\n - `started_at: string`\n - `status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'`\n - `type: 'data_sync_all' | 'w4_form_employee_sync'`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst automatedAsyncJob = await client.jobs.automated.retrieve('job_id');\n\nconsole.log(automatedAsyncJob);\n```", perLanguage: { - go: { - method: 'client.Jobs.Automated.Get', + typescript: { + method: 'client.jobs.automated.retrieve', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tautomatedAsyncJob, err := client.Jobs.Automated.Get(context.TODO(), "job_id")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", automatedAsyncJob.JobID)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst automatedAsyncJob = await client.jobs.automated.retrieve('job_id');\n\nconsole.log(automatedAsyncJob.job_id);", }, - http: { + python: { + method: 'jobs.automated.retrieve', example: - 'curl https://api.tryfinch.com/jobs/automated/$JOB_ID \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nautomated_async_job = client.jobs.automated.retrieve(\n "job_id",\n)\nprint(automated_async_job.job_id)', }, java: { method: 'jobs().automated().retrieve', @@ -1602,20 +1603,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AutomatedAsyncJob\nimport com.tryfinch.api.models.JobAutomatedRetrieveParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val automatedAsyncJob: AutomatedAsyncJob = client.jobs().automated().retrieve("job_id")\n}', }, - python: { - method: 'jobs.automated.retrieve', + go: { + method: 'client.Jobs.Automated.Get', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nautomated_async_job = client.jobs.automated.retrieve(\n "job_id",\n)\nprint(automated_async_job.job_id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tautomatedAsyncJob, err := client.Jobs.Automated.Get(context.TODO(), "job_id")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", automatedAsyncJob.JobID)\n}\n', }, ruby: { method: 'jobs.automated.retrieve', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nautomated_async_job = finch.jobs.automated.retrieve("job_id")\n\nputs(automated_async_job)', }, - typescript: { - method: 'client.jobs.automated.retrieve', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst automatedAsyncJob = await client.jobs.automated.retrieve('job_id');\n\nconsole.log(automatedAsyncJob.job_id);", + 'curl https://api.tryfinch.com/jobs/automated/$JOB_ID \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -1633,14 +1633,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## retrieve\n\n`client.jobs.manual.retrieve(job_id: string): { body: object[]; job_id: string; status: 'pending' | 'in_progress' | 'error' | 'complete'; }`\n\n**get** `/jobs/manual/{job_id}`\n\nCheck the status and outcome of a job by `job_id`. This includes all deductions jobs including those for both automated and assisted integrations.\n\n### Parameters\n\n- `job_id: string`\n\n### Returns\n\n- `{ body: object[]; job_id: string; status: 'pending' | 'in_progress' | 'error' | 'complete'; }`\n\n - `body: object[]`\n - `job_id: string`\n - `status: 'pending' | 'in_progress' | 'error' | 'complete'`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst manualAsyncJob = await client.jobs.manual.retrieve('job_id');\n\nconsole.log(manualAsyncJob);\n```", perLanguage: { - go: { - method: 'client.Jobs.Manual.Get', + typescript: { + method: 'client.jobs.manual.retrieve', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmanualAsyncJob, err := client.Jobs.Manual.Get(context.TODO(), "job_id")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", manualAsyncJob.JobID)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst manualAsyncJob = await client.jobs.manual.retrieve('job_id');\n\nconsole.log(manualAsyncJob.job_id);", }, - http: { + python: { + method: 'jobs.manual.retrieve', example: - 'curl https://api.tryfinch.com/jobs/manual/$JOB_ID \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nmanual_async_job = client.jobs.manual.retrieve(\n "job_id",\n)\nprint(manual_async_job.job_id)', }, java: { method: 'jobs().manual().retrieve', @@ -1652,20 +1653,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.JobManualRetrieveParams\nimport com.tryfinch.api.models.ManualAsyncJob\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val manualAsyncJob: ManualAsyncJob = client.jobs().manual().retrieve("job_id")\n}', }, - python: { - method: 'jobs.manual.retrieve', + go: { + method: 'client.Jobs.Manual.Get', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nmanual_async_job = client.jobs.manual.retrieve(\n "job_id",\n)\nprint(manual_async_job.job_id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmanualAsyncJob, err := client.Jobs.Manual.Get(context.TODO(), "job_id")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", manualAsyncJob.JobID)\n}\n', }, ruby: { method: 'jobs.manual.retrieve', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nmanual_async_job = finch.jobs.manual.retrieve("job_id")\n\nputs(manual_async_job)', }, - typescript: { - method: 'client.jobs.manual.retrieve', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst manualAsyncJob = await client.jobs.manual.retrieve('job_id');\n\nconsole.log(manualAsyncJob.job_id);", + 'curl https://api.tryfinch.com/jobs/manual/$JOB_ID \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -1688,14 +1688,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## create\n\n`client.sandbox.connections.create(provider_id: string, authentication_type?: 'credential' | 'api_token' | 'oauth' | 'assisted', employee_size?: number, products?: string[]): { access_token: string; account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; token_type?: string; }`\n\n**post** `/sandbox/connections`\n\nCreate a new connection (new company/provider pair) with a new account\n\n### Parameters\n\n- `provider_id: string`\n The provider associated with the connection\n\n- `authentication_type?: 'credential' | 'api_token' | 'oauth' | 'assisted'`\n\n- `employee_size?: number`\n Optional: the size of the employer to be created with this connection. Defaults to 20. Note that if this is higher than 100, historical payroll data will not be generated, and instead only one pay period will be created.\n\n- `products?: string[]`\n\n### Returns\n\n- `{ access_token: string; account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; token_type?: string; }`\n\n - `access_token: string`\n - `account_id: string`\n - `authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'`\n - `company_id: string`\n - `connection_id: string`\n - `entity_id: string`\n - `products: string[]`\n - `provider_id: string`\n - `token_type?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst connection = await client.sandbox.connections.create({ provider_id: 'provider_id' });\n\nconsole.log(connection);\n```", perLanguage: { - go: { - method: 'client.Sandbox.Connections.New', + typescript: { + method: 'client.sandbox.connections.create', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithClientID("4ab15e51-11ad-49f4-acae-f343b7794375"),\n\t\toption.WithClientSecret("My Client Secret"),\n\t)\n\tconnection, err := client.Sandbox.Connections.New(context.TODO(), finchgo.SandboxConnectionNewParams{\n\t\tProviderID: finchgo.F("provider_id"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", connection.AccountID)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n clientID: process.env['FINCH_CLIENT_ID'], // This is the default and can be omitted\n clientSecret: process.env['FINCH_CLIENT_SECRET'], // This is the default and can be omitted\n});\n\nconst connection = await client.sandbox.connections.create({ provider_id: 'provider_id' });\n\nconsole.log(connection.account_id);", }, - http: { + python: { + method: 'sandbox.connections.create', example: - 'curl https://api.tryfinch.com/sandbox/connections \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -u "$FINCH_CLIENT_ID:FINCH_CLIENT_SECRET" \\\n -d \'{\n "provider_id": "provider_id"\n }\'', + 'import os\nfrom finch import Finch\n\nclient = Finch(\n client_id=os.environ.get("FINCH_CLIENT_ID"), # This is the default and can be omitted\n client_secret=os.environ.get("FINCH_CLIENT_SECRET"), # This is the default and can be omitted\n)\nconnection = client.sandbox.connections.create(\n provider_id="provider_id",\n)\nprint(connection.account_id)', }, java: { method: 'sandbox().connections().create', @@ -1707,20 +1708,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.ConnectionCreateResponse\nimport com.tryfinch.api.models.SandboxConnectionCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.fromEnv()\n\n val params: SandboxConnectionCreateParams = SandboxConnectionCreateParams.builder()\n .providerId("provider_id")\n .build()\n val connection: ConnectionCreateResponse = client.sandbox().connections().create(params)\n}', }, - python: { - method: 'sandbox.connections.create', + go: { + method: 'client.Sandbox.Connections.New', example: - 'import os\nfrom finch import Finch\n\nclient = Finch(\n client_id=os.environ.get("FINCH_CLIENT_ID"), # This is the default and can be omitted\n client_secret=os.environ.get("FINCH_CLIENT_SECRET"), # This is the default and can be omitted\n)\nconnection = client.sandbox.connections.create(\n provider_id="provider_id",\n)\nprint(connection.account_id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithClientID("4ab15e51-11ad-49f4-acae-f343b7794375"),\n\t\toption.WithClientSecret("My Client Secret"),\n\t)\n\tconnection, err := client.Sandbox.Connections.New(context.TODO(), finchgo.SandboxConnectionNewParams{\n\t\tProviderID: finchgo.F("provider_id"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", connection.AccountID)\n}\n', }, ruby: { method: 'sandbox.connections.create', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(client_id: "4ab15e51-11ad-49f4-acae-f343b7794375", client_secret: "My Client Secret")\n\nconnection = finch.sandbox.connections.create(provider_id: "provider_id")\n\nputs(connection)', }, - typescript: { - method: 'client.sandbox.connections.create', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n clientID: process.env['FINCH_CLIENT_ID'], // This is the default and can be omitted\n clientSecret: process.env['FINCH_CLIENT_SECRET'], // This is the default and can be omitted\n});\n\nconst connection = await client.sandbox.connections.create({ provider_id: 'provider_id' });\n\nconsole.log(connection.account_id);", + 'curl https://api.tryfinch.com/sandbox/connections \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -u "$FINCH_CLIENT_ID:FINCH_CLIENT_SECRET" \\\n -d \'{\n "provider_id": "provider_id"\n }\'', }, }, }, @@ -1743,14 +1743,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## create\n\n`client.sandbox.connections.accounts.create(company_id: string, provider_id: string, authentication_type?: 'credential' | 'api_token' | 'oauth' | 'assisted', products?: string[]): { access_token: string; account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; }`\n\n**post** `/sandbox/connections/accounts`\n\nCreate a new account for an existing connection (company/provider pair)\n\n### Parameters\n\n- `company_id: string`\n\n- `provider_id: string`\n The provider associated with the `access_token`\n\n- `authentication_type?: 'credential' | 'api_token' | 'oauth' | 'assisted'`\n\n- `products?: string[]`\n Optional, defaults to Organization products (`company`, `directory`, `employment`, `individual`)\n\n### Returns\n\n- `{ access_token: string; account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; }`\n\n - `access_token: string`\n - `account_id: string`\n - `authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'`\n - `company_id: string`\n - `connection_id: string`\n - `entity_id: string`\n - `products: string[]`\n - `provider_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst account = await client.sandbox.connections.accounts.create({ company_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', provider_id: 'provider_id' });\n\nconsole.log(account);\n```", perLanguage: { - go: { - method: 'client.Sandbox.Connections.Accounts.New', + typescript: { + method: 'client.sandbox.connections.accounts.create', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithClientID("4ab15e51-11ad-49f4-acae-f343b7794375"),\n\t\toption.WithClientSecret("My Client Secret"),\n\t)\n\taccount, err := client.Sandbox.Connections.Accounts.New(context.TODO(), finchgo.SandboxConnectionAccountNewParams{\n\t\tCompanyID: finchgo.F("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"),\n\t\tProviderID: finchgo.F("provider_id"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", account.AccountID)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n clientID: process.env['FINCH_CLIENT_ID'], // This is the default and can be omitted\n clientSecret: process.env['FINCH_CLIENT_SECRET'], // This is the default and can be omitted\n});\n\nconst account = await client.sandbox.connections.accounts.create({\n company_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',\n provider_id: 'provider_id',\n});\n\nconsole.log(account.account_id);", }, - http: { + python: { + method: 'sandbox.connections.accounts.create', example: - 'curl https://api.tryfinch.com/sandbox/connections/accounts \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -u "$FINCH_CLIENT_ID:FINCH_CLIENT_SECRET" \\\n -d \'{\n "company_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n "provider_id": "provider_id"\n }\'', + 'import os\nfrom finch import Finch\n\nclient = Finch(\n client_id=os.environ.get("FINCH_CLIENT_ID"), # This is the default and can be omitted\n client_secret=os.environ.get("FINCH_CLIENT_SECRET"), # This is the default and can be omitted\n)\naccount = client.sandbox.connections.accounts.create(\n company_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n provider_id="provider_id",\n)\nprint(account.account_id)', }, java: { method: 'sandbox().connections().accounts().create', @@ -1762,20 +1763,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AccountCreateResponse\nimport com.tryfinch.api.models.SandboxConnectionAccountCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.fromEnv()\n\n val params: SandboxConnectionAccountCreateParams = SandboxConnectionAccountCreateParams.builder()\n .companyId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")\n .providerId("provider_id")\n .build()\n val account: AccountCreateResponse = client.sandbox().connections().accounts().create(params)\n}', }, - python: { - method: 'sandbox.connections.accounts.create', + go: { + method: 'client.Sandbox.Connections.Accounts.New', example: - 'import os\nfrom finch import Finch\n\nclient = Finch(\n client_id=os.environ.get("FINCH_CLIENT_ID"), # This is the default and can be omitted\n client_secret=os.environ.get("FINCH_CLIENT_SECRET"), # This is the default and can be omitted\n)\naccount = client.sandbox.connections.accounts.create(\n company_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n provider_id="provider_id",\n)\nprint(account.account_id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithClientID("4ab15e51-11ad-49f4-acae-f343b7794375"),\n\t\toption.WithClientSecret("My Client Secret"),\n\t)\n\taccount, err := client.Sandbox.Connections.Accounts.New(context.TODO(), finchgo.SandboxConnectionAccountNewParams{\n\t\tCompanyID: finchgo.F("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"),\n\t\tProviderID: finchgo.F("provider_id"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", account.AccountID)\n}\n', }, ruby: { method: 'sandbox.connections.accounts.create', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(client_id: "4ab15e51-11ad-49f4-acae-f343b7794375", client_secret: "My Client Secret")\n\naccount = finch.sandbox.connections.accounts.create(\n company_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n provider_id: "provider_id"\n)\n\nputs(account)', }, - typescript: { - method: 'client.sandbox.connections.accounts.create', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n clientID: process.env['FINCH_CLIENT_ID'], // This is the default and can be omitted\n clientSecret: process.env['FINCH_CLIENT_SECRET'], // This is the default and can be omitted\n});\n\nconst account = await client.sandbox.connections.accounts.create({\n company_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',\n provider_id: 'provider_id',\n});\n\nconsole.log(account.account_id);", + 'curl https://api.tryfinch.com/sandbox/connections/accounts \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -u "$FINCH_CLIENT_ID:FINCH_CLIENT_SECRET" \\\n -d \'{\n "company_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n "provider_id": "provider_id"\n }\'', }, }, }, @@ -1796,14 +1796,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## update\n\n`client.sandbox.connections.accounts.update(connection_status?: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth'): { account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; }`\n\n**put** `/sandbox/connections/accounts`\n\nUpdate an existing sandbox account. Change the connection status to understand how the Finch API responds.\n\n### Parameters\n\n- `connection_status?: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth'`\n\n### Returns\n\n- `{ account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; }`\n\n - `account_id: string`\n - `authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'`\n - `company_id: string`\n - `connection_id: string`\n - `entity_id: string`\n - `products: string[]`\n - `provider_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst account = await client.sandbox.connections.accounts.update();\n\nconsole.log(account);\n```", perLanguage: { - go: { - method: 'client.Sandbox.Connections.Accounts.Update', + typescript: { + method: 'client.sandbox.connections.accounts.update', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n\t"github.com/Finch-API/finch-api-go/shared"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\taccount, err := client.Sandbox.Connections.Accounts.Update(context.TODO(), finchgo.SandboxConnectionAccountUpdateParams{\n\t\tConnectionStatus: finchgo.F(shared.ConnectionStatusTypeReauth),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", account.AccountID)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst account = await client.sandbox.connections.accounts.update({ connection_status: 'reauth' });\n\nconsole.log(account.account_id);", }, - http: { + python: { + method: 'sandbox.connections.accounts.update', example: - 'curl https://api.tryfinch.com/sandbox/connections/accounts \\\n -X PUT \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\naccount = client.sandbox.connections.accounts.update(\n connection_status="reauth",\n)\nprint(account.account_id)', }, java: { method: 'sandbox().connections().accounts().update', @@ -1815,20 +1816,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AccountUpdateResponse\nimport com.tryfinch.api.models.SandboxConnectionAccountUpdateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val account: AccountUpdateResponse = client.sandbox().connections().accounts().update()\n}', }, - python: { - method: 'sandbox.connections.accounts.update', + go: { + method: 'client.Sandbox.Connections.Accounts.Update', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\naccount = client.sandbox.connections.accounts.update(\n connection_status="reauth",\n)\nprint(account.account_id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n\t"github.com/Finch-API/finch-api-go/shared"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\taccount, err := client.Sandbox.Connections.Accounts.Update(context.TODO(), finchgo.SandboxConnectionAccountUpdateParams{\n\t\tConnectionStatus: finchgo.F(shared.ConnectionStatusTypeReauth),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", account.AccountID)\n}\n', }, ruby: { method: 'sandbox.connections.accounts.update', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\naccount = finch.sandbox.connections.accounts.update\n\nputs(account)', }, - typescript: { - method: 'client.sandbox.connections.accounts.update', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst account = await client.sandbox.connections.accounts.update({ connection_status: 'reauth' });\n\nconsole.log(account.account_id);", + 'curl https://api.tryfinch.com/sandbox/connections/accounts \\\n -X PUT \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -1855,14 +1855,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## update\n\n`client.sandbox.company.update(accounts: { account_name?: string; account_number?: string; account_type?: 'checking' | 'savings'; institution_name?: string; routing_number?: string; }[], departments: { name?: string; parent?: { name?: string; }; }[], ein: string, entity: { subtype?: 's_corporation' | 'c_corporation' | 'b_corporation'; type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }, legal_name: string, locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[], primary_email: string, primary_phone_number: string): { accounts: object[]; departments: object[]; ein: string; entity: object; legal_name: string; locations: location[]; primary_email: string; primary_phone_number: string; }`\n\n**put** `/sandbox/company`\n\nUpdate a sandbox company's data\n\n### Parameters\n\n- `accounts: { account_name?: string; account_number?: string; account_type?: 'checking' | 'savings'; institution_name?: string; routing_number?: string; }[]`\n An array of bank account objects associated with the payroll/HRIS system.\n\n- `departments: { name?: string; parent?: { name?: string; }; }[]`\n The array of company departments.\n\n- `ein: string`\n The employer identification number.\n\n- `entity: { subtype?: 's_corporation' | 'c_corporation' | 'b_corporation'; type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }`\n The entity type object.\n - `subtype?: 's_corporation' | 'c_corporation' | 'b_corporation'`\n The tax payer subtype of the company.\n - `type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'`\n The tax payer type of the company.\n\n- `legal_name: string`\n The legal name of the company.\n\n- `locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]`\n\n- `primary_email: string`\n The email of the main administrator on the account.\n\n- `primary_phone_number: string`\n The phone number of the main administrator on the account. Format: E.164, with extension where applicable, e.g. `+NNNNNNNNNNN xExtension`\n\n### Returns\n\n- `{ accounts: { account_name?: string; account_number?: string; account_type?: 'checking' | 'savings'; institution_name?: string; routing_number?: string; }[]; departments: { name?: string; parent?: { name?: string; }; }[]; ein: string; entity: { subtype?: 's_corporation' | 'c_corporation' | 'b_corporation'; type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }; legal_name: string; locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]; primary_email: string; primary_phone_number: string; }`\n\n - `accounts: { account_name?: string; account_number?: string; account_type?: 'checking' | 'savings'; institution_name?: string; routing_number?: string; }[]`\n - `departments: { name?: string; parent?: { name?: string; }; }[]`\n - `ein: string`\n - `entity: { subtype?: 's_corporation' | 'c_corporation' | 'b_corporation'; type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }`\n - `legal_name: string`\n - `locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]`\n - `primary_email: string`\n - `primary_phone_number: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst company = await client.sandbox.company.update({\n accounts: [{}],\n departments: [{}],\n ein: 'ein',\n entity: {},\n legal_name: 'legal_name',\n locations: [{\n city: 'city',\n country: 'country',\n line1: 'line1',\n line2: 'line2',\n postal_code: 'postal_code',\n state: 'state',\n}],\n primary_email: 'dev@stainless.com',\n primary_phone_number: 'primary_phone_number',\n});\n\nconsole.log(company);\n```", perLanguage: { - go: { - method: 'client.Sandbox.Company.Update', + typescript: { + method: 'client.sandbox.company.update', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcompany, err := client.Sandbox.Company.Update(context.TODO(), finchgo.SandboxCompanyUpdateParams{\n\t\tAccounts: finchgo.F([]finchgo.SandboxCompanyUpdateParamsAccount{{}}),\n\t\tDepartments: finchgo.F([]finchgo.SandboxCompanyUpdateParamsDepartment{{}}),\n\t\tEin: finchgo.F("ein"),\n\t\tEntity: finchgo.F(finchgo.SandboxCompanyUpdateParamsEntity{}),\n\t\tLegalName: finchgo.F("legal_name"),\n\t\tLocations: finchgo.F([]finchgo.LocationParam{{\n\t\t\tCity: finchgo.F("city"),\n\t\t\tCountry: finchgo.F("country"),\n\t\t\tLine1: finchgo.F("line1"),\n\t\t\tLine2: finchgo.F("line2"),\n\t\t\tPostalCode: finchgo.F("postal_code"),\n\t\t\tState: finchgo.F("state"),\n\t\t}}),\n\t\tPrimaryEmail: finchgo.F("dev@stainless.com"),\n\t\tPrimaryPhoneNumber: finchgo.F("primary_phone_number"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", company.Accounts)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst company = await client.sandbox.company.update({\n accounts: [{}],\n departments: [{}],\n ein: 'ein',\n entity: {},\n legal_name: 'legal_name',\n locations: [\n {\n city: 'city',\n country: 'country',\n line1: 'line1',\n line2: 'line2',\n postal_code: 'postal_code',\n state: 'state',\n },\n ],\n primary_email: 'dev@stainless.com',\n primary_phone_number: 'primary_phone_number',\n});\n\nconsole.log(company.accounts);", }, - http: { + python: { + method: 'sandbox.company.update', example: - 'curl https://api.tryfinch.com/sandbox/company \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "accounts": [\n {}\n ],\n "departments": [\n {}\n ],\n "ein": "ein",\n "entity": {},\n "legal_name": "legal_name",\n "locations": [\n {\n "city": "city",\n "country": "country",\n "line1": "line1",\n "line2": "line2",\n "postal_code": "postal_code",\n "state": "state"\n }\n ],\n "primary_email": "dev@stainless.com",\n "primary_phone_number": "primary_phone_number"\n }\'', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\ncompany = client.sandbox.company.update(\n accounts=[{}],\n departments=[{}],\n ein="ein",\n entity={},\n legal_name="legal_name",\n locations=[{\n "city": "city",\n "country": "country",\n "line1": "line1",\n "line2": "line2",\n "postal_code": "postal_code",\n "state": "state",\n }],\n primary_email="dev@stainless.com",\n primary_phone_number="primary_phone_number",\n)\nprint(company.accounts)', }, java: { method: 'sandbox().company().update', @@ -1874,20 +1875,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.CompanyUpdateResponse\nimport com.tryfinch.api.models.Location\nimport com.tryfinch.api.models.SandboxCompanyUpdateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val params: SandboxCompanyUpdateParams = SandboxCompanyUpdateParams.builder()\n .addAccount(SandboxCompanyUpdateParams.Account.builder().build())\n .addDepartment(SandboxCompanyUpdateParams.Department.builder().build())\n .ein("ein")\n .entity(SandboxCompanyUpdateParams.Entity.builder().build())\n .legalName("legal_name")\n .addLocation(Location.builder()\n .city("city")\n .country("country")\n .line1("line1")\n .line2("line2")\n .postalCode("postal_code")\n .state("state")\n .build())\n .primaryEmail("dev@stainless.com")\n .primaryPhoneNumber("primary_phone_number")\n .build()\n val company: CompanyUpdateResponse = client.sandbox().company().update(params)\n}', }, - python: { - method: 'sandbox.company.update', + go: { + method: 'client.Sandbox.Company.Update', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\ncompany = client.sandbox.company.update(\n accounts=[{}],\n departments=[{}],\n ein="ein",\n entity={},\n legal_name="legal_name",\n locations=[{\n "city": "city",\n "country": "country",\n "line1": "line1",\n "line2": "line2",\n "postal_code": "postal_code",\n "state": "state",\n }],\n primary_email="dev@stainless.com",\n primary_phone_number="primary_phone_number",\n)\nprint(company.accounts)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcompany, err := client.Sandbox.Company.Update(context.TODO(), finchgo.SandboxCompanyUpdateParams{\n\t\tAccounts: finchgo.F([]finchgo.SandboxCompanyUpdateParamsAccount{{}}),\n\t\tDepartments: finchgo.F([]finchgo.SandboxCompanyUpdateParamsDepartment{{}}),\n\t\tEin: finchgo.F("ein"),\n\t\tEntity: finchgo.F(finchgo.SandboxCompanyUpdateParamsEntity{}),\n\t\tLegalName: finchgo.F("legal_name"),\n\t\tLocations: finchgo.F([]finchgo.LocationParam{{\n\t\t\tCity: finchgo.F("city"),\n\t\t\tCountry: finchgo.F("country"),\n\t\t\tLine1: finchgo.F("line1"),\n\t\t\tLine2: finchgo.F("line2"),\n\t\t\tPostalCode: finchgo.F("postal_code"),\n\t\t\tState: finchgo.F("state"),\n\t\t}}),\n\t\tPrimaryEmail: finchgo.F("dev@stainless.com"),\n\t\tPrimaryPhoneNumber: finchgo.F("primary_phone_number"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", company.Accounts)\n}\n', }, ruby: { method: 'sandbox.company.update', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\ncompany = finch.sandbox.company.update(\n accounts: [{}],\n departments: [{}],\n ein: "ein",\n entity: {},\n legal_name: "legal_name",\n locations: [\n {city: "city", country: "country", line1: "line1", line2: "line2", postal_code: "postal_code", state: "state"}\n ],\n primary_email: "dev@stainless.com",\n primary_phone_number: "primary_phone_number"\n)\n\nputs(company)', }, - typescript: { - method: 'client.sandbox.company.update', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst company = await client.sandbox.company.update({\n accounts: [{}],\n departments: [{}],\n ein: 'ein',\n entity: {},\n legal_name: 'legal_name',\n locations: [\n {\n city: 'city',\n country: 'country',\n line1: 'line1',\n line2: 'line2',\n postal_code: 'postal_code',\n state: 'state',\n },\n ],\n primary_email: 'dev@stainless.com',\n primary_phone_number: 'primary_phone_number',\n});\n\nconsole.log(company.accounts);", + 'curl https://api.tryfinch.com/sandbox/company \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "accounts": [\n {}\n ],\n "departments": [\n {}\n ],\n "ein": "ein",\n "entity": {},\n "legal_name": "legal_name",\n "locations": [\n {\n "city": "city",\n "country": "country",\n "line1": "line1",\n "line2": "line2",\n "postal_code": "postal_code",\n "state": "state"\n }\n ],\n "primary_email": "dev@stainless.com",\n "primary_phone_number": "primary_phone_number"\n }\'', }, }, }, @@ -1906,14 +1906,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## create\n\n`client.sandbox.directory.create(body?: { class_code?: string; custom_fields?: { name?: string; value?: object; }[]; department?: { name?: string; }; dob?: string; emails?: { data?: string; type?: 'work' | 'personal'; }[]; employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }; employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; encrypted_ssn?: string; end_date?: string; ethnicity?: string; first_name?: string; flsa_status?: 'exempt' | 'non_exempt' | 'unknown'; gender?: 'female' | 'male' | 'other' | 'decline_to_specify'; income?: object; income_history?: object[]; is_active?: boolean; last_name?: string; latest_rehire_date?: string; location?: object; manager?: { id?: string; }; middle_name?: string; phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]; preferred_name?: string; residence?: object; source_id?: string; ssn?: string; start_date?: string; title?: string; }[]): object[]`\n\n**post** `/sandbox/directory`\n\nAdd new individuals to a sandbox company\n\n### Parameters\n\n- `body?: { class_code?: string; custom_fields?: { name?: string; value?: object; }[]; department?: { name?: string; }; dob?: string; emails?: { data?: string; type?: 'work' | 'personal'; }[]; employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }; employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; encrypted_ssn?: string; end_date?: string; ethnicity?: string; first_name?: string; flsa_status?: 'exempt' | 'non_exempt' | 'unknown'; gender?: 'female' | 'male' | 'other' | 'decline_to_specify'; income?: { amount: number; currency: string; effective_date: string; unit: string; }; income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]; is_active?: boolean; last_name?: string; latest_rehire_date?: string; location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; manager?: { id?: string; }; middle_name?: string; phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]; preferred_name?: string; residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; source_id?: string; ssn?: string; start_date?: string; title?: string; }[]`\n Array of individuals to create. Takes all combined fields from `/individual` and `/employment` endpoints. All fields are optional.\n\n### Returns\n\n- `object[]`\n The individuals which were created\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst directories = await client.sandbox.directory.create();\n\nconsole.log(directories);\n```", perLanguage: { - go: { - method: 'client.Sandbox.Directory.New', + typescript: { + method: 'client.sandbox.directory.create', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tdirectories, err := client.Sandbox.Directory.New(context.TODO(), finchgo.SandboxDirectoryNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", directories)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst directories = await client.sandbox.directory.create();\n\nconsole.log(directories);", }, - http: { + python: { + method: 'sandbox.directory.create', example: - 'curl https://api.tryfinch.com/sandbox/directory \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\ndirectories = client.sandbox.directory.create()\nprint(directories)', }, java: { method: 'sandbox().directory().create', @@ -1925,20 +1926,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.DirectoryCreateResponse\nimport com.tryfinch.api.models.SandboxDirectoryCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val directories: List = client.sandbox().directory().create()\n}', }, - python: { - method: 'sandbox.directory.create', + go: { + method: 'client.Sandbox.Directory.New', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\ndirectories = client.sandbox.directory.create()\nprint(directories)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tdirectories, err := client.Sandbox.Directory.New(context.TODO(), finchgo.SandboxDirectoryNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", directories)\n}\n', }, ruby: { method: 'sandbox.directory.create', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\ndirectories = finch.sandbox.directory.create\n\nputs(directories)', }, - typescript: { - method: 'client.sandbox.directory.create', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst directories = await client.sandbox.directory.create();\n\nconsole.log(directories);", + 'curl https://api.tryfinch.com/sandbox/directory \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -1970,14 +1970,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## update\n\n`client.sandbox.individual.update(individual_id: string, dob?: string, emails?: { data?: string; type?: 'work' | 'personal'; }[], encrypted_ssn?: string, ethnicity?: string, first_name?: string, gender?: 'female' | 'male' | 'other' | 'decline_to_specify', last_name?: string, middle_name?: string, phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[], preferred_name?: string, residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }, ssn?: string): { id?: string; dob?: string; emails?: object[]; encrypted_ssn?: string; ethnicity?: string; first_name?: string; gender?: 'female' | 'male' | 'other' | 'decline_to_specify'; last_name?: string; middle_name?: string; phone_numbers?: object[]; preferred_name?: string; residence?: location; ssn?: string; }`\n\n**put** `/sandbox/individual/{individual_id}`\n\nUpdate sandbox individual\n\n### Parameters\n\n- `individual_id: string`\n\n- `dob?: string`\n\n- `emails?: { data?: string; type?: 'work' | 'personal'; }[]`\n\n- `encrypted_ssn?: string`\n Social Security Number of the individual in **encrypted** format. This field is only available with the `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the body.\n\n- `ethnicity?: string`\n The EEOC-defined ethnicity of the individual.\n\n- `first_name?: string`\n The legal first name of the individual.\n\n- `gender?: 'female' | 'male' | 'other' | 'decline_to_specify'`\n The gender of the individual.\n\n- `last_name?: string`\n The legal last name of the individual.\n\n- `middle_name?: string`\n The legal middle name of the individual.\n\n- `phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]`\n\n- `preferred_name?: string`\n The preferred name of the individual.\n\n- `residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }`\n - `city: string`\n City, district, suburb, town, or village.\n - `country: string`\n The 2-letter ISO 3166 country code.\n - `line1: string`\n Street address or PO box.\n - `line2: string`\n Apartment, suite, unit, or building.\n - `postal_code: string`\n The postal code or zip code.\n - `state: string`\n The state code.\n - `name?: string`\n - `source_id?: string`\n\n- `ssn?: string`\n Social Security Number of the individual. This field is only available with the `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the body. [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).\n\n### Returns\n\n- `{ id?: string; dob?: string; emails?: { data?: string; type?: 'work' | 'personal'; }[]; encrypted_ssn?: string; ethnicity?: string; first_name?: string; gender?: 'female' | 'male' | 'other' | 'decline_to_specify'; last_name?: string; middle_name?: string; phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]; preferred_name?: string; residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; ssn?: string; }`\n\n - `id?: string`\n - `dob?: string`\n - `emails?: { data?: string; type?: 'work' | 'personal'; }[]`\n - `encrypted_ssn?: string`\n - `ethnicity?: string`\n - `first_name?: string`\n - `gender?: 'female' | 'male' | 'other' | 'decline_to_specify'`\n - `last_name?: string`\n - `middle_name?: string`\n - `phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]`\n - `preferred_name?: string`\n - `residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }`\n - `ssn?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst individual = await client.sandbox.individual.update('individual_id');\n\nconsole.log(individual);\n```", perLanguage: { - go: { - method: 'client.Sandbox.Individual.Update', + typescript: { + method: 'client.sandbox.individual.update', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tindividual, err := client.Sandbox.Individual.Update(\n\t\tcontext.TODO(),\n\t\t"individual_id",\n\t\tfinchgo.SandboxIndividualUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", individual.ID)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst individual = await client.sandbox.individual.update('individual_id');\n\nconsole.log(individual.id);", }, - http: { + python: { + method: 'sandbox.individual.update', example: - 'curl https://api.tryfinch.com/sandbox/individual/$INDIVIDUAL_ID \\\n -X PUT \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nindividual = client.sandbox.individual.update(\n individual_id="individual_id",\n)\nprint(individual.id)', }, java: { method: 'sandbox().individual().update', @@ -1989,20 +1990,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.IndividualUpdateResponse\nimport com.tryfinch.api.models.SandboxIndividualUpdateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val individual: IndividualUpdateResponse = client.sandbox().individual().update("individual_id")\n}', }, - python: { - method: 'sandbox.individual.update', + go: { + method: 'client.Sandbox.Individual.Update', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nindividual = client.sandbox.individual.update(\n individual_id="individual_id",\n)\nprint(individual.id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tindividual, err := client.Sandbox.Individual.Update(\n\t\tcontext.TODO(),\n\t\t"individual_id",\n\t\tfinchgo.SandboxIndividualUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", individual.ID)\n}\n', }, ruby: { method: 'sandbox.individual.update', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nindividual = finch.sandbox.individual.update("individual_id")\n\nputs(individual)', }, - typescript: { - method: 'client.sandbox.individual.update', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst individual = await client.sandbox.individual.update('individual_id');\n\nconsole.log(individual.id);", + 'curl https://api.tryfinch.com/sandbox/individual/$INDIVIDUAL_ID \\\n -X PUT \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -2041,14 +2041,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## update\n\n`client.sandbox.employment.update(individual_id: string, class_code?: string, custom_fields?: { name?: string; value?: object; }[], department?: { name?: string; }, employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }, employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated', end_date?: string, first_name?: string, flsa_status?: 'exempt' | 'non_exempt' | 'unknown', income?: { amount: number; currency: string; effective_date: string; unit: string; }, income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[], is_active?: boolean, last_name?: string, latest_rehire_date?: string, location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }, manager?: { id?: string; }, middle_name?: string, source_id?: string, start_date?: string, title?: string): { id?: string; class_code?: string; custom_fields?: object[]; department?: object; employment?: object; employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; end_date?: string; first_name?: string; flsa_status?: 'exempt' | 'non_exempt' | 'unknown'; income?: income; income_history?: income[]; is_active?: boolean; last_name?: string; latest_rehire_date?: string; location?: location; manager?: object; middle_name?: string; source_id?: string; start_date?: string; title?: string; }`\n\n**put** `/sandbox/employment/{individual_id}`\n\nUpdate sandbox employment\n\n### Parameters\n\n- `individual_id: string`\n\n- `class_code?: string`\n Worker's compensation classification code for this employee\n\n- `custom_fields?: { name?: string; value?: object; }[]`\n Custom fields for the individual. These are fields which are defined by the employer in the system. Custom fields are not currently supported for assisted connections.\n\n- `department?: { name?: string; }`\n The department object.\n - `name?: string`\n The name of the department associated with the individual.\n\n- `employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }`\n The employment object.\n - `subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'`\n The secondary employment type of the individual. Options: `full_time`, `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.\n - `type?: 'employee' | 'contractor'`\n The main employment type of the individual.\n\n- `employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'`\n The detailed employment status of the individual.\n\n- `end_date?: string`\n\n- `first_name?: string`\n The legal first name of the individual.\n\n- `flsa_status?: 'exempt' | 'non_exempt' | 'unknown'`\n The FLSA status of the individual. Available options: `exempt`, `non_exempt`, `unknown`.\n\n- `income?: { amount: number; currency: string; effective_date: string; unit: string; }`\n The employee's income as reported by the provider. This may not always be annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, depending on what information the provider returns.\n - `amount: number`\n The income amount in cents.\n - `currency: string`\n The currency code.\n - `effective_date: string`\n The date the income amount went into effect.\n - `unit: string`\n The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`.\n\n- `income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]`\n The array of income history.\n\n- `is_active?: boolean`\n `true` if the individual an an active employee or contractor at the company.\n\n- `last_name?: string`\n The legal last name of the individual.\n\n- `latest_rehire_date?: string`\n\n- `location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }`\n - `city: string`\n City, district, suburb, town, or village.\n - `country: string`\n The 2-letter ISO 3166 country code.\n - `line1: string`\n Street address or PO box.\n - `line2: string`\n Apartment, suite, unit, or building.\n - `postal_code: string`\n The postal code or zip code.\n - `state: string`\n The state code.\n - `name?: string`\n - `source_id?: string`\n\n- `manager?: { id?: string; }`\n The manager object representing the manager of the individual within the org.\n - `id?: string`\n A stable Finch `id` (UUID v4) for an individual in the company.\n\n- `middle_name?: string`\n The legal middle name of the individual.\n\n- `source_id?: string`\n The source system's unique employment identifier for this individual\n\n- `start_date?: string`\n\n- `title?: string`\n The current title of the individual.\n\n### Returns\n\n- `{ id?: string; class_code?: string; custom_fields?: { name?: string; value?: object; }[]; department?: { name?: string; }; employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }; employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; end_date?: string; first_name?: string; flsa_status?: 'exempt' | 'non_exempt' | 'unknown'; income?: { amount: number; currency: string; effective_date: string; unit: string; }; income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]; is_active?: boolean; last_name?: string; latest_rehire_date?: string; location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; manager?: { id?: string; }; middle_name?: string; source_id?: string; start_date?: string; title?: string; }`\n\n - `id?: string`\n - `class_code?: string`\n - `custom_fields?: { name?: string; value?: object; }[]`\n - `department?: { name?: string; }`\n - `employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }`\n - `employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'`\n - `end_date?: string`\n - `first_name?: string`\n - `flsa_status?: 'exempt' | 'non_exempt' | 'unknown'`\n - `income?: { amount: number; currency: string; effective_date: string; unit: string; }`\n - `income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]`\n - `is_active?: boolean`\n - `last_name?: string`\n - `latest_rehire_date?: string`\n - `location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }`\n - `manager?: { id?: string; }`\n - `middle_name?: string`\n - `source_id?: string`\n - `start_date?: string`\n - `title?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst employment = await client.sandbox.employment.update('individual_id');\n\nconsole.log(employment);\n```", perLanguage: { - go: { - method: 'client.Sandbox.Employment.Update', + typescript: { + method: 'client.sandbox.employment.update', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\temployment, err := client.Sandbox.Employment.Update(\n\t\tcontext.TODO(),\n\t\t"individual_id",\n\t\tfinchgo.SandboxEmploymentUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", employment.ID)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst employment = await client.sandbox.employment.update('individual_id');\n\nconsole.log(employment.id);", }, - http: { + python: { + method: 'sandbox.employment.update', example: - 'curl https://api.tryfinch.com/sandbox/employment/$INDIVIDUAL_ID \\\n -X PUT \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nemployment = client.sandbox.employment.update(\n individual_id="individual_id",\n)\nprint(employment.id)', }, java: { method: 'sandbox().employment().update', @@ -2060,20 +2061,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.EmploymentUpdateResponse\nimport com.tryfinch.api.models.SandboxEmploymentUpdateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val employment: EmploymentUpdateResponse = client.sandbox().employment().update("individual_id")\n}', }, - python: { - method: 'sandbox.employment.update', + go: { + method: 'client.Sandbox.Employment.Update', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nemployment = client.sandbox.employment.update(\n individual_id="individual_id",\n)\nprint(employment.id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\temployment, err := client.Sandbox.Employment.Update(\n\t\tcontext.TODO(),\n\t\t"individual_id",\n\t\tfinchgo.SandboxEmploymentUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", employment.ID)\n}\n', }, ruby: { method: 'sandbox.employment.update', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nemployment = finch.sandbox.employment.update("individual_id")\n\nputs(employment)', }, - typescript: { - method: 'client.sandbox.employment.update', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst employment = await client.sandbox.employment.update('individual_id');\n\nconsole.log(employment.id);", + 'curl https://api.tryfinch.com/sandbox/employment/$INDIVIDUAL_ID \\\n -X PUT \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -2094,14 +2094,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## create\n\n`client.sandbox.payment.create(end_date?: string, pay_statements?: { individual_id: string; earnings?: { amount?: number; hours?: number; name?: string; type?: string; }[]; employee_deductions?: { amount?: number; name?: string; pre_tax?: boolean; type?: string; }[]; employer_contributions?: { amount?: number; name?: string; type?: string; }[]; gross_pay?: number; net_pay?: number; payment_method?: 'check' | 'direct_deposit' | 'other'; taxes?: { amount?: number; employer?: boolean; name?: string; type?: 'federal' | 'fica' | 'local' | 'state'; }[]; total_hours?: number; type?: 'off_cycle_payroll' | 'one_time_payment' | 'regular_payroll'; }[], start_date?: string): { pay_date: string; payment_id: string; }`\n\n**post** `/sandbox/payment`\n\nAdd a new sandbox payment\n\n### Parameters\n\n- `end_date?: string`\n\n- `pay_statements?: { individual_id: string; earnings?: { amount?: number; hours?: number; name?: string; type?: string; }[]; employee_deductions?: { amount?: number; name?: string; pre_tax?: boolean; type?: string; }[]; employer_contributions?: { amount?: number; name?: string; type?: string; }[]; gross_pay?: number; net_pay?: number; payment_method?: 'check' | 'direct_deposit' | 'other'; taxes?: { amount?: number; employer?: boolean; name?: string; type?: 'federal' | 'fica' | 'local' | 'state'; }[]; total_hours?: number; type?: 'off_cycle_payroll' | 'one_time_payment' | 'regular_payroll'; }[]`\n Array of pay statements to include in the payment.\n\n- `start_date?: string`\n\n### Returns\n\n- `{ pay_date: string; payment_id: string; }`\n\n - `pay_date: string`\n - `payment_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst payment = await client.sandbox.payment.create();\n\nconsole.log(payment);\n```", perLanguage: { - go: { - method: 'client.Sandbox.Payment.New', + typescript: { + method: 'client.sandbox.payment.create', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpayment, err := client.Sandbox.Payment.New(context.TODO(), finchgo.SandboxPaymentNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", payment.PaymentID)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst payment = await client.sandbox.payment.create();\n\nconsole.log(payment.payment_id);", }, - http: { + python: { + method: 'sandbox.payment.create', example: - 'curl https://api.tryfinch.com/sandbox/payment \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npayment = client.sandbox.payment.create()\nprint(payment.payment_id)', }, java: { method: 'sandbox().payment().create', @@ -2113,20 +2114,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.PaymentCreateResponse\nimport com.tryfinch.api.models.SandboxPaymentCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val payment: PaymentCreateResponse = client.sandbox().payment().create()\n}', }, - python: { - method: 'sandbox.payment.create', + go: { + method: 'client.Sandbox.Payment.New', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npayment = client.sandbox.payment.create()\nprint(payment.payment_id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpayment, err := client.Sandbox.Payment.New(context.TODO(), finchgo.SandboxPaymentNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", payment.PaymentID)\n}\n', }, ruby: { method: 'sandbox.payment.create', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npayment = finch.sandbox.payment.create\n\nputs(payment)', }, - typescript: { - method: 'client.sandbox.payment.create', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst payment = await client.sandbox.payment.create();\n\nconsole.log(payment.payment_id);", + 'curl https://api.tryfinch.com/sandbox/payment \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -2143,14 +2143,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## create\n\n`client.sandbox.jobs.create(type: 'data_sync_all'): { allowed_refreshes: number; job_id: string; job_url: string; remaining_refreshes: number; }`\n\n**post** `/sandbox/jobs`\n\nEnqueue a new sandbox job\n\n### Parameters\n\n- `type: 'data_sync_all'`\n The type of job to start. Currently the only supported type is `data_sync_all`\n\n### Returns\n\n- `{ allowed_refreshes: number; job_id: string; job_url: string; remaining_refreshes: number; }`\n\n - `allowed_refreshes: number`\n - `job_id: string`\n - `job_url: string`\n - `remaining_refreshes: number`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst job = await client.sandbox.jobs.create({ type: 'data_sync_all' });\n\nconsole.log(job);\n```", perLanguage: { - go: { - method: 'client.Sandbox.Jobs.New', + typescript: { + method: 'client.sandbox.jobs.create', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tjob, err := client.Sandbox.Jobs.New(context.TODO(), finchgo.SandboxJobNewParams{\n\t\tType: finchgo.F(finchgo.SandboxJobNewParamsTypeDataSyncAll),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", job.JobID)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst job = await client.sandbox.jobs.create({ type: 'data_sync_all' });\n\nconsole.log(job.job_id);", }, - http: { + python: { + method: 'sandbox.jobs.create', example: - 'curl https://api.tryfinch.com/sandbox/jobs \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "type": "data_sync_all"\n }\'', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\njob = client.sandbox.jobs.create(\n type="data_sync_all",\n)\nprint(job.job_id)', }, java: { method: 'sandbox().jobs().create', @@ -2162,20 +2163,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.JobCreateResponse\nimport com.tryfinch.api.models.SandboxJobCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val params: SandboxJobCreateParams = SandboxJobCreateParams.builder()\n .type(SandboxJobCreateParams.Type.DATA_SYNC_ALL)\n .build()\n val job: JobCreateResponse = client.sandbox().jobs().create(params)\n}', }, - python: { - method: 'sandbox.jobs.create', + go: { + method: 'client.Sandbox.Jobs.New', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\njob = client.sandbox.jobs.create(\n type="data_sync_all",\n)\nprint(job.job_id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tjob, err := client.Sandbox.Jobs.New(context.TODO(), finchgo.SandboxJobNewParams{\n\t\tType: finchgo.F(finchgo.SandboxJobNewParamsTypeDataSyncAll),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", job.JobID)\n}\n', }, ruby: { method: 'sandbox.jobs.create', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\njob = finch.sandbox.jobs.create(type: :data_sync_all)\n\nputs(job)', }, - typescript: { - method: 'client.sandbox.jobs.create', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst job = await client.sandbox.jobs.create({ type: 'data_sync_all' });\n\nconsole.log(job.job_id);", + 'curl https://api.tryfinch.com/sandbox/jobs \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "type": "data_sync_all"\n }\'', }, }, }, @@ -2192,14 +2192,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## retrieve\n\n`client.sandbox.jobs.configuration.retrieve(): object[]`\n\n**get** `/sandbox/jobs/configuration`\n\nGet configurations for sandbox jobs\n\n### Returns\n\n- `{ completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'; type: 'data_sync_all'; }[]`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst sandboxJobConfigurations = await client.sandbox.jobs.configuration.retrieve();\n\nconsole.log(sandboxJobConfigurations);\n```", perLanguage: { - go: { - method: 'client.Sandbox.Jobs.Configuration.Get', + typescript: { + method: 'client.sandbox.jobs.configuration.retrieve', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsandboxJobConfigurations, err := client.Sandbox.Jobs.Configuration.Get(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", sandboxJobConfigurations)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst sandboxJobConfigurations = await client.sandbox.jobs.configuration.retrieve();\n\nconsole.log(sandboxJobConfigurations);", }, - http: { + python: { + method: 'sandbox.jobs.configuration.retrieve', example: - 'curl https://api.tryfinch.com/sandbox/jobs/configuration \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nsandbox_job_configurations = client.sandbox.jobs.configuration.retrieve()\nprint(sandbox_job_configurations)', }, java: { method: 'sandbox().jobs().configuration().retrieve', @@ -2211,20 +2212,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.SandboxJobConfiguration\nimport com.tryfinch.api.models.SandboxJobConfigurationRetrieveParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val sandboxJobConfigurations: List = client.sandbox().jobs().configuration().retrieve()\n}', }, - python: { - method: 'sandbox.jobs.configuration.retrieve', + go: { + method: 'client.Sandbox.Jobs.Configuration.Get', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nsandbox_job_configurations = client.sandbox.jobs.configuration.retrieve()\nprint(sandbox_job_configurations)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsandboxJobConfigurations, err := client.Sandbox.Jobs.Configuration.Get(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", sandboxJobConfigurations)\n}\n', }, ruby: { method: 'sandbox.jobs.configuration.retrieve', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nsandbox_job_configurations = finch.sandbox.jobs.configuration.retrieve\n\nputs(sandbox_job_configurations)', }, - typescript: { - method: 'client.sandbox.jobs.configuration.retrieve', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst sandboxJobConfigurations = await client.sandbox.jobs.configuration.retrieve();\n\nconsole.log(sandboxJobConfigurations);", + 'curl https://api.tryfinch.com/sandbox/jobs/configuration \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -2245,14 +2245,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## update\n\n`client.sandbox.jobs.configuration.update(completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error', type: 'data_sync_all'): { completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'; type: 'data_sync_all'; }`\n\n**put** `/sandbox/jobs/configuration`\n\nUpdate configurations for sandbox jobs\n\n### Parameters\n\n- `completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'`\n\n- `type: 'data_sync_all'`\n\n### Returns\n\n- `{ completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'; type: 'data_sync_all'; }`\n\n - `completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'`\n - `type: 'data_sync_all'`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst sandboxJobConfiguration = await client.sandbox.jobs.configuration.update({ completion_status: 'complete', type: 'data_sync_all' });\n\nconsole.log(sandboxJobConfiguration);\n```", perLanguage: { - go: { - method: 'client.Sandbox.Jobs.Configuration.Update', + typescript: { + method: 'client.sandbox.jobs.configuration.update', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsandboxJobConfiguration, err := client.Sandbox.Jobs.Configuration.Update(context.TODO(), finchgo.SandboxJobConfigurationUpdateParams{\n\t\tCompletionStatus: finchgo.F(finchgo.SandboxJobConfigurationUpdateParamsCompletionStatusComplete),\n\t\tType: finchgo.F(finchgo.SandboxJobConfigurationUpdateParamsTypeDataSyncAll),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", sandboxJobConfiguration.CompletionStatus)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst sandboxJobConfiguration = await client.sandbox.jobs.configuration.update({\n completion_status: 'complete',\n type: 'data_sync_all',\n});\n\nconsole.log(sandboxJobConfiguration.completion_status);", }, - http: { + python: { + method: 'sandbox.jobs.configuration.update', example: - 'curl https://api.tryfinch.com/sandbox/jobs/configuration \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "completion_status": "complete",\n "type": "data_sync_all"\n }\'', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nsandbox_job_configuration = client.sandbox.jobs.configuration.update(\n completion_status="complete",\n type="data_sync_all",\n)\nprint(sandbox_job_configuration.completion_status)', }, java: { method: 'sandbox().jobs().configuration().update', @@ -2264,20 +2265,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.SandboxJobConfiguration\nimport com.tryfinch.api.models.SandboxJobConfigurationUpdateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val params: SandboxJobConfiguration = SandboxJobConfiguration.builder()\n .completionStatus(SandboxJobConfiguration.CompletionStatus.COMPLETE)\n .type(SandboxJobConfiguration.Type.DATA_SYNC_ALL)\n .build()\n val sandboxJobConfiguration: SandboxJobConfiguration = client.sandbox().jobs().configuration().update(params)\n}', }, - python: { - method: 'sandbox.jobs.configuration.update', + go: { + method: 'client.Sandbox.Jobs.Configuration.Update', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nsandbox_job_configuration = client.sandbox.jobs.configuration.update(\n completion_status="complete",\n type="data_sync_all",\n)\nprint(sandbox_job_configuration.completion_status)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsandboxJobConfiguration, err := client.Sandbox.Jobs.Configuration.Update(context.TODO(), finchgo.SandboxJobConfigurationUpdateParams{\n\t\tCompletionStatus: finchgo.F(finchgo.SandboxJobConfigurationUpdateParamsCompletionStatusComplete),\n\t\tType: finchgo.F(finchgo.SandboxJobConfigurationUpdateParamsTypeDataSyncAll),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", sandboxJobConfiguration.CompletionStatus)\n}\n', }, ruby: { method: 'sandbox.jobs.configuration.update', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nsandbox_job_configuration = finch.sandbox.jobs.configuration.update(completion_status: :complete, type: :data_sync_all)\n\nputs(sandbox_job_configuration)', }, - typescript: { - method: 'client.sandbox.jobs.configuration.update', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst sandboxJobConfiguration = await client.sandbox.jobs.configuration.update({\n completion_status: 'complete',\n type: 'data_sync_all',\n});\n\nconsole.log(sandboxJobConfiguration.completion_status);", + 'curl https://api.tryfinch.com/sandbox/jobs/configuration \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "completion_status": "complete",\n "type": "data_sync_all"\n }\'', }, }, }, @@ -2294,14 +2294,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## list\n\n`client.payroll.payGroups.list(entity_ids?: string[], individual_id?: string, pay_frequencies?: string[]): { id: string; name: string; pay_frequencies: string[]; }`\n\n**get** `/employer/pay-groups`\n\nRead company pay groups and frequencies\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `individual_id?: string`\n\n- `pay_frequencies?: string[]`\n\n### Returns\n\n- `{ id: string; name: string; pay_frequencies: string[]; }`\n\n - `id: string`\n - `name: string`\n - `pay_frequencies: string[]`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const payGroupListResponse of client.payroll.payGroups.list()) {\n console.log(payGroupListResponse);\n}\n```", perLanguage: { - go: { - method: 'client.Payroll.PayGroups.List', + typescript: { + method: 'client.payroll.payGroups.list', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Payroll.PayGroups.List(context.TODO(), finchgo.PayrollPayGroupListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const payGroupListResponse of client.payroll.payGroups.list()) {\n console.log(payGroupListResponse.id);\n}", }, - http: { + python: { + method: 'payroll.pay_groups.list', example: - 'curl https://api.tryfinch.com/employer/pay-groups \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.payroll.pay_groups.list()\npage = page.items[0]\nprint(page.id)', }, java: { method: 'payroll().payGroups().list', @@ -2313,20 +2314,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.PayrollPayGroupListPage\nimport com.tryfinch.api.models.PayrollPayGroupListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val page: PayrollPayGroupListPage = client.payroll().payGroups().list()\n}', }, - python: { - method: 'payroll.pay_groups.list', + go: { + method: 'client.Payroll.PayGroups.List', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.payroll.pay_groups.list()\npage = page.items[0]\nprint(page.id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Payroll.PayGroups.List(context.TODO(), finchgo.PayrollPayGroupListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', }, ruby: { method: 'payroll.pay_groups.list', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.payroll.pay_groups.list\n\nputs(page)', }, - typescript: { - method: 'client.payroll.payGroups.list', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const payGroupListResponse of client.payroll.payGroups.list()) {\n console.log(payGroupListResponse.id);\n}", + 'curl https://api.tryfinch.com/employer/pay-groups \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -2343,14 +2343,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## retrieve\n\n`client.payroll.payGroups.retrieve(pay_group_id: string, entity_ids?: string[]): { id: string; individual_ids: string[]; name: string; pay_frequencies: string[]; }`\n\n**get** `/employer/pay-groups/{pay_group_id}`\n\nRead information from a single pay group\n\n### Parameters\n\n- `pay_group_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ id: string; individual_ids: string[]; name: string; pay_frequencies: string[]; }`\n\n - `id: string`\n - `individual_ids: string[]`\n - `name: string`\n - `pay_frequencies: string[]`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst payGroup = await client.payroll.payGroups.retrieve('pay_group_id');\n\nconsole.log(payGroup);\n```", perLanguage: { - go: { - method: 'client.Payroll.PayGroups.Get', + typescript: { + method: 'client.payroll.payGroups.retrieve', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpayGroup, err := client.Payroll.PayGroups.Get(\n\t\tcontext.TODO(),\n\t\t"pay_group_id",\n\t\tfinchgo.PayrollPayGroupGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", payGroup.ID)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst payGroup = await client.payroll.payGroups.retrieve('pay_group_id');\n\nconsole.log(payGroup.id);", }, - http: { + python: { + method: 'payroll.pay_groups.retrieve', example: - 'curl https://api.tryfinch.com/employer/pay-groups/$PAY_GROUP_ID \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npay_group = client.payroll.pay_groups.retrieve(\n pay_group_id="pay_group_id",\n)\nprint(pay_group.id)', }, java: { method: 'payroll().payGroups().retrieve', @@ -2362,20 +2363,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.PayGroupRetrieveResponse\nimport com.tryfinch.api.models.PayrollPayGroupRetrieveParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val payGroup: PayGroupRetrieveResponse = client.payroll().payGroups().retrieve("pay_group_id")\n}', }, - python: { - method: 'payroll.pay_groups.retrieve', + go: { + method: 'client.Payroll.PayGroups.Get', example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npay_group = client.payroll.pay_groups.retrieve(\n pay_group_id="pay_group_id",\n)\nprint(pay_group.id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpayGroup, err := client.Payroll.PayGroups.Get(\n\t\tcontext.TODO(),\n\t\t"pay_group_id",\n\t\tfinchgo.PayrollPayGroupGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", payGroup.ID)\n}\n', }, ruby: { method: 'payroll.pay_groups.retrieve', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npay_group = finch.payroll.pay_groups.retrieve("pay_group_id")\n\nputs(pay_group)', }, - typescript: { - method: 'client.payroll.payGroups.retrieve', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst payGroup = await client.payroll.payGroups.retrieve('pay_group_id');\n\nconsole.log(payGroup.id);", + 'curl https://api.tryfinch.com/employer/pay-groups/$PAY_GROUP_ID \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', }, }, }, @@ -2402,14 +2402,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## new\n\n`client.connect.sessions.new(customer_id: string, customer_name: string, products: string[], customer_email?: string, integration?: { provider: string; auth_method?: 'assisted' | 'credential' | 'oauth' | 'api_token'; }, manual?: boolean, minutes_to_expire?: number, redirect_uri?: string, sandbox?: 'finch' | 'provider'): { connect_url: string; session_id: string; }`\n\n**post** `/connect/sessions`\n\nCreate a new connect session for an employer\n\n### Parameters\n\n- `customer_id: string`\n Unique identifier for the customer\n\n- `customer_name: string`\n Name of the customer\n\n- `products: string[]`\n The Finch products to request access to. Use `benefits` to access deductions endpoints — `deduction` is a deprecated alias that is still accepted but should not be combined with `benefits`.\n\n- `customer_email?: string`\n Email address of the customer\n\n- `integration?: { provider: string; auth_method?: 'assisted' | 'credential' | 'oauth' | 'api_token'; }`\n Integration configuration for the connect session\n - `provider: string`\n The provider to integrate with\n - `auth_method?: 'assisted' | 'credential' | 'oauth' | 'api_token'`\n The authentication method to use\n\n- `manual?: boolean`\n Enable manual authentication mode\n\n- `minutes_to_expire?: number`\n The number of minutes until the session expires (defaults to 129,600, which is 90 days)\n\n- `redirect_uri?: string`\n The URI to redirect to after the Connect flow is completed\n\n- `sandbox?: 'finch' | 'provider'`\n Sandbox mode for testing\n\n### Returns\n\n- `{ connect_url: string; session_id: string; }`\n\n - `connect_url: string`\n - `session_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst response = await client.connect.sessions.new({\n customer_id: 'x',\n customer_name: 'x',\n products: ['benefits'],\n});\n\nconsole.log(response);\n```", perLanguage: { - go: { - method: 'client.Connect.Sessions.New', + typescript: { + method: 'client.connect.sessions.new', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithClientID("4ab15e51-11ad-49f4-acae-f343b7794375"),\n\t\toption.WithClientSecret("My Client Secret"),\n\t)\n\tresponse, err := client.Connect.Sessions.New(context.TODO(), finchgo.ConnectSessionNewParams{\n\t\tCustomerID: finchgo.F("x"),\n\t\tCustomerName: finchgo.F("x"),\n\t\tProducts: finchgo.F([]finchgo.ConnectSessionNewParamsProduct{finchgo.ConnectSessionNewParamsProductBenefits}),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response.SessionID)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n clientID: process.env['FINCH_CLIENT_ID'], // This is the default and can be omitted\n clientSecret: process.env['FINCH_CLIENT_SECRET'], // This is the default and can be omitted\n});\n\nconst response = await client.connect.sessions.new({\n customer_id: 'x',\n customer_name: 'x',\n products: ['benefits'],\n});\n\nconsole.log(response.session_id);", }, - http: { + python: { + method: 'connect.sessions.new', example: - 'curl https://api.tryfinch.com/connect/sessions \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -u "$FINCH_CLIENT_ID:FINCH_CLIENT_SECRET" \\\n -d \'{\n "customer_id": "x",\n "customer_name": "x",\n "products": [\n "benefits"\n ]\n }\'', + 'import os\nfrom finch import Finch\n\nclient = Finch(\n client_id=os.environ.get("FINCH_CLIENT_ID"), # This is the default and can be omitted\n client_secret=os.environ.get("FINCH_CLIENT_SECRET"), # This is the default and can be omitted\n)\nresponse = client.connect.sessions.new(\n customer_id="x",\n customer_name="x",\n products=["benefits"],\n)\nprint(response.session_id)', }, java: { method: 'connect().sessions().new_', @@ -2421,20 +2422,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.ConnectSessionNewParams\nimport com.tryfinch.api.models.SessionNewResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.fromEnv()\n\n val params: ConnectSessionNewParams = ConnectSessionNewParams.builder()\n .customerId("x")\n .customerName("x")\n .addProduct(ConnectSessionNewParams.ConnectProducts.BENEFITS)\n .build()\n val response: SessionNewResponse = client.connect().sessions().new(params)\n}', }, - python: { - method: 'connect.sessions.new', + go: { + method: 'client.Connect.Sessions.New', example: - 'import os\nfrom finch import Finch\n\nclient = Finch(\n client_id=os.environ.get("FINCH_CLIENT_ID"), # This is the default and can be omitted\n client_secret=os.environ.get("FINCH_CLIENT_SECRET"), # This is the default and can be omitted\n)\nresponse = client.connect.sessions.new(\n customer_id="x",\n customer_name="x",\n products=["benefits"],\n)\nprint(response.session_id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithClientID("4ab15e51-11ad-49f4-acae-f343b7794375"),\n\t\toption.WithClientSecret("My Client Secret"),\n\t)\n\tresponse, err := client.Connect.Sessions.New(context.TODO(), finchgo.ConnectSessionNewParams{\n\t\tCustomerID: finchgo.F("x"),\n\t\tCustomerName: finchgo.F("x"),\n\t\tProducts: finchgo.F([]finchgo.ConnectSessionNewParamsProduct{finchgo.ConnectSessionNewParamsProductBenefits}),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response.SessionID)\n}\n', }, ruby: { method: 'connect.sessions.new', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(client_id: "4ab15e51-11ad-49f4-acae-f343b7794375", client_secret: "My Client Secret")\n\nresponse = finch.connect.sessions.new(customer_id: "x", customer_name: "x", products: [:benefits])\n\nputs(response)', }, - typescript: { - method: 'client.connect.sessions.new', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n clientID: process.env['FINCH_CLIENT_ID'], // This is the default and can be omitted\n clientSecret: process.env['FINCH_CLIENT_SECRET'], // This is the default and can be omitted\n});\n\nconst response = await client.connect.sessions.new({\n customer_id: 'x',\n customer_name: 'x',\n products: ['benefits'],\n});\n\nconsole.log(response.session_id);", + 'curl https://api.tryfinch.com/connect/sessions \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -u "$FINCH_CLIENT_ID:FINCH_CLIENT_SECRET" \\\n -d \'{\n "customer_id": "x",\n "customer_name": "x",\n "products": [\n "benefits"\n ]\n }\'', }, }, }, @@ -2456,14 +2456,15 @@ const EMBEDDED_METHODS: MethodEntry[] = [ markdown: "## reauthenticate\n\n`client.connect.sessions.reauthenticate(connection_id: string, minutes_to_expire?: number, products?: string[], redirect_uri?: string): { connect_url: string; session_id: string; }`\n\n**post** `/connect/sessions/reauthenticate`\n\nCreate a new Connect session for reauthenticating an existing connection\n\n### Parameters\n\n- `connection_id: string`\n The ID of the existing connection to reauthenticate\n\n- `minutes_to_expire?: number`\n The number of minutes until the session expires (defaults to 43,200, which is 30 days)\n\n- `products?: string[]`\n The products to request access to (optional for reauthentication). Use `benefits` to access deductions endpoints — `deduction` is a deprecated alias that is still accepted but should not be combined with `benefits`.\n\n- `redirect_uri?: string`\n The URI to redirect to after the Connect flow is completed\n\n### Returns\n\n- `{ connect_url: string; session_id: string; }`\n\n - `connect_url: string`\n - `session_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst response = await client.connect.sessions.reauthenticate({ connection_id: 'connection_id' });\n\nconsole.log(response);\n```", perLanguage: { - go: { - method: 'client.Connect.Sessions.Reauthenticate', + typescript: { + method: 'client.connect.sessions.reauthenticate', example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithClientID("4ab15e51-11ad-49f4-acae-f343b7794375"),\n\t\toption.WithClientSecret("My Client Secret"),\n\t)\n\tresponse, err := client.Connect.Sessions.Reauthenticate(context.TODO(), finchgo.ConnectSessionReauthenticateParams{\n\t\tConnectionID: finchgo.F("connection_id"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response.SessionID)\n}\n', + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n clientID: process.env['FINCH_CLIENT_ID'], // This is the default and can be omitted\n clientSecret: process.env['FINCH_CLIENT_SECRET'], // This is the default and can be omitted\n});\n\nconst response = await client.connect.sessions.reauthenticate({ connection_id: 'connection_id' });\n\nconsole.log(response.session_id);", }, - http: { + python: { + method: 'connect.sessions.reauthenticate', example: - 'curl https://api.tryfinch.com/connect/sessions/reauthenticate \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -u "$FINCH_CLIENT_ID:FINCH_CLIENT_SECRET" \\\n -d \'{\n "connection_id": "connection_id"\n }\'', + 'import os\nfrom finch import Finch\n\nclient = Finch(\n client_id=os.environ.get("FINCH_CLIENT_ID"), # This is the default and can be omitted\n client_secret=os.environ.get("FINCH_CLIENT_SECRET"), # This is the default and can be omitted\n)\nresponse = client.connect.sessions.reauthenticate(\n connection_id="connection_id",\n)\nprint(response.session_id)', }, java: { method: 'connect().sessions().reauthenticate', @@ -2475,20 +2476,19 @@ const EMBEDDED_METHODS: MethodEntry[] = [ example: 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.ConnectSessionReauthenticateParams\nimport com.tryfinch.api.models.SessionReauthenticateResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.fromEnv()\n\n val params: ConnectSessionReauthenticateParams = ConnectSessionReauthenticateParams.builder()\n .connectionId("connection_id")\n .build()\n val response: SessionReauthenticateResponse = client.connect().sessions().reauthenticate(params)\n}', }, - python: { - method: 'connect.sessions.reauthenticate', + go: { + method: 'client.Connect.Sessions.Reauthenticate', example: - 'import os\nfrom finch import Finch\n\nclient = Finch(\n client_id=os.environ.get("FINCH_CLIENT_ID"), # This is the default and can be omitted\n client_secret=os.environ.get("FINCH_CLIENT_SECRET"), # This is the default and can be omitted\n)\nresponse = client.connect.sessions.reauthenticate(\n connection_id="connection_id",\n)\nprint(response.session_id)', + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithClientID("4ab15e51-11ad-49f4-acae-f343b7794375"),\n\t\toption.WithClientSecret("My Client Secret"),\n\t)\n\tresponse, err := client.Connect.Sessions.Reauthenticate(context.TODO(), finchgo.ConnectSessionReauthenticateParams{\n\t\tConnectionID: finchgo.F("connection_id"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response.SessionID)\n}\n', }, ruby: { method: 'connect.sessions.reauthenticate', example: 'require "finch_api"\n\nfinch = FinchAPI::Client.new(client_id: "4ab15e51-11ad-49f4-acae-f343b7794375", client_secret: "My Client Secret")\n\nresponse = finch.connect.sessions.reauthenticate(connection_id: "connection_id")\n\nputs(response)', }, - typescript: { - method: 'client.connect.sessions.reauthenticate', + http: { example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n clientID: process.env['FINCH_CLIENT_ID'], // This is the default and can be omitted\n clientSecret: process.env['FINCH_CLIENT_SECRET'], // This is the default and can be omitted\n});\n\nconst response = await client.connect.sessions.reauthenticate({ connection_id: 'connection_id' });\n\nconsole.log(response.session_id);", + 'curl https://api.tryfinch.com/connect/sessions/reauthenticate \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -u "$FINCH_CLIENT_ID:FINCH_CLIENT_SECRET" \\\n -d \'{\n "connection_id": "connection_id"\n }\'', }, }, }, From b9fffd84d80648d59f2ba5c6df4eb57e8ff8d811 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 24 Apr 2026 15:54:55 +0000 Subject: [PATCH 06/14] chore(formatter): run prettier and eslint separately --- bin/cli | 17 +- eslint.config.mjs | 3 - package.json | 1 - packages/mcp-server/jest.config.ts | 4 +- packages/mcp-server/src/auth.ts | 60 +- packages/mcp-server/src/code-tool-types.ts | 2 +- packages/mcp-server/src/code-tool-worker.ts | 112 +- packages/mcp-server/src/code-tool.ts | 144 +- packages/mcp-server/src/docs-search-tool.ts | 55 +- packages/mcp-server/src/http.ts | 68 +- packages/mcp-server/src/index.ts | 2 +- packages/mcp-server/src/instructions.ts | 20 +- packages/mcp-server/src/local-docs-search.ts | 4326 ++++++++--------- packages/mcp-server/src/methods.ts | 539 +- packages/mcp-server/src/options.ts | 47 +- packages/mcp-server/src/server.ts | 105 +- packages/mcp-server/src/types.ts | 80 +- scripts/fast-format | 6 +- scripts/format | 3 +- scripts/lint | 3 + src/api-promise.ts | 2 +- src/client.ts | 392 +- src/core/api-promise.ts | 9 +- src/core/error.ts | 46 +- src/core/pagination.ts | 57 +- src/error.ts | 2 +- src/index.ts | 16 +- src/internal/builtin-types.ts | 23 +- src/internal/detect-platform.ts | 6 +- src/internal/errors.ts | 14 +- src/internal/headers.ts | 4 +- src/internal/parse.ts | 12 +- src/internal/qs/utils.ts | 5 +- src/internal/request-options.ts | 8 +- src/internal/shim-types.ts | 4 +- src/internal/shims.ts | 4 +- src/internal/to-file.ts | 14 +- src/internal/types.ts | 50 +- src/internal/utils/log.ts | 37 +- src/internal/utils/query.ts | 2 +- src/internal/utils/uuid.ts | 8 +- src/pagination.ts | 2 +- src/resource.ts | 2 +- src/resources/access-tokens.ts | 4 +- src/resources/account.ts | 18 +- src/resources/connect/connect.ts | 10 +- src/resources/connect/index.ts | 10 +- src/resources/connect/sessions.ts | 41 +- src/resources/hris/benefits/benefits.ts | 117 +- src/resources/hris/benefits/index.ts | 35 +- src/resources/hris/benefits/individuals.ts | 64 +- src/resources/hris/company/company.ts | 35 +- src/resources/hris/company/index.ts | 9 +- .../hris/company/pay-statement-item/index.ts | 20 +- .../pay-statement-item/pay-statement-item.ts | 30 +- .../hris/company/pay-statement-item/rules.ts | 58 +- src/resources/hris/directory.ts | 15 +- src/resources/hris/documents.ts | 29 +- src/resources/hris/employments.ts | 31 +- src/resources/hris/hris.ts | 100 +- src/resources/hris/index.ts | 72 +- src/resources/hris/individuals.ts | 32 +- src/resources/hris/pay-statements.ts | 35 +- src/resources/hris/payments.ts | 22 +- src/resources/index.ts | 43 +- src/resources/jobs/automated.ts | 17 +- src/resources/jobs/index.ts | 13 +- src/resources/jobs/jobs.ts | 16 +- src/resources/jobs/manual.ts | 6 +- src/resources/payroll/index.ts | 11 +- src/resources/payroll/pay-groups.ts | 51 +- src/resources/payroll/payroll.ts | 11 +- src/resources/providers.ts | 9 +- src/resources/request-forwarding.ts | 9 +- src/resources/sandbox/company.ts | 24 +- src/resources/sandbox/connections/accounts.ts | 19 +- .../sandbox/connections/connections.ts | 14 +- src/resources/sandbox/connections/index.ts | 10 +- src/resources/sandbox/directory.ts | 38 +- src/resources/sandbox/employment.ts | 34 +- src/resources/sandbox/index.ts | 16 +- src/resources/sandbox/individual.ts | 36 +- src/resources/sandbox/jobs/configuration.ts | 12 +- src/resources/sandbox/jobs/index.ts | 9 +- src/resources/sandbox/jobs/jobs.ts | 16 +- src/resources/sandbox/payment.ts | 66 +- src/resources/sandbox/sandbox.ts | 14 +- src/resources/shared.ts | 15 +- src/resources/webhooks.ts | 23 +- src/uploads.ts | 2 +- src/version.ts | 2 +- tests/api-resources/access-tokens.test.ts | 12 +- tests/api-resources/account.test.ts | 2 +- tests/api-resources/connect/sessions.test.ts | 40 +- .../hris/benefits/benefits.test.ts | 61 +- .../hris/benefits/individuals.test.ts | 78 +- .../hris/company/company.test.ts | 11 +- .../pay-statement-item.test.ts | 25 +- .../company/pay-statement-item/rules.test.ts | 70 +- tests/api-resources/hris/directory.test.ts | 36 +- tests/api-resources/hris/documents.test.ts | 33 +- tests/api-resources/hris/employments.test.ts | 11 +- tests/api-resources/hris/individuals.test.ts | 19 +- .../api-resources/hris/pay-statements.test.ts | 21 +- tests/api-resources/hris/payments.test.ts | 10 +- tests/api-resources/jobs/automated.test.ts | 8 +- tests/api-resources/jobs/manual.test.ts | 2 +- .../api-resources/payroll/pay-groups.test.ts | 29 +- tests/api-resources/providers.test.ts | 2 +- .../api-resources/request-forwarding.test.ts | 14 +- tests/api-resources/sandbox/company.test.ts | 96 +- .../sandbox/connections/accounts.test.ts | 26 +- .../sandbox/connections/connections.test.ts | 12 +- tests/api-resources/sandbox/directory.test.ts | 139 +- .../api-resources/sandbox/employment.test.ts | 100 +- .../api-resources/sandbox/individual.test.ts | 56 +- .../sandbox/jobs/configuration.test.ts | 12 +- tests/api-resources/sandbox/jobs/jobs.test.ts | 2 +- tests/api-resources/sandbox/payment.test.ts | 89 +- tests/index.test.ts | 740 ++- tests/qs/utils.test.ts | 2 +- tests/stringifyQuery.test.ts | 32 +- yarn.lock | 32 - 123 files changed, 3912 insertions(+), 5549 deletions(-) diff --git a/bin/cli b/bin/cli index 38f15a1d..e1cc5d5e 100755 --- a/bin/cli +++ b/bin/cli @@ -4,26 +4,19 @@ const { spawnSync } = require('child_process'); const commands = { migrate: { - description: - 'Run migrations to update your code using @tryfinch/finch-api@6 to be compatible with @tryfinch/finch-api@7', + description: 'Run migrations to update your code using @tryfinch/finch-api@6 to be compatible with @tryfinch/finch-api@7', fn: () => { const result = spawnSync( 'npx', - [ - '-y', - 'https://github.com/stainless-api/migrate-ts/releases/download/0.0.2/stainless-api-migrate-0.0.2-6.tgz', - '--migrationConfig', - require.resolve('./migration-config.json'), - ...process.argv.slice(3), - ], + ['-y', 'https://github.com/stainless-api/migrate-ts/releases/download/0.0.2/stainless-api-migrate-0.0.2-6.tgz', '--migrationConfig', require.resolve('./migration-config.json'), ...process.argv.slice(3)], { stdio: 'inherit' }, ); if (result.status !== 0) { process.exit(result.status); } - }, - }, -}; + } + } +} function exitWithHelp() { console.log(`Usage: tryfinch-finch-api `); diff --git a/eslint.config.mjs b/eslint.config.mjs index 8dff6305..978d1f73 100644 --- a/eslint.config.mjs +++ b/eslint.config.mjs @@ -1,7 +1,6 @@ // @ts-check import tseslint from 'typescript-eslint'; import unusedImports from 'eslint-plugin-unused-imports'; -import prettier from 'eslint-plugin-prettier'; export default tseslint.config( { @@ -14,11 +13,9 @@ export default tseslint.config( plugins: { '@typescript-eslint': tseslint.plugin, 'unused-imports': unusedImports, - prettier, }, rules: { 'no-unused-vars': 'off', - 'prettier/prettier': 'error', 'unused-imports/no-unused-imports': 'error', 'no-restricted-imports': [ 'error', diff --git a/package.json b/package.json index 896f78bd..1140bba8 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,6 @@ "@typescript-eslint/eslint-plugin": "8.31.1", "@typescript-eslint/parser": "8.31.1", "eslint": "^9.39.1", - "eslint-plugin-prettier": "^5.4.1", "eslint-plugin-unused-imports": "^4.1.4", "iconv-lite": "^0.6.3", "jest": "^29.4.0", diff --git a/packages/mcp-server/jest.config.ts b/packages/mcp-server/jest.config.ts index 53dd2a25..787cf21f 100644 --- a/packages/mcp-server/jest.config.ts +++ b/packages/mcp-server/jest.config.ts @@ -10,7 +10,9 @@ const config: JestConfigWithTsJest = { '^@tryfinch/finch-api-mcp$': '/src/index.ts', '^@tryfinch/finch-api-mcp/(.*)$': '/src/$1', }, - modulePathIgnorePatterns: ['/dist/'], + modulePathIgnorePatterns: [ + '/dist/', + ], testPathIgnorePatterns: ['scripts'], }; diff --git a/packages/mcp-server/src/auth.ts b/packages/mcp-server/src/auth.ts index 35e3b55e..8e9ab8f3 100644 --- a/packages/mcp-server/src/auth.ts +++ b/packages/mcp-server/src/auth.ts @@ -1,52 +1,38 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -import { IncomingMessage } from 'node:http'; -import { ClientOptions } from '@tryfinch/finch-api'; +import { IncomingMessage } from 'node:http' +import { ClientOptions } from '@tryfinch/finch-api' import { McpOptions } from './options'; -export const parseClientAuthHeaders = (req: IncomingMessage, required?: boolean): Partial => { - if (req.headers.authorization) { - const scheme = req.headers.authorization.split(' ')[0]!; - const value = req.headers.authorization.slice(scheme.length + 1); - switch (scheme) { - case 'Bearer': - return { accessToken: req.headers.authorization.slice('Bearer '.length) }; - case 'Basic': - const rawValue = Buffer.from(value, 'base64').toString(); - return { - clientID: rawValue.slice(0, rawValue.search(':')), - clientSecret: rawValue.slice(rawValue.search(':') + 1), - }; - default: - throw new Error( - 'Unsupported authorization scheme. Expected the "Authorization" header to be a supported scheme (Bearer, Basic).', - ); - } - } else if (required) { - throw new Error('Missing required Authorization header; see WWW-Authenticate header for details.'); +export const parseClientAuthHeaders = (req: IncomingMessage, required?: boolean): Partial => { if (req.headers.authorization) { + const scheme = req.headers.authorization.split(" ")[0]!; + const value = req.headers.authorization.slice(scheme.length + 1); + switch (scheme) { + case 'Bearer': + return { accessToken: req.headers.authorization.slice("Bearer ".length) }; + case 'Basic': + const rawValue = Buffer.from(value, 'base64').toString(); + return { clientID: rawValue.slice(0, rawValue.search(':')), clientSecret: rawValue.slice(rawValue.search(':') + 1) } + default: + throw new Error('Unsupported authorization scheme. Expected the "Authorization" header to be a supported scheme (Bearer, Basic).'); } +} else if (required) { + throw new Error('Missing required Authorization header; see WWW-Authenticate header for details.'); +} - const clientID = - Array.isArray(req.headers['x-finch-client-id']) ? - req.headers['x-finch-client-id'][0] - : req.headers['x-finch-client-id']; - const clientSecret = - Array.isArray(req.headers['x-finch-client-secret']) ? - req.headers['x-finch-client-secret'][0] - : req.headers['x-finch-client-secret']; - return { clientID, clientSecret }; -}; +const clientID = Array.isArray(req.headers['x-finch-client-id']) ? req.headers['x-finch-client-id'][0] : req.headers['x-finch-client-id'] +const clientSecret = Array.isArray(req.headers['x-finch-client-secret']) ? req.headers['x-finch-client-secret'][0] : req.headers['x-finch-client-secret'] +return {clientID, clientSecret}; } export const getStainlessApiKey = (req: IncomingMessage, mcpOptions: McpOptions): string | undefined => { // Try to get the key from the x-stainless-api-key header - const headerKey = - Array.isArray(req.headers['x-stainless-api-key']) ? - req.headers['x-stainless-api-key'][0] - : req.headers['x-stainless-api-key']; + const headerKey = Array.isArray(req.headers['x-stainless-api-key']) ? + req.headers['x-stainless-api-key'][0] + : req.headers['x-stainless-api-key']; if (headerKey && typeof headerKey === 'string') { return headerKey; } // Fall back to value set in the mcpOptions (e.g. from environment variable), if provided return mcpOptions.stainlessApiKey; -}; +} diff --git a/packages/mcp-server/src/code-tool-types.ts b/packages/mcp-server/src/code-tool-types.ts index 6080d5b9..9f8000ab 100644 --- a/packages/mcp-server/src/code-tool-types.ts +++ b/packages/mcp-server/src/code-tool-types.ts @@ -1,6 +1,6 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -import { ClientOptions } from '@tryfinch/finch-api'; +import { ClientOptions } from '@tryfinch/finch-api' export type WorkerInput = { project_name: string; diff --git a/packages/mcp-server/src/code-tool-worker.ts b/packages/mcp-server/src/code-tool-worker.ts index b8f7aa26..7025c635 100644 --- a/packages/mcp-server/src/code-tool-worker.ts +++ b/packages/mcp-server/src/code-tool-worker.ts @@ -59,8 +59,8 @@ function getTSDiagnostics(code: string): string[] { const codeWithImport = [ 'import { Finch } from "@tryfinch/finch-api";', functionSource.type === 'declaration' ? - `async function run(${functionSource.client}: Finch)` - : `const run: (${functionSource.client}: Finch) => Promise =`, + `async function run(${functionSource.client}: Finch)` : + `const run: (${functionSource.client}: Finch) => Promise =`, functionSource.code, ].join('\n'); const sourcePath = path.resolve('code.ts'); @@ -108,53 +108,53 @@ function getTSDiagnostics(code: string): string[] { const fuse = new Fuse( [ - 'client.accessTokens.create', - 'client.hris.company.retrieve', - 'client.hris.company.payStatementItem.list', - 'client.hris.company.payStatementItem.rules.create', - 'client.hris.company.payStatementItem.rules.delete', - 'client.hris.company.payStatementItem.rules.list', - 'client.hris.company.payStatementItem.rules.update', - 'client.hris.directory.list', - 'client.hris.directory.listIndividuals', - 'client.hris.individuals.retrieveMany', - 'client.hris.employments.retrieveMany', - 'client.hris.payments.list', - 'client.hris.payStatements.retrieveMany', - 'client.hris.documents.list', - 'client.hris.documents.retreive', - 'client.hris.benefits.create', - 'client.hris.benefits.list', - 'client.hris.benefits.listSupportedBenefits', - 'client.hris.benefits.retrieve', - 'client.hris.benefits.update', - 'client.hris.benefits.individuals.enrollMany', - 'client.hris.benefits.individuals.enrolledIDs', - 'client.hris.benefits.individuals.retrieveManyBenefits', - 'client.hris.benefits.individuals.unenrollMany', - 'client.providers.list', - 'client.account.disconnect', - 'client.account.introspect', - 'client.requestForwarding.forward', - 'client.jobs.automated.create', - 'client.jobs.automated.list', - 'client.jobs.automated.retrieve', - 'client.jobs.manual.retrieve', - 'client.sandbox.connections.create', - 'client.sandbox.connections.accounts.create', - 'client.sandbox.connections.accounts.update', - 'client.sandbox.company.update', - 'client.sandbox.directory.create', - 'client.sandbox.individual.update', - 'client.sandbox.employment.update', - 'client.sandbox.payment.create', - 'client.sandbox.jobs.create', - 'client.sandbox.jobs.configuration.retrieve', - 'client.sandbox.jobs.configuration.update', - 'client.payroll.payGroups.list', - 'client.payroll.payGroups.retrieve', - 'client.connect.sessions.new', - 'client.connect.sessions.reauthenticate', + "client.accessTokens.create", + "client.hris.company.retrieve", + "client.hris.company.payStatementItem.list", + "client.hris.company.payStatementItem.rules.create", + "client.hris.company.payStatementItem.rules.delete", + "client.hris.company.payStatementItem.rules.list", + "client.hris.company.payStatementItem.rules.update", + "client.hris.directory.list", + "client.hris.directory.listIndividuals", + "client.hris.individuals.retrieveMany", + "client.hris.employments.retrieveMany", + "client.hris.payments.list", + "client.hris.payStatements.retrieveMany", + "client.hris.documents.list", + "client.hris.documents.retreive", + "client.hris.benefits.create", + "client.hris.benefits.list", + "client.hris.benefits.listSupportedBenefits", + "client.hris.benefits.retrieve", + "client.hris.benefits.update", + "client.hris.benefits.individuals.enrollMany", + "client.hris.benefits.individuals.enrolledIDs", + "client.hris.benefits.individuals.retrieveManyBenefits", + "client.hris.benefits.individuals.unenrollMany", + "client.providers.list", + "client.account.disconnect", + "client.account.introspect", + "client.requestForwarding.forward", + "client.jobs.automated.create", + "client.jobs.automated.list", + "client.jobs.automated.retrieve", + "client.jobs.manual.retrieve", + "client.sandbox.connections.create", + "client.sandbox.connections.accounts.create", + "client.sandbox.connections.accounts.update", + "client.sandbox.company.update", + "client.sandbox.directory.create", + "client.sandbox.individual.update", + "client.sandbox.employment.update", + "client.sandbox.payment.create", + "client.sandbox.jobs.create", + "client.sandbox.jobs.configuration.retrieve", + "client.sandbox.jobs.configuration.update", + "client.payroll.payGroups.list", + "client.payroll.payGroups.retrieve", + "client.connect.sessions.new", + "client.connect.sessions.reauthenticate" ], { threshold: 1, shouldSort: true }, ); @@ -237,12 +237,7 @@ function parseError(code: string, error: unknown): string | undefined { // Deno uses V8; the first ":LINE:COLUMN" is the top of stack. const lineNumber = error.stack?.match(/:([0-9]+):[0-9]+/)?.[1]; // -1 for the zero-based indexing - const line = - lineNumber && - code - .split('\n') - .at(parseInt(lineNumber, 10) - 1) - ?.trim(); + const line = lineNumber && code.split('\n').at(parseInt(lineNumber, 10) - 1)?.trim(); return line ? `${message}\n at line ${lineNumber}\n ${line}` : message; } catch { return message; @@ -254,9 +249,8 @@ const fetch = async (req: Request): Promise => { const runFunctionSource = code ? getRunFunctionSource(code) : null; if (!runFunctionSource) { - const message = - code ? - 'The code is missing a top-level `run` function.' + const message = code + ? 'The code is missing a top-level `run` function.' : 'The code argument is missing. Provide one containing a top-level `run` function.'; return Response.json( { @@ -301,7 +295,7 @@ const fetch = async (req: Request): Promise => { try { let run_ = async (client: any) => {}; run_ = (await tseval(`${code}\nexport default run;`)).default; - const result = await run_(makeSdkProxy(client, { path: ['client'] })); + const result = await run_(makeSdkProxy(client, { path: ["client"] })); return Response.json({ is_error: false, result, diff --git a/packages/mcp-server/src/code-tool.ts b/packages/mcp-server/src/code-tool.ts index d3593e6e..dcd226ad 100644 --- a/packages/mcp-server/src/code-tool.ts +++ b/packages/mcp-server/src/code-tool.ts @@ -1,16 +1,8 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -import { - ContentBlock, - McpRequestContext, - McpTool, - Metadata, - ToolCallResult, - asErrorResult, - asTextContentResult, -} from './types'; +import { ContentBlock, McpRequestContext, McpTool, Metadata, ToolCallResult, asErrorResult, asTextContentResult } from './types'; import { Tool } from '@modelcontextprotocol/sdk/types.js'; -import { readEnv } from './util'; +import { readEnv } from "./util"; import { WorkerInput, WorkerOutput } from './code-tool-types'; import { getLogger } from './logger'; import { SdkMethod } from './methods'; @@ -53,13 +45,10 @@ Always type dynamic key-value stores explicitly as Record * @param codeExecutionMode - Whether to execute code in a local Deno environment or in a remote * sandbox environment hosted by Stainless. */ -export function codeTool({ - blockedMethods, - codeExecutionMode, -}: { - blockedMethods: SdkMethod[] | undefined; - codeExecutionMode: McpCodeExecutionMode; -}): McpTool { +export function codeTool( + {blockedMethods, codeExecutionMode}: + {blockedMethods: SdkMethod[] | undefined, codeExecutionMode: McpCodeExecutionMode}, +): McpTool { const metadata: Metadata = { resource: 'all', operation: 'write', tags: [] }; const tool: Tool = { name: 'execute', @@ -82,13 +71,10 @@ export function codeTool({ const logger = getLogger(); - const handler = async ({ - reqContext, - args, - }: { - reqContext: McpRequestContext; - args: any; - }): Promise => { + const handler = async ( + {reqContext, args}: + {reqContext: McpRequestContext, args: any}, + ): Promise => { const code = args.code as string; // Do very basic blocking of code that includes forbidden method names. // @@ -98,11 +84,7 @@ export function codeTool({ if (blockedMethods) { const blockedMatches = blockedMethods.filter((method) => code.includes(method.fullyQualifiedName)); if (blockedMatches.length > 0) { - return asErrorResult( - `The following methods have been blocked by the MCP server and cannot be used in code execution: ${blockedMatches - .map((m) => m.fullyQualifiedName) - .join(', ')}`, - ); + return asErrorResult(`The following methods have been blocked by the MCP server and cannot be used in code execution: ${blockedMatches.map((m) => m.fullyQualifiedName).join(', ')}`); } } @@ -127,43 +109,40 @@ export function codeTool({ 'Got code tool execution result', ); return result; - }; + } return { metadata, tool, handler }; } -const remoteStainlessHandler = async ({ - reqContext, - args, -}: { - reqContext: McpRequestContext; - args: any; -}): Promise => { +const remoteStainlessHandler = async ( + {reqContext, args}: + {reqContext: McpRequestContext, args: any}, +): Promise => { const code = args.code as string; const intent = args.intent as string | undefined; const client = reqContext.client; - const codeModeEndpoint = readEnv('CODE_MODE_ENDPOINT_URL') ?? 'https://api.stainless.com/api/ai/code-tool'; + const codeModeEndpoint = readEnv("CODE_MODE_ENDPOINT_URL") ?? "https://api.stainless.com/api/ai/code-tool"; const localClientEnvs = { - FINCH_CLIENT_ID: readEnv('FINCH_CLIENT_ID') ?? client.clientID ?? undefined, - FINCH_CLIENT_SECRET: readEnv('FINCH_CLIENT_SECRET') ?? client.clientSecret ?? undefined, - FINCH_WEBHOOK_SECRET: readEnv('FINCH_WEBHOOK_SECRET') ?? client.webhookSecret ?? undefined, - FINCH_BASE_URL: readEnv('FINCH_BASE_URL') ?? client.baseURL ?? undefined, - }; + FINCH_CLIENT_ID: readEnv('FINCH_CLIENT_ID') ?? client.clientID ?? undefined, + FINCH_CLIENT_SECRET: readEnv('FINCH_CLIENT_SECRET') ?? client.clientSecret ?? undefined, + FINCH_WEBHOOK_SECRET: readEnv('FINCH_WEBHOOK_SECRET') ?? client.webhookSecret ?? undefined, + FINCH_BASE_URL: readEnv('FINCH_BASE_URL') ?? client.baseURL ?? undefined, +}; // Merge any upstream client envs from the request header, with upstream values taking precedence. const mergedClientEnvs = { ...localClientEnvs, ...reqContext.upstreamClientEnvs }; // Setting a Stainless API key authenticates requests to the code tool endpoint. const res = await fetch(codeModeEndpoint, { - method: 'POST', + method: "POST", headers: { - ...(reqContext.stainlessApiKey && { Authorization: reqContext.stainlessApiKey }), - 'Content-Type': 'application/json', - 'x-stainless-mcp-client-envs': JSON.stringify(mergedClientEnvs), + ...(reqContext.stainlessApiKey && { Authorization: reqContext.stainlessApiKey, }), + "Content-Type": "application/json", + "x-stainless-mcp-client-envs": JSON.stringify(mergedClientEnvs), }, body: JSON.stringify({ - project_name: 'finch', + project_name: "finch", code, intent, client_opts: { accessToken: readEnv('FINCH_ACCESS_TOKEN') }, @@ -172,18 +151,12 @@ const remoteStainlessHandler = async ({ if (!res.ok) { if (res.status === 404 && !reqContext.stainlessApiKey) { - throw new Error( - 'Could not access code tool for this project. You may need to provide a Stainless API key via the STAINLESS_API_KEY environment variable, the --stainless-api-key flag, or the x-stainless-api-key HTTP header.', - ); + throw new Error('Could not access code tool for this project. You may need to provide a Stainless API key via the STAINLESS_API_KEY environment variable, the --stainless-api-key flag, or the x-stainless-api-key HTTP header.'); } - throw new Error( - `${res.status}: ${ - res.statusText - } error when trying to contact Code Tool server. Details: ${await res.text()}`, - ); + throw new Error(`${res.status}: ${res.statusText} error when trying to contact Code Tool server. Details: ${await res.text()}`); } - const { is_error, result, log_lines, err_lines } = (await res.json()) as WorkerOutput; + const { is_error, result, log_lines, err_lines } = await res.json() as WorkerOutput; const hasLogs = log_lines.length > 0 || err_lines.length > 0; const output = { result, @@ -191,18 +164,17 @@ const remoteStainlessHandler = async ({ ...(err_lines.length > 0 && { err_lines }), }; if (is_error) { - return asErrorResult(typeof result === 'string' && !hasLogs ? result : JSON.stringify(output, null, 2)); + return asErrorResult( + typeof result === 'string' && !hasLogs ? result : JSON.stringify(output, null, 2), + ); } return asTextContentResult(output); }; -const localDenoHandler = async ({ - reqContext, - args, -}: { - reqContext: McpRequestContext; - args: unknown; -}): Promise => { +const localDenoHandler = async ( + {reqContext, args} : + {reqContext: McpRequestContext, args: unknown}, +): Promise => { const fs = await import('node:fs'); const path = await import('node:path'); const url = await import('node:url'); @@ -227,20 +199,24 @@ const localDenoHandler = async ({ } catch { try { // Use deno binary in node_modules if it's found - const denoNodeModulesPath = path.resolve(packageNodeModulesPath, 'deno', 'bin.cjs'); + const denoNodeModulesPath = path.resolve( + packageNodeModulesPath, + 'deno', + 'bin.cjs', + ); await fs.promises.access(denoNodeModulesPath, fs.constants.X_OK); denoPath = denoNodeModulesPath; } catch { return asErrorResult( 'Deno is required for code execution but was not found. ' + - 'Install it from https://deno.land or run: npm install deno', + 'Install it from https://deno.land or run: npm install deno', ); } } const allowReadPaths = [ 'code-tool-worker.mjs', - `${workerPath.replace(/([\/\\]node_modules)[\/\\].+$/, '$1')}/`, + `${workerPath.replace(/([\/\\]node_modules)[\/\\].+$/, "$1")}/`, packageRoot, ]; @@ -274,7 +250,7 @@ const localDenoHandler = async ({ // Merge any upstream client envs into the Deno subprocess environment, // with the upstream env vars taking precedence. env: { ...process.env, ...reqContext.upstreamClientEnvs }, - }, + } }); try { @@ -286,14 +262,14 @@ const localDenoHandler = async ({ // Strip null/undefined values so that the worker SDK client can fall back to // reading from environment variables (including any upstreamClientEnvs). const opts = { - ...(client.baseURL != null ? { baseURL: client.baseURL } : undefined), - ...(client.accessToken != null ? { accessToken: client.accessToken } : undefined), - ...(client.clientID != null ? { clientID: client.clientID } : undefined), - ...(client.clientSecret != null ? { clientSecret: client.clientSecret } : undefined), - ...(client.webhookSecret != null ? { webhookSecret: client.webhookSecret } : undefined), - defaultHeaders: { - 'X-Stainless-MCP': 'true', - }, + ...(client.baseURL != null ? { baseURL: client.baseURL } : undefined), + ...(client.accessToken != null ? { accessToken: client.accessToken } : undefined), + ...(client.clientID != null ? { clientID: client.clientID } : undefined), + ...(client.clientSecret != null ? { clientSecret: client.clientSecret } : undefined), + ...(client.webhookSecret != null ? { webhookSecret: client.webhookSecret } : undefined), + defaultHeaders: { + 'X-Stainless-MCP': 'true', + }, } satisfies Partial as ClientOptions; const req = worker.request( @@ -340,12 +316,11 @@ const localDenoHandler = async ({ if (resp.status === 200) { const { result, log_lines, err_lines } = (await resp.json()) as WorkerOutput; const returnOutput: ContentBlock | null = - result == null ? null : ( - { + result == null ? null + : { type: 'text', text: typeof result === 'string' ? result : JSON.stringify(result), - } - ); + }; const logOutput: ContentBlock | null = log_lines.length === 0 ? null @@ -366,12 +341,11 @@ const localDenoHandler = async ({ } else { const { result, log_lines, err_lines } = (await resp.json()) as WorkerOutput; const messageOutput: ContentBlock | null = - result == null ? null : ( - { + result == null ? null + : { type: 'text', text: typeof result === 'string' ? result : JSON.stringify(result), - } - ); + }; const logOutput: ContentBlock | null = log_lines.length === 0 ? null diff --git a/packages/mcp-server/src/docs-search-tool.ts b/packages/mcp-server/src/docs-search-tool.ts index b32ff477..4fb849d4 100644 --- a/packages/mcp-server/src/docs-search-tool.ts +++ b/packages/mcp-server/src/docs-search-tool.ts @@ -14,8 +14,7 @@ export const metadata: Metadata = { export const tool: Tool = { name: 'search_docs', - description: - 'Search SDK documentation to find methods, parameters, and usage examples for interacting with the API. Use this before writing code when you need to discover the right approach.', + description: 'Search SDK documentation to find methods, parameters, and usage examples for interacting with the API. Use this before writing code when you need to discover the right approach.', inputSchema: { type: 'object', properties: { @@ -32,7 +31,7 @@ export const tool: Tool = { type: 'string', description: 'The amount of detail to return.', enum: ['default', 'verbose'], - }, + } }, required: ['query', 'language'], }, @@ -41,8 +40,7 @@ export const tool: Tool = { }, }; -const docsSearchURL = - process.env['DOCS_SEARCH_URL'] || 'https://api.stainless.com/api/projects/finch/docs/search'; +const docsSearchURL = process.env['DOCS_SEARCH_URL'] || 'https://api.stainless.com/api/projects/finch/docs/search' let _localSearch: LocalDocsSearch | undefined; @@ -67,27 +65,30 @@ async function searchLocal(args: Record): Promise { }).results; } -async function searchRemote(args: Record, reqContext: McpRequestContext): Promise { +async function searchRemote( + args: Record, + reqContext: McpRequestContext, +): Promise { const body = args as any; const query = new URLSearchParams(body).toString(); const startTime = Date.now(); - const result = await fetch(`${docsSearchURL}?${query}`, { - headers: { - ...(reqContext.stainlessApiKey && { Authorization: reqContext.stainlessApiKey }), - ...(reqContext.mcpSessionId && { 'x-stainless-mcp-session-id': reqContext.mcpSessionId }), - ...(reqContext.mcpClientInfo && { - 'x-stainless-mcp-client-info': JSON.stringify(reqContext.mcpClientInfo), - }), + const result = await fetch( + `${docsSearchURL}?${query}`, + { + headers: { + ...(reqContext.stainlessApiKey && { Authorization: reqContext.stainlessApiKey }), + ...(reqContext.mcpSessionId && { 'x-stainless-mcp-session-id': reqContext.mcpSessionId }), + ...(reqContext.mcpClientInfo && { 'x-stainless-mcp-client-info': JSON.stringify(reqContext.mcpClientInfo) }), + }, }, - }); + ); const logger = getLogger(); if (!result.ok) { const errorText = await result.text(); - logger.warn( - { + logger.warn({ durationMs: Date.now() - startTime, query: body.query, status: result.status, @@ -98,19 +99,14 @@ async function searchRemote(args: Record, reqContext: McpReques ); if (result.status === 404 && !reqContext.stainlessApiKey) { - throw new Error( - 'Could not find docs for this project. You may need to provide a Stainless API key via the STAINLESS_API_KEY environment variable, the --stainless-api-key flag, or the x-stainless-api-key HTTP header.', - ); + throw new Error('Could not find docs for this project. You may need to provide a Stainless API key via the STAINLESS_API_KEY environment variable, the --stainless-api-key flag, or the x-stainless-api-key HTTP header.'); } - throw new Error( - `${result.status}: ${result.statusText} when using doc search tool. Details: ${errorText}`, - ); + throw new Error(`${result.status}: ${result.statusText} when using doc search tool. Details: ${errorText}`); } const resultBody = await result.json(); - logger.info( - { + logger.info({ durationMs: Date.now() - startTime, query: body.query, }, @@ -119,13 +115,10 @@ async function searchRemote(args: Record, reqContext: McpReques return resultBody; } -export const handler = async ({ - reqContext, - args, -}: { - reqContext: McpRequestContext; - args: Record | undefined; -}) => { +export const handler = async ( + { reqContext, args }: + { reqContext: McpRequestContext; args: Record | undefined }, +) => { const body = args ?? {}; if (_localSearch) { diff --git a/packages/mcp-server/src/http.ts b/packages/mcp-server/src/http.ts index 12c6b0d9..b00e3ce3 100644 --- a/packages/mcp-server/src/http.ts +++ b/packages/mcp-server/src/http.ts @@ -1,7 +1,7 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. import { McpServer } from '@modelcontextprotocol/sdk/server/mcp'; -import { StreamableHTTPServerTransport } from '@modelcontextprotocol/sdk/server/streamableHttp.js'; +import { StreamableHTTPServerTransport } from '@modelcontextprotocol/sdk/server/streamableHttp.js' import { ClientOptions } from '@tryfinch/finch-api'; import express from 'express'; import pino from 'pino'; @@ -24,7 +24,7 @@ const newServer = async ({ }): Promise => { const stainlessApiKey = getStainlessApiKey(req, mcpOptions); const customInstructionsPath = mcpOptions.customInstructionsPath; - const server = await newMcpServer({ stainlessApiKey, customInstructionsPath }); + const server = await newMcpServer({stainlessApiKey, customInstructionsPath}); const authOptions = parseClientAuthHeaders(req, false); @@ -65,13 +65,15 @@ const newServer = async ({ ); } } catch (error) { - getLogger().warn({ error }, 'Failed to parse x-stainless-mcp-client-permissions header'); + getLogger().warn( + { error }, + 'Failed to parse x-stainless-mcp-client-permissions header', + ); } } - const mcpClientInfo = - typeof req.body?.params?.clientInfo?.name === 'string' ? - { name: req.body.params.clientInfo.name, version: String(req.body.params.clientInfo.version ?? '') } + const mcpClientInfo = typeof req.body?.params?.clientInfo?.name === 'string' + ? { name: req.body.params.clientInfo.name, version: String(req.body.params.clientInfo.version ?? '') } : undefined; await initMcpServer({ @@ -88,7 +90,10 @@ const newServer = async ({ }); if (mcpClientInfo) { - getLogger().info({ mcpSessionId: (req as any).mcpSessionId, mcpClientInfo }, 'MCP client connected'); + getLogger().info( + { mcpSessionId: (req as any).mcpSessionId, mcpClientInfo }, + 'MCP client connected', + ); } return server; @@ -128,7 +133,7 @@ const del = async (req: express.Request, res: express.Response) => { const redactHeaders = (headers: Record) => { const hiddenHeaders = /auth|cookie|key|token|x-stainless-mcp-client-envs/i; const filtered = { ...headers }; - Object.keys(filtered).forEach((key) => { + Object.keys(filtered).forEach(key => { if (hiddenHeaders.test(key)) { filtered[key] = '[REDACTED]'; } @@ -181,17 +186,17 @@ export const streamableHTTPApp = ({ req: pino.stdSerializers.wrapRequestSerializer((req) => { return { ...req, - headers: redactHeaders(req.raw.headers), + headers: redactHeaders(req.raw.headers) }; }), res: pino.stdSerializers.wrapResponseSerializer((res) => { return { ...res, - headers: redactHeaders(res.headers), + headers: redactHeaders(res.headers) }; }), - }, - }), + } + }) ); app.get('/health', async (req: express.Request, res: express.Response) => { @@ -204,24 +209,23 @@ export const streamableHTTPApp = ({ return app; }; -export const launchStreamableHTTPServer = async ({ - mcpOptions, - port, -}: { - mcpOptions: McpOptions; - port: number | string | undefined; -}) => { - const app = streamableHTTPApp({ mcpOptions }); - const server = app.listen(port); - const address = server.address(); - - const logger = getLogger(); - - if (typeof address === 'string') { - logger.info(`MCP Server running on streamable HTTP at ${address}`); - } else if (address !== null) { - logger.info(`MCP Server running on streamable HTTP on port ${address.port}`); - } else { - logger.info(`MCP Server running on streamable HTTP on port ${port}`); +export const launchStreamableHTTPServer = async( + {mcpOptions, port}: { + mcpOptions: McpOptions, + port: number | string | undefined, + } +) => { + const app = streamableHTTPApp({ mcpOptions }); + const server = app.listen(port); + const address = server.address(); + + const logger = getLogger(); + + if (typeof address === 'string') { + logger.info(`MCP Server running on streamable HTTP at ${address}`); + } else if (address !== null) { + logger.info(`MCP Server running on streamable HTTP on port ${address.port}`); + } else { + logger.info(`MCP Server running on streamable HTTP on port ${port}`); + } } -}; diff --git a/packages/mcp-server/src/index.ts b/packages/mcp-server/src/index.ts index 5bca4a60..6306dc26 100644 --- a/packages/mcp-server/src/index.ts +++ b/packages/mcp-server/src/index.ts @@ -17,7 +17,7 @@ async function main() { const selectedTools = await selectToolsOrError(options); getLogger().info( - { tools: selectedTools.map((e) => e.tool.name) }, + {tools: selectedTools.map((e) => e.tool.name)}, `MCP Server starting with ${selectedTools.length} tools`, ); diff --git a/packages/mcp-server/src/instructions.ts b/packages/mcp-server/src/instructions.ts index 687f4f36..58278f49 100644 --- a/packages/mcp-server/src/instructions.ts +++ b/packages/mcp-server/src/instructions.ts @@ -60,24 +60,24 @@ async function fetchLatestInstructionsFromApi(stainlessApiKey: string | undefine // Setting the stainless API key is optional, but may be required // to authenticate requests to the Stainless API. const response = await fetch( - readEnv('CODE_MODE_INSTRUCTIONS_URL') ?? 'https://api.stainless.com/api/ai/instructions/finch', + readEnv("CODE_MODE_INSTRUCTIONS_URL") ?? + 'https://api.stainless.com/api/ai/instructions/finch', { - method: 'GET', - headers: { ...(stainlessApiKey && { Authorization: stainlessApiKey }) }, - }, - ); + method: "GET", + headers: { ...( stainlessApiKey && { Authorization: stainlessApiKey } ) } + } + ) let instructions: string | undefined; if (!response.ok) { getLogger().warn( - 'Warning: failed to retrieve MCP server instructions. Proceeding with default instructions...', - ); + "Warning: failed to retrieve MCP server instructions. Proceeding with default instructions..." + ) - instructions = - '\n This is the finch MCP server.\n\n Available tools:\n - search_docs: Search SDK documentation to find the right methods and parameters.\n - execute: Run TypeScript code against a pre-authenticated SDK client. Define an async run(client) function.\n\n Workflow:\n - If unsure about the API, call search_docs first.\n - Write complete solutions in a single execute call when possible. For large datasets, use API filters to narrow results or paginate within a single execute block.\n - If execute returns an error, read the error and fix your code rather than retrying the same approach.\n - Variables do not persist between execute calls. Return or log all data you need.\n - Individual HTTP requests to the API have a 30-second timeout. If a request times out, try a smaller query or add filters.\n - Code execution has a total timeout of approximately 5 minutes. If your code times out, simplify it or break it into smaller steps.\n '; + instructions = "\n This is the finch MCP server.\n\n Available tools:\n - search_docs: Search SDK documentation to find the right methods and parameters.\n - execute: Run TypeScript code against a pre-authenticated SDK client. Define an async run(client) function.\n\n Workflow:\n - If unsure about the API, call search_docs first.\n - Write complete solutions in a single execute call when possible. For large datasets, use API filters to narrow results or paginate within a single execute block.\n - If execute returns an error, read the error and fix your code rather than retrying the same approach.\n - Variables do not persist between execute calls. Return or log all data you need.\n - Individual HTTP requests to the API have a 30-second timeout. If a request times out, try a smaller query or add filters.\n - Code execution has a total timeout of approximately 5 minutes. If your code times out, simplify it or break it into smaller steps.\n "; } - instructions ??= ((await response.json()) as { instructions: string }).instructions; + instructions ??= (await response.json() as { instructions: string }).instructions; return instructions; } diff --git a/packages/mcp-server/src/local-docs-search.ts b/packages/mcp-server/src/local-docs-search.ts index e62ea746..00ffd506 100644 --- a/packages/mcp-server/src/local-docs-search.ts +++ b/packages/mcp-server/src/local-docs-search.ts @@ -51,2480 +51,2129 @@ type SearchResult = { const EMBEDDED_METHODS: MethodEntry[] = [ { - name: 'create', - endpoint: '/auth/token', - httpMethod: 'post', - summary: 'Create Access Token', - description: 'Exchange the authorization code for an access token', - stainlessPath: '(resource) access_tokens > (method) create', - qualified: 'client.accessTokens.create', - params: ['code: string;', 'client_id?: string;', 'client_secret?: string;', 'redirect_uri?: string;'], - response: - "{ access_token: string; client_type: 'development' | 'production' | 'sandbox'; connection_id: string; connection_type: 'finch' | 'provider'; entity_ids: string[]; products: string[]; provider_id: string; token_type: string; account_id?: string; company_id?: string; customer_id?: string; customer_name?: string; }", - markdown: - "## create\n\n`client.accessTokens.create(code: string, client_id?: string, client_secret?: string, redirect_uri?: string): { access_token: string; client_type: 'development' | 'production' | 'sandbox'; connection_id: string; connection_type: 'finch' | 'provider'; entity_ids: string[]; products: string[]; provider_id: string; token_type: string; account_id?: string; company_id?: string; customer_id?: string; customer_name?: string; }`\n\n**post** `/auth/token`\n\nExchange the authorization code for an access token\n\n### Parameters\n\n- `code: string`\n The authorization code received from the authorization server\n\n- `client_id?: string`\n The client ID for your application\n\n- `client_secret?: string`\n The client secret for your application\n\n- `redirect_uri?: string`\n The redirect URI used in the authorization request (optional)\n\n### Returns\n\n- `{ access_token: string; client_type: 'development' | 'production' | 'sandbox'; connection_id: string; connection_type: 'finch' | 'provider'; entity_ids: string[]; products: string[]; provider_id: string; token_type: string; account_id?: string; company_id?: string; customer_id?: string; customer_name?: string; }`\n\n - `access_token: string`\n - `client_type: 'development' | 'production' | 'sandbox'`\n - `connection_id: string`\n - `connection_type: 'finch' | 'provider'`\n - `entity_ids: string[]`\n - `products: string[]`\n - `provider_id: string`\n - `token_type: string`\n - `account_id?: string`\n - `company_id?: string`\n - `customer_id?: string`\n - `customer_name?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst createAccessTokenResponse = await client.accessTokens.create({ code: 'code' });\n\nconsole.log(createAccessTokenResponse);\n```", - perLanguage: { - typescript: { - method: 'client.accessTokens.create', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst createAccessTokenResponse = await client.accessTokens.create({ code: 'code' });\n\nconsole.log(createAccessTokenResponse.connection_id);", - }, - python: { - method: 'access_tokens.create', - example: - 'from finch import Finch\n\nclient = Finch()\ncreate_access_token_response = client.access_tokens.create(\n code="code",\n)\nprint(create_access_token_response.connection_id)', - }, - java: { - method: 'accessTokens().create', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.AccessTokenCreateParams;\nimport com.tryfinch.api.models.CreateAccessTokenResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AccessTokenCreateParams params = AccessTokenCreateParams.builder()\n .code("code")\n .build();\n CreateAccessTokenResponse createAccessTokenResponse = client.accessTokens().create(params);\n }\n}', - }, - kotlin: { - method: 'accessTokens().create', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AccessTokenCreateParams\nimport com.tryfinch.api.models.CreateAccessTokenResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val params: AccessTokenCreateParams = AccessTokenCreateParams.builder()\n .code("code")\n .build()\n val createAccessTokenResponse: CreateAccessTokenResponse = client.accessTokens().create(params)\n}', - }, - go: { - method: 'client.AccessTokens.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t\toption.WithClientID("4ab15e51-11ad-49f4-acae-f343b7794375"),\n\t\toption.WithClientSecret("My Client Secret"),\n\t)\n\tcreateAccessTokenResponse, err := client.AccessTokens.New(context.TODO(), finchgo.AccessTokenNewParams{\n\t\tCode: finchgo.F("code"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", createAccessTokenResponse.ConnectionID)\n}\n', - }, - ruby: { - method: 'access_tokens.create', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(\n access_token: "My Access Token",\n client_id: "4ab15e51-11ad-49f4-acae-f343b7794375",\n client_secret: "My Client Secret"\n)\n\ncreate_access_token_response = finch.access_tokens.create(code: "code")\n\nputs(create_access_token_response)', - }, - http: { - example: - 'curl https://api.tryfinch.com/auth/token \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "code": "code"\n }\'', - }, - }, + "name": "create", + "endpoint": "/auth/token", + "httpMethod": "post", + "summary": "Create Access Token", + "description": "Exchange the authorization code for an access token", + "stainlessPath": "(resource) access_tokens > (method) create", + "qualified": "client.accessTokens.create", + "params": [ + "code: string;", + "client_id?: string;", + "client_secret?: string;", + "redirect_uri?: string;" + ], + "response": "{ access_token: string; client_type: 'development' | 'production' | 'sandbox'; connection_id: string; connection_type: 'finch' | 'provider'; entity_ids: string[]; products: string[]; provider_id: string; token_type: string; account_id?: string; company_id?: string; customer_id?: string; customer_name?: string; }", + "markdown": "## create\n\n`client.accessTokens.create(code: string, client_id?: string, client_secret?: string, redirect_uri?: string): { access_token: string; client_type: 'development' | 'production' | 'sandbox'; connection_id: string; connection_type: 'finch' | 'provider'; entity_ids: string[]; products: string[]; provider_id: string; token_type: string; account_id?: string; company_id?: string; customer_id?: string; customer_name?: string; }`\n\n**post** `/auth/token`\n\nExchange the authorization code for an access token\n\n### Parameters\n\n- `code: string`\n The authorization code received from the authorization server\n\n- `client_id?: string`\n The client ID for your application\n\n- `client_secret?: string`\n The client secret for your application\n\n- `redirect_uri?: string`\n The redirect URI used in the authorization request (optional)\n\n### Returns\n\n- `{ access_token: string; client_type: 'development' | 'production' | 'sandbox'; connection_id: string; connection_type: 'finch' | 'provider'; entity_ids: string[]; products: string[]; provider_id: string; token_type: string; account_id?: string; company_id?: string; customer_id?: string; customer_name?: string; }`\n\n - `access_token: string`\n - `client_type: 'development' | 'production' | 'sandbox'`\n - `connection_id: string`\n - `connection_type: 'finch' | 'provider'`\n - `entity_ids: string[]`\n - `products: string[]`\n - `provider_id: string`\n - `token_type: string`\n - `account_id?: string`\n - `company_id?: string`\n - `customer_id?: string`\n - `customer_name?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst createAccessTokenResponse = await client.accessTokens.create({ code: 'code' });\n\nconsole.log(createAccessTokenResponse);\n```", + "perLanguage": { + "typescript": { + "method": "client.accessTokens.create", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst createAccessTokenResponse = await client.accessTokens.create({ code: 'code' });\n\nconsole.log(createAccessTokenResponse.connection_id);" + }, + "python": { + "method": "access_tokens.create", + "example": "from finch import Finch\n\nclient = Finch()\ncreate_access_token_response = client.access_tokens.create(\n code=\"code\",\n)\nprint(create_access_token_response.connection_id)" + }, + "java": { + "method": "accessTokens().create", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.AccessTokenCreateParams;\nimport com.tryfinch.api.models.CreateAccessTokenResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n AccessTokenCreateParams params = AccessTokenCreateParams.builder()\n .code(\"code\")\n .build();\n CreateAccessTokenResponse createAccessTokenResponse = client.accessTokens().create(params);\n }\n}" + }, + "kotlin": { + "method": "accessTokens().create", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AccessTokenCreateParams\nimport com.tryfinch.api.models.CreateAccessTokenResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val params: AccessTokenCreateParams = AccessTokenCreateParams.builder()\n .code(\"code\")\n .build()\n val createAccessTokenResponse: CreateAccessTokenResponse = client.accessTokens().create(params)\n}" + }, + "go": { + "method": "client.AccessTokens.New", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t\toption.WithClientID(\"4ab15e51-11ad-49f4-acae-f343b7794375\"),\n\t\toption.WithClientSecret(\"My Client Secret\"),\n\t)\n\tcreateAccessTokenResponse, err := client.AccessTokens.New(context.TODO(), finchgo.AccessTokenNewParams{\n\t\tCode: finchgo.F(\"code\"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", createAccessTokenResponse.ConnectionID)\n}\n" + }, + "ruby": { + "method": "access_tokens.create", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(\n access_token: \"My Access Token\",\n client_id: \"4ab15e51-11ad-49f4-acae-f343b7794375\",\n client_secret: \"My Client Secret\"\n)\n\ncreate_access_token_response = finch.access_tokens.create(code: \"code\")\n\nputs(create_access_token_response)" + }, + "http": { + "example": "curl https://api.tryfinch.com/auth/token \\\n -H 'Content-Type: application/json' \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{\n \"code\": \"code\"\n }'" + } + } }, { - name: 'retrieve', - endpoint: '/employer/company', - httpMethod: 'get', - summary: 'Company', - description: 'Read basic company data', - stainlessPath: '(resource) hris.company > (method) retrieve', - qualified: 'client.hris.company.retrieve', - params: ['entity_ids?: string[];'], - response: - "{ id: string; accounts: { account_name: string; account_number: string; account_type: 'checking' | 'savings'; institution_name: string; routing_number: string; }[]; departments: { name: string; parent: { name: string; }; }[]; ein: string; entity: { subtype: 's_corporation' | 'c_corporation' | 'b_corporation'; type: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }; legal_name: string; locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]; primary_email: string; primary_phone_number: string; }", - markdown: - "## retrieve\n\n`client.hris.company.retrieve(entity_ids?: string[]): { id: string; accounts: object[]; departments: object[]; ein: string; entity: object; legal_name: string; locations: location[]; primary_email: string; primary_phone_number: string; }`\n\n**get** `/employer/company`\n\nRead basic company data\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ id: string; accounts: { account_name: string; account_number: string; account_type: 'checking' | 'savings'; institution_name: string; routing_number: string; }[]; departments: { name: string; parent: { name: string; }; }[]; ein: string; entity: { subtype: 's_corporation' | 'c_corporation' | 'b_corporation'; type: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }; legal_name: string; locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]; primary_email: string; primary_phone_number: string; }`\n\n - `id: string`\n - `accounts: { account_name: string; account_number: string; account_type: 'checking' | 'savings'; institution_name: string; routing_number: string; }[]`\n - `departments: { name: string; parent: { name: string; }; }[]`\n - `ein: string`\n - `entity: { subtype: 's_corporation' | 'c_corporation' | 'b_corporation'; type: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }`\n - `legal_name: string`\n - `locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]`\n - `primary_email: string`\n - `primary_phone_number: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst company = await client.hris.company.retrieve();\n\nconsole.log(company);\n```", - perLanguage: { - typescript: { - method: 'client.hris.company.retrieve', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst company = await client.hris.company.retrieve();\n\nconsole.log(company.id);", - }, - python: { - method: 'hris.company.retrieve', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\ncompany = client.hris.company.retrieve()\nprint(company.id)', - }, - java: { - method: 'hris().company().retrieve', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.Company;\nimport com.tryfinch.api.models.HrisCompanyRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n Company company = client.hris().company().retrieve();\n }\n}', - }, - kotlin: { - method: 'hris().company().retrieve', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.Company\nimport com.tryfinch.api.models.HrisCompanyRetrieveParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val company: Company = client.hris().company().retrieve()\n}', - }, - go: { - method: 'client.HRIS.Company.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcompany, err := client.HRIS.Company.Get(context.TODO(), finchgo.HRISCompanyGetParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", company.ID)\n}\n', - }, - ruby: { - method: 'hris.company.retrieve', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\ncompany = finch.hris.company.retrieve\n\nputs(company)', - }, - http: { - example: - 'curl https://api.tryfinch.com/employer/company \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "name": "retrieve", + "endpoint": "/employer/company", + "httpMethod": "get", + "summary": "Company", + "description": "Read basic company data", + "stainlessPath": "(resource) hris.company > (method) retrieve", + "qualified": "client.hris.company.retrieve", + "params": [ + "entity_ids?: string[];" + ], + "response": "{ id: string; accounts: { account_name: string; account_number: string; account_type: 'checking' | 'savings'; institution_name: string; routing_number: string; }[]; departments: { name: string; parent: { name: string; }; }[]; ein: string; entity: { subtype: 's_corporation' | 'c_corporation' | 'b_corporation'; type: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }; legal_name: string; locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]; primary_email: string; primary_phone_number: string; }", + "markdown": "## retrieve\n\n`client.hris.company.retrieve(entity_ids?: string[]): { id: string; accounts: object[]; departments: object[]; ein: string; entity: object; legal_name: string; locations: location[]; primary_email: string; primary_phone_number: string; }`\n\n**get** `/employer/company`\n\nRead basic company data\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ id: string; accounts: { account_name: string; account_number: string; account_type: 'checking' | 'savings'; institution_name: string; routing_number: string; }[]; departments: { name: string; parent: { name: string; }; }[]; ein: string; entity: { subtype: 's_corporation' | 'c_corporation' | 'b_corporation'; type: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }; legal_name: string; locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]; primary_email: string; primary_phone_number: string; }`\n\n - `id: string`\n - `accounts: { account_name: string; account_number: string; account_type: 'checking' | 'savings'; institution_name: string; routing_number: string; }[]`\n - `departments: { name: string; parent: { name: string; }; }[]`\n - `ein: string`\n - `entity: { subtype: 's_corporation' | 'c_corporation' | 'b_corporation'; type: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }`\n - `legal_name: string`\n - `locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]`\n - `primary_email: string`\n - `primary_phone_number: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst company = await client.hris.company.retrieve();\n\nconsole.log(company);\n```", + "perLanguage": { + "typescript": { + "method": "client.hris.company.retrieve", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst company = await client.hris.company.retrieve();\n\nconsole.log(company.id);" + }, + "python": { + "method": "hris.company.retrieve", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\ncompany = client.hris.company.retrieve()\nprint(company.id)" + }, + "java": { + "method": "hris().company().retrieve", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.Company;\nimport com.tryfinch.api.models.HrisCompanyRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n Company company = client.hris().company().retrieve();\n }\n}" + }, + "kotlin": { + "method": "hris().company().retrieve", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.Company\nimport com.tryfinch.api.models.HrisCompanyRetrieveParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val company: Company = client.hris().company().retrieve()\n}" + }, + "go": { + "method": "client.HRIS.Company.Get", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tcompany, err := client.HRIS.Company.Get(context.TODO(), finchgo.HRISCompanyGetParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", company.ID)\n}\n" + }, + "ruby": { + "method": "hris.company.retrieve", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\ncompany = finch.hris.company.retrieve\n\nputs(company)" + }, + "http": { + "example": "curl https://api.tryfinch.com/employer/company \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'list', - endpoint: '/employer/pay-statement-item', - httpMethod: 'get', - summary: 'Pay Statement Item', - description: - "Retrieve a list of detailed pay statement items for the access token's connection account.\n", - stainlessPath: '(resource) hris.company.pay_statement_item > (method) list', - qualified: 'client.hris.company.payStatementItem.list', - params: [ + "name": "list", + "endpoint": "/employer/pay-statement-item", + "httpMethod": "get", + "summary": "Pay Statement Item", + "description": "Retrieve a list of detailed pay statement items for the access token's connection account.\n", + "stainlessPath": "(resource) hris.company.pay_statement_item > (method) list", + "qualified": "client.hris.company.payStatementItem.list", + "params": [ "categories?: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions'[];", - 'end_date?: string;', - 'entity_ids?: string[];', - 'name?: string;', - 'start_date?: string;', - 'type?: string;', + "end_date?: string;", + "entity_ids?: string[];", + "name?: string;", + "start_date?: string;", + "type?: string;" ], - response: - "{ attributes: { metadata: object; employer?: boolean; pre_tax?: boolean; type?: string; }; category: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions'; name: string; }", - markdown: - "## list\n\n`client.hris.company.payStatementItem.list(categories?: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions'[], end_date?: string, entity_ids?: string[], name?: string, start_date?: string, type?: string): { attributes: object; category: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions'; name: string; }`\n\n**get** `/employer/pay-statement-item`\n\nRetrieve a list of detailed pay statement items for the access token's connection account.\n\n\n### Parameters\n\n- `categories?: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions'[]`\n Comma-delimited list of pay statement item categories to filter on. If empty, defaults to all categories.\n\n- `end_date?: string`\n The end date to retrieve pay statement items by via their last seen pay date in `YYYY-MM-DD` format.\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `name?: string`\n Case-insensitive partial match search by pay statement item name.\n\n- `start_date?: string`\n The start date to retrieve pay statement items by via their last seen pay date (inclusive) in `YYYY-MM-DD` format.\n\n- `type?: string`\n String search by pay statement item type.\n\n### Returns\n\n- `{ attributes: { metadata: object; employer?: boolean; pre_tax?: boolean; type?: string; }; category: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions'; name: string; }`\n\n - `attributes: { metadata: object; employer?: boolean; pre_tax?: boolean; type?: string; }`\n - `category: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions'`\n - `name: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const payStatementItemListResponse of client.hris.company.payStatementItem.list()) {\n console.log(payStatementItemListResponse);\n}\n```", - perLanguage: { - typescript: { - method: 'client.hris.company.payStatementItem.list', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const payStatementItemListResponse of client.hris.company.payStatementItem.list()) {\n console.log(payStatementItemListResponse.attributes);\n}", - }, - python: { - method: 'hris.company.pay_statement_item.list', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.company.pay_statement_item.list()\npage = page.responses[0]\nprint(page.attributes)', - }, - java: { - method: 'hris().company().payStatementItem().list', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemListPage;\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HrisCompanyPayStatementItemListPage page = client.hris().company().payStatementItem().list();\n }\n}', - }, - kotlin: { - method: 'hris().company().payStatementItem().list', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemListPage\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val page: HrisCompanyPayStatementItemListPage = client.hris().company().payStatementItem().list()\n}', - }, - go: { - method: 'client.HRIS.Company.PayStatementItem.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Company.PayStatementItem.List(context.TODO(), finchgo.HRISCompanyPayStatementItemListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'hris.company.pay_statement_item.list', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.company.pay_statement_item.list\n\nputs(page)', - }, - http: { - example: - 'curl https://api.tryfinch.com/employer/pay-statement-item \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "response": "{ attributes: { metadata: object; employer?: boolean; pre_tax?: boolean; type?: string; }; category: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions'; name: string; }", + "markdown": "## list\n\n`client.hris.company.payStatementItem.list(categories?: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions'[], end_date?: string, entity_ids?: string[], name?: string, start_date?: string, type?: string): { attributes: object; category: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions'; name: string; }`\n\n**get** `/employer/pay-statement-item`\n\nRetrieve a list of detailed pay statement items for the access token's connection account.\n\n\n### Parameters\n\n- `categories?: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions'[]`\n Comma-delimited list of pay statement item categories to filter on. If empty, defaults to all categories.\n\n- `end_date?: string`\n The end date to retrieve pay statement items by via their last seen pay date in `YYYY-MM-DD` format.\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `name?: string`\n Case-insensitive partial match search by pay statement item name.\n\n- `start_date?: string`\n The start date to retrieve pay statement items by via their last seen pay date (inclusive) in `YYYY-MM-DD` format.\n\n- `type?: string`\n String search by pay statement item type.\n\n### Returns\n\n- `{ attributes: { metadata: object; employer?: boolean; pre_tax?: boolean; type?: string; }; category: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions'; name: string; }`\n\n - `attributes: { metadata: object; employer?: boolean; pre_tax?: boolean; type?: string; }`\n - `category: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions'`\n - `name: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const payStatementItemListResponse of client.hris.company.payStatementItem.list()) {\n console.log(payStatementItemListResponse);\n}\n```", + "perLanguage": { + "typescript": { + "method": "client.hris.company.payStatementItem.list", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const payStatementItemListResponse of client.hris.company.payStatementItem.list()) {\n console.log(payStatementItemListResponse.attributes);\n}" + }, + "python": { + "method": "hris.company.pay_statement_item.list", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\npage = client.hris.company.pay_statement_item.list()\npage = page.responses[0]\nprint(page.attributes)" + }, + "java": { + "method": "hris().company().payStatementItem().list", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemListPage;\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n HrisCompanyPayStatementItemListPage page = client.hris().company().payStatementItem().list();\n }\n}" + }, + "kotlin": { + "method": "hris().company().payStatementItem().list", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemListPage\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val page: HrisCompanyPayStatementItemListPage = client.hris().company().payStatementItem().list()\n}" + }, + "go": { + "method": "client.HRIS.Company.PayStatementItem.List", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tpage, err := client.HRIS.Company.PayStatementItem.List(context.TODO(), finchgo.HRISCompanyPayStatementItemListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n" + }, + "ruby": { + "method": "hris.company.pay_statement_item.list", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\npage = finch.hris.company.pay_statement_item.list\n\nputs(page)" + }, + "http": { + "example": "curl https://api.tryfinch.com/employer/pay-statement-item \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'create', - endpoint: '/employer/pay-statement-item/rule', - httpMethod: 'post', - summary: 'Create Rule', - description: - 'Custom rules can be created to associate specific attributes to pay statement items depending on the use case. For example, pay statement items that meet certain conditions can be labeled as a pre-tax 401k. This metadata can be retrieved where pay statement item information is available.\n', - stainlessPath: '(resource) hris.company.pay_statement_item.rules > (method) create', - qualified: 'client.hris.company.payStatementItem.rules.create', - params: [ - 'entity_ids?: string[];', - 'attributes?: { metadata?: object; };', + "name": "create", + "endpoint": "/employer/pay-statement-item/rule", + "httpMethod": "post", + "summary": "Create Rule", + "description": "Custom rules can be created to associate specific attributes to pay statement items depending on the use case. For example, pay statement items that meet certain conditions can be labeled as a pre-tax 401k. This metadata can be retrieved where pay statement item information is available.\n", + "stainlessPath": "(resource) hris.company.pay_statement_item.rules > (method) create", + "qualified": "client.hris.company.payStatementItem.rules.create", + "params": [ + "entity_ids?: string[];", + "attributes?: { metadata?: object; };", "conditions?: { field?: string; operator?: 'equals'; value?: string; }[];", - 'effective_end_date?: string;', - 'effective_start_date?: string;', - "entity_type?: 'pay_statement_item';", + "effective_end_date?: string;", + "effective_start_date?: string;", + "entity_type?: 'pay_statement_item';" ], - response: - "{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }", - markdown: - "## create\n\n`client.hris.company.payStatementItem.rules.create(entity_ids?: string[], attributes?: { metadata?: object; }, conditions?: { field?: string; operator?: 'equals'; value?: string; }[], effective_end_date?: string, effective_start_date?: string, entity_type?: 'pay_statement_item'): { id?: string; attributes?: object; conditions?: object[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n**post** `/employer/pay-statement-item/rule`\n\nCustom rules can be created to associate specific attributes to pay statement items depending on the use case. For example, pay statement items that meet certain conditions can be labeled as a pre-tax 401k. This metadata can be retrieved where pay statement item information is available.\n\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to create the rule for.\n\n- `attributes?: { metadata?: object; }`\n Specifies the fields to be applied when the condition is met.\n - `metadata?: object`\n The metadata to be attached in the entity. It is a key-value pairs where the values can be of any type (string, number, boolean, object, array, etc.).\n\n- `conditions?: { field?: string; operator?: 'equals'; value?: string; }[]`\n\n- `effective_end_date?: string`\n Specifies when the rules should stop applying rules based on the date.\n\n- `effective_start_date?: string`\n Specifies when the rule should begin applying based on the date.\n\n- `entity_type?: 'pay_statement_item'`\n The entity type to which the rule is applied.\n\n### Returns\n\n- `{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n - `id?: string`\n - `attributes?: { metadata?: object; }`\n - `conditions?: { field?: string; operator?: 'equals'; value?: string; }[]`\n - `created_at?: string`\n - `effective_end_date?: string`\n - `effective_start_date?: string`\n - `entity_type?: 'pay_statement_item'`\n - `priority?: number`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst rule = await client.hris.company.payStatementItem.rules.create();\n\nconsole.log(rule);\n```", - perLanguage: { - typescript: { - method: 'client.hris.company.payStatementItem.rules.create', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst rule = await client.hris.company.payStatementItem.rules.create();\n\nconsole.log(rule.id);", - }, - python: { - method: 'hris.company.pay_statement_item.rules.create', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nrule = client.hris.company.pay_statement_item.rules.create()\nprint(rule.id)', - }, - java: { - method: 'hris().company().payStatementItem().rules().create', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleCreateParams;\nimport com.tryfinch.api.models.RuleCreateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RuleCreateResponse rule = client.hris().company().payStatementItem().rules().create();\n }\n}', - }, - kotlin: { - method: 'hris().company().payStatementItem().rules().create', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleCreateParams\nimport com.tryfinch.api.models.RuleCreateResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val rule: RuleCreateResponse = client.hris().company().payStatementItem().rules().create()\n}', - }, - go: { - method: 'client.HRIS.Company.PayStatementItem.Rules.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\trule, err := client.HRIS.Company.PayStatementItem.Rules.New(context.TODO(), finchgo.HRISCompanyPayStatementItemRuleNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", rule.ID)\n}\n', - }, - ruby: { - method: 'hris.company.pay_statement_item.rules.create', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nrule = finch.hris.company.pay_statement_item.rules.create\n\nputs(rule)', - }, - http: { - example: - 'curl https://api.tryfinch.com/employer/pay-statement-item/rule \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "response": "{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }", + "markdown": "## create\n\n`client.hris.company.payStatementItem.rules.create(entity_ids?: string[], attributes?: { metadata?: object; }, conditions?: { field?: string; operator?: 'equals'; value?: string; }[], effective_end_date?: string, effective_start_date?: string, entity_type?: 'pay_statement_item'): { id?: string; attributes?: object; conditions?: object[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n**post** `/employer/pay-statement-item/rule`\n\nCustom rules can be created to associate specific attributes to pay statement items depending on the use case. For example, pay statement items that meet certain conditions can be labeled as a pre-tax 401k. This metadata can be retrieved where pay statement item information is available.\n\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to create the rule for.\n\n- `attributes?: { metadata?: object; }`\n Specifies the fields to be applied when the condition is met.\n - `metadata?: object`\n The metadata to be attached in the entity. It is a key-value pairs where the values can be of any type (string, number, boolean, object, array, etc.).\n\n- `conditions?: { field?: string; operator?: 'equals'; value?: string; }[]`\n\n- `effective_end_date?: string`\n Specifies when the rules should stop applying rules based on the date.\n\n- `effective_start_date?: string`\n Specifies when the rule should begin applying based on the date.\n\n- `entity_type?: 'pay_statement_item'`\n The entity type to which the rule is applied.\n\n### Returns\n\n- `{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n - `id?: string`\n - `attributes?: { metadata?: object; }`\n - `conditions?: { field?: string; operator?: 'equals'; value?: string; }[]`\n - `created_at?: string`\n - `effective_end_date?: string`\n - `effective_start_date?: string`\n - `entity_type?: 'pay_statement_item'`\n - `priority?: number`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst rule = await client.hris.company.payStatementItem.rules.create();\n\nconsole.log(rule);\n```", + "perLanguage": { + "typescript": { + "method": "client.hris.company.payStatementItem.rules.create", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst rule = await client.hris.company.payStatementItem.rules.create();\n\nconsole.log(rule.id);" + }, + "python": { + "method": "hris.company.pay_statement_item.rules.create", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nrule = client.hris.company.pay_statement_item.rules.create()\nprint(rule.id)" + }, + "java": { + "method": "hris().company().payStatementItem().rules().create", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleCreateParams;\nimport com.tryfinch.api.models.RuleCreateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n RuleCreateResponse rule = client.hris().company().payStatementItem().rules().create();\n }\n}" + }, + "kotlin": { + "method": "hris().company().payStatementItem().rules().create", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleCreateParams\nimport com.tryfinch.api.models.RuleCreateResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val rule: RuleCreateResponse = client.hris().company().payStatementItem().rules().create()\n}" + }, + "go": { + "method": "client.HRIS.Company.PayStatementItem.Rules.New", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\trule, err := client.HRIS.Company.PayStatementItem.Rules.New(context.TODO(), finchgo.HRISCompanyPayStatementItemRuleNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", rule.ID)\n}\n" + }, + "ruby": { + "method": "hris.company.pay_statement_item.rules.create", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nrule = finch.hris.company.pay_statement_item.rules.create\n\nputs(rule)" + }, + "http": { + "example": "curl https://api.tryfinch.com/employer/pay-statement-item/rule \\\n -X POST \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'list', - endpoint: '/employer/pay-statement-item/rule', - httpMethod: 'get', - summary: 'Get Rules', - description: 'List all rules of a connection account.', - stainlessPath: '(resource) hris.company.pay_statement_item.rules > (method) list', - qualified: 'client.hris.company.payStatementItem.rules.list', - params: ['entity_ids?: string[];'], - response: - "{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }", - markdown: - "## list\n\n`client.hris.company.payStatementItem.rules.list(entity_ids?: string[]): { id?: string; attributes?: object; conditions?: object[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n**get** `/employer/pay-statement-item/rule`\n\nList all rules of a connection account.\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to retrieve rules for.\n\n### Returns\n\n- `{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n - `id?: string`\n - `attributes?: { metadata?: object; }`\n - `conditions?: { field?: string; operator?: 'equals'; value?: string; }[]`\n - `created_at?: string`\n - `effective_end_date?: string`\n - `effective_start_date?: string`\n - `entity_type?: 'pay_statement_item'`\n - `priority?: number`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const ruleListResponse of client.hris.company.payStatementItem.rules.list()) {\n console.log(ruleListResponse);\n}\n```", - perLanguage: { - typescript: { - method: 'client.hris.company.payStatementItem.rules.list', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const ruleListResponse of client.hris.company.payStatementItem.rules.list()) {\n console.log(ruleListResponse.id);\n}", - }, - python: { - method: 'hris.company.pay_statement_item.rules.list', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.company.pay_statement_item.rules.list()\npage = page.responses[0]\nprint(page.id)', - }, - java: { - method: 'hris().company().payStatementItem().rules().list', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleListPage;\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HrisCompanyPayStatementItemRuleListPage page = client.hris().company().payStatementItem().rules().list();\n }\n}', - }, - kotlin: { - method: 'hris().company().payStatementItem().rules().list', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleListPage\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val page: HrisCompanyPayStatementItemRuleListPage = client.hris().company().payStatementItem().rules().list()\n}', - }, - go: { - method: 'client.HRIS.Company.PayStatementItem.Rules.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Company.PayStatementItem.Rules.List(context.TODO(), finchgo.HRISCompanyPayStatementItemRuleListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'hris.company.pay_statement_item.rules.list', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.company.pay_statement_item.rules.list\n\nputs(page)', - }, - http: { - example: - 'curl https://api.tryfinch.com/employer/pay-statement-item/rule \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "name": "list", + "endpoint": "/employer/pay-statement-item/rule", + "httpMethod": "get", + "summary": "Get Rules", + "description": "List all rules of a connection account.", + "stainlessPath": "(resource) hris.company.pay_statement_item.rules > (method) list", + "qualified": "client.hris.company.payStatementItem.rules.list", + "params": [ + "entity_ids?: string[];" + ], + "response": "{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }", + "markdown": "## list\n\n`client.hris.company.payStatementItem.rules.list(entity_ids?: string[]): { id?: string; attributes?: object; conditions?: object[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n**get** `/employer/pay-statement-item/rule`\n\nList all rules of a connection account.\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to retrieve rules for.\n\n### Returns\n\n- `{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n - `id?: string`\n - `attributes?: { metadata?: object; }`\n - `conditions?: { field?: string; operator?: 'equals'; value?: string; }[]`\n - `created_at?: string`\n - `effective_end_date?: string`\n - `effective_start_date?: string`\n - `entity_type?: 'pay_statement_item'`\n - `priority?: number`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const ruleListResponse of client.hris.company.payStatementItem.rules.list()) {\n console.log(ruleListResponse);\n}\n```", + "perLanguage": { + "typescript": { + "method": "client.hris.company.payStatementItem.rules.list", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const ruleListResponse of client.hris.company.payStatementItem.rules.list()) {\n console.log(ruleListResponse.id);\n}" + }, + "python": { + "method": "hris.company.pay_statement_item.rules.list", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\npage = client.hris.company.pay_statement_item.rules.list()\npage = page.responses[0]\nprint(page.id)" + }, + "java": { + "method": "hris().company().payStatementItem().rules().list", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleListPage;\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n HrisCompanyPayStatementItemRuleListPage page = client.hris().company().payStatementItem().rules().list();\n }\n}" + }, + "kotlin": { + "method": "hris().company().payStatementItem().rules().list", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleListPage\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val page: HrisCompanyPayStatementItemRuleListPage = client.hris().company().payStatementItem().rules().list()\n}" + }, + "go": { + "method": "client.HRIS.Company.PayStatementItem.Rules.List", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tpage, err := client.HRIS.Company.PayStatementItem.Rules.List(context.TODO(), finchgo.HRISCompanyPayStatementItemRuleListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n" + }, + "ruby": { + "method": "hris.company.pay_statement_item.rules.list", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\npage = finch.hris.company.pay_statement_item.rules.list\n\nputs(page)" + }, + "http": { + "example": "curl https://api.tryfinch.com/employer/pay-statement-item/rule \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'update', - endpoint: '/employer/pay-statement-item/rule/{rule_id}', - httpMethod: 'put', - summary: 'Update Rule', - description: 'Update a rule for a pay statement item.', - stainlessPath: '(resource) hris.company.pay_statement_item.rules > (method) update', - qualified: 'client.hris.company.payStatementItem.rules.update', - params: ['rule_id: string;', 'entity_ids?: string[];', 'optionalProperty?: object;'], - response: - "{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }", - markdown: - "## update\n\n`client.hris.company.payStatementItem.rules.update(rule_id: string, entity_ids?: string[], optionalProperty?: object): { id?: string; attributes?: object; conditions?: object[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n**put** `/employer/pay-statement-item/rule/{rule_id}`\n\nUpdate a rule for a pay statement item.\n\n### Parameters\n\n- `rule_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to update the rule for.\n\n- `optionalProperty?: object`\n\n### Returns\n\n- `{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n - `id?: string`\n - `attributes?: { metadata?: object; }`\n - `conditions?: { field?: string; operator?: 'equals'; value?: string; }[]`\n - `created_at?: string`\n - `effective_end_date?: string`\n - `effective_start_date?: string`\n - `entity_type?: 'pay_statement_item'`\n - `priority?: number`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst rule = await client.hris.company.payStatementItem.rules.update('rule_id');\n\nconsole.log(rule);\n```", - perLanguage: { - typescript: { - method: 'client.hris.company.payStatementItem.rules.update', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst rule = await client.hris.company.payStatementItem.rules.update('rule_id');\n\nconsole.log(rule.id);", - }, - python: { - method: 'hris.company.pay_statement_item.rules.update', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nrule = client.hris.company.pay_statement_item.rules.update(\n rule_id="rule_id",\n)\nprint(rule.id)', - }, - java: { - method: 'hris().company().payStatementItem().rules().update', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleUpdateParams;\nimport com.tryfinch.api.models.RuleUpdateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RuleUpdateResponse rule = client.hris().company().payStatementItem().rules().update("rule_id");\n }\n}', - }, - kotlin: { - method: 'hris().company().payStatementItem().rules().update', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleUpdateParams\nimport com.tryfinch.api.models.RuleUpdateResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val rule: RuleUpdateResponse = client.hris().company().payStatementItem().rules().update("rule_id")\n}', - }, - go: { - method: 'client.HRIS.Company.PayStatementItem.Rules.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\trule, err := client.HRIS.Company.PayStatementItem.Rules.Update(\n\t\tcontext.TODO(),\n\t\t"rule_id",\n\t\tfinchgo.HRISCompanyPayStatementItemRuleUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", rule.ID)\n}\n', - }, - ruby: { - method: 'hris.company.pay_statement_item.rules.update', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nrule = finch.hris.company.pay_statement_item.rules.update("rule_id")\n\nputs(rule)', - }, - http: { - example: - 'curl https://api.tryfinch.com/employer/pay-statement-item/rule/$RULE_ID \\\n -X PUT \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "name": "update", + "endpoint": "/employer/pay-statement-item/rule/{rule_id}", + "httpMethod": "put", + "summary": "Update Rule", + "description": "Update a rule for a pay statement item.", + "stainlessPath": "(resource) hris.company.pay_statement_item.rules > (method) update", + "qualified": "client.hris.company.payStatementItem.rules.update", + "params": [ + "rule_id: string;", + "entity_ids?: string[];", + "optionalProperty?: object;" + ], + "response": "{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }", + "markdown": "## update\n\n`client.hris.company.payStatementItem.rules.update(rule_id: string, entity_ids?: string[], optionalProperty?: object): { id?: string; attributes?: object; conditions?: object[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n**put** `/employer/pay-statement-item/rule/{rule_id}`\n\nUpdate a rule for a pay statement item.\n\n### Parameters\n\n- `rule_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to update the rule for.\n\n- `optionalProperty?: object`\n\n### Returns\n\n- `{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n - `id?: string`\n - `attributes?: { metadata?: object; }`\n - `conditions?: { field?: string; operator?: 'equals'; value?: string; }[]`\n - `created_at?: string`\n - `effective_end_date?: string`\n - `effective_start_date?: string`\n - `entity_type?: 'pay_statement_item'`\n - `priority?: number`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst rule = await client.hris.company.payStatementItem.rules.update('rule_id');\n\nconsole.log(rule);\n```", + "perLanguage": { + "typescript": { + "method": "client.hris.company.payStatementItem.rules.update", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst rule = await client.hris.company.payStatementItem.rules.update('rule_id');\n\nconsole.log(rule.id);" + }, + "python": { + "method": "hris.company.pay_statement_item.rules.update", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nrule = client.hris.company.pay_statement_item.rules.update(\n rule_id=\"rule_id\",\n)\nprint(rule.id)" + }, + "java": { + "method": "hris().company().payStatementItem().rules().update", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleUpdateParams;\nimport com.tryfinch.api.models.RuleUpdateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n RuleUpdateResponse rule = client.hris().company().payStatementItem().rules().update(\"rule_id\");\n }\n}" + }, + "kotlin": { + "method": "hris().company().payStatementItem().rules().update", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleUpdateParams\nimport com.tryfinch.api.models.RuleUpdateResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val rule: RuleUpdateResponse = client.hris().company().payStatementItem().rules().update(\"rule_id\")\n}" + }, + "go": { + "method": "client.HRIS.Company.PayStatementItem.Rules.Update", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\trule, err := client.HRIS.Company.PayStatementItem.Rules.Update(\n\t\tcontext.TODO(),\n\t\t\"rule_id\",\n\t\tfinchgo.HRISCompanyPayStatementItemRuleUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", rule.ID)\n}\n" + }, + "ruby": { + "method": "hris.company.pay_statement_item.rules.update", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nrule = finch.hris.company.pay_statement_item.rules.update(\"rule_id\")\n\nputs(rule)" + }, + "http": { + "example": "curl https://api.tryfinch.com/employer/pay-statement-item/rule/$RULE_ID \\\n -X PUT \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'delete', - endpoint: '/employer/pay-statement-item/rule/{rule_id}', - httpMethod: 'delete', - summary: 'Delete Rule', - description: 'Delete a rule for a pay statement item.', - stainlessPath: '(resource) hris.company.pay_statement_item.rules > (method) delete', - qualified: 'client.hris.company.payStatementItem.rules.delete', - params: ['rule_id: string;', 'entity_ids?: string[];'], - response: - "{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; deleted_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }", - markdown: - "## delete\n\n`client.hris.company.payStatementItem.rules.delete(rule_id: string, entity_ids?: string[]): { id?: string; attributes?: object; conditions?: object[]; created_at?: string; deleted_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n**delete** `/employer/pay-statement-item/rule/{rule_id}`\n\nDelete a rule for a pay statement item.\n\n### Parameters\n\n- `rule_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to delete the rule for.\n\n### Returns\n\n- `{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; deleted_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n - `id?: string`\n - `attributes?: { metadata?: object; }`\n - `conditions?: { field?: string; operator?: 'equals'; value?: string; }[]`\n - `created_at?: string`\n - `deleted_at?: string`\n - `effective_end_date?: string`\n - `effective_start_date?: string`\n - `entity_type?: 'pay_statement_item'`\n - `priority?: number`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst rule = await client.hris.company.payStatementItem.rules.delete('rule_id');\n\nconsole.log(rule);\n```", - perLanguage: { - typescript: { - method: 'client.hris.company.payStatementItem.rules.delete', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst rule = await client.hris.company.payStatementItem.rules.delete('rule_id');\n\nconsole.log(rule.id);", - }, - python: { - method: 'hris.company.pay_statement_item.rules.delete', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nrule = client.hris.company.pay_statement_item.rules.delete(\n rule_id="rule_id",\n)\nprint(rule.id)', - }, - java: { - method: 'hris().company().payStatementItem().rules().delete', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleDeleteParams;\nimport com.tryfinch.api.models.RuleDeleteResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RuleDeleteResponse rule = client.hris().company().payStatementItem().rules().delete("rule_id");\n }\n}', - }, - kotlin: { - method: 'hris().company().payStatementItem().rules().delete', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleDeleteParams\nimport com.tryfinch.api.models.RuleDeleteResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val rule: RuleDeleteResponse = client.hris().company().payStatementItem().rules().delete("rule_id")\n}', - }, - go: { - method: 'client.HRIS.Company.PayStatementItem.Rules.Delete', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\trule, err := client.HRIS.Company.PayStatementItem.Rules.Delete(\n\t\tcontext.TODO(),\n\t\t"rule_id",\n\t\tfinchgo.HRISCompanyPayStatementItemRuleDeleteParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", rule.ID)\n}\n', - }, - ruby: { - method: 'hris.company.pay_statement_item.rules.delete', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nrule = finch.hris.company.pay_statement_item.rules.delete("rule_id")\n\nputs(rule)', - }, - http: { - example: - 'curl https://api.tryfinch.com/employer/pay-statement-item/rule/$RULE_ID \\\n -X DELETE \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "name": "delete", + "endpoint": "/employer/pay-statement-item/rule/{rule_id}", + "httpMethod": "delete", + "summary": "Delete Rule", + "description": "Delete a rule for a pay statement item.", + "stainlessPath": "(resource) hris.company.pay_statement_item.rules > (method) delete", + "qualified": "client.hris.company.payStatementItem.rules.delete", + "params": [ + "rule_id: string;", + "entity_ids?: string[];" + ], + "response": "{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; deleted_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }", + "markdown": "## delete\n\n`client.hris.company.payStatementItem.rules.delete(rule_id: string, entity_ids?: string[]): { id?: string; attributes?: object; conditions?: object[]; created_at?: string; deleted_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n**delete** `/employer/pay-statement-item/rule/{rule_id}`\n\nDelete a rule for a pay statement item.\n\n### Parameters\n\n- `rule_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to delete the rule for.\n\n### Returns\n\n- `{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; deleted_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n - `id?: string`\n - `attributes?: { metadata?: object; }`\n - `conditions?: { field?: string; operator?: 'equals'; value?: string; }[]`\n - `created_at?: string`\n - `deleted_at?: string`\n - `effective_end_date?: string`\n - `effective_start_date?: string`\n - `entity_type?: 'pay_statement_item'`\n - `priority?: number`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst rule = await client.hris.company.payStatementItem.rules.delete('rule_id');\n\nconsole.log(rule);\n```", + "perLanguage": { + "typescript": { + "method": "client.hris.company.payStatementItem.rules.delete", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst rule = await client.hris.company.payStatementItem.rules.delete('rule_id');\n\nconsole.log(rule.id);" + }, + "python": { + "method": "hris.company.pay_statement_item.rules.delete", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nrule = client.hris.company.pay_statement_item.rules.delete(\n rule_id=\"rule_id\",\n)\nprint(rule.id)" + }, + "java": { + "method": "hris().company().payStatementItem().rules().delete", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleDeleteParams;\nimport com.tryfinch.api.models.RuleDeleteResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n RuleDeleteResponse rule = client.hris().company().payStatementItem().rules().delete(\"rule_id\");\n }\n}" + }, + "kotlin": { + "method": "hris().company().payStatementItem().rules().delete", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleDeleteParams\nimport com.tryfinch.api.models.RuleDeleteResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val rule: RuleDeleteResponse = client.hris().company().payStatementItem().rules().delete(\"rule_id\")\n}" + }, + "go": { + "method": "client.HRIS.Company.PayStatementItem.Rules.Delete", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\trule, err := client.HRIS.Company.PayStatementItem.Rules.Delete(\n\t\tcontext.TODO(),\n\t\t\"rule_id\",\n\t\tfinchgo.HRISCompanyPayStatementItemRuleDeleteParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", rule.ID)\n}\n" + }, + "ruby": { + "method": "hris.company.pay_statement_item.rules.delete", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nrule = finch.hris.company.pay_statement_item.rules.delete(\"rule_id\")\n\nputs(rule)" + }, + "http": { + "example": "curl https://api.tryfinch.com/employer/pay-statement-item/rule/$RULE_ID \\\n -X DELETE \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'list', - endpoint: '/employer/directory', - httpMethod: 'get', - summary: 'Directory', - description: 'Read company directory and organization structure', - stainlessPath: '(resource) hris.directory > (method) list', - qualified: 'client.hris.directory.list', - params: ['entity_ids?: string[];', 'limit?: number;', 'offset?: number;'], - response: - '{ id: string; department: { name?: string; }; first_name: string; is_active: boolean; last_name: string; manager: { id: string; }; middle_name: string; }', - markdown: - "## list\n\n`client.hris.directory.list(entity_ids?: string[], limit?: number, offset?: number): { id: string; department: object; first_name: string; is_active: boolean; last_name: string; manager: object; middle_name: string; }`\n\n**get** `/employer/directory`\n\nRead company directory and organization structure\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `limit?: number`\n Number of employees to return (defaults to all)\n\n- `offset?: number`\n Index to start from (defaults to 0)\n\n### Returns\n\n- `{ id: string; department: { name?: string; }; first_name: string; is_active: boolean; last_name: string; manager: { id: string; }; middle_name: string; }`\n\n - `id: string`\n - `department: { name?: string; }`\n - `first_name: string`\n - `is_active: boolean`\n - `last_name: string`\n - `manager: { id: string; }`\n - `middle_name: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const individualInDirectory of client.hris.directory.list()) {\n console.log(individualInDirectory);\n}\n```", - perLanguage: { - typescript: { - method: 'client.hris.directory.list', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const individualInDirectory of client.hris.directory.list()) {\n console.log(individualInDirectory.id);\n}", - }, - python: { - method: 'hris.directory.list', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.directory.list()\npage = page.individuals[0]\nprint(page.id)', - }, - java: { - method: 'hris().directory().list', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisDirectoryListPage;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HrisDirectoryListPage page = client.hris().directory().list();\n }\n}', - }, - kotlin: { - method: 'hris().directory().list', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisDirectoryListPage\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val page: HrisDirectoryListPage = client.hris().directory().list()\n}', - }, - go: { - method: 'client.HRIS.Directory.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Directory.List(context.TODO(), finchgo.HRISDirectoryListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'hris.directory.list', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.directory.list\n\nputs(page)', - }, - http: { - example: - 'curl https://api.tryfinch.com/employer/directory \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "name": "list", + "endpoint": "/employer/directory", + "httpMethod": "get", + "summary": "Directory", + "description": "Read company directory and organization structure", + "stainlessPath": "(resource) hris.directory > (method) list", + "qualified": "client.hris.directory.list", + "params": [ + "entity_ids?: string[];", + "limit?: number;", + "offset?: number;" + ], + "response": "{ id: string; department: { name?: string; }; first_name: string; is_active: boolean; last_name: string; manager: { id: string; }; middle_name: string; }", + "markdown": "## list\n\n`client.hris.directory.list(entity_ids?: string[], limit?: number, offset?: number): { id: string; department: object; first_name: string; is_active: boolean; last_name: string; manager: object; middle_name: string; }`\n\n**get** `/employer/directory`\n\nRead company directory and organization structure\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `limit?: number`\n Number of employees to return (defaults to all)\n\n- `offset?: number`\n Index to start from (defaults to 0)\n\n### Returns\n\n- `{ id: string; department: { name?: string; }; first_name: string; is_active: boolean; last_name: string; manager: { id: string; }; middle_name: string; }`\n\n - `id: string`\n - `department: { name?: string; }`\n - `first_name: string`\n - `is_active: boolean`\n - `last_name: string`\n - `manager: { id: string; }`\n - `middle_name: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const individualInDirectory of client.hris.directory.list()) {\n console.log(individualInDirectory);\n}\n```", + "perLanguage": { + "typescript": { + "method": "client.hris.directory.list", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const individualInDirectory of client.hris.directory.list()) {\n console.log(individualInDirectory.id);\n}" + }, + "python": { + "method": "hris.directory.list", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\npage = client.hris.directory.list()\npage = page.individuals[0]\nprint(page.id)" + }, + "java": { + "method": "hris().directory().list", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisDirectoryListPage;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n HrisDirectoryListPage page = client.hris().directory().list();\n }\n}" + }, + "kotlin": { + "method": "hris().directory().list", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisDirectoryListPage\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val page: HrisDirectoryListPage = client.hris().directory().list()\n}" + }, + "go": { + "method": "client.HRIS.Directory.List", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tpage, err := client.HRIS.Directory.List(context.TODO(), finchgo.HRISDirectoryListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n" + }, + "ruby": { + "method": "hris.directory.list", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\npage = finch.hris.directory.list\n\nputs(page)" + }, + "http": { + "example": "curl https://api.tryfinch.com/employer/directory \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'list_individuals', - endpoint: '/employer/directory', - httpMethod: 'get', - summary: 'Directory', - description: 'Read company directory and organization structure', - stainlessPath: '(resource) hris.directory > (method) list_individuals', - qualified: 'client.hris.directory.listIndividuals', - perLanguage: { - typescript: { - method: 'client.hris.directory.listIndividuals', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.hris.directory.listIndividuals();\n\nconsole.log(response.individuals);", - }, - python: { - method: 'hris.directory.list_individuals', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nresponse = client.hris.directory.list_individuals()\nprint(response.individuals)', - }, - java: { - method: 'hris().directory().listIndividuals', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.DirectoryListIndividualsResponse;\nimport com.tryfinch.api.models.HrisDirectoryListIndividualsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DirectoryListIndividualsResponse response = client.hris().directory().listIndividuals();\n }\n}', - }, - kotlin: { - method: 'hris().directory().listIndividuals', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.DirectoryListIndividualsResponse\nimport com.tryfinch.api.models.HrisDirectoryListIndividualsParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val response: DirectoryListIndividualsResponse = client.hris().directory().listIndividuals()\n}', - }, - go: { - method: 'client.HRIS.Directory.ListIndividuals', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.HRIS.Directory.ListIndividuals(context.TODO(), finchgo.HRISDirectoryListIndividualsParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response.Individuals)\n}\n', - }, - ruby: { - method: 'hris.directory.list_individuals', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nresponse = finch.hris.directory.list_individuals\n\nputs(response)', - }, - }, + "name": "list_individuals", + "endpoint": "/employer/directory", + "httpMethod": "get", + "summary": "Directory", + "description": "Read company directory and organization structure", + "stainlessPath": "(resource) hris.directory > (method) list_individuals", + "qualified": "client.hris.directory.listIndividuals", + "perLanguage": { + "typescript": { + "method": "client.hris.directory.listIndividuals", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.hris.directory.listIndividuals();\n\nconsole.log(response.individuals);" + }, + "python": { + "method": "hris.directory.list_individuals", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nresponse = client.hris.directory.list_individuals()\nprint(response.individuals)" + }, + "java": { + "method": "hris().directory().listIndividuals", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.DirectoryListIndividualsResponse;\nimport com.tryfinch.api.models.HrisDirectoryListIndividualsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n DirectoryListIndividualsResponse response = client.hris().directory().listIndividuals();\n }\n}" + }, + "kotlin": { + "method": "hris().directory().listIndividuals", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.DirectoryListIndividualsResponse\nimport com.tryfinch.api.models.HrisDirectoryListIndividualsParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val response: DirectoryListIndividualsResponse = client.hris().directory().listIndividuals()\n}" + }, + "go": { + "method": "client.HRIS.Directory.ListIndividuals", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tresponse, err := client.HRIS.Directory.ListIndividuals(context.TODO(), finchgo.HRISDirectoryListIndividualsParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.Individuals)\n}\n" + }, + "ruby": { + "method": "hris.directory.list_individuals", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nresponse = finch.hris.directory.list_individuals\n\nputs(response)" + } + } }, { - name: 'retrieve_many', - endpoint: '/employer/individual', - httpMethod: 'post', - summary: 'Individual', - description: 'Read individual data, excluding income and employment data', - stainlessPath: '(resource) hris.individuals > (method) retrieve_many', - qualified: 'client.hris.individuals.retrieveMany', - params: [ - 'entity_ids?: string[];', - 'options?: { include?: string[]; };', - 'requests?: { individual_id?: string; }[];', + "name": "retrieve_many", + "endpoint": "/employer/individual", + "httpMethod": "post", + "summary": "Individual", + "description": "Read individual data, excluding income and employment data", + "stainlessPath": "(resource) hris.individuals > (method) retrieve_many", + "qualified": "client.hris.individuals.retrieveMany", + "params": [ + "entity_ids?: string[];", + "options?: { include?: string[]; };", + "requests?: { individual_id?: string; }[];" ], - response: - "{ body: { id: string; dob: string; ethnicity: string; first_name: string; gender: 'female' | 'male' | 'other' | 'decline_to_specify'; last_name: string; middle_name: string; phone_numbers: object[]; preferred_name: string; residence: location; emails?: object[]; encrypted_ssn?: string; ssn?: string; } | { code: number; message: string; name: string; finch_code?: string; }; code: number; individual_id: string; }", - markdown: - "## retrieve_many\n\n`client.hris.individuals.retrieveMany(entity_ids?: string[], options?: { include?: string[]; }, requests?: { individual_id?: string; }[]): { body: individual; code: number; individual_id: string; }`\n\n**post** `/employer/individual`\n\nRead individual data, excluding income and employment data\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `options?: { include?: string[]; }`\n - `include?: string[]`\n\n- `requests?: { individual_id?: string; }[]`\n\n### Returns\n\n- `{ body: { id: string; dob: string; ethnicity: string; first_name: string; gender: 'female' | 'male' | 'other' | 'decline_to_specify'; last_name: string; middle_name: string; phone_numbers: object[]; preferred_name: string; residence: location; emails?: object[]; encrypted_ssn?: string; ssn?: string; } | { code: number; message: string; name: string; finch_code?: string; }; code: number; individual_id: string; }`\n\n - `body: { id: string; dob: string; ethnicity: string; first_name: string; gender: 'female' | 'male' | 'other' | 'decline_to_specify'; last_name: string; middle_name: string; phone_numbers: { data: string; type: 'work' | 'personal'; }[]; preferred_name: string; residence: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; emails?: { data: string; type: 'work' | 'personal'; }[]; encrypted_ssn?: string; ssn?: string; } | { code: number; message: string; name: string; finch_code?: string; }`\n - `code: number`\n - `individual_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const individualResponse of client.hris.individuals.retrieveMany()) {\n console.log(individualResponse);\n}\n```", - perLanguage: { - typescript: { - method: 'client.hris.individuals.retrieveMany', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const individualResponse of client.hris.individuals.retrieveMany()) {\n console.log(individualResponse.individual_id);\n}", - }, - python: { - method: 'hris.individuals.retrieve_many', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.individuals.retrieve_many()\npage = page.responses[0]\nprint(page.individual_id)', - }, - java: { - method: 'hris().individuals().retrieveMany', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisIndividualRetrieveManyPage;\nimport com.tryfinch.api.models.HrisIndividualRetrieveManyParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HrisIndividualRetrieveManyPage page = client.hris().individuals().retrieveMany();\n }\n}', - }, - kotlin: { - method: 'hris().individuals().retrieveMany', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisIndividualRetrieveManyPage\nimport com.tryfinch.api.models.HrisIndividualRetrieveManyParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val page: HrisIndividualRetrieveManyPage = client.hris().individuals().retrieveMany()\n}', - }, - go: { - method: 'client.HRIS.Individuals.GetMany', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Individuals.GetMany(context.TODO(), finchgo.HRISIndividualGetManyParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'hris.individuals.retrieve_many', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.individuals.retrieve_many\n\nputs(page)', - }, - http: { - example: - 'curl https://api.tryfinch.com/employer/individual \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "response": "{ body: { id: string; dob: string; ethnicity: string; first_name: string; gender: 'female' | 'male' | 'other' | 'decline_to_specify'; last_name: string; middle_name: string; phone_numbers: object[]; preferred_name: string; residence: location; emails?: object[]; encrypted_ssn?: string; ssn?: string; } | { code: number; message: string; name: string; finch_code?: string; }; code: number; individual_id: string; }", + "markdown": "## retrieve_many\n\n`client.hris.individuals.retrieveMany(entity_ids?: string[], options?: { include?: string[]; }, requests?: { individual_id?: string; }[]): { body: individual; code: number; individual_id: string; }`\n\n**post** `/employer/individual`\n\nRead individual data, excluding income and employment data\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `options?: { include?: string[]; }`\n - `include?: string[]`\n\n- `requests?: { individual_id?: string; }[]`\n\n### Returns\n\n- `{ body: { id: string; dob: string; ethnicity: string; first_name: string; gender: 'female' | 'male' | 'other' | 'decline_to_specify'; last_name: string; middle_name: string; phone_numbers: object[]; preferred_name: string; residence: location; emails?: object[]; encrypted_ssn?: string; ssn?: string; } | { code: number; message: string; name: string; finch_code?: string; }; code: number; individual_id: string; }`\n\n - `body: { id: string; dob: string; ethnicity: string; first_name: string; gender: 'female' | 'male' | 'other' | 'decline_to_specify'; last_name: string; middle_name: string; phone_numbers: { data: string; type: 'work' | 'personal'; }[]; preferred_name: string; residence: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; emails?: { data: string; type: 'work' | 'personal'; }[]; encrypted_ssn?: string; ssn?: string; } | { code: number; message: string; name: string; finch_code?: string; }`\n - `code: number`\n - `individual_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const individualResponse of client.hris.individuals.retrieveMany()) {\n console.log(individualResponse);\n}\n```", + "perLanguage": { + "typescript": { + "method": "client.hris.individuals.retrieveMany", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const individualResponse of client.hris.individuals.retrieveMany()) {\n console.log(individualResponse.individual_id);\n}" + }, + "python": { + "method": "hris.individuals.retrieve_many", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\npage = client.hris.individuals.retrieve_many()\npage = page.responses[0]\nprint(page.individual_id)" + }, + "java": { + "method": "hris().individuals().retrieveMany", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisIndividualRetrieveManyPage;\nimport com.tryfinch.api.models.HrisIndividualRetrieveManyParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n HrisIndividualRetrieveManyPage page = client.hris().individuals().retrieveMany();\n }\n}" + }, + "kotlin": { + "method": "hris().individuals().retrieveMany", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisIndividualRetrieveManyPage\nimport com.tryfinch.api.models.HrisIndividualRetrieveManyParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val page: HrisIndividualRetrieveManyPage = client.hris().individuals().retrieveMany()\n}" + }, + "go": { + "method": "client.HRIS.Individuals.GetMany", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tpage, err := client.HRIS.Individuals.GetMany(context.TODO(), finchgo.HRISIndividualGetManyParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n" + }, + "ruby": { + "method": "hris.individuals.retrieve_many", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\npage = finch.hris.individuals.retrieve_many\n\nputs(page)" + }, + "http": { + "example": "curl https://api.tryfinch.com/employer/individual \\\n -X POST \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'retrieve_many', - endpoint: '/employer/employment', - httpMethod: 'post', - summary: 'Employment', - description: 'Read individual employment and income data', - stainlessPath: '(resource) hris.employments > (method) retrieve_many', - qualified: 'client.hris.employments.retrieveMany', - params: ['requests: { individual_id: string; }[];', 'entity_ids?: string[];'], - response: - "{ body: { id: string; class_code: string; department: object; employment: object; employment_status: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; end_date: string; first_name: string; flsa_status: 'exempt' | 'non_exempt' | 'unknown'; is_active: boolean; last_name: string; latest_rehire_date: string; location: location; manager: object; middle_name: string; start_date: string; title: string; custom_fields?: object[]; income?: income; income_history?: income[]; source_id?: string; work_id?: string; } | { code: number; message: string; name: string; finch_code?: string; }; code: number; individual_id: string; }", - markdown: - "## retrieve_many\n\n`client.hris.employments.retrieveMany(requests: { individual_id: string; }[], entity_ids?: string[]): { body: employment_data; code: number; individual_id: string; }`\n\n**post** `/employer/employment`\n\nRead individual employment and income data\n\n### Parameters\n\n- `requests: { individual_id: string; }[]`\n The array of batch requests.\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ body: { id: string; class_code: string; department: object; employment: object; employment_status: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; end_date: string; first_name: string; flsa_status: 'exempt' | 'non_exempt' | 'unknown'; is_active: boolean; last_name: string; latest_rehire_date: string; location: location; manager: object; middle_name: string; start_date: string; title: string; custom_fields?: object[]; income?: income; income_history?: income[]; source_id?: string; work_id?: string; } | { code: number; message: string; name: string; finch_code?: string; }; code: number; individual_id: string; }`\n\n - `body: { id: string; class_code: string; department: { name: string; }; employment: { subtype: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type: 'employee' | 'contractor'; }; employment_status: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; end_date: string; first_name: string; flsa_status: 'exempt' | 'non_exempt' | 'unknown'; is_active: boolean; last_name: string; latest_rehire_date: string; location: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; manager: { id: string; }; middle_name: string; start_date: string; title: string; custom_fields?: { name?: string; value?: string | object[] | object | number | boolean; }[]; income?: { amount: number; currency: string; effective_date: string; unit: string; }; income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]; source_id?: string; work_id?: string; } | { code: number; message: string; name: string; finch_code?: string; }`\n - `code: number`\n - `individual_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const employmentDataResponse of client.hris.employments.retrieveMany({ requests: [{ individual_id: 'individual_id' }] })) {\n console.log(employmentDataResponse);\n}\n```", - perLanguage: { - typescript: { - method: 'client.hris.employments.retrieveMany', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const employmentDataResponse of client.hris.employments.retrieveMany({\n requests: [{ individual_id: 'individual_id' }],\n})) {\n console.log(employmentDataResponse.individual_id);\n}", - }, - python: { - method: 'hris.employments.retrieve_many', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.employments.retrieve_many(\n requests=[{\n "individual_id": "individual_id"\n }],\n)\npage = page.responses[0]\nprint(page.individual_id)', - }, - java: { - method: 'hris().employments().retrieveMany', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisEmploymentRetrieveManyPage;\nimport com.tryfinch.api.models.HrisEmploymentRetrieveManyParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HrisEmploymentRetrieveManyParams params = HrisEmploymentRetrieveManyParams.builder()\n .addRequest(HrisEmploymentRetrieveManyParams.Request.builder()\n .individualId("individual_id")\n .build())\n .build();\n HrisEmploymentRetrieveManyPage page = client.hris().employments().retrieveMany(params);\n }\n}', - }, - kotlin: { - method: 'hris().employments().retrieveMany', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisEmploymentRetrieveManyPage\nimport com.tryfinch.api.models.HrisEmploymentRetrieveManyParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val params: HrisEmploymentRetrieveManyParams = HrisEmploymentRetrieveManyParams.builder()\n .addRequest(HrisEmploymentRetrieveManyParams.Request.builder()\n .individualId("individual_id")\n .build())\n .build()\n val page: HrisEmploymentRetrieveManyPage = client.hris().employments().retrieveMany(params)\n}', - }, - go: { - method: 'client.HRIS.Employments.GetMany', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Employments.GetMany(context.TODO(), finchgo.HRISEmploymentGetManyParams{\n\t\tRequests: finchgo.F([]finchgo.HRISEmploymentGetManyParamsRequest{{\n\t\t\tIndividualID: finchgo.F("individual_id"),\n\t\t}}),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'hris.employments.retrieve_many', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.employments.retrieve_many(requests: [{individual_id: "individual_id"}])\n\nputs(page)', - }, - http: { - example: - 'curl https://api.tryfinch.com/employer/employment \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "requests": [\n {\n "individual_id": "individual_id"\n }\n ]\n }\'', - }, - }, + "name": "retrieve_many", + "endpoint": "/employer/employment", + "httpMethod": "post", + "summary": "Employment", + "description": "Read individual employment and income data", + "stainlessPath": "(resource) hris.employments > (method) retrieve_many", + "qualified": "client.hris.employments.retrieveMany", + "params": [ + "requests: { individual_id: string; }[];", + "entity_ids?: string[];" + ], + "response": "{ body: { id: string; class_code: string; department: object; employment: object; employment_status: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; end_date: string; first_name: string; flsa_status: 'exempt' | 'non_exempt' | 'unknown'; is_active: boolean; last_name: string; latest_rehire_date: string; location: location; manager: object; middle_name: string; start_date: string; title: string; custom_fields?: object[]; income?: income; income_history?: income[]; source_id?: string; work_id?: string; } | { code: number; message: string; name: string; finch_code?: string; }; code: number; individual_id: string; }", + "markdown": "## retrieve_many\n\n`client.hris.employments.retrieveMany(requests: { individual_id: string; }[], entity_ids?: string[]): { body: employment_data; code: number; individual_id: string; }`\n\n**post** `/employer/employment`\n\nRead individual employment and income data\n\n### Parameters\n\n- `requests: { individual_id: string; }[]`\n The array of batch requests.\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ body: { id: string; class_code: string; department: object; employment: object; employment_status: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; end_date: string; first_name: string; flsa_status: 'exempt' | 'non_exempt' | 'unknown'; is_active: boolean; last_name: string; latest_rehire_date: string; location: location; manager: object; middle_name: string; start_date: string; title: string; custom_fields?: object[]; income?: income; income_history?: income[]; source_id?: string; work_id?: string; } | { code: number; message: string; name: string; finch_code?: string; }; code: number; individual_id: string; }`\n\n - `body: { id: string; class_code: string; department: { name: string; }; employment: { subtype: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type: 'employee' | 'contractor'; }; employment_status: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; end_date: string; first_name: string; flsa_status: 'exempt' | 'non_exempt' | 'unknown'; is_active: boolean; last_name: string; latest_rehire_date: string; location: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; manager: { id: string; }; middle_name: string; start_date: string; title: string; custom_fields?: { name?: string; value?: string | object[] | object | number | boolean; }[]; income?: { amount: number; currency: string; effective_date: string; unit: string; }; income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]; source_id?: string; work_id?: string; } | { code: number; message: string; name: string; finch_code?: string; }`\n - `code: number`\n - `individual_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const employmentDataResponse of client.hris.employments.retrieveMany({ requests: [{ individual_id: 'individual_id' }] })) {\n console.log(employmentDataResponse);\n}\n```", + "perLanguage": { + "typescript": { + "method": "client.hris.employments.retrieveMany", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const employmentDataResponse of client.hris.employments.retrieveMany({\n requests: [{ individual_id: 'individual_id' }],\n})) {\n console.log(employmentDataResponse.individual_id);\n}" + }, + "python": { + "method": "hris.employments.retrieve_many", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\npage = client.hris.employments.retrieve_many(\n requests=[{\n \"individual_id\": \"individual_id\"\n }],\n)\npage = page.responses[0]\nprint(page.individual_id)" + }, + "java": { + "method": "hris().employments().retrieveMany", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisEmploymentRetrieveManyPage;\nimport com.tryfinch.api.models.HrisEmploymentRetrieveManyParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n HrisEmploymentRetrieveManyParams params = HrisEmploymentRetrieveManyParams.builder()\n .addRequest(HrisEmploymentRetrieveManyParams.Request.builder()\n .individualId(\"individual_id\")\n .build())\n .build();\n HrisEmploymentRetrieveManyPage page = client.hris().employments().retrieveMany(params);\n }\n}" + }, + "kotlin": { + "method": "hris().employments().retrieveMany", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisEmploymentRetrieveManyPage\nimport com.tryfinch.api.models.HrisEmploymentRetrieveManyParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val params: HrisEmploymentRetrieveManyParams = HrisEmploymentRetrieveManyParams.builder()\n .addRequest(HrisEmploymentRetrieveManyParams.Request.builder()\n .individualId(\"individual_id\")\n .build())\n .build()\n val page: HrisEmploymentRetrieveManyPage = client.hris().employments().retrieveMany(params)\n}" + }, + "go": { + "method": "client.HRIS.Employments.GetMany", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tpage, err := client.HRIS.Employments.GetMany(context.TODO(), finchgo.HRISEmploymentGetManyParams{\n\t\tRequests: finchgo.F([]finchgo.HRISEmploymentGetManyParamsRequest{{\n\t\t\tIndividualID: finchgo.F(\"individual_id\"),\n\t\t}}),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n" + }, + "ruby": { + "method": "hris.employments.retrieve_many", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\npage = finch.hris.employments.retrieve_many(requests: [{individual_id: \"individual_id\"}])\n\nputs(page)" + }, + "http": { + "example": "curl https://api.tryfinch.com/employer/employment \\\n -H 'Content-Type: application/json' \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{\n \"requests\": [\n {\n \"individual_id\": \"individual_id\"\n }\n ]\n }'" + } + } }, { - name: 'list', - endpoint: '/employer/payment', - httpMethod: 'get', - summary: 'Payment', - description: 'Read payroll and contractor related payments by the company.', - stainlessPath: '(resource) hris.payments > (method) list', - qualified: 'client.hris.payments.list', - params: ['end_date: string;', 'start_date: string;', 'entity_ids?: string[];'], - response: - '{ id: string; company_debit: { amount: number; currency: string; }; debit_date: string; employee_taxes: { amount: number; currency: string; }; employer_taxes: { amount: number; currency: string; }; gross_pay: { amount: number; currency: string; }; individual_ids: string[]; net_pay: { amount: number; currency: string; }; pay_date: string; pay_frequencies: string[]; pay_group_ids: string[]; pay_period: { end_date: string; start_date: string; }; }', - markdown: - "## list\n\n`client.hris.payments.list(end_date: string, start_date: string, entity_ids?: string[]): { id: string; company_debit: money; debit_date: string; employee_taxes: money; employer_taxes: money; gross_pay: money; individual_ids: string[]; net_pay: money; pay_date: string; pay_frequencies: string[]; pay_group_ids: string[]; pay_period: object; }`\n\n**get** `/employer/payment`\n\nRead payroll and contractor related payments by the company.\n\n### Parameters\n\n- `end_date: string`\n The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` format. Filters payments by their **pay_date** field.\n\n- `start_date: string`\n The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` format. Filters payments by their **pay_date** field.\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ id: string; company_debit: { amount: number; currency: string; }; debit_date: string; employee_taxes: { amount: number; currency: string; }; employer_taxes: { amount: number; currency: string; }; gross_pay: { amount: number; currency: string; }; individual_ids: string[]; net_pay: { amount: number; currency: string; }; pay_date: string; pay_frequencies: string[]; pay_group_ids: string[]; pay_period: { end_date: string; start_date: string; }; }`\n\n - `id: string`\n - `company_debit: { amount: number; currency: string; }`\n - `debit_date: string`\n - `employee_taxes: { amount: number; currency: string; }`\n - `employer_taxes: { amount: number; currency: string; }`\n - `gross_pay: { amount: number; currency: string; }`\n - `individual_ids: string[]`\n - `net_pay: { amount: number; currency: string; }`\n - `pay_date: string`\n - `pay_frequencies: string[]`\n - `pay_group_ids: string[]`\n - `pay_period: { end_date: string; start_date: string; }`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const payment of client.hris.payments.list({ end_date: '2021-01-01', start_date: '2021-01-01' })) {\n console.log(payment);\n}\n```", - perLanguage: { - typescript: { - method: 'client.hris.payments.list', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const payment of client.hris.payments.list({\n end_date: '2021-01-01',\n start_date: '2021-01-01',\n})) {\n console.log(payment.id);\n}", - }, - python: { - method: 'hris.payments.list', - example: - 'from datetime import date\nfrom finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.payments.list(\n end_date=date.fromisoformat("2021-01-01"),\n start_date=date.fromisoformat("2021-01-01"),\n)\npage = page.items[0]\nprint(page.id)', - }, - java: { - method: 'hris().payments().list', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisPaymentListPage;\nimport com.tryfinch.api.models.HrisPaymentListParams;\nimport java.time.LocalDate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HrisPaymentListParams params = HrisPaymentListParams.builder()\n .endDate(LocalDate.parse("2021-01-01"))\n .startDate(LocalDate.parse("2021-01-01"))\n .build();\n HrisPaymentListPage page = client.hris().payments().list(params);\n }\n}', - }, - kotlin: { - method: 'hris().payments().list', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisPaymentListPage\nimport com.tryfinch.api.models.HrisPaymentListParams\nimport java.time.LocalDate\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val params: HrisPaymentListParams = HrisPaymentListParams.builder()\n .endDate(LocalDate.parse("2021-01-01"))\n .startDate(LocalDate.parse("2021-01-01"))\n .build()\n val page: HrisPaymentListPage = client.hris().payments().list(params)\n}', - }, - go: { - method: 'client.HRIS.Payments.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Payments.List(context.TODO(), finchgo.HRISPaymentListParams{\n\t\tEndDate: finchgo.F(time.Now()),\n\t\tStartDate: finchgo.F(time.Now()),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'hris.payments.list', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.payments.list(end_date: "2021-01-01", start_date: "2021-01-01")\n\nputs(page)', - }, - http: { - example: - 'curl https://api.tryfinch.com/employer/payment \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "name": "list", + "endpoint": "/employer/payment", + "httpMethod": "get", + "summary": "Payment", + "description": "Read payroll and contractor related payments by the company.", + "stainlessPath": "(resource) hris.payments > (method) list", + "qualified": "client.hris.payments.list", + "params": [ + "end_date: string;", + "start_date: string;", + "entity_ids?: string[];" + ], + "response": "{ id: string; company_debit: { amount: number; currency: string; }; debit_date: string; employee_taxes: { amount: number; currency: string; }; employer_taxes: { amount: number; currency: string; }; gross_pay: { amount: number; currency: string; }; individual_ids: string[]; net_pay: { amount: number; currency: string; }; pay_date: string; pay_frequencies: string[]; pay_group_ids: string[]; pay_period: { end_date: string; start_date: string; }; }", + "markdown": "## list\n\n`client.hris.payments.list(end_date: string, start_date: string, entity_ids?: string[]): { id: string; company_debit: money; debit_date: string; employee_taxes: money; employer_taxes: money; gross_pay: money; individual_ids: string[]; net_pay: money; pay_date: string; pay_frequencies: string[]; pay_group_ids: string[]; pay_period: object; }`\n\n**get** `/employer/payment`\n\nRead payroll and contractor related payments by the company.\n\n### Parameters\n\n- `end_date: string`\n The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` format. Filters payments by their **pay_date** field.\n\n- `start_date: string`\n The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` format. Filters payments by their **pay_date** field.\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ id: string; company_debit: { amount: number; currency: string; }; debit_date: string; employee_taxes: { amount: number; currency: string; }; employer_taxes: { amount: number; currency: string; }; gross_pay: { amount: number; currency: string; }; individual_ids: string[]; net_pay: { amount: number; currency: string; }; pay_date: string; pay_frequencies: string[]; pay_group_ids: string[]; pay_period: { end_date: string; start_date: string; }; }`\n\n - `id: string`\n - `company_debit: { amount: number; currency: string; }`\n - `debit_date: string`\n - `employee_taxes: { amount: number; currency: string; }`\n - `employer_taxes: { amount: number; currency: string; }`\n - `gross_pay: { amount: number; currency: string; }`\n - `individual_ids: string[]`\n - `net_pay: { amount: number; currency: string; }`\n - `pay_date: string`\n - `pay_frequencies: string[]`\n - `pay_group_ids: string[]`\n - `pay_period: { end_date: string; start_date: string; }`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const payment of client.hris.payments.list({ end_date: '2021-01-01', start_date: '2021-01-01' })) {\n console.log(payment);\n}\n```", + "perLanguage": { + "typescript": { + "method": "client.hris.payments.list", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const payment of client.hris.payments.list({\n end_date: '2021-01-01',\n start_date: '2021-01-01',\n})) {\n console.log(payment.id);\n}" + }, + "python": { + "method": "hris.payments.list", + "example": "from datetime import date\nfrom finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\npage = client.hris.payments.list(\n end_date=date.fromisoformat(\"2021-01-01\"),\n start_date=date.fromisoformat(\"2021-01-01\"),\n)\npage = page.items[0]\nprint(page.id)" + }, + "java": { + "method": "hris().payments().list", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisPaymentListPage;\nimport com.tryfinch.api.models.HrisPaymentListParams;\nimport java.time.LocalDate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n HrisPaymentListParams params = HrisPaymentListParams.builder()\n .endDate(LocalDate.parse(\"2021-01-01\"))\n .startDate(LocalDate.parse(\"2021-01-01\"))\n .build();\n HrisPaymentListPage page = client.hris().payments().list(params);\n }\n}" + }, + "kotlin": { + "method": "hris().payments().list", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisPaymentListPage\nimport com.tryfinch.api.models.HrisPaymentListParams\nimport java.time.LocalDate\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val params: HrisPaymentListParams = HrisPaymentListParams.builder()\n .endDate(LocalDate.parse(\"2021-01-01\"))\n .startDate(LocalDate.parse(\"2021-01-01\"))\n .build()\n val page: HrisPaymentListPage = client.hris().payments().list(params)\n}" + }, + "go": { + "method": "client.HRIS.Payments.List", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"time\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tpage, err := client.HRIS.Payments.List(context.TODO(), finchgo.HRISPaymentListParams{\n\t\tEndDate: finchgo.F(time.Now()),\n\t\tStartDate: finchgo.F(time.Now()),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n" + }, + "ruby": { + "method": "hris.payments.list", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\npage = finch.hris.payments.list(end_date: \"2021-01-01\", start_date: \"2021-01-01\")\n\nputs(page)" + }, + "http": { + "example": "curl https://api.tryfinch.com/employer/payment \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'retrieve_many', - endpoint: '/employer/pay-statement', - httpMethod: 'post', - summary: 'Pay Statement', - description: - 'Read detailed pay statements for each individual.\n\nDeduction and contribution types are supported by the payroll systems that supports Benefits.', - stainlessPath: '(resource) hris.pay_statements > (method) retrieve_many', - qualified: 'client.hris.payStatements.retrieveMany', - params: [ - 'requests: { payment_id: string; limit?: number; offset?: number; }[];', - 'entity_ids?: string[];', + "name": "retrieve_many", + "endpoint": "/employer/pay-statement", + "httpMethod": "post", + "summary": "Pay Statement", + "description": "Read detailed pay statements for each individual.\n\nDeduction and contribution types are supported by the payroll systems that supports Benefits.", + "stainlessPath": "(resource) hris.pay_statements > (method) retrieve_many", + "qualified": "client.hris.payStatements.retrieveMany", + "params": [ + "requests: { payment_id: string; limit?: number; offset?: number; }[];", + "entity_ids?: string[];" ], - response: - "{ body: { paging: object; pay_statements: pay_statement[]; } | { code: number; message: string; name: string; finch_code?: string; } | { code: 202; finch_code: 'data_sync_in_progress'; message: 'The pay statements for this payment are being fetched. Please check back later.'; name: 'accepted'; }; code: number; payment_id: string; }", - markdown: - "## retrieve_many\n\n`client.hris.payStatements.retrieveMany(requests: { payment_id: string; limit?: number; offset?: number; }[], entity_ids?: string[]): { body: pay_statement_response_body | object | pay_statement_data_sync_in_progress; code: number; payment_id: string; }`\n\n**post** `/employer/pay-statement`\n\nRead detailed pay statements for each individual.\n\nDeduction and contribution types are supported by the payroll systems that supports Benefits.\n\n### Parameters\n\n- `requests: { payment_id: string; limit?: number; offset?: number; }[]`\n The array of batch requests.\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ body: { paging: object; pay_statements: pay_statement[]; } | { code: number; message: string; name: string; finch_code?: string; } | { code: 202; finch_code: 'data_sync_in_progress'; message: 'The pay statements for this payment are being fetched. Please check back later.'; name: 'accepted'; }; code: number; payment_id: string; }`\n\n - `body: { paging: { offset: number; count?: number; }; pay_statements: { earnings: object[]; employee_deductions: object[]; employer_contributions: object[]; gross_pay: money; individual_id: string; net_pay: money; payment_method: 'check' | 'direct_deposit' | 'other'; taxes: object[]; total_hours: number; type: 'off_cycle_payroll' | 'one_time_payment' | 'regular_payroll'; }[]; } | { code: number; message: string; name: string; finch_code?: string; } | { code: 202; finch_code: 'data_sync_in_progress'; message: 'The pay statements for this payment are being fetched. Please check back later.'; name: 'accepted'; }`\n - `code: number`\n - `payment_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const payStatementResponse of client.hris.payStatements.retrieveMany({ requests: [{ payment_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }] })) {\n console.log(payStatementResponse);\n}\n```", - perLanguage: { - typescript: { - method: 'client.hris.payStatements.retrieveMany', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const payStatementResponse of client.hris.payStatements.retrieveMany({\n requests: [{ payment_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }],\n})) {\n console.log(payStatementResponse.payment_id);\n}", - }, - python: { - method: 'hris.pay_statements.retrieve_many', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.pay_statements.retrieve_many(\n requests=[{\n "payment_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"\n }],\n)\npage = page.responses[0]\nprint(page.payment_id)', - }, - java: { - method: 'hris().payStatements().retrieveMany', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisPayStatementRetrieveManyPage;\nimport com.tryfinch.api.models.HrisPayStatementRetrieveManyParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HrisPayStatementRetrieveManyParams params = HrisPayStatementRetrieveManyParams.builder()\n .addRequest(HrisPayStatementRetrieveManyParams.Request.builder()\n .paymentId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")\n .build())\n .build();\n HrisPayStatementRetrieveManyPage page = client.hris().payStatements().retrieveMany(params);\n }\n}', - }, - kotlin: { - method: 'hris().payStatements().retrieveMany', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisPayStatementRetrieveManyPage\nimport com.tryfinch.api.models.HrisPayStatementRetrieveManyParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val params: HrisPayStatementRetrieveManyParams = HrisPayStatementRetrieveManyParams.builder()\n .addRequest(HrisPayStatementRetrieveManyParams.Request.builder()\n .paymentId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")\n .build())\n .build()\n val page: HrisPayStatementRetrieveManyPage = client.hris().payStatements().retrieveMany(params)\n}', - }, - go: { - method: 'client.HRIS.PayStatements.GetMany', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.PayStatements.GetMany(context.TODO(), finchgo.HRISPayStatementGetManyParams{\n\t\tRequests: finchgo.F([]finchgo.HRISPayStatementGetManyParamsRequest{{\n\t\t\tPaymentID: finchgo.F("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"),\n\t\t}}),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'hris.pay_statements.retrieve_many', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.pay_statements.retrieve_many(requests: [{payment_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"}])\n\nputs(page)', - }, - http: { - example: - 'curl https://api.tryfinch.com/employer/pay-statement \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "requests": [\n {\n "payment_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"\n }\n ]\n }\'', - }, - }, + "response": "{ body: { paging: object; pay_statements: pay_statement[]; } | { code: number; message: string; name: string; finch_code?: string; } | { code: 202; finch_code: 'data_sync_in_progress'; message: 'The pay statements for this payment are being fetched. Please check back later.'; name: 'accepted'; }; code: number; payment_id: string; }", + "markdown": "## retrieve_many\n\n`client.hris.payStatements.retrieveMany(requests: { payment_id: string; limit?: number; offset?: number; }[], entity_ids?: string[]): { body: pay_statement_response_body | object | pay_statement_data_sync_in_progress; code: number; payment_id: string; }`\n\n**post** `/employer/pay-statement`\n\nRead detailed pay statements for each individual.\n\nDeduction and contribution types are supported by the payroll systems that supports Benefits.\n\n### Parameters\n\n- `requests: { payment_id: string; limit?: number; offset?: number; }[]`\n The array of batch requests.\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ body: { paging: object; pay_statements: pay_statement[]; } | { code: number; message: string; name: string; finch_code?: string; } | { code: 202; finch_code: 'data_sync_in_progress'; message: 'The pay statements for this payment are being fetched. Please check back later.'; name: 'accepted'; }; code: number; payment_id: string; }`\n\n - `body: { paging: { offset: number; count?: number; }; pay_statements: { earnings: object[]; employee_deductions: object[]; employer_contributions: object[]; gross_pay: money; individual_id: string; net_pay: money; payment_method: 'check' | 'direct_deposit' | 'other'; taxes: object[]; total_hours: number; type: 'off_cycle_payroll' | 'one_time_payment' | 'regular_payroll'; }[]; } | { code: number; message: string; name: string; finch_code?: string; } | { code: 202; finch_code: 'data_sync_in_progress'; message: 'The pay statements for this payment are being fetched. Please check back later.'; name: 'accepted'; }`\n - `code: number`\n - `payment_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const payStatementResponse of client.hris.payStatements.retrieveMany({ requests: [{ payment_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }] })) {\n console.log(payStatementResponse);\n}\n```", + "perLanguage": { + "typescript": { + "method": "client.hris.payStatements.retrieveMany", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const payStatementResponse of client.hris.payStatements.retrieveMany({\n requests: [{ payment_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }],\n})) {\n console.log(payStatementResponse.payment_id);\n}" + }, + "python": { + "method": "hris.pay_statements.retrieve_many", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\npage = client.hris.pay_statements.retrieve_many(\n requests=[{\n \"payment_id\": \"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\"\n }],\n)\npage = page.responses[0]\nprint(page.payment_id)" + }, + "java": { + "method": "hris().payStatements().retrieveMany", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisPayStatementRetrieveManyPage;\nimport com.tryfinch.api.models.HrisPayStatementRetrieveManyParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n HrisPayStatementRetrieveManyParams params = HrisPayStatementRetrieveManyParams.builder()\n .addRequest(HrisPayStatementRetrieveManyParams.Request.builder()\n .paymentId(\"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\")\n .build())\n .build();\n HrisPayStatementRetrieveManyPage page = client.hris().payStatements().retrieveMany(params);\n }\n}" + }, + "kotlin": { + "method": "hris().payStatements().retrieveMany", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisPayStatementRetrieveManyPage\nimport com.tryfinch.api.models.HrisPayStatementRetrieveManyParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val params: HrisPayStatementRetrieveManyParams = HrisPayStatementRetrieveManyParams.builder()\n .addRequest(HrisPayStatementRetrieveManyParams.Request.builder()\n .paymentId(\"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\")\n .build())\n .build()\n val page: HrisPayStatementRetrieveManyPage = client.hris().payStatements().retrieveMany(params)\n}" + }, + "go": { + "method": "client.HRIS.PayStatements.GetMany", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tpage, err := client.HRIS.PayStatements.GetMany(context.TODO(), finchgo.HRISPayStatementGetManyParams{\n\t\tRequests: finchgo.F([]finchgo.HRISPayStatementGetManyParamsRequest{{\n\t\t\tPaymentID: finchgo.F(\"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\"),\n\t\t}}),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n" + }, + "ruby": { + "method": "hris.pay_statements.retrieve_many", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\npage = finch.hris.pay_statements.retrieve_many(requests: [{payment_id: \"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\"}])\n\nputs(page)" + }, + "http": { + "example": "curl https://api.tryfinch.com/employer/pay-statement \\\n -H 'Content-Type: application/json' \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{\n \"requests\": [\n {\n \"payment_id\": \"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\"\n }\n ]\n }'" + } + } }, { - name: 'list', - endpoint: '/employer/documents', - httpMethod: 'get', - summary: 'List Documents', - description: - '**Beta:** This endpoint is in beta and may change.\nRetrieve a list of company-wide documents.\n', - stainlessPath: '(resource) hris.documents > (method) list', - qualified: 'client.hris.documents.list', - params: [ - 'entity_ids?: string[];', - 'individual_ids?: string[];', - 'limit?: number;', - 'offset?: number;', - "types?: 'w4_2020' | 'w4_2005'[];", + "name": "list", + "endpoint": "/employer/documents", + "httpMethod": "get", + "summary": "List Documents", + "description": "**Beta:** This endpoint is in beta and may change.\nRetrieve a list of company-wide documents.\n", + "stainlessPath": "(resource) hris.documents > (method) list", + "qualified": "client.hris.documents.list", + "params": [ + "entity_ids?: string[];", + "individual_ids?: string[];", + "limit?: number;", + "offset?: number;", + "types?: 'w4_2020' | 'w4_2005'[];" ], - response: - "{ documents: { id: string; individual_id: string; type: 'w4_2020' | 'w4_2005'; url: string; year: number; }[]; paging: { offset: number; count?: number; }; }", - markdown: - "## list\n\n`client.hris.documents.list(entity_ids?: string[], individual_ids?: string[], limit?: number, offset?: number, types?: 'w4_2020' | 'w4_2005'[]): { documents: document_response[]; paging: paging; }`\n\n**get** `/employer/documents`\n\n**Beta:** This endpoint is in beta and may change.\nRetrieve a list of company-wide documents.\n\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `individual_ids?: string[]`\n Comma-delimited list of stable Finch uuids for each individual. If empty, defaults to all individuals\n\n- `limit?: number`\n Number of documents to return (defaults to all)\n\n- `offset?: number`\n Index to start from (defaults to 0)\n\n- `types?: 'w4_2020' | 'w4_2005'[]`\n Comma-delimited list of document types to filter on. If empty, defaults to all types\n\n### Returns\n\n- `{ documents: { id: string; individual_id: string; type: 'w4_2020' | 'w4_2005'; url: string; year: number; }[]; paging: { offset: number; count?: number; }; }`\n\n - `documents: { id: string; individual_id: string; type: 'w4_2020' | 'w4_2005'; url: string; year: number; }[]`\n - `paging: { offset: number; count?: number; }`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst documents = await client.hris.documents.list();\n\nconsole.log(documents);\n```", - perLanguage: { - typescript: { - method: 'client.hris.documents.list', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst documents = await client.hris.documents.list();\n\nconsole.log(documents.documents);", - }, - python: { - method: 'hris.documents.list', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\ndocuments = client.hris.documents.list()\nprint(documents.documents)', - }, - java: { - method: 'hris().documents().list', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.DocumentListResponse;\nimport com.tryfinch.api.models.HrisDocumentListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DocumentListResponse documents = client.hris().documents().list();\n }\n}', - }, - kotlin: { - method: 'hris().documents().list', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.DocumentListResponse\nimport com.tryfinch.api.models.HrisDocumentListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val documents: DocumentListResponse = client.hris().documents().list()\n}', - }, - go: { - method: 'client.HRIS.Documents.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tdocuments, err := client.HRIS.Documents.List(context.TODO(), finchgo.HRISDocumentListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", documents.Documents)\n}\n', - }, - ruby: { - method: 'hris.documents.list', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\ndocuments = finch.hris.documents.list\n\nputs(documents)', - }, - http: { - example: - 'curl https://api.tryfinch.com/employer/documents \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "response": "{ documents: { id: string; individual_id: string; type: 'w4_2020' | 'w4_2005'; url: string; year: number; }[]; paging: { offset: number; count?: number; }; }", + "markdown": "## list\n\n`client.hris.documents.list(entity_ids?: string[], individual_ids?: string[], limit?: number, offset?: number, types?: 'w4_2020' | 'w4_2005'[]): { documents: document_response[]; paging: paging; }`\n\n**get** `/employer/documents`\n\n**Beta:** This endpoint is in beta and may change.\nRetrieve a list of company-wide documents.\n\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `individual_ids?: string[]`\n Comma-delimited list of stable Finch uuids for each individual. If empty, defaults to all individuals\n\n- `limit?: number`\n Number of documents to return (defaults to all)\n\n- `offset?: number`\n Index to start from (defaults to 0)\n\n- `types?: 'w4_2020' | 'w4_2005'[]`\n Comma-delimited list of document types to filter on. If empty, defaults to all types\n\n### Returns\n\n- `{ documents: { id: string; individual_id: string; type: 'w4_2020' | 'w4_2005'; url: string; year: number; }[]; paging: { offset: number; count?: number; }; }`\n\n - `documents: { id: string; individual_id: string; type: 'w4_2020' | 'w4_2005'; url: string; year: number; }[]`\n - `paging: { offset: number; count?: number; }`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst documents = await client.hris.documents.list();\n\nconsole.log(documents);\n```", + "perLanguage": { + "typescript": { + "method": "client.hris.documents.list", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst documents = await client.hris.documents.list();\n\nconsole.log(documents.documents);" + }, + "python": { + "method": "hris.documents.list", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\ndocuments = client.hris.documents.list()\nprint(documents.documents)" + }, + "java": { + "method": "hris().documents().list", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.DocumentListResponse;\nimport com.tryfinch.api.models.HrisDocumentListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n DocumentListResponse documents = client.hris().documents().list();\n }\n}" + }, + "kotlin": { + "method": "hris().documents().list", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.DocumentListResponse\nimport com.tryfinch.api.models.HrisDocumentListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val documents: DocumentListResponse = client.hris().documents().list()\n}" + }, + "go": { + "method": "client.HRIS.Documents.List", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tdocuments, err := client.HRIS.Documents.List(context.TODO(), finchgo.HRISDocumentListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", documents.Documents)\n}\n" + }, + "ruby": { + "method": "hris.documents.list", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\ndocuments = finch.hris.documents.list\n\nputs(documents)" + }, + "http": { + "example": "curl https://api.tryfinch.com/employer/documents \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'retreive', - endpoint: '/employer/documents/{document_id}', - httpMethod: 'get', - summary: 'Get Document', - description: - '**Beta:** This endpoint is in beta and may change.\nRetrieve details of a specific document by its ID.\n', - stainlessPath: '(resource) hris.documents > (method) retreive', - qualified: 'client.hris.documents.retreive', - params: ['document_id: string;', 'entity_ids?: string[];'], - response: - "{ data: { amount_for_other_dependents: number; amount_for_qualifying_children_under_17: number; deductions: number; extra_withholding: number; filing_status: string; individual_id: string; other_income: number; total_claim_dependent_and_other_credits: number; }; type: 'w4_2020'; year: number; } | { data: { additional_withholding: number; exemption: 'exempt' | 'non_exempt'; filing_status: 'married' | 'married_but_withhold_at_higher_single_rate' | 'single'; individual_id: string; total_number_of_allowances: number; }; type: 'w4_2005'; year: number; }", - markdown: - "## retreive\n\n`client.hris.documents.retreive(document_id: string, entity_ids?: string[]): object | object`\n\n**get** `/employer/documents/{document_id}`\n\n**Beta:** This endpoint is in beta and may change.\nRetrieve details of a specific document by its ID.\n\n\n### Parameters\n\n- `document_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ data: { amount_for_other_dependents: number; amount_for_qualifying_children_under_17: number; deductions: number; extra_withholding: number; filing_status: string; individual_id: string; other_income: number; total_claim_dependent_and_other_credits: number; }; type: 'w4_2020'; year: number; } | { data: { additional_withholding: number; exemption: 'exempt' | 'non_exempt'; filing_status: 'married' | 'married_but_withhold_at_higher_single_rate' | 'single'; individual_id: string; total_number_of_allowances: number; }; type: 'w4_2005'; year: number; }`\n A 2020 version of the W-4 tax form containing information on an individual's filing status, dependents, and withholding details.\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst response = await client.hris.documents.retreive('document_id');\n\nconsole.log(response);\n```", - perLanguage: { - typescript: { - method: 'client.hris.documents.retreive', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.hris.documents.retreive('document_id');\n\nconsole.log(response);", - }, - python: { - method: 'hris.documents.retreive', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nresponse = client.hris.documents.retreive(\n document_id="document_id",\n)\nprint(response)', - }, - java: { - method: 'hris().documents().retreive', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.DocumentRetreiveResponse;\nimport com.tryfinch.api.models.HrisDocumentRetreiveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DocumentRetreiveResponse response = client.hris().documents().retreive("document_id");\n }\n}', - }, - kotlin: { - method: 'hris().documents().retreive', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.DocumentRetreiveResponse\nimport com.tryfinch.api.models.HrisDocumentRetreiveParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val response: DocumentRetreiveResponse = client.hris().documents().retreive("document_id")\n}', - }, - go: { - method: 'client.HRIS.Documents.Retreive', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.HRIS.Documents.Retreive(\n\t\tcontext.TODO(),\n\t\t"document_id",\n\t\tfinchgo.HRISDocumentRetreiveParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', - }, - ruby: { - method: 'hris.documents.retreive', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nresponse = finch.hris.documents.retreive("document_id")\n\nputs(response)', - }, - http: { - example: - 'curl https://api.tryfinch.com/employer/documents/$DOCUMENT_ID \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "name": "retreive", + "endpoint": "/employer/documents/{document_id}", + "httpMethod": "get", + "summary": "Get Document", + "description": "**Beta:** This endpoint is in beta and may change.\nRetrieve details of a specific document by its ID.\n", + "stainlessPath": "(resource) hris.documents > (method) retreive", + "qualified": "client.hris.documents.retreive", + "params": [ + "document_id: string;", + "entity_ids?: string[];" + ], + "response": "{ data: { amount_for_other_dependents: number; amount_for_qualifying_children_under_17: number; deductions: number; extra_withholding: number; filing_status: string; individual_id: string; other_income: number; total_claim_dependent_and_other_credits: number; }; type: 'w4_2020'; year: number; } | { data: { additional_withholding: number; exemption: 'exempt' | 'non_exempt'; filing_status: 'married' | 'married_but_withhold_at_higher_single_rate' | 'single'; individual_id: string; total_number_of_allowances: number; }; type: 'w4_2005'; year: number; }", + "markdown": "## retreive\n\n`client.hris.documents.retreive(document_id: string, entity_ids?: string[]): object | object`\n\n**get** `/employer/documents/{document_id}`\n\n**Beta:** This endpoint is in beta and may change.\nRetrieve details of a specific document by its ID.\n\n\n### Parameters\n\n- `document_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ data: { amount_for_other_dependents: number; amount_for_qualifying_children_under_17: number; deductions: number; extra_withholding: number; filing_status: string; individual_id: string; other_income: number; total_claim_dependent_and_other_credits: number; }; type: 'w4_2020'; year: number; } | { data: { additional_withholding: number; exemption: 'exempt' | 'non_exempt'; filing_status: 'married' | 'married_but_withhold_at_higher_single_rate' | 'single'; individual_id: string; total_number_of_allowances: number; }; type: 'w4_2005'; year: number; }`\n A 2020 version of the W-4 tax form containing information on an individual's filing status, dependents, and withholding details.\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst response = await client.hris.documents.retreive('document_id');\n\nconsole.log(response);\n```", + "perLanguage": { + "typescript": { + "method": "client.hris.documents.retreive", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.hris.documents.retreive('document_id');\n\nconsole.log(response);" + }, + "python": { + "method": "hris.documents.retreive", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nresponse = client.hris.documents.retreive(\n document_id=\"document_id\",\n)\nprint(response)" + }, + "java": { + "method": "hris().documents().retreive", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.DocumentRetreiveResponse;\nimport com.tryfinch.api.models.HrisDocumentRetreiveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n DocumentRetreiveResponse response = client.hris().documents().retreive(\"document_id\");\n }\n}" + }, + "kotlin": { + "method": "hris().documents().retreive", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.DocumentRetreiveResponse\nimport com.tryfinch.api.models.HrisDocumentRetreiveParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val response: DocumentRetreiveResponse = client.hris().documents().retreive(\"document_id\")\n}" + }, + "go": { + "method": "client.HRIS.Documents.Retreive", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tresponse, err := client.HRIS.Documents.Retreive(\n\t\tcontext.TODO(),\n\t\t\"document_id\",\n\t\tfinchgo.HRISDocumentRetreiveParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response)\n}\n" + }, + "ruby": { + "method": "hris.documents.retreive", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nresponse = finch.hris.documents.retreive(\"document_id\")\n\nputs(response)" + }, + "http": { + "example": "curl https://api.tryfinch.com/employer/documents/$DOCUMENT_ID \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'list', - endpoint: '/employer/benefits', - httpMethod: 'get', - summary: 'Get All Deductions', - description: 'List all company-wide deductions and contributions.', - stainlessPath: '(resource) hris.benefits > (method) list', - qualified: 'client.hris.benefits.list', - params: ['entity_ids?: string[];'], - response: - "{ benefit_id: string; description: string; frequency: 'every_paycheck' | 'monthly' | 'one_time'; type: string; company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }; }", - markdown: - "## list\n\n`client.hris.benefits.list(entity_ids?: string[]): { benefit_id: string; description: string; frequency: benefit_frequency; type: benefit_type; company_contribution?: object; }`\n\n**get** `/employer/benefits`\n\nList all company-wide deductions and contributions.\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ benefit_id: string; description: string; frequency: 'every_paycheck' | 'monthly' | 'one_time'; type: string; company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }; }`\n\n - `benefit_id: string`\n - `description: string`\n - `frequency: 'every_paycheck' | 'monthly' | 'one_time'`\n - `type: string`\n - `company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const companyBenefit of client.hris.benefits.list()) {\n console.log(companyBenefit);\n}\n```", - perLanguage: { - typescript: { - method: 'client.hris.benefits.list', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const companyBenefit of client.hris.benefits.list()) {\n console.log(companyBenefit.benefit_id);\n}", - }, - python: { - method: 'hris.benefits.list', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.benefits.list()\npage = page.items[0]\nprint(page.benefit_id)', - }, - java: { - method: 'hris().benefits().list', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisBenefitListPage;\nimport com.tryfinch.api.models.HrisBenefitListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HrisBenefitListPage page = client.hris().benefits().list();\n }\n}', - }, - kotlin: { - method: 'hris().benefits().list', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisBenefitListPage\nimport com.tryfinch.api.models.HrisBenefitListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val page: HrisBenefitListPage = client.hris().benefits().list()\n}', - }, - go: { - method: 'client.HRIS.Benefits.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Benefits.List(context.TODO(), finchgo.HRISBenefitListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'hris.benefits.list', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.benefits.list\n\nputs(page)', - }, - http: { - example: - 'curl https://api.tryfinch.com/employer/benefits \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "name": "list", + "endpoint": "/employer/benefits", + "httpMethod": "get", + "summary": "Get All Deductions", + "description": "List all company-wide deductions and contributions.", + "stainlessPath": "(resource) hris.benefits > (method) list", + "qualified": "client.hris.benefits.list", + "params": [ + "entity_ids?: string[];" + ], + "response": "{ benefit_id: string; description: string; frequency: 'every_paycheck' | 'monthly' | 'one_time'; type: string; company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }; }", + "markdown": "## list\n\n`client.hris.benefits.list(entity_ids?: string[]): { benefit_id: string; description: string; frequency: benefit_frequency; type: benefit_type; company_contribution?: object; }`\n\n**get** `/employer/benefits`\n\nList all company-wide deductions and contributions.\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ benefit_id: string; description: string; frequency: 'every_paycheck' | 'monthly' | 'one_time'; type: string; company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }; }`\n\n - `benefit_id: string`\n - `description: string`\n - `frequency: 'every_paycheck' | 'monthly' | 'one_time'`\n - `type: string`\n - `company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const companyBenefit of client.hris.benefits.list()) {\n console.log(companyBenefit);\n}\n```", + "perLanguage": { + "typescript": { + "method": "client.hris.benefits.list", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const companyBenefit of client.hris.benefits.list()) {\n console.log(companyBenefit.benefit_id);\n}" + }, + "python": { + "method": "hris.benefits.list", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\npage = client.hris.benefits.list()\npage = page.items[0]\nprint(page.benefit_id)" + }, + "java": { + "method": "hris().benefits().list", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisBenefitListPage;\nimport com.tryfinch.api.models.HrisBenefitListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n HrisBenefitListPage page = client.hris().benefits().list();\n }\n}" + }, + "kotlin": { + "method": "hris().benefits().list", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisBenefitListPage\nimport com.tryfinch.api.models.HrisBenefitListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val page: HrisBenefitListPage = client.hris().benefits().list()\n}" + }, + "go": { + "method": "client.HRIS.Benefits.List", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tpage, err := client.HRIS.Benefits.List(context.TODO(), finchgo.HRISBenefitListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n" + }, + "ruby": { + "method": "hris.benefits.list", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\npage = finch.hris.benefits.list\n\nputs(page)" + }, + "http": { + "example": "curl https://api.tryfinch.com/employer/benefits \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'create', - endpoint: '/employer/benefits', - httpMethod: 'post', - summary: 'Create Deduction', - description: - 'Creates a new company-wide deduction or contribution. Please use the `/providers` endpoint to view available types for each provider.', - stainlessPath: '(resource) hris.benefits > (method) create', - qualified: 'client.hris.benefits.create', - params: [ - 'entity_ids?: string[];', + "name": "create", + "endpoint": "/employer/benefits", + "httpMethod": "post", + "summary": "Create Deduction", + "description": "Creates a new company-wide deduction or contribution. Please use the `/providers` endpoint to view available types for each provider.", + "stainlessPath": "(resource) hris.benefits > (method) create", + "qualified": "client.hris.benefits.create", + "params": [ + "entity_ids?: string[];", "company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; };", - 'description?: string;', + "description?: string;", "frequency?: 'every_paycheck' | 'monthly' | 'one_time';", - 'type?: string;', + "type?: string;" ], - response: '{ benefit_id: string; job_id: string; }', - markdown: - "## create\n\n`client.hris.benefits.create(entity_ids?: string[], company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }, description?: string, frequency?: 'every_paycheck' | 'monthly' | 'one_time', type?: string): { benefit_id: string; job_id: string; }`\n\n**post** `/employer/benefits`\n\nCreates a new company-wide deduction or contribution. Please use the `/providers` endpoint to view available types for each provider.\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }`\n The company match for this benefit.\n - `tiers: { match: number; threshold: number; }[]`\n - `type: 'match'`\n\n- `description?: string`\n Name of the benefit as it appears in the provider and pay statements. Recommend limiting this to <30 characters due to limitations in specific providers (e.g. Justworks).\n\n- `frequency?: 'every_paycheck' | 'monthly' | 'one_time'`\n The frequency of the benefit deduction/contribution.\n\n- `type?: string`\n Type of benefit.\n\n### Returns\n\n- `{ benefit_id: string; job_id: string; }`\n\n - `benefit_id: string`\n - `job_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst createCompanyBenefitsResponse = await client.hris.benefits.create();\n\nconsole.log(createCompanyBenefitsResponse);\n```", - perLanguage: { - typescript: { - method: 'client.hris.benefits.create', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst createCompanyBenefitsResponse = await client.hris.benefits.create();\n\nconsole.log(createCompanyBenefitsResponse.benefit_id);", - }, - python: { - method: 'hris.benefits.create', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\ncreate_company_benefits_response = client.hris.benefits.create()\nprint(create_company_benefits_response.benefit_id)', - }, - java: { - method: 'hris().benefits().create', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.CreateCompanyBenefitsResponse;\nimport com.tryfinch.api.models.HrisBenefitCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CreateCompanyBenefitsResponse createCompanyBenefitsResponse = client.hris().benefits().create();\n }\n}', - }, - kotlin: { - method: 'hris().benefits().create', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.CreateCompanyBenefitsResponse\nimport com.tryfinch.api.models.HrisBenefitCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val createCompanyBenefitsResponse: CreateCompanyBenefitsResponse = client.hris().benefits().create()\n}', - }, - go: { - method: 'client.HRIS.Benefits.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcreateCompanyBenefitsResponse, err := client.HRIS.Benefits.New(context.TODO(), finchgo.HRISBenefitNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", createCompanyBenefitsResponse.BenefitID)\n}\n', - }, - ruby: { - method: 'hris.benefits.create', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\ncreate_company_benefits_response = finch.hris.benefits.create\n\nputs(create_company_benefits_response)', - }, - http: { - example: - 'curl https://api.tryfinch.com/employer/benefits \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "response": "{ benefit_id: string; job_id: string; }", + "markdown": "## create\n\n`client.hris.benefits.create(entity_ids?: string[], company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }, description?: string, frequency?: 'every_paycheck' | 'monthly' | 'one_time', type?: string): { benefit_id: string; job_id: string; }`\n\n**post** `/employer/benefits`\n\nCreates a new company-wide deduction or contribution. Please use the `/providers` endpoint to view available types for each provider.\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }`\n The company match for this benefit.\n - `tiers: { match: number; threshold: number; }[]`\n - `type: 'match'`\n\n- `description?: string`\n Name of the benefit as it appears in the provider and pay statements. Recommend limiting this to <30 characters due to limitations in specific providers (e.g. Justworks).\n\n- `frequency?: 'every_paycheck' | 'monthly' | 'one_time'`\n The frequency of the benefit deduction/contribution.\n\n- `type?: string`\n Type of benefit.\n\n### Returns\n\n- `{ benefit_id: string; job_id: string; }`\n\n - `benefit_id: string`\n - `job_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst createCompanyBenefitsResponse = await client.hris.benefits.create();\n\nconsole.log(createCompanyBenefitsResponse);\n```", + "perLanguage": { + "typescript": { + "method": "client.hris.benefits.create", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst createCompanyBenefitsResponse = await client.hris.benefits.create();\n\nconsole.log(createCompanyBenefitsResponse.benefit_id);" + }, + "python": { + "method": "hris.benefits.create", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\ncreate_company_benefits_response = client.hris.benefits.create()\nprint(create_company_benefits_response.benefit_id)" + }, + "java": { + "method": "hris().benefits().create", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.CreateCompanyBenefitsResponse;\nimport com.tryfinch.api.models.HrisBenefitCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n CreateCompanyBenefitsResponse createCompanyBenefitsResponse = client.hris().benefits().create();\n }\n}" + }, + "kotlin": { + "method": "hris().benefits().create", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.CreateCompanyBenefitsResponse\nimport com.tryfinch.api.models.HrisBenefitCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val createCompanyBenefitsResponse: CreateCompanyBenefitsResponse = client.hris().benefits().create()\n}" + }, + "go": { + "method": "client.HRIS.Benefits.New", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tcreateCompanyBenefitsResponse, err := client.HRIS.Benefits.New(context.TODO(), finchgo.HRISBenefitNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", createCompanyBenefitsResponse.BenefitID)\n}\n" + }, + "ruby": { + "method": "hris.benefits.create", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\ncreate_company_benefits_response = finch.hris.benefits.create\n\nputs(create_company_benefits_response)" + }, + "http": { + "example": "curl https://api.tryfinch.com/employer/benefits \\\n -X POST \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'retrieve', - endpoint: '/employer/benefits/{benefit_id}', - httpMethod: 'get', - summary: 'Get Deduction', - description: 'Lists deductions and contributions information for a given item', - stainlessPath: '(resource) hris.benefits > (method) retrieve', - qualified: 'client.hris.benefits.retrieve', - params: ['benefit_id: string;', 'entity_ids?: string[];'], - response: - "{ benefit_id: string; description: string; frequency: 'every_paycheck' | 'monthly' | 'one_time'; type: string; company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }; }", - markdown: - "## retrieve\n\n`client.hris.benefits.retrieve(benefit_id: string, entity_ids?: string[]): { benefit_id: string; description: string; frequency: benefit_frequency; type: benefit_type; company_contribution?: object; }`\n\n**get** `/employer/benefits/{benefit_id}`\n\nLists deductions and contributions information for a given item\n\n### Parameters\n\n- `benefit_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ benefit_id: string; description: string; frequency: 'every_paycheck' | 'monthly' | 'one_time'; type: string; company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }; }`\n\n - `benefit_id: string`\n - `description: string`\n - `frequency: 'every_paycheck' | 'monthly' | 'one_time'`\n - `type: string`\n - `company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst companyBenefit = await client.hris.benefits.retrieve('benefit_id');\n\nconsole.log(companyBenefit);\n```", - perLanguage: { - typescript: { - method: 'client.hris.benefits.retrieve', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst companyBenefit = await client.hris.benefits.retrieve('benefit_id');\n\nconsole.log(companyBenefit.benefit_id);", - }, - python: { - method: 'hris.benefits.retrieve', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\ncompany_benefit = client.hris.benefits.retrieve(\n benefit_id="benefit_id",\n)\nprint(company_benefit.benefit_id)', - }, - java: { - method: 'hris().benefits().retrieve', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.CompanyBenefit;\nimport com.tryfinch.api.models.HrisBenefitRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CompanyBenefit companyBenefit = client.hris().benefits().retrieve("benefit_id");\n }\n}', - }, - kotlin: { - method: 'hris().benefits().retrieve', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.CompanyBenefit\nimport com.tryfinch.api.models.HrisBenefitRetrieveParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val companyBenefit: CompanyBenefit = client.hris().benefits().retrieve("benefit_id")\n}', - }, - go: { - method: 'client.HRIS.Benefits.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcompanyBenefit, err := client.HRIS.Benefits.Get(\n\t\tcontext.TODO(),\n\t\t"benefit_id",\n\t\tfinchgo.HRISBenefitGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", companyBenefit.BenefitID)\n}\n', - }, - ruby: { - method: 'hris.benefits.retrieve', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\ncompany_benefit = finch.hris.benefits.retrieve("benefit_id")\n\nputs(company_benefit)', - }, - http: { - example: - 'curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "name": "retrieve", + "endpoint": "/employer/benefits/{benefit_id}", + "httpMethod": "get", + "summary": "Get Deduction", + "description": "Lists deductions and contributions information for a given item", + "stainlessPath": "(resource) hris.benefits > (method) retrieve", + "qualified": "client.hris.benefits.retrieve", + "params": [ + "benefit_id: string;", + "entity_ids?: string[];" + ], + "response": "{ benefit_id: string; description: string; frequency: 'every_paycheck' | 'monthly' | 'one_time'; type: string; company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }; }", + "markdown": "## retrieve\n\n`client.hris.benefits.retrieve(benefit_id: string, entity_ids?: string[]): { benefit_id: string; description: string; frequency: benefit_frequency; type: benefit_type; company_contribution?: object; }`\n\n**get** `/employer/benefits/{benefit_id}`\n\nLists deductions and contributions information for a given item\n\n### Parameters\n\n- `benefit_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ benefit_id: string; description: string; frequency: 'every_paycheck' | 'monthly' | 'one_time'; type: string; company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }; }`\n\n - `benefit_id: string`\n - `description: string`\n - `frequency: 'every_paycheck' | 'monthly' | 'one_time'`\n - `type: string`\n - `company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst companyBenefit = await client.hris.benefits.retrieve('benefit_id');\n\nconsole.log(companyBenefit);\n```", + "perLanguage": { + "typescript": { + "method": "client.hris.benefits.retrieve", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst companyBenefit = await client.hris.benefits.retrieve('benefit_id');\n\nconsole.log(companyBenefit.benefit_id);" + }, + "python": { + "method": "hris.benefits.retrieve", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\ncompany_benefit = client.hris.benefits.retrieve(\n benefit_id=\"benefit_id\",\n)\nprint(company_benefit.benefit_id)" + }, + "java": { + "method": "hris().benefits().retrieve", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.CompanyBenefit;\nimport com.tryfinch.api.models.HrisBenefitRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n CompanyBenefit companyBenefit = client.hris().benefits().retrieve(\"benefit_id\");\n }\n}" + }, + "kotlin": { + "method": "hris().benefits().retrieve", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.CompanyBenefit\nimport com.tryfinch.api.models.HrisBenefitRetrieveParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val companyBenefit: CompanyBenefit = client.hris().benefits().retrieve(\"benefit_id\")\n}" + }, + "go": { + "method": "client.HRIS.Benefits.Get", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tcompanyBenefit, err := client.HRIS.Benefits.Get(\n\t\tcontext.TODO(),\n\t\t\"benefit_id\",\n\t\tfinchgo.HRISBenefitGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", companyBenefit.BenefitID)\n}\n" + }, + "ruby": { + "method": "hris.benefits.retrieve", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\ncompany_benefit = finch.hris.benefits.retrieve(\"benefit_id\")\n\nputs(company_benefit)" + }, + "http": { + "example": "curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'update', - endpoint: '/employer/benefits/{benefit_id}', - httpMethod: 'post', - summary: 'Update Deduction', - description: 'Updates an existing company-wide deduction or contribution', - stainlessPath: '(resource) hris.benefits > (method) update', - qualified: 'client.hris.benefits.update', - params: ['benefit_id: string;', 'entity_ids?: string[];', 'description?: string;'], - response: '{ benefit_id: string; job_id: string; }', - markdown: - "## update\n\n`client.hris.benefits.update(benefit_id: string, entity_ids?: string[], description?: string): { benefit_id: string; job_id: string; }`\n\n**post** `/employer/benefits/{benefit_id}`\n\nUpdates an existing company-wide deduction or contribution\n\n### Parameters\n\n- `benefit_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `description?: string`\n Updated name or description.\n\n### Returns\n\n- `{ benefit_id: string; job_id: string; }`\n\n - `benefit_id: string`\n - `job_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst updateCompanyBenefitResponse = await client.hris.benefits.update('benefit_id');\n\nconsole.log(updateCompanyBenefitResponse);\n```", - perLanguage: { - typescript: { - method: 'client.hris.benefits.update', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst updateCompanyBenefitResponse = await client.hris.benefits.update('benefit_id');\n\nconsole.log(updateCompanyBenefitResponse.benefit_id);", - }, - python: { - method: 'hris.benefits.update', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nupdate_company_benefit_response = client.hris.benefits.update(\n benefit_id="benefit_id",\n)\nprint(update_company_benefit_response.benefit_id)', - }, - java: { - method: 'hris().benefits().update', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisBenefitUpdateParams;\nimport com.tryfinch.api.models.UpdateCompanyBenefitResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UpdateCompanyBenefitResponse updateCompanyBenefitResponse = client.hris().benefits().update("benefit_id");\n }\n}', - }, - kotlin: { - method: 'hris().benefits().update', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisBenefitUpdateParams\nimport com.tryfinch.api.models.UpdateCompanyBenefitResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val updateCompanyBenefitResponse: UpdateCompanyBenefitResponse = client.hris().benefits().update("benefit_id")\n}', - }, - go: { - method: 'client.HRIS.Benefits.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tupdateCompanyBenefitResponse, err := client.HRIS.Benefits.Update(\n\t\tcontext.TODO(),\n\t\t"benefit_id",\n\t\tfinchgo.HRISBenefitUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", updateCompanyBenefitResponse.BenefitID)\n}\n', - }, - ruby: { - method: 'hris.benefits.update', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nupdate_company_benefit_response = finch.hris.benefits.update("benefit_id")\n\nputs(update_company_benefit_response)', - }, - http: { - example: - 'curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "name": "update", + "endpoint": "/employer/benefits/{benefit_id}", + "httpMethod": "post", + "summary": "Update Deduction", + "description": "Updates an existing company-wide deduction or contribution", + "stainlessPath": "(resource) hris.benefits > (method) update", + "qualified": "client.hris.benefits.update", + "params": [ + "benefit_id: string;", + "entity_ids?: string[];", + "description?: string;" + ], + "response": "{ benefit_id: string; job_id: string; }", + "markdown": "## update\n\n`client.hris.benefits.update(benefit_id: string, entity_ids?: string[], description?: string): { benefit_id: string; job_id: string; }`\n\n**post** `/employer/benefits/{benefit_id}`\n\nUpdates an existing company-wide deduction or contribution\n\n### Parameters\n\n- `benefit_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `description?: string`\n Updated name or description.\n\n### Returns\n\n- `{ benefit_id: string; job_id: string; }`\n\n - `benefit_id: string`\n - `job_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst updateCompanyBenefitResponse = await client.hris.benefits.update('benefit_id');\n\nconsole.log(updateCompanyBenefitResponse);\n```", + "perLanguage": { + "typescript": { + "method": "client.hris.benefits.update", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst updateCompanyBenefitResponse = await client.hris.benefits.update('benefit_id');\n\nconsole.log(updateCompanyBenefitResponse.benefit_id);" + }, + "python": { + "method": "hris.benefits.update", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nupdate_company_benefit_response = client.hris.benefits.update(\n benefit_id=\"benefit_id\",\n)\nprint(update_company_benefit_response.benefit_id)" + }, + "java": { + "method": "hris().benefits().update", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisBenefitUpdateParams;\nimport com.tryfinch.api.models.UpdateCompanyBenefitResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n UpdateCompanyBenefitResponse updateCompanyBenefitResponse = client.hris().benefits().update(\"benefit_id\");\n }\n}" + }, + "kotlin": { + "method": "hris().benefits().update", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisBenefitUpdateParams\nimport com.tryfinch.api.models.UpdateCompanyBenefitResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val updateCompanyBenefitResponse: UpdateCompanyBenefitResponse = client.hris().benefits().update(\"benefit_id\")\n}" + }, + "go": { + "method": "client.HRIS.Benefits.Update", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tupdateCompanyBenefitResponse, err := client.HRIS.Benefits.Update(\n\t\tcontext.TODO(),\n\t\t\"benefit_id\",\n\t\tfinchgo.HRISBenefitUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", updateCompanyBenefitResponse.BenefitID)\n}\n" + }, + "ruby": { + "method": "hris.benefits.update", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nupdate_company_benefit_response = finch.hris.benefits.update(\"benefit_id\")\n\nputs(update_company_benefit_response)" + }, + "http": { + "example": "curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID \\\n -X POST \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'list_supported_benefits', - endpoint: '/employer/benefits/meta', - httpMethod: 'get', - summary: '[Deprecated] Get Deductions Metadata', - description: 'Get deductions metadata', - stainlessPath: '(resource) hris.benefits > (method) list_supported_benefits', - qualified: 'client.hris.benefits.listSupportedBenefits', - params: ['entity_ids?: string[];'], - response: - "{ annual_maximum: boolean; company_contribution: 'fixed' | 'percent' | 'tiered'[]; description: string; employee_deduction: 'fixed' | 'percent'[]; frequencies: 'every_paycheck' | 'monthly' | 'one_time'[]; catch_up?: boolean; hsa_contribution_limit?: 'family' | 'individual'[]; }", - markdown: - "## list_supported_benefits\n\n`client.hris.benefits.listSupportedBenefits(entity_ids?: string[]): { annual_maximum: boolean; company_contribution: 'fixed' | 'percent' | 'tiered'[]; description: string; employee_deduction: 'fixed' | 'percent'[]; frequencies: benefit_frequency[]; catch_up?: boolean; hsa_contribution_limit?: 'family' | 'individual'[]; }`\n\n**get** `/employer/benefits/meta`\n\nGet deductions metadata\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ annual_maximum: boolean; company_contribution: 'fixed' | 'percent' | 'tiered'[]; description: string; employee_deduction: 'fixed' | 'percent'[]; frequencies: 'every_paycheck' | 'monthly' | 'one_time'[]; catch_up?: boolean; hsa_contribution_limit?: 'family' | 'individual'[]; }`\n\n - `annual_maximum: boolean`\n - `company_contribution: 'fixed' | 'percent' | 'tiered'[]`\n - `description: string`\n - `employee_deduction: 'fixed' | 'percent'[]`\n - `frequencies: 'every_paycheck' | 'monthly' | 'one_time'[]`\n - `catch_up?: boolean`\n - `hsa_contribution_limit?: 'family' | 'individual'[]`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const supportedBenefit of client.hris.benefits.listSupportedBenefits()) {\n console.log(supportedBenefit);\n}\n```", - perLanguage: { - typescript: { - method: 'client.hris.benefits.listSupportedBenefits', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const supportedBenefit of client.hris.benefits.listSupportedBenefits()) {\n console.log(supportedBenefit.annual_maximum);\n}", - }, - python: { - method: 'hris.benefits.list_supported_benefits', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.benefits.list_supported_benefits()\npage = page.items[0]\nprint(page.annual_maximum)', - }, - java: { - method: 'hris().benefits().listSupportedBenefits', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisBenefitListSupportedBenefitsPage;\nimport com.tryfinch.api.models.HrisBenefitListSupportedBenefitsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HrisBenefitListSupportedBenefitsPage page = client.hris().benefits().listSupportedBenefits();\n }\n}', - }, - kotlin: { - method: 'hris().benefits().listSupportedBenefits', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisBenefitListSupportedBenefitsPage\nimport com.tryfinch.api.models.HrisBenefitListSupportedBenefitsParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val page: HrisBenefitListSupportedBenefitsPage = client.hris().benefits().listSupportedBenefits()\n}', - }, - go: { - method: 'client.HRIS.Benefits.ListSupportedBenefits', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Benefits.ListSupportedBenefits(context.TODO(), finchgo.HRISBenefitListSupportedBenefitsParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'hris.benefits.list_supported_benefits', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.benefits.list_supported_benefits\n\nputs(page)', - }, - http: { - example: - 'curl https://api.tryfinch.com/employer/benefits/meta \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "name": "list_supported_benefits", + "endpoint": "/employer/benefits/meta", + "httpMethod": "get", + "summary": "[Deprecated] Get Deductions Metadata", + "description": "Get deductions metadata", + "stainlessPath": "(resource) hris.benefits > (method) list_supported_benefits", + "qualified": "client.hris.benefits.listSupportedBenefits", + "params": [ + "entity_ids?: string[];" + ], + "response": "{ annual_maximum: boolean; company_contribution: 'fixed' | 'percent' | 'tiered'[]; description: string; employee_deduction: 'fixed' | 'percent'[]; frequencies: 'every_paycheck' | 'monthly' | 'one_time'[]; catch_up?: boolean; hsa_contribution_limit?: 'family' | 'individual'[]; }", + "markdown": "## list_supported_benefits\n\n`client.hris.benefits.listSupportedBenefits(entity_ids?: string[]): { annual_maximum: boolean; company_contribution: 'fixed' | 'percent' | 'tiered'[]; description: string; employee_deduction: 'fixed' | 'percent'[]; frequencies: benefit_frequency[]; catch_up?: boolean; hsa_contribution_limit?: 'family' | 'individual'[]; }`\n\n**get** `/employer/benefits/meta`\n\nGet deductions metadata\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ annual_maximum: boolean; company_contribution: 'fixed' | 'percent' | 'tiered'[]; description: string; employee_deduction: 'fixed' | 'percent'[]; frequencies: 'every_paycheck' | 'monthly' | 'one_time'[]; catch_up?: boolean; hsa_contribution_limit?: 'family' | 'individual'[]; }`\n\n - `annual_maximum: boolean`\n - `company_contribution: 'fixed' | 'percent' | 'tiered'[]`\n - `description: string`\n - `employee_deduction: 'fixed' | 'percent'[]`\n - `frequencies: 'every_paycheck' | 'monthly' | 'one_time'[]`\n - `catch_up?: boolean`\n - `hsa_contribution_limit?: 'family' | 'individual'[]`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const supportedBenefit of client.hris.benefits.listSupportedBenefits()) {\n console.log(supportedBenefit);\n}\n```", + "perLanguage": { + "typescript": { + "method": "client.hris.benefits.listSupportedBenefits", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const supportedBenefit of client.hris.benefits.listSupportedBenefits()) {\n console.log(supportedBenefit.annual_maximum);\n}" + }, + "python": { + "method": "hris.benefits.list_supported_benefits", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\npage = client.hris.benefits.list_supported_benefits()\npage = page.items[0]\nprint(page.annual_maximum)" + }, + "java": { + "method": "hris().benefits().listSupportedBenefits", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisBenefitListSupportedBenefitsPage;\nimport com.tryfinch.api.models.HrisBenefitListSupportedBenefitsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n HrisBenefitListSupportedBenefitsPage page = client.hris().benefits().listSupportedBenefits();\n }\n}" + }, + "kotlin": { + "method": "hris().benefits().listSupportedBenefits", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisBenefitListSupportedBenefitsPage\nimport com.tryfinch.api.models.HrisBenefitListSupportedBenefitsParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val page: HrisBenefitListSupportedBenefitsPage = client.hris().benefits().listSupportedBenefits()\n}" + }, + "go": { + "method": "client.HRIS.Benefits.ListSupportedBenefits", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tpage, err := client.HRIS.Benefits.ListSupportedBenefits(context.TODO(), finchgo.HRISBenefitListSupportedBenefitsParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n" + }, + "ruby": { + "method": "hris.benefits.list_supported_benefits", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\npage = finch.hris.benefits.list_supported_benefits\n\nputs(page)" + }, + "http": { + "example": "curl https://api.tryfinch.com/employer/benefits/meta \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'enrolled_ids', - endpoint: '/employer/benefits/{benefit_id}/enrolled', - httpMethod: 'get', - summary: 'Get Enrolled Individuals', - description: 'Lists individuals currently enrolled in a given deduction.', - stainlessPath: '(resource) hris.benefits.individuals > (method) enrolled_ids', - qualified: 'client.hris.benefits.individuals.enrolledIDs', - params: ['benefit_id: string;', 'entity_ids?: string[];'], - response: '{ benefit_id: string; individual_ids: string[]; }', - markdown: - "## enrolled_ids\n\n`client.hris.benefits.individuals.enrolledIDs(benefit_id: string, entity_ids?: string[]): { benefit_id: string; individual_ids: string[]; }`\n\n**get** `/employer/benefits/{benefit_id}/enrolled`\n\nLists individuals currently enrolled in a given deduction.\n\n### Parameters\n\n- `benefit_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ benefit_id: string; individual_ids: string[]; }`\n\n - `benefit_id: string`\n - `individual_ids: string[]`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst response = await client.hris.benefits.individuals.enrolledIDs('benefit_id');\n\nconsole.log(response);\n```", - perLanguage: { - typescript: { - method: 'client.hris.benefits.individuals.enrolledIDs', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.hris.benefits.individuals.enrolledIDs('benefit_id');\n\nconsole.log(response.benefit_id);", - }, - python: { - method: 'hris.benefits.individuals.enrolled_ids', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nresponse = client.hris.benefits.individuals.enrolled_ids(\n benefit_id="benefit_id",\n)\nprint(response.benefit_id)', - }, - java: { - method: 'hris().benefits().individuals().enrolledIds', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisBenefitIndividualEnrolledIdsParams;\nimport com.tryfinch.api.models.IndividualEnrolledIdsResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n IndividualEnrolledIdsResponse response = client.hris().benefits().individuals().enrolledIds("benefit_id");\n }\n}', - }, - kotlin: { - method: 'hris().benefits().individuals().enrolledIds', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisBenefitIndividualEnrolledIdsParams\nimport com.tryfinch.api.models.IndividualEnrolledIdsResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val response: IndividualEnrolledIdsResponse = client.hris().benefits().individuals().enrolledIds("benefit_id")\n}', - }, - go: { - method: 'client.HRIS.Benefits.Individuals.EnrolledIDs', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.HRIS.Benefits.Individuals.EnrolledIDs(\n\t\tcontext.TODO(),\n\t\t"benefit_id",\n\t\tfinchgo.HRISBenefitIndividualEnrolledIDsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response.BenefitID)\n}\n', - }, - ruby: { - method: 'hris.benefits.individuals.enrolled_ids', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nresponse = finch.hris.benefits.individuals.enrolled_ids("benefit_id")\n\nputs(response)', - }, - http: { - example: - 'curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID/enrolled \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "name": "enrolled_ids", + "endpoint": "/employer/benefits/{benefit_id}/enrolled", + "httpMethod": "get", + "summary": "Get Enrolled Individuals", + "description": "Lists individuals currently enrolled in a given deduction.", + "stainlessPath": "(resource) hris.benefits.individuals > (method) enrolled_ids", + "qualified": "client.hris.benefits.individuals.enrolledIDs", + "params": [ + "benefit_id: string;", + "entity_ids?: string[];" + ], + "response": "{ benefit_id: string; individual_ids: string[]; }", + "markdown": "## enrolled_ids\n\n`client.hris.benefits.individuals.enrolledIDs(benefit_id: string, entity_ids?: string[]): { benefit_id: string; individual_ids: string[]; }`\n\n**get** `/employer/benefits/{benefit_id}/enrolled`\n\nLists individuals currently enrolled in a given deduction.\n\n### Parameters\n\n- `benefit_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ benefit_id: string; individual_ids: string[]; }`\n\n - `benefit_id: string`\n - `individual_ids: string[]`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst response = await client.hris.benefits.individuals.enrolledIDs('benefit_id');\n\nconsole.log(response);\n```", + "perLanguage": { + "typescript": { + "method": "client.hris.benefits.individuals.enrolledIDs", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.hris.benefits.individuals.enrolledIDs('benefit_id');\n\nconsole.log(response.benefit_id);" + }, + "python": { + "method": "hris.benefits.individuals.enrolled_ids", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nresponse = client.hris.benefits.individuals.enrolled_ids(\n benefit_id=\"benefit_id\",\n)\nprint(response.benefit_id)" + }, + "java": { + "method": "hris().benefits().individuals().enrolledIds", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisBenefitIndividualEnrolledIdsParams;\nimport com.tryfinch.api.models.IndividualEnrolledIdsResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n IndividualEnrolledIdsResponse response = client.hris().benefits().individuals().enrolledIds(\"benefit_id\");\n }\n}" + }, + "kotlin": { + "method": "hris().benefits().individuals().enrolledIds", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisBenefitIndividualEnrolledIdsParams\nimport com.tryfinch.api.models.IndividualEnrolledIdsResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val response: IndividualEnrolledIdsResponse = client.hris().benefits().individuals().enrolledIds(\"benefit_id\")\n}" + }, + "go": { + "method": "client.HRIS.Benefits.Individuals.EnrolledIDs", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tresponse, err := client.HRIS.Benefits.Individuals.EnrolledIDs(\n\t\tcontext.TODO(),\n\t\t\"benefit_id\",\n\t\tfinchgo.HRISBenefitIndividualEnrolledIDsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.BenefitID)\n}\n" + }, + "ruby": { + "method": "hris.benefits.individuals.enrolled_ids", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nresponse = finch.hris.benefits.individuals.enrolled_ids(\"benefit_id\")\n\nputs(response)" + }, + "http": { + "example": "curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID/enrolled \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'retrieve_many_benefits', - endpoint: '/employer/benefits/{benefit_id}/individuals', - httpMethod: 'get', - summary: 'Get Deductions for Individuals', - description: 'Get enrollment information for the given individuals.', - stainlessPath: '(resource) hris.benefits.individuals > (method) retrieve_many_benefits', - qualified: 'client.hris.benefits.individuals.retrieveManyBenefits', - params: ['benefit_id: string;', 'entity_ids?: string[];', 'individual_ids?: string;'], - response: - "{ body: { annual_maximum: number; catch_up: boolean; company_contribution: { amount: number; type: 'fixed'; } | { amount: number; type: 'percent'; } | { tiers: object[]; type: 'tiered'; }; employee_deduction: { amount: number; type: 'fixed'; } | { amount: number; type: 'percent'; }; hsa_contribution_limit?: 'individual' | 'family'; } | { code: number; message: string; name: string; finch_code?: string; }; code: number; individual_id: string; }", - markdown: - "## retrieve_many_benefits\n\n`client.hris.benefits.individuals.retrieveManyBenefits(benefit_id: string, entity_ids?: string[], individual_ids?: string): { body: object | object; code: number; individual_id: string; }`\n\n**get** `/employer/benefits/{benefit_id}/individuals`\n\nGet enrollment information for the given individuals.\n\n### Parameters\n\n- `benefit_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `individual_ids?: string`\n comma-delimited list of stable Finch uuids for each individual. If empty, defaults to all individuals\n\n### Returns\n\n- `{ body: { annual_maximum: number; catch_up: boolean; company_contribution: { amount: number; type: 'fixed'; } | { amount: number; type: 'percent'; } | { tiers: object[]; type: 'tiered'; }; employee_deduction: { amount: number; type: 'fixed'; } | { amount: number; type: 'percent'; }; hsa_contribution_limit?: 'individual' | 'family'; } | { code: number; message: string; name: string; finch_code?: string; }; code: number; individual_id: string; }`\n\n - `body: { annual_maximum: number; catch_up: boolean; company_contribution: { amount: number; type: 'fixed'; } | { amount: number; type: 'percent'; } | { tiers: { match: number; threshold: number; }[]; type: 'tiered'; }; employee_deduction: { amount: number; type: 'fixed'; } | { amount: number; type: 'percent'; }; hsa_contribution_limit?: 'individual' | 'family'; } | { code: number; message: string; name: string; finch_code?: string; }`\n - `code: number`\n - `individual_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const individualBenefit of client.hris.benefits.individuals.retrieveManyBenefits('benefit_id')) {\n console.log(individualBenefit);\n}\n```", - perLanguage: { - typescript: { - method: 'client.hris.benefits.individuals.retrieveManyBenefits', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const individualBenefit of client.hris.benefits.individuals.retrieveManyBenefits(\n 'benefit_id',\n)) {\n console.log(individualBenefit.individual_id);\n}", - }, - python: { - method: 'hris.benefits.individuals.retrieve_many_benefits', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.benefits.individuals.retrieve_many_benefits(\n benefit_id="benefit_id",\n)\npage = page.items[0]\nprint(page.individual_id)', - }, - java: { - method: 'hris().benefits().individuals().retrieveManyBenefits', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisBenefitIndividualRetrieveManyBenefitsPage;\nimport com.tryfinch.api.models.HrisBenefitIndividualRetrieveManyBenefitsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HrisBenefitIndividualRetrieveManyBenefitsPage page = client.hris().benefits().individuals().retrieveManyBenefits("benefit_id");\n }\n}', - }, - kotlin: { - method: 'hris().benefits().individuals().retrieveManyBenefits', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisBenefitIndividualRetrieveManyBenefitsPage\nimport com.tryfinch.api.models.HrisBenefitIndividualRetrieveManyBenefitsParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val page: HrisBenefitIndividualRetrieveManyBenefitsPage = client.hris().benefits().individuals().retrieveManyBenefits("benefit_id")\n}', - }, - go: { - method: 'client.HRIS.Benefits.Individuals.GetManyBenefits', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Benefits.Individuals.GetManyBenefits(\n\t\tcontext.TODO(),\n\t\t"benefit_id",\n\t\tfinchgo.HRISBenefitIndividualGetManyBenefitsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'hris.benefits.individuals.retrieve_many_benefits', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.benefits.individuals.retrieve_many_benefits("benefit_id")\n\nputs(page)', - }, - http: { - example: - 'curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID/individuals \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "name": "retrieve_many_benefits", + "endpoint": "/employer/benefits/{benefit_id}/individuals", + "httpMethod": "get", + "summary": "Get Deductions for Individuals", + "description": "Get enrollment information for the given individuals.", + "stainlessPath": "(resource) hris.benefits.individuals > (method) retrieve_many_benefits", + "qualified": "client.hris.benefits.individuals.retrieveManyBenefits", + "params": [ + "benefit_id: string;", + "entity_ids?: string[];", + "individual_ids?: string;" + ], + "response": "{ body: { annual_maximum: number; catch_up: boolean; company_contribution: { amount: number; type: 'fixed'; } | { amount: number; type: 'percent'; } | { tiers: object[]; type: 'tiered'; }; employee_deduction: { amount: number; type: 'fixed'; } | { amount: number; type: 'percent'; }; hsa_contribution_limit?: 'individual' | 'family'; } | { code: number; message: string; name: string; finch_code?: string; }; code: number; individual_id: string; }", + "markdown": "## retrieve_many_benefits\n\n`client.hris.benefits.individuals.retrieveManyBenefits(benefit_id: string, entity_ids?: string[], individual_ids?: string): { body: object | object; code: number; individual_id: string; }`\n\n**get** `/employer/benefits/{benefit_id}/individuals`\n\nGet enrollment information for the given individuals.\n\n### Parameters\n\n- `benefit_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `individual_ids?: string`\n comma-delimited list of stable Finch uuids for each individual. If empty, defaults to all individuals\n\n### Returns\n\n- `{ body: { annual_maximum: number; catch_up: boolean; company_contribution: { amount: number; type: 'fixed'; } | { amount: number; type: 'percent'; } | { tiers: object[]; type: 'tiered'; }; employee_deduction: { amount: number; type: 'fixed'; } | { amount: number; type: 'percent'; }; hsa_contribution_limit?: 'individual' | 'family'; } | { code: number; message: string; name: string; finch_code?: string; }; code: number; individual_id: string; }`\n\n - `body: { annual_maximum: number; catch_up: boolean; company_contribution: { amount: number; type: 'fixed'; } | { amount: number; type: 'percent'; } | { tiers: { match: number; threshold: number; }[]; type: 'tiered'; }; employee_deduction: { amount: number; type: 'fixed'; } | { amount: number; type: 'percent'; }; hsa_contribution_limit?: 'individual' | 'family'; } | { code: number; message: string; name: string; finch_code?: string; }`\n - `code: number`\n - `individual_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const individualBenefit of client.hris.benefits.individuals.retrieveManyBenefits('benefit_id')) {\n console.log(individualBenefit);\n}\n```", + "perLanguage": { + "typescript": { + "method": "client.hris.benefits.individuals.retrieveManyBenefits", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const individualBenefit of client.hris.benefits.individuals.retrieveManyBenefits(\n 'benefit_id',\n)) {\n console.log(individualBenefit.individual_id);\n}" + }, + "python": { + "method": "hris.benefits.individuals.retrieve_many_benefits", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\npage = client.hris.benefits.individuals.retrieve_many_benefits(\n benefit_id=\"benefit_id\",\n)\npage = page.items[0]\nprint(page.individual_id)" + }, + "java": { + "method": "hris().benefits().individuals().retrieveManyBenefits", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisBenefitIndividualRetrieveManyBenefitsPage;\nimport com.tryfinch.api.models.HrisBenefitIndividualRetrieveManyBenefitsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n HrisBenefitIndividualRetrieveManyBenefitsPage page = client.hris().benefits().individuals().retrieveManyBenefits(\"benefit_id\");\n }\n}" + }, + "kotlin": { + "method": "hris().benefits().individuals().retrieveManyBenefits", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisBenefitIndividualRetrieveManyBenefitsPage\nimport com.tryfinch.api.models.HrisBenefitIndividualRetrieveManyBenefitsParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val page: HrisBenefitIndividualRetrieveManyBenefitsPage = client.hris().benefits().individuals().retrieveManyBenefits(\"benefit_id\")\n}" + }, + "go": { + "method": "client.HRIS.Benefits.Individuals.GetManyBenefits", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tpage, err := client.HRIS.Benefits.Individuals.GetManyBenefits(\n\t\tcontext.TODO(),\n\t\t\"benefit_id\",\n\t\tfinchgo.HRISBenefitIndividualGetManyBenefitsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n" + }, + "ruby": { + "method": "hris.benefits.individuals.retrieve_many_benefits", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\npage = finch.hris.benefits.individuals.retrieve_many_benefits(\"benefit_id\")\n\nputs(page)" + }, + "http": { + "example": "curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID/individuals \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'enroll_many', - endpoint: '/employer/benefits/{benefit_id}/individuals', - httpMethod: 'post', - summary: 'Enroll Individuals in Deductions', - description: - 'Enroll an individual into a deduction or contribution. This is an overwrite operation. If the employee is already enrolled, the enrollment amounts will be adjusted. Making the same request multiple times will not create new enrollments, but will continue to set the state of the existing enrollment.', - stainlessPath: '(resource) hris.benefits.individuals > (method) enroll_many', - qualified: 'client.hris.benefits.individuals.enrollMany', - params: [ - 'benefit_id: string;', - 'entity_ids?: string[];', - "individuals?: { configuration?: { annual_contribution_limit?: 'individual' | 'family'; annual_maximum?: number; catch_up?: boolean; company_contribution?: { amount?: number; tiers?: { match: number; threshold: number; }[]; type?: 'fixed' | 'percent' | 'tiered'; }; effective_date?: string; employee_deduction?: { amount?: number; type?: 'fixed' | 'percent'; }; }; individual_id?: string; }[];", + "name": "enroll_many", + "endpoint": "/employer/benefits/{benefit_id}/individuals", + "httpMethod": "post", + "summary": "Enroll Individuals in Deductions", + "description": "Enroll an individual into a deduction or contribution. This is an overwrite operation. If the employee is already enrolled, the enrollment amounts will be adjusted. Making the same request multiple times will not create new enrollments, but will continue to set the state of the existing enrollment.", + "stainlessPath": "(resource) hris.benefits.individuals > (method) enroll_many", + "qualified": "client.hris.benefits.individuals.enrollMany", + "params": [ + "benefit_id: string;", + "entity_ids?: string[];", + "individuals?: { configuration?: { annual_contribution_limit?: 'individual' | 'family'; annual_maximum?: number; catch_up?: boolean; company_contribution?: { amount?: number; tiers?: { match: number; threshold: number; }[]; type?: 'fixed' | 'percent' | 'tiered'; }; effective_date?: string; employee_deduction?: { amount?: number; type?: 'fixed' | 'percent'; }; }; individual_id?: string; }[];" ], - response: '{ job_id: string; }', - markdown: - "## enroll_many\n\n`client.hris.benefits.individuals.enrollMany(benefit_id: string, entity_ids?: string[], individuals?: { configuration?: { annual_contribution_limit?: 'individual' | 'family'; annual_maximum?: number; catch_up?: boolean; company_contribution?: object; effective_date?: string; employee_deduction?: object; }; individual_id?: string; }[]): { job_id: string; }`\n\n**post** `/employer/benefits/{benefit_id}/individuals`\n\nEnroll an individual into a deduction or contribution. This is an overwrite operation. If the employee is already enrolled, the enrollment amounts will be adjusted. Making the same request multiple times will not create new enrollments, but will continue to set the state of the existing enrollment.\n\n### Parameters\n\n- `benefit_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `individuals?: { configuration?: { annual_contribution_limit?: 'individual' | 'family'; annual_maximum?: number; catch_up?: boolean; company_contribution?: { amount?: number; tiers?: { match: number; threshold: number; }[]; type?: 'fixed' | 'percent' | 'tiered'; }; effective_date?: string; employee_deduction?: { amount?: number; type?: 'fixed' | 'percent'; }; }; individual_id?: string; }[]`\n Array of the individual_id to enroll and a configuration object.\n\n### Returns\n\n- `{ job_id: string; }`\n\n - `job_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst enrolledIndividualBenefitResponse = await client.hris.benefits.individuals.enrollMany('benefit_id');\n\nconsole.log(enrolledIndividualBenefitResponse);\n```", - perLanguage: { - typescript: { - method: 'client.hris.benefits.individuals.enrollMany', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst enrolledIndividualBenefitResponse = await client.hris.benefits.individuals.enrollMany(\n 'benefit_id',\n);\n\nconsole.log(enrolledIndividualBenefitResponse.job_id);", - }, - python: { - method: 'hris.benefits.individuals.enroll_many', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nenrolled_individual_benefit_response = client.hris.benefits.individuals.enroll_many(\n benefit_id="benefit_id",\n)\nprint(enrolled_individual_benefit_response.job_id)', - }, - ruby: { - method: 'hris.benefits.individuals.enroll_many', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nenrolled_individual_benefit_response = finch.hris.benefits.individuals.enroll_many("benefit_id")\n\nputs(enrolled_individual_benefit_response)', - }, - http: { - example: - 'curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID/individuals \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "response": "{ job_id: string; }", + "markdown": "## enroll_many\n\n`client.hris.benefits.individuals.enrollMany(benefit_id: string, entity_ids?: string[], individuals?: { configuration?: { annual_contribution_limit?: 'individual' | 'family'; annual_maximum?: number; catch_up?: boolean; company_contribution?: object; effective_date?: string; employee_deduction?: object; }; individual_id?: string; }[]): { job_id: string; }`\n\n**post** `/employer/benefits/{benefit_id}/individuals`\n\nEnroll an individual into a deduction or contribution. This is an overwrite operation. If the employee is already enrolled, the enrollment amounts will be adjusted. Making the same request multiple times will not create new enrollments, but will continue to set the state of the existing enrollment.\n\n### Parameters\n\n- `benefit_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `individuals?: { configuration?: { annual_contribution_limit?: 'individual' | 'family'; annual_maximum?: number; catch_up?: boolean; company_contribution?: { amount?: number; tiers?: { match: number; threshold: number; }[]; type?: 'fixed' | 'percent' | 'tiered'; }; effective_date?: string; employee_deduction?: { amount?: number; type?: 'fixed' | 'percent'; }; }; individual_id?: string; }[]`\n Array of the individual_id to enroll and a configuration object.\n\n### Returns\n\n- `{ job_id: string; }`\n\n - `job_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst enrolledIndividualBenefitResponse = await client.hris.benefits.individuals.enrollMany('benefit_id');\n\nconsole.log(enrolledIndividualBenefitResponse);\n```", + "perLanguage": { + "typescript": { + "method": "client.hris.benefits.individuals.enrollMany", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst enrolledIndividualBenefitResponse = await client.hris.benefits.individuals.enrollMany(\n 'benefit_id',\n);\n\nconsole.log(enrolledIndividualBenefitResponse.job_id);" + }, + "python": { + "method": "hris.benefits.individuals.enroll_many", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nenrolled_individual_benefit_response = client.hris.benefits.individuals.enroll_many(\n benefit_id=\"benefit_id\",\n)\nprint(enrolled_individual_benefit_response.job_id)" + }, + "ruby": { + "method": "hris.benefits.individuals.enroll_many", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nenrolled_individual_benefit_response = finch.hris.benefits.individuals.enroll_many(\"benefit_id\")\n\nputs(enrolled_individual_benefit_response)" + }, + "http": { + "example": "curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID/individuals \\\n -X POST \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'unenroll_many', - endpoint: '/employer/benefits/{benefit_id}/individuals', - httpMethod: 'delete', - summary: 'Unenroll Individuals from Deductions', - description: 'Unenroll individuals from a deduction or contribution', - stainlessPath: '(resource) hris.benefits.individuals > (method) unenroll_many', - qualified: 'client.hris.benefits.individuals.unenrollMany', - params: ['benefit_id: string;', 'entity_ids?: string[];', 'individual_ids?: string[];'], - response: '{ job_id: string; }', - markdown: - "## unenroll_many\n\n`client.hris.benefits.individuals.unenrollMany(benefit_id: string, entity_ids?: string[], individual_ids?: string[]): { job_id: string; }`\n\n**delete** `/employer/benefits/{benefit_id}/individuals`\n\nUnenroll individuals from a deduction or contribution\n\n### Parameters\n\n- `benefit_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `individual_ids?: string[]`\n Array of individual_ids to unenroll.\n\n### Returns\n\n- `{ job_id: string; }`\n\n - `job_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst unenrolledIndividualBenefitResponse = await client.hris.benefits.individuals.unenrollMany('benefit_id');\n\nconsole.log(unenrolledIndividualBenefitResponse);\n```", - perLanguage: { - typescript: { - method: 'client.hris.benefits.individuals.unenrollMany', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst unenrolledIndividualBenefitResponse = await client.hris.benefits.individuals.unenrollMany(\n 'benefit_id',\n);\n\nconsole.log(unenrolledIndividualBenefitResponse.job_id);", - }, - python: { - method: 'hris.benefits.individuals.unenroll_many', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nunenrolled_individual_benefit_response = client.hris.benefits.individuals.unenroll_many(\n benefit_id="benefit_id",\n)\nprint(unenrolled_individual_benefit_response.job_id)', - }, - java: { - method: 'hris().benefits().individuals().unenrollMany', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisBenefitIndividualUnenrollManyParams;\nimport com.tryfinch.api.models.UnenrolledIndividualBenefitResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UnenrolledIndividualBenefitResponse unenrolledIndividualBenefitResponse = client.hris().benefits().individuals().unenrollMany("benefit_id");\n }\n}', - }, - kotlin: { - method: 'hris().benefits().individuals().unenrollMany', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisBenefitIndividualUnenrollManyParams\nimport com.tryfinch.api.models.UnenrolledIndividualBenefitResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val unenrolledIndividualBenefitResponse: UnenrolledIndividualBenefitResponse = client.hris().benefits().individuals().unenrollMany("benefit_id")\n}', - }, - go: { - method: 'client.HRIS.Benefits.Individuals.UnenrollMany', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tunenrolledIndividualBenefitResponse, err := client.HRIS.Benefits.Individuals.UnenrollMany(\n\t\tcontext.TODO(),\n\t\t"benefit_id",\n\t\tfinchgo.HRISBenefitIndividualUnenrollManyParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", unenrolledIndividualBenefitResponse.JobID)\n}\n', - }, - ruby: { - method: 'hris.benefits.individuals.unenroll_many', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nunenrolled_individual_benefit_response = finch.hris.benefits.individuals.unenroll_many("benefit_id")\n\nputs(unenrolled_individual_benefit_response)', - }, - http: { - example: - 'curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID/individuals \\\n -X DELETE \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "name": "unenroll_many", + "endpoint": "/employer/benefits/{benefit_id}/individuals", + "httpMethod": "delete", + "summary": "Unenroll Individuals from Deductions", + "description": "Unenroll individuals from a deduction or contribution", + "stainlessPath": "(resource) hris.benefits.individuals > (method) unenroll_many", + "qualified": "client.hris.benefits.individuals.unenrollMany", + "params": [ + "benefit_id: string;", + "entity_ids?: string[];", + "individual_ids?: string[];" + ], + "response": "{ job_id: string; }", + "markdown": "## unenroll_many\n\n`client.hris.benefits.individuals.unenrollMany(benefit_id: string, entity_ids?: string[], individual_ids?: string[]): { job_id: string; }`\n\n**delete** `/employer/benefits/{benefit_id}/individuals`\n\nUnenroll individuals from a deduction or contribution\n\n### Parameters\n\n- `benefit_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `individual_ids?: string[]`\n Array of individual_ids to unenroll.\n\n### Returns\n\n- `{ job_id: string; }`\n\n - `job_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst unenrolledIndividualBenefitResponse = await client.hris.benefits.individuals.unenrollMany('benefit_id');\n\nconsole.log(unenrolledIndividualBenefitResponse);\n```", + "perLanguage": { + "typescript": { + "method": "client.hris.benefits.individuals.unenrollMany", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst unenrolledIndividualBenefitResponse = await client.hris.benefits.individuals.unenrollMany(\n 'benefit_id',\n);\n\nconsole.log(unenrolledIndividualBenefitResponse.job_id);" + }, + "python": { + "method": "hris.benefits.individuals.unenroll_many", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nunenrolled_individual_benefit_response = client.hris.benefits.individuals.unenroll_many(\n benefit_id=\"benefit_id\",\n)\nprint(unenrolled_individual_benefit_response.job_id)" + }, + "java": { + "method": "hris().benefits().individuals().unenrollMany", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisBenefitIndividualUnenrollManyParams;\nimport com.tryfinch.api.models.UnenrolledIndividualBenefitResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n UnenrolledIndividualBenefitResponse unenrolledIndividualBenefitResponse = client.hris().benefits().individuals().unenrollMany(\"benefit_id\");\n }\n}" + }, + "kotlin": { + "method": "hris().benefits().individuals().unenrollMany", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisBenefitIndividualUnenrollManyParams\nimport com.tryfinch.api.models.UnenrolledIndividualBenefitResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val unenrolledIndividualBenefitResponse: UnenrolledIndividualBenefitResponse = client.hris().benefits().individuals().unenrollMany(\"benefit_id\")\n}" + }, + "go": { + "method": "client.HRIS.Benefits.Individuals.UnenrollMany", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tunenrolledIndividualBenefitResponse, err := client.HRIS.Benefits.Individuals.UnenrollMany(\n\t\tcontext.TODO(),\n\t\t\"benefit_id\",\n\t\tfinchgo.HRISBenefitIndividualUnenrollManyParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", unenrolledIndividualBenefitResponse.JobID)\n}\n" + }, + "ruby": { + "method": "hris.benefits.individuals.unenroll_many", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nunenrolled_individual_benefit_response = finch.hris.benefits.individuals.unenroll_many(\"benefit_id\")\n\nputs(unenrolled_individual_benefit_response)" + }, + "http": { + "example": "curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID/individuals \\\n -X DELETE \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'list', - endpoint: '/providers', - httpMethod: 'get', - summary: 'Providers', - description: 'Return details on all available payroll and HR systems.', - stainlessPath: '(resource) providers > (method) list', - qualified: 'client.providers.list', - response: - "{ id: string; display_name: string; products: string[]; authentication_methods?: { type: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth' | 'api'; benefits_support?: object; supported_fields?: object; }[]; beta?: boolean; icon?: string; logo?: string; manual?: boolean; mfa_required?: boolean; primary_color?: string; }", - markdown: - "## list\n\n`client.providers.list(): { id: string; display_name: string; products: string[]; authentication_methods?: object[]; beta?: boolean; icon?: string; logo?: string; manual?: boolean; mfa_required?: boolean; primary_color?: string; }`\n\n**get** `/providers`\n\nReturn details on all available payroll and HR systems.\n\n### Returns\n\n- `{ id: string; display_name: string; products: string[]; authentication_methods?: { type: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth' | 'api'; benefits_support?: object; supported_fields?: object; }[]; beta?: boolean; icon?: string; logo?: string; manual?: boolean; mfa_required?: boolean; primary_color?: string; }`\n\n - `id: string`\n - `display_name: string`\n - `products: string[]`\n - `authentication_methods?: { type: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth' | 'api'; benefits_support?: object; supported_fields?: object; }[]`\n - `beta?: boolean`\n - `icon?: string`\n - `logo?: string`\n - `manual?: boolean`\n - `mfa_required?: boolean`\n - `primary_color?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const providerListResponse of client.providers.list()) {\n console.log(providerListResponse);\n}\n```", - perLanguage: { - typescript: { - method: 'client.providers.list', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const providerListResponse of client.providers.list()) {\n console.log(providerListResponse.id);\n}", - }, - python: { - method: 'providers.list', - example: - 'from finch import Finch\n\nclient = Finch()\npage = client.providers.list()\npage = page.items[0]\nprint(page.id)', - }, - java: { - method: 'providers().list', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.ProviderListPage;\nimport com.tryfinch.api.models.ProviderListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.fromEnv();\n\n ProviderListPage page = client.providers().list();\n }\n}', - }, - kotlin: { - method: 'providers().list', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.ProviderListPage\nimport com.tryfinch.api.models.ProviderListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.fromEnv()\n\n val page: ProviderListPage = client.providers().list()\n}', - }, - go: { - method: 'client.Providers.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient()\n\tpage, err := client.Providers.List(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'providers.list', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new\n\npage = finch.providers.list\n\nputs(page)', - }, - http: { - example: "curl https://api.tryfinch.com/providers \\\n -H 'Finch-API-Version: 2020-09-17'", - }, - }, + "name": "list", + "endpoint": "/providers", + "httpMethod": "get", + "summary": "Providers", + "description": "Return details on all available payroll and HR systems.", + "stainlessPath": "(resource) providers > (method) list", + "qualified": "client.providers.list", + "response": "{ id: string; display_name: string; products: string[]; authentication_methods?: { type: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth' | 'api'; benefits_support?: object; supported_fields?: object; }[]; beta?: boolean; icon?: string; logo?: string; manual?: boolean; mfa_required?: boolean; primary_color?: string; }", + "markdown": "## list\n\n`client.providers.list(): { id: string; display_name: string; products: string[]; authentication_methods?: object[]; beta?: boolean; icon?: string; logo?: string; manual?: boolean; mfa_required?: boolean; primary_color?: string; }`\n\n**get** `/providers`\n\nReturn details on all available payroll and HR systems.\n\n### Returns\n\n- `{ id: string; display_name: string; products: string[]; authentication_methods?: { type: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth' | 'api'; benefits_support?: object; supported_fields?: object; }[]; beta?: boolean; icon?: string; logo?: string; manual?: boolean; mfa_required?: boolean; primary_color?: string; }`\n\n - `id: string`\n - `display_name: string`\n - `products: string[]`\n - `authentication_methods?: { type: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth' | 'api'; benefits_support?: object; supported_fields?: object; }[]`\n - `beta?: boolean`\n - `icon?: string`\n - `logo?: string`\n - `manual?: boolean`\n - `mfa_required?: boolean`\n - `primary_color?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const providerListResponse of client.providers.list()) {\n console.log(providerListResponse);\n}\n```", + "perLanguage": { + "typescript": { + "method": "client.providers.list", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const providerListResponse of client.providers.list()) {\n console.log(providerListResponse.id);\n}" + }, + "python": { + "method": "providers.list", + "example": "from finch import Finch\n\nclient = Finch()\npage = client.providers.list()\npage = page.items[0]\nprint(page.id)" + }, + "java": { + "method": "providers().list", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.ProviderListPage;\nimport com.tryfinch.api.models.ProviderListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.fromEnv();\n\n ProviderListPage page = client.providers().list();\n }\n}" + }, + "kotlin": { + "method": "providers().list", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.ProviderListPage\nimport com.tryfinch.api.models.ProviderListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.fromEnv()\n\n val page: ProviderListPage = client.providers().list()\n}" + }, + "go": { + "method": "client.Providers.List", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient()\n\tpage, err := client.Providers.List(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n" + }, + "ruby": { + "method": "providers.list", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new\n\npage = finch.providers.list\n\nputs(page)" + }, + "http": { + "example": "curl https://api.tryfinch.com/providers \\\n -H 'Finch-API-Version: 2020-09-17'" + } + } }, { - name: 'introspect', - endpoint: '/introspect', - httpMethod: 'get', - summary: 'Introspect', - description: 'Read account information associated with an `access_token`', - stainlessPath: '(resource) account > (method) introspect', - qualified: 'client.account.introspect', - response: - "{ id: string; client_id: string; client_type: 'development' | 'production' | 'sandbox'; connection_id: string; connection_status: { status: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth'; last_successful_sync?: string | string; message?: string; }; connection_type: 'finch' | 'provider'; products: string[]; provider_id: string; account_id?: string; authentication_methods?: { type: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth'; connection_status?: { status: connection_status_type; last_successful_sync?: string | string; message?: string; }; products?: string[]; }[]; company_id?: string; customer_email?: string; customer_id?: string; customer_name?: string; entities?: { id: string; name: string; source_id: string; status: string; }[]; manual?: boolean; payroll_provider_id?: string; username?: string; }", - markdown: - "## introspect\n\n`client.account.introspect(): { id: string; client_id: string; client_type: 'development' | 'production' | 'sandbox'; connection_id: string; connection_status: object; connection_type: 'finch' | 'provider'; products: string[]; provider_id: string; account_id?: string; authentication_methods?: object[]; company_id?: string; customer_email?: string; customer_id?: string; customer_name?: string; entities?: object[]; manual?: boolean; payroll_provider_id?: string; username?: string; }`\n\n**get** `/introspect`\n\nRead account information associated with an `access_token`\n\n### Returns\n\n- `{ id: string; client_id: string; client_type: 'development' | 'production' | 'sandbox'; connection_id: string; connection_status: { status: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth'; last_successful_sync?: string | string; message?: string; }; connection_type: 'finch' | 'provider'; products: string[]; provider_id: string; account_id?: string; authentication_methods?: { type: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth'; connection_status?: { status: connection_status_type; last_successful_sync?: string | string; message?: string; }; products?: string[]; }[]; company_id?: string; customer_email?: string; customer_id?: string; customer_name?: string; entities?: { id: string; name: string; source_id: string; status: string; }[]; manual?: boolean; payroll_provider_id?: string; username?: string; }`\n\n - `id: string`\n - `client_id: string`\n - `client_type: 'development' | 'production' | 'sandbox'`\n - `connection_id: string`\n - `connection_status: { status: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth'; last_successful_sync?: string | string; message?: string; }`\n - `connection_type: 'finch' | 'provider'`\n - `products: string[]`\n - `provider_id: string`\n - `account_id?: string`\n - `authentication_methods?: { type: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth'; connection_status?: { status: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth'; last_successful_sync?: string | string; message?: string; }; products?: string[]; }[]`\n - `company_id?: string`\n - `customer_email?: string`\n - `customer_id?: string`\n - `customer_name?: string`\n - `entities?: { id: string; name: string; source_id: string; status: string; }[]`\n - `manual?: boolean`\n - `payroll_provider_id?: string`\n - `username?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst introspection = await client.account.introspect();\n\nconsole.log(introspection);\n```", - perLanguage: { - typescript: { - method: 'client.account.introspect', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst introspection = await client.account.introspect();\n\nconsole.log(introspection.id);", - }, - python: { - method: 'account.introspect', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nintrospection = client.account.introspect()\nprint(introspection.id)', - }, - java: { - method: 'account().introspect', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.AccountIntrospectParams;\nimport com.tryfinch.api.models.Introspection;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n Introspection introspection = client.account().introspect();\n }\n}', - }, - kotlin: { - method: 'account().introspect', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AccountIntrospectParams\nimport com.tryfinch.api.models.Introspection\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val introspection: Introspection = client.account().introspect()\n}', - }, - go: { - method: 'client.Account.Introspect', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tintrospection, err := client.Account.Introspect(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", introspection.ID)\n}\n', - }, - ruby: { - method: 'account.introspect', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nintrospection = finch.account.introspect\n\nputs(introspection)', - }, - http: { - example: - 'curl https://api.tryfinch.com/introspect \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "name": "introspect", + "endpoint": "/introspect", + "httpMethod": "get", + "summary": "Introspect", + "description": "Read account information associated with an `access_token`", + "stainlessPath": "(resource) account > (method) introspect", + "qualified": "client.account.introspect", + "response": "{ id: string; client_id: string; client_type: 'development' | 'production' | 'sandbox'; connection_id: string; connection_status: { status: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth'; last_successful_sync?: string | string; message?: string; }; connection_type: 'finch' | 'provider'; products: string[]; provider_id: string; account_id?: string; authentication_methods?: { type: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth'; connection_status?: { status: connection_status_type; last_successful_sync?: string | string; message?: string; }; products?: string[]; }[]; company_id?: string; customer_email?: string; customer_id?: string; customer_name?: string; entities?: { id: string; name: string; source_id: string; status: string; }[]; manual?: boolean; payroll_provider_id?: string; username?: string; }", + "markdown": "## introspect\n\n`client.account.introspect(): { id: string; client_id: string; client_type: 'development' | 'production' | 'sandbox'; connection_id: string; connection_status: object; connection_type: 'finch' | 'provider'; products: string[]; provider_id: string; account_id?: string; authentication_methods?: object[]; company_id?: string; customer_email?: string; customer_id?: string; customer_name?: string; entities?: object[]; manual?: boolean; payroll_provider_id?: string; username?: string; }`\n\n**get** `/introspect`\n\nRead account information associated with an `access_token`\n\n### Returns\n\n- `{ id: string; client_id: string; client_type: 'development' | 'production' | 'sandbox'; connection_id: string; connection_status: { status: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth'; last_successful_sync?: string | string; message?: string; }; connection_type: 'finch' | 'provider'; products: string[]; provider_id: string; account_id?: string; authentication_methods?: { type: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth'; connection_status?: { status: connection_status_type; last_successful_sync?: string | string; message?: string; }; products?: string[]; }[]; company_id?: string; customer_email?: string; customer_id?: string; customer_name?: string; entities?: { id: string; name: string; source_id: string; status: string; }[]; manual?: boolean; payroll_provider_id?: string; username?: string; }`\n\n - `id: string`\n - `client_id: string`\n - `client_type: 'development' | 'production' | 'sandbox'`\n - `connection_id: string`\n - `connection_status: { status: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth'; last_successful_sync?: string | string; message?: string; }`\n - `connection_type: 'finch' | 'provider'`\n - `products: string[]`\n - `provider_id: string`\n - `account_id?: string`\n - `authentication_methods?: { type: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth'; connection_status?: { status: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth'; last_successful_sync?: string | string; message?: string; }; products?: string[]; }[]`\n - `company_id?: string`\n - `customer_email?: string`\n - `customer_id?: string`\n - `customer_name?: string`\n - `entities?: { id: string; name: string; source_id: string; status: string; }[]`\n - `manual?: boolean`\n - `payroll_provider_id?: string`\n - `username?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst introspection = await client.account.introspect();\n\nconsole.log(introspection);\n```", + "perLanguage": { + "typescript": { + "method": "client.account.introspect", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst introspection = await client.account.introspect();\n\nconsole.log(introspection.id);" + }, + "python": { + "method": "account.introspect", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nintrospection = client.account.introspect()\nprint(introspection.id)" + }, + "java": { + "method": "account().introspect", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.AccountIntrospectParams;\nimport com.tryfinch.api.models.Introspection;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n Introspection introspection = client.account().introspect();\n }\n}" + }, + "kotlin": { + "method": "account().introspect", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AccountIntrospectParams\nimport com.tryfinch.api.models.Introspection\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val introspection: Introspection = client.account().introspect()\n}" + }, + "go": { + "method": "client.Account.Introspect", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tintrospection, err := client.Account.Introspect(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", introspection.ID)\n}\n" + }, + "ruby": { + "method": "account.introspect", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nintrospection = finch.account.introspect\n\nputs(introspection)" + }, + "http": { + "example": "curl https://api.tryfinch.com/introspect \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'disconnect', - endpoint: '/disconnect', - httpMethod: 'post', - summary: 'Disconnect', - description: 'Disconnect one or more `access_token`s from your application.', - stainlessPath: '(resource) account > (method) disconnect', - qualified: 'client.account.disconnect', - response: '{ status: string; }', - markdown: - "## disconnect\n\n`client.account.disconnect(): { status: string; }`\n\n**post** `/disconnect`\n\nDisconnect one or more `access_token`s from your application.\n\n### Returns\n\n- `{ status: string; }`\n\n - `status: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst disconnectResponse = await client.account.disconnect();\n\nconsole.log(disconnectResponse);\n```", - perLanguage: { - typescript: { - method: 'client.account.disconnect', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst disconnectResponse = await client.account.disconnect();\n\nconsole.log(disconnectResponse.status);", - }, - python: { - method: 'account.disconnect', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\ndisconnect_response = client.account.disconnect()\nprint(disconnect_response.status)', - }, - java: { - method: 'account().disconnect', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.AccountDisconnectParams;\nimport com.tryfinch.api.models.DisconnectResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DisconnectResponse disconnectResponse = client.account().disconnect();\n }\n}', - }, - kotlin: { - method: 'account().disconnect', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AccountDisconnectParams\nimport com.tryfinch.api.models.DisconnectResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val disconnectResponse: DisconnectResponse = client.account().disconnect()\n}', - }, - go: { - method: 'client.Account.Disconnect', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tdisconnectResponse, err := client.Account.Disconnect(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", disconnectResponse.Status)\n}\n', - }, - ruby: { - method: 'account.disconnect', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\ndisconnect_response = finch.account.disconnect\n\nputs(disconnect_response)', - }, - http: { - example: - 'curl https://api.tryfinch.com/disconnect \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "name": "disconnect", + "endpoint": "/disconnect", + "httpMethod": "post", + "summary": "Disconnect", + "description": "Disconnect one or more `access_token`s from your application.", + "stainlessPath": "(resource) account > (method) disconnect", + "qualified": "client.account.disconnect", + "response": "{ status: string; }", + "markdown": "## disconnect\n\n`client.account.disconnect(): { status: string; }`\n\n**post** `/disconnect`\n\nDisconnect one or more `access_token`s from your application.\n\n### Returns\n\n- `{ status: string; }`\n\n - `status: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst disconnectResponse = await client.account.disconnect();\n\nconsole.log(disconnectResponse);\n```", + "perLanguage": { + "typescript": { + "method": "client.account.disconnect", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst disconnectResponse = await client.account.disconnect();\n\nconsole.log(disconnectResponse.status);" + }, + "python": { + "method": "account.disconnect", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\ndisconnect_response = client.account.disconnect()\nprint(disconnect_response.status)" + }, + "java": { + "method": "account().disconnect", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.AccountDisconnectParams;\nimport com.tryfinch.api.models.DisconnectResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n DisconnectResponse disconnectResponse = client.account().disconnect();\n }\n}" + }, + "kotlin": { + "method": "account().disconnect", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AccountDisconnectParams\nimport com.tryfinch.api.models.DisconnectResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val disconnectResponse: DisconnectResponse = client.account().disconnect()\n}" + }, + "go": { + "method": "client.Account.Disconnect", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tdisconnectResponse, err := client.Account.Disconnect(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", disconnectResponse.Status)\n}\n" + }, + "ruby": { + "method": "account.disconnect", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\ndisconnect_response = finch.account.disconnect\n\nputs(disconnect_response)" + }, + "http": { + "example": "curl https://api.tryfinch.com/disconnect \\\n -X POST \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'forward', - endpoint: '/forward', - httpMethod: 'post', - summary: 'Request Forwarding', - description: - "The Forward API allows you to make direct requests to an employment system. If Finch's unified API\ndoesn't have a data model that cleanly fits your needs, then Forward allows you to push or pull\ndata models directly against an integration's API.", - stainlessPath: '(resource) request_forwarding > (method) forward', - qualified: 'client.requestForwarding.forward', - params: [ - 'method: string;', - 'route: string;', - 'data?: string;', - 'params?: object;', - 'request_headers?: object;', + "name": "forward", + "endpoint": "/forward", + "httpMethod": "post", + "summary": "Request Forwarding", + "description": "The Forward API allows you to make direct requests to an employment system. If Finch's unified API\ndoesn't have a data model that cleanly fits your needs, then Forward allows you to push or pull\ndata models directly against an integration's API.", + "stainlessPath": "(resource) request_forwarding > (method) forward", + "qualified": "client.requestForwarding.forward", + "params": [ + "method: string;", + "route: string;", + "data?: string;", + "params?: object;", + "request_headers?: object;" ], - response: - '{ request: { method: string; route: string; data?: string | object; headers?: object; params?: object; }; statusCode: number; data?: string; headers?: object; }', - markdown: - "## forward\n\n`client.requestForwarding.forward(method: string, route: string, data?: string, params?: object, request_headers?: object): { request: object; statusCode: number; data?: string; headers?: object; }`\n\n**post** `/forward`\n\nThe Forward API allows you to make direct requests to an employment system. If Finch's unified API\ndoesn't have a data model that cleanly fits your needs, then Forward allows you to push or pull\ndata models directly against an integration's API.\n\n### Parameters\n\n- `method: string`\n The HTTP method for the forwarded request. Valid values include: `GET` , `POST` , `PUT` , `DELETE` , and `PATCH`.\n\n- `route: string`\n The URL route path for the forwarded request. This value must begin with a forward-slash ( / ) and may only contain alphanumeric characters, hyphens, and underscores.\n\n- `data?: string`\n The body for the forwarded request. This value must be specified as either a string or a valid JSON object.\n\n- `params?: object`\n The query parameters for the forwarded request. This value must be specified as a valid JSON object rather than a query string.\n\n- `request_headers?: object`\n The HTTP headers to include on the forwarded request. This value must be specified as an object of key-value pairs. Example: `{\"Content-Type\": \"application/xml\", \"X-API-Version\": \"v1\" }`\n\n### Returns\n\n- `{ request: { method: string; route: string; data?: string | object; headers?: object; params?: object; }; statusCode: number; data?: string; headers?: object; }`\n\n - `request: { method: string; route: string; data?: string | object; headers?: object; params?: object; }`\n - `statusCode: number`\n - `data?: string`\n - `headers?: object`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst response = await client.requestForwarding.forward({ method: 'method', route: 'route' });\n\nconsole.log(response);\n```", - perLanguage: { - typescript: { - method: 'client.requestForwarding.forward', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.requestForwarding.forward({ method: 'method', route: 'route' });\n\nconsole.log(response.request);", - }, - python: { - method: 'request_forwarding.forward', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nresponse = client.request_forwarding.forward(\n method="method",\n route="route",\n)\nprint(response.request)', - }, - java: { - method: 'requestForwarding().forward', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.RequestForwardingForwardParams;\nimport com.tryfinch.api.models.RequestForwardingForwardResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RequestForwardingForwardParams params = RequestForwardingForwardParams.builder()\n .method("method")\n .route("route")\n .build();\n RequestForwardingForwardResponse response = client.requestForwarding().forward(params);\n }\n}', - }, - kotlin: { - method: 'requestForwarding().forward', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.RequestForwardingForwardParams\nimport com.tryfinch.api.models.RequestForwardingForwardResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val params: RequestForwardingForwardParams = RequestForwardingForwardParams.builder()\n .method("method")\n .route("route")\n .build()\n val response: RequestForwardingForwardResponse = client.requestForwarding().forward(params)\n}', - }, - go: { - method: 'client.RequestForwarding.Forward', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.RequestForwarding.Forward(context.TODO(), finchgo.RequestForwardingForwardParams{\n\t\tMethod: finchgo.F("method"),\n\t\tRoute: finchgo.F("route"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response.Request)\n}\n', - }, - ruby: { - method: 'request_forwarding.forward', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nresponse = finch.request_forwarding.forward(method_: "method", route: "route")\n\nputs(response)', - }, - http: { - example: - 'curl https://api.tryfinch.com/forward \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "method": "method",\n "route": "route"\n }\'', - }, - }, + "response": "{ request: { method: string; route: string; data?: string | object; headers?: object; params?: object; }; statusCode: number; data?: string; headers?: object; }", + "markdown": "## forward\n\n`client.requestForwarding.forward(method: string, route: string, data?: string, params?: object, request_headers?: object): { request: object; statusCode: number; data?: string; headers?: object; }`\n\n**post** `/forward`\n\nThe Forward API allows you to make direct requests to an employment system. If Finch's unified API\ndoesn't have a data model that cleanly fits your needs, then Forward allows you to push or pull\ndata models directly against an integration's API.\n\n### Parameters\n\n- `method: string`\n The HTTP method for the forwarded request. Valid values include: `GET` , `POST` , `PUT` , `DELETE` , and `PATCH`.\n\n- `route: string`\n The URL route path for the forwarded request. This value must begin with a forward-slash ( / ) and may only contain alphanumeric characters, hyphens, and underscores.\n\n- `data?: string`\n The body for the forwarded request. This value must be specified as either a string or a valid JSON object.\n\n- `params?: object`\n The query parameters for the forwarded request. This value must be specified as a valid JSON object rather than a query string.\n\n- `request_headers?: object`\n The HTTP headers to include on the forwarded request. This value must be specified as an object of key-value pairs. Example: `{\"Content-Type\": \"application/xml\", \"X-API-Version\": \"v1\" }`\n\n### Returns\n\n- `{ request: { method: string; route: string; data?: string | object; headers?: object; params?: object; }; statusCode: number; data?: string; headers?: object; }`\n\n - `request: { method: string; route: string; data?: string | object; headers?: object; params?: object; }`\n - `statusCode: number`\n - `data?: string`\n - `headers?: object`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst response = await client.requestForwarding.forward({ method: 'method', route: 'route' });\n\nconsole.log(response);\n```", + "perLanguage": { + "typescript": { + "method": "client.requestForwarding.forward", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.requestForwarding.forward({ method: 'method', route: 'route' });\n\nconsole.log(response.request);" + }, + "python": { + "method": "request_forwarding.forward", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nresponse = client.request_forwarding.forward(\n method=\"method\",\n route=\"route\",\n)\nprint(response.request)" + }, + "java": { + "method": "requestForwarding().forward", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.RequestForwardingForwardParams;\nimport com.tryfinch.api.models.RequestForwardingForwardResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n RequestForwardingForwardParams params = RequestForwardingForwardParams.builder()\n .method(\"method\")\n .route(\"route\")\n .build();\n RequestForwardingForwardResponse response = client.requestForwarding().forward(params);\n }\n}" + }, + "kotlin": { + "method": "requestForwarding().forward", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.RequestForwardingForwardParams\nimport com.tryfinch.api.models.RequestForwardingForwardResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val params: RequestForwardingForwardParams = RequestForwardingForwardParams.builder()\n .method(\"method\")\n .route(\"route\")\n .build()\n val response: RequestForwardingForwardResponse = client.requestForwarding().forward(params)\n}" + }, + "go": { + "method": "client.RequestForwarding.Forward", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tresponse, err := client.RequestForwarding.Forward(context.TODO(), finchgo.RequestForwardingForwardParams{\n\t\tMethod: finchgo.F(\"method\"),\n\t\tRoute: finchgo.F(\"route\"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.Request)\n}\n" + }, + "ruby": { + "method": "request_forwarding.forward", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nresponse = finch.request_forwarding.forward(method_: \"method\", route: \"route\")\n\nputs(response)" + }, + "http": { + "example": "curl https://api.tryfinch.com/forward \\\n -H 'Content-Type: application/json' \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{\n \"method\": \"method\",\n \"route\": \"route\"\n }'" + } + } }, { - name: 'list', - endpoint: '/jobs/automated', - httpMethod: 'get', - summary: 'List All Automated Jobs', - description: - 'Get all automated jobs. Automated jobs are completed by a machine. By default, jobs are sorted in descending order by submission time. For scheduled jobs such as data syncs, only the next scheduled job is shown.', - stainlessPath: '(resource) jobs.automated > (method) list', - qualified: 'client.jobs.automated.list', - params: ['limit?: number;', 'offset?: number;'], - response: - "{ data: { completed_at: string; created_at: string; job_id: string; job_url: string; params: object; scheduled_at: string; started_at: string; status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'; type: 'data_sync_all' | 'w4_form_employee_sync'; }[]; meta: { quotas?: { data_sync_all?: object; }; }; }", - markdown: - "## list\n\n`client.jobs.automated.list(limit?: number, offset?: number): { data: automated_async_job[]; meta: object; }`\n\n**get** `/jobs/automated`\n\nGet all automated jobs. Automated jobs are completed by a machine. By default, jobs are sorted in descending order by submission time. For scheduled jobs such as data syncs, only the next scheduled job is shown.\n\n### Parameters\n\n- `limit?: number`\n Number of items to return\n\n- `offset?: number`\n Index to start from (defaults to 0)\n\n### Returns\n\n- `{ data: { completed_at: string; created_at: string; job_id: string; job_url: string; params: object; scheduled_at: string; started_at: string; status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'; type: 'data_sync_all' | 'w4_form_employee_sync'; }[]; meta: { quotas?: { data_sync_all?: object; }; }; }`\n\n - `data: { completed_at: string; created_at: string; job_id: string; job_url: string; params: { individual_id?: string; }; scheduled_at: string; started_at: string; status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'; type: 'data_sync_all' | 'w4_form_employee_sync'; }[]`\n - `meta: { quotas?: { data_sync_all?: { allowed_refreshes?: number; remaining_refreshes?: number; }; }; }`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst automateds = await client.jobs.automated.list();\n\nconsole.log(automateds);\n```", - perLanguage: { - typescript: { - method: 'client.jobs.automated.list', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst automateds = await client.jobs.automated.list();\n\nconsole.log(automateds.data);", - }, - python: { - method: 'jobs.automated.list', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nautomateds = client.jobs.automated.list()\nprint(automateds.data)', - }, - java: { - method: 'jobs().automated().list', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.AutomatedListResponse;\nimport com.tryfinch.api.models.JobAutomatedListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AutomatedListResponse automateds = client.jobs().automated().list();\n }\n}', - }, - kotlin: { - method: 'jobs().automated().list', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AutomatedListResponse\nimport com.tryfinch.api.models.JobAutomatedListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val automateds: AutomatedListResponse = client.jobs().automated().list()\n}', - }, - go: { - method: 'client.Jobs.Automated.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tautomateds, err := client.Jobs.Automated.List(context.TODO(), finchgo.JobAutomatedListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", automateds.Data)\n}\n', - }, - ruby: { - method: 'jobs.automated.list', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nautomateds = finch.jobs.automated.list\n\nputs(automateds)', - }, - http: { - example: - 'curl https://api.tryfinch.com/jobs/automated \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "name": "list", + "endpoint": "/jobs/automated", + "httpMethod": "get", + "summary": "List All Automated Jobs", + "description": "Get all automated jobs. Automated jobs are completed by a machine. By default, jobs are sorted in descending order by submission time. For scheduled jobs such as data syncs, only the next scheduled job is shown.", + "stainlessPath": "(resource) jobs.automated > (method) list", + "qualified": "client.jobs.automated.list", + "params": [ + "limit?: number;", + "offset?: number;" + ], + "response": "{ data: { completed_at: string; created_at: string; job_id: string; job_url: string; params: object; scheduled_at: string; started_at: string; status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'; type: 'data_sync_all' | 'w4_form_employee_sync'; }[]; meta: { quotas?: { data_sync_all?: object; }; }; }", + "markdown": "## list\n\n`client.jobs.automated.list(limit?: number, offset?: number): { data: automated_async_job[]; meta: object; }`\n\n**get** `/jobs/automated`\n\nGet all automated jobs. Automated jobs are completed by a machine. By default, jobs are sorted in descending order by submission time. For scheduled jobs such as data syncs, only the next scheduled job is shown.\n\n### Parameters\n\n- `limit?: number`\n Number of items to return\n\n- `offset?: number`\n Index to start from (defaults to 0)\n\n### Returns\n\n- `{ data: { completed_at: string; created_at: string; job_id: string; job_url: string; params: object; scheduled_at: string; started_at: string; status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'; type: 'data_sync_all' | 'w4_form_employee_sync'; }[]; meta: { quotas?: { data_sync_all?: object; }; }; }`\n\n - `data: { completed_at: string; created_at: string; job_id: string; job_url: string; params: { individual_id?: string; }; scheduled_at: string; started_at: string; status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'; type: 'data_sync_all' | 'w4_form_employee_sync'; }[]`\n - `meta: { quotas?: { data_sync_all?: { allowed_refreshes?: number; remaining_refreshes?: number; }; }; }`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst automateds = await client.jobs.automated.list();\n\nconsole.log(automateds);\n```", + "perLanguage": { + "typescript": { + "method": "client.jobs.automated.list", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst automateds = await client.jobs.automated.list();\n\nconsole.log(automateds.data);" + }, + "python": { + "method": "jobs.automated.list", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nautomateds = client.jobs.automated.list()\nprint(automateds.data)" + }, + "java": { + "method": "jobs().automated().list", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.AutomatedListResponse;\nimport com.tryfinch.api.models.JobAutomatedListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n AutomatedListResponse automateds = client.jobs().automated().list();\n }\n}" + }, + "kotlin": { + "method": "jobs().automated().list", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AutomatedListResponse\nimport com.tryfinch.api.models.JobAutomatedListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val automateds: AutomatedListResponse = client.jobs().automated().list()\n}" + }, + "go": { + "method": "client.Jobs.Automated.List", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tautomateds, err := client.Jobs.Automated.List(context.TODO(), finchgo.JobAutomatedListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", automateds.Data)\n}\n" + }, + "ruby": { + "method": "jobs.automated.list", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nautomateds = finch.jobs.automated.list\n\nputs(automateds)" + }, + "http": { + "example": "curl https://api.tryfinch.com/jobs/automated \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'create', - endpoint: '/jobs/automated', - httpMethod: 'post', - summary: 'Enqueue a New Automated Job', - description: - 'Enqueue an automated job.\n\n`data_sync_all`: Enqueue a job to re-sync all data for a connection. `data_sync_all` has a concurrency limit of 1 job at a time per connection. This means that if this endpoint is called while a job is already in progress for this connection, Finch will return the `job_id` of the job that is currently in progress. Finch allows a fixed window rate limit of 1 forced refresh per hour per connection.\n\n`w4_form_employee_sync`: Enqueues a job for sync W-4 data for a particular individual, identified by `individual_id`. This feature is currently in beta.\n\nThis endpoint is available for *Scale* tier customers as an add-on. To request access to this endpoint, please contact your Finch account manager.', - stainlessPath: '(resource) jobs.automated > (method) create', - qualified: 'client.jobs.automated.create', - params: [ - "{ type: 'data_sync_all'; } | { params: { individual_id: string; }; type: 'w4_form_employee_sync'; };", + "name": "create", + "endpoint": "/jobs/automated", + "httpMethod": "post", + "summary": "Enqueue a New Automated Job", + "description": "Enqueue an automated job.\n\n`data_sync_all`: Enqueue a job to re-sync all data for a connection. `data_sync_all` has a concurrency limit of 1 job at a time per connection. This means that if this endpoint is called while a job is already in progress for this connection, Finch will return the `job_id` of the job that is currently in progress. Finch allows a fixed window rate limit of 1 forced refresh per hour per connection.\n\n`w4_form_employee_sync`: Enqueues a job for sync W-4 data for a particular individual, identified by `individual_id`. This feature is currently in beta.\n\nThis endpoint is available for *Scale* tier customers as an add-on. To request access to this endpoint, please contact your Finch account manager.", + "stainlessPath": "(resource) jobs.automated > (method) create", + "qualified": "client.jobs.automated.create", + "params": [ + "{ type: 'data_sync_all'; } | { params: { individual_id: string; }; type: 'w4_form_employee_sync'; };" ], - response: - '{ allowed_refreshes: number; remaining_refreshes: number; job_id?: string; job_url?: string; retry_at?: string; }', - perLanguage: { - typescript: { - method: 'client.jobs.automated.create', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst automated = await client.jobs.automated.create({ type: 'data_sync_all' });\n\nconsole.log(automated.job_id);", - }, - python: { - method: 'jobs.automated.create', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nautomated = client.jobs.automated.create(\n type="data_sync_all",\n)\nprint(automated.job_id)', - }, - java: { - method: 'jobs().automated().create', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.core.JsonValue;\nimport com.tryfinch.api.models.AutomatedCreateResponse;\nimport com.tryfinch.api.models.JobAutomatedCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n JobAutomatedCreateParams.Body params = JobAutomatedCreateParams.Body.ofDataSyncAll();\n AutomatedCreateResponse automated = client.jobs().automated().create(params);\n }\n}', - }, - kotlin: { - method: 'jobs().automated().create', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.core.JsonValue\nimport com.tryfinch.api.models.AutomatedCreateResponse\nimport com.tryfinch.api.models.JobAutomatedCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val params: JobAutomatedCreateParams.Body = JobAutomatedCreateParams.Body.ofDataSyncAll()\n val automated: AutomatedCreateResponse = client.jobs().automated().create(params)\n}', - }, - go: { - method: 'client.Jobs.Automated.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tautomated, err := client.Jobs.Automated.New(context.TODO(), finchgo.JobAutomatedNewParamsDataSyncAll{\n\t\tType: finchgo.F(finchgo.JobAutomatedNewParamsDataSyncAllTypeDataSyncAll),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", automated.JobID)\n}\n', - }, - ruby: { - method: 'jobs.automated.create', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nautomated = finch.jobs.automated.create(body: {type: :data_sync_all})\n\nputs(automated)', - }, - http: { - example: - 'curl https://api.tryfinch.com/jobs/automated \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "type": "data_sync_all"\n }\'', - }, - }, + "response": "{ allowed_refreshes: number; remaining_refreshes: number; job_id?: string; job_url?: string; retry_at?: string; }", + "perLanguage": { + "typescript": { + "method": "client.jobs.automated.create", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst automated = await client.jobs.automated.create({ type: 'data_sync_all' });\n\nconsole.log(automated.job_id);" + }, + "python": { + "method": "jobs.automated.create", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nautomated = client.jobs.automated.create(\n type=\"data_sync_all\",\n)\nprint(automated.job_id)" + }, + "java": { + "method": "jobs().automated().create", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.core.JsonValue;\nimport com.tryfinch.api.models.AutomatedCreateResponse;\nimport com.tryfinch.api.models.JobAutomatedCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n JobAutomatedCreateParams.Body params = JobAutomatedCreateParams.Body.ofDataSyncAll();\n AutomatedCreateResponse automated = client.jobs().automated().create(params);\n }\n}" + }, + "kotlin": { + "method": "jobs().automated().create", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.core.JsonValue\nimport com.tryfinch.api.models.AutomatedCreateResponse\nimport com.tryfinch.api.models.JobAutomatedCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val params: JobAutomatedCreateParams.Body = JobAutomatedCreateParams.Body.ofDataSyncAll()\n val automated: AutomatedCreateResponse = client.jobs().automated().create(params)\n}" + }, + "go": { + "method": "client.Jobs.Automated.New", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tautomated, err := client.Jobs.Automated.New(context.TODO(), finchgo.JobAutomatedNewParamsDataSyncAll{\n\t\tType: finchgo.F(finchgo.JobAutomatedNewParamsDataSyncAllTypeDataSyncAll),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", automated.JobID)\n}\n" + }, + "ruby": { + "method": "jobs.automated.create", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nautomated = finch.jobs.automated.create(body: {type: :data_sync_all})\n\nputs(automated)" + }, + "http": { + "example": "curl https://api.tryfinch.com/jobs/automated \\\n -H 'Content-Type: application/json' \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{\n \"type\": \"data_sync_all\"\n }'" + } + } }, { - name: 'retrieve', - endpoint: '/jobs/automated/{job_id}', - httpMethod: 'get', - summary: 'Retrieve an Automated Job', - description: 'Get an automated job by `job_id`.', - stainlessPath: '(resource) jobs.automated > (method) retrieve', - qualified: 'client.jobs.automated.retrieve', - params: ['job_id: string;'], - response: - "{ completed_at: string; created_at: string; job_id: string; job_url: string; params: { individual_id?: string; }; scheduled_at: string; started_at: string; status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'; type: 'data_sync_all' | 'w4_form_employee_sync'; }", - markdown: - "## retrieve\n\n`client.jobs.automated.retrieve(job_id: string): { completed_at: string; created_at: string; job_id: string; job_url: string; params: object; scheduled_at: string; started_at: string; status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'; type: 'data_sync_all' | 'w4_form_employee_sync'; }`\n\n**get** `/jobs/automated/{job_id}`\n\nGet an automated job by `job_id`.\n\n### Parameters\n\n- `job_id: string`\n\n### Returns\n\n- `{ completed_at: string; created_at: string; job_id: string; job_url: string; params: { individual_id?: string; }; scheduled_at: string; started_at: string; status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'; type: 'data_sync_all' | 'w4_form_employee_sync'; }`\n\n - `completed_at: string`\n - `created_at: string`\n - `job_id: string`\n - `job_url: string`\n - `params: { individual_id?: string; }`\n - `scheduled_at: string`\n - `started_at: string`\n - `status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'`\n - `type: 'data_sync_all' | 'w4_form_employee_sync'`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst automatedAsyncJob = await client.jobs.automated.retrieve('job_id');\n\nconsole.log(automatedAsyncJob);\n```", - perLanguage: { - typescript: { - method: 'client.jobs.automated.retrieve', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst automatedAsyncJob = await client.jobs.automated.retrieve('job_id');\n\nconsole.log(automatedAsyncJob.job_id);", - }, - python: { - method: 'jobs.automated.retrieve', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nautomated_async_job = client.jobs.automated.retrieve(\n "job_id",\n)\nprint(automated_async_job.job_id)', - }, - java: { - method: 'jobs().automated().retrieve', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.AutomatedAsyncJob;\nimport com.tryfinch.api.models.JobAutomatedRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AutomatedAsyncJob automatedAsyncJob = client.jobs().automated().retrieve("job_id");\n }\n}', - }, - kotlin: { - method: 'jobs().automated().retrieve', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AutomatedAsyncJob\nimport com.tryfinch.api.models.JobAutomatedRetrieveParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val automatedAsyncJob: AutomatedAsyncJob = client.jobs().automated().retrieve("job_id")\n}', - }, - go: { - method: 'client.Jobs.Automated.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tautomatedAsyncJob, err := client.Jobs.Automated.Get(context.TODO(), "job_id")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", automatedAsyncJob.JobID)\n}\n', - }, - ruby: { - method: 'jobs.automated.retrieve', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nautomated_async_job = finch.jobs.automated.retrieve("job_id")\n\nputs(automated_async_job)', - }, - http: { - example: - 'curl https://api.tryfinch.com/jobs/automated/$JOB_ID \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "name": "retrieve", + "endpoint": "/jobs/automated/{job_id}", + "httpMethod": "get", + "summary": "Retrieve an Automated Job", + "description": "Get an automated job by `job_id`.", + "stainlessPath": "(resource) jobs.automated > (method) retrieve", + "qualified": "client.jobs.automated.retrieve", + "params": [ + "job_id: string;" + ], + "response": "{ completed_at: string; created_at: string; job_id: string; job_url: string; params: { individual_id?: string; }; scheduled_at: string; started_at: string; status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'; type: 'data_sync_all' | 'w4_form_employee_sync'; }", + "markdown": "## retrieve\n\n`client.jobs.automated.retrieve(job_id: string): { completed_at: string; created_at: string; job_id: string; job_url: string; params: object; scheduled_at: string; started_at: string; status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'; type: 'data_sync_all' | 'w4_form_employee_sync'; }`\n\n**get** `/jobs/automated/{job_id}`\n\nGet an automated job by `job_id`.\n\n### Parameters\n\n- `job_id: string`\n\n### Returns\n\n- `{ completed_at: string; created_at: string; job_id: string; job_url: string; params: { individual_id?: string; }; scheduled_at: string; started_at: string; status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'; type: 'data_sync_all' | 'w4_form_employee_sync'; }`\n\n - `completed_at: string`\n - `created_at: string`\n - `job_id: string`\n - `job_url: string`\n - `params: { individual_id?: string; }`\n - `scheduled_at: string`\n - `started_at: string`\n - `status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'`\n - `type: 'data_sync_all' | 'w4_form_employee_sync'`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst automatedAsyncJob = await client.jobs.automated.retrieve('job_id');\n\nconsole.log(automatedAsyncJob);\n```", + "perLanguage": { + "typescript": { + "method": "client.jobs.automated.retrieve", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst automatedAsyncJob = await client.jobs.automated.retrieve('job_id');\n\nconsole.log(automatedAsyncJob.job_id);" + }, + "python": { + "method": "jobs.automated.retrieve", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nautomated_async_job = client.jobs.automated.retrieve(\n \"job_id\",\n)\nprint(automated_async_job.job_id)" + }, + "java": { + "method": "jobs().automated().retrieve", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.AutomatedAsyncJob;\nimport com.tryfinch.api.models.JobAutomatedRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n AutomatedAsyncJob automatedAsyncJob = client.jobs().automated().retrieve(\"job_id\");\n }\n}" + }, + "kotlin": { + "method": "jobs().automated().retrieve", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AutomatedAsyncJob\nimport com.tryfinch.api.models.JobAutomatedRetrieveParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val automatedAsyncJob: AutomatedAsyncJob = client.jobs().automated().retrieve(\"job_id\")\n}" + }, + "go": { + "method": "client.Jobs.Automated.Get", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tautomatedAsyncJob, err := client.Jobs.Automated.Get(context.TODO(), \"job_id\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", automatedAsyncJob.JobID)\n}\n" + }, + "ruby": { + "method": "jobs.automated.retrieve", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nautomated_async_job = finch.jobs.automated.retrieve(\"job_id\")\n\nputs(automated_async_job)" + }, + "http": { + "example": "curl https://api.tryfinch.com/jobs/automated/$JOB_ID \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'retrieve', - endpoint: '/jobs/manual/{job_id}', - httpMethod: 'get', - summary: 'Retrieve a Manual Job', - description: - 'Check the status and outcome of a job by `job_id`. This includes all deductions jobs including those for both automated and assisted integrations.', - stainlessPath: '(resource) jobs.manual > (method) retrieve', - qualified: 'client.jobs.manual.retrieve', - params: ['job_id: string;'], - response: "{ body: object[]; job_id: string; status: 'pending' | 'in_progress' | 'error' | 'complete'; }", - markdown: - "## retrieve\n\n`client.jobs.manual.retrieve(job_id: string): { body: object[]; job_id: string; status: 'pending' | 'in_progress' | 'error' | 'complete'; }`\n\n**get** `/jobs/manual/{job_id}`\n\nCheck the status and outcome of a job by `job_id`. This includes all deductions jobs including those for both automated and assisted integrations.\n\n### Parameters\n\n- `job_id: string`\n\n### Returns\n\n- `{ body: object[]; job_id: string; status: 'pending' | 'in_progress' | 'error' | 'complete'; }`\n\n - `body: object[]`\n - `job_id: string`\n - `status: 'pending' | 'in_progress' | 'error' | 'complete'`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst manualAsyncJob = await client.jobs.manual.retrieve('job_id');\n\nconsole.log(manualAsyncJob);\n```", - perLanguage: { - typescript: { - method: 'client.jobs.manual.retrieve', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst manualAsyncJob = await client.jobs.manual.retrieve('job_id');\n\nconsole.log(manualAsyncJob.job_id);", - }, - python: { - method: 'jobs.manual.retrieve', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nmanual_async_job = client.jobs.manual.retrieve(\n "job_id",\n)\nprint(manual_async_job.job_id)', - }, - java: { - method: 'jobs().manual().retrieve', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.JobManualRetrieveParams;\nimport com.tryfinch.api.models.ManualAsyncJob;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ManualAsyncJob manualAsyncJob = client.jobs().manual().retrieve("job_id");\n }\n}', - }, - kotlin: { - method: 'jobs().manual().retrieve', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.JobManualRetrieveParams\nimport com.tryfinch.api.models.ManualAsyncJob\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val manualAsyncJob: ManualAsyncJob = client.jobs().manual().retrieve("job_id")\n}', - }, - go: { - method: 'client.Jobs.Manual.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmanualAsyncJob, err := client.Jobs.Manual.Get(context.TODO(), "job_id")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", manualAsyncJob.JobID)\n}\n', - }, - ruby: { - method: 'jobs.manual.retrieve', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nmanual_async_job = finch.jobs.manual.retrieve("job_id")\n\nputs(manual_async_job)', - }, - http: { - example: - 'curl https://api.tryfinch.com/jobs/manual/$JOB_ID \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "name": "retrieve", + "endpoint": "/jobs/manual/{job_id}", + "httpMethod": "get", + "summary": "Retrieve a Manual Job", + "description": "Check the status and outcome of a job by `job_id`. This includes all deductions jobs including those for both automated and assisted integrations.", + "stainlessPath": "(resource) jobs.manual > (method) retrieve", + "qualified": "client.jobs.manual.retrieve", + "params": [ + "job_id: string;" + ], + "response": "{ body: object[]; job_id: string; status: 'pending' | 'in_progress' | 'error' | 'complete'; }", + "markdown": "## retrieve\n\n`client.jobs.manual.retrieve(job_id: string): { body: object[]; job_id: string; status: 'pending' | 'in_progress' | 'error' | 'complete'; }`\n\n**get** `/jobs/manual/{job_id}`\n\nCheck the status and outcome of a job by `job_id`. This includes all deductions jobs including those for both automated and assisted integrations.\n\n### Parameters\n\n- `job_id: string`\n\n### Returns\n\n- `{ body: object[]; job_id: string; status: 'pending' | 'in_progress' | 'error' | 'complete'; }`\n\n - `body: object[]`\n - `job_id: string`\n - `status: 'pending' | 'in_progress' | 'error' | 'complete'`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst manualAsyncJob = await client.jobs.manual.retrieve('job_id');\n\nconsole.log(manualAsyncJob);\n```", + "perLanguage": { + "typescript": { + "method": "client.jobs.manual.retrieve", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst manualAsyncJob = await client.jobs.manual.retrieve('job_id');\n\nconsole.log(manualAsyncJob.job_id);" + }, + "python": { + "method": "jobs.manual.retrieve", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nmanual_async_job = client.jobs.manual.retrieve(\n \"job_id\",\n)\nprint(manual_async_job.job_id)" + }, + "java": { + "method": "jobs().manual().retrieve", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.JobManualRetrieveParams;\nimport com.tryfinch.api.models.ManualAsyncJob;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n ManualAsyncJob manualAsyncJob = client.jobs().manual().retrieve(\"job_id\");\n }\n}" + }, + "kotlin": { + "method": "jobs().manual().retrieve", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.JobManualRetrieveParams\nimport com.tryfinch.api.models.ManualAsyncJob\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val manualAsyncJob: ManualAsyncJob = client.jobs().manual().retrieve(\"job_id\")\n}" + }, + "go": { + "method": "client.Jobs.Manual.Get", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tmanualAsyncJob, err := client.Jobs.Manual.Get(context.TODO(), \"job_id\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", manualAsyncJob.JobID)\n}\n" + }, + "ruby": { + "method": "jobs.manual.retrieve", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nmanual_async_job = finch.jobs.manual.retrieve(\"job_id\")\n\nputs(manual_async_job)" + }, + "http": { + "example": "curl https://api.tryfinch.com/jobs/manual/$JOB_ID \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'create', - endpoint: '/sandbox/connections', - httpMethod: 'post', - summary: 'Create a new Sandbox Connection', - description: 'Create a new connection (new company/provider pair) with a new account', - stainlessPath: '(resource) sandbox.connections > (method) create', - qualified: 'client.sandbox.connections.create', - params: [ - 'provider_id: string;', + "name": "create", + "endpoint": "/sandbox/connections", + "httpMethod": "post", + "summary": "Create a new Sandbox Connection", + "description": "Create a new connection (new company/provider pair) with a new account", + "stainlessPath": "(resource) sandbox.connections > (method) create", + "qualified": "client.sandbox.connections.create", + "params": [ + "provider_id: string;", "authentication_type?: 'credential' | 'api_token' | 'oauth' | 'assisted';", - 'employee_size?: number;', - 'products?: string[];', + "employee_size?: number;", + "products?: string[];" ], - response: - "{ access_token: string; account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; token_type?: string; }", - markdown: - "## create\n\n`client.sandbox.connections.create(provider_id: string, authentication_type?: 'credential' | 'api_token' | 'oauth' | 'assisted', employee_size?: number, products?: string[]): { access_token: string; account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; token_type?: string; }`\n\n**post** `/sandbox/connections`\n\nCreate a new connection (new company/provider pair) with a new account\n\n### Parameters\n\n- `provider_id: string`\n The provider associated with the connection\n\n- `authentication_type?: 'credential' | 'api_token' | 'oauth' | 'assisted'`\n\n- `employee_size?: number`\n Optional: the size of the employer to be created with this connection. Defaults to 20. Note that if this is higher than 100, historical payroll data will not be generated, and instead only one pay period will be created.\n\n- `products?: string[]`\n\n### Returns\n\n- `{ access_token: string; account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; token_type?: string; }`\n\n - `access_token: string`\n - `account_id: string`\n - `authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'`\n - `company_id: string`\n - `connection_id: string`\n - `entity_id: string`\n - `products: string[]`\n - `provider_id: string`\n - `token_type?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst connection = await client.sandbox.connections.create({ provider_id: 'provider_id' });\n\nconsole.log(connection);\n```", - perLanguage: { - typescript: { - method: 'client.sandbox.connections.create', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n clientID: process.env['FINCH_CLIENT_ID'], // This is the default and can be omitted\n clientSecret: process.env['FINCH_CLIENT_SECRET'], // This is the default and can be omitted\n});\n\nconst connection = await client.sandbox.connections.create({ provider_id: 'provider_id' });\n\nconsole.log(connection.account_id);", - }, - python: { - method: 'sandbox.connections.create', - example: - 'import os\nfrom finch import Finch\n\nclient = Finch(\n client_id=os.environ.get("FINCH_CLIENT_ID"), # This is the default and can be omitted\n client_secret=os.environ.get("FINCH_CLIENT_SECRET"), # This is the default and can be omitted\n)\nconnection = client.sandbox.connections.create(\n provider_id="provider_id",\n)\nprint(connection.account_id)', - }, - java: { - method: 'sandbox().connections().create', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.ConnectionCreateResponse;\nimport com.tryfinch.api.models.SandboxConnectionCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.fromEnv();\n\n SandboxConnectionCreateParams params = SandboxConnectionCreateParams.builder()\n .providerId("provider_id")\n .build();\n ConnectionCreateResponse connection = client.sandbox().connections().create(params);\n }\n}', - }, - kotlin: { - method: 'sandbox().connections().create', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.ConnectionCreateResponse\nimport com.tryfinch.api.models.SandboxConnectionCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.fromEnv()\n\n val params: SandboxConnectionCreateParams = SandboxConnectionCreateParams.builder()\n .providerId("provider_id")\n .build()\n val connection: ConnectionCreateResponse = client.sandbox().connections().create(params)\n}', - }, - go: { - method: 'client.Sandbox.Connections.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithClientID("4ab15e51-11ad-49f4-acae-f343b7794375"),\n\t\toption.WithClientSecret("My Client Secret"),\n\t)\n\tconnection, err := client.Sandbox.Connections.New(context.TODO(), finchgo.SandboxConnectionNewParams{\n\t\tProviderID: finchgo.F("provider_id"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", connection.AccountID)\n}\n', - }, - ruby: { - method: 'sandbox.connections.create', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(client_id: "4ab15e51-11ad-49f4-acae-f343b7794375", client_secret: "My Client Secret")\n\nconnection = finch.sandbox.connections.create(provider_id: "provider_id")\n\nputs(connection)', - }, - http: { - example: - 'curl https://api.tryfinch.com/sandbox/connections \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -u "$FINCH_CLIENT_ID:FINCH_CLIENT_SECRET" \\\n -d \'{\n "provider_id": "provider_id"\n }\'', - }, - }, + "response": "{ access_token: string; account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; token_type?: string; }", + "markdown": "## create\n\n`client.sandbox.connections.create(provider_id: string, authentication_type?: 'credential' | 'api_token' | 'oauth' | 'assisted', employee_size?: number, products?: string[]): { access_token: string; account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; token_type?: string; }`\n\n**post** `/sandbox/connections`\n\nCreate a new connection (new company/provider pair) with a new account\n\n### Parameters\n\n- `provider_id: string`\n The provider associated with the connection\n\n- `authentication_type?: 'credential' | 'api_token' | 'oauth' | 'assisted'`\n\n- `employee_size?: number`\n Optional: the size of the employer to be created with this connection. Defaults to 20. Note that if this is higher than 100, historical payroll data will not be generated, and instead only one pay period will be created.\n\n- `products?: string[]`\n\n### Returns\n\n- `{ access_token: string; account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; token_type?: string; }`\n\n - `access_token: string`\n - `account_id: string`\n - `authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'`\n - `company_id: string`\n - `connection_id: string`\n - `entity_id: string`\n - `products: string[]`\n - `provider_id: string`\n - `token_type?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst connection = await client.sandbox.connections.create({ provider_id: 'provider_id' });\n\nconsole.log(connection);\n```", + "perLanguage": { + "typescript": { + "method": "client.sandbox.connections.create", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n clientID: process.env['FINCH_CLIENT_ID'], // This is the default and can be omitted\n clientSecret: process.env['FINCH_CLIENT_SECRET'], // This is the default and can be omitted\n});\n\nconst connection = await client.sandbox.connections.create({ provider_id: 'provider_id' });\n\nconsole.log(connection.account_id);" + }, + "python": { + "method": "sandbox.connections.create", + "example": "import os\nfrom finch import Finch\n\nclient = Finch(\n client_id=os.environ.get(\"FINCH_CLIENT_ID\"), # This is the default and can be omitted\n client_secret=os.environ.get(\"FINCH_CLIENT_SECRET\"), # This is the default and can be omitted\n)\nconnection = client.sandbox.connections.create(\n provider_id=\"provider_id\",\n)\nprint(connection.account_id)" + }, + "java": { + "method": "sandbox().connections().create", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.ConnectionCreateResponse;\nimport com.tryfinch.api.models.SandboxConnectionCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.fromEnv();\n\n SandboxConnectionCreateParams params = SandboxConnectionCreateParams.builder()\n .providerId(\"provider_id\")\n .build();\n ConnectionCreateResponse connection = client.sandbox().connections().create(params);\n }\n}" + }, + "kotlin": { + "method": "sandbox().connections().create", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.ConnectionCreateResponse\nimport com.tryfinch.api.models.SandboxConnectionCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.fromEnv()\n\n val params: SandboxConnectionCreateParams = SandboxConnectionCreateParams.builder()\n .providerId(\"provider_id\")\n .build()\n val connection: ConnectionCreateResponse = client.sandbox().connections().create(params)\n}" + }, + "go": { + "method": "client.Sandbox.Connections.New", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithClientID(\"4ab15e51-11ad-49f4-acae-f343b7794375\"),\n\t\toption.WithClientSecret(\"My Client Secret\"),\n\t)\n\tconnection, err := client.Sandbox.Connections.New(context.TODO(), finchgo.SandboxConnectionNewParams{\n\t\tProviderID: finchgo.F(\"provider_id\"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", connection.AccountID)\n}\n" + }, + "ruby": { + "method": "sandbox.connections.create", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(client_id: \"4ab15e51-11ad-49f4-acae-f343b7794375\", client_secret: \"My Client Secret\")\n\nconnection = finch.sandbox.connections.create(provider_id: \"provider_id\")\n\nputs(connection)" + }, + "http": { + "example": "curl https://api.tryfinch.com/sandbox/connections \\\n -H 'Content-Type: application/json' \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -u \"$FINCH_CLIENT_ID:FINCH_CLIENT_SECRET\" \\\n -d '{\n \"provider_id\": \"provider_id\"\n }'" + } + } }, { - name: 'create', - endpoint: '/sandbox/connections/accounts', - httpMethod: 'post', - summary: 'Create a new sandbox account', - description: 'Create a new account for an existing connection (company/provider pair)', - stainlessPath: '(resource) sandbox.connections.accounts > (method) create', - qualified: 'client.sandbox.connections.accounts.create', - params: [ - 'company_id: string;', - 'provider_id: string;', + "name": "create", + "endpoint": "/sandbox/connections/accounts", + "httpMethod": "post", + "summary": "Create a new sandbox account", + "description": "Create a new account for an existing connection (company/provider pair)", + "stainlessPath": "(resource) sandbox.connections.accounts > (method) create", + "qualified": "client.sandbox.connections.accounts.create", + "params": [ + "company_id: string;", + "provider_id: string;", "authentication_type?: 'credential' | 'api_token' | 'oauth' | 'assisted';", - 'products?: string[];', + "products?: string[];" ], - response: - "{ access_token: string; account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; }", - markdown: - "## create\n\n`client.sandbox.connections.accounts.create(company_id: string, provider_id: string, authentication_type?: 'credential' | 'api_token' | 'oauth' | 'assisted', products?: string[]): { access_token: string; account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; }`\n\n**post** `/sandbox/connections/accounts`\n\nCreate a new account for an existing connection (company/provider pair)\n\n### Parameters\n\n- `company_id: string`\n\n- `provider_id: string`\n The provider associated with the `access_token`\n\n- `authentication_type?: 'credential' | 'api_token' | 'oauth' | 'assisted'`\n\n- `products?: string[]`\n Optional, defaults to Organization products (`company`, `directory`, `employment`, `individual`)\n\n### Returns\n\n- `{ access_token: string; account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; }`\n\n - `access_token: string`\n - `account_id: string`\n - `authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'`\n - `company_id: string`\n - `connection_id: string`\n - `entity_id: string`\n - `products: string[]`\n - `provider_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst account = await client.sandbox.connections.accounts.create({ company_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', provider_id: 'provider_id' });\n\nconsole.log(account);\n```", - perLanguage: { - typescript: { - method: 'client.sandbox.connections.accounts.create', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n clientID: process.env['FINCH_CLIENT_ID'], // This is the default and can be omitted\n clientSecret: process.env['FINCH_CLIENT_SECRET'], // This is the default and can be omitted\n});\n\nconst account = await client.sandbox.connections.accounts.create({\n company_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',\n provider_id: 'provider_id',\n});\n\nconsole.log(account.account_id);", - }, - python: { - method: 'sandbox.connections.accounts.create', - example: - 'import os\nfrom finch import Finch\n\nclient = Finch(\n client_id=os.environ.get("FINCH_CLIENT_ID"), # This is the default and can be omitted\n client_secret=os.environ.get("FINCH_CLIENT_SECRET"), # This is the default and can be omitted\n)\naccount = client.sandbox.connections.accounts.create(\n company_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n provider_id="provider_id",\n)\nprint(account.account_id)', - }, - java: { - method: 'sandbox().connections().accounts().create', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.AccountCreateResponse;\nimport com.tryfinch.api.models.SandboxConnectionAccountCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.fromEnv();\n\n SandboxConnectionAccountCreateParams params = SandboxConnectionAccountCreateParams.builder()\n .companyId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")\n .providerId("provider_id")\n .build();\n AccountCreateResponse account = client.sandbox().connections().accounts().create(params);\n }\n}', - }, - kotlin: { - method: 'sandbox().connections().accounts().create', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AccountCreateResponse\nimport com.tryfinch.api.models.SandboxConnectionAccountCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.fromEnv()\n\n val params: SandboxConnectionAccountCreateParams = SandboxConnectionAccountCreateParams.builder()\n .companyId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")\n .providerId("provider_id")\n .build()\n val account: AccountCreateResponse = client.sandbox().connections().accounts().create(params)\n}', - }, - go: { - method: 'client.Sandbox.Connections.Accounts.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithClientID("4ab15e51-11ad-49f4-acae-f343b7794375"),\n\t\toption.WithClientSecret("My Client Secret"),\n\t)\n\taccount, err := client.Sandbox.Connections.Accounts.New(context.TODO(), finchgo.SandboxConnectionAccountNewParams{\n\t\tCompanyID: finchgo.F("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"),\n\t\tProviderID: finchgo.F("provider_id"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", account.AccountID)\n}\n', - }, - ruby: { - method: 'sandbox.connections.accounts.create', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(client_id: "4ab15e51-11ad-49f4-acae-f343b7794375", client_secret: "My Client Secret")\n\naccount = finch.sandbox.connections.accounts.create(\n company_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n provider_id: "provider_id"\n)\n\nputs(account)', - }, - http: { - example: - 'curl https://api.tryfinch.com/sandbox/connections/accounts \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -u "$FINCH_CLIENT_ID:FINCH_CLIENT_SECRET" \\\n -d \'{\n "company_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n "provider_id": "provider_id"\n }\'', - }, - }, + "response": "{ access_token: string; account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; }", + "markdown": "## create\n\n`client.sandbox.connections.accounts.create(company_id: string, provider_id: string, authentication_type?: 'credential' | 'api_token' | 'oauth' | 'assisted', products?: string[]): { access_token: string; account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; }`\n\n**post** `/sandbox/connections/accounts`\n\nCreate a new account for an existing connection (company/provider pair)\n\n### Parameters\n\n- `company_id: string`\n\n- `provider_id: string`\n The provider associated with the `access_token`\n\n- `authentication_type?: 'credential' | 'api_token' | 'oauth' | 'assisted'`\n\n- `products?: string[]`\n Optional, defaults to Organization products (`company`, `directory`, `employment`, `individual`)\n\n### Returns\n\n- `{ access_token: string; account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; }`\n\n - `access_token: string`\n - `account_id: string`\n - `authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'`\n - `company_id: string`\n - `connection_id: string`\n - `entity_id: string`\n - `products: string[]`\n - `provider_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst account = await client.sandbox.connections.accounts.create({ company_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', provider_id: 'provider_id' });\n\nconsole.log(account);\n```", + "perLanguage": { + "typescript": { + "method": "client.sandbox.connections.accounts.create", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n clientID: process.env['FINCH_CLIENT_ID'], // This is the default and can be omitted\n clientSecret: process.env['FINCH_CLIENT_SECRET'], // This is the default and can be omitted\n});\n\nconst account = await client.sandbox.connections.accounts.create({\n company_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',\n provider_id: 'provider_id',\n});\n\nconsole.log(account.account_id);" + }, + "python": { + "method": "sandbox.connections.accounts.create", + "example": "import os\nfrom finch import Finch\n\nclient = Finch(\n client_id=os.environ.get(\"FINCH_CLIENT_ID\"), # This is the default and can be omitted\n client_secret=os.environ.get(\"FINCH_CLIENT_SECRET\"), # This is the default and can be omitted\n)\naccount = client.sandbox.connections.accounts.create(\n company_id=\"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\",\n provider_id=\"provider_id\",\n)\nprint(account.account_id)" + }, + "java": { + "method": "sandbox().connections().accounts().create", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.AccountCreateResponse;\nimport com.tryfinch.api.models.SandboxConnectionAccountCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.fromEnv();\n\n SandboxConnectionAccountCreateParams params = SandboxConnectionAccountCreateParams.builder()\n .companyId(\"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\")\n .providerId(\"provider_id\")\n .build();\n AccountCreateResponse account = client.sandbox().connections().accounts().create(params);\n }\n}" + }, + "kotlin": { + "method": "sandbox().connections().accounts().create", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AccountCreateResponse\nimport com.tryfinch.api.models.SandboxConnectionAccountCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.fromEnv()\n\n val params: SandboxConnectionAccountCreateParams = SandboxConnectionAccountCreateParams.builder()\n .companyId(\"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\")\n .providerId(\"provider_id\")\n .build()\n val account: AccountCreateResponse = client.sandbox().connections().accounts().create(params)\n}" + }, + "go": { + "method": "client.Sandbox.Connections.Accounts.New", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithClientID(\"4ab15e51-11ad-49f4-acae-f343b7794375\"),\n\t\toption.WithClientSecret(\"My Client Secret\"),\n\t)\n\taccount, err := client.Sandbox.Connections.Accounts.New(context.TODO(), finchgo.SandboxConnectionAccountNewParams{\n\t\tCompanyID: finchgo.F(\"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\"),\n\t\tProviderID: finchgo.F(\"provider_id\"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", account.AccountID)\n}\n" + }, + "ruby": { + "method": "sandbox.connections.accounts.create", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(client_id: \"4ab15e51-11ad-49f4-acae-f343b7794375\", client_secret: \"My Client Secret\")\n\naccount = finch.sandbox.connections.accounts.create(\n company_id: \"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\",\n provider_id: \"provider_id\"\n)\n\nputs(account)" + }, + "http": { + "example": "curl https://api.tryfinch.com/sandbox/connections/accounts \\\n -H 'Content-Type: application/json' \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -u \"$FINCH_CLIENT_ID:FINCH_CLIENT_SECRET\" \\\n -d '{\n \"company_id\": \"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\",\n \"provider_id\": \"provider_id\"\n }'" + } + } }, { - name: 'update', - endpoint: '/sandbox/connections/accounts', - httpMethod: 'put', - summary: 'Update a sandbox account', - description: - 'Update an existing sandbox account. Change the connection status to understand how the Finch API responds.', - stainlessPath: '(resource) sandbox.connections.accounts > (method) update', - qualified: 'client.sandbox.connections.accounts.update', - params: [ - "connection_status?: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth';", + "name": "update", + "endpoint": "/sandbox/connections/accounts", + "httpMethod": "put", + "summary": "Update a sandbox account", + "description": "Update an existing sandbox account. Change the connection status to understand how the Finch API responds.", + "stainlessPath": "(resource) sandbox.connections.accounts > (method) update", + "qualified": "client.sandbox.connections.accounts.update", + "params": [ + "connection_status?: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth';" ], - response: - "{ account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; }", - markdown: - "## update\n\n`client.sandbox.connections.accounts.update(connection_status?: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth'): { account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; }`\n\n**put** `/sandbox/connections/accounts`\n\nUpdate an existing sandbox account. Change the connection status to understand how the Finch API responds.\n\n### Parameters\n\n- `connection_status?: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth'`\n\n### Returns\n\n- `{ account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; }`\n\n - `account_id: string`\n - `authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'`\n - `company_id: string`\n - `connection_id: string`\n - `entity_id: string`\n - `products: string[]`\n - `provider_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst account = await client.sandbox.connections.accounts.update();\n\nconsole.log(account);\n```", - perLanguage: { - typescript: { - method: 'client.sandbox.connections.accounts.update', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst account = await client.sandbox.connections.accounts.update({ connection_status: 'reauth' });\n\nconsole.log(account.account_id);", - }, - python: { - method: 'sandbox.connections.accounts.update', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\naccount = client.sandbox.connections.accounts.update(\n connection_status="reauth",\n)\nprint(account.account_id)', - }, - java: { - method: 'sandbox().connections().accounts().update', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.AccountUpdateResponse;\nimport com.tryfinch.api.models.SandboxConnectionAccountUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AccountUpdateResponse account = client.sandbox().connections().accounts().update();\n }\n}', - }, - kotlin: { - method: 'sandbox().connections().accounts().update', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AccountUpdateResponse\nimport com.tryfinch.api.models.SandboxConnectionAccountUpdateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val account: AccountUpdateResponse = client.sandbox().connections().accounts().update()\n}', - }, - go: { - method: 'client.Sandbox.Connections.Accounts.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n\t"github.com/Finch-API/finch-api-go/shared"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\taccount, err := client.Sandbox.Connections.Accounts.Update(context.TODO(), finchgo.SandboxConnectionAccountUpdateParams{\n\t\tConnectionStatus: finchgo.F(shared.ConnectionStatusTypeReauth),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", account.AccountID)\n}\n', - }, - ruby: { - method: 'sandbox.connections.accounts.update', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\naccount = finch.sandbox.connections.accounts.update\n\nputs(account)', - }, - http: { - example: - 'curl https://api.tryfinch.com/sandbox/connections/accounts \\\n -X PUT \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "response": "{ account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; }", + "markdown": "## update\n\n`client.sandbox.connections.accounts.update(connection_status?: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth'): { account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; }`\n\n**put** `/sandbox/connections/accounts`\n\nUpdate an existing sandbox account. Change the connection status to understand how the Finch API responds.\n\n### Parameters\n\n- `connection_status?: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth'`\n\n### Returns\n\n- `{ account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; }`\n\n - `account_id: string`\n - `authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'`\n - `company_id: string`\n - `connection_id: string`\n - `entity_id: string`\n - `products: string[]`\n - `provider_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst account = await client.sandbox.connections.accounts.update();\n\nconsole.log(account);\n```", + "perLanguage": { + "typescript": { + "method": "client.sandbox.connections.accounts.update", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst account = await client.sandbox.connections.accounts.update({ connection_status: 'reauth' });\n\nconsole.log(account.account_id);" + }, + "python": { + "method": "sandbox.connections.accounts.update", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\naccount = client.sandbox.connections.accounts.update(\n connection_status=\"reauth\",\n)\nprint(account.account_id)" + }, + "java": { + "method": "sandbox().connections().accounts().update", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.AccountUpdateResponse;\nimport com.tryfinch.api.models.SandboxConnectionAccountUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n AccountUpdateResponse account = client.sandbox().connections().accounts().update();\n }\n}" + }, + "kotlin": { + "method": "sandbox().connections().accounts().update", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AccountUpdateResponse\nimport com.tryfinch.api.models.SandboxConnectionAccountUpdateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val account: AccountUpdateResponse = client.sandbox().connections().accounts().update()\n}" + }, + "go": { + "method": "client.Sandbox.Connections.Accounts.Update", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n\t\"github.com/Finch-API/finch-api-go/shared\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\taccount, err := client.Sandbox.Connections.Accounts.Update(context.TODO(), finchgo.SandboxConnectionAccountUpdateParams{\n\t\tConnectionStatus: finchgo.F(shared.ConnectionStatusTypeReauth),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", account.AccountID)\n}\n" + }, + "ruby": { + "method": "sandbox.connections.accounts.update", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\naccount = finch.sandbox.connections.accounts.update\n\nputs(account)" + }, + "http": { + "example": "curl https://api.tryfinch.com/sandbox/connections/accounts \\\n -X PUT \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'update', - endpoint: '/sandbox/company', - httpMethod: 'put', - summary: "Update a sandbox company's data", - description: "Update a sandbox company's data", - stainlessPath: '(resource) sandbox.company > (method) update', - qualified: 'client.sandbox.company.update', - params: [ + "name": "update", + "endpoint": "/sandbox/company", + "httpMethod": "put", + "summary": "Update a sandbox company's data", + "description": "Update a sandbox company's data", + "stainlessPath": "(resource) sandbox.company > (method) update", + "qualified": "client.sandbox.company.update", + "params": [ "accounts: { account_name?: string; account_number?: string; account_type?: 'checking' | 'savings'; institution_name?: string; routing_number?: string; }[];", - 'departments: { name?: string; parent?: { name?: string; }; }[];', - 'ein: string;', + "departments: { name?: string; parent?: { name?: string; }; }[];", + "ein: string;", "entity: { subtype?: 's_corporation' | 'c_corporation' | 'b_corporation'; type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; };", - 'legal_name: string;', - 'locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[];', - 'primary_email: string;', - 'primary_phone_number: string;', + "legal_name: string;", + "locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[];", + "primary_email: string;", + "primary_phone_number: string;" ], - response: - "{ accounts: { account_name?: string; account_number?: string; account_type?: 'checking' | 'savings'; institution_name?: string; routing_number?: string; }[]; departments: { name?: string; parent?: { name?: string; }; }[]; ein: string; entity: { subtype?: 's_corporation' | 'c_corporation' | 'b_corporation'; type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }; legal_name: string; locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]; primary_email: string; primary_phone_number: string; }", - markdown: - "## update\n\n`client.sandbox.company.update(accounts: { account_name?: string; account_number?: string; account_type?: 'checking' | 'savings'; institution_name?: string; routing_number?: string; }[], departments: { name?: string; parent?: { name?: string; }; }[], ein: string, entity: { subtype?: 's_corporation' | 'c_corporation' | 'b_corporation'; type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }, legal_name: string, locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[], primary_email: string, primary_phone_number: string): { accounts: object[]; departments: object[]; ein: string; entity: object; legal_name: string; locations: location[]; primary_email: string; primary_phone_number: string; }`\n\n**put** `/sandbox/company`\n\nUpdate a sandbox company's data\n\n### Parameters\n\n- `accounts: { account_name?: string; account_number?: string; account_type?: 'checking' | 'savings'; institution_name?: string; routing_number?: string; }[]`\n An array of bank account objects associated with the payroll/HRIS system.\n\n- `departments: { name?: string; parent?: { name?: string; }; }[]`\n The array of company departments.\n\n- `ein: string`\n The employer identification number.\n\n- `entity: { subtype?: 's_corporation' | 'c_corporation' | 'b_corporation'; type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }`\n The entity type object.\n - `subtype?: 's_corporation' | 'c_corporation' | 'b_corporation'`\n The tax payer subtype of the company.\n - `type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'`\n The tax payer type of the company.\n\n- `legal_name: string`\n The legal name of the company.\n\n- `locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]`\n\n- `primary_email: string`\n The email of the main administrator on the account.\n\n- `primary_phone_number: string`\n The phone number of the main administrator on the account. Format: E.164, with extension where applicable, e.g. `+NNNNNNNNNNN xExtension`\n\n### Returns\n\n- `{ accounts: { account_name?: string; account_number?: string; account_type?: 'checking' | 'savings'; institution_name?: string; routing_number?: string; }[]; departments: { name?: string; parent?: { name?: string; }; }[]; ein: string; entity: { subtype?: 's_corporation' | 'c_corporation' | 'b_corporation'; type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }; legal_name: string; locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]; primary_email: string; primary_phone_number: string; }`\n\n - `accounts: { account_name?: string; account_number?: string; account_type?: 'checking' | 'savings'; institution_name?: string; routing_number?: string; }[]`\n - `departments: { name?: string; parent?: { name?: string; }; }[]`\n - `ein: string`\n - `entity: { subtype?: 's_corporation' | 'c_corporation' | 'b_corporation'; type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }`\n - `legal_name: string`\n - `locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]`\n - `primary_email: string`\n - `primary_phone_number: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst company = await client.sandbox.company.update({\n accounts: [{}],\n departments: [{}],\n ein: 'ein',\n entity: {},\n legal_name: 'legal_name',\n locations: [{\n city: 'city',\n country: 'country',\n line1: 'line1',\n line2: 'line2',\n postal_code: 'postal_code',\n state: 'state',\n}],\n primary_email: 'dev@stainless.com',\n primary_phone_number: 'primary_phone_number',\n});\n\nconsole.log(company);\n```", - perLanguage: { - typescript: { - method: 'client.sandbox.company.update', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst company = await client.sandbox.company.update({\n accounts: [{}],\n departments: [{}],\n ein: 'ein',\n entity: {},\n legal_name: 'legal_name',\n locations: [\n {\n city: 'city',\n country: 'country',\n line1: 'line1',\n line2: 'line2',\n postal_code: 'postal_code',\n state: 'state',\n },\n ],\n primary_email: 'dev@stainless.com',\n primary_phone_number: 'primary_phone_number',\n});\n\nconsole.log(company.accounts);", - }, - python: { - method: 'sandbox.company.update', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\ncompany = client.sandbox.company.update(\n accounts=[{}],\n departments=[{}],\n ein="ein",\n entity={},\n legal_name="legal_name",\n locations=[{\n "city": "city",\n "country": "country",\n "line1": "line1",\n "line2": "line2",\n "postal_code": "postal_code",\n "state": "state",\n }],\n primary_email="dev@stainless.com",\n primary_phone_number="primary_phone_number",\n)\nprint(company.accounts)', - }, - java: { - method: 'sandbox().company().update', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.CompanyUpdateResponse;\nimport com.tryfinch.api.models.Location;\nimport com.tryfinch.api.models.SandboxCompanyUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SandboxCompanyUpdateParams params = SandboxCompanyUpdateParams.builder()\n .addAccount(SandboxCompanyUpdateParams.Account.builder().build())\n .addDepartment(SandboxCompanyUpdateParams.Department.builder().build())\n .ein("ein")\n .entity(SandboxCompanyUpdateParams.Entity.builder().build())\n .legalName("legal_name")\n .addLocation(Location.builder()\n .city("city")\n .country("country")\n .line1("line1")\n .line2("line2")\n .postalCode("postal_code")\n .state("state")\n .build())\n .primaryEmail("dev@stainless.com")\n .primaryPhoneNumber("primary_phone_number")\n .build();\n CompanyUpdateResponse company = client.sandbox().company().update(params);\n }\n}', - }, - kotlin: { - method: 'sandbox().company().update', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.CompanyUpdateResponse\nimport com.tryfinch.api.models.Location\nimport com.tryfinch.api.models.SandboxCompanyUpdateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val params: SandboxCompanyUpdateParams = SandboxCompanyUpdateParams.builder()\n .addAccount(SandboxCompanyUpdateParams.Account.builder().build())\n .addDepartment(SandboxCompanyUpdateParams.Department.builder().build())\n .ein("ein")\n .entity(SandboxCompanyUpdateParams.Entity.builder().build())\n .legalName("legal_name")\n .addLocation(Location.builder()\n .city("city")\n .country("country")\n .line1("line1")\n .line2("line2")\n .postalCode("postal_code")\n .state("state")\n .build())\n .primaryEmail("dev@stainless.com")\n .primaryPhoneNumber("primary_phone_number")\n .build()\n val company: CompanyUpdateResponse = client.sandbox().company().update(params)\n}', - }, - go: { - method: 'client.Sandbox.Company.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcompany, err := client.Sandbox.Company.Update(context.TODO(), finchgo.SandboxCompanyUpdateParams{\n\t\tAccounts: finchgo.F([]finchgo.SandboxCompanyUpdateParamsAccount{{}}),\n\t\tDepartments: finchgo.F([]finchgo.SandboxCompanyUpdateParamsDepartment{{}}),\n\t\tEin: finchgo.F("ein"),\n\t\tEntity: finchgo.F(finchgo.SandboxCompanyUpdateParamsEntity{}),\n\t\tLegalName: finchgo.F("legal_name"),\n\t\tLocations: finchgo.F([]finchgo.LocationParam{{\n\t\t\tCity: finchgo.F("city"),\n\t\t\tCountry: finchgo.F("country"),\n\t\t\tLine1: finchgo.F("line1"),\n\t\t\tLine2: finchgo.F("line2"),\n\t\t\tPostalCode: finchgo.F("postal_code"),\n\t\t\tState: finchgo.F("state"),\n\t\t}}),\n\t\tPrimaryEmail: finchgo.F("dev@stainless.com"),\n\t\tPrimaryPhoneNumber: finchgo.F("primary_phone_number"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", company.Accounts)\n}\n', - }, - ruby: { - method: 'sandbox.company.update', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\ncompany = finch.sandbox.company.update(\n accounts: [{}],\n departments: [{}],\n ein: "ein",\n entity: {},\n legal_name: "legal_name",\n locations: [\n {city: "city", country: "country", line1: "line1", line2: "line2", postal_code: "postal_code", state: "state"}\n ],\n primary_email: "dev@stainless.com",\n primary_phone_number: "primary_phone_number"\n)\n\nputs(company)', - }, - http: { - example: - 'curl https://api.tryfinch.com/sandbox/company \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "accounts": [\n {}\n ],\n "departments": [\n {}\n ],\n "ein": "ein",\n "entity": {},\n "legal_name": "legal_name",\n "locations": [\n {\n "city": "city",\n "country": "country",\n "line1": "line1",\n "line2": "line2",\n "postal_code": "postal_code",\n "state": "state"\n }\n ],\n "primary_email": "dev@stainless.com",\n "primary_phone_number": "primary_phone_number"\n }\'', - }, - }, + "response": "{ accounts: { account_name?: string; account_number?: string; account_type?: 'checking' | 'savings'; institution_name?: string; routing_number?: string; }[]; departments: { name?: string; parent?: { name?: string; }; }[]; ein: string; entity: { subtype?: 's_corporation' | 'c_corporation' | 'b_corporation'; type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }; legal_name: string; locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]; primary_email: string; primary_phone_number: string; }", + "markdown": "## update\n\n`client.sandbox.company.update(accounts: { account_name?: string; account_number?: string; account_type?: 'checking' | 'savings'; institution_name?: string; routing_number?: string; }[], departments: { name?: string; parent?: { name?: string; }; }[], ein: string, entity: { subtype?: 's_corporation' | 'c_corporation' | 'b_corporation'; type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }, legal_name: string, locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[], primary_email: string, primary_phone_number: string): { accounts: object[]; departments: object[]; ein: string; entity: object; legal_name: string; locations: location[]; primary_email: string; primary_phone_number: string; }`\n\n**put** `/sandbox/company`\n\nUpdate a sandbox company's data\n\n### Parameters\n\n- `accounts: { account_name?: string; account_number?: string; account_type?: 'checking' | 'savings'; institution_name?: string; routing_number?: string; }[]`\n An array of bank account objects associated with the payroll/HRIS system.\n\n- `departments: { name?: string; parent?: { name?: string; }; }[]`\n The array of company departments.\n\n- `ein: string`\n The employer identification number.\n\n- `entity: { subtype?: 's_corporation' | 'c_corporation' | 'b_corporation'; type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }`\n The entity type object.\n - `subtype?: 's_corporation' | 'c_corporation' | 'b_corporation'`\n The tax payer subtype of the company.\n - `type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'`\n The tax payer type of the company.\n\n- `legal_name: string`\n The legal name of the company.\n\n- `locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]`\n\n- `primary_email: string`\n The email of the main administrator on the account.\n\n- `primary_phone_number: string`\n The phone number of the main administrator on the account. Format: E.164, with extension where applicable, e.g. `+NNNNNNNNNNN xExtension`\n\n### Returns\n\n- `{ accounts: { account_name?: string; account_number?: string; account_type?: 'checking' | 'savings'; institution_name?: string; routing_number?: string; }[]; departments: { name?: string; parent?: { name?: string; }; }[]; ein: string; entity: { subtype?: 's_corporation' | 'c_corporation' | 'b_corporation'; type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }; legal_name: string; locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]; primary_email: string; primary_phone_number: string; }`\n\n - `accounts: { account_name?: string; account_number?: string; account_type?: 'checking' | 'savings'; institution_name?: string; routing_number?: string; }[]`\n - `departments: { name?: string; parent?: { name?: string; }; }[]`\n - `ein: string`\n - `entity: { subtype?: 's_corporation' | 'c_corporation' | 'b_corporation'; type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }`\n - `legal_name: string`\n - `locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]`\n - `primary_email: string`\n - `primary_phone_number: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst company = await client.sandbox.company.update({\n accounts: [{}],\n departments: [{}],\n ein: 'ein',\n entity: {},\n legal_name: 'legal_name',\n locations: [{\n city: 'city',\n country: 'country',\n line1: 'line1',\n line2: 'line2',\n postal_code: 'postal_code',\n state: 'state',\n}],\n primary_email: 'dev@stainless.com',\n primary_phone_number: 'primary_phone_number',\n});\n\nconsole.log(company);\n```", + "perLanguage": { + "typescript": { + "method": "client.sandbox.company.update", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst company = await client.sandbox.company.update({\n accounts: [{}],\n departments: [{}],\n ein: 'ein',\n entity: {},\n legal_name: 'legal_name',\n locations: [\n {\n city: 'city',\n country: 'country',\n line1: 'line1',\n line2: 'line2',\n postal_code: 'postal_code',\n state: 'state',\n },\n ],\n primary_email: 'dev@stainless.com',\n primary_phone_number: 'primary_phone_number',\n});\n\nconsole.log(company.accounts);" + }, + "python": { + "method": "sandbox.company.update", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\ncompany = client.sandbox.company.update(\n accounts=[{}],\n departments=[{}],\n ein=\"ein\",\n entity={},\n legal_name=\"legal_name\",\n locations=[{\n \"city\": \"city\",\n \"country\": \"country\",\n \"line1\": \"line1\",\n \"line2\": \"line2\",\n \"postal_code\": \"postal_code\",\n \"state\": \"state\",\n }],\n primary_email=\"dev@stainless.com\",\n primary_phone_number=\"primary_phone_number\",\n)\nprint(company.accounts)" + }, + "java": { + "method": "sandbox().company().update", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.CompanyUpdateResponse;\nimport com.tryfinch.api.models.Location;\nimport com.tryfinch.api.models.SandboxCompanyUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n SandboxCompanyUpdateParams params = SandboxCompanyUpdateParams.builder()\n .addAccount(SandboxCompanyUpdateParams.Account.builder().build())\n .addDepartment(SandboxCompanyUpdateParams.Department.builder().build())\n .ein(\"ein\")\n .entity(SandboxCompanyUpdateParams.Entity.builder().build())\n .legalName(\"legal_name\")\n .addLocation(Location.builder()\n .city(\"city\")\n .country(\"country\")\n .line1(\"line1\")\n .line2(\"line2\")\n .postalCode(\"postal_code\")\n .state(\"state\")\n .build())\n .primaryEmail(\"dev@stainless.com\")\n .primaryPhoneNumber(\"primary_phone_number\")\n .build();\n CompanyUpdateResponse company = client.sandbox().company().update(params);\n }\n}" + }, + "kotlin": { + "method": "sandbox().company().update", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.CompanyUpdateResponse\nimport com.tryfinch.api.models.Location\nimport com.tryfinch.api.models.SandboxCompanyUpdateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val params: SandboxCompanyUpdateParams = SandboxCompanyUpdateParams.builder()\n .addAccount(SandboxCompanyUpdateParams.Account.builder().build())\n .addDepartment(SandboxCompanyUpdateParams.Department.builder().build())\n .ein(\"ein\")\n .entity(SandboxCompanyUpdateParams.Entity.builder().build())\n .legalName(\"legal_name\")\n .addLocation(Location.builder()\n .city(\"city\")\n .country(\"country\")\n .line1(\"line1\")\n .line2(\"line2\")\n .postalCode(\"postal_code\")\n .state(\"state\")\n .build())\n .primaryEmail(\"dev@stainless.com\")\n .primaryPhoneNumber(\"primary_phone_number\")\n .build()\n val company: CompanyUpdateResponse = client.sandbox().company().update(params)\n}" + }, + "go": { + "method": "client.Sandbox.Company.Update", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tcompany, err := client.Sandbox.Company.Update(context.TODO(), finchgo.SandboxCompanyUpdateParams{\n\t\tAccounts: finchgo.F([]finchgo.SandboxCompanyUpdateParamsAccount{{}}),\n\t\tDepartments: finchgo.F([]finchgo.SandboxCompanyUpdateParamsDepartment{{}}),\n\t\tEin: finchgo.F(\"ein\"),\n\t\tEntity: finchgo.F(finchgo.SandboxCompanyUpdateParamsEntity{}),\n\t\tLegalName: finchgo.F(\"legal_name\"),\n\t\tLocations: finchgo.F([]finchgo.LocationParam{{\n\t\t\tCity: finchgo.F(\"city\"),\n\t\t\tCountry: finchgo.F(\"country\"),\n\t\t\tLine1: finchgo.F(\"line1\"),\n\t\t\tLine2: finchgo.F(\"line2\"),\n\t\t\tPostalCode: finchgo.F(\"postal_code\"),\n\t\t\tState: finchgo.F(\"state\"),\n\t\t}}),\n\t\tPrimaryEmail: finchgo.F(\"dev@stainless.com\"),\n\t\tPrimaryPhoneNumber: finchgo.F(\"primary_phone_number\"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", company.Accounts)\n}\n" + }, + "ruby": { + "method": "sandbox.company.update", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\ncompany = finch.sandbox.company.update(\n accounts: [{}],\n departments: [{}],\n ein: \"ein\",\n entity: {},\n legal_name: \"legal_name\",\n locations: [\n {city: \"city\", country: \"country\", line1: \"line1\", line2: \"line2\", postal_code: \"postal_code\", state: \"state\"}\n ],\n primary_email: \"dev@stainless.com\",\n primary_phone_number: \"primary_phone_number\"\n)\n\nputs(company)" + }, + "http": { + "example": "curl https://api.tryfinch.com/sandbox/company \\\n -X PUT \\\n -H 'Content-Type: application/json' \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{\n \"accounts\": [\n {}\n ],\n \"departments\": [\n {}\n ],\n \"ein\": \"ein\",\n \"entity\": {},\n \"legal_name\": \"legal_name\",\n \"locations\": [\n {\n \"city\": \"city\",\n \"country\": \"country\",\n \"line1\": \"line1\",\n \"line2\": \"line2\",\n \"postal_code\": \"postal_code\",\n \"state\": \"state\"\n }\n ],\n \"primary_email\": \"dev@stainless.com\",\n \"primary_phone_number\": \"primary_phone_number\"\n }'" + } + } }, { - name: 'create', - endpoint: '/sandbox/directory', - httpMethod: 'post', - summary: 'Add new individuals to a sandbox company', - description: 'Add new individuals to a sandbox company', - stainlessPath: '(resource) sandbox.directory > (method) create', - qualified: 'client.sandbox.directory.create', - params: [ - "body?: { class_code?: string; custom_fields?: { name?: string; value?: object; }[]; department?: { name?: string; }; dob?: string; emails?: { data?: string; type?: 'work' | 'personal'; }[]; employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }; employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; encrypted_ssn?: string; end_date?: string; ethnicity?: string; first_name?: string; flsa_status?: 'exempt' | 'non_exempt' | 'unknown'; gender?: 'female' | 'male' | 'other' | 'decline_to_specify'; income?: { amount: number; currency: string; effective_date: string; unit: string; }; income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]; is_active?: boolean; last_name?: string; latest_rehire_date?: string; location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; manager?: { id?: string; }; middle_name?: string; phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]; preferred_name?: string; residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; source_id?: string; ssn?: string; start_date?: string; title?: string; }[];", + "name": "create", + "endpoint": "/sandbox/directory", + "httpMethod": "post", + "summary": "Add new individuals to a sandbox company", + "description": "Add new individuals to a sandbox company", + "stainlessPath": "(resource) sandbox.directory > (method) create", + "qualified": "client.sandbox.directory.create", + "params": [ + "body?: { class_code?: string; custom_fields?: { name?: string; value?: object; }[]; department?: { name?: string; }; dob?: string; emails?: { data?: string; type?: 'work' | 'personal'; }[]; employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }; employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; encrypted_ssn?: string; end_date?: string; ethnicity?: string; first_name?: string; flsa_status?: 'exempt' | 'non_exempt' | 'unknown'; gender?: 'female' | 'male' | 'other' | 'decline_to_specify'; income?: { amount: number; currency: string; effective_date: string; unit: string; }; income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]; is_active?: boolean; last_name?: string; latest_rehire_date?: string; location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; manager?: { id?: string; }; middle_name?: string; phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]; preferred_name?: string; residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; source_id?: string; ssn?: string; start_date?: string; title?: string; }[];" ], - response: 'object[]', - markdown: - "## create\n\n`client.sandbox.directory.create(body?: { class_code?: string; custom_fields?: { name?: string; value?: object; }[]; department?: { name?: string; }; dob?: string; emails?: { data?: string; type?: 'work' | 'personal'; }[]; employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }; employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; encrypted_ssn?: string; end_date?: string; ethnicity?: string; first_name?: string; flsa_status?: 'exempt' | 'non_exempt' | 'unknown'; gender?: 'female' | 'male' | 'other' | 'decline_to_specify'; income?: object; income_history?: object[]; is_active?: boolean; last_name?: string; latest_rehire_date?: string; location?: object; manager?: { id?: string; }; middle_name?: string; phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]; preferred_name?: string; residence?: object; source_id?: string; ssn?: string; start_date?: string; title?: string; }[]): object[]`\n\n**post** `/sandbox/directory`\n\nAdd new individuals to a sandbox company\n\n### Parameters\n\n- `body?: { class_code?: string; custom_fields?: { name?: string; value?: object; }[]; department?: { name?: string; }; dob?: string; emails?: { data?: string; type?: 'work' | 'personal'; }[]; employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }; employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; encrypted_ssn?: string; end_date?: string; ethnicity?: string; first_name?: string; flsa_status?: 'exempt' | 'non_exempt' | 'unknown'; gender?: 'female' | 'male' | 'other' | 'decline_to_specify'; income?: { amount: number; currency: string; effective_date: string; unit: string; }; income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]; is_active?: boolean; last_name?: string; latest_rehire_date?: string; location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; manager?: { id?: string; }; middle_name?: string; phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]; preferred_name?: string; residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; source_id?: string; ssn?: string; start_date?: string; title?: string; }[]`\n Array of individuals to create. Takes all combined fields from `/individual` and `/employment` endpoints. All fields are optional.\n\n### Returns\n\n- `object[]`\n The individuals which were created\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst directories = await client.sandbox.directory.create();\n\nconsole.log(directories);\n```", - perLanguage: { - typescript: { - method: 'client.sandbox.directory.create', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst directories = await client.sandbox.directory.create();\n\nconsole.log(directories);", - }, - python: { - method: 'sandbox.directory.create', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\ndirectories = client.sandbox.directory.create()\nprint(directories)', - }, - java: { - method: 'sandbox().directory().create', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.DirectoryCreateResponse;\nimport com.tryfinch.api.models.SandboxDirectoryCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n List directories = client.sandbox().directory().create();\n }\n}', - }, - kotlin: { - method: 'sandbox().directory().create', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.DirectoryCreateResponse\nimport com.tryfinch.api.models.SandboxDirectoryCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val directories: List = client.sandbox().directory().create()\n}', - }, - go: { - method: 'client.Sandbox.Directory.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tdirectories, err := client.Sandbox.Directory.New(context.TODO(), finchgo.SandboxDirectoryNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", directories)\n}\n', - }, - ruby: { - method: 'sandbox.directory.create', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\ndirectories = finch.sandbox.directory.create\n\nputs(directories)', - }, - http: { - example: - 'curl https://api.tryfinch.com/sandbox/directory \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "response": "object[]", + "markdown": "## create\n\n`client.sandbox.directory.create(body?: { class_code?: string; custom_fields?: { name?: string; value?: object; }[]; department?: { name?: string; }; dob?: string; emails?: { data?: string; type?: 'work' | 'personal'; }[]; employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }; employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; encrypted_ssn?: string; end_date?: string; ethnicity?: string; first_name?: string; flsa_status?: 'exempt' | 'non_exempt' | 'unknown'; gender?: 'female' | 'male' | 'other' | 'decline_to_specify'; income?: object; income_history?: object[]; is_active?: boolean; last_name?: string; latest_rehire_date?: string; location?: object; manager?: { id?: string; }; middle_name?: string; phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]; preferred_name?: string; residence?: object; source_id?: string; ssn?: string; start_date?: string; title?: string; }[]): object[]`\n\n**post** `/sandbox/directory`\n\nAdd new individuals to a sandbox company\n\n### Parameters\n\n- `body?: { class_code?: string; custom_fields?: { name?: string; value?: object; }[]; department?: { name?: string; }; dob?: string; emails?: { data?: string; type?: 'work' | 'personal'; }[]; employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }; employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; encrypted_ssn?: string; end_date?: string; ethnicity?: string; first_name?: string; flsa_status?: 'exempt' | 'non_exempt' | 'unknown'; gender?: 'female' | 'male' | 'other' | 'decline_to_specify'; income?: { amount: number; currency: string; effective_date: string; unit: string; }; income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]; is_active?: boolean; last_name?: string; latest_rehire_date?: string; location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; manager?: { id?: string; }; middle_name?: string; phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]; preferred_name?: string; residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; source_id?: string; ssn?: string; start_date?: string; title?: string; }[]`\n Array of individuals to create. Takes all combined fields from `/individual` and `/employment` endpoints. All fields are optional.\n\n### Returns\n\n- `object[]`\n The individuals which were created\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst directories = await client.sandbox.directory.create();\n\nconsole.log(directories);\n```", + "perLanguage": { + "typescript": { + "method": "client.sandbox.directory.create", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst directories = await client.sandbox.directory.create();\n\nconsole.log(directories);" + }, + "python": { + "method": "sandbox.directory.create", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\ndirectories = client.sandbox.directory.create()\nprint(directories)" + }, + "java": { + "method": "sandbox().directory().create", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.DirectoryCreateResponse;\nimport com.tryfinch.api.models.SandboxDirectoryCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n List directories = client.sandbox().directory().create();\n }\n}" + }, + "kotlin": { + "method": "sandbox().directory().create", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.DirectoryCreateResponse\nimport com.tryfinch.api.models.SandboxDirectoryCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val directories: List = client.sandbox().directory().create()\n}" + }, + "go": { + "method": "client.Sandbox.Directory.New", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tdirectories, err := client.Sandbox.Directory.New(context.TODO(), finchgo.SandboxDirectoryNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", directories)\n}\n" + }, + "ruby": { + "method": "sandbox.directory.create", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\ndirectories = finch.sandbox.directory.create\n\nputs(directories)" + }, + "http": { + "example": "curl https://api.tryfinch.com/sandbox/directory \\\n -X POST \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'update', - endpoint: '/sandbox/individual/{individual_id}', - httpMethod: 'put', - summary: 'Update sandbox individual', - description: 'Update sandbox individual', - stainlessPath: '(resource) sandbox.individual > (method) update', - qualified: 'client.sandbox.individual.update', - params: [ - 'individual_id: string;', - 'dob?: string;', + "name": "update", + "endpoint": "/sandbox/individual/{individual_id}", + "httpMethod": "put", + "summary": "Update sandbox individual", + "description": "Update sandbox individual", + "stainlessPath": "(resource) sandbox.individual > (method) update", + "qualified": "client.sandbox.individual.update", + "params": [ + "individual_id: string;", + "dob?: string;", "emails?: { data?: string; type?: 'work' | 'personal'; }[];", - 'encrypted_ssn?: string;', - 'ethnicity?: string;', - 'first_name?: string;', + "encrypted_ssn?: string;", + "ethnicity?: string;", + "first_name?: string;", "gender?: 'female' | 'male' | 'other' | 'decline_to_specify';", - 'last_name?: string;', - 'middle_name?: string;', + "last_name?: string;", + "middle_name?: string;", "phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[];", - 'preferred_name?: string;', - 'residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; };', - 'ssn?: string;', + "preferred_name?: string;", + "residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; };", + "ssn?: string;" ], - response: - "{ id?: string; dob?: string; emails?: { data?: string; type?: 'work' | 'personal'; }[]; encrypted_ssn?: string; ethnicity?: string; first_name?: string; gender?: 'female' | 'male' | 'other' | 'decline_to_specify'; last_name?: string; middle_name?: string; phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]; preferred_name?: string; residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; ssn?: string; }", - markdown: - "## update\n\n`client.sandbox.individual.update(individual_id: string, dob?: string, emails?: { data?: string; type?: 'work' | 'personal'; }[], encrypted_ssn?: string, ethnicity?: string, first_name?: string, gender?: 'female' | 'male' | 'other' | 'decline_to_specify', last_name?: string, middle_name?: string, phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[], preferred_name?: string, residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }, ssn?: string): { id?: string; dob?: string; emails?: object[]; encrypted_ssn?: string; ethnicity?: string; first_name?: string; gender?: 'female' | 'male' | 'other' | 'decline_to_specify'; last_name?: string; middle_name?: string; phone_numbers?: object[]; preferred_name?: string; residence?: location; ssn?: string; }`\n\n**put** `/sandbox/individual/{individual_id}`\n\nUpdate sandbox individual\n\n### Parameters\n\n- `individual_id: string`\n\n- `dob?: string`\n\n- `emails?: { data?: string; type?: 'work' | 'personal'; }[]`\n\n- `encrypted_ssn?: string`\n Social Security Number of the individual in **encrypted** format. This field is only available with the `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the body.\n\n- `ethnicity?: string`\n The EEOC-defined ethnicity of the individual.\n\n- `first_name?: string`\n The legal first name of the individual.\n\n- `gender?: 'female' | 'male' | 'other' | 'decline_to_specify'`\n The gender of the individual.\n\n- `last_name?: string`\n The legal last name of the individual.\n\n- `middle_name?: string`\n The legal middle name of the individual.\n\n- `phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]`\n\n- `preferred_name?: string`\n The preferred name of the individual.\n\n- `residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }`\n - `city: string`\n City, district, suburb, town, or village.\n - `country: string`\n The 2-letter ISO 3166 country code.\n - `line1: string`\n Street address or PO box.\n - `line2: string`\n Apartment, suite, unit, or building.\n - `postal_code: string`\n The postal code or zip code.\n - `state: string`\n The state code.\n - `name?: string`\n - `source_id?: string`\n\n- `ssn?: string`\n Social Security Number of the individual. This field is only available with the `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the body. [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).\n\n### Returns\n\n- `{ id?: string; dob?: string; emails?: { data?: string; type?: 'work' | 'personal'; }[]; encrypted_ssn?: string; ethnicity?: string; first_name?: string; gender?: 'female' | 'male' | 'other' | 'decline_to_specify'; last_name?: string; middle_name?: string; phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]; preferred_name?: string; residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; ssn?: string; }`\n\n - `id?: string`\n - `dob?: string`\n - `emails?: { data?: string; type?: 'work' | 'personal'; }[]`\n - `encrypted_ssn?: string`\n - `ethnicity?: string`\n - `first_name?: string`\n - `gender?: 'female' | 'male' | 'other' | 'decline_to_specify'`\n - `last_name?: string`\n - `middle_name?: string`\n - `phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]`\n - `preferred_name?: string`\n - `residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }`\n - `ssn?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst individual = await client.sandbox.individual.update('individual_id');\n\nconsole.log(individual);\n```", - perLanguage: { - typescript: { - method: 'client.sandbox.individual.update', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst individual = await client.sandbox.individual.update('individual_id');\n\nconsole.log(individual.id);", - }, - python: { - method: 'sandbox.individual.update', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nindividual = client.sandbox.individual.update(\n individual_id="individual_id",\n)\nprint(individual.id)', - }, - java: { - method: 'sandbox().individual().update', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.IndividualUpdateResponse;\nimport com.tryfinch.api.models.SandboxIndividualUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n IndividualUpdateResponse individual = client.sandbox().individual().update("individual_id");\n }\n}', - }, - kotlin: { - method: 'sandbox().individual().update', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.IndividualUpdateResponse\nimport com.tryfinch.api.models.SandboxIndividualUpdateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val individual: IndividualUpdateResponse = client.sandbox().individual().update("individual_id")\n}', - }, - go: { - method: 'client.Sandbox.Individual.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tindividual, err := client.Sandbox.Individual.Update(\n\t\tcontext.TODO(),\n\t\t"individual_id",\n\t\tfinchgo.SandboxIndividualUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", individual.ID)\n}\n', - }, - ruby: { - method: 'sandbox.individual.update', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nindividual = finch.sandbox.individual.update("individual_id")\n\nputs(individual)', - }, - http: { - example: - 'curl https://api.tryfinch.com/sandbox/individual/$INDIVIDUAL_ID \\\n -X PUT \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "response": "{ id?: string; dob?: string; emails?: { data?: string; type?: 'work' | 'personal'; }[]; encrypted_ssn?: string; ethnicity?: string; first_name?: string; gender?: 'female' | 'male' | 'other' | 'decline_to_specify'; last_name?: string; middle_name?: string; phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]; preferred_name?: string; residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; ssn?: string; }", + "markdown": "## update\n\n`client.sandbox.individual.update(individual_id: string, dob?: string, emails?: { data?: string; type?: 'work' | 'personal'; }[], encrypted_ssn?: string, ethnicity?: string, first_name?: string, gender?: 'female' | 'male' | 'other' | 'decline_to_specify', last_name?: string, middle_name?: string, phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[], preferred_name?: string, residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }, ssn?: string): { id?: string; dob?: string; emails?: object[]; encrypted_ssn?: string; ethnicity?: string; first_name?: string; gender?: 'female' | 'male' | 'other' | 'decline_to_specify'; last_name?: string; middle_name?: string; phone_numbers?: object[]; preferred_name?: string; residence?: location; ssn?: string; }`\n\n**put** `/sandbox/individual/{individual_id}`\n\nUpdate sandbox individual\n\n### Parameters\n\n- `individual_id: string`\n\n- `dob?: string`\n\n- `emails?: { data?: string; type?: 'work' | 'personal'; }[]`\n\n- `encrypted_ssn?: string`\n Social Security Number of the individual in **encrypted** format. This field is only available with the `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the body.\n\n- `ethnicity?: string`\n The EEOC-defined ethnicity of the individual.\n\n- `first_name?: string`\n The legal first name of the individual.\n\n- `gender?: 'female' | 'male' | 'other' | 'decline_to_specify'`\n The gender of the individual.\n\n- `last_name?: string`\n The legal last name of the individual.\n\n- `middle_name?: string`\n The legal middle name of the individual.\n\n- `phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]`\n\n- `preferred_name?: string`\n The preferred name of the individual.\n\n- `residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }`\n - `city: string`\n City, district, suburb, town, or village.\n - `country: string`\n The 2-letter ISO 3166 country code.\n - `line1: string`\n Street address or PO box.\n - `line2: string`\n Apartment, suite, unit, or building.\n - `postal_code: string`\n The postal code or zip code.\n - `state: string`\n The state code.\n - `name?: string`\n - `source_id?: string`\n\n- `ssn?: string`\n Social Security Number of the individual. This field is only available with the `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the body. [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).\n\n### Returns\n\n- `{ id?: string; dob?: string; emails?: { data?: string; type?: 'work' | 'personal'; }[]; encrypted_ssn?: string; ethnicity?: string; first_name?: string; gender?: 'female' | 'male' | 'other' | 'decline_to_specify'; last_name?: string; middle_name?: string; phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]; preferred_name?: string; residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; ssn?: string; }`\n\n - `id?: string`\n - `dob?: string`\n - `emails?: { data?: string; type?: 'work' | 'personal'; }[]`\n - `encrypted_ssn?: string`\n - `ethnicity?: string`\n - `first_name?: string`\n - `gender?: 'female' | 'male' | 'other' | 'decline_to_specify'`\n - `last_name?: string`\n - `middle_name?: string`\n - `phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]`\n - `preferred_name?: string`\n - `residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }`\n - `ssn?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst individual = await client.sandbox.individual.update('individual_id');\n\nconsole.log(individual);\n```", + "perLanguage": { + "typescript": { + "method": "client.sandbox.individual.update", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst individual = await client.sandbox.individual.update('individual_id');\n\nconsole.log(individual.id);" + }, + "python": { + "method": "sandbox.individual.update", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nindividual = client.sandbox.individual.update(\n individual_id=\"individual_id\",\n)\nprint(individual.id)" + }, + "java": { + "method": "sandbox().individual().update", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.IndividualUpdateResponse;\nimport com.tryfinch.api.models.SandboxIndividualUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n IndividualUpdateResponse individual = client.sandbox().individual().update(\"individual_id\");\n }\n}" + }, + "kotlin": { + "method": "sandbox().individual().update", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.IndividualUpdateResponse\nimport com.tryfinch.api.models.SandboxIndividualUpdateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val individual: IndividualUpdateResponse = client.sandbox().individual().update(\"individual_id\")\n}" + }, + "go": { + "method": "client.Sandbox.Individual.Update", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tindividual, err := client.Sandbox.Individual.Update(\n\t\tcontext.TODO(),\n\t\t\"individual_id\",\n\t\tfinchgo.SandboxIndividualUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", individual.ID)\n}\n" + }, + "ruby": { + "method": "sandbox.individual.update", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nindividual = finch.sandbox.individual.update(\"individual_id\")\n\nputs(individual)" + }, + "http": { + "example": "curl https://api.tryfinch.com/sandbox/individual/$INDIVIDUAL_ID \\\n -X PUT \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'update', - endpoint: '/sandbox/employment/{individual_id}', - httpMethod: 'put', - summary: 'Update sandbox employment', - description: 'Update sandbox employment', - stainlessPath: '(resource) sandbox.employment > (method) update', - qualified: 'client.sandbox.employment.update', - params: [ - 'individual_id: string;', - 'class_code?: string;', - 'custom_fields?: { name?: string; value?: object; }[];', - 'department?: { name?: string; };', + "name": "update", + "endpoint": "/sandbox/employment/{individual_id}", + "httpMethod": "put", + "summary": "Update sandbox employment", + "description": "Update sandbox employment", + "stainlessPath": "(resource) sandbox.employment > (method) update", + "qualified": "client.sandbox.employment.update", + "params": [ + "individual_id: string;", + "class_code?: string;", + "custom_fields?: { name?: string; value?: object; }[];", + "department?: { name?: string; };", "employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; };", "employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated';", - 'end_date?: string;', - 'first_name?: string;', + "end_date?: string;", + "first_name?: string;", "flsa_status?: 'exempt' | 'non_exempt' | 'unknown';", - 'income?: { amount: number; currency: string; effective_date: string; unit: string; };', - 'income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[];', - 'is_active?: boolean;', - 'last_name?: string;', - 'latest_rehire_date?: string;', - 'location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; };', - 'manager?: { id?: string; };', - 'middle_name?: string;', - 'source_id?: string;', - 'start_date?: string;', - 'title?: string;', + "income?: { amount: number; currency: string; effective_date: string; unit: string; };", + "income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[];", + "is_active?: boolean;", + "last_name?: string;", + "latest_rehire_date?: string;", + "location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; };", + "manager?: { id?: string; };", + "middle_name?: string;", + "source_id?: string;", + "start_date?: string;", + "title?: string;" ], - response: - "{ id?: string; class_code?: string; custom_fields?: { name?: string; value?: object; }[]; department?: { name?: string; }; employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }; employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; end_date?: string; first_name?: string; flsa_status?: 'exempt' | 'non_exempt' | 'unknown'; income?: { amount: number; currency: string; effective_date: string; unit: string; }; income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]; is_active?: boolean; last_name?: string; latest_rehire_date?: string; location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; manager?: { id?: string; }; middle_name?: string; source_id?: string; start_date?: string; title?: string; }", - markdown: - "## update\n\n`client.sandbox.employment.update(individual_id: string, class_code?: string, custom_fields?: { name?: string; value?: object; }[], department?: { name?: string; }, employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }, employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated', end_date?: string, first_name?: string, flsa_status?: 'exempt' | 'non_exempt' | 'unknown', income?: { amount: number; currency: string; effective_date: string; unit: string; }, income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[], is_active?: boolean, last_name?: string, latest_rehire_date?: string, location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }, manager?: { id?: string; }, middle_name?: string, source_id?: string, start_date?: string, title?: string): { id?: string; class_code?: string; custom_fields?: object[]; department?: object; employment?: object; employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; end_date?: string; first_name?: string; flsa_status?: 'exempt' | 'non_exempt' | 'unknown'; income?: income; income_history?: income[]; is_active?: boolean; last_name?: string; latest_rehire_date?: string; location?: location; manager?: object; middle_name?: string; source_id?: string; start_date?: string; title?: string; }`\n\n**put** `/sandbox/employment/{individual_id}`\n\nUpdate sandbox employment\n\n### Parameters\n\n- `individual_id: string`\n\n- `class_code?: string`\n Worker's compensation classification code for this employee\n\n- `custom_fields?: { name?: string; value?: object; }[]`\n Custom fields for the individual. These are fields which are defined by the employer in the system. Custom fields are not currently supported for assisted connections.\n\n- `department?: { name?: string; }`\n The department object.\n - `name?: string`\n The name of the department associated with the individual.\n\n- `employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }`\n The employment object.\n - `subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'`\n The secondary employment type of the individual. Options: `full_time`, `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.\n - `type?: 'employee' | 'contractor'`\n The main employment type of the individual.\n\n- `employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'`\n The detailed employment status of the individual.\n\n- `end_date?: string`\n\n- `first_name?: string`\n The legal first name of the individual.\n\n- `flsa_status?: 'exempt' | 'non_exempt' | 'unknown'`\n The FLSA status of the individual. Available options: `exempt`, `non_exempt`, `unknown`.\n\n- `income?: { amount: number; currency: string; effective_date: string; unit: string; }`\n The employee's income as reported by the provider. This may not always be annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, depending on what information the provider returns.\n - `amount: number`\n The income amount in cents.\n - `currency: string`\n The currency code.\n - `effective_date: string`\n The date the income amount went into effect.\n - `unit: string`\n The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`.\n\n- `income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]`\n The array of income history.\n\n- `is_active?: boolean`\n `true` if the individual an an active employee or contractor at the company.\n\n- `last_name?: string`\n The legal last name of the individual.\n\n- `latest_rehire_date?: string`\n\n- `location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }`\n - `city: string`\n City, district, suburb, town, or village.\n - `country: string`\n The 2-letter ISO 3166 country code.\n - `line1: string`\n Street address or PO box.\n - `line2: string`\n Apartment, suite, unit, or building.\n - `postal_code: string`\n The postal code or zip code.\n - `state: string`\n The state code.\n - `name?: string`\n - `source_id?: string`\n\n- `manager?: { id?: string; }`\n The manager object representing the manager of the individual within the org.\n - `id?: string`\n A stable Finch `id` (UUID v4) for an individual in the company.\n\n- `middle_name?: string`\n The legal middle name of the individual.\n\n- `source_id?: string`\n The source system's unique employment identifier for this individual\n\n- `start_date?: string`\n\n- `title?: string`\n The current title of the individual.\n\n### Returns\n\n- `{ id?: string; class_code?: string; custom_fields?: { name?: string; value?: object; }[]; department?: { name?: string; }; employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }; employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; end_date?: string; first_name?: string; flsa_status?: 'exempt' | 'non_exempt' | 'unknown'; income?: { amount: number; currency: string; effective_date: string; unit: string; }; income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]; is_active?: boolean; last_name?: string; latest_rehire_date?: string; location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; manager?: { id?: string; }; middle_name?: string; source_id?: string; start_date?: string; title?: string; }`\n\n - `id?: string`\n - `class_code?: string`\n - `custom_fields?: { name?: string; value?: object; }[]`\n - `department?: { name?: string; }`\n - `employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }`\n - `employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'`\n - `end_date?: string`\n - `first_name?: string`\n - `flsa_status?: 'exempt' | 'non_exempt' | 'unknown'`\n - `income?: { amount: number; currency: string; effective_date: string; unit: string; }`\n - `income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]`\n - `is_active?: boolean`\n - `last_name?: string`\n - `latest_rehire_date?: string`\n - `location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }`\n - `manager?: { id?: string; }`\n - `middle_name?: string`\n - `source_id?: string`\n - `start_date?: string`\n - `title?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst employment = await client.sandbox.employment.update('individual_id');\n\nconsole.log(employment);\n```", - perLanguage: { - typescript: { - method: 'client.sandbox.employment.update', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst employment = await client.sandbox.employment.update('individual_id');\n\nconsole.log(employment.id);", - }, - python: { - method: 'sandbox.employment.update', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nemployment = client.sandbox.employment.update(\n individual_id="individual_id",\n)\nprint(employment.id)', - }, - java: { - method: 'sandbox().employment().update', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.EmploymentUpdateResponse;\nimport com.tryfinch.api.models.SandboxEmploymentUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EmploymentUpdateResponse employment = client.sandbox().employment().update("individual_id");\n }\n}', - }, - kotlin: { - method: 'sandbox().employment().update', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.EmploymentUpdateResponse\nimport com.tryfinch.api.models.SandboxEmploymentUpdateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val employment: EmploymentUpdateResponse = client.sandbox().employment().update("individual_id")\n}', - }, - go: { - method: 'client.Sandbox.Employment.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\temployment, err := client.Sandbox.Employment.Update(\n\t\tcontext.TODO(),\n\t\t"individual_id",\n\t\tfinchgo.SandboxEmploymentUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", employment.ID)\n}\n', - }, - ruby: { - method: 'sandbox.employment.update', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nemployment = finch.sandbox.employment.update("individual_id")\n\nputs(employment)', - }, - http: { - example: - 'curl https://api.tryfinch.com/sandbox/employment/$INDIVIDUAL_ID \\\n -X PUT \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "response": "{ id?: string; class_code?: string; custom_fields?: { name?: string; value?: object; }[]; department?: { name?: string; }; employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }; employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; end_date?: string; first_name?: string; flsa_status?: 'exempt' | 'non_exempt' | 'unknown'; income?: { amount: number; currency: string; effective_date: string; unit: string; }; income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]; is_active?: boolean; last_name?: string; latest_rehire_date?: string; location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; manager?: { id?: string; }; middle_name?: string; source_id?: string; start_date?: string; title?: string; }", + "markdown": "## update\n\n`client.sandbox.employment.update(individual_id: string, class_code?: string, custom_fields?: { name?: string; value?: object; }[], department?: { name?: string; }, employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }, employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated', end_date?: string, first_name?: string, flsa_status?: 'exempt' | 'non_exempt' | 'unknown', income?: { amount: number; currency: string; effective_date: string; unit: string; }, income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[], is_active?: boolean, last_name?: string, latest_rehire_date?: string, location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }, manager?: { id?: string; }, middle_name?: string, source_id?: string, start_date?: string, title?: string): { id?: string; class_code?: string; custom_fields?: object[]; department?: object; employment?: object; employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; end_date?: string; first_name?: string; flsa_status?: 'exempt' | 'non_exempt' | 'unknown'; income?: income; income_history?: income[]; is_active?: boolean; last_name?: string; latest_rehire_date?: string; location?: location; manager?: object; middle_name?: string; source_id?: string; start_date?: string; title?: string; }`\n\n**put** `/sandbox/employment/{individual_id}`\n\nUpdate sandbox employment\n\n### Parameters\n\n- `individual_id: string`\n\n- `class_code?: string`\n Worker's compensation classification code for this employee\n\n- `custom_fields?: { name?: string; value?: object; }[]`\n Custom fields for the individual. These are fields which are defined by the employer in the system. Custom fields are not currently supported for assisted connections.\n\n- `department?: { name?: string; }`\n The department object.\n - `name?: string`\n The name of the department associated with the individual.\n\n- `employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }`\n The employment object.\n - `subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'`\n The secondary employment type of the individual. Options: `full_time`, `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.\n - `type?: 'employee' | 'contractor'`\n The main employment type of the individual.\n\n- `employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'`\n The detailed employment status of the individual.\n\n- `end_date?: string`\n\n- `first_name?: string`\n The legal first name of the individual.\n\n- `flsa_status?: 'exempt' | 'non_exempt' | 'unknown'`\n The FLSA status of the individual. Available options: `exempt`, `non_exempt`, `unknown`.\n\n- `income?: { amount: number; currency: string; effective_date: string; unit: string; }`\n The employee's income as reported by the provider. This may not always be annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, depending on what information the provider returns.\n - `amount: number`\n The income amount in cents.\n - `currency: string`\n The currency code.\n - `effective_date: string`\n The date the income amount went into effect.\n - `unit: string`\n The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`.\n\n- `income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]`\n The array of income history.\n\n- `is_active?: boolean`\n `true` if the individual an an active employee or contractor at the company.\n\n- `last_name?: string`\n The legal last name of the individual.\n\n- `latest_rehire_date?: string`\n\n- `location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }`\n - `city: string`\n City, district, suburb, town, or village.\n - `country: string`\n The 2-letter ISO 3166 country code.\n - `line1: string`\n Street address or PO box.\n - `line2: string`\n Apartment, suite, unit, or building.\n - `postal_code: string`\n The postal code or zip code.\n - `state: string`\n The state code.\n - `name?: string`\n - `source_id?: string`\n\n- `manager?: { id?: string; }`\n The manager object representing the manager of the individual within the org.\n - `id?: string`\n A stable Finch `id` (UUID v4) for an individual in the company.\n\n- `middle_name?: string`\n The legal middle name of the individual.\n\n- `source_id?: string`\n The source system's unique employment identifier for this individual\n\n- `start_date?: string`\n\n- `title?: string`\n The current title of the individual.\n\n### Returns\n\n- `{ id?: string; class_code?: string; custom_fields?: { name?: string; value?: object; }[]; department?: { name?: string; }; employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }; employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; end_date?: string; first_name?: string; flsa_status?: 'exempt' | 'non_exempt' | 'unknown'; income?: { amount: number; currency: string; effective_date: string; unit: string; }; income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]; is_active?: boolean; last_name?: string; latest_rehire_date?: string; location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; manager?: { id?: string; }; middle_name?: string; source_id?: string; start_date?: string; title?: string; }`\n\n - `id?: string`\n - `class_code?: string`\n - `custom_fields?: { name?: string; value?: object; }[]`\n - `department?: { name?: string; }`\n - `employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }`\n - `employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'`\n - `end_date?: string`\n - `first_name?: string`\n - `flsa_status?: 'exempt' | 'non_exempt' | 'unknown'`\n - `income?: { amount: number; currency: string; effective_date: string; unit: string; }`\n - `income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]`\n - `is_active?: boolean`\n - `last_name?: string`\n - `latest_rehire_date?: string`\n - `location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }`\n - `manager?: { id?: string; }`\n - `middle_name?: string`\n - `source_id?: string`\n - `start_date?: string`\n - `title?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst employment = await client.sandbox.employment.update('individual_id');\n\nconsole.log(employment);\n```", + "perLanguage": { + "typescript": { + "method": "client.sandbox.employment.update", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst employment = await client.sandbox.employment.update('individual_id');\n\nconsole.log(employment.id);" + }, + "python": { + "method": "sandbox.employment.update", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nemployment = client.sandbox.employment.update(\n individual_id=\"individual_id\",\n)\nprint(employment.id)" + }, + "java": { + "method": "sandbox().employment().update", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.EmploymentUpdateResponse;\nimport com.tryfinch.api.models.SandboxEmploymentUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n EmploymentUpdateResponse employment = client.sandbox().employment().update(\"individual_id\");\n }\n}" + }, + "kotlin": { + "method": "sandbox().employment().update", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.EmploymentUpdateResponse\nimport com.tryfinch.api.models.SandboxEmploymentUpdateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val employment: EmploymentUpdateResponse = client.sandbox().employment().update(\"individual_id\")\n}" + }, + "go": { + "method": "client.Sandbox.Employment.Update", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\temployment, err := client.Sandbox.Employment.Update(\n\t\tcontext.TODO(),\n\t\t\"individual_id\",\n\t\tfinchgo.SandboxEmploymentUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", employment.ID)\n}\n" + }, + "ruby": { + "method": "sandbox.employment.update", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nemployment = finch.sandbox.employment.update(\"individual_id\")\n\nputs(employment)" + }, + "http": { + "example": "curl https://api.tryfinch.com/sandbox/employment/$INDIVIDUAL_ID \\\n -X PUT \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'create', - endpoint: '/sandbox/payment', - httpMethod: 'post', - summary: 'Add a new sandbox payment', - description: 'Add a new sandbox payment', - stainlessPath: '(resource) sandbox.payment > (method) create', - qualified: 'client.sandbox.payment.create', - params: [ - 'end_date?: string;', + "name": "create", + "endpoint": "/sandbox/payment", + "httpMethod": "post", + "summary": "Add a new sandbox payment", + "description": "Add a new sandbox payment", + "stainlessPath": "(resource) sandbox.payment > (method) create", + "qualified": "client.sandbox.payment.create", + "params": [ + "end_date?: string;", "pay_statements?: { individual_id: string; earnings?: { amount?: number; hours?: number; name?: string; type?: string; }[]; employee_deductions?: { amount?: number; name?: string; pre_tax?: boolean; type?: string; }[]; employer_contributions?: { amount?: number; name?: string; type?: string; }[]; gross_pay?: number; net_pay?: number; payment_method?: 'check' | 'direct_deposit' | 'other'; taxes?: { amount?: number; employer?: boolean; name?: string; type?: 'federal' | 'fica' | 'local' | 'state'; }[]; total_hours?: number; type?: 'off_cycle_payroll' | 'one_time_payment' | 'regular_payroll'; }[];", - 'start_date?: string;', + "start_date?: string;" ], - response: '{ pay_date: string; payment_id: string; }', - markdown: - "## create\n\n`client.sandbox.payment.create(end_date?: string, pay_statements?: { individual_id: string; earnings?: { amount?: number; hours?: number; name?: string; type?: string; }[]; employee_deductions?: { amount?: number; name?: string; pre_tax?: boolean; type?: string; }[]; employer_contributions?: { amount?: number; name?: string; type?: string; }[]; gross_pay?: number; net_pay?: number; payment_method?: 'check' | 'direct_deposit' | 'other'; taxes?: { amount?: number; employer?: boolean; name?: string; type?: 'federal' | 'fica' | 'local' | 'state'; }[]; total_hours?: number; type?: 'off_cycle_payroll' | 'one_time_payment' | 'regular_payroll'; }[], start_date?: string): { pay_date: string; payment_id: string; }`\n\n**post** `/sandbox/payment`\n\nAdd a new sandbox payment\n\n### Parameters\n\n- `end_date?: string`\n\n- `pay_statements?: { individual_id: string; earnings?: { amount?: number; hours?: number; name?: string; type?: string; }[]; employee_deductions?: { amount?: number; name?: string; pre_tax?: boolean; type?: string; }[]; employer_contributions?: { amount?: number; name?: string; type?: string; }[]; gross_pay?: number; net_pay?: number; payment_method?: 'check' | 'direct_deposit' | 'other'; taxes?: { amount?: number; employer?: boolean; name?: string; type?: 'federal' | 'fica' | 'local' | 'state'; }[]; total_hours?: number; type?: 'off_cycle_payroll' | 'one_time_payment' | 'regular_payroll'; }[]`\n Array of pay statements to include in the payment.\n\n- `start_date?: string`\n\n### Returns\n\n- `{ pay_date: string; payment_id: string; }`\n\n - `pay_date: string`\n - `payment_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst payment = await client.sandbox.payment.create();\n\nconsole.log(payment);\n```", - perLanguage: { - typescript: { - method: 'client.sandbox.payment.create', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst payment = await client.sandbox.payment.create();\n\nconsole.log(payment.payment_id);", - }, - python: { - method: 'sandbox.payment.create', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npayment = client.sandbox.payment.create()\nprint(payment.payment_id)', - }, - java: { - method: 'sandbox().payment().create', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.PaymentCreateResponse;\nimport com.tryfinch.api.models.SandboxPaymentCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PaymentCreateResponse payment = client.sandbox().payment().create();\n }\n}', - }, - kotlin: { - method: 'sandbox().payment().create', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.PaymentCreateResponse\nimport com.tryfinch.api.models.SandboxPaymentCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val payment: PaymentCreateResponse = client.sandbox().payment().create()\n}', - }, - go: { - method: 'client.Sandbox.Payment.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpayment, err := client.Sandbox.Payment.New(context.TODO(), finchgo.SandboxPaymentNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", payment.PaymentID)\n}\n', - }, - ruby: { - method: 'sandbox.payment.create', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npayment = finch.sandbox.payment.create\n\nputs(payment)', - }, - http: { - example: - 'curl https://api.tryfinch.com/sandbox/payment \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "response": "{ pay_date: string; payment_id: string; }", + "markdown": "## create\n\n`client.sandbox.payment.create(end_date?: string, pay_statements?: { individual_id: string; earnings?: { amount?: number; hours?: number; name?: string; type?: string; }[]; employee_deductions?: { amount?: number; name?: string; pre_tax?: boolean; type?: string; }[]; employer_contributions?: { amount?: number; name?: string; type?: string; }[]; gross_pay?: number; net_pay?: number; payment_method?: 'check' | 'direct_deposit' | 'other'; taxes?: { amount?: number; employer?: boolean; name?: string; type?: 'federal' | 'fica' | 'local' | 'state'; }[]; total_hours?: number; type?: 'off_cycle_payroll' | 'one_time_payment' | 'regular_payroll'; }[], start_date?: string): { pay_date: string; payment_id: string; }`\n\n**post** `/sandbox/payment`\n\nAdd a new sandbox payment\n\n### Parameters\n\n- `end_date?: string`\n\n- `pay_statements?: { individual_id: string; earnings?: { amount?: number; hours?: number; name?: string; type?: string; }[]; employee_deductions?: { amount?: number; name?: string; pre_tax?: boolean; type?: string; }[]; employer_contributions?: { amount?: number; name?: string; type?: string; }[]; gross_pay?: number; net_pay?: number; payment_method?: 'check' | 'direct_deposit' | 'other'; taxes?: { amount?: number; employer?: boolean; name?: string; type?: 'federal' | 'fica' | 'local' | 'state'; }[]; total_hours?: number; type?: 'off_cycle_payroll' | 'one_time_payment' | 'regular_payroll'; }[]`\n Array of pay statements to include in the payment.\n\n- `start_date?: string`\n\n### Returns\n\n- `{ pay_date: string; payment_id: string; }`\n\n - `pay_date: string`\n - `payment_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst payment = await client.sandbox.payment.create();\n\nconsole.log(payment);\n```", + "perLanguage": { + "typescript": { + "method": "client.sandbox.payment.create", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst payment = await client.sandbox.payment.create();\n\nconsole.log(payment.payment_id);" + }, + "python": { + "method": "sandbox.payment.create", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\npayment = client.sandbox.payment.create()\nprint(payment.payment_id)" + }, + "java": { + "method": "sandbox().payment().create", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.PaymentCreateResponse;\nimport com.tryfinch.api.models.SandboxPaymentCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n PaymentCreateResponse payment = client.sandbox().payment().create();\n }\n}" + }, + "kotlin": { + "method": "sandbox().payment().create", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.PaymentCreateResponse\nimport com.tryfinch.api.models.SandboxPaymentCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val payment: PaymentCreateResponse = client.sandbox().payment().create()\n}" + }, + "go": { + "method": "client.Sandbox.Payment.New", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tpayment, err := client.Sandbox.Payment.New(context.TODO(), finchgo.SandboxPaymentNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", payment.PaymentID)\n}\n" + }, + "ruby": { + "method": "sandbox.payment.create", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\npayment = finch.sandbox.payment.create\n\nputs(payment)" + }, + "http": { + "example": "curl https://api.tryfinch.com/sandbox/payment \\\n -X POST \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'create', - endpoint: '/sandbox/jobs', - httpMethod: 'post', - summary: 'Enqueue a new sandbox job', - description: 'Enqueue a new sandbox job', - stainlessPath: '(resource) sandbox.jobs > (method) create', - qualified: 'client.sandbox.jobs.create', - params: ["type: 'data_sync_all';"], - response: '{ allowed_refreshes: number; job_id: string; job_url: string; remaining_refreshes: number; }', - markdown: - "## create\n\n`client.sandbox.jobs.create(type: 'data_sync_all'): { allowed_refreshes: number; job_id: string; job_url: string; remaining_refreshes: number; }`\n\n**post** `/sandbox/jobs`\n\nEnqueue a new sandbox job\n\n### Parameters\n\n- `type: 'data_sync_all'`\n The type of job to start. Currently the only supported type is `data_sync_all`\n\n### Returns\n\n- `{ allowed_refreshes: number; job_id: string; job_url: string; remaining_refreshes: number; }`\n\n - `allowed_refreshes: number`\n - `job_id: string`\n - `job_url: string`\n - `remaining_refreshes: number`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst job = await client.sandbox.jobs.create({ type: 'data_sync_all' });\n\nconsole.log(job);\n```", - perLanguage: { - typescript: { - method: 'client.sandbox.jobs.create', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst job = await client.sandbox.jobs.create({ type: 'data_sync_all' });\n\nconsole.log(job.job_id);", - }, - python: { - method: 'sandbox.jobs.create', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\njob = client.sandbox.jobs.create(\n type="data_sync_all",\n)\nprint(job.job_id)', - }, - java: { - method: 'sandbox().jobs().create', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.JobCreateResponse;\nimport com.tryfinch.api.models.SandboxJobCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SandboxJobCreateParams params = SandboxJobCreateParams.builder()\n .type(SandboxJobCreateParams.Type.DATA_SYNC_ALL)\n .build();\n JobCreateResponse job = client.sandbox().jobs().create(params);\n }\n}', - }, - kotlin: { - method: 'sandbox().jobs().create', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.JobCreateResponse\nimport com.tryfinch.api.models.SandboxJobCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val params: SandboxJobCreateParams = SandboxJobCreateParams.builder()\n .type(SandboxJobCreateParams.Type.DATA_SYNC_ALL)\n .build()\n val job: JobCreateResponse = client.sandbox().jobs().create(params)\n}', - }, - go: { - method: 'client.Sandbox.Jobs.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tjob, err := client.Sandbox.Jobs.New(context.TODO(), finchgo.SandboxJobNewParams{\n\t\tType: finchgo.F(finchgo.SandboxJobNewParamsTypeDataSyncAll),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", job.JobID)\n}\n', - }, - ruby: { - method: 'sandbox.jobs.create', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\njob = finch.sandbox.jobs.create(type: :data_sync_all)\n\nputs(job)', - }, - http: { - example: - 'curl https://api.tryfinch.com/sandbox/jobs \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "type": "data_sync_all"\n }\'', - }, - }, + "name": "create", + "endpoint": "/sandbox/jobs", + "httpMethod": "post", + "summary": "Enqueue a new sandbox job", + "description": "Enqueue a new sandbox job", + "stainlessPath": "(resource) sandbox.jobs > (method) create", + "qualified": "client.sandbox.jobs.create", + "params": [ + "type: 'data_sync_all';" + ], + "response": "{ allowed_refreshes: number; job_id: string; job_url: string; remaining_refreshes: number; }", + "markdown": "## create\n\n`client.sandbox.jobs.create(type: 'data_sync_all'): { allowed_refreshes: number; job_id: string; job_url: string; remaining_refreshes: number; }`\n\n**post** `/sandbox/jobs`\n\nEnqueue a new sandbox job\n\n### Parameters\n\n- `type: 'data_sync_all'`\n The type of job to start. Currently the only supported type is `data_sync_all`\n\n### Returns\n\n- `{ allowed_refreshes: number; job_id: string; job_url: string; remaining_refreshes: number; }`\n\n - `allowed_refreshes: number`\n - `job_id: string`\n - `job_url: string`\n - `remaining_refreshes: number`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst job = await client.sandbox.jobs.create({ type: 'data_sync_all' });\n\nconsole.log(job);\n```", + "perLanguage": { + "typescript": { + "method": "client.sandbox.jobs.create", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst job = await client.sandbox.jobs.create({ type: 'data_sync_all' });\n\nconsole.log(job.job_id);" + }, + "python": { + "method": "sandbox.jobs.create", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\njob = client.sandbox.jobs.create(\n type=\"data_sync_all\",\n)\nprint(job.job_id)" + }, + "java": { + "method": "sandbox().jobs().create", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.JobCreateResponse;\nimport com.tryfinch.api.models.SandboxJobCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n SandboxJobCreateParams params = SandboxJobCreateParams.builder()\n .type(SandboxJobCreateParams.Type.DATA_SYNC_ALL)\n .build();\n JobCreateResponse job = client.sandbox().jobs().create(params);\n }\n}" + }, + "kotlin": { + "method": "sandbox().jobs().create", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.JobCreateResponse\nimport com.tryfinch.api.models.SandboxJobCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val params: SandboxJobCreateParams = SandboxJobCreateParams.builder()\n .type(SandboxJobCreateParams.Type.DATA_SYNC_ALL)\n .build()\n val job: JobCreateResponse = client.sandbox().jobs().create(params)\n}" + }, + "go": { + "method": "client.Sandbox.Jobs.New", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tjob, err := client.Sandbox.Jobs.New(context.TODO(), finchgo.SandboxJobNewParams{\n\t\tType: finchgo.F(finchgo.SandboxJobNewParamsTypeDataSyncAll),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", job.JobID)\n}\n" + }, + "ruby": { + "method": "sandbox.jobs.create", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\njob = finch.sandbox.jobs.create(type: :data_sync_all)\n\nputs(job)" + }, + "http": { + "example": "curl https://api.tryfinch.com/sandbox/jobs \\\n -H 'Content-Type: application/json' \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{\n \"type\": \"data_sync_all\"\n }'" + } + } }, { - name: 'retrieve', - endpoint: '/sandbox/jobs/configuration', - httpMethod: 'get', - summary: 'Get configurations for sandbox jobs', - description: 'Get configurations for sandbox jobs', - stainlessPath: '(resource) sandbox.jobs.configuration > (method) retrieve', - qualified: 'client.sandbox.jobs.configuration.retrieve', - response: - "{ completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'; type: 'data_sync_all'; }[]", - markdown: - "## retrieve\n\n`client.sandbox.jobs.configuration.retrieve(): object[]`\n\n**get** `/sandbox/jobs/configuration`\n\nGet configurations for sandbox jobs\n\n### Returns\n\n- `{ completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'; type: 'data_sync_all'; }[]`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst sandboxJobConfigurations = await client.sandbox.jobs.configuration.retrieve();\n\nconsole.log(sandboxJobConfigurations);\n```", - perLanguage: { - typescript: { - method: 'client.sandbox.jobs.configuration.retrieve', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst sandboxJobConfigurations = await client.sandbox.jobs.configuration.retrieve();\n\nconsole.log(sandboxJobConfigurations);", - }, - python: { - method: 'sandbox.jobs.configuration.retrieve', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nsandbox_job_configurations = client.sandbox.jobs.configuration.retrieve()\nprint(sandbox_job_configurations)', - }, - java: { - method: 'sandbox().jobs().configuration().retrieve', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.SandboxJobConfiguration;\nimport com.tryfinch.api.models.SandboxJobConfigurationRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n List sandboxJobConfigurations = client.sandbox().jobs().configuration().retrieve();\n }\n}', - }, - kotlin: { - method: 'sandbox().jobs().configuration().retrieve', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.SandboxJobConfiguration\nimport com.tryfinch.api.models.SandboxJobConfigurationRetrieveParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val sandboxJobConfigurations: List = client.sandbox().jobs().configuration().retrieve()\n}', - }, - go: { - method: 'client.Sandbox.Jobs.Configuration.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsandboxJobConfigurations, err := client.Sandbox.Jobs.Configuration.Get(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", sandboxJobConfigurations)\n}\n', - }, - ruby: { - method: 'sandbox.jobs.configuration.retrieve', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nsandbox_job_configurations = finch.sandbox.jobs.configuration.retrieve\n\nputs(sandbox_job_configurations)', - }, - http: { - example: - 'curl https://api.tryfinch.com/sandbox/jobs/configuration \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "name": "retrieve", + "endpoint": "/sandbox/jobs/configuration", + "httpMethod": "get", + "summary": "Get configurations for sandbox jobs", + "description": "Get configurations for sandbox jobs", + "stainlessPath": "(resource) sandbox.jobs.configuration > (method) retrieve", + "qualified": "client.sandbox.jobs.configuration.retrieve", + "response": "{ completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'; type: 'data_sync_all'; }[]", + "markdown": "## retrieve\n\n`client.sandbox.jobs.configuration.retrieve(): object[]`\n\n**get** `/sandbox/jobs/configuration`\n\nGet configurations for sandbox jobs\n\n### Returns\n\n- `{ completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'; type: 'data_sync_all'; }[]`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst sandboxJobConfigurations = await client.sandbox.jobs.configuration.retrieve();\n\nconsole.log(sandboxJobConfigurations);\n```", + "perLanguage": { + "typescript": { + "method": "client.sandbox.jobs.configuration.retrieve", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst sandboxJobConfigurations = await client.sandbox.jobs.configuration.retrieve();\n\nconsole.log(sandboxJobConfigurations);" + }, + "python": { + "method": "sandbox.jobs.configuration.retrieve", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nsandbox_job_configurations = client.sandbox.jobs.configuration.retrieve()\nprint(sandbox_job_configurations)" + }, + "java": { + "method": "sandbox().jobs().configuration().retrieve", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.SandboxJobConfiguration;\nimport com.tryfinch.api.models.SandboxJobConfigurationRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n List sandboxJobConfigurations = client.sandbox().jobs().configuration().retrieve();\n }\n}" + }, + "kotlin": { + "method": "sandbox().jobs().configuration().retrieve", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.SandboxJobConfiguration\nimport com.tryfinch.api.models.SandboxJobConfigurationRetrieveParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val sandboxJobConfigurations: List = client.sandbox().jobs().configuration().retrieve()\n}" + }, + "go": { + "method": "client.Sandbox.Jobs.Configuration.Get", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tsandboxJobConfigurations, err := client.Sandbox.Jobs.Configuration.Get(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", sandboxJobConfigurations)\n}\n" + }, + "ruby": { + "method": "sandbox.jobs.configuration.retrieve", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nsandbox_job_configurations = finch.sandbox.jobs.configuration.retrieve\n\nputs(sandbox_job_configurations)" + }, + "http": { + "example": "curl https://api.tryfinch.com/sandbox/jobs/configuration \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'update', - endpoint: '/sandbox/jobs/configuration', - httpMethod: 'put', - summary: 'Update configurations for sandbox jobs', - description: 'Update configurations for sandbox jobs', - stainlessPath: '(resource) sandbox.jobs.configuration > (method) update', - qualified: 'client.sandbox.jobs.configuration.update', - params: [ + "name": "update", + "endpoint": "/sandbox/jobs/configuration", + "httpMethod": "put", + "summary": "Update configurations for sandbox jobs", + "description": "Update configurations for sandbox jobs", + "stainlessPath": "(resource) sandbox.jobs.configuration > (method) update", + "qualified": "client.sandbox.jobs.configuration.update", + "params": [ "completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error';", - "type: 'data_sync_all';", + "type: 'data_sync_all';" ], - response: - "{ completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'; type: 'data_sync_all'; }", - markdown: - "## update\n\n`client.sandbox.jobs.configuration.update(completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error', type: 'data_sync_all'): { completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'; type: 'data_sync_all'; }`\n\n**put** `/sandbox/jobs/configuration`\n\nUpdate configurations for sandbox jobs\n\n### Parameters\n\n- `completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'`\n\n- `type: 'data_sync_all'`\n\n### Returns\n\n- `{ completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'; type: 'data_sync_all'; }`\n\n - `completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'`\n - `type: 'data_sync_all'`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst sandboxJobConfiguration = await client.sandbox.jobs.configuration.update({ completion_status: 'complete', type: 'data_sync_all' });\n\nconsole.log(sandboxJobConfiguration);\n```", - perLanguage: { - typescript: { - method: 'client.sandbox.jobs.configuration.update', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst sandboxJobConfiguration = await client.sandbox.jobs.configuration.update({\n completion_status: 'complete',\n type: 'data_sync_all',\n});\n\nconsole.log(sandboxJobConfiguration.completion_status);", - }, - python: { - method: 'sandbox.jobs.configuration.update', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nsandbox_job_configuration = client.sandbox.jobs.configuration.update(\n completion_status="complete",\n type="data_sync_all",\n)\nprint(sandbox_job_configuration.completion_status)', - }, - java: { - method: 'sandbox().jobs().configuration().update', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.SandboxJobConfiguration;\nimport com.tryfinch.api.models.SandboxJobConfigurationUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SandboxJobConfiguration params = SandboxJobConfiguration.builder()\n .completionStatus(SandboxJobConfiguration.CompletionStatus.COMPLETE)\n .type(SandboxJobConfiguration.Type.DATA_SYNC_ALL)\n .build();\n SandboxJobConfiguration sandboxJobConfiguration = client.sandbox().jobs().configuration().update(params);\n }\n}', - }, - kotlin: { - method: 'sandbox().jobs().configuration().update', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.SandboxJobConfiguration\nimport com.tryfinch.api.models.SandboxJobConfigurationUpdateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val params: SandboxJobConfiguration = SandboxJobConfiguration.builder()\n .completionStatus(SandboxJobConfiguration.CompletionStatus.COMPLETE)\n .type(SandboxJobConfiguration.Type.DATA_SYNC_ALL)\n .build()\n val sandboxJobConfiguration: SandboxJobConfiguration = client.sandbox().jobs().configuration().update(params)\n}', - }, - go: { - method: 'client.Sandbox.Jobs.Configuration.Update', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsandboxJobConfiguration, err := client.Sandbox.Jobs.Configuration.Update(context.TODO(), finchgo.SandboxJobConfigurationUpdateParams{\n\t\tCompletionStatus: finchgo.F(finchgo.SandboxJobConfigurationUpdateParamsCompletionStatusComplete),\n\t\tType: finchgo.F(finchgo.SandboxJobConfigurationUpdateParamsTypeDataSyncAll),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", sandboxJobConfiguration.CompletionStatus)\n}\n', - }, - ruby: { - method: 'sandbox.jobs.configuration.update', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nsandbox_job_configuration = finch.sandbox.jobs.configuration.update(completion_status: :complete, type: :data_sync_all)\n\nputs(sandbox_job_configuration)', - }, - http: { - example: - 'curl https://api.tryfinch.com/sandbox/jobs/configuration \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "completion_status": "complete",\n "type": "data_sync_all"\n }\'', - }, - }, + "response": "{ completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'; type: 'data_sync_all'; }", + "markdown": "## update\n\n`client.sandbox.jobs.configuration.update(completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error', type: 'data_sync_all'): { completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'; type: 'data_sync_all'; }`\n\n**put** `/sandbox/jobs/configuration`\n\nUpdate configurations for sandbox jobs\n\n### Parameters\n\n- `completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'`\n\n- `type: 'data_sync_all'`\n\n### Returns\n\n- `{ completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'; type: 'data_sync_all'; }`\n\n - `completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'`\n - `type: 'data_sync_all'`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst sandboxJobConfiguration = await client.sandbox.jobs.configuration.update({ completion_status: 'complete', type: 'data_sync_all' });\n\nconsole.log(sandboxJobConfiguration);\n```", + "perLanguage": { + "typescript": { + "method": "client.sandbox.jobs.configuration.update", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst sandboxJobConfiguration = await client.sandbox.jobs.configuration.update({\n completion_status: 'complete',\n type: 'data_sync_all',\n});\n\nconsole.log(sandboxJobConfiguration.completion_status);" + }, + "python": { + "method": "sandbox.jobs.configuration.update", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nsandbox_job_configuration = client.sandbox.jobs.configuration.update(\n completion_status=\"complete\",\n type=\"data_sync_all\",\n)\nprint(sandbox_job_configuration.completion_status)" + }, + "java": { + "method": "sandbox().jobs().configuration().update", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.SandboxJobConfiguration;\nimport com.tryfinch.api.models.SandboxJobConfigurationUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n SandboxJobConfiguration params = SandboxJobConfiguration.builder()\n .completionStatus(SandboxJobConfiguration.CompletionStatus.COMPLETE)\n .type(SandboxJobConfiguration.Type.DATA_SYNC_ALL)\n .build();\n SandboxJobConfiguration sandboxJobConfiguration = client.sandbox().jobs().configuration().update(params);\n }\n}" + }, + "kotlin": { + "method": "sandbox().jobs().configuration().update", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.SandboxJobConfiguration\nimport com.tryfinch.api.models.SandboxJobConfigurationUpdateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val params: SandboxJobConfiguration = SandboxJobConfiguration.builder()\n .completionStatus(SandboxJobConfiguration.CompletionStatus.COMPLETE)\n .type(SandboxJobConfiguration.Type.DATA_SYNC_ALL)\n .build()\n val sandboxJobConfiguration: SandboxJobConfiguration = client.sandbox().jobs().configuration().update(params)\n}" + }, + "go": { + "method": "client.Sandbox.Jobs.Configuration.Update", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tsandboxJobConfiguration, err := client.Sandbox.Jobs.Configuration.Update(context.TODO(), finchgo.SandboxJobConfigurationUpdateParams{\n\t\tCompletionStatus: finchgo.F(finchgo.SandboxJobConfigurationUpdateParamsCompletionStatusComplete),\n\t\tType: finchgo.F(finchgo.SandboxJobConfigurationUpdateParamsTypeDataSyncAll),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", sandboxJobConfiguration.CompletionStatus)\n}\n" + }, + "ruby": { + "method": "sandbox.jobs.configuration.update", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nsandbox_job_configuration = finch.sandbox.jobs.configuration.update(completion_status: :complete, type: :data_sync_all)\n\nputs(sandbox_job_configuration)" + }, + "http": { + "example": "curl https://api.tryfinch.com/sandbox/jobs/configuration \\\n -X PUT \\\n -H 'Content-Type: application/json' \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{\n \"completion_status\": \"complete\",\n \"type\": \"data_sync_all\"\n }'" + } + } }, { - name: 'list', - endpoint: '/employer/pay-groups', - httpMethod: 'get', - summary: 'Get All Pay Groups', - description: 'Read company pay groups and frequencies', - stainlessPath: '(resource) payroll.pay_groups > (method) list', - qualified: 'client.payroll.payGroups.list', - params: ['entity_ids?: string[];', 'individual_id?: string;', 'pay_frequencies?: string[];'], - response: '{ id: string; name: string; pay_frequencies: string[]; }', - markdown: - "## list\n\n`client.payroll.payGroups.list(entity_ids?: string[], individual_id?: string, pay_frequencies?: string[]): { id: string; name: string; pay_frequencies: string[]; }`\n\n**get** `/employer/pay-groups`\n\nRead company pay groups and frequencies\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `individual_id?: string`\n\n- `pay_frequencies?: string[]`\n\n### Returns\n\n- `{ id: string; name: string; pay_frequencies: string[]; }`\n\n - `id: string`\n - `name: string`\n - `pay_frequencies: string[]`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const payGroupListResponse of client.payroll.payGroups.list()) {\n console.log(payGroupListResponse);\n}\n```", - perLanguage: { - typescript: { - method: 'client.payroll.payGroups.list', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const payGroupListResponse of client.payroll.payGroups.list()) {\n console.log(payGroupListResponse.id);\n}", - }, - python: { - method: 'payroll.pay_groups.list', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.payroll.pay_groups.list()\npage = page.items[0]\nprint(page.id)', - }, - java: { - method: 'payroll().payGroups().list', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.PayrollPayGroupListPage;\nimport com.tryfinch.api.models.PayrollPayGroupListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PayrollPayGroupListPage page = client.payroll().payGroups().list();\n }\n}', - }, - kotlin: { - method: 'payroll().payGroups().list', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.PayrollPayGroupListPage\nimport com.tryfinch.api.models.PayrollPayGroupListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val page: PayrollPayGroupListPage = client.payroll().payGroups().list()\n}', - }, - go: { - method: 'client.Payroll.PayGroups.List', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Payroll.PayGroups.List(context.TODO(), finchgo.PayrollPayGroupListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', - }, - ruby: { - method: 'payroll.pay_groups.list', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.payroll.pay_groups.list\n\nputs(page)', - }, - http: { - example: - 'curl https://api.tryfinch.com/employer/pay-groups \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "name": "list", + "endpoint": "/employer/pay-groups", + "httpMethod": "get", + "summary": "Get All Pay Groups", + "description": "Read company pay groups and frequencies", + "stainlessPath": "(resource) payroll.pay_groups > (method) list", + "qualified": "client.payroll.payGroups.list", + "params": [ + "entity_ids?: string[];", + "individual_id?: string;", + "pay_frequencies?: string[];" + ], + "response": "{ id: string; name: string; pay_frequencies: string[]; }", + "markdown": "## list\n\n`client.payroll.payGroups.list(entity_ids?: string[], individual_id?: string, pay_frequencies?: string[]): { id: string; name: string; pay_frequencies: string[]; }`\n\n**get** `/employer/pay-groups`\n\nRead company pay groups and frequencies\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `individual_id?: string`\n\n- `pay_frequencies?: string[]`\n\n### Returns\n\n- `{ id: string; name: string; pay_frequencies: string[]; }`\n\n - `id: string`\n - `name: string`\n - `pay_frequencies: string[]`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const payGroupListResponse of client.payroll.payGroups.list()) {\n console.log(payGroupListResponse);\n}\n```", + "perLanguage": { + "typescript": { + "method": "client.payroll.payGroups.list", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const payGroupListResponse of client.payroll.payGroups.list()) {\n console.log(payGroupListResponse.id);\n}" + }, + "python": { + "method": "payroll.pay_groups.list", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\npage = client.payroll.pay_groups.list()\npage = page.items[0]\nprint(page.id)" + }, + "java": { + "method": "payroll().payGroups().list", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.PayrollPayGroupListPage;\nimport com.tryfinch.api.models.PayrollPayGroupListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n PayrollPayGroupListPage page = client.payroll().payGroups().list();\n }\n}" + }, + "kotlin": { + "method": "payroll().payGroups().list", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.PayrollPayGroupListPage\nimport com.tryfinch.api.models.PayrollPayGroupListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val page: PayrollPayGroupListPage = client.payroll().payGroups().list()\n}" + }, + "go": { + "method": "client.Payroll.PayGroups.List", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tpage, err := client.Payroll.PayGroups.List(context.TODO(), finchgo.PayrollPayGroupListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n" + }, + "ruby": { + "method": "payroll.pay_groups.list", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\npage = finch.payroll.pay_groups.list\n\nputs(page)" + }, + "http": { + "example": "curl https://api.tryfinch.com/employer/pay-groups \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'retrieve', - endpoint: '/employer/pay-groups/{pay_group_id}', - httpMethod: 'get', - summary: 'Get Pay Group', - description: 'Read information from a single pay group', - stainlessPath: '(resource) payroll.pay_groups > (method) retrieve', - qualified: 'client.payroll.payGroups.retrieve', - params: ['pay_group_id: string;', 'entity_ids?: string[];'], - response: '{ id: string; individual_ids: string[]; name: string; pay_frequencies: string[]; }', - markdown: - "## retrieve\n\n`client.payroll.payGroups.retrieve(pay_group_id: string, entity_ids?: string[]): { id: string; individual_ids: string[]; name: string; pay_frequencies: string[]; }`\n\n**get** `/employer/pay-groups/{pay_group_id}`\n\nRead information from a single pay group\n\n### Parameters\n\n- `pay_group_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ id: string; individual_ids: string[]; name: string; pay_frequencies: string[]; }`\n\n - `id: string`\n - `individual_ids: string[]`\n - `name: string`\n - `pay_frequencies: string[]`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst payGroup = await client.payroll.payGroups.retrieve('pay_group_id');\n\nconsole.log(payGroup);\n```", - perLanguage: { - typescript: { - method: 'client.payroll.payGroups.retrieve', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst payGroup = await client.payroll.payGroups.retrieve('pay_group_id');\n\nconsole.log(payGroup.id);", - }, - python: { - method: 'payroll.pay_groups.retrieve', - example: - 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npay_group = client.payroll.pay_groups.retrieve(\n pay_group_id="pay_group_id",\n)\nprint(pay_group.id)', - }, - java: { - method: 'payroll().payGroups().retrieve', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.PayGroupRetrieveResponse;\nimport com.tryfinch.api.models.PayrollPayGroupRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PayGroupRetrieveResponse payGroup = client.payroll().payGroups().retrieve("pay_group_id");\n }\n}', - }, - kotlin: { - method: 'payroll().payGroups().retrieve', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.PayGroupRetrieveResponse\nimport com.tryfinch.api.models.PayrollPayGroupRetrieveParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val payGroup: PayGroupRetrieveResponse = client.payroll().payGroups().retrieve("pay_group_id")\n}', - }, - go: { - method: 'client.Payroll.PayGroups.Get', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpayGroup, err := client.Payroll.PayGroups.Get(\n\t\tcontext.TODO(),\n\t\t"pay_group_id",\n\t\tfinchgo.PayrollPayGroupGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", payGroup.ID)\n}\n', - }, - ruby: { - method: 'payroll.pay_groups.retrieve', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npay_group = finch.payroll.pay_groups.retrieve("pay_group_id")\n\nputs(pay_group)', - }, - http: { - example: - 'curl https://api.tryfinch.com/employer/pay-groups/$PAY_GROUP_ID \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', - }, - }, + "name": "retrieve", + "endpoint": "/employer/pay-groups/{pay_group_id}", + "httpMethod": "get", + "summary": "Get Pay Group", + "description": "Read information from a single pay group", + "stainlessPath": "(resource) payroll.pay_groups > (method) retrieve", + "qualified": "client.payroll.payGroups.retrieve", + "params": [ + "pay_group_id: string;", + "entity_ids?: string[];" + ], + "response": "{ id: string; individual_ids: string[]; name: string; pay_frequencies: string[]; }", + "markdown": "## retrieve\n\n`client.payroll.payGroups.retrieve(pay_group_id: string, entity_ids?: string[]): { id: string; individual_ids: string[]; name: string; pay_frequencies: string[]; }`\n\n**get** `/employer/pay-groups/{pay_group_id}`\n\nRead information from a single pay group\n\n### Parameters\n\n- `pay_group_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ id: string; individual_ids: string[]; name: string; pay_frequencies: string[]; }`\n\n - `id: string`\n - `individual_ids: string[]`\n - `name: string`\n - `pay_frequencies: string[]`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst payGroup = await client.payroll.payGroups.retrieve('pay_group_id');\n\nconsole.log(payGroup);\n```", + "perLanguage": { + "typescript": { + "method": "client.payroll.payGroups.retrieve", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst payGroup = await client.payroll.payGroups.retrieve('pay_group_id');\n\nconsole.log(payGroup.id);" + }, + "python": { + "method": "payroll.pay_groups.retrieve", + "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\npay_group = client.payroll.pay_groups.retrieve(\n pay_group_id=\"pay_group_id\",\n)\nprint(pay_group.id)" + }, + "java": { + "method": "payroll().payGroups().retrieve", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.PayGroupRetrieveResponse;\nimport com.tryfinch.api.models.PayrollPayGroupRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n PayGroupRetrieveResponse payGroup = client.payroll().payGroups().retrieve(\"pay_group_id\");\n }\n}" + }, + "kotlin": { + "method": "payroll().payGroups().retrieve", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.PayGroupRetrieveResponse\nimport com.tryfinch.api.models.PayrollPayGroupRetrieveParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val payGroup: PayGroupRetrieveResponse = client.payroll().payGroups().retrieve(\"pay_group_id\")\n}" + }, + "go": { + "method": "client.Payroll.PayGroups.Get", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tpayGroup, err := client.Payroll.PayGroups.Get(\n\t\tcontext.TODO(),\n\t\t\"pay_group_id\",\n\t\tfinchgo.PayrollPayGroupGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", payGroup.ID)\n}\n" + }, + "ruby": { + "method": "payroll.pay_groups.retrieve", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\npay_group = finch.payroll.pay_groups.retrieve(\"pay_group_id\")\n\nputs(pay_group)" + }, + "http": { + "example": "curl https://api.tryfinch.com/employer/pay-groups/$PAY_GROUP_ID \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" + } + } }, { - name: 'new', - endpoint: '/connect/sessions', - httpMethod: 'post', - summary: 'Create a new connect session', - description: 'Create a new connect session for an employer', - stainlessPath: '(resource) connect.sessions > (method) new', - qualified: 'client.connect.sessions.new', - params: [ - 'customer_id: string;', - 'customer_name: string;', - 'products: string[];', - 'customer_email?: string;', + "name": "new", + "endpoint": "/connect/sessions", + "httpMethod": "post", + "summary": "Create a new connect session", + "description": "Create a new connect session for an employer", + "stainlessPath": "(resource) connect.sessions > (method) new", + "qualified": "client.connect.sessions.new", + "params": [ + "customer_id: string;", + "customer_name: string;", + "products: string[];", + "customer_email?: string;", "integration?: { provider: string; auth_method?: 'assisted' | 'credential' | 'oauth' | 'api_token'; };", - 'manual?: boolean;', - 'minutes_to_expire?: number;', - 'redirect_uri?: string;', - "sandbox?: 'finch' | 'provider';", + "manual?: boolean;", + "minutes_to_expire?: number;", + "redirect_uri?: string;", + "sandbox?: 'finch' | 'provider';" ], - response: '{ connect_url: string; session_id: string; }', - markdown: - "## new\n\n`client.connect.sessions.new(customer_id: string, customer_name: string, products: string[], customer_email?: string, integration?: { provider: string; auth_method?: 'assisted' | 'credential' | 'oauth' | 'api_token'; }, manual?: boolean, minutes_to_expire?: number, redirect_uri?: string, sandbox?: 'finch' | 'provider'): { connect_url: string; session_id: string; }`\n\n**post** `/connect/sessions`\n\nCreate a new connect session for an employer\n\n### Parameters\n\n- `customer_id: string`\n Unique identifier for the customer\n\n- `customer_name: string`\n Name of the customer\n\n- `products: string[]`\n The Finch products to request access to. Use `benefits` to access deductions endpoints — `deduction` is a deprecated alias that is still accepted but should not be combined with `benefits`.\n\n- `customer_email?: string`\n Email address of the customer\n\n- `integration?: { provider: string; auth_method?: 'assisted' | 'credential' | 'oauth' | 'api_token'; }`\n Integration configuration for the connect session\n - `provider: string`\n The provider to integrate with\n - `auth_method?: 'assisted' | 'credential' | 'oauth' | 'api_token'`\n The authentication method to use\n\n- `manual?: boolean`\n Enable manual authentication mode\n\n- `minutes_to_expire?: number`\n The number of minutes until the session expires (defaults to 129,600, which is 90 days)\n\n- `redirect_uri?: string`\n The URI to redirect to after the Connect flow is completed\n\n- `sandbox?: 'finch' | 'provider'`\n Sandbox mode for testing\n\n### Returns\n\n- `{ connect_url: string; session_id: string; }`\n\n - `connect_url: string`\n - `session_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst response = await client.connect.sessions.new({\n customer_id: 'x',\n customer_name: 'x',\n products: ['benefits'],\n});\n\nconsole.log(response);\n```", - perLanguage: { - typescript: { - method: 'client.connect.sessions.new', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n clientID: process.env['FINCH_CLIENT_ID'], // This is the default and can be omitted\n clientSecret: process.env['FINCH_CLIENT_SECRET'], // This is the default and can be omitted\n});\n\nconst response = await client.connect.sessions.new({\n customer_id: 'x',\n customer_name: 'x',\n products: ['benefits'],\n});\n\nconsole.log(response.session_id);", - }, - python: { - method: 'connect.sessions.new', - example: - 'import os\nfrom finch import Finch\n\nclient = Finch(\n client_id=os.environ.get("FINCH_CLIENT_ID"), # This is the default and can be omitted\n client_secret=os.environ.get("FINCH_CLIENT_SECRET"), # This is the default and can be omitted\n)\nresponse = client.connect.sessions.new(\n customer_id="x",\n customer_name="x",\n products=["benefits"],\n)\nprint(response.session_id)', - }, - java: { - method: 'connect().sessions().new_', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.ConnectSessionNewParams;\nimport com.tryfinch.api.models.SessionNewResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.fromEnv();\n\n ConnectSessionNewParams params = ConnectSessionNewParams.builder()\n .customerId("x")\n .customerName("x")\n .addProduct(ConnectSessionNewParams.ConnectProducts.BENEFITS)\n .build();\n SessionNewResponse response = client.connect().sessions().new_(params);\n }\n}', - }, - kotlin: { - method: 'connect().sessions().new', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.ConnectSessionNewParams\nimport com.tryfinch.api.models.SessionNewResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.fromEnv()\n\n val params: ConnectSessionNewParams = ConnectSessionNewParams.builder()\n .customerId("x")\n .customerName("x")\n .addProduct(ConnectSessionNewParams.ConnectProducts.BENEFITS)\n .build()\n val response: SessionNewResponse = client.connect().sessions().new(params)\n}', - }, - go: { - method: 'client.Connect.Sessions.New', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithClientID("4ab15e51-11ad-49f4-acae-f343b7794375"),\n\t\toption.WithClientSecret("My Client Secret"),\n\t)\n\tresponse, err := client.Connect.Sessions.New(context.TODO(), finchgo.ConnectSessionNewParams{\n\t\tCustomerID: finchgo.F("x"),\n\t\tCustomerName: finchgo.F("x"),\n\t\tProducts: finchgo.F([]finchgo.ConnectSessionNewParamsProduct{finchgo.ConnectSessionNewParamsProductBenefits}),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response.SessionID)\n}\n', - }, - ruby: { - method: 'connect.sessions.new', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(client_id: "4ab15e51-11ad-49f4-acae-f343b7794375", client_secret: "My Client Secret")\n\nresponse = finch.connect.sessions.new(customer_id: "x", customer_name: "x", products: [:benefits])\n\nputs(response)', - }, - http: { - example: - 'curl https://api.tryfinch.com/connect/sessions \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -u "$FINCH_CLIENT_ID:FINCH_CLIENT_SECRET" \\\n -d \'{\n "customer_id": "x",\n "customer_name": "x",\n "products": [\n "benefits"\n ]\n }\'', - }, - }, + "response": "{ connect_url: string; session_id: string; }", + "markdown": "## new\n\n`client.connect.sessions.new(customer_id: string, customer_name: string, products: string[], customer_email?: string, integration?: { provider: string; auth_method?: 'assisted' | 'credential' | 'oauth' | 'api_token'; }, manual?: boolean, minutes_to_expire?: number, redirect_uri?: string, sandbox?: 'finch' | 'provider'): { connect_url: string; session_id: string; }`\n\n**post** `/connect/sessions`\n\nCreate a new connect session for an employer\n\n### Parameters\n\n- `customer_id: string`\n Unique identifier for the customer\n\n- `customer_name: string`\n Name of the customer\n\n- `products: string[]`\n The Finch products to request access to. Use `benefits` to access deductions endpoints — `deduction` is a deprecated alias that is still accepted but should not be combined with `benefits`.\n\n- `customer_email?: string`\n Email address of the customer\n\n- `integration?: { provider: string; auth_method?: 'assisted' | 'credential' | 'oauth' | 'api_token'; }`\n Integration configuration for the connect session\n - `provider: string`\n The provider to integrate with\n - `auth_method?: 'assisted' | 'credential' | 'oauth' | 'api_token'`\n The authentication method to use\n\n- `manual?: boolean`\n Enable manual authentication mode\n\n- `minutes_to_expire?: number`\n The number of minutes until the session expires (defaults to 129,600, which is 90 days)\n\n- `redirect_uri?: string`\n The URI to redirect to after the Connect flow is completed\n\n- `sandbox?: 'finch' | 'provider'`\n Sandbox mode for testing\n\n### Returns\n\n- `{ connect_url: string; session_id: string; }`\n\n - `connect_url: string`\n - `session_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst response = await client.connect.sessions.new({\n customer_id: 'x',\n customer_name: 'x',\n products: ['benefits'],\n});\n\nconsole.log(response);\n```", + "perLanguage": { + "typescript": { + "method": "client.connect.sessions.new", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n clientID: process.env['FINCH_CLIENT_ID'], // This is the default and can be omitted\n clientSecret: process.env['FINCH_CLIENT_SECRET'], // This is the default and can be omitted\n});\n\nconst response = await client.connect.sessions.new({\n customer_id: 'x',\n customer_name: 'x',\n products: ['benefits'],\n});\n\nconsole.log(response.session_id);" + }, + "python": { + "method": "connect.sessions.new", + "example": "import os\nfrom finch import Finch\n\nclient = Finch(\n client_id=os.environ.get(\"FINCH_CLIENT_ID\"), # This is the default and can be omitted\n client_secret=os.environ.get(\"FINCH_CLIENT_SECRET\"), # This is the default and can be omitted\n)\nresponse = client.connect.sessions.new(\n customer_id=\"x\",\n customer_name=\"x\",\n products=[\"benefits\"],\n)\nprint(response.session_id)" + }, + "java": { + "method": "connect().sessions().new_", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.ConnectSessionNewParams;\nimport com.tryfinch.api.models.SessionNewResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.fromEnv();\n\n ConnectSessionNewParams params = ConnectSessionNewParams.builder()\n .customerId(\"x\")\n .customerName(\"x\")\n .addProduct(ConnectSessionNewParams.ConnectProducts.BENEFITS)\n .build();\n SessionNewResponse response = client.connect().sessions().new_(params);\n }\n}" + }, + "kotlin": { + "method": "connect().sessions().new", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.ConnectSessionNewParams\nimport com.tryfinch.api.models.SessionNewResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.fromEnv()\n\n val params: ConnectSessionNewParams = ConnectSessionNewParams.builder()\n .customerId(\"x\")\n .customerName(\"x\")\n .addProduct(ConnectSessionNewParams.ConnectProducts.BENEFITS)\n .build()\n val response: SessionNewResponse = client.connect().sessions().new(params)\n}" + }, + "go": { + "method": "client.Connect.Sessions.New", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithClientID(\"4ab15e51-11ad-49f4-acae-f343b7794375\"),\n\t\toption.WithClientSecret(\"My Client Secret\"),\n\t)\n\tresponse, err := client.Connect.Sessions.New(context.TODO(), finchgo.ConnectSessionNewParams{\n\t\tCustomerID: finchgo.F(\"x\"),\n\t\tCustomerName: finchgo.F(\"x\"),\n\t\tProducts: finchgo.F([]finchgo.ConnectSessionNewParamsProduct{finchgo.ConnectSessionNewParamsProductBenefits}),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.SessionID)\n}\n" + }, + "ruby": { + "method": "connect.sessions.new", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(client_id: \"4ab15e51-11ad-49f4-acae-f343b7794375\", client_secret: \"My Client Secret\")\n\nresponse = finch.connect.sessions.new(customer_id: \"x\", customer_name: \"x\", products: [:benefits])\n\nputs(response)" + }, + "http": { + "example": "curl https://api.tryfinch.com/connect/sessions \\\n -H 'Content-Type: application/json' \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -u \"$FINCH_CLIENT_ID:FINCH_CLIENT_SECRET\" \\\n -d '{\n \"customer_id\": \"x\",\n \"customer_name\": \"x\",\n \"products\": [\n \"benefits\"\n ]\n }'" + } + } }, { - name: 'reauthenticate', - endpoint: '/connect/sessions/reauthenticate', - httpMethod: 'post', - summary: 'Create a new Connect session for reauthentication', - description: 'Create a new Connect session for reauthenticating an existing connection', - stainlessPath: '(resource) connect.sessions > (method) reauthenticate', - qualified: 'client.connect.sessions.reauthenticate', - params: [ - 'connection_id: string;', - 'minutes_to_expire?: number;', - 'products?: string[];', - 'redirect_uri?: string;', + "name": "reauthenticate", + "endpoint": "/connect/sessions/reauthenticate", + "httpMethod": "post", + "summary": "Create a new Connect session for reauthentication", + "description": "Create a new Connect session for reauthenticating an existing connection", + "stainlessPath": "(resource) connect.sessions > (method) reauthenticate", + "qualified": "client.connect.sessions.reauthenticate", + "params": [ + "connection_id: string;", + "minutes_to_expire?: number;", + "products?: string[];", + "redirect_uri?: string;" ], - response: '{ connect_url: string; session_id: string; }', - markdown: - "## reauthenticate\n\n`client.connect.sessions.reauthenticate(connection_id: string, minutes_to_expire?: number, products?: string[], redirect_uri?: string): { connect_url: string; session_id: string; }`\n\n**post** `/connect/sessions/reauthenticate`\n\nCreate a new Connect session for reauthenticating an existing connection\n\n### Parameters\n\n- `connection_id: string`\n The ID of the existing connection to reauthenticate\n\n- `minutes_to_expire?: number`\n The number of minutes until the session expires (defaults to 43,200, which is 30 days)\n\n- `products?: string[]`\n The products to request access to (optional for reauthentication). Use `benefits` to access deductions endpoints — `deduction` is a deprecated alias that is still accepted but should not be combined with `benefits`.\n\n- `redirect_uri?: string`\n The URI to redirect to after the Connect flow is completed\n\n### Returns\n\n- `{ connect_url: string; session_id: string; }`\n\n - `connect_url: string`\n - `session_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst response = await client.connect.sessions.reauthenticate({ connection_id: 'connection_id' });\n\nconsole.log(response);\n```", - perLanguage: { - typescript: { - method: 'client.connect.sessions.reauthenticate', - example: - "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n clientID: process.env['FINCH_CLIENT_ID'], // This is the default and can be omitted\n clientSecret: process.env['FINCH_CLIENT_SECRET'], // This is the default and can be omitted\n});\n\nconst response = await client.connect.sessions.reauthenticate({ connection_id: 'connection_id' });\n\nconsole.log(response.session_id);", - }, - python: { - method: 'connect.sessions.reauthenticate', - example: - 'import os\nfrom finch import Finch\n\nclient = Finch(\n client_id=os.environ.get("FINCH_CLIENT_ID"), # This is the default and can be omitted\n client_secret=os.environ.get("FINCH_CLIENT_SECRET"), # This is the default and can be omitted\n)\nresponse = client.connect.sessions.reauthenticate(\n connection_id="connection_id",\n)\nprint(response.session_id)', - }, - java: { - method: 'connect().sessions().reauthenticate', - example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.ConnectSessionReauthenticateParams;\nimport com.tryfinch.api.models.SessionReauthenticateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.fromEnv();\n\n ConnectSessionReauthenticateParams params = ConnectSessionReauthenticateParams.builder()\n .connectionId("connection_id")\n .build();\n SessionReauthenticateResponse response = client.connect().sessions().reauthenticate(params);\n }\n}', - }, - kotlin: { - method: 'connect().sessions().reauthenticate', - example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.ConnectSessionReauthenticateParams\nimport com.tryfinch.api.models.SessionReauthenticateResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.fromEnv()\n\n val params: ConnectSessionReauthenticateParams = ConnectSessionReauthenticateParams.builder()\n .connectionId("connection_id")\n .build()\n val response: SessionReauthenticateResponse = client.connect().sessions().reauthenticate(params)\n}', - }, - go: { - method: 'client.Connect.Sessions.Reauthenticate', - example: - 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithClientID("4ab15e51-11ad-49f4-acae-f343b7794375"),\n\t\toption.WithClientSecret("My Client Secret"),\n\t)\n\tresponse, err := client.Connect.Sessions.Reauthenticate(context.TODO(), finchgo.ConnectSessionReauthenticateParams{\n\t\tConnectionID: finchgo.F("connection_id"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response.SessionID)\n}\n', - }, - ruby: { - method: 'connect.sessions.reauthenticate', - example: - 'require "finch_api"\n\nfinch = FinchAPI::Client.new(client_id: "4ab15e51-11ad-49f4-acae-f343b7794375", client_secret: "My Client Secret")\n\nresponse = finch.connect.sessions.reauthenticate(connection_id: "connection_id")\n\nputs(response)', - }, - http: { - example: - 'curl https://api.tryfinch.com/connect/sessions/reauthenticate \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -u "$FINCH_CLIENT_ID:FINCH_CLIENT_SECRET" \\\n -d \'{\n "connection_id": "connection_id"\n }\'', - }, - }, - }, + "response": "{ connect_url: string; session_id: string; }", + "markdown": "## reauthenticate\n\n`client.connect.sessions.reauthenticate(connection_id: string, minutes_to_expire?: number, products?: string[], redirect_uri?: string): { connect_url: string; session_id: string; }`\n\n**post** `/connect/sessions/reauthenticate`\n\nCreate a new Connect session for reauthenticating an existing connection\n\n### Parameters\n\n- `connection_id: string`\n The ID of the existing connection to reauthenticate\n\n- `minutes_to_expire?: number`\n The number of minutes until the session expires (defaults to 43,200, which is 30 days)\n\n- `products?: string[]`\n The products to request access to (optional for reauthentication). Use `benefits` to access deductions endpoints — `deduction` is a deprecated alias that is still accepted but should not be combined with `benefits`.\n\n- `redirect_uri?: string`\n The URI to redirect to after the Connect flow is completed\n\n### Returns\n\n- `{ connect_url: string; session_id: string; }`\n\n - `connect_url: string`\n - `session_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst response = await client.connect.sessions.reauthenticate({ connection_id: 'connection_id' });\n\nconsole.log(response);\n```", + "perLanguage": { + "typescript": { + "method": "client.connect.sessions.reauthenticate", + "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n clientID: process.env['FINCH_CLIENT_ID'], // This is the default and can be omitted\n clientSecret: process.env['FINCH_CLIENT_SECRET'], // This is the default and can be omitted\n});\n\nconst response = await client.connect.sessions.reauthenticate({ connection_id: 'connection_id' });\n\nconsole.log(response.session_id);" + }, + "python": { + "method": "connect.sessions.reauthenticate", + "example": "import os\nfrom finch import Finch\n\nclient = Finch(\n client_id=os.environ.get(\"FINCH_CLIENT_ID\"), # This is the default and can be omitted\n client_secret=os.environ.get(\"FINCH_CLIENT_SECRET\"), # This is the default and can be omitted\n)\nresponse = client.connect.sessions.reauthenticate(\n connection_id=\"connection_id\",\n)\nprint(response.session_id)" + }, + "java": { + "method": "connect().sessions().reauthenticate", + "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.ConnectSessionReauthenticateParams;\nimport com.tryfinch.api.models.SessionReauthenticateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.fromEnv();\n\n ConnectSessionReauthenticateParams params = ConnectSessionReauthenticateParams.builder()\n .connectionId(\"connection_id\")\n .build();\n SessionReauthenticateResponse response = client.connect().sessions().reauthenticate(params);\n }\n}" + }, + "kotlin": { + "method": "connect().sessions().reauthenticate", + "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.ConnectSessionReauthenticateParams\nimport com.tryfinch.api.models.SessionReauthenticateResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.fromEnv()\n\n val params: ConnectSessionReauthenticateParams = ConnectSessionReauthenticateParams.builder()\n .connectionId(\"connection_id\")\n .build()\n val response: SessionReauthenticateResponse = client.connect().sessions().reauthenticate(params)\n}" + }, + "go": { + "method": "client.Connect.Sessions.Reauthenticate", + "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithClientID(\"4ab15e51-11ad-49f4-acae-f343b7794375\"),\n\t\toption.WithClientSecret(\"My Client Secret\"),\n\t)\n\tresponse, err := client.Connect.Sessions.Reauthenticate(context.TODO(), finchgo.ConnectSessionReauthenticateParams{\n\t\tConnectionID: finchgo.F(\"connection_id\"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.SessionID)\n}\n" + }, + "ruby": { + "method": "connect.sessions.reauthenticate", + "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(client_id: \"4ab15e51-11ad-49f4-acae-f343b7794375\", client_secret: \"My Client Secret\")\n\nresponse = finch.connect.sessions.reauthenticate(connection_id: \"connection_id\")\n\nputs(response)" + }, + "http": { + "example": "curl https://api.tryfinch.com/connect/sessions/reauthenticate \\\n -H 'Content-Type: application/json' \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -u \"$FINCH_CLIENT_ID:FINCH_CLIENT_SECRET\" \\\n -d '{\n \"connection_id\": \"connection_id\"\n }'" + } + } + } ]; const EMBEDDED_READMES: { language: string; content: string }[] = [ { - language: 'go', - content: - '# Finch Go API Library\n\nGo Reference\n\nThe Finch Go library provides convenient access to the [Finch REST API](https://developer.tryfinch.com/)\nfrom applications written in Go.\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Installation\n\n\n\n```go\nimport (\n\t"github.com/Finch-API/finch-api-go" // imported as SDK_PackageName\n)\n```\n\n\n\nOr to pin the version:\n\n\n\n```sh\ngo get -u \'github.com/Finch-API/finch-api-go@v0.0.1\'\n```\n\n\n\n## Requirements\n\nThis library requires Go 1.22+.\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n```go\npackage main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Directory.List(context.TODO(), finchgo.HRISDirectoryListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n\n```\n\n### Request fields\n\nAll request parameters are wrapped in a generic `Field` type,\nwhich we use to distinguish zero values from null or omitted fields.\n\nThis prevents accidentally sending a zero value if you forget a required parameter,\nand enables explicitly sending `null`, `false`, `\'\'`, or `0` on optional parameters.\nAny field not specified is not sent.\n\nTo construct fields with values, use the helpers `String()`, `Int()`, `Float()`, or most commonly, the generic `F[T]()`.\nTo send a null, use `Null[T]()`, and to send a nonconforming value, use `Raw[T](any)`. For example:\n\n```go\nparams := FooParams{\n\tName: SDK_PackageName.F("hello"),\n\n\t// Explicitly send `"description": null`\n\tDescription: SDK_PackageName.Null[string](),\n\n\tPoint: SDK_PackageName.F(SDK_PackageName.Point{\n\t\tX: SDK_PackageName.Int(0),\n\t\tY: SDK_PackageName.Int(1),\n\n\t\t// In cases where the API specifies a given type,\n\t\t// but you want to send something else, use `Raw`:\n\t\tZ: SDK_PackageName.Raw[int64](0.01), // sends a float\n\t}),\n}\n```\n\n### Response objects\n\nAll fields in response structs are value types (not pointers or wrappers).\n\nIf a given field is `null`, not present, or invalid, the corresponding field\nwill simply be its zero value.\n\nAll response structs also include a special `JSON` field, containing more detailed\ninformation about each property, which you can use like so:\n\n```go\nif res.Name == "" {\n\t// true if `"name"` is either not present or explicitly null\n\tres.JSON.Name.IsNull()\n\n\t// true if the `"name"` key was not present in the response JSON at all\n\tres.JSON.Name.IsMissing()\n\n\t// When the API returns data that cannot be coerced to the expected type:\n\tif res.JSON.Name.IsInvalid() {\n\t\traw := res.JSON.Name.Raw()\n\n\t\tlegacyName := struct{\n\t\t\tFirst string `json:"first"`\n\t\t\tLast string `json:"last"`\n\t\t}{}\n\t\tjson.Unmarshal([]byte(raw), &legacyName)\n\t\tname = legacyName.First + " " + legacyName.Last\n\t}\n}\n```\n\nThese `.JSON` structs also include an `Extras` map containing\nany properties in the json response that were not specified\nin the struct. This can be useful for API features not yet\npresent in the SDK.\n\n```go\nbody := res.JSON.ExtraFields["my_unexpected_field"].Raw()\n```\n\n### RequestOptions\n\nThis library uses the functional options pattern. Functions defined in the\n`SDK_PackageOptionName` package return a `RequestOption`, which is a closure that mutates a\n`RequestConfig`. These options can be supplied to the client or at individual\nrequests. For example:\n\n```go\nclient := SDK_PackageName.SDK_ClientInitializerName(\n\t// Adds a header to every request made by the client\n\tSDK_PackageOptionName.WithHeader("X-Some-Header", "custom_header_info"),\n)\n\nclient.HRIS.Directory.List(context.TODO(), ...,\n\t// Override the header\n\tSDK_PackageOptionName.WithHeader("X-Some-Header", "some_other_custom_header_info"),\n\t// Add an undocumented field to the request body, using sjson syntax\n\tSDK_PackageOptionName.WithJSONSet("some.json.path", map[string]string{"my": "object"}),\n)\n```\n\nSee the [full list of request options](https://pkg.go.dev/github.com/Finch-API/finch-api-go/SDK_PackageOptionName).\n\n### Pagination\n\nThis library provides some conveniences for working with paginated list endpoints.\n\nYou can use `.ListAutoPaging()` methods to iterate through items across all pages:\n\n```go\niter := client.HRIS.Directory.ListAutoPaging(context.TODO(), finchgo.HRISDirectoryListParams{})\n// Automatically fetches more pages as needed.\nfor iter.Next() {\n\tindividualInDirectory := iter.Current()\n\tfmt.Printf("%+v\\n", individualInDirectory)\n}\nif err := iter.Err(); err != nil {\n\tpanic(err.Error())\n}\n```\n\nOr you can use simple `.List()` methods to fetch a single page and receive a standard response object\nwith additional helper methods like `.GetNextPage()`, e.g.:\n\n```go\npage, err := client.HRIS.Directory.List(context.TODO(), finchgo.HRISDirectoryListParams{})\nfor page != nil {\n\tfor _, directory := range page.Individuals {\n\t\tfmt.Printf("%+v\\n", directory)\n\t}\n\tpage, err = page.GetNextPage()\n}\nif err != nil {\n\tpanic(err.Error())\n}\n```\n\n### Errors\n\nWhen the API returns a non-success status code, we return an error with type\n`*SDK_PackageName.Error`. This contains the `StatusCode`, `*http.Request`, and\n`*http.Response` values of the request, as well as the JSON of the error body\n(much like other response objects in the SDK).\n\nTo handle errors, we recommend that you use the `errors.As` pattern:\n\n```go\n_, err := client.HRIS.Company.Get(context.TODO(), finchgo.HRISCompanyGetParams{})\nif err != nil {\n\tvar apierr *finchgo.Error\n\tif errors.As(err, &apierr) {\n\t\tprintln(string(apierr.DumpRequest(true))) // Prints the serialized HTTP request\n\t\tprintln(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response\n\t}\n\tpanic(err.Error()) // GET "/employer/company": 400 Bad Request { ... }\n}\n```\n\nWhen other errors occur, they are returned unwrapped; for example,\nif HTTP transport fails, you might receive `*url.Error` wrapping `*net.OpError`.\n\n### Timeouts\n\nRequests do not time out by default; use context to configure a timeout for a request lifecycle.\n\nNote that if a request is [retried](#retries), the context timeout does not start over.\nTo set a per-retry timeout, use `SDK_PackageOptionName.WithRequestTimeout()`.\n\n```go\n// This sets the timeout for the request, including all the retries.\nctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)\ndefer cancel()\nclient.HRIS.Directory.List(\n\tctx,\n\tfinchgo.HRISDirectoryListParams{},\n\t// This sets the per-retry timeout\n\toption.WithRequestTimeout(20*time.Second),\n)\n```\n\n### File uploads\n\nRequest parameters that correspond to file uploads in multipart requests are typed as\n`param.Field[io.Reader]`. The contents of the `io.Reader` will by default be sent as a multipart form\npart with the file name of "anonymous_file" and content-type of "application/octet-stream".\n\nThe file name and content-type can be customized by implementing `Name() string` or `ContentType()\nstring` on the run-time type of `io.Reader`. Note that `os.File` implements `Name() string`, so a\nfile returned by `os.Open` will be sent with the file name on disk.\n\nWe also provide a helper `SDK_PackageName.FileParam(reader io.Reader, filename string, contentType string)`\nwhich can be used to wrap any `io.Reader` with the appropriate file name and content type.\n\n\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\nWe retry by default all connection errors, 408 Request Timeout, 409 Conflict, 429 Rate Limit,\nand >=500 Internal errors.\n\nYou can use the `WithMaxRetries` option to configure or disable this:\n\n```go\n// Configure the default for all requests:\nclient := finchgo.NewClient(\n\toption.WithMaxRetries(0), // default is 2\n)\n\n// Override per-request:\nclient.HRIS.Directory.List(\n\tcontext.TODO(),\n\tfinchgo.HRISDirectoryListParams{},\n\toption.WithMaxRetries(5),\n)\n```\n\n\n### Accessing raw response data (e.g. response headers)\n\nYou can access the raw HTTP response data by using the `option.WithResponseInto()` request option. This is useful when\nyou need to examine response headers, status codes, or other details.\n\n```go\n// Create a variable to store the HTTP response\nvar response *http.Response\npage, err := client.HRIS.Directory.List(\n\tcontext.TODO(),\n\tfinchgo.HRISDirectoryListParams{},\n\toption.WithResponseInto(&response),\n)\nif err != nil {\n\t// handle error\n}\nfmt.Printf("%+v\\n", page)\n\nfmt.Printf("Status Code: %d\\n", response.StatusCode)\nfmt.Printf("Headers: %+#v\\n", response.Header)\n```\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API. If you need to access undocumented\nendpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can use `client.Get`, `client.Post`, and other HTTP verbs.\n`RequestOptions` on the client, such as retries, will be respected when making these requests.\n\n```go\nvar (\n // params can be an io.Reader, a []byte, an encoding/json serializable object,\n // or a "…Params" struct defined in this library.\n params map[string]interface{}\n\n // result can be an []byte, *http.Response, a encoding/json deserializable object,\n // or a model defined in this library.\n result *http.Response\n)\nerr := client.Post(context.Background(), "/unspecified", params, &result)\nif err != nil {\n …\n}\n```\n\n#### Undocumented request params\n\nTo make requests using undocumented parameters, you may use either the `SDK_PackageOptionName.WithQuerySet()`\nor the `SDK_PackageOptionName.WithJSONSet()` methods.\n\n```go\nparams := FooNewParams{\n ID: SDK_PackageName.F("id_xxxx"),\n Data: SDK_PackageName.F(FooNewParamsData{\n FirstName: SDK_PackageName.F("John"),\n }),\n}\nclient.Foo.New(context.Background(), params, SDK_PackageOptionName.WithJSONSet("data.last_name", "Doe"))\n```\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you may either access the raw JSON of the response as a string\nwith `result.JSON.RawJSON()`, or get the raw JSON of a particular field on the result with\n`result.JSON.Foo.Raw()`.\n\nAny fields that are not present on the response struct will be saved and can be accessed by `result.JSON.ExtraFields()` which returns the extra fields as a `map[string]Field`.\n\n### Middleware\n\nWe provide `SDK_PackageOptionName.WithMiddleware` which applies the given\nmiddleware to requests.\n\n```go\nfunc Logger(req *http.Request, next SDK_PackageOptionName.MiddlewareNext) (res *http.Response, err error) {\n\t// Before the request\n\tstart := time.Now()\n\tLogReq(req)\n\n\t// Forward the request to the next handler\n\tres, err = next(req)\n\n\t// Handle stuff after the request\n\tend := time.Now()\n\tLogRes(res, err, start - end)\n\n return res, err\n}\n\nclient := SDK_PackageName.SDK_ClientInitializerName(\n\tSDK_PackageOptionName.WithMiddleware(Logger),\n)\n```\n\nWhen multiple middlewares are provided as variadic arguments, the middlewares\nare applied left to right. If `SDK_PackageOptionName.WithMiddleware` is given\nmultiple times, for example first in the client then the method, the\nmiddleware in the client will run first and the middleware given in the method\nwill run next.\n\nYou may also replace the default `http.Client` with\n`SDK_PackageOptionName.WithHTTPClient(client)`. Only one http client is\naccepted (this overwrites any previous client) and receives requests after any\nmiddleware has been applied.\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n2. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Finch-API/finch-api-go/issues) with questions, bugs, or suggestions.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n', + "language": "go", + "content": "# Finch Go API Library\n\n\"Go\n\nThe Finch Go library provides convenient access to the [Finch REST API](https://developer.tryfinch.com/)\nfrom applications written in Go.\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Installation\n\n\n\n```go\nimport (\n\t\"github.com/Finch-API/finch-api-go\" // imported as SDK_PackageName\n)\n```\n\n\n\nOr to pin the version:\n\n\n\n```sh\ngo get -u 'github.com/Finch-API/finch-api-go@v0.0.1'\n```\n\n\n\n## Requirements\n\nThis library requires Go 1.22+.\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n```go\npackage main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tpage, err := client.HRIS.Directory.List(context.TODO(), finchgo.HRISDirectoryListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n\n```\n\n### Request fields\n\nAll request parameters are wrapped in a generic `Field` type,\nwhich we use to distinguish zero values from null or omitted fields.\n\nThis prevents accidentally sending a zero value if you forget a required parameter,\nand enables explicitly sending `null`, `false`, `''`, or `0` on optional parameters.\nAny field not specified is not sent.\n\nTo construct fields with values, use the helpers `String()`, `Int()`, `Float()`, or most commonly, the generic `F[T]()`.\nTo send a null, use `Null[T]()`, and to send a nonconforming value, use `Raw[T](any)`. For example:\n\n```go\nparams := FooParams{\n\tName: SDK_PackageName.F(\"hello\"),\n\n\t// Explicitly send `\"description\": null`\n\tDescription: SDK_PackageName.Null[string](),\n\n\tPoint: SDK_PackageName.F(SDK_PackageName.Point{\n\t\tX: SDK_PackageName.Int(0),\n\t\tY: SDK_PackageName.Int(1),\n\n\t\t// In cases where the API specifies a given type,\n\t\t// but you want to send something else, use `Raw`:\n\t\tZ: SDK_PackageName.Raw[int64](0.01), // sends a float\n\t}),\n}\n```\n\n### Response objects\n\nAll fields in response structs are value types (not pointers or wrappers).\n\nIf a given field is `null`, not present, or invalid, the corresponding field\nwill simply be its zero value.\n\nAll response structs also include a special `JSON` field, containing more detailed\ninformation about each property, which you can use like so:\n\n```go\nif res.Name == \"\" {\n\t// true if `\"name\"` is either not present or explicitly null\n\tres.JSON.Name.IsNull()\n\n\t// true if the `\"name\"` key was not present in the response JSON at all\n\tres.JSON.Name.IsMissing()\n\n\t// When the API returns data that cannot be coerced to the expected type:\n\tif res.JSON.Name.IsInvalid() {\n\t\traw := res.JSON.Name.Raw()\n\n\t\tlegacyName := struct{\n\t\t\tFirst string `json:\"first\"`\n\t\t\tLast string `json:\"last\"`\n\t\t}{}\n\t\tjson.Unmarshal([]byte(raw), &legacyName)\n\t\tname = legacyName.First + \" \" + legacyName.Last\n\t}\n}\n```\n\nThese `.JSON` structs also include an `Extras` map containing\nany properties in the json response that were not specified\nin the struct. This can be useful for API features not yet\npresent in the SDK.\n\n```go\nbody := res.JSON.ExtraFields[\"my_unexpected_field\"].Raw()\n```\n\n### RequestOptions\n\nThis library uses the functional options pattern. Functions defined in the\n`SDK_PackageOptionName` package return a `RequestOption`, which is a closure that mutates a\n`RequestConfig`. These options can be supplied to the client or at individual\nrequests. For example:\n\n```go\nclient := SDK_PackageName.SDK_ClientInitializerName(\n\t// Adds a header to every request made by the client\n\tSDK_PackageOptionName.WithHeader(\"X-Some-Header\", \"custom_header_info\"),\n)\n\nclient.HRIS.Directory.List(context.TODO(), ...,\n\t// Override the header\n\tSDK_PackageOptionName.WithHeader(\"X-Some-Header\", \"some_other_custom_header_info\"),\n\t// Add an undocumented field to the request body, using sjson syntax\n\tSDK_PackageOptionName.WithJSONSet(\"some.json.path\", map[string]string{\"my\": \"object\"}),\n)\n```\n\nSee the [full list of request options](https://pkg.go.dev/github.com/Finch-API/finch-api-go/SDK_PackageOptionName).\n\n### Pagination\n\nThis library provides some conveniences for working with paginated list endpoints.\n\nYou can use `.ListAutoPaging()` methods to iterate through items across all pages:\n\n```go\niter := client.HRIS.Directory.ListAutoPaging(context.TODO(), finchgo.HRISDirectoryListParams{})\n// Automatically fetches more pages as needed.\nfor iter.Next() {\n\tindividualInDirectory := iter.Current()\n\tfmt.Printf(\"%+v\\n\", individualInDirectory)\n}\nif err := iter.Err(); err != nil {\n\tpanic(err.Error())\n}\n```\n\nOr you can use simple `.List()` methods to fetch a single page and receive a standard response object\nwith additional helper methods like `.GetNextPage()`, e.g.:\n\n```go\npage, err := client.HRIS.Directory.List(context.TODO(), finchgo.HRISDirectoryListParams{})\nfor page != nil {\n\tfor _, directory := range page.Individuals {\n\t\tfmt.Printf(\"%+v\\n\", directory)\n\t}\n\tpage, err = page.GetNextPage()\n}\nif err != nil {\n\tpanic(err.Error())\n}\n```\n\n### Errors\n\nWhen the API returns a non-success status code, we return an error with type\n`*SDK_PackageName.Error`. This contains the `StatusCode`, `*http.Request`, and\n`*http.Response` values of the request, as well as the JSON of the error body\n(much like other response objects in the SDK).\n\nTo handle errors, we recommend that you use the `errors.As` pattern:\n\n```go\n_, err := client.HRIS.Company.Get(context.TODO(), finchgo.HRISCompanyGetParams{})\nif err != nil {\n\tvar apierr *finchgo.Error\n\tif errors.As(err, &apierr) {\n\t\tprintln(string(apierr.DumpRequest(true))) // Prints the serialized HTTP request\n\t\tprintln(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response\n\t}\n\tpanic(err.Error()) // GET \"/employer/company\": 400 Bad Request { ... }\n}\n```\n\nWhen other errors occur, they are returned unwrapped; for example,\nif HTTP transport fails, you might receive `*url.Error` wrapping `*net.OpError`.\n\n### Timeouts\n\nRequests do not time out by default; use context to configure a timeout for a request lifecycle.\n\nNote that if a request is [retried](#retries), the context timeout does not start over.\nTo set a per-retry timeout, use `SDK_PackageOptionName.WithRequestTimeout()`.\n\n```go\n// This sets the timeout for the request, including all the retries.\nctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)\ndefer cancel()\nclient.HRIS.Directory.List(\n\tctx,\n\tfinchgo.HRISDirectoryListParams{},\n\t// This sets the per-retry timeout\n\toption.WithRequestTimeout(20*time.Second),\n)\n```\n\n### File uploads\n\nRequest parameters that correspond to file uploads in multipart requests are typed as\n`param.Field[io.Reader]`. The contents of the `io.Reader` will by default be sent as a multipart form\npart with the file name of \"anonymous_file\" and content-type of \"application/octet-stream\".\n\nThe file name and content-type can be customized by implementing `Name() string` or `ContentType()\nstring` on the run-time type of `io.Reader`. Note that `os.File` implements `Name() string`, so a\nfile returned by `os.Open` will be sent with the file name on disk.\n\nWe also provide a helper `SDK_PackageName.FileParam(reader io.Reader, filename string, contentType string)`\nwhich can be used to wrap any `io.Reader` with the appropriate file name and content type.\n\n\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\nWe retry by default all connection errors, 408 Request Timeout, 409 Conflict, 429 Rate Limit,\nand >=500 Internal errors.\n\nYou can use the `WithMaxRetries` option to configure or disable this:\n\n```go\n// Configure the default for all requests:\nclient := finchgo.NewClient(\n\toption.WithMaxRetries(0), // default is 2\n)\n\n// Override per-request:\nclient.HRIS.Directory.List(\n\tcontext.TODO(),\n\tfinchgo.HRISDirectoryListParams{},\n\toption.WithMaxRetries(5),\n)\n```\n\n\n### Accessing raw response data (e.g. response headers)\n\nYou can access the raw HTTP response data by using the `option.WithResponseInto()` request option. This is useful when\nyou need to examine response headers, status codes, or other details.\n\n```go\n// Create a variable to store the HTTP response\nvar response *http.Response\npage, err := client.HRIS.Directory.List(\n\tcontext.TODO(),\n\tfinchgo.HRISDirectoryListParams{},\n\toption.WithResponseInto(&response),\n)\nif err != nil {\n\t// handle error\n}\nfmt.Printf(\"%+v\\n\", page)\n\nfmt.Printf(\"Status Code: %d\\n\", response.StatusCode)\nfmt.Printf(\"Headers: %+#v\\n\", response.Header)\n```\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API. If you need to access undocumented\nendpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can use `client.Get`, `client.Post`, and other HTTP verbs.\n`RequestOptions` on the client, such as retries, will be respected when making these requests.\n\n```go\nvar (\n // params can be an io.Reader, a []byte, an encoding/json serializable object,\n // or a \"…Params\" struct defined in this library.\n params map[string]interface{}\n\n // result can be an []byte, *http.Response, a encoding/json deserializable object,\n // or a model defined in this library.\n result *http.Response\n)\nerr := client.Post(context.Background(), \"/unspecified\", params, &result)\nif err != nil {\n …\n}\n```\n\n#### Undocumented request params\n\nTo make requests using undocumented parameters, you may use either the `SDK_PackageOptionName.WithQuerySet()`\nor the `SDK_PackageOptionName.WithJSONSet()` methods.\n\n```go\nparams := FooNewParams{\n ID: SDK_PackageName.F(\"id_xxxx\"),\n Data: SDK_PackageName.F(FooNewParamsData{\n FirstName: SDK_PackageName.F(\"John\"),\n }),\n}\nclient.Foo.New(context.Background(), params, SDK_PackageOptionName.WithJSONSet(\"data.last_name\", \"Doe\"))\n```\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you may either access the raw JSON of the response as a string\nwith `result.JSON.RawJSON()`, or get the raw JSON of a particular field on the result with\n`result.JSON.Foo.Raw()`.\n\nAny fields that are not present on the response struct will be saved and can be accessed by `result.JSON.ExtraFields()` which returns the extra fields as a `map[string]Field`.\n\n### Middleware\n\nWe provide `SDK_PackageOptionName.WithMiddleware` which applies the given\nmiddleware to requests.\n\n```go\nfunc Logger(req *http.Request, next SDK_PackageOptionName.MiddlewareNext) (res *http.Response, err error) {\n\t// Before the request\n\tstart := time.Now()\n\tLogReq(req)\n\n\t// Forward the request to the next handler\n\tres, err = next(req)\n\n\t// Handle stuff after the request\n\tend := time.Now()\n\tLogRes(res, err, start - end)\n\n return res, err\n}\n\nclient := SDK_PackageName.SDK_ClientInitializerName(\n\tSDK_PackageOptionName.WithMiddleware(Logger),\n)\n```\n\nWhen multiple middlewares are provided as variadic arguments, the middlewares\nare applied left to right. If `SDK_PackageOptionName.WithMiddleware` is given\nmultiple times, for example first in the client then the method, the\nmiddleware in the client will run first and the middleware given in the method\nwill run next.\n\nYou may also replace the default `http.Client` with\n`SDK_PackageOptionName.WithHTTPClient(client)`. Only one http client is\naccepted (this overwrites any previous client) and receives requests after any\nmiddleware has been applied.\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n2. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Finch-API/finch-api-go/issues) with questions, bugs, or suggestions.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n" }, { - language: 'java', - content: - '# Finch Java API Library\n\n\n[![Maven Central](https://img.shields.io/maven-central/v/com.tryfinch.api/finch-java)](https://central.sonatype.com/artifact/com.tryfinch.api/finch-java/0.0.1)\n[![javadoc](https://javadoc.io/badge2/com.tryfinch.api/finch-java/0.0.1/javadoc.svg)](https://javadoc.io/doc/com.tryfinch.api/finch-java/0.0.1)\n\n\nThe Finch Java SDK provides convenient access to the [Finch REST API](https://developer.tryfinch.com/) from applications written in Java.\n\nThe Finch Java SDK is similar to the Finch Kotlin SDK but with minor differences that make it more ergonomic for use in Java, such as `Optional` instead of nullable values, `Stream` instead of `Sequence`, and `CompletableFuture` instead of suspend functions.\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n\n\nThe REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/). Javadocs are available on [javadoc.io](https://javadoc.io/doc/com.tryfinch.api/finch-java/0.0.1).\n\n\n\n## Installation\n\n\n\n### Gradle\n\n~~~kotlin\nimplementation("com.tryfinch.api:finch-java:0.0.1")\n~~~\n\n### Maven\n\n~~~xml\n\n com.tryfinch.api\n finch-java\n 0.0.1\n\n~~~\n\n\n\n## Requirements\n\nThis library requires Java 8 or later.\n\n## Usage\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisDirectoryListPage;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\nFinchClient client = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\nHrisDirectoryListPage page = client.hris().directory().list();\n```\n\n## Client configuration\n\nConfigure the client using system properties or environment variables:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n```\n\nOr manually:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n .accessToken("My Access Token")\n .build();\n```\n\nOr using a combination of the two approaches:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n```\n\nSee this table for the available options:\n\n| Setter | System property | Environment variable | Required | Default value |\n| --------------- | --------------------- | ---------------------- | -------- | ---------------------------- |\n| `clientId` | `finch.clientId` | `FINCH_CLIENT_ID` | false | - |\n| `clientSecret` | `finch.clientSecret` | `FINCH_CLIENT_SECRET` | false | - |\n| `webhookSecret` | `finch.webhookSecret` | `FINCH_WEBHOOK_SECRET` | false | - |\n| `baseUrl` | `finch.baseUrl` | `FINCH_BASE_URL` | true | `"https://api.tryfinch.com"` |\n\nSystem properties take precedence over environment variables.\n\n> [!TIP]\n> Don\'t create more than one client in the same application. Each client has a connection pool and\n> thread pools, which are more efficient to share between requests.\n\n### Modifying configuration\n\nTo temporarily use a modified client configuration, while reusing the same connection and thread pools, call `withOptions()` on any client or service:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\n\nFinchClient clientWithOptions = client.withOptions(optionsBuilder -> {\n optionsBuilder.baseUrl("https://example.com");\n optionsBuilder.maxRetries(42);\n});\n```\n\nThe `withOptions()` method does not affect the original client or service.\n\n## Requests and responses\n\nTo send a request to the Finch API, build an instance of some `Params` class and pass it to the corresponding client method. When the response is received, it will be deserialized into an instance of a Java class.\n\nFor example, `client.hris().directory().list(...)` should be called with an instance of `HrisDirectoryListParams`, and it will return an instance of `HrisDirectoryListPage`.\n\n## Immutability\n\nEach class in the SDK has an associated [builder](https://blogs.oracle.com/javamagazine/post/exploring-joshua-blochs-builder-design-pattern-in-java) or factory method for constructing it.\n\nEach class is [immutable](https://docs.oracle.com/javase/tutorial/essential/concurrency/immutable.html) once constructed. If the class has an associated builder, then it has a `toBuilder()` method, which can be used to convert it back to a builder for making a modified copy.\n\nBecause each class is immutable, builder modification will _never_ affect already built class instances.\n\n## Asynchronous execution\n\nThe default client is synchronous. To switch to asynchronous execution, call the `async()` method:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\nimport java.util.concurrent.CompletableFuture;\n\nFinchClient client = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\nCompletableFuture page = client.async().hris().directory().list();\n```\n\nOr create an asynchronous client from the beginning:\n\n```java\nimport com.tryfinch.api.client.FinchClientAsync;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClientAsync;\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\nimport java.util.concurrent.CompletableFuture;\n\nFinchClientAsync client = FinchOkHttpClientAsync.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\nCompletableFuture page = client.hris().directory().list();\n```\n\nThe asynchronous client supports the same options as the synchronous one, except most methods return `CompletableFuture`s.\n\n\n\n\n\n\n\n## Raw responses\n\nThe SDK defines methods that deserialize responses into instances of Java classes. However, these methods don\'t provide access to the response headers, status code, or the raw response body.\n\nTo access this data, prefix any HTTP method call on a client or service with `withRawResponse()`:\n\n```java\nimport com.tryfinch.api.core.http.Headers;\nimport com.tryfinch.api.core.http.HttpResponseFor;\nimport com.tryfinch.api.models.HrisDirectoryListPage;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\nHttpResponseFor page = client.hris().directory().withRawResponse().list();\n\nint statusCode = page.statusCode();\nHeaders headers = page.headers();\n```\n\nYou can still deserialize the response into an instance of a Java class if needed:\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListPage;\n\nHrisDirectoryListPage parsedPage = page.parse();\n```\n\n## Error handling\n\nThe SDK throws custom unchecked exception types:\n\n- [`FinchServiceException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchServiceException.kt): Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:\n\n | Status | Exception |\n | ------ | -------------------------------------------------- |\n | 400 | [`BadRequestException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/BadRequestException.kt) |\n | 401 | [`UnauthorizedException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/UnauthorizedException.kt) |\n | 403 | [`PermissionDeniedException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/PermissionDeniedException.kt) |\n | 404 | [`NotFoundException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/NotFoundException.kt) |\n | 422 | [`UnprocessableEntityException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/UnprocessableEntityException.kt) |\n | 429 | [`RateLimitException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/RateLimitException.kt) |\n | 5xx | [`InternalServerException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/InternalServerException.kt) |\n | others | [`UnexpectedStatusCodeException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/UnexpectedStatusCodeException.kt) |\n\n- [`FinchIoException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchIoException.kt): I/O networking errors.\n\n- [`FinchRetryableException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchRetryableException.kt): Generic error indicating a failure that could be retried by the client.\n\n- [`FinchInvalidDataException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchInvalidDataException.kt): Failure to interpret successfully parsed data. For example, when accessing a property that\'s supposed to be required, but the API unexpectedly omitted it from the response.\n\n- [`FinchException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchException.kt): Base class for all exceptions. Most errors will result in one of the previously mentioned ones, but completely generic errors may be thrown using the base class.\n\n## Pagination\n\nThe SDK defines methods that return a paginated lists of results. It provides convenient ways to access the results either one page at a time or item-by-item across all pages.\n\n### Auto-pagination\n\nTo iterate through all results across all pages, use the `autoPager()` method, which automatically fetches more pages as needed.\n\nWhen using the synchronous client, the method returns an [`Iterable`](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html)\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListPage;\nimport com.tryfinch.api.models.IndividualInDirectory;\n\nHrisDirectoryListPage page = client.hris().directory().list();\n\n// Process as an Iterable\nfor (IndividualInDirectory directory : page.autoPager()) {\n System.out.println(directory);\n}\n\n// Process as a Stream\npage.autoPager()\n .stream()\n .limit(50)\n .forEach(directory -> System.out.println(directory));\n```\n\nWhen using the asynchronous client, the method returns an [`AsyncStreamResponse`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/http/AsyncStreamResponse.kt):\n\n```java\nimport com.tryfinch.api.core.http.AsyncStreamResponse;\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync;\nimport com.tryfinch.api.models.IndividualInDirectory;\nimport java.util.Optional;\nimport java.util.concurrent.CompletableFuture;\n\nCompletableFuture pageFuture = client.async().hris().directory().list();\n\npageFuture.thenRun(page -> page.autoPager().subscribe(directory -> {\n System.out.println(directory);\n}));\n\n// If you need to handle errors or completion of the stream\npageFuture.thenRun(page -> page.autoPager().subscribe(new AsyncStreamResponse.Handler<>() {\n @Override\n public void onNext(IndividualInDirectory directory) {\n System.out.println(directory);\n }\n\n @Override\n public void onComplete(Optional error) {\n if (error.isPresent()) {\n System.out.println("Something went wrong!");\n throw new RuntimeException(error.get());\n } else {\n System.out.println("No more!");\n }\n }\n}));\n\n// Or use futures\npageFuture.thenRun(page -> page.autoPager()\n .subscribe(directory -> {\n System.out.println(directory);\n })\n .onCompleteFuture()\n .whenComplete((unused, error) -> {\n if (error != null) {\n System.out.println("Something went wrong!");\n throw new RuntimeException(error);\n } else {\n System.out.println("No more!");\n }\n }));\n```\n\n### Manual pagination\n\nTo access individual page items and manually request the next page, use the `items()`,\n`hasNextPage()`, and `nextPage()` methods:\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListPage;\nimport com.tryfinch.api.models.IndividualInDirectory;\n\nHrisDirectoryListPage page = client.hris().directory().list();\nwhile (true) {\n for (IndividualInDirectory directory : page.items()) {\n System.out.println(directory);\n }\n\n if (!page.hasNextPage()) {\n break;\n }\n\n page = page.nextPage();\n}\n```\n\n## Logging\n\nThe SDK uses the standard [OkHttp logging interceptor](https://github.com/square/okhttp/tree/master/okhttp-logging-interceptor).\n\nEnable logging by setting the `FINCH_LOG` environment variable to `info`:\n\n```sh\nexport FINCH_LOG=info\n```\n\nOr to `debug` for more verbose logging:\n\n```sh\nexport FINCH_LOG=debug\n```\n\n## ProGuard and R8\n\nAlthough the SDK uses reflection, it is still usable with [ProGuard](https://github.com/Guardsquare/proguard) and [R8](https://developer.android.com/topic/performance/app-optimization/enable-app-optimization) because `finch-java-core` is published with a [configuration file](finch-java-core/src/main/resources/META-INF/proguard/finch-java-core.pro) containing [keep rules](https://www.guardsquare.com/manual/configuration/usage).\n\nProGuard and R8 should automatically detect and use the published rules, but you can also manually copy the keep rules if necessary.\n\n\n\n\n\n## Jackson\n\nThe SDK depends on [Jackson](https://github.com/FasterXML/jackson) for JSON serialization/deserialization. It is compatible with version 2.13.4 or higher, but depends on version 2.18.2 by default.\n\nThe SDK throws an exception if it detects an incompatible Jackson version at runtime (e.g. if the default version was overridden in your Maven or Gradle config).\n\nIf the SDK threw an exception, but you\'re _certain_ the version is compatible, then disable the version check using the `checkJacksonVersionCompatibility` on [`FinchOkHttpClient`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt).\n\n> [!CAUTION]\n> We make no guarantee that the SDK works correctly when the Jackson version check is disabled.\n\nAlso note that there are bugs in older Jackson versions that can affect the SDK. We don\'t work around all Jackson bugs ([example](https://github.com/FasterXML/jackson-databind/issues/3240)) and expect users to upgrade Jackson for those instead.\n\n## Network options\n\n### Retries\n\nThe SDK automatically retries 2 times by default, with a short exponential backoff between requests.\n\nOnly the following error types are retried:\n- Connection errors (for example, due to a network connectivity problem)\n- 408 Request Timeout\n- 409 Conflict\n- 429 Rate Limit\n- 5xx Internal\n\nThe API may also explicitly instruct the SDK to retry or not retry a request.\n\nTo set a custom number of retries, configure the client using the `maxRetries` method:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .maxRetries(4)\n .accessToken("My Access Token")\n .build();\n```\n\n### Timeouts\n\nRequests time out after 1 minute by default.\n\nTo set a custom timeout, configure the method call using the `timeout` method:\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListPage;\n\nHrisDirectoryListPage page = client.hris().directory().list(RequestOptions.builder().timeout(Duration.ofSeconds(30)).build());\n```\n\nOr configure the default for all method calls at the client level:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport java.time.Duration;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .timeout(Duration.ofSeconds(30))\n .accessToken("My Access Token")\n .build();\n```\n\n### Proxies\n\nTo route requests through a proxy, configure the client using the `proxy` method:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport java.net.InetSocketAddress;\nimport java.net.Proxy;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .proxy(new Proxy(\n Proxy.Type.HTTP, new InetSocketAddress(\n "https://example.com", 8080\n )\n ))\n .accessToken("My Access Token")\n .build();\n```\n\n### Connection pooling\n\nTo customize the underlying OkHttp connection pool, configure the client using the `maxIdleConnections` and `keepAliveDuration` methods:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport java.time.Duration;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n // If `maxIdleConnections` is set, then `keepAliveDuration` must be set, and vice versa.\n .maxIdleConnections(10)\n .keepAliveDuration(Duration.ofMinutes(2))\n .accessToken("My Access Token")\n .build();\n```\n\nIf both options are unset, OkHttp\'s default connection pool settings are used.\n\n### HTTPS\n\n> [!NOTE]\n> Most applications should not call these methods, and instead use the system defaults. The defaults include\n> special optimizations that can be lost if the implementations are modified.\n\nTo configure how HTTPS connections are secured, configure the client using the `sslSocketFactory`, `trustManager`, and `hostnameVerifier` methods:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n // If `sslSocketFactory` is set, then `trustManager` must be set, and vice versa.\n .sslSocketFactory(yourSSLSocketFactory)\n .trustManager(yourTrustManager)\n .hostnameVerifier(yourHostnameVerifier)\n .accessToken("My Access Token")\n .build();\n```\n\n\n\n### Custom HTTP client\n\nThe SDK consists of three artifacts:\n- `finch-java-core`\n - Contains core SDK logic\n - Does not depend on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`FinchClient`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClient.kt), [`FinchClientAsync`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsync.kt), [`FinchClientImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt), and [`FinchClientAsyncImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), all of which can work with any HTTP client\n- `finch-java-client-okhttp`\n - Depends on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`FinchOkHttpClient`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) and [`FinchOkHttpClientAsync`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), which provide a way to construct [`FinchClientImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) and [`FinchClientAsyncImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), respectively, using OkHttp\n- `finch-java`\n - Depends on and exposes the APIs of both `finch-java-core` and `finch-java-client-okhttp`\n - Does not have its own logic\n\nThis structure allows replacing the SDK\'s default HTTP client without pulling in unnecessary dependencies.\n\n#### Customized [`OkHttpClient`](https://square.github.io/okhttp/3.x/okhttp/okhttp3/OkHttpClient.html)\n\n> [!TIP]\n> Try the available [network options](#network-options) before replacing the default client.\n\nTo use a customized `OkHttpClient`:\n\n1. Replace your [`finch-java` dependency](#installation) with `finch-java-core`\n2. Copy `finch-java-client-okhttp`\'s [`OkHttpClient`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/OkHttpClient.kt) class into your code and customize it\n3. Construct [`FinchClientImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) or [`FinchClientAsyncImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), similarly to [`FinchOkHttpClient`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), using your customized client\n\n### Completely custom HTTP client\n\nTo use a completely custom HTTP client:\n\n1. Replace your [`finch-java` dependency](#installation) with `finch-java-core`\n2. Write a class that implements the [`HttpClient`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/http/HttpClient.kt) interface\n3. Construct [`FinchClientImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) or [`FinchClientAsyncImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), similarly to [`FinchOkHttpClient`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), using your new client class\n\n## Undocumented API functionality\n\nThe SDK is typed for convenient usage of the documented API. However, it also supports working with undocumented or not yet supported parts of the API.\n\n### Parameters\n\nTo set undocumented parameters, call the `putAdditionalHeader`, `putAdditionalQueryParam`, or `putAdditionalBodyProperty` methods on any `Params` class:\n\n```java\nimport com.tryfinch.api.core.JsonValue;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\nHrisDirectoryListParams params = HrisDirectoryListParams.builder()\n .putAdditionalHeader("Secret-Header", "42")\n .putAdditionalQueryParam("secret_query_param", "42")\n .putAdditionalBodyProperty("secretProperty", JsonValue.from("42"))\n .build();\n```\n\nThese can be accessed on the built object later using the `_additionalHeaders()`, `_additionalQueryParams()`, and `_additionalBodyProperties()` methods.\n\nTo set a documented parameter or property to an undocumented or not yet supported _value_, pass a [`JsonValue`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/Values.kt) object to its setter:\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\nHrisDirectoryListParams params = HrisDirectoryListParams.builder().build();\n```\n\nThe most straightforward way to create a [`JsonValue`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/Values.kt) is using its `from(...)` method:\n\n```java\nimport com.tryfinch.api.core.JsonValue;\nimport java.util.List;\nimport java.util.Map;\n\n// Create primitive JSON values\nJsonValue nullValue = JsonValue.from(null);\nJsonValue booleanValue = JsonValue.from(true);\nJsonValue numberValue = JsonValue.from(42);\nJsonValue stringValue = JsonValue.from("Hello World!");\n\n// Create a JSON array value equivalent to `["Hello", "World"]`\nJsonValue arrayValue = JsonValue.from(List.of(\n "Hello", "World"\n));\n\n// Create a JSON object value equivalent to `{ "a": 1, "b": 2 }`\nJsonValue objectValue = JsonValue.from(Map.of(\n "a", 1,\n "b", 2\n));\n\n// Create an arbitrarily nested JSON equivalent to:\n// {\n// "a": [1, 2],\n// "b": [3, 4]\n// }\nJsonValue complexValue = JsonValue.from(Map.of(\n "a", List.of(\n 1, 2\n ),\n "b", List.of(\n 3, 4\n )\n));\n```\n\nNormally a `Builder` class\'s `build` method will throw [`IllegalStateException`](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) if any required parameter or property is unset.\n\nTo forcibly omit a required parameter or property, pass [`JsonMissing`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/Values.kt):\n\n```java\nimport com.tryfinch.api.core.JsonMissing;\nimport com.tryfinch.api.models.AccessTokenCreateParams;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\nHrisDirectoryListParams params = AccessTokenCreateParams.builder()\n .code(JsonMissing.of())\n .build();\n```\n\n### Response properties\n\nTo access undocumented response properties, call the `_additionalProperties()` method:\n\n```java\nimport com.tryfinch.api.core.JsonValue;\nimport java.util.Map;\n\nMap additionalProperties = client.accessTokens().create(params)._additionalProperties();\nJsonValue secretPropertyValue = additionalProperties.get("secretProperty");\n\nString result = secretPropertyValue.accept(new JsonValue.Visitor<>() {\n @Override\n public String visitNull() {\n return "It\'s null!";\n }\n\n @Override\n public String visitBoolean(boolean value) {\n return "It\'s a boolean!";\n }\n\n @Override\n public String visitNumber(Number value) {\n return "It\'s a number!";\n }\n\n // Other methods include `visitMissing`, `visitString`, `visitArray`, and `visitObject`\n // The default implementation of each unimplemented method delegates to `visitDefault`, which throws by default, but can also be overridden\n});\n```\n\nTo access a property\'s raw JSON value, which may be undocumented, call its `_` prefixed method:\n\n```java\nimport com.tryfinch.api.core.JsonField;\nimport java.util.Optional;\n\nJsonField code = client.accessTokens().create(params)._code();\n\nif (code.isMissing()) {\n // The property is absent from the JSON response\n} else if (code.isNull()) {\n // The property was set to literal null\n} else {\n // Check if value was provided as a string\n // Other methods include `asNumber()`, `asBoolean()`, etc.\n Optional jsonString = code.asString();\n\n // Try to deserialize into a custom type\n MyClass myObject = code.asUnknown().orElseThrow().convert(MyClass.class);\n}\n```\n\n### Response validation\n\nIn rare cases, the API may return a response that doesn\'t match the expected type. For example, the SDK may expect a property to contain a `String`, but the API could return something else.\n\nBy default, the SDK will not throw an exception in this case. It will throw [`FinchInvalidDataException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchInvalidDataException.kt) only if you directly access the property.\n\nIf you would prefer to check that the response is completely well-typed upfront, then either call `validate()`:\n\n```java\nimport com.tryfinch.api.models.CreateAccessTokenResponse;\n\nCreateAccessTokenResponse createAccessTokenResponse = client.accessTokens().create(params).validate();\n```\n\nOr configure the method call to validate the response using the `responseValidation` method:\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListPage;\n\nHrisDirectoryListPage page = client.hris().directory().list(RequestOptions.builder().responseValidation(true).build());\n```\n\nOr configure the default for all method calls at the client level:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .responseValidation(true)\n .accessToken("My Access Token")\n .build();\n```\n\n## FAQ\n\n### Why don\'t you use plain `enum` classes?\n\nJava `enum` classes are not trivially [forwards compatible](https://www.stainless.com/blog/making-java-enums-forwards-compatible). Using them in the SDK could cause runtime exceptions if the API is updated to respond with a new enum value.\n\n### Why do you represent fields using `JsonField` instead of just plain `T`?\n\nUsing `JsonField` enables a few features:\n\n- Allowing usage of [undocumented API functionality](#undocumented-api-functionality)\n- Lazily [validating the API response against the expected shape](#response-validation)\n- Representing absent vs explicitly null values\n\n### Why don\'t you use [`data` classes](https://kotlinlang.org/docs/data-classes.html)?\n\nIt is not [backwards compatible to add new fields to a data class](https://kotlinlang.org/docs/api-guidelines-backward-compatibility.html#avoid-using-data-classes-in-your-api) and we don\'t want to introduce a breaking change every time we add a field to a class.\n\n### Why don\'t you use checked exceptions?\n\nChecked exceptions are widely considered a mistake in the Java programming language. In fact, they were omitted from Kotlin for this reason.\n\nChecked exceptions:\n\n- Are verbose to handle\n- Encourage error handling at the wrong level of abstraction, where nothing can be done about the error\n- Are tedious to propagate due to the [function coloring problem](https://journal.stuffwithstuff.com/2015/02/01/what-color-is-your-function)\n- Don\'t play well with lambdas (also due to the function coloring problem)\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n2. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Finch-API/finch-api-java/issues) with questions, bugs, or suggestions.\n', + "language": "java", + "content": "# Finch Java API Library\n\n\n[![Maven Central](https://img.shields.io/maven-central/v/com.tryfinch.api/finch-java)](https://central.sonatype.com/artifact/com.tryfinch.api/finch-java/0.0.1)\n[![javadoc](https://javadoc.io/badge2/com.tryfinch.api/finch-java/0.0.1/javadoc.svg)](https://javadoc.io/doc/com.tryfinch.api/finch-java/0.0.1)\n\n\nThe Finch Java SDK provides convenient access to the [Finch REST API](https://developer.tryfinch.com/) from applications written in Java.\n\nThe Finch Java SDK is similar to the Finch Kotlin SDK but with minor differences that make it more ergonomic for use in Java, such as `Optional` instead of nullable values, `Stream` instead of `Sequence`, and `CompletableFuture` instead of suspend functions.\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n\n\nThe REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/). Javadocs are available on [javadoc.io](https://javadoc.io/doc/com.tryfinch.api/finch-java/0.0.1).\n\n\n\n## Installation\n\n\n\n### Gradle\n\n~~~kotlin\nimplementation(\"com.tryfinch.api:finch-java:0.0.1\")\n~~~\n\n### Maven\n\n~~~xml\n\n com.tryfinch.api\n finch-java\n 0.0.1\n\n~~~\n\n\n\n## Requirements\n\nThis library requires Java 8 or later.\n\n## Usage\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisDirectoryListPage;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\nFinchClient client = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\nHrisDirectoryListPage page = client.hris().directory().list();\n```\n\n## Client configuration\n\nConfigure the client using system properties or environment variables:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n```\n\nOr manually:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n .accessToken(\"My Access Token\")\n .build();\n```\n\nOr using a combination of the two approaches:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n```\n\nSee this table for the available options:\n\n| Setter | System property | Environment variable | Required | Default value |\n| --------------- | --------------------- | ---------------------- | -------- | ---------------------------- |\n| `clientId` | `finch.clientId` | `FINCH_CLIENT_ID` | false | - |\n| `clientSecret` | `finch.clientSecret` | `FINCH_CLIENT_SECRET` | false | - |\n| `webhookSecret` | `finch.webhookSecret` | `FINCH_WEBHOOK_SECRET` | false | - |\n| `baseUrl` | `finch.baseUrl` | `FINCH_BASE_URL` | true | `\"https://api.tryfinch.com\"` |\n\nSystem properties take precedence over environment variables.\n\n> [!TIP]\n> Don't create more than one client in the same application. Each client has a connection pool and\n> thread pools, which are more efficient to share between requests.\n\n### Modifying configuration\n\nTo temporarily use a modified client configuration, while reusing the same connection and thread pools, call `withOptions()` on any client or service:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\n\nFinchClient clientWithOptions = client.withOptions(optionsBuilder -> {\n optionsBuilder.baseUrl(\"https://example.com\");\n optionsBuilder.maxRetries(42);\n});\n```\n\nThe `withOptions()` method does not affect the original client or service.\n\n## Requests and responses\n\nTo send a request to the Finch API, build an instance of some `Params` class and pass it to the corresponding client method. When the response is received, it will be deserialized into an instance of a Java class.\n\nFor example, `client.hris().directory().list(...)` should be called with an instance of `HrisDirectoryListParams`, and it will return an instance of `HrisDirectoryListPage`.\n\n## Immutability\n\nEach class in the SDK has an associated [builder](https://blogs.oracle.com/javamagazine/post/exploring-joshua-blochs-builder-design-pattern-in-java) or factory method for constructing it.\n\nEach class is [immutable](https://docs.oracle.com/javase/tutorial/essential/concurrency/immutable.html) once constructed. If the class has an associated builder, then it has a `toBuilder()` method, which can be used to convert it back to a builder for making a modified copy.\n\nBecause each class is immutable, builder modification will _never_ affect already built class instances.\n\n## Asynchronous execution\n\nThe default client is synchronous. To switch to asynchronous execution, call the `async()` method:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\nimport java.util.concurrent.CompletableFuture;\n\nFinchClient client = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\nCompletableFuture page = client.async().hris().directory().list();\n```\n\nOr create an asynchronous client from the beginning:\n\n```java\nimport com.tryfinch.api.client.FinchClientAsync;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClientAsync;\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\nimport java.util.concurrent.CompletableFuture;\n\nFinchClientAsync client = FinchOkHttpClientAsync.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\nCompletableFuture page = client.hris().directory().list();\n```\n\nThe asynchronous client supports the same options as the synchronous one, except most methods return `CompletableFuture`s.\n\n\n\n\n\n\n\n## Raw responses\n\nThe SDK defines methods that deserialize responses into instances of Java classes. However, these methods don't provide access to the response headers, status code, or the raw response body.\n\nTo access this data, prefix any HTTP method call on a client or service with `withRawResponse()`:\n\n```java\nimport com.tryfinch.api.core.http.Headers;\nimport com.tryfinch.api.core.http.HttpResponseFor;\nimport com.tryfinch.api.models.HrisDirectoryListPage;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\nHttpResponseFor page = client.hris().directory().withRawResponse().list();\n\nint statusCode = page.statusCode();\nHeaders headers = page.headers();\n```\n\nYou can still deserialize the response into an instance of a Java class if needed:\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListPage;\n\nHrisDirectoryListPage parsedPage = page.parse();\n```\n\n## Error handling\n\nThe SDK throws custom unchecked exception types:\n\n- [`FinchServiceException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchServiceException.kt): Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:\n\n | Status | Exception |\n | ------ | -------------------------------------------------- |\n | 400 | [`BadRequestException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/BadRequestException.kt) |\n | 401 | [`UnauthorizedException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/UnauthorizedException.kt) |\n | 403 | [`PermissionDeniedException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/PermissionDeniedException.kt) |\n | 404 | [`NotFoundException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/NotFoundException.kt) |\n | 422 | [`UnprocessableEntityException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/UnprocessableEntityException.kt) |\n | 429 | [`RateLimitException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/RateLimitException.kt) |\n | 5xx | [`InternalServerException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/InternalServerException.kt) |\n | others | [`UnexpectedStatusCodeException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/UnexpectedStatusCodeException.kt) |\n\n- [`FinchIoException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchIoException.kt): I/O networking errors.\n\n- [`FinchRetryableException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchRetryableException.kt): Generic error indicating a failure that could be retried by the client.\n\n- [`FinchInvalidDataException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchInvalidDataException.kt): Failure to interpret successfully parsed data. For example, when accessing a property that's supposed to be required, but the API unexpectedly omitted it from the response.\n\n- [`FinchException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchException.kt): Base class for all exceptions. Most errors will result in one of the previously mentioned ones, but completely generic errors may be thrown using the base class.\n\n## Pagination\n\nThe SDK defines methods that return a paginated lists of results. It provides convenient ways to access the results either one page at a time or item-by-item across all pages.\n\n### Auto-pagination\n\nTo iterate through all results across all pages, use the `autoPager()` method, which automatically fetches more pages as needed.\n\nWhen using the synchronous client, the method returns an [`Iterable`](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html)\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListPage;\nimport com.tryfinch.api.models.IndividualInDirectory;\n\nHrisDirectoryListPage page = client.hris().directory().list();\n\n// Process as an Iterable\nfor (IndividualInDirectory directory : page.autoPager()) {\n System.out.println(directory);\n}\n\n// Process as a Stream\npage.autoPager()\n .stream()\n .limit(50)\n .forEach(directory -> System.out.println(directory));\n```\n\nWhen using the asynchronous client, the method returns an [`AsyncStreamResponse`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/http/AsyncStreamResponse.kt):\n\n```java\nimport com.tryfinch.api.core.http.AsyncStreamResponse;\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync;\nimport com.tryfinch.api.models.IndividualInDirectory;\nimport java.util.Optional;\nimport java.util.concurrent.CompletableFuture;\n\nCompletableFuture pageFuture = client.async().hris().directory().list();\n\npageFuture.thenRun(page -> page.autoPager().subscribe(directory -> {\n System.out.println(directory);\n}));\n\n// If you need to handle errors or completion of the stream\npageFuture.thenRun(page -> page.autoPager().subscribe(new AsyncStreamResponse.Handler<>() {\n @Override\n public void onNext(IndividualInDirectory directory) {\n System.out.println(directory);\n }\n\n @Override\n public void onComplete(Optional error) {\n if (error.isPresent()) {\n System.out.println(\"Something went wrong!\");\n throw new RuntimeException(error.get());\n } else {\n System.out.println(\"No more!\");\n }\n }\n}));\n\n// Or use futures\npageFuture.thenRun(page -> page.autoPager()\n .subscribe(directory -> {\n System.out.println(directory);\n })\n .onCompleteFuture()\n .whenComplete((unused, error) -> {\n if (error != null) {\n System.out.println(\"Something went wrong!\");\n throw new RuntimeException(error);\n } else {\n System.out.println(\"No more!\");\n }\n }));\n```\n\n### Manual pagination\n\nTo access individual page items and manually request the next page, use the `items()`,\n`hasNextPage()`, and `nextPage()` methods:\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListPage;\nimport com.tryfinch.api.models.IndividualInDirectory;\n\nHrisDirectoryListPage page = client.hris().directory().list();\nwhile (true) {\n for (IndividualInDirectory directory : page.items()) {\n System.out.println(directory);\n }\n\n if (!page.hasNextPage()) {\n break;\n }\n\n page = page.nextPage();\n}\n```\n\n## Logging\n\nThe SDK uses the standard [OkHttp logging interceptor](https://github.com/square/okhttp/tree/master/okhttp-logging-interceptor).\n\nEnable logging by setting the `FINCH_LOG` environment variable to `info`:\n\n```sh\nexport FINCH_LOG=info\n```\n\nOr to `debug` for more verbose logging:\n\n```sh\nexport FINCH_LOG=debug\n```\n\n## ProGuard and R8\n\nAlthough the SDK uses reflection, it is still usable with [ProGuard](https://github.com/Guardsquare/proguard) and [R8](https://developer.android.com/topic/performance/app-optimization/enable-app-optimization) because `finch-java-core` is published with a [configuration file](finch-java-core/src/main/resources/META-INF/proguard/finch-java-core.pro) containing [keep rules](https://www.guardsquare.com/manual/configuration/usage).\n\nProGuard and R8 should automatically detect and use the published rules, but you can also manually copy the keep rules if necessary.\n\n\n\n\n\n## Jackson\n\nThe SDK depends on [Jackson](https://github.com/FasterXML/jackson) for JSON serialization/deserialization. It is compatible with version 2.13.4 or higher, but depends on version 2.18.2 by default.\n\nThe SDK throws an exception if it detects an incompatible Jackson version at runtime (e.g. if the default version was overridden in your Maven or Gradle config).\n\nIf the SDK threw an exception, but you're _certain_ the version is compatible, then disable the version check using the `checkJacksonVersionCompatibility` on [`FinchOkHttpClient`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt).\n\n> [!CAUTION]\n> We make no guarantee that the SDK works correctly when the Jackson version check is disabled.\n\nAlso note that there are bugs in older Jackson versions that can affect the SDK. We don't work around all Jackson bugs ([example](https://github.com/FasterXML/jackson-databind/issues/3240)) and expect users to upgrade Jackson for those instead.\n\n## Network options\n\n### Retries\n\nThe SDK automatically retries 2 times by default, with a short exponential backoff between requests.\n\nOnly the following error types are retried:\n- Connection errors (for example, due to a network connectivity problem)\n- 408 Request Timeout\n- 409 Conflict\n- 429 Rate Limit\n- 5xx Internal\n\nThe API may also explicitly instruct the SDK to retry or not retry a request.\n\nTo set a custom number of retries, configure the client using the `maxRetries` method:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .maxRetries(4)\n .accessToken(\"My Access Token\")\n .build();\n```\n\n### Timeouts\n\nRequests time out after 1 minute by default.\n\nTo set a custom timeout, configure the method call using the `timeout` method:\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListPage;\n\nHrisDirectoryListPage page = client.hris().directory().list(RequestOptions.builder().timeout(Duration.ofSeconds(30)).build());\n```\n\nOr configure the default for all method calls at the client level:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport java.time.Duration;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .timeout(Duration.ofSeconds(30))\n .accessToken(\"My Access Token\")\n .build();\n```\n\n### Proxies\n\nTo route requests through a proxy, configure the client using the `proxy` method:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport java.net.InetSocketAddress;\nimport java.net.Proxy;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .proxy(new Proxy(\n Proxy.Type.HTTP, new InetSocketAddress(\n \"https://example.com\", 8080\n )\n ))\n .accessToken(\"My Access Token\")\n .build();\n```\n\n### Connection pooling\n\nTo customize the underlying OkHttp connection pool, configure the client using the `maxIdleConnections` and `keepAliveDuration` methods:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport java.time.Duration;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n // If `maxIdleConnections` is set, then `keepAliveDuration` must be set, and vice versa.\n .maxIdleConnections(10)\n .keepAliveDuration(Duration.ofMinutes(2))\n .accessToken(\"My Access Token\")\n .build();\n```\n\nIf both options are unset, OkHttp's default connection pool settings are used.\n\n### HTTPS\n\n> [!NOTE]\n> Most applications should not call these methods, and instead use the system defaults. The defaults include\n> special optimizations that can be lost if the implementations are modified.\n\nTo configure how HTTPS connections are secured, configure the client using the `sslSocketFactory`, `trustManager`, and `hostnameVerifier` methods:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n // If `sslSocketFactory` is set, then `trustManager` must be set, and vice versa.\n .sslSocketFactory(yourSSLSocketFactory)\n .trustManager(yourTrustManager)\n .hostnameVerifier(yourHostnameVerifier)\n .accessToken(\"My Access Token\")\n .build();\n```\n\n\n\n### Custom HTTP client\n\nThe SDK consists of three artifacts:\n- `finch-java-core`\n - Contains core SDK logic\n - Does not depend on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`FinchClient`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClient.kt), [`FinchClientAsync`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsync.kt), [`FinchClientImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt), and [`FinchClientAsyncImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), all of which can work with any HTTP client\n- `finch-java-client-okhttp`\n - Depends on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`FinchOkHttpClient`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) and [`FinchOkHttpClientAsync`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), which provide a way to construct [`FinchClientImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) and [`FinchClientAsyncImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), respectively, using OkHttp\n- `finch-java`\n - Depends on and exposes the APIs of both `finch-java-core` and `finch-java-client-okhttp`\n - Does not have its own logic\n\nThis structure allows replacing the SDK's default HTTP client without pulling in unnecessary dependencies.\n\n#### Customized [`OkHttpClient`](https://square.github.io/okhttp/3.x/okhttp/okhttp3/OkHttpClient.html)\n\n> [!TIP]\n> Try the available [network options](#network-options) before replacing the default client.\n\nTo use a customized `OkHttpClient`:\n\n1. Replace your [`finch-java` dependency](#installation) with `finch-java-core`\n2. Copy `finch-java-client-okhttp`'s [`OkHttpClient`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/OkHttpClient.kt) class into your code and customize it\n3. Construct [`FinchClientImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) or [`FinchClientAsyncImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), similarly to [`FinchOkHttpClient`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), using your customized client\n\n### Completely custom HTTP client\n\nTo use a completely custom HTTP client:\n\n1. Replace your [`finch-java` dependency](#installation) with `finch-java-core`\n2. Write a class that implements the [`HttpClient`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/http/HttpClient.kt) interface\n3. Construct [`FinchClientImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) or [`FinchClientAsyncImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), similarly to [`FinchOkHttpClient`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), using your new client class\n\n## Undocumented API functionality\n\nThe SDK is typed for convenient usage of the documented API. However, it also supports working with undocumented or not yet supported parts of the API.\n\n### Parameters\n\nTo set undocumented parameters, call the `putAdditionalHeader`, `putAdditionalQueryParam`, or `putAdditionalBodyProperty` methods on any `Params` class:\n\n```java\nimport com.tryfinch.api.core.JsonValue;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\nHrisDirectoryListParams params = HrisDirectoryListParams.builder()\n .putAdditionalHeader(\"Secret-Header\", \"42\")\n .putAdditionalQueryParam(\"secret_query_param\", \"42\")\n .putAdditionalBodyProperty(\"secretProperty\", JsonValue.from(\"42\"))\n .build();\n```\n\nThese can be accessed on the built object later using the `_additionalHeaders()`, `_additionalQueryParams()`, and `_additionalBodyProperties()` methods.\n\nTo set a documented parameter or property to an undocumented or not yet supported _value_, pass a [`JsonValue`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/Values.kt) object to its setter:\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\nHrisDirectoryListParams params = HrisDirectoryListParams.builder().build();\n```\n\nThe most straightforward way to create a [`JsonValue`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/Values.kt) is using its `from(...)` method:\n\n```java\nimport com.tryfinch.api.core.JsonValue;\nimport java.util.List;\nimport java.util.Map;\n\n// Create primitive JSON values\nJsonValue nullValue = JsonValue.from(null);\nJsonValue booleanValue = JsonValue.from(true);\nJsonValue numberValue = JsonValue.from(42);\nJsonValue stringValue = JsonValue.from(\"Hello World!\");\n\n// Create a JSON array value equivalent to `[\"Hello\", \"World\"]`\nJsonValue arrayValue = JsonValue.from(List.of(\n \"Hello\", \"World\"\n));\n\n// Create a JSON object value equivalent to `{ \"a\": 1, \"b\": 2 }`\nJsonValue objectValue = JsonValue.from(Map.of(\n \"a\", 1,\n \"b\", 2\n));\n\n// Create an arbitrarily nested JSON equivalent to:\n// {\n// \"a\": [1, 2],\n// \"b\": [3, 4]\n// }\nJsonValue complexValue = JsonValue.from(Map.of(\n \"a\", List.of(\n 1, 2\n ),\n \"b\", List.of(\n 3, 4\n )\n));\n```\n\nNormally a `Builder` class's `build` method will throw [`IllegalStateException`](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) if any required parameter or property is unset.\n\nTo forcibly omit a required parameter or property, pass [`JsonMissing`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/Values.kt):\n\n```java\nimport com.tryfinch.api.core.JsonMissing;\nimport com.tryfinch.api.models.AccessTokenCreateParams;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\nHrisDirectoryListParams params = AccessTokenCreateParams.builder()\n .code(JsonMissing.of())\n .build();\n```\n\n### Response properties\n\nTo access undocumented response properties, call the `_additionalProperties()` method:\n\n```java\nimport com.tryfinch.api.core.JsonValue;\nimport java.util.Map;\n\nMap additionalProperties = client.accessTokens().create(params)._additionalProperties();\nJsonValue secretPropertyValue = additionalProperties.get(\"secretProperty\");\n\nString result = secretPropertyValue.accept(new JsonValue.Visitor<>() {\n @Override\n public String visitNull() {\n return \"It's null!\";\n }\n\n @Override\n public String visitBoolean(boolean value) {\n return \"It's a boolean!\";\n }\n\n @Override\n public String visitNumber(Number value) {\n return \"It's a number!\";\n }\n\n // Other methods include `visitMissing`, `visitString`, `visitArray`, and `visitObject`\n // The default implementation of each unimplemented method delegates to `visitDefault`, which throws by default, but can also be overridden\n});\n```\n\nTo access a property's raw JSON value, which may be undocumented, call its `_` prefixed method:\n\n```java\nimport com.tryfinch.api.core.JsonField;\nimport java.util.Optional;\n\nJsonField code = client.accessTokens().create(params)._code();\n\nif (code.isMissing()) {\n // The property is absent from the JSON response\n} else if (code.isNull()) {\n // The property was set to literal null\n} else {\n // Check if value was provided as a string\n // Other methods include `asNumber()`, `asBoolean()`, etc.\n Optional jsonString = code.asString();\n\n // Try to deserialize into a custom type\n MyClass myObject = code.asUnknown().orElseThrow().convert(MyClass.class);\n}\n```\n\n### Response validation\n\nIn rare cases, the API may return a response that doesn't match the expected type. For example, the SDK may expect a property to contain a `String`, but the API could return something else.\n\nBy default, the SDK will not throw an exception in this case. It will throw [`FinchInvalidDataException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchInvalidDataException.kt) only if you directly access the property.\n\nIf you would prefer to check that the response is completely well-typed upfront, then either call `validate()`:\n\n```java\nimport com.tryfinch.api.models.CreateAccessTokenResponse;\n\nCreateAccessTokenResponse createAccessTokenResponse = client.accessTokens().create(params).validate();\n```\n\nOr configure the method call to validate the response using the `responseValidation` method:\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListPage;\n\nHrisDirectoryListPage page = client.hris().directory().list(RequestOptions.builder().responseValidation(true).build());\n```\n\nOr configure the default for all method calls at the client level:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .responseValidation(true)\n .accessToken(\"My Access Token\")\n .build();\n```\n\n## FAQ\n\n### Why don't you use plain `enum` classes?\n\nJava `enum` classes are not trivially [forwards compatible](https://www.stainless.com/blog/making-java-enums-forwards-compatible). Using them in the SDK could cause runtime exceptions if the API is updated to respond with a new enum value.\n\n### Why do you represent fields using `JsonField` instead of just plain `T`?\n\nUsing `JsonField` enables a few features:\n\n- Allowing usage of [undocumented API functionality](#undocumented-api-functionality)\n- Lazily [validating the API response against the expected shape](#response-validation)\n- Representing absent vs explicitly null values\n\n### Why don't you use [`data` classes](https://kotlinlang.org/docs/data-classes.html)?\n\nIt is not [backwards compatible to add new fields to a data class](https://kotlinlang.org/docs/api-guidelines-backward-compatibility.html#avoid-using-data-classes-in-your-api) and we don't want to introduce a breaking change every time we add a field to a class.\n\n### Why don't you use checked exceptions?\n\nChecked exceptions are widely considered a mistake in the Java programming language. In fact, they were omitted from Kotlin for this reason.\n\nChecked exceptions:\n\n- Are verbose to handle\n- Encourage error handling at the wrong level of abstraction, where nothing can be done about the error\n- Are tedious to propagate due to the [function coloring problem](https://journal.stuffwithstuff.com/2015/02/01/what-color-is-your-function)\n- Don't play well with lambdas (also due to the function coloring problem)\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n2. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Finch-API/finch-api-java/issues) with questions, bugs, or suggestions.\n" }, { - language: 'kotlin', - content: - '# Finch Kotlin API Library\n\n\n[![Maven Central](https://img.shields.io/maven-central/v/com.tryfinch.api/finch-kotlin)](https://central.sonatype.com/artifact/com.tryfinch.api/finch-kotlin/0.0.1)\n[![javadoc](https://javadoc.io/badge2/com.tryfinch.api/finch-kotlin/0.0.1/javadoc.svg)](https://javadoc.io/doc/com.tryfinch.api/finch-kotlin/0.0.1)\n\n\nThe Finch Kotlin SDK provides convenient access to the [Finch REST API](https://developer.tryfinch.com/) from applications written in Kotlin.\n\nThe Finch Kotlin SDK is similar to the Finch Java SDK but with minor differences that make it more ergonomic for use in Kotlin, such as nullable values instead of `Optional`, `Sequence` instead of `Stream`, and suspend functions instead of `CompletableFuture`.\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n\n\nThe REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/). KDocs are available on [javadoc.io](https://javadoc.io/doc/com.tryfinch.api/finch-kotlin/0.0.1).\n\n\n\n## Installation\n\n\n\n### Gradle\n\n~~~kotlin\nimplementation("com.tryfinch.api:finch-kotlin:0.0.1")\n~~~\n\n### Maven\n\n~~~xml\n\n com.tryfinch.api\n finch-kotlin\n 0.0.1\n\n~~~\n\n\n\n## Requirements\n\nThis library requires Java 8 or later.\n\n## Usage\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisDirectoryListPage\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval client: FinchClient = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\nval page: HrisDirectoryListPage = client.hris().directory().list()\n```\n\n## Client configuration\n\nConfigure the client using system properties or environment variables:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n```\n\nOr manually:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .accessToken("My Access Token")\n .build()\n```\n\nOr using a combination of the two approaches:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n```\n\nSee this table for the available options:\n\n| Setter | System property | Environment variable | Required | Default value |\n| --------------- | --------------------- | ---------------------- | -------- | ---------------------------- |\n| `clientId` | `finch.clientId` | `FINCH_CLIENT_ID` | false | - |\n| `clientSecret` | `finch.clientSecret` | `FINCH_CLIENT_SECRET` | false | - |\n| `webhookSecret` | `finch.webhookSecret` | `FINCH_WEBHOOK_SECRET` | false | - |\n| `baseUrl` | `finch.baseUrl` | `FINCH_BASE_URL` | true | `"https://api.tryfinch.com"` |\n\nSystem properties take precedence over environment variables.\n\n> [!TIP]\n> Don\'t create more than one client in the same application. Each client has a connection pool and\n> thread pools, which are more efficient to share between requests.\n\n### Modifying configuration\n\nTo temporarily use a modified client configuration, while reusing the same connection and thread pools, call `withOptions()` on any client or service:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\n\nval clientWithOptions: FinchClient = client.withOptions {\n it.baseUrl("https://example.com")\n it.maxRetries(42)\n}\n```\n\nThe `withOptions()` method does not affect the original client or service.\n\n## Requests and responses\n\nTo send a request to the Finch API, build an instance of some `Params` class and pass it to the corresponding client method. When the response is received, it will be deserialized into an instance of a Kotlin class.\n\nFor example, `client.hris().directory().list(...)` should be called with an instance of `HrisDirectoryListParams`, and it will return an instance of `HrisDirectoryListPage`.\n\n## Immutability\n\nEach class in the SDK has an associated [builder](https://blogs.oracle.com/javamagazine/post/exploring-joshua-blochs-builder-design-pattern-in-java) or factory method for constructing it.\n\nEach class is [immutable](https://docs.oracle.com/javase/tutorial/essential/concurrency/immutable.html) once constructed. If the class has an associated builder, then it has a `toBuilder()` method, which can be used to convert it back to a builder for making a modified copy.\n\nBecause each class is immutable, builder modification will _never_ affect already built class instances.\n\n## Asynchronous execution\n\nThe default client is synchronous. To switch to asynchronous execution, call the `async()` method:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval client: FinchClient = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\nval page: HrisDirectoryListPageAsync = client.async().hris().directory().list()\n```\n\nOr create an asynchronous client from the beginning:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClientAsync\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClientAsync\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval client: FinchClientAsync = FinchOkHttpClientAsync.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\nval page: HrisDirectoryListPageAsync = client.hris().directory().list()\n```\n\nThe asynchronous client supports the same options as the synchronous one, except most methods are [suspending](https://kotlinlang.org/docs/coroutines-guide.html).\n\n\n\n\n\n\n\n## Raw responses\n\nThe SDK defines methods that deserialize responses into instances of Kotlin classes. However, these methods don\'t provide access to the response headers, status code, or the raw response body.\n\nTo access this data, prefix any HTTP method call on a client or service with `withRawResponse()`:\n\n```kotlin\nimport com.tryfinch.api.core.http.Headers\nimport com.tryfinch.api.core.http.HttpResponseFor\nimport com.tryfinch.api.models.HrisDirectoryListPage\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval page: HttpResponseFor = client.hris().directory().withRawResponse().list()\n\nval statusCode: Int = page.statusCode()\nval headers: Headers = page.headers()\n```\n\nYou can still deserialize the response into an instance of a Kotlin class if needed:\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPage\n\nval parsedPage: HrisDirectoryListPage = page.parse()\n```\n\n## Error handling\n\nThe SDK throws custom unchecked exception types:\n\n- [`FinchServiceException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchServiceException.kt): Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:\n\n | Status | Exception |\n | ------ | -------------------------------------------------- |\n | 400 | [`BadRequestException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/BadRequestException.kt) |\n | 401 | [`UnauthorizedException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/UnauthorizedException.kt) |\n | 403 | [`PermissionDeniedException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/PermissionDeniedException.kt) |\n | 404 | [`NotFoundException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/NotFoundException.kt) |\n | 422 | [`UnprocessableEntityException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/UnprocessableEntityException.kt) |\n | 429 | [`RateLimitException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/RateLimitException.kt) |\n | 5xx | [`InternalServerException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/InternalServerException.kt) |\n | others | [`UnexpectedStatusCodeException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/UnexpectedStatusCodeException.kt) |\n\n- [`FinchIoException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchIoException.kt): I/O networking errors.\n\n- [`FinchRetryableException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchRetryableException.kt): Generic error indicating a failure that could be retried by the client.\n\n- [`FinchInvalidDataException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchInvalidDataException.kt): Failure to interpret successfully parsed data. For example, when accessing a property that\'s supposed to be required, but the API unexpectedly omitted it from the response.\n\n- [`FinchException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchException.kt): Base class for all exceptions. Most errors will result in one of the previously mentioned ones, but completely generic errors may be thrown using the base class.\n\n## Pagination\n\nThe SDK defines methods that return a paginated lists of results. It provides convenient ways to access the results either one page at a time or item-by-item across all pages.\n\n### Auto-pagination\n\nTo iterate through all results across all pages, use the `autoPager()` method, which automatically fetches more pages as needed.\n\nWhen using the synchronous client, the method returns a [`Sequence`](https://kotlinlang.org/docs/sequences.html)\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPage\n\nval page: HrisDirectoryListPage = client.hris().directory().list()\npage.autoPager()\n .take(50)\n .forEach { directory -> println(directory) }\n```\n\nWhen using the asynchronous client, the method returns a [`Flow`](https://kotlinlang.org/docs/flow.html):\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync\n\nval page: HrisDirectoryListPageAsync = client.async().hris().directory().list()\npage.autoPager()\n .take(50)\n .forEach { directory -> println(directory) }\n```\n\n### Manual pagination\n\nTo access individual page items and manually request the next page, use the `items()`,\n`hasNextPage()`, and `nextPage()` methods:\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPage\nimport com.tryfinch.api.models.IndividualInDirectory\n\nval page: HrisDirectoryListPage = client.hris().directory().list()\nwhile (true) {\n for (directory in page.items()) {\n println(directory)\n }\n\n if (!page.hasNextPage()) {\n break\n }\n\n page = page.nextPage()\n}\n```\n\n## Logging\n\nThe SDK uses the standard [OkHttp logging interceptor](https://github.com/square/okhttp/tree/master/okhttp-logging-interceptor).\n\nEnable logging by setting the `FINCH_LOG` environment variable to `info`:\n\n```sh\nexport FINCH_LOG=info\n```\n\nOr to `debug` for more verbose logging:\n\n```sh\nexport FINCH_LOG=debug\n```\n\n## ProGuard and R8\n\nAlthough the SDK uses reflection, it is still usable with [ProGuard](https://github.com/Guardsquare/proguard) and [R8](https://developer.android.com/topic/performance/app-optimization/enable-app-optimization) because `finch-kotlin-core` is published with a [configuration file](finch-kotlin-core/src/main/resources/META-INF/proguard/finch-kotlin-core.pro) containing [keep rules](https://www.guardsquare.com/manual/configuration/usage).\n\nProGuard and R8 should automatically detect and use the published rules, but you can also manually copy the keep rules if necessary.\n\n\n\n\n\n## Jackson\n\nThe SDK depends on [Jackson](https://github.com/FasterXML/jackson) for JSON serialization/deserialization. It is compatible with version 2.13.4 or higher, but depends on version 2.18.2 by default.\n\nThe SDK throws an exception if it detects an incompatible Jackson version at runtime (e.g. if the default version was overridden in your Maven or Gradle config).\n\nIf the SDK threw an exception, but you\'re _certain_ the version is compatible, then disable the version check using the `checkJacksonVersionCompatibility` on [`FinchOkHttpClient`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt).\n\n> [!CAUTION]\n> We make no guarantee that the SDK works correctly when the Jackson version check is disabled.\n\nAlso note that there are bugs in older Jackson versions that can affect the SDK. We don\'t work around all Jackson bugs ([example](https://github.com/FasterXML/jackson-databind/issues/3240)) and expect users to upgrade Jackson for those instead.\n\n## Network options\n\n### Retries\n\nThe SDK automatically retries 2 times by default, with a short exponential backoff between requests.\n\nOnly the following error types are retried:\n- Connection errors (for example, due to a network connectivity problem)\n- 408 Request Timeout\n- 409 Conflict\n- 429 Rate Limit\n- 5xx Internal\n\nThe API may also explicitly instruct the SDK to retry or not retry a request.\n\nTo set a custom number of retries, configure the client using the `maxRetries` method:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .maxRetries(4)\n .accessToken("My Access Token")\n .build()\n```\n\n### Timeouts\n\nRequests time out after 1 minute by default.\n\nTo set a custom timeout, configure the method call using the `timeout` method:\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPage\n\nval page: HrisDirectoryListPage = client.hris().directory().list(RequestOptions.builder().timeout(Duration.ofSeconds(30)).build())\n```\n\nOr configure the default for all method calls at the client level:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport java.time.Duration\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .timeout(Duration.ofSeconds(30))\n .accessToken("My Access Token")\n .build()\n```\n\n### Proxies\n\nTo route requests through a proxy, configure the client using the `proxy` method:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport java.net.InetSocketAddress\nimport java.net.Proxy\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .proxy(Proxy(\n Proxy.Type.HTTP, InetSocketAddress(\n "https://example.com", 8080\n )\n ))\n .accessToken("My Access Token")\n .build()\n```\n\n### Connection pooling\n\nTo customize the underlying OkHttp connection pool, configure the client using the `maxIdleConnections` and `keepAliveDuration` methods:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport java.time.Duration\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n // If `maxIdleConnections` is set, then `keepAliveDuration` must be set, and vice versa.\n .maxIdleConnections(10)\n .keepAliveDuration(Duration.ofMinutes(2))\n .accessToken("My Access Token")\n .build()\n```\n\nIf both options are unset, OkHttp\'s default connection pool settings are used.\n\n### HTTPS\n\n> [!NOTE]\n> Most applications should not call these methods, and instead use the system defaults. The defaults include\n> special optimizations that can be lost if the implementations are modified.\n\nTo configure how HTTPS connections are secured, configure the client using the `sslSocketFactory`, `trustManager`, and `hostnameVerifier` methods:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n // If `sslSocketFactory` is set, then `trustManager` must be set, and vice versa.\n .sslSocketFactory(yourSSLSocketFactory)\n .trustManager(yourTrustManager)\n .hostnameVerifier(yourHostnameVerifier)\n .accessToken("My Access Token")\n .build()\n```\n\n\n\n### Custom HTTP client\n\nThe SDK consists of three artifacts:\n- `finch-kotlin-core`\n - Contains core SDK logic\n - Does not depend on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`FinchClient`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClient.kt), [`FinchClientAsync`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsync.kt), [`FinchClientImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt), and [`FinchClientAsyncImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), all of which can work with any HTTP client\n- `finch-kotlin-client-okhttp`\n - Depends on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`FinchOkHttpClient`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) and [`FinchOkHttpClientAsync`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), which provide a way to construct [`FinchClientImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) and [`FinchClientAsyncImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), respectively, using OkHttp\n- `finch-kotlin`\n - Depends on and exposes the APIs of both `finch-kotlin-core` and `finch-kotlin-client-okhttp`\n - Does not have its own logic\n\nThis structure allows replacing the SDK\'s default HTTP client without pulling in unnecessary dependencies.\n\n#### Customized [`OkHttpClient`](https://square.github.io/okhttp/3.x/okhttp/okhttp3/OkHttpClient.html)\n\n> [!TIP]\n> Try the available [network options](#network-options) before replacing the default client.\n\nTo use a customized `OkHttpClient`:\n\n1. Replace your [`finch-kotlin` dependency](#installation) with `finch-kotlin-core`\n2. Copy `finch-kotlin-client-okhttp`\'s [`OkHttpClient`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/OkHttpClient.kt) class into your code and customize it\n3. Construct [`FinchClientImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) or [`FinchClientAsyncImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), similarly to [`FinchOkHttpClient`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), using your customized client\n\n### Completely custom HTTP client\n\nTo use a completely custom HTTP client:\n\n1. Replace your [`finch-kotlin` dependency](#installation) with `finch-kotlin-core`\n2. Write a class that implements the [`HttpClient`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/core/http/HttpClient.kt) interface\n3. Construct [`FinchClientImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) or [`FinchClientAsyncImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), similarly to [`FinchOkHttpClient`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), using your new client class\n\n## Undocumented API functionality\n\nThe SDK is typed for convenient usage of the documented API. However, it also supports working with undocumented or not yet supported parts of the API.\n\n### Parameters\n\nTo set undocumented parameters, call the `putAdditionalHeader`, `putAdditionalQueryParam`, or `putAdditionalBodyProperty` methods on any `Params` class:\n\n```kotlin\nimport com.tryfinch.api.core.JsonValue\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval params: HrisDirectoryListParams = HrisDirectoryListParams.builder()\n .putAdditionalHeader("Secret-Header", "42")\n .putAdditionalQueryParam("secret_query_param", "42")\n .putAdditionalBodyProperty("secretProperty", JsonValue.from("42"))\n .build()\n```\n\nThese can be accessed on the built object later using the `_additionalHeaders()`, `_additionalQueryParams()`, and `_additionalBodyProperties()` methods.\n\nTo set a documented parameter or property to an undocumented or not yet supported _value_, pass a [`JsonValue`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/core/Values.kt) object to its setter:\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval params: HrisDirectoryListParams = HrisDirectoryListParams.builder().build()\n```\n\nThe most straightforward way to create a [`JsonValue`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/core/Values.kt) is using its `from(...)` method:\n\n```kotlin\nimport com.tryfinch.api.core.JsonValue\n\n// Create primitive JSON values\nval nullValue: JsonValue = JsonValue.from(null)\nval booleanValue: JsonValue = JsonValue.from(true)\nval numberValue: JsonValue = JsonValue.from(42)\nval stringValue: JsonValue = JsonValue.from("Hello World!")\n\n// Create a JSON array value equivalent to `["Hello", "World"]`\nval arrayValue: JsonValue = JsonValue.from(listOf(\n "Hello", "World"\n))\n\n// Create a JSON object value equivalent to `{ "a": 1, "b": 2 }`\nval objectValue: JsonValue = JsonValue.from(mapOf(\n "a" to 1, "b" to 2\n))\n\n// Create an arbitrarily nested JSON equivalent to:\n// {\n// "a": [1, 2],\n// "b": [3, 4]\n// }\nval complexValue: JsonValue = JsonValue.from(mapOf(\n "a" to listOf(\n 1, 2\n ), "b" to listOf(\n 3, 4\n )\n))\n```\n\nNormally a `Builder` class\'s `build` method will throw [`IllegalStateException`](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) if any required parameter or property is unset.\n\nTo forcibly omit a required parameter or property, pass [`JsonMissing`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/core/Values.kt):\n\n```kotlin\nimport com.tryfinch.api.core.JsonMissing\nimport com.tryfinch.api.models.AccessTokenCreateParams\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval params: HrisDirectoryListParams = AccessTokenCreateParams.builder()\n .code(JsonMissing.of())\n .build()\n```\n\n### Response properties\n\nTo access undocumented response properties, call the `_additionalProperties()` method:\n\n```kotlin\nimport com.tryfinch.api.core.JsonBoolean\nimport com.tryfinch.api.core.JsonNull\nimport com.tryfinch.api.core.JsonNumber\nimport com.tryfinch.api.core.JsonValue\n\nval additionalProperties: Map = client.accessTokens().create(params)._additionalProperties()\nval secretPropertyValue: JsonValue = additionalProperties.get("secretProperty")\n\nval result = when (secretPropertyValue) {\n is JsonNull -> "It\'s null!"\n is JsonBoolean -> "It\'s a boolean!"\n is JsonNumber -> "It\'s a number!"\n // Other types include `JsonMissing`, `JsonString`, `JsonArray`, and `JsonObject`\n else -> "It\'s something else!"\n}\n```\n\nTo access a property\'s raw JSON value, which may be undocumented, call its `_` prefixed method:\n\n```kotlin\nimport com.tryfinch.api.core.JsonField\n\nval code: JsonField = client.accessTokens().create(params)._code()\n\nif (code.isMissing()) {\n // The property is absent from the JSON response\n} else if (code.isNull()) {\n // The property was set to literal null\n} else {\n // Check if value was provided as a string\n // Other methods include `asNumber()`, `asBoolean()`, etc.\n val jsonString: String? = code.asString();\n\n // Try to deserialize into a custom type\n val myObject: MyClass = code.asUnknown()!!.convert(MyClass::class.java)\n}\n```\n\n### Response validation\n\nIn rare cases, the API may return a response that doesn\'t match the expected type. For example, the SDK may expect a property to contain a `String`, but the API could return something else.\n\nBy default, the SDK will not throw an exception in this case. It will throw [`FinchInvalidDataException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchInvalidDataException.kt) only if you directly access the property.\n\nIf you would prefer to check that the response is completely well-typed upfront, then either call `validate()`:\n\n```kotlin\nimport com.tryfinch.api.models.CreateAccessTokenResponse\n\nval createAccessTokenResponse: CreateAccessTokenResponse = client.accessTokens().create(params).validate()\n```\n\nOr configure the method call to validate the response using the `responseValidation` method:\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPage\n\nval page: HrisDirectoryListPage = client.hris().directory().list(RequestOptions.builder().responseValidation(true).build())\n```\n\nOr configure the default for all method calls at the client level:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .responseValidation(true)\n .accessToken("My Access Token")\n .build()\n```\n\n## FAQ\n\n### Why don\'t you use plain `enum` classes?\n\nKotlin `enum` classes are not trivially [forwards compatible](https://www.stainless.com/blog/making-java-enums-forwards-compatible). Using them in the SDK could cause runtime exceptions if the API is updated to respond with a new enum value.\n\n### Why do you represent fields using `JsonField` instead of just plain `T`?\n\nUsing `JsonField` enables a few features:\n\n- Allowing usage of [undocumented API functionality](#undocumented-api-functionality)\n- Lazily [validating the API response against the expected shape](#response-validation)\n- Representing absent vs explicitly null values\n\n### Why don\'t you use [`data` classes](https://kotlinlang.org/docs/data-classes.html)?\n\nIt is not [backwards compatible to add new fields to a data class](https://kotlinlang.org/docs/api-guidelines-backward-compatibility.html#avoid-using-data-classes-in-your-api) and we don\'t want to introduce a breaking change every time we add a field to a class.\n\n### Why don\'t you use checked exceptions?\n\nChecked exceptions are widely considered a mistake in the Java programming language. In fact, they were omitted from Kotlin for this reason.\n\nChecked exceptions:\n\n- Are verbose to handle\n- Encourage error handling at the wrong level of abstraction, where nothing can be done about the error\n- Are tedious to propagate due to the [function coloring problem](https://journal.stuffwithstuff.com/2015/02/01/what-color-is-your-function)\n- Don\'t play well with lambdas (also due to the function coloring problem)\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n2. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Finch-API/finch-api-kotlin/issues) with questions, bugs, or suggestions.\n', + "language": "kotlin", + "content": "# Finch Kotlin API Library\n\n\n[![Maven Central](https://img.shields.io/maven-central/v/com.tryfinch.api/finch-kotlin)](https://central.sonatype.com/artifact/com.tryfinch.api/finch-kotlin/0.0.1)\n[![javadoc](https://javadoc.io/badge2/com.tryfinch.api/finch-kotlin/0.0.1/javadoc.svg)](https://javadoc.io/doc/com.tryfinch.api/finch-kotlin/0.0.1)\n\n\nThe Finch Kotlin SDK provides convenient access to the [Finch REST API](https://developer.tryfinch.com/) from applications written in Kotlin.\n\nThe Finch Kotlin SDK is similar to the Finch Java SDK but with minor differences that make it more ergonomic for use in Kotlin, such as nullable values instead of `Optional`, `Sequence` instead of `Stream`, and suspend functions instead of `CompletableFuture`.\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n\n\nThe REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/). KDocs are available on [javadoc.io](https://javadoc.io/doc/com.tryfinch.api/finch-kotlin/0.0.1).\n\n\n\n## Installation\n\n\n\n### Gradle\n\n~~~kotlin\nimplementation(\"com.tryfinch.api:finch-kotlin:0.0.1\")\n~~~\n\n### Maven\n\n~~~xml\n\n com.tryfinch.api\n finch-kotlin\n 0.0.1\n\n~~~\n\n\n\n## Requirements\n\nThis library requires Java 8 or later.\n\n## Usage\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisDirectoryListPage\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval client: FinchClient = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\nval page: HrisDirectoryListPage = client.hris().directory().list()\n```\n\n## Client configuration\n\nConfigure the client using system properties or environment variables:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n```\n\nOr manually:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .accessToken(\"My Access Token\")\n .build()\n```\n\nOr using a combination of the two approaches:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n```\n\nSee this table for the available options:\n\n| Setter | System property | Environment variable | Required | Default value |\n| --------------- | --------------------- | ---------------------- | -------- | ---------------------------- |\n| `clientId` | `finch.clientId` | `FINCH_CLIENT_ID` | false | - |\n| `clientSecret` | `finch.clientSecret` | `FINCH_CLIENT_SECRET` | false | - |\n| `webhookSecret` | `finch.webhookSecret` | `FINCH_WEBHOOK_SECRET` | false | - |\n| `baseUrl` | `finch.baseUrl` | `FINCH_BASE_URL` | true | `\"https://api.tryfinch.com\"` |\n\nSystem properties take precedence over environment variables.\n\n> [!TIP]\n> Don't create more than one client in the same application. Each client has a connection pool and\n> thread pools, which are more efficient to share between requests.\n\n### Modifying configuration\n\nTo temporarily use a modified client configuration, while reusing the same connection and thread pools, call `withOptions()` on any client or service:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\n\nval clientWithOptions: FinchClient = client.withOptions {\n it.baseUrl(\"https://example.com\")\n it.maxRetries(42)\n}\n```\n\nThe `withOptions()` method does not affect the original client or service.\n\n## Requests and responses\n\nTo send a request to the Finch API, build an instance of some `Params` class and pass it to the corresponding client method. When the response is received, it will be deserialized into an instance of a Kotlin class.\n\nFor example, `client.hris().directory().list(...)` should be called with an instance of `HrisDirectoryListParams`, and it will return an instance of `HrisDirectoryListPage`.\n\n## Immutability\n\nEach class in the SDK has an associated [builder](https://blogs.oracle.com/javamagazine/post/exploring-joshua-blochs-builder-design-pattern-in-java) or factory method for constructing it.\n\nEach class is [immutable](https://docs.oracle.com/javase/tutorial/essential/concurrency/immutable.html) once constructed. If the class has an associated builder, then it has a `toBuilder()` method, which can be used to convert it back to a builder for making a modified copy.\n\nBecause each class is immutable, builder modification will _never_ affect already built class instances.\n\n## Asynchronous execution\n\nThe default client is synchronous. To switch to asynchronous execution, call the `async()` method:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval client: FinchClient = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\nval page: HrisDirectoryListPageAsync = client.async().hris().directory().list()\n```\n\nOr create an asynchronous client from the beginning:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClientAsync\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClientAsync\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval client: FinchClientAsync = FinchOkHttpClientAsync.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\nval page: HrisDirectoryListPageAsync = client.hris().directory().list()\n```\n\nThe asynchronous client supports the same options as the synchronous one, except most methods are [suspending](https://kotlinlang.org/docs/coroutines-guide.html).\n\n\n\n\n\n\n\n## Raw responses\n\nThe SDK defines methods that deserialize responses into instances of Kotlin classes. However, these methods don't provide access to the response headers, status code, or the raw response body.\n\nTo access this data, prefix any HTTP method call on a client or service with `withRawResponse()`:\n\n```kotlin\nimport com.tryfinch.api.core.http.Headers\nimport com.tryfinch.api.core.http.HttpResponseFor\nimport com.tryfinch.api.models.HrisDirectoryListPage\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval page: HttpResponseFor = client.hris().directory().withRawResponse().list()\n\nval statusCode: Int = page.statusCode()\nval headers: Headers = page.headers()\n```\n\nYou can still deserialize the response into an instance of a Kotlin class if needed:\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPage\n\nval parsedPage: HrisDirectoryListPage = page.parse()\n```\n\n## Error handling\n\nThe SDK throws custom unchecked exception types:\n\n- [`FinchServiceException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchServiceException.kt): Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:\n\n | Status | Exception |\n | ------ | -------------------------------------------------- |\n | 400 | [`BadRequestException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/BadRequestException.kt) |\n | 401 | [`UnauthorizedException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/UnauthorizedException.kt) |\n | 403 | [`PermissionDeniedException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/PermissionDeniedException.kt) |\n | 404 | [`NotFoundException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/NotFoundException.kt) |\n | 422 | [`UnprocessableEntityException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/UnprocessableEntityException.kt) |\n | 429 | [`RateLimitException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/RateLimitException.kt) |\n | 5xx | [`InternalServerException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/InternalServerException.kt) |\n | others | [`UnexpectedStatusCodeException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/UnexpectedStatusCodeException.kt) |\n\n- [`FinchIoException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchIoException.kt): I/O networking errors.\n\n- [`FinchRetryableException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchRetryableException.kt): Generic error indicating a failure that could be retried by the client.\n\n- [`FinchInvalidDataException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchInvalidDataException.kt): Failure to interpret successfully parsed data. For example, when accessing a property that's supposed to be required, but the API unexpectedly omitted it from the response.\n\n- [`FinchException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchException.kt): Base class for all exceptions. Most errors will result in one of the previously mentioned ones, but completely generic errors may be thrown using the base class.\n\n## Pagination\n\nThe SDK defines methods that return a paginated lists of results. It provides convenient ways to access the results either one page at a time or item-by-item across all pages.\n\n### Auto-pagination\n\nTo iterate through all results across all pages, use the `autoPager()` method, which automatically fetches more pages as needed.\n\nWhen using the synchronous client, the method returns a [`Sequence`](https://kotlinlang.org/docs/sequences.html)\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPage\n\nval page: HrisDirectoryListPage = client.hris().directory().list()\npage.autoPager()\n .take(50)\n .forEach { directory -> println(directory) }\n```\n\nWhen using the asynchronous client, the method returns a [`Flow`](https://kotlinlang.org/docs/flow.html):\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync\n\nval page: HrisDirectoryListPageAsync = client.async().hris().directory().list()\npage.autoPager()\n .take(50)\n .forEach { directory -> println(directory) }\n```\n\n### Manual pagination\n\nTo access individual page items and manually request the next page, use the `items()`,\n`hasNextPage()`, and `nextPage()` methods:\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPage\nimport com.tryfinch.api.models.IndividualInDirectory\n\nval page: HrisDirectoryListPage = client.hris().directory().list()\nwhile (true) {\n for (directory in page.items()) {\n println(directory)\n }\n\n if (!page.hasNextPage()) {\n break\n }\n\n page = page.nextPage()\n}\n```\n\n## Logging\n\nThe SDK uses the standard [OkHttp logging interceptor](https://github.com/square/okhttp/tree/master/okhttp-logging-interceptor).\n\nEnable logging by setting the `FINCH_LOG` environment variable to `info`:\n\n```sh\nexport FINCH_LOG=info\n```\n\nOr to `debug` for more verbose logging:\n\n```sh\nexport FINCH_LOG=debug\n```\n\n## ProGuard and R8\n\nAlthough the SDK uses reflection, it is still usable with [ProGuard](https://github.com/Guardsquare/proguard) and [R8](https://developer.android.com/topic/performance/app-optimization/enable-app-optimization) because `finch-kotlin-core` is published with a [configuration file](finch-kotlin-core/src/main/resources/META-INF/proguard/finch-kotlin-core.pro) containing [keep rules](https://www.guardsquare.com/manual/configuration/usage).\n\nProGuard and R8 should automatically detect and use the published rules, but you can also manually copy the keep rules if necessary.\n\n\n\n\n\n## Jackson\n\nThe SDK depends on [Jackson](https://github.com/FasterXML/jackson) for JSON serialization/deserialization. It is compatible with version 2.13.4 or higher, but depends on version 2.18.2 by default.\n\nThe SDK throws an exception if it detects an incompatible Jackson version at runtime (e.g. if the default version was overridden in your Maven or Gradle config).\n\nIf the SDK threw an exception, but you're _certain_ the version is compatible, then disable the version check using the `checkJacksonVersionCompatibility` on [`FinchOkHttpClient`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt).\n\n> [!CAUTION]\n> We make no guarantee that the SDK works correctly when the Jackson version check is disabled.\n\nAlso note that there are bugs in older Jackson versions that can affect the SDK. We don't work around all Jackson bugs ([example](https://github.com/FasterXML/jackson-databind/issues/3240)) and expect users to upgrade Jackson for those instead.\n\n## Network options\n\n### Retries\n\nThe SDK automatically retries 2 times by default, with a short exponential backoff between requests.\n\nOnly the following error types are retried:\n- Connection errors (for example, due to a network connectivity problem)\n- 408 Request Timeout\n- 409 Conflict\n- 429 Rate Limit\n- 5xx Internal\n\nThe API may also explicitly instruct the SDK to retry or not retry a request.\n\nTo set a custom number of retries, configure the client using the `maxRetries` method:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .maxRetries(4)\n .accessToken(\"My Access Token\")\n .build()\n```\n\n### Timeouts\n\nRequests time out after 1 minute by default.\n\nTo set a custom timeout, configure the method call using the `timeout` method:\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPage\n\nval page: HrisDirectoryListPage = client.hris().directory().list(RequestOptions.builder().timeout(Duration.ofSeconds(30)).build())\n```\n\nOr configure the default for all method calls at the client level:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport java.time.Duration\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .timeout(Duration.ofSeconds(30))\n .accessToken(\"My Access Token\")\n .build()\n```\n\n### Proxies\n\nTo route requests through a proxy, configure the client using the `proxy` method:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport java.net.InetSocketAddress\nimport java.net.Proxy\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .proxy(Proxy(\n Proxy.Type.HTTP, InetSocketAddress(\n \"https://example.com\", 8080\n )\n ))\n .accessToken(\"My Access Token\")\n .build()\n```\n\n### Connection pooling\n\nTo customize the underlying OkHttp connection pool, configure the client using the `maxIdleConnections` and `keepAliveDuration` methods:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport java.time.Duration\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n // If `maxIdleConnections` is set, then `keepAliveDuration` must be set, and vice versa.\n .maxIdleConnections(10)\n .keepAliveDuration(Duration.ofMinutes(2))\n .accessToken(\"My Access Token\")\n .build()\n```\n\nIf both options are unset, OkHttp's default connection pool settings are used.\n\n### HTTPS\n\n> [!NOTE]\n> Most applications should not call these methods, and instead use the system defaults. The defaults include\n> special optimizations that can be lost if the implementations are modified.\n\nTo configure how HTTPS connections are secured, configure the client using the `sslSocketFactory`, `trustManager`, and `hostnameVerifier` methods:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n // If `sslSocketFactory` is set, then `trustManager` must be set, and vice versa.\n .sslSocketFactory(yourSSLSocketFactory)\n .trustManager(yourTrustManager)\n .hostnameVerifier(yourHostnameVerifier)\n .accessToken(\"My Access Token\")\n .build()\n```\n\n\n\n### Custom HTTP client\n\nThe SDK consists of three artifacts:\n- `finch-kotlin-core`\n - Contains core SDK logic\n - Does not depend on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`FinchClient`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClient.kt), [`FinchClientAsync`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsync.kt), [`FinchClientImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt), and [`FinchClientAsyncImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), all of which can work with any HTTP client\n- `finch-kotlin-client-okhttp`\n - Depends on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`FinchOkHttpClient`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) and [`FinchOkHttpClientAsync`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), which provide a way to construct [`FinchClientImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) and [`FinchClientAsyncImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), respectively, using OkHttp\n- `finch-kotlin`\n - Depends on and exposes the APIs of both `finch-kotlin-core` and `finch-kotlin-client-okhttp`\n - Does not have its own logic\n\nThis structure allows replacing the SDK's default HTTP client without pulling in unnecessary dependencies.\n\n#### Customized [`OkHttpClient`](https://square.github.io/okhttp/3.x/okhttp/okhttp3/OkHttpClient.html)\n\n> [!TIP]\n> Try the available [network options](#network-options) before replacing the default client.\n\nTo use a customized `OkHttpClient`:\n\n1. Replace your [`finch-kotlin` dependency](#installation) with `finch-kotlin-core`\n2. Copy `finch-kotlin-client-okhttp`'s [`OkHttpClient`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/OkHttpClient.kt) class into your code and customize it\n3. Construct [`FinchClientImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) or [`FinchClientAsyncImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), similarly to [`FinchOkHttpClient`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), using your customized client\n\n### Completely custom HTTP client\n\nTo use a completely custom HTTP client:\n\n1. Replace your [`finch-kotlin` dependency](#installation) with `finch-kotlin-core`\n2. Write a class that implements the [`HttpClient`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/core/http/HttpClient.kt) interface\n3. Construct [`FinchClientImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) or [`FinchClientAsyncImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), similarly to [`FinchOkHttpClient`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), using your new client class\n\n## Undocumented API functionality\n\nThe SDK is typed for convenient usage of the documented API. However, it also supports working with undocumented or not yet supported parts of the API.\n\n### Parameters\n\nTo set undocumented parameters, call the `putAdditionalHeader`, `putAdditionalQueryParam`, or `putAdditionalBodyProperty` methods on any `Params` class:\n\n```kotlin\nimport com.tryfinch.api.core.JsonValue\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval params: HrisDirectoryListParams = HrisDirectoryListParams.builder()\n .putAdditionalHeader(\"Secret-Header\", \"42\")\n .putAdditionalQueryParam(\"secret_query_param\", \"42\")\n .putAdditionalBodyProperty(\"secretProperty\", JsonValue.from(\"42\"))\n .build()\n```\n\nThese can be accessed on the built object later using the `_additionalHeaders()`, `_additionalQueryParams()`, and `_additionalBodyProperties()` methods.\n\nTo set a documented parameter or property to an undocumented or not yet supported _value_, pass a [`JsonValue`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/core/Values.kt) object to its setter:\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval params: HrisDirectoryListParams = HrisDirectoryListParams.builder().build()\n```\n\nThe most straightforward way to create a [`JsonValue`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/core/Values.kt) is using its `from(...)` method:\n\n```kotlin\nimport com.tryfinch.api.core.JsonValue\n\n// Create primitive JSON values\nval nullValue: JsonValue = JsonValue.from(null)\nval booleanValue: JsonValue = JsonValue.from(true)\nval numberValue: JsonValue = JsonValue.from(42)\nval stringValue: JsonValue = JsonValue.from(\"Hello World!\")\n\n// Create a JSON array value equivalent to `[\"Hello\", \"World\"]`\nval arrayValue: JsonValue = JsonValue.from(listOf(\n \"Hello\", \"World\"\n))\n\n// Create a JSON object value equivalent to `{ \"a\": 1, \"b\": 2 }`\nval objectValue: JsonValue = JsonValue.from(mapOf(\n \"a\" to 1, \"b\" to 2\n))\n\n// Create an arbitrarily nested JSON equivalent to:\n// {\n// \"a\": [1, 2],\n// \"b\": [3, 4]\n// }\nval complexValue: JsonValue = JsonValue.from(mapOf(\n \"a\" to listOf(\n 1, 2\n ), \"b\" to listOf(\n 3, 4\n )\n))\n```\n\nNormally a `Builder` class's `build` method will throw [`IllegalStateException`](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) if any required parameter or property is unset.\n\nTo forcibly omit a required parameter or property, pass [`JsonMissing`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/core/Values.kt):\n\n```kotlin\nimport com.tryfinch.api.core.JsonMissing\nimport com.tryfinch.api.models.AccessTokenCreateParams\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval params: HrisDirectoryListParams = AccessTokenCreateParams.builder()\n .code(JsonMissing.of())\n .build()\n```\n\n### Response properties\n\nTo access undocumented response properties, call the `_additionalProperties()` method:\n\n```kotlin\nimport com.tryfinch.api.core.JsonBoolean\nimport com.tryfinch.api.core.JsonNull\nimport com.tryfinch.api.core.JsonNumber\nimport com.tryfinch.api.core.JsonValue\n\nval additionalProperties: Map = client.accessTokens().create(params)._additionalProperties()\nval secretPropertyValue: JsonValue = additionalProperties.get(\"secretProperty\")\n\nval result = when (secretPropertyValue) {\n is JsonNull -> \"It's null!\"\n is JsonBoolean -> \"It's a boolean!\"\n is JsonNumber -> \"It's a number!\"\n // Other types include `JsonMissing`, `JsonString`, `JsonArray`, and `JsonObject`\n else -> \"It's something else!\"\n}\n```\n\nTo access a property's raw JSON value, which may be undocumented, call its `_` prefixed method:\n\n```kotlin\nimport com.tryfinch.api.core.JsonField\n\nval code: JsonField = client.accessTokens().create(params)._code()\n\nif (code.isMissing()) {\n // The property is absent from the JSON response\n} else if (code.isNull()) {\n // The property was set to literal null\n} else {\n // Check if value was provided as a string\n // Other methods include `asNumber()`, `asBoolean()`, etc.\n val jsonString: String? = code.asString();\n\n // Try to deserialize into a custom type\n val myObject: MyClass = code.asUnknown()!!.convert(MyClass::class.java)\n}\n```\n\n### Response validation\n\nIn rare cases, the API may return a response that doesn't match the expected type. For example, the SDK may expect a property to contain a `String`, but the API could return something else.\n\nBy default, the SDK will not throw an exception in this case. It will throw [`FinchInvalidDataException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchInvalidDataException.kt) only if you directly access the property.\n\nIf you would prefer to check that the response is completely well-typed upfront, then either call `validate()`:\n\n```kotlin\nimport com.tryfinch.api.models.CreateAccessTokenResponse\n\nval createAccessTokenResponse: CreateAccessTokenResponse = client.accessTokens().create(params).validate()\n```\n\nOr configure the method call to validate the response using the `responseValidation` method:\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPage\n\nval page: HrisDirectoryListPage = client.hris().directory().list(RequestOptions.builder().responseValidation(true).build())\n```\n\nOr configure the default for all method calls at the client level:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .responseValidation(true)\n .accessToken(\"My Access Token\")\n .build()\n```\n\n## FAQ\n\n### Why don't you use plain `enum` classes?\n\nKotlin `enum` classes are not trivially [forwards compatible](https://www.stainless.com/blog/making-java-enums-forwards-compatible). Using them in the SDK could cause runtime exceptions if the API is updated to respond with a new enum value.\n\n### Why do you represent fields using `JsonField` instead of just plain `T`?\n\nUsing `JsonField` enables a few features:\n\n- Allowing usage of [undocumented API functionality](#undocumented-api-functionality)\n- Lazily [validating the API response against the expected shape](#response-validation)\n- Representing absent vs explicitly null values\n\n### Why don't you use [`data` classes](https://kotlinlang.org/docs/data-classes.html)?\n\nIt is not [backwards compatible to add new fields to a data class](https://kotlinlang.org/docs/api-guidelines-backward-compatibility.html#avoid-using-data-classes-in-your-api) and we don't want to introduce a breaking change every time we add a field to a class.\n\n### Why don't you use checked exceptions?\n\nChecked exceptions are widely considered a mistake in the Java programming language. In fact, they were omitted from Kotlin for this reason.\n\nChecked exceptions:\n\n- Are verbose to handle\n- Encourage error handling at the wrong level of abstraction, where nothing can be done about the error\n- Are tedious to propagate due to the [function coloring problem](https://journal.stuffwithstuff.com/2015/02/01/what-color-is-your-function)\n- Don't play well with lambdas (also due to the function coloring problem)\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n2. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Finch-API/finch-api-kotlin/issues) with questions, bugs, or suggestions.\n" }, { - language: 'python', - content: - '# Finch Python API library\n\n\n[![PyPI version](https://img.shields.io/pypi/v/finch-api.svg?label=pypi%20(stable))](https://pypi.org/project/finch-api/)\n\nThe Finch Python library provides convenient access to the Finch REST API from any Python 3.9+\napplication. The library includes type definitions for all request params and response fields,\nand offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).\n\n\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Documentation\n\nThe REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/). The full API of this library can be found in [api.md](api.md).\n\n## Installation\n\n```sh\n# install from PyPI\npip install finch-api\n```\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n```python\nfrom finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\n\npage = client.hris.directory.list()\nprint(page.individuals)\n```\n\n\n\n## Async usage\n\nSimply import `AsyncFinch` instead of `Finch` and use `await` with each API call:\n\n```python\nimport asyncio\nfrom finch import AsyncFinch\n\nclient = AsyncFinch(\n access_token="My Access Token",\n)\n\nasync def main() -> None:\n page = await client.hris.directory.list()\n print(page.individuals)\n\nasyncio.run(main())\n```\n\nFunctionality between the synchronous and asynchronous clients is otherwise identical.\n\n### With aiohttp\n\nBy default, the async client uses `httpx` for HTTP requests. However, for improved concurrency performance you may also use `aiohttp` as the HTTP backend.\n\nYou can enable this by installing `aiohttp`:\n\n```sh\n# install from PyPI\npip install finch-api[aiohttp]\n```\n\nThen you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:\n\n```python\nimport asyncio\nfrom finch import DefaultAioHttpClient\nfrom finch import AsyncFinch\n\nasync def main() -> None:\n async with AsyncFinch(\n access_token="My Access Token",\n http_client=DefaultAioHttpClient(),\n) as client:\n page = await client.hris.directory.list()\n print(page.individuals)\n\nasyncio.run(main())\n```\n\n\n\n## Using types\n\nNested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:\n\n- Serializing back into JSON, `model.to_json()`\n- Converting to a dictionary, `model.to_dict()`\n\nTyped requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.\n\n## Pagination\n\nList methods in the Finch API are paginated.\n\nThis library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:\n\n```python\nfrom finch import Finch\n\nclient = Finch()\n\nall_directories = []\n# Automatically fetches more pages as needed.\nfor directory in client.hris.directory.list():\n # Do something with directory here\n all_directories.append(directory)\nprint(all_directories)\n```\n\nOr, asynchronously:\n\n```python\nimport asyncio\nfrom finch import AsyncFinch\n\nclient = AsyncFinch()\n\nasync def main() -> None:\n all_directories = []\n # Iterate through items across all pages, issuing requests as needed.\n async for directory in client.hris.directory.list():\n all_directories.append(directory)\n print(all_directories)\n\nasyncio.run(main())\n```\n\nAlternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:\n\n```python\nfirst_page = await client.hris.directory.list()\nif first_page.has_next_page():\n print(f"will fetch next page using these details: {first_page.next_page_info()}")\n next_page = await first_page.get_next_page()\n print(f"number of items we just fetched: {len(next_page.individuals)}")\n\n# Remove `await` for non-async usage.\n```\n\nOr just work directly with the returned data:\n\n```python\nfirst_page = await client.hris.directory.list()\n\nprint(f"the current start offset for this page: {first_page.paging.offset}") # => "the current start offset for this page: 1"\nfor directory in first_page.individuals:\n print(directory.id)\n\n# Remove `await` for non-async usage.\n```\n\n\n\n\n\n## Handling errors\n\nWhen the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `finch.APIConnectionError` is raised.\n\nWhen the API returns a non-success status code (that is, 4xx or 5xx\nresponse), a subclass of `finch.APIStatusError` is raised, containing `status_code` and `response` properties.\n\nAll errors inherit from `finch.APIError`.\n\n```python\nimport finch\nfrom finch import Finch\n\nclient = Finch()\n\ntry:\n client.hris.company.retrieve()\nexcept finch.APIConnectionError as e:\n print("The server could not be reached")\n print(e.__cause__) # an underlying Exception, likely raised within httpx.\nexcept finch.RateLimitError as e:\n print("A 429 status code was received; we should back off a bit.")\nexcept finch.APIStatusError as e:\n print("Another non-200-range status code was received")\n print(e.status_code)\n print(e.response)\n```\n\nError codes are as follows:\n\n| Status Code | Error Type |\n| ----------- | -------------------------- |\n| 400 | `BadRequestError` |\n| 401 | `AuthenticationError` |\n| 403 | `PermissionDeniedError` |\n| 404 | `NotFoundError` |\n| 422 | `UnprocessableEntityError` |\n| 429 | `RateLimitError` |\n| >=500 | `InternalServerError` |\n| N/A | `APIConnectionError` |\n\n### Retries\n\nCertain errors are automatically retried 2 times by default, with a short exponential backoff.\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,\n429 Rate Limit, and >=500 Internal errors are all retried by default.\n\nYou can use the `max_retries` option to configure or disable retry settings:\n\n```python\nfrom finch import Finch\n\n# Configure the default for all requests:\nclient = Finch(\n # default is 2\n max_retries=0,\n)\n\n# Or, configure per-request:\nclient.with_options(max_retries = 5).hris.directory.list()\n```\n\n### Timeouts\n\nBy default requests time out after 1 minute. You can configure this with a `timeout` option,\nwhich accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object:\n\n```python\nfrom finch import Finch\n\n# Configure the default for all requests:\nclient = Finch(\n # 20 seconds (default is 1 minute)\n timeout=20.0,\n)\n\n# More granular control:\nclient = Finch(\n timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),\n)\n\n# Override per-request:\nclient.with_options(timeout = 5.0).hris.directory.list()\n```\n\nOn timeout, an `APITimeoutError` is thrown.\n\nNote that requests that time out are [retried twice by default](#retries).\n\n## Default Headers\n\nWe automatically send the `Finch-API-Version` header set to `2020-09-17`.\n\nIf you need to, you can override it by setting default headers per-request or on the client object.\n\nBe aware that doing so may result in incorrect types and other unexpected or undefined behavior in the SDK.\n\n```python\nfrom finch import Finch\n\nclient = Finch(\n default_headers={\n "Finch-API-Version": "My-Custom-Value"\n },\n)\n```\n\n## Advanced\n\n### Logging\n\nWe use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.\n\nYou can enable logging by setting the environment variable `FINCH_LOG` to `info`.\n\n```shell\n$ export FINCH_LOG=info\n```\n\nOr to `debug` for more verbose logging.\n\n### How to tell whether `None` means `null` or missing\n\nIn an API response, a field may be explicitly `null`, or missing entirely; in either case, its value is `None` in this library. You can differentiate the two cases with `.model_fields_set`:\n\n```py\nif response.my_field is None:\n if \'my_field\' not in response.model_fields_set:\n print(\'Got json like {}, without a "my_field" key present at all.\')\n else:\n print(\'Got json like {"my_field": null}.\')\n```\n\n### Accessing raw response data (e.g. headers)\n\nThe "raw" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,\n\n```py\nfrom finch import Finch\n\nclient = Finch()\nresponse = client.hris.directory.with_raw_response.list()\nprint(response.headers.get(\'X-My-Header\'))\n\ndirectory = response.parse() # get the object that `hris.directory.list()` would have returned\nprint(directory.id)\n```\n\nThese methods return a [`LegacyAPIResponse`](https://github.com/Finch-API/finch-api-python/tree/main/src/finch/_legacy_response.py) object. This is a legacy class as we\'re changing it slightly in the next major version.\n\nFor the sync client this will mostly be the same with the exception\nof `content` & `text` will be methods instead of properties. In the\nasync client, all methods will be async.\n\nA migration script will be provided & the migration in general should\nbe smooth.\n\n#### `.with_streaming_response`\n\nThe above interface eagerly reads the full response body when you make the request, which may not always be what you want.\n\nTo stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.\n\nAs such, `.with_streaming_response` methods return a different [`APIResponse`](https://github.com/Finch-API/finch-api-python/tree/main/src/finch/_response.py) object, and the async client returns an [`AsyncAPIResponse`](https://github.com/Finch-API/finch-api-python/tree/main/src/finch/_response.py) object.\n\n```python\nwith client.hris.directory.with_streaming_response.list() as response :\n print(response.headers.get(\'X-My-Header\'))\n\n for line in response.iter_lines():\n print(line)\n```\n\nThe context manager is required so that the response will reliably be closed.\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API.\n\nIf you need to access undocumented endpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can make requests using `client.get`, `client.post`, and other\nhttp verbs. Options on the client will be respected (such as retries) when making this request.\n\n```py\nimport httpx\n\nresponse = client.post(\n "/foo",\n cast_to=httpx.Response,\n body={"my_param": True},\n)\n\nprint(response.headers.get("x-foo"))\n```\n\n#### Undocumented request params\n\nIf you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request\noptions.\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You\ncan also get all the extra fields on the Pydantic model as a dict with\n[`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra).\n\n### Configuring the HTTP client\n\nYou can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including:\n\n- Support for [proxies](https://www.python-httpx.org/advanced/proxies/)\n- Custom [transports](https://www.python-httpx.org/advanced/transports/)\n- Additional [advanced](https://www.python-httpx.org/advanced/clients/) functionality\n\n```python\nimport httpx\nfrom finch import Finch, DefaultHttpxClient\n\nclient = Finch(\n # Or use the `FINCH_BASE_URL` env var\n base_url="http://my.test.server.example.com:8083",\n http_client=DefaultHttpxClient(proxy="http://my.test.proxy.example.com", transport=httpx.HTTPTransport(local_address="0.0.0.0")),\n)\n```\n\nYou can also customize the client on a per-request basis by using `with_options()`:\n\n```python\nclient.with_options(http_client=DefaultHttpxClient(...))\n```\n\n### Managing HTTP resources\n\nBy default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.\n\n```py\nfrom finch import Finch\n\nwith Finch() as client:\n # make requests here\n ...\n\n# HTTP client is now closed\n```\n\n## Versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes that only affect static types, without breaking runtime behavior.\n2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n3. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Finch-API/finch-api-python/issues) with questions, bugs, or suggestions.\n\n### Determining the installed version\n\nIf you\'ve upgraded to the latest version but aren\'t seeing any new features you were expecting then your python environment is likely still using an older version.\n\nYou can determine the version that is being used at runtime with:\n\n```py\nimport finch\nprint(finch.__version__)\n```\n\n## Requirements\n\nPython 3.9 or higher.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n', + "language": "python", + "content": "# Finch Python API library\n\n\n[![PyPI version](https://img.shields.io/pypi/v/finch-api.svg?label=pypi%20(stable))](https://pypi.org/project/finch-api/)\n\nThe Finch Python library provides convenient access to the Finch REST API from any Python 3.9+\napplication. The library includes type definitions for all request params and response fields,\nand offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).\n\n\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Documentation\n\nThe REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/). The full API of this library can be found in [api.md](api.md).\n\n## Installation\n\n```sh\n# install from PyPI\npip install finch-api\n```\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n```python\nfrom finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\n\npage = client.hris.directory.list()\nprint(page.individuals)\n```\n\n\n\n## Async usage\n\nSimply import `AsyncFinch` instead of `Finch` and use `await` with each API call:\n\n```python\nimport asyncio\nfrom finch import AsyncFinch\n\nclient = AsyncFinch(\n access_token=\"My Access Token\",\n)\n\nasync def main() -> None:\n page = await client.hris.directory.list()\n print(page.individuals)\n\nasyncio.run(main())\n```\n\nFunctionality between the synchronous and asynchronous clients is otherwise identical.\n\n### With aiohttp\n\nBy default, the async client uses `httpx` for HTTP requests. However, for improved concurrency performance you may also use `aiohttp` as the HTTP backend.\n\nYou can enable this by installing `aiohttp`:\n\n```sh\n# install from PyPI\npip install finch-api[aiohttp]\n```\n\nThen you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:\n\n```python\nimport asyncio\nfrom finch import DefaultAioHttpClient\nfrom finch import AsyncFinch\n\nasync def main() -> None:\n async with AsyncFinch(\n access_token=\"My Access Token\",\n http_client=DefaultAioHttpClient(),\n) as client:\n page = await client.hris.directory.list()\n print(page.individuals)\n\nasyncio.run(main())\n```\n\n\n\n## Using types\n\nNested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:\n\n- Serializing back into JSON, `model.to_json()`\n- Converting to a dictionary, `model.to_dict()`\n\nTyped requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.\n\n## Pagination\n\nList methods in the Finch API are paginated.\n\nThis library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:\n\n```python\nfrom finch import Finch\n\nclient = Finch()\n\nall_directories = []\n# Automatically fetches more pages as needed.\nfor directory in client.hris.directory.list():\n # Do something with directory here\n all_directories.append(directory)\nprint(all_directories)\n```\n\nOr, asynchronously:\n\n```python\nimport asyncio\nfrom finch import AsyncFinch\n\nclient = AsyncFinch()\n\nasync def main() -> None:\n all_directories = []\n # Iterate through items across all pages, issuing requests as needed.\n async for directory in client.hris.directory.list():\n all_directories.append(directory)\n print(all_directories)\n\nasyncio.run(main())\n```\n\nAlternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:\n\n```python\nfirst_page = await client.hris.directory.list()\nif first_page.has_next_page():\n print(f\"will fetch next page using these details: {first_page.next_page_info()}\")\n next_page = await first_page.get_next_page()\n print(f\"number of items we just fetched: {len(next_page.individuals)}\")\n\n# Remove `await` for non-async usage.\n```\n\nOr just work directly with the returned data:\n\n```python\nfirst_page = await client.hris.directory.list()\n\nprint(f\"the current start offset for this page: {first_page.paging.offset}\") # => \"the current start offset for this page: 1\"\nfor directory in first_page.individuals:\n print(directory.id)\n\n# Remove `await` for non-async usage.\n```\n\n\n\n\n\n## Handling errors\n\nWhen the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `finch.APIConnectionError` is raised.\n\nWhen the API returns a non-success status code (that is, 4xx or 5xx\nresponse), a subclass of `finch.APIStatusError` is raised, containing `status_code` and `response` properties.\n\nAll errors inherit from `finch.APIError`.\n\n```python\nimport finch\nfrom finch import Finch\n\nclient = Finch()\n\ntry:\n client.hris.company.retrieve()\nexcept finch.APIConnectionError as e:\n print(\"The server could not be reached\")\n print(e.__cause__) # an underlying Exception, likely raised within httpx.\nexcept finch.RateLimitError as e:\n print(\"A 429 status code was received; we should back off a bit.\")\nexcept finch.APIStatusError as e:\n print(\"Another non-200-range status code was received\")\n print(e.status_code)\n print(e.response)\n```\n\nError codes are as follows:\n\n| Status Code | Error Type |\n| ----------- | -------------------------- |\n| 400 | `BadRequestError` |\n| 401 | `AuthenticationError` |\n| 403 | `PermissionDeniedError` |\n| 404 | `NotFoundError` |\n| 422 | `UnprocessableEntityError` |\n| 429 | `RateLimitError` |\n| >=500 | `InternalServerError` |\n| N/A | `APIConnectionError` |\n\n### Retries\n\nCertain errors are automatically retried 2 times by default, with a short exponential backoff.\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,\n429 Rate Limit, and >=500 Internal errors are all retried by default.\n\nYou can use the `max_retries` option to configure or disable retry settings:\n\n```python\nfrom finch import Finch\n\n# Configure the default for all requests:\nclient = Finch(\n # default is 2\n max_retries=0,\n)\n\n# Or, configure per-request:\nclient.with_options(max_retries = 5).hris.directory.list()\n```\n\n### Timeouts\n\nBy default requests time out after 1 minute. You can configure this with a `timeout` option,\nwhich accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object:\n\n```python\nfrom finch import Finch\n\n# Configure the default for all requests:\nclient = Finch(\n # 20 seconds (default is 1 minute)\n timeout=20.0,\n)\n\n# More granular control:\nclient = Finch(\n timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),\n)\n\n# Override per-request:\nclient.with_options(timeout = 5.0).hris.directory.list()\n```\n\nOn timeout, an `APITimeoutError` is thrown.\n\nNote that requests that time out are [retried twice by default](#retries).\n\n## Default Headers\n\nWe automatically send the `Finch-API-Version` header set to `2020-09-17`.\n\nIf you need to, you can override it by setting default headers per-request or on the client object.\n\nBe aware that doing so may result in incorrect types and other unexpected or undefined behavior in the SDK.\n\n```python\nfrom finch import Finch\n\nclient = Finch(\n default_headers={\n \"Finch-API-Version\": \"My-Custom-Value\"\n },\n)\n```\n\n## Advanced\n\n### Logging\n\nWe use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.\n\nYou can enable logging by setting the environment variable `FINCH_LOG` to `info`.\n\n```shell\n$ export FINCH_LOG=info\n```\n\nOr to `debug` for more verbose logging.\n\n### How to tell whether `None` means `null` or missing\n\nIn an API response, a field may be explicitly `null`, or missing entirely; in either case, its value is `None` in this library. You can differentiate the two cases with `.model_fields_set`:\n\n```py\nif response.my_field is None:\n if 'my_field' not in response.model_fields_set:\n print('Got json like {}, without a \"my_field\" key present at all.')\n else:\n print('Got json like {\"my_field\": null}.')\n```\n\n### Accessing raw response data (e.g. headers)\n\nThe \"raw\" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,\n\n```py\nfrom finch import Finch\n\nclient = Finch()\nresponse = client.hris.directory.with_raw_response.list()\nprint(response.headers.get('X-My-Header'))\n\ndirectory = response.parse() # get the object that `hris.directory.list()` would have returned\nprint(directory.id)\n```\n\nThese methods return a [`LegacyAPIResponse`](https://github.com/Finch-API/finch-api-python/tree/main/src/finch/_legacy_response.py) object. This is a legacy class as we're changing it slightly in the next major version.\n\nFor the sync client this will mostly be the same with the exception\nof `content` & `text` will be methods instead of properties. In the\nasync client, all methods will be async.\n\nA migration script will be provided & the migration in general should\nbe smooth.\n\n#### `.with_streaming_response`\n\nThe above interface eagerly reads the full response body when you make the request, which may not always be what you want.\n\nTo stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.\n\nAs such, `.with_streaming_response` methods return a different [`APIResponse`](https://github.com/Finch-API/finch-api-python/tree/main/src/finch/_response.py) object, and the async client returns an [`AsyncAPIResponse`](https://github.com/Finch-API/finch-api-python/tree/main/src/finch/_response.py) object.\n\n```python\nwith client.hris.directory.with_streaming_response.list() as response :\n print(response.headers.get('X-My-Header'))\n\n for line in response.iter_lines():\n print(line)\n```\n\nThe context manager is required so that the response will reliably be closed.\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API.\n\nIf you need to access undocumented endpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can make requests using `client.get`, `client.post`, and other\nhttp verbs. Options on the client will be respected (such as retries) when making this request.\n\n```py\nimport httpx\n\nresponse = client.post(\n \"/foo\",\n cast_to=httpx.Response,\n body={\"my_param\": True},\n)\n\nprint(response.headers.get(\"x-foo\"))\n```\n\n#### Undocumented request params\n\nIf you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request\noptions.\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You\ncan also get all the extra fields on the Pydantic model as a dict with\n[`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra).\n\n### Configuring the HTTP client\n\nYou can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including:\n\n- Support for [proxies](https://www.python-httpx.org/advanced/proxies/)\n- Custom [transports](https://www.python-httpx.org/advanced/transports/)\n- Additional [advanced](https://www.python-httpx.org/advanced/clients/) functionality\n\n```python\nimport httpx\nfrom finch import Finch, DefaultHttpxClient\n\nclient = Finch(\n # Or use the `FINCH_BASE_URL` env var\n base_url=\"http://my.test.server.example.com:8083\",\n http_client=DefaultHttpxClient(proxy=\"http://my.test.proxy.example.com\", transport=httpx.HTTPTransport(local_address=\"0.0.0.0\")),\n)\n```\n\nYou can also customize the client on a per-request basis by using `with_options()`:\n\n```python\nclient.with_options(http_client=DefaultHttpxClient(...))\n```\n\n### Managing HTTP resources\n\nBy default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.\n\n```py\nfrom finch import Finch\n\nwith Finch() as client:\n # make requests here\n ...\n\n# HTTP client is now closed\n```\n\n## Versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes that only affect static types, without breaking runtime behavior.\n2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n3. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Finch-API/finch-api-python/issues) with questions, bugs, or suggestions.\n\n### Determining the installed version\n\nIf you've upgraded to the latest version but aren't seeing any new features you were expecting then your python environment is likely still using an older version.\n\nYou can determine the version that is being used at runtime with:\n\n```py\nimport finch\nprint(finch.__version__)\n```\n\n## Requirements\n\nPython 3.9 or higher.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n" }, { - language: 'ruby', - content: - '# Finch Ruby API library\n\nThe Finch Ruby library provides convenient access to the Finch REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/Finch-API/finch-api-ruby#Sorbet) for usage with Sorbet. The standard library\'s `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.\n\n\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Documentation\n\nDocumentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/finch-api).\n\nThe REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/).\n\n## Installation\n\nTo use this gem, install via Bundler by adding the following to your application\'s `Gemfile`:\n\n\n\n```ruby\ngem "finch-api", "~> 0.0.1"\n```\n\n\n\n## Usage\n\n```ruby\nrequire "bundler/setup"\nrequire "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.directory.list\n\nputs(page.id)\n```\n\n\n\n### Pagination\n\nList methods in the Finch API are paginated.\n\nThis library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:\n\n```ruby\npage = finch.hris.directory.list\n\n# Fetch single item from page.\ndirectory = page.individuals[0]\nputs(directory.id)\n\n# Automatically fetches more pages as needed.\npage.auto_paging_each do |directory|\n puts(directory.id)\nend\n```\n\nAlternatively, you can use the `#next_page?` and `#next_page` methods for more granular control working with pages.\n\n```ruby\nif page.next_page?\n new_page = page.next_page\n puts(new_page.individuals[0].id)\nend\n```\n\n\n\n### Handling errors\n\nWhen the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `FinchAPI::Errors::APIError` will be thrown:\n\n```ruby\nbegin\n company = finch.hris.company.retrieve\nrescue FinchAPI::Errors::APIConnectionError => e\n puts("The server could not be reached")\n puts(e.cause) # an underlying Exception, likely raised within `net/http`\nrescue FinchAPI::Errors::RateLimitError => e\n puts("A 429 status code was received; we should back off a bit.")\nrescue FinchAPI::Errors::APIStatusError => e\n puts("Another non-200-range status code was received")\n puts(e.status)\nend\n```\n\nError codes are as follows:\n\n| Cause | Error Type |\n| ---------------- | -------------------------- |\n| HTTP 400 | `BadRequestError` |\n| HTTP 401 | `AuthenticationError` |\n| HTTP 403 | `PermissionDeniedError` |\n| HTTP 404 | `NotFoundError` |\n| HTTP 409 | `ConflictError` |\n| HTTP 422 | `UnprocessableEntityError` |\n| HTTP 429 | `RateLimitError` |\n| HTTP >= 500 | `InternalServerError` |\n| Other HTTP error | `APIStatusError` |\n| Timeout | `APITimeoutError` |\n| Network error | `APIConnectionError` |\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\n\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, >=500 Internal errors, and timeouts will all be retried by default.\n\nYou can use the `max_retries` option to configure or disable this:\n\n```ruby\n# Configure the default for all requests:\nfinch = FinchAPI::Client.new(\n max_retries: 0 # default is 2\n)\n\n# Or, configure per-request:\nfinch.hris.directory.list(request_options: {max_retries: 5})\n```\n\n### Timeouts\n\nBy default, requests will time out after 60 seconds. You can use the timeout option to configure or disable this:\n\n```ruby\n# Configure the default for all requests:\nfinch = FinchAPI::Client.new(\n timeout: nil # default is 60\n)\n\n# Or, configure per-request:\nfinch.hris.directory.list(request_options: {timeout: 5})\n```\n\nOn timeout, `FinchAPI::Errors::APITimeoutError` is raised.\n\nNote that requests that time out are retried by default.\n\n## Advanced concepts\n\n### BaseModel\n\nAll parameter and response objects inherit from `FinchAPI::Internal::Type::BaseModel`, which provides several conveniences, including:\n\n1. All fields, including unknown ones, are accessible with `obj[:prop]` syntax, and can be destructured with `obj => {prop: prop}` or pattern-matching syntax.\n\n2. Structural equivalence for equality; if two API calls return the same values, comparing the responses with == will return true.\n\n3. Both instances and the classes themselves can be pretty-printed.\n\n4. Helpers such as `#to_h`, `#deep_to_h`, `#to_json`, and `#to_yaml`.\n\n### Making custom or undocumented requests\n\n#### Undocumented properties\n\nYou can send undocumented parameters to any endpoint, and read undocumented response properties, like so:\n\nNote: the `extra_` parameters of the same name overrides the documented parameters.\n\n```ruby\npage =\n finch.hris.directory.list(\n request_options: {\n extra_query: {my_query_parameter: value},\n extra_body: {my_body_parameter: value},\n extra_headers: {"my-header": value}\n }\n )\n\nputs(page[:my_undocumented_property])\n```\n\n#### Undocumented request params\n\nIf you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request, as seen in the examples above.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints while retaining the benefit of auth, retries, and so on, you can make requests using `client.request`, like so:\n\n```ruby\nresponse = client.request(\n method: :post,\n path: \'/undocumented/endpoint\',\n query: {"dog": "woof"},\n headers: {"useful-header": "interesting-value"},\n body: {"hello": "world"}\n)\n```\n\n### Concurrency & connection pooling\n\nThe `FinchAPI::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.\n\nEach instance of `FinchAPI::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.\n\nWhen all available connections from the pool are checked out, requests wait for a new connection to become available, with queue time counting towards the request timeout.\n\nUnless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.\n\n## Sorbet\n\nThis library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitions, and has no dependency on sorbet-runtime.\n\nYou can provide typesafe request parameters like so:\n\n```ruby\nfinch.hris.directory.list \n```\n\nOr, equivalently:\n\n```ruby\n# Hashes work, but are not typesafe:\nfinch.hris.directory.list\n\n# You can also splat a full Params class:\nparams = FinchAPI::HRIS::DirectoryListParams.new\nfinch.hris.directory.list(**params)\n```\n\n### Enums\n\nSince this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:\n\n```ruby\n# :every_paycheck\nputs(FinchAPI::HRIS::BenefitFrequency::EVERY_PAYCHECK)\n\n# Revealed type: `T.all(FinchAPI::HRIS::BenefitFrequency, Symbol)`\nT.reveal_type(FinchAPI::HRIS::BenefitFrequency::EVERY_PAYCHECK)\n```\n\nEnum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:\n\n```ruby\n# Using the enum constants preserves the tagged type information:\nfinch.hris.benefits.create(\n frequency: FinchAPI::HRIS::BenefitFrequency::EVERY_PAYCHECK,\n # …\n)\n\n# Literal values are also permissible:\nfinch.hris.benefits.create(\n frequency: :every_paycheck,\n # …\n)\n```\n\n## Versioning\n\nThis package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time.\n\nThis package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` type definitions to be non-breaking changes.\n\n## Requirements\n\nRuby 3.2.0 or higher.\n\n## Contributing\n\nSee [the contributing documentation](https://github.com/Finch-API/finch-api-ruby/tree/main/CONTRIBUTING.md).\n', + "language": "ruby", + "content": "# Finch Ruby API library\n\nThe Finch Ruby library provides convenient access to the Finch REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/Finch-API/finch-api-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.\n\n\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Documentation\n\nDocumentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/finch-api).\n\nThe REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/).\n\n## Installation\n\nTo use this gem, install via Bundler by adding the following to your application's `Gemfile`:\n\n\n\n```ruby\ngem \"finch-api\", \"~> 0.0.1\"\n```\n\n\n\n## Usage\n\n```ruby\nrequire \"bundler/setup\"\nrequire \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\npage = finch.hris.directory.list\n\nputs(page.id)\n```\n\n\n\n### Pagination\n\nList methods in the Finch API are paginated.\n\nThis library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:\n\n```ruby\npage = finch.hris.directory.list\n\n# Fetch single item from page.\ndirectory = page.individuals[0]\nputs(directory.id)\n\n# Automatically fetches more pages as needed.\npage.auto_paging_each do |directory|\n puts(directory.id)\nend\n```\n\nAlternatively, you can use the `#next_page?` and `#next_page` methods for more granular control working with pages.\n\n```ruby\nif page.next_page?\n new_page = page.next_page\n puts(new_page.individuals[0].id)\nend\n```\n\n\n\n### Handling errors\n\nWhen the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `FinchAPI::Errors::APIError` will be thrown:\n\n```ruby\nbegin\n company = finch.hris.company.retrieve\nrescue FinchAPI::Errors::APIConnectionError => e\n puts(\"The server could not be reached\")\n puts(e.cause) # an underlying Exception, likely raised within `net/http`\nrescue FinchAPI::Errors::RateLimitError => e\n puts(\"A 429 status code was received; we should back off a bit.\")\nrescue FinchAPI::Errors::APIStatusError => e\n puts(\"Another non-200-range status code was received\")\n puts(e.status)\nend\n```\n\nError codes are as follows:\n\n| Cause | Error Type |\n| ---------------- | -------------------------- |\n| HTTP 400 | `BadRequestError` |\n| HTTP 401 | `AuthenticationError` |\n| HTTP 403 | `PermissionDeniedError` |\n| HTTP 404 | `NotFoundError` |\n| HTTP 409 | `ConflictError` |\n| HTTP 422 | `UnprocessableEntityError` |\n| HTTP 429 | `RateLimitError` |\n| HTTP >= 500 | `InternalServerError` |\n| Other HTTP error | `APIStatusError` |\n| Timeout | `APITimeoutError` |\n| Network error | `APIConnectionError` |\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\n\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, >=500 Internal errors, and timeouts will all be retried by default.\n\nYou can use the `max_retries` option to configure or disable this:\n\n```ruby\n# Configure the default for all requests:\nfinch = FinchAPI::Client.new(\n max_retries: 0 # default is 2\n)\n\n# Or, configure per-request:\nfinch.hris.directory.list(request_options: {max_retries: 5})\n```\n\n### Timeouts\n\nBy default, requests will time out after 60 seconds. You can use the timeout option to configure or disable this:\n\n```ruby\n# Configure the default for all requests:\nfinch = FinchAPI::Client.new(\n timeout: nil # default is 60\n)\n\n# Or, configure per-request:\nfinch.hris.directory.list(request_options: {timeout: 5})\n```\n\nOn timeout, `FinchAPI::Errors::APITimeoutError` is raised.\n\nNote that requests that time out are retried by default.\n\n## Advanced concepts\n\n### BaseModel\n\nAll parameter and response objects inherit from `FinchAPI::Internal::Type::BaseModel`, which provides several conveniences, including:\n\n1. All fields, including unknown ones, are accessible with `obj[:prop]` syntax, and can be destructured with `obj => {prop: prop}` or pattern-matching syntax.\n\n2. Structural equivalence for equality; if two API calls return the same values, comparing the responses with == will return true.\n\n3. Both instances and the classes themselves can be pretty-printed.\n\n4. Helpers such as `#to_h`, `#deep_to_h`, `#to_json`, and `#to_yaml`.\n\n### Making custom or undocumented requests\n\n#### Undocumented properties\n\nYou can send undocumented parameters to any endpoint, and read undocumented response properties, like so:\n\nNote: the `extra_` parameters of the same name overrides the documented parameters.\n\n```ruby\npage =\n finch.hris.directory.list(\n request_options: {\n extra_query: {my_query_parameter: value},\n extra_body: {my_body_parameter: value},\n extra_headers: {\"my-header\": value}\n }\n )\n\nputs(page[:my_undocumented_property])\n```\n\n#### Undocumented request params\n\nIf you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request, as seen in the examples above.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints while retaining the benefit of auth, retries, and so on, you can make requests using `client.request`, like so:\n\n```ruby\nresponse = client.request(\n method: :post,\n path: '/undocumented/endpoint',\n query: {\"dog\": \"woof\"},\n headers: {\"useful-header\": \"interesting-value\"},\n body: {\"hello\": \"world\"}\n)\n```\n\n### Concurrency & connection pooling\n\nThe `FinchAPI::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.\n\nEach instance of `FinchAPI::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.\n\nWhen all available connections from the pool are checked out, requests wait for a new connection to become available, with queue time counting towards the request timeout.\n\nUnless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.\n\n## Sorbet\n\nThis library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitions, and has no dependency on sorbet-runtime.\n\nYou can provide typesafe request parameters like so:\n\n```ruby\nfinch.hris.directory.list \n```\n\nOr, equivalently:\n\n```ruby\n# Hashes work, but are not typesafe:\nfinch.hris.directory.list\n\n# You can also splat a full Params class:\nparams = FinchAPI::HRIS::DirectoryListParams.new\nfinch.hris.directory.list(**params)\n```\n\n### Enums\n\nSince this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide \"tagged symbols\" instead, which is always a primitive at runtime:\n\n```ruby\n# :every_paycheck\nputs(FinchAPI::HRIS::BenefitFrequency::EVERY_PAYCHECK)\n\n# Revealed type: `T.all(FinchAPI::HRIS::BenefitFrequency, Symbol)`\nT.reveal_type(FinchAPI::HRIS::BenefitFrequency::EVERY_PAYCHECK)\n```\n\nEnum parameters have a \"relaxed\" type, so you can either pass in enum constants or their literal value:\n\n```ruby\n# Using the enum constants preserves the tagged type information:\nfinch.hris.benefits.create(\n frequency: FinchAPI::HRIS::BenefitFrequency::EVERY_PAYCHECK,\n # …\n)\n\n# Literal values are also permissible:\nfinch.hris.benefits.create(\n frequency: :every_paycheck,\n # …\n)\n```\n\n## Versioning\n\nThis package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time.\n\nThis package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` type definitions to be non-breaking changes.\n\n## Requirements\n\nRuby 3.2.0 or higher.\n\n## Contributing\n\nSee [the contributing documentation](https://github.com/Finch-API/finch-api-ruby/tree/main/CONTRIBUTING.md).\n" }, { - language: 'typescript', - content: - "# Finch TypeScript API Library\n\n[![NPM version](https://img.shields.io/npm/v/@tryfinch/finch-api.svg?label=npm%20(stable))](https://npmjs.org/package/@tryfinch/finch-api) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@tryfinch/finch-api)\n\nThis library provides convenient access to the Finch REST API from server-side TypeScript or JavaScript.\n\n\n\nThe REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/). The full API of this library can be found in [api.md](api.md).\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Installation\n\n```sh\nnpm install @tryfinch/finch-api\n```\n\n\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n\n```js\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst page = await client.hris.directory.list();\nconst individualInDirectory = page.individuals[0];\n\nconsole.log(individualInDirectory.id);\n```\n\n\n\n### Request & Response types\n\nThis library includes TypeScript definitions for all request params and response fields. You may import and use them like so:\n\n\n```ts\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst [individualInDirectory]: [Finch.HRIS.IndividualInDirectory] =\n await client.hris.directory.list();\n```\n\nDocumentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.\n\n\n\n\n\n## Handling errors\n\nWhen the library is unable to connect to the API,\nor if the API returns a non-success status code (i.e., 4xx or 5xx response),\na subclass of `APIError` will be thrown:\n\n\n```ts\nconst company = await client.hris.company.retrieve().catch(async (err) => {\n if (err instanceof Finch.APIError) {\n console.log(err.status); // 400\n console.log(err.name); // BadRequestError\n console.log(err.headers); // {server: 'nginx', ...}\n } else {\n throw err;\n }\n});\n```\n\nError codes are as follows:\n\n| Status Code | Error Type |\n| ----------- | -------------------------- |\n| 400 | `BadRequestError` |\n| 401 | `AuthenticationError` |\n| 403 | `PermissionDeniedError` |\n| 404 | `NotFoundError` |\n| 422 | `UnprocessableEntityError` |\n| 429 | `RateLimitError` |\n| >=500 | `InternalServerError` |\n| N/A | `APIConnectionError` |\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,\n429 Rate Limit, and >=500 Internal errors will all be retried by default.\n\nYou can use the `maxRetries` option to configure or disable this:\n\n\n```js\n// Configure the default for all requests:\nconst client = new Finch({\n maxRetries: 0, // default is 2\n});\n\n// Or, configure per-request:\nawait client.hris.directory.list({\n maxRetries: 5,\n});\n```\n\n### Timeouts\n\nRequests time out after 1 minute by default. You can configure this with a `timeout` option:\n\n\n```ts\n// Configure the default for all requests:\nconst client = new Finch({\n timeout: 20 * 1000, // 20 seconds (default is 1 minute)\n});\n\n// Override per-request:\nawait client.hris.directory.list({\n timeout: 5 * 1000,\n});\n```\n\nOn timeout, an `APIConnectionTimeoutError` is thrown.\n\nNote that requests which time out will be [retried twice by default](#retries).\n\n## Auto-pagination\n\nList methods in the Finch API are paginated.\nYou can use the `for await … of` syntax to iterate through items across all pages:\n\n```ts\nasync function fetchAllIndividualInDirectories(params) {\n const allIndividualInDirectories = [];\n // Automatically fetches more pages as needed.\n for await (const individualInDirectory of client.hris.directory.list()) {\n allIndividualInDirectories.push(individualInDirectory);\n }\n return allIndividualInDirectories;\n}\n```\n\nAlternatively, you can request a single page at a time:\n\n```ts\nlet page = await client.hris.directory.list();\nfor (const individualInDirectory of page.individuals) {\n console.log(individualInDirectory);\n}\n\n// Convenience methods are provided for manually paginating:\nwhile (page.hasNextPage()) {\n page = await page.getNextPage();\n // ...\n}\n```\n\n## Default Headers\n\nWe automatically send the `Finch-API-Version` header set to `2020-09-17`.\n\nIf you need to, you can override it by setting default headers on a per-request basis.\n\nBe aware that doing so may result in incorrect types and other unexpected or undefined behavior in the SDK.\n\n```ts\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst page = await client.hris.directory.list({\n headers: { 'Finch-API-Version': 'My-Custom-Value' },\n});\nconst individualInDirectory = page.individuals[0];\n```\n\n## Advanced Usage\n\n### Accessing raw Response data (e.g., headers)\n\nThe \"raw\" `Response` returned by `fetch()` can be accessed through the `.asResponse()` method on the `APIPromise` type that all methods return.\nThis method returns as soon as the headers for a successful response are received and does not consume the response body, so you are free to write custom parsing or streaming logic.\n\nYou can also use the `.withResponse()` method to get the raw `Response` along with the parsed data.\nUnlike `.asResponse()` this method consumes the body, returning once it is parsed.\n\n\n```ts\nconst client = new Finch();\n\nconst response = await client.hris.directory.list().asResponse();\nconsole.log(response.headers.get('X-My-Header'));\nconsole.log(response.statusText); // access the underlying Response object\n\nconst { data: page, response: raw } = await client.hris.directory.list().withResponse();\nconsole.log(raw.headers.get('X-My-Header'));\nfor await (const individualInDirectory of page) {\n console.log(individualInDirectory.id);\n}\n```\n\n### Logging\n\n> [!IMPORTANT]\n> All log messages are intended for debugging only. The format and content of log messages\n> may change between releases.\n\n#### Log levels\n\nThe log level can be configured in two ways:\n\n1. Via the `FINCH_LOG` environment variable\n2. Using the `logLevel` client option (overrides the environment variable if set)\n\n```ts\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n logLevel: 'debug', // Show all log messages\n});\n```\n\nAvailable log levels, from most to least verbose:\n\n- `'debug'` - Show debug messages, info, warnings, and errors\n- `'info'` - Show info messages, warnings, and errors\n- `'warn'` - Show warnings and errors (default)\n- `'error'` - Show only errors\n- `'off'` - Disable all logging\n\nAt the `'debug'` level, all HTTP requests and responses are logged, including headers and bodies.\nSome authentication-related headers are redacted, but sensitive data in request and response bodies\nmay still be visible.\n\n#### Custom logger\n\nBy default, this library logs to `globalThis.console`. You can also provide a custom logger.\nMost logging libraries are supported, including [pino](https://www.npmjs.com/package/pino), [winston](https://www.npmjs.com/package/winston), [bunyan](https://www.npmjs.com/package/bunyan), [consola](https://www.npmjs.com/package/consola), [signale](https://www.npmjs.com/package/signale), and [@std/log](https://jsr.io/@std/log). If your logger doesn't work, please open an issue.\n\nWhen providing a custom logger, the `logLevel` option still controls which messages are emitted, messages\nbelow the configured level will not be sent to your logger.\n\n```ts\nimport Finch from '@tryfinch/finch-api';\nimport pino from 'pino';\n\nconst logger = pino();\n\nconst client = new Finch({\n logger: logger.child({ name: 'Finch' }),\n logLevel: 'debug', // Send all messages to pino, allowing it to filter\n});\n```\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API. If you need to access undocumented\nendpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can use `client.get`, `client.post`, and other HTTP verbs.\nOptions on the client, such as retries, will be respected when making these requests.\n\n```ts\nawait client.post('/some/path', {\n body: { some_prop: 'foo' },\n query: { some_query_arg: 'bar' },\n});\n```\n\n#### Undocumented request params\n\nTo make requests using undocumented parameters, you may use `// @ts-expect-error` on the undocumented\nparameter. This library doesn't validate at runtime that the request matches the type, so any extra values you\nsend will be sent as-is.\n\n```ts\nclient.hris.directory.list({\n // ...\n // @ts-expect-error baz is not yet public\n baz: 'undocumented option',\n});\n```\n\nFor requests with the `GET` verb, any extra params will be in the query, all other requests will send the\nextra param in the body.\n\nIf you want to explicitly send an extra argument, you can do so with the `query`, `body`, and `headers` request\noptions.\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you may access the response object with `// @ts-expect-error` on\nthe response object, or cast the response object to the requisite type. Like the request params, we do not\nvalidate or strip extra properties from the response from the API.\n\n### Customizing the fetch client\n\nBy default, this library expects a global `fetch` function is defined.\n\nIf you want to use a different `fetch` function, you can either polyfill the global:\n\n```ts\nimport fetch from 'my-fetch';\n\nglobalThis.fetch = fetch;\n```\n\nOr pass it to the client:\n\n```ts\nimport Finch from '@tryfinch/finch-api';\nimport fetch from 'my-fetch';\n\nconst client = new Finch({ fetch });\n```\n\n### Fetch options\n\nIf you want to set custom `fetch` options without overriding the `fetch` function, you can provide a `fetchOptions` object when instantiating the client or making a request. (Request-specific options override client options.)\n\n```ts\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n fetchOptions: {\n // `RequestInit` options\n },\n});\n```\n\n#### Configuring proxies\n\nTo modify proxy behavior, you can provide custom `fetchOptions` that add runtime-specific proxy\noptions to requests:\n\n **Node** [[docs](https://github.com/nodejs/undici/blob/main/docs/docs/api/ProxyAgent.md#example---proxyagent-with-fetch)]\n\n```ts\nimport Finch from '@tryfinch/finch-api';\nimport * as undici from 'undici';\n\nconst proxyAgent = new undici.ProxyAgent('http://localhost:8888');\nconst client = new Finch({\n fetchOptions: {\n dispatcher: proxyAgent,\n },\n});\n```\n\n **Bun** [[docs](https://bun.sh/guides/http/proxy)]\n\n```ts\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n fetchOptions: {\n proxy: 'http://localhost:8888',\n },\n});\n```\n\n **Deno** [[docs](https://docs.deno.com/api/deno/~/Deno.createHttpClient)]\n\n```ts\nimport Finch from 'npm:@tryfinch/finch-api';\n\nconst httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });\nconst client = new Finch({\n fetchOptions: {\n client: httpClient,\n },\n});\n```\n\n## Frequently Asked Questions\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes that only affect static types, without breaking runtime behavior.\n2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n3. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Finch-API/finch-api-node/issues) with questions, bugs, or suggestions.\n\n## Requirements\n\nTypeScript >= 4.9 is supported.\n\nThe following runtimes are supported:\n\n- Node.js 20 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.\n- Deno v1.28.0 or higher.\n- Bun 1.0 or later.\n- Cloudflare Workers.\n- Vercel Edge Runtime.\n- Jest 28 or greater with the `\"node\"` environment (`\"jsdom\"` is not supported at this time).\n- Nitro v2.6 or greater.\n- Web browsers: disabled by default to avoid exposing your secret API credentials. Enable browser support by explicitly setting `dangerouslyAllowBrowser` to true'.\n
\n More explanation\n\n ### Why is this dangerous?\n Enabling the `dangerouslyAllowBrowser` option can be dangerous because it exposes your secret API credentials in the client-side code. Web browsers are inherently less secure than server environments,\n any user with access to the browser can potentially inspect, extract, and misuse these credentials. This could lead to unauthorized access using your credentials and potentially compromise sensitive data or functionality.\n ### When might this not be dangerous?\n In certain scenarios where enabling browser support might not pose significant risks:\n - Internal Tools: If the application is used solely within a controlled internal environment where the users are trusted, the risk of credential exposure can be mitigated.\n - Public APIs with Limited Scope: If your API has very limited scope and the exposed credentials do not grant access to sensitive data or critical operations, the potential impact of exposure is reduced.\n - Development or debugging purpose: Enabling this feature temporarily might be acceptable, provided the credentials are short-lived, aren't also used in production environments, or are frequently rotated.\n\n
\n\nNote that React Native is not supported at this time.\n\nIf you are interested in other runtime environments, please open or upvote an issue on GitHub.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n", - }, + "language": "typescript", + "content": "# Finch TypeScript API Library\n\n[![NPM version](https://img.shields.io/npm/v/@tryfinch/finch-api.svg?label=npm%20(stable))](https://npmjs.org/package/@tryfinch/finch-api) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@tryfinch/finch-api)\n\nThis library provides convenient access to the Finch REST API from server-side TypeScript or JavaScript.\n\n\n\nThe REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/). The full API of this library can be found in [api.md](api.md).\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Installation\n\n```sh\nnpm install @tryfinch/finch-api\n```\n\n\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n\n```js\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst page = await client.hris.directory.list();\nconst individualInDirectory = page.individuals[0];\n\nconsole.log(individualInDirectory.id);\n```\n\n\n\n### Request & Response types\n\nThis library includes TypeScript definitions for all request params and response fields. You may import and use them like so:\n\n\n```ts\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst [individualInDirectory]: [Finch.HRIS.IndividualInDirectory] =\n await client.hris.directory.list();\n```\n\nDocumentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.\n\n\n\n\n\n## Handling errors\n\nWhen the library is unable to connect to the API,\nor if the API returns a non-success status code (i.e., 4xx or 5xx response),\na subclass of `APIError` will be thrown:\n\n\n```ts\nconst company = await client.hris.company.retrieve().catch(async (err) => {\n if (err instanceof Finch.APIError) {\n console.log(err.status); // 400\n console.log(err.name); // BadRequestError\n console.log(err.headers); // {server: 'nginx', ...}\n } else {\n throw err;\n }\n});\n```\n\nError codes are as follows:\n\n| Status Code | Error Type |\n| ----------- | -------------------------- |\n| 400 | `BadRequestError` |\n| 401 | `AuthenticationError` |\n| 403 | `PermissionDeniedError` |\n| 404 | `NotFoundError` |\n| 422 | `UnprocessableEntityError` |\n| 429 | `RateLimitError` |\n| >=500 | `InternalServerError` |\n| N/A | `APIConnectionError` |\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,\n429 Rate Limit, and >=500 Internal errors will all be retried by default.\n\nYou can use the `maxRetries` option to configure or disable this:\n\n\n```js\n// Configure the default for all requests:\nconst client = new Finch({\n maxRetries: 0, // default is 2\n});\n\n// Or, configure per-request:\nawait client.hris.directory.list({\n maxRetries: 5,\n});\n```\n\n### Timeouts\n\nRequests time out after 1 minute by default. You can configure this with a `timeout` option:\n\n\n```ts\n// Configure the default for all requests:\nconst client = new Finch({\n timeout: 20 * 1000, // 20 seconds (default is 1 minute)\n});\n\n// Override per-request:\nawait client.hris.directory.list({\n timeout: 5 * 1000,\n});\n```\n\nOn timeout, an `APIConnectionTimeoutError` is thrown.\n\nNote that requests which time out will be [retried twice by default](#retries).\n\n## Auto-pagination\n\nList methods in the Finch API are paginated.\nYou can use the `for await … of` syntax to iterate through items across all pages:\n\n```ts\nasync function fetchAllIndividualInDirectories(params) {\n const allIndividualInDirectories = [];\n // Automatically fetches more pages as needed.\n for await (const individualInDirectory of client.hris.directory.list()) {\n allIndividualInDirectories.push(individualInDirectory);\n }\n return allIndividualInDirectories;\n}\n```\n\nAlternatively, you can request a single page at a time:\n\n```ts\nlet page = await client.hris.directory.list();\nfor (const individualInDirectory of page.individuals) {\n console.log(individualInDirectory);\n}\n\n// Convenience methods are provided for manually paginating:\nwhile (page.hasNextPage()) {\n page = await page.getNextPage();\n // ...\n}\n```\n\n## Default Headers\n\nWe automatically send the `Finch-API-Version` header set to `2020-09-17`.\n\nIf you need to, you can override it by setting default headers on a per-request basis.\n\nBe aware that doing so may result in incorrect types and other unexpected or undefined behavior in the SDK.\n\n```ts\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst page = await client.hris.directory.list({\n headers: { 'Finch-API-Version': 'My-Custom-Value' },\n});\nconst individualInDirectory = page.individuals[0];\n```\n\n## Advanced Usage\n\n### Accessing raw Response data (e.g., headers)\n\nThe \"raw\" `Response` returned by `fetch()` can be accessed through the `.asResponse()` method on the `APIPromise` type that all methods return.\nThis method returns as soon as the headers for a successful response are received and does not consume the response body, so you are free to write custom parsing or streaming logic.\n\nYou can also use the `.withResponse()` method to get the raw `Response` along with the parsed data.\nUnlike `.asResponse()` this method consumes the body, returning once it is parsed.\n\n\n```ts\nconst client = new Finch();\n\nconst response = await client.hris.directory.list().asResponse();\nconsole.log(response.headers.get('X-My-Header'));\nconsole.log(response.statusText); // access the underlying Response object\n\nconst { data: page, response: raw } = await client.hris.directory.list().withResponse();\nconsole.log(raw.headers.get('X-My-Header'));\nfor await (const individualInDirectory of page) {\n console.log(individualInDirectory.id);\n}\n```\n\n### Logging\n\n> [!IMPORTANT]\n> All log messages are intended for debugging only. The format and content of log messages\n> may change between releases.\n\n#### Log levels\n\nThe log level can be configured in two ways:\n\n1. Via the `FINCH_LOG` environment variable\n2. Using the `logLevel` client option (overrides the environment variable if set)\n\n```ts\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n logLevel: 'debug', // Show all log messages\n});\n```\n\nAvailable log levels, from most to least verbose:\n\n- `'debug'` - Show debug messages, info, warnings, and errors\n- `'info'` - Show info messages, warnings, and errors\n- `'warn'` - Show warnings and errors (default)\n- `'error'` - Show only errors\n- `'off'` - Disable all logging\n\nAt the `'debug'` level, all HTTP requests and responses are logged, including headers and bodies.\nSome authentication-related headers are redacted, but sensitive data in request and response bodies\nmay still be visible.\n\n#### Custom logger\n\nBy default, this library logs to `globalThis.console`. You can also provide a custom logger.\nMost logging libraries are supported, including [pino](https://www.npmjs.com/package/pino), [winston](https://www.npmjs.com/package/winston), [bunyan](https://www.npmjs.com/package/bunyan), [consola](https://www.npmjs.com/package/consola), [signale](https://www.npmjs.com/package/signale), and [@std/log](https://jsr.io/@std/log). If your logger doesn't work, please open an issue.\n\nWhen providing a custom logger, the `logLevel` option still controls which messages are emitted, messages\nbelow the configured level will not be sent to your logger.\n\n```ts\nimport Finch from '@tryfinch/finch-api';\nimport pino from 'pino';\n\nconst logger = pino();\n\nconst client = new Finch({\n logger: logger.child({ name: 'Finch' }),\n logLevel: 'debug', // Send all messages to pino, allowing it to filter\n});\n```\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API. If you need to access undocumented\nendpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can use `client.get`, `client.post`, and other HTTP verbs.\nOptions on the client, such as retries, will be respected when making these requests.\n\n```ts\nawait client.post('/some/path', {\n body: { some_prop: 'foo' },\n query: { some_query_arg: 'bar' },\n});\n```\n\n#### Undocumented request params\n\nTo make requests using undocumented parameters, you may use `// @ts-expect-error` on the undocumented\nparameter. This library doesn't validate at runtime that the request matches the type, so any extra values you\nsend will be sent as-is.\n\n```ts\nclient.hris.directory.list({\n // ...\n // @ts-expect-error baz is not yet public\n baz: 'undocumented option',\n});\n```\n\nFor requests with the `GET` verb, any extra params will be in the query, all other requests will send the\nextra param in the body.\n\nIf you want to explicitly send an extra argument, you can do so with the `query`, `body`, and `headers` request\noptions.\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you may access the response object with `// @ts-expect-error` on\nthe response object, or cast the response object to the requisite type. Like the request params, we do not\nvalidate or strip extra properties from the response from the API.\n\n### Customizing the fetch client\n\nBy default, this library expects a global `fetch` function is defined.\n\nIf you want to use a different `fetch` function, you can either polyfill the global:\n\n```ts\nimport fetch from 'my-fetch';\n\nglobalThis.fetch = fetch;\n```\n\nOr pass it to the client:\n\n```ts\nimport Finch from '@tryfinch/finch-api';\nimport fetch from 'my-fetch';\n\nconst client = new Finch({ fetch });\n```\n\n### Fetch options\n\nIf you want to set custom `fetch` options without overriding the `fetch` function, you can provide a `fetchOptions` object when instantiating the client or making a request. (Request-specific options override client options.)\n\n```ts\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n fetchOptions: {\n // `RequestInit` options\n },\n});\n```\n\n#### Configuring proxies\n\nTo modify proxy behavior, you can provide custom `fetchOptions` that add runtime-specific proxy\noptions to requests:\n\n **Node** [[docs](https://github.com/nodejs/undici/blob/main/docs/docs/api/ProxyAgent.md#example---proxyagent-with-fetch)]\n\n```ts\nimport Finch from '@tryfinch/finch-api';\nimport * as undici from 'undici';\n\nconst proxyAgent = new undici.ProxyAgent('http://localhost:8888');\nconst client = new Finch({\n fetchOptions: {\n dispatcher: proxyAgent,\n },\n});\n```\n\n **Bun** [[docs](https://bun.sh/guides/http/proxy)]\n\n```ts\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n fetchOptions: {\n proxy: 'http://localhost:8888',\n },\n});\n```\n\n **Deno** [[docs](https://docs.deno.com/api/deno/~/Deno.createHttpClient)]\n\n```ts\nimport Finch from 'npm:@tryfinch/finch-api';\n\nconst httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });\nconst client = new Finch({\n fetchOptions: {\n client: httpClient,\n },\n});\n```\n\n## Frequently Asked Questions\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes that only affect static types, without breaking runtime behavior.\n2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n3. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Finch-API/finch-api-node/issues) with questions, bugs, or suggestions.\n\n## Requirements\n\nTypeScript >= 4.9 is supported.\n\nThe following runtimes are supported:\n\n- Node.js 20 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.\n- Deno v1.28.0 or higher.\n- Bun 1.0 or later.\n- Cloudflare Workers.\n- Vercel Edge Runtime.\n- Jest 28 or greater with the `\"node\"` environment (`\"jsdom\"` is not supported at this time).\n- Nitro v2.6 or greater.\n- Web browsers: disabled by default to avoid exposing your secret API credentials. Enable browser support by explicitly setting `dangerouslyAllowBrowser` to true'.\n
\n More explanation\n\n ### Why is this dangerous?\n Enabling the `dangerouslyAllowBrowser` option can be dangerous because it exposes your secret API credentials in the client-side code. Web browsers are inherently less secure than server environments,\n any user with access to the browser can potentially inspect, extract, and misuse these credentials. This could lead to unauthorized access using your credentials and potentially compromise sensitive data or functionality.\n ### When might this not be dangerous?\n In certain scenarios where enabling browser support might not pose significant risks:\n - Internal Tools: If the application is used solely within a controlled internal environment where the users are trusted, the risk of credential exposure can be mitigated.\n - Public APIs with Limited Scope: If your API has very limited scope and the exposed credentials do not grant access to sensitive data or critical operations, the potential impact of exposure is reduced.\n - Development or debugging purpose: Enabling this feature temporarily might be acceptable, provided the credentials are short-lived, aren't also used in production environments, or are frequently rotated.\n\n
\n\nNote that React Native is not supported at this time.\n\nIf you are interested in other runtime environments, please open or upvote an issue on GitHub.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n" + } ]; const INDEX_OPTIONS = { @@ -2587,18 +2236,21 @@ export class LocalDocsSearch { maxResults?: number; maxLength?: number; }): SearchResult { - const { query, language = 'typescript', detail = 'default', maxResults = 5, maxLength = 100_000 } = props; + const { + query, + language = 'typescript', + detail = 'default', + maxResults = 5, + maxLength = 100_000, + } = props; const useMarkdown = detail === 'verbose' || detail === 'high'; // Search both indices and merge results by score. // Filter prose hits so language-tagged content (READMEs and docs with // frontmatter) only matches the requested language. - const methodHits = this.methodIndex - .search(query) - .map((hit) => ({ ...hit, _kind: 'http_method' as const })); - const proseHits = this.proseIndex - .search(query) + const methodHits = this.methodIndex.search(query).map((hit) => ({ ...hit, _kind: 'http_method' as const })); + const proseHits = this.proseIndex.search(query) .filter((hit) => { const source = ((hit as Record)['_original'] as ProseChunk | undefined)?.source; if (!source) return true; diff --git a/packages/mcp-server/src/methods.ts b/packages/mcp-server/src/methods.ts index 82258b2f..344b7e9f 100644 --- a/packages/mcp-server/src/methods.ts +++ b/packages/mcp-server/src/methods.ts @@ -7,290 +7,239 @@ export type SdkMethod = { fullyQualifiedName: string; httpMethod?: 'get' | 'post' | 'put' | 'patch' | 'delete' | 'query'; httpPath?: string; -}; +} -export const sdkMethods: SdkMethod[] = [ - { - clientCallName: 'client.accessTokens.create', - fullyQualifiedName: 'accessTokens.create', - httpMethod: 'post', - httpPath: '/auth/token', - }, - { - clientCallName: 'client.hris.company.retrieve', - fullyQualifiedName: 'hris.company.retrieve', - httpMethod: 'get', - httpPath: '/employer/company', - }, - { - clientCallName: 'client.hris.company.payStatementItem.list', - fullyQualifiedName: 'hris.company.payStatementItem.list', - httpMethod: 'get', - httpPath: '/employer/pay-statement-item', - }, - { - clientCallName: 'client.hris.company.payStatementItem.rules.create', - fullyQualifiedName: 'hris.company.payStatementItem.rules.create', - httpMethod: 'post', - httpPath: '/employer/pay-statement-item/rule', - }, - { - clientCallName: 'client.hris.company.payStatementItem.rules.update', - fullyQualifiedName: 'hris.company.payStatementItem.rules.update', - httpMethod: 'put', - httpPath: '/employer/pay-statement-item/rule/{rule_id}', - }, - { - clientCallName: 'client.hris.company.payStatementItem.rules.list', - fullyQualifiedName: 'hris.company.payStatementItem.rules.list', - httpMethod: 'get', - httpPath: '/employer/pay-statement-item/rule', - }, - { - clientCallName: 'client.hris.company.payStatementItem.rules.delete', - fullyQualifiedName: 'hris.company.payStatementItem.rules.delete', - httpMethod: 'delete', - httpPath: '/employer/pay-statement-item/rule/{rule_id}', - }, - { - clientCallName: 'client.hris.directory.list', - fullyQualifiedName: 'hris.directory.list', - httpMethod: 'get', - httpPath: '/employer/directory', - }, - { - clientCallName: 'client.hris.directory.listIndividuals', - fullyQualifiedName: 'hris.directory.listIndividuals', - }, - { - clientCallName: 'client.hris.individuals.retrieveMany', - fullyQualifiedName: 'hris.individuals.retrieveMany', - httpMethod: 'post', - httpPath: '/employer/individual', - }, - { - clientCallName: 'client.hris.employments.retrieveMany', - fullyQualifiedName: 'hris.employments.retrieveMany', - httpMethod: 'post', - httpPath: '/employer/employment', - }, - { - clientCallName: 'client.hris.payments.list', - fullyQualifiedName: 'hris.payments.list', - httpMethod: 'get', - httpPath: '/employer/payment', - }, - { - clientCallName: 'client.hris.payStatements.retrieveMany', - fullyQualifiedName: 'hris.payStatements.retrieveMany', - httpMethod: 'post', - httpPath: '/employer/pay-statement', - }, - { - clientCallName: 'client.hris.documents.list', - fullyQualifiedName: 'hris.documents.list', - httpMethod: 'get', - httpPath: '/employer/documents', - }, - { - clientCallName: 'client.hris.documents.retreive', - fullyQualifiedName: 'hris.documents.retreive', - httpMethod: 'get', - httpPath: '/employer/documents/{document_id}', - }, - { - clientCallName: 'client.hris.benefits.create', - fullyQualifiedName: 'hris.benefits.create', - httpMethod: 'post', - httpPath: '/employer/benefits', - }, - { - clientCallName: 'client.hris.benefits.retrieve', - fullyQualifiedName: 'hris.benefits.retrieve', - httpMethod: 'get', - httpPath: '/employer/benefits/{benefit_id}', - }, - { - clientCallName: 'client.hris.benefits.update', - fullyQualifiedName: 'hris.benefits.update', - httpMethod: 'post', - httpPath: '/employer/benefits/{benefit_id}', - }, - { - clientCallName: 'client.hris.benefits.list', - fullyQualifiedName: 'hris.benefits.list', - httpMethod: 'get', - httpPath: '/employer/benefits', - }, - { - clientCallName: 'client.hris.benefits.listSupportedBenefits', - fullyQualifiedName: 'hris.benefits.listSupportedBenefits', - httpMethod: 'get', - httpPath: '/employer/benefits/meta', - }, - { - clientCallName: 'client.hris.benefits.individuals.enrollMany', - fullyQualifiedName: 'hris.benefits.individuals.enrollMany', - httpMethod: 'post', - httpPath: '/employer/benefits/{benefit_id}/individuals', - }, - { - clientCallName: 'client.hris.benefits.individuals.enrolledIDs', - fullyQualifiedName: 'hris.benefits.individuals.enrolledIDs', - httpMethod: 'get', - httpPath: '/employer/benefits/{benefit_id}/enrolled', - }, - { - clientCallName: 'client.hris.benefits.individuals.retrieveManyBenefits', - fullyQualifiedName: 'hris.benefits.individuals.retrieveManyBenefits', - httpMethod: 'get', - httpPath: '/employer/benefits/{benefit_id}/individuals', - }, - { - clientCallName: 'client.hris.benefits.individuals.unenrollMany', - fullyQualifiedName: 'hris.benefits.individuals.unenrollMany', - httpMethod: 'delete', - httpPath: '/employer/benefits/{benefit_id}/individuals', - }, - { - clientCallName: 'client.providers.list', - fullyQualifiedName: 'providers.list', - httpMethod: 'get', - httpPath: '/providers', - }, - { - clientCallName: 'client.account.disconnect', - fullyQualifiedName: 'account.disconnect', - httpMethod: 'post', - httpPath: '/disconnect', - }, - { - clientCallName: 'client.account.introspect', - fullyQualifiedName: 'account.introspect', - httpMethod: 'get', - httpPath: '/introspect', - }, - { - clientCallName: 'client.requestForwarding.forward', - fullyQualifiedName: 'requestForwarding.forward', - httpMethod: 'post', - httpPath: '/forward', - }, - { - clientCallName: 'client.jobs.automated.create', - fullyQualifiedName: 'jobs.automated.create', - httpMethod: 'post', - httpPath: '/jobs/automated', - }, - { - clientCallName: 'client.jobs.automated.retrieve', - fullyQualifiedName: 'jobs.automated.retrieve', - httpMethod: 'get', - httpPath: '/jobs/automated/{job_id}', - }, - { - clientCallName: 'client.jobs.automated.list', - fullyQualifiedName: 'jobs.automated.list', - httpMethod: 'get', - httpPath: '/jobs/automated', - }, - { - clientCallName: 'client.jobs.manual.retrieve', - fullyQualifiedName: 'jobs.manual.retrieve', - httpMethod: 'get', - httpPath: '/jobs/manual/{job_id}', - }, - { - clientCallName: 'client.sandbox.connections.create', - fullyQualifiedName: 'sandbox.connections.create', - httpMethod: 'post', - httpPath: '/sandbox/connections', - }, - { - clientCallName: 'client.sandbox.connections.accounts.create', - fullyQualifiedName: 'sandbox.connections.accounts.create', - httpMethod: 'post', - httpPath: '/sandbox/connections/accounts', - }, - { - clientCallName: 'client.sandbox.connections.accounts.update', - fullyQualifiedName: 'sandbox.connections.accounts.update', - httpMethod: 'put', - httpPath: '/sandbox/connections/accounts', - }, - { - clientCallName: 'client.sandbox.company.update', - fullyQualifiedName: 'sandbox.company.update', - httpMethod: 'put', - httpPath: '/sandbox/company', - }, - { - clientCallName: 'client.sandbox.directory.create', - fullyQualifiedName: 'sandbox.directory.create', - httpMethod: 'post', - httpPath: '/sandbox/directory', - }, - { - clientCallName: 'client.sandbox.individual.update', - fullyQualifiedName: 'sandbox.individual.update', - httpMethod: 'put', - httpPath: '/sandbox/individual/{individual_id}', - }, - { - clientCallName: 'client.sandbox.employment.update', - fullyQualifiedName: 'sandbox.employment.update', - httpMethod: 'put', - httpPath: '/sandbox/employment/{individual_id}', - }, - { - clientCallName: 'client.sandbox.payment.create', - fullyQualifiedName: 'sandbox.payment.create', - httpMethod: 'post', - httpPath: '/sandbox/payment', - }, - { - clientCallName: 'client.sandbox.jobs.create', - fullyQualifiedName: 'sandbox.jobs.create', - httpMethod: 'post', - httpPath: '/sandbox/jobs', - }, - { - clientCallName: 'client.sandbox.jobs.configuration.retrieve', - fullyQualifiedName: 'sandbox.jobs.configuration.retrieve', - httpMethod: 'get', - httpPath: '/sandbox/jobs/configuration', - }, - { - clientCallName: 'client.sandbox.jobs.configuration.update', - fullyQualifiedName: 'sandbox.jobs.configuration.update', - httpMethod: 'put', - httpPath: '/sandbox/jobs/configuration', - }, - { - clientCallName: 'client.payroll.payGroups.retrieve', - fullyQualifiedName: 'payroll.payGroups.retrieve', - httpMethod: 'get', - httpPath: '/employer/pay-groups/{pay_group_id}', - }, - { - clientCallName: 'client.payroll.payGroups.list', - fullyQualifiedName: 'payroll.payGroups.list', - httpMethod: 'get', - httpPath: '/employer/pay-groups', - }, - { - clientCallName: 'client.connect.sessions.new', - fullyQualifiedName: 'connect.sessions.new', - httpMethod: 'post', - httpPath: '/connect/sessions', - }, - { - clientCallName: 'client.connect.sessions.reauthenticate', - fullyQualifiedName: 'connect.sessions.reauthenticate', - httpMethod: 'post', - httpPath: '/connect/sessions/reauthenticate', - }, -]; +export const sdkMethods: SdkMethod[] = [{ + clientCallName: 'client.accessTokens.create', + fullyQualifiedName: 'accessTokens.create', + httpMethod: 'post', + httpPath: '/auth/token', +},{ + clientCallName: 'client.hris.company.retrieve', + fullyQualifiedName: 'hris.company.retrieve', + httpMethod: 'get', + httpPath: '/employer/company', +},{ + clientCallName: 'client.hris.company.payStatementItem.list', + fullyQualifiedName: 'hris.company.payStatementItem.list', + httpMethod: 'get', + httpPath: '/employer/pay-statement-item', +},{ + clientCallName: 'client.hris.company.payStatementItem.rules.create', + fullyQualifiedName: 'hris.company.payStatementItem.rules.create', + httpMethod: 'post', + httpPath: '/employer/pay-statement-item/rule', +},{ + clientCallName: 'client.hris.company.payStatementItem.rules.update', + fullyQualifiedName: 'hris.company.payStatementItem.rules.update', + httpMethod: 'put', + httpPath: '/employer/pay-statement-item/rule/{rule_id}', +},{ + clientCallName: 'client.hris.company.payStatementItem.rules.list', + fullyQualifiedName: 'hris.company.payStatementItem.rules.list', + httpMethod: 'get', + httpPath: '/employer/pay-statement-item/rule', +},{ + clientCallName: 'client.hris.company.payStatementItem.rules.delete', + fullyQualifiedName: 'hris.company.payStatementItem.rules.delete', + httpMethod: 'delete', + httpPath: '/employer/pay-statement-item/rule/{rule_id}', +},{ + clientCallName: 'client.hris.directory.list', + fullyQualifiedName: 'hris.directory.list', + httpMethod: 'get', + httpPath: '/employer/directory', +},{ clientCallName: 'client.hris.directory.listIndividuals', fullyQualifiedName: 'hris.directory.listIndividuals' },{ + clientCallName: 'client.hris.individuals.retrieveMany', + fullyQualifiedName: 'hris.individuals.retrieveMany', + httpMethod: 'post', + httpPath: '/employer/individual', +},{ + clientCallName: 'client.hris.employments.retrieveMany', + fullyQualifiedName: 'hris.employments.retrieveMany', + httpMethod: 'post', + httpPath: '/employer/employment', +},{ + clientCallName: 'client.hris.payments.list', + fullyQualifiedName: 'hris.payments.list', + httpMethod: 'get', + httpPath: '/employer/payment', +},{ + clientCallName: 'client.hris.payStatements.retrieveMany', + fullyQualifiedName: 'hris.payStatements.retrieveMany', + httpMethod: 'post', + httpPath: '/employer/pay-statement', +},{ + clientCallName: 'client.hris.documents.list', + fullyQualifiedName: 'hris.documents.list', + httpMethod: 'get', + httpPath: '/employer/documents', +},{ + clientCallName: 'client.hris.documents.retreive', + fullyQualifiedName: 'hris.documents.retreive', + httpMethod: 'get', + httpPath: '/employer/documents/{document_id}', +},{ + clientCallName: 'client.hris.benefits.create', + fullyQualifiedName: 'hris.benefits.create', + httpMethod: 'post', + httpPath: '/employer/benefits', +},{ + clientCallName: 'client.hris.benefits.retrieve', + fullyQualifiedName: 'hris.benefits.retrieve', + httpMethod: 'get', + httpPath: '/employer/benefits/{benefit_id}', +},{ + clientCallName: 'client.hris.benefits.update', + fullyQualifiedName: 'hris.benefits.update', + httpMethod: 'post', + httpPath: '/employer/benefits/{benefit_id}', +},{ + clientCallName: 'client.hris.benefits.list', + fullyQualifiedName: 'hris.benefits.list', + httpMethod: 'get', + httpPath: '/employer/benefits', +},{ + clientCallName: 'client.hris.benefits.listSupportedBenefits', + fullyQualifiedName: 'hris.benefits.listSupportedBenefits', + httpMethod: 'get', + httpPath: '/employer/benefits/meta', +},{ + clientCallName: 'client.hris.benefits.individuals.enrollMany', + fullyQualifiedName: 'hris.benefits.individuals.enrollMany', + httpMethod: 'post', + httpPath: '/employer/benefits/{benefit_id}/individuals', +},{ + clientCallName: 'client.hris.benefits.individuals.enrolledIDs', + fullyQualifiedName: 'hris.benefits.individuals.enrolledIDs', + httpMethod: 'get', + httpPath: '/employer/benefits/{benefit_id}/enrolled', +},{ + clientCallName: 'client.hris.benefits.individuals.retrieveManyBenefits', + fullyQualifiedName: 'hris.benefits.individuals.retrieveManyBenefits', + httpMethod: 'get', + httpPath: '/employer/benefits/{benefit_id}/individuals', +},{ + clientCallName: 'client.hris.benefits.individuals.unenrollMany', + fullyQualifiedName: 'hris.benefits.individuals.unenrollMany', + httpMethod: 'delete', + httpPath: '/employer/benefits/{benefit_id}/individuals', +},{ + clientCallName: 'client.providers.list', + fullyQualifiedName: 'providers.list', + httpMethod: 'get', + httpPath: '/providers', +},{ + clientCallName: 'client.account.disconnect', + fullyQualifiedName: 'account.disconnect', + httpMethod: 'post', + httpPath: '/disconnect', +},{ + clientCallName: 'client.account.introspect', + fullyQualifiedName: 'account.introspect', + httpMethod: 'get', + httpPath: '/introspect', +},{ + clientCallName: 'client.requestForwarding.forward', + fullyQualifiedName: 'requestForwarding.forward', + httpMethod: 'post', + httpPath: '/forward', +},{ + clientCallName: 'client.jobs.automated.create', + fullyQualifiedName: 'jobs.automated.create', + httpMethod: 'post', + httpPath: '/jobs/automated', +},{ + clientCallName: 'client.jobs.automated.retrieve', + fullyQualifiedName: 'jobs.automated.retrieve', + httpMethod: 'get', + httpPath: '/jobs/automated/{job_id}', +},{ + clientCallName: 'client.jobs.automated.list', + fullyQualifiedName: 'jobs.automated.list', + httpMethod: 'get', + httpPath: '/jobs/automated', +},{ + clientCallName: 'client.jobs.manual.retrieve', + fullyQualifiedName: 'jobs.manual.retrieve', + httpMethod: 'get', + httpPath: '/jobs/manual/{job_id}', +},{ + clientCallName: 'client.sandbox.connections.create', + fullyQualifiedName: 'sandbox.connections.create', + httpMethod: 'post', + httpPath: '/sandbox/connections', +},{ + clientCallName: 'client.sandbox.connections.accounts.create', + fullyQualifiedName: 'sandbox.connections.accounts.create', + httpMethod: 'post', + httpPath: '/sandbox/connections/accounts', +},{ + clientCallName: 'client.sandbox.connections.accounts.update', + fullyQualifiedName: 'sandbox.connections.accounts.update', + httpMethod: 'put', + httpPath: '/sandbox/connections/accounts', +},{ + clientCallName: 'client.sandbox.company.update', + fullyQualifiedName: 'sandbox.company.update', + httpMethod: 'put', + httpPath: '/sandbox/company', +},{ + clientCallName: 'client.sandbox.directory.create', + fullyQualifiedName: 'sandbox.directory.create', + httpMethod: 'post', + httpPath: '/sandbox/directory', +},{ + clientCallName: 'client.sandbox.individual.update', + fullyQualifiedName: 'sandbox.individual.update', + httpMethod: 'put', + httpPath: '/sandbox/individual/{individual_id}', +},{ + clientCallName: 'client.sandbox.employment.update', + fullyQualifiedName: 'sandbox.employment.update', + httpMethod: 'put', + httpPath: '/sandbox/employment/{individual_id}', +},{ + clientCallName: 'client.sandbox.payment.create', + fullyQualifiedName: 'sandbox.payment.create', + httpMethod: 'post', + httpPath: '/sandbox/payment', +},{ + clientCallName: 'client.sandbox.jobs.create', + fullyQualifiedName: 'sandbox.jobs.create', + httpMethod: 'post', + httpPath: '/sandbox/jobs', +},{ + clientCallName: 'client.sandbox.jobs.configuration.retrieve', + fullyQualifiedName: 'sandbox.jobs.configuration.retrieve', + httpMethod: 'get', + httpPath: '/sandbox/jobs/configuration', +},{ + clientCallName: 'client.sandbox.jobs.configuration.update', + fullyQualifiedName: 'sandbox.jobs.configuration.update', + httpMethod: 'put', + httpPath: '/sandbox/jobs/configuration', +},{ + clientCallName: 'client.payroll.payGroups.retrieve', + fullyQualifiedName: 'payroll.payGroups.retrieve', + httpMethod: 'get', + httpPath: '/employer/pay-groups/{pay_group_id}', +},{ + clientCallName: 'client.payroll.payGroups.list', + fullyQualifiedName: 'payroll.payGroups.list', + httpMethod: 'get', + httpPath: '/employer/pay-groups', +},{ + clientCallName: 'client.connect.sessions.new', + fullyQualifiedName: 'connect.sessions.new', + httpMethod: 'post', + httpPath: '/connect/sessions', +},{ + clientCallName: 'client.connect.sessions.reauthenticate', + fullyQualifiedName: 'connect.sessions.reauthenticate', + httpMethod: 'post', + httpPath: '/connect/sessions/reauthenticate', +}]; function allowedMethodsForCodeTool(options: McpOptions | undefined): SdkMethod[] | undefined { if (!options) { @@ -305,9 +254,9 @@ function allowedMethodsForCodeTool(options: McpOptions | undefined): SdkMethod[] if (options.codeAllowHttpGets) { // Add all methods that map to an HTTP GET - sdkMethods - .filter((method) => method.httpMethod === 'get') - .forEach((method) => allowedMethodsSet.add(method)); + sdkMethods.filter((method) => method.httpMethod === 'get').forEach( + (method) => allowedMethodsSet.add(method) + ); } if (options.codeAllowedMethods) { @@ -316,15 +265,13 @@ function allowedMethodsForCodeTool(options: McpOptions | undefined): SdkMethod[] try { return new RegExp(pattern); } catch (e) { - throw new Error( - `Invalid regex pattern for allowed method: "${pattern}": ${e instanceof Error ? e.message : e}`, - ); + throw new Error(`Invalid regex pattern for allowed method: "${pattern}": ${e instanceof Error ? e.message : e}`); } }); - sdkMethods - .filter((method) => allowedRegexps.some((regexp) => regexp.test(method.fullyQualifiedName))) - .forEach((method) => allowedMethodsSet.add(method)); + sdkMethods.filter((method) => + allowedRegexps.some((regexp) => regexp.test(method.fullyQualifiedName)) + ).forEach((method) => allowedMethodsSet.add(method)); } allowedMethods = Array.from(allowedMethodsSet); @@ -339,14 +286,12 @@ function allowedMethodsForCodeTool(options: McpOptions | undefined): SdkMethod[] try { return new RegExp(pattern); } catch (e) { - throw new Error( - `Invalid regex pattern for blocked method: "${pattern}": ${e instanceof Error ? e.message : e}`, - ); + throw new Error(`Invalid regex pattern for blocked method: "${pattern}": ${e instanceof Error ? e.message : e}`); } }); - allowedMethods = allowedMethods.filter( - (method) => !blockedRegexps.some((regexp) => regexp.test(method.fullyQualifiedName)), + allowedMethods = allowedMethods.filter((method) => + !blockedRegexps.some((regexp) => regexp.test(method.fullyQualifiedName)) ); } diff --git a/packages/mcp-server/src/options.ts b/packages/mcp-server/src/options.ts index f1518764..873ab8e8 100644 --- a/packages/mcp-server/src/options.ts +++ b/packages/mcp-server/src/options.ts @@ -31,46 +31,31 @@ export type McpCodeExecutionMode = 'stainless-sandbox' | 'local'; export function parseCLIOptions(): CLIOptions { const opts = yargs(hideBin(process.argv)) - .option('code-allow-http-gets', { - type: 'boolean', - description: - 'Allow all code tool methods that map to HTTP GET operations. If all code-allow-* flags are unset, then everything is allowed.', - }) + .option('code-allow-http-gets', { type: 'boolean', description: 'Allow all code tool methods that map to HTTP GET operations. If all code-allow-* flags are unset, then everything is allowed.' }) .option('code-allowed-methods', { type: 'string', array: true, - description: - 'Methods to explicitly allow for code tool. Evaluated as regular expressions against method fully qualified names. If all code-allow-* flags are unset, then everything is allowed.', + description: 'Methods to explicitly allow for code tool. Evaluated as regular expressions against method fully qualified names. If all code-allow-* flags are unset, then everything is allowed.', }) .option('code-blocked-methods', { type: 'string', array: true, - description: - 'Methods to explicitly block for code tool. Evaluated as regular expressions against method fully qualified names. If all code-allow-* flags are unset, then everything is allowed.', + description: 'Methods to explicitly block for code tool. Evaluated as regular expressions against method fully qualified names. If all code-allow-* flags are unset, then everything is allowed.', }) .option('code-execution-mode', { type: 'string', choices: ['stainless-sandbox', 'local'], default: 'stainless-sandbox', - description: - "Where to run code execution in code tool; 'stainless-sandbox' will execute code in Stainless-hosted sandboxes whereas 'local' will execute code locally on the MCP server machine.", - }) - .option('custom-instructions-path', { - type: 'string', - description: 'Path to custom instructions for the MCP server', + description: 'Where to run code execution in code tool; \'stainless-sandbox\' will execute code in Stainless-hosted sandboxes whereas \'local\' will execute code locally on the MCP server machine.', }) + .option('custom-instructions-path', { type: 'string', description: 'Path to custom instructions for the MCP server' }) .option('debug', { type: 'boolean', description: 'Enable debug logging' }) - .option('docs-dir', { - type: 'string', - description: - 'Path to a directory of local documentation files (markdown/JSON) to include in local docs search.', - }) + .option('docs-dir', { type: 'string', description: 'Path to a directory of local documentation files (markdown/JSON) to include in local docs search.' }) .option('docs-search-mode', { type: 'string', choices: ['stainless-api', 'local'], default: 'stainless-api', - description: - "Where to search documentation; 'stainless-api' uses the Stainless-hosted search API whereas 'local' uses an in-memory search index built from embedded SDK method data and optional local docs files.", + description: 'Where to search documentation; \'stainless-api\' uses the Stainless-hosted search API whereas \'local\' uses an in-memory search index built from embedded SDK method data and optional local docs files.', }) .option('log-format', { type: 'string', @@ -92,8 +77,7 @@ export function parseCLIOptions(): CLIOptions { .option('stainless-api-key', { type: 'string', default: readEnv('STAINLESS_API_KEY'), - description: - 'API key for Stainless. Used to authenticate requests to Stainless-hosted tools endpoints.', + description: 'API key for Stainless. Used to authenticate requests to Stainless-hosted tools endpoints.', }) .option('tools', { type: 'string', @@ -114,18 +98,15 @@ export function parseCLIOptions(): CLIOptions { const argv = opts.parseSync(); const shouldIncludeToolType = (toolType: 'code' | 'docs') => - argv.noTools?.includes(toolType) ? false - : argv.tools?.includes(toolType) ? true - : undefined; + argv.noTools?.includes(toolType) ? false + : argv.tools?.includes(toolType) ? true + : undefined; const includeCodeTool = shouldIncludeToolType('code'); const includeDocsTools = shouldIncludeToolType('docs'); const transport = argv.transport as 'stdio' | 'http'; - const logFormat = - argv.logFormat ? (argv.logFormat as 'json' | 'pretty') - : process.stderr.isTTY ? 'pretty' - : 'json'; + const logFormat = argv.logFormat ? argv.logFormat as 'json' | 'pretty' : (process.stderr.isTTY ? 'pretty' : 'json'); return { ...(includeCodeTool !== undefined && { includeCodeTool }), @@ -166,8 +147,8 @@ export function parseQueryOptions(defaultOptions: McpOptions, query: unknown): M const queryOptions = QueryOptions.parse(queryObject); let codeTool: boolean | undefined = - queryOptions.no_tools && queryOptions.no_tools?.includes('code') ? false - : queryOptions.tools?.includes('code') ? true + queryOptions.no_tools && queryOptions.no_tools?.includes("code") ? false + : queryOptions.tools?.includes("code") ? true : defaultOptions.includeCodeTool; let docsTools: boolean | undefined = diff --git a/packages/mcp-server/src/server.ts b/packages/mcp-server/src/server.ts index 6a26f6c7..71e4b1ff 100644 --- a/packages/mcp-server/src/server.ts +++ b/packages/mcp-server/src/server.ts @@ -3,9 +3,7 @@ import { Server } from '@modelcontextprotocol/sdk/server/index.js'; import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js'; import { - CallToolRequestSchema, - ListToolsRequestSchema, - SetLevelRequestSchema, + CallToolRequestSchema,ListToolsRequestSchema,SetLevelRequestSchema } from '@modelcontextprotocol/sdk/types.js'; import { ClientOptions } from '@tryfinch/finch-api'; import Finch from '@tryfinch/finch-api'; @@ -16,26 +14,25 @@ import { LocalDocsSearch } from './local-docs-search'; import { getInstructions } from './instructions'; import { McpOptions } from './options'; import { blockedMethodsForCodeTool } from './methods'; -import { HandlerFunction, McpRequestContext, ToolCallResult, McpTool } from './types'; +import { HandlerFunction, McpRequestContext, ToolCallResult, McpTool } from "./types" import { readEnv } from './util'; export const newMcpServer = async ({ stainlessApiKey, customInstructionsPath, }: { - stainlessApiKey?: string | undefined; - customInstructionsPath?: string | undefined; -}) => - new McpServer( - { - name: 'tryfinch_finch_api_api', - version: '9.6.0', - }, - { - instructions: await getInstructions({ stainlessApiKey, customInstructionsPath }), - capabilities: { tools: {}, logging: {} }, - }, - ); + stainlessApiKey?: string | undefined, + customInstructionsPath?: string | undefined, +}) => new McpServer( + { + name: 'tryfinch_finch_api_api', + version: '9.6.0', + }, + { + instructions: await getInstructions({stainlessApiKey, customInstructionsPath}), + capabilities: { tools: {}, logging: {} }, + } +); /** * Initializes the provided MCP Server with the given tools and handlers. @@ -57,15 +54,15 @@ export async function initMcpServer(params: { (message: string, ...rest: unknown[]) => { void server.sendLoggingMessage({ level, - data: { message, rest }, + data: {message, rest}, }); - }; + } const logger = { - debug: logAtLevel('debug'), - info: logAtLevel('info'), - warn: logAtLevel('warning'), - error: logAtLevel('error'), - }; + debug: logAtLevel("debug"), + info: logAtLevel("info"), + warn: logAtLevel("warning"), + error: logAtLevel("error"), + } if (params.mcpOptions?.docsSearchMode === 'local') { const docsDir = params.mcpOptions?.docsDir; @@ -82,14 +79,14 @@ export async function initMcpServer(params: { if (!_client) { try { _client = new Finch({ - ...{ accessToken: readEnv('FINCH_ACCESS_TOKEN') }, - logger, - ...params.clientOptions, - defaultHeaders: { - ...params.clientOptions?.defaultHeaders, - 'X-Stainless-MCP': 'true', - }, - }); + ...({ accessToken: readEnv('FINCH_ACCESS_TOKEN') }), + logger, + ...params.clientOptions, + defaultHeaders: { + ...params.clientOptions?.defaultHeaders, + 'X-Stainless-MCP': 'true', + }, +}); if (_logLevel) { _client = _client.withOptions({ logLevel: _logLevel }); } @@ -122,12 +119,10 @@ export async function initMcpServer(params: { client = getClient(); } catch (error) { return { - content: [ - { - type: 'text' as const, - text: `Failed to initialize client: ${error instanceof Error ? error.message : String(error)}`, - }, - ], + content: [{ + type: 'text' as const, + text: `Failed to initialize client: ${error instanceof Error ? error.message : String(error)}`, + }], isError: true, }; } @@ -177,16 +172,17 @@ export async function initMcpServer(params: { /** * Selects the tools to include in the MCP Server based on the provided options. */ -export function selectTools(options?: McpOptions): McpTool[] { +export function selectTools( + options?: McpOptions +): McpTool[] { + const includedTools = []; if (options?.includeCodeTool ?? true) { - includedTools.push( - codeTool({ - blockedMethods: blockedMethodsForCodeTool(options), - codeExecutionMode: options?.codeExecutionMode ?? 'stainless-sandbox', - }), - ); + includedTools.push(codeTool({ + blockedMethods: blockedMethodsForCodeTool(options), + codeExecutionMode: options?.codeExecutionMode ?? 'stainless-sandbox', + })); } if (options?.includeDocsTools ?? true) { includedTools.push(docsSearchTool); @@ -197,14 +193,13 @@ export function selectTools(options?: McpOptions): McpTool[] { /** * Runs the provided handler with the given client and arguments. */ -export async function executeHandler({ - handler, - reqContext, - args, -}: { - handler: HandlerFunction; - reqContext: McpRequestContext; - args: Record | undefined; -}): Promise { - return await handler({ reqContext, args: args || {} }); +export async function executeHandler( + {handler, reqContext, args}: + { + handler: HandlerFunction; + reqContext: McpRequestContext; + args: Record | undefined; + } +): Promise { + return await handler({reqContext, args: args || {}}); } diff --git a/packages/mcp-server/src/types.ts b/packages/mcp-server/src/types.ts index 667354fc..f71be718 100644 --- a/packages/mcp-server/src/types.ts +++ b/packages/mcp-server/src/types.ts @@ -4,43 +4,41 @@ import Finch from '@tryfinch/finch-api'; import { Tool } from '@modelcontextprotocol/sdk/types.js'; type TextContentBlock = { - type: 'text'; - text: string; -}; + type: "text", + text: string +} type ImageContentBlock = { - type: 'image'; - data: string; - mimeType: string; -}; + type: "image", + data: string, + mimeType: string +} type AudioContentBlock = { - type: 'audio'; - data: string; - mimeType: string; -}; + type: "audio", + data: string, + mimeType: string +} type ResourceContentBlock = { - type: 'resource'; - resource: - | { - uri: string; - mimeType: string; - text: string; - } - | { - uri: string; - mimeType: string; - blob: string; - }; -}; + type: "resource", + resource: { + uri: string, + mimeType: string, + text: string + } | { + uri: string, + mimeType: string, + blob: string + } +} export type ContentBlock = TextContentBlock | ImageContentBlock | AudioContentBlock | ResourceContentBlock; export type ToolCallResult = { content: ContentBlock[]; isError?: boolean; -}; +} export type McpRequestContext = { client: Finch; @@ -48,7 +46,7 @@ export type McpRequestContext = { upstreamClientEnvs?: Record | undefined; mcpSessionId?: string | undefined; mcpClientInfo?: { name: string; version: string } | undefined; -}; +} export type HandlerFunction = ({ reqContext, @@ -58,7 +56,9 @@ export type HandlerFunction = ({ args: Record | undefined; }) => Promise; -export function asTextContentResult(result: unknown): ToolCallResult { +export function asTextContentResult( + result: unknown, +): ToolCallResult { return { content: [ { @@ -69,18 +69,24 @@ export function asTextContentResult(result: unknown): ToolCallResult { }; } -export async function asBinaryContentResult(response: Response): Promise { +export async function asBinaryContentResult( + response: Response, +): Promise { const blob = await response.blob(); const mimeType = blob.type; const data = Buffer.from(await blob.arrayBuffer()).toString('base64'); if (mimeType.startsWith('image/')) { return { - content: [{ type: 'image', mimeType, data }], - }; + content: [ + {type: 'image', mimeType, data} + ] + } } else if (mimeType.startsWith('audio/')) { return { - content: [{ type: 'audio', mimeType, data }], - }; + content: [ + {type: 'audio', mimeType, data} + ] + } } else { return { content: [ @@ -98,7 +104,9 @@ export async function asBinaryContentResult(response: Response): Promise Running prettier --write" -# format things eslint didn't -PRETTIER_FILES="$(grep '\.\(js\|json\)$' "$FILE_LIST" || true)" +PRETTIER_FILES="$(grep '\.\([mc]?tsx?\|[mc]?jsx?\|json\)$' "$FILE_LIST" || true)" if ! [ -z "$PRETTIER_FILES" ]; then echo "$PRETTIER_FILES" | xargs ./node_modules/.bin/prettier \ - --write --cache --cache-strategy metadata --no-error-on-unmatched-pattern \ - '!**/dist' '!**/*.ts' '!**/*.mts' '!**/*.cts' '!**/*.js' '!**/*.mjs' '!**/*.cjs' + --write --cache --cache-strategy metadata --no-error-on-unmatched-pattern fi diff --git a/scripts/format b/scripts/format index 7a756401..b1b2c17a 100755 --- a/scripts/format +++ b/scripts/format @@ -8,5 +8,4 @@ echo "==> Running eslint --fix" ./node_modules/.bin/eslint --fix . echo "==> Running prettier --write" -# format things eslint didn't -./node_modules/.bin/prettier --write --cache --cache-strategy metadata . '!**/dist' '!**/*.ts' '!**/*.mts' '!**/*.cts' '!**/*.js' '!**/*.mjs' '!**/*.cjs' +./node_modules/.bin/prettier --write --cache --cache-strategy metadata . diff --git a/scripts/lint b/scripts/lint index 3ffb78a6..1f532548 100755 --- a/scripts/lint +++ b/scripts/lint @@ -4,6 +4,9 @@ set -e cd "$(dirname "$0")/.." +echo "==> Running prettier --check" +./node_modules/.bin/prettier --check . + echo "==> Running eslint" ./node_modules/.bin/eslint . diff --git a/src/api-promise.ts b/src/api-promise.ts index 8c775ee6..4e701286 100644 --- a/src/api-promise.ts +++ b/src/api-promise.ts @@ -1,2 +1,2 @@ /** @deprecated Import from ./core/api-promise instead */ -export * from './core/api-promise'; +export * from "./core/api-promise" \ No newline at end of file diff --git a/src/client.ts b/src/client.ts index 48d32320..441377c6 100644 --- a/src/client.ts +++ b/src/client.ts @@ -15,44 +15,15 @@ import { stringifyQuery } from './internal/utils/query'; import { VERSION } from './version'; import * as Errors from './core/error'; import * as Pagination from './core/pagination'; -import { - AbstractPage, - type IndividualsPageParams, - IndividualsPageResponse, - type PageParams, - PageResponse, - ResponsesPageResponse, - SinglePageResponse, -} from './core/pagination'; +import { AbstractPage, type IndividualsPageParams, IndividualsPageResponse, type PageParams, PageResponse, ResponsesPageResponse, SinglePageResponse } from './core/pagination'; import * as Uploads from './core/uploads'; import * as API from './resources/index'; import { APIPromise } from './core/api-promise'; import { AccessTokenCreateParams, AccessTokens, CreateAccessTokenResponse } from './resources/access-tokens'; import { Account, DisconnectResponse, Introspection } from './resources/account'; -import { - Provider, - ProviderListResponse, - ProviderListResponsesSinglePage, - Providers, -} from './resources/providers'; -import { - RequestForwarding, - RequestForwardingForwardParams, - RequestForwardingForwardResponse, -} from './resources/request-forwarding'; -import { - AccountUpdateEvent, - BaseWebhookEvent, - CompanyEvent, - DirectoryEvent, - EmploymentEvent, - IndividualEvent, - JobCompletionEvent, - PayStatementEvent, - PaymentEvent, - WebhookEvent, - Webhooks, -} from './resources/webhooks'; +import { Provider, ProviderListResponse, ProviderListResponsesSinglePage, Providers } from './resources/providers'; +import { RequestForwarding, RequestForwardingForwardParams, RequestForwardingForwardResponse } from './resources/request-forwarding'; +import { AccountUpdateEvent, BaseWebhookEvent, CompanyEvent, DirectoryEvent, EmploymentEvent, IndividualEvent, JobCompletionEvent, PayStatementEvent, PaymentEvent, WebhookEvent, Webhooks } from './resources/webhooks'; import { Connect } from './resources/connect/connect'; import { HRIS, Income, Location, Money } from './resources/hris/hris'; import { Jobs } from './resources/jobs/jobs'; @@ -64,13 +35,7 @@ import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers'; import { FinalRequestOptions, RequestOptions } from './internal/request-options'; import { toBase64 } from './internal/utils/base64'; import { readEnv } from './internal/utils/env'; -import { - type LogLevel, - type Logger, - formatRequestDetails, - loggerFor, - parseLogLevel, -} from './internal/utils/log'; +import { type LogLevel, type Logger, formatRequestDetails, loggerFor, parseLogLevel } from './internal/utils/log'; import { isEmptyObj } from './internal/utils/values'; export interface ClientOptions { @@ -167,7 +132,7 @@ export interface ClientOptions { } /** - * API Client for interfacing with the Finch API. + * API Client for interfacing with the Finch API. */ export class Finch { accessToken: string | null; @@ -211,6 +176,7 @@ export class Finch { webhookSecret = readEnv('FINCH_WEBHOOK_SECRET') ?? null, ...opts }: ClientOptions = {}) { + const options: ClientOptions = { accessToken, clientID, @@ -221,9 +187,7 @@ export class Finch { }; if (!options.dangerouslyAllowBrowser && isRunningInBrowser()) { - throw new Errors.FinchError( - 'This is disabled by default, as it risks exposing your secret API credentials to attackers.\nIf you understand the risks and have appropriate mitigations in place,\nyou can set the `dangerouslyAllowBrowser` option to `true`, e.g.,\n\nnew Finch({ dangerouslyAllowBrowser: true })', - ); + throw new Errors.FinchError('This is disabled by default, as it risks exposing your secret API credentials to attackers.\nIf you understand the risks and have appropriate mitigations in place,\nyou can set the `dangerouslyAllowBrowser` option to `true`, e.g.,\n\nnew Finch({ dangerouslyAllowBrowser: true })') } this.baseURL = options.baseURL!; @@ -232,10 +196,7 @@ export class Finch { const defaultLogLevel = 'warn'; // Set default logLevel early so that we can log a warning in parseLogLevel. this.logLevel = defaultLogLevel; - this.logLevel = - parseLogLevel(options.logLevel, 'ClientOptions.logLevel', this) ?? - parseLogLevel(readEnv('FINCH_LOG'), "process.env['FINCH_LOG']", this) ?? - defaultLogLevel; + this.logLevel = parseLogLevel(options.logLevel, 'ClientOptions.logLevel', this) ?? parseLogLevel(readEnv('FINCH_LOG'), 'process.env[\'FINCH_LOG\']', this) ?? defaultLogLevel; this.fetchOptions = options.fetchOptions; this.maxRetries = options.maxRetries ?? 2; this.fetch = options.fetch ?? Shims.getDefaultFetch(); @@ -266,7 +227,7 @@ export class Finch { clientID: this.clientID, clientSecret: this.clientSecret, webhookSecret: this.webhookSecret, - ...options, + ...options }); return client; } @@ -279,7 +240,7 @@ export class Finch { } protected defaultQuery(): Record | undefined { - return this._options.defaultQuery; + return this._options.defaultQuery } protected validateHeaders({ values, nulls }: NullableHeaders) { @@ -297,19 +258,11 @@ export class Finch { return; } - throw new Error( - 'Could not resolve authentication method. Expected either accessToken, clientID or clientSecret to be set. Or for one of the "Authorization" or "Authorization" headers to be explicitly omitted', - ); + throw new Error('Could not resolve authentication method. Expected either accessToken, clientID or clientSecret to be set. Or for one of the "Authorization" or "Authorization" headers to be explicitly omitted') } - protected async authHeaders( - opts: FinalRequestOptions, - schemes: { bearerAuth?: boolean; basicAuth?: boolean }, - ): Promise { - return buildHeaders([ - schemes.bearerAuth ? await this.bearerAuth(opts) : null, - schemes.basicAuth ? await this.basicAuth(opts) : null, - ]); + protected async authHeaders(opts: FinalRequestOptions, schemes: { bearerAuth?: boolean, basicAuth?: boolean }): Promise { + return buildHeaders([schemes.bearerAuth ? await this.bearerAuth(opts) : null, schemes.basicAuth ? await this.basicAuth(opts) : null]); } protected async bearerAuth(opts: FinalRequestOptions): Promise { @@ -328,9 +281,9 @@ export class Finch { return undefined; } - const credentials = `${this.clientID}:${this.clientSecret}`; - const Authorization = `Basic ${toBase64(credentials)}`; - return buildHeaders([{ Authorization }]); + const credentials = `${this.clientID}:${this.clientSecret}` + const Authorization = `Basic ${toBase64(credentials)}` + return buildHeaders([{ Authorization }]) } protected stringifyQuery(query: object | Record): string { @@ -354,11 +307,7 @@ export class Finch { return Errors.APIError.generate(status, error, message, headers); } - buildURL( - path: string, - query: Record | null | undefined, - defaultBaseURL?: string | undefined, - ): string { + buildURL(path: string, query: Record | null | undefined, defaultBaseURL?: string | undefined): string { const baseURL = (!this.#baseURLOverridden() && defaultBaseURL) || this.baseURL; const url = isAbsoluteURL(path) ? @@ -446,9 +395,7 @@ export class Finch { await this.prepareOptions(options); - const { req, url, timeout } = await this.buildRequest(options, { - retryCount: maxRetries - retriesRemaining, - }); + const { req, url, timeout } = await this.buildRequest(options, { retryCount: maxRetries - retriesRemaining }); await this.prepareRequest(req, { url, options }); @@ -457,16 +404,7 @@ export class Finch { const retryLogStr = retryOfRequestLogID === undefined ? '' : `, retryOf: ${retryOfRequestLogID}`; const startTime = Date.now(); - loggerFor(this).debug( - `[${requestLogID}] sending request`, - formatRequestDetails({ - retryOfRequestLogID, - method: options.method, - url, - options, - headers: req.headers, - }), - ); + loggerFor(this).debug(`[${requestLogID}] sending request`, formatRequestDetails({ retryOfRequestLogID, method: options.method, url, options, headers: req.headers })); if (options.signal?.aborted) { throw new Errors.APIUserAbortError(); @@ -485,45 +423,21 @@ export class Finch { // deno throws "TypeError: error sending request for url (https://example/): client error (Connect): tcp connect error: Operation timed out (os error 60): Operation timed out (os error 60)" // undici throws "TypeError: fetch failed" with cause "ConnectTimeoutError: Connect Timeout Error (attempted address: example:443, timeout: 1ms)" // others do not provide enough information to distinguish timeouts from other connection errors - const isTimeout = - isAbortError(response) || - /timed? ?out/i.test(String(response) + ('cause' in response ? String(response.cause) : '')); + const isTimeout = isAbortError(response) || /timed? ?out/i.test(String(response) + ('cause' in response ? String(response.cause) : '')) if (retriesRemaining) { - loggerFor(this).info( - `[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} - ${retryMessage}`, - ); - loggerFor(this).debug( - `[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} (${retryMessage})`, - formatRequestDetails({ - retryOfRequestLogID, - url, - durationMs: headersTime - startTime, - message: response.message, - }), - ); + loggerFor(this).info(`[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} - ${retryMessage}`) + loggerFor(this).debug(`[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} (${retryMessage})`, formatRequestDetails({ retryOfRequestLogID, url, durationMs: headersTime - startTime, message: response.message })); return this.retryRequest(options, retriesRemaining, retryOfRequestLogID ?? requestLogID); } - loggerFor(this).info( - `[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} - error; no more retries left`, - ); - loggerFor(this).debug( - `[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} (error; no more retries left)`, - formatRequestDetails({ - retryOfRequestLogID, - url, - durationMs: headersTime - startTime, - message: response.message, - }), - ); + loggerFor(this).info(`[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} - error; no more retries left`) + loggerFor(this).debug(`[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} (error; no more retries left)`, formatRequestDetails({ retryOfRequestLogID, url, durationMs: headersTime - startTime, message: response.message })); if (isTimeout) { throw new Errors.APIConnectionTimeoutError(); } throw new Errors.APIConnectionError({ cause: response }); } - const responseInfo = `[${requestLogID}${retryLogStr}] ${req.method} ${url} ${ - response.ok ? 'succeeded' : 'failed' - } with status ${response.status} in ${headersTime - startTime}ms`; + const responseInfo = `[${requestLogID}${retryLogStr}] ${req.method} ${url} ${response.ok ? 'succeeded' : 'failed'} with status ${response.status} in ${headersTime - startTime}ms`; if (!response.ok) { const shouldRetry = await this.shouldRetry(response); @@ -532,60 +446,27 @@ export class Finch { // We don't need the body of this response. await Shims.CancelReadableStream(response.body); - loggerFor(this).info(`${responseInfo} - ${retryMessage}`); - loggerFor(this).debug( - `[${requestLogID}] response error (${retryMessage})`, - formatRequestDetails({ - retryOfRequestLogID, - url: response.url, - status: response.status, - headers: response.headers, - durationMs: headersTime - startTime, - }), - ); - return this.retryRequest( - options, - retriesRemaining, - retryOfRequestLogID ?? requestLogID, - response.headers, - ); + loggerFor(this).info(`${responseInfo} - ${retryMessage}`) + loggerFor(this).debug(`[${requestLogID}] response error (${retryMessage})`, formatRequestDetails({ retryOfRequestLogID, url: response.url, status: response.status, headers: response.headers, durationMs: headersTime - startTime })); + return this.retryRequest(options, retriesRemaining, retryOfRequestLogID ?? requestLogID, response.headers); } const retryMessage = shouldRetry ? `error; no more retries left` : `error; not retryable`; - loggerFor(this).info(`${responseInfo} - ${retryMessage}`); + loggerFor(this).info(`${responseInfo} - ${retryMessage}`) const errText = await response.text().catch((err: any) => castToError(err).message); const errJSON = safeJSON(errText) as any; const errMessage = errJSON ? undefined : errText; - loggerFor(this).debug( - `[${requestLogID}] response error (${retryMessage})`, - formatRequestDetails({ - retryOfRequestLogID, - url: response.url, - status: response.status, - headers: response.headers, - message: errMessage, - durationMs: Date.now() - startTime, - }), - ); + loggerFor(this).debug(`[${requestLogID}] response error (${retryMessage})`, formatRequestDetails({ retryOfRequestLogID, url: response.url, status: response.status, headers: response.headers, message: errMessage, durationMs: Date.now() - startTime })); const err = this.makeStatusError(response.status, errJSON, errMessage, response.headers); throw err; } - loggerFor(this).info(responseInfo); - loggerFor(this).debug( - `[${requestLogID}] response start`, - formatRequestDetails({ - retryOfRequestLogID, - url: response.url, - status: response.status, - headers: response.headers, - durationMs: headersTime - startTime, - }), - ); + loggerFor(this).info(responseInfo) + loggerFor(this).debug(`[${requestLogID}] response start`, formatRequestDetails({ retryOfRequestLogID, url: response.url, status: response.status, headers: response.headers, durationMs: headersTime - startTime })); return { response, options, controller, requestLogID, retryOfRequestLogID, startTime }; } @@ -603,10 +484,7 @@ export class Finch { ); } - requestAPIList< - Item = unknown, - PageClass extends Pagination.AbstractPage = Pagination.AbstractPage, - >( + requestAPIList = Pagination.AbstractPage>( Page: new (...args: ConstructorParameters) => PageClass, options: PromiseOrValue, ): Pagination.PagePromise { @@ -626,9 +504,7 @@ export class Finch { const timeout = setTimeout(abort, ms); - const isReadableBody = - ((globalThis as any).ReadableStream && options.body instanceof (globalThis as any).ReadableStream) || - (typeof options.body === 'object' && options.body !== null && Symbol.asyncIterator in options.body); + const isReadableBody = ((globalThis as any).ReadableStream && options.body instanceof (globalThis as any).ReadableStream) || (typeof options.body === "object" && options.body !== null && Symbol.asyncIterator in options.body); const fetchOptions: RequestInit = { signal: controller.signal as any, @@ -643,6 +519,7 @@ export class Finch { } try { + // use undefined this binding; fetch errors if bound to something else in browser/cloudflare return await this.fetch.call(undefined, url, fetchOptions); } finally { @@ -743,12 +620,11 @@ export class Finch { const req: FinalizedRequestInit = { method, headers: reqHeaders, - ...(options.signal && { signal: options.signal }), - ...((globalThis as any).ReadableStream && - body instanceof (globalThis as any).ReadableStream && { duplex: 'half' }), + ...(options.signal && { signal: options.signal}), + ...((globalThis as any).ReadableStream && body instanceof (globalThis as any).ReadableStream && { duplex: "half" }), ...(body && { body }), - ...((this.fetchOptions as any) ?? {}), - ...((options.fetchOptions as any) ?? {}), + ...(this.fetchOptions as any ?? {}), + ...(options.fetchOptions as any ?? {}), }; return { req, url, timeout: options.timeout }; @@ -773,18 +649,16 @@ export class Finch { const headers = buildHeaders([ idempotencyHeaders, - { - Accept: 'application/json', - 'User-Agent': this.getUserAgent(), - 'X-Stainless-Retry-Count': String(retryCount), - ...(options.timeout ? { 'X-Stainless-Timeout': String(Math.trunc(options.timeout / 1000)) } : {}), - ...getPlatformHeaders(), - 'Finch-API-Version': '2020-09-17', - }, - await this.authHeaders(options, options.__security ?? { bearerAuth: true, basicAuth: true }), + {Accept: 'application/json', + 'User-Agent': this.getUserAgent(), + 'X-Stainless-Retry-Count': String(retryCount), + ...(options.timeout ? { 'X-Stainless-Timeout': String(Math.trunc(options.timeout / 1000)) } : {}), + ...getPlatformHeaders(), + 'Finch-API-Version': '2020-09-17'}, + await this.authHeaders(options, options.__security ?? { bearerAuth: true,basicAuth: true }), this._options.defaultHeaders, bodyHeaders, - options.headers, + options.headers ]); this.validateHeaders(headers); @@ -811,9 +685,11 @@ export class Finch { ArrayBuffer.isView(body) || body instanceof ArrayBuffer || body instanceof DataView || - (typeof body === 'string' && + ( + typeof body === 'string' && // Preserve legacy string encoding behavior for now - headers.values.has('content-type')) || + headers.values.has('content-type') + ) || // `Blob` is superset of `File` ((globalThis as any).Blob && body instanceof (globalThis as any).Blob) || // `FormData` -> `multipart/form-data` @@ -844,7 +720,7 @@ export class Finch { } static Finch = this; - static DEFAULT_TIMEOUT = 60000; // 1 minute + static DEFAULT_TIMEOUT = 60000 // 1 minute static FinchError = Errors.FinchError; static APIError = Errors.APIError; @@ -921,74 +797,94 @@ Finch.Payroll = Payroll; Finch.Connect = Connect; export declare namespace Finch { - export type RequestOptions = Opts.RequestOptions; - - export import SinglePage = Pagination.SinglePage; - export { type SinglePageResponse as SinglePageResponse }; - - export import ResponsesPage = Pagination.ResponsesPage; - export { type ResponsesPageResponse as ResponsesPageResponse }; - - export import IndividualsPage = Pagination.IndividualsPage; - export { - type IndividualsPageParams as IndividualsPageParams, - type IndividualsPageResponse as IndividualsPageResponse, - }; - - export import Page = Pagination.Page; - export { type PageParams as PageParams, type PageResponse as PageResponse }; - - export { - AccessTokens as AccessTokens, - type CreateAccessTokenResponse as CreateAccessTokenResponse, - type AccessTokenCreateParams as AccessTokenCreateParams, - }; - - export { HRIS as HRIS, type Income as Income, type Location as Location, type Money as Money }; - - export { - Providers as Providers, - type Provider as Provider, - type ProviderListResponse as ProviderListResponse, - type ProviderListResponsesSinglePage as ProviderListResponsesSinglePage, - }; - - export { - Account as Account, - type DisconnectResponse as DisconnectResponse, - type Introspection as Introspection, - }; - - export { - Webhooks as Webhooks, - type AccountUpdateEvent as AccountUpdateEvent, - type BaseWebhookEvent as BaseWebhookEvent, - type CompanyEvent as CompanyEvent, - type DirectoryEvent as DirectoryEvent, - type EmploymentEvent as EmploymentEvent, - type IndividualEvent as IndividualEvent, - type JobCompletionEvent as JobCompletionEvent, - type PayStatementEvent as PayStatementEvent, - type PaymentEvent as PaymentEvent, - type WebhookEvent as WebhookEvent, - }; - - export { - RequestForwarding as RequestForwarding, - type RequestForwardingForwardResponse as RequestForwardingForwardResponse, - type RequestForwardingForwardParams as RequestForwardingForwardParams, - }; - - export { Jobs as Jobs }; - - export { Sandbox as Sandbox }; - - export { Payroll as Payroll }; - - export { Connect as Connect }; - - export type ConnectionStatusType = API.ConnectionStatusType; - export type OperationSupport = API.OperationSupport; - export type OperationSupportMatrix = API.OperationSupportMatrix; - export type Paging = API.Paging; -} + export type RequestOptions = Opts.RequestOptions; + + export import SinglePage = Pagination.SinglePage; +export { + type SinglePageResponse as SinglePageResponse +}; + +export import ResponsesPage = Pagination.ResponsesPage; +export { + type ResponsesPageResponse as ResponsesPageResponse +}; + +export import IndividualsPage = Pagination.IndividualsPage; +export { + type IndividualsPageParams as IndividualsPageParams, + type IndividualsPageResponse as IndividualsPageResponse +}; + +export import Page = Pagination.Page; +export { + type PageParams as PageParams, + type PageResponse as PageResponse +}; + +export { + AccessTokens as AccessTokens, + type CreateAccessTokenResponse as CreateAccessTokenResponse, + type AccessTokenCreateParams as AccessTokenCreateParams +}; + +export { + HRIS as HRIS, + type Income as Income, + type Location as Location, + type Money as Money +}; + +export { + Providers as Providers, + type Provider as Provider, + type ProviderListResponse as ProviderListResponse, + type ProviderListResponsesSinglePage as ProviderListResponsesSinglePage +}; + +export { + Account as Account, + type DisconnectResponse as DisconnectResponse, + type Introspection as Introspection +}; + +export { + Webhooks as Webhooks, + type AccountUpdateEvent as AccountUpdateEvent, + type BaseWebhookEvent as BaseWebhookEvent, + type CompanyEvent as CompanyEvent, + type DirectoryEvent as DirectoryEvent, + type EmploymentEvent as EmploymentEvent, + type IndividualEvent as IndividualEvent, + type JobCompletionEvent as JobCompletionEvent, + type PayStatementEvent as PayStatementEvent, + type PaymentEvent as PaymentEvent, + type WebhookEvent as WebhookEvent +}; + +export { + RequestForwarding as RequestForwarding, + type RequestForwardingForwardResponse as RequestForwardingForwardResponse, + type RequestForwardingForwardParams as RequestForwardingForwardParams +}; + +export { + Jobs as Jobs +}; + +export { + Sandbox as Sandbox +}; + +export { + Payroll as Payroll +}; + +export { + Connect as Connect +}; + +export type ConnectionStatusType = API.ConnectionStatusType; +export type OperationSupport = API.OperationSupport; +export type OperationSupportMatrix = API.OperationSupportMatrix; +export type Paging = API.Paging; + } diff --git a/src/core/api-promise.ts b/src/core/api-promise.ts index a3d3ebef..ff15d7c3 100644 --- a/src/core/api-promise.ts +++ b/src/core/api-promise.ts @@ -16,10 +16,7 @@ export class APIPromise extends Promise { constructor( client: Finch, private responsePromise: Promise, - private parseResponse: ( - client: Finch, - props: APIResponseProps, - ) => PromiseOrValue = defaultParseResponse, + private parseResponse: (client: Finch, props: APIResponseProps) => PromiseOrValue = defaultParseResponse, ) { super((resolve) => { // this is maybe a bit weird but this has to be a no-op to not implicitly @@ -31,9 +28,7 @@ export class APIPromise extends Promise { } _thenUnwrap(transform: (data: T, props: APIResponseProps) => U): APIPromise { - return new APIPromise(this.#client, this.responsePromise, async (client, props) => - transform(await this.parseResponse(client, props), props), - ); + return new APIPromise(this.#client, this.responsePromise, async (client, props) => transform(await this.parseResponse(client, props), props)); } /** diff --git a/src/core/error.ts b/src/core/error.ts index e969b5f4..28ea490f 100644 --- a/src/core/error.ts +++ b/src/core/error.ts @@ -2,13 +2,10 @@ import { castToError } from '../internal/errors'; -export class FinchError extends Error {} +export class FinchError extends Error { +} -export class APIError< - TStatus extends number | undefined = number | undefined, - THeaders extends Headers | undefined = Headers | undefined, - TError extends Object | undefined = Object | undefined, -> extends FinchError { +export class APIError extends FinchError { /** HTTP status for the response that caused the error */ readonly status: TStatus; /** HTTP headers for the response that caused the error */ @@ -16,6 +13,9 @@ export class APIError< /** JSON body of the response that caused the error */ readonly error: TError; + + ; + constructor(status: TStatus, error: TError, message: string | undefined, headers: THeaders) { super(`${APIError.makeMessage(status, error, message)}`); this.status = status; @@ -26,8 +26,7 @@ export class APIError< private static makeMessage(status: number | undefined, error: any, message: string | undefined) { const msg = error?.message ? - typeof error.message === 'string' ? - error.message + typeof error.message === 'string' ? error.message : JSON.stringify(error.message) : error ? JSON.stringify(error) : message; @@ -44,12 +43,7 @@ export class APIError< return '(no status code or body)'; } - static generate( - status: number | undefined, - errorResponse: Object | undefined, - message: string | undefined, - headers: Headers | undefined, - ): APIError { + static generate(status: number | undefined, errorResponse: Object | undefined, message: string | undefined, headers: Headers | undefined): APIError { if (!status || !headers) { return new APIConnectionError({ message, cause: castToError(errorResponse) }); } @@ -113,18 +107,26 @@ export class APIConnectionTimeoutError extends APIConnectionError { } } -export class BadRequestError extends APIError<400, Headers> {} +export class BadRequestError extends APIError<400, Headers> { +} -export class AuthenticationError extends APIError<401, Headers> {} +export class AuthenticationError extends APIError<401, Headers> { +} -export class PermissionDeniedError extends APIError<403, Headers> {} +export class PermissionDeniedError extends APIError<403, Headers> { +} -export class NotFoundError extends APIError<404, Headers> {} +export class NotFoundError extends APIError<404, Headers> { +} -export class ConflictError extends APIError<409, Headers> {} +export class ConflictError extends APIError<409, Headers> { +} -export class UnprocessableEntityError extends APIError<422, Headers> {} +export class UnprocessableEntityError extends APIError<422, Headers> { +} -export class RateLimitError extends APIError<429, Headers> {} +export class RateLimitError extends APIError<429, Headers> { +} -export class InternalServerError extends APIError {} +export class InternalServerError extends APIError { +} diff --git a/src/core/pagination.ts b/src/core/pagination.ts index 475ff532..15d024fb 100644 --- a/src/core/pagination.ts +++ b/src/core/pagination.ts @@ -89,8 +89,7 @@ export class PagePromise< super( client, request, - async (client, props) => - new Page(client, props.response, await defaultParseResponse(client, props), props.options), + async (client, props) => new Page(client, props.response, await defaultParseResponse(client, props), props.options) ); } @@ -114,12 +113,7 @@ export type SinglePageResponse = Item[]; export class SinglePage extends AbstractPage { items: Array; - constructor( - client: Finch, - response: Response, - body: SinglePageResponse, - options: FinalRequestOptions, - ) { + constructor(client: Finch, response: Response, body: SinglePageResponse, options: FinalRequestOptions) { super(client, response, body, options); this.items = body || []; @@ -141,12 +135,7 @@ export interface ResponsesPageResponse { export class ResponsesPage extends AbstractPage implements ResponsesPageResponse { responses: Array; - constructor( - client: Finch, - response: Response, - body: ResponsesPageResponse, - options: FinalRequestOptions, - ) { + constructor(client: Finch, response: Response, body: ResponsesPageResponse, options: FinalRequestOptions) { super(client, response, body, options); this.responses = body.responses || []; @@ -182,10 +171,7 @@ export interface IndividualsPageParams { offset?: number; } -export class IndividualsPage - extends AbstractPage - implements IndividualsPageResponse -{ +export class IndividualsPage extends AbstractPage implements IndividualsPageResponse { /** * The array of employees. */ @@ -193,12 +179,7 @@ export class IndividualsPage paging: Shared.Paging; - constructor( - client: Finch, - response: Response, - body: IndividualsPageResponse, - options: FinalRequestOptions, - ) { + constructor(client: Finch, response: Response, body: IndividualsPageResponse, options: FinalRequestOptions) { super(client, response, body, options); this.individuals = body.individuals || []; @@ -221,15 +202,15 @@ export class IndividualsPage if (currentCount < totalCount) { return { - ...this.options, - query: { - ...maybeObj(this.options.query), - offset: currentCount, - }, - }; + ...this.options, + query: { + ...maybeObj(this.options.query), + offset: currentCount, + }, + }; } - return null; + return null } } @@ -279,14 +260,14 @@ export class Page extends AbstractPage implements PageResponse if (currentCount < totalCount) { return { - ...this.options, - query: { - ...maybeObj(this.options.query), - offset: currentCount, - }, - }; + ...this.options, + query: { + ...maybeObj(this.options.query), + offset: currentCount, + }, + }; } - return null; + return null } } diff --git a/src/error.ts b/src/error.ts index fc55f46c..d0832d34 100644 --- a/src/error.ts +++ b/src/error.ts @@ -1,2 +1,2 @@ /** @deprecated Import from ./core/error instead */ -export * from './core/error'; +export * from "./core/error" \ No newline at end of file diff --git a/src/index.ts b/src/index.ts index ad0e5450..3cdfba13 100644 --- a/src/index.ts +++ b/src/index.ts @@ -6,18 +6,4 @@ export { type Uploadable, toFile } from './core/uploads'; export { APIPromise } from './core/api-promise'; export { Finch, type ClientOptions } from './client'; export { PagePromise } from './core/pagination'; -export { - FinchError, - APIError, - APIConnectionError, - APIConnectionTimeoutError, - APIUserAbortError, - NotFoundError, - ConflictError, - RateLimitError, - BadRequestError, - AuthenticationError, - InternalServerError, - PermissionDeniedError, - UnprocessableEntityError, -} from './core/error'; +export { FinchError, APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError, NotFoundError, ConflictError, RateLimitError, BadRequestError, AuthenticationError, InternalServerError, PermissionDeniedError, UnprocessableEntityError } from './core/error'; diff --git a/src/internal/builtin-types.ts b/src/internal/builtin-types.ts index c23d3bde..6059d5db 100644 --- a/src/internal/builtin-types.ts +++ b/src/internal/builtin-types.ts @@ -1,20 +1,23 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -export type Fetch = (input: string | URL | Request, init?: RequestInit) => Promise; +export type Fetch = ( + input: string | URL | Request, + init?: RequestInit, +) => Promise /** * An alias to the builtin `RequestInit` type so we can * easily alias it in import statements if there are name clashes. - * - * https://developer.mozilla.org/docs/Web/API/RequestInit + * + * https://developer.mozilla.org/docs/Web/API/RequestInit */ type _RequestInit = RequestInit; /** * An alias to the builtin `Response` type so we can * easily alias it in import statements if there are name clashes. - * - * https://developer.mozilla.org/docs/Web/API/Response + * + * https://developer.mozilla.org/docs/Web/API/Response */ type _Response = Response; @@ -51,15 +54,7 @@ type _Array = Array; */ type _Record = Record; -export type { - _Array as Array, - _BodyInit as BodyInit, - _HeadersInit as HeadersInit, - _Record as Record, - _RequestInfo as RequestInfo, - _RequestInit as RequestInit, - _Response as Response, -}; +export type { _Array as Array, _BodyInit as BodyInit, _HeadersInit as HeadersInit, _Record as Record, _RequestInfo as RequestInfo, _RequestInit as RequestInit, _Response as Response }; /** * A copy of the builtin `EndingType` type as it isn't fully supported in certain diff --git a/src/internal/detect-platform.ts b/src/internal/detect-platform.ts index e82d95c9..394ede88 100644 --- a/src/internal/detect-platform.ts +++ b/src/internal/detect-platform.ts @@ -25,11 +25,7 @@ function getDetectedPlatform(): DetectedPlatform { if (typeof EdgeRuntime !== 'undefined') { return 'edge'; } - if ( - Object.prototype.toString.call( - typeof (globalThis as any).process !== 'undefined' ? (globalThis as any).process : 0, - ) === '[object process]' - ) { + if (Object.prototype.toString.call(typeof (globalThis as any).process !== 'undefined' ? (globalThis as any).process : 0) === '[object process]') { return 'node'; } return 'unknown'; diff --git a/src/internal/errors.ts b/src/internal/errors.ts index 82c7b14d..c14a742b 100644 --- a/src/internal/errors.ts +++ b/src/internal/errors.ts @@ -2,12 +2,12 @@ export function isAbortError(err: unknown) { return ( - typeof err === 'object' && - err !== null && - // Spec-compliant fetch implementations - (('name' in err && (err as any).name === 'AbortError') || + typeof err === 'object' && err !== null && ( + // Spec-compliant fetch implementations + ('name' in err && (err as any).name === 'AbortError') || // Expo fetch - ('message' in err && String((err as any).message).includes('FetchRequestCanceledException'))) + ('message' in err && String((err as any).message).includes('FetchRequestCanceledException')) + ) ); } @@ -24,10 +24,10 @@ export const castToError = (err: any): Error => { if (err.name) error.name = err.name; return error; } - } catch {} + } catch { } try { return new Error(JSON.stringify(err)); - } catch {} + } catch { } } return new Error(err); }; diff --git a/src/internal/headers.ts b/src/internal/headers.ts index 6d9e48dc..54428d74 100644 --- a/src/internal/headers.ts +++ b/src/internal/headers.ts @@ -1,6 +1,6 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -import { isReadonlyArray } from './utils/values'; +import { isReadonlyArray } from "./utils/values"; type HeaderValue = string | undefined | null; export type HeadersLike = @@ -51,7 +51,7 @@ function* iterateHeaders(headers: HeadersLike): IterableIterator(client: Finch, props: APIResponseProps): Promise { const { response, requestLogID, retryOfRequestLogID, startTime } = props; const body = await (async () => { + // fetch refuses to read the body when the status code is 204. if (response.status === 204) { return null as T; @@ -42,15 +43,6 @@ export async function defaultParseResponse(client: Finch, props: APIResponseP const text = await response.text(); return text as unknown as T; })(); - loggerFor(client).debug( - `[${requestLogID}] response parsed`, - formatRequestDetails({ - retryOfRequestLogID, - url: response.url, - status: response.status, - body, - durationMs: Date.now() - startTime, - }), - ); + loggerFor(client).debug(`[${requestLogID}] response parsed`, formatRequestDetails({ retryOfRequestLogID, url: response.url, status: response.status, body, durationMs: Date.now() - startTime })); return body; } diff --git a/src/internal/qs/utils.ts b/src/internal/qs/utils.ts index 4cd56579..f21d955b 100644 --- a/src/internal/qs/utils.ts +++ b/src/internal/qs/utils.ts @@ -62,7 +62,10 @@ export function merge( if (isArray(target)) { target.push(source); } else if (target && typeof target === 'object') { - if ((options && (options.plainObjects || options.allowPrototypes)) || !has(Object.prototype, source)) { + if ( + (options && (options.plainObjects || options.allowPrototypes)) || + !has(Object.prototype, source) + ) { target[source] = true; } } else { diff --git a/src/internal/request-options.ts b/src/internal/request-options.ts index 21e8c1ba..77d8d750 100644 --- a/src/internal/request-options.ts +++ b/src/internal/request-options.ts @@ -75,13 +75,17 @@ export type RequestOptions = { */ defaultBaseURL?: string | undefined; - __security?: { bearerAuth?: boolean; basicAuth?: boolean }; + __security?: { bearerAuth?: boolean, basicAuth?: boolean }; __binaryResponse?: boolean | undefined; + }; export type EncodedContent = { bodyHeaders: HeadersLike; body: BodyInit }; -export type RequestEncoder = (request: { headers: NullableHeaders; body: unknown }) => EncodedContent; +export type RequestEncoder = (request: { + headers: NullableHeaders; + body: unknown; +}) => EncodedContent; export const FallbackEncoder: RequestEncoder = ({ headers, body }) => { return { diff --git a/src/internal/shim-types.ts b/src/internal/shim-types.ts index 8ddf7b0a..accbf576 100644 --- a/src/internal/shim-types.ts +++ b/src/internal/shim-types.ts @@ -19,8 +19,8 @@ type _ConditionalNodeReadableStream = typeof globalThis extends { ReadableStream: any } ? never : _NodeReadableStream; type _ReadableStream = NeverToAny< - | ([0] extends [1 & _DOMReadableStream] ? never : _DOMReadableStream) - | ([0] extends [1 & _ConditionalNodeReadableStream] ? never : _ConditionalNodeReadableStream) + ([0] extends [1 & _DOMReadableStream] ? never : _DOMReadableStream) | + ([0] extends [1 & _ConditionalNodeReadableStream] ? never : _ConditionalNodeReadableStream) >; export type { _ReadableStream as ReadableStream }; diff --git a/src/internal/shims.ts b/src/internal/shims.ts index 5c6104af..91ab751a 100644 --- a/src/internal/shims.ts +++ b/src/internal/shims.ts @@ -27,9 +27,7 @@ export function makeReadableStream(...args: ReadableStreamArgs): ReadableStream if (typeof ReadableStream === 'undefined') { // Note: All of the platforms / runtimes we officially support already define // `ReadableStream` as a global, so this should only ever be hit on unsupported runtimes. - throw new Error( - '`ReadableStream` is not defined as a global; You will need to polyfill it, `globalThis.ReadableStream = ReadableStream`', - ); + throw new Error('`ReadableStream` is not defined as a global; You will need to polyfill it, `globalThis.ReadableStream = ReadableStream`'); } return new ReadableStream(...args); diff --git a/src/internal/to-file.ts b/src/internal/to-file.ts index 30eada32..c72a2b41 100644 --- a/src/internal/to-file.ts +++ b/src/internal/to-file.ts @@ -1,4 +1,4 @@ -import { BlobPart, getName, makeFile, isAsyncIterable } from './uploads'; +import { BlobPart, getName, makeFile, isAsyncIterable } from "./uploads"; import type { FilePropertyBag } from './builtin-types'; import { checkFileSupport } from './uploads'; @@ -65,11 +65,8 @@ const isResponseLike = (value: any): value is ResponseLike => typeof value.url === 'string' && typeof value.blob === 'function'; -export type ToFileInput = - | FileLike - | ResponseLike - | Exclude - | AsyncIterable; +export type ToFileInput = FileLike | ResponseLike | Exclude | AsyncIterable; + /** * Helper for creating a {@link File} to pass to an SDK upload method from a variety of different data formats @@ -119,7 +116,9 @@ export async function toFile( return makeFile(parts, name, options); } -async function getBytes(value: BlobLikePart | AsyncIterable): Promise> { +async function getBytes( + value: BlobLikePart | AsyncIterable, +): Promise> { let parts: Array = []; if ( typeof value === 'string' || @@ -152,3 +151,4 @@ function propsForError(value: unknown): string { const props = Object.getOwnPropertyNames(value); return `; props: [${props.map((p) => `"${p}"`).join(', ')}]`; } + diff --git a/src/internal/types.ts b/src/internal/types.ts index b668dfc0..c45fee32 100644 --- a/src/internal/types.ts +++ b/src/internal/types.ts @@ -7,40 +7,34 @@ export type KeysEnum = { [P in keyof Required]: true }; export type FinalizedRequestInit = RequestInit & { headers: Headers }; -type NotAny = [0] extends [1 & T] ? never : T; +type NotAny = [0] extends [(1 & T)] ? never : T; /** * Some environments overload the global fetch function, and Parameters only gets the last signature. */ -type OverloadedParameters = - T extends ( - { +type OverloadedParameters = T extends { + (...args: infer A): unknown; + (...args: infer B): unknown; + (...args: infer C): unknown; + (...args: infer D): unknown; +} + ? A | B | C | D + : T extends { (...args: infer A): unknown; (...args: infer B): unknown; (...args: infer C): unknown; - (...args: infer D): unknown; } - ) ? - A | B | C | D - : T extends ( - { - (...args: infer A): unknown; - (...args: infer B): unknown; - (...args: infer C): unknown; - } - ) ? - A | B | C - : T extends ( - { + ? A | B | C + : T extends { (...args: infer A): unknown; (...args: infer B): unknown; } - ) ? - A | B - : T extends (...args: infer A) => unknown ? A + ? A | B + : T extends (...args: infer A) => unknown + ? A : never; -/* eslint-disable */ + /** * These imports attempt to get types from a parent package's dependencies. * Unresolved bare specifiers can trigger [automatic type acquisition][1] in some projects, which @@ -63,19 +57,19 @@ type OverloadedParameters = * * [1]: https://www.typescriptlang.org/tsconfig/#typeAcquisition */ -/** @ts-ignore For users with \@types/node */ +/** @ts-ignore For users with \@types/node */ /* prettier-ignore */ type UndiciTypesRequestInit = NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny; -/** @ts-ignore For users with undici */ +/** @ts-ignore For users with undici */ /* prettier-ignore */ type UndiciRequestInit = NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny; -/** @ts-ignore For users with \@types/bun */ +/** @ts-ignore For users with \@types/bun */ /* prettier-ignore */ type BunRequestInit = globalThis.FetchRequestInit; -/** @ts-ignore For users with node-fetch@2 */ +/** @ts-ignore For users with node-fetch@2 */ /* prettier-ignore */ type NodeFetch2RequestInit = NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny; -/** @ts-ignore For users with node-fetch@3, doesn't need file extension because types are at ./@types/index.d.ts */ +/** @ts-ignore For users with node-fetch@3, doesn't need file extension because types are at ./@types/index.d.ts */ /* prettier-ignore */ type NodeFetch3RequestInit = NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny; -/** @ts-ignore For users who use Deno */ +/** @ts-ignore For users who use Deno */ /* prettier-ignore */ type FetchRequestInit = NonNullable[1]>; -/* eslint-enable */ + type RequestInits = | NotAny diff --git a/src/internal/utils/log.ts b/src/internal/utils/log.ts index 55eb21e3..34e101ac 100644 --- a/src/internal/utils/log.ts +++ b/src/internal/utils/log.ts @@ -4,7 +4,7 @@ import { hasOwn } from './values'; import { type Finch } from '../../client'; import { RequestOptions } from '../request-options'; -type LogFn = (message: string, ...rest: unknown[]) => void; +type LogFn = (message: string, ...rest: unknown[]) => void export type Logger = { error: LogFn; warn: LogFn; @@ -21,22 +21,14 @@ const levelNumbers = { debug: 500, }; -export const parseLogLevel = ( - maybeLevel: string | undefined, - sourceName: string, - client: Finch, -): LogLevel | undefined => { +export const parseLogLevel = (maybeLevel: string | undefined, sourceName: string, client: Finch): LogLevel | undefined => { if (!maybeLevel) { return undefined; } if (hasOwn(levelNumbers, maybeLevel)) { return maybeLevel; - } - loggerFor(client).warn( - `${sourceName} was set to ${JSON.stringify(maybeLevel)}, expected one of ${JSON.stringify( - Object.keys(levelNumbers), - )}`, - ); + }; + loggerFor(client).warn(`${sourceName} was set to ${JSON.stringify(maybeLevel)}, expected one of ${JSON.stringify(Object.keys(levelNumbers))}`); return undefined; }; @@ -97,24 +89,11 @@ export const formatRequestDetails = (details: { body?: unknown; }) => { if (details.options) { - details.options = { ...details.options }; + details.options = {...details.options}; delete details.options['headers']; // redundant + leaks internals } if (details.headers) { - details.headers = Object.fromEntries( - (details.headers instanceof Headers ? [...details.headers] : Object.entries(details.headers)).map( - ([name, value]) => [ - name, - ( - name.toLowerCase() === 'authorization' || - name.toLowerCase() === 'cookie' || - name.toLowerCase() === 'set-cookie' - ) ? - '***' - : value, - ], - ), - ); + details.headers = Object.fromEntries((details.headers instanceof Headers ? [...details.headers] : Object.entries(details.headers)).map(([name, value]) => [name, name.toLowerCase() === 'authorization' || name.toLowerCase() === 'cookie' || name.toLowerCase() === 'set-cookie' ? '***' : value])) } if ('retryOfRequestLogID' in details) { if (details.retryOfRequestLogID) { @@ -122,5 +101,5 @@ export const formatRequestDetails = (details: { } delete details.retryOfRequestLogID; } - return details; -}; + return details +} diff --git a/src/internal/utils/query.ts b/src/internal/utils/query.ts index f7d1b4b2..0f61c00b 100644 --- a/src/internal/utils/query.ts +++ b/src/internal/utils/query.ts @@ -3,5 +3,5 @@ import * as qs from '../qs/stringify'; export function stringifyQuery(query: object | Record) { - return qs.stringify(query, { arrayFormat: 'brackets' }); + return qs.stringify(query, { arrayFormat: 'brackets' }) } diff --git a/src/internal/utils/uuid.ts b/src/internal/utils/uuid.ts index b0e53aaf..53708ba6 100644 --- a/src/internal/utils/uuid.ts +++ b/src/internal/utils/uuid.ts @@ -10,8 +10,10 @@ export let uuid4 = function () { return crypto.randomUUID(); } const u8 = new Uint8Array(1); - const randomByte = crypto ? () => crypto.getRandomValues(u8)[0]! : () => (Math.random() * 0xff) & 0xff; - return '10000000-1000-4000-8000-100000000000'.replace(/[018]/g, (c) => + const randomByte = crypto + ? () => crypto.getRandomValues(u8)[0]! + : () => (Math.random() * 0xff) & 0xff; + return "10000000-1000-4000-8000-100000000000".replace(/[018]/g, (c) => (+c ^ (randomByte() & (15 >> (+c / 4)))).toString(16), ); -}; +} diff --git a/src/pagination.ts b/src/pagination.ts index 90bf015e..e1e5d091 100644 --- a/src/pagination.ts +++ b/src/pagination.ts @@ -1,2 +1,2 @@ /** @deprecated Import from ./core/pagination instead */ -export * from './core/pagination'; +export * from "./core/pagination" \ No newline at end of file diff --git a/src/resource.ts b/src/resource.ts index 363e3516..57a27a94 100644 --- a/src/resource.ts +++ b/src/resource.ts @@ -1,2 +1,2 @@ /** @deprecated Import from ./core/resource instead */ -export * from './core/resource'; +export * from "./core/resource" \ No newline at end of file diff --git a/src/resources/access-tokens.ts b/src/resources/access-tokens.ts index 0f9624ba..787873bd 100644 --- a/src/resources/access-tokens.ts +++ b/src/resources/access-tokens.ts @@ -32,7 +32,7 @@ export class AccessTokens extends APIResource { body: bodyWithReplacements, ...options, headers: headersWithReplacements, - __security: {}, + __security: { }, }); } } @@ -131,6 +131,6 @@ export interface AccessTokenCreateParams { export declare namespace AccessTokens { export { type CreateAccessTokenResponse as CreateAccessTokenResponse, - type AccessTokenCreateParams as AccessTokenCreateParams, + type AccessTokenCreateParams as AccessTokenCreateParams }; } diff --git a/src/resources/account.ts b/src/resources/account.ts index d8a6a0dc..723b8b11 100644 --- a/src/resources/account.ts +++ b/src/resources/account.ts @@ -10,14 +10,14 @@ export class Account extends APIResource { * Disconnect one or more `access_token`s from your application. */ disconnect(options?: RequestOptions): APIPromise { - return this._client.post('/disconnect', { ...options, __security: { bearerAuth: true } }); + return this._client.post('/disconnect', { ...options, __security: { bearerAuth : true } }); } /** * Read account information associated with an `access_token` */ introspect(options?: RequestOptions): APIPromise { - return this._client.get('/introspect', { ...options, __security: { bearerAuth: true } }); + return this._client.get('/introspect', { ...options, __security: { bearerAuth : true } }); } } @@ -184,17 +184,13 @@ export namespace Introspection { /** * The status of the entity connection */ - status: - | 'pending' - | 'processing' - | 'connected' - | 'error_no_account_setup' - | 'error_permissions' - | 'reauth' - | 'disconnected'; + status: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth' | 'disconnected'; } } export declare namespace Account { - export { type DisconnectResponse as DisconnectResponse, type Introspection as Introspection }; + export { + type DisconnectResponse as DisconnectResponse, + type Introspection as Introspection + }; } diff --git a/src/resources/connect/connect.ts b/src/resources/connect/connect.ts index 876dad04..b45f2b73 100644 --- a/src/resources/connect/connect.ts +++ b/src/resources/connect/connect.ts @@ -2,13 +2,7 @@ import { APIResource } from '../../core/resource'; import * as SessionsAPI from './sessions'; -import { - SessionNewParams, - SessionNewResponse, - SessionReauthenticateParams, - SessionReauthenticateResponse, - Sessions, -} from './sessions'; +import { SessionNewParams, SessionNewResponse, SessionReauthenticateParams, SessionReauthenticateResponse, Sessions } from './sessions'; export class Connect extends APIResource { sessions: SessionsAPI.Sessions = new SessionsAPI.Sessions(this._client); @@ -22,6 +16,6 @@ export declare namespace Connect { type SessionNewResponse as SessionNewResponse, type SessionReauthenticateResponse as SessionReauthenticateResponse, type SessionNewParams as SessionNewParams, - type SessionReauthenticateParams as SessionReauthenticateParams, + type SessionReauthenticateParams as SessionReauthenticateParams }; } diff --git a/src/resources/connect/index.ts b/src/resources/connect/index.ts index 6e29c158..c4611a3b 100644 --- a/src/resources/connect/index.ts +++ b/src/resources/connect/index.ts @@ -1,10 +1,4 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -export { Connect } from './connect'; -export { - Sessions, - type SessionNewResponse, - type SessionReauthenticateResponse, - type SessionNewParams, - type SessionReauthenticateParams, -} from './sessions'; +export { Connect } from './connect';; +export { Sessions, type SessionNewResponse, type SessionReauthenticateResponse, type SessionNewParams, type SessionReauthenticateParams } from './sessions';; diff --git a/src/resources/connect/sessions.ts b/src/resources/connect/sessions.ts index 0132d9de..5a1a5550 100644 --- a/src/resources/connect/sessions.ts +++ b/src/resources/connect/sessions.ts @@ -9,21 +9,14 @@ export class Sessions extends APIResource { * Create a new connect session for an employer */ new(body: SessionNewParams, options?: RequestOptions): APIPromise { - return this._client.post('/connect/sessions', { body, ...options, __security: { basicAuth: true } }); + return this._client.post('/connect/sessions', { body, ...options, __security: { basicAuth : true } }); } /** * Create a new Connect session for reauthenticating an existing connection */ - reauthenticate( - body: SessionReauthenticateParams, - options?: RequestOptions, - ): APIPromise { - return this._client.post('/connect/sessions/reauthenticate', { - body, - ...options, - __security: { basicAuth: true }, - }); + reauthenticate(body: SessionReauthenticateParams, options?: RequestOptions): APIPromise { + return this._client.post('/connect/sessions/reauthenticate', { body, ...options, __security: { basicAuth : true } }); } } @@ -67,18 +60,7 @@ export interface SessionNewParams { * endpoints — `deduction` is a deprecated alias that is still accepted but should * not be combined with `benefits`. */ - products: Array< - | 'benefits' - | 'company' - | 'deduction' - | 'directory' - | 'documents' - | 'employment' - | 'individual' - | 'payment' - | 'pay_statement' - | 'ssn' - >; + products: Array<'benefits' | 'company' | 'deduction' | 'directory' | 'documents' | 'employment' | 'individual' | 'payment' | 'pay_statement' | 'ssn'>; /** * Email address of the customer @@ -146,18 +128,7 @@ export interface SessionReauthenticateParams { * `benefits` to access deductions endpoints — `deduction` is a deprecated alias * that is still accepted but should not be combined with `benefits`. */ - products?: Array< - | 'benefits' - | 'company' - | 'deduction' - | 'directory' - | 'documents' - | 'employment' - | 'individual' - | 'payment' - | 'pay_statement' - | 'ssn' - > | null; + products?: Array<'benefits' | 'company' | 'deduction' | 'directory' | 'documents' | 'employment' | 'individual' | 'payment' | 'pay_statement' | 'ssn'> | null; /** * The URI to redirect to after the Connect flow is completed @@ -170,6 +141,6 @@ export declare namespace Sessions { type SessionNewResponse as SessionNewResponse, type SessionReauthenticateResponse as SessionReauthenticateResponse, type SessionNewParams as SessionNewParams, - type SessionReauthenticateParams as SessionReauthenticateParams, + type SessionReauthenticateParams as SessionReauthenticateParams }; } diff --git a/src/resources/hris/benefits/benefits.ts b/src/resources/hris/benefits/benefits.ts index 38af20cc..ed90d389 100644 --- a/src/resources/hris/benefits/benefits.ts +++ b/src/resources/hris/benefits/benefits.ts @@ -3,18 +3,7 @@ import { APIResource } from '../../../core/resource'; import * as Shared from '../../shared'; import * as IndividualsAPI from './individuals'; -import { - EnrolledIndividualBenefitResponse, - IndividualBenefit, - IndividualBenefitsSinglePage, - IndividualEnrollManyParams, - IndividualEnrolledIDsParams, - IndividualEnrolledIDsResponse, - IndividualRetrieveManyBenefitsParams, - IndividualUnenrollManyParams, - Individuals, - UnenrolledIndividualBenefitResponse, -} from './individuals'; +import { EnrolledIndividualBenefitResponse, IndividualBenefit, IndividualBenefitsSinglePage, IndividualEnrollManyParams, IndividualEnrolledIDsParams, IndividualEnrolledIDsResponse, IndividualRetrieveManyBenefitsParams, IndividualUnenrollManyParams, Individuals, UnenrolledIndividualBenefitResponse } from './individuals'; import { APIPromise } from '../../../core/api-promise'; import { PagePromise, SinglePage } from '../../../core/pagination'; import { RequestOptions } from '../../../internal/request-options'; @@ -33,17 +22,9 @@ export class Benefits extends APIResource { * await client.hris.benefits.create(); * ``` */ - create( - params: BenefitCreateParams | null | undefined = {}, - options?: RequestOptions, - ): APIPromise { - const { entity_ids, ...body } = params ?? {}; - return this._client.post('/employer/benefits', { - query: { entity_ids }, - body, - ...options, - __security: { bearerAuth: true }, - }); + create(params: BenefitCreateParams | null | undefined = {}, options?: RequestOptions): APIPromise { + const { entity_ids, ...body } = params ?? {} + return this._client.post('/employer/benefits', { query: { entity_ids }, body, ...options, __security: { bearerAuth : true } }); } /** @@ -56,16 +37,8 @@ export class Benefits extends APIResource { * ); * ``` */ - retrieve( - benefitID: string, - query: BenefitRetrieveParams | null | undefined = {}, - options?: RequestOptions, - ): APIPromise { - return this._client.get(path`/employer/benefits/${benefitID}`, { - query, - ...options, - __security: { bearerAuth: true }, - }); + retrieve(benefitID: string, query: BenefitRetrieveParams | null | undefined = {}, options?: RequestOptions): APIPromise { + return this._client.get(path`/employer/benefits/${benefitID}`, { query, ...options, __security: { bearerAuth : true } }); } /** @@ -77,18 +50,9 @@ export class Benefits extends APIResource { * await client.hris.benefits.update('benefit_id'); * ``` */ - update( - benefitID: string, - params: BenefitUpdateParams | null | undefined = {}, - options?: RequestOptions, - ): APIPromise { - const { entity_ids, ...body } = params ?? {}; - return this._client.post(path`/employer/benefits/${benefitID}`, { - query: { entity_ids }, - body, - ...options, - __security: { bearerAuth: true }, - }); + update(benefitID: string, params: BenefitUpdateParams | null | undefined = {}, options?: RequestOptions): APIPromise { + const { entity_ids, ...body } = params ?? {} + return this._client.post(path`/employer/benefits/${benefitID}`, { query: { entity_ids }, body, ...options, __security: { bearerAuth : true } }); } /** @@ -102,15 +66,8 @@ export class Benefits extends APIResource { * } * ``` */ - list( - query: BenefitListParams | null | undefined = {}, - options?: RequestOptions, - ): PagePromise { - return this._client.getAPIList('/employer/benefits', SinglePage, { - query, - ...options, - __security: { bearerAuth: true }, - }); + list(query: BenefitListParams | null | undefined = {}, options?: RequestOptions): PagePromise { + return this._client.getAPIList('/employer/benefits', SinglePage, { query, ...options, __security: { bearerAuth : true } }); } /** @@ -124,26 +81,16 @@ export class Benefits extends APIResource { * } * ``` */ - listSupportedBenefits( - query: BenefitListSupportedBenefitsParams | null | undefined = {}, - options?: RequestOptions, - ): PagePromise { - return this._client.getAPIList('/employer/benefits/meta', SinglePage, { - query, - ...options, - __security: { bearerAuth: true }, - }); + listSupportedBenefits(query: BenefitListSupportedBenefitsParams | null | undefined = {}, options?: RequestOptions): PagePromise { + return this._client.getAPIList('/employer/benefits/meta', SinglePage, { query, ...options, __security: { bearerAuth : true } }); } } -export type CompanyBenefitsSinglePage = SinglePage; +export type CompanyBenefitsSinglePage = SinglePage -export type SupportedBenefitsSinglePage = SinglePage; +export type SupportedBenefitsSinglePage = SinglePage -export type BenefitContribution = - | BenefitContribution.UnionMember0 - | BenefitContribution.UnionMember1 - | BenefitContribution.UnionMember2; +export type BenefitContribution = BenefitContribution.UnionMember0 | BenefitContribution.UnionMember1 | BenefitContribution.UnionMember2 export namespace BenefitContribution { export interface UnionMember0 { @@ -201,32 +148,12 @@ export interface BenefitFeaturesAndOperations { /** * The frequency of the benefit deduction/contribution. */ -export type BenefitFrequency = 'every_paycheck' | 'monthly' | 'one_time' | null; +export type BenefitFrequency = 'every_paycheck' | 'monthly' | 'one_time' | null /** * Type of benefit. */ -export type BenefitType = - | '457' - | '401k' - | '401k_roth' - | '401k_loan' - | '403b' - | '403b_roth' - | '457_roth' - | 'commuter' - | 'custom_post_tax' - | 'custom_pre_tax' - | 'fsa_dependent_care' - | 'fsa_medical' - | 'hsa_post' - | 'hsa_pre' - | 's125_dental' - | 's125_medical' - | 's125_vision' - | 'simple' - | 'simple_ira' - | null; +export type BenefitType = '457' | '401k' | '401k_roth' | '401k_loan' | '403b' | '403b_roth' | '457_roth' | 'commuter' | 'custom_post_tax' | 'custom_pre_tax' | 'fsa_dependent_care' | 'fsa_medical' | 'hsa_post' | 'hsa_pre' | 's125_dental' | 's125_medical' | 's125_vision' | 'simple' | 'simple_ira' | null /** * Each benefit type and their supported features. If the benefit type is not @@ -257,7 +184,7 @@ export interface BenefitsSupport { simple_ira?: BenefitFeaturesAndOperations | null; - [k: string]: BenefitFeaturesAndOperations | null | undefined; +[k: string]: BenefitFeaturesAndOperations | null | undefined } export interface CompanyBenefit { @@ -368,7 +295,7 @@ export interface UpdateCompanyBenefitResponse { /** * @deprecated use `BenefitContribution` instead */ -export type BenfitContribution = BenefitContribution | null; +export type BenfitContribution = BenefitContribution | null export interface BenefitCreateParams { /** @@ -472,7 +399,7 @@ export declare namespace Benefits { type BenefitRetrieveParams as BenefitRetrieveParams, type BenefitUpdateParams as BenefitUpdateParams, type BenefitListParams as BenefitListParams, - type BenefitListSupportedBenefitsParams as BenefitListSupportedBenefitsParams, + type BenefitListSupportedBenefitsParams as BenefitListSupportedBenefitsParams }; export { @@ -485,6 +412,6 @@ export declare namespace Benefits { type IndividualEnrollManyParams as IndividualEnrollManyParams, type IndividualEnrolledIDsParams as IndividualEnrolledIDsParams, type IndividualRetrieveManyBenefitsParams as IndividualRetrieveManyBenefitsParams, - type IndividualUnenrollManyParams as IndividualUnenrollManyParams, + type IndividualUnenrollManyParams as IndividualUnenrollManyParams }; } diff --git a/src/resources/hris/benefits/index.ts b/src/resources/hris/benefits/index.ts index b754e6cb..057dbab3 100644 --- a/src/resources/hris/benefits/index.ts +++ b/src/resources/hris/benefits/index.ts @@ -1,35 +1,4 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -export { - Benefits, - type BenefitContribution, - type BenefitFeaturesAndOperations, - type BenefitFrequency, - type BenefitType, - type BenefitsSupport, - type CompanyBenefit, - type CreateCompanyBenefitsResponse, - type SupportPerBenefitType, - type SupportedBenefit, - type UpdateCompanyBenefitResponse, - type BenfitContribution, - type BenefitCreateParams, - type BenefitRetrieveParams, - type BenefitUpdateParams, - type BenefitListParams, - type BenefitListSupportedBenefitsParams, - type CompanyBenefitsSinglePage, - type SupportedBenefitsSinglePage, -} from './benefits'; -export { - Individuals, - type EnrolledIndividualBenefitResponse, - type IndividualBenefit, - type UnenrolledIndividualBenefitResponse, - type IndividualEnrolledIDsResponse, - type IndividualEnrollManyParams, - type IndividualEnrolledIDsParams, - type IndividualRetrieveManyBenefitsParams, - type IndividualUnenrollManyParams, - type IndividualBenefitsSinglePage, -} from './individuals'; +export { Benefits, type BenefitContribution, type BenefitFeaturesAndOperations, type BenefitFrequency, type BenefitType, type BenefitsSupport, type CompanyBenefit, type CreateCompanyBenefitsResponse, type SupportPerBenefitType, type SupportedBenefit, type UpdateCompanyBenefitResponse, type BenfitContribution, type BenefitCreateParams, type BenefitRetrieveParams, type BenefitUpdateParams, type BenefitListParams, type BenefitListSupportedBenefitsParams, type CompanyBenefitsSinglePage, type SupportedBenefitsSinglePage } from './benefits';; +export { Individuals, type EnrolledIndividualBenefitResponse, type IndividualBenefit, type UnenrolledIndividualBenefitResponse, type IndividualEnrolledIDsResponse, type IndividualEnrollManyParams, type IndividualEnrolledIDsParams, type IndividualRetrieveManyBenefitsParams, type IndividualUnenrollManyParams, type IndividualBenefitsSinglePage } from './individuals';; diff --git a/src/resources/hris/benefits/individuals.ts b/src/resources/hris/benefits/individuals.ts index c747d92b..7b69eb1e 100644 --- a/src/resources/hris/benefits/individuals.ts +++ b/src/resources/hris/benefits/individuals.ts @@ -21,18 +21,9 @@ export class Individuals extends APIResource { * ); * ``` */ - enrollMany( - benefitID: string, - params: IndividualEnrollManyParams | null | undefined = undefined, - options?: RequestOptions, - ): APIPromise { - const { entity_ids, individuals } = params ?? {}; - return this._client.post(path`/employer/benefits/${benefitID}/individuals`, { - query: { entity_ids }, - body: individuals, - ...options, - __security: { bearerAuth: true }, - }); + enrollMany(benefitID: string, params: IndividualEnrollManyParams | null | undefined = undefined, options?: RequestOptions): APIPromise { + const { entity_ids, individuals } = params ?? {} + return this._client.post(path`/employer/benefits/${benefitID}/individuals`, { query: { entity_ids }, body: individuals, ...options, __security: { bearerAuth : true } }); } /** @@ -46,16 +37,8 @@ export class Individuals extends APIResource { * ); * ``` */ - enrolledIDs( - benefitID: string, - query: IndividualEnrolledIDsParams | null | undefined = {}, - options?: RequestOptions, - ): APIPromise { - return this._client.get(path`/employer/benefits/${benefitID}/enrolled`, { - query, - ...options, - __security: { bearerAuth: true }, - }); + enrolledIDs(benefitID: string, query: IndividualEnrolledIDsParams | null | undefined = {}, options?: RequestOptions): APIPromise { + return this._client.get(path`/employer/benefits/${benefitID}/enrolled`, { query, ...options, __security: { bearerAuth : true } }); } /** @@ -71,16 +54,8 @@ export class Individuals extends APIResource { * } * ``` */ - retrieveManyBenefits( - benefitID: string, - query: IndividualRetrieveManyBenefitsParams | null | undefined = {}, - options?: RequestOptions, - ): PagePromise { - return this._client.getAPIList( - path`/employer/benefits/${benefitID}/individuals`, - SinglePage, - { query, ...options, __security: { bearerAuth: true } }, - ); + retrieveManyBenefits(benefitID: string, query: IndividualRetrieveManyBenefitsParams | null | undefined = {}, options?: RequestOptions): PagePromise { + return this._client.getAPIList(path`/employer/benefits/${benefitID}/individuals`, SinglePage, { query, ...options, __security: { bearerAuth : true } }); } /** @@ -94,22 +69,13 @@ export class Individuals extends APIResource { * ); * ``` */ - unenrollMany( - benefitID: string, - params: IndividualUnenrollManyParams | null | undefined = {}, - options?: RequestOptions, - ): APIPromise { - const { entity_ids, ...body } = params ?? {}; - return this._client.delete(path`/employer/benefits/${benefitID}/individuals`, { - query: { entity_ids }, - body, - ...options, - __security: { bearerAuth: true }, - }); + unenrollMany(benefitID: string, params: IndividualUnenrollManyParams | null | undefined = {}, options?: RequestOptions): APIPromise { + const { entity_ids, ...body } = params ?? {} + return this._client.delete(path`/employer/benefits/${benefitID}/individuals`, { query: { entity_ids }, body, ...options, __security: { bearerAuth : true } }); } } -export type IndividualBenefitsSinglePage = SinglePage; +export type IndividualBenefitsSinglePage = SinglePage export interface EnrolledIndividualBenefitResponse { job_id: string; @@ -141,11 +107,7 @@ export namespace IndividualBenefit { * percentage-based contributions (in basis points where 100 = 1%), or tiered * matching structures. */ - company_contribution: - | UnionMember0.UnionMember0 - | UnionMember0.UnionMember1 - | UnionMember0.UnionMember2 - | null; + company_contribution: UnionMember0.UnionMember0 | UnionMember0.UnionMember1 | UnionMember0.UnionMember2 | null; /** * Employee deduction configuration. Supports both fixed amounts (in cents) and @@ -399,6 +361,6 @@ export declare namespace Individuals { type IndividualEnrollManyParams as IndividualEnrollManyParams, type IndividualEnrolledIDsParams as IndividualEnrolledIDsParams, type IndividualRetrieveManyBenefitsParams as IndividualRetrieveManyBenefitsParams, - type IndividualUnenrollManyParams as IndividualUnenrollManyParams, + type IndividualUnenrollManyParams as IndividualUnenrollManyParams }; } diff --git a/src/resources/hris/company/company.ts b/src/resources/hris/company/company.ts index bec6a702..34c16763 100644 --- a/src/resources/hris/company/company.ts +++ b/src/resources/hris/company/company.ts @@ -3,19 +3,12 @@ import { APIResource } from '../../../core/resource'; import * as HRISAPI from '../hris'; import * as PayStatementItemAPI from './pay-statement-item/pay-statement-item'; -import { - PayStatementItem, - PayStatementItemListParams, - PayStatementItemListResponse, - PayStatementItemListResponsesPage, -} from './pay-statement-item/pay-statement-item'; +import { PayStatementItem, PayStatementItemListParams, PayStatementItemListResponse, PayStatementItemListResponsesPage } from './pay-statement-item/pay-statement-item'; import { APIPromise } from '../../../core/api-promise'; import { RequestOptions } from '../../../internal/request-options'; export class CompanyResource extends APIResource { - payStatementItem: PayStatementItemAPI.PayStatementItem = new PayStatementItemAPI.PayStatementItem( - this._client, - ); + payStatementItem: PayStatementItemAPI.PayStatementItem = new PayStatementItemAPI.PayStatementItem(this._client); /** * Read basic company data @@ -25,11 +18,8 @@ export class CompanyResource extends APIResource { * const company = await client.hris.company.retrieve(); * ``` */ - retrieve( - query: CompanyRetrieveParams | null | undefined = {}, - options?: RequestOptions, - ): APIPromise { - return this._client.get('/employer/company', { query, ...options, __security: { bearerAuth: true } }); + retrieve(query: CompanyRetrieveParams | null | undefined = {}, options?: RequestOptions): APIPromise { + return this._client.get('/employer/company', { query, ...options, __security: { bearerAuth : true } }); } } @@ -143,15 +133,7 @@ export namespace Company { /** * The tax payer type of the company. */ - type: - | 'llc' - | 'lp' - | 'corporation' - | 'sole_proprietor' - | 'non_profit' - | 'partnership' - | 'cooperative' - | null; + type: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative' | null; } } @@ -165,12 +147,15 @@ export interface CompanyRetrieveParams { CompanyResource.PayStatementItem = PayStatementItem; export declare namespace CompanyResource { - export { type Company as Company, type CompanyRetrieveParams as CompanyRetrieveParams }; + export { + type Company as Company, + type CompanyRetrieveParams as CompanyRetrieveParams + }; export { PayStatementItem as PayStatementItem, type PayStatementItemListResponse as PayStatementItemListResponse, type PayStatementItemListResponsesPage as PayStatementItemListResponsesPage, - type PayStatementItemListParams as PayStatementItemListParams, + type PayStatementItemListParams as PayStatementItemListParams }; } diff --git a/src/resources/hris/company/index.ts b/src/resources/hris/company/index.ts index 94a550df..757f7186 100644 --- a/src/resources/hris/company/index.ts +++ b/src/resources/hris/company/index.ts @@ -1,9 +1,4 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -export { CompanyResource, type Company, type CompanyRetrieveParams } from './company'; -export { - PayStatementItem, - type PayStatementItemListResponse, - type PayStatementItemListParams, - type PayStatementItemListResponsesPage, -} from './pay-statement-item/index'; +export { CompanyResource, type Company, type CompanyRetrieveParams } from './company';; +export { PayStatementItem, type PayStatementItemListResponse, type PayStatementItemListParams, type PayStatementItemListResponsesPage } from './pay-statement-item/index';; diff --git a/src/resources/hris/company/pay-statement-item/index.ts b/src/resources/hris/company/pay-statement-item/index.ts index e0aab289..affe5b48 100644 --- a/src/resources/hris/company/pay-statement-item/index.ts +++ b/src/resources/hris/company/pay-statement-item/index.ts @@ -1,20 +1,4 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -export { - PayStatementItem, - type PayStatementItemListResponse, - type PayStatementItemListParams, - type PayStatementItemListResponsesPage, -} from './pay-statement-item'; -export { - Rules, - type RuleCreateResponse, - type RuleUpdateResponse, - type RuleListResponse, - type RuleDeleteResponse, - type RuleCreateParams, - type RuleUpdateParams, - type RuleListParams, - type RuleDeleteParams, - type RuleListResponsesPage, -} from './rules'; +export { PayStatementItem, type PayStatementItemListResponse, type PayStatementItemListParams, type PayStatementItemListResponsesPage } from './pay-statement-item';; +export { Rules, type RuleCreateResponse, type RuleUpdateResponse, type RuleListResponse, type RuleDeleteResponse, type RuleCreateParams, type RuleUpdateParams, type RuleListParams, type RuleDeleteParams, type RuleListResponsesPage } from './rules';; diff --git a/src/resources/hris/company/pay-statement-item/pay-statement-item.ts b/src/resources/hris/company/pay-statement-item/pay-statement-item.ts index 82c251bd..7de4e0c8 100644 --- a/src/resources/hris/company/pay-statement-item/pay-statement-item.ts +++ b/src/resources/hris/company/pay-statement-item/pay-statement-item.ts @@ -2,18 +2,7 @@ import { APIResource } from '../../../../core/resource'; import * as RulesAPI from './rules'; -import { - RuleCreateParams, - RuleCreateResponse, - RuleDeleteParams, - RuleDeleteResponse, - RuleListParams, - RuleListResponse, - RuleListResponsesPage, - RuleUpdateParams, - RuleUpdateResponse, - Rules, -} from './rules'; +import { RuleCreateParams, RuleCreateResponse, RuleDeleteParams, RuleDeleteResponse, RuleListParams, RuleListResponse, RuleListResponsesPage, RuleUpdateParams, RuleUpdateResponse, Rules } from './rules'; import { PagePromise, ResponsesPage } from '../../../../core/pagination'; import { RequestOptions } from '../../../../internal/request-options'; @@ -32,19 +21,12 @@ export class PayStatementItem extends APIResource { * } * ``` */ - list( - query: PayStatementItemListParams | null | undefined = {}, - options?: RequestOptions, - ): PagePromise { - return this._client.getAPIList( - '/employer/pay-statement-item', - ResponsesPage, - { query, ...options, __security: { bearerAuth: true } }, - ); + list(query: PayStatementItemListParams | null | undefined = {}, options?: RequestOptions): PagePromise { + return this._client.getAPIList('/employer/pay-statement-item', ResponsesPage, { query, ...options, __security: { bearerAuth : true } }); } } -export type PayStatementItemListResponsesPage = ResponsesPage; +export type PayStatementItemListResponsesPage = ResponsesPage export interface PayStatementItemListResponse { /** @@ -134,7 +116,7 @@ export declare namespace PayStatementItem { export { type PayStatementItemListResponse as PayStatementItemListResponse, type PayStatementItemListResponsesPage as PayStatementItemListResponsesPage, - type PayStatementItemListParams as PayStatementItemListParams, + type PayStatementItemListParams as PayStatementItemListParams }; export { @@ -147,6 +129,6 @@ export declare namespace PayStatementItem { type RuleCreateParams as RuleCreateParams, type RuleUpdateParams as RuleUpdateParams, type RuleListParams as RuleListParams, - type RuleDeleteParams as RuleDeleteParams, + type RuleDeleteParams as RuleDeleteParams }; } diff --git a/src/resources/hris/company/pay-statement-item/rules.ts b/src/resources/hris/company/pay-statement-item/rules.ts index ed9f9616..47fe9034 100644 --- a/src/resources/hris/company/pay-statement-item/rules.ts +++ b/src/resources/hris/company/pay-statement-item/rules.ts @@ -19,17 +19,9 @@ export class Rules extends APIResource { * await client.hris.company.payStatementItem.rules.create(); * ``` */ - create( - params: RuleCreateParams | null | undefined = {}, - options?: RequestOptions, - ): APIPromise { - const { entity_ids, ...body } = params ?? {}; - return this._client.post('/employer/pay-statement-item/rule', { - query: { entity_ids }, - body, - ...options, - __security: { bearerAuth: true }, - }); + create(params: RuleCreateParams | null | undefined = {}, options?: RequestOptions): APIPromise { + const { entity_ids, ...body } = params ?? {} + return this._client.post('/employer/pay-statement-item/rule', { query: { entity_ids }, body, ...options, __security: { bearerAuth : true } }); } /** @@ -43,18 +35,9 @@ export class Rules extends APIResource { * ); * ``` */ - update( - ruleID: string, - params: RuleUpdateParams | null | undefined = {}, - options?: RequestOptions, - ): APIPromise { - const { entity_ids, ...body } = params ?? {}; - return this._client.put(path`/employer/pay-statement-item/rule/${ruleID}`, { - query: { entity_ids }, - body, - ...options, - __security: { bearerAuth: true }, - }); + update(ruleID: string, params: RuleUpdateParams | null | undefined = {}, options?: RequestOptions): APIPromise { + const { entity_ids, ...body } = params ?? {} + return this._client.put(path`/employer/pay-statement-item/rule/${ruleID}`, { query: { entity_ids }, body, ...options, __security: { bearerAuth : true } }); } /** @@ -68,15 +51,8 @@ export class Rules extends APIResource { * } * ``` */ - list( - query: RuleListParams | null | undefined = {}, - options?: RequestOptions, - ): PagePromise { - return this._client.getAPIList('/employer/pay-statement-item/rule', ResponsesPage, { - query, - ...options, - __security: { bearerAuth: true }, - }); + list(query: RuleListParams | null | undefined = {}, options?: RequestOptions): PagePromise { + return this._client.getAPIList('/employer/pay-statement-item/rule', ResponsesPage, { query, ...options, __security: { bearerAuth : true } }); } /** @@ -90,21 +66,13 @@ export class Rules extends APIResource { * ); * ``` */ - delete( - ruleID: string, - params: RuleDeleteParams | null | undefined = {}, - options?: RequestOptions, - ): APIPromise { - const { entity_ids } = params ?? {}; - return this._client.delete(path`/employer/pay-statement-item/rule/${ruleID}`, { - query: { entity_ids }, - ...options, - __security: { bearerAuth: true }, - }); + delete(ruleID: string, params: RuleDeleteParams | null | undefined = {}, options?: RequestOptions): APIPromise { + const { entity_ids } = params ?? {} + return this._client.delete(path`/employer/pay-statement-item/rule/${ruleID}`, { query: { entity_ids }, ...options, __security: { bearerAuth : true } }); } } -export type RuleListResponsesPage = ResponsesPage; +export type RuleListResponsesPage = ResponsesPage export interface RuleCreateResponse { /** @@ -506,6 +474,6 @@ export declare namespace Rules { type RuleCreateParams as RuleCreateParams, type RuleUpdateParams as RuleUpdateParams, type RuleListParams as RuleListParams, - type RuleDeleteParams as RuleDeleteParams, + type RuleDeleteParams as RuleDeleteParams }; } diff --git a/src/resources/hris/directory.ts b/src/resources/hris/directory.ts index 8329707f..8e24ba13 100644 --- a/src/resources/hris/directory.ts +++ b/src/resources/hris/directory.ts @@ -16,21 +16,14 @@ export class Directory extends APIResource { * } * ``` */ - list( - query: DirectoryListParams | null | undefined = {}, - options?: RequestOptions, - ): PagePromise { - return this._client.getAPIList('/employer/directory', IndividualsPage, { - query, - ...options, - __security: { bearerAuth: true }, - }); + list(query: DirectoryListParams | null | undefined = {}, options?: RequestOptions): PagePromise { + return this._client.getAPIList('/employer/directory', IndividualsPage, { query, ...options, __security: { bearerAuth : true } }); } /** * @deprecated use `list` instead */ - listIndividuals = this.list; + listIndividuals = this.list } export interface IndividualInDirectory { @@ -120,6 +113,6 @@ export declare namespace Directory { export { type IndividualInDirectory as IndividualInDirectory, type DirectoryListParams as DirectoryListParams, - type DirectoryListIndividualsParams as DirectoryListIndividualsParams, + type DirectoryListIndividualsParams as DirectoryListIndividualsParams }; } diff --git a/src/resources/hris/documents.ts b/src/resources/hris/documents.ts index fe02baf2..49bde202 100644 --- a/src/resources/hris/documents.ts +++ b/src/resources/hris/documents.ts @@ -16,11 +16,8 @@ export class Documents extends APIResource { * const documents = await client.hris.documents.list(); * ``` */ - list( - query: DocumentListParams | null | undefined = {}, - options?: RequestOptions, - ): APIPromise { - return this._client.get('/employer/documents', { query, ...options, __security: { bearerAuth: true } }); + list(query: DocumentListParams | null | undefined = {}, options?: RequestOptions): APIPromise { + return this._client.get('/employer/documents', { query, ...options, __security: { bearerAuth : true } }); } /** @@ -34,16 +31,8 @@ export class Documents extends APIResource { * ); * ``` */ - retreive( - documentID: string, - query: DocumentRetreiveParams | null | undefined = {}, - options?: RequestOptions, - ): APIPromise { - return this._client.get(path`/employer/documents/${documentID}`, { - query, - ...options, - __security: { bearerAuth: true }, - }); + retreive(documentID: string, query: DocumentRetreiveParams | null | undefined = {}, options?: RequestOptions): APIPromise { + return this._client.get(path`/employer/documents/${documentID}`, { query, ...options, __security: { bearerAuth : true } }); } } @@ -179,11 +168,7 @@ export namespace W42020 { /** * The individual's filing status for tax purposes. */ - filing_status: - | 'head_of_household' - | 'married_filing_jointly_or_qualifying_surviving_spouse' - | 'single_or_married_filing_separately' - | null; + filing_status: 'head_of_household' | 'married_filing_jointly_or_qualifying_surviving_spouse' | 'single_or_married_filing_separately' | null; /** * The unique identifier for the individual associated with this document. @@ -212,7 +197,7 @@ export interface DocumentListResponse { * A 2020 version of the W-4 tax form containing information on an individual's * filing status, dependents, and withholding details. */ -export type DocumentRetreiveResponse = W42020 | W42005; +export type DocumentRetreiveResponse = W42020 | W42005 export interface DocumentListParams { /** @@ -258,6 +243,6 @@ export declare namespace Documents { type DocumentListResponse as DocumentListResponse, type DocumentRetreiveResponse as DocumentRetreiveResponse, type DocumentListParams as DocumentListParams, - type DocumentRetreiveParams as DocumentRetreiveParams, + type DocumentRetreiveParams as DocumentRetreiveParams }; } diff --git a/src/resources/hris/employments.ts b/src/resources/hris/employments.ts index 8d985e1d..94dbef2e 100644 --- a/src/resources/hris/employments.ts +++ b/src/resources/hris/employments.ts @@ -19,24 +19,15 @@ export class Employments extends APIResource { * } * ``` */ - retrieveMany( - params: EmploymentRetrieveManyParams, - options?: RequestOptions, - ): PagePromise { - const { entity_ids, ...body } = params; - return this._client.getAPIList('/employer/employment', ResponsesPage, { - query: { entity_ids }, - body, - method: 'post', - ...options, - __security: { bearerAuth: true }, - }); + retrieveMany(params: EmploymentRetrieveManyParams, options?: RequestOptions): PagePromise { + const { entity_ids, ...body } = params + return this._client.getAPIList('/employer/employment', ResponsesPage, { query: { entity_ids }, body, method: 'post', ...options, __security: { bearerAuth : true } }); } } -export type EmploymentDataResponsesPage = ResponsesPage; +export type EmploymentDataResponsesPage = ResponsesPage -export type EmploymentData = EmploymentData.UnionMember0 | EmploymentData.BatchError; +export type EmploymentData = EmploymentData.UnionMember0 | EmploymentData.BatchError export namespace EmploymentData { export interface UnionMember0 { @@ -63,15 +54,7 @@ export namespace EmploymentData { /** * The detailed employment status of the individual. */ - employment_status: - | 'active' - | 'deceased' - | 'leave' - | 'onboarding' - | 'prehire' - | 'retired' - | 'terminated' - | null; + employment_status: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated' | null; end_date: string | null; @@ -241,6 +224,6 @@ export declare namespace Employments { type EmploymentData as EmploymentData, type EmploymentDataResponse as EmploymentDataResponse, type EmploymentDataResponsesPage as EmploymentDataResponsesPage, - type EmploymentRetrieveManyParams as EmploymentRetrieveManyParams, + type EmploymentRetrieveManyParams as EmploymentRetrieveManyParams }; } diff --git a/src/resources/hris/hris.ts b/src/resources/hris/hris.ts index 4ecf085c..d66b2899 100644 --- a/src/resources/hris/hris.ts +++ b/src/resources/hris/hris.ts @@ -2,73 +2,19 @@ import { APIResource } from '../../core/resource'; import * as DirectoryAPI from './directory'; -import { - Directory, - DirectoryListIndividualsParams, - DirectoryListParams, - IndividualInDirectory, -} from './directory'; +import { Directory, DirectoryListIndividualsParams, DirectoryListParams, IndividualInDirectory } from './directory'; import * as DocumentsAPI from './documents'; -import { - DocumentListParams, - DocumentListResponse, - DocumentResponse, - DocumentRetreiveParams, - DocumentRetreiveResponse, - Documents, - W42005, - W42020, -} from './documents'; +import { DocumentListParams, DocumentListResponse, DocumentResponse, DocumentRetreiveParams, DocumentRetreiveResponse, Documents, W42005, W42020 } from './documents'; import * as EmploymentsAPI from './employments'; -import { - EmploymentData, - EmploymentDataResponse, - EmploymentDataResponsesPage, - EmploymentRetrieveManyParams, - Employments, -} from './employments'; +import { EmploymentData, EmploymentDataResponse, EmploymentDataResponsesPage, EmploymentRetrieveManyParams, Employments } from './employments'; import * as IndividualsAPI from './individuals'; -import { - Individual, - IndividualResponse, - IndividualResponsesPage, - IndividualRetrieveManyParams, - Individuals, -} from './individuals'; +import { Individual, IndividualResponse, IndividualResponsesPage, IndividualRetrieveManyParams, Individuals } from './individuals'; import * as PayStatementsAPI from './pay-statements'; -import { - PayStatement, - PayStatementDataSyncInProgress, - PayStatementResponse, - PayStatementResponseBody, - PayStatementResponsesPage, - PayStatementRetrieveManyParams, - PayStatements, -} from './pay-statements'; +import { PayStatement, PayStatementDataSyncInProgress, PayStatementResponse, PayStatementResponseBody, PayStatementResponsesPage, PayStatementRetrieveManyParams, PayStatements } from './pay-statements'; import * as PaymentsAPI from './payments'; import { Payment, PaymentListParams, Payments, PaymentsSinglePage } from './payments'; import * as BenefitsAPI from './benefits/benefits'; -import { - BenefitContribution, - BenefitCreateParams, - BenefitFeaturesAndOperations, - BenefitFrequency, - BenefitListParams, - BenefitListSupportedBenefitsParams, - BenefitRetrieveParams, - BenefitType, - BenefitUpdateParams, - Benefits, - BenefitsSupport, - BenfitContribution, - CompanyBenefit, - CompanyBenefitsSinglePage, - CreateCompanyBenefitsResponse, - SupportPerBenefitType, - SupportedBenefit, - SupportedBenefitsSinglePage, - UpdateCompanyBenefitResponse, -} from './benefits/benefits'; +import { BenefitContribution, BenefitCreateParams, BenefitFeaturesAndOperations, BenefitFrequency, BenefitListParams, BenefitListSupportedBenefitsParams, BenefitRetrieveParams, BenefitType, BenefitUpdateParams, Benefits, BenefitsSupport, BenfitContribution, CompanyBenefit, CompanyBenefitsSinglePage, CreateCompanyBenefitsResponse, SupportPerBenefitType, SupportedBenefit, SupportedBenefitsSinglePage, UpdateCompanyBenefitResponse } from './benefits/benefits'; import * as CompanyAPI from './company/company'; import { Company, CompanyResource, CompanyRetrieveParams } from './company/company'; @@ -108,17 +54,7 @@ export interface Income { * The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, * `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`. */ - unit: - | 'yearly' - | 'quarterly' - | 'monthly' - | 'semi_monthly' - | 'bi_weekly' - | 'weekly' - | 'daily' - | 'hourly' - | 'fixed' - | null; + unit: 'yearly' | 'quarterly' | 'monthly' | 'semi_monthly' | 'bi_weekly' | 'weekly' | 'daily' | 'hourly' | 'fixed' | null; } export interface Location { @@ -176,19 +112,23 @@ HRIS.Documents = Documents; HRIS.Benefits = Benefits; export declare namespace HRIS { - export { type Income as Income, type Location as Location, type Money as Money }; + export { + type Income as Income, + type Location as Location, + type Money as Money + }; export { CompanyResource as CompanyResource, type Company as Company, - type CompanyRetrieveParams as CompanyRetrieveParams, + type CompanyRetrieveParams as CompanyRetrieveParams }; export { Directory as Directory, type IndividualInDirectory as IndividualInDirectory, type DirectoryListParams as DirectoryListParams, - type DirectoryListIndividualsParams as DirectoryListIndividualsParams, + type DirectoryListIndividualsParams as DirectoryListIndividualsParams }; export { @@ -196,7 +136,7 @@ export declare namespace HRIS { type Individual as Individual, type IndividualResponse as IndividualResponse, type IndividualResponsesPage as IndividualResponsesPage, - type IndividualRetrieveManyParams as IndividualRetrieveManyParams, + type IndividualRetrieveManyParams as IndividualRetrieveManyParams }; export { @@ -204,14 +144,14 @@ export declare namespace HRIS { type EmploymentData as EmploymentData, type EmploymentDataResponse as EmploymentDataResponse, type EmploymentDataResponsesPage as EmploymentDataResponsesPage, - type EmploymentRetrieveManyParams as EmploymentRetrieveManyParams, + type EmploymentRetrieveManyParams as EmploymentRetrieveManyParams }; export { Payments as Payments, type Payment as Payment, type PaymentsSinglePage as PaymentsSinglePage, - type PaymentListParams as PaymentListParams, + type PaymentListParams as PaymentListParams }; export { @@ -221,7 +161,7 @@ export declare namespace HRIS { type PayStatementResponse as PayStatementResponse, type PayStatementResponseBody as PayStatementResponseBody, type PayStatementResponsesPage as PayStatementResponsesPage, - type PayStatementRetrieveManyParams as PayStatementRetrieveManyParams, + type PayStatementRetrieveManyParams as PayStatementRetrieveManyParams }; export { @@ -232,7 +172,7 @@ export declare namespace HRIS { type DocumentListResponse as DocumentListResponse, type DocumentRetreiveResponse as DocumentRetreiveResponse, type DocumentListParams as DocumentListParams, - type DocumentRetreiveParams as DocumentRetreiveParams, + type DocumentRetreiveParams as DocumentRetreiveParams }; export { @@ -254,6 +194,6 @@ export declare namespace HRIS { type BenefitRetrieveParams as BenefitRetrieveParams, type BenefitUpdateParams as BenefitUpdateParams, type BenefitListParams as BenefitListParams, - type BenefitListSupportedBenefitsParams as BenefitListSupportedBenefitsParams, + type BenefitListSupportedBenefitsParams as BenefitListSupportedBenefitsParams }; } diff --git a/src/resources/hris/index.ts b/src/resources/hris/index.ts index 391e5a6b..3d4196a9 100644 --- a/src/resources/hris/index.ts +++ b/src/resources/hris/index.ts @@ -1,65 +1,11 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -export { - Benefits, - type BenefitContribution, - type BenefitFeaturesAndOperations, - type BenefitFrequency, - type BenefitType, - type BenefitsSupport, - type CompanyBenefit, - type CreateCompanyBenefitsResponse, - type SupportPerBenefitType, - type SupportedBenefit, - type UpdateCompanyBenefitResponse, - type BenfitContribution, - type BenefitCreateParams, - type BenefitRetrieveParams, - type BenefitUpdateParams, - type BenefitListParams, - type BenefitListSupportedBenefitsParams, - type CompanyBenefitsSinglePage, - type SupportedBenefitsSinglePage, -} from './benefits/index'; -export { CompanyResource, type Company, type CompanyRetrieveParams } from './company/index'; -export { - Directory, - type IndividualInDirectory, - type DirectoryListParams, - type DirectoryListIndividualsParams, -} from './directory'; -export { - Documents, - type DocumentResponse, - type W42005, - type W42020, - type DocumentListResponse, - type DocumentRetreiveResponse, - type DocumentListParams, - type DocumentRetreiveParams, -} from './documents'; -export { - Employments, - type EmploymentData, - type EmploymentDataResponse, - type EmploymentRetrieveManyParams, - type EmploymentDataResponsesPage, -} from './employments'; -export { HRIS, type Income, type Location, type Money } from './hris'; -export { - Individuals, - type Individual, - type IndividualResponse, - type IndividualRetrieveManyParams, - type IndividualResponsesPage, -} from './individuals'; -export { - PayStatements, - type PayStatement, - type PayStatementDataSyncInProgress, - type PayStatementResponse, - type PayStatementResponseBody, - type PayStatementRetrieveManyParams, - type PayStatementResponsesPage, -} from './pay-statements'; -export { Payments, type Payment, type PaymentListParams, type PaymentsSinglePage } from './payments'; +export { Benefits, type BenefitContribution, type BenefitFeaturesAndOperations, type BenefitFrequency, type BenefitType, type BenefitsSupport, type CompanyBenefit, type CreateCompanyBenefitsResponse, type SupportPerBenefitType, type SupportedBenefit, type UpdateCompanyBenefitResponse, type BenfitContribution, type BenefitCreateParams, type BenefitRetrieveParams, type BenefitUpdateParams, type BenefitListParams, type BenefitListSupportedBenefitsParams, type CompanyBenefitsSinglePage, type SupportedBenefitsSinglePage } from './benefits/index';; +export { CompanyResource, type Company, type CompanyRetrieveParams } from './company/index';; +export { Directory, type IndividualInDirectory, type DirectoryListParams, type DirectoryListIndividualsParams } from './directory';; +export { Documents, type DocumentResponse, type W42005, type W42020, type DocumentListResponse, type DocumentRetreiveResponse, type DocumentListParams, type DocumentRetreiveParams } from './documents';; +export { Employments, type EmploymentData, type EmploymentDataResponse, type EmploymentRetrieveManyParams, type EmploymentDataResponsesPage } from './employments';; +export { HRIS, type Income, type Location, type Money } from './hris';; +export { Individuals, type Individual, type IndividualResponse, type IndividualRetrieveManyParams, type IndividualResponsesPage } from './individuals';; +export { PayStatements, type PayStatement, type PayStatementDataSyncInProgress, type PayStatementResponse, type PayStatementResponseBody, type PayStatementRetrieveManyParams, type PayStatementResponsesPage } from './pay-statements';; +export { Payments, type Payment, type PaymentListParams, type PaymentsSinglePage } from './payments';; diff --git a/src/resources/hris/individuals.ts b/src/resources/hris/individuals.ts index 5f1c2ea7..ef06762c 100644 --- a/src/resources/hris/individuals.ts +++ b/src/resources/hris/individuals.ts @@ -17,24 +17,15 @@ export class Individuals extends APIResource { * } * ``` */ - retrieveMany( - params: IndividualRetrieveManyParams | null | undefined = {}, - options?: RequestOptions, - ): PagePromise { - const { entity_ids, ...body } = params ?? {}; - return this._client.getAPIList('/employer/individual', ResponsesPage, { - query: { entity_ids }, - body, - method: 'post', - ...options, - __security: { bearerAuth: true }, - }); + retrieveMany(params: IndividualRetrieveManyParams | null | undefined = {}, options?: RequestOptions): PagePromise { + const { entity_ids, ...body } = params ?? {} + return this._client.getAPIList('/employer/individual', ResponsesPage, { query: { entity_ids }, body, method: 'post', ...options, __security: { bearerAuth : true } }); } } -export type IndividualResponsesPage = ResponsesPage; +export type IndividualResponsesPage = ResponsesPage -export type Individual = Individual.UnionMember0 | Individual.BatchError; +export type Individual = Individual.UnionMember0 | Individual.BatchError export namespace Individual { export interface UnionMember0 { @@ -48,16 +39,7 @@ export namespace Individual { /** * The EEOC-defined ethnicity of the individual. */ - ethnicity: - | 'asian' - | 'white' - | 'black_or_african_american' - | 'native_hawaiian_or_pacific_islander' - | 'american_indian_or_alaska_native' - | 'hispanic_or_latino' - | 'two_or_more_races' - | 'decline_to_specify' - | null; + ethnicity: 'asian' | 'white' | 'black_or_african_american' | 'native_hawaiian_or_pacific_islander' | 'american_indian_or_alaska_native' | 'hispanic_or_latino' | 'two_or_more_races' | 'decline_to_specify' | null; /** * The legal first name of the individual. @@ -171,6 +153,6 @@ export declare namespace Individuals { type Individual as Individual, type IndividualResponse as IndividualResponse, type IndividualResponsesPage as IndividualResponsesPage, - type IndividualRetrieveManyParams as IndividualRetrieveManyParams, + type IndividualRetrieveManyParams as IndividualRetrieveManyParams }; } diff --git a/src/resources/hris/pay-statements.ts b/src/resources/hris/pay-statements.ts index c256c1f9..6bcb0c42 100644 --- a/src/resources/hris/pay-statements.ts +++ b/src/resources/hris/pay-statements.ts @@ -29,22 +29,13 @@ export class PayStatements extends APIResource { * } * ``` */ - retrieveMany( - params: PayStatementRetrieveManyParams, - options?: RequestOptions, - ): PagePromise { - const { entity_ids, ...body } = params; - return this._client.getAPIList('/employer/pay-statement', ResponsesPage, { - query: { entity_ids }, - body, - method: 'post', - ...options, - __security: { bearerAuth: true }, - }); + retrieveMany(params: PayStatementRetrieveManyParams, options?: RequestOptions): PagePromise { + const { entity_ids, ...body } = params + return this._client.getAPIList('/employer/pay-statement', ResponsesPage, { query: { entity_ids }, body, method: 'post', ...options, __security: { bearerAuth : true } }); } } -export type PayStatementResponsesPage = ResponsesPage; +export type PayStatementResponsesPage = ResponsesPage export interface PayStatement { /** @@ -115,21 +106,7 @@ export namespace PayStatement { /** * The type of earning. */ - type: - | 'salary' - | 'wage' - | 'reimbursement' - | 'overtime' - | 'severance' - | 'double_overtime' - | 'pto' - | 'sick' - | 'bonus' - | 'commission' - | 'tips' - | '1099' - | 'other' - | null; + type: 'salary' | 'wage' | 'reimbursement' | 'overtime' | 'severance' | 'double_overtime' | 'pto' | 'sick' | 'bonus' | 'commission' | 'tips' | '1099' | 'other' | null; attributes?: Earning.Attributes | null; } @@ -349,6 +326,6 @@ export declare namespace PayStatements { type PayStatementResponse as PayStatementResponse, type PayStatementResponseBody as PayStatementResponseBody, type PayStatementResponsesPage as PayStatementResponsesPage, - type PayStatementRetrieveManyParams as PayStatementRetrieveManyParams, + type PayStatementRetrieveManyParams as PayStatementRetrieveManyParams }; } diff --git a/src/resources/hris/payments.ts b/src/resources/hris/payments.ts index e1f5fec2..cf9f0f1d 100644 --- a/src/resources/hris/payments.ts +++ b/src/resources/hris/payments.ts @@ -21,15 +21,11 @@ export class Payments extends APIResource { * ``` */ list(query: PaymentListParams, options?: RequestOptions): PagePromise { - return this._client.getAPIList('/employer/payment', SinglePage, { - query, - ...options, - __security: { bearerAuth: true }, - }); + return this._client.getAPIList('/employer/payment', SinglePage, { query, ...options, __security: { bearerAuth : true } }); } } -export type PaymentsSinglePage = SinglePage; +export type PaymentsSinglePage = SinglePage export interface Payment { /** @@ -59,17 +55,7 @@ export interface Payment { /** * List of pay frequencies associated with this payment. */ - pay_frequencies: Array< - | 'annually' - | 'bi_weekly' - | 'daily' - | 'monthly' - | 'other' - | 'quarterly' - | 'semi_annually' - | 'semi_monthly' - | 'weekly' - > | null; + pay_frequencies: Array<'annually' | 'bi_weekly' | 'daily' | 'monthly' | 'other' | 'quarterly' | 'semi_annually' | 'semi_monthly' | 'weekly'> | null; /** * Array of the Finch id (uuidv4) of every pay group associated with this payment. @@ -116,6 +102,6 @@ export declare namespace Payments { export { type Payment as Payment, type PaymentsSinglePage as PaymentsSinglePage, - type PaymentListParams as PaymentListParams, + type PaymentListParams as PaymentListParams }; } diff --git a/src/resources/index.ts b/src/resources/index.ts index ff93bb94..ee56086b 100644 --- a/src/resources/index.ts +++ b/src/resources/index.ts @@ -1,34 +1,13 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -export * from './shared'; -export { AccessTokens, type CreateAccessTokenResponse, type AccessTokenCreateParams } from './access-tokens'; -export { Account, type DisconnectResponse, type Introspection } from './account'; -export { Connect } from './connect/connect'; -export { HRIS, type Income, type Location, type Money } from './hris/hris'; -export { Jobs } from './jobs/jobs'; -export { Payroll } from './payroll/payroll'; -export { - Providers, - type Provider, - type ProviderListResponse, - type ProviderListResponsesSinglePage, -} from './providers'; -export { - RequestForwarding, - type RequestForwardingForwardResponse, - type RequestForwardingForwardParams, -} from './request-forwarding'; -export { Sandbox } from './sandbox/sandbox'; -export { - Webhooks, - type AccountUpdateEvent, - type BaseWebhookEvent, - type CompanyEvent, - type DirectoryEvent, - type EmploymentEvent, - type IndividualEvent, - type JobCompletionEvent, - type PayStatementEvent, - type PaymentEvent, - type WebhookEvent, -} from './webhooks'; +export * from './shared';; +export { AccessTokens, type CreateAccessTokenResponse, type AccessTokenCreateParams } from './access-tokens';; +export { Account, type DisconnectResponse, type Introspection } from './account';; +export { Connect } from './connect/connect';; +export { HRIS, type Income, type Location, type Money } from './hris/hris';; +export { Jobs } from './jobs/jobs';; +export { Payroll } from './payroll/payroll';; +export { Providers, type Provider, type ProviderListResponse, type ProviderListResponsesSinglePage } from './providers';; +export { RequestForwarding, type RequestForwardingForwardResponse, type RequestForwardingForwardParams } from './request-forwarding';; +export { Sandbox } from './sandbox/sandbox';; +export { Webhooks, type AccountUpdateEvent, type BaseWebhookEvent, type CompanyEvent, type DirectoryEvent, type EmploymentEvent, type IndividualEvent, type JobCompletionEvent, type PayStatementEvent, type PaymentEvent, type WebhookEvent } from './webhooks';; diff --git a/src/resources/jobs/automated.ts b/src/resources/jobs/automated.ts index 534810c5..0a9d32a5 100644 --- a/src/resources/jobs/automated.ts +++ b/src/resources/jobs/automated.ts @@ -23,14 +23,14 @@ export class Automated extends APIResource { * access to this endpoint, please contact your Finch account manager. */ create(body: AutomatedCreateParams, options?: RequestOptions): APIPromise { - return this._client.post('/jobs/automated', { body, ...options, __security: { bearerAuth: true } }); + return this._client.post('/jobs/automated', { body, ...options, __security: { bearerAuth : true } }); } /** * Get an automated job by `job_id`. */ retrieve(jobID: string, options?: RequestOptions): APIPromise { - return this._client.get(path`/jobs/automated/${jobID}`, { ...options, __security: { bearerAuth: true } }); + return this._client.get(path`/jobs/automated/${jobID}`, { ...options, __security: { bearerAuth : true } }); } /** @@ -38,11 +38,8 @@ export class Automated extends APIResource { * jobs are sorted in descending order by submission time. For scheduled jobs such * as data syncs, only the next scheduled job is shown. */ - list( - query: AutomatedListParams | null | undefined = {}, - options?: RequestOptions, - ): APIPromise { - return this._client.get('/jobs/automated', { query, ...options, __security: { bearerAuth: true } }); + list(query: AutomatedListParams | null | undefined = {}, options?: RequestOptions): APIPromise { + return this._client.get('/jobs/automated', { query, ...options, __security: { bearerAuth : true } }); } } @@ -171,9 +168,7 @@ export namespace AutomatedListResponse { } } -export type AutomatedCreateParams = - | AutomatedCreateParams.DataSyncAll - | AutomatedCreateParams.W4FormEmployeeSync; +export type AutomatedCreateParams = AutomatedCreateParams.DataSyncAll | AutomatedCreateParams.W4FormEmployeeSync export declare namespace AutomatedCreateParams { export interface DataSyncAll { @@ -220,6 +215,6 @@ export declare namespace Automated { type AutomatedCreateResponse as AutomatedCreateResponse, type AutomatedListResponse as AutomatedListResponse, type AutomatedCreateParams as AutomatedCreateParams, - type AutomatedListParams as AutomatedListParams, + type AutomatedListParams as AutomatedListParams }; } diff --git a/src/resources/jobs/index.ts b/src/resources/jobs/index.ts index fc96a5e7..88ecc2dd 100644 --- a/src/resources/jobs/index.ts +++ b/src/resources/jobs/index.ts @@ -1,12 +1,5 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -export { - Automated, - type AutomatedAsyncJob, - type AutomatedCreateResponse, - type AutomatedListResponse, - type AutomatedCreateParams, - type AutomatedListParams, -} from './automated'; -export { Jobs } from './jobs'; -export { Manual, type ManualAsyncJob } from './manual'; +export { Automated, type AutomatedAsyncJob, type AutomatedCreateResponse, type AutomatedListResponse, type AutomatedCreateParams, type AutomatedListParams } from './automated';; +export { Jobs } from './jobs';; +export { Manual, type ManualAsyncJob } from './manual';; diff --git a/src/resources/jobs/jobs.ts b/src/resources/jobs/jobs.ts index 4daaed61..4a61a5a5 100644 --- a/src/resources/jobs/jobs.ts +++ b/src/resources/jobs/jobs.ts @@ -2,14 +2,7 @@ import { APIResource } from '../../core/resource'; import * as AutomatedAPI from './automated'; -import { - Automated, - AutomatedAsyncJob, - AutomatedCreateParams, - AutomatedCreateResponse, - AutomatedListParams, - AutomatedListResponse, -} from './automated'; +import { Automated, AutomatedAsyncJob, AutomatedCreateParams, AutomatedCreateResponse, AutomatedListParams, AutomatedListResponse } from './automated'; import * as ManualAPI from './manual'; import { Manual, ManualAsyncJob } from './manual'; @@ -28,8 +21,11 @@ export declare namespace Jobs { type AutomatedCreateResponse as AutomatedCreateResponse, type AutomatedListResponse as AutomatedListResponse, type AutomatedCreateParams as AutomatedCreateParams, - type AutomatedListParams as AutomatedListParams, + type AutomatedListParams as AutomatedListParams }; - export { Manual as Manual, type ManualAsyncJob as ManualAsyncJob }; + export { + Manual as Manual, + type ManualAsyncJob as ManualAsyncJob + }; } diff --git a/src/resources/jobs/manual.ts b/src/resources/jobs/manual.ts index 7b3ac406..62120b9a 100644 --- a/src/resources/jobs/manual.ts +++ b/src/resources/jobs/manual.ts @@ -11,7 +11,7 @@ export class Manual extends APIResource { * jobs including those for both automated and assisted integrations. */ retrieve(jobID: string, options?: RequestOptions): APIPromise { - return this._client.get(path`/jobs/manual/${jobID}`, { ...options, __security: { bearerAuth: true } }); + return this._client.get(path`/jobs/manual/${jobID}`, { ...options, __security: { bearerAuth : true } }); } } @@ -27,5 +27,7 @@ export interface ManualAsyncJob { } export declare namespace Manual { - export { type ManualAsyncJob as ManualAsyncJob }; + export { + type ManualAsyncJob as ManualAsyncJob + }; } diff --git a/src/resources/payroll/index.ts b/src/resources/payroll/index.ts index 23896339..a3b2b637 100644 --- a/src/resources/payroll/index.ts +++ b/src/resources/payroll/index.ts @@ -1,11 +1,4 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -export { - PayGroups, - type PayGroupRetrieveResponse, - type PayGroupListResponse, - type PayGroupRetrieveParams, - type PayGroupListParams, - type PayGroupListResponsesSinglePage, -} from './pay-groups'; -export { Payroll } from './payroll'; +export { PayGroups, type PayGroupRetrieveResponse, type PayGroupListResponse, type PayGroupRetrieveParams, type PayGroupListParams, type PayGroupListResponsesSinglePage } from './pay-groups';; +export { Payroll } from './payroll';; diff --git a/src/resources/payroll/pay-groups.ts b/src/resources/payroll/pay-groups.ts index ca99eabc..7e833397 100644 --- a/src/resources/payroll/pay-groups.ts +++ b/src/resources/payroll/pay-groups.ts @@ -10,34 +10,19 @@ export class PayGroups extends APIResource { /** * Read information from a single pay group */ - retrieve( - payGroupID: string, - query: PayGroupRetrieveParams | null | undefined = {}, - options?: RequestOptions, - ): APIPromise { - return this._client.get(path`/employer/pay-groups/${payGroupID}`, { - query, - ...options, - __security: { bearerAuth: true }, - }); + retrieve(payGroupID: string, query: PayGroupRetrieveParams | null | undefined = {}, options?: RequestOptions): APIPromise { + return this._client.get(path`/employer/pay-groups/${payGroupID}`, { query, ...options, __security: { bearerAuth : true } }); } /** * Read company pay groups and frequencies */ - list( - query: PayGroupListParams | null | undefined = {}, - options?: RequestOptions, - ): PagePromise { - return this._client.getAPIList('/employer/pay-groups', SinglePage, { - query, - ...options, - __security: { bearerAuth: true }, - }); + list(query: PayGroupListParams | null | undefined = {}, options?: RequestOptions): PagePromise { + return this._client.getAPIList('/employer/pay-groups', SinglePage, { query, ...options, __security: { bearerAuth : true } }); } } -export type PayGroupListResponsesSinglePage = SinglePage; +export type PayGroupListResponsesSinglePage = SinglePage export interface PayGroupRetrieveResponse { /** @@ -55,17 +40,7 @@ export interface PayGroupRetrieveResponse { /** * List of pay frequencies associated with this pay group */ - pay_frequencies: Array< - | 'annually' - | 'bi_weekly' - | 'daily' - | 'monthly' - | 'other' - | 'quarterly' - | 'semi_annually' - | 'semi_monthly' - | 'weekly' - >; + pay_frequencies: Array<'annually' | 'bi_weekly' | 'daily' | 'monthly' | 'other' | 'quarterly' | 'semi_annually' | 'semi_monthly' | 'weekly'>; } export interface PayGroupListResponse { @@ -82,17 +57,7 @@ export interface PayGroupListResponse { /** * List of pay frequencies associated with this pay group */ - pay_frequencies: Array< - | 'annually' - | 'bi_weekly' - | 'daily' - | 'monthly' - | 'other' - | 'quarterly' - | 'semi_annually' - | 'semi_monthly' - | 'weekly' - >; + pay_frequencies: Array<'annually' | 'bi_weekly' | 'daily' | 'monthly' | 'other' | 'quarterly' | 'semi_annually' | 'semi_monthly' | 'weekly'>; } export interface PayGroupRetrieveParams { @@ -119,6 +84,6 @@ export declare namespace PayGroups { type PayGroupListResponse as PayGroupListResponse, type PayGroupListResponsesSinglePage as PayGroupListResponsesSinglePage, type PayGroupRetrieveParams as PayGroupRetrieveParams, - type PayGroupListParams as PayGroupListParams, + type PayGroupListParams as PayGroupListParams }; } diff --git a/src/resources/payroll/payroll.ts b/src/resources/payroll/payroll.ts index b7ebad3a..76caa341 100644 --- a/src/resources/payroll/payroll.ts +++ b/src/resources/payroll/payroll.ts @@ -2,14 +2,7 @@ import { APIResource } from '../../core/resource'; import * as PayGroupsAPI from './pay-groups'; -import { - PayGroupListParams, - PayGroupListResponse, - PayGroupListResponsesSinglePage, - PayGroupRetrieveParams, - PayGroupRetrieveResponse, - PayGroups, -} from './pay-groups'; +import { PayGroupListParams, PayGroupListResponse, PayGroupListResponsesSinglePage, PayGroupRetrieveParams, PayGroupRetrieveResponse, PayGroups } from './pay-groups'; export class Payroll extends APIResource { payGroups: PayGroupsAPI.PayGroups = new PayGroupsAPI.PayGroups(this._client); @@ -24,6 +17,6 @@ export declare namespace Payroll { type PayGroupListResponse as PayGroupListResponse, type PayGroupListResponsesSinglePage as PayGroupListResponsesSinglePage, type PayGroupRetrieveParams as PayGroupRetrieveParams, - type PayGroupListParams as PayGroupListParams, + type PayGroupListParams as PayGroupListParams }; } diff --git a/src/resources/providers.ts b/src/resources/providers.ts index 0b763a2c..7e3d5e17 100644 --- a/src/resources/providers.ts +++ b/src/resources/providers.ts @@ -9,14 +9,11 @@ export class Providers extends APIResource { * Return details on all available payroll and HR systems. */ list(options?: RequestOptions): PagePromise { - return this._client.getAPIList('/providers', SinglePage, { - ...options, - __security: { bearerAuth: true }, - }); + return this._client.getAPIList('/providers', SinglePage, { ...options, __security: { bearerAuth : true } }); } } -export type ProviderListResponsesSinglePage = SinglePage; +export type ProviderListResponsesSinglePage = SinglePage export interface Provider { /** @@ -168,6 +165,6 @@ export declare namespace Providers { export { type Provider as Provider, type ProviderListResponse as ProviderListResponse, - type ProviderListResponsesSinglePage as ProviderListResponsesSinglePage, + type ProviderListResponsesSinglePage as ProviderListResponsesSinglePage }; } diff --git a/src/resources/request-forwarding.ts b/src/resources/request-forwarding.ts index 83cb3eee..8d2ed36a 100644 --- a/src/resources/request-forwarding.ts +++ b/src/resources/request-forwarding.ts @@ -11,11 +11,8 @@ export class RequestForwarding extends APIResource { * Forward allows you to push or pull data models directly against an integration's * API. */ - forward( - body: RequestForwardingForwardParams, - options?: RequestOptions, - ): APIPromise { - return this._client.post('/forward', { body, ...options, __security: { bearerAuth: true } }); + forward(body: RequestForwardingForwardParams, options?: RequestOptions): APIPromise { + return this._client.post('/forward', { body, ...options, __security: { bearerAuth : true } }); } } @@ -117,6 +114,6 @@ export interface RequestForwardingForwardParams { export declare namespace RequestForwarding { export { type RequestForwardingForwardResponse as RequestForwardingForwardResponse, - type RequestForwardingForwardParams as RequestForwardingForwardParams, + type RequestForwardingForwardParams as RequestForwardingForwardParams }; } diff --git a/src/resources/sandbox/company.ts b/src/resources/sandbox/company.ts index 5e5b6abe..baee3fa3 100644 --- a/src/resources/sandbox/company.ts +++ b/src/resources/sandbox/company.ts @@ -33,7 +33,7 @@ export class Company extends APIResource { * ``` */ update(body: CompanyUpdateParams, options?: RequestOptions): APIPromise { - return this._client.put('/sandbox/company', { body, ...options, __security: { bearerAuth: true } }); + return this._client.put('/sandbox/company', { body, ...options, __security: { bearerAuth : true } }); } } @@ -142,15 +142,7 @@ export namespace CompanyUpdateResponse { /** * The tax payer type of the company. */ - type?: - | 'llc' - | 'lp' - | 'corporation' - | 'sole_proprietor' - | 'non_profit' - | 'partnership' - | 'cooperative' - | null; + type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative' | null; } } @@ -259,21 +251,13 @@ export namespace CompanyUpdateParams { /** * The tax payer type of the company. */ - type?: - | 'llc' - | 'lp' - | 'corporation' - | 'sole_proprietor' - | 'non_profit' - | 'partnership' - | 'cooperative' - | null; + type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative' | null; } } export declare namespace Company { export { type CompanyUpdateResponse as CompanyUpdateResponse, - type CompanyUpdateParams as CompanyUpdateParams, + type CompanyUpdateParams as CompanyUpdateParams }; } diff --git a/src/resources/sandbox/connections/accounts.ts b/src/resources/sandbox/connections/accounts.ts index 83d765d7..13bf1300 100644 --- a/src/resources/sandbox/connections/accounts.ts +++ b/src/resources/sandbox/connections/accounts.ts @@ -19,11 +19,7 @@ export class Accounts extends APIResource { * ``` */ create(body: AccountCreateParams, options?: RequestOptions): APIPromise { - return this._client.post('/sandbox/connections/accounts', { - body, - ...options, - __security: { basicAuth: true }, - }); + return this._client.post('/sandbox/connections/accounts', { body, ...options, __security: { basicAuth : true } }); } /** @@ -38,15 +34,8 @@ export class Accounts extends APIResource { * }); * ``` */ - update( - body: AccountUpdateParams | null | undefined = {}, - options?: RequestOptions, - ): APIPromise { - return this._client.put('/sandbox/connections/accounts', { - body, - ...options, - __security: { bearerAuth: true }, - }); + update(body: AccountUpdateParams | null | undefined = {}, options?: RequestOptions): APIPromise { + return this._client.put('/sandbox/connections/accounts', { body, ...options, __security: { bearerAuth : true } }); } } @@ -144,6 +133,6 @@ export declare namespace Accounts { type AccountCreateResponse as AccountCreateResponse, type AccountUpdateResponse as AccountUpdateResponse, type AccountCreateParams as AccountCreateParams, - type AccountUpdateParams as AccountUpdateParams, + type AccountUpdateParams as AccountUpdateParams }; } diff --git a/src/resources/sandbox/connections/connections.ts b/src/resources/sandbox/connections/connections.ts index c338bbee..47a6f0d2 100644 --- a/src/resources/sandbox/connections/connections.ts +++ b/src/resources/sandbox/connections/connections.ts @@ -2,13 +2,7 @@ import { APIResource } from '../../../core/resource'; import * as AccountsAPI from './accounts'; -import { - AccountCreateParams, - AccountCreateResponse, - AccountUpdateParams, - AccountUpdateResponse, - Accounts, -} from './accounts'; +import { AccountCreateParams, AccountCreateResponse, AccountUpdateParams, AccountUpdateResponse, Accounts } from './accounts'; import { APIPromise } from '../../../core/api-promise'; import { RequestOptions } from '../../../internal/request-options'; @@ -26,7 +20,7 @@ export class Connections extends APIResource { * ``` */ create(body: ConnectionCreateParams, options?: RequestOptions): APIPromise { - return this._client.post('/sandbox/connections', { body, ...options, __security: { basicAuth: true } }); + return this._client.post('/sandbox/connections', { body, ...options, __security: { basicAuth : true } }); } } @@ -90,7 +84,7 @@ Connections.Accounts = Accounts; export declare namespace Connections { export { type ConnectionCreateResponse as ConnectionCreateResponse, - type ConnectionCreateParams as ConnectionCreateParams, + type ConnectionCreateParams as ConnectionCreateParams }; export { @@ -98,6 +92,6 @@ export declare namespace Connections { type AccountCreateResponse as AccountCreateResponse, type AccountUpdateResponse as AccountUpdateResponse, type AccountCreateParams as AccountCreateParams, - type AccountUpdateParams as AccountUpdateParams, + type AccountUpdateParams as AccountUpdateParams }; } diff --git a/src/resources/sandbox/connections/index.ts b/src/resources/sandbox/connections/index.ts index 53b8e3d6..0460a8e6 100644 --- a/src/resources/sandbox/connections/index.ts +++ b/src/resources/sandbox/connections/index.ts @@ -1,10 +1,4 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -export { - Accounts, - type AccountCreateResponse, - type AccountUpdateResponse, - type AccountCreateParams, - type AccountUpdateParams, -} from './accounts'; -export { Connections, type ConnectionCreateResponse, type ConnectionCreateParams } from './connections'; +export { Accounts, type AccountCreateResponse, type AccountUpdateResponse, type AccountCreateParams, type AccountUpdateParams } from './accounts';; +export { Connections, type ConnectionCreateResponse, type ConnectionCreateParams } from './connections';; diff --git a/src/resources/sandbox/directory.ts b/src/resources/sandbox/directory.ts index 22c3fcd3..de8371aa 100644 --- a/src/resources/sandbox/directory.ts +++ b/src/resources/sandbox/directory.ts @@ -14,23 +14,16 @@ export class Directory extends APIResource { * const directories = await client.sandbox.directory.create(); * ``` */ - create( - params: DirectoryCreateParams | null | undefined = undefined, - options?: RequestOptions, - ): APIPromise { - const { body } = params ?? {}; - return this._client.post('/sandbox/directory', { - body: body, - ...options, - __security: { bearerAuth: true }, - }); + create(params: DirectoryCreateParams | null | undefined = undefined, options?: RequestOptions): APIPromise { + const { body } = params ?? {} + return this._client.post('/sandbox/directory', { body: body, ...options, __security: { bearerAuth : true } }); } } /** * The individuals which were created */ -export type DirectoryCreateResponse = Array; +export type DirectoryCreateResponse = Array export interface DirectoryCreateParams { /** @@ -71,15 +64,7 @@ export namespace DirectoryCreateParams { /** * The detailed employment status of the individual. */ - employment_status?: - | 'active' - | 'deceased' - | 'leave' - | 'onboarding' - | 'prehire' - | 'retired' - | 'terminated' - | null; + employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated' | null; /** * Social Security Number of the individual in **encrypted** format. This field is @@ -93,16 +78,7 @@ export namespace DirectoryCreateParams { /** * The EEOC-defined ethnicity of the individual. */ - ethnicity?: - | 'asian' - | 'white' - | 'black_or_african_american' - | 'native_hawaiian_or_pacific_islander' - | 'american_indian_or_alaska_native' - | 'hispanic_or_latino' - | 'two_or_more_races' - | 'decline_to_specify' - | null; + ethnicity?: 'asian' | 'white' | 'black_or_african_american' | 'native_hawaiian_or_pacific_islander' | 'american_indian_or_alaska_native' | 'hispanic_or_latino' | 'two_or_more_races' | 'decline_to_specify' | null; /** * The legal first name of the individual. @@ -246,6 +222,6 @@ export namespace DirectoryCreateParams { export declare namespace Directory { export { type DirectoryCreateResponse as DirectoryCreateResponse, - type DirectoryCreateParams as DirectoryCreateParams, + type DirectoryCreateParams as DirectoryCreateParams }; } diff --git a/src/resources/sandbox/employment.ts b/src/resources/sandbox/employment.ts index 99a196b5..94f80e7e 100644 --- a/src/resources/sandbox/employment.ts +++ b/src/resources/sandbox/employment.ts @@ -17,16 +17,8 @@ export class Employment extends APIResource { * ); * ``` */ - update( - individualID: string, - body: EmploymentUpdateParams | null | undefined = {}, - options?: RequestOptions, - ): APIPromise { - return this._client.put(path`/sandbox/employment/${individualID}`, { - body, - ...options, - __security: { bearerAuth: true }, - }); + update(individualID: string, body: EmploymentUpdateParams | null | undefined = {}, options?: RequestOptions): APIPromise { + return this._client.put(path`/sandbox/employment/${individualID}`, { body, ...options, __security: { bearerAuth : true } }); } } @@ -61,15 +53,7 @@ export interface EmploymentUpdateResponse { /** * The detailed employment status of the individual. */ - employment_status?: - | 'active' - | 'deceased' - | 'leave' - | 'onboarding' - | 'prehire' - | 'retired' - | 'terminated' - | null; + employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated' | null; end_date?: string | null; @@ -203,15 +187,7 @@ export interface EmploymentUpdateParams { /** * The detailed employment status of the individual. */ - employment_status?: - | 'active' - | 'deceased' - | 'leave' - | 'onboarding' - | 'prehire' - | 'retired' - | 'terminated' - | null; + employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated' | null; end_date?: string | null; @@ -322,6 +298,6 @@ export namespace EmploymentUpdateParams { export declare namespace Employment { export { type EmploymentUpdateResponse as EmploymentUpdateResponse, - type EmploymentUpdateParams as EmploymentUpdateParams, + type EmploymentUpdateParams as EmploymentUpdateParams }; } diff --git a/src/resources/sandbox/index.ts b/src/resources/sandbox/index.ts index ad0185c3..0bb30828 100644 --- a/src/resources/sandbox/index.ts +++ b/src/resources/sandbox/index.ts @@ -1,10 +1,10 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -export { Company, type CompanyUpdateResponse, type CompanyUpdateParams } from './company'; -export { Connections, type ConnectionCreateResponse, type ConnectionCreateParams } from './connections/index'; -export { Directory, type DirectoryCreateResponse, type DirectoryCreateParams } from './directory'; -export { Employment, type EmploymentUpdateResponse, type EmploymentUpdateParams } from './employment'; -export { Individual, type IndividualUpdateResponse, type IndividualUpdateParams } from './individual'; -export { Jobs, type JobCreateResponse, type JobCreateParams } from './jobs/index'; -export { Payment, type PaymentCreateResponse, type PaymentCreateParams } from './payment'; -export { Sandbox } from './sandbox'; +export { Company, type CompanyUpdateResponse, type CompanyUpdateParams } from './company';; +export { Connections, type ConnectionCreateResponse, type ConnectionCreateParams } from './connections/index';; +export { Directory, type DirectoryCreateResponse, type DirectoryCreateParams } from './directory';; +export { Employment, type EmploymentUpdateResponse, type EmploymentUpdateParams } from './employment';; +export { Individual, type IndividualUpdateResponse, type IndividualUpdateParams } from './individual';; +export { Jobs, type JobCreateResponse, type JobCreateParams } from './jobs/index';; +export { Payment, type PaymentCreateResponse, type PaymentCreateParams } from './payment';; +export { Sandbox } from './sandbox';; diff --git a/src/resources/sandbox/individual.ts b/src/resources/sandbox/individual.ts index 6db0f550..89c1021d 100644 --- a/src/resources/sandbox/individual.ts +++ b/src/resources/sandbox/individual.ts @@ -17,16 +17,8 @@ export class Individual extends APIResource { * ); * ``` */ - update( - individualID: string, - body: IndividualUpdateParams | null | undefined = {}, - options?: RequestOptions, - ): APIPromise { - return this._client.put(path`/sandbox/individual/${individualID}`, { - body, - ...options, - __security: { bearerAuth: true }, - }); + update(individualID: string, body: IndividualUpdateParams | null | undefined = {}, options?: RequestOptions): APIPromise { + return this._client.put(path`/sandbox/individual/${individualID}`, { body, ...options, __security: { bearerAuth : true } }); } } @@ -50,16 +42,7 @@ export interface IndividualUpdateResponse { /** * The EEOC-defined ethnicity of the individual. */ - ethnicity?: - | 'asian' - | 'white' - | 'black_or_african_american' - | 'native_hawaiian_or_pacific_islander' - | 'american_indian_or_alaska_native' - | 'hispanic_or_latino' - | 'two_or_more_races' - | 'decline_to_specify' - | null; + ethnicity?: 'asian' | 'white' | 'black_or_african_american' | 'native_hawaiian_or_pacific_islander' | 'american_indian_or_alaska_native' | 'hispanic_or_latino' | 'two_or_more_races' | 'decline_to_specify' | null; /** * The legal first name of the individual. @@ -128,16 +111,7 @@ export interface IndividualUpdateParams { /** * The EEOC-defined ethnicity of the individual. */ - ethnicity?: - | 'asian' - | 'white' - | 'black_or_african_american' - | 'native_hawaiian_or_pacific_islander' - | 'american_indian_or_alaska_native' - | 'hispanic_or_latino' - | 'two_or_more_races' - | 'decline_to_specify' - | null; + ethnicity?: 'asian' | 'white' | 'black_or_african_american' | 'native_hawaiian_or_pacific_islander' | 'american_indian_or_alaska_native' | 'hispanic_or_latino' | 'two_or_more_races' | 'decline_to_specify' | null; /** * The legal first name of the individual. @@ -194,6 +168,6 @@ export namespace IndividualUpdateParams { export declare namespace Individual { export { type IndividualUpdateResponse as IndividualUpdateResponse, - type IndividualUpdateParams as IndividualUpdateParams, + type IndividualUpdateParams as IndividualUpdateParams }; } diff --git a/src/resources/sandbox/jobs/configuration.ts b/src/resources/sandbox/jobs/configuration.ts index 75ad1d35..a2cc6683 100644 --- a/src/resources/sandbox/jobs/configuration.ts +++ b/src/resources/sandbox/jobs/configuration.ts @@ -15,7 +15,7 @@ export class Configuration extends APIResource { * ``` */ retrieve(options?: RequestOptions): APIPromise { - return this._client.get('/sandbox/jobs/configuration', { ...options, __security: { bearerAuth: true } }); + return this._client.get('/sandbox/jobs/configuration', { ...options, __security: { bearerAuth : true } }); } /** @@ -31,11 +31,7 @@ export class Configuration extends APIResource { * ``` */ update(body: ConfigurationUpdateParams, options?: RequestOptions): APIPromise { - return this._client.put('/sandbox/jobs/configuration', { - body, - ...options, - __security: { bearerAuth: true }, - }); + return this._client.put('/sandbox/jobs/configuration', { body, ...options, __security: { bearerAuth : true } }); } } @@ -45,7 +41,7 @@ export interface SandboxJobConfiguration { type: 'data_sync_all'; } -export type ConfigurationRetrieveResponse = Array; +export type ConfigurationRetrieveResponse = Array export interface ConfigurationUpdateParams { completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'; @@ -57,6 +53,6 @@ export declare namespace Configuration { export { type SandboxJobConfiguration as SandboxJobConfiguration, type ConfigurationRetrieveResponse as ConfigurationRetrieveResponse, - type ConfigurationUpdateParams as ConfigurationUpdateParams, + type ConfigurationUpdateParams as ConfigurationUpdateParams }; } diff --git a/src/resources/sandbox/jobs/index.ts b/src/resources/sandbox/jobs/index.ts index 6dc11796..0dfeff08 100644 --- a/src/resources/sandbox/jobs/index.ts +++ b/src/resources/sandbox/jobs/index.ts @@ -1,9 +1,4 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -export { - Configuration, - type SandboxJobConfiguration, - type ConfigurationRetrieveResponse, - type ConfigurationUpdateParams, -} from './configuration'; -export { Jobs, type JobCreateResponse, type JobCreateParams } from './jobs'; +export { Configuration, type SandboxJobConfiguration, type ConfigurationRetrieveResponse, type ConfigurationUpdateParams } from './configuration';; +export { Jobs, type JobCreateResponse, type JobCreateParams } from './jobs';; diff --git a/src/resources/sandbox/jobs/jobs.ts b/src/resources/sandbox/jobs/jobs.ts index 05ea2721..7ac89807 100644 --- a/src/resources/sandbox/jobs/jobs.ts +++ b/src/resources/sandbox/jobs/jobs.ts @@ -2,12 +2,7 @@ import { APIResource } from '../../../core/resource'; import * as ConfigurationAPI from './configuration'; -import { - Configuration, - ConfigurationRetrieveResponse, - ConfigurationUpdateParams, - SandboxJobConfiguration, -} from './configuration'; +import { Configuration, ConfigurationRetrieveResponse, ConfigurationUpdateParams, SandboxJobConfiguration } from './configuration'; import { APIPromise } from '../../../core/api-promise'; import { RequestOptions } from '../../../internal/request-options'; @@ -25,7 +20,7 @@ export class Jobs extends APIResource { * ``` */ create(body: JobCreateParams, options?: RequestOptions): APIPromise { - return this._client.post('/sandbox/jobs', { body, ...options, __security: { bearerAuth: true } }); + return this._client.post('/sandbox/jobs', { body, ...options, __security: { bearerAuth : true } }); } } @@ -61,12 +56,15 @@ export interface JobCreateParams { Jobs.Configuration = Configuration; export declare namespace Jobs { - export { type JobCreateResponse as JobCreateResponse, type JobCreateParams as JobCreateParams }; + export { + type JobCreateResponse as JobCreateResponse, + type JobCreateParams as JobCreateParams + }; export { Configuration as Configuration, type SandboxJobConfiguration as SandboxJobConfiguration, type ConfigurationRetrieveResponse as ConfigurationRetrieveResponse, - type ConfigurationUpdateParams as ConfigurationUpdateParams, + type ConfigurationUpdateParams as ConfigurationUpdateParams }; } diff --git a/src/resources/sandbox/payment.ts b/src/resources/sandbox/payment.ts index b6aa8c2f..2bc2c066 100644 --- a/src/resources/sandbox/payment.ts +++ b/src/resources/sandbox/payment.ts @@ -13,11 +13,8 @@ export class Payment extends APIResource { * const payment = await client.sandbox.payment.create(); * ``` */ - create( - body: PaymentCreateParams | null | undefined = {}, - options?: RequestOptions, - ): APIPromise { - return this._client.post('/sandbox/payment', { body, ...options, __security: { bearerAuth: true } }); + create(body: PaymentCreateParams | null | undefined = {}, options?: RequestOptions): APIPromise { + return this._client.post('/sandbox/payment', { body, ...options, __security: { bearerAuth : true } }); } } @@ -75,20 +72,7 @@ export namespace PaymentCreateParams { name?: string; - type?: - | 'bonus' - | 'commission' - | 'double_overtime' - | 'other' - | 'overtime' - | 'pto' - | 'reimbursement' - | 'salary' - | 'severance' - | 'sick' - | 'tips' - | 'wage' - | '1099'; + type?: 'bonus' | 'commission' | 'double_overtime' | 'other' | 'overtime' | 'pto' | 'reimbursement' | 'salary' | 'severance' | 'sick' | 'tips' | 'wage' | '1099'; } export interface EmployeeDeduction { @@ -101,26 +85,7 @@ export namespace PaymentCreateParams { pre_tax?: boolean; - type?: - | '457' - | '401k' - | '401k_roth' - | '401k_loan' - | '403b' - | '403b_roth' - | '457_roth' - | 'commuter' - | 'custom_post_tax' - | 'custom_pre_tax' - | 'fsa_dependent_care' - | 'fsa_medical' - | 'hsa_post' - | 'hsa_pre' - | 's125_dental' - | 's125_medical' - | 's125_vision' - | 'simple' - | 'simple_ira'; + type?: '457' | '401k' | '401k_roth' | '401k_loan' | '403b' | '403b_roth' | '457_roth' | 'commuter' | 'custom_post_tax' | 'custom_pre_tax' | 'fsa_dependent_care' | 'fsa_medical' | 'hsa_post' | 'hsa_pre' | 's125_dental' | 's125_medical' | 's125_vision' | 'simple' | 'simple_ira'; } export interface EmployerContribution { @@ -131,26 +96,7 @@ export namespace PaymentCreateParams { */ name?: string; - type?: - | '457' - | '401k' - | '401k_roth' - | '401k_loan' - | '403b' - | '403b_roth' - | '457_roth' - | 'commuter' - | 'custom_post_tax' - | 'custom_pre_tax' - | 'fsa_dependent_care' - | 'fsa_medical' - | 'hsa_post' - | 'hsa_pre' - | 's125_dental' - | 's125_medical' - | 's125_vision' - | 'simple' - | 'simple_ira'; + type?: '457' | '401k' | '401k_roth' | '401k_loan' | '403b' | '403b_roth' | '457_roth' | 'commuter' | 'custom_post_tax' | 'custom_pre_tax' | 'fsa_dependent_care' | 'fsa_medical' | 'hsa_post' | 'hsa_pre' | 's125_dental' | 's125_medical' | 's125_vision' | 'simple' | 'simple_ira'; } export interface Tax { @@ -168,6 +114,6 @@ export namespace PaymentCreateParams { export declare namespace Payment { export { type PaymentCreateResponse as PaymentCreateResponse, - type PaymentCreateParams as PaymentCreateParams, + type PaymentCreateParams as PaymentCreateParams }; } diff --git a/src/resources/sandbox/sandbox.ts b/src/resources/sandbox/sandbox.ts index 4390b7eb..1db2967c 100644 --- a/src/resources/sandbox/sandbox.ts +++ b/src/resources/sandbox/sandbox.ts @@ -38,42 +38,42 @@ export declare namespace Sandbox { export { Connections as Connections, type ConnectionCreateResponse as ConnectionCreateResponse, - type ConnectionCreateParams as ConnectionCreateParams, + type ConnectionCreateParams as ConnectionCreateParams }; export { Company as Company, type CompanyUpdateResponse as CompanyUpdateResponse, - type CompanyUpdateParams as CompanyUpdateParams, + type CompanyUpdateParams as CompanyUpdateParams }; export { Directory as Directory, type DirectoryCreateResponse as DirectoryCreateResponse, - type DirectoryCreateParams as DirectoryCreateParams, + type DirectoryCreateParams as DirectoryCreateParams }; export { Individual as Individual, type IndividualUpdateResponse as IndividualUpdateResponse, - type IndividualUpdateParams as IndividualUpdateParams, + type IndividualUpdateParams as IndividualUpdateParams }; export { Employment as Employment, type EmploymentUpdateResponse as EmploymentUpdateResponse, - type EmploymentUpdateParams as EmploymentUpdateParams, + type EmploymentUpdateParams as EmploymentUpdateParams }; export { Payment as Payment, type PaymentCreateResponse as PaymentCreateResponse, - type PaymentCreateParams as PaymentCreateParams, + type PaymentCreateParams as PaymentCreateParams }; export { Jobs as Jobs, type JobCreateResponse as JobCreateResponse, - type JobCreateParams as JobCreateParams, + type JobCreateParams as JobCreateParams }; } diff --git a/src/resources/shared.ts b/src/resources/shared.ts index a329d6a6..bbae8636 100644 --- a/src/resources/shared.ts +++ b/src/resources/shared.ts @@ -1,12 +1,7 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -export type ConnectionStatusType = - | 'pending' - | 'processing' - | 'connected' - | 'error_no_account_setup' - | 'error_permissions' - | 'reauth'; + +export type ConnectionStatusType = 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth' /** * - `supported`: This operation is supported by both the provider and Finch @@ -17,11 +12,7 @@ export type ConnectionStatusType = * - `client_access_only`: This behavior is supported by the provider, but only * available to the client and not to Finch */ -export type OperationSupport = - | 'supported' - | 'not_supported_by_finch' - | 'not_supported_by_provider' - | 'client_access_only'; +export type OperationSupport = 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' export interface OperationSupportMatrix { /** diff --git a/src/resources/webhooks.ts b/src/resources/webhooks.ts index 0e4ce25c..f4e2bded 100644 --- a/src/resources/webhooks.ts +++ b/src/resources/webhooks.ts @@ -637,16 +637,7 @@ export namespace IndividualEvent { export interface JobCompletionEvent extends BaseWebhookEvent { data?: JobCompletionEvent.Data; - event_type?: - | 'job.benefit_create.completed' - | 'job.benefit_enroll.completed' - | 'job.benefit_register.completed' - | 'job.benefit_unenroll.completed' - | 'job.benefit_update.completed' - | 'job.data_sync_all.completed' - | 'job.w4_form_employee_sync.completed' - | 'job.initial_data_sync_org.succeeded' - | 'job.initial_data_sync_payroll.succeeded'; + event_type?: 'job.benefit_create.completed' | 'job.benefit_enroll.completed' | 'job.benefit_register.completed' | 'job.benefit_unenroll.completed' | 'job.benefit_update.completed' | 'job.data_sync_all.completed' | 'job.w4_form_employee_sync.completed' | 'job.initial_data_sync_org.succeeded' | 'job.initial_data_sync_payroll.succeeded'; } export namespace JobCompletionEvent { @@ -703,15 +694,7 @@ export namespace PaymentEvent { } } -export type WebhookEvent = - | AccountUpdateEvent - | JobCompletionEvent - | CompanyEvent - | DirectoryEvent - | EmploymentEvent - | IndividualEvent - | PaymentEvent - | PayStatementEvent; +export type WebhookEvent = AccountUpdateEvent | JobCompletionEvent | CompanyEvent | DirectoryEvent | EmploymentEvent | IndividualEvent | PaymentEvent | PayStatementEvent export declare namespace Webhooks { export { @@ -724,6 +707,6 @@ export declare namespace Webhooks { type JobCompletionEvent as JobCompletionEvent, type PayStatementEvent as PayStatementEvent, type PaymentEvent as PaymentEvent, - type WebhookEvent as WebhookEvent, + type WebhookEvent as WebhookEvent }; } diff --git a/src/uploads.ts b/src/uploads.ts index b2ef6471..d5437085 100644 --- a/src/uploads.ts +++ b/src/uploads.ts @@ -1,2 +1,2 @@ /** @deprecated Import from ./core/uploads instead */ -export * from './core/uploads'; +export * from "./core/uploads" \ No newline at end of file diff --git a/src/version.ts b/src/version.ts index 01f3ec2a..bf3532f1 100644 --- a/src/version.ts +++ b/src/version.ts @@ -1 +1 @@ -export const VERSION = '9.6.0'; // x-release-please-version +export const VERSION = '9.6.0';// x-release-please-version diff --git a/tests/api-resources/access-tokens.test.ts b/tests/api-resources/access-tokens.test.ts index 2f11d82a..42c76e7c 100644 --- a/tests/api-resources/access-tokens.test.ts +++ b/tests/api-resources/access-tokens.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', }); describe('resource accessTokens', () => { @@ -25,10 +25,10 @@ describe('resource accessTokens', () => { // prism doesnt like the format for the API-Version header test.skip('create: required and optional params', async () => { const response = await client.accessTokens.create({ - code: 'code', - client_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', - client_secret: 'client_secret', - redirect_uri: 'redirect_uri', - }); + code: 'code', + client_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', + client_secret: 'client_secret', + redirect_uri: 'redirect_uri', + }); }); }); diff --git a/tests/api-resources/account.test.ts b/tests/api-resources/account.test.ts index 2d12c264..1d67482a 100644 --- a/tests/api-resources/account.test.ts +++ b/tests/api-resources/account.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', }); describe('resource account', () => { diff --git a/tests/api-resources/connect/sessions.test.ts b/tests/api-resources/connect/sessions.test.ts index 7f5779c2..89e7ada4 100644 --- a/tests/api-resources/connect/sessions.test.ts +++ b/tests/api-resources/connect/sessions.test.ts @@ -6,17 +6,17 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', }); describe('resource sessions', () => { // prism tests are broken test.skip('new: only required params', async () => { const responsePromise = client.connect.sessions.new({ - customer_id: 'x', - customer_name: 'x', - products: ['benefits'], - }); + customer_id: 'x', + customer_name: 'x', + products: ['benefits'], + }); const rawResponse = await responsePromise.asResponse(); expect(rawResponse).toBeInstanceOf(Response); const response = await responsePromise; @@ -29,16 +29,16 @@ describe('resource sessions', () => { // prism tests are broken test.skip('new: required and optional params', async () => { const response = await client.connect.sessions.new({ - customer_id: 'x', - customer_name: 'x', - products: ['benefits'], - customer_email: 'dev@stainless.com', - integration: { provider: 'provider', auth_method: 'assisted' }, - manual: true, - minutes_to_expire: 1, - redirect_uri: 'redirect_uri', - sandbox: 'finch', - }); + customer_id: 'x', + customer_name: 'x', + products: ['benefits'], + customer_email: 'dev@stainless.com', + integration: { provider: 'provider', auth_method: 'assisted' }, + manual: true, + minutes_to_expire: 1, + redirect_uri: 'redirect_uri', + sandbox: 'finch', + }); }); // prism tests are broken @@ -56,10 +56,10 @@ describe('resource sessions', () => { // prism tests are broken test.skip('reauthenticate: required and optional params', async () => { const response = await client.connect.sessions.reauthenticate({ - connection_id: 'connection_id', - minutes_to_expire: 0, - products: ['benefits'], - redirect_uri: 'https://example.com', - }); + connection_id: 'connection_id', + minutes_to_expire: 0, + products: ['benefits'], + redirect_uri: 'https://example.com', + }); }); }); diff --git a/tests/api-resources/hris/benefits/benefits.test.ts b/tests/api-resources/hris/benefits/benefits.test.ts index d1351187..562fe531 100644 --- a/tests/api-resources/hris/benefits/benefits.test.ts +++ b/tests/api-resources/hris/benefits/benefits.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', }); describe('resource benefits', () => { @@ -23,18 +23,15 @@ describe('resource benefits', () => { test('create: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect( - client.hris.benefits.create( - { - entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], - company_contribution: { tiers: [{ match: 1, threshold: 1 }], type: 'match' }, - description: 'description', - frequency: 'every_paycheck', - type: '457', - }, - { path: '/_stainless_unknown_path' }, - ), - ).rejects.toThrow(Finch.NotFoundError); + await expect(client.hris.benefits.create({ + entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], + company_contribution: { tiers: [{ match: 1, threshold: 1 }], type: 'match' }, + description: 'description', + frequency: 'every_paycheck', + type: '457', + }, { path: '/_stainless_unknown_path' })) + .rejects + .toThrow(Finch.NotFoundError); }); test('retrieve', async () => { @@ -50,13 +47,9 @@ describe('resource benefits', () => { test('retrieve: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect( - client.hris.benefits.retrieve( - 'benefit_id', - { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, - { path: '/_stainless_unknown_path' }, - ), - ).rejects.toThrow(Finch.NotFoundError); + await expect(client.hris.benefits.retrieve('benefit_id', { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, { path: '/_stainless_unknown_path' })) + .rejects + .toThrow(Finch.NotFoundError); }); test('update', async () => { @@ -72,13 +65,9 @@ describe('resource benefits', () => { test('update: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect( - client.hris.benefits.update( - 'benefit_id', - { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], description: 'description' }, - { path: '/_stainless_unknown_path' }, - ), - ).rejects.toThrow(Finch.NotFoundError); + await expect(client.hris.benefits.update('benefit_id', { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], description: 'description' }, { path: '/_stainless_unknown_path' })) + .rejects + .toThrow(Finch.NotFoundError); }); test('list', async () => { @@ -94,12 +83,9 @@ describe('resource benefits', () => { test('list: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect( - client.hris.benefits.list( - { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, - { path: '/_stainless_unknown_path' }, - ), - ).rejects.toThrow(Finch.NotFoundError); + await expect(client.hris.benefits.list({ entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, { path: '/_stainless_unknown_path' })) + .rejects + .toThrow(Finch.NotFoundError); }); test('listSupportedBenefits', async () => { @@ -115,11 +101,8 @@ describe('resource benefits', () => { test('listSupportedBenefits: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect( - client.hris.benefits.listSupportedBenefits( - { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, - { path: '/_stainless_unknown_path' }, - ), - ).rejects.toThrow(Finch.NotFoundError); + await expect(client.hris.benefits.listSupportedBenefits({ entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, { path: '/_stainless_unknown_path' })) + .rejects + .toThrow(Finch.NotFoundError); }); }); diff --git a/tests/api-resources/hris/benefits/individuals.test.ts b/tests/api-resources/hris/benefits/individuals.test.ts index 2ad50578..d82401cb 100644 --- a/tests/api-resources/hris/benefits/individuals.test.ts +++ b/tests/api-resources/hris/benefits/individuals.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', }); describe('resource individuals', () => { @@ -23,32 +23,23 @@ describe('resource individuals', () => { test('enrollMany: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect( - client.hris.benefits.individuals.enrollMany( - 'benefit_id', - { - entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], - individuals: [ - { - configuration: { - annual_contribution_limit: 'individual', - annual_maximum: null, - catch_up: true, - company_contribution: { - amount: 0, - tiers: [{ match: 0, threshold: 0 }], - type: 'fixed', - }, - effective_date: '2019-12-27', - employee_deduction: { amount: 10000, type: 'fixed' }, - }, - individual_id: 'd02a6346-1f08-4312-a064-49ff3cafaa7a', - }, - ], - }, - { path: '/_stainless_unknown_path' }, - ), - ).rejects.toThrow(Finch.NotFoundError); + await expect(client.hris.benefits.individuals.enrollMany('benefit_id', { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], individuals: [{ + configuration: { + annual_contribution_limit: 'individual', + annual_maximum: null, + catch_up: true, + company_contribution: { + amount: 0, + tiers: [{ match: 0, threshold: 0 }], + type: 'fixed', + }, + effective_date: '2019-12-27', + employee_deduction: { amount: 10000, type: 'fixed' }, + }, + individual_id: 'd02a6346-1f08-4312-a064-49ff3cafaa7a', + }] }, { path: '/_stainless_unknown_path' })) + .rejects + .toThrow(Finch.NotFoundError); }); test('enrolledIDs', async () => { @@ -64,13 +55,9 @@ describe('resource individuals', () => { test('enrolledIDs: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect( - client.hris.benefits.individuals.enrolledIDs( - 'benefit_id', - { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, - { path: '/_stainless_unknown_path' }, - ), - ).rejects.toThrow(Finch.NotFoundError); + await expect(client.hris.benefits.individuals.enrolledIDs('benefit_id', { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, { path: '/_stainless_unknown_path' })) + .rejects + .toThrow(Finch.NotFoundError); }); test('retrieveManyBenefits', async () => { @@ -86,16 +73,9 @@ describe('resource individuals', () => { test('retrieveManyBenefits: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect( - client.hris.benefits.individuals.retrieveManyBenefits( - 'benefit_id', - { - entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], - individual_ids: 'd675d2b7-6d7b-41a8-b2d3-001eb3fb88f6,d02a6346-1f08-4312-a064-49ff3cafaa7a', - }, - { path: '/_stainless_unknown_path' }, - ), - ).rejects.toThrow(Finch.NotFoundError); + await expect(client.hris.benefits.individuals.retrieveManyBenefits('benefit_id', { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], individual_ids: 'd675d2b7-6d7b-41a8-b2d3-001eb3fb88f6,d02a6346-1f08-4312-a064-49ff3cafaa7a' }, { path: '/_stainless_unknown_path' })) + .rejects + .toThrow(Finch.NotFoundError); }); test('unenrollMany', async () => { @@ -111,12 +91,8 @@ describe('resource individuals', () => { test('unenrollMany: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect( - client.hris.benefits.individuals.unenrollMany( - 'benefit_id', - { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], individual_ids: ['string'] }, - { path: '/_stainless_unknown_path' }, - ), - ).rejects.toThrow(Finch.NotFoundError); + await expect(client.hris.benefits.individuals.unenrollMany('benefit_id', { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], individual_ids: ['string'] }, { path: '/_stainless_unknown_path' })) + .rejects + .toThrow(Finch.NotFoundError); }); }); diff --git a/tests/api-resources/hris/company/company.test.ts b/tests/api-resources/hris/company/company.test.ts index 462d62c3..5420d97d 100644 --- a/tests/api-resources/hris/company/company.test.ts +++ b/tests/api-resources/hris/company/company.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', }); describe('resource company', () => { @@ -23,11 +23,8 @@ describe('resource company', () => { test('retrieve: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect( - client.hris.company.retrieve( - { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, - { path: '/_stainless_unknown_path' }, - ), - ).rejects.toThrow(Finch.NotFoundError); + await expect(client.hris.company.retrieve({ entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, { path: '/_stainless_unknown_path' })) + .rejects + .toThrow(Finch.NotFoundError); }); }); diff --git a/tests/api-resources/hris/company/pay-statement-item/pay-statement-item.test.ts b/tests/api-resources/hris/company/pay-statement-item/pay-statement-item.test.ts index 04f11a4c..609609da 100644 --- a/tests/api-resources/hris/company/pay-statement-item/pay-statement-item.test.ts +++ b/tests/api-resources/hris/company/pay-statement-item/pay-statement-item.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', }); describe('resource payStatementItem', () => { @@ -23,18 +23,15 @@ describe('resource payStatementItem', () => { test('list: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect( - client.hris.company.payStatementItem.list( - { - categories: ['earnings'], - end_date: '2024-07-01', - entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], - name: 'name', - start_date: '2024-01-01', - type: 'base_compensation', - }, - { path: '/_stainless_unknown_path' }, - ), - ).rejects.toThrow(Finch.NotFoundError); + await expect(client.hris.company.payStatementItem.list({ + categories: ['earnings'], + end_date: '2024-07-01', + entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], + name: 'name', + start_date: '2024-01-01', + type: 'base_compensation', + }, { path: '/_stainless_unknown_path' })) + .rejects + .toThrow(Finch.NotFoundError); }); }); diff --git a/tests/api-resources/hris/company/pay-statement-item/rules.test.ts b/tests/api-resources/hris/company/pay-statement-item/rules.test.ts index 3c13638f..6ab2b16c 100644 --- a/tests/api-resources/hris/company/pay-statement-item/rules.test.ts +++ b/tests/api-resources/hris/company/pay-statement-item/rules.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', }); describe('resource rules', () => { @@ -23,25 +23,20 @@ describe('resource rules', () => { test('create: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect( - client.hris.company.payStatementItem.rules.create( - { - entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], - attributes: { metadata: { foo: 'bar' } }, - conditions: [ - { - field: 'field', - operator: 'equals', - value: 'value', - }, - ], - effective_end_date: 'effective_end_date', - effective_start_date: 'effective_start_date', - entity_type: 'pay_statement_item', - }, - { path: '/_stainless_unknown_path' }, - ), - ).rejects.toThrow(Finch.NotFoundError); + await expect(client.hris.company.payStatementItem.rules.create({ + entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], + attributes: { metadata: { foo: 'bar' } }, + conditions: [{ + field: 'field', + operator: 'equals', + value: 'value', + }], + effective_end_date: 'effective_end_date', + effective_start_date: 'effective_start_date', + entity_type: 'pay_statement_item', + }, { path: '/_stainless_unknown_path' })) + .rejects + .toThrow(Finch.NotFoundError); }); test('update', async () => { @@ -57,16 +52,12 @@ describe('resource rules', () => { test('update: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect( - client.hris.company.payStatementItem.rules.update( - 'rule_id', - { - entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], - optionalProperty: {}, - }, - { path: '/_stainless_unknown_path' }, - ), - ).rejects.toThrow(Finch.NotFoundError); + await expect(client.hris.company.payStatementItem.rules.update('rule_id', { + entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], + optionalProperty: {}, + }, { path: '/_stainless_unknown_path' })) + .rejects + .toThrow(Finch.NotFoundError); }); test('list', async () => { @@ -82,12 +73,9 @@ describe('resource rules', () => { test('list: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect( - client.hris.company.payStatementItem.rules.list( - { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, - { path: '/_stainless_unknown_path' }, - ), - ).rejects.toThrow(Finch.NotFoundError); + await expect(client.hris.company.payStatementItem.rules.list({ entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, { path: '/_stainless_unknown_path' })) + .rejects + .toThrow(Finch.NotFoundError); }); test('delete', async () => { @@ -103,12 +91,8 @@ describe('resource rules', () => { test('delete: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect( - client.hris.company.payStatementItem.rules.delete( - 'rule_id', - { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, - { path: '/_stainless_unknown_path' }, - ), - ).rejects.toThrow(Finch.NotFoundError); + await expect(client.hris.company.payStatementItem.rules.delete('rule_id', { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, { path: '/_stainless_unknown_path' })) + .rejects + .toThrow(Finch.NotFoundError); }); }); diff --git a/tests/api-resources/hris/directory.test.ts b/tests/api-resources/hris/directory.test.ts index 0990c668..e6474758 100644 --- a/tests/api-resources/hris/directory.test.ts +++ b/tests/api-resources/hris/directory.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', }); describe('resource directory', () => { @@ -23,16 +23,13 @@ describe('resource directory', () => { test('list: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect( - client.hris.directory.list( - { - entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], - limit: 0, - offset: 0, - }, - { path: '/_stainless_unknown_path' }, - ), - ).rejects.toThrow(Finch.NotFoundError); + await expect(client.hris.directory.list({ + entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], + limit: 0, + offset: 0, + }, { path: '/_stainless_unknown_path' })) + .rejects + .toThrow(Finch.NotFoundError); }); test('listIndividuals', async () => { @@ -48,15 +45,12 @@ describe('resource directory', () => { test('listIndividuals: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect( - client.hris.directory.listIndividuals( - { - entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], - limit: 0, - offset: 0, - }, - { path: '/_stainless_unknown_path' }, - ), - ).rejects.toThrow(Finch.NotFoundError); + await expect(client.hris.directory.listIndividuals({ + entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], + limit: 0, + offset: 0, + }, { path: '/_stainless_unknown_path' })) + .rejects + .toThrow(Finch.NotFoundError); }); }); diff --git a/tests/api-resources/hris/documents.test.ts b/tests/api-resources/hris/documents.test.ts index ade4b651..1cad23a7 100644 --- a/tests/api-resources/hris/documents.test.ts +++ b/tests/api-resources/hris/documents.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', }); describe('resource documents', () => { @@ -23,18 +23,15 @@ describe('resource documents', () => { test('list: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect( - client.hris.documents.list( - { - entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], - individual_ids: ['string'], - limit: 0, - offset: 0, - types: ['w4_2020'], - }, - { path: '/_stainless_unknown_path' }, - ), - ).rejects.toThrow(Finch.NotFoundError); + await expect(client.hris.documents.list({ + entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], + individual_ids: ['string'], + limit: 0, + offset: 0, + types: ['w4_2020'], + }, { path: '/_stainless_unknown_path' })) + .rejects + .toThrow(Finch.NotFoundError); }); test('retreive', async () => { @@ -50,12 +47,8 @@ describe('resource documents', () => { test('retreive: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect( - client.hris.documents.retreive( - 'document_id', - { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, - { path: '/_stainless_unknown_path' }, - ), - ).rejects.toThrow(Finch.NotFoundError); + await expect(client.hris.documents.retreive('document_id', { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, { path: '/_stainless_unknown_path' })) + .rejects + .toThrow(Finch.NotFoundError); }); }); diff --git a/tests/api-resources/hris/employments.test.ts b/tests/api-resources/hris/employments.test.ts index 5d33a634..db9fe870 100644 --- a/tests/api-resources/hris/employments.test.ts +++ b/tests/api-resources/hris/employments.test.ts @@ -6,14 +6,12 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', }); describe('resource employments', () => { test('retrieveMany: only required params', async () => { - const responsePromise = client.hris.employments.retrieveMany({ - requests: [{ individual_id: 'individual_id' }], - }); + const responsePromise = client.hris.employments.retrieveMany({ requests: [{ individual_id: 'individual_id' }] }); const rawResponse = await responsePromise.asResponse(); expect(rawResponse).toBeInstanceOf(Response); const response = await responsePromise; @@ -24,9 +22,6 @@ describe('resource employments', () => { }); test('retrieveMany: required and optional params', async () => { - const response = await client.hris.employments.retrieveMany({ - requests: [{ individual_id: 'individual_id' }], - entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], - }); + const response = await client.hris.employments.retrieveMany({ requests: [{ individual_id: 'individual_id' }], entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }); }); }); diff --git a/tests/api-resources/hris/individuals.test.ts b/tests/api-resources/hris/individuals.test.ts index ff4c0d35..a940db1e 100644 --- a/tests/api-resources/hris/individuals.test.ts +++ b/tests/api-resources/hris/individuals.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', }); describe('resource individuals', () => { @@ -23,15 +23,12 @@ describe('resource individuals', () => { test('retrieveMany: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect( - client.hris.individuals.retrieveMany( - { - entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], - options: { include: ['string'] }, - requests: [{ individual_id: 'individual_id' }], - }, - { path: '/_stainless_unknown_path' }, - ), - ).rejects.toThrow(Finch.NotFoundError); + await expect(client.hris.individuals.retrieveMany({ + entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], + options: { include: ['string'] }, + requests: [{ individual_id: 'individual_id' }], + }, { path: '/_stainless_unknown_path' })) + .rejects + .toThrow(Finch.NotFoundError); }); }); diff --git a/tests/api-resources/hris/pay-statements.test.ts b/tests/api-resources/hris/pay-statements.test.ts index 47198b3b..fa64f228 100644 --- a/tests/api-resources/hris/pay-statements.test.ts +++ b/tests/api-resources/hris/pay-statements.test.ts @@ -6,14 +6,12 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', }); describe('resource payStatements', () => { test('retrieveMany: only required params', async () => { - const responsePromise = client.hris.payStatements.retrieveMany({ - requests: [{ payment_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }], - }); + const responsePromise = client.hris.payStatements.retrieveMany({ requests: [{ payment_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }] }); const rawResponse = await responsePromise.asResponse(); expect(rawResponse).toBeInstanceOf(Response); const response = await responsePromise; @@ -24,15 +22,10 @@ describe('resource payStatements', () => { }); test('retrieveMany: required and optional params', async () => { - const response = await client.hris.payStatements.retrieveMany({ - requests: [ - { - payment_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', - limit: 50, - offset: 0, - }, - ], - entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], - }); + const response = await client.hris.payStatements.retrieveMany({ requests: [{ + payment_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', + limit: 50, + offset: 0, + }], entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }); }); }); diff --git a/tests/api-resources/hris/payments.test.ts b/tests/api-resources/hris/payments.test.ts index c6875591..d166bda6 100644 --- a/tests/api-resources/hris/payments.test.ts +++ b/tests/api-resources/hris/payments.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', }); describe('resource payments', () => { @@ -23,9 +23,9 @@ describe('resource payments', () => { test('list: required and optional params', async () => { const response = await client.hris.payments.list({ - end_date: '2021-01-01', - start_date: '2021-01-01', - entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], - }); + end_date: '2021-01-01', + start_date: '2021-01-01', + entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], + }); }); }); diff --git a/tests/api-resources/jobs/automated.test.ts b/tests/api-resources/jobs/automated.test.ts index 47f86079..f0341002 100644 --- a/tests/api-resources/jobs/automated.test.ts +++ b/tests/api-resources/jobs/automated.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', }); describe('resource automated', () => { @@ -49,8 +49,8 @@ describe('resource automated', () => { test('list: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect( - client.jobs.automated.list({ limit: 0, offset: 0 }, { path: '/_stainless_unknown_path' }), - ).rejects.toThrow(Finch.NotFoundError); + await expect(client.jobs.automated.list({ limit: 0, offset: 0 }, { path: '/_stainless_unknown_path' })) + .rejects + .toThrow(Finch.NotFoundError); }); }); diff --git a/tests/api-resources/jobs/manual.test.ts b/tests/api-resources/jobs/manual.test.ts index 84d7e814..c3d0e5f2 100644 --- a/tests/api-resources/jobs/manual.test.ts +++ b/tests/api-resources/jobs/manual.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', }); describe('resource manual', () => { diff --git a/tests/api-resources/payroll/pay-groups.test.ts b/tests/api-resources/payroll/pay-groups.test.ts index 0e365f3b..dbc616c0 100644 --- a/tests/api-resources/payroll/pay-groups.test.ts +++ b/tests/api-resources/payroll/pay-groups.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', }); describe('resource payGroups', () => { @@ -23,13 +23,9 @@ describe('resource payGroups', () => { test('retrieve: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect( - client.payroll.payGroups.retrieve( - 'pay_group_id', - { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, - { path: '/_stainless_unknown_path' }, - ), - ).rejects.toThrow(Finch.NotFoundError); + await expect(client.payroll.payGroups.retrieve('pay_group_id', { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, { path: '/_stainless_unknown_path' })) + .rejects + .toThrow(Finch.NotFoundError); }); test('list', async () => { @@ -45,15 +41,12 @@ describe('resource payGroups', () => { test('list: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect( - client.payroll.payGroups.list( - { - entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], - individual_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', - pay_frequencies: ['string'], - }, - { path: '/_stainless_unknown_path' }, - ), - ).rejects.toThrow(Finch.NotFoundError); + await expect(client.payroll.payGroups.list({ + entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], + individual_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', + pay_frequencies: ['string'], + }, { path: '/_stainless_unknown_path' })) + .rejects + .toThrow(Finch.NotFoundError); }); }); diff --git a/tests/api-resources/providers.test.ts b/tests/api-resources/providers.test.ts index 71714371..adbaa732 100644 --- a/tests/api-resources/providers.test.ts +++ b/tests/api-resources/providers.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', }); describe('resource providers', () => { diff --git a/tests/api-resources/request-forwarding.test.ts b/tests/api-resources/request-forwarding.test.ts index d39e70b6..1697a27a 100644 --- a/tests/api-resources/request-forwarding.test.ts +++ b/tests/api-resources/request-forwarding.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', }); describe('resource requestForwarding', () => { @@ -23,11 +23,11 @@ describe('resource requestForwarding', () => { test('forward: required and optional params', async () => { const response = await client.requestForwarding.forward({ - method: 'method', - route: 'route', - data: 'data', - params: { foo: 'bar' }, - request_headers: { foo: 'bar' }, - }); + method: 'method', + route: 'route', + data: 'data', + params: { foo: 'bar' }, + request_headers: { foo: 'bar' }, + }); }); }); diff --git a/tests/api-resources/sandbox/company.test.ts b/tests/api-resources/sandbox/company.test.ts index bc620167..14e5f966 100644 --- a/tests/api-resources/sandbox/company.test.ts +++ b/tests/api-resources/sandbox/company.test.ts @@ -6,30 +6,28 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', }); describe('resource company', () => { test('update: only required params', async () => { const responsePromise = client.sandbox.company.update({ - accounts: [{}], - departments: [{}], - ein: 'ein', - entity: {}, - legal_name: 'legal_name', - locations: [ - { - city: 'city', - country: 'country', - line1: 'line1', - line2: 'line2', - postal_code: 'postal_code', - state: 'state', - }, - ], - primary_email: 'dev@stainless.com', - primary_phone_number: 'primary_phone_number', - }); + accounts: [{}], + departments: [{}], + ein: 'ein', + entity: {}, + legal_name: 'legal_name', + locations: [{ + city: 'city', + country: 'country', + line1: 'line1', + line2: 'line2', + postal_code: 'postal_code', + state: 'state', + }], + primary_email: 'dev@stainless.com', + primary_phone_number: 'primary_phone_number', + }); const rawResponse = await responsePromise.asResponse(); expect(rawResponse).toBeInstanceOf(Response); const response = await responsePromise; @@ -41,38 +39,32 @@ describe('resource company', () => { test('update: required and optional params', async () => { const response = await client.sandbox.company.update({ - accounts: [ - { - account_name: 'account_name', - account_number: 'account_number', - account_type: 'checking', - institution_name: 'institution_name', - routing_number: 'routing_number', - }, - ], - departments: [ - { - name: 'name', - parent: { name: 'name' }, - }, - ], - ein: 'ein', - entity: { subtype: 's_corporation', type: 'llc' }, - legal_name: 'legal_name', - locations: [ - { - city: 'city', - country: 'country', - line1: 'line1', - line2: 'line2', - postal_code: 'postal_code', - state: 'state', - name: 'name', - source_id: 'source_id', - }, - ], - primary_email: 'dev@stainless.com', - primary_phone_number: 'primary_phone_number', - }); + accounts: [{ + account_name: 'account_name', + account_number: 'account_number', + account_type: 'checking', + institution_name: 'institution_name', + routing_number: 'routing_number', + }], + departments: [{ + name: 'name', + parent: { name: 'name' }, + }], + ein: 'ein', + entity: { subtype: 's_corporation', type: 'llc' }, + legal_name: 'legal_name', + locations: [{ + city: 'city', + country: 'country', + line1: 'line1', + line2: 'line2', + postal_code: 'postal_code', + state: 'state', + name: 'name', + source_id: 'source_id', + }], + primary_email: 'dev@stainless.com', + primary_phone_number: 'primary_phone_number', + }); }); }); diff --git a/tests/api-resources/sandbox/connections/accounts.test.ts b/tests/api-resources/sandbox/connections/accounts.test.ts index 6291ad89..4eaef486 100644 --- a/tests/api-resources/sandbox/connections/accounts.test.ts +++ b/tests/api-resources/sandbox/connections/accounts.test.ts @@ -6,16 +6,13 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', }); describe('resource accounts', () => { // prism tests are broken test.skip('create: only required params', async () => { - const responsePromise = client.sandbox.connections.accounts.create({ - company_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', - provider_id: 'provider_id', - }); + const responsePromise = client.sandbox.connections.accounts.create({ company_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', provider_id: 'provider_id' }); const rawResponse = await responsePromise.asResponse(); expect(rawResponse).toBeInstanceOf(Response); const response = await responsePromise; @@ -28,11 +25,11 @@ describe('resource accounts', () => { // prism tests are broken test.skip('create: required and optional params', async () => { const response = await client.sandbox.connections.accounts.create({ - company_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', - provider_id: 'provider_id', - authentication_type: 'credential', - products: ['string'], - }); + company_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', + provider_id: 'provider_id', + authentication_type: 'credential', + products: ['string'], + }); }); test('update', async () => { @@ -48,11 +45,8 @@ describe('resource accounts', () => { test('update: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect( - client.sandbox.connections.accounts.update( - { connection_status: 'reauth' }, - { path: '/_stainless_unknown_path' }, - ), - ).rejects.toThrow(Finch.NotFoundError); + await expect(client.sandbox.connections.accounts.update({ connection_status: 'reauth' }, { path: '/_stainless_unknown_path' })) + .rejects + .toThrow(Finch.NotFoundError); }); }); diff --git a/tests/api-resources/sandbox/connections/connections.test.ts b/tests/api-resources/sandbox/connections/connections.test.ts index 029a80f8..ada91f27 100644 --- a/tests/api-resources/sandbox/connections/connections.test.ts +++ b/tests/api-resources/sandbox/connections/connections.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', }); describe('resource connections', () => { @@ -25,10 +25,10 @@ describe('resource connections', () => { // prism tests are broken test.skip('create: required and optional params', async () => { const response = await client.sandbox.connections.create({ - provider_id: 'provider_id', - authentication_type: 'credential', - employee_size: 0, - products: ['string'], - }); + provider_id: 'provider_id', + authentication_type: 'credential', + employee_size: 0, + products: ['string'], + }); }); }); diff --git a/tests/api-resources/sandbox/directory.test.ts b/tests/api-resources/sandbox/directory.test.ts index b2fdecf2..1a785c36 100644 --- a/tests/api-resources/sandbox/directory.test.ts +++ b/tests/api-resources/sandbox/directory.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', }); describe('resource directory', () => { @@ -23,79 +23,68 @@ describe('resource directory', () => { test('create: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect( - client.sandbox.directory.create( - { - body: [ - { - class_code: 'class_code', - custom_fields: [ - { - name: 'name', - value: {}, - }, - ], - department: { name: 'name' }, - dob: 'dob', - emails: [{ data: 'data', type: 'work' }], - employment: { subtype: 'full_time', type: 'employee' }, - employment_status: 'active', - encrypted_ssn: 'encrypted_ssn', - end_date: 'end_date', - ethnicity: 'asian', - first_name: 'first_name', - flsa_status: 'exempt', - gender: 'female', - income: { - amount: 0, - currency: 'currency', - effective_date: '2019-12-27', - unit: 'yearly', - }, - income_history: [ - { - amount: 0, - currency: 'currency', - effective_date: '2019-12-27', - unit: 'yearly', - }, - ], - is_active: true, - last_name: 'last_name', - latest_rehire_date: 'latest_rehire_date', - location: { - city: 'city', - country: 'country', - line1: 'line1', - line2: 'line2', - postal_code: 'postal_code', - state: 'state', - name: 'name', - source_id: 'source_id', - }, - manager: { id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }, - middle_name: 'middle_name', - phone_numbers: [{ data: 'data', type: 'work' }], - preferred_name: 'preferred_name', - residence: { - city: 'city', - country: 'country', - line1: 'line1', - line2: 'line2', - postal_code: 'postal_code', - state: 'state', - name: 'name', - source_id: 'source_id', - }, - source_id: 'source_id', - ssn: 'ssn', - start_date: 'start_date', - title: 'title', - }, - ], - }, - { path: '/_stainless_unknown_path' }, - ), - ).rejects.toThrow(Finch.NotFoundError); + await expect(client.sandbox.directory.create({ body: [{ + class_code: 'class_code', + custom_fields: [{ + name: 'name', + value: {}, + }], + department: { name: 'name' }, + dob: 'dob', + emails: [{ data: 'data', type: 'work' }], + employment: { subtype: 'full_time', type: 'employee' }, + employment_status: 'active', + encrypted_ssn: 'encrypted_ssn', + end_date: 'end_date', + ethnicity: 'asian', + first_name: 'first_name', + flsa_status: 'exempt', + gender: 'female', + income: { + amount: 0, + currency: 'currency', + effective_date: '2019-12-27', + unit: 'yearly', + }, + income_history: [{ + amount: 0, + currency: 'currency', + effective_date: '2019-12-27', + unit: 'yearly', + }], + is_active: true, + last_name: 'last_name', + latest_rehire_date: 'latest_rehire_date', + location: { + city: 'city', + country: 'country', + line1: 'line1', + line2: 'line2', + postal_code: 'postal_code', + state: 'state', + name: 'name', + source_id: 'source_id', + }, + manager: { id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }, + middle_name: 'middle_name', + phone_numbers: [{ data: 'data', type: 'work' }], + preferred_name: 'preferred_name', + residence: { + city: 'city', + country: 'country', + line1: 'line1', + line2: 'line2', + postal_code: 'postal_code', + state: 'state', + name: 'name', + source_id: 'source_id', + }, + source_id: 'source_id', + ssn: 'ssn', + start_date: 'start_date', + title: 'title', + }] }, { path: '/_stainless_unknown_path' })) + .rejects + .toThrow(Finch.NotFoundError); }); }); diff --git a/tests/api-resources/sandbox/employment.test.ts b/tests/api-resources/sandbox/employment.test.ts index afe83df9..2c48f52f 100644 --- a/tests/api-resources/sandbox/employment.test.ts +++ b/tests/api-resources/sandbox/employment.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', }); describe('resource employment', () => { @@ -23,58 +23,50 @@ describe('resource employment', () => { test('update: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect( - client.sandbox.employment.update( - 'individual_id', - { - class_code: 'class_code', - custom_fields: [ - { - name: 'name', - value: {}, - }, - ], - department: { name: 'name' }, - employment: { subtype: 'full_time', type: 'employee' }, - employment_status: 'active', - end_date: 'end_date', - first_name: 'first_name', - flsa_status: 'exempt', - income: { - amount: 0, - currency: 'currency', - effective_date: '2019-12-27', - unit: 'yearly', - }, - income_history: [ - { - amount: 0, - currency: 'currency', - effective_date: '2019-12-27', - unit: 'yearly', - }, - ], - is_active: true, - last_name: 'last_name', - latest_rehire_date: 'latest_rehire_date', - location: { - city: 'city', - country: 'country', - line1: 'line1', - line2: 'line2', - postal_code: 'postal_code', - state: 'state', - name: 'name', - source_id: 'source_id', - }, - manager: { id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }, - middle_name: 'middle_name', - source_id: 'source_id', - start_date: 'start_date', - title: 'title', - }, - { path: '/_stainless_unknown_path' }, - ), - ).rejects.toThrow(Finch.NotFoundError); + await expect(client.sandbox.employment.update('individual_id', { + class_code: 'class_code', + custom_fields: [{ + name: 'name', + value: {}, + }], + department: { name: 'name' }, + employment: { subtype: 'full_time', type: 'employee' }, + employment_status: 'active', + end_date: 'end_date', + first_name: 'first_name', + flsa_status: 'exempt', + income: { + amount: 0, + currency: 'currency', + effective_date: '2019-12-27', + unit: 'yearly', + }, + income_history: [{ + amount: 0, + currency: 'currency', + effective_date: '2019-12-27', + unit: 'yearly', + }], + is_active: true, + last_name: 'last_name', + latest_rehire_date: 'latest_rehire_date', + location: { + city: 'city', + country: 'country', + line1: 'line1', + line2: 'line2', + postal_code: 'postal_code', + state: 'state', + name: 'name', + source_id: 'source_id', + }, + manager: { id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }, + middle_name: 'middle_name', + source_id: 'source_id', + start_date: 'start_date', + title: 'title', + }, { path: '/_stainless_unknown_path' })) + .rejects + .toThrow(Finch.NotFoundError); }); }); diff --git a/tests/api-resources/sandbox/individual.test.ts b/tests/api-resources/sandbox/individual.test.ts index 2f3a18e0..36c773b0 100644 --- a/tests/api-resources/sandbox/individual.test.ts +++ b/tests/api-resources/sandbox/individual.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', }); describe('resource individual', () => { @@ -23,34 +23,30 @@ describe('resource individual', () => { test('update: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect( - client.sandbox.individual.update( - 'individual_id', - { - dob: 'dob', - emails: [{ data: 'data', type: 'work' }], - encrypted_ssn: 'encrypted_ssn', - ethnicity: 'asian', - first_name: 'first_name', - gender: 'female', - last_name: 'last_name', - middle_name: 'middle_name', - phone_numbers: [{ data: 'data', type: 'work' }], - preferred_name: 'preferred_name', - residence: { - city: 'city', - country: 'country', - line1: 'line1', - line2: 'line2', - postal_code: 'postal_code', - state: 'state', - name: 'name', - source_id: 'source_id', - }, - ssn: 'ssn', - }, - { path: '/_stainless_unknown_path' }, - ), - ).rejects.toThrow(Finch.NotFoundError); + await expect(client.sandbox.individual.update('individual_id', { + dob: 'dob', + emails: [{ data: 'data', type: 'work' }], + encrypted_ssn: 'encrypted_ssn', + ethnicity: 'asian', + first_name: 'first_name', + gender: 'female', + last_name: 'last_name', + middle_name: 'middle_name', + phone_numbers: [{ data: 'data', type: 'work' }], + preferred_name: 'preferred_name', + residence: { + city: 'city', + country: 'country', + line1: 'line1', + line2: 'line2', + postal_code: 'postal_code', + state: 'state', + name: 'name', + source_id: 'source_id', + }, + ssn: 'ssn', + }, { path: '/_stainless_unknown_path' })) + .rejects + .toThrow(Finch.NotFoundError); }); }); diff --git a/tests/api-resources/sandbox/jobs/configuration.test.ts b/tests/api-resources/sandbox/jobs/configuration.test.ts index de15bc00..994c98bf 100644 --- a/tests/api-resources/sandbox/jobs/configuration.test.ts +++ b/tests/api-resources/sandbox/jobs/configuration.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', }); describe('resource configuration', () => { @@ -22,10 +22,7 @@ describe('resource configuration', () => { }); test('update: only required params', async () => { - const responsePromise = client.sandbox.jobs.configuration.update({ - completion_status: 'complete', - type: 'data_sync_all', - }); + const responsePromise = client.sandbox.jobs.configuration.update({ completion_status: 'complete', type: 'data_sync_all' }); const rawResponse = await responsePromise.asResponse(); expect(rawResponse).toBeInstanceOf(Response); const response = await responsePromise; @@ -36,9 +33,6 @@ describe('resource configuration', () => { }); test('update: required and optional params', async () => { - const response = await client.sandbox.jobs.configuration.update({ - completion_status: 'complete', - type: 'data_sync_all', - }); + const response = await client.sandbox.jobs.configuration.update({ completion_status: 'complete', type: 'data_sync_all' }); }); }); diff --git a/tests/api-resources/sandbox/jobs/jobs.test.ts b/tests/api-resources/sandbox/jobs/jobs.test.ts index 5ab4ceda..a0abf8b7 100644 --- a/tests/api-resources/sandbox/jobs/jobs.test.ts +++ b/tests/api-resources/sandbox/jobs/jobs.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', }); describe('resource jobs', () => { diff --git a/tests/api-resources/sandbox/payment.test.ts b/tests/api-resources/sandbox/payment.test.ts index a5918dfa..d1202eb1 100644 --- a/tests/api-resources/sandbox/payment.test.ts +++ b/tests/api-resources/sandbox/payment.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', }); describe('resource payment', () => { @@ -23,55 +23,42 @@ describe('resource payment', () => { test('create: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect( - client.sandbox.payment.create( - { - end_date: '2019-12-27', - pay_statements: [ - { - individual_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', - earnings: [ - { - amount: 0, - hours: 0, - name: 'x', - type: 'bonus', - }, - ], - employee_deductions: [ - { - amount: 0, - name: 'x', - pre_tax: true, - type: '457', - }, - ], - employer_contributions: [ - { - amount: 0, - name: 'x', - type: '457', - }, - ], - gross_pay: 1, - net_pay: 9007199254740991, - payment_method: 'check', - taxes: [ - { - amount: 0, - employer: true, - name: 'x', - type: 'federal', - }, - ], - total_hours: 1, - type: 'off_cycle_payroll', - }, - ], - start_date: '2019-12-27', - }, - { path: '/_stainless_unknown_path' }, - ), - ).rejects.toThrow(Finch.NotFoundError); + await expect(client.sandbox.payment.create({ + end_date: '2019-12-27', + pay_statements: [{ + individual_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', + earnings: [{ + amount: 0, + hours: 0, + name: 'x', + type: 'bonus', + }], + employee_deductions: [{ + amount: 0, + name: 'x', + pre_tax: true, + type: '457', + }], + employer_contributions: [{ + amount: 0, + name: 'x', + type: '457', + }], + gross_pay: 1, + net_pay: 9007199254740991, + payment_method: 'check', + taxes: [{ + amount: 0, + employer: true, + name: 'x', + type: 'federal', + }], + total_hours: 1, + type: 'off_cycle_payroll', + }], + start_date: '2019-12-27', + }, { path: '/_stainless_unknown_path' })) + .rejects + .toThrow(Finch.NotFoundError); }); }); diff --git a/tests/index.test.ts b/tests/index.test.ts index 3ef75699..02b4d743 100644 --- a/tests/index.test.ts +++ b/tests/index.test.ts @@ -21,12 +21,12 @@ describe('instantiate client', () => { describe('defaultHeaders', () => { const client = new Finch({ - baseURL: 'http://localhost:5000/', - defaultHeaders: { 'X-My-Default-Header': '2' }, - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); + baseURL: 'http://localhost:5000/', + defaultHeaders: { 'X-My-Default-Header': '2' }, + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', +}) test('they are used in the request', async () => { const { req } = await client.buildRequest({ path: '/foo', method: 'post' }); @@ -51,223 +51,221 @@ describe('instantiate client', () => { expect(req.headers.has('x-my-default-header')).toBe(false); }); }); - describe('logging', () => { - const env = process.env; +describe('logging', () => { + const env = process.env; - beforeEach(() => { - process.env = { ...env }; - process.env['FINCH_LOG'] = undefined; - }); + beforeEach(() => { + process.env = { ...env }; + process.env['FINCH_LOG'] = undefined; + }); - afterEach(() => { - process.env = env; - }); + afterEach(() => { + process.env = env; + }); - const forceAPIResponseForClient = async (client: Finch) => { - await new APIPromise( - client, - Promise.resolve({ - response: new Response(), - controller: new AbortController(), - requestLogID: 'log_000000', - retryOfRequestLogID: undefined, - startTime: Date.now(), - options: { - method: 'get', - path: '/', - }, - }), - ); + const forceAPIResponseForClient = async (client: Finch) => { + await new APIPromise( + client, + Promise.resolve({ + response: new Response(), + controller: new AbortController(), + requestLogID: 'log_000000', + retryOfRequestLogID: undefined, + startTime: Date.now(), + options: { + method: 'get', + path: '/', + }, + }), + ); + }; + + test('debug logs when log level is debug', async () => { + const debugMock = jest.fn(); + const logger = { + debug: debugMock, + info: jest.fn(), + warn: jest.fn(), + error: jest.fn(), }; - test('debug logs when log level is debug', async () => { - const debugMock = jest.fn(); - const logger = { - debug: debugMock, - info: jest.fn(), - warn: jest.fn(), - error: jest.fn(), - }; - - const client = new Finch({ - logger: logger, - logLevel: 'debug', - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); + const client = new Finch({ + logger: logger, + logLevel: 'debug', + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', +}); - await forceAPIResponseForClient(client); - expect(debugMock).toHaveBeenCalled(); - }); + await forceAPIResponseForClient(client); + expect(debugMock).toHaveBeenCalled(); + }); - test('default logLevel is warn', async () => { - const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); - expect(client.logLevel).toBe('warn'); - }); + test('default logLevel is warn', async () => { + const client = new Finch({ + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', +}); + expect(client.logLevel).toBe('warn'); + }); - test('debug logs are skipped when log level is info', async () => { - const debugMock = jest.fn(); - const logger = { - debug: debugMock, - info: jest.fn(), - warn: jest.fn(), - error: jest.fn(), - }; + test('debug logs are skipped when log level is info', async () => { + const debugMock = jest.fn(); + const logger = { + debug: debugMock, + info: jest.fn(), + warn: jest.fn(), + error: jest.fn(), + }; - const client = new Finch({ - logger: logger, - logLevel: 'info', - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); + const client = new Finch({ + logger: logger, + logLevel: 'info', + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', +}); - await forceAPIResponseForClient(client); - expect(debugMock).not.toHaveBeenCalled(); - }); + await forceAPIResponseForClient(client); + expect(debugMock).not.toHaveBeenCalled(); + }); - test('debug logs happen with debug env var', async () => { - const debugMock = jest.fn(); - const logger = { - debug: debugMock, - info: jest.fn(), - warn: jest.fn(), - error: jest.fn(), - }; + test('debug logs happen with debug env var', async () => { + const debugMock = jest.fn(); + const logger = { + debug: debugMock, + info: jest.fn(), + warn: jest.fn(), + error: jest.fn(), + }; - process.env['FINCH_LOG'] = 'debug'; - const client = new Finch({ - logger: logger, - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); - expect(client.logLevel).toBe('debug'); + process.env['FINCH_LOG'] = 'debug'; + const client = new Finch({ + logger: logger, + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', +}); + expect(client.logLevel).toBe('debug'); - await forceAPIResponseForClient(client); - expect(debugMock).toHaveBeenCalled(); - }); + await forceAPIResponseForClient(client); + expect(debugMock).toHaveBeenCalled(); + }); - test('warn when env var level is invalid', async () => { - const warnMock = jest.fn(); - const logger = { - debug: jest.fn(), - info: jest.fn(), - warn: warnMock, - error: jest.fn(), - }; + test('warn when env var level is invalid', async () => { + const warnMock = jest.fn(); + const logger = { + debug: jest.fn(), + info: jest.fn(), + warn: warnMock, + error: jest.fn(), + }; - process.env['FINCH_LOG'] = 'not a log level'; - const client = new Finch({ - logger: logger, - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); - expect(client.logLevel).toBe('warn'); - expect(warnMock).toHaveBeenCalledWith( - 'process.env[\'FINCH_LOG\'] was set to "not a log level", expected one of ["off","error","warn","info","debug"]', - ); - }); + process.env['FINCH_LOG'] = 'not a log level'; + const client = new Finch({ + logger: logger, + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', +}); + expect(client.logLevel).toBe('warn'); + expect(warnMock).toHaveBeenCalledWith('process.env[\'FINCH_LOG\'] was set to "not a log level", expected one of ["off","error","warn","info","debug"]'); + }); - test('client log level overrides env var', async () => { - const debugMock = jest.fn(); - const logger = { - debug: debugMock, - info: jest.fn(), - warn: jest.fn(), - error: jest.fn(), - }; + test('client log level overrides env var', async () => { + const debugMock = jest.fn(); + const logger = { + debug: debugMock, + info: jest.fn(), + warn: jest.fn(), + error: jest.fn(), + }; - process.env['FINCH_LOG'] = 'debug'; - const client = new Finch({ - logger: logger, - logLevel: 'off', - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); + process.env['FINCH_LOG'] = 'debug'; + const client = new Finch({ + logger: logger, + logLevel: 'off', + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', +}); - await forceAPIResponseForClient(client); - expect(debugMock).not.toHaveBeenCalled(); - }); + await forceAPIResponseForClient(client); + expect(debugMock).not.toHaveBeenCalled(); + }); - test('no warning logged for invalid env var level + valid client level', async () => { - const warnMock = jest.fn(); - const logger = { - debug: jest.fn(), - info: jest.fn(), - warn: warnMock, - error: jest.fn(), - }; + test('no warning logged for invalid env var level + valid client level', async () => { + const warnMock = jest.fn(); + const logger = { + debug: jest.fn(), + info: jest.fn(), + warn: warnMock, + error: jest.fn(), + }; - process.env['FINCH_LOG'] = 'not a log level'; - const client = new Finch({ - logger: logger, - logLevel: 'debug', - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); - expect(client.logLevel).toBe('debug'); - expect(warnMock).not.toHaveBeenCalled(); - }); + process.env['FINCH_LOG'] = 'not a log level'; + const client = new Finch({ + logger: logger, + logLevel: 'debug', + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', +}); + expect(client.logLevel).toBe('debug'); + expect(warnMock).not.toHaveBeenCalled(); }); +}); describe('defaultQuery', () => { test('with null query params given', () => { const client = new Finch({ - baseURL: 'http://localhost:5000/', - defaultQuery: { apiVersion: 'foo' }, - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); + baseURL: 'http://localhost:5000/', + defaultQuery: { apiVersion: 'foo' }, + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', +}); expect(client.buildURL('/foo', null)).toEqual('http://localhost:5000/foo?apiVersion=foo'); }); test('multiple default query params', () => { const client = new Finch({ - baseURL: 'http://localhost:5000/', - defaultQuery: { apiVersion: 'foo', hello: 'world' }, - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); + baseURL: 'http://localhost:5000/', + defaultQuery: { apiVersion: 'foo', hello: 'world' }, + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', +}); expect(client.buildURL('/foo', null)).toEqual('http://localhost:5000/foo?apiVersion=foo&hello=world'); }); test('overriding with `undefined`', () => { const client = new Finch({ - baseURL: 'http://localhost:5000/', - defaultQuery: { hello: 'world' }, - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); + baseURL: 'http://localhost:5000/', + defaultQuery: { hello: 'world' }, + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', +}) expect(client.buildURL('/foo', { hello: undefined })).toEqual('http://localhost:5000/foo'); }); }); test('custom fetch', async () => { const client = new Finch({ - baseURL: 'http://localhost:5000/', - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - fetch: (url) => { - return Promise.resolve( - new Response(JSON.stringify({ url, custom: true }), { - headers: { 'Content-Type': 'application/json' }, - }), - ); - }, - }); + baseURL: 'http://localhost:5000/', + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + fetch: (url) => { + return Promise.resolve( + new Response(JSON.stringify({ url, custom: true }), { + headers: { 'Content-Type': 'application/json' }, + }), + ); +}, +}); const response = await client.get('/foo'); expect(response).toEqual({ url: 'http://localhost:5000/foo', custom: true }); @@ -276,39 +274,41 @@ describe('instantiate client', () => { test('explicit global fetch', async () => { // make sure the global fetch type is assignable to our Fetch type const client = new Finch({ - baseURL: 'http://localhost:5000/', - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - fetch: defaultFetch, - }); + baseURL: 'http://localhost:5000/', + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + fetch: defaultFetch, +}); }); test('custom signal', async () => { const client = new Finch({ - baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - fetch: (...args) => { - return new Promise((resolve, reject) => - setTimeout( - () => - defaultFetch(...args) - .then(resolve) - .catch(reject), - 300, - ), - ); - }, - }); + baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + fetch: (...args) => { + return new Promise((resolve, reject) => + setTimeout( + () => + defaultFetch(...args) + .then(resolve) + .catch(reject), + 300, + ), + ); +}, +}); const controller = new AbortController(); setTimeout(() => controller.abort(), 200); const spy = jest.spyOn(client, 'request'); - await expect(client.get('/foo', { signal: controller.signal })).rejects.toThrowError(APIUserAbortError); + await expect(client.get('/foo', { signal: controller.signal })).rejects.toThrowError( + APIUserAbortError, + ); expect(spy).toHaveBeenCalledTimes(1); }); @@ -320,12 +320,12 @@ describe('instantiate client', () => { }; const client = new Finch({ - baseURL: 'http://localhost:5000/', - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - fetch: testFetch, - }); + baseURL: 'http://localhost:5000/', + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + fetch: testFetch, +}); await client.patch('/foo'); expect(capturedRequest?.method).toEqual('PATCH'); @@ -334,21 +334,21 @@ describe('instantiate client', () => { describe('baseUrl', () => { test('trailing slash', () => { const client = new Finch({ - baseURL: 'http://localhost:5000/custom/path/', - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); + baseURL: 'http://localhost:5000/custom/path/', + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', +}); expect(client.buildURL('/foo', null)).toEqual('http://localhost:5000/custom/path/foo'); }); test('no trailing slash', () => { const client = new Finch({ - baseURL: 'http://localhost:5000/custom/path', - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); + baseURL: 'http://localhost:5000/custom/path', + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', +}); expect(client.buildURL('/foo', null)).toEqual('http://localhost:5000/custom/path/foo'); }); @@ -358,107 +358,101 @@ describe('instantiate client', () => { test('explicit option', () => { const client = new Finch({ - baseURL: 'https://example.com', - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); + baseURL: 'https://example.com', + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', +}); expect(client.baseURL).toEqual('https://example.com'); }); test('env variable', () => { process.env['FINCH_BASE_URL'] = 'https://example.com/from_env'; const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', +}); expect(client.baseURL).toEqual('https://example.com/from_env'); }); test('empty env variable', () => { process.env['FINCH_BASE_URL'] = ''; // empty const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); - expect(client.baseURL).toEqual('https://api.tryfinch.com'); + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); + expect(client.baseURL).toEqual('https://api.tryfinch.com') }); test('blank env variable', () => { process.env['FINCH_BASE_URL'] = ' '; // blank const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); - expect(client.baseURL).toEqual('https://api.tryfinch.com'); + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); + expect(client.baseURL).toEqual('https://api.tryfinch.com') }); test('in request options', () => { const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); - expect(client.buildURL('/foo', null, 'http://localhost:5000/option')).toEqual( - 'http://localhost:5000/option/foo', - ); + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); + expect(client.buildURL('/foo', null, 'http://localhost:5000/option')).toEqual('http://localhost:5000/option/foo'); }); test('in request options overridden by client options', () => { const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - baseURL: 'http://localhost:5000/client', - }); - expect(client.buildURL('/foo', null, 'http://localhost:5000/option')).toEqual( - 'http://localhost:5000/client/foo', - ); + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + baseURL: 'http://localhost:5000/client', + }); + expect(client.buildURL('/foo', null, 'http://localhost:5000/option')).toEqual('http://localhost:5000/client/foo'); }); test('in request options overridden by env variable', () => { process.env['FINCH_BASE_URL'] = 'http://localhost:5000/env'; const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); - expect(client.buildURL('/foo', null, 'http://localhost:5000/option')).toEqual( - 'http://localhost:5000/env/foo', - ); + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); + expect(client.buildURL('/foo', null, 'http://localhost:5000/option')).toEqual('http://localhost:5000/env/foo'); }); }); test('maxRetries option is correctly set', () => { const client = new Finch({ - maxRetries: 4, - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); + maxRetries: 4, + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', +}); expect(client.maxRetries).toEqual(4); // default const client2 = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', +}); expect(client2.maxRetries).toEqual(2); }); describe('withOptions', () => { test('creates a new client with overridden options', async () => { const client = new Finch({ - baseURL: 'http://localhost:5000/', - maxRetries: 3, - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); + baseURL: 'http://localhost:5000/', + maxRetries: 3, + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); const newClient = client.withOptions({ maxRetries: 5, @@ -480,13 +474,13 @@ describe('instantiate client', () => { test('inherits options from the parent client', async () => { const client = new Finch({ - baseURL: 'http://localhost:5000/', - defaultHeaders: { 'X-Test-Header': 'test-value' }, - defaultQuery: { 'test-param': 'test-value' }, - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); + baseURL: 'http://localhost:5000/', + defaultHeaders: { 'X-Test-Header': 'test-value' }, + defaultQuery: { 'test-param': 'test-value' }, + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); const newClient = client.withOptions({ baseURL: 'http://localhost:5001/', @@ -501,12 +495,12 @@ describe('instantiate client', () => { test('respects runtime property changes when creating new client', () => { const client = new Finch({ - baseURL: 'http://localhost:5000/', - timeout: 1000, - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); + baseURL: 'http://localhost:5000/', + timeout: 1000, + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); // Modify the client properties directly after creation client.baseURL = 'http://localhost:6000/'; @@ -559,33 +553,28 @@ describe('instantiate client', () => { describe('request building', () => { const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', +}); describe('custom headers', () => { test('handles undefined', async () => { - const { req } = await client.buildRequest({ - path: '/foo', - method: 'post', - body: { value: 'hello' }, - headers: { 'X-Foo': 'baz', 'x-foo': 'bar', 'x-Foo': undefined, 'x-baz': 'bam', 'X-Baz': null }, - }); + const { req } = await client.buildRequest({ path: '/foo', method: 'post', body: { value: 'hello' }, headers: { 'X-Foo': 'baz', 'x-foo': 'bar', 'x-Foo': undefined, 'x-baz': 'bam', 'X-Baz': null } }); expect(req.headers.get('x-foo')).toEqual('bar'); expect(req.headers.get('x-Foo')).toEqual('bar'); expect(req.headers.get('X-Foo')).toEqual('bar'); expect(req.headers.get('x-baz')).toEqual(null); }); - }); + }) }); describe('default encoder', () => { const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', +}); class Serializable { toJSON() { @@ -658,42 +647,39 @@ describe('default encoder', () => { describe('retries', () => { test('retry on timeout', async () => { let count = 0; - const testFetch = async ( - url: string | URL | Request, - { signal }: RequestInit = {}, - ): Promise => { - if (count++ === 0) { - return new Promise( - (resolve, reject) => signal?.addEventListener('abort', () => reject(new Error('timed out'))), - ); - } - return new Response(JSON.stringify({ a: 1 }), { headers: { 'Content-Type': 'application/json' } }); - }; - - const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - timeout: 10, - fetch: testFetch, - }); + const testFetch = async (url: string | URL | Request, { signal }: RequestInit = {}): Promise => { + if (count++ === 0) { + return new Promise((resolve, reject) => + signal?.addEventListener('abort', () => reject(new Error('timed out'))), + ); + } + return new Response(JSON.stringify({ a: 1 }), { headers: { 'Content-Type': 'application/json' } }); + }; - expect(await client.request({ path: '/foo', method: 'get' })).toEqual({ a: 1 }); - expect(count).toEqual(2); - expect( - await client - .request({ path: '/foo', method: 'get' }) - .asResponse() - .then((r) => r.text()), - ).toEqual(JSON.stringify({ a: 1 })); - expect(count).toEqual(3); + const client = new Finch({ + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + timeout: 10, + fetch: testFetch, }); + expect(await client.request({ path: '/foo', method: 'get' })).toEqual({ a: 1 }); + expect(count).toEqual(2); + expect( + await client + .request({ path: '/foo', method: 'get' }) + .asResponse() + .then((r) => r.text()), + ).toEqual(JSON.stringify({ a: 1 })); + expect(count).toEqual(3); + }); + test('retry count header', async () => { let count = 0; let capturedRequest: RequestInit | undefined; const testFetch = async (url: string | URL | Request, init: RequestInit = {}): Promise => { - count++; + count++ if (count <= 2) { return new Response(undefined, { status: 429, @@ -707,12 +693,12 @@ describe('retries', () => { }; const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - fetch: testFetch, - maxRetries: 4, - }); + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + fetch: testFetch, + maxRetries: 4, + }); expect(await client.request({ path: '/foo', method: 'get' })).toEqual({ a: 1 }); @@ -724,7 +710,7 @@ describe('retries', () => { let count = 0; let capturedRequest: RequestInit | undefined; const testFetch = async (url: string | URL | Request, init: RequestInit = {}): Promise => { - count++; + count++ if (count <= 2) { return new Response(undefined, { status: 429, @@ -737,12 +723,12 @@ describe('retries', () => { return new Response(JSON.stringify({ a: 1 }), { headers: { 'Content-Type': 'application/json' } }); }; const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - fetch: testFetch, - maxRetries: 4, - }); + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + fetch: testFetch, + maxRetries: 4, + }); expect( await client.request({ @@ -759,7 +745,7 @@ describe('retries', () => { let count = 0; let capturedRequest: RequestInit | undefined; const testFetch = async (url: string | URL | Request, init: RequestInit = {}): Promise => { - count++; + count++ if (count <= 2) { return new Response(undefined, { status: 429, @@ -772,13 +758,13 @@ describe('retries', () => { return new Response(JSON.stringify({ a: 1 }), { headers: { 'Content-Type': 'application/json' } }); }; const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - fetch: testFetch, - maxRetries: 4, - defaultHeaders: { 'X-Stainless-Retry-Count': null }, - }); + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + fetch: testFetch, + maxRetries: 4, + defaultHeaders: { 'X-Stainless-Retry-Count': null }, + }); expect( await client.request({ @@ -794,7 +780,7 @@ describe('retries', () => { let count = 0; let capturedRequest: RequestInit | undefined; const testFetch = async (url: string | URL | Request, init: RequestInit = {}): Promise => { - count++; + count++ if (count <= 2) { return new Response(undefined, { status: 429, @@ -807,12 +793,12 @@ describe('retries', () => { return new Response(JSON.stringify({ a: 1 }), { headers: { 'Content-Type': 'application/json' } }); }; const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - fetch: testFetch, - maxRetries: 4, - }); + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + fetch: testFetch, + maxRetries: 4, + }); expect( await client.request({ @@ -827,10 +813,7 @@ describe('retries', () => { test('retry on 429 with retry-after', async () => { let count = 0; - const testFetch = async ( - url: string | URL | Request, - { signal }: RequestInit = {}, - ): Promise => { + const testFetch = async (url: string | URL | Request, { signal }: RequestInit = {}): Promise => { if (count++ === 0) { return new Response(undefined, { status: 429, @@ -843,11 +826,11 @@ describe('retries', () => { }; const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - fetch: testFetch, - }); + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + fetch: testFetch, + }); expect(await client.request({ path: '/foo', method: 'get' })).toEqual({ a: 1 }); expect(count).toEqual(2); @@ -862,10 +845,7 @@ describe('retries', () => { test('retry on 429 with retry-after-ms', async () => { let count = 0; - const testFetch = async ( - url: string | URL | Request, - { signal }: RequestInit = {}, - ): Promise => { + const testFetch = async (url: string | URL | Request, { signal }: RequestInit = {}): Promise => { if (count++ === 0) { return new Response(undefined, { status: 429, @@ -878,11 +858,11 @@ describe('retries', () => { }; const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - fetch: testFetch, - }); + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + fetch: testFetch, + }); expect(await client.request({ path: '/foo', method: 'get' })).toEqual({ a: 1 }); expect(count).toEqual(2); diff --git a/tests/qs/utils.test.ts b/tests/qs/utils.test.ts index 6636cee5..74dd17c1 100644 --- a/tests/qs/utils.test.ts +++ b/tests/qs/utils.test.ts @@ -66,7 +66,7 @@ describe('merge()', function () { // st.equal(getCount, 1); expect(setCount).toEqual(0); expect(getCount).toEqual(1); - observed[0] = observed[0]; + observed[0] = observed[0]; // st.equal(setCount, 1); // st.equal(getCount, 2); expect(setCount).toEqual(1); diff --git a/tests/stringifyQuery.test.ts b/tests/stringifyQuery.test.ts index ab8e2f49..45f878d9 100644 --- a/tests/stringifyQuery.test.ts +++ b/tests/stringifyQuery.test.ts @@ -2,20 +2,18 @@ import { stringifyQuery } from '@tryfinch/finch-api/internal/utils/query'; -describe(stringifyQuery, () => { - for (const [input, expected] of [ - [{ a: '1', b: 2, c: true }, 'a=1&b=2&c=true'], - [{ a: null, b: false, c: undefined }, 'a=&b=false'], - [{ 'a/b': 1.28341 }, `${encodeURIComponent('a/b')}=1.28341`], - [ - { 'a/b': 'c/d', 'e=f': 'g&h' }, - `${encodeURIComponent('a/b')}=${encodeURIComponent('c/d')}&${encodeURIComponent( - 'e=f', - )}=${encodeURIComponent('g&h')}`, - ], - ] as const) { - it(`${JSON.stringify(input)} -> ${expected}`, () => { - expect(stringifyQuery(input)).toEqual(expected); - }); - } -}); +describe(stringifyQuery, () => { for (const [input, expected] of [ + [{ a: '1', b: 2, c: true }, 'a=1&b=2&c=true'], + [{ a: null, b: false, c: undefined }, 'a=&b=false'], + [{ 'a/b': 1.28341 }, `${encodeURIComponent('a/b')}=1.28341`], + [ + { 'a/b': 'c/d', 'e=f': 'g&h' }, + `${encodeURIComponent('a/b')}=${encodeURIComponent('c/d')}&${encodeURIComponent( + 'e=f', + )}=${encodeURIComponent('g&h')}`, + ], +] as const) { + it(`${JSON.stringify(input)} -> ${expected}`, () => { + expect(stringifyQuery(input)).toEqual(expected); + }); +} }) diff --git a/yarn.lock b/yarn.lock index 62f7eb60..efb31bcc 100644 --- a/yarn.lock +++ b/yarn.lock @@ -714,11 +714,6 @@ "@nodelib/fs.scandir" "2.1.5" fastq "^1.6.0" -"@pkgr/core@^0.2.4": - version "0.2.4" - resolved "https://registry.yarnpkg.com/@pkgr/core/-/core-0.2.4.tgz#d897170a2b0ba51f78a099edccd968f7b103387c" - integrity sha512-ROFF39F6ZrnzSUEmQQZUar0Jt4xVoP9WnDRdWwF4NNcXs3xBTLgBUDoOwW141y1jP+S8nahIbdxbFC7IShw9Iw== - "@sinclair/typebox@^0.27.8": version "0.27.8" resolved "https://registry.yarnpkg.com/@sinclair/typebox/-/typebox-0.27.8.tgz#6667fac16c436b5434a387a34dedb013198f6e6e" @@ -1520,14 +1515,6 @@ escape-string-regexp@^4.0.0: resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz#14ba83a5d373e3d311e5afca29cf5bfad965bf34" integrity sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA== -eslint-plugin-prettier@^5.4.1: - version "5.4.1" - resolved "https://registry.yarnpkg.com/eslint-plugin-prettier/-/eslint-plugin-prettier-5.4.1.tgz#99b55d7dd70047886b2222fdd853665f180b36af" - integrity sha512-9dF+KuU/Ilkq27A8idRP7N2DH8iUR6qXcjF3FR2wETY21PZdBrIjwCau8oboyGj9b7etWmTGEeM8e7oOed6ZWg== - dependencies: - prettier-linter-helpers "^1.0.0" - synckit "^0.11.7" - eslint-plugin-unused-imports@^4.1.4: version "4.1.4" resolved "https://registry.yarnpkg.com/eslint-plugin-unused-imports/-/eslint-plugin-unused-imports-4.1.4.tgz#62ddc7446ccbf9aa7b6f1f0b00a980423cda2738" @@ -1679,11 +1666,6 @@ fast-deep-equal@^3.1.1, fast-deep-equal@^3.1.3: resolved "https://registry.yarnpkg.com/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz#3a7d56b559d6cbc3eb512325244e619a65c6c525" integrity sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q== -fast-diff@^1.1.2: - version "1.3.0" - resolved "https://registry.yarnpkg.com/fast-diff/-/fast-diff-1.3.0.tgz#ece407fa550a64d638536cd727e129c61616e0f0" - integrity sha512-VxPP4NqbUjj6MaAOafWeUn2cXWLcCtljklUtZf0Ind4XQ+QPtmA0b18zZy0jIQx+ExRVCR/ZQpBmik5lXshNsw== - fast-glob@^3.3.2: version "3.3.2" resolved "https://registry.yarnpkg.com/fast-glob/-/fast-glob-3.3.2.tgz#a904501e57cfdd2ffcded45e99a54fef55e46129" @@ -2846,13 +2828,6 @@ prelude-ls@^1.2.1: resolved "https://registry.yarnpkg.com/prelude-ls/-/prelude-ls-1.2.1.tgz#debc6489d7a6e6b0e7611888cec880337d316396" integrity sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g== -prettier-linter-helpers@^1.0.0: - version "1.0.0" - resolved "https://registry.yarnpkg.com/prettier-linter-helpers/-/prettier-linter-helpers-1.0.0.tgz#d23d41fe1375646de2d0104d3454a3008802cf7b" - integrity sha512-GbK2cP9nraSSUF9N2XwUwqfzlAFlMNYYl+ShE/V+H8a9uNl/oUqB1w2EL54Jh0OlyRSd8RfWYJ3coVS4TROP2w== - dependencies: - fast-diff "^1.1.2" - prettier@^3.0.0: version "3.1.1" resolved "https://registry.yarnpkg.com/prettier/-/prettier-3.1.1.tgz#6ba9f23165d690b6cbdaa88cb0807278f7019848" @@ -3149,13 +3124,6 @@ supports-preserve-symlinks-flag@^1.0.0: resolved "https://registry.yarnpkg.com/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz#6eda4bd344a3c94aea376d4cc31bc77311039e09" integrity sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w== -synckit@^0.11.7: - version "0.11.8" - resolved "https://registry.yarnpkg.com/synckit/-/synckit-0.11.8.tgz#b2aaae998a4ef47ded60773ad06e7cb821f55457" - integrity sha512-+XZ+r1XGIJGeQk3VvXhT6xx/VpbHsRzsTkGgF6E5RX9TTXD0118l87puaEBZ566FhqblC6U0d4XnubznJDm30A== - dependencies: - "@pkgr/core" "^0.2.4" - test-exclude@^6.0.0: version "6.0.0" resolved "https://registry.yarnpkg.com/test-exclude/-/test-exclude-6.0.0.tgz#04a8698661d805ea6fa293b6cb9e63ac044ef15e" From fbbc840e907f54c6403793a483153aaad9f163dd Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 27 Apr 2026 20:30:20 +0000 Subject: [PATCH 07/14] chore(internal): codegen related update --- eslint.config.mjs | 3 + package.json | 1 + packages/mcp-server/jest.config.ts | 4 +- packages/mcp-server/src/auth.ts | 60 +- packages/mcp-server/src/code-tool-types.ts | 2 +- packages/mcp-server/src/code-tool-worker.ts | 112 +- packages/mcp-server/src/code-tool.ts | 144 +- packages/mcp-server/src/docs-search-tool.ts | 55 +- packages/mcp-server/src/http.ts | 68 +- packages/mcp-server/src/index.ts | 2 +- packages/mcp-server/src/instructions.ts | 20 +- packages/mcp-server/src/local-docs-search.ts | 4326 +++++++++-------- packages/mcp-server/src/methods.ts | 539 +- packages/mcp-server/src/options.ts | 47 +- packages/mcp-server/src/server.ts | 105 +- packages/mcp-server/src/types.ts | 80 +- scripts/fast-format | 6 +- scripts/format | 3 +- scripts/lint | 3 - scripts/utils/postprocess-files.cjs | 9 +- src/api-promise.ts | 2 +- src/client.ts | 392 +- src/core/api-promise.ts | 9 +- src/core/error.ts | 46 +- src/core/pagination.ts | 57 +- src/error.ts | 2 +- src/index.ts | 16 +- src/internal/builtin-types.ts | 23 +- src/internal/detect-platform.ts | 6 +- src/internal/errors.ts | 14 +- src/internal/headers.ts | 4 +- src/internal/parse.ts | 12 +- src/internal/qs/utils.ts | 5 +- src/internal/request-options.ts | 8 +- src/internal/shim-types.ts | 4 +- src/internal/shims.ts | 4 +- src/internal/to-file.ts | 14 +- src/internal/types.ts | 50 +- src/internal/utils/log.ts | 37 +- src/internal/utils/query.ts | 2 +- src/internal/utils/uuid.ts | 8 +- src/pagination.ts | 2 +- src/resource.ts | 2 +- src/resources/access-tokens.ts | 4 +- src/resources/account.ts | 18 +- src/resources/connect/connect.ts | 10 +- src/resources/connect/index.ts | 10 +- src/resources/connect/sessions.ts | 41 +- src/resources/hris/benefits/benefits.ts | 117 +- src/resources/hris/benefits/index.ts | 35 +- src/resources/hris/benefits/individuals.ts | 64 +- src/resources/hris/company/company.ts | 35 +- src/resources/hris/company/index.ts | 9 +- .../hris/company/pay-statement-item/index.ts | 20 +- .../pay-statement-item/pay-statement-item.ts | 30 +- .../hris/company/pay-statement-item/rules.ts | 58 +- src/resources/hris/directory.ts | 15 +- src/resources/hris/documents.ts | 29 +- src/resources/hris/employments.ts | 31 +- src/resources/hris/hris.ts | 100 +- src/resources/hris/index.ts | 72 +- src/resources/hris/individuals.ts | 32 +- src/resources/hris/pay-statements.ts | 35 +- src/resources/hris/payments.ts | 22 +- src/resources/index.ts | 43 +- src/resources/jobs/automated.ts | 17 +- src/resources/jobs/index.ts | 13 +- src/resources/jobs/jobs.ts | 16 +- src/resources/jobs/manual.ts | 6 +- src/resources/payroll/index.ts | 11 +- src/resources/payroll/pay-groups.ts | 51 +- src/resources/payroll/payroll.ts | 11 +- src/resources/providers.ts | 9 +- src/resources/request-forwarding.ts | 9 +- src/resources/sandbox/company.ts | 24 +- src/resources/sandbox/connections/accounts.ts | 19 +- .../sandbox/connections/connections.ts | 14 +- src/resources/sandbox/connections/index.ts | 10 +- src/resources/sandbox/directory.ts | 38 +- src/resources/sandbox/employment.ts | 34 +- src/resources/sandbox/index.ts | 16 +- src/resources/sandbox/individual.ts | 36 +- src/resources/sandbox/jobs/configuration.ts | 12 +- src/resources/sandbox/jobs/index.ts | 9 +- src/resources/sandbox/jobs/jobs.ts | 16 +- src/resources/sandbox/payment.ts | 66 +- src/resources/sandbox/sandbox.ts | 14 +- src/resources/shared.ts | 15 +- src/resources/webhooks.ts | 23 +- src/uploads.ts | 2 +- src/version.ts | 2 +- tests/api-resources/access-tokens.test.ts | 12 +- tests/api-resources/account.test.ts | 2 +- tests/api-resources/connect/sessions.test.ts | 40 +- .../hris/benefits/benefits.test.ts | 61 +- .../hris/benefits/individuals.test.ts | 78 +- .../hris/company/company.test.ts | 11 +- .../pay-statement-item.test.ts | 25 +- .../company/pay-statement-item/rules.test.ts | 70 +- tests/api-resources/hris/directory.test.ts | 36 +- tests/api-resources/hris/documents.test.ts | 33 +- tests/api-resources/hris/employments.test.ts | 11 +- tests/api-resources/hris/individuals.test.ts | 19 +- .../api-resources/hris/pay-statements.test.ts | 21 +- tests/api-resources/hris/payments.test.ts | 10 +- tests/api-resources/jobs/automated.test.ts | 8 +- tests/api-resources/jobs/manual.test.ts | 2 +- .../api-resources/payroll/pay-groups.test.ts | 29 +- tests/api-resources/providers.test.ts | 2 +- .../api-resources/request-forwarding.test.ts | 14 +- tests/api-resources/sandbox/company.test.ts | 96 +- .../sandbox/connections/accounts.test.ts | 26 +- .../sandbox/connections/connections.test.ts | 12 +- tests/api-resources/sandbox/directory.test.ts | 139 +- .../api-resources/sandbox/employment.test.ts | 100 +- .../api-resources/sandbox/individual.test.ts | 56 +- .../sandbox/jobs/configuration.test.ts | 12 +- tests/api-resources/sandbox/jobs/jobs.test.ts | 2 +- tests/api-resources/sandbox/payment.test.ts | 89 +- tests/index.test.ts | 740 +-- tests/qs/utils.test.ts | 2 +- tests/stringifyQuery.test.ts | 32 +- yarn.lock | 32 + 123 files changed, 5545 insertions(+), 3908 deletions(-) diff --git a/eslint.config.mjs b/eslint.config.mjs index 978d1f73..8dff6305 100644 --- a/eslint.config.mjs +++ b/eslint.config.mjs @@ -1,6 +1,7 @@ // @ts-check import tseslint from 'typescript-eslint'; import unusedImports from 'eslint-plugin-unused-imports'; +import prettier from 'eslint-plugin-prettier'; export default tseslint.config( { @@ -13,9 +14,11 @@ export default tseslint.config( plugins: { '@typescript-eslint': tseslint.plugin, 'unused-imports': unusedImports, + prettier, }, rules: { 'no-unused-vars': 'off', + 'prettier/prettier': 'error', 'unused-imports/no-unused-imports': 'error', 'no-restricted-imports': [ 'error', diff --git a/package.json b/package.json index 1140bba8..896f78bd 100644 --- a/package.json +++ b/package.json @@ -38,6 +38,7 @@ "@typescript-eslint/eslint-plugin": "8.31.1", "@typescript-eslint/parser": "8.31.1", "eslint": "^9.39.1", + "eslint-plugin-prettier": "^5.4.1", "eslint-plugin-unused-imports": "^4.1.4", "iconv-lite": "^0.6.3", "jest": "^29.4.0", diff --git a/packages/mcp-server/jest.config.ts b/packages/mcp-server/jest.config.ts index 787cf21f..53dd2a25 100644 --- a/packages/mcp-server/jest.config.ts +++ b/packages/mcp-server/jest.config.ts @@ -10,9 +10,7 @@ const config: JestConfigWithTsJest = { '^@tryfinch/finch-api-mcp$': '/src/index.ts', '^@tryfinch/finch-api-mcp/(.*)$': '/src/$1', }, - modulePathIgnorePatterns: [ - '/dist/', - ], + modulePathIgnorePatterns: ['/dist/'], testPathIgnorePatterns: ['scripts'], }; diff --git a/packages/mcp-server/src/auth.ts b/packages/mcp-server/src/auth.ts index 8e9ab8f3..35e3b55e 100644 --- a/packages/mcp-server/src/auth.ts +++ b/packages/mcp-server/src/auth.ts @@ -1,38 +1,52 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -import { IncomingMessage } from 'node:http' -import { ClientOptions } from '@tryfinch/finch-api' +import { IncomingMessage } from 'node:http'; +import { ClientOptions } from '@tryfinch/finch-api'; import { McpOptions } from './options'; -export const parseClientAuthHeaders = (req: IncomingMessage, required?: boolean): Partial => { if (req.headers.authorization) { - const scheme = req.headers.authorization.split(" ")[0]!; - const value = req.headers.authorization.slice(scheme.length + 1); - switch (scheme) { - case 'Bearer': - return { accessToken: req.headers.authorization.slice("Bearer ".length) }; - case 'Basic': - const rawValue = Buffer.from(value, 'base64').toString(); - return { clientID: rawValue.slice(0, rawValue.search(':')), clientSecret: rawValue.slice(rawValue.search(':') + 1) } - default: - throw new Error('Unsupported authorization scheme. Expected the "Authorization" header to be a supported scheme (Bearer, Basic).'); +export const parseClientAuthHeaders = (req: IncomingMessage, required?: boolean): Partial => { + if (req.headers.authorization) { + const scheme = req.headers.authorization.split(' ')[0]!; + const value = req.headers.authorization.slice(scheme.length + 1); + switch (scheme) { + case 'Bearer': + return { accessToken: req.headers.authorization.slice('Bearer '.length) }; + case 'Basic': + const rawValue = Buffer.from(value, 'base64').toString(); + return { + clientID: rawValue.slice(0, rawValue.search(':')), + clientSecret: rawValue.slice(rawValue.search(':') + 1), + }; + default: + throw new Error( + 'Unsupported authorization scheme. Expected the "Authorization" header to be a supported scheme (Bearer, Basic).', + ); + } + } else if (required) { + throw new Error('Missing required Authorization header; see WWW-Authenticate header for details.'); } -} else if (required) { - throw new Error('Missing required Authorization header; see WWW-Authenticate header for details.'); -} -const clientID = Array.isArray(req.headers['x-finch-client-id']) ? req.headers['x-finch-client-id'][0] : req.headers['x-finch-client-id'] -const clientSecret = Array.isArray(req.headers['x-finch-client-secret']) ? req.headers['x-finch-client-secret'][0] : req.headers['x-finch-client-secret'] -return {clientID, clientSecret}; } + const clientID = + Array.isArray(req.headers['x-finch-client-id']) ? + req.headers['x-finch-client-id'][0] + : req.headers['x-finch-client-id']; + const clientSecret = + Array.isArray(req.headers['x-finch-client-secret']) ? + req.headers['x-finch-client-secret'][0] + : req.headers['x-finch-client-secret']; + return { clientID, clientSecret }; +}; export const getStainlessApiKey = (req: IncomingMessage, mcpOptions: McpOptions): string | undefined => { // Try to get the key from the x-stainless-api-key header - const headerKey = Array.isArray(req.headers['x-stainless-api-key']) ? - req.headers['x-stainless-api-key'][0] - : req.headers['x-stainless-api-key']; + const headerKey = + Array.isArray(req.headers['x-stainless-api-key']) ? + req.headers['x-stainless-api-key'][0] + : req.headers['x-stainless-api-key']; if (headerKey && typeof headerKey === 'string') { return headerKey; } // Fall back to value set in the mcpOptions (e.g. from environment variable), if provided return mcpOptions.stainlessApiKey; -} +}; diff --git a/packages/mcp-server/src/code-tool-types.ts b/packages/mcp-server/src/code-tool-types.ts index 9f8000ab..6080d5b9 100644 --- a/packages/mcp-server/src/code-tool-types.ts +++ b/packages/mcp-server/src/code-tool-types.ts @@ -1,6 +1,6 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -import { ClientOptions } from '@tryfinch/finch-api' +import { ClientOptions } from '@tryfinch/finch-api'; export type WorkerInput = { project_name: string; diff --git a/packages/mcp-server/src/code-tool-worker.ts b/packages/mcp-server/src/code-tool-worker.ts index 7025c635..b8f7aa26 100644 --- a/packages/mcp-server/src/code-tool-worker.ts +++ b/packages/mcp-server/src/code-tool-worker.ts @@ -59,8 +59,8 @@ function getTSDiagnostics(code: string): string[] { const codeWithImport = [ 'import { Finch } from "@tryfinch/finch-api";', functionSource.type === 'declaration' ? - `async function run(${functionSource.client}: Finch)` : - `const run: (${functionSource.client}: Finch) => Promise =`, + `async function run(${functionSource.client}: Finch)` + : `const run: (${functionSource.client}: Finch) => Promise =`, functionSource.code, ].join('\n'); const sourcePath = path.resolve('code.ts'); @@ -108,53 +108,53 @@ function getTSDiagnostics(code: string): string[] { const fuse = new Fuse( [ - "client.accessTokens.create", - "client.hris.company.retrieve", - "client.hris.company.payStatementItem.list", - "client.hris.company.payStatementItem.rules.create", - "client.hris.company.payStatementItem.rules.delete", - "client.hris.company.payStatementItem.rules.list", - "client.hris.company.payStatementItem.rules.update", - "client.hris.directory.list", - "client.hris.directory.listIndividuals", - "client.hris.individuals.retrieveMany", - "client.hris.employments.retrieveMany", - "client.hris.payments.list", - "client.hris.payStatements.retrieveMany", - "client.hris.documents.list", - "client.hris.documents.retreive", - "client.hris.benefits.create", - "client.hris.benefits.list", - "client.hris.benefits.listSupportedBenefits", - "client.hris.benefits.retrieve", - "client.hris.benefits.update", - "client.hris.benefits.individuals.enrollMany", - "client.hris.benefits.individuals.enrolledIDs", - "client.hris.benefits.individuals.retrieveManyBenefits", - "client.hris.benefits.individuals.unenrollMany", - "client.providers.list", - "client.account.disconnect", - "client.account.introspect", - "client.requestForwarding.forward", - "client.jobs.automated.create", - "client.jobs.automated.list", - "client.jobs.automated.retrieve", - "client.jobs.manual.retrieve", - "client.sandbox.connections.create", - "client.sandbox.connections.accounts.create", - "client.sandbox.connections.accounts.update", - "client.sandbox.company.update", - "client.sandbox.directory.create", - "client.sandbox.individual.update", - "client.sandbox.employment.update", - "client.sandbox.payment.create", - "client.sandbox.jobs.create", - "client.sandbox.jobs.configuration.retrieve", - "client.sandbox.jobs.configuration.update", - "client.payroll.payGroups.list", - "client.payroll.payGroups.retrieve", - "client.connect.sessions.new", - "client.connect.sessions.reauthenticate" + 'client.accessTokens.create', + 'client.hris.company.retrieve', + 'client.hris.company.payStatementItem.list', + 'client.hris.company.payStatementItem.rules.create', + 'client.hris.company.payStatementItem.rules.delete', + 'client.hris.company.payStatementItem.rules.list', + 'client.hris.company.payStatementItem.rules.update', + 'client.hris.directory.list', + 'client.hris.directory.listIndividuals', + 'client.hris.individuals.retrieveMany', + 'client.hris.employments.retrieveMany', + 'client.hris.payments.list', + 'client.hris.payStatements.retrieveMany', + 'client.hris.documents.list', + 'client.hris.documents.retreive', + 'client.hris.benefits.create', + 'client.hris.benefits.list', + 'client.hris.benefits.listSupportedBenefits', + 'client.hris.benefits.retrieve', + 'client.hris.benefits.update', + 'client.hris.benefits.individuals.enrollMany', + 'client.hris.benefits.individuals.enrolledIDs', + 'client.hris.benefits.individuals.retrieveManyBenefits', + 'client.hris.benefits.individuals.unenrollMany', + 'client.providers.list', + 'client.account.disconnect', + 'client.account.introspect', + 'client.requestForwarding.forward', + 'client.jobs.automated.create', + 'client.jobs.automated.list', + 'client.jobs.automated.retrieve', + 'client.jobs.manual.retrieve', + 'client.sandbox.connections.create', + 'client.sandbox.connections.accounts.create', + 'client.sandbox.connections.accounts.update', + 'client.sandbox.company.update', + 'client.sandbox.directory.create', + 'client.sandbox.individual.update', + 'client.sandbox.employment.update', + 'client.sandbox.payment.create', + 'client.sandbox.jobs.create', + 'client.sandbox.jobs.configuration.retrieve', + 'client.sandbox.jobs.configuration.update', + 'client.payroll.payGroups.list', + 'client.payroll.payGroups.retrieve', + 'client.connect.sessions.new', + 'client.connect.sessions.reauthenticate', ], { threshold: 1, shouldSort: true }, ); @@ -237,7 +237,12 @@ function parseError(code: string, error: unknown): string | undefined { // Deno uses V8; the first ":LINE:COLUMN" is the top of stack. const lineNumber = error.stack?.match(/:([0-9]+):[0-9]+/)?.[1]; // -1 for the zero-based indexing - const line = lineNumber && code.split('\n').at(parseInt(lineNumber, 10) - 1)?.trim(); + const line = + lineNumber && + code + .split('\n') + .at(parseInt(lineNumber, 10) - 1) + ?.trim(); return line ? `${message}\n at line ${lineNumber}\n ${line}` : message; } catch { return message; @@ -249,8 +254,9 @@ const fetch = async (req: Request): Promise => { const runFunctionSource = code ? getRunFunctionSource(code) : null; if (!runFunctionSource) { - const message = code - ? 'The code is missing a top-level `run` function.' + const message = + code ? + 'The code is missing a top-level `run` function.' : 'The code argument is missing. Provide one containing a top-level `run` function.'; return Response.json( { @@ -295,7 +301,7 @@ const fetch = async (req: Request): Promise => { try { let run_ = async (client: any) => {}; run_ = (await tseval(`${code}\nexport default run;`)).default; - const result = await run_(makeSdkProxy(client, { path: ["client"] })); + const result = await run_(makeSdkProxy(client, { path: ['client'] })); return Response.json({ is_error: false, result, diff --git a/packages/mcp-server/src/code-tool.ts b/packages/mcp-server/src/code-tool.ts index dcd226ad..d3593e6e 100644 --- a/packages/mcp-server/src/code-tool.ts +++ b/packages/mcp-server/src/code-tool.ts @@ -1,8 +1,16 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -import { ContentBlock, McpRequestContext, McpTool, Metadata, ToolCallResult, asErrorResult, asTextContentResult } from './types'; +import { + ContentBlock, + McpRequestContext, + McpTool, + Metadata, + ToolCallResult, + asErrorResult, + asTextContentResult, +} from './types'; import { Tool } from '@modelcontextprotocol/sdk/types.js'; -import { readEnv } from "./util"; +import { readEnv } from './util'; import { WorkerInput, WorkerOutput } from './code-tool-types'; import { getLogger } from './logger'; import { SdkMethod } from './methods'; @@ -45,10 +53,13 @@ Always type dynamic key-value stores explicitly as Record * @param codeExecutionMode - Whether to execute code in a local Deno environment or in a remote * sandbox environment hosted by Stainless. */ -export function codeTool( - {blockedMethods, codeExecutionMode}: - {blockedMethods: SdkMethod[] | undefined, codeExecutionMode: McpCodeExecutionMode}, -): McpTool { +export function codeTool({ + blockedMethods, + codeExecutionMode, +}: { + blockedMethods: SdkMethod[] | undefined; + codeExecutionMode: McpCodeExecutionMode; +}): McpTool { const metadata: Metadata = { resource: 'all', operation: 'write', tags: [] }; const tool: Tool = { name: 'execute', @@ -71,10 +82,13 @@ export function codeTool( const logger = getLogger(); - const handler = async ( - {reqContext, args}: - {reqContext: McpRequestContext, args: any}, - ): Promise => { + const handler = async ({ + reqContext, + args, + }: { + reqContext: McpRequestContext; + args: any; + }): Promise => { const code = args.code as string; // Do very basic blocking of code that includes forbidden method names. // @@ -84,7 +98,11 @@ export function codeTool( if (blockedMethods) { const blockedMatches = blockedMethods.filter((method) => code.includes(method.fullyQualifiedName)); if (blockedMatches.length > 0) { - return asErrorResult(`The following methods have been blocked by the MCP server and cannot be used in code execution: ${blockedMatches.map((m) => m.fullyQualifiedName).join(', ')}`); + return asErrorResult( + `The following methods have been blocked by the MCP server and cannot be used in code execution: ${blockedMatches + .map((m) => m.fullyQualifiedName) + .join(', ')}`, + ); } } @@ -109,40 +127,43 @@ export function codeTool( 'Got code tool execution result', ); return result; - } + }; return { metadata, tool, handler }; } -const remoteStainlessHandler = async ( - {reqContext, args}: - {reqContext: McpRequestContext, args: any}, -): Promise => { +const remoteStainlessHandler = async ({ + reqContext, + args, +}: { + reqContext: McpRequestContext; + args: any; +}): Promise => { const code = args.code as string; const intent = args.intent as string | undefined; const client = reqContext.client; - const codeModeEndpoint = readEnv("CODE_MODE_ENDPOINT_URL") ?? "https://api.stainless.com/api/ai/code-tool"; + const codeModeEndpoint = readEnv('CODE_MODE_ENDPOINT_URL') ?? 'https://api.stainless.com/api/ai/code-tool'; const localClientEnvs = { - FINCH_CLIENT_ID: readEnv('FINCH_CLIENT_ID') ?? client.clientID ?? undefined, - FINCH_CLIENT_SECRET: readEnv('FINCH_CLIENT_SECRET') ?? client.clientSecret ?? undefined, - FINCH_WEBHOOK_SECRET: readEnv('FINCH_WEBHOOK_SECRET') ?? client.webhookSecret ?? undefined, - FINCH_BASE_URL: readEnv('FINCH_BASE_URL') ?? client.baseURL ?? undefined, -}; + FINCH_CLIENT_ID: readEnv('FINCH_CLIENT_ID') ?? client.clientID ?? undefined, + FINCH_CLIENT_SECRET: readEnv('FINCH_CLIENT_SECRET') ?? client.clientSecret ?? undefined, + FINCH_WEBHOOK_SECRET: readEnv('FINCH_WEBHOOK_SECRET') ?? client.webhookSecret ?? undefined, + FINCH_BASE_URL: readEnv('FINCH_BASE_URL') ?? client.baseURL ?? undefined, + }; // Merge any upstream client envs from the request header, with upstream values taking precedence. const mergedClientEnvs = { ...localClientEnvs, ...reqContext.upstreamClientEnvs }; // Setting a Stainless API key authenticates requests to the code tool endpoint. const res = await fetch(codeModeEndpoint, { - method: "POST", + method: 'POST', headers: { - ...(reqContext.stainlessApiKey && { Authorization: reqContext.stainlessApiKey, }), - "Content-Type": "application/json", - "x-stainless-mcp-client-envs": JSON.stringify(mergedClientEnvs), + ...(reqContext.stainlessApiKey && { Authorization: reqContext.stainlessApiKey }), + 'Content-Type': 'application/json', + 'x-stainless-mcp-client-envs': JSON.stringify(mergedClientEnvs), }, body: JSON.stringify({ - project_name: "finch", + project_name: 'finch', code, intent, client_opts: { accessToken: readEnv('FINCH_ACCESS_TOKEN') }, @@ -151,12 +172,18 @@ const remoteStainlessHandler = async ( if (!res.ok) { if (res.status === 404 && !reqContext.stainlessApiKey) { - throw new Error('Could not access code tool for this project. You may need to provide a Stainless API key via the STAINLESS_API_KEY environment variable, the --stainless-api-key flag, or the x-stainless-api-key HTTP header.'); + throw new Error( + 'Could not access code tool for this project. You may need to provide a Stainless API key via the STAINLESS_API_KEY environment variable, the --stainless-api-key flag, or the x-stainless-api-key HTTP header.', + ); } - throw new Error(`${res.status}: ${res.statusText} error when trying to contact Code Tool server. Details: ${await res.text()}`); + throw new Error( + `${res.status}: ${ + res.statusText + } error when trying to contact Code Tool server. Details: ${await res.text()}`, + ); } - const { is_error, result, log_lines, err_lines } = await res.json() as WorkerOutput; + const { is_error, result, log_lines, err_lines } = (await res.json()) as WorkerOutput; const hasLogs = log_lines.length > 0 || err_lines.length > 0; const output = { result, @@ -164,17 +191,18 @@ const remoteStainlessHandler = async ( ...(err_lines.length > 0 && { err_lines }), }; if (is_error) { - return asErrorResult( - typeof result === 'string' && !hasLogs ? result : JSON.stringify(output, null, 2), - ); + return asErrorResult(typeof result === 'string' && !hasLogs ? result : JSON.stringify(output, null, 2)); } return asTextContentResult(output); }; -const localDenoHandler = async ( - {reqContext, args} : - {reqContext: McpRequestContext, args: unknown}, -): Promise => { +const localDenoHandler = async ({ + reqContext, + args, +}: { + reqContext: McpRequestContext; + args: unknown; +}): Promise => { const fs = await import('node:fs'); const path = await import('node:path'); const url = await import('node:url'); @@ -199,24 +227,20 @@ const localDenoHandler = async ( } catch { try { // Use deno binary in node_modules if it's found - const denoNodeModulesPath = path.resolve( - packageNodeModulesPath, - 'deno', - 'bin.cjs', - ); + const denoNodeModulesPath = path.resolve(packageNodeModulesPath, 'deno', 'bin.cjs'); await fs.promises.access(denoNodeModulesPath, fs.constants.X_OK); denoPath = denoNodeModulesPath; } catch { return asErrorResult( 'Deno is required for code execution but was not found. ' + - 'Install it from https://deno.land or run: npm install deno', + 'Install it from https://deno.land or run: npm install deno', ); } } const allowReadPaths = [ 'code-tool-worker.mjs', - `${workerPath.replace(/([\/\\]node_modules)[\/\\].+$/, "$1")}/`, + `${workerPath.replace(/([\/\\]node_modules)[\/\\].+$/, '$1')}/`, packageRoot, ]; @@ -250,7 +274,7 @@ const localDenoHandler = async ( // Merge any upstream client envs into the Deno subprocess environment, // with the upstream env vars taking precedence. env: { ...process.env, ...reqContext.upstreamClientEnvs }, - } + }, }); try { @@ -262,14 +286,14 @@ const localDenoHandler = async ( // Strip null/undefined values so that the worker SDK client can fall back to // reading from environment variables (including any upstreamClientEnvs). const opts = { - ...(client.baseURL != null ? { baseURL: client.baseURL } : undefined), - ...(client.accessToken != null ? { accessToken: client.accessToken } : undefined), - ...(client.clientID != null ? { clientID: client.clientID } : undefined), - ...(client.clientSecret != null ? { clientSecret: client.clientSecret } : undefined), - ...(client.webhookSecret != null ? { webhookSecret: client.webhookSecret } : undefined), - defaultHeaders: { - 'X-Stainless-MCP': 'true', - }, + ...(client.baseURL != null ? { baseURL: client.baseURL } : undefined), + ...(client.accessToken != null ? { accessToken: client.accessToken } : undefined), + ...(client.clientID != null ? { clientID: client.clientID } : undefined), + ...(client.clientSecret != null ? { clientSecret: client.clientSecret } : undefined), + ...(client.webhookSecret != null ? { webhookSecret: client.webhookSecret } : undefined), + defaultHeaders: { + 'X-Stainless-MCP': 'true', + }, } satisfies Partial as ClientOptions; const req = worker.request( @@ -316,11 +340,12 @@ const localDenoHandler = async ( if (resp.status === 200) { const { result, log_lines, err_lines } = (await resp.json()) as WorkerOutput; const returnOutput: ContentBlock | null = - result == null ? null - : { + result == null ? null : ( + { type: 'text', text: typeof result === 'string' ? result : JSON.stringify(result), - }; + } + ); const logOutput: ContentBlock | null = log_lines.length === 0 ? null @@ -341,11 +366,12 @@ const localDenoHandler = async ( } else { const { result, log_lines, err_lines } = (await resp.json()) as WorkerOutput; const messageOutput: ContentBlock | null = - result == null ? null - : { + result == null ? null : ( + { type: 'text', text: typeof result === 'string' ? result : JSON.stringify(result), - }; + } + ); const logOutput: ContentBlock | null = log_lines.length === 0 ? null diff --git a/packages/mcp-server/src/docs-search-tool.ts b/packages/mcp-server/src/docs-search-tool.ts index 4fb849d4..b32ff477 100644 --- a/packages/mcp-server/src/docs-search-tool.ts +++ b/packages/mcp-server/src/docs-search-tool.ts @@ -14,7 +14,8 @@ export const metadata: Metadata = { export const tool: Tool = { name: 'search_docs', - description: 'Search SDK documentation to find methods, parameters, and usage examples for interacting with the API. Use this before writing code when you need to discover the right approach.', + description: + 'Search SDK documentation to find methods, parameters, and usage examples for interacting with the API. Use this before writing code when you need to discover the right approach.', inputSchema: { type: 'object', properties: { @@ -31,7 +32,7 @@ export const tool: Tool = { type: 'string', description: 'The amount of detail to return.', enum: ['default', 'verbose'], - } + }, }, required: ['query', 'language'], }, @@ -40,7 +41,8 @@ export const tool: Tool = { }, }; -const docsSearchURL = process.env['DOCS_SEARCH_URL'] || 'https://api.stainless.com/api/projects/finch/docs/search' +const docsSearchURL = + process.env['DOCS_SEARCH_URL'] || 'https://api.stainless.com/api/projects/finch/docs/search'; let _localSearch: LocalDocsSearch | undefined; @@ -65,30 +67,27 @@ async function searchLocal(args: Record): Promise { }).results; } -async function searchRemote( - args: Record, - reqContext: McpRequestContext, -): Promise { +async function searchRemote(args: Record, reqContext: McpRequestContext): Promise { const body = args as any; const query = new URLSearchParams(body).toString(); const startTime = Date.now(); - const result = await fetch( - `${docsSearchURL}?${query}`, - { - headers: { - ...(reqContext.stainlessApiKey && { Authorization: reqContext.stainlessApiKey }), - ...(reqContext.mcpSessionId && { 'x-stainless-mcp-session-id': reqContext.mcpSessionId }), - ...(reqContext.mcpClientInfo && { 'x-stainless-mcp-client-info': JSON.stringify(reqContext.mcpClientInfo) }), - }, + const result = await fetch(`${docsSearchURL}?${query}`, { + headers: { + ...(reqContext.stainlessApiKey && { Authorization: reqContext.stainlessApiKey }), + ...(reqContext.mcpSessionId && { 'x-stainless-mcp-session-id': reqContext.mcpSessionId }), + ...(reqContext.mcpClientInfo && { + 'x-stainless-mcp-client-info': JSON.stringify(reqContext.mcpClientInfo), + }), }, - ); + }); const logger = getLogger(); if (!result.ok) { const errorText = await result.text(); - logger.warn({ + logger.warn( + { durationMs: Date.now() - startTime, query: body.query, status: result.status, @@ -99,14 +98,19 @@ async function searchRemote( ); if (result.status === 404 && !reqContext.stainlessApiKey) { - throw new Error('Could not find docs for this project. You may need to provide a Stainless API key via the STAINLESS_API_KEY environment variable, the --stainless-api-key flag, or the x-stainless-api-key HTTP header.'); + throw new Error( + 'Could not find docs for this project. You may need to provide a Stainless API key via the STAINLESS_API_KEY environment variable, the --stainless-api-key flag, or the x-stainless-api-key HTTP header.', + ); } - throw new Error(`${result.status}: ${result.statusText} when using doc search tool. Details: ${errorText}`); + throw new Error( + `${result.status}: ${result.statusText} when using doc search tool. Details: ${errorText}`, + ); } const resultBody = await result.json(); - logger.info({ + logger.info( + { durationMs: Date.now() - startTime, query: body.query, }, @@ -115,10 +119,13 @@ async function searchRemote( return resultBody; } -export const handler = async ( - { reqContext, args }: - { reqContext: McpRequestContext; args: Record | undefined }, -) => { +export const handler = async ({ + reqContext, + args, +}: { + reqContext: McpRequestContext; + args: Record | undefined; +}) => { const body = args ?? {}; if (_localSearch) { diff --git a/packages/mcp-server/src/http.ts b/packages/mcp-server/src/http.ts index b00e3ce3..12c6b0d9 100644 --- a/packages/mcp-server/src/http.ts +++ b/packages/mcp-server/src/http.ts @@ -1,7 +1,7 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. import { McpServer } from '@modelcontextprotocol/sdk/server/mcp'; -import { StreamableHTTPServerTransport } from '@modelcontextprotocol/sdk/server/streamableHttp.js' +import { StreamableHTTPServerTransport } from '@modelcontextprotocol/sdk/server/streamableHttp.js'; import { ClientOptions } from '@tryfinch/finch-api'; import express from 'express'; import pino from 'pino'; @@ -24,7 +24,7 @@ const newServer = async ({ }): Promise => { const stainlessApiKey = getStainlessApiKey(req, mcpOptions); const customInstructionsPath = mcpOptions.customInstructionsPath; - const server = await newMcpServer({stainlessApiKey, customInstructionsPath}); + const server = await newMcpServer({ stainlessApiKey, customInstructionsPath }); const authOptions = parseClientAuthHeaders(req, false); @@ -65,15 +65,13 @@ const newServer = async ({ ); } } catch (error) { - getLogger().warn( - { error }, - 'Failed to parse x-stainless-mcp-client-permissions header', - ); + getLogger().warn({ error }, 'Failed to parse x-stainless-mcp-client-permissions header'); } } - const mcpClientInfo = typeof req.body?.params?.clientInfo?.name === 'string' - ? { name: req.body.params.clientInfo.name, version: String(req.body.params.clientInfo.version ?? '') } + const mcpClientInfo = + typeof req.body?.params?.clientInfo?.name === 'string' ? + { name: req.body.params.clientInfo.name, version: String(req.body.params.clientInfo.version ?? '') } : undefined; await initMcpServer({ @@ -90,10 +88,7 @@ const newServer = async ({ }); if (mcpClientInfo) { - getLogger().info( - { mcpSessionId: (req as any).mcpSessionId, mcpClientInfo }, - 'MCP client connected', - ); + getLogger().info({ mcpSessionId: (req as any).mcpSessionId, mcpClientInfo }, 'MCP client connected'); } return server; @@ -133,7 +128,7 @@ const del = async (req: express.Request, res: express.Response) => { const redactHeaders = (headers: Record) => { const hiddenHeaders = /auth|cookie|key|token|x-stainless-mcp-client-envs/i; const filtered = { ...headers }; - Object.keys(filtered).forEach(key => { + Object.keys(filtered).forEach((key) => { if (hiddenHeaders.test(key)) { filtered[key] = '[REDACTED]'; } @@ -186,17 +181,17 @@ export const streamableHTTPApp = ({ req: pino.stdSerializers.wrapRequestSerializer((req) => { return { ...req, - headers: redactHeaders(req.raw.headers) + headers: redactHeaders(req.raw.headers), }; }), res: pino.stdSerializers.wrapResponseSerializer((res) => { return { ...res, - headers: redactHeaders(res.headers) + headers: redactHeaders(res.headers), }; }), - } - }) + }, + }), ); app.get('/health', async (req: express.Request, res: express.Response) => { @@ -209,23 +204,24 @@ export const streamableHTTPApp = ({ return app; }; -export const launchStreamableHTTPServer = async( - {mcpOptions, port}: { - mcpOptions: McpOptions, - port: number | string | undefined, - } -) => { - const app = streamableHTTPApp({ mcpOptions }); - const server = app.listen(port); - const address = server.address(); - - const logger = getLogger(); - - if (typeof address === 'string') { - logger.info(`MCP Server running on streamable HTTP at ${address}`); - } else if (address !== null) { - logger.info(`MCP Server running on streamable HTTP on port ${address.port}`); - } else { - logger.info(`MCP Server running on streamable HTTP on port ${port}`); - } +export const launchStreamableHTTPServer = async ({ + mcpOptions, + port, +}: { + mcpOptions: McpOptions; + port: number | string | undefined; +}) => { + const app = streamableHTTPApp({ mcpOptions }); + const server = app.listen(port); + const address = server.address(); + + const logger = getLogger(); + + if (typeof address === 'string') { + logger.info(`MCP Server running on streamable HTTP at ${address}`); + } else if (address !== null) { + logger.info(`MCP Server running on streamable HTTP on port ${address.port}`); + } else { + logger.info(`MCP Server running on streamable HTTP on port ${port}`); } +}; diff --git a/packages/mcp-server/src/index.ts b/packages/mcp-server/src/index.ts index 6306dc26..5bca4a60 100644 --- a/packages/mcp-server/src/index.ts +++ b/packages/mcp-server/src/index.ts @@ -17,7 +17,7 @@ async function main() { const selectedTools = await selectToolsOrError(options); getLogger().info( - {tools: selectedTools.map((e) => e.tool.name)}, + { tools: selectedTools.map((e) => e.tool.name) }, `MCP Server starting with ${selectedTools.length} tools`, ); diff --git a/packages/mcp-server/src/instructions.ts b/packages/mcp-server/src/instructions.ts index 58278f49..687f4f36 100644 --- a/packages/mcp-server/src/instructions.ts +++ b/packages/mcp-server/src/instructions.ts @@ -60,24 +60,24 @@ async function fetchLatestInstructionsFromApi(stainlessApiKey: string | undefine // Setting the stainless API key is optional, but may be required // to authenticate requests to the Stainless API. const response = await fetch( - readEnv("CODE_MODE_INSTRUCTIONS_URL") ?? - 'https://api.stainless.com/api/ai/instructions/finch', + readEnv('CODE_MODE_INSTRUCTIONS_URL') ?? 'https://api.stainless.com/api/ai/instructions/finch', { - method: "GET", - headers: { ...( stainlessApiKey && { Authorization: stainlessApiKey } ) } - } - ) + method: 'GET', + headers: { ...(stainlessApiKey && { Authorization: stainlessApiKey }) }, + }, + ); let instructions: string | undefined; if (!response.ok) { getLogger().warn( - "Warning: failed to retrieve MCP server instructions. Proceeding with default instructions..." - ) + 'Warning: failed to retrieve MCP server instructions. Proceeding with default instructions...', + ); - instructions = "\n This is the finch MCP server.\n\n Available tools:\n - search_docs: Search SDK documentation to find the right methods and parameters.\n - execute: Run TypeScript code against a pre-authenticated SDK client. Define an async run(client) function.\n\n Workflow:\n - If unsure about the API, call search_docs first.\n - Write complete solutions in a single execute call when possible. For large datasets, use API filters to narrow results or paginate within a single execute block.\n - If execute returns an error, read the error and fix your code rather than retrying the same approach.\n - Variables do not persist between execute calls. Return or log all data you need.\n - Individual HTTP requests to the API have a 30-second timeout. If a request times out, try a smaller query or add filters.\n - Code execution has a total timeout of approximately 5 minutes. If your code times out, simplify it or break it into smaller steps.\n "; + instructions = + '\n This is the finch MCP server.\n\n Available tools:\n - search_docs: Search SDK documentation to find the right methods and parameters.\n - execute: Run TypeScript code against a pre-authenticated SDK client. Define an async run(client) function.\n\n Workflow:\n - If unsure about the API, call search_docs first.\n - Write complete solutions in a single execute call when possible. For large datasets, use API filters to narrow results or paginate within a single execute block.\n - If execute returns an error, read the error and fix your code rather than retrying the same approach.\n - Variables do not persist between execute calls. Return or log all data you need.\n - Individual HTTP requests to the API have a 30-second timeout. If a request times out, try a smaller query or add filters.\n - Code execution has a total timeout of approximately 5 minutes. If your code times out, simplify it or break it into smaller steps.\n '; } - instructions ??= (await response.json() as { instructions: string }).instructions; + instructions ??= ((await response.json()) as { instructions: string }).instructions; return instructions; } diff --git a/packages/mcp-server/src/local-docs-search.ts b/packages/mcp-server/src/local-docs-search.ts index 00ffd506..e62ea746 100644 --- a/packages/mcp-server/src/local-docs-search.ts +++ b/packages/mcp-server/src/local-docs-search.ts @@ -51,2129 +51,2480 @@ type SearchResult = { const EMBEDDED_METHODS: MethodEntry[] = [ { - "name": "create", - "endpoint": "/auth/token", - "httpMethod": "post", - "summary": "Create Access Token", - "description": "Exchange the authorization code for an access token", - "stainlessPath": "(resource) access_tokens > (method) create", - "qualified": "client.accessTokens.create", - "params": [ - "code: string;", - "client_id?: string;", - "client_secret?: string;", - "redirect_uri?: string;" - ], - "response": "{ access_token: string; client_type: 'development' | 'production' | 'sandbox'; connection_id: string; connection_type: 'finch' | 'provider'; entity_ids: string[]; products: string[]; provider_id: string; token_type: string; account_id?: string; company_id?: string; customer_id?: string; customer_name?: string; }", - "markdown": "## create\n\n`client.accessTokens.create(code: string, client_id?: string, client_secret?: string, redirect_uri?: string): { access_token: string; client_type: 'development' | 'production' | 'sandbox'; connection_id: string; connection_type: 'finch' | 'provider'; entity_ids: string[]; products: string[]; provider_id: string; token_type: string; account_id?: string; company_id?: string; customer_id?: string; customer_name?: string; }`\n\n**post** `/auth/token`\n\nExchange the authorization code for an access token\n\n### Parameters\n\n- `code: string`\n The authorization code received from the authorization server\n\n- `client_id?: string`\n The client ID for your application\n\n- `client_secret?: string`\n The client secret for your application\n\n- `redirect_uri?: string`\n The redirect URI used in the authorization request (optional)\n\n### Returns\n\n- `{ access_token: string; client_type: 'development' | 'production' | 'sandbox'; connection_id: string; connection_type: 'finch' | 'provider'; entity_ids: string[]; products: string[]; provider_id: string; token_type: string; account_id?: string; company_id?: string; customer_id?: string; customer_name?: string; }`\n\n - `access_token: string`\n - `client_type: 'development' | 'production' | 'sandbox'`\n - `connection_id: string`\n - `connection_type: 'finch' | 'provider'`\n - `entity_ids: string[]`\n - `products: string[]`\n - `provider_id: string`\n - `token_type: string`\n - `account_id?: string`\n - `company_id?: string`\n - `customer_id?: string`\n - `customer_name?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst createAccessTokenResponse = await client.accessTokens.create({ code: 'code' });\n\nconsole.log(createAccessTokenResponse);\n```", - "perLanguage": { - "typescript": { - "method": "client.accessTokens.create", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst createAccessTokenResponse = await client.accessTokens.create({ code: 'code' });\n\nconsole.log(createAccessTokenResponse.connection_id);" - }, - "python": { - "method": "access_tokens.create", - "example": "from finch import Finch\n\nclient = Finch()\ncreate_access_token_response = client.access_tokens.create(\n code=\"code\",\n)\nprint(create_access_token_response.connection_id)" - }, - "java": { - "method": "accessTokens().create", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.AccessTokenCreateParams;\nimport com.tryfinch.api.models.CreateAccessTokenResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n AccessTokenCreateParams params = AccessTokenCreateParams.builder()\n .code(\"code\")\n .build();\n CreateAccessTokenResponse createAccessTokenResponse = client.accessTokens().create(params);\n }\n}" - }, - "kotlin": { - "method": "accessTokens().create", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AccessTokenCreateParams\nimport com.tryfinch.api.models.CreateAccessTokenResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val params: AccessTokenCreateParams = AccessTokenCreateParams.builder()\n .code(\"code\")\n .build()\n val createAccessTokenResponse: CreateAccessTokenResponse = client.accessTokens().create(params)\n}" - }, - "go": { - "method": "client.AccessTokens.New", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t\toption.WithClientID(\"4ab15e51-11ad-49f4-acae-f343b7794375\"),\n\t\toption.WithClientSecret(\"My Client Secret\"),\n\t)\n\tcreateAccessTokenResponse, err := client.AccessTokens.New(context.TODO(), finchgo.AccessTokenNewParams{\n\t\tCode: finchgo.F(\"code\"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", createAccessTokenResponse.ConnectionID)\n}\n" - }, - "ruby": { - "method": "access_tokens.create", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(\n access_token: \"My Access Token\",\n client_id: \"4ab15e51-11ad-49f4-acae-f343b7794375\",\n client_secret: \"My Client Secret\"\n)\n\ncreate_access_token_response = finch.access_tokens.create(code: \"code\")\n\nputs(create_access_token_response)" - }, - "http": { - "example": "curl https://api.tryfinch.com/auth/token \\\n -H 'Content-Type: application/json' \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{\n \"code\": \"code\"\n }'" - } - } + name: 'create', + endpoint: '/auth/token', + httpMethod: 'post', + summary: 'Create Access Token', + description: 'Exchange the authorization code for an access token', + stainlessPath: '(resource) access_tokens > (method) create', + qualified: 'client.accessTokens.create', + params: ['code: string;', 'client_id?: string;', 'client_secret?: string;', 'redirect_uri?: string;'], + response: + "{ access_token: string; client_type: 'development' | 'production' | 'sandbox'; connection_id: string; connection_type: 'finch' | 'provider'; entity_ids: string[]; products: string[]; provider_id: string; token_type: string; account_id?: string; company_id?: string; customer_id?: string; customer_name?: string; }", + markdown: + "## create\n\n`client.accessTokens.create(code: string, client_id?: string, client_secret?: string, redirect_uri?: string): { access_token: string; client_type: 'development' | 'production' | 'sandbox'; connection_id: string; connection_type: 'finch' | 'provider'; entity_ids: string[]; products: string[]; provider_id: string; token_type: string; account_id?: string; company_id?: string; customer_id?: string; customer_name?: string; }`\n\n**post** `/auth/token`\n\nExchange the authorization code for an access token\n\n### Parameters\n\n- `code: string`\n The authorization code received from the authorization server\n\n- `client_id?: string`\n The client ID for your application\n\n- `client_secret?: string`\n The client secret for your application\n\n- `redirect_uri?: string`\n The redirect URI used in the authorization request (optional)\n\n### Returns\n\n- `{ access_token: string; client_type: 'development' | 'production' | 'sandbox'; connection_id: string; connection_type: 'finch' | 'provider'; entity_ids: string[]; products: string[]; provider_id: string; token_type: string; account_id?: string; company_id?: string; customer_id?: string; customer_name?: string; }`\n\n - `access_token: string`\n - `client_type: 'development' | 'production' | 'sandbox'`\n - `connection_id: string`\n - `connection_type: 'finch' | 'provider'`\n - `entity_ids: string[]`\n - `products: string[]`\n - `provider_id: string`\n - `token_type: string`\n - `account_id?: string`\n - `company_id?: string`\n - `customer_id?: string`\n - `customer_name?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst createAccessTokenResponse = await client.accessTokens.create({ code: 'code' });\n\nconsole.log(createAccessTokenResponse);\n```", + perLanguage: { + typescript: { + method: 'client.accessTokens.create', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst createAccessTokenResponse = await client.accessTokens.create({ code: 'code' });\n\nconsole.log(createAccessTokenResponse.connection_id);", + }, + python: { + method: 'access_tokens.create', + example: + 'from finch import Finch\n\nclient = Finch()\ncreate_access_token_response = client.access_tokens.create(\n code="code",\n)\nprint(create_access_token_response.connection_id)', + }, + java: { + method: 'accessTokens().create', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.AccessTokenCreateParams;\nimport com.tryfinch.api.models.CreateAccessTokenResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AccessTokenCreateParams params = AccessTokenCreateParams.builder()\n .code("code")\n .build();\n CreateAccessTokenResponse createAccessTokenResponse = client.accessTokens().create(params);\n }\n}', + }, + kotlin: { + method: 'accessTokens().create', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AccessTokenCreateParams\nimport com.tryfinch.api.models.CreateAccessTokenResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val params: AccessTokenCreateParams = AccessTokenCreateParams.builder()\n .code("code")\n .build()\n val createAccessTokenResponse: CreateAccessTokenResponse = client.accessTokens().create(params)\n}', + }, + go: { + method: 'client.AccessTokens.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t\toption.WithClientID("4ab15e51-11ad-49f4-acae-f343b7794375"),\n\t\toption.WithClientSecret("My Client Secret"),\n\t)\n\tcreateAccessTokenResponse, err := client.AccessTokens.New(context.TODO(), finchgo.AccessTokenNewParams{\n\t\tCode: finchgo.F("code"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", createAccessTokenResponse.ConnectionID)\n}\n', + }, + ruby: { + method: 'access_tokens.create', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(\n access_token: "My Access Token",\n client_id: "4ab15e51-11ad-49f4-acae-f343b7794375",\n client_secret: "My Client Secret"\n)\n\ncreate_access_token_response = finch.access_tokens.create(code: "code")\n\nputs(create_access_token_response)', + }, + http: { + example: + 'curl https://api.tryfinch.com/auth/token \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "code": "code"\n }\'', + }, + }, }, { - "name": "retrieve", - "endpoint": "/employer/company", - "httpMethod": "get", - "summary": "Company", - "description": "Read basic company data", - "stainlessPath": "(resource) hris.company > (method) retrieve", - "qualified": "client.hris.company.retrieve", - "params": [ - "entity_ids?: string[];" - ], - "response": "{ id: string; accounts: { account_name: string; account_number: string; account_type: 'checking' | 'savings'; institution_name: string; routing_number: string; }[]; departments: { name: string; parent: { name: string; }; }[]; ein: string; entity: { subtype: 's_corporation' | 'c_corporation' | 'b_corporation'; type: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }; legal_name: string; locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]; primary_email: string; primary_phone_number: string; }", - "markdown": "## retrieve\n\n`client.hris.company.retrieve(entity_ids?: string[]): { id: string; accounts: object[]; departments: object[]; ein: string; entity: object; legal_name: string; locations: location[]; primary_email: string; primary_phone_number: string; }`\n\n**get** `/employer/company`\n\nRead basic company data\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ id: string; accounts: { account_name: string; account_number: string; account_type: 'checking' | 'savings'; institution_name: string; routing_number: string; }[]; departments: { name: string; parent: { name: string; }; }[]; ein: string; entity: { subtype: 's_corporation' | 'c_corporation' | 'b_corporation'; type: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }; legal_name: string; locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]; primary_email: string; primary_phone_number: string; }`\n\n - `id: string`\n - `accounts: { account_name: string; account_number: string; account_type: 'checking' | 'savings'; institution_name: string; routing_number: string; }[]`\n - `departments: { name: string; parent: { name: string; }; }[]`\n - `ein: string`\n - `entity: { subtype: 's_corporation' | 'c_corporation' | 'b_corporation'; type: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }`\n - `legal_name: string`\n - `locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]`\n - `primary_email: string`\n - `primary_phone_number: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst company = await client.hris.company.retrieve();\n\nconsole.log(company);\n```", - "perLanguage": { - "typescript": { - "method": "client.hris.company.retrieve", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst company = await client.hris.company.retrieve();\n\nconsole.log(company.id);" - }, - "python": { - "method": "hris.company.retrieve", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\ncompany = client.hris.company.retrieve()\nprint(company.id)" - }, - "java": { - "method": "hris().company().retrieve", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.Company;\nimport com.tryfinch.api.models.HrisCompanyRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n Company company = client.hris().company().retrieve();\n }\n}" - }, - "kotlin": { - "method": "hris().company().retrieve", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.Company\nimport com.tryfinch.api.models.HrisCompanyRetrieveParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val company: Company = client.hris().company().retrieve()\n}" - }, - "go": { - "method": "client.HRIS.Company.Get", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tcompany, err := client.HRIS.Company.Get(context.TODO(), finchgo.HRISCompanyGetParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", company.ID)\n}\n" - }, - "ruby": { - "method": "hris.company.retrieve", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\ncompany = finch.hris.company.retrieve\n\nputs(company)" - }, - "http": { - "example": "curl https://api.tryfinch.com/employer/company \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + name: 'retrieve', + endpoint: '/employer/company', + httpMethod: 'get', + summary: 'Company', + description: 'Read basic company data', + stainlessPath: '(resource) hris.company > (method) retrieve', + qualified: 'client.hris.company.retrieve', + params: ['entity_ids?: string[];'], + response: + "{ id: string; accounts: { account_name: string; account_number: string; account_type: 'checking' | 'savings'; institution_name: string; routing_number: string; }[]; departments: { name: string; parent: { name: string; }; }[]; ein: string; entity: { subtype: 's_corporation' | 'c_corporation' | 'b_corporation'; type: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }; legal_name: string; locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]; primary_email: string; primary_phone_number: string; }", + markdown: + "## retrieve\n\n`client.hris.company.retrieve(entity_ids?: string[]): { id: string; accounts: object[]; departments: object[]; ein: string; entity: object; legal_name: string; locations: location[]; primary_email: string; primary_phone_number: string; }`\n\n**get** `/employer/company`\n\nRead basic company data\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ id: string; accounts: { account_name: string; account_number: string; account_type: 'checking' | 'savings'; institution_name: string; routing_number: string; }[]; departments: { name: string; parent: { name: string; }; }[]; ein: string; entity: { subtype: 's_corporation' | 'c_corporation' | 'b_corporation'; type: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }; legal_name: string; locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]; primary_email: string; primary_phone_number: string; }`\n\n - `id: string`\n - `accounts: { account_name: string; account_number: string; account_type: 'checking' | 'savings'; institution_name: string; routing_number: string; }[]`\n - `departments: { name: string; parent: { name: string; }; }[]`\n - `ein: string`\n - `entity: { subtype: 's_corporation' | 'c_corporation' | 'b_corporation'; type: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }`\n - `legal_name: string`\n - `locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]`\n - `primary_email: string`\n - `primary_phone_number: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst company = await client.hris.company.retrieve();\n\nconsole.log(company);\n```", + perLanguage: { + typescript: { + method: 'client.hris.company.retrieve', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst company = await client.hris.company.retrieve();\n\nconsole.log(company.id);", + }, + python: { + method: 'hris.company.retrieve', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\ncompany = client.hris.company.retrieve()\nprint(company.id)', + }, + java: { + method: 'hris().company().retrieve', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.Company;\nimport com.tryfinch.api.models.HrisCompanyRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n Company company = client.hris().company().retrieve();\n }\n}', + }, + kotlin: { + method: 'hris().company().retrieve', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.Company\nimport com.tryfinch.api.models.HrisCompanyRetrieveParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val company: Company = client.hris().company().retrieve()\n}', + }, + go: { + method: 'client.HRIS.Company.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcompany, err := client.HRIS.Company.Get(context.TODO(), finchgo.HRISCompanyGetParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", company.ID)\n}\n', + }, + ruby: { + method: 'hris.company.retrieve', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\ncompany = finch.hris.company.retrieve\n\nputs(company)', + }, + http: { + example: + 'curl https://api.tryfinch.com/employer/company \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "list", - "endpoint": "/employer/pay-statement-item", - "httpMethod": "get", - "summary": "Pay Statement Item", - "description": "Retrieve a list of detailed pay statement items for the access token's connection account.\n", - "stainlessPath": "(resource) hris.company.pay_statement_item > (method) list", - "qualified": "client.hris.company.payStatementItem.list", - "params": [ + name: 'list', + endpoint: '/employer/pay-statement-item', + httpMethod: 'get', + summary: 'Pay Statement Item', + description: + "Retrieve a list of detailed pay statement items for the access token's connection account.\n", + stainlessPath: '(resource) hris.company.pay_statement_item > (method) list', + qualified: 'client.hris.company.payStatementItem.list', + params: [ "categories?: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions'[];", - "end_date?: string;", - "entity_ids?: string[];", - "name?: string;", - "start_date?: string;", - "type?: string;" + 'end_date?: string;', + 'entity_ids?: string[];', + 'name?: string;', + 'start_date?: string;', + 'type?: string;', ], - "response": "{ attributes: { metadata: object; employer?: boolean; pre_tax?: boolean; type?: string; }; category: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions'; name: string; }", - "markdown": "## list\n\n`client.hris.company.payStatementItem.list(categories?: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions'[], end_date?: string, entity_ids?: string[], name?: string, start_date?: string, type?: string): { attributes: object; category: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions'; name: string; }`\n\n**get** `/employer/pay-statement-item`\n\nRetrieve a list of detailed pay statement items for the access token's connection account.\n\n\n### Parameters\n\n- `categories?: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions'[]`\n Comma-delimited list of pay statement item categories to filter on. If empty, defaults to all categories.\n\n- `end_date?: string`\n The end date to retrieve pay statement items by via their last seen pay date in `YYYY-MM-DD` format.\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `name?: string`\n Case-insensitive partial match search by pay statement item name.\n\n- `start_date?: string`\n The start date to retrieve pay statement items by via their last seen pay date (inclusive) in `YYYY-MM-DD` format.\n\n- `type?: string`\n String search by pay statement item type.\n\n### Returns\n\n- `{ attributes: { metadata: object; employer?: boolean; pre_tax?: boolean; type?: string; }; category: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions'; name: string; }`\n\n - `attributes: { metadata: object; employer?: boolean; pre_tax?: boolean; type?: string; }`\n - `category: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions'`\n - `name: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const payStatementItemListResponse of client.hris.company.payStatementItem.list()) {\n console.log(payStatementItemListResponse);\n}\n```", - "perLanguage": { - "typescript": { - "method": "client.hris.company.payStatementItem.list", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const payStatementItemListResponse of client.hris.company.payStatementItem.list()) {\n console.log(payStatementItemListResponse.attributes);\n}" - }, - "python": { - "method": "hris.company.pay_statement_item.list", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\npage = client.hris.company.pay_statement_item.list()\npage = page.responses[0]\nprint(page.attributes)" - }, - "java": { - "method": "hris().company().payStatementItem().list", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemListPage;\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n HrisCompanyPayStatementItemListPage page = client.hris().company().payStatementItem().list();\n }\n}" - }, - "kotlin": { - "method": "hris().company().payStatementItem().list", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemListPage\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val page: HrisCompanyPayStatementItemListPage = client.hris().company().payStatementItem().list()\n}" - }, - "go": { - "method": "client.HRIS.Company.PayStatementItem.List", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tpage, err := client.HRIS.Company.PayStatementItem.List(context.TODO(), finchgo.HRISCompanyPayStatementItemListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n" - }, - "ruby": { - "method": "hris.company.pay_statement_item.list", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\npage = finch.hris.company.pay_statement_item.list\n\nputs(page)" - }, - "http": { - "example": "curl https://api.tryfinch.com/employer/pay-statement-item \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + response: + "{ attributes: { metadata: object; employer?: boolean; pre_tax?: boolean; type?: string; }; category: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions'; name: string; }", + markdown: + "## list\n\n`client.hris.company.payStatementItem.list(categories?: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions'[], end_date?: string, entity_ids?: string[], name?: string, start_date?: string, type?: string): { attributes: object; category: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions'; name: string; }`\n\n**get** `/employer/pay-statement-item`\n\nRetrieve a list of detailed pay statement items for the access token's connection account.\n\n\n### Parameters\n\n- `categories?: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions'[]`\n Comma-delimited list of pay statement item categories to filter on. If empty, defaults to all categories.\n\n- `end_date?: string`\n The end date to retrieve pay statement items by via their last seen pay date in `YYYY-MM-DD` format.\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `name?: string`\n Case-insensitive partial match search by pay statement item name.\n\n- `start_date?: string`\n The start date to retrieve pay statement items by via their last seen pay date (inclusive) in `YYYY-MM-DD` format.\n\n- `type?: string`\n String search by pay statement item type.\n\n### Returns\n\n- `{ attributes: { metadata: object; employer?: boolean; pre_tax?: boolean; type?: string; }; category: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions'; name: string; }`\n\n - `attributes: { metadata: object; employer?: boolean; pre_tax?: boolean; type?: string; }`\n - `category: 'earnings' | 'taxes' | 'employee_deductions' | 'employer_contributions'`\n - `name: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const payStatementItemListResponse of client.hris.company.payStatementItem.list()) {\n console.log(payStatementItemListResponse);\n}\n```", + perLanguage: { + typescript: { + method: 'client.hris.company.payStatementItem.list', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const payStatementItemListResponse of client.hris.company.payStatementItem.list()) {\n console.log(payStatementItemListResponse.attributes);\n}", + }, + python: { + method: 'hris.company.pay_statement_item.list', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.company.pay_statement_item.list()\npage = page.responses[0]\nprint(page.attributes)', + }, + java: { + method: 'hris().company().payStatementItem().list', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemListPage;\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HrisCompanyPayStatementItemListPage page = client.hris().company().payStatementItem().list();\n }\n}', + }, + kotlin: { + method: 'hris().company().payStatementItem().list', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemListPage\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val page: HrisCompanyPayStatementItemListPage = client.hris().company().payStatementItem().list()\n}', + }, + go: { + method: 'client.HRIS.Company.PayStatementItem.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Company.PayStatementItem.List(context.TODO(), finchgo.HRISCompanyPayStatementItemListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'hris.company.pay_statement_item.list', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.company.pay_statement_item.list\n\nputs(page)', + }, + http: { + example: + 'curl https://api.tryfinch.com/employer/pay-statement-item \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "create", - "endpoint": "/employer/pay-statement-item/rule", - "httpMethod": "post", - "summary": "Create Rule", - "description": "Custom rules can be created to associate specific attributes to pay statement items depending on the use case. For example, pay statement items that meet certain conditions can be labeled as a pre-tax 401k. This metadata can be retrieved where pay statement item information is available.\n", - "stainlessPath": "(resource) hris.company.pay_statement_item.rules > (method) create", - "qualified": "client.hris.company.payStatementItem.rules.create", - "params": [ - "entity_ids?: string[];", - "attributes?: { metadata?: object; };", + name: 'create', + endpoint: '/employer/pay-statement-item/rule', + httpMethod: 'post', + summary: 'Create Rule', + description: + 'Custom rules can be created to associate specific attributes to pay statement items depending on the use case. For example, pay statement items that meet certain conditions can be labeled as a pre-tax 401k. This metadata can be retrieved where pay statement item information is available.\n', + stainlessPath: '(resource) hris.company.pay_statement_item.rules > (method) create', + qualified: 'client.hris.company.payStatementItem.rules.create', + params: [ + 'entity_ids?: string[];', + 'attributes?: { metadata?: object; };', "conditions?: { field?: string; operator?: 'equals'; value?: string; }[];", - "effective_end_date?: string;", - "effective_start_date?: string;", - "entity_type?: 'pay_statement_item';" + 'effective_end_date?: string;', + 'effective_start_date?: string;', + "entity_type?: 'pay_statement_item';", ], - "response": "{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }", - "markdown": "## create\n\n`client.hris.company.payStatementItem.rules.create(entity_ids?: string[], attributes?: { metadata?: object; }, conditions?: { field?: string; operator?: 'equals'; value?: string; }[], effective_end_date?: string, effective_start_date?: string, entity_type?: 'pay_statement_item'): { id?: string; attributes?: object; conditions?: object[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n**post** `/employer/pay-statement-item/rule`\n\nCustom rules can be created to associate specific attributes to pay statement items depending on the use case. For example, pay statement items that meet certain conditions can be labeled as a pre-tax 401k. This metadata can be retrieved where pay statement item information is available.\n\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to create the rule for.\n\n- `attributes?: { metadata?: object; }`\n Specifies the fields to be applied when the condition is met.\n - `metadata?: object`\n The metadata to be attached in the entity. It is a key-value pairs where the values can be of any type (string, number, boolean, object, array, etc.).\n\n- `conditions?: { field?: string; operator?: 'equals'; value?: string; }[]`\n\n- `effective_end_date?: string`\n Specifies when the rules should stop applying rules based on the date.\n\n- `effective_start_date?: string`\n Specifies when the rule should begin applying based on the date.\n\n- `entity_type?: 'pay_statement_item'`\n The entity type to which the rule is applied.\n\n### Returns\n\n- `{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n - `id?: string`\n - `attributes?: { metadata?: object; }`\n - `conditions?: { field?: string; operator?: 'equals'; value?: string; }[]`\n - `created_at?: string`\n - `effective_end_date?: string`\n - `effective_start_date?: string`\n - `entity_type?: 'pay_statement_item'`\n - `priority?: number`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst rule = await client.hris.company.payStatementItem.rules.create();\n\nconsole.log(rule);\n```", - "perLanguage": { - "typescript": { - "method": "client.hris.company.payStatementItem.rules.create", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst rule = await client.hris.company.payStatementItem.rules.create();\n\nconsole.log(rule.id);" - }, - "python": { - "method": "hris.company.pay_statement_item.rules.create", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nrule = client.hris.company.pay_statement_item.rules.create()\nprint(rule.id)" - }, - "java": { - "method": "hris().company().payStatementItem().rules().create", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleCreateParams;\nimport com.tryfinch.api.models.RuleCreateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n RuleCreateResponse rule = client.hris().company().payStatementItem().rules().create();\n }\n}" - }, - "kotlin": { - "method": "hris().company().payStatementItem().rules().create", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleCreateParams\nimport com.tryfinch.api.models.RuleCreateResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val rule: RuleCreateResponse = client.hris().company().payStatementItem().rules().create()\n}" - }, - "go": { - "method": "client.HRIS.Company.PayStatementItem.Rules.New", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\trule, err := client.HRIS.Company.PayStatementItem.Rules.New(context.TODO(), finchgo.HRISCompanyPayStatementItemRuleNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", rule.ID)\n}\n" - }, - "ruby": { - "method": "hris.company.pay_statement_item.rules.create", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nrule = finch.hris.company.pay_statement_item.rules.create\n\nputs(rule)" - }, - "http": { - "example": "curl https://api.tryfinch.com/employer/pay-statement-item/rule \\\n -X POST \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + response: + "{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }", + markdown: + "## create\n\n`client.hris.company.payStatementItem.rules.create(entity_ids?: string[], attributes?: { metadata?: object; }, conditions?: { field?: string; operator?: 'equals'; value?: string; }[], effective_end_date?: string, effective_start_date?: string, entity_type?: 'pay_statement_item'): { id?: string; attributes?: object; conditions?: object[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n**post** `/employer/pay-statement-item/rule`\n\nCustom rules can be created to associate specific attributes to pay statement items depending on the use case. For example, pay statement items that meet certain conditions can be labeled as a pre-tax 401k. This metadata can be retrieved where pay statement item information is available.\n\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to create the rule for.\n\n- `attributes?: { metadata?: object; }`\n Specifies the fields to be applied when the condition is met.\n - `metadata?: object`\n The metadata to be attached in the entity. It is a key-value pairs where the values can be of any type (string, number, boolean, object, array, etc.).\n\n- `conditions?: { field?: string; operator?: 'equals'; value?: string; }[]`\n\n- `effective_end_date?: string`\n Specifies when the rules should stop applying rules based on the date.\n\n- `effective_start_date?: string`\n Specifies when the rule should begin applying based on the date.\n\n- `entity_type?: 'pay_statement_item'`\n The entity type to which the rule is applied.\n\n### Returns\n\n- `{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n - `id?: string`\n - `attributes?: { metadata?: object; }`\n - `conditions?: { field?: string; operator?: 'equals'; value?: string; }[]`\n - `created_at?: string`\n - `effective_end_date?: string`\n - `effective_start_date?: string`\n - `entity_type?: 'pay_statement_item'`\n - `priority?: number`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst rule = await client.hris.company.payStatementItem.rules.create();\n\nconsole.log(rule);\n```", + perLanguage: { + typescript: { + method: 'client.hris.company.payStatementItem.rules.create', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst rule = await client.hris.company.payStatementItem.rules.create();\n\nconsole.log(rule.id);", + }, + python: { + method: 'hris.company.pay_statement_item.rules.create', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nrule = client.hris.company.pay_statement_item.rules.create()\nprint(rule.id)', + }, + java: { + method: 'hris().company().payStatementItem().rules().create', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleCreateParams;\nimport com.tryfinch.api.models.RuleCreateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RuleCreateResponse rule = client.hris().company().payStatementItem().rules().create();\n }\n}', + }, + kotlin: { + method: 'hris().company().payStatementItem().rules().create', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleCreateParams\nimport com.tryfinch.api.models.RuleCreateResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val rule: RuleCreateResponse = client.hris().company().payStatementItem().rules().create()\n}', + }, + go: { + method: 'client.HRIS.Company.PayStatementItem.Rules.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\trule, err := client.HRIS.Company.PayStatementItem.Rules.New(context.TODO(), finchgo.HRISCompanyPayStatementItemRuleNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", rule.ID)\n}\n', + }, + ruby: { + method: 'hris.company.pay_statement_item.rules.create', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nrule = finch.hris.company.pay_statement_item.rules.create\n\nputs(rule)', + }, + http: { + example: + 'curl https://api.tryfinch.com/employer/pay-statement-item/rule \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "list", - "endpoint": "/employer/pay-statement-item/rule", - "httpMethod": "get", - "summary": "Get Rules", - "description": "List all rules of a connection account.", - "stainlessPath": "(resource) hris.company.pay_statement_item.rules > (method) list", - "qualified": "client.hris.company.payStatementItem.rules.list", - "params": [ - "entity_ids?: string[];" - ], - "response": "{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }", - "markdown": "## list\n\n`client.hris.company.payStatementItem.rules.list(entity_ids?: string[]): { id?: string; attributes?: object; conditions?: object[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n**get** `/employer/pay-statement-item/rule`\n\nList all rules of a connection account.\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to retrieve rules for.\n\n### Returns\n\n- `{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n - `id?: string`\n - `attributes?: { metadata?: object; }`\n - `conditions?: { field?: string; operator?: 'equals'; value?: string; }[]`\n - `created_at?: string`\n - `effective_end_date?: string`\n - `effective_start_date?: string`\n - `entity_type?: 'pay_statement_item'`\n - `priority?: number`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const ruleListResponse of client.hris.company.payStatementItem.rules.list()) {\n console.log(ruleListResponse);\n}\n```", - "perLanguage": { - "typescript": { - "method": "client.hris.company.payStatementItem.rules.list", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const ruleListResponse of client.hris.company.payStatementItem.rules.list()) {\n console.log(ruleListResponse.id);\n}" - }, - "python": { - "method": "hris.company.pay_statement_item.rules.list", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\npage = client.hris.company.pay_statement_item.rules.list()\npage = page.responses[0]\nprint(page.id)" - }, - "java": { - "method": "hris().company().payStatementItem().rules().list", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleListPage;\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n HrisCompanyPayStatementItemRuleListPage page = client.hris().company().payStatementItem().rules().list();\n }\n}" - }, - "kotlin": { - "method": "hris().company().payStatementItem().rules().list", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleListPage\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val page: HrisCompanyPayStatementItemRuleListPage = client.hris().company().payStatementItem().rules().list()\n}" - }, - "go": { - "method": "client.HRIS.Company.PayStatementItem.Rules.List", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tpage, err := client.HRIS.Company.PayStatementItem.Rules.List(context.TODO(), finchgo.HRISCompanyPayStatementItemRuleListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n" - }, - "ruby": { - "method": "hris.company.pay_statement_item.rules.list", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\npage = finch.hris.company.pay_statement_item.rules.list\n\nputs(page)" - }, - "http": { - "example": "curl https://api.tryfinch.com/employer/pay-statement-item/rule \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + name: 'list', + endpoint: '/employer/pay-statement-item/rule', + httpMethod: 'get', + summary: 'Get Rules', + description: 'List all rules of a connection account.', + stainlessPath: '(resource) hris.company.pay_statement_item.rules > (method) list', + qualified: 'client.hris.company.payStatementItem.rules.list', + params: ['entity_ids?: string[];'], + response: + "{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }", + markdown: + "## list\n\n`client.hris.company.payStatementItem.rules.list(entity_ids?: string[]): { id?: string; attributes?: object; conditions?: object[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n**get** `/employer/pay-statement-item/rule`\n\nList all rules of a connection account.\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to retrieve rules for.\n\n### Returns\n\n- `{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n - `id?: string`\n - `attributes?: { metadata?: object; }`\n - `conditions?: { field?: string; operator?: 'equals'; value?: string; }[]`\n - `created_at?: string`\n - `effective_end_date?: string`\n - `effective_start_date?: string`\n - `entity_type?: 'pay_statement_item'`\n - `priority?: number`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const ruleListResponse of client.hris.company.payStatementItem.rules.list()) {\n console.log(ruleListResponse);\n}\n```", + perLanguage: { + typescript: { + method: 'client.hris.company.payStatementItem.rules.list', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const ruleListResponse of client.hris.company.payStatementItem.rules.list()) {\n console.log(ruleListResponse.id);\n}", + }, + python: { + method: 'hris.company.pay_statement_item.rules.list', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.company.pay_statement_item.rules.list()\npage = page.responses[0]\nprint(page.id)', + }, + java: { + method: 'hris().company().payStatementItem().rules().list', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleListPage;\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HrisCompanyPayStatementItemRuleListPage page = client.hris().company().payStatementItem().rules().list();\n }\n}', + }, + kotlin: { + method: 'hris().company().payStatementItem().rules().list', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleListPage\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val page: HrisCompanyPayStatementItemRuleListPage = client.hris().company().payStatementItem().rules().list()\n}', + }, + go: { + method: 'client.HRIS.Company.PayStatementItem.Rules.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Company.PayStatementItem.Rules.List(context.TODO(), finchgo.HRISCompanyPayStatementItemRuleListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'hris.company.pay_statement_item.rules.list', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.company.pay_statement_item.rules.list\n\nputs(page)', + }, + http: { + example: + 'curl https://api.tryfinch.com/employer/pay-statement-item/rule \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "update", - "endpoint": "/employer/pay-statement-item/rule/{rule_id}", - "httpMethod": "put", - "summary": "Update Rule", - "description": "Update a rule for a pay statement item.", - "stainlessPath": "(resource) hris.company.pay_statement_item.rules > (method) update", - "qualified": "client.hris.company.payStatementItem.rules.update", - "params": [ - "rule_id: string;", - "entity_ids?: string[];", - "optionalProperty?: object;" - ], - "response": "{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }", - "markdown": "## update\n\n`client.hris.company.payStatementItem.rules.update(rule_id: string, entity_ids?: string[], optionalProperty?: object): { id?: string; attributes?: object; conditions?: object[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n**put** `/employer/pay-statement-item/rule/{rule_id}`\n\nUpdate a rule for a pay statement item.\n\n### Parameters\n\n- `rule_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to update the rule for.\n\n- `optionalProperty?: object`\n\n### Returns\n\n- `{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n - `id?: string`\n - `attributes?: { metadata?: object; }`\n - `conditions?: { field?: string; operator?: 'equals'; value?: string; }[]`\n - `created_at?: string`\n - `effective_end_date?: string`\n - `effective_start_date?: string`\n - `entity_type?: 'pay_statement_item'`\n - `priority?: number`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst rule = await client.hris.company.payStatementItem.rules.update('rule_id');\n\nconsole.log(rule);\n```", - "perLanguage": { - "typescript": { - "method": "client.hris.company.payStatementItem.rules.update", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst rule = await client.hris.company.payStatementItem.rules.update('rule_id');\n\nconsole.log(rule.id);" - }, - "python": { - "method": "hris.company.pay_statement_item.rules.update", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nrule = client.hris.company.pay_statement_item.rules.update(\n rule_id=\"rule_id\",\n)\nprint(rule.id)" - }, - "java": { - "method": "hris().company().payStatementItem().rules().update", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleUpdateParams;\nimport com.tryfinch.api.models.RuleUpdateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n RuleUpdateResponse rule = client.hris().company().payStatementItem().rules().update(\"rule_id\");\n }\n}" - }, - "kotlin": { - "method": "hris().company().payStatementItem().rules().update", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleUpdateParams\nimport com.tryfinch.api.models.RuleUpdateResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val rule: RuleUpdateResponse = client.hris().company().payStatementItem().rules().update(\"rule_id\")\n}" - }, - "go": { - "method": "client.HRIS.Company.PayStatementItem.Rules.Update", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\trule, err := client.HRIS.Company.PayStatementItem.Rules.Update(\n\t\tcontext.TODO(),\n\t\t\"rule_id\",\n\t\tfinchgo.HRISCompanyPayStatementItemRuleUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", rule.ID)\n}\n" - }, - "ruby": { - "method": "hris.company.pay_statement_item.rules.update", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nrule = finch.hris.company.pay_statement_item.rules.update(\"rule_id\")\n\nputs(rule)" - }, - "http": { - "example": "curl https://api.tryfinch.com/employer/pay-statement-item/rule/$RULE_ID \\\n -X PUT \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + name: 'update', + endpoint: '/employer/pay-statement-item/rule/{rule_id}', + httpMethod: 'put', + summary: 'Update Rule', + description: 'Update a rule for a pay statement item.', + stainlessPath: '(resource) hris.company.pay_statement_item.rules > (method) update', + qualified: 'client.hris.company.payStatementItem.rules.update', + params: ['rule_id: string;', 'entity_ids?: string[];', 'optionalProperty?: object;'], + response: + "{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }", + markdown: + "## update\n\n`client.hris.company.payStatementItem.rules.update(rule_id: string, entity_ids?: string[], optionalProperty?: object): { id?: string; attributes?: object; conditions?: object[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n**put** `/employer/pay-statement-item/rule/{rule_id}`\n\nUpdate a rule for a pay statement item.\n\n### Parameters\n\n- `rule_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to update the rule for.\n\n- `optionalProperty?: object`\n\n### Returns\n\n- `{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n - `id?: string`\n - `attributes?: { metadata?: object; }`\n - `conditions?: { field?: string; operator?: 'equals'; value?: string; }[]`\n - `created_at?: string`\n - `effective_end_date?: string`\n - `effective_start_date?: string`\n - `entity_type?: 'pay_statement_item'`\n - `priority?: number`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst rule = await client.hris.company.payStatementItem.rules.update('rule_id');\n\nconsole.log(rule);\n```", + perLanguage: { + typescript: { + method: 'client.hris.company.payStatementItem.rules.update', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst rule = await client.hris.company.payStatementItem.rules.update('rule_id');\n\nconsole.log(rule.id);", + }, + python: { + method: 'hris.company.pay_statement_item.rules.update', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nrule = client.hris.company.pay_statement_item.rules.update(\n rule_id="rule_id",\n)\nprint(rule.id)', + }, + java: { + method: 'hris().company().payStatementItem().rules().update', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleUpdateParams;\nimport com.tryfinch.api.models.RuleUpdateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RuleUpdateResponse rule = client.hris().company().payStatementItem().rules().update("rule_id");\n }\n}', + }, + kotlin: { + method: 'hris().company().payStatementItem().rules().update', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleUpdateParams\nimport com.tryfinch.api.models.RuleUpdateResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val rule: RuleUpdateResponse = client.hris().company().payStatementItem().rules().update("rule_id")\n}', + }, + go: { + method: 'client.HRIS.Company.PayStatementItem.Rules.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\trule, err := client.HRIS.Company.PayStatementItem.Rules.Update(\n\t\tcontext.TODO(),\n\t\t"rule_id",\n\t\tfinchgo.HRISCompanyPayStatementItemRuleUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", rule.ID)\n}\n', + }, + ruby: { + method: 'hris.company.pay_statement_item.rules.update', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nrule = finch.hris.company.pay_statement_item.rules.update("rule_id")\n\nputs(rule)', + }, + http: { + example: + 'curl https://api.tryfinch.com/employer/pay-statement-item/rule/$RULE_ID \\\n -X PUT \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "delete", - "endpoint": "/employer/pay-statement-item/rule/{rule_id}", - "httpMethod": "delete", - "summary": "Delete Rule", - "description": "Delete a rule for a pay statement item.", - "stainlessPath": "(resource) hris.company.pay_statement_item.rules > (method) delete", - "qualified": "client.hris.company.payStatementItem.rules.delete", - "params": [ - "rule_id: string;", - "entity_ids?: string[];" - ], - "response": "{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; deleted_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }", - "markdown": "## delete\n\n`client.hris.company.payStatementItem.rules.delete(rule_id: string, entity_ids?: string[]): { id?: string; attributes?: object; conditions?: object[]; created_at?: string; deleted_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n**delete** `/employer/pay-statement-item/rule/{rule_id}`\n\nDelete a rule for a pay statement item.\n\n### Parameters\n\n- `rule_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to delete the rule for.\n\n### Returns\n\n- `{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; deleted_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n - `id?: string`\n - `attributes?: { metadata?: object; }`\n - `conditions?: { field?: string; operator?: 'equals'; value?: string; }[]`\n - `created_at?: string`\n - `deleted_at?: string`\n - `effective_end_date?: string`\n - `effective_start_date?: string`\n - `entity_type?: 'pay_statement_item'`\n - `priority?: number`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst rule = await client.hris.company.payStatementItem.rules.delete('rule_id');\n\nconsole.log(rule);\n```", - "perLanguage": { - "typescript": { - "method": "client.hris.company.payStatementItem.rules.delete", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst rule = await client.hris.company.payStatementItem.rules.delete('rule_id');\n\nconsole.log(rule.id);" - }, - "python": { - "method": "hris.company.pay_statement_item.rules.delete", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nrule = client.hris.company.pay_statement_item.rules.delete(\n rule_id=\"rule_id\",\n)\nprint(rule.id)" - }, - "java": { - "method": "hris().company().payStatementItem().rules().delete", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleDeleteParams;\nimport com.tryfinch.api.models.RuleDeleteResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n RuleDeleteResponse rule = client.hris().company().payStatementItem().rules().delete(\"rule_id\");\n }\n}" - }, - "kotlin": { - "method": "hris().company().payStatementItem().rules().delete", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleDeleteParams\nimport com.tryfinch.api.models.RuleDeleteResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val rule: RuleDeleteResponse = client.hris().company().payStatementItem().rules().delete(\"rule_id\")\n}" - }, - "go": { - "method": "client.HRIS.Company.PayStatementItem.Rules.Delete", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\trule, err := client.HRIS.Company.PayStatementItem.Rules.Delete(\n\t\tcontext.TODO(),\n\t\t\"rule_id\",\n\t\tfinchgo.HRISCompanyPayStatementItemRuleDeleteParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", rule.ID)\n}\n" - }, - "ruby": { - "method": "hris.company.pay_statement_item.rules.delete", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nrule = finch.hris.company.pay_statement_item.rules.delete(\"rule_id\")\n\nputs(rule)" - }, - "http": { - "example": "curl https://api.tryfinch.com/employer/pay-statement-item/rule/$RULE_ID \\\n -X DELETE \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + name: 'delete', + endpoint: '/employer/pay-statement-item/rule/{rule_id}', + httpMethod: 'delete', + summary: 'Delete Rule', + description: 'Delete a rule for a pay statement item.', + stainlessPath: '(resource) hris.company.pay_statement_item.rules > (method) delete', + qualified: 'client.hris.company.payStatementItem.rules.delete', + params: ['rule_id: string;', 'entity_ids?: string[];'], + response: + "{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; deleted_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }", + markdown: + "## delete\n\n`client.hris.company.payStatementItem.rules.delete(rule_id: string, entity_ids?: string[]): { id?: string; attributes?: object; conditions?: object[]; created_at?: string; deleted_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n**delete** `/employer/pay-statement-item/rule/{rule_id}`\n\nDelete a rule for a pay statement item.\n\n### Parameters\n\n- `rule_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to delete the rule for.\n\n### Returns\n\n- `{ id?: string; attributes?: { metadata?: object; }; conditions?: { field?: string; operator?: 'equals'; value?: string; }[]; created_at?: string; deleted_at?: string; effective_end_date?: string; effective_start_date?: string; entity_type?: 'pay_statement_item'; priority?: number; updated_at?: string; }`\n\n - `id?: string`\n - `attributes?: { metadata?: object; }`\n - `conditions?: { field?: string; operator?: 'equals'; value?: string; }[]`\n - `created_at?: string`\n - `deleted_at?: string`\n - `effective_end_date?: string`\n - `effective_start_date?: string`\n - `entity_type?: 'pay_statement_item'`\n - `priority?: number`\n - `updated_at?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst rule = await client.hris.company.payStatementItem.rules.delete('rule_id');\n\nconsole.log(rule);\n```", + perLanguage: { + typescript: { + method: 'client.hris.company.payStatementItem.rules.delete', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst rule = await client.hris.company.payStatementItem.rules.delete('rule_id');\n\nconsole.log(rule.id);", + }, + python: { + method: 'hris.company.pay_statement_item.rules.delete', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nrule = client.hris.company.pay_statement_item.rules.delete(\n rule_id="rule_id",\n)\nprint(rule.id)', + }, + java: { + method: 'hris().company().payStatementItem().rules().delete', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleDeleteParams;\nimport com.tryfinch.api.models.RuleDeleteResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RuleDeleteResponse rule = client.hris().company().payStatementItem().rules().delete("rule_id");\n }\n}', + }, + kotlin: { + method: 'hris().company().payStatementItem().rules().delete', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisCompanyPayStatementItemRuleDeleteParams\nimport com.tryfinch.api.models.RuleDeleteResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val rule: RuleDeleteResponse = client.hris().company().payStatementItem().rules().delete("rule_id")\n}', + }, + go: { + method: 'client.HRIS.Company.PayStatementItem.Rules.Delete', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\trule, err := client.HRIS.Company.PayStatementItem.Rules.Delete(\n\t\tcontext.TODO(),\n\t\t"rule_id",\n\t\tfinchgo.HRISCompanyPayStatementItemRuleDeleteParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", rule.ID)\n}\n', + }, + ruby: { + method: 'hris.company.pay_statement_item.rules.delete', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nrule = finch.hris.company.pay_statement_item.rules.delete("rule_id")\n\nputs(rule)', + }, + http: { + example: + 'curl https://api.tryfinch.com/employer/pay-statement-item/rule/$RULE_ID \\\n -X DELETE \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "list", - "endpoint": "/employer/directory", - "httpMethod": "get", - "summary": "Directory", - "description": "Read company directory and organization structure", - "stainlessPath": "(resource) hris.directory > (method) list", - "qualified": "client.hris.directory.list", - "params": [ - "entity_ids?: string[];", - "limit?: number;", - "offset?: number;" - ], - "response": "{ id: string; department: { name?: string; }; first_name: string; is_active: boolean; last_name: string; manager: { id: string; }; middle_name: string; }", - "markdown": "## list\n\n`client.hris.directory.list(entity_ids?: string[], limit?: number, offset?: number): { id: string; department: object; first_name: string; is_active: boolean; last_name: string; manager: object; middle_name: string; }`\n\n**get** `/employer/directory`\n\nRead company directory and organization structure\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `limit?: number`\n Number of employees to return (defaults to all)\n\n- `offset?: number`\n Index to start from (defaults to 0)\n\n### Returns\n\n- `{ id: string; department: { name?: string; }; first_name: string; is_active: boolean; last_name: string; manager: { id: string; }; middle_name: string; }`\n\n - `id: string`\n - `department: { name?: string; }`\n - `first_name: string`\n - `is_active: boolean`\n - `last_name: string`\n - `manager: { id: string; }`\n - `middle_name: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const individualInDirectory of client.hris.directory.list()) {\n console.log(individualInDirectory);\n}\n```", - "perLanguage": { - "typescript": { - "method": "client.hris.directory.list", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const individualInDirectory of client.hris.directory.list()) {\n console.log(individualInDirectory.id);\n}" - }, - "python": { - "method": "hris.directory.list", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\npage = client.hris.directory.list()\npage = page.individuals[0]\nprint(page.id)" - }, - "java": { - "method": "hris().directory().list", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisDirectoryListPage;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n HrisDirectoryListPage page = client.hris().directory().list();\n }\n}" - }, - "kotlin": { - "method": "hris().directory().list", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisDirectoryListPage\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val page: HrisDirectoryListPage = client.hris().directory().list()\n}" - }, - "go": { - "method": "client.HRIS.Directory.List", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tpage, err := client.HRIS.Directory.List(context.TODO(), finchgo.HRISDirectoryListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n" - }, - "ruby": { - "method": "hris.directory.list", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\npage = finch.hris.directory.list\n\nputs(page)" - }, - "http": { - "example": "curl https://api.tryfinch.com/employer/directory \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + name: 'list', + endpoint: '/employer/directory', + httpMethod: 'get', + summary: 'Directory', + description: 'Read company directory and organization structure', + stainlessPath: '(resource) hris.directory > (method) list', + qualified: 'client.hris.directory.list', + params: ['entity_ids?: string[];', 'limit?: number;', 'offset?: number;'], + response: + '{ id: string; department: { name?: string; }; first_name: string; is_active: boolean; last_name: string; manager: { id: string; }; middle_name: string; }', + markdown: + "## list\n\n`client.hris.directory.list(entity_ids?: string[], limit?: number, offset?: number): { id: string; department: object; first_name: string; is_active: boolean; last_name: string; manager: object; middle_name: string; }`\n\n**get** `/employer/directory`\n\nRead company directory and organization structure\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `limit?: number`\n Number of employees to return (defaults to all)\n\n- `offset?: number`\n Index to start from (defaults to 0)\n\n### Returns\n\n- `{ id: string; department: { name?: string; }; first_name: string; is_active: boolean; last_name: string; manager: { id: string; }; middle_name: string; }`\n\n - `id: string`\n - `department: { name?: string; }`\n - `first_name: string`\n - `is_active: boolean`\n - `last_name: string`\n - `manager: { id: string; }`\n - `middle_name: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const individualInDirectory of client.hris.directory.list()) {\n console.log(individualInDirectory);\n}\n```", + perLanguage: { + typescript: { + method: 'client.hris.directory.list', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const individualInDirectory of client.hris.directory.list()) {\n console.log(individualInDirectory.id);\n}", + }, + python: { + method: 'hris.directory.list', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.directory.list()\npage = page.individuals[0]\nprint(page.id)', + }, + java: { + method: 'hris().directory().list', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisDirectoryListPage;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HrisDirectoryListPage page = client.hris().directory().list();\n }\n}', + }, + kotlin: { + method: 'hris().directory().list', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisDirectoryListPage\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val page: HrisDirectoryListPage = client.hris().directory().list()\n}', + }, + go: { + method: 'client.HRIS.Directory.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Directory.List(context.TODO(), finchgo.HRISDirectoryListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'hris.directory.list', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.directory.list\n\nputs(page)', + }, + http: { + example: + 'curl https://api.tryfinch.com/employer/directory \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "list_individuals", - "endpoint": "/employer/directory", - "httpMethod": "get", - "summary": "Directory", - "description": "Read company directory and organization structure", - "stainlessPath": "(resource) hris.directory > (method) list_individuals", - "qualified": "client.hris.directory.listIndividuals", - "perLanguage": { - "typescript": { - "method": "client.hris.directory.listIndividuals", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.hris.directory.listIndividuals();\n\nconsole.log(response.individuals);" - }, - "python": { - "method": "hris.directory.list_individuals", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nresponse = client.hris.directory.list_individuals()\nprint(response.individuals)" - }, - "java": { - "method": "hris().directory().listIndividuals", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.DirectoryListIndividualsResponse;\nimport com.tryfinch.api.models.HrisDirectoryListIndividualsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n DirectoryListIndividualsResponse response = client.hris().directory().listIndividuals();\n }\n}" - }, - "kotlin": { - "method": "hris().directory().listIndividuals", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.DirectoryListIndividualsResponse\nimport com.tryfinch.api.models.HrisDirectoryListIndividualsParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val response: DirectoryListIndividualsResponse = client.hris().directory().listIndividuals()\n}" - }, - "go": { - "method": "client.HRIS.Directory.ListIndividuals", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tresponse, err := client.HRIS.Directory.ListIndividuals(context.TODO(), finchgo.HRISDirectoryListIndividualsParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.Individuals)\n}\n" - }, - "ruby": { - "method": "hris.directory.list_individuals", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nresponse = finch.hris.directory.list_individuals\n\nputs(response)" - } - } + name: 'list_individuals', + endpoint: '/employer/directory', + httpMethod: 'get', + summary: 'Directory', + description: 'Read company directory and organization structure', + stainlessPath: '(resource) hris.directory > (method) list_individuals', + qualified: 'client.hris.directory.listIndividuals', + perLanguage: { + typescript: { + method: 'client.hris.directory.listIndividuals', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.hris.directory.listIndividuals();\n\nconsole.log(response.individuals);", + }, + python: { + method: 'hris.directory.list_individuals', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nresponse = client.hris.directory.list_individuals()\nprint(response.individuals)', + }, + java: { + method: 'hris().directory().listIndividuals', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.DirectoryListIndividualsResponse;\nimport com.tryfinch.api.models.HrisDirectoryListIndividualsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DirectoryListIndividualsResponse response = client.hris().directory().listIndividuals();\n }\n}', + }, + kotlin: { + method: 'hris().directory().listIndividuals', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.DirectoryListIndividualsResponse\nimport com.tryfinch.api.models.HrisDirectoryListIndividualsParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val response: DirectoryListIndividualsResponse = client.hris().directory().listIndividuals()\n}', + }, + go: { + method: 'client.HRIS.Directory.ListIndividuals', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.HRIS.Directory.ListIndividuals(context.TODO(), finchgo.HRISDirectoryListIndividualsParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response.Individuals)\n}\n', + }, + ruby: { + method: 'hris.directory.list_individuals', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nresponse = finch.hris.directory.list_individuals\n\nputs(response)', + }, + }, }, { - "name": "retrieve_many", - "endpoint": "/employer/individual", - "httpMethod": "post", - "summary": "Individual", - "description": "Read individual data, excluding income and employment data", - "stainlessPath": "(resource) hris.individuals > (method) retrieve_many", - "qualified": "client.hris.individuals.retrieveMany", - "params": [ - "entity_ids?: string[];", - "options?: { include?: string[]; };", - "requests?: { individual_id?: string; }[];" + name: 'retrieve_many', + endpoint: '/employer/individual', + httpMethod: 'post', + summary: 'Individual', + description: 'Read individual data, excluding income and employment data', + stainlessPath: '(resource) hris.individuals > (method) retrieve_many', + qualified: 'client.hris.individuals.retrieveMany', + params: [ + 'entity_ids?: string[];', + 'options?: { include?: string[]; };', + 'requests?: { individual_id?: string; }[];', ], - "response": "{ body: { id: string; dob: string; ethnicity: string; first_name: string; gender: 'female' | 'male' | 'other' | 'decline_to_specify'; last_name: string; middle_name: string; phone_numbers: object[]; preferred_name: string; residence: location; emails?: object[]; encrypted_ssn?: string; ssn?: string; } | { code: number; message: string; name: string; finch_code?: string; }; code: number; individual_id: string; }", - "markdown": "## retrieve_many\n\n`client.hris.individuals.retrieveMany(entity_ids?: string[], options?: { include?: string[]; }, requests?: { individual_id?: string; }[]): { body: individual; code: number; individual_id: string; }`\n\n**post** `/employer/individual`\n\nRead individual data, excluding income and employment data\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `options?: { include?: string[]; }`\n - `include?: string[]`\n\n- `requests?: { individual_id?: string; }[]`\n\n### Returns\n\n- `{ body: { id: string; dob: string; ethnicity: string; first_name: string; gender: 'female' | 'male' | 'other' | 'decline_to_specify'; last_name: string; middle_name: string; phone_numbers: object[]; preferred_name: string; residence: location; emails?: object[]; encrypted_ssn?: string; ssn?: string; } | { code: number; message: string; name: string; finch_code?: string; }; code: number; individual_id: string; }`\n\n - `body: { id: string; dob: string; ethnicity: string; first_name: string; gender: 'female' | 'male' | 'other' | 'decline_to_specify'; last_name: string; middle_name: string; phone_numbers: { data: string; type: 'work' | 'personal'; }[]; preferred_name: string; residence: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; emails?: { data: string; type: 'work' | 'personal'; }[]; encrypted_ssn?: string; ssn?: string; } | { code: number; message: string; name: string; finch_code?: string; }`\n - `code: number`\n - `individual_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const individualResponse of client.hris.individuals.retrieveMany()) {\n console.log(individualResponse);\n}\n```", - "perLanguage": { - "typescript": { - "method": "client.hris.individuals.retrieveMany", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const individualResponse of client.hris.individuals.retrieveMany()) {\n console.log(individualResponse.individual_id);\n}" - }, - "python": { - "method": "hris.individuals.retrieve_many", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\npage = client.hris.individuals.retrieve_many()\npage = page.responses[0]\nprint(page.individual_id)" - }, - "java": { - "method": "hris().individuals().retrieveMany", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisIndividualRetrieveManyPage;\nimport com.tryfinch.api.models.HrisIndividualRetrieveManyParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n HrisIndividualRetrieveManyPage page = client.hris().individuals().retrieveMany();\n }\n}" - }, - "kotlin": { - "method": "hris().individuals().retrieveMany", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisIndividualRetrieveManyPage\nimport com.tryfinch.api.models.HrisIndividualRetrieveManyParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val page: HrisIndividualRetrieveManyPage = client.hris().individuals().retrieveMany()\n}" - }, - "go": { - "method": "client.HRIS.Individuals.GetMany", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tpage, err := client.HRIS.Individuals.GetMany(context.TODO(), finchgo.HRISIndividualGetManyParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n" - }, - "ruby": { - "method": "hris.individuals.retrieve_many", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\npage = finch.hris.individuals.retrieve_many\n\nputs(page)" - }, - "http": { - "example": "curl https://api.tryfinch.com/employer/individual \\\n -X POST \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + response: + "{ body: { id: string; dob: string; ethnicity: string; first_name: string; gender: 'female' | 'male' | 'other' | 'decline_to_specify'; last_name: string; middle_name: string; phone_numbers: object[]; preferred_name: string; residence: location; emails?: object[]; encrypted_ssn?: string; ssn?: string; } | { code: number; message: string; name: string; finch_code?: string; }; code: number; individual_id: string; }", + markdown: + "## retrieve_many\n\n`client.hris.individuals.retrieveMany(entity_ids?: string[], options?: { include?: string[]; }, requests?: { individual_id?: string; }[]): { body: individual; code: number; individual_id: string; }`\n\n**post** `/employer/individual`\n\nRead individual data, excluding income and employment data\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `options?: { include?: string[]; }`\n - `include?: string[]`\n\n- `requests?: { individual_id?: string; }[]`\n\n### Returns\n\n- `{ body: { id: string; dob: string; ethnicity: string; first_name: string; gender: 'female' | 'male' | 'other' | 'decline_to_specify'; last_name: string; middle_name: string; phone_numbers: object[]; preferred_name: string; residence: location; emails?: object[]; encrypted_ssn?: string; ssn?: string; } | { code: number; message: string; name: string; finch_code?: string; }; code: number; individual_id: string; }`\n\n - `body: { id: string; dob: string; ethnicity: string; first_name: string; gender: 'female' | 'male' | 'other' | 'decline_to_specify'; last_name: string; middle_name: string; phone_numbers: { data: string; type: 'work' | 'personal'; }[]; preferred_name: string; residence: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; emails?: { data: string; type: 'work' | 'personal'; }[]; encrypted_ssn?: string; ssn?: string; } | { code: number; message: string; name: string; finch_code?: string; }`\n - `code: number`\n - `individual_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const individualResponse of client.hris.individuals.retrieveMany()) {\n console.log(individualResponse);\n}\n```", + perLanguage: { + typescript: { + method: 'client.hris.individuals.retrieveMany', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const individualResponse of client.hris.individuals.retrieveMany()) {\n console.log(individualResponse.individual_id);\n}", + }, + python: { + method: 'hris.individuals.retrieve_many', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.individuals.retrieve_many()\npage = page.responses[0]\nprint(page.individual_id)', + }, + java: { + method: 'hris().individuals().retrieveMany', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisIndividualRetrieveManyPage;\nimport com.tryfinch.api.models.HrisIndividualRetrieveManyParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HrisIndividualRetrieveManyPage page = client.hris().individuals().retrieveMany();\n }\n}', + }, + kotlin: { + method: 'hris().individuals().retrieveMany', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisIndividualRetrieveManyPage\nimport com.tryfinch.api.models.HrisIndividualRetrieveManyParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val page: HrisIndividualRetrieveManyPage = client.hris().individuals().retrieveMany()\n}', + }, + go: { + method: 'client.HRIS.Individuals.GetMany', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Individuals.GetMany(context.TODO(), finchgo.HRISIndividualGetManyParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'hris.individuals.retrieve_many', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.individuals.retrieve_many\n\nputs(page)', + }, + http: { + example: + 'curl https://api.tryfinch.com/employer/individual \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "retrieve_many", - "endpoint": "/employer/employment", - "httpMethod": "post", - "summary": "Employment", - "description": "Read individual employment and income data", - "stainlessPath": "(resource) hris.employments > (method) retrieve_many", - "qualified": "client.hris.employments.retrieveMany", - "params": [ - "requests: { individual_id: string; }[];", - "entity_ids?: string[];" - ], - "response": "{ body: { id: string; class_code: string; department: object; employment: object; employment_status: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; end_date: string; first_name: string; flsa_status: 'exempt' | 'non_exempt' | 'unknown'; is_active: boolean; last_name: string; latest_rehire_date: string; location: location; manager: object; middle_name: string; start_date: string; title: string; custom_fields?: object[]; income?: income; income_history?: income[]; source_id?: string; work_id?: string; } | { code: number; message: string; name: string; finch_code?: string; }; code: number; individual_id: string; }", - "markdown": "## retrieve_many\n\n`client.hris.employments.retrieveMany(requests: { individual_id: string; }[], entity_ids?: string[]): { body: employment_data; code: number; individual_id: string; }`\n\n**post** `/employer/employment`\n\nRead individual employment and income data\n\n### Parameters\n\n- `requests: { individual_id: string; }[]`\n The array of batch requests.\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ body: { id: string; class_code: string; department: object; employment: object; employment_status: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; end_date: string; first_name: string; flsa_status: 'exempt' | 'non_exempt' | 'unknown'; is_active: boolean; last_name: string; latest_rehire_date: string; location: location; manager: object; middle_name: string; start_date: string; title: string; custom_fields?: object[]; income?: income; income_history?: income[]; source_id?: string; work_id?: string; } | { code: number; message: string; name: string; finch_code?: string; }; code: number; individual_id: string; }`\n\n - `body: { id: string; class_code: string; department: { name: string; }; employment: { subtype: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type: 'employee' | 'contractor'; }; employment_status: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; end_date: string; first_name: string; flsa_status: 'exempt' | 'non_exempt' | 'unknown'; is_active: boolean; last_name: string; latest_rehire_date: string; location: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; manager: { id: string; }; middle_name: string; start_date: string; title: string; custom_fields?: { name?: string; value?: string | object[] | object | number | boolean; }[]; income?: { amount: number; currency: string; effective_date: string; unit: string; }; income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]; source_id?: string; work_id?: string; } | { code: number; message: string; name: string; finch_code?: string; }`\n - `code: number`\n - `individual_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const employmentDataResponse of client.hris.employments.retrieveMany({ requests: [{ individual_id: 'individual_id' }] })) {\n console.log(employmentDataResponse);\n}\n```", - "perLanguage": { - "typescript": { - "method": "client.hris.employments.retrieveMany", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const employmentDataResponse of client.hris.employments.retrieveMany({\n requests: [{ individual_id: 'individual_id' }],\n})) {\n console.log(employmentDataResponse.individual_id);\n}" - }, - "python": { - "method": "hris.employments.retrieve_many", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\npage = client.hris.employments.retrieve_many(\n requests=[{\n \"individual_id\": \"individual_id\"\n }],\n)\npage = page.responses[0]\nprint(page.individual_id)" - }, - "java": { - "method": "hris().employments().retrieveMany", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisEmploymentRetrieveManyPage;\nimport com.tryfinch.api.models.HrisEmploymentRetrieveManyParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n HrisEmploymentRetrieveManyParams params = HrisEmploymentRetrieveManyParams.builder()\n .addRequest(HrisEmploymentRetrieveManyParams.Request.builder()\n .individualId(\"individual_id\")\n .build())\n .build();\n HrisEmploymentRetrieveManyPage page = client.hris().employments().retrieveMany(params);\n }\n}" - }, - "kotlin": { - "method": "hris().employments().retrieveMany", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisEmploymentRetrieveManyPage\nimport com.tryfinch.api.models.HrisEmploymentRetrieveManyParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val params: HrisEmploymentRetrieveManyParams = HrisEmploymentRetrieveManyParams.builder()\n .addRequest(HrisEmploymentRetrieveManyParams.Request.builder()\n .individualId(\"individual_id\")\n .build())\n .build()\n val page: HrisEmploymentRetrieveManyPage = client.hris().employments().retrieveMany(params)\n}" - }, - "go": { - "method": "client.HRIS.Employments.GetMany", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tpage, err := client.HRIS.Employments.GetMany(context.TODO(), finchgo.HRISEmploymentGetManyParams{\n\t\tRequests: finchgo.F([]finchgo.HRISEmploymentGetManyParamsRequest{{\n\t\t\tIndividualID: finchgo.F(\"individual_id\"),\n\t\t}}),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n" - }, - "ruby": { - "method": "hris.employments.retrieve_many", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\npage = finch.hris.employments.retrieve_many(requests: [{individual_id: \"individual_id\"}])\n\nputs(page)" - }, - "http": { - "example": "curl https://api.tryfinch.com/employer/employment \\\n -H 'Content-Type: application/json' \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{\n \"requests\": [\n {\n \"individual_id\": \"individual_id\"\n }\n ]\n }'" - } - } + name: 'retrieve_many', + endpoint: '/employer/employment', + httpMethod: 'post', + summary: 'Employment', + description: 'Read individual employment and income data', + stainlessPath: '(resource) hris.employments > (method) retrieve_many', + qualified: 'client.hris.employments.retrieveMany', + params: ['requests: { individual_id: string; }[];', 'entity_ids?: string[];'], + response: + "{ body: { id: string; class_code: string; department: object; employment: object; employment_status: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; end_date: string; first_name: string; flsa_status: 'exempt' | 'non_exempt' | 'unknown'; is_active: boolean; last_name: string; latest_rehire_date: string; location: location; manager: object; middle_name: string; start_date: string; title: string; custom_fields?: object[]; income?: income; income_history?: income[]; source_id?: string; work_id?: string; } | { code: number; message: string; name: string; finch_code?: string; }; code: number; individual_id: string; }", + markdown: + "## retrieve_many\n\n`client.hris.employments.retrieveMany(requests: { individual_id: string; }[], entity_ids?: string[]): { body: employment_data; code: number; individual_id: string; }`\n\n**post** `/employer/employment`\n\nRead individual employment and income data\n\n### Parameters\n\n- `requests: { individual_id: string; }[]`\n The array of batch requests.\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ body: { id: string; class_code: string; department: object; employment: object; employment_status: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; end_date: string; first_name: string; flsa_status: 'exempt' | 'non_exempt' | 'unknown'; is_active: boolean; last_name: string; latest_rehire_date: string; location: location; manager: object; middle_name: string; start_date: string; title: string; custom_fields?: object[]; income?: income; income_history?: income[]; source_id?: string; work_id?: string; } | { code: number; message: string; name: string; finch_code?: string; }; code: number; individual_id: string; }`\n\n - `body: { id: string; class_code: string; department: { name: string; }; employment: { subtype: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type: 'employee' | 'contractor'; }; employment_status: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; end_date: string; first_name: string; flsa_status: 'exempt' | 'non_exempt' | 'unknown'; is_active: boolean; last_name: string; latest_rehire_date: string; location: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; manager: { id: string; }; middle_name: string; start_date: string; title: string; custom_fields?: { name?: string; value?: string | object[] | object | number | boolean; }[]; income?: { amount: number; currency: string; effective_date: string; unit: string; }; income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]; source_id?: string; work_id?: string; } | { code: number; message: string; name: string; finch_code?: string; }`\n - `code: number`\n - `individual_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const employmentDataResponse of client.hris.employments.retrieveMany({ requests: [{ individual_id: 'individual_id' }] })) {\n console.log(employmentDataResponse);\n}\n```", + perLanguage: { + typescript: { + method: 'client.hris.employments.retrieveMany', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const employmentDataResponse of client.hris.employments.retrieveMany({\n requests: [{ individual_id: 'individual_id' }],\n})) {\n console.log(employmentDataResponse.individual_id);\n}", + }, + python: { + method: 'hris.employments.retrieve_many', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.employments.retrieve_many(\n requests=[{\n "individual_id": "individual_id"\n }],\n)\npage = page.responses[0]\nprint(page.individual_id)', + }, + java: { + method: 'hris().employments().retrieveMany', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisEmploymentRetrieveManyPage;\nimport com.tryfinch.api.models.HrisEmploymentRetrieveManyParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HrisEmploymentRetrieveManyParams params = HrisEmploymentRetrieveManyParams.builder()\n .addRequest(HrisEmploymentRetrieveManyParams.Request.builder()\n .individualId("individual_id")\n .build())\n .build();\n HrisEmploymentRetrieveManyPage page = client.hris().employments().retrieveMany(params);\n }\n}', + }, + kotlin: { + method: 'hris().employments().retrieveMany', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisEmploymentRetrieveManyPage\nimport com.tryfinch.api.models.HrisEmploymentRetrieveManyParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val params: HrisEmploymentRetrieveManyParams = HrisEmploymentRetrieveManyParams.builder()\n .addRequest(HrisEmploymentRetrieveManyParams.Request.builder()\n .individualId("individual_id")\n .build())\n .build()\n val page: HrisEmploymentRetrieveManyPage = client.hris().employments().retrieveMany(params)\n}', + }, + go: { + method: 'client.HRIS.Employments.GetMany', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Employments.GetMany(context.TODO(), finchgo.HRISEmploymentGetManyParams{\n\t\tRequests: finchgo.F([]finchgo.HRISEmploymentGetManyParamsRequest{{\n\t\t\tIndividualID: finchgo.F("individual_id"),\n\t\t}}),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'hris.employments.retrieve_many', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.employments.retrieve_many(requests: [{individual_id: "individual_id"}])\n\nputs(page)', + }, + http: { + example: + 'curl https://api.tryfinch.com/employer/employment \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "requests": [\n {\n "individual_id": "individual_id"\n }\n ]\n }\'', + }, + }, }, { - "name": "list", - "endpoint": "/employer/payment", - "httpMethod": "get", - "summary": "Payment", - "description": "Read payroll and contractor related payments by the company.", - "stainlessPath": "(resource) hris.payments > (method) list", - "qualified": "client.hris.payments.list", - "params": [ - "end_date: string;", - "start_date: string;", - "entity_ids?: string[];" - ], - "response": "{ id: string; company_debit: { amount: number; currency: string; }; debit_date: string; employee_taxes: { amount: number; currency: string; }; employer_taxes: { amount: number; currency: string; }; gross_pay: { amount: number; currency: string; }; individual_ids: string[]; net_pay: { amount: number; currency: string; }; pay_date: string; pay_frequencies: string[]; pay_group_ids: string[]; pay_period: { end_date: string; start_date: string; }; }", - "markdown": "## list\n\n`client.hris.payments.list(end_date: string, start_date: string, entity_ids?: string[]): { id: string; company_debit: money; debit_date: string; employee_taxes: money; employer_taxes: money; gross_pay: money; individual_ids: string[]; net_pay: money; pay_date: string; pay_frequencies: string[]; pay_group_ids: string[]; pay_period: object; }`\n\n**get** `/employer/payment`\n\nRead payroll and contractor related payments by the company.\n\n### Parameters\n\n- `end_date: string`\n The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` format. Filters payments by their **pay_date** field.\n\n- `start_date: string`\n The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` format. Filters payments by their **pay_date** field.\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ id: string; company_debit: { amount: number; currency: string; }; debit_date: string; employee_taxes: { amount: number; currency: string; }; employer_taxes: { amount: number; currency: string; }; gross_pay: { amount: number; currency: string; }; individual_ids: string[]; net_pay: { amount: number; currency: string; }; pay_date: string; pay_frequencies: string[]; pay_group_ids: string[]; pay_period: { end_date: string; start_date: string; }; }`\n\n - `id: string`\n - `company_debit: { amount: number; currency: string; }`\n - `debit_date: string`\n - `employee_taxes: { amount: number; currency: string; }`\n - `employer_taxes: { amount: number; currency: string; }`\n - `gross_pay: { amount: number; currency: string; }`\n - `individual_ids: string[]`\n - `net_pay: { amount: number; currency: string; }`\n - `pay_date: string`\n - `pay_frequencies: string[]`\n - `pay_group_ids: string[]`\n - `pay_period: { end_date: string; start_date: string; }`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const payment of client.hris.payments.list({ end_date: '2021-01-01', start_date: '2021-01-01' })) {\n console.log(payment);\n}\n```", - "perLanguage": { - "typescript": { - "method": "client.hris.payments.list", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const payment of client.hris.payments.list({\n end_date: '2021-01-01',\n start_date: '2021-01-01',\n})) {\n console.log(payment.id);\n}" - }, - "python": { - "method": "hris.payments.list", - "example": "from datetime import date\nfrom finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\npage = client.hris.payments.list(\n end_date=date.fromisoformat(\"2021-01-01\"),\n start_date=date.fromisoformat(\"2021-01-01\"),\n)\npage = page.items[0]\nprint(page.id)" - }, - "java": { - "method": "hris().payments().list", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisPaymentListPage;\nimport com.tryfinch.api.models.HrisPaymentListParams;\nimport java.time.LocalDate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n HrisPaymentListParams params = HrisPaymentListParams.builder()\n .endDate(LocalDate.parse(\"2021-01-01\"))\n .startDate(LocalDate.parse(\"2021-01-01\"))\n .build();\n HrisPaymentListPage page = client.hris().payments().list(params);\n }\n}" - }, - "kotlin": { - "method": "hris().payments().list", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisPaymentListPage\nimport com.tryfinch.api.models.HrisPaymentListParams\nimport java.time.LocalDate\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val params: HrisPaymentListParams = HrisPaymentListParams.builder()\n .endDate(LocalDate.parse(\"2021-01-01\"))\n .startDate(LocalDate.parse(\"2021-01-01\"))\n .build()\n val page: HrisPaymentListPage = client.hris().payments().list(params)\n}" - }, - "go": { - "method": "client.HRIS.Payments.List", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"time\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tpage, err := client.HRIS.Payments.List(context.TODO(), finchgo.HRISPaymentListParams{\n\t\tEndDate: finchgo.F(time.Now()),\n\t\tStartDate: finchgo.F(time.Now()),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n" - }, - "ruby": { - "method": "hris.payments.list", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\npage = finch.hris.payments.list(end_date: \"2021-01-01\", start_date: \"2021-01-01\")\n\nputs(page)" - }, - "http": { - "example": "curl https://api.tryfinch.com/employer/payment \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + name: 'list', + endpoint: '/employer/payment', + httpMethod: 'get', + summary: 'Payment', + description: 'Read payroll and contractor related payments by the company.', + stainlessPath: '(resource) hris.payments > (method) list', + qualified: 'client.hris.payments.list', + params: ['end_date: string;', 'start_date: string;', 'entity_ids?: string[];'], + response: + '{ id: string; company_debit: { amount: number; currency: string; }; debit_date: string; employee_taxes: { amount: number; currency: string; }; employer_taxes: { amount: number; currency: string; }; gross_pay: { amount: number; currency: string; }; individual_ids: string[]; net_pay: { amount: number; currency: string; }; pay_date: string; pay_frequencies: string[]; pay_group_ids: string[]; pay_period: { end_date: string; start_date: string; }; }', + markdown: + "## list\n\n`client.hris.payments.list(end_date: string, start_date: string, entity_ids?: string[]): { id: string; company_debit: money; debit_date: string; employee_taxes: money; employer_taxes: money; gross_pay: money; individual_ids: string[]; net_pay: money; pay_date: string; pay_frequencies: string[]; pay_group_ids: string[]; pay_period: object; }`\n\n**get** `/employer/payment`\n\nRead payroll and contractor related payments by the company.\n\n### Parameters\n\n- `end_date: string`\n The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` format. Filters payments by their **pay_date** field.\n\n- `start_date: string`\n The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` format. Filters payments by their **pay_date** field.\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ id: string; company_debit: { amount: number; currency: string; }; debit_date: string; employee_taxes: { amount: number; currency: string; }; employer_taxes: { amount: number; currency: string; }; gross_pay: { amount: number; currency: string; }; individual_ids: string[]; net_pay: { amount: number; currency: string; }; pay_date: string; pay_frequencies: string[]; pay_group_ids: string[]; pay_period: { end_date: string; start_date: string; }; }`\n\n - `id: string`\n - `company_debit: { amount: number; currency: string; }`\n - `debit_date: string`\n - `employee_taxes: { amount: number; currency: string; }`\n - `employer_taxes: { amount: number; currency: string; }`\n - `gross_pay: { amount: number; currency: string; }`\n - `individual_ids: string[]`\n - `net_pay: { amount: number; currency: string; }`\n - `pay_date: string`\n - `pay_frequencies: string[]`\n - `pay_group_ids: string[]`\n - `pay_period: { end_date: string; start_date: string; }`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const payment of client.hris.payments.list({ end_date: '2021-01-01', start_date: '2021-01-01' })) {\n console.log(payment);\n}\n```", + perLanguage: { + typescript: { + method: 'client.hris.payments.list', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const payment of client.hris.payments.list({\n end_date: '2021-01-01',\n start_date: '2021-01-01',\n})) {\n console.log(payment.id);\n}", + }, + python: { + method: 'hris.payments.list', + example: + 'from datetime import date\nfrom finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.payments.list(\n end_date=date.fromisoformat("2021-01-01"),\n start_date=date.fromisoformat("2021-01-01"),\n)\npage = page.items[0]\nprint(page.id)', + }, + java: { + method: 'hris().payments().list', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisPaymentListPage;\nimport com.tryfinch.api.models.HrisPaymentListParams;\nimport java.time.LocalDate;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HrisPaymentListParams params = HrisPaymentListParams.builder()\n .endDate(LocalDate.parse("2021-01-01"))\n .startDate(LocalDate.parse("2021-01-01"))\n .build();\n HrisPaymentListPage page = client.hris().payments().list(params);\n }\n}', + }, + kotlin: { + method: 'hris().payments().list', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisPaymentListPage\nimport com.tryfinch.api.models.HrisPaymentListParams\nimport java.time.LocalDate\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val params: HrisPaymentListParams = HrisPaymentListParams.builder()\n .endDate(LocalDate.parse("2021-01-01"))\n .startDate(LocalDate.parse("2021-01-01"))\n .build()\n val page: HrisPaymentListPage = client.hris().payments().list(params)\n}', + }, + go: { + method: 'client.HRIS.Payments.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\t"time"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Payments.List(context.TODO(), finchgo.HRISPaymentListParams{\n\t\tEndDate: finchgo.F(time.Now()),\n\t\tStartDate: finchgo.F(time.Now()),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'hris.payments.list', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.payments.list(end_date: "2021-01-01", start_date: "2021-01-01")\n\nputs(page)', + }, + http: { + example: + 'curl https://api.tryfinch.com/employer/payment \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "retrieve_many", - "endpoint": "/employer/pay-statement", - "httpMethod": "post", - "summary": "Pay Statement", - "description": "Read detailed pay statements for each individual.\n\nDeduction and contribution types are supported by the payroll systems that supports Benefits.", - "stainlessPath": "(resource) hris.pay_statements > (method) retrieve_many", - "qualified": "client.hris.payStatements.retrieveMany", - "params": [ - "requests: { payment_id: string; limit?: number; offset?: number; }[];", - "entity_ids?: string[];" + name: 'retrieve_many', + endpoint: '/employer/pay-statement', + httpMethod: 'post', + summary: 'Pay Statement', + description: + 'Read detailed pay statements for each individual.\n\nDeduction and contribution types are supported by the payroll systems that supports Benefits.', + stainlessPath: '(resource) hris.pay_statements > (method) retrieve_many', + qualified: 'client.hris.payStatements.retrieveMany', + params: [ + 'requests: { payment_id: string; limit?: number; offset?: number; }[];', + 'entity_ids?: string[];', ], - "response": "{ body: { paging: object; pay_statements: pay_statement[]; } | { code: number; message: string; name: string; finch_code?: string; } | { code: 202; finch_code: 'data_sync_in_progress'; message: 'The pay statements for this payment are being fetched. Please check back later.'; name: 'accepted'; }; code: number; payment_id: string; }", - "markdown": "## retrieve_many\n\n`client.hris.payStatements.retrieveMany(requests: { payment_id: string; limit?: number; offset?: number; }[], entity_ids?: string[]): { body: pay_statement_response_body | object | pay_statement_data_sync_in_progress; code: number; payment_id: string; }`\n\n**post** `/employer/pay-statement`\n\nRead detailed pay statements for each individual.\n\nDeduction and contribution types are supported by the payroll systems that supports Benefits.\n\n### Parameters\n\n- `requests: { payment_id: string; limit?: number; offset?: number; }[]`\n The array of batch requests.\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ body: { paging: object; pay_statements: pay_statement[]; } | { code: number; message: string; name: string; finch_code?: string; } | { code: 202; finch_code: 'data_sync_in_progress'; message: 'The pay statements for this payment are being fetched. Please check back later.'; name: 'accepted'; }; code: number; payment_id: string; }`\n\n - `body: { paging: { offset: number; count?: number; }; pay_statements: { earnings: object[]; employee_deductions: object[]; employer_contributions: object[]; gross_pay: money; individual_id: string; net_pay: money; payment_method: 'check' | 'direct_deposit' | 'other'; taxes: object[]; total_hours: number; type: 'off_cycle_payroll' | 'one_time_payment' | 'regular_payroll'; }[]; } | { code: number; message: string; name: string; finch_code?: string; } | { code: 202; finch_code: 'data_sync_in_progress'; message: 'The pay statements for this payment are being fetched. Please check back later.'; name: 'accepted'; }`\n - `code: number`\n - `payment_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const payStatementResponse of client.hris.payStatements.retrieveMany({ requests: [{ payment_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }] })) {\n console.log(payStatementResponse);\n}\n```", - "perLanguage": { - "typescript": { - "method": "client.hris.payStatements.retrieveMany", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const payStatementResponse of client.hris.payStatements.retrieveMany({\n requests: [{ payment_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }],\n})) {\n console.log(payStatementResponse.payment_id);\n}" - }, - "python": { - "method": "hris.pay_statements.retrieve_many", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\npage = client.hris.pay_statements.retrieve_many(\n requests=[{\n \"payment_id\": \"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\"\n }],\n)\npage = page.responses[0]\nprint(page.payment_id)" - }, - "java": { - "method": "hris().payStatements().retrieveMany", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisPayStatementRetrieveManyPage;\nimport com.tryfinch.api.models.HrisPayStatementRetrieveManyParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n HrisPayStatementRetrieveManyParams params = HrisPayStatementRetrieveManyParams.builder()\n .addRequest(HrisPayStatementRetrieveManyParams.Request.builder()\n .paymentId(\"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\")\n .build())\n .build();\n HrisPayStatementRetrieveManyPage page = client.hris().payStatements().retrieveMany(params);\n }\n}" - }, - "kotlin": { - "method": "hris().payStatements().retrieveMany", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisPayStatementRetrieveManyPage\nimport com.tryfinch.api.models.HrisPayStatementRetrieveManyParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val params: HrisPayStatementRetrieveManyParams = HrisPayStatementRetrieveManyParams.builder()\n .addRequest(HrisPayStatementRetrieveManyParams.Request.builder()\n .paymentId(\"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\")\n .build())\n .build()\n val page: HrisPayStatementRetrieveManyPage = client.hris().payStatements().retrieveMany(params)\n}" - }, - "go": { - "method": "client.HRIS.PayStatements.GetMany", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tpage, err := client.HRIS.PayStatements.GetMany(context.TODO(), finchgo.HRISPayStatementGetManyParams{\n\t\tRequests: finchgo.F([]finchgo.HRISPayStatementGetManyParamsRequest{{\n\t\t\tPaymentID: finchgo.F(\"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\"),\n\t\t}}),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n" - }, - "ruby": { - "method": "hris.pay_statements.retrieve_many", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\npage = finch.hris.pay_statements.retrieve_many(requests: [{payment_id: \"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\"}])\n\nputs(page)" - }, - "http": { - "example": "curl https://api.tryfinch.com/employer/pay-statement \\\n -H 'Content-Type: application/json' \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{\n \"requests\": [\n {\n \"payment_id\": \"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\"\n }\n ]\n }'" - } - } + response: + "{ body: { paging: object; pay_statements: pay_statement[]; } | { code: number; message: string; name: string; finch_code?: string; } | { code: 202; finch_code: 'data_sync_in_progress'; message: 'The pay statements for this payment are being fetched. Please check back later.'; name: 'accepted'; }; code: number; payment_id: string; }", + markdown: + "## retrieve_many\n\n`client.hris.payStatements.retrieveMany(requests: { payment_id: string; limit?: number; offset?: number; }[], entity_ids?: string[]): { body: pay_statement_response_body | object | pay_statement_data_sync_in_progress; code: number; payment_id: string; }`\n\n**post** `/employer/pay-statement`\n\nRead detailed pay statements for each individual.\n\nDeduction and contribution types are supported by the payroll systems that supports Benefits.\n\n### Parameters\n\n- `requests: { payment_id: string; limit?: number; offset?: number; }[]`\n The array of batch requests.\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ body: { paging: object; pay_statements: pay_statement[]; } | { code: number; message: string; name: string; finch_code?: string; } | { code: 202; finch_code: 'data_sync_in_progress'; message: 'The pay statements for this payment are being fetched. Please check back later.'; name: 'accepted'; }; code: number; payment_id: string; }`\n\n - `body: { paging: { offset: number; count?: number; }; pay_statements: { earnings: object[]; employee_deductions: object[]; employer_contributions: object[]; gross_pay: money; individual_id: string; net_pay: money; payment_method: 'check' | 'direct_deposit' | 'other'; taxes: object[]; total_hours: number; type: 'off_cycle_payroll' | 'one_time_payment' | 'regular_payroll'; }[]; } | { code: number; message: string; name: string; finch_code?: string; } | { code: 202; finch_code: 'data_sync_in_progress'; message: 'The pay statements for this payment are being fetched. Please check back later.'; name: 'accepted'; }`\n - `code: number`\n - `payment_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const payStatementResponse of client.hris.payStatements.retrieveMany({ requests: [{ payment_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }] })) {\n console.log(payStatementResponse);\n}\n```", + perLanguage: { + typescript: { + method: 'client.hris.payStatements.retrieveMany', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const payStatementResponse of client.hris.payStatements.retrieveMany({\n requests: [{ payment_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }],\n})) {\n console.log(payStatementResponse.payment_id);\n}", + }, + python: { + method: 'hris.pay_statements.retrieve_many', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.pay_statements.retrieve_many(\n requests=[{\n "payment_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"\n }],\n)\npage = page.responses[0]\nprint(page.payment_id)', + }, + java: { + method: 'hris().payStatements().retrieveMany', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisPayStatementRetrieveManyPage;\nimport com.tryfinch.api.models.HrisPayStatementRetrieveManyParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HrisPayStatementRetrieveManyParams params = HrisPayStatementRetrieveManyParams.builder()\n .addRequest(HrisPayStatementRetrieveManyParams.Request.builder()\n .paymentId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")\n .build())\n .build();\n HrisPayStatementRetrieveManyPage page = client.hris().payStatements().retrieveMany(params);\n }\n}', + }, + kotlin: { + method: 'hris().payStatements().retrieveMany', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisPayStatementRetrieveManyPage\nimport com.tryfinch.api.models.HrisPayStatementRetrieveManyParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val params: HrisPayStatementRetrieveManyParams = HrisPayStatementRetrieveManyParams.builder()\n .addRequest(HrisPayStatementRetrieveManyParams.Request.builder()\n .paymentId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")\n .build())\n .build()\n val page: HrisPayStatementRetrieveManyPage = client.hris().payStatements().retrieveMany(params)\n}', + }, + go: { + method: 'client.HRIS.PayStatements.GetMany', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.PayStatements.GetMany(context.TODO(), finchgo.HRISPayStatementGetManyParams{\n\t\tRequests: finchgo.F([]finchgo.HRISPayStatementGetManyParamsRequest{{\n\t\t\tPaymentID: finchgo.F("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"),\n\t\t}}),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'hris.pay_statements.retrieve_many', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.pay_statements.retrieve_many(requests: [{payment_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"}])\n\nputs(page)', + }, + http: { + example: + 'curl https://api.tryfinch.com/employer/pay-statement \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "requests": [\n {\n "payment_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"\n }\n ]\n }\'', + }, + }, }, { - "name": "list", - "endpoint": "/employer/documents", - "httpMethod": "get", - "summary": "List Documents", - "description": "**Beta:** This endpoint is in beta and may change.\nRetrieve a list of company-wide documents.\n", - "stainlessPath": "(resource) hris.documents > (method) list", - "qualified": "client.hris.documents.list", - "params": [ - "entity_ids?: string[];", - "individual_ids?: string[];", - "limit?: number;", - "offset?: number;", - "types?: 'w4_2020' | 'w4_2005'[];" + name: 'list', + endpoint: '/employer/documents', + httpMethod: 'get', + summary: 'List Documents', + description: + '**Beta:** This endpoint is in beta and may change.\nRetrieve a list of company-wide documents.\n', + stainlessPath: '(resource) hris.documents > (method) list', + qualified: 'client.hris.documents.list', + params: [ + 'entity_ids?: string[];', + 'individual_ids?: string[];', + 'limit?: number;', + 'offset?: number;', + "types?: 'w4_2020' | 'w4_2005'[];", ], - "response": "{ documents: { id: string; individual_id: string; type: 'w4_2020' | 'w4_2005'; url: string; year: number; }[]; paging: { offset: number; count?: number; }; }", - "markdown": "## list\n\n`client.hris.documents.list(entity_ids?: string[], individual_ids?: string[], limit?: number, offset?: number, types?: 'w4_2020' | 'w4_2005'[]): { documents: document_response[]; paging: paging; }`\n\n**get** `/employer/documents`\n\n**Beta:** This endpoint is in beta and may change.\nRetrieve a list of company-wide documents.\n\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `individual_ids?: string[]`\n Comma-delimited list of stable Finch uuids for each individual. If empty, defaults to all individuals\n\n- `limit?: number`\n Number of documents to return (defaults to all)\n\n- `offset?: number`\n Index to start from (defaults to 0)\n\n- `types?: 'w4_2020' | 'w4_2005'[]`\n Comma-delimited list of document types to filter on. If empty, defaults to all types\n\n### Returns\n\n- `{ documents: { id: string; individual_id: string; type: 'w4_2020' | 'w4_2005'; url: string; year: number; }[]; paging: { offset: number; count?: number; }; }`\n\n - `documents: { id: string; individual_id: string; type: 'w4_2020' | 'w4_2005'; url: string; year: number; }[]`\n - `paging: { offset: number; count?: number; }`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst documents = await client.hris.documents.list();\n\nconsole.log(documents);\n```", - "perLanguage": { - "typescript": { - "method": "client.hris.documents.list", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst documents = await client.hris.documents.list();\n\nconsole.log(documents.documents);" - }, - "python": { - "method": "hris.documents.list", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\ndocuments = client.hris.documents.list()\nprint(documents.documents)" - }, - "java": { - "method": "hris().documents().list", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.DocumentListResponse;\nimport com.tryfinch.api.models.HrisDocumentListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n DocumentListResponse documents = client.hris().documents().list();\n }\n}" - }, - "kotlin": { - "method": "hris().documents().list", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.DocumentListResponse\nimport com.tryfinch.api.models.HrisDocumentListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val documents: DocumentListResponse = client.hris().documents().list()\n}" - }, - "go": { - "method": "client.HRIS.Documents.List", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tdocuments, err := client.HRIS.Documents.List(context.TODO(), finchgo.HRISDocumentListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", documents.Documents)\n}\n" - }, - "ruby": { - "method": "hris.documents.list", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\ndocuments = finch.hris.documents.list\n\nputs(documents)" - }, - "http": { - "example": "curl https://api.tryfinch.com/employer/documents \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + response: + "{ documents: { id: string; individual_id: string; type: 'w4_2020' | 'w4_2005'; url: string; year: number; }[]; paging: { offset: number; count?: number; }; }", + markdown: + "## list\n\n`client.hris.documents.list(entity_ids?: string[], individual_ids?: string[], limit?: number, offset?: number, types?: 'w4_2020' | 'w4_2005'[]): { documents: document_response[]; paging: paging; }`\n\n**get** `/employer/documents`\n\n**Beta:** This endpoint is in beta and may change.\nRetrieve a list of company-wide documents.\n\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `individual_ids?: string[]`\n Comma-delimited list of stable Finch uuids for each individual. If empty, defaults to all individuals\n\n- `limit?: number`\n Number of documents to return (defaults to all)\n\n- `offset?: number`\n Index to start from (defaults to 0)\n\n- `types?: 'w4_2020' | 'w4_2005'[]`\n Comma-delimited list of document types to filter on. If empty, defaults to all types\n\n### Returns\n\n- `{ documents: { id: string; individual_id: string; type: 'w4_2020' | 'w4_2005'; url: string; year: number; }[]; paging: { offset: number; count?: number; }; }`\n\n - `documents: { id: string; individual_id: string; type: 'w4_2020' | 'w4_2005'; url: string; year: number; }[]`\n - `paging: { offset: number; count?: number; }`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst documents = await client.hris.documents.list();\n\nconsole.log(documents);\n```", + perLanguage: { + typescript: { + method: 'client.hris.documents.list', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst documents = await client.hris.documents.list();\n\nconsole.log(documents.documents);", + }, + python: { + method: 'hris.documents.list', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\ndocuments = client.hris.documents.list()\nprint(documents.documents)', + }, + java: { + method: 'hris().documents().list', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.DocumentListResponse;\nimport com.tryfinch.api.models.HrisDocumentListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DocumentListResponse documents = client.hris().documents().list();\n }\n}', + }, + kotlin: { + method: 'hris().documents().list', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.DocumentListResponse\nimport com.tryfinch.api.models.HrisDocumentListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val documents: DocumentListResponse = client.hris().documents().list()\n}', + }, + go: { + method: 'client.HRIS.Documents.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tdocuments, err := client.HRIS.Documents.List(context.TODO(), finchgo.HRISDocumentListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", documents.Documents)\n}\n', + }, + ruby: { + method: 'hris.documents.list', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\ndocuments = finch.hris.documents.list\n\nputs(documents)', + }, + http: { + example: + 'curl https://api.tryfinch.com/employer/documents \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "retreive", - "endpoint": "/employer/documents/{document_id}", - "httpMethod": "get", - "summary": "Get Document", - "description": "**Beta:** This endpoint is in beta and may change.\nRetrieve details of a specific document by its ID.\n", - "stainlessPath": "(resource) hris.documents > (method) retreive", - "qualified": "client.hris.documents.retreive", - "params": [ - "document_id: string;", - "entity_ids?: string[];" - ], - "response": "{ data: { amount_for_other_dependents: number; amount_for_qualifying_children_under_17: number; deductions: number; extra_withholding: number; filing_status: string; individual_id: string; other_income: number; total_claim_dependent_and_other_credits: number; }; type: 'w4_2020'; year: number; } | { data: { additional_withholding: number; exemption: 'exempt' | 'non_exempt'; filing_status: 'married' | 'married_but_withhold_at_higher_single_rate' | 'single'; individual_id: string; total_number_of_allowances: number; }; type: 'w4_2005'; year: number; }", - "markdown": "## retreive\n\n`client.hris.documents.retreive(document_id: string, entity_ids?: string[]): object | object`\n\n**get** `/employer/documents/{document_id}`\n\n**Beta:** This endpoint is in beta and may change.\nRetrieve details of a specific document by its ID.\n\n\n### Parameters\n\n- `document_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ data: { amount_for_other_dependents: number; amount_for_qualifying_children_under_17: number; deductions: number; extra_withholding: number; filing_status: string; individual_id: string; other_income: number; total_claim_dependent_and_other_credits: number; }; type: 'w4_2020'; year: number; } | { data: { additional_withholding: number; exemption: 'exempt' | 'non_exempt'; filing_status: 'married' | 'married_but_withhold_at_higher_single_rate' | 'single'; individual_id: string; total_number_of_allowances: number; }; type: 'w4_2005'; year: number; }`\n A 2020 version of the W-4 tax form containing information on an individual's filing status, dependents, and withholding details.\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst response = await client.hris.documents.retreive('document_id');\n\nconsole.log(response);\n```", - "perLanguage": { - "typescript": { - "method": "client.hris.documents.retreive", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.hris.documents.retreive('document_id');\n\nconsole.log(response);" - }, - "python": { - "method": "hris.documents.retreive", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nresponse = client.hris.documents.retreive(\n document_id=\"document_id\",\n)\nprint(response)" - }, - "java": { - "method": "hris().documents().retreive", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.DocumentRetreiveResponse;\nimport com.tryfinch.api.models.HrisDocumentRetreiveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n DocumentRetreiveResponse response = client.hris().documents().retreive(\"document_id\");\n }\n}" - }, - "kotlin": { - "method": "hris().documents().retreive", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.DocumentRetreiveResponse\nimport com.tryfinch.api.models.HrisDocumentRetreiveParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val response: DocumentRetreiveResponse = client.hris().documents().retreive(\"document_id\")\n}" - }, - "go": { - "method": "client.HRIS.Documents.Retreive", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tresponse, err := client.HRIS.Documents.Retreive(\n\t\tcontext.TODO(),\n\t\t\"document_id\",\n\t\tfinchgo.HRISDocumentRetreiveParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response)\n}\n" - }, - "ruby": { - "method": "hris.documents.retreive", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nresponse = finch.hris.documents.retreive(\"document_id\")\n\nputs(response)" - }, - "http": { - "example": "curl https://api.tryfinch.com/employer/documents/$DOCUMENT_ID \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + name: 'retreive', + endpoint: '/employer/documents/{document_id}', + httpMethod: 'get', + summary: 'Get Document', + description: + '**Beta:** This endpoint is in beta and may change.\nRetrieve details of a specific document by its ID.\n', + stainlessPath: '(resource) hris.documents > (method) retreive', + qualified: 'client.hris.documents.retreive', + params: ['document_id: string;', 'entity_ids?: string[];'], + response: + "{ data: { amount_for_other_dependents: number; amount_for_qualifying_children_under_17: number; deductions: number; extra_withholding: number; filing_status: string; individual_id: string; other_income: number; total_claim_dependent_and_other_credits: number; }; type: 'w4_2020'; year: number; } | { data: { additional_withholding: number; exemption: 'exempt' | 'non_exempt'; filing_status: 'married' | 'married_but_withhold_at_higher_single_rate' | 'single'; individual_id: string; total_number_of_allowances: number; }; type: 'w4_2005'; year: number; }", + markdown: + "## retreive\n\n`client.hris.documents.retreive(document_id: string, entity_ids?: string[]): object | object`\n\n**get** `/employer/documents/{document_id}`\n\n**Beta:** This endpoint is in beta and may change.\nRetrieve details of a specific document by its ID.\n\n\n### Parameters\n\n- `document_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ data: { amount_for_other_dependents: number; amount_for_qualifying_children_under_17: number; deductions: number; extra_withholding: number; filing_status: string; individual_id: string; other_income: number; total_claim_dependent_and_other_credits: number; }; type: 'w4_2020'; year: number; } | { data: { additional_withholding: number; exemption: 'exempt' | 'non_exempt'; filing_status: 'married' | 'married_but_withhold_at_higher_single_rate' | 'single'; individual_id: string; total_number_of_allowances: number; }; type: 'w4_2005'; year: number; }`\n A 2020 version of the W-4 tax form containing information on an individual's filing status, dependents, and withholding details.\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst response = await client.hris.documents.retreive('document_id');\n\nconsole.log(response);\n```", + perLanguage: { + typescript: { + method: 'client.hris.documents.retreive', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.hris.documents.retreive('document_id');\n\nconsole.log(response);", + }, + python: { + method: 'hris.documents.retreive', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nresponse = client.hris.documents.retreive(\n document_id="document_id",\n)\nprint(response)', + }, + java: { + method: 'hris().documents().retreive', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.DocumentRetreiveResponse;\nimport com.tryfinch.api.models.HrisDocumentRetreiveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DocumentRetreiveResponse response = client.hris().documents().retreive("document_id");\n }\n}', + }, + kotlin: { + method: 'hris().documents().retreive', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.DocumentRetreiveResponse\nimport com.tryfinch.api.models.HrisDocumentRetreiveParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val response: DocumentRetreiveResponse = client.hris().documents().retreive("document_id")\n}', + }, + go: { + method: 'client.HRIS.Documents.Retreive', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.HRIS.Documents.Retreive(\n\t\tcontext.TODO(),\n\t\t"document_id",\n\t\tfinchgo.HRISDocumentRetreiveParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response)\n}\n', + }, + ruby: { + method: 'hris.documents.retreive', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nresponse = finch.hris.documents.retreive("document_id")\n\nputs(response)', + }, + http: { + example: + 'curl https://api.tryfinch.com/employer/documents/$DOCUMENT_ID \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "list", - "endpoint": "/employer/benefits", - "httpMethod": "get", - "summary": "Get All Deductions", - "description": "List all company-wide deductions and contributions.", - "stainlessPath": "(resource) hris.benefits > (method) list", - "qualified": "client.hris.benefits.list", - "params": [ - "entity_ids?: string[];" - ], - "response": "{ benefit_id: string; description: string; frequency: 'every_paycheck' | 'monthly' | 'one_time'; type: string; company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }; }", - "markdown": "## list\n\n`client.hris.benefits.list(entity_ids?: string[]): { benefit_id: string; description: string; frequency: benefit_frequency; type: benefit_type; company_contribution?: object; }`\n\n**get** `/employer/benefits`\n\nList all company-wide deductions and contributions.\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ benefit_id: string; description: string; frequency: 'every_paycheck' | 'monthly' | 'one_time'; type: string; company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }; }`\n\n - `benefit_id: string`\n - `description: string`\n - `frequency: 'every_paycheck' | 'monthly' | 'one_time'`\n - `type: string`\n - `company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const companyBenefit of client.hris.benefits.list()) {\n console.log(companyBenefit);\n}\n```", - "perLanguage": { - "typescript": { - "method": "client.hris.benefits.list", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const companyBenefit of client.hris.benefits.list()) {\n console.log(companyBenefit.benefit_id);\n}" - }, - "python": { - "method": "hris.benefits.list", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\npage = client.hris.benefits.list()\npage = page.items[0]\nprint(page.benefit_id)" - }, - "java": { - "method": "hris().benefits().list", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisBenefitListPage;\nimport com.tryfinch.api.models.HrisBenefitListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n HrisBenefitListPage page = client.hris().benefits().list();\n }\n}" - }, - "kotlin": { - "method": "hris().benefits().list", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisBenefitListPage\nimport com.tryfinch.api.models.HrisBenefitListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val page: HrisBenefitListPage = client.hris().benefits().list()\n}" - }, - "go": { - "method": "client.HRIS.Benefits.List", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tpage, err := client.HRIS.Benefits.List(context.TODO(), finchgo.HRISBenefitListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n" - }, - "ruby": { - "method": "hris.benefits.list", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\npage = finch.hris.benefits.list\n\nputs(page)" - }, - "http": { - "example": "curl https://api.tryfinch.com/employer/benefits \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + name: 'list', + endpoint: '/employer/benefits', + httpMethod: 'get', + summary: 'Get All Deductions', + description: 'List all company-wide deductions and contributions.', + stainlessPath: '(resource) hris.benefits > (method) list', + qualified: 'client.hris.benefits.list', + params: ['entity_ids?: string[];'], + response: + "{ benefit_id: string; description: string; frequency: 'every_paycheck' | 'monthly' | 'one_time'; type: string; company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }; }", + markdown: + "## list\n\n`client.hris.benefits.list(entity_ids?: string[]): { benefit_id: string; description: string; frequency: benefit_frequency; type: benefit_type; company_contribution?: object; }`\n\n**get** `/employer/benefits`\n\nList all company-wide deductions and contributions.\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ benefit_id: string; description: string; frequency: 'every_paycheck' | 'monthly' | 'one_time'; type: string; company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }; }`\n\n - `benefit_id: string`\n - `description: string`\n - `frequency: 'every_paycheck' | 'monthly' | 'one_time'`\n - `type: string`\n - `company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const companyBenefit of client.hris.benefits.list()) {\n console.log(companyBenefit);\n}\n```", + perLanguage: { + typescript: { + method: 'client.hris.benefits.list', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const companyBenefit of client.hris.benefits.list()) {\n console.log(companyBenefit.benefit_id);\n}", + }, + python: { + method: 'hris.benefits.list', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.benefits.list()\npage = page.items[0]\nprint(page.benefit_id)', + }, + java: { + method: 'hris().benefits().list', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisBenefitListPage;\nimport com.tryfinch.api.models.HrisBenefitListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HrisBenefitListPage page = client.hris().benefits().list();\n }\n}', + }, + kotlin: { + method: 'hris().benefits().list', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisBenefitListPage\nimport com.tryfinch.api.models.HrisBenefitListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val page: HrisBenefitListPage = client.hris().benefits().list()\n}', + }, + go: { + method: 'client.HRIS.Benefits.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Benefits.List(context.TODO(), finchgo.HRISBenefitListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'hris.benefits.list', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.benefits.list\n\nputs(page)', + }, + http: { + example: + 'curl https://api.tryfinch.com/employer/benefits \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "create", - "endpoint": "/employer/benefits", - "httpMethod": "post", - "summary": "Create Deduction", - "description": "Creates a new company-wide deduction or contribution. Please use the `/providers` endpoint to view available types for each provider.", - "stainlessPath": "(resource) hris.benefits > (method) create", - "qualified": "client.hris.benefits.create", - "params": [ - "entity_ids?: string[];", + name: 'create', + endpoint: '/employer/benefits', + httpMethod: 'post', + summary: 'Create Deduction', + description: + 'Creates a new company-wide deduction or contribution. Please use the `/providers` endpoint to view available types for each provider.', + stainlessPath: '(resource) hris.benefits > (method) create', + qualified: 'client.hris.benefits.create', + params: [ + 'entity_ids?: string[];', "company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; };", - "description?: string;", + 'description?: string;', "frequency?: 'every_paycheck' | 'monthly' | 'one_time';", - "type?: string;" + 'type?: string;', ], - "response": "{ benefit_id: string; job_id: string; }", - "markdown": "## create\n\n`client.hris.benefits.create(entity_ids?: string[], company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }, description?: string, frequency?: 'every_paycheck' | 'monthly' | 'one_time', type?: string): { benefit_id: string; job_id: string; }`\n\n**post** `/employer/benefits`\n\nCreates a new company-wide deduction or contribution. Please use the `/providers` endpoint to view available types for each provider.\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }`\n The company match for this benefit.\n - `tiers: { match: number; threshold: number; }[]`\n - `type: 'match'`\n\n- `description?: string`\n Name of the benefit as it appears in the provider and pay statements. Recommend limiting this to <30 characters due to limitations in specific providers (e.g. Justworks).\n\n- `frequency?: 'every_paycheck' | 'monthly' | 'one_time'`\n The frequency of the benefit deduction/contribution.\n\n- `type?: string`\n Type of benefit.\n\n### Returns\n\n- `{ benefit_id: string; job_id: string; }`\n\n - `benefit_id: string`\n - `job_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst createCompanyBenefitsResponse = await client.hris.benefits.create();\n\nconsole.log(createCompanyBenefitsResponse);\n```", - "perLanguage": { - "typescript": { - "method": "client.hris.benefits.create", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst createCompanyBenefitsResponse = await client.hris.benefits.create();\n\nconsole.log(createCompanyBenefitsResponse.benefit_id);" - }, - "python": { - "method": "hris.benefits.create", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\ncreate_company_benefits_response = client.hris.benefits.create()\nprint(create_company_benefits_response.benefit_id)" - }, - "java": { - "method": "hris().benefits().create", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.CreateCompanyBenefitsResponse;\nimport com.tryfinch.api.models.HrisBenefitCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n CreateCompanyBenefitsResponse createCompanyBenefitsResponse = client.hris().benefits().create();\n }\n}" - }, - "kotlin": { - "method": "hris().benefits().create", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.CreateCompanyBenefitsResponse\nimport com.tryfinch.api.models.HrisBenefitCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val createCompanyBenefitsResponse: CreateCompanyBenefitsResponse = client.hris().benefits().create()\n}" - }, - "go": { - "method": "client.HRIS.Benefits.New", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tcreateCompanyBenefitsResponse, err := client.HRIS.Benefits.New(context.TODO(), finchgo.HRISBenefitNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", createCompanyBenefitsResponse.BenefitID)\n}\n" - }, - "ruby": { - "method": "hris.benefits.create", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\ncreate_company_benefits_response = finch.hris.benefits.create\n\nputs(create_company_benefits_response)" - }, - "http": { - "example": "curl https://api.tryfinch.com/employer/benefits \\\n -X POST \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + response: '{ benefit_id: string; job_id: string; }', + markdown: + "## create\n\n`client.hris.benefits.create(entity_ids?: string[], company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }, description?: string, frequency?: 'every_paycheck' | 'monthly' | 'one_time', type?: string): { benefit_id: string; job_id: string; }`\n\n**post** `/employer/benefits`\n\nCreates a new company-wide deduction or contribution. Please use the `/providers` endpoint to view available types for each provider.\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }`\n The company match for this benefit.\n - `tiers: { match: number; threshold: number; }[]`\n - `type: 'match'`\n\n- `description?: string`\n Name of the benefit as it appears in the provider and pay statements. Recommend limiting this to <30 characters due to limitations in specific providers (e.g. Justworks).\n\n- `frequency?: 'every_paycheck' | 'monthly' | 'one_time'`\n The frequency of the benefit deduction/contribution.\n\n- `type?: string`\n Type of benefit.\n\n### Returns\n\n- `{ benefit_id: string; job_id: string; }`\n\n - `benefit_id: string`\n - `job_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst createCompanyBenefitsResponse = await client.hris.benefits.create();\n\nconsole.log(createCompanyBenefitsResponse);\n```", + perLanguage: { + typescript: { + method: 'client.hris.benefits.create', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst createCompanyBenefitsResponse = await client.hris.benefits.create();\n\nconsole.log(createCompanyBenefitsResponse.benefit_id);", + }, + python: { + method: 'hris.benefits.create', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\ncreate_company_benefits_response = client.hris.benefits.create()\nprint(create_company_benefits_response.benefit_id)', + }, + java: { + method: 'hris().benefits().create', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.CreateCompanyBenefitsResponse;\nimport com.tryfinch.api.models.HrisBenefitCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CreateCompanyBenefitsResponse createCompanyBenefitsResponse = client.hris().benefits().create();\n }\n}', + }, + kotlin: { + method: 'hris().benefits().create', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.CreateCompanyBenefitsResponse\nimport com.tryfinch.api.models.HrisBenefitCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val createCompanyBenefitsResponse: CreateCompanyBenefitsResponse = client.hris().benefits().create()\n}', + }, + go: { + method: 'client.HRIS.Benefits.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcreateCompanyBenefitsResponse, err := client.HRIS.Benefits.New(context.TODO(), finchgo.HRISBenefitNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", createCompanyBenefitsResponse.BenefitID)\n}\n', + }, + ruby: { + method: 'hris.benefits.create', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\ncreate_company_benefits_response = finch.hris.benefits.create\n\nputs(create_company_benefits_response)', + }, + http: { + example: + 'curl https://api.tryfinch.com/employer/benefits \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "retrieve", - "endpoint": "/employer/benefits/{benefit_id}", - "httpMethod": "get", - "summary": "Get Deduction", - "description": "Lists deductions and contributions information for a given item", - "stainlessPath": "(resource) hris.benefits > (method) retrieve", - "qualified": "client.hris.benefits.retrieve", - "params": [ - "benefit_id: string;", - "entity_ids?: string[];" - ], - "response": "{ benefit_id: string; description: string; frequency: 'every_paycheck' | 'monthly' | 'one_time'; type: string; company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }; }", - "markdown": "## retrieve\n\n`client.hris.benefits.retrieve(benefit_id: string, entity_ids?: string[]): { benefit_id: string; description: string; frequency: benefit_frequency; type: benefit_type; company_contribution?: object; }`\n\n**get** `/employer/benefits/{benefit_id}`\n\nLists deductions and contributions information for a given item\n\n### Parameters\n\n- `benefit_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ benefit_id: string; description: string; frequency: 'every_paycheck' | 'monthly' | 'one_time'; type: string; company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }; }`\n\n - `benefit_id: string`\n - `description: string`\n - `frequency: 'every_paycheck' | 'monthly' | 'one_time'`\n - `type: string`\n - `company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst companyBenefit = await client.hris.benefits.retrieve('benefit_id');\n\nconsole.log(companyBenefit);\n```", - "perLanguage": { - "typescript": { - "method": "client.hris.benefits.retrieve", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst companyBenefit = await client.hris.benefits.retrieve('benefit_id');\n\nconsole.log(companyBenefit.benefit_id);" - }, - "python": { - "method": "hris.benefits.retrieve", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\ncompany_benefit = client.hris.benefits.retrieve(\n benefit_id=\"benefit_id\",\n)\nprint(company_benefit.benefit_id)" - }, - "java": { - "method": "hris().benefits().retrieve", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.CompanyBenefit;\nimport com.tryfinch.api.models.HrisBenefitRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n CompanyBenefit companyBenefit = client.hris().benefits().retrieve(\"benefit_id\");\n }\n}" - }, - "kotlin": { - "method": "hris().benefits().retrieve", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.CompanyBenefit\nimport com.tryfinch.api.models.HrisBenefitRetrieveParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val companyBenefit: CompanyBenefit = client.hris().benefits().retrieve(\"benefit_id\")\n}" - }, - "go": { - "method": "client.HRIS.Benefits.Get", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tcompanyBenefit, err := client.HRIS.Benefits.Get(\n\t\tcontext.TODO(),\n\t\t\"benefit_id\",\n\t\tfinchgo.HRISBenefitGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", companyBenefit.BenefitID)\n}\n" - }, - "ruby": { - "method": "hris.benefits.retrieve", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\ncompany_benefit = finch.hris.benefits.retrieve(\"benefit_id\")\n\nputs(company_benefit)" - }, - "http": { - "example": "curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + name: 'retrieve', + endpoint: '/employer/benefits/{benefit_id}', + httpMethod: 'get', + summary: 'Get Deduction', + description: 'Lists deductions and contributions information for a given item', + stainlessPath: '(resource) hris.benefits > (method) retrieve', + qualified: 'client.hris.benefits.retrieve', + params: ['benefit_id: string;', 'entity_ids?: string[];'], + response: + "{ benefit_id: string; description: string; frequency: 'every_paycheck' | 'monthly' | 'one_time'; type: string; company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }; }", + markdown: + "## retrieve\n\n`client.hris.benefits.retrieve(benefit_id: string, entity_ids?: string[]): { benefit_id: string; description: string; frequency: benefit_frequency; type: benefit_type; company_contribution?: object; }`\n\n**get** `/employer/benefits/{benefit_id}`\n\nLists deductions and contributions information for a given item\n\n### Parameters\n\n- `benefit_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ benefit_id: string; description: string; frequency: 'every_paycheck' | 'monthly' | 'one_time'; type: string; company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }; }`\n\n - `benefit_id: string`\n - `description: string`\n - `frequency: 'every_paycheck' | 'monthly' | 'one_time'`\n - `type: string`\n - `company_contribution?: { tiers: { match: number; threshold: number; }[]; type: 'match'; }`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst companyBenefit = await client.hris.benefits.retrieve('benefit_id');\n\nconsole.log(companyBenefit);\n```", + perLanguage: { + typescript: { + method: 'client.hris.benefits.retrieve', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst companyBenefit = await client.hris.benefits.retrieve('benefit_id');\n\nconsole.log(companyBenefit.benefit_id);", + }, + python: { + method: 'hris.benefits.retrieve', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\ncompany_benefit = client.hris.benefits.retrieve(\n benefit_id="benefit_id",\n)\nprint(company_benefit.benefit_id)', + }, + java: { + method: 'hris().benefits().retrieve', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.CompanyBenefit;\nimport com.tryfinch.api.models.HrisBenefitRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n CompanyBenefit companyBenefit = client.hris().benefits().retrieve("benefit_id");\n }\n}', + }, + kotlin: { + method: 'hris().benefits().retrieve', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.CompanyBenefit\nimport com.tryfinch.api.models.HrisBenefitRetrieveParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val companyBenefit: CompanyBenefit = client.hris().benefits().retrieve("benefit_id")\n}', + }, + go: { + method: 'client.HRIS.Benefits.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcompanyBenefit, err := client.HRIS.Benefits.Get(\n\t\tcontext.TODO(),\n\t\t"benefit_id",\n\t\tfinchgo.HRISBenefitGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", companyBenefit.BenefitID)\n}\n', + }, + ruby: { + method: 'hris.benefits.retrieve', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\ncompany_benefit = finch.hris.benefits.retrieve("benefit_id")\n\nputs(company_benefit)', + }, + http: { + example: + 'curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "update", - "endpoint": "/employer/benefits/{benefit_id}", - "httpMethod": "post", - "summary": "Update Deduction", - "description": "Updates an existing company-wide deduction or contribution", - "stainlessPath": "(resource) hris.benefits > (method) update", - "qualified": "client.hris.benefits.update", - "params": [ - "benefit_id: string;", - "entity_ids?: string[];", - "description?: string;" - ], - "response": "{ benefit_id: string; job_id: string; }", - "markdown": "## update\n\n`client.hris.benefits.update(benefit_id: string, entity_ids?: string[], description?: string): { benefit_id: string; job_id: string; }`\n\n**post** `/employer/benefits/{benefit_id}`\n\nUpdates an existing company-wide deduction or contribution\n\n### Parameters\n\n- `benefit_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `description?: string`\n Updated name or description.\n\n### Returns\n\n- `{ benefit_id: string; job_id: string; }`\n\n - `benefit_id: string`\n - `job_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst updateCompanyBenefitResponse = await client.hris.benefits.update('benefit_id');\n\nconsole.log(updateCompanyBenefitResponse);\n```", - "perLanguage": { - "typescript": { - "method": "client.hris.benefits.update", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst updateCompanyBenefitResponse = await client.hris.benefits.update('benefit_id');\n\nconsole.log(updateCompanyBenefitResponse.benefit_id);" - }, - "python": { - "method": "hris.benefits.update", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nupdate_company_benefit_response = client.hris.benefits.update(\n benefit_id=\"benefit_id\",\n)\nprint(update_company_benefit_response.benefit_id)" - }, - "java": { - "method": "hris().benefits().update", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisBenefitUpdateParams;\nimport com.tryfinch.api.models.UpdateCompanyBenefitResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n UpdateCompanyBenefitResponse updateCompanyBenefitResponse = client.hris().benefits().update(\"benefit_id\");\n }\n}" - }, - "kotlin": { - "method": "hris().benefits().update", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisBenefitUpdateParams\nimport com.tryfinch.api.models.UpdateCompanyBenefitResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val updateCompanyBenefitResponse: UpdateCompanyBenefitResponse = client.hris().benefits().update(\"benefit_id\")\n}" - }, - "go": { - "method": "client.HRIS.Benefits.Update", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tupdateCompanyBenefitResponse, err := client.HRIS.Benefits.Update(\n\t\tcontext.TODO(),\n\t\t\"benefit_id\",\n\t\tfinchgo.HRISBenefitUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", updateCompanyBenefitResponse.BenefitID)\n}\n" - }, - "ruby": { - "method": "hris.benefits.update", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nupdate_company_benefit_response = finch.hris.benefits.update(\"benefit_id\")\n\nputs(update_company_benefit_response)" - }, - "http": { - "example": "curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID \\\n -X POST \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + name: 'update', + endpoint: '/employer/benefits/{benefit_id}', + httpMethod: 'post', + summary: 'Update Deduction', + description: 'Updates an existing company-wide deduction or contribution', + stainlessPath: '(resource) hris.benefits > (method) update', + qualified: 'client.hris.benefits.update', + params: ['benefit_id: string;', 'entity_ids?: string[];', 'description?: string;'], + response: '{ benefit_id: string; job_id: string; }', + markdown: + "## update\n\n`client.hris.benefits.update(benefit_id: string, entity_ids?: string[], description?: string): { benefit_id: string; job_id: string; }`\n\n**post** `/employer/benefits/{benefit_id}`\n\nUpdates an existing company-wide deduction or contribution\n\n### Parameters\n\n- `benefit_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `description?: string`\n Updated name or description.\n\n### Returns\n\n- `{ benefit_id: string; job_id: string; }`\n\n - `benefit_id: string`\n - `job_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst updateCompanyBenefitResponse = await client.hris.benefits.update('benefit_id');\n\nconsole.log(updateCompanyBenefitResponse);\n```", + perLanguage: { + typescript: { + method: 'client.hris.benefits.update', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst updateCompanyBenefitResponse = await client.hris.benefits.update('benefit_id');\n\nconsole.log(updateCompanyBenefitResponse.benefit_id);", + }, + python: { + method: 'hris.benefits.update', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nupdate_company_benefit_response = client.hris.benefits.update(\n benefit_id="benefit_id",\n)\nprint(update_company_benefit_response.benefit_id)', + }, + java: { + method: 'hris().benefits().update', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisBenefitUpdateParams;\nimport com.tryfinch.api.models.UpdateCompanyBenefitResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UpdateCompanyBenefitResponse updateCompanyBenefitResponse = client.hris().benefits().update("benefit_id");\n }\n}', + }, + kotlin: { + method: 'hris().benefits().update', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisBenefitUpdateParams\nimport com.tryfinch.api.models.UpdateCompanyBenefitResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val updateCompanyBenefitResponse: UpdateCompanyBenefitResponse = client.hris().benefits().update("benefit_id")\n}', + }, + go: { + method: 'client.HRIS.Benefits.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tupdateCompanyBenefitResponse, err := client.HRIS.Benefits.Update(\n\t\tcontext.TODO(),\n\t\t"benefit_id",\n\t\tfinchgo.HRISBenefitUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", updateCompanyBenefitResponse.BenefitID)\n}\n', + }, + ruby: { + method: 'hris.benefits.update', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nupdate_company_benefit_response = finch.hris.benefits.update("benefit_id")\n\nputs(update_company_benefit_response)', + }, + http: { + example: + 'curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "list_supported_benefits", - "endpoint": "/employer/benefits/meta", - "httpMethod": "get", - "summary": "[Deprecated] Get Deductions Metadata", - "description": "Get deductions metadata", - "stainlessPath": "(resource) hris.benefits > (method) list_supported_benefits", - "qualified": "client.hris.benefits.listSupportedBenefits", - "params": [ - "entity_ids?: string[];" - ], - "response": "{ annual_maximum: boolean; company_contribution: 'fixed' | 'percent' | 'tiered'[]; description: string; employee_deduction: 'fixed' | 'percent'[]; frequencies: 'every_paycheck' | 'monthly' | 'one_time'[]; catch_up?: boolean; hsa_contribution_limit?: 'family' | 'individual'[]; }", - "markdown": "## list_supported_benefits\n\n`client.hris.benefits.listSupportedBenefits(entity_ids?: string[]): { annual_maximum: boolean; company_contribution: 'fixed' | 'percent' | 'tiered'[]; description: string; employee_deduction: 'fixed' | 'percent'[]; frequencies: benefit_frequency[]; catch_up?: boolean; hsa_contribution_limit?: 'family' | 'individual'[]; }`\n\n**get** `/employer/benefits/meta`\n\nGet deductions metadata\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ annual_maximum: boolean; company_contribution: 'fixed' | 'percent' | 'tiered'[]; description: string; employee_deduction: 'fixed' | 'percent'[]; frequencies: 'every_paycheck' | 'monthly' | 'one_time'[]; catch_up?: boolean; hsa_contribution_limit?: 'family' | 'individual'[]; }`\n\n - `annual_maximum: boolean`\n - `company_contribution: 'fixed' | 'percent' | 'tiered'[]`\n - `description: string`\n - `employee_deduction: 'fixed' | 'percent'[]`\n - `frequencies: 'every_paycheck' | 'monthly' | 'one_time'[]`\n - `catch_up?: boolean`\n - `hsa_contribution_limit?: 'family' | 'individual'[]`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const supportedBenefit of client.hris.benefits.listSupportedBenefits()) {\n console.log(supportedBenefit);\n}\n```", - "perLanguage": { - "typescript": { - "method": "client.hris.benefits.listSupportedBenefits", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const supportedBenefit of client.hris.benefits.listSupportedBenefits()) {\n console.log(supportedBenefit.annual_maximum);\n}" - }, - "python": { - "method": "hris.benefits.list_supported_benefits", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\npage = client.hris.benefits.list_supported_benefits()\npage = page.items[0]\nprint(page.annual_maximum)" - }, - "java": { - "method": "hris().benefits().listSupportedBenefits", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisBenefitListSupportedBenefitsPage;\nimport com.tryfinch.api.models.HrisBenefitListSupportedBenefitsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n HrisBenefitListSupportedBenefitsPage page = client.hris().benefits().listSupportedBenefits();\n }\n}" - }, - "kotlin": { - "method": "hris().benefits().listSupportedBenefits", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisBenefitListSupportedBenefitsPage\nimport com.tryfinch.api.models.HrisBenefitListSupportedBenefitsParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val page: HrisBenefitListSupportedBenefitsPage = client.hris().benefits().listSupportedBenefits()\n}" - }, - "go": { - "method": "client.HRIS.Benefits.ListSupportedBenefits", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tpage, err := client.HRIS.Benefits.ListSupportedBenefits(context.TODO(), finchgo.HRISBenefitListSupportedBenefitsParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n" - }, - "ruby": { - "method": "hris.benefits.list_supported_benefits", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\npage = finch.hris.benefits.list_supported_benefits\n\nputs(page)" - }, - "http": { - "example": "curl https://api.tryfinch.com/employer/benefits/meta \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + name: 'list_supported_benefits', + endpoint: '/employer/benefits/meta', + httpMethod: 'get', + summary: '[Deprecated] Get Deductions Metadata', + description: 'Get deductions metadata', + stainlessPath: '(resource) hris.benefits > (method) list_supported_benefits', + qualified: 'client.hris.benefits.listSupportedBenefits', + params: ['entity_ids?: string[];'], + response: + "{ annual_maximum: boolean; company_contribution: 'fixed' | 'percent' | 'tiered'[]; description: string; employee_deduction: 'fixed' | 'percent'[]; frequencies: 'every_paycheck' | 'monthly' | 'one_time'[]; catch_up?: boolean; hsa_contribution_limit?: 'family' | 'individual'[]; }", + markdown: + "## list_supported_benefits\n\n`client.hris.benefits.listSupportedBenefits(entity_ids?: string[]): { annual_maximum: boolean; company_contribution: 'fixed' | 'percent' | 'tiered'[]; description: string; employee_deduction: 'fixed' | 'percent'[]; frequencies: benefit_frequency[]; catch_up?: boolean; hsa_contribution_limit?: 'family' | 'individual'[]; }`\n\n**get** `/employer/benefits/meta`\n\nGet deductions metadata\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ annual_maximum: boolean; company_contribution: 'fixed' | 'percent' | 'tiered'[]; description: string; employee_deduction: 'fixed' | 'percent'[]; frequencies: 'every_paycheck' | 'monthly' | 'one_time'[]; catch_up?: boolean; hsa_contribution_limit?: 'family' | 'individual'[]; }`\n\n - `annual_maximum: boolean`\n - `company_contribution: 'fixed' | 'percent' | 'tiered'[]`\n - `description: string`\n - `employee_deduction: 'fixed' | 'percent'[]`\n - `frequencies: 'every_paycheck' | 'monthly' | 'one_time'[]`\n - `catch_up?: boolean`\n - `hsa_contribution_limit?: 'family' | 'individual'[]`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const supportedBenefit of client.hris.benefits.listSupportedBenefits()) {\n console.log(supportedBenefit);\n}\n```", + perLanguage: { + typescript: { + method: 'client.hris.benefits.listSupportedBenefits', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const supportedBenefit of client.hris.benefits.listSupportedBenefits()) {\n console.log(supportedBenefit.annual_maximum);\n}", + }, + python: { + method: 'hris.benefits.list_supported_benefits', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.benefits.list_supported_benefits()\npage = page.items[0]\nprint(page.annual_maximum)', + }, + java: { + method: 'hris().benefits().listSupportedBenefits', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisBenefitListSupportedBenefitsPage;\nimport com.tryfinch.api.models.HrisBenefitListSupportedBenefitsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HrisBenefitListSupportedBenefitsPage page = client.hris().benefits().listSupportedBenefits();\n }\n}', + }, + kotlin: { + method: 'hris().benefits().listSupportedBenefits', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisBenefitListSupportedBenefitsPage\nimport com.tryfinch.api.models.HrisBenefitListSupportedBenefitsParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val page: HrisBenefitListSupportedBenefitsPage = client.hris().benefits().listSupportedBenefits()\n}', + }, + go: { + method: 'client.HRIS.Benefits.ListSupportedBenefits', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Benefits.ListSupportedBenefits(context.TODO(), finchgo.HRISBenefitListSupportedBenefitsParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'hris.benefits.list_supported_benefits', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.benefits.list_supported_benefits\n\nputs(page)', + }, + http: { + example: + 'curl https://api.tryfinch.com/employer/benefits/meta \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "enrolled_ids", - "endpoint": "/employer/benefits/{benefit_id}/enrolled", - "httpMethod": "get", - "summary": "Get Enrolled Individuals", - "description": "Lists individuals currently enrolled in a given deduction.", - "stainlessPath": "(resource) hris.benefits.individuals > (method) enrolled_ids", - "qualified": "client.hris.benefits.individuals.enrolledIDs", - "params": [ - "benefit_id: string;", - "entity_ids?: string[];" - ], - "response": "{ benefit_id: string; individual_ids: string[]; }", - "markdown": "## enrolled_ids\n\n`client.hris.benefits.individuals.enrolledIDs(benefit_id: string, entity_ids?: string[]): { benefit_id: string; individual_ids: string[]; }`\n\n**get** `/employer/benefits/{benefit_id}/enrolled`\n\nLists individuals currently enrolled in a given deduction.\n\n### Parameters\n\n- `benefit_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ benefit_id: string; individual_ids: string[]; }`\n\n - `benefit_id: string`\n - `individual_ids: string[]`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst response = await client.hris.benefits.individuals.enrolledIDs('benefit_id');\n\nconsole.log(response);\n```", - "perLanguage": { - "typescript": { - "method": "client.hris.benefits.individuals.enrolledIDs", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.hris.benefits.individuals.enrolledIDs('benefit_id');\n\nconsole.log(response.benefit_id);" - }, - "python": { - "method": "hris.benefits.individuals.enrolled_ids", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nresponse = client.hris.benefits.individuals.enrolled_ids(\n benefit_id=\"benefit_id\",\n)\nprint(response.benefit_id)" - }, - "java": { - "method": "hris().benefits().individuals().enrolledIds", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisBenefitIndividualEnrolledIdsParams;\nimport com.tryfinch.api.models.IndividualEnrolledIdsResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n IndividualEnrolledIdsResponse response = client.hris().benefits().individuals().enrolledIds(\"benefit_id\");\n }\n}" - }, - "kotlin": { - "method": "hris().benefits().individuals().enrolledIds", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisBenefitIndividualEnrolledIdsParams\nimport com.tryfinch.api.models.IndividualEnrolledIdsResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val response: IndividualEnrolledIdsResponse = client.hris().benefits().individuals().enrolledIds(\"benefit_id\")\n}" - }, - "go": { - "method": "client.HRIS.Benefits.Individuals.EnrolledIDs", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tresponse, err := client.HRIS.Benefits.Individuals.EnrolledIDs(\n\t\tcontext.TODO(),\n\t\t\"benefit_id\",\n\t\tfinchgo.HRISBenefitIndividualEnrolledIDsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.BenefitID)\n}\n" - }, - "ruby": { - "method": "hris.benefits.individuals.enrolled_ids", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nresponse = finch.hris.benefits.individuals.enrolled_ids(\"benefit_id\")\n\nputs(response)" - }, - "http": { - "example": "curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID/enrolled \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + name: 'enrolled_ids', + endpoint: '/employer/benefits/{benefit_id}/enrolled', + httpMethod: 'get', + summary: 'Get Enrolled Individuals', + description: 'Lists individuals currently enrolled in a given deduction.', + stainlessPath: '(resource) hris.benefits.individuals > (method) enrolled_ids', + qualified: 'client.hris.benefits.individuals.enrolledIDs', + params: ['benefit_id: string;', 'entity_ids?: string[];'], + response: '{ benefit_id: string; individual_ids: string[]; }', + markdown: + "## enrolled_ids\n\n`client.hris.benefits.individuals.enrolledIDs(benefit_id: string, entity_ids?: string[]): { benefit_id: string; individual_ids: string[]; }`\n\n**get** `/employer/benefits/{benefit_id}/enrolled`\n\nLists individuals currently enrolled in a given deduction.\n\n### Parameters\n\n- `benefit_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ benefit_id: string; individual_ids: string[]; }`\n\n - `benefit_id: string`\n - `individual_ids: string[]`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst response = await client.hris.benefits.individuals.enrolledIDs('benefit_id');\n\nconsole.log(response);\n```", + perLanguage: { + typescript: { + method: 'client.hris.benefits.individuals.enrolledIDs', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.hris.benefits.individuals.enrolledIDs('benefit_id');\n\nconsole.log(response.benefit_id);", + }, + python: { + method: 'hris.benefits.individuals.enrolled_ids', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nresponse = client.hris.benefits.individuals.enrolled_ids(\n benefit_id="benefit_id",\n)\nprint(response.benefit_id)', + }, + java: { + method: 'hris().benefits().individuals().enrolledIds', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisBenefitIndividualEnrolledIdsParams;\nimport com.tryfinch.api.models.IndividualEnrolledIdsResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n IndividualEnrolledIdsResponse response = client.hris().benefits().individuals().enrolledIds("benefit_id");\n }\n}', + }, + kotlin: { + method: 'hris().benefits().individuals().enrolledIds', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisBenefitIndividualEnrolledIdsParams\nimport com.tryfinch.api.models.IndividualEnrolledIdsResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val response: IndividualEnrolledIdsResponse = client.hris().benefits().individuals().enrolledIds("benefit_id")\n}', + }, + go: { + method: 'client.HRIS.Benefits.Individuals.EnrolledIDs', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.HRIS.Benefits.Individuals.EnrolledIDs(\n\t\tcontext.TODO(),\n\t\t"benefit_id",\n\t\tfinchgo.HRISBenefitIndividualEnrolledIDsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response.BenefitID)\n}\n', + }, + ruby: { + method: 'hris.benefits.individuals.enrolled_ids', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nresponse = finch.hris.benefits.individuals.enrolled_ids("benefit_id")\n\nputs(response)', + }, + http: { + example: + 'curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID/enrolled \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "retrieve_many_benefits", - "endpoint": "/employer/benefits/{benefit_id}/individuals", - "httpMethod": "get", - "summary": "Get Deductions for Individuals", - "description": "Get enrollment information for the given individuals.", - "stainlessPath": "(resource) hris.benefits.individuals > (method) retrieve_many_benefits", - "qualified": "client.hris.benefits.individuals.retrieveManyBenefits", - "params": [ - "benefit_id: string;", - "entity_ids?: string[];", - "individual_ids?: string;" - ], - "response": "{ body: { annual_maximum: number; catch_up: boolean; company_contribution: { amount: number; type: 'fixed'; } | { amount: number; type: 'percent'; } | { tiers: object[]; type: 'tiered'; }; employee_deduction: { amount: number; type: 'fixed'; } | { amount: number; type: 'percent'; }; hsa_contribution_limit?: 'individual' | 'family'; } | { code: number; message: string; name: string; finch_code?: string; }; code: number; individual_id: string; }", - "markdown": "## retrieve_many_benefits\n\n`client.hris.benefits.individuals.retrieveManyBenefits(benefit_id: string, entity_ids?: string[], individual_ids?: string): { body: object | object; code: number; individual_id: string; }`\n\n**get** `/employer/benefits/{benefit_id}/individuals`\n\nGet enrollment information for the given individuals.\n\n### Parameters\n\n- `benefit_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `individual_ids?: string`\n comma-delimited list of stable Finch uuids for each individual. If empty, defaults to all individuals\n\n### Returns\n\n- `{ body: { annual_maximum: number; catch_up: boolean; company_contribution: { amount: number; type: 'fixed'; } | { amount: number; type: 'percent'; } | { tiers: object[]; type: 'tiered'; }; employee_deduction: { amount: number; type: 'fixed'; } | { amount: number; type: 'percent'; }; hsa_contribution_limit?: 'individual' | 'family'; } | { code: number; message: string; name: string; finch_code?: string; }; code: number; individual_id: string; }`\n\n - `body: { annual_maximum: number; catch_up: boolean; company_contribution: { amount: number; type: 'fixed'; } | { amount: number; type: 'percent'; } | { tiers: { match: number; threshold: number; }[]; type: 'tiered'; }; employee_deduction: { amount: number; type: 'fixed'; } | { amount: number; type: 'percent'; }; hsa_contribution_limit?: 'individual' | 'family'; } | { code: number; message: string; name: string; finch_code?: string; }`\n - `code: number`\n - `individual_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const individualBenefit of client.hris.benefits.individuals.retrieveManyBenefits('benefit_id')) {\n console.log(individualBenefit);\n}\n```", - "perLanguage": { - "typescript": { - "method": "client.hris.benefits.individuals.retrieveManyBenefits", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const individualBenefit of client.hris.benefits.individuals.retrieveManyBenefits(\n 'benefit_id',\n)) {\n console.log(individualBenefit.individual_id);\n}" - }, - "python": { - "method": "hris.benefits.individuals.retrieve_many_benefits", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\npage = client.hris.benefits.individuals.retrieve_many_benefits(\n benefit_id=\"benefit_id\",\n)\npage = page.items[0]\nprint(page.individual_id)" - }, - "java": { - "method": "hris().benefits().individuals().retrieveManyBenefits", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisBenefitIndividualRetrieveManyBenefitsPage;\nimport com.tryfinch.api.models.HrisBenefitIndividualRetrieveManyBenefitsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n HrisBenefitIndividualRetrieveManyBenefitsPage page = client.hris().benefits().individuals().retrieveManyBenefits(\"benefit_id\");\n }\n}" - }, - "kotlin": { - "method": "hris().benefits().individuals().retrieveManyBenefits", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisBenefitIndividualRetrieveManyBenefitsPage\nimport com.tryfinch.api.models.HrisBenefitIndividualRetrieveManyBenefitsParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val page: HrisBenefitIndividualRetrieveManyBenefitsPage = client.hris().benefits().individuals().retrieveManyBenefits(\"benefit_id\")\n}" - }, - "go": { - "method": "client.HRIS.Benefits.Individuals.GetManyBenefits", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tpage, err := client.HRIS.Benefits.Individuals.GetManyBenefits(\n\t\tcontext.TODO(),\n\t\t\"benefit_id\",\n\t\tfinchgo.HRISBenefitIndividualGetManyBenefitsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n" - }, - "ruby": { - "method": "hris.benefits.individuals.retrieve_many_benefits", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\npage = finch.hris.benefits.individuals.retrieve_many_benefits(\"benefit_id\")\n\nputs(page)" - }, - "http": { - "example": "curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID/individuals \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + name: 'retrieve_many_benefits', + endpoint: '/employer/benefits/{benefit_id}/individuals', + httpMethod: 'get', + summary: 'Get Deductions for Individuals', + description: 'Get enrollment information for the given individuals.', + stainlessPath: '(resource) hris.benefits.individuals > (method) retrieve_many_benefits', + qualified: 'client.hris.benefits.individuals.retrieveManyBenefits', + params: ['benefit_id: string;', 'entity_ids?: string[];', 'individual_ids?: string;'], + response: + "{ body: { annual_maximum: number; catch_up: boolean; company_contribution: { amount: number; type: 'fixed'; } | { amount: number; type: 'percent'; } | { tiers: object[]; type: 'tiered'; }; employee_deduction: { amount: number; type: 'fixed'; } | { amount: number; type: 'percent'; }; hsa_contribution_limit?: 'individual' | 'family'; } | { code: number; message: string; name: string; finch_code?: string; }; code: number; individual_id: string; }", + markdown: + "## retrieve_many_benefits\n\n`client.hris.benefits.individuals.retrieveManyBenefits(benefit_id: string, entity_ids?: string[], individual_ids?: string): { body: object | object; code: number; individual_id: string; }`\n\n**get** `/employer/benefits/{benefit_id}/individuals`\n\nGet enrollment information for the given individuals.\n\n### Parameters\n\n- `benefit_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `individual_ids?: string`\n comma-delimited list of stable Finch uuids for each individual. If empty, defaults to all individuals\n\n### Returns\n\n- `{ body: { annual_maximum: number; catch_up: boolean; company_contribution: { amount: number; type: 'fixed'; } | { amount: number; type: 'percent'; } | { tiers: object[]; type: 'tiered'; }; employee_deduction: { amount: number; type: 'fixed'; } | { amount: number; type: 'percent'; }; hsa_contribution_limit?: 'individual' | 'family'; } | { code: number; message: string; name: string; finch_code?: string; }; code: number; individual_id: string; }`\n\n - `body: { annual_maximum: number; catch_up: boolean; company_contribution: { amount: number; type: 'fixed'; } | { amount: number; type: 'percent'; } | { tiers: { match: number; threshold: number; }[]; type: 'tiered'; }; employee_deduction: { amount: number; type: 'fixed'; } | { amount: number; type: 'percent'; }; hsa_contribution_limit?: 'individual' | 'family'; } | { code: number; message: string; name: string; finch_code?: string; }`\n - `code: number`\n - `individual_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const individualBenefit of client.hris.benefits.individuals.retrieveManyBenefits('benefit_id')) {\n console.log(individualBenefit);\n}\n```", + perLanguage: { + typescript: { + method: 'client.hris.benefits.individuals.retrieveManyBenefits', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const individualBenefit of client.hris.benefits.individuals.retrieveManyBenefits(\n 'benefit_id',\n)) {\n console.log(individualBenefit.individual_id);\n}", + }, + python: { + method: 'hris.benefits.individuals.retrieve_many_benefits', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.hris.benefits.individuals.retrieve_many_benefits(\n benefit_id="benefit_id",\n)\npage = page.items[0]\nprint(page.individual_id)', + }, + java: { + method: 'hris().benefits().individuals().retrieveManyBenefits', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisBenefitIndividualRetrieveManyBenefitsPage;\nimport com.tryfinch.api.models.HrisBenefitIndividualRetrieveManyBenefitsParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n HrisBenefitIndividualRetrieveManyBenefitsPage page = client.hris().benefits().individuals().retrieveManyBenefits("benefit_id");\n }\n}', + }, + kotlin: { + method: 'hris().benefits().individuals().retrieveManyBenefits', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisBenefitIndividualRetrieveManyBenefitsPage\nimport com.tryfinch.api.models.HrisBenefitIndividualRetrieveManyBenefitsParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val page: HrisBenefitIndividualRetrieveManyBenefitsPage = client.hris().benefits().individuals().retrieveManyBenefits("benefit_id")\n}', + }, + go: { + method: 'client.HRIS.Benefits.Individuals.GetManyBenefits', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Benefits.Individuals.GetManyBenefits(\n\t\tcontext.TODO(),\n\t\t"benefit_id",\n\t\tfinchgo.HRISBenefitIndividualGetManyBenefitsParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'hris.benefits.individuals.retrieve_many_benefits', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.benefits.individuals.retrieve_many_benefits("benefit_id")\n\nputs(page)', + }, + http: { + example: + 'curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID/individuals \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "enroll_many", - "endpoint": "/employer/benefits/{benefit_id}/individuals", - "httpMethod": "post", - "summary": "Enroll Individuals in Deductions", - "description": "Enroll an individual into a deduction or contribution. This is an overwrite operation. If the employee is already enrolled, the enrollment amounts will be adjusted. Making the same request multiple times will not create new enrollments, but will continue to set the state of the existing enrollment.", - "stainlessPath": "(resource) hris.benefits.individuals > (method) enroll_many", - "qualified": "client.hris.benefits.individuals.enrollMany", - "params": [ - "benefit_id: string;", - "entity_ids?: string[];", - "individuals?: { configuration?: { annual_contribution_limit?: 'individual' | 'family'; annual_maximum?: number; catch_up?: boolean; company_contribution?: { amount?: number; tiers?: { match: number; threshold: number; }[]; type?: 'fixed' | 'percent' | 'tiered'; }; effective_date?: string; employee_deduction?: { amount?: number; type?: 'fixed' | 'percent'; }; }; individual_id?: string; }[];" + name: 'enroll_many', + endpoint: '/employer/benefits/{benefit_id}/individuals', + httpMethod: 'post', + summary: 'Enroll Individuals in Deductions', + description: + 'Enroll an individual into a deduction or contribution. This is an overwrite operation. If the employee is already enrolled, the enrollment amounts will be adjusted. Making the same request multiple times will not create new enrollments, but will continue to set the state of the existing enrollment.', + stainlessPath: '(resource) hris.benefits.individuals > (method) enroll_many', + qualified: 'client.hris.benefits.individuals.enrollMany', + params: [ + 'benefit_id: string;', + 'entity_ids?: string[];', + "individuals?: { configuration?: { annual_contribution_limit?: 'individual' | 'family'; annual_maximum?: number; catch_up?: boolean; company_contribution?: { amount?: number; tiers?: { match: number; threshold: number; }[]; type?: 'fixed' | 'percent' | 'tiered'; }; effective_date?: string; employee_deduction?: { amount?: number; type?: 'fixed' | 'percent'; }; }; individual_id?: string; }[];", ], - "response": "{ job_id: string; }", - "markdown": "## enroll_many\n\n`client.hris.benefits.individuals.enrollMany(benefit_id: string, entity_ids?: string[], individuals?: { configuration?: { annual_contribution_limit?: 'individual' | 'family'; annual_maximum?: number; catch_up?: boolean; company_contribution?: object; effective_date?: string; employee_deduction?: object; }; individual_id?: string; }[]): { job_id: string; }`\n\n**post** `/employer/benefits/{benefit_id}/individuals`\n\nEnroll an individual into a deduction or contribution. This is an overwrite operation. If the employee is already enrolled, the enrollment amounts will be adjusted. Making the same request multiple times will not create new enrollments, but will continue to set the state of the existing enrollment.\n\n### Parameters\n\n- `benefit_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `individuals?: { configuration?: { annual_contribution_limit?: 'individual' | 'family'; annual_maximum?: number; catch_up?: boolean; company_contribution?: { amount?: number; tiers?: { match: number; threshold: number; }[]; type?: 'fixed' | 'percent' | 'tiered'; }; effective_date?: string; employee_deduction?: { amount?: number; type?: 'fixed' | 'percent'; }; }; individual_id?: string; }[]`\n Array of the individual_id to enroll and a configuration object.\n\n### Returns\n\n- `{ job_id: string; }`\n\n - `job_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst enrolledIndividualBenefitResponse = await client.hris.benefits.individuals.enrollMany('benefit_id');\n\nconsole.log(enrolledIndividualBenefitResponse);\n```", - "perLanguage": { - "typescript": { - "method": "client.hris.benefits.individuals.enrollMany", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst enrolledIndividualBenefitResponse = await client.hris.benefits.individuals.enrollMany(\n 'benefit_id',\n);\n\nconsole.log(enrolledIndividualBenefitResponse.job_id);" - }, - "python": { - "method": "hris.benefits.individuals.enroll_many", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nenrolled_individual_benefit_response = client.hris.benefits.individuals.enroll_many(\n benefit_id=\"benefit_id\",\n)\nprint(enrolled_individual_benefit_response.job_id)" - }, - "ruby": { - "method": "hris.benefits.individuals.enroll_many", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nenrolled_individual_benefit_response = finch.hris.benefits.individuals.enroll_many(\"benefit_id\")\n\nputs(enrolled_individual_benefit_response)" - }, - "http": { - "example": "curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID/individuals \\\n -X POST \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + response: '{ job_id: string; }', + markdown: + "## enroll_many\n\n`client.hris.benefits.individuals.enrollMany(benefit_id: string, entity_ids?: string[], individuals?: { configuration?: { annual_contribution_limit?: 'individual' | 'family'; annual_maximum?: number; catch_up?: boolean; company_contribution?: object; effective_date?: string; employee_deduction?: object; }; individual_id?: string; }[]): { job_id: string; }`\n\n**post** `/employer/benefits/{benefit_id}/individuals`\n\nEnroll an individual into a deduction or contribution. This is an overwrite operation. If the employee is already enrolled, the enrollment amounts will be adjusted. Making the same request multiple times will not create new enrollments, but will continue to set the state of the existing enrollment.\n\n### Parameters\n\n- `benefit_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `individuals?: { configuration?: { annual_contribution_limit?: 'individual' | 'family'; annual_maximum?: number; catch_up?: boolean; company_contribution?: { amount?: number; tiers?: { match: number; threshold: number; }[]; type?: 'fixed' | 'percent' | 'tiered'; }; effective_date?: string; employee_deduction?: { amount?: number; type?: 'fixed' | 'percent'; }; }; individual_id?: string; }[]`\n Array of the individual_id to enroll and a configuration object.\n\n### Returns\n\n- `{ job_id: string; }`\n\n - `job_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst enrolledIndividualBenefitResponse = await client.hris.benefits.individuals.enrollMany('benefit_id');\n\nconsole.log(enrolledIndividualBenefitResponse);\n```", + perLanguage: { + typescript: { + method: 'client.hris.benefits.individuals.enrollMany', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst enrolledIndividualBenefitResponse = await client.hris.benefits.individuals.enrollMany(\n 'benefit_id',\n);\n\nconsole.log(enrolledIndividualBenefitResponse.job_id);", + }, + python: { + method: 'hris.benefits.individuals.enroll_many', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nenrolled_individual_benefit_response = client.hris.benefits.individuals.enroll_many(\n benefit_id="benefit_id",\n)\nprint(enrolled_individual_benefit_response.job_id)', + }, + ruby: { + method: 'hris.benefits.individuals.enroll_many', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nenrolled_individual_benefit_response = finch.hris.benefits.individuals.enroll_many("benefit_id")\n\nputs(enrolled_individual_benefit_response)', + }, + http: { + example: + 'curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID/individuals \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "unenroll_many", - "endpoint": "/employer/benefits/{benefit_id}/individuals", - "httpMethod": "delete", - "summary": "Unenroll Individuals from Deductions", - "description": "Unenroll individuals from a deduction or contribution", - "stainlessPath": "(resource) hris.benefits.individuals > (method) unenroll_many", - "qualified": "client.hris.benefits.individuals.unenrollMany", - "params": [ - "benefit_id: string;", - "entity_ids?: string[];", - "individual_ids?: string[];" - ], - "response": "{ job_id: string; }", - "markdown": "## unenroll_many\n\n`client.hris.benefits.individuals.unenrollMany(benefit_id: string, entity_ids?: string[], individual_ids?: string[]): { job_id: string; }`\n\n**delete** `/employer/benefits/{benefit_id}/individuals`\n\nUnenroll individuals from a deduction or contribution\n\n### Parameters\n\n- `benefit_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `individual_ids?: string[]`\n Array of individual_ids to unenroll.\n\n### Returns\n\n- `{ job_id: string; }`\n\n - `job_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst unenrolledIndividualBenefitResponse = await client.hris.benefits.individuals.unenrollMany('benefit_id');\n\nconsole.log(unenrolledIndividualBenefitResponse);\n```", - "perLanguage": { - "typescript": { - "method": "client.hris.benefits.individuals.unenrollMany", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst unenrolledIndividualBenefitResponse = await client.hris.benefits.individuals.unenrollMany(\n 'benefit_id',\n);\n\nconsole.log(unenrolledIndividualBenefitResponse.job_id);" - }, - "python": { - "method": "hris.benefits.individuals.unenroll_many", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nunenrolled_individual_benefit_response = client.hris.benefits.individuals.unenroll_many(\n benefit_id=\"benefit_id\",\n)\nprint(unenrolled_individual_benefit_response.job_id)" - }, - "java": { - "method": "hris().benefits().individuals().unenrollMany", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisBenefitIndividualUnenrollManyParams;\nimport com.tryfinch.api.models.UnenrolledIndividualBenefitResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n UnenrolledIndividualBenefitResponse unenrolledIndividualBenefitResponse = client.hris().benefits().individuals().unenrollMany(\"benefit_id\");\n }\n}" - }, - "kotlin": { - "method": "hris().benefits().individuals().unenrollMany", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisBenefitIndividualUnenrollManyParams\nimport com.tryfinch.api.models.UnenrolledIndividualBenefitResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val unenrolledIndividualBenefitResponse: UnenrolledIndividualBenefitResponse = client.hris().benefits().individuals().unenrollMany(\"benefit_id\")\n}" - }, - "go": { - "method": "client.HRIS.Benefits.Individuals.UnenrollMany", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tunenrolledIndividualBenefitResponse, err := client.HRIS.Benefits.Individuals.UnenrollMany(\n\t\tcontext.TODO(),\n\t\t\"benefit_id\",\n\t\tfinchgo.HRISBenefitIndividualUnenrollManyParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", unenrolledIndividualBenefitResponse.JobID)\n}\n" - }, - "ruby": { - "method": "hris.benefits.individuals.unenroll_many", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nunenrolled_individual_benefit_response = finch.hris.benefits.individuals.unenroll_many(\"benefit_id\")\n\nputs(unenrolled_individual_benefit_response)" - }, - "http": { - "example": "curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID/individuals \\\n -X DELETE \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + name: 'unenroll_many', + endpoint: '/employer/benefits/{benefit_id}/individuals', + httpMethod: 'delete', + summary: 'Unenroll Individuals from Deductions', + description: 'Unenroll individuals from a deduction or contribution', + stainlessPath: '(resource) hris.benefits.individuals > (method) unenroll_many', + qualified: 'client.hris.benefits.individuals.unenrollMany', + params: ['benefit_id: string;', 'entity_ids?: string[];', 'individual_ids?: string[];'], + response: '{ job_id: string; }', + markdown: + "## unenroll_many\n\n`client.hris.benefits.individuals.unenrollMany(benefit_id: string, entity_ids?: string[], individual_ids?: string[]): { job_id: string; }`\n\n**delete** `/employer/benefits/{benefit_id}/individuals`\n\nUnenroll individuals from a deduction or contribution\n\n### Parameters\n\n- `benefit_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `individual_ids?: string[]`\n Array of individual_ids to unenroll.\n\n### Returns\n\n- `{ job_id: string; }`\n\n - `job_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst unenrolledIndividualBenefitResponse = await client.hris.benefits.individuals.unenrollMany('benefit_id');\n\nconsole.log(unenrolledIndividualBenefitResponse);\n```", + perLanguage: { + typescript: { + method: 'client.hris.benefits.individuals.unenrollMany', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst unenrolledIndividualBenefitResponse = await client.hris.benefits.individuals.unenrollMany(\n 'benefit_id',\n);\n\nconsole.log(unenrolledIndividualBenefitResponse.job_id);", + }, + python: { + method: 'hris.benefits.individuals.unenroll_many', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nunenrolled_individual_benefit_response = client.hris.benefits.individuals.unenroll_many(\n benefit_id="benefit_id",\n)\nprint(unenrolled_individual_benefit_response.job_id)', + }, + java: { + method: 'hris().benefits().individuals().unenrollMany', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisBenefitIndividualUnenrollManyParams;\nimport com.tryfinch.api.models.UnenrolledIndividualBenefitResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n UnenrolledIndividualBenefitResponse unenrolledIndividualBenefitResponse = client.hris().benefits().individuals().unenrollMany("benefit_id");\n }\n}', + }, + kotlin: { + method: 'hris().benefits().individuals().unenrollMany', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisBenefitIndividualUnenrollManyParams\nimport com.tryfinch.api.models.UnenrolledIndividualBenefitResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val unenrolledIndividualBenefitResponse: UnenrolledIndividualBenefitResponse = client.hris().benefits().individuals().unenrollMany("benefit_id")\n}', + }, + go: { + method: 'client.HRIS.Benefits.Individuals.UnenrollMany', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tunenrolledIndividualBenefitResponse, err := client.HRIS.Benefits.Individuals.UnenrollMany(\n\t\tcontext.TODO(),\n\t\t"benefit_id",\n\t\tfinchgo.HRISBenefitIndividualUnenrollManyParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", unenrolledIndividualBenefitResponse.JobID)\n}\n', + }, + ruby: { + method: 'hris.benefits.individuals.unenroll_many', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nunenrolled_individual_benefit_response = finch.hris.benefits.individuals.unenroll_many("benefit_id")\n\nputs(unenrolled_individual_benefit_response)', + }, + http: { + example: + 'curl https://api.tryfinch.com/employer/benefits/$BENEFIT_ID/individuals \\\n -X DELETE \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "list", - "endpoint": "/providers", - "httpMethod": "get", - "summary": "Providers", - "description": "Return details on all available payroll and HR systems.", - "stainlessPath": "(resource) providers > (method) list", - "qualified": "client.providers.list", - "response": "{ id: string; display_name: string; products: string[]; authentication_methods?: { type: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth' | 'api'; benefits_support?: object; supported_fields?: object; }[]; beta?: boolean; icon?: string; logo?: string; manual?: boolean; mfa_required?: boolean; primary_color?: string; }", - "markdown": "## list\n\n`client.providers.list(): { id: string; display_name: string; products: string[]; authentication_methods?: object[]; beta?: boolean; icon?: string; logo?: string; manual?: boolean; mfa_required?: boolean; primary_color?: string; }`\n\n**get** `/providers`\n\nReturn details on all available payroll and HR systems.\n\n### Returns\n\n- `{ id: string; display_name: string; products: string[]; authentication_methods?: { type: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth' | 'api'; benefits_support?: object; supported_fields?: object; }[]; beta?: boolean; icon?: string; logo?: string; manual?: boolean; mfa_required?: boolean; primary_color?: string; }`\n\n - `id: string`\n - `display_name: string`\n - `products: string[]`\n - `authentication_methods?: { type: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth' | 'api'; benefits_support?: object; supported_fields?: object; }[]`\n - `beta?: boolean`\n - `icon?: string`\n - `logo?: string`\n - `manual?: boolean`\n - `mfa_required?: boolean`\n - `primary_color?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const providerListResponse of client.providers.list()) {\n console.log(providerListResponse);\n}\n```", - "perLanguage": { - "typescript": { - "method": "client.providers.list", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const providerListResponse of client.providers.list()) {\n console.log(providerListResponse.id);\n}" - }, - "python": { - "method": "providers.list", - "example": "from finch import Finch\n\nclient = Finch()\npage = client.providers.list()\npage = page.items[0]\nprint(page.id)" - }, - "java": { - "method": "providers().list", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.ProviderListPage;\nimport com.tryfinch.api.models.ProviderListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.fromEnv();\n\n ProviderListPage page = client.providers().list();\n }\n}" - }, - "kotlin": { - "method": "providers().list", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.ProviderListPage\nimport com.tryfinch.api.models.ProviderListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.fromEnv()\n\n val page: ProviderListPage = client.providers().list()\n}" - }, - "go": { - "method": "client.Providers.List", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient()\n\tpage, err := client.Providers.List(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n" - }, - "ruby": { - "method": "providers.list", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new\n\npage = finch.providers.list\n\nputs(page)" - }, - "http": { - "example": "curl https://api.tryfinch.com/providers \\\n -H 'Finch-API-Version: 2020-09-17'" - } - } + name: 'list', + endpoint: '/providers', + httpMethod: 'get', + summary: 'Providers', + description: 'Return details on all available payroll and HR systems.', + stainlessPath: '(resource) providers > (method) list', + qualified: 'client.providers.list', + response: + "{ id: string; display_name: string; products: string[]; authentication_methods?: { type: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth' | 'api'; benefits_support?: object; supported_fields?: object; }[]; beta?: boolean; icon?: string; logo?: string; manual?: boolean; mfa_required?: boolean; primary_color?: string; }", + markdown: + "## list\n\n`client.providers.list(): { id: string; display_name: string; products: string[]; authentication_methods?: object[]; beta?: boolean; icon?: string; logo?: string; manual?: boolean; mfa_required?: boolean; primary_color?: string; }`\n\n**get** `/providers`\n\nReturn details on all available payroll and HR systems.\n\n### Returns\n\n- `{ id: string; display_name: string; products: string[]; authentication_methods?: { type: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth' | 'api'; benefits_support?: object; supported_fields?: object; }[]; beta?: boolean; icon?: string; logo?: string; manual?: boolean; mfa_required?: boolean; primary_color?: string; }`\n\n - `id: string`\n - `display_name: string`\n - `products: string[]`\n - `authentication_methods?: { type: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth' | 'api'; benefits_support?: object; supported_fields?: object; }[]`\n - `beta?: boolean`\n - `icon?: string`\n - `logo?: string`\n - `manual?: boolean`\n - `mfa_required?: boolean`\n - `primary_color?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const providerListResponse of client.providers.list()) {\n console.log(providerListResponse);\n}\n```", + perLanguage: { + typescript: { + method: 'client.providers.list', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const providerListResponse of client.providers.list()) {\n console.log(providerListResponse.id);\n}", + }, + python: { + method: 'providers.list', + example: + 'from finch import Finch\n\nclient = Finch()\npage = client.providers.list()\npage = page.items[0]\nprint(page.id)', + }, + java: { + method: 'providers().list', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.ProviderListPage;\nimport com.tryfinch.api.models.ProviderListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.fromEnv();\n\n ProviderListPage page = client.providers().list();\n }\n}', + }, + kotlin: { + method: 'providers().list', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.ProviderListPage\nimport com.tryfinch.api.models.ProviderListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.fromEnv()\n\n val page: ProviderListPage = client.providers().list()\n}', + }, + go: { + method: 'client.Providers.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient()\n\tpage, err := client.Providers.List(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'providers.list', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new\n\npage = finch.providers.list\n\nputs(page)', + }, + http: { + example: "curl https://api.tryfinch.com/providers \\\n -H 'Finch-API-Version: 2020-09-17'", + }, + }, }, { - "name": "introspect", - "endpoint": "/introspect", - "httpMethod": "get", - "summary": "Introspect", - "description": "Read account information associated with an `access_token`", - "stainlessPath": "(resource) account > (method) introspect", - "qualified": "client.account.introspect", - "response": "{ id: string; client_id: string; client_type: 'development' | 'production' | 'sandbox'; connection_id: string; connection_status: { status: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth'; last_successful_sync?: string | string; message?: string; }; connection_type: 'finch' | 'provider'; products: string[]; provider_id: string; account_id?: string; authentication_methods?: { type: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth'; connection_status?: { status: connection_status_type; last_successful_sync?: string | string; message?: string; }; products?: string[]; }[]; company_id?: string; customer_email?: string; customer_id?: string; customer_name?: string; entities?: { id: string; name: string; source_id: string; status: string; }[]; manual?: boolean; payroll_provider_id?: string; username?: string; }", - "markdown": "## introspect\n\n`client.account.introspect(): { id: string; client_id: string; client_type: 'development' | 'production' | 'sandbox'; connection_id: string; connection_status: object; connection_type: 'finch' | 'provider'; products: string[]; provider_id: string; account_id?: string; authentication_methods?: object[]; company_id?: string; customer_email?: string; customer_id?: string; customer_name?: string; entities?: object[]; manual?: boolean; payroll_provider_id?: string; username?: string; }`\n\n**get** `/introspect`\n\nRead account information associated with an `access_token`\n\n### Returns\n\n- `{ id: string; client_id: string; client_type: 'development' | 'production' | 'sandbox'; connection_id: string; connection_status: { status: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth'; last_successful_sync?: string | string; message?: string; }; connection_type: 'finch' | 'provider'; products: string[]; provider_id: string; account_id?: string; authentication_methods?: { type: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth'; connection_status?: { status: connection_status_type; last_successful_sync?: string | string; message?: string; }; products?: string[]; }[]; company_id?: string; customer_email?: string; customer_id?: string; customer_name?: string; entities?: { id: string; name: string; source_id: string; status: string; }[]; manual?: boolean; payroll_provider_id?: string; username?: string; }`\n\n - `id: string`\n - `client_id: string`\n - `client_type: 'development' | 'production' | 'sandbox'`\n - `connection_id: string`\n - `connection_status: { status: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth'; last_successful_sync?: string | string; message?: string; }`\n - `connection_type: 'finch' | 'provider'`\n - `products: string[]`\n - `provider_id: string`\n - `account_id?: string`\n - `authentication_methods?: { type: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth'; connection_status?: { status: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth'; last_successful_sync?: string | string; message?: string; }; products?: string[]; }[]`\n - `company_id?: string`\n - `customer_email?: string`\n - `customer_id?: string`\n - `customer_name?: string`\n - `entities?: { id: string; name: string; source_id: string; status: string; }[]`\n - `manual?: boolean`\n - `payroll_provider_id?: string`\n - `username?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst introspection = await client.account.introspect();\n\nconsole.log(introspection);\n```", - "perLanguage": { - "typescript": { - "method": "client.account.introspect", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst introspection = await client.account.introspect();\n\nconsole.log(introspection.id);" - }, - "python": { - "method": "account.introspect", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nintrospection = client.account.introspect()\nprint(introspection.id)" - }, - "java": { - "method": "account().introspect", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.AccountIntrospectParams;\nimport com.tryfinch.api.models.Introspection;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n Introspection introspection = client.account().introspect();\n }\n}" - }, - "kotlin": { - "method": "account().introspect", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AccountIntrospectParams\nimport com.tryfinch.api.models.Introspection\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val introspection: Introspection = client.account().introspect()\n}" - }, - "go": { - "method": "client.Account.Introspect", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tintrospection, err := client.Account.Introspect(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", introspection.ID)\n}\n" - }, - "ruby": { - "method": "account.introspect", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nintrospection = finch.account.introspect\n\nputs(introspection)" - }, - "http": { - "example": "curl https://api.tryfinch.com/introspect \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + name: 'introspect', + endpoint: '/introspect', + httpMethod: 'get', + summary: 'Introspect', + description: 'Read account information associated with an `access_token`', + stainlessPath: '(resource) account > (method) introspect', + qualified: 'client.account.introspect', + response: + "{ id: string; client_id: string; client_type: 'development' | 'production' | 'sandbox'; connection_id: string; connection_status: { status: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth'; last_successful_sync?: string | string; message?: string; }; connection_type: 'finch' | 'provider'; products: string[]; provider_id: string; account_id?: string; authentication_methods?: { type: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth'; connection_status?: { status: connection_status_type; last_successful_sync?: string | string; message?: string; }; products?: string[]; }[]; company_id?: string; customer_email?: string; customer_id?: string; customer_name?: string; entities?: { id: string; name: string; source_id: string; status: string; }[]; manual?: boolean; payroll_provider_id?: string; username?: string; }", + markdown: + "## introspect\n\n`client.account.introspect(): { id: string; client_id: string; client_type: 'development' | 'production' | 'sandbox'; connection_id: string; connection_status: object; connection_type: 'finch' | 'provider'; products: string[]; provider_id: string; account_id?: string; authentication_methods?: object[]; company_id?: string; customer_email?: string; customer_id?: string; customer_name?: string; entities?: object[]; manual?: boolean; payroll_provider_id?: string; username?: string; }`\n\n**get** `/introspect`\n\nRead account information associated with an `access_token`\n\n### Returns\n\n- `{ id: string; client_id: string; client_type: 'development' | 'production' | 'sandbox'; connection_id: string; connection_status: { status: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth'; last_successful_sync?: string | string; message?: string; }; connection_type: 'finch' | 'provider'; products: string[]; provider_id: string; account_id?: string; authentication_methods?: { type: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth'; connection_status?: { status: connection_status_type; last_successful_sync?: string | string; message?: string; }; products?: string[]; }[]; company_id?: string; customer_email?: string; customer_id?: string; customer_name?: string; entities?: { id: string; name: string; source_id: string; status: string; }[]; manual?: boolean; payroll_provider_id?: string; username?: string; }`\n\n - `id: string`\n - `client_id: string`\n - `client_type: 'development' | 'production' | 'sandbox'`\n - `connection_id: string`\n - `connection_status: { status: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth'; last_successful_sync?: string | string; message?: string; }`\n - `connection_type: 'finch' | 'provider'`\n - `products: string[]`\n - `provider_id: string`\n - `account_id?: string`\n - `authentication_methods?: { type: 'assisted' | 'credential' | 'api_token' | 'api_credential' | 'oauth'; connection_status?: { status: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth'; last_successful_sync?: string | string; message?: string; }; products?: string[]; }[]`\n - `company_id?: string`\n - `customer_email?: string`\n - `customer_id?: string`\n - `customer_name?: string`\n - `entities?: { id: string; name: string; source_id: string; status: string; }[]`\n - `manual?: boolean`\n - `payroll_provider_id?: string`\n - `username?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst introspection = await client.account.introspect();\n\nconsole.log(introspection);\n```", + perLanguage: { + typescript: { + method: 'client.account.introspect', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst introspection = await client.account.introspect();\n\nconsole.log(introspection.id);", + }, + python: { + method: 'account.introspect', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nintrospection = client.account.introspect()\nprint(introspection.id)', + }, + java: { + method: 'account().introspect', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.AccountIntrospectParams;\nimport com.tryfinch.api.models.Introspection;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n Introspection introspection = client.account().introspect();\n }\n}', + }, + kotlin: { + method: 'account().introspect', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AccountIntrospectParams\nimport com.tryfinch.api.models.Introspection\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val introspection: Introspection = client.account().introspect()\n}', + }, + go: { + method: 'client.Account.Introspect', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tintrospection, err := client.Account.Introspect(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", introspection.ID)\n}\n', + }, + ruby: { + method: 'account.introspect', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nintrospection = finch.account.introspect\n\nputs(introspection)', + }, + http: { + example: + 'curl https://api.tryfinch.com/introspect \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "disconnect", - "endpoint": "/disconnect", - "httpMethod": "post", - "summary": "Disconnect", - "description": "Disconnect one or more `access_token`s from your application.", - "stainlessPath": "(resource) account > (method) disconnect", - "qualified": "client.account.disconnect", - "response": "{ status: string; }", - "markdown": "## disconnect\n\n`client.account.disconnect(): { status: string; }`\n\n**post** `/disconnect`\n\nDisconnect one or more `access_token`s from your application.\n\n### Returns\n\n- `{ status: string; }`\n\n - `status: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst disconnectResponse = await client.account.disconnect();\n\nconsole.log(disconnectResponse);\n```", - "perLanguage": { - "typescript": { - "method": "client.account.disconnect", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst disconnectResponse = await client.account.disconnect();\n\nconsole.log(disconnectResponse.status);" - }, - "python": { - "method": "account.disconnect", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\ndisconnect_response = client.account.disconnect()\nprint(disconnect_response.status)" - }, - "java": { - "method": "account().disconnect", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.AccountDisconnectParams;\nimport com.tryfinch.api.models.DisconnectResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n DisconnectResponse disconnectResponse = client.account().disconnect();\n }\n}" - }, - "kotlin": { - "method": "account().disconnect", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AccountDisconnectParams\nimport com.tryfinch.api.models.DisconnectResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val disconnectResponse: DisconnectResponse = client.account().disconnect()\n}" - }, - "go": { - "method": "client.Account.Disconnect", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tdisconnectResponse, err := client.Account.Disconnect(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", disconnectResponse.Status)\n}\n" - }, - "ruby": { - "method": "account.disconnect", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\ndisconnect_response = finch.account.disconnect\n\nputs(disconnect_response)" - }, - "http": { - "example": "curl https://api.tryfinch.com/disconnect \\\n -X POST \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + name: 'disconnect', + endpoint: '/disconnect', + httpMethod: 'post', + summary: 'Disconnect', + description: 'Disconnect one or more `access_token`s from your application.', + stainlessPath: '(resource) account > (method) disconnect', + qualified: 'client.account.disconnect', + response: '{ status: string; }', + markdown: + "## disconnect\n\n`client.account.disconnect(): { status: string; }`\n\n**post** `/disconnect`\n\nDisconnect one or more `access_token`s from your application.\n\n### Returns\n\n- `{ status: string; }`\n\n - `status: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst disconnectResponse = await client.account.disconnect();\n\nconsole.log(disconnectResponse);\n```", + perLanguage: { + typescript: { + method: 'client.account.disconnect', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst disconnectResponse = await client.account.disconnect();\n\nconsole.log(disconnectResponse.status);", + }, + python: { + method: 'account.disconnect', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\ndisconnect_response = client.account.disconnect()\nprint(disconnect_response.status)', + }, + java: { + method: 'account().disconnect', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.AccountDisconnectParams;\nimport com.tryfinch.api.models.DisconnectResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n DisconnectResponse disconnectResponse = client.account().disconnect();\n }\n}', + }, + kotlin: { + method: 'account().disconnect', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AccountDisconnectParams\nimport com.tryfinch.api.models.DisconnectResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val disconnectResponse: DisconnectResponse = client.account().disconnect()\n}', + }, + go: { + method: 'client.Account.Disconnect', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tdisconnectResponse, err := client.Account.Disconnect(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", disconnectResponse.Status)\n}\n', + }, + ruby: { + method: 'account.disconnect', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\ndisconnect_response = finch.account.disconnect\n\nputs(disconnect_response)', + }, + http: { + example: + 'curl https://api.tryfinch.com/disconnect \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "forward", - "endpoint": "/forward", - "httpMethod": "post", - "summary": "Request Forwarding", - "description": "The Forward API allows you to make direct requests to an employment system. If Finch's unified API\ndoesn't have a data model that cleanly fits your needs, then Forward allows you to push or pull\ndata models directly against an integration's API.", - "stainlessPath": "(resource) request_forwarding > (method) forward", - "qualified": "client.requestForwarding.forward", - "params": [ - "method: string;", - "route: string;", - "data?: string;", - "params?: object;", - "request_headers?: object;" + name: 'forward', + endpoint: '/forward', + httpMethod: 'post', + summary: 'Request Forwarding', + description: + "The Forward API allows you to make direct requests to an employment system. If Finch's unified API\ndoesn't have a data model that cleanly fits your needs, then Forward allows you to push or pull\ndata models directly against an integration's API.", + stainlessPath: '(resource) request_forwarding > (method) forward', + qualified: 'client.requestForwarding.forward', + params: [ + 'method: string;', + 'route: string;', + 'data?: string;', + 'params?: object;', + 'request_headers?: object;', ], - "response": "{ request: { method: string; route: string; data?: string | object; headers?: object; params?: object; }; statusCode: number; data?: string; headers?: object; }", - "markdown": "## forward\n\n`client.requestForwarding.forward(method: string, route: string, data?: string, params?: object, request_headers?: object): { request: object; statusCode: number; data?: string; headers?: object; }`\n\n**post** `/forward`\n\nThe Forward API allows you to make direct requests to an employment system. If Finch's unified API\ndoesn't have a data model that cleanly fits your needs, then Forward allows you to push or pull\ndata models directly against an integration's API.\n\n### Parameters\n\n- `method: string`\n The HTTP method for the forwarded request. Valid values include: `GET` , `POST` , `PUT` , `DELETE` , and `PATCH`.\n\n- `route: string`\n The URL route path for the forwarded request. This value must begin with a forward-slash ( / ) and may only contain alphanumeric characters, hyphens, and underscores.\n\n- `data?: string`\n The body for the forwarded request. This value must be specified as either a string or a valid JSON object.\n\n- `params?: object`\n The query parameters for the forwarded request. This value must be specified as a valid JSON object rather than a query string.\n\n- `request_headers?: object`\n The HTTP headers to include on the forwarded request. This value must be specified as an object of key-value pairs. Example: `{\"Content-Type\": \"application/xml\", \"X-API-Version\": \"v1\" }`\n\n### Returns\n\n- `{ request: { method: string; route: string; data?: string | object; headers?: object; params?: object; }; statusCode: number; data?: string; headers?: object; }`\n\n - `request: { method: string; route: string; data?: string | object; headers?: object; params?: object; }`\n - `statusCode: number`\n - `data?: string`\n - `headers?: object`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst response = await client.requestForwarding.forward({ method: 'method', route: 'route' });\n\nconsole.log(response);\n```", - "perLanguage": { - "typescript": { - "method": "client.requestForwarding.forward", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.requestForwarding.forward({ method: 'method', route: 'route' });\n\nconsole.log(response.request);" - }, - "python": { - "method": "request_forwarding.forward", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nresponse = client.request_forwarding.forward(\n method=\"method\",\n route=\"route\",\n)\nprint(response.request)" - }, - "java": { - "method": "requestForwarding().forward", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.RequestForwardingForwardParams;\nimport com.tryfinch.api.models.RequestForwardingForwardResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n RequestForwardingForwardParams params = RequestForwardingForwardParams.builder()\n .method(\"method\")\n .route(\"route\")\n .build();\n RequestForwardingForwardResponse response = client.requestForwarding().forward(params);\n }\n}" - }, - "kotlin": { - "method": "requestForwarding().forward", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.RequestForwardingForwardParams\nimport com.tryfinch.api.models.RequestForwardingForwardResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val params: RequestForwardingForwardParams = RequestForwardingForwardParams.builder()\n .method(\"method\")\n .route(\"route\")\n .build()\n val response: RequestForwardingForwardResponse = client.requestForwarding().forward(params)\n}" - }, - "go": { - "method": "client.RequestForwarding.Forward", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tresponse, err := client.RequestForwarding.Forward(context.TODO(), finchgo.RequestForwardingForwardParams{\n\t\tMethod: finchgo.F(\"method\"),\n\t\tRoute: finchgo.F(\"route\"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.Request)\n}\n" - }, - "ruby": { - "method": "request_forwarding.forward", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nresponse = finch.request_forwarding.forward(method_: \"method\", route: \"route\")\n\nputs(response)" - }, - "http": { - "example": "curl https://api.tryfinch.com/forward \\\n -H 'Content-Type: application/json' \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{\n \"method\": \"method\",\n \"route\": \"route\"\n }'" - } - } + response: + '{ request: { method: string; route: string; data?: string | object; headers?: object; params?: object; }; statusCode: number; data?: string; headers?: object; }', + markdown: + "## forward\n\n`client.requestForwarding.forward(method: string, route: string, data?: string, params?: object, request_headers?: object): { request: object; statusCode: number; data?: string; headers?: object; }`\n\n**post** `/forward`\n\nThe Forward API allows you to make direct requests to an employment system. If Finch's unified API\ndoesn't have a data model that cleanly fits your needs, then Forward allows you to push or pull\ndata models directly against an integration's API.\n\n### Parameters\n\n- `method: string`\n The HTTP method for the forwarded request. Valid values include: `GET` , `POST` , `PUT` , `DELETE` , and `PATCH`.\n\n- `route: string`\n The URL route path for the forwarded request. This value must begin with a forward-slash ( / ) and may only contain alphanumeric characters, hyphens, and underscores.\n\n- `data?: string`\n The body for the forwarded request. This value must be specified as either a string or a valid JSON object.\n\n- `params?: object`\n The query parameters for the forwarded request. This value must be specified as a valid JSON object rather than a query string.\n\n- `request_headers?: object`\n The HTTP headers to include on the forwarded request. This value must be specified as an object of key-value pairs. Example: `{\"Content-Type\": \"application/xml\", \"X-API-Version\": \"v1\" }`\n\n### Returns\n\n- `{ request: { method: string; route: string; data?: string | object; headers?: object; params?: object; }; statusCode: number; data?: string; headers?: object; }`\n\n - `request: { method: string; route: string; data?: string | object; headers?: object; params?: object; }`\n - `statusCode: number`\n - `data?: string`\n - `headers?: object`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst response = await client.requestForwarding.forward({ method: 'method', route: 'route' });\n\nconsole.log(response);\n```", + perLanguage: { + typescript: { + method: 'client.requestForwarding.forward', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst response = await client.requestForwarding.forward({ method: 'method', route: 'route' });\n\nconsole.log(response.request);", + }, + python: { + method: 'request_forwarding.forward', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nresponse = client.request_forwarding.forward(\n method="method",\n route="route",\n)\nprint(response.request)', + }, + java: { + method: 'requestForwarding().forward', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.RequestForwardingForwardParams;\nimport com.tryfinch.api.models.RequestForwardingForwardResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n RequestForwardingForwardParams params = RequestForwardingForwardParams.builder()\n .method("method")\n .route("route")\n .build();\n RequestForwardingForwardResponse response = client.requestForwarding().forward(params);\n }\n}', + }, + kotlin: { + method: 'requestForwarding().forward', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.RequestForwardingForwardParams\nimport com.tryfinch.api.models.RequestForwardingForwardResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val params: RequestForwardingForwardParams = RequestForwardingForwardParams.builder()\n .method("method")\n .route("route")\n .build()\n val response: RequestForwardingForwardResponse = client.requestForwarding().forward(params)\n}', + }, + go: { + method: 'client.RequestForwarding.Forward', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tresponse, err := client.RequestForwarding.Forward(context.TODO(), finchgo.RequestForwardingForwardParams{\n\t\tMethod: finchgo.F("method"),\n\t\tRoute: finchgo.F("route"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response.Request)\n}\n', + }, + ruby: { + method: 'request_forwarding.forward', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nresponse = finch.request_forwarding.forward(method_: "method", route: "route")\n\nputs(response)', + }, + http: { + example: + 'curl https://api.tryfinch.com/forward \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "method": "method",\n "route": "route"\n }\'', + }, + }, }, { - "name": "list", - "endpoint": "/jobs/automated", - "httpMethod": "get", - "summary": "List All Automated Jobs", - "description": "Get all automated jobs. Automated jobs are completed by a machine. By default, jobs are sorted in descending order by submission time. For scheduled jobs such as data syncs, only the next scheduled job is shown.", - "stainlessPath": "(resource) jobs.automated > (method) list", - "qualified": "client.jobs.automated.list", - "params": [ - "limit?: number;", - "offset?: number;" - ], - "response": "{ data: { completed_at: string; created_at: string; job_id: string; job_url: string; params: object; scheduled_at: string; started_at: string; status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'; type: 'data_sync_all' | 'w4_form_employee_sync'; }[]; meta: { quotas?: { data_sync_all?: object; }; }; }", - "markdown": "## list\n\n`client.jobs.automated.list(limit?: number, offset?: number): { data: automated_async_job[]; meta: object; }`\n\n**get** `/jobs/automated`\n\nGet all automated jobs. Automated jobs are completed by a machine. By default, jobs are sorted in descending order by submission time. For scheduled jobs such as data syncs, only the next scheduled job is shown.\n\n### Parameters\n\n- `limit?: number`\n Number of items to return\n\n- `offset?: number`\n Index to start from (defaults to 0)\n\n### Returns\n\n- `{ data: { completed_at: string; created_at: string; job_id: string; job_url: string; params: object; scheduled_at: string; started_at: string; status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'; type: 'data_sync_all' | 'w4_form_employee_sync'; }[]; meta: { quotas?: { data_sync_all?: object; }; }; }`\n\n - `data: { completed_at: string; created_at: string; job_id: string; job_url: string; params: { individual_id?: string; }; scheduled_at: string; started_at: string; status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'; type: 'data_sync_all' | 'w4_form_employee_sync'; }[]`\n - `meta: { quotas?: { data_sync_all?: { allowed_refreshes?: number; remaining_refreshes?: number; }; }; }`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst automateds = await client.jobs.automated.list();\n\nconsole.log(automateds);\n```", - "perLanguage": { - "typescript": { - "method": "client.jobs.automated.list", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst automateds = await client.jobs.automated.list();\n\nconsole.log(automateds.data);" - }, - "python": { - "method": "jobs.automated.list", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nautomateds = client.jobs.automated.list()\nprint(automateds.data)" - }, - "java": { - "method": "jobs().automated().list", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.AutomatedListResponse;\nimport com.tryfinch.api.models.JobAutomatedListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n AutomatedListResponse automateds = client.jobs().automated().list();\n }\n}" - }, - "kotlin": { - "method": "jobs().automated().list", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AutomatedListResponse\nimport com.tryfinch.api.models.JobAutomatedListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val automateds: AutomatedListResponse = client.jobs().automated().list()\n}" - }, - "go": { - "method": "client.Jobs.Automated.List", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tautomateds, err := client.Jobs.Automated.List(context.TODO(), finchgo.JobAutomatedListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", automateds.Data)\n}\n" - }, - "ruby": { - "method": "jobs.automated.list", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nautomateds = finch.jobs.automated.list\n\nputs(automateds)" - }, - "http": { - "example": "curl https://api.tryfinch.com/jobs/automated \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + name: 'list', + endpoint: '/jobs/automated', + httpMethod: 'get', + summary: 'List All Automated Jobs', + description: + 'Get all automated jobs. Automated jobs are completed by a machine. By default, jobs are sorted in descending order by submission time. For scheduled jobs such as data syncs, only the next scheduled job is shown.', + stainlessPath: '(resource) jobs.automated > (method) list', + qualified: 'client.jobs.automated.list', + params: ['limit?: number;', 'offset?: number;'], + response: + "{ data: { completed_at: string; created_at: string; job_id: string; job_url: string; params: object; scheduled_at: string; started_at: string; status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'; type: 'data_sync_all' | 'w4_form_employee_sync'; }[]; meta: { quotas?: { data_sync_all?: object; }; }; }", + markdown: + "## list\n\n`client.jobs.automated.list(limit?: number, offset?: number): { data: automated_async_job[]; meta: object; }`\n\n**get** `/jobs/automated`\n\nGet all automated jobs. Automated jobs are completed by a machine. By default, jobs are sorted in descending order by submission time. For scheduled jobs such as data syncs, only the next scheduled job is shown.\n\n### Parameters\n\n- `limit?: number`\n Number of items to return\n\n- `offset?: number`\n Index to start from (defaults to 0)\n\n### Returns\n\n- `{ data: { completed_at: string; created_at: string; job_id: string; job_url: string; params: object; scheduled_at: string; started_at: string; status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'; type: 'data_sync_all' | 'w4_form_employee_sync'; }[]; meta: { quotas?: { data_sync_all?: object; }; }; }`\n\n - `data: { completed_at: string; created_at: string; job_id: string; job_url: string; params: { individual_id?: string; }; scheduled_at: string; started_at: string; status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'; type: 'data_sync_all' | 'w4_form_employee_sync'; }[]`\n - `meta: { quotas?: { data_sync_all?: { allowed_refreshes?: number; remaining_refreshes?: number; }; }; }`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst automateds = await client.jobs.automated.list();\n\nconsole.log(automateds);\n```", + perLanguage: { + typescript: { + method: 'client.jobs.automated.list', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst automateds = await client.jobs.automated.list();\n\nconsole.log(automateds.data);", + }, + python: { + method: 'jobs.automated.list', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nautomateds = client.jobs.automated.list()\nprint(automateds.data)', + }, + java: { + method: 'jobs().automated().list', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.AutomatedListResponse;\nimport com.tryfinch.api.models.JobAutomatedListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AutomatedListResponse automateds = client.jobs().automated().list();\n }\n}', + }, + kotlin: { + method: 'jobs().automated().list', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AutomatedListResponse\nimport com.tryfinch.api.models.JobAutomatedListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val automateds: AutomatedListResponse = client.jobs().automated().list()\n}', + }, + go: { + method: 'client.Jobs.Automated.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tautomateds, err := client.Jobs.Automated.List(context.TODO(), finchgo.JobAutomatedListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", automateds.Data)\n}\n', + }, + ruby: { + method: 'jobs.automated.list', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nautomateds = finch.jobs.automated.list\n\nputs(automateds)', + }, + http: { + example: + 'curl https://api.tryfinch.com/jobs/automated \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "create", - "endpoint": "/jobs/automated", - "httpMethod": "post", - "summary": "Enqueue a New Automated Job", - "description": "Enqueue an automated job.\n\n`data_sync_all`: Enqueue a job to re-sync all data for a connection. `data_sync_all` has a concurrency limit of 1 job at a time per connection. This means that if this endpoint is called while a job is already in progress for this connection, Finch will return the `job_id` of the job that is currently in progress. Finch allows a fixed window rate limit of 1 forced refresh per hour per connection.\n\n`w4_form_employee_sync`: Enqueues a job for sync W-4 data for a particular individual, identified by `individual_id`. This feature is currently in beta.\n\nThis endpoint is available for *Scale* tier customers as an add-on. To request access to this endpoint, please contact your Finch account manager.", - "stainlessPath": "(resource) jobs.automated > (method) create", - "qualified": "client.jobs.automated.create", - "params": [ - "{ type: 'data_sync_all'; } | { params: { individual_id: string; }; type: 'w4_form_employee_sync'; };" + name: 'create', + endpoint: '/jobs/automated', + httpMethod: 'post', + summary: 'Enqueue a New Automated Job', + description: + 'Enqueue an automated job.\n\n`data_sync_all`: Enqueue a job to re-sync all data for a connection. `data_sync_all` has a concurrency limit of 1 job at a time per connection. This means that if this endpoint is called while a job is already in progress for this connection, Finch will return the `job_id` of the job that is currently in progress. Finch allows a fixed window rate limit of 1 forced refresh per hour per connection.\n\n`w4_form_employee_sync`: Enqueues a job for sync W-4 data for a particular individual, identified by `individual_id`. This feature is currently in beta.\n\nThis endpoint is available for *Scale* tier customers as an add-on. To request access to this endpoint, please contact your Finch account manager.', + stainlessPath: '(resource) jobs.automated > (method) create', + qualified: 'client.jobs.automated.create', + params: [ + "{ type: 'data_sync_all'; } | { params: { individual_id: string; }; type: 'w4_form_employee_sync'; };", ], - "response": "{ allowed_refreshes: number; remaining_refreshes: number; job_id?: string; job_url?: string; retry_at?: string; }", - "perLanguage": { - "typescript": { - "method": "client.jobs.automated.create", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst automated = await client.jobs.automated.create({ type: 'data_sync_all' });\n\nconsole.log(automated.job_id);" - }, - "python": { - "method": "jobs.automated.create", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nautomated = client.jobs.automated.create(\n type=\"data_sync_all\",\n)\nprint(automated.job_id)" - }, - "java": { - "method": "jobs().automated().create", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.core.JsonValue;\nimport com.tryfinch.api.models.AutomatedCreateResponse;\nimport com.tryfinch.api.models.JobAutomatedCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n JobAutomatedCreateParams.Body params = JobAutomatedCreateParams.Body.ofDataSyncAll();\n AutomatedCreateResponse automated = client.jobs().automated().create(params);\n }\n}" - }, - "kotlin": { - "method": "jobs().automated().create", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.core.JsonValue\nimport com.tryfinch.api.models.AutomatedCreateResponse\nimport com.tryfinch.api.models.JobAutomatedCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val params: JobAutomatedCreateParams.Body = JobAutomatedCreateParams.Body.ofDataSyncAll()\n val automated: AutomatedCreateResponse = client.jobs().automated().create(params)\n}" - }, - "go": { - "method": "client.Jobs.Automated.New", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tautomated, err := client.Jobs.Automated.New(context.TODO(), finchgo.JobAutomatedNewParamsDataSyncAll{\n\t\tType: finchgo.F(finchgo.JobAutomatedNewParamsDataSyncAllTypeDataSyncAll),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", automated.JobID)\n}\n" - }, - "ruby": { - "method": "jobs.automated.create", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nautomated = finch.jobs.automated.create(body: {type: :data_sync_all})\n\nputs(automated)" - }, - "http": { - "example": "curl https://api.tryfinch.com/jobs/automated \\\n -H 'Content-Type: application/json' \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{\n \"type\": \"data_sync_all\"\n }'" - } - } + response: + '{ allowed_refreshes: number; remaining_refreshes: number; job_id?: string; job_url?: string; retry_at?: string; }', + perLanguage: { + typescript: { + method: 'client.jobs.automated.create', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst automated = await client.jobs.automated.create({ type: 'data_sync_all' });\n\nconsole.log(automated.job_id);", + }, + python: { + method: 'jobs.automated.create', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nautomated = client.jobs.automated.create(\n type="data_sync_all",\n)\nprint(automated.job_id)', + }, + java: { + method: 'jobs().automated().create', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.core.JsonValue;\nimport com.tryfinch.api.models.AutomatedCreateResponse;\nimport com.tryfinch.api.models.JobAutomatedCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n JobAutomatedCreateParams.Body params = JobAutomatedCreateParams.Body.ofDataSyncAll();\n AutomatedCreateResponse automated = client.jobs().automated().create(params);\n }\n}', + }, + kotlin: { + method: 'jobs().automated().create', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.core.JsonValue\nimport com.tryfinch.api.models.AutomatedCreateResponse\nimport com.tryfinch.api.models.JobAutomatedCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val params: JobAutomatedCreateParams.Body = JobAutomatedCreateParams.Body.ofDataSyncAll()\n val automated: AutomatedCreateResponse = client.jobs().automated().create(params)\n}', + }, + go: { + method: 'client.Jobs.Automated.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tautomated, err := client.Jobs.Automated.New(context.TODO(), finchgo.JobAutomatedNewParamsDataSyncAll{\n\t\tType: finchgo.F(finchgo.JobAutomatedNewParamsDataSyncAllTypeDataSyncAll),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", automated.JobID)\n}\n', + }, + ruby: { + method: 'jobs.automated.create', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nautomated = finch.jobs.automated.create(body: {type: :data_sync_all})\n\nputs(automated)', + }, + http: { + example: + 'curl https://api.tryfinch.com/jobs/automated \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "type": "data_sync_all"\n }\'', + }, + }, }, { - "name": "retrieve", - "endpoint": "/jobs/automated/{job_id}", - "httpMethod": "get", - "summary": "Retrieve an Automated Job", - "description": "Get an automated job by `job_id`.", - "stainlessPath": "(resource) jobs.automated > (method) retrieve", - "qualified": "client.jobs.automated.retrieve", - "params": [ - "job_id: string;" - ], - "response": "{ completed_at: string; created_at: string; job_id: string; job_url: string; params: { individual_id?: string; }; scheduled_at: string; started_at: string; status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'; type: 'data_sync_all' | 'w4_form_employee_sync'; }", - "markdown": "## retrieve\n\n`client.jobs.automated.retrieve(job_id: string): { completed_at: string; created_at: string; job_id: string; job_url: string; params: object; scheduled_at: string; started_at: string; status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'; type: 'data_sync_all' | 'w4_form_employee_sync'; }`\n\n**get** `/jobs/automated/{job_id}`\n\nGet an automated job by `job_id`.\n\n### Parameters\n\n- `job_id: string`\n\n### Returns\n\n- `{ completed_at: string; created_at: string; job_id: string; job_url: string; params: { individual_id?: string; }; scheduled_at: string; started_at: string; status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'; type: 'data_sync_all' | 'w4_form_employee_sync'; }`\n\n - `completed_at: string`\n - `created_at: string`\n - `job_id: string`\n - `job_url: string`\n - `params: { individual_id?: string; }`\n - `scheduled_at: string`\n - `started_at: string`\n - `status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'`\n - `type: 'data_sync_all' | 'w4_form_employee_sync'`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst automatedAsyncJob = await client.jobs.automated.retrieve('job_id');\n\nconsole.log(automatedAsyncJob);\n```", - "perLanguage": { - "typescript": { - "method": "client.jobs.automated.retrieve", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst automatedAsyncJob = await client.jobs.automated.retrieve('job_id');\n\nconsole.log(automatedAsyncJob.job_id);" - }, - "python": { - "method": "jobs.automated.retrieve", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nautomated_async_job = client.jobs.automated.retrieve(\n \"job_id\",\n)\nprint(automated_async_job.job_id)" - }, - "java": { - "method": "jobs().automated().retrieve", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.AutomatedAsyncJob;\nimport com.tryfinch.api.models.JobAutomatedRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n AutomatedAsyncJob automatedAsyncJob = client.jobs().automated().retrieve(\"job_id\");\n }\n}" - }, - "kotlin": { - "method": "jobs().automated().retrieve", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AutomatedAsyncJob\nimport com.tryfinch.api.models.JobAutomatedRetrieveParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val automatedAsyncJob: AutomatedAsyncJob = client.jobs().automated().retrieve(\"job_id\")\n}" - }, - "go": { - "method": "client.Jobs.Automated.Get", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tautomatedAsyncJob, err := client.Jobs.Automated.Get(context.TODO(), \"job_id\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", automatedAsyncJob.JobID)\n}\n" - }, - "ruby": { - "method": "jobs.automated.retrieve", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nautomated_async_job = finch.jobs.automated.retrieve(\"job_id\")\n\nputs(automated_async_job)" - }, - "http": { - "example": "curl https://api.tryfinch.com/jobs/automated/$JOB_ID \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + name: 'retrieve', + endpoint: '/jobs/automated/{job_id}', + httpMethod: 'get', + summary: 'Retrieve an Automated Job', + description: 'Get an automated job by `job_id`.', + stainlessPath: '(resource) jobs.automated > (method) retrieve', + qualified: 'client.jobs.automated.retrieve', + params: ['job_id: string;'], + response: + "{ completed_at: string; created_at: string; job_id: string; job_url: string; params: { individual_id?: string; }; scheduled_at: string; started_at: string; status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'; type: 'data_sync_all' | 'w4_form_employee_sync'; }", + markdown: + "## retrieve\n\n`client.jobs.automated.retrieve(job_id: string): { completed_at: string; created_at: string; job_id: string; job_url: string; params: object; scheduled_at: string; started_at: string; status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'; type: 'data_sync_all' | 'w4_form_employee_sync'; }`\n\n**get** `/jobs/automated/{job_id}`\n\nGet an automated job by `job_id`.\n\n### Parameters\n\n- `job_id: string`\n\n### Returns\n\n- `{ completed_at: string; created_at: string; job_id: string; job_url: string; params: { individual_id?: string; }; scheduled_at: string; started_at: string; status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'; type: 'data_sync_all' | 'w4_form_employee_sync'; }`\n\n - `completed_at: string`\n - `created_at: string`\n - `job_id: string`\n - `job_url: string`\n - `params: { individual_id?: string; }`\n - `scheduled_at: string`\n - `started_at: string`\n - `status: 'pending' | 'in_progress' | 'complete' | 'error' | 'reauth_error' | 'permissions_error'`\n - `type: 'data_sync_all' | 'w4_form_employee_sync'`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst automatedAsyncJob = await client.jobs.automated.retrieve('job_id');\n\nconsole.log(automatedAsyncJob);\n```", + perLanguage: { + typescript: { + method: 'client.jobs.automated.retrieve', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst automatedAsyncJob = await client.jobs.automated.retrieve('job_id');\n\nconsole.log(automatedAsyncJob.job_id);", + }, + python: { + method: 'jobs.automated.retrieve', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nautomated_async_job = client.jobs.automated.retrieve(\n "job_id",\n)\nprint(automated_async_job.job_id)', + }, + java: { + method: 'jobs().automated().retrieve', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.AutomatedAsyncJob;\nimport com.tryfinch.api.models.JobAutomatedRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AutomatedAsyncJob automatedAsyncJob = client.jobs().automated().retrieve("job_id");\n }\n}', + }, + kotlin: { + method: 'jobs().automated().retrieve', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AutomatedAsyncJob\nimport com.tryfinch.api.models.JobAutomatedRetrieveParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val automatedAsyncJob: AutomatedAsyncJob = client.jobs().automated().retrieve("job_id")\n}', + }, + go: { + method: 'client.Jobs.Automated.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tautomatedAsyncJob, err := client.Jobs.Automated.Get(context.TODO(), "job_id")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", automatedAsyncJob.JobID)\n}\n', + }, + ruby: { + method: 'jobs.automated.retrieve', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nautomated_async_job = finch.jobs.automated.retrieve("job_id")\n\nputs(automated_async_job)', + }, + http: { + example: + 'curl https://api.tryfinch.com/jobs/automated/$JOB_ID \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "retrieve", - "endpoint": "/jobs/manual/{job_id}", - "httpMethod": "get", - "summary": "Retrieve a Manual Job", - "description": "Check the status and outcome of a job by `job_id`. This includes all deductions jobs including those for both automated and assisted integrations.", - "stainlessPath": "(resource) jobs.manual > (method) retrieve", - "qualified": "client.jobs.manual.retrieve", - "params": [ - "job_id: string;" - ], - "response": "{ body: object[]; job_id: string; status: 'pending' | 'in_progress' | 'error' | 'complete'; }", - "markdown": "## retrieve\n\n`client.jobs.manual.retrieve(job_id: string): { body: object[]; job_id: string; status: 'pending' | 'in_progress' | 'error' | 'complete'; }`\n\n**get** `/jobs/manual/{job_id}`\n\nCheck the status and outcome of a job by `job_id`. This includes all deductions jobs including those for both automated and assisted integrations.\n\n### Parameters\n\n- `job_id: string`\n\n### Returns\n\n- `{ body: object[]; job_id: string; status: 'pending' | 'in_progress' | 'error' | 'complete'; }`\n\n - `body: object[]`\n - `job_id: string`\n - `status: 'pending' | 'in_progress' | 'error' | 'complete'`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst manualAsyncJob = await client.jobs.manual.retrieve('job_id');\n\nconsole.log(manualAsyncJob);\n```", - "perLanguage": { - "typescript": { - "method": "client.jobs.manual.retrieve", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst manualAsyncJob = await client.jobs.manual.retrieve('job_id');\n\nconsole.log(manualAsyncJob.job_id);" - }, - "python": { - "method": "jobs.manual.retrieve", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nmanual_async_job = client.jobs.manual.retrieve(\n \"job_id\",\n)\nprint(manual_async_job.job_id)" - }, - "java": { - "method": "jobs().manual().retrieve", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.JobManualRetrieveParams;\nimport com.tryfinch.api.models.ManualAsyncJob;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n ManualAsyncJob manualAsyncJob = client.jobs().manual().retrieve(\"job_id\");\n }\n}" - }, - "kotlin": { - "method": "jobs().manual().retrieve", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.JobManualRetrieveParams\nimport com.tryfinch.api.models.ManualAsyncJob\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val manualAsyncJob: ManualAsyncJob = client.jobs().manual().retrieve(\"job_id\")\n}" - }, - "go": { - "method": "client.Jobs.Manual.Get", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tmanualAsyncJob, err := client.Jobs.Manual.Get(context.TODO(), \"job_id\")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", manualAsyncJob.JobID)\n}\n" - }, - "ruby": { - "method": "jobs.manual.retrieve", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nmanual_async_job = finch.jobs.manual.retrieve(\"job_id\")\n\nputs(manual_async_job)" - }, - "http": { - "example": "curl https://api.tryfinch.com/jobs/manual/$JOB_ID \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + name: 'retrieve', + endpoint: '/jobs/manual/{job_id}', + httpMethod: 'get', + summary: 'Retrieve a Manual Job', + description: + 'Check the status and outcome of a job by `job_id`. This includes all deductions jobs including those for both automated and assisted integrations.', + stainlessPath: '(resource) jobs.manual > (method) retrieve', + qualified: 'client.jobs.manual.retrieve', + params: ['job_id: string;'], + response: "{ body: object[]; job_id: string; status: 'pending' | 'in_progress' | 'error' | 'complete'; }", + markdown: + "## retrieve\n\n`client.jobs.manual.retrieve(job_id: string): { body: object[]; job_id: string; status: 'pending' | 'in_progress' | 'error' | 'complete'; }`\n\n**get** `/jobs/manual/{job_id}`\n\nCheck the status and outcome of a job by `job_id`. This includes all deductions jobs including those for both automated and assisted integrations.\n\n### Parameters\n\n- `job_id: string`\n\n### Returns\n\n- `{ body: object[]; job_id: string; status: 'pending' | 'in_progress' | 'error' | 'complete'; }`\n\n - `body: object[]`\n - `job_id: string`\n - `status: 'pending' | 'in_progress' | 'error' | 'complete'`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst manualAsyncJob = await client.jobs.manual.retrieve('job_id');\n\nconsole.log(manualAsyncJob);\n```", + perLanguage: { + typescript: { + method: 'client.jobs.manual.retrieve', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst manualAsyncJob = await client.jobs.manual.retrieve('job_id');\n\nconsole.log(manualAsyncJob.job_id);", + }, + python: { + method: 'jobs.manual.retrieve', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nmanual_async_job = client.jobs.manual.retrieve(\n "job_id",\n)\nprint(manual_async_job.job_id)', + }, + java: { + method: 'jobs().manual().retrieve', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.JobManualRetrieveParams;\nimport com.tryfinch.api.models.ManualAsyncJob;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n ManualAsyncJob manualAsyncJob = client.jobs().manual().retrieve("job_id");\n }\n}', + }, + kotlin: { + method: 'jobs().manual().retrieve', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.JobManualRetrieveParams\nimport com.tryfinch.api.models.ManualAsyncJob\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val manualAsyncJob: ManualAsyncJob = client.jobs().manual().retrieve("job_id")\n}', + }, + go: { + method: 'client.Jobs.Manual.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tmanualAsyncJob, err := client.Jobs.Manual.Get(context.TODO(), "job_id")\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", manualAsyncJob.JobID)\n}\n', + }, + ruby: { + method: 'jobs.manual.retrieve', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nmanual_async_job = finch.jobs.manual.retrieve("job_id")\n\nputs(manual_async_job)', + }, + http: { + example: + 'curl https://api.tryfinch.com/jobs/manual/$JOB_ID \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "create", - "endpoint": "/sandbox/connections", - "httpMethod": "post", - "summary": "Create a new Sandbox Connection", - "description": "Create a new connection (new company/provider pair) with a new account", - "stainlessPath": "(resource) sandbox.connections > (method) create", - "qualified": "client.sandbox.connections.create", - "params": [ - "provider_id: string;", + name: 'create', + endpoint: '/sandbox/connections', + httpMethod: 'post', + summary: 'Create a new Sandbox Connection', + description: 'Create a new connection (new company/provider pair) with a new account', + stainlessPath: '(resource) sandbox.connections > (method) create', + qualified: 'client.sandbox.connections.create', + params: [ + 'provider_id: string;', "authentication_type?: 'credential' | 'api_token' | 'oauth' | 'assisted';", - "employee_size?: number;", - "products?: string[];" + 'employee_size?: number;', + 'products?: string[];', ], - "response": "{ access_token: string; account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; token_type?: string; }", - "markdown": "## create\n\n`client.sandbox.connections.create(provider_id: string, authentication_type?: 'credential' | 'api_token' | 'oauth' | 'assisted', employee_size?: number, products?: string[]): { access_token: string; account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; token_type?: string; }`\n\n**post** `/sandbox/connections`\n\nCreate a new connection (new company/provider pair) with a new account\n\n### Parameters\n\n- `provider_id: string`\n The provider associated with the connection\n\n- `authentication_type?: 'credential' | 'api_token' | 'oauth' | 'assisted'`\n\n- `employee_size?: number`\n Optional: the size of the employer to be created with this connection. Defaults to 20. Note that if this is higher than 100, historical payroll data will not be generated, and instead only one pay period will be created.\n\n- `products?: string[]`\n\n### Returns\n\n- `{ access_token: string; account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; token_type?: string; }`\n\n - `access_token: string`\n - `account_id: string`\n - `authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'`\n - `company_id: string`\n - `connection_id: string`\n - `entity_id: string`\n - `products: string[]`\n - `provider_id: string`\n - `token_type?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst connection = await client.sandbox.connections.create({ provider_id: 'provider_id' });\n\nconsole.log(connection);\n```", - "perLanguage": { - "typescript": { - "method": "client.sandbox.connections.create", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n clientID: process.env['FINCH_CLIENT_ID'], // This is the default and can be omitted\n clientSecret: process.env['FINCH_CLIENT_SECRET'], // This is the default and can be omitted\n});\n\nconst connection = await client.sandbox.connections.create({ provider_id: 'provider_id' });\n\nconsole.log(connection.account_id);" - }, - "python": { - "method": "sandbox.connections.create", - "example": "import os\nfrom finch import Finch\n\nclient = Finch(\n client_id=os.environ.get(\"FINCH_CLIENT_ID\"), # This is the default and can be omitted\n client_secret=os.environ.get(\"FINCH_CLIENT_SECRET\"), # This is the default and can be omitted\n)\nconnection = client.sandbox.connections.create(\n provider_id=\"provider_id\",\n)\nprint(connection.account_id)" - }, - "java": { - "method": "sandbox().connections().create", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.ConnectionCreateResponse;\nimport com.tryfinch.api.models.SandboxConnectionCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.fromEnv();\n\n SandboxConnectionCreateParams params = SandboxConnectionCreateParams.builder()\n .providerId(\"provider_id\")\n .build();\n ConnectionCreateResponse connection = client.sandbox().connections().create(params);\n }\n}" - }, - "kotlin": { - "method": "sandbox().connections().create", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.ConnectionCreateResponse\nimport com.tryfinch.api.models.SandboxConnectionCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.fromEnv()\n\n val params: SandboxConnectionCreateParams = SandboxConnectionCreateParams.builder()\n .providerId(\"provider_id\")\n .build()\n val connection: ConnectionCreateResponse = client.sandbox().connections().create(params)\n}" - }, - "go": { - "method": "client.Sandbox.Connections.New", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithClientID(\"4ab15e51-11ad-49f4-acae-f343b7794375\"),\n\t\toption.WithClientSecret(\"My Client Secret\"),\n\t)\n\tconnection, err := client.Sandbox.Connections.New(context.TODO(), finchgo.SandboxConnectionNewParams{\n\t\tProviderID: finchgo.F(\"provider_id\"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", connection.AccountID)\n}\n" - }, - "ruby": { - "method": "sandbox.connections.create", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(client_id: \"4ab15e51-11ad-49f4-acae-f343b7794375\", client_secret: \"My Client Secret\")\n\nconnection = finch.sandbox.connections.create(provider_id: \"provider_id\")\n\nputs(connection)" - }, - "http": { - "example": "curl https://api.tryfinch.com/sandbox/connections \\\n -H 'Content-Type: application/json' \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -u \"$FINCH_CLIENT_ID:FINCH_CLIENT_SECRET\" \\\n -d '{\n \"provider_id\": \"provider_id\"\n }'" - } - } + response: + "{ access_token: string; account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; token_type?: string; }", + markdown: + "## create\n\n`client.sandbox.connections.create(provider_id: string, authentication_type?: 'credential' | 'api_token' | 'oauth' | 'assisted', employee_size?: number, products?: string[]): { access_token: string; account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; token_type?: string; }`\n\n**post** `/sandbox/connections`\n\nCreate a new connection (new company/provider pair) with a new account\n\n### Parameters\n\n- `provider_id: string`\n The provider associated with the connection\n\n- `authentication_type?: 'credential' | 'api_token' | 'oauth' | 'assisted'`\n\n- `employee_size?: number`\n Optional: the size of the employer to be created with this connection. Defaults to 20. Note that if this is higher than 100, historical payroll data will not be generated, and instead only one pay period will be created.\n\n- `products?: string[]`\n\n### Returns\n\n- `{ access_token: string; account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; token_type?: string; }`\n\n - `access_token: string`\n - `account_id: string`\n - `authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'`\n - `company_id: string`\n - `connection_id: string`\n - `entity_id: string`\n - `products: string[]`\n - `provider_id: string`\n - `token_type?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst connection = await client.sandbox.connections.create({ provider_id: 'provider_id' });\n\nconsole.log(connection);\n```", + perLanguage: { + typescript: { + method: 'client.sandbox.connections.create', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n clientID: process.env['FINCH_CLIENT_ID'], // This is the default and can be omitted\n clientSecret: process.env['FINCH_CLIENT_SECRET'], // This is the default and can be omitted\n});\n\nconst connection = await client.sandbox.connections.create({ provider_id: 'provider_id' });\n\nconsole.log(connection.account_id);", + }, + python: { + method: 'sandbox.connections.create', + example: + 'import os\nfrom finch import Finch\n\nclient = Finch(\n client_id=os.environ.get("FINCH_CLIENT_ID"), # This is the default and can be omitted\n client_secret=os.environ.get("FINCH_CLIENT_SECRET"), # This is the default and can be omitted\n)\nconnection = client.sandbox.connections.create(\n provider_id="provider_id",\n)\nprint(connection.account_id)', + }, + java: { + method: 'sandbox().connections().create', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.ConnectionCreateResponse;\nimport com.tryfinch.api.models.SandboxConnectionCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.fromEnv();\n\n SandboxConnectionCreateParams params = SandboxConnectionCreateParams.builder()\n .providerId("provider_id")\n .build();\n ConnectionCreateResponse connection = client.sandbox().connections().create(params);\n }\n}', + }, + kotlin: { + method: 'sandbox().connections().create', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.ConnectionCreateResponse\nimport com.tryfinch.api.models.SandboxConnectionCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.fromEnv()\n\n val params: SandboxConnectionCreateParams = SandboxConnectionCreateParams.builder()\n .providerId("provider_id")\n .build()\n val connection: ConnectionCreateResponse = client.sandbox().connections().create(params)\n}', + }, + go: { + method: 'client.Sandbox.Connections.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithClientID("4ab15e51-11ad-49f4-acae-f343b7794375"),\n\t\toption.WithClientSecret("My Client Secret"),\n\t)\n\tconnection, err := client.Sandbox.Connections.New(context.TODO(), finchgo.SandboxConnectionNewParams{\n\t\tProviderID: finchgo.F("provider_id"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", connection.AccountID)\n}\n', + }, + ruby: { + method: 'sandbox.connections.create', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(client_id: "4ab15e51-11ad-49f4-acae-f343b7794375", client_secret: "My Client Secret")\n\nconnection = finch.sandbox.connections.create(provider_id: "provider_id")\n\nputs(connection)', + }, + http: { + example: + 'curl https://api.tryfinch.com/sandbox/connections \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -u "$FINCH_CLIENT_ID:FINCH_CLIENT_SECRET" \\\n -d \'{\n "provider_id": "provider_id"\n }\'', + }, + }, }, { - "name": "create", - "endpoint": "/sandbox/connections/accounts", - "httpMethod": "post", - "summary": "Create a new sandbox account", - "description": "Create a new account for an existing connection (company/provider pair)", - "stainlessPath": "(resource) sandbox.connections.accounts > (method) create", - "qualified": "client.sandbox.connections.accounts.create", - "params": [ - "company_id: string;", - "provider_id: string;", + name: 'create', + endpoint: '/sandbox/connections/accounts', + httpMethod: 'post', + summary: 'Create a new sandbox account', + description: 'Create a new account for an existing connection (company/provider pair)', + stainlessPath: '(resource) sandbox.connections.accounts > (method) create', + qualified: 'client.sandbox.connections.accounts.create', + params: [ + 'company_id: string;', + 'provider_id: string;', "authentication_type?: 'credential' | 'api_token' | 'oauth' | 'assisted';", - "products?: string[];" + 'products?: string[];', ], - "response": "{ access_token: string; account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; }", - "markdown": "## create\n\n`client.sandbox.connections.accounts.create(company_id: string, provider_id: string, authentication_type?: 'credential' | 'api_token' | 'oauth' | 'assisted', products?: string[]): { access_token: string; account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; }`\n\n**post** `/sandbox/connections/accounts`\n\nCreate a new account for an existing connection (company/provider pair)\n\n### Parameters\n\n- `company_id: string`\n\n- `provider_id: string`\n The provider associated with the `access_token`\n\n- `authentication_type?: 'credential' | 'api_token' | 'oauth' | 'assisted'`\n\n- `products?: string[]`\n Optional, defaults to Organization products (`company`, `directory`, `employment`, `individual`)\n\n### Returns\n\n- `{ access_token: string; account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; }`\n\n - `access_token: string`\n - `account_id: string`\n - `authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'`\n - `company_id: string`\n - `connection_id: string`\n - `entity_id: string`\n - `products: string[]`\n - `provider_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst account = await client.sandbox.connections.accounts.create({ company_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', provider_id: 'provider_id' });\n\nconsole.log(account);\n```", - "perLanguage": { - "typescript": { - "method": "client.sandbox.connections.accounts.create", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n clientID: process.env['FINCH_CLIENT_ID'], // This is the default and can be omitted\n clientSecret: process.env['FINCH_CLIENT_SECRET'], // This is the default and can be omitted\n});\n\nconst account = await client.sandbox.connections.accounts.create({\n company_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',\n provider_id: 'provider_id',\n});\n\nconsole.log(account.account_id);" - }, - "python": { - "method": "sandbox.connections.accounts.create", - "example": "import os\nfrom finch import Finch\n\nclient = Finch(\n client_id=os.environ.get(\"FINCH_CLIENT_ID\"), # This is the default and can be omitted\n client_secret=os.environ.get(\"FINCH_CLIENT_SECRET\"), # This is the default and can be omitted\n)\naccount = client.sandbox.connections.accounts.create(\n company_id=\"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\",\n provider_id=\"provider_id\",\n)\nprint(account.account_id)" - }, - "java": { - "method": "sandbox().connections().accounts().create", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.AccountCreateResponse;\nimport com.tryfinch.api.models.SandboxConnectionAccountCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.fromEnv();\n\n SandboxConnectionAccountCreateParams params = SandboxConnectionAccountCreateParams.builder()\n .companyId(\"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\")\n .providerId(\"provider_id\")\n .build();\n AccountCreateResponse account = client.sandbox().connections().accounts().create(params);\n }\n}" - }, - "kotlin": { - "method": "sandbox().connections().accounts().create", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AccountCreateResponse\nimport com.tryfinch.api.models.SandboxConnectionAccountCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.fromEnv()\n\n val params: SandboxConnectionAccountCreateParams = SandboxConnectionAccountCreateParams.builder()\n .companyId(\"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\")\n .providerId(\"provider_id\")\n .build()\n val account: AccountCreateResponse = client.sandbox().connections().accounts().create(params)\n}" - }, - "go": { - "method": "client.Sandbox.Connections.Accounts.New", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithClientID(\"4ab15e51-11ad-49f4-acae-f343b7794375\"),\n\t\toption.WithClientSecret(\"My Client Secret\"),\n\t)\n\taccount, err := client.Sandbox.Connections.Accounts.New(context.TODO(), finchgo.SandboxConnectionAccountNewParams{\n\t\tCompanyID: finchgo.F(\"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\"),\n\t\tProviderID: finchgo.F(\"provider_id\"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", account.AccountID)\n}\n" - }, - "ruby": { - "method": "sandbox.connections.accounts.create", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(client_id: \"4ab15e51-11ad-49f4-acae-f343b7794375\", client_secret: \"My Client Secret\")\n\naccount = finch.sandbox.connections.accounts.create(\n company_id: \"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\",\n provider_id: \"provider_id\"\n)\n\nputs(account)" - }, - "http": { - "example": "curl https://api.tryfinch.com/sandbox/connections/accounts \\\n -H 'Content-Type: application/json' \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -u \"$FINCH_CLIENT_ID:FINCH_CLIENT_SECRET\" \\\n -d '{\n \"company_id\": \"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\",\n \"provider_id\": \"provider_id\"\n }'" - } - } + response: + "{ access_token: string; account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; }", + markdown: + "## create\n\n`client.sandbox.connections.accounts.create(company_id: string, provider_id: string, authentication_type?: 'credential' | 'api_token' | 'oauth' | 'assisted', products?: string[]): { access_token: string; account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; }`\n\n**post** `/sandbox/connections/accounts`\n\nCreate a new account for an existing connection (company/provider pair)\n\n### Parameters\n\n- `company_id: string`\n\n- `provider_id: string`\n The provider associated with the `access_token`\n\n- `authentication_type?: 'credential' | 'api_token' | 'oauth' | 'assisted'`\n\n- `products?: string[]`\n Optional, defaults to Organization products (`company`, `directory`, `employment`, `individual`)\n\n### Returns\n\n- `{ access_token: string; account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; }`\n\n - `access_token: string`\n - `account_id: string`\n - `authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'`\n - `company_id: string`\n - `connection_id: string`\n - `entity_id: string`\n - `products: string[]`\n - `provider_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst account = await client.sandbox.connections.accounts.create({ company_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', provider_id: 'provider_id' });\n\nconsole.log(account);\n```", + perLanguage: { + typescript: { + method: 'client.sandbox.connections.accounts.create', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n clientID: process.env['FINCH_CLIENT_ID'], // This is the default and can be omitted\n clientSecret: process.env['FINCH_CLIENT_SECRET'], // This is the default and can be omitted\n});\n\nconst account = await client.sandbox.connections.accounts.create({\n company_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',\n provider_id: 'provider_id',\n});\n\nconsole.log(account.account_id);", + }, + python: { + method: 'sandbox.connections.accounts.create', + example: + 'import os\nfrom finch import Finch\n\nclient = Finch(\n client_id=os.environ.get("FINCH_CLIENT_ID"), # This is the default and can be omitted\n client_secret=os.environ.get("FINCH_CLIENT_SECRET"), # This is the default and can be omitted\n)\naccount = client.sandbox.connections.accounts.create(\n company_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n provider_id="provider_id",\n)\nprint(account.account_id)', + }, + java: { + method: 'sandbox().connections().accounts().create', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.AccountCreateResponse;\nimport com.tryfinch.api.models.SandboxConnectionAccountCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.fromEnv();\n\n SandboxConnectionAccountCreateParams params = SandboxConnectionAccountCreateParams.builder()\n .companyId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")\n .providerId("provider_id")\n .build();\n AccountCreateResponse account = client.sandbox().connections().accounts().create(params);\n }\n}', + }, + kotlin: { + method: 'sandbox().connections().accounts().create', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AccountCreateResponse\nimport com.tryfinch.api.models.SandboxConnectionAccountCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.fromEnv()\n\n val params: SandboxConnectionAccountCreateParams = SandboxConnectionAccountCreateParams.builder()\n .companyId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")\n .providerId("provider_id")\n .build()\n val account: AccountCreateResponse = client.sandbox().connections().accounts().create(params)\n}', + }, + go: { + method: 'client.Sandbox.Connections.Accounts.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithClientID("4ab15e51-11ad-49f4-acae-f343b7794375"),\n\t\toption.WithClientSecret("My Client Secret"),\n\t)\n\taccount, err := client.Sandbox.Connections.Accounts.New(context.TODO(), finchgo.SandboxConnectionAccountNewParams{\n\t\tCompanyID: finchgo.F("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"),\n\t\tProviderID: finchgo.F("provider_id"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", account.AccountID)\n}\n', + }, + ruby: { + method: 'sandbox.connections.accounts.create', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(client_id: "4ab15e51-11ad-49f4-acae-f343b7794375", client_secret: "My Client Secret")\n\naccount = finch.sandbox.connections.accounts.create(\n company_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n provider_id: "provider_id"\n)\n\nputs(account)', + }, + http: { + example: + 'curl https://api.tryfinch.com/sandbox/connections/accounts \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -u "$FINCH_CLIENT_ID:FINCH_CLIENT_SECRET" \\\n -d \'{\n "company_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",\n "provider_id": "provider_id"\n }\'', + }, + }, }, { - "name": "update", - "endpoint": "/sandbox/connections/accounts", - "httpMethod": "put", - "summary": "Update a sandbox account", - "description": "Update an existing sandbox account. Change the connection status to understand how the Finch API responds.", - "stainlessPath": "(resource) sandbox.connections.accounts > (method) update", - "qualified": "client.sandbox.connections.accounts.update", - "params": [ - "connection_status?: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth';" + name: 'update', + endpoint: '/sandbox/connections/accounts', + httpMethod: 'put', + summary: 'Update a sandbox account', + description: + 'Update an existing sandbox account. Change the connection status to understand how the Finch API responds.', + stainlessPath: '(resource) sandbox.connections.accounts > (method) update', + qualified: 'client.sandbox.connections.accounts.update', + params: [ + "connection_status?: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth';", ], - "response": "{ account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; }", - "markdown": "## update\n\n`client.sandbox.connections.accounts.update(connection_status?: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth'): { account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; }`\n\n**put** `/sandbox/connections/accounts`\n\nUpdate an existing sandbox account. Change the connection status to understand how the Finch API responds.\n\n### Parameters\n\n- `connection_status?: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth'`\n\n### Returns\n\n- `{ account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; }`\n\n - `account_id: string`\n - `authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'`\n - `company_id: string`\n - `connection_id: string`\n - `entity_id: string`\n - `products: string[]`\n - `provider_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst account = await client.sandbox.connections.accounts.update();\n\nconsole.log(account);\n```", - "perLanguage": { - "typescript": { - "method": "client.sandbox.connections.accounts.update", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst account = await client.sandbox.connections.accounts.update({ connection_status: 'reauth' });\n\nconsole.log(account.account_id);" - }, - "python": { - "method": "sandbox.connections.accounts.update", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\naccount = client.sandbox.connections.accounts.update(\n connection_status=\"reauth\",\n)\nprint(account.account_id)" - }, - "java": { - "method": "sandbox().connections().accounts().update", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.AccountUpdateResponse;\nimport com.tryfinch.api.models.SandboxConnectionAccountUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n AccountUpdateResponse account = client.sandbox().connections().accounts().update();\n }\n}" - }, - "kotlin": { - "method": "sandbox().connections().accounts().update", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AccountUpdateResponse\nimport com.tryfinch.api.models.SandboxConnectionAccountUpdateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val account: AccountUpdateResponse = client.sandbox().connections().accounts().update()\n}" - }, - "go": { - "method": "client.Sandbox.Connections.Accounts.Update", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n\t\"github.com/Finch-API/finch-api-go/shared\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\taccount, err := client.Sandbox.Connections.Accounts.Update(context.TODO(), finchgo.SandboxConnectionAccountUpdateParams{\n\t\tConnectionStatus: finchgo.F(shared.ConnectionStatusTypeReauth),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", account.AccountID)\n}\n" - }, - "ruby": { - "method": "sandbox.connections.accounts.update", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\naccount = finch.sandbox.connections.accounts.update\n\nputs(account)" - }, - "http": { - "example": "curl https://api.tryfinch.com/sandbox/connections/accounts \\\n -X PUT \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + response: + "{ account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; }", + markdown: + "## update\n\n`client.sandbox.connections.accounts.update(connection_status?: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth'): { account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; }`\n\n**put** `/sandbox/connections/accounts`\n\nUpdate an existing sandbox account. Change the connection status to understand how the Finch API responds.\n\n### Parameters\n\n- `connection_status?: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth'`\n\n### Returns\n\n- `{ account_id: string; authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'; company_id: string; connection_id: string; entity_id: string; products: string[]; provider_id: string; }`\n\n - `account_id: string`\n - `authentication_type: 'credential' | 'api_token' | 'oauth' | 'assisted'`\n - `company_id: string`\n - `connection_id: string`\n - `entity_id: string`\n - `products: string[]`\n - `provider_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst account = await client.sandbox.connections.accounts.update();\n\nconsole.log(account);\n```", + perLanguage: { + typescript: { + method: 'client.sandbox.connections.accounts.update', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst account = await client.sandbox.connections.accounts.update({ connection_status: 'reauth' });\n\nconsole.log(account.account_id);", + }, + python: { + method: 'sandbox.connections.accounts.update', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\naccount = client.sandbox.connections.accounts.update(\n connection_status="reauth",\n)\nprint(account.account_id)', + }, + java: { + method: 'sandbox().connections().accounts().update', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.AccountUpdateResponse;\nimport com.tryfinch.api.models.SandboxConnectionAccountUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n AccountUpdateResponse account = client.sandbox().connections().accounts().update();\n }\n}', + }, + kotlin: { + method: 'sandbox().connections().accounts().update', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AccountUpdateResponse\nimport com.tryfinch.api.models.SandboxConnectionAccountUpdateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val account: AccountUpdateResponse = client.sandbox().connections().accounts().update()\n}', + }, + go: { + method: 'client.Sandbox.Connections.Accounts.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n\t"github.com/Finch-API/finch-api-go/shared"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\taccount, err := client.Sandbox.Connections.Accounts.Update(context.TODO(), finchgo.SandboxConnectionAccountUpdateParams{\n\t\tConnectionStatus: finchgo.F(shared.ConnectionStatusTypeReauth),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", account.AccountID)\n}\n', + }, + ruby: { + method: 'sandbox.connections.accounts.update', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\naccount = finch.sandbox.connections.accounts.update\n\nputs(account)', + }, + http: { + example: + 'curl https://api.tryfinch.com/sandbox/connections/accounts \\\n -X PUT \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "update", - "endpoint": "/sandbox/company", - "httpMethod": "put", - "summary": "Update a sandbox company's data", - "description": "Update a sandbox company's data", - "stainlessPath": "(resource) sandbox.company > (method) update", - "qualified": "client.sandbox.company.update", - "params": [ + name: 'update', + endpoint: '/sandbox/company', + httpMethod: 'put', + summary: "Update a sandbox company's data", + description: "Update a sandbox company's data", + stainlessPath: '(resource) sandbox.company > (method) update', + qualified: 'client.sandbox.company.update', + params: [ "accounts: { account_name?: string; account_number?: string; account_type?: 'checking' | 'savings'; institution_name?: string; routing_number?: string; }[];", - "departments: { name?: string; parent?: { name?: string; }; }[];", - "ein: string;", + 'departments: { name?: string; parent?: { name?: string; }; }[];', + 'ein: string;', "entity: { subtype?: 's_corporation' | 'c_corporation' | 'b_corporation'; type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; };", - "legal_name: string;", - "locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[];", - "primary_email: string;", - "primary_phone_number: string;" + 'legal_name: string;', + 'locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[];', + 'primary_email: string;', + 'primary_phone_number: string;', ], - "response": "{ accounts: { account_name?: string; account_number?: string; account_type?: 'checking' | 'savings'; institution_name?: string; routing_number?: string; }[]; departments: { name?: string; parent?: { name?: string; }; }[]; ein: string; entity: { subtype?: 's_corporation' | 'c_corporation' | 'b_corporation'; type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }; legal_name: string; locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]; primary_email: string; primary_phone_number: string; }", - "markdown": "## update\n\n`client.sandbox.company.update(accounts: { account_name?: string; account_number?: string; account_type?: 'checking' | 'savings'; institution_name?: string; routing_number?: string; }[], departments: { name?: string; parent?: { name?: string; }; }[], ein: string, entity: { subtype?: 's_corporation' | 'c_corporation' | 'b_corporation'; type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }, legal_name: string, locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[], primary_email: string, primary_phone_number: string): { accounts: object[]; departments: object[]; ein: string; entity: object; legal_name: string; locations: location[]; primary_email: string; primary_phone_number: string; }`\n\n**put** `/sandbox/company`\n\nUpdate a sandbox company's data\n\n### Parameters\n\n- `accounts: { account_name?: string; account_number?: string; account_type?: 'checking' | 'savings'; institution_name?: string; routing_number?: string; }[]`\n An array of bank account objects associated with the payroll/HRIS system.\n\n- `departments: { name?: string; parent?: { name?: string; }; }[]`\n The array of company departments.\n\n- `ein: string`\n The employer identification number.\n\n- `entity: { subtype?: 's_corporation' | 'c_corporation' | 'b_corporation'; type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }`\n The entity type object.\n - `subtype?: 's_corporation' | 'c_corporation' | 'b_corporation'`\n The tax payer subtype of the company.\n - `type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'`\n The tax payer type of the company.\n\n- `legal_name: string`\n The legal name of the company.\n\n- `locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]`\n\n- `primary_email: string`\n The email of the main administrator on the account.\n\n- `primary_phone_number: string`\n The phone number of the main administrator on the account. Format: E.164, with extension where applicable, e.g. `+NNNNNNNNNNN xExtension`\n\n### Returns\n\n- `{ accounts: { account_name?: string; account_number?: string; account_type?: 'checking' | 'savings'; institution_name?: string; routing_number?: string; }[]; departments: { name?: string; parent?: { name?: string; }; }[]; ein: string; entity: { subtype?: 's_corporation' | 'c_corporation' | 'b_corporation'; type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }; legal_name: string; locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]; primary_email: string; primary_phone_number: string; }`\n\n - `accounts: { account_name?: string; account_number?: string; account_type?: 'checking' | 'savings'; institution_name?: string; routing_number?: string; }[]`\n - `departments: { name?: string; parent?: { name?: string; }; }[]`\n - `ein: string`\n - `entity: { subtype?: 's_corporation' | 'c_corporation' | 'b_corporation'; type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }`\n - `legal_name: string`\n - `locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]`\n - `primary_email: string`\n - `primary_phone_number: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst company = await client.sandbox.company.update({\n accounts: [{}],\n departments: [{}],\n ein: 'ein',\n entity: {},\n legal_name: 'legal_name',\n locations: [{\n city: 'city',\n country: 'country',\n line1: 'line1',\n line2: 'line2',\n postal_code: 'postal_code',\n state: 'state',\n}],\n primary_email: 'dev@stainless.com',\n primary_phone_number: 'primary_phone_number',\n});\n\nconsole.log(company);\n```", - "perLanguage": { - "typescript": { - "method": "client.sandbox.company.update", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst company = await client.sandbox.company.update({\n accounts: [{}],\n departments: [{}],\n ein: 'ein',\n entity: {},\n legal_name: 'legal_name',\n locations: [\n {\n city: 'city',\n country: 'country',\n line1: 'line1',\n line2: 'line2',\n postal_code: 'postal_code',\n state: 'state',\n },\n ],\n primary_email: 'dev@stainless.com',\n primary_phone_number: 'primary_phone_number',\n});\n\nconsole.log(company.accounts);" - }, - "python": { - "method": "sandbox.company.update", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\ncompany = client.sandbox.company.update(\n accounts=[{}],\n departments=[{}],\n ein=\"ein\",\n entity={},\n legal_name=\"legal_name\",\n locations=[{\n \"city\": \"city\",\n \"country\": \"country\",\n \"line1\": \"line1\",\n \"line2\": \"line2\",\n \"postal_code\": \"postal_code\",\n \"state\": \"state\",\n }],\n primary_email=\"dev@stainless.com\",\n primary_phone_number=\"primary_phone_number\",\n)\nprint(company.accounts)" - }, - "java": { - "method": "sandbox().company().update", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.CompanyUpdateResponse;\nimport com.tryfinch.api.models.Location;\nimport com.tryfinch.api.models.SandboxCompanyUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n SandboxCompanyUpdateParams params = SandboxCompanyUpdateParams.builder()\n .addAccount(SandboxCompanyUpdateParams.Account.builder().build())\n .addDepartment(SandboxCompanyUpdateParams.Department.builder().build())\n .ein(\"ein\")\n .entity(SandboxCompanyUpdateParams.Entity.builder().build())\n .legalName(\"legal_name\")\n .addLocation(Location.builder()\n .city(\"city\")\n .country(\"country\")\n .line1(\"line1\")\n .line2(\"line2\")\n .postalCode(\"postal_code\")\n .state(\"state\")\n .build())\n .primaryEmail(\"dev@stainless.com\")\n .primaryPhoneNumber(\"primary_phone_number\")\n .build();\n CompanyUpdateResponse company = client.sandbox().company().update(params);\n }\n}" - }, - "kotlin": { - "method": "sandbox().company().update", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.CompanyUpdateResponse\nimport com.tryfinch.api.models.Location\nimport com.tryfinch.api.models.SandboxCompanyUpdateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val params: SandboxCompanyUpdateParams = SandboxCompanyUpdateParams.builder()\n .addAccount(SandboxCompanyUpdateParams.Account.builder().build())\n .addDepartment(SandboxCompanyUpdateParams.Department.builder().build())\n .ein(\"ein\")\n .entity(SandboxCompanyUpdateParams.Entity.builder().build())\n .legalName(\"legal_name\")\n .addLocation(Location.builder()\n .city(\"city\")\n .country(\"country\")\n .line1(\"line1\")\n .line2(\"line2\")\n .postalCode(\"postal_code\")\n .state(\"state\")\n .build())\n .primaryEmail(\"dev@stainless.com\")\n .primaryPhoneNumber(\"primary_phone_number\")\n .build()\n val company: CompanyUpdateResponse = client.sandbox().company().update(params)\n}" - }, - "go": { - "method": "client.Sandbox.Company.Update", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tcompany, err := client.Sandbox.Company.Update(context.TODO(), finchgo.SandboxCompanyUpdateParams{\n\t\tAccounts: finchgo.F([]finchgo.SandboxCompanyUpdateParamsAccount{{}}),\n\t\tDepartments: finchgo.F([]finchgo.SandboxCompanyUpdateParamsDepartment{{}}),\n\t\tEin: finchgo.F(\"ein\"),\n\t\tEntity: finchgo.F(finchgo.SandboxCompanyUpdateParamsEntity{}),\n\t\tLegalName: finchgo.F(\"legal_name\"),\n\t\tLocations: finchgo.F([]finchgo.LocationParam{{\n\t\t\tCity: finchgo.F(\"city\"),\n\t\t\tCountry: finchgo.F(\"country\"),\n\t\t\tLine1: finchgo.F(\"line1\"),\n\t\t\tLine2: finchgo.F(\"line2\"),\n\t\t\tPostalCode: finchgo.F(\"postal_code\"),\n\t\t\tState: finchgo.F(\"state\"),\n\t\t}}),\n\t\tPrimaryEmail: finchgo.F(\"dev@stainless.com\"),\n\t\tPrimaryPhoneNumber: finchgo.F(\"primary_phone_number\"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", company.Accounts)\n}\n" - }, - "ruby": { - "method": "sandbox.company.update", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\ncompany = finch.sandbox.company.update(\n accounts: [{}],\n departments: [{}],\n ein: \"ein\",\n entity: {},\n legal_name: \"legal_name\",\n locations: [\n {city: \"city\", country: \"country\", line1: \"line1\", line2: \"line2\", postal_code: \"postal_code\", state: \"state\"}\n ],\n primary_email: \"dev@stainless.com\",\n primary_phone_number: \"primary_phone_number\"\n)\n\nputs(company)" - }, - "http": { - "example": "curl https://api.tryfinch.com/sandbox/company \\\n -X PUT \\\n -H 'Content-Type: application/json' \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{\n \"accounts\": [\n {}\n ],\n \"departments\": [\n {}\n ],\n \"ein\": \"ein\",\n \"entity\": {},\n \"legal_name\": \"legal_name\",\n \"locations\": [\n {\n \"city\": \"city\",\n \"country\": \"country\",\n \"line1\": \"line1\",\n \"line2\": \"line2\",\n \"postal_code\": \"postal_code\",\n \"state\": \"state\"\n }\n ],\n \"primary_email\": \"dev@stainless.com\",\n \"primary_phone_number\": \"primary_phone_number\"\n }'" - } - } + response: + "{ accounts: { account_name?: string; account_number?: string; account_type?: 'checking' | 'savings'; institution_name?: string; routing_number?: string; }[]; departments: { name?: string; parent?: { name?: string; }; }[]; ein: string; entity: { subtype?: 's_corporation' | 'c_corporation' | 'b_corporation'; type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }; legal_name: string; locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]; primary_email: string; primary_phone_number: string; }", + markdown: + "## update\n\n`client.sandbox.company.update(accounts: { account_name?: string; account_number?: string; account_type?: 'checking' | 'savings'; institution_name?: string; routing_number?: string; }[], departments: { name?: string; parent?: { name?: string; }; }[], ein: string, entity: { subtype?: 's_corporation' | 'c_corporation' | 'b_corporation'; type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }, legal_name: string, locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[], primary_email: string, primary_phone_number: string): { accounts: object[]; departments: object[]; ein: string; entity: object; legal_name: string; locations: location[]; primary_email: string; primary_phone_number: string; }`\n\n**put** `/sandbox/company`\n\nUpdate a sandbox company's data\n\n### Parameters\n\n- `accounts: { account_name?: string; account_number?: string; account_type?: 'checking' | 'savings'; institution_name?: string; routing_number?: string; }[]`\n An array of bank account objects associated with the payroll/HRIS system.\n\n- `departments: { name?: string; parent?: { name?: string; }; }[]`\n The array of company departments.\n\n- `ein: string`\n The employer identification number.\n\n- `entity: { subtype?: 's_corporation' | 'c_corporation' | 'b_corporation'; type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }`\n The entity type object.\n - `subtype?: 's_corporation' | 'c_corporation' | 'b_corporation'`\n The tax payer subtype of the company.\n - `type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'`\n The tax payer type of the company.\n\n- `legal_name: string`\n The legal name of the company.\n\n- `locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]`\n\n- `primary_email: string`\n The email of the main administrator on the account.\n\n- `primary_phone_number: string`\n The phone number of the main administrator on the account. Format: E.164, with extension where applicable, e.g. `+NNNNNNNNNNN xExtension`\n\n### Returns\n\n- `{ accounts: { account_name?: string; account_number?: string; account_type?: 'checking' | 'savings'; institution_name?: string; routing_number?: string; }[]; departments: { name?: string; parent?: { name?: string; }; }[]; ein: string; entity: { subtype?: 's_corporation' | 'c_corporation' | 'b_corporation'; type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }; legal_name: string; locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]; primary_email: string; primary_phone_number: string; }`\n\n - `accounts: { account_name?: string; account_number?: string; account_type?: 'checking' | 'savings'; institution_name?: string; routing_number?: string; }[]`\n - `departments: { name?: string; parent?: { name?: string; }; }[]`\n - `ein: string`\n - `entity: { subtype?: 's_corporation' | 'c_corporation' | 'b_corporation'; type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative'; }`\n - `legal_name: string`\n - `locations: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }[]`\n - `primary_email: string`\n - `primary_phone_number: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst company = await client.sandbox.company.update({\n accounts: [{}],\n departments: [{}],\n ein: 'ein',\n entity: {},\n legal_name: 'legal_name',\n locations: [{\n city: 'city',\n country: 'country',\n line1: 'line1',\n line2: 'line2',\n postal_code: 'postal_code',\n state: 'state',\n}],\n primary_email: 'dev@stainless.com',\n primary_phone_number: 'primary_phone_number',\n});\n\nconsole.log(company);\n```", + perLanguage: { + typescript: { + method: 'client.sandbox.company.update', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst company = await client.sandbox.company.update({\n accounts: [{}],\n departments: [{}],\n ein: 'ein',\n entity: {},\n legal_name: 'legal_name',\n locations: [\n {\n city: 'city',\n country: 'country',\n line1: 'line1',\n line2: 'line2',\n postal_code: 'postal_code',\n state: 'state',\n },\n ],\n primary_email: 'dev@stainless.com',\n primary_phone_number: 'primary_phone_number',\n});\n\nconsole.log(company.accounts);", + }, + python: { + method: 'sandbox.company.update', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\ncompany = client.sandbox.company.update(\n accounts=[{}],\n departments=[{}],\n ein="ein",\n entity={},\n legal_name="legal_name",\n locations=[{\n "city": "city",\n "country": "country",\n "line1": "line1",\n "line2": "line2",\n "postal_code": "postal_code",\n "state": "state",\n }],\n primary_email="dev@stainless.com",\n primary_phone_number="primary_phone_number",\n)\nprint(company.accounts)', + }, + java: { + method: 'sandbox().company().update', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.CompanyUpdateResponse;\nimport com.tryfinch.api.models.Location;\nimport com.tryfinch.api.models.SandboxCompanyUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SandboxCompanyUpdateParams params = SandboxCompanyUpdateParams.builder()\n .addAccount(SandboxCompanyUpdateParams.Account.builder().build())\n .addDepartment(SandboxCompanyUpdateParams.Department.builder().build())\n .ein("ein")\n .entity(SandboxCompanyUpdateParams.Entity.builder().build())\n .legalName("legal_name")\n .addLocation(Location.builder()\n .city("city")\n .country("country")\n .line1("line1")\n .line2("line2")\n .postalCode("postal_code")\n .state("state")\n .build())\n .primaryEmail("dev@stainless.com")\n .primaryPhoneNumber("primary_phone_number")\n .build();\n CompanyUpdateResponse company = client.sandbox().company().update(params);\n }\n}', + }, + kotlin: { + method: 'sandbox().company().update', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.CompanyUpdateResponse\nimport com.tryfinch.api.models.Location\nimport com.tryfinch.api.models.SandboxCompanyUpdateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val params: SandboxCompanyUpdateParams = SandboxCompanyUpdateParams.builder()\n .addAccount(SandboxCompanyUpdateParams.Account.builder().build())\n .addDepartment(SandboxCompanyUpdateParams.Department.builder().build())\n .ein("ein")\n .entity(SandboxCompanyUpdateParams.Entity.builder().build())\n .legalName("legal_name")\n .addLocation(Location.builder()\n .city("city")\n .country("country")\n .line1("line1")\n .line2("line2")\n .postalCode("postal_code")\n .state("state")\n .build())\n .primaryEmail("dev@stainless.com")\n .primaryPhoneNumber("primary_phone_number")\n .build()\n val company: CompanyUpdateResponse = client.sandbox().company().update(params)\n}', + }, + go: { + method: 'client.Sandbox.Company.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tcompany, err := client.Sandbox.Company.Update(context.TODO(), finchgo.SandboxCompanyUpdateParams{\n\t\tAccounts: finchgo.F([]finchgo.SandboxCompanyUpdateParamsAccount{{}}),\n\t\tDepartments: finchgo.F([]finchgo.SandboxCompanyUpdateParamsDepartment{{}}),\n\t\tEin: finchgo.F("ein"),\n\t\tEntity: finchgo.F(finchgo.SandboxCompanyUpdateParamsEntity{}),\n\t\tLegalName: finchgo.F("legal_name"),\n\t\tLocations: finchgo.F([]finchgo.LocationParam{{\n\t\t\tCity: finchgo.F("city"),\n\t\t\tCountry: finchgo.F("country"),\n\t\t\tLine1: finchgo.F("line1"),\n\t\t\tLine2: finchgo.F("line2"),\n\t\t\tPostalCode: finchgo.F("postal_code"),\n\t\t\tState: finchgo.F("state"),\n\t\t}}),\n\t\tPrimaryEmail: finchgo.F("dev@stainless.com"),\n\t\tPrimaryPhoneNumber: finchgo.F("primary_phone_number"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", company.Accounts)\n}\n', + }, + ruby: { + method: 'sandbox.company.update', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\ncompany = finch.sandbox.company.update(\n accounts: [{}],\n departments: [{}],\n ein: "ein",\n entity: {},\n legal_name: "legal_name",\n locations: [\n {city: "city", country: "country", line1: "line1", line2: "line2", postal_code: "postal_code", state: "state"}\n ],\n primary_email: "dev@stainless.com",\n primary_phone_number: "primary_phone_number"\n)\n\nputs(company)', + }, + http: { + example: + 'curl https://api.tryfinch.com/sandbox/company \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "accounts": [\n {}\n ],\n "departments": [\n {}\n ],\n "ein": "ein",\n "entity": {},\n "legal_name": "legal_name",\n "locations": [\n {\n "city": "city",\n "country": "country",\n "line1": "line1",\n "line2": "line2",\n "postal_code": "postal_code",\n "state": "state"\n }\n ],\n "primary_email": "dev@stainless.com",\n "primary_phone_number": "primary_phone_number"\n }\'', + }, + }, }, { - "name": "create", - "endpoint": "/sandbox/directory", - "httpMethod": "post", - "summary": "Add new individuals to a sandbox company", - "description": "Add new individuals to a sandbox company", - "stainlessPath": "(resource) sandbox.directory > (method) create", - "qualified": "client.sandbox.directory.create", - "params": [ - "body?: { class_code?: string; custom_fields?: { name?: string; value?: object; }[]; department?: { name?: string; }; dob?: string; emails?: { data?: string; type?: 'work' | 'personal'; }[]; employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }; employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; encrypted_ssn?: string; end_date?: string; ethnicity?: string; first_name?: string; flsa_status?: 'exempt' | 'non_exempt' | 'unknown'; gender?: 'female' | 'male' | 'other' | 'decline_to_specify'; income?: { amount: number; currency: string; effective_date: string; unit: string; }; income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]; is_active?: boolean; last_name?: string; latest_rehire_date?: string; location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; manager?: { id?: string; }; middle_name?: string; phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]; preferred_name?: string; residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; source_id?: string; ssn?: string; start_date?: string; title?: string; }[];" + name: 'create', + endpoint: '/sandbox/directory', + httpMethod: 'post', + summary: 'Add new individuals to a sandbox company', + description: 'Add new individuals to a sandbox company', + stainlessPath: '(resource) sandbox.directory > (method) create', + qualified: 'client.sandbox.directory.create', + params: [ + "body?: { class_code?: string; custom_fields?: { name?: string; value?: object; }[]; department?: { name?: string; }; dob?: string; emails?: { data?: string; type?: 'work' | 'personal'; }[]; employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }; employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; encrypted_ssn?: string; end_date?: string; ethnicity?: string; first_name?: string; flsa_status?: 'exempt' | 'non_exempt' | 'unknown'; gender?: 'female' | 'male' | 'other' | 'decline_to_specify'; income?: { amount: number; currency: string; effective_date: string; unit: string; }; income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]; is_active?: boolean; last_name?: string; latest_rehire_date?: string; location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; manager?: { id?: string; }; middle_name?: string; phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]; preferred_name?: string; residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; source_id?: string; ssn?: string; start_date?: string; title?: string; }[];", ], - "response": "object[]", - "markdown": "## create\n\n`client.sandbox.directory.create(body?: { class_code?: string; custom_fields?: { name?: string; value?: object; }[]; department?: { name?: string; }; dob?: string; emails?: { data?: string; type?: 'work' | 'personal'; }[]; employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }; employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; encrypted_ssn?: string; end_date?: string; ethnicity?: string; first_name?: string; flsa_status?: 'exempt' | 'non_exempt' | 'unknown'; gender?: 'female' | 'male' | 'other' | 'decline_to_specify'; income?: object; income_history?: object[]; is_active?: boolean; last_name?: string; latest_rehire_date?: string; location?: object; manager?: { id?: string; }; middle_name?: string; phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]; preferred_name?: string; residence?: object; source_id?: string; ssn?: string; start_date?: string; title?: string; }[]): object[]`\n\n**post** `/sandbox/directory`\n\nAdd new individuals to a sandbox company\n\n### Parameters\n\n- `body?: { class_code?: string; custom_fields?: { name?: string; value?: object; }[]; department?: { name?: string; }; dob?: string; emails?: { data?: string; type?: 'work' | 'personal'; }[]; employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }; employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; encrypted_ssn?: string; end_date?: string; ethnicity?: string; first_name?: string; flsa_status?: 'exempt' | 'non_exempt' | 'unknown'; gender?: 'female' | 'male' | 'other' | 'decline_to_specify'; income?: { amount: number; currency: string; effective_date: string; unit: string; }; income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]; is_active?: boolean; last_name?: string; latest_rehire_date?: string; location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; manager?: { id?: string; }; middle_name?: string; phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]; preferred_name?: string; residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; source_id?: string; ssn?: string; start_date?: string; title?: string; }[]`\n Array of individuals to create. Takes all combined fields from `/individual` and `/employment` endpoints. All fields are optional.\n\n### Returns\n\n- `object[]`\n The individuals which were created\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst directories = await client.sandbox.directory.create();\n\nconsole.log(directories);\n```", - "perLanguage": { - "typescript": { - "method": "client.sandbox.directory.create", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst directories = await client.sandbox.directory.create();\n\nconsole.log(directories);" - }, - "python": { - "method": "sandbox.directory.create", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\ndirectories = client.sandbox.directory.create()\nprint(directories)" - }, - "java": { - "method": "sandbox().directory().create", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.DirectoryCreateResponse;\nimport com.tryfinch.api.models.SandboxDirectoryCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n List directories = client.sandbox().directory().create();\n }\n}" - }, - "kotlin": { - "method": "sandbox().directory().create", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.DirectoryCreateResponse\nimport com.tryfinch.api.models.SandboxDirectoryCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val directories: List = client.sandbox().directory().create()\n}" - }, - "go": { - "method": "client.Sandbox.Directory.New", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tdirectories, err := client.Sandbox.Directory.New(context.TODO(), finchgo.SandboxDirectoryNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", directories)\n}\n" - }, - "ruby": { - "method": "sandbox.directory.create", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\ndirectories = finch.sandbox.directory.create\n\nputs(directories)" - }, - "http": { - "example": "curl https://api.tryfinch.com/sandbox/directory \\\n -X POST \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + response: 'object[]', + markdown: + "## create\n\n`client.sandbox.directory.create(body?: { class_code?: string; custom_fields?: { name?: string; value?: object; }[]; department?: { name?: string; }; dob?: string; emails?: { data?: string; type?: 'work' | 'personal'; }[]; employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }; employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; encrypted_ssn?: string; end_date?: string; ethnicity?: string; first_name?: string; flsa_status?: 'exempt' | 'non_exempt' | 'unknown'; gender?: 'female' | 'male' | 'other' | 'decline_to_specify'; income?: object; income_history?: object[]; is_active?: boolean; last_name?: string; latest_rehire_date?: string; location?: object; manager?: { id?: string; }; middle_name?: string; phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]; preferred_name?: string; residence?: object; source_id?: string; ssn?: string; start_date?: string; title?: string; }[]): object[]`\n\n**post** `/sandbox/directory`\n\nAdd new individuals to a sandbox company\n\n### Parameters\n\n- `body?: { class_code?: string; custom_fields?: { name?: string; value?: object; }[]; department?: { name?: string; }; dob?: string; emails?: { data?: string; type?: 'work' | 'personal'; }[]; employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }; employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; encrypted_ssn?: string; end_date?: string; ethnicity?: string; first_name?: string; flsa_status?: 'exempt' | 'non_exempt' | 'unknown'; gender?: 'female' | 'male' | 'other' | 'decline_to_specify'; income?: { amount: number; currency: string; effective_date: string; unit: string; }; income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]; is_active?: boolean; last_name?: string; latest_rehire_date?: string; location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; manager?: { id?: string; }; middle_name?: string; phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]; preferred_name?: string; residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; source_id?: string; ssn?: string; start_date?: string; title?: string; }[]`\n Array of individuals to create. Takes all combined fields from `/individual` and `/employment` endpoints. All fields are optional.\n\n### Returns\n\n- `object[]`\n The individuals which were created\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst directories = await client.sandbox.directory.create();\n\nconsole.log(directories);\n```", + perLanguage: { + typescript: { + method: 'client.sandbox.directory.create', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst directories = await client.sandbox.directory.create();\n\nconsole.log(directories);", + }, + python: { + method: 'sandbox.directory.create', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\ndirectories = client.sandbox.directory.create()\nprint(directories)', + }, + java: { + method: 'sandbox().directory().create', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.DirectoryCreateResponse;\nimport com.tryfinch.api.models.SandboxDirectoryCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n List directories = client.sandbox().directory().create();\n }\n}', + }, + kotlin: { + method: 'sandbox().directory().create', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.DirectoryCreateResponse\nimport com.tryfinch.api.models.SandboxDirectoryCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val directories: List = client.sandbox().directory().create()\n}', + }, + go: { + method: 'client.Sandbox.Directory.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tdirectories, err := client.Sandbox.Directory.New(context.TODO(), finchgo.SandboxDirectoryNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", directories)\n}\n', + }, + ruby: { + method: 'sandbox.directory.create', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\ndirectories = finch.sandbox.directory.create\n\nputs(directories)', + }, + http: { + example: + 'curl https://api.tryfinch.com/sandbox/directory \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "update", - "endpoint": "/sandbox/individual/{individual_id}", - "httpMethod": "put", - "summary": "Update sandbox individual", - "description": "Update sandbox individual", - "stainlessPath": "(resource) sandbox.individual > (method) update", - "qualified": "client.sandbox.individual.update", - "params": [ - "individual_id: string;", - "dob?: string;", + name: 'update', + endpoint: '/sandbox/individual/{individual_id}', + httpMethod: 'put', + summary: 'Update sandbox individual', + description: 'Update sandbox individual', + stainlessPath: '(resource) sandbox.individual > (method) update', + qualified: 'client.sandbox.individual.update', + params: [ + 'individual_id: string;', + 'dob?: string;', "emails?: { data?: string; type?: 'work' | 'personal'; }[];", - "encrypted_ssn?: string;", - "ethnicity?: string;", - "first_name?: string;", + 'encrypted_ssn?: string;', + 'ethnicity?: string;', + 'first_name?: string;', "gender?: 'female' | 'male' | 'other' | 'decline_to_specify';", - "last_name?: string;", - "middle_name?: string;", + 'last_name?: string;', + 'middle_name?: string;', "phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[];", - "preferred_name?: string;", - "residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; };", - "ssn?: string;" + 'preferred_name?: string;', + 'residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; };', + 'ssn?: string;', ], - "response": "{ id?: string; dob?: string; emails?: { data?: string; type?: 'work' | 'personal'; }[]; encrypted_ssn?: string; ethnicity?: string; first_name?: string; gender?: 'female' | 'male' | 'other' | 'decline_to_specify'; last_name?: string; middle_name?: string; phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]; preferred_name?: string; residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; ssn?: string; }", - "markdown": "## update\n\n`client.sandbox.individual.update(individual_id: string, dob?: string, emails?: { data?: string; type?: 'work' | 'personal'; }[], encrypted_ssn?: string, ethnicity?: string, first_name?: string, gender?: 'female' | 'male' | 'other' | 'decline_to_specify', last_name?: string, middle_name?: string, phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[], preferred_name?: string, residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }, ssn?: string): { id?: string; dob?: string; emails?: object[]; encrypted_ssn?: string; ethnicity?: string; first_name?: string; gender?: 'female' | 'male' | 'other' | 'decline_to_specify'; last_name?: string; middle_name?: string; phone_numbers?: object[]; preferred_name?: string; residence?: location; ssn?: string; }`\n\n**put** `/sandbox/individual/{individual_id}`\n\nUpdate sandbox individual\n\n### Parameters\n\n- `individual_id: string`\n\n- `dob?: string`\n\n- `emails?: { data?: string; type?: 'work' | 'personal'; }[]`\n\n- `encrypted_ssn?: string`\n Social Security Number of the individual in **encrypted** format. This field is only available with the `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the body.\n\n- `ethnicity?: string`\n The EEOC-defined ethnicity of the individual.\n\n- `first_name?: string`\n The legal first name of the individual.\n\n- `gender?: 'female' | 'male' | 'other' | 'decline_to_specify'`\n The gender of the individual.\n\n- `last_name?: string`\n The legal last name of the individual.\n\n- `middle_name?: string`\n The legal middle name of the individual.\n\n- `phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]`\n\n- `preferred_name?: string`\n The preferred name of the individual.\n\n- `residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }`\n - `city: string`\n City, district, suburb, town, or village.\n - `country: string`\n The 2-letter ISO 3166 country code.\n - `line1: string`\n Street address or PO box.\n - `line2: string`\n Apartment, suite, unit, or building.\n - `postal_code: string`\n The postal code or zip code.\n - `state: string`\n The state code.\n - `name?: string`\n - `source_id?: string`\n\n- `ssn?: string`\n Social Security Number of the individual. This field is only available with the `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the body. [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).\n\n### Returns\n\n- `{ id?: string; dob?: string; emails?: { data?: string; type?: 'work' | 'personal'; }[]; encrypted_ssn?: string; ethnicity?: string; first_name?: string; gender?: 'female' | 'male' | 'other' | 'decline_to_specify'; last_name?: string; middle_name?: string; phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]; preferred_name?: string; residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; ssn?: string; }`\n\n - `id?: string`\n - `dob?: string`\n - `emails?: { data?: string; type?: 'work' | 'personal'; }[]`\n - `encrypted_ssn?: string`\n - `ethnicity?: string`\n - `first_name?: string`\n - `gender?: 'female' | 'male' | 'other' | 'decline_to_specify'`\n - `last_name?: string`\n - `middle_name?: string`\n - `phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]`\n - `preferred_name?: string`\n - `residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }`\n - `ssn?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst individual = await client.sandbox.individual.update('individual_id');\n\nconsole.log(individual);\n```", - "perLanguage": { - "typescript": { - "method": "client.sandbox.individual.update", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst individual = await client.sandbox.individual.update('individual_id');\n\nconsole.log(individual.id);" - }, - "python": { - "method": "sandbox.individual.update", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nindividual = client.sandbox.individual.update(\n individual_id=\"individual_id\",\n)\nprint(individual.id)" - }, - "java": { - "method": "sandbox().individual().update", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.IndividualUpdateResponse;\nimport com.tryfinch.api.models.SandboxIndividualUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n IndividualUpdateResponse individual = client.sandbox().individual().update(\"individual_id\");\n }\n}" - }, - "kotlin": { - "method": "sandbox().individual().update", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.IndividualUpdateResponse\nimport com.tryfinch.api.models.SandboxIndividualUpdateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val individual: IndividualUpdateResponse = client.sandbox().individual().update(\"individual_id\")\n}" - }, - "go": { - "method": "client.Sandbox.Individual.Update", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tindividual, err := client.Sandbox.Individual.Update(\n\t\tcontext.TODO(),\n\t\t\"individual_id\",\n\t\tfinchgo.SandboxIndividualUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", individual.ID)\n}\n" - }, - "ruby": { - "method": "sandbox.individual.update", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nindividual = finch.sandbox.individual.update(\"individual_id\")\n\nputs(individual)" - }, - "http": { - "example": "curl https://api.tryfinch.com/sandbox/individual/$INDIVIDUAL_ID \\\n -X PUT \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + response: + "{ id?: string; dob?: string; emails?: { data?: string; type?: 'work' | 'personal'; }[]; encrypted_ssn?: string; ethnicity?: string; first_name?: string; gender?: 'female' | 'male' | 'other' | 'decline_to_specify'; last_name?: string; middle_name?: string; phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]; preferred_name?: string; residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; ssn?: string; }", + markdown: + "## update\n\n`client.sandbox.individual.update(individual_id: string, dob?: string, emails?: { data?: string; type?: 'work' | 'personal'; }[], encrypted_ssn?: string, ethnicity?: string, first_name?: string, gender?: 'female' | 'male' | 'other' | 'decline_to_specify', last_name?: string, middle_name?: string, phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[], preferred_name?: string, residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }, ssn?: string): { id?: string; dob?: string; emails?: object[]; encrypted_ssn?: string; ethnicity?: string; first_name?: string; gender?: 'female' | 'male' | 'other' | 'decline_to_specify'; last_name?: string; middle_name?: string; phone_numbers?: object[]; preferred_name?: string; residence?: location; ssn?: string; }`\n\n**put** `/sandbox/individual/{individual_id}`\n\nUpdate sandbox individual\n\n### Parameters\n\n- `individual_id: string`\n\n- `dob?: string`\n\n- `emails?: { data?: string; type?: 'work' | 'personal'; }[]`\n\n- `encrypted_ssn?: string`\n Social Security Number of the individual in **encrypted** format. This field is only available with the `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the body.\n\n- `ethnicity?: string`\n The EEOC-defined ethnicity of the individual.\n\n- `first_name?: string`\n The legal first name of the individual.\n\n- `gender?: 'female' | 'male' | 'other' | 'decline_to_specify'`\n The gender of the individual.\n\n- `last_name?: string`\n The legal last name of the individual.\n\n- `middle_name?: string`\n The legal middle name of the individual.\n\n- `phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]`\n\n- `preferred_name?: string`\n The preferred name of the individual.\n\n- `residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }`\n - `city: string`\n City, district, suburb, town, or village.\n - `country: string`\n The 2-letter ISO 3166 country code.\n - `line1: string`\n Street address or PO box.\n - `line2: string`\n Apartment, suite, unit, or building.\n - `postal_code: string`\n The postal code or zip code.\n - `state: string`\n The state code.\n - `name?: string`\n - `source_id?: string`\n\n- `ssn?: string`\n Social Security Number of the individual. This field is only available with the `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the body. [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).\n\n### Returns\n\n- `{ id?: string; dob?: string; emails?: { data?: string; type?: 'work' | 'personal'; }[]; encrypted_ssn?: string; ethnicity?: string; first_name?: string; gender?: 'female' | 'male' | 'other' | 'decline_to_specify'; last_name?: string; middle_name?: string; phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]; preferred_name?: string; residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; ssn?: string; }`\n\n - `id?: string`\n - `dob?: string`\n - `emails?: { data?: string; type?: 'work' | 'personal'; }[]`\n - `encrypted_ssn?: string`\n - `ethnicity?: string`\n - `first_name?: string`\n - `gender?: 'female' | 'male' | 'other' | 'decline_to_specify'`\n - `last_name?: string`\n - `middle_name?: string`\n - `phone_numbers?: { data?: string; type?: 'work' | 'personal'; }[]`\n - `preferred_name?: string`\n - `residence?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }`\n - `ssn?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst individual = await client.sandbox.individual.update('individual_id');\n\nconsole.log(individual);\n```", + perLanguage: { + typescript: { + method: 'client.sandbox.individual.update', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst individual = await client.sandbox.individual.update('individual_id');\n\nconsole.log(individual.id);", + }, + python: { + method: 'sandbox.individual.update', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nindividual = client.sandbox.individual.update(\n individual_id="individual_id",\n)\nprint(individual.id)', + }, + java: { + method: 'sandbox().individual().update', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.IndividualUpdateResponse;\nimport com.tryfinch.api.models.SandboxIndividualUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n IndividualUpdateResponse individual = client.sandbox().individual().update("individual_id");\n }\n}', + }, + kotlin: { + method: 'sandbox().individual().update', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.IndividualUpdateResponse\nimport com.tryfinch.api.models.SandboxIndividualUpdateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val individual: IndividualUpdateResponse = client.sandbox().individual().update("individual_id")\n}', + }, + go: { + method: 'client.Sandbox.Individual.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tindividual, err := client.Sandbox.Individual.Update(\n\t\tcontext.TODO(),\n\t\t"individual_id",\n\t\tfinchgo.SandboxIndividualUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", individual.ID)\n}\n', + }, + ruby: { + method: 'sandbox.individual.update', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nindividual = finch.sandbox.individual.update("individual_id")\n\nputs(individual)', + }, + http: { + example: + 'curl https://api.tryfinch.com/sandbox/individual/$INDIVIDUAL_ID \\\n -X PUT \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "update", - "endpoint": "/sandbox/employment/{individual_id}", - "httpMethod": "put", - "summary": "Update sandbox employment", - "description": "Update sandbox employment", - "stainlessPath": "(resource) sandbox.employment > (method) update", - "qualified": "client.sandbox.employment.update", - "params": [ - "individual_id: string;", - "class_code?: string;", - "custom_fields?: { name?: string; value?: object; }[];", - "department?: { name?: string; };", + name: 'update', + endpoint: '/sandbox/employment/{individual_id}', + httpMethod: 'put', + summary: 'Update sandbox employment', + description: 'Update sandbox employment', + stainlessPath: '(resource) sandbox.employment > (method) update', + qualified: 'client.sandbox.employment.update', + params: [ + 'individual_id: string;', + 'class_code?: string;', + 'custom_fields?: { name?: string; value?: object; }[];', + 'department?: { name?: string; };', "employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; };", "employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated';", - "end_date?: string;", - "first_name?: string;", + 'end_date?: string;', + 'first_name?: string;', "flsa_status?: 'exempt' | 'non_exempt' | 'unknown';", - "income?: { amount: number; currency: string; effective_date: string; unit: string; };", - "income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[];", - "is_active?: boolean;", - "last_name?: string;", - "latest_rehire_date?: string;", - "location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; };", - "manager?: { id?: string; };", - "middle_name?: string;", - "source_id?: string;", - "start_date?: string;", - "title?: string;" + 'income?: { amount: number; currency: string; effective_date: string; unit: string; };', + 'income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[];', + 'is_active?: boolean;', + 'last_name?: string;', + 'latest_rehire_date?: string;', + 'location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; };', + 'manager?: { id?: string; };', + 'middle_name?: string;', + 'source_id?: string;', + 'start_date?: string;', + 'title?: string;', ], - "response": "{ id?: string; class_code?: string; custom_fields?: { name?: string; value?: object; }[]; department?: { name?: string; }; employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }; employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; end_date?: string; first_name?: string; flsa_status?: 'exempt' | 'non_exempt' | 'unknown'; income?: { amount: number; currency: string; effective_date: string; unit: string; }; income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]; is_active?: boolean; last_name?: string; latest_rehire_date?: string; location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; manager?: { id?: string; }; middle_name?: string; source_id?: string; start_date?: string; title?: string; }", - "markdown": "## update\n\n`client.sandbox.employment.update(individual_id: string, class_code?: string, custom_fields?: { name?: string; value?: object; }[], department?: { name?: string; }, employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }, employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated', end_date?: string, first_name?: string, flsa_status?: 'exempt' | 'non_exempt' | 'unknown', income?: { amount: number; currency: string; effective_date: string; unit: string; }, income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[], is_active?: boolean, last_name?: string, latest_rehire_date?: string, location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }, manager?: { id?: string; }, middle_name?: string, source_id?: string, start_date?: string, title?: string): { id?: string; class_code?: string; custom_fields?: object[]; department?: object; employment?: object; employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; end_date?: string; first_name?: string; flsa_status?: 'exempt' | 'non_exempt' | 'unknown'; income?: income; income_history?: income[]; is_active?: boolean; last_name?: string; latest_rehire_date?: string; location?: location; manager?: object; middle_name?: string; source_id?: string; start_date?: string; title?: string; }`\n\n**put** `/sandbox/employment/{individual_id}`\n\nUpdate sandbox employment\n\n### Parameters\n\n- `individual_id: string`\n\n- `class_code?: string`\n Worker's compensation classification code for this employee\n\n- `custom_fields?: { name?: string; value?: object; }[]`\n Custom fields for the individual. These are fields which are defined by the employer in the system. Custom fields are not currently supported for assisted connections.\n\n- `department?: { name?: string; }`\n The department object.\n - `name?: string`\n The name of the department associated with the individual.\n\n- `employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }`\n The employment object.\n - `subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'`\n The secondary employment type of the individual. Options: `full_time`, `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.\n - `type?: 'employee' | 'contractor'`\n The main employment type of the individual.\n\n- `employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'`\n The detailed employment status of the individual.\n\n- `end_date?: string`\n\n- `first_name?: string`\n The legal first name of the individual.\n\n- `flsa_status?: 'exempt' | 'non_exempt' | 'unknown'`\n The FLSA status of the individual. Available options: `exempt`, `non_exempt`, `unknown`.\n\n- `income?: { amount: number; currency: string; effective_date: string; unit: string; }`\n The employee's income as reported by the provider. This may not always be annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, depending on what information the provider returns.\n - `amount: number`\n The income amount in cents.\n - `currency: string`\n The currency code.\n - `effective_date: string`\n The date the income amount went into effect.\n - `unit: string`\n The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`.\n\n- `income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]`\n The array of income history.\n\n- `is_active?: boolean`\n `true` if the individual an an active employee or contractor at the company.\n\n- `last_name?: string`\n The legal last name of the individual.\n\n- `latest_rehire_date?: string`\n\n- `location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }`\n - `city: string`\n City, district, suburb, town, or village.\n - `country: string`\n The 2-letter ISO 3166 country code.\n - `line1: string`\n Street address or PO box.\n - `line2: string`\n Apartment, suite, unit, or building.\n - `postal_code: string`\n The postal code or zip code.\n - `state: string`\n The state code.\n - `name?: string`\n - `source_id?: string`\n\n- `manager?: { id?: string; }`\n The manager object representing the manager of the individual within the org.\n - `id?: string`\n A stable Finch `id` (UUID v4) for an individual in the company.\n\n- `middle_name?: string`\n The legal middle name of the individual.\n\n- `source_id?: string`\n The source system's unique employment identifier for this individual\n\n- `start_date?: string`\n\n- `title?: string`\n The current title of the individual.\n\n### Returns\n\n- `{ id?: string; class_code?: string; custom_fields?: { name?: string; value?: object; }[]; department?: { name?: string; }; employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }; employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; end_date?: string; first_name?: string; flsa_status?: 'exempt' | 'non_exempt' | 'unknown'; income?: { amount: number; currency: string; effective_date: string; unit: string; }; income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]; is_active?: boolean; last_name?: string; latest_rehire_date?: string; location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; manager?: { id?: string; }; middle_name?: string; source_id?: string; start_date?: string; title?: string; }`\n\n - `id?: string`\n - `class_code?: string`\n - `custom_fields?: { name?: string; value?: object; }[]`\n - `department?: { name?: string; }`\n - `employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }`\n - `employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'`\n - `end_date?: string`\n - `first_name?: string`\n - `flsa_status?: 'exempt' | 'non_exempt' | 'unknown'`\n - `income?: { amount: number; currency: string; effective_date: string; unit: string; }`\n - `income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]`\n - `is_active?: boolean`\n - `last_name?: string`\n - `latest_rehire_date?: string`\n - `location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }`\n - `manager?: { id?: string; }`\n - `middle_name?: string`\n - `source_id?: string`\n - `start_date?: string`\n - `title?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst employment = await client.sandbox.employment.update('individual_id');\n\nconsole.log(employment);\n```", - "perLanguage": { - "typescript": { - "method": "client.sandbox.employment.update", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst employment = await client.sandbox.employment.update('individual_id');\n\nconsole.log(employment.id);" - }, - "python": { - "method": "sandbox.employment.update", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nemployment = client.sandbox.employment.update(\n individual_id=\"individual_id\",\n)\nprint(employment.id)" - }, - "java": { - "method": "sandbox().employment().update", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.EmploymentUpdateResponse;\nimport com.tryfinch.api.models.SandboxEmploymentUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n EmploymentUpdateResponse employment = client.sandbox().employment().update(\"individual_id\");\n }\n}" - }, - "kotlin": { - "method": "sandbox().employment().update", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.EmploymentUpdateResponse\nimport com.tryfinch.api.models.SandboxEmploymentUpdateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val employment: EmploymentUpdateResponse = client.sandbox().employment().update(\"individual_id\")\n}" - }, - "go": { - "method": "client.Sandbox.Employment.Update", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\temployment, err := client.Sandbox.Employment.Update(\n\t\tcontext.TODO(),\n\t\t\"individual_id\",\n\t\tfinchgo.SandboxEmploymentUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", employment.ID)\n}\n" - }, - "ruby": { - "method": "sandbox.employment.update", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nemployment = finch.sandbox.employment.update(\"individual_id\")\n\nputs(employment)" - }, - "http": { - "example": "curl https://api.tryfinch.com/sandbox/employment/$INDIVIDUAL_ID \\\n -X PUT \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + response: + "{ id?: string; class_code?: string; custom_fields?: { name?: string; value?: object; }[]; department?: { name?: string; }; employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }; employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; end_date?: string; first_name?: string; flsa_status?: 'exempt' | 'non_exempt' | 'unknown'; income?: { amount: number; currency: string; effective_date: string; unit: string; }; income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]; is_active?: boolean; last_name?: string; latest_rehire_date?: string; location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; manager?: { id?: string; }; middle_name?: string; source_id?: string; start_date?: string; title?: string; }", + markdown: + "## update\n\n`client.sandbox.employment.update(individual_id: string, class_code?: string, custom_fields?: { name?: string; value?: object; }[], department?: { name?: string; }, employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }, employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated', end_date?: string, first_name?: string, flsa_status?: 'exempt' | 'non_exempt' | 'unknown', income?: { amount: number; currency: string; effective_date: string; unit: string; }, income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[], is_active?: boolean, last_name?: string, latest_rehire_date?: string, location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }, manager?: { id?: string; }, middle_name?: string, source_id?: string, start_date?: string, title?: string): { id?: string; class_code?: string; custom_fields?: object[]; department?: object; employment?: object; employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; end_date?: string; first_name?: string; flsa_status?: 'exempt' | 'non_exempt' | 'unknown'; income?: income; income_history?: income[]; is_active?: boolean; last_name?: string; latest_rehire_date?: string; location?: location; manager?: object; middle_name?: string; source_id?: string; start_date?: string; title?: string; }`\n\n**put** `/sandbox/employment/{individual_id}`\n\nUpdate sandbox employment\n\n### Parameters\n\n- `individual_id: string`\n\n- `class_code?: string`\n Worker's compensation classification code for this employee\n\n- `custom_fields?: { name?: string; value?: object; }[]`\n Custom fields for the individual. These are fields which are defined by the employer in the system. Custom fields are not currently supported for assisted connections.\n\n- `department?: { name?: string; }`\n The department object.\n - `name?: string`\n The name of the department associated with the individual.\n\n- `employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }`\n The employment object.\n - `subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'`\n The secondary employment type of the individual. Options: `full_time`, `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.\n - `type?: 'employee' | 'contractor'`\n The main employment type of the individual.\n\n- `employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'`\n The detailed employment status of the individual.\n\n- `end_date?: string`\n\n- `first_name?: string`\n The legal first name of the individual.\n\n- `flsa_status?: 'exempt' | 'non_exempt' | 'unknown'`\n The FLSA status of the individual. Available options: `exempt`, `non_exempt`, `unknown`.\n\n- `income?: { amount: number; currency: string; effective_date: string; unit: string; }`\n The employee's income as reported by the provider. This may not always be annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, depending on what information the provider returns.\n - `amount: number`\n The income amount in cents.\n - `currency: string`\n The currency code.\n - `effective_date: string`\n The date the income amount went into effect.\n - `unit: string`\n The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`.\n\n- `income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]`\n The array of income history.\n\n- `is_active?: boolean`\n `true` if the individual an an active employee or contractor at the company.\n\n- `last_name?: string`\n The legal last name of the individual.\n\n- `latest_rehire_date?: string`\n\n- `location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }`\n - `city: string`\n City, district, suburb, town, or village.\n - `country: string`\n The 2-letter ISO 3166 country code.\n - `line1: string`\n Street address or PO box.\n - `line2: string`\n Apartment, suite, unit, or building.\n - `postal_code: string`\n The postal code or zip code.\n - `state: string`\n The state code.\n - `name?: string`\n - `source_id?: string`\n\n- `manager?: { id?: string; }`\n The manager object representing the manager of the individual within the org.\n - `id?: string`\n A stable Finch `id` (UUID v4) for an individual in the company.\n\n- `middle_name?: string`\n The legal middle name of the individual.\n\n- `source_id?: string`\n The source system's unique employment identifier for this individual\n\n- `start_date?: string`\n\n- `title?: string`\n The current title of the individual.\n\n### Returns\n\n- `{ id?: string; class_code?: string; custom_fields?: { name?: string; value?: object; }[]; department?: { name?: string; }; employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }; employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'; end_date?: string; first_name?: string; flsa_status?: 'exempt' | 'non_exempt' | 'unknown'; income?: { amount: number; currency: string; effective_date: string; unit: string; }; income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]; is_active?: boolean; last_name?: string; latest_rehire_date?: string; location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }; manager?: { id?: string; }; middle_name?: string; source_id?: string; start_date?: string; title?: string; }`\n\n - `id?: string`\n - `class_code?: string`\n - `custom_fields?: { name?: string; value?: object; }[]`\n - `department?: { name?: string; }`\n - `employment?: { subtype?: 'full_time' | 'intern' | 'part_time' | 'temp' | 'seasonal' | 'individual_contractor'; type?: 'employee' | 'contractor'; }`\n - `employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated'`\n - `end_date?: string`\n - `first_name?: string`\n - `flsa_status?: 'exempt' | 'non_exempt' | 'unknown'`\n - `income?: { amount: number; currency: string; effective_date: string; unit: string; }`\n - `income_history?: { amount: number; currency: string; effective_date: string; unit: string; }[]`\n - `is_active?: boolean`\n - `last_name?: string`\n - `latest_rehire_date?: string`\n - `location?: { city: string; country: string; line1: string; line2: string; postal_code: string; state: string; name?: string; source_id?: string; }`\n - `manager?: { id?: string; }`\n - `middle_name?: string`\n - `source_id?: string`\n - `start_date?: string`\n - `title?: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst employment = await client.sandbox.employment.update('individual_id');\n\nconsole.log(employment);\n```", + perLanguage: { + typescript: { + method: 'client.sandbox.employment.update', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst employment = await client.sandbox.employment.update('individual_id');\n\nconsole.log(employment.id);", + }, + python: { + method: 'sandbox.employment.update', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nemployment = client.sandbox.employment.update(\n individual_id="individual_id",\n)\nprint(employment.id)', + }, + java: { + method: 'sandbox().employment().update', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.EmploymentUpdateResponse;\nimport com.tryfinch.api.models.SandboxEmploymentUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n EmploymentUpdateResponse employment = client.sandbox().employment().update("individual_id");\n }\n}', + }, + kotlin: { + method: 'sandbox().employment().update', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.EmploymentUpdateResponse\nimport com.tryfinch.api.models.SandboxEmploymentUpdateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val employment: EmploymentUpdateResponse = client.sandbox().employment().update("individual_id")\n}', + }, + go: { + method: 'client.Sandbox.Employment.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\temployment, err := client.Sandbox.Employment.Update(\n\t\tcontext.TODO(),\n\t\t"individual_id",\n\t\tfinchgo.SandboxEmploymentUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", employment.ID)\n}\n', + }, + ruby: { + method: 'sandbox.employment.update', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nemployment = finch.sandbox.employment.update("individual_id")\n\nputs(employment)', + }, + http: { + example: + 'curl https://api.tryfinch.com/sandbox/employment/$INDIVIDUAL_ID \\\n -X PUT \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "create", - "endpoint": "/sandbox/payment", - "httpMethod": "post", - "summary": "Add a new sandbox payment", - "description": "Add a new sandbox payment", - "stainlessPath": "(resource) sandbox.payment > (method) create", - "qualified": "client.sandbox.payment.create", - "params": [ - "end_date?: string;", + name: 'create', + endpoint: '/sandbox/payment', + httpMethod: 'post', + summary: 'Add a new sandbox payment', + description: 'Add a new sandbox payment', + stainlessPath: '(resource) sandbox.payment > (method) create', + qualified: 'client.sandbox.payment.create', + params: [ + 'end_date?: string;', "pay_statements?: { individual_id: string; earnings?: { amount?: number; hours?: number; name?: string; type?: string; }[]; employee_deductions?: { amount?: number; name?: string; pre_tax?: boolean; type?: string; }[]; employer_contributions?: { amount?: number; name?: string; type?: string; }[]; gross_pay?: number; net_pay?: number; payment_method?: 'check' | 'direct_deposit' | 'other'; taxes?: { amount?: number; employer?: boolean; name?: string; type?: 'federal' | 'fica' | 'local' | 'state'; }[]; total_hours?: number; type?: 'off_cycle_payroll' | 'one_time_payment' | 'regular_payroll'; }[];", - "start_date?: string;" + 'start_date?: string;', ], - "response": "{ pay_date: string; payment_id: string; }", - "markdown": "## create\n\n`client.sandbox.payment.create(end_date?: string, pay_statements?: { individual_id: string; earnings?: { amount?: number; hours?: number; name?: string; type?: string; }[]; employee_deductions?: { amount?: number; name?: string; pre_tax?: boolean; type?: string; }[]; employer_contributions?: { amount?: number; name?: string; type?: string; }[]; gross_pay?: number; net_pay?: number; payment_method?: 'check' | 'direct_deposit' | 'other'; taxes?: { amount?: number; employer?: boolean; name?: string; type?: 'federal' | 'fica' | 'local' | 'state'; }[]; total_hours?: number; type?: 'off_cycle_payroll' | 'one_time_payment' | 'regular_payroll'; }[], start_date?: string): { pay_date: string; payment_id: string; }`\n\n**post** `/sandbox/payment`\n\nAdd a new sandbox payment\n\n### Parameters\n\n- `end_date?: string`\n\n- `pay_statements?: { individual_id: string; earnings?: { amount?: number; hours?: number; name?: string; type?: string; }[]; employee_deductions?: { amount?: number; name?: string; pre_tax?: boolean; type?: string; }[]; employer_contributions?: { amount?: number; name?: string; type?: string; }[]; gross_pay?: number; net_pay?: number; payment_method?: 'check' | 'direct_deposit' | 'other'; taxes?: { amount?: number; employer?: boolean; name?: string; type?: 'federal' | 'fica' | 'local' | 'state'; }[]; total_hours?: number; type?: 'off_cycle_payroll' | 'one_time_payment' | 'regular_payroll'; }[]`\n Array of pay statements to include in the payment.\n\n- `start_date?: string`\n\n### Returns\n\n- `{ pay_date: string; payment_id: string; }`\n\n - `pay_date: string`\n - `payment_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst payment = await client.sandbox.payment.create();\n\nconsole.log(payment);\n```", - "perLanguage": { - "typescript": { - "method": "client.sandbox.payment.create", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst payment = await client.sandbox.payment.create();\n\nconsole.log(payment.payment_id);" - }, - "python": { - "method": "sandbox.payment.create", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\npayment = client.sandbox.payment.create()\nprint(payment.payment_id)" - }, - "java": { - "method": "sandbox().payment().create", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.PaymentCreateResponse;\nimport com.tryfinch.api.models.SandboxPaymentCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n PaymentCreateResponse payment = client.sandbox().payment().create();\n }\n}" - }, - "kotlin": { - "method": "sandbox().payment().create", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.PaymentCreateResponse\nimport com.tryfinch.api.models.SandboxPaymentCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val payment: PaymentCreateResponse = client.sandbox().payment().create()\n}" - }, - "go": { - "method": "client.Sandbox.Payment.New", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tpayment, err := client.Sandbox.Payment.New(context.TODO(), finchgo.SandboxPaymentNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", payment.PaymentID)\n}\n" - }, - "ruby": { - "method": "sandbox.payment.create", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\npayment = finch.sandbox.payment.create\n\nputs(payment)" - }, - "http": { - "example": "curl https://api.tryfinch.com/sandbox/payment \\\n -X POST \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + response: '{ pay_date: string; payment_id: string; }', + markdown: + "## create\n\n`client.sandbox.payment.create(end_date?: string, pay_statements?: { individual_id: string; earnings?: { amount?: number; hours?: number; name?: string; type?: string; }[]; employee_deductions?: { amount?: number; name?: string; pre_tax?: boolean; type?: string; }[]; employer_contributions?: { amount?: number; name?: string; type?: string; }[]; gross_pay?: number; net_pay?: number; payment_method?: 'check' | 'direct_deposit' | 'other'; taxes?: { amount?: number; employer?: boolean; name?: string; type?: 'federal' | 'fica' | 'local' | 'state'; }[]; total_hours?: number; type?: 'off_cycle_payroll' | 'one_time_payment' | 'regular_payroll'; }[], start_date?: string): { pay_date: string; payment_id: string; }`\n\n**post** `/sandbox/payment`\n\nAdd a new sandbox payment\n\n### Parameters\n\n- `end_date?: string`\n\n- `pay_statements?: { individual_id: string; earnings?: { amount?: number; hours?: number; name?: string; type?: string; }[]; employee_deductions?: { amount?: number; name?: string; pre_tax?: boolean; type?: string; }[]; employer_contributions?: { amount?: number; name?: string; type?: string; }[]; gross_pay?: number; net_pay?: number; payment_method?: 'check' | 'direct_deposit' | 'other'; taxes?: { amount?: number; employer?: boolean; name?: string; type?: 'federal' | 'fica' | 'local' | 'state'; }[]; total_hours?: number; type?: 'off_cycle_payroll' | 'one_time_payment' | 'regular_payroll'; }[]`\n Array of pay statements to include in the payment.\n\n- `start_date?: string`\n\n### Returns\n\n- `{ pay_date: string; payment_id: string; }`\n\n - `pay_date: string`\n - `payment_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst payment = await client.sandbox.payment.create();\n\nconsole.log(payment);\n```", + perLanguage: { + typescript: { + method: 'client.sandbox.payment.create', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst payment = await client.sandbox.payment.create();\n\nconsole.log(payment.payment_id);", + }, + python: { + method: 'sandbox.payment.create', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npayment = client.sandbox.payment.create()\nprint(payment.payment_id)', + }, + java: { + method: 'sandbox().payment().create', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.PaymentCreateResponse;\nimport com.tryfinch.api.models.SandboxPaymentCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PaymentCreateResponse payment = client.sandbox().payment().create();\n }\n}', + }, + kotlin: { + method: 'sandbox().payment().create', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.PaymentCreateResponse\nimport com.tryfinch.api.models.SandboxPaymentCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val payment: PaymentCreateResponse = client.sandbox().payment().create()\n}', + }, + go: { + method: 'client.Sandbox.Payment.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpayment, err := client.Sandbox.Payment.New(context.TODO(), finchgo.SandboxPaymentNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", payment.PaymentID)\n}\n', + }, + ruby: { + method: 'sandbox.payment.create', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npayment = finch.sandbox.payment.create\n\nputs(payment)', + }, + http: { + example: + 'curl https://api.tryfinch.com/sandbox/payment \\\n -X POST \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "create", - "endpoint": "/sandbox/jobs", - "httpMethod": "post", - "summary": "Enqueue a new sandbox job", - "description": "Enqueue a new sandbox job", - "stainlessPath": "(resource) sandbox.jobs > (method) create", - "qualified": "client.sandbox.jobs.create", - "params": [ - "type: 'data_sync_all';" - ], - "response": "{ allowed_refreshes: number; job_id: string; job_url: string; remaining_refreshes: number; }", - "markdown": "## create\n\n`client.sandbox.jobs.create(type: 'data_sync_all'): { allowed_refreshes: number; job_id: string; job_url: string; remaining_refreshes: number; }`\n\n**post** `/sandbox/jobs`\n\nEnqueue a new sandbox job\n\n### Parameters\n\n- `type: 'data_sync_all'`\n The type of job to start. Currently the only supported type is `data_sync_all`\n\n### Returns\n\n- `{ allowed_refreshes: number; job_id: string; job_url: string; remaining_refreshes: number; }`\n\n - `allowed_refreshes: number`\n - `job_id: string`\n - `job_url: string`\n - `remaining_refreshes: number`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst job = await client.sandbox.jobs.create({ type: 'data_sync_all' });\n\nconsole.log(job);\n```", - "perLanguage": { - "typescript": { - "method": "client.sandbox.jobs.create", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst job = await client.sandbox.jobs.create({ type: 'data_sync_all' });\n\nconsole.log(job.job_id);" - }, - "python": { - "method": "sandbox.jobs.create", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\njob = client.sandbox.jobs.create(\n type=\"data_sync_all\",\n)\nprint(job.job_id)" - }, - "java": { - "method": "sandbox().jobs().create", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.JobCreateResponse;\nimport com.tryfinch.api.models.SandboxJobCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n SandboxJobCreateParams params = SandboxJobCreateParams.builder()\n .type(SandboxJobCreateParams.Type.DATA_SYNC_ALL)\n .build();\n JobCreateResponse job = client.sandbox().jobs().create(params);\n }\n}" - }, - "kotlin": { - "method": "sandbox().jobs().create", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.JobCreateResponse\nimport com.tryfinch.api.models.SandboxJobCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val params: SandboxJobCreateParams = SandboxJobCreateParams.builder()\n .type(SandboxJobCreateParams.Type.DATA_SYNC_ALL)\n .build()\n val job: JobCreateResponse = client.sandbox().jobs().create(params)\n}" - }, - "go": { - "method": "client.Sandbox.Jobs.New", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tjob, err := client.Sandbox.Jobs.New(context.TODO(), finchgo.SandboxJobNewParams{\n\t\tType: finchgo.F(finchgo.SandboxJobNewParamsTypeDataSyncAll),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", job.JobID)\n}\n" - }, - "ruby": { - "method": "sandbox.jobs.create", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\njob = finch.sandbox.jobs.create(type: :data_sync_all)\n\nputs(job)" - }, - "http": { - "example": "curl https://api.tryfinch.com/sandbox/jobs \\\n -H 'Content-Type: application/json' \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{\n \"type\": \"data_sync_all\"\n }'" - } - } + name: 'create', + endpoint: '/sandbox/jobs', + httpMethod: 'post', + summary: 'Enqueue a new sandbox job', + description: 'Enqueue a new sandbox job', + stainlessPath: '(resource) sandbox.jobs > (method) create', + qualified: 'client.sandbox.jobs.create', + params: ["type: 'data_sync_all';"], + response: '{ allowed_refreshes: number; job_id: string; job_url: string; remaining_refreshes: number; }', + markdown: + "## create\n\n`client.sandbox.jobs.create(type: 'data_sync_all'): { allowed_refreshes: number; job_id: string; job_url: string; remaining_refreshes: number; }`\n\n**post** `/sandbox/jobs`\n\nEnqueue a new sandbox job\n\n### Parameters\n\n- `type: 'data_sync_all'`\n The type of job to start. Currently the only supported type is `data_sync_all`\n\n### Returns\n\n- `{ allowed_refreshes: number; job_id: string; job_url: string; remaining_refreshes: number; }`\n\n - `allowed_refreshes: number`\n - `job_id: string`\n - `job_url: string`\n - `remaining_refreshes: number`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst job = await client.sandbox.jobs.create({ type: 'data_sync_all' });\n\nconsole.log(job);\n```", + perLanguage: { + typescript: { + method: 'client.sandbox.jobs.create', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst job = await client.sandbox.jobs.create({ type: 'data_sync_all' });\n\nconsole.log(job.job_id);", + }, + python: { + method: 'sandbox.jobs.create', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\njob = client.sandbox.jobs.create(\n type="data_sync_all",\n)\nprint(job.job_id)', + }, + java: { + method: 'sandbox().jobs().create', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.JobCreateResponse;\nimport com.tryfinch.api.models.SandboxJobCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SandboxJobCreateParams params = SandboxJobCreateParams.builder()\n .type(SandboxJobCreateParams.Type.DATA_SYNC_ALL)\n .build();\n JobCreateResponse job = client.sandbox().jobs().create(params);\n }\n}', + }, + kotlin: { + method: 'sandbox().jobs().create', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.JobCreateResponse\nimport com.tryfinch.api.models.SandboxJobCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val params: SandboxJobCreateParams = SandboxJobCreateParams.builder()\n .type(SandboxJobCreateParams.Type.DATA_SYNC_ALL)\n .build()\n val job: JobCreateResponse = client.sandbox().jobs().create(params)\n}', + }, + go: { + method: 'client.Sandbox.Jobs.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tjob, err := client.Sandbox.Jobs.New(context.TODO(), finchgo.SandboxJobNewParams{\n\t\tType: finchgo.F(finchgo.SandboxJobNewParamsTypeDataSyncAll),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", job.JobID)\n}\n', + }, + ruby: { + method: 'sandbox.jobs.create', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\njob = finch.sandbox.jobs.create(type: :data_sync_all)\n\nputs(job)', + }, + http: { + example: + 'curl https://api.tryfinch.com/sandbox/jobs \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "type": "data_sync_all"\n }\'', + }, + }, }, { - "name": "retrieve", - "endpoint": "/sandbox/jobs/configuration", - "httpMethod": "get", - "summary": "Get configurations for sandbox jobs", - "description": "Get configurations for sandbox jobs", - "stainlessPath": "(resource) sandbox.jobs.configuration > (method) retrieve", - "qualified": "client.sandbox.jobs.configuration.retrieve", - "response": "{ completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'; type: 'data_sync_all'; }[]", - "markdown": "## retrieve\n\n`client.sandbox.jobs.configuration.retrieve(): object[]`\n\n**get** `/sandbox/jobs/configuration`\n\nGet configurations for sandbox jobs\n\n### Returns\n\n- `{ completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'; type: 'data_sync_all'; }[]`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst sandboxJobConfigurations = await client.sandbox.jobs.configuration.retrieve();\n\nconsole.log(sandboxJobConfigurations);\n```", - "perLanguage": { - "typescript": { - "method": "client.sandbox.jobs.configuration.retrieve", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst sandboxJobConfigurations = await client.sandbox.jobs.configuration.retrieve();\n\nconsole.log(sandboxJobConfigurations);" - }, - "python": { - "method": "sandbox.jobs.configuration.retrieve", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nsandbox_job_configurations = client.sandbox.jobs.configuration.retrieve()\nprint(sandbox_job_configurations)" - }, - "java": { - "method": "sandbox().jobs().configuration().retrieve", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.SandboxJobConfiguration;\nimport com.tryfinch.api.models.SandboxJobConfigurationRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n List sandboxJobConfigurations = client.sandbox().jobs().configuration().retrieve();\n }\n}" - }, - "kotlin": { - "method": "sandbox().jobs().configuration().retrieve", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.SandboxJobConfiguration\nimport com.tryfinch.api.models.SandboxJobConfigurationRetrieveParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val sandboxJobConfigurations: List = client.sandbox().jobs().configuration().retrieve()\n}" - }, - "go": { - "method": "client.Sandbox.Jobs.Configuration.Get", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tsandboxJobConfigurations, err := client.Sandbox.Jobs.Configuration.Get(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", sandboxJobConfigurations)\n}\n" - }, - "ruby": { - "method": "sandbox.jobs.configuration.retrieve", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nsandbox_job_configurations = finch.sandbox.jobs.configuration.retrieve\n\nputs(sandbox_job_configurations)" - }, - "http": { - "example": "curl https://api.tryfinch.com/sandbox/jobs/configuration \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + name: 'retrieve', + endpoint: '/sandbox/jobs/configuration', + httpMethod: 'get', + summary: 'Get configurations for sandbox jobs', + description: 'Get configurations for sandbox jobs', + stainlessPath: '(resource) sandbox.jobs.configuration > (method) retrieve', + qualified: 'client.sandbox.jobs.configuration.retrieve', + response: + "{ completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'; type: 'data_sync_all'; }[]", + markdown: + "## retrieve\n\n`client.sandbox.jobs.configuration.retrieve(): object[]`\n\n**get** `/sandbox/jobs/configuration`\n\nGet configurations for sandbox jobs\n\n### Returns\n\n- `{ completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'; type: 'data_sync_all'; }[]`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst sandboxJobConfigurations = await client.sandbox.jobs.configuration.retrieve();\n\nconsole.log(sandboxJobConfigurations);\n```", + perLanguage: { + typescript: { + method: 'client.sandbox.jobs.configuration.retrieve', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst sandboxJobConfigurations = await client.sandbox.jobs.configuration.retrieve();\n\nconsole.log(sandboxJobConfigurations);", + }, + python: { + method: 'sandbox.jobs.configuration.retrieve', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nsandbox_job_configurations = client.sandbox.jobs.configuration.retrieve()\nprint(sandbox_job_configurations)', + }, + java: { + method: 'sandbox().jobs().configuration().retrieve', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.SandboxJobConfiguration;\nimport com.tryfinch.api.models.SandboxJobConfigurationRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n List sandboxJobConfigurations = client.sandbox().jobs().configuration().retrieve();\n }\n}', + }, + kotlin: { + method: 'sandbox().jobs().configuration().retrieve', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.SandboxJobConfiguration\nimport com.tryfinch.api.models.SandboxJobConfigurationRetrieveParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val sandboxJobConfigurations: List = client.sandbox().jobs().configuration().retrieve()\n}', + }, + go: { + method: 'client.Sandbox.Jobs.Configuration.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsandboxJobConfigurations, err := client.Sandbox.Jobs.Configuration.Get(context.TODO())\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", sandboxJobConfigurations)\n}\n', + }, + ruby: { + method: 'sandbox.jobs.configuration.retrieve', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nsandbox_job_configurations = finch.sandbox.jobs.configuration.retrieve\n\nputs(sandbox_job_configurations)', + }, + http: { + example: + 'curl https://api.tryfinch.com/sandbox/jobs/configuration \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "update", - "endpoint": "/sandbox/jobs/configuration", - "httpMethod": "put", - "summary": "Update configurations for sandbox jobs", - "description": "Update configurations for sandbox jobs", - "stainlessPath": "(resource) sandbox.jobs.configuration > (method) update", - "qualified": "client.sandbox.jobs.configuration.update", - "params": [ + name: 'update', + endpoint: '/sandbox/jobs/configuration', + httpMethod: 'put', + summary: 'Update configurations for sandbox jobs', + description: 'Update configurations for sandbox jobs', + stainlessPath: '(resource) sandbox.jobs.configuration > (method) update', + qualified: 'client.sandbox.jobs.configuration.update', + params: [ "completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error';", - "type: 'data_sync_all';" + "type: 'data_sync_all';", ], - "response": "{ completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'; type: 'data_sync_all'; }", - "markdown": "## update\n\n`client.sandbox.jobs.configuration.update(completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error', type: 'data_sync_all'): { completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'; type: 'data_sync_all'; }`\n\n**put** `/sandbox/jobs/configuration`\n\nUpdate configurations for sandbox jobs\n\n### Parameters\n\n- `completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'`\n\n- `type: 'data_sync_all'`\n\n### Returns\n\n- `{ completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'; type: 'data_sync_all'; }`\n\n - `completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'`\n - `type: 'data_sync_all'`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst sandboxJobConfiguration = await client.sandbox.jobs.configuration.update({ completion_status: 'complete', type: 'data_sync_all' });\n\nconsole.log(sandboxJobConfiguration);\n```", - "perLanguage": { - "typescript": { - "method": "client.sandbox.jobs.configuration.update", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst sandboxJobConfiguration = await client.sandbox.jobs.configuration.update({\n completion_status: 'complete',\n type: 'data_sync_all',\n});\n\nconsole.log(sandboxJobConfiguration.completion_status);" - }, - "python": { - "method": "sandbox.jobs.configuration.update", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nsandbox_job_configuration = client.sandbox.jobs.configuration.update(\n completion_status=\"complete\",\n type=\"data_sync_all\",\n)\nprint(sandbox_job_configuration.completion_status)" - }, - "java": { - "method": "sandbox().jobs().configuration().update", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.SandboxJobConfiguration;\nimport com.tryfinch.api.models.SandboxJobConfigurationUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n SandboxJobConfiguration params = SandboxJobConfiguration.builder()\n .completionStatus(SandboxJobConfiguration.CompletionStatus.COMPLETE)\n .type(SandboxJobConfiguration.Type.DATA_SYNC_ALL)\n .build();\n SandboxJobConfiguration sandboxJobConfiguration = client.sandbox().jobs().configuration().update(params);\n }\n}" - }, - "kotlin": { - "method": "sandbox().jobs().configuration().update", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.SandboxJobConfiguration\nimport com.tryfinch.api.models.SandboxJobConfigurationUpdateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val params: SandboxJobConfiguration = SandboxJobConfiguration.builder()\n .completionStatus(SandboxJobConfiguration.CompletionStatus.COMPLETE)\n .type(SandboxJobConfiguration.Type.DATA_SYNC_ALL)\n .build()\n val sandboxJobConfiguration: SandboxJobConfiguration = client.sandbox().jobs().configuration().update(params)\n}" - }, - "go": { - "method": "client.Sandbox.Jobs.Configuration.Update", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tsandboxJobConfiguration, err := client.Sandbox.Jobs.Configuration.Update(context.TODO(), finchgo.SandboxJobConfigurationUpdateParams{\n\t\tCompletionStatus: finchgo.F(finchgo.SandboxJobConfigurationUpdateParamsCompletionStatusComplete),\n\t\tType: finchgo.F(finchgo.SandboxJobConfigurationUpdateParamsTypeDataSyncAll),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", sandboxJobConfiguration.CompletionStatus)\n}\n" - }, - "ruby": { - "method": "sandbox.jobs.configuration.update", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nsandbox_job_configuration = finch.sandbox.jobs.configuration.update(completion_status: :complete, type: :data_sync_all)\n\nputs(sandbox_job_configuration)" - }, - "http": { - "example": "curl https://api.tryfinch.com/sandbox/jobs/configuration \\\n -X PUT \\\n -H 'Content-Type: application/json' \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\" \\\n -d '{\n \"completion_status\": \"complete\",\n \"type\": \"data_sync_all\"\n }'" - } - } + response: + "{ completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'; type: 'data_sync_all'; }", + markdown: + "## update\n\n`client.sandbox.jobs.configuration.update(completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error', type: 'data_sync_all'): { completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'; type: 'data_sync_all'; }`\n\n**put** `/sandbox/jobs/configuration`\n\nUpdate configurations for sandbox jobs\n\n### Parameters\n\n- `completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'`\n\n- `type: 'data_sync_all'`\n\n### Returns\n\n- `{ completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'; type: 'data_sync_all'; }`\n\n - `completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'`\n - `type: 'data_sync_all'`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst sandboxJobConfiguration = await client.sandbox.jobs.configuration.update({ completion_status: 'complete', type: 'data_sync_all' });\n\nconsole.log(sandboxJobConfiguration);\n```", + perLanguage: { + typescript: { + method: 'client.sandbox.jobs.configuration.update', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst sandboxJobConfiguration = await client.sandbox.jobs.configuration.update({\n completion_status: 'complete',\n type: 'data_sync_all',\n});\n\nconsole.log(sandboxJobConfiguration.completion_status);", + }, + python: { + method: 'sandbox.jobs.configuration.update', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\nsandbox_job_configuration = client.sandbox.jobs.configuration.update(\n completion_status="complete",\n type="data_sync_all",\n)\nprint(sandbox_job_configuration.completion_status)', + }, + java: { + method: 'sandbox().jobs().configuration().update', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.SandboxJobConfiguration;\nimport com.tryfinch.api.models.SandboxJobConfigurationUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SandboxJobConfiguration params = SandboxJobConfiguration.builder()\n .completionStatus(SandboxJobConfiguration.CompletionStatus.COMPLETE)\n .type(SandboxJobConfiguration.Type.DATA_SYNC_ALL)\n .build();\n SandboxJobConfiguration sandboxJobConfiguration = client.sandbox().jobs().configuration().update(params);\n }\n}', + }, + kotlin: { + method: 'sandbox().jobs().configuration().update', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.SandboxJobConfiguration\nimport com.tryfinch.api.models.SandboxJobConfigurationUpdateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val params: SandboxJobConfiguration = SandboxJobConfiguration.builder()\n .completionStatus(SandboxJobConfiguration.CompletionStatus.COMPLETE)\n .type(SandboxJobConfiguration.Type.DATA_SYNC_ALL)\n .build()\n val sandboxJobConfiguration: SandboxJobConfiguration = client.sandbox().jobs().configuration().update(params)\n}', + }, + go: { + method: 'client.Sandbox.Jobs.Configuration.Update', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tsandboxJobConfiguration, err := client.Sandbox.Jobs.Configuration.Update(context.TODO(), finchgo.SandboxJobConfigurationUpdateParams{\n\t\tCompletionStatus: finchgo.F(finchgo.SandboxJobConfigurationUpdateParamsCompletionStatusComplete),\n\t\tType: finchgo.F(finchgo.SandboxJobConfigurationUpdateParamsTypeDataSyncAll),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", sandboxJobConfiguration.CompletionStatus)\n}\n', + }, + ruby: { + method: 'sandbox.jobs.configuration.update', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\nsandbox_job_configuration = finch.sandbox.jobs.configuration.update(completion_status: :complete, type: :data_sync_all)\n\nputs(sandbox_job_configuration)', + }, + http: { + example: + 'curl https://api.tryfinch.com/sandbox/jobs/configuration \\\n -X PUT \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN" \\\n -d \'{\n "completion_status": "complete",\n "type": "data_sync_all"\n }\'', + }, + }, }, { - "name": "list", - "endpoint": "/employer/pay-groups", - "httpMethod": "get", - "summary": "Get All Pay Groups", - "description": "Read company pay groups and frequencies", - "stainlessPath": "(resource) payroll.pay_groups > (method) list", - "qualified": "client.payroll.payGroups.list", - "params": [ - "entity_ids?: string[];", - "individual_id?: string;", - "pay_frequencies?: string[];" - ], - "response": "{ id: string; name: string; pay_frequencies: string[]; }", - "markdown": "## list\n\n`client.payroll.payGroups.list(entity_ids?: string[], individual_id?: string, pay_frequencies?: string[]): { id: string; name: string; pay_frequencies: string[]; }`\n\n**get** `/employer/pay-groups`\n\nRead company pay groups and frequencies\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `individual_id?: string`\n\n- `pay_frequencies?: string[]`\n\n### Returns\n\n- `{ id: string; name: string; pay_frequencies: string[]; }`\n\n - `id: string`\n - `name: string`\n - `pay_frequencies: string[]`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const payGroupListResponse of client.payroll.payGroups.list()) {\n console.log(payGroupListResponse);\n}\n```", - "perLanguage": { - "typescript": { - "method": "client.payroll.payGroups.list", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const payGroupListResponse of client.payroll.payGroups.list()) {\n console.log(payGroupListResponse.id);\n}" - }, - "python": { - "method": "payroll.pay_groups.list", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\npage = client.payroll.pay_groups.list()\npage = page.items[0]\nprint(page.id)" - }, - "java": { - "method": "payroll().payGroups().list", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.PayrollPayGroupListPage;\nimport com.tryfinch.api.models.PayrollPayGroupListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n PayrollPayGroupListPage page = client.payroll().payGroups().list();\n }\n}" - }, - "kotlin": { - "method": "payroll().payGroups().list", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.PayrollPayGroupListPage\nimport com.tryfinch.api.models.PayrollPayGroupListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val page: PayrollPayGroupListPage = client.payroll().payGroups().list()\n}" - }, - "go": { - "method": "client.Payroll.PayGroups.List", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tpage, err := client.Payroll.PayGroups.List(context.TODO(), finchgo.PayrollPayGroupListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n" - }, - "ruby": { - "method": "payroll.pay_groups.list", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\npage = finch.payroll.pay_groups.list\n\nputs(page)" - }, - "http": { - "example": "curl https://api.tryfinch.com/employer/pay-groups \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + name: 'list', + endpoint: '/employer/pay-groups', + httpMethod: 'get', + summary: 'Get All Pay Groups', + description: 'Read company pay groups and frequencies', + stainlessPath: '(resource) payroll.pay_groups > (method) list', + qualified: 'client.payroll.payGroups.list', + params: ['entity_ids?: string[];', 'individual_id?: string;', 'pay_frequencies?: string[];'], + response: '{ id: string; name: string; pay_frequencies: string[]; }', + markdown: + "## list\n\n`client.payroll.payGroups.list(entity_ids?: string[], individual_id?: string, pay_frequencies?: string[]): { id: string; name: string; pay_frequencies: string[]; }`\n\n**get** `/employer/pay-groups`\n\nRead company pay groups and frequencies\n\n### Parameters\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n- `individual_id?: string`\n\n- `pay_frequencies?: string[]`\n\n### Returns\n\n- `{ id: string; name: string; pay_frequencies: string[]; }`\n\n - `id: string`\n - `name: string`\n - `pay_frequencies: string[]`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\n// Automatically fetches more pages as needed.\nfor await (const payGroupListResponse of client.payroll.payGroups.list()) {\n console.log(payGroupListResponse);\n}\n```", + perLanguage: { + typescript: { + method: 'client.payroll.payGroups.list', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\n// Automatically fetches more pages as needed.\nfor await (const payGroupListResponse of client.payroll.payGroups.list()) {\n console.log(payGroupListResponse.id);\n}", + }, + python: { + method: 'payroll.pay_groups.list', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npage = client.payroll.pay_groups.list()\npage = page.items[0]\nprint(page.id)', + }, + java: { + method: 'payroll().payGroups().list', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.PayrollPayGroupListPage;\nimport com.tryfinch.api.models.PayrollPayGroupListParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PayrollPayGroupListPage page = client.payroll().payGroups().list();\n }\n}', + }, + kotlin: { + method: 'payroll().payGroups().list', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.PayrollPayGroupListPage\nimport com.tryfinch.api.models.PayrollPayGroupListParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val page: PayrollPayGroupListPage = client.payroll().payGroups().list()\n}', + }, + go: { + method: 'client.Payroll.PayGroups.List', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.Payroll.PayGroups.List(context.TODO(), finchgo.PayrollPayGroupListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n', + }, + ruby: { + method: 'payroll.pay_groups.list', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.payroll.pay_groups.list\n\nputs(page)', + }, + http: { + example: + 'curl https://api.tryfinch.com/employer/pay-groups \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "retrieve", - "endpoint": "/employer/pay-groups/{pay_group_id}", - "httpMethod": "get", - "summary": "Get Pay Group", - "description": "Read information from a single pay group", - "stainlessPath": "(resource) payroll.pay_groups > (method) retrieve", - "qualified": "client.payroll.payGroups.retrieve", - "params": [ - "pay_group_id: string;", - "entity_ids?: string[];" - ], - "response": "{ id: string; individual_ids: string[]; name: string; pay_frequencies: string[]; }", - "markdown": "## retrieve\n\n`client.payroll.payGroups.retrieve(pay_group_id: string, entity_ids?: string[]): { id: string; individual_ids: string[]; name: string; pay_frequencies: string[]; }`\n\n**get** `/employer/pay-groups/{pay_group_id}`\n\nRead information from a single pay group\n\n### Parameters\n\n- `pay_group_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ id: string; individual_ids: string[]; name: string; pay_frequencies: string[]; }`\n\n - `id: string`\n - `individual_ids: string[]`\n - `name: string`\n - `pay_frequencies: string[]`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst payGroup = await client.payroll.payGroups.retrieve('pay_group_id');\n\nconsole.log(payGroup);\n```", - "perLanguage": { - "typescript": { - "method": "client.payroll.payGroups.retrieve", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst payGroup = await client.payroll.payGroups.retrieve('pay_group_id');\n\nconsole.log(payGroup.id);" - }, - "python": { - "method": "payroll.pay_groups.retrieve", - "example": "from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\npay_group = client.payroll.pay_groups.retrieve(\n pay_group_id=\"pay_group_id\",\n)\nprint(pay_group.id)" - }, - "java": { - "method": "payroll().payGroups().retrieve", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.PayGroupRetrieveResponse;\nimport com.tryfinch.api.models.PayrollPayGroupRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n PayGroupRetrieveResponse payGroup = client.payroll().payGroups().retrieve(\"pay_group_id\");\n }\n}" - }, - "kotlin": { - "method": "payroll().payGroups().retrieve", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.PayGroupRetrieveResponse\nimport com.tryfinch.api.models.PayrollPayGroupRetrieveParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val payGroup: PayGroupRetrieveResponse = client.payroll().payGroups().retrieve(\"pay_group_id\")\n}" - }, - "go": { - "method": "client.Payroll.PayGroups.Get", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tpayGroup, err := client.Payroll.PayGroups.Get(\n\t\tcontext.TODO(),\n\t\t\"pay_group_id\",\n\t\tfinchgo.PayrollPayGroupGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", payGroup.ID)\n}\n" - }, - "ruby": { - "method": "payroll.pay_groups.retrieve", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\npay_group = finch.payroll.pay_groups.retrieve(\"pay_group_id\")\n\nputs(pay_group)" - }, - "http": { - "example": "curl https://api.tryfinch.com/employer/pay-groups/$PAY_GROUP_ID \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -H \"Authorization: Bearer $ACCESS_TOKEN\"" - } - } + name: 'retrieve', + endpoint: '/employer/pay-groups/{pay_group_id}', + httpMethod: 'get', + summary: 'Get Pay Group', + description: 'Read information from a single pay group', + stainlessPath: '(resource) payroll.pay_groups > (method) retrieve', + qualified: 'client.payroll.payGroups.retrieve', + params: ['pay_group_id: string;', 'entity_ids?: string[];'], + response: '{ id: string; individual_ids: string[]; name: string; pay_frequencies: string[]; }', + markdown: + "## retrieve\n\n`client.payroll.payGroups.retrieve(pay_group_id: string, entity_ids?: string[]): { id: string; individual_ids: string[]; name: string; pay_frequencies: string[]; }`\n\n**get** `/employer/pay-groups/{pay_group_id}`\n\nRead information from a single pay group\n\n### Parameters\n\n- `pay_group_id: string`\n\n- `entity_ids?: string[]`\n The entity IDs to specify which entities' data to access.\n\n### Returns\n\n- `{ id: string; individual_ids: string[]; name: string; pay_frequencies: string[]; }`\n\n - `id: string`\n - `individual_ids: string[]`\n - `name: string`\n - `pay_frequencies: string[]`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst payGroup = await client.payroll.payGroups.retrieve('pay_group_id');\n\nconsole.log(payGroup);\n```", + perLanguage: { + typescript: { + method: 'client.payroll.payGroups.retrieve', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst payGroup = await client.payroll.payGroups.retrieve('pay_group_id');\n\nconsole.log(payGroup.id);", + }, + python: { + method: 'payroll.pay_groups.retrieve', + example: + 'from finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\npay_group = client.payroll.pay_groups.retrieve(\n pay_group_id="pay_group_id",\n)\nprint(pay_group.id)', + }, + java: { + method: 'payroll().payGroups().retrieve', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.PayGroupRetrieveResponse;\nimport com.tryfinch.api.models.PayrollPayGroupRetrieveParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n PayGroupRetrieveResponse payGroup = client.payroll().payGroups().retrieve("pay_group_id");\n }\n}', + }, + kotlin: { + method: 'payroll().payGroups().retrieve', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.PayGroupRetrieveResponse\nimport com.tryfinch.api.models.PayrollPayGroupRetrieveParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val payGroup: PayGroupRetrieveResponse = client.payroll().payGroups().retrieve("pay_group_id")\n}', + }, + go: { + method: 'client.Payroll.PayGroups.Get', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpayGroup, err := client.Payroll.PayGroups.Get(\n\t\tcontext.TODO(),\n\t\t"pay_group_id",\n\t\tfinchgo.PayrollPayGroupGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", payGroup.ID)\n}\n', + }, + ruby: { + method: 'payroll.pay_groups.retrieve', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npay_group = finch.payroll.pay_groups.retrieve("pay_group_id")\n\nputs(pay_group)', + }, + http: { + example: + 'curl https://api.tryfinch.com/employer/pay-groups/$PAY_GROUP_ID \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -H "Authorization: Bearer $ACCESS_TOKEN"', + }, + }, }, { - "name": "new", - "endpoint": "/connect/sessions", - "httpMethod": "post", - "summary": "Create a new connect session", - "description": "Create a new connect session for an employer", - "stainlessPath": "(resource) connect.sessions > (method) new", - "qualified": "client.connect.sessions.new", - "params": [ - "customer_id: string;", - "customer_name: string;", - "products: string[];", - "customer_email?: string;", + name: 'new', + endpoint: '/connect/sessions', + httpMethod: 'post', + summary: 'Create a new connect session', + description: 'Create a new connect session for an employer', + stainlessPath: '(resource) connect.sessions > (method) new', + qualified: 'client.connect.sessions.new', + params: [ + 'customer_id: string;', + 'customer_name: string;', + 'products: string[];', + 'customer_email?: string;', "integration?: { provider: string; auth_method?: 'assisted' | 'credential' | 'oauth' | 'api_token'; };", - "manual?: boolean;", - "minutes_to_expire?: number;", - "redirect_uri?: string;", - "sandbox?: 'finch' | 'provider';" + 'manual?: boolean;', + 'minutes_to_expire?: number;', + 'redirect_uri?: string;', + "sandbox?: 'finch' | 'provider';", ], - "response": "{ connect_url: string; session_id: string; }", - "markdown": "## new\n\n`client.connect.sessions.new(customer_id: string, customer_name: string, products: string[], customer_email?: string, integration?: { provider: string; auth_method?: 'assisted' | 'credential' | 'oauth' | 'api_token'; }, manual?: boolean, minutes_to_expire?: number, redirect_uri?: string, sandbox?: 'finch' | 'provider'): { connect_url: string; session_id: string; }`\n\n**post** `/connect/sessions`\n\nCreate a new connect session for an employer\n\n### Parameters\n\n- `customer_id: string`\n Unique identifier for the customer\n\n- `customer_name: string`\n Name of the customer\n\n- `products: string[]`\n The Finch products to request access to. Use `benefits` to access deductions endpoints — `deduction` is a deprecated alias that is still accepted but should not be combined with `benefits`.\n\n- `customer_email?: string`\n Email address of the customer\n\n- `integration?: { provider: string; auth_method?: 'assisted' | 'credential' | 'oauth' | 'api_token'; }`\n Integration configuration for the connect session\n - `provider: string`\n The provider to integrate with\n - `auth_method?: 'assisted' | 'credential' | 'oauth' | 'api_token'`\n The authentication method to use\n\n- `manual?: boolean`\n Enable manual authentication mode\n\n- `minutes_to_expire?: number`\n The number of minutes until the session expires (defaults to 129,600, which is 90 days)\n\n- `redirect_uri?: string`\n The URI to redirect to after the Connect flow is completed\n\n- `sandbox?: 'finch' | 'provider'`\n Sandbox mode for testing\n\n### Returns\n\n- `{ connect_url: string; session_id: string; }`\n\n - `connect_url: string`\n - `session_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst response = await client.connect.sessions.new({\n customer_id: 'x',\n customer_name: 'x',\n products: ['benefits'],\n});\n\nconsole.log(response);\n```", - "perLanguage": { - "typescript": { - "method": "client.connect.sessions.new", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n clientID: process.env['FINCH_CLIENT_ID'], // This is the default and can be omitted\n clientSecret: process.env['FINCH_CLIENT_SECRET'], // This is the default and can be omitted\n});\n\nconst response = await client.connect.sessions.new({\n customer_id: 'x',\n customer_name: 'x',\n products: ['benefits'],\n});\n\nconsole.log(response.session_id);" - }, - "python": { - "method": "connect.sessions.new", - "example": "import os\nfrom finch import Finch\n\nclient = Finch(\n client_id=os.environ.get(\"FINCH_CLIENT_ID\"), # This is the default and can be omitted\n client_secret=os.environ.get(\"FINCH_CLIENT_SECRET\"), # This is the default and can be omitted\n)\nresponse = client.connect.sessions.new(\n customer_id=\"x\",\n customer_name=\"x\",\n products=[\"benefits\"],\n)\nprint(response.session_id)" - }, - "java": { - "method": "connect().sessions().new_", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.ConnectSessionNewParams;\nimport com.tryfinch.api.models.SessionNewResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.fromEnv();\n\n ConnectSessionNewParams params = ConnectSessionNewParams.builder()\n .customerId(\"x\")\n .customerName(\"x\")\n .addProduct(ConnectSessionNewParams.ConnectProducts.BENEFITS)\n .build();\n SessionNewResponse response = client.connect().sessions().new_(params);\n }\n}" - }, - "kotlin": { - "method": "connect().sessions().new", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.ConnectSessionNewParams\nimport com.tryfinch.api.models.SessionNewResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.fromEnv()\n\n val params: ConnectSessionNewParams = ConnectSessionNewParams.builder()\n .customerId(\"x\")\n .customerName(\"x\")\n .addProduct(ConnectSessionNewParams.ConnectProducts.BENEFITS)\n .build()\n val response: SessionNewResponse = client.connect().sessions().new(params)\n}" - }, - "go": { - "method": "client.Connect.Sessions.New", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithClientID(\"4ab15e51-11ad-49f4-acae-f343b7794375\"),\n\t\toption.WithClientSecret(\"My Client Secret\"),\n\t)\n\tresponse, err := client.Connect.Sessions.New(context.TODO(), finchgo.ConnectSessionNewParams{\n\t\tCustomerID: finchgo.F(\"x\"),\n\t\tCustomerName: finchgo.F(\"x\"),\n\t\tProducts: finchgo.F([]finchgo.ConnectSessionNewParamsProduct{finchgo.ConnectSessionNewParamsProductBenefits}),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.SessionID)\n}\n" - }, - "ruby": { - "method": "connect.sessions.new", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(client_id: \"4ab15e51-11ad-49f4-acae-f343b7794375\", client_secret: \"My Client Secret\")\n\nresponse = finch.connect.sessions.new(customer_id: \"x\", customer_name: \"x\", products: [:benefits])\n\nputs(response)" - }, - "http": { - "example": "curl https://api.tryfinch.com/connect/sessions \\\n -H 'Content-Type: application/json' \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -u \"$FINCH_CLIENT_ID:FINCH_CLIENT_SECRET\" \\\n -d '{\n \"customer_id\": \"x\",\n \"customer_name\": \"x\",\n \"products\": [\n \"benefits\"\n ]\n }'" - } - } + response: '{ connect_url: string; session_id: string; }', + markdown: + "## new\n\n`client.connect.sessions.new(customer_id: string, customer_name: string, products: string[], customer_email?: string, integration?: { provider: string; auth_method?: 'assisted' | 'credential' | 'oauth' | 'api_token'; }, manual?: boolean, minutes_to_expire?: number, redirect_uri?: string, sandbox?: 'finch' | 'provider'): { connect_url: string; session_id: string; }`\n\n**post** `/connect/sessions`\n\nCreate a new connect session for an employer\n\n### Parameters\n\n- `customer_id: string`\n Unique identifier for the customer\n\n- `customer_name: string`\n Name of the customer\n\n- `products: string[]`\n The Finch products to request access to. Use `benefits` to access deductions endpoints — `deduction` is a deprecated alias that is still accepted but should not be combined with `benefits`.\n\n- `customer_email?: string`\n Email address of the customer\n\n- `integration?: { provider: string; auth_method?: 'assisted' | 'credential' | 'oauth' | 'api_token'; }`\n Integration configuration for the connect session\n - `provider: string`\n The provider to integrate with\n - `auth_method?: 'assisted' | 'credential' | 'oauth' | 'api_token'`\n The authentication method to use\n\n- `manual?: boolean`\n Enable manual authentication mode\n\n- `minutes_to_expire?: number`\n The number of minutes until the session expires (defaults to 129,600, which is 90 days)\n\n- `redirect_uri?: string`\n The URI to redirect to after the Connect flow is completed\n\n- `sandbox?: 'finch' | 'provider'`\n Sandbox mode for testing\n\n### Returns\n\n- `{ connect_url: string; session_id: string; }`\n\n - `connect_url: string`\n - `session_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst response = await client.connect.sessions.new({\n customer_id: 'x',\n customer_name: 'x',\n products: ['benefits'],\n});\n\nconsole.log(response);\n```", + perLanguage: { + typescript: { + method: 'client.connect.sessions.new', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n clientID: process.env['FINCH_CLIENT_ID'], // This is the default and can be omitted\n clientSecret: process.env['FINCH_CLIENT_SECRET'], // This is the default and can be omitted\n});\n\nconst response = await client.connect.sessions.new({\n customer_id: 'x',\n customer_name: 'x',\n products: ['benefits'],\n});\n\nconsole.log(response.session_id);", + }, + python: { + method: 'connect.sessions.new', + example: + 'import os\nfrom finch import Finch\n\nclient = Finch(\n client_id=os.environ.get("FINCH_CLIENT_ID"), # This is the default and can be omitted\n client_secret=os.environ.get("FINCH_CLIENT_SECRET"), # This is the default and can be omitted\n)\nresponse = client.connect.sessions.new(\n customer_id="x",\n customer_name="x",\n products=["benefits"],\n)\nprint(response.session_id)', + }, + java: { + method: 'connect().sessions().new_', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.ConnectSessionNewParams;\nimport com.tryfinch.api.models.SessionNewResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.fromEnv();\n\n ConnectSessionNewParams params = ConnectSessionNewParams.builder()\n .customerId("x")\n .customerName("x")\n .addProduct(ConnectSessionNewParams.ConnectProducts.BENEFITS)\n .build();\n SessionNewResponse response = client.connect().sessions().new_(params);\n }\n}', + }, + kotlin: { + method: 'connect().sessions().new', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.ConnectSessionNewParams\nimport com.tryfinch.api.models.SessionNewResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.fromEnv()\n\n val params: ConnectSessionNewParams = ConnectSessionNewParams.builder()\n .customerId("x")\n .customerName("x")\n .addProduct(ConnectSessionNewParams.ConnectProducts.BENEFITS)\n .build()\n val response: SessionNewResponse = client.connect().sessions().new(params)\n}', + }, + go: { + method: 'client.Connect.Sessions.New', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithClientID("4ab15e51-11ad-49f4-acae-f343b7794375"),\n\t\toption.WithClientSecret("My Client Secret"),\n\t)\n\tresponse, err := client.Connect.Sessions.New(context.TODO(), finchgo.ConnectSessionNewParams{\n\t\tCustomerID: finchgo.F("x"),\n\t\tCustomerName: finchgo.F("x"),\n\t\tProducts: finchgo.F([]finchgo.ConnectSessionNewParamsProduct{finchgo.ConnectSessionNewParamsProductBenefits}),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response.SessionID)\n}\n', + }, + ruby: { + method: 'connect.sessions.new', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(client_id: "4ab15e51-11ad-49f4-acae-f343b7794375", client_secret: "My Client Secret")\n\nresponse = finch.connect.sessions.new(customer_id: "x", customer_name: "x", products: [:benefits])\n\nputs(response)', + }, + http: { + example: + 'curl https://api.tryfinch.com/connect/sessions \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -u "$FINCH_CLIENT_ID:FINCH_CLIENT_SECRET" \\\n -d \'{\n "customer_id": "x",\n "customer_name": "x",\n "products": [\n "benefits"\n ]\n }\'', + }, + }, }, { - "name": "reauthenticate", - "endpoint": "/connect/sessions/reauthenticate", - "httpMethod": "post", - "summary": "Create a new Connect session for reauthentication", - "description": "Create a new Connect session for reauthenticating an existing connection", - "stainlessPath": "(resource) connect.sessions > (method) reauthenticate", - "qualified": "client.connect.sessions.reauthenticate", - "params": [ - "connection_id: string;", - "minutes_to_expire?: number;", - "products?: string[];", - "redirect_uri?: string;" + name: 'reauthenticate', + endpoint: '/connect/sessions/reauthenticate', + httpMethod: 'post', + summary: 'Create a new Connect session for reauthentication', + description: 'Create a new Connect session for reauthenticating an existing connection', + stainlessPath: '(resource) connect.sessions > (method) reauthenticate', + qualified: 'client.connect.sessions.reauthenticate', + params: [ + 'connection_id: string;', + 'minutes_to_expire?: number;', + 'products?: string[];', + 'redirect_uri?: string;', ], - "response": "{ connect_url: string; session_id: string; }", - "markdown": "## reauthenticate\n\n`client.connect.sessions.reauthenticate(connection_id: string, minutes_to_expire?: number, products?: string[], redirect_uri?: string): { connect_url: string; session_id: string; }`\n\n**post** `/connect/sessions/reauthenticate`\n\nCreate a new Connect session for reauthenticating an existing connection\n\n### Parameters\n\n- `connection_id: string`\n The ID of the existing connection to reauthenticate\n\n- `minutes_to_expire?: number`\n The number of minutes until the session expires (defaults to 43,200, which is 30 days)\n\n- `products?: string[]`\n The products to request access to (optional for reauthentication). Use `benefits` to access deductions endpoints — `deduction` is a deprecated alias that is still accepted but should not be combined with `benefits`.\n\n- `redirect_uri?: string`\n The URI to redirect to after the Connect flow is completed\n\n### Returns\n\n- `{ connect_url: string; session_id: string; }`\n\n - `connect_url: string`\n - `session_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst response = await client.connect.sessions.reauthenticate({ connection_id: 'connection_id' });\n\nconsole.log(response);\n```", - "perLanguage": { - "typescript": { - "method": "client.connect.sessions.reauthenticate", - "example": "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n clientID: process.env['FINCH_CLIENT_ID'], // This is the default and can be omitted\n clientSecret: process.env['FINCH_CLIENT_SECRET'], // This is the default and can be omitted\n});\n\nconst response = await client.connect.sessions.reauthenticate({ connection_id: 'connection_id' });\n\nconsole.log(response.session_id);" - }, - "python": { - "method": "connect.sessions.reauthenticate", - "example": "import os\nfrom finch import Finch\n\nclient = Finch(\n client_id=os.environ.get(\"FINCH_CLIENT_ID\"), # This is the default and can be omitted\n client_secret=os.environ.get(\"FINCH_CLIENT_SECRET\"), # This is the default and can be omitted\n)\nresponse = client.connect.sessions.reauthenticate(\n connection_id=\"connection_id\",\n)\nprint(response.session_id)" - }, - "java": { - "method": "connect().sessions().reauthenticate", - "example": "package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.ConnectSessionReauthenticateParams;\nimport com.tryfinch.api.models.SessionReauthenticateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.fromEnv();\n\n ConnectSessionReauthenticateParams params = ConnectSessionReauthenticateParams.builder()\n .connectionId(\"connection_id\")\n .build();\n SessionReauthenticateResponse response = client.connect().sessions().reauthenticate(params);\n }\n}" - }, - "kotlin": { - "method": "connect().sessions().reauthenticate", - "example": "package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.ConnectSessionReauthenticateParams\nimport com.tryfinch.api.models.SessionReauthenticateResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.fromEnv()\n\n val params: ConnectSessionReauthenticateParams = ConnectSessionReauthenticateParams.builder()\n .connectionId(\"connection_id\")\n .build()\n val response: SessionReauthenticateResponse = client.connect().sessions().reauthenticate(params)\n}" - }, - "go": { - "method": "client.Connect.Sessions.Reauthenticate", - "example": "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithClientID(\"4ab15e51-11ad-49f4-acae-f343b7794375\"),\n\t\toption.WithClientSecret(\"My Client Secret\"),\n\t)\n\tresponse, err := client.Connect.Sessions.Reauthenticate(context.TODO(), finchgo.ConnectSessionReauthenticateParams{\n\t\tConnectionID: finchgo.F(\"connection_id\"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.SessionID)\n}\n" - }, - "ruby": { - "method": "connect.sessions.reauthenticate", - "example": "require \"finch_api\"\n\nfinch = FinchAPI::Client.new(client_id: \"4ab15e51-11ad-49f4-acae-f343b7794375\", client_secret: \"My Client Secret\")\n\nresponse = finch.connect.sessions.reauthenticate(connection_id: \"connection_id\")\n\nputs(response)" - }, - "http": { - "example": "curl https://api.tryfinch.com/connect/sessions/reauthenticate \\\n -H 'Content-Type: application/json' \\\n -H 'Finch-API-Version: 2020-09-17' \\\n -u \"$FINCH_CLIENT_ID:FINCH_CLIENT_SECRET\" \\\n -d '{\n \"connection_id\": \"connection_id\"\n }'" - } - } - } + response: '{ connect_url: string; session_id: string; }', + markdown: + "## reauthenticate\n\n`client.connect.sessions.reauthenticate(connection_id: string, minutes_to_expire?: number, products?: string[], redirect_uri?: string): { connect_url: string; session_id: string; }`\n\n**post** `/connect/sessions/reauthenticate`\n\nCreate a new Connect session for reauthenticating an existing connection\n\n### Parameters\n\n- `connection_id: string`\n The ID of the existing connection to reauthenticate\n\n- `minutes_to_expire?: number`\n The number of minutes until the session expires (defaults to 43,200, which is 30 days)\n\n- `products?: string[]`\n The products to request access to (optional for reauthentication). Use `benefits` to access deductions endpoints — `deduction` is a deprecated alias that is still accepted but should not be combined with `benefits`.\n\n- `redirect_uri?: string`\n The URI to redirect to after the Connect flow is completed\n\n### Returns\n\n- `{ connect_url: string; session_id: string; }`\n\n - `connect_url: string`\n - `session_id: string`\n\n### Example\n\n```typescript\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst response = await client.connect.sessions.reauthenticate({ connection_id: 'connection_id' });\n\nconsole.log(response);\n```", + perLanguage: { + typescript: { + method: 'client.connect.sessions.reauthenticate', + example: + "import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n clientID: process.env['FINCH_CLIENT_ID'], // This is the default and can be omitted\n clientSecret: process.env['FINCH_CLIENT_SECRET'], // This is the default and can be omitted\n});\n\nconst response = await client.connect.sessions.reauthenticate({ connection_id: 'connection_id' });\n\nconsole.log(response.session_id);", + }, + python: { + method: 'connect.sessions.reauthenticate', + example: + 'import os\nfrom finch import Finch\n\nclient = Finch(\n client_id=os.environ.get("FINCH_CLIENT_ID"), # This is the default and can be omitted\n client_secret=os.environ.get("FINCH_CLIENT_SECRET"), # This is the default and can be omitted\n)\nresponse = client.connect.sessions.reauthenticate(\n connection_id="connection_id",\n)\nprint(response.session_id)', + }, + java: { + method: 'connect().sessions().reauthenticate', + example: + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.ConnectSessionReauthenticateParams;\nimport com.tryfinch.api.models.SessionReauthenticateResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.fromEnv();\n\n ConnectSessionReauthenticateParams params = ConnectSessionReauthenticateParams.builder()\n .connectionId("connection_id")\n .build();\n SessionReauthenticateResponse response = client.connect().sessions().reauthenticate(params);\n }\n}', + }, + kotlin: { + method: 'connect().sessions().reauthenticate', + example: + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.ConnectSessionReauthenticateParams\nimport com.tryfinch.api.models.SessionReauthenticateResponse\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.fromEnv()\n\n val params: ConnectSessionReauthenticateParams = ConnectSessionReauthenticateParams.builder()\n .connectionId("connection_id")\n .build()\n val response: SessionReauthenticateResponse = client.connect().sessions().reauthenticate(params)\n}', + }, + go: { + method: 'client.Connect.Sessions.Reauthenticate', + example: + 'package main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithClientID("4ab15e51-11ad-49f4-acae-f343b7794375"),\n\t\toption.WithClientSecret("My Client Secret"),\n\t)\n\tresponse, err := client.Connect.Sessions.Reauthenticate(context.TODO(), finchgo.ConnectSessionReauthenticateParams{\n\t\tConnectionID: finchgo.F("connection_id"),\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", response.SessionID)\n}\n', + }, + ruby: { + method: 'connect.sessions.reauthenticate', + example: + 'require "finch_api"\n\nfinch = FinchAPI::Client.new(client_id: "4ab15e51-11ad-49f4-acae-f343b7794375", client_secret: "My Client Secret")\n\nresponse = finch.connect.sessions.reauthenticate(connection_id: "connection_id")\n\nputs(response)', + }, + http: { + example: + 'curl https://api.tryfinch.com/connect/sessions/reauthenticate \\\n -H \'Content-Type: application/json\' \\\n -H \'Finch-API-Version: 2020-09-17\' \\\n -u "$FINCH_CLIENT_ID:FINCH_CLIENT_SECRET" \\\n -d \'{\n "connection_id": "connection_id"\n }\'', + }, + }, + }, ]; const EMBEDDED_READMES: { language: string; content: string }[] = [ { - "language": "go", - "content": "# Finch Go API Library\n\n\"Go\n\nThe Finch Go library provides convenient access to the [Finch REST API](https://developer.tryfinch.com/)\nfrom applications written in Go.\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Installation\n\n\n\n```go\nimport (\n\t\"github.com/Finch-API/finch-api-go\" // imported as SDK_PackageName\n)\n```\n\n\n\nOr to pin the version:\n\n\n\n```sh\ngo get -u 'github.com/Finch-API/finch-api-go@v0.0.1'\n```\n\n\n\n## Requirements\n\nThis library requires Go 1.22+.\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n```go\npackage main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go\"\n\t\"github.com/Finch-API/finch-api-go/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tpage, err := client.HRIS.Directory.List(context.TODO(), finchgo.HRISDirectoryListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n\n```\n\n### Request fields\n\nAll request parameters are wrapped in a generic `Field` type,\nwhich we use to distinguish zero values from null or omitted fields.\n\nThis prevents accidentally sending a zero value if you forget a required parameter,\nand enables explicitly sending `null`, `false`, `''`, or `0` on optional parameters.\nAny field not specified is not sent.\n\nTo construct fields with values, use the helpers `String()`, `Int()`, `Float()`, or most commonly, the generic `F[T]()`.\nTo send a null, use `Null[T]()`, and to send a nonconforming value, use `Raw[T](any)`. For example:\n\n```go\nparams := FooParams{\n\tName: SDK_PackageName.F(\"hello\"),\n\n\t// Explicitly send `\"description\": null`\n\tDescription: SDK_PackageName.Null[string](),\n\n\tPoint: SDK_PackageName.F(SDK_PackageName.Point{\n\t\tX: SDK_PackageName.Int(0),\n\t\tY: SDK_PackageName.Int(1),\n\n\t\t// In cases where the API specifies a given type,\n\t\t// but you want to send something else, use `Raw`:\n\t\tZ: SDK_PackageName.Raw[int64](0.01), // sends a float\n\t}),\n}\n```\n\n### Response objects\n\nAll fields in response structs are value types (not pointers or wrappers).\n\nIf a given field is `null`, not present, or invalid, the corresponding field\nwill simply be its zero value.\n\nAll response structs also include a special `JSON` field, containing more detailed\ninformation about each property, which you can use like so:\n\n```go\nif res.Name == \"\" {\n\t// true if `\"name\"` is either not present or explicitly null\n\tres.JSON.Name.IsNull()\n\n\t// true if the `\"name\"` key was not present in the response JSON at all\n\tres.JSON.Name.IsMissing()\n\n\t// When the API returns data that cannot be coerced to the expected type:\n\tif res.JSON.Name.IsInvalid() {\n\t\traw := res.JSON.Name.Raw()\n\n\t\tlegacyName := struct{\n\t\t\tFirst string `json:\"first\"`\n\t\t\tLast string `json:\"last\"`\n\t\t}{}\n\t\tjson.Unmarshal([]byte(raw), &legacyName)\n\t\tname = legacyName.First + \" \" + legacyName.Last\n\t}\n}\n```\n\nThese `.JSON` structs also include an `Extras` map containing\nany properties in the json response that were not specified\nin the struct. This can be useful for API features not yet\npresent in the SDK.\n\n```go\nbody := res.JSON.ExtraFields[\"my_unexpected_field\"].Raw()\n```\n\n### RequestOptions\n\nThis library uses the functional options pattern. Functions defined in the\n`SDK_PackageOptionName` package return a `RequestOption`, which is a closure that mutates a\n`RequestConfig`. These options can be supplied to the client or at individual\nrequests. For example:\n\n```go\nclient := SDK_PackageName.SDK_ClientInitializerName(\n\t// Adds a header to every request made by the client\n\tSDK_PackageOptionName.WithHeader(\"X-Some-Header\", \"custom_header_info\"),\n)\n\nclient.HRIS.Directory.List(context.TODO(), ...,\n\t// Override the header\n\tSDK_PackageOptionName.WithHeader(\"X-Some-Header\", \"some_other_custom_header_info\"),\n\t// Add an undocumented field to the request body, using sjson syntax\n\tSDK_PackageOptionName.WithJSONSet(\"some.json.path\", map[string]string{\"my\": \"object\"}),\n)\n```\n\nSee the [full list of request options](https://pkg.go.dev/github.com/Finch-API/finch-api-go/SDK_PackageOptionName).\n\n### Pagination\n\nThis library provides some conveniences for working with paginated list endpoints.\n\nYou can use `.ListAutoPaging()` methods to iterate through items across all pages:\n\n```go\niter := client.HRIS.Directory.ListAutoPaging(context.TODO(), finchgo.HRISDirectoryListParams{})\n// Automatically fetches more pages as needed.\nfor iter.Next() {\n\tindividualInDirectory := iter.Current()\n\tfmt.Printf(\"%+v\\n\", individualInDirectory)\n}\nif err := iter.Err(); err != nil {\n\tpanic(err.Error())\n}\n```\n\nOr you can use simple `.List()` methods to fetch a single page and receive a standard response object\nwith additional helper methods like `.GetNextPage()`, e.g.:\n\n```go\npage, err := client.HRIS.Directory.List(context.TODO(), finchgo.HRISDirectoryListParams{})\nfor page != nil {\n\tfor _, directory := range page.Individuals {\n\t\tfmt.Printf(\"%+v\\n\", directory)\n\t}\n\tpage, err = page.GetNextPage()\n}\nif err != nil {\n\tpanic(err.Error())\n}\n```\n\n### Errors\n\nWhen the API returns a non-success status code, we return an error with type\n`*SDK_PackageName.Error`. This contains the `StatusCode`, `*http.Request`, and\n`*http.Response` values of the request, as well as the JSON of the error body\n(much like other response objects in the SDK).\n\nTo handle errors, we recommend that you use the `errors.As` pattern:\n\n```go\n_, err := client.HRIS.Company.Get(context.TODO(), finchgo.HRISCompanyGetParams{})\nif err != nil {\n\tvar apierr *finchgo.Error\n\tif errors.As(err, &apierr) {\n\t\tprintln(string(apierr.DumpRequest(true))) // Prints the serialized HTTP request\n\t\tprintln(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response\n\t}\n\tpanic(err.Error()) // GET \"/employer/company\": 400 Bad Request { ... }\n}\n```\n\nWhen other errors occur, they are returned unwrapped; for example,\nif HTTP transport fails, you might receive `*url.Error` wrapping `*net.OpError`.\n\n### Timeouts\n\nRequests do not time out by default; use context to configure a timeout for a request lifecycle.\n\nNote that if a request is [retried](#retries), the context timeout does not start over.\nTo set a per-retry timeout, use `SDK_PackageOptionName.WithRequestTimeout()`.\n\n```go\n// This sets the timeout for the request, including all the retries.\nctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)\ndefer cancel()\nclient.HRIS.Directory.List(\n\tctx,\n\tfinchgo.HRISDirectoryListParams{},\n\t// This sets the per-retry timeout\n\toption.WithRequestTimeout(20*time.Second),\n)\n```\n\n### File uploads\n\nRequest parameters that correspond to file uploads in multipart requests are typed as\n`param.Field[io.Reader]`. The contents of the `io.Reader` will by default be sent as a multipart form\npart with the file name of \"anonymous_file\" and content-type of \"application/octet-stream\".\n\nThe file name and content-type can be customized by implementing `Name() string` or `ContentType()\nstring` on the run-time type of `io.Reader`. Note that `os.File` implements `Name() string`, so a\nfile returned by `os.Open` will be sent with the file name on disk.\n\nWe also provide a helper `SDK_PackageName.FileParam(reader io.Reader, filename string, contentType string)`\nwhich can be used to wrap any `io.Reader` with the appropriate file name and content type.\n\n\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\nWe retry by default all connection errors, 408 Request Timeout, 409 Conflict, 429 Rate Limit,\nand >=500 Internal errors.\n\nYou can use the `WithMaxRetries` option to configure or disable this:\n\n```go\n// Configure the default for all requests:\nclient := finchgo.NewClient(\n\toption.WithMaxRetries(0), // default is 2\n)\n\n// Override per-request:\nclient.HRIS.Directory.List(\n\tcontext.TODO(),\n\tfinchgo.HRISDirectoryListParams{},\n\toption.WithMaxRetries(5),\n)\n```\n\n\n### Accessing raw response data (e.g. response headers)\n\nYou can access the raw HTTP response data by using the `option.WithResponseInto()` request option. This is useful when\nyou need to examine response headers, status codes, or other details.\n\n```go\n// Create a variable to store the HTTP response\nvar response *http.Response\npage, err := client.HRIS.Directory.List(\n\tcontext.TODO(),\n\tfinchgo.HRISDirectoryListParams{},\n\toption.WithResponseInto(&response),\n)\nif err != nil {\n\t// handle error\n}\nfmt.Printf(\"%+v\\n\", page)\n\nfmt.Printf(\"Status Code: %d\\n\", response.StatusCode)\nfmt.Printf(\"Headers: %+#v\\n\", response.Header)\n```\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API. If you need to access undocumented\nendpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can use `client.Get`, `client.Post`, and other HTTP verbs.\n`RequestOptions` on the client, such as retries, will be respected when making these requests.\n\n```go\nvar (\n // params can be an io.Reader, a []byte, an encoding/json serializable object,\n // or a \"…Params\" struct defined in this library.\n params map[string]interface{}\n\n // result can be an []byte, *http.Response, a encoding/json deserializable object,\n // or a model defined in this library.\n result *http.Response\n)\nerr := client.Post(context.Background(), \"/unspecified\", params, &result)\nif err != nil {\n …\n}\n```\n\n#### Undocumented request params\n\nTo make requests using undocumented parameters, you may use either the `SDK_PackageOptionName.WithQuerySet()`\nor the `SDK_PackageOptionName.WithJSONSet()` methods.\n\n```go\nparams := FooNewParams{\n ID: SDK_PackageName.F(\"id_xxxx\"),\n Data: SDK_PackageName.F(FooNewParamsData{\n FirstName: SDK_PackageName.F(\"John\"),\n }),\n}\nclient.Foo.New(context.Background(), params, SDK_PackageOptionName.WithJSONSet(\"data.last_name\", \"Doe\"))\n```\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you may either access the raw JSON of the response as a string\nwith `result.JSON.RawJSON()`, or get the raw JSON of a particular field on the result with\n`result.JSON.Foo.Raw()`.\n\nAny fields that are not present on the response struct will be saved and can be accessed by `result.JSON.ExtraFields()` which returns the extra fields as a `map[string]Field`.\n\n### Middleware\n\nWe provide `SDK_PackageOptionName.WithMiddleware` which applies the given\nmiddleware to requests.\n\n```go\nfunc Logger(req *http.Request, next SDK_PackageOptionName.MiddlewareNext) (res *http.Response, err error) {\n\t// Before the request\n\tstart := time.Now()\n\tLogReq(req)\n\n\t// Forward the request to the next handler\n\tres, err = next(req)\n\n\t// Handle stuff after the request\n\tend := time.Now()\n\tLogRes(res, err, start - end)\n\n return res, err\n}\n\nclient := SDK_PackageName.SDK_ClientInitializerName(\n\tSDK_PackageOptionName.WithMiddleware(Logger),\n)\n```\n\nWhen multiple middlewares are provided as variadic arguments, the middlewares\nare applied left to right. If `SDK_PackageOptionName.WithMiddleware` is given\nmultiple times, for example first in the client then the method, the\nmiddleware in the client will run first and the middleware given in the method\nwill run next.\n\nYou may also replace the default `http.Client` with\n`SDK_PackageOptionName.WithHTTPClient(client)`. Only one http client is\naccepted (this overwrites any previous client) and receives requests after any\nmiddleware has been applied.\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n2. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Finch-API/finch-api-go/issues) with questions, bugs, or suggestions.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n" + language: 'go', + content: + '# Finch Go API Library\n\nGo Reference\n\nThe Finch Go library provides convenient access to the [Finch REST API](https://developer.tryfinch.com/)\nfrom applications written in Go.\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Installation\n\n\n\n```go\nimport (\n\t"github.com/Finch-API/finch-api-go" // imported as SDK_PackageName\n)\n```\n\n\n\nOr to pin the version:\n\n\n\n```sh\ngo get -u \'github.com/Finch-API/finch-api-go@v0.0.1\'\n```\n\n\n\n## Requirements\n\nThis library requires Go 1.22+.\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n```go\npackage main\n\nimport (\n\t"context"\n\t"fmt"\n\n\t"github.com/Finch-API/finch-api-go"\n\t"github.com/Finch-API/finch-api-go/option"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken("My Access Token"),\n\t)\n\tpage, err := client.HRIS.Directory.List(context.TODO(), finchgo.HRISDirectoryListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf("%+v\\n", page)\n}\n\n```\n\n### Request fields\n\nAll request parameters are wrapped in a generic `Field` type,\nwhich we use to distinguish zero values from null or omitted fields.\n\nThis prevents accidentally sending a zero value if you forget a required parameter,\nand enables explicitly sending `null`, `false`, `\'\'`, or `0` on optional parameters.\nAny field not specified is not sent.\n\nTo construct fields with values, use the helpers `String()`, `Int()`, `Float()`, or most commonly, the generic `F[T]()`.\nTo send a null, use `Null[T]()`, and to send a nonconforming value, use `Raw[T](any)`. For example:\n\n```go\nparams := FooParams{\n\tName: SDK_PackageName.F("hello"),\n\n\t// Explicitly send `"description": null`\n\tDescription: SDK_PackageName.Null[string](),\n\n\tPoint: SDK_PackageName.F(SDK_PackageName.Point{\n\t\tX: SDK_PackageName.Int(0),\n\t\tY: SDK_PackageName.Int(1),\n\n\t\t// In cases where the API specifies a given type,\n\t\t// but you want to send something else, use `Raw`:\n\t\tZ: SDK_PackageName.Raw[int64](0.01), // sends a float\n\t}),\n}\n```\n\n### Response objects\n\nAll fields in response structs are value types (not pointers or wrappers).\n\nIf a given field is `null`, not present, or invalid, the corresponding field\nwill simply be its zero value.\n\nAll response structs also include a special `JSON` field, containing more detailed\ninformation about each property, which you can use like so:\n\n```go\nif res.Name == "" {\n\t// true if `"name"` is either not present or explicitly null\n\tres.JSON.Name.IsNull()\n\n\t// true if the `"name"` key was not present in the response JSON at all\n\tres.JSON.Name.IsMissing()\n\n\t// When the API returns data that cannot be coerced to the expected type:\n\tif res.JSON.Name.IsInvalid() {\n\t\traw := res.JSON.Name.Raw()\n\n\t\tlegacyName := struct{\n\t\t\tFirst string `json:"first"`\n\t\t\tLast string `json:"last"`\n\t\t}{}\n\t\tjson.Unmarshal([]byte(raw), &legacyName)\n\t\tname = legacyName.First + " " + legacyName.Last\n\t}\n}\n```\n\nThese `.JSON` structs also include an `Extras` map containing\nany properties in the json response that were not specified\nin the struct. This can be useful for API features not yet\npresent in the SDK.\n\n```go\nbody := res.JSON.ExtraFields["my_unexpected_field"].Raw()\n```\n\n### RequestOptions\n\nThis library uses the functional options pattern. Functions defined in the\n`SDK_PackageOptionName` package return a `RequestOption`, which is a closure that mutates a\n`RequestConfig`. These options can be supplied to the client or at individual\nrequests. For example:\n\n```go\nclient := SDK_PackageName.SDK_ClientInitializerName(\n\t// Adds a header to every request made by the client\n\tSDK_PackageOptionName.WithHeader("X-Some-Header", "custom_header_info"),\n)\n\nclient.HRIS.Directory.List(context.TODO(), ...,\n\t// Override the header\n\tSDK_PackageOptionName.WithHeader("X-Some-Header", "some_other_custom_header_info"),\n\t// Add an undocumented field to the request body, using sjson syntax\n\tSDK_PackageOptionName.WithJSONSet("some.json.path", map[string]string{"my": "object"}),\n)\n```\n\nSee the [full list of request options](https://pkg.go.dev/github.com/Finch-API/finch-api-go/SDK_PackageOptionName).\n\n### Pagination\n\nThis library provides some conveniences for working with paginated list endpoints.\n\nYou can use `.ListAutoPaging()` methods to iterate through items across all pages:\n\n```go\niter := client.HRIS.Directory.ListAutoPaging(context.TODO(), finchgo.HRISDirectoryListParams{})\n// Automatically fetches more pages as needed.\nfor iter.Next() {\n\tindividualInDirectory := iter.Current()\n\tfmt.Printf("%+v\\n", individualInDirectory)\n}\nif err := iter.Err(); err != nil {\n\tpanic(err.Error())\n}\n```\n\nOr you can use simple `.List()` methods to fetch a single page and receive a standard response object\nwith additional helper methods like `.GetNextPage()`, e.g.:\n\n```go\npage, err := client.HRIS.Directory.List(context.TODO(), finchgo.HRISDirectoryListParams{})\nfor page != nil {\n\tfor _, directory := range page.Individuals {\n\t\tfmt.Printf("%+v\\n", directory)\n\t}\n\tpage, err = page.GetNextPage()\n}\nif err != nil {\n\tpanic(err.Error())\n}\n```\n\n### Errors\n\nWhen the API returns a non-success status code, we return an error with type\n`*SDK_PackageName.Error`. This contains the `StatusCode`, `*http.Request`, and\n`*http.Response` values of the request, as well as the JSON of the error body\n(much like other response objects in the SDK).\n\nTo handle errors, we recommend that you use the `errors.As` pattern:\n\n```go\n_, err := client.HRIS.Company.Get(context.TODO(), finchgo.HRISCompanyGetParams{})\nif err != nil {\n\tvar apierr *finchgo.Error\n\tif errors.As(err, &apierr) {\n\t\tprintln(string(apierr.DumpRequest(true))) // Prints the serialized HTTP request\n\t\tprintln(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response\n\t}\n\tpanic(err.Error()) // GET "/employer/company": 400 Bad Request { ... }\n}\n```\n\nWhen other errors occur, they are returned unwrapped; for example,\nif HTTP transport fails, you might receive `*url.Error` wrapping `*net.OpError`.\n\n### Timeouts\n\nRequests do not time out by default; use context to configure a timeout for a request lifecycle.\n\nNote that if a request is [retried](#retries), the context timeout does not start over.\nTo set a per-retry timeout, use `SDK_PackageOptionName.WithRequestTimeout()`.\n\n```go\n// This sets the timeout for the request, including all the retries.\nctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)\ndefer cancel()\nclient.HRIS.Directory.List(\n\tctx,\n\tfinchgo.HRISDirectoryListParams{},\n\t// This sets the per-retry timeout\n\toption.WithRequestTimeout(20*time.Second),\n)\n```\n\n### File uploads\n\nRequest parameters that correspond to file uploads in multipart requests are typed as\n`param.Field[io.Reader]`. The contents of the `io.Reader` will by default be sent as a multipart form\npart with the file name of "anonymous_file" and content-type of "application/octet-stream".\n\nThe file name and content-type can be customized by implementing `Name() string` or `ContentType()\nstring` on the run-time type of `io.Reader`. Note that `os.File` implements `Name() string`, so a\nfile returned by `os.Open` will be sent with the file name on disk.\n\nWe also provide a helper `SDK_PackageName.FileParam(reader io.Reader, filename string, contentType string)`\nwhich can be used to wrap any `io.Reader` with the appropriate file name and content type.\n\n\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\nWe retry by default all connection errors, 408 Request Timeout, 409 Conflict, 429 Rate Limit,\nand >=500 Internal errors.\n\nYou can use the `WithMaxRetries` option to configure or disable this:\n\n```go\n// Configure the default for all requests:\nclient := finchgo.NewClient(\n\toption.WithMaxRetries(0), // default is 2\n)\n\n// Override per-request:\nclient.HRIS.Directory.List(\n\tcontext.TODO(),\n\tfinchgo.HRISDirectoryListParams{},\n\toption.WithMaxRetries(5),\n)\n```\n\n\n### Accessing raw response data (e.g. response headers)\n\nYou can access the raw HTTP response data by using the `option.WithResponseInto()` request option. This is useful when\nyou need to examine response headers, status codes, or other details.\n\n```go\n// Create a variable to store the HTTP response\nvar response *http.Response\npage, err := client.HRIS.Directory.List(\n\tcontext.TODO(),\n\tfinchgo.HRISDirectoryListParams{},\n\toption.WithResponseInto(&response),\n)\nif err != nil {\n\t// handle error\n}\nfmt.Printf("%+v\\n", page)\n\nfmt.Printf("Status Code: %d\\n", response.StatusCode)\nfmt.Printf("Headers: %+#v\\n", response.Header)\n```\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API. If you need to access undocumented\nendpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can use `client.Get`, `client.Post`, and other HTTP verbs.\n`RequestOptions` on the client, such as retries, will be respected when making these requests.\n\n```go\nvar (\n // params can be an io.Reader, a []byte, an encoding/json serializable object,\n // or a "…Params" struct defined in this library.\n params map[string]interface{}\n\n // result can be an []byte, *http.Response, a encoding/json deserializable object,\n // or a model defined in this library.\n result *http.Response\n)\nerr := client.Post(context.Background(), "/unspecified", params, &result)\nif err != nil {\n …\n}\n```\n\n#### Undocumented request params\n\nTo make requests using undocumented parameters, you may use either the `SDK_PackageOptionName.WithQuerySet()`\nor the `SDK_PackageOptionName.WithJSONSet()` methods.\n\n```go\nparams := FooNewParams{\n ID: SDK_PackageName.F("id_xxxx"),\n Data: SDK_PackageName.F(FooNewParamsData{\n FirstName: SDK_PackageName.F("John"),\n }),\n}\nclient.Foo.New(context.Background(), params, SDK_PackageOptionName.WithJSONSet("data.last_name", "Doe"))\n```\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you may either access the raw JSON of the response as a string\nwith `result.JSON.RawJSON()`, or get the raw JSON of a particular field on the result with\n`result.JSON.Foo.Raw()`.\n\nAny fields that are not present on the response struct will be saved and can be accessed by `result.JSON.ExtraFields()` which returns the extra fields as a `map[string]Field`.\n\n### Middleware\n\nWe provide `SDK_PackageOptionName.WithMiddleware` which applies the given\nmiddleware to requests.\n\n```go\nfunc Logger(req *http.Request, next SDK_PackageOptionName.MiddlewareNext) (res *http.Response, err error) {\n\t// Before the request\n\tstart := time.Now()\n\tLogReq(req)\n\n\t// Forward the request to the next handler\n\tres, err = next(req)\n\n\t// Handle stuff after the request\n\tend := time.Now()\n\tLogRes(res, err, start - end)\n\n return res, err\n}\n\nclient := SDK_PackageName.SDK_ClientInitializerName(\n\tSDK_PackageOptionName.WithMiddleware(Logger),\n)\n```\n\nWhen multiple middlewares are provided as variadic arguments, the middlewares\nare applied left to right. If `SDK_PackageOptionName.WithMiddleware` is given\nmultiple times, for example first in the client then the method, the\nmiddleware in the client will run first and the middleware given in the method\nwill run next.\n\nYou may also replace the default `http.Client` with\n`SDK_PackageOptionName.WithHTTPClient(client)`. Only one http client is\naccepted (this overwrites any previous client) and receives requests after any\nmiddleware has been applied.\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n2. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Finch-API/finch-api-go/issues) with questions, bugs, or suggestions.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n', }, { - "language": "java", - "content": "# Finch Java API Library\n\n\n[![Maven Central](https://img.shields.io/maven-central/v/com.tryfinch.api/finch-java)](https://central.sonatype.com/artifact/com.tryfinch.api/finch-java/0.0.1)\n[![javadoc](https://javadoc.io/badge2/com.tryfinch.api/finch-java/0.0.1/javadoc.svg)](https://javadoc.io/doc/com.tryfinch.api/finch-java/0.0.1)\n\n\nThe Finch Java SDK provides convenient access to the [Finch REST API](https://developer.tryfinch.com/) from applications written in Java.\n\nThe Finch Java SDK is similar to the Finch Kotlin SDK but with minor differences that make it more ergonomic for use in Java, such as `Optional` instead of nullable values, `Stream` instead of `Sequence`, and `CompletableFuture` instead of suspend functions.\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n\n\nThe REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/). Javadocs are available on [javadoc.io](https://javadoc.io/doc/com.tryfinch.api/finch-java/0.0.1).\n\n\n\n## Installation\n\n\n\n### Gradle\n\n~~~kotlin\nimplementation(\"com.tryfinch.api:finch-java:0.0.1\")\n~~~\n\n### Maven\n\n~~~xml\n\n com.tryfinch.api\n finch-java\n 0.0.1\n\n~~~\n\n\n\n## Requirements\n\nThis library requires Java 8 or later.\n\n## Usage\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisDirectoryListPage;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\nFinchClient client = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\nHrisDirectoryListPage page = client.hris().directory().list();\n```\n\n## Client configuration\n\nConfigure the client using system properties or environment variables:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n```\n\nOr manually:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n .accessToken(\"My Access Token\")\n .build();\n```\n\nOr using a combination of the two approaches:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n```\n\nSee this table for the available options:\n\n| Setter | System property | Environment variable | Required | Default value |\n| --------------- | --------------------- | ---------------------- | -------- | ---------------------------- |\n| `clientId` | `finch.clientId` | `FINCH_CLIENT_ID` | false | - |\n| `clientSecret` | `finch.clientSecret` | `FINCH_CLIENT_SECRET` | false | - |\n| `webhookSecret` | `finch.webhookSecret` | `FINCH_WEBHOOK_SECRET` | false | - |\n| `baseUrl` | `finch.baseUrl` | `FINCH_BASE_URL` | true | `\"https://api.tryfinch.com\"` |\n\nSystem properties take precedence over environment variables.\n\n> [!TIP]\n> Don't create more than one client in the same application. Each client has a connection pool and\n> thread pools, which are more efficient to share between requests.\n\n### Modifying configuration\n\nTo temporarily use a modified client configuration, while reusing the same connection and thread pools, call `withOptions()` on any client or service:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\n\nFinchClient clientWithOptions = client.withOptions(optionsBuilder -> {\n optionsBuilder.baseUrl(\"https://example.com\");\n optionsBuilder.maxRetries(42);\n});\n```\n\nThe `withOptions()` method does not affect the original client or service.\n\n## Requests and responses\n\nTo send a request to the Finch API, build an instance of some `Params` class and pass it to the corresponding client method. When the response is received, it will be deserialized into an instance of a Java class.\n\nFor example, `client.hris().directory().list(...)` should be called with an instance of `HrisDirectoryListParams`, and it will return an instance of `HrisDirectoryListPage`.\n\n## Immutability\n\nEach class in the SDK has an associated [builder](https://blogs.oracle.com/javamagazine/post/exploring-joshua-blochs-builder-design-pattern-in-java) or factory method for constructing it.\n\nEach class is [immutable](https://docs.oracle.com/javase/tutorial/essential/concurrency/immutable.html) once constructed. If the class has an associated builder, then it has a `toBuilder()` method, which can be used to convert it back to a builder for making a modified copy.\n\nBecause each class is immutable, builder modification will _never_ affect already built class instances.\n\n## Asynchronous execution\n\nThe default client is synchronous. To switch to asynchronous execution, call the `async()` method:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\nimport java.util.concurrent.CompletableFuture;\n\nFinchClient client = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\nCompletableFuture page = client.async().hris().directory().list();\n```\n\nOr create an asynchronous client from the beginning:\n\n```java\nimport com.tryfinch.api.client.FinchClientAsync;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClientAsync;\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\nimport java.util.concurrent.CompletableFuture;\n\nFinchClientAsync client = FinchOkHttpClientAsync.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\nCompletableFuture page = client.hris().directory().list();\n```\n\nThe asynchronous client supports the same options as the synchronous one, except most methods return `CompletableFuture`s.\n\n\n\n\n\n\n\n## Raw responses\n\nThe SDK defines methods that deserialize responses into instances of Java classes. However, these methods don't provide access to the response headers, status code, or the raw response body.\n\nTo access this data, prefix any HTTP method call on a client or service with `withRawResponse()`:\n\n```java\nimport com.tryfinch.api.core.http.Headers;\nimport com.tryfinch.api.core.http.HttpResponseFor;\nimport com.tryfinch.api.models.HrisDirectoryListPage;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\nHttpResponseFor page = client.hris().directory().withRawResponse().list();\n\nint statusCode = page.statusCode();\nHeaders headers = page.headers();\n```\n\nYou can still deserialize the response into an instance of a Java class if needed:\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListPage;\n\nHrisDirectoryListPage parsedPage = page.parse();\n```\n\n## Error handling\n\nThe SDK throws custom unchecked exception types:\n\n- [`FinchServiceException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchServiceException.kt): Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:\n\n | Status | Exception |\n | ------ | -------------------------------------------------- |\n | 400 | [`BadRequestException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/BadRequestException.kt) |\n | 401 | [`UnauthorizedException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/UnauthorizedException.kt) |\n | 403 | [`PermissionDeniedException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/PermissionDeniedException.kt) |\n | 404 | [`NotFoundException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/NotFoundException.kt) |\n | 422 | [`UnprocessableEntityException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/UnprocessableEntityException.kt) |\n | 429 | [`RateLimitException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/RateLimitException.kt) |\n | 5xx | [`InternalServerException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/InternalServerException.kt) |\n | others | [`UnexpectedStatusCodeException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/UnexpectedStatusCodeException.kt) |\n\n- [`FinchIoException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchIoException.kt): I/O networking errors.\n\n- [`FinchRetryableException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchRetryableException.kt): Generic error indicating a failure that could be retried by the client.\n\n- [`FinchInvalidDataException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchInvalidDataException.kt): Failure to interpret successfully parsed data. For example, when accessing a property that's supposed to be required, but the API unexpectedly omitted it from the response.\n\n- [`FinchException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchException.kt): Base class for all exceptions. Most errors will result in one of the previously mentioned ones, but completely generic errors may be thrown using the base class.\n\n## Pagination\n\nThe SDK defines methods that return a paginated lists of results. It provides convenient ways to access the results either one page at a time or item-by-item across all pages.\n\n### Auto-pagination\n\nTo iterate through all results across all pages, use the `autoPager()` method, which automatically fetches more pages as needed.\n\nWhen using the synchronous client, the method returns an [`Iterable`](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html)\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListPage;\nimport com.tryfinch.api.models.IndividualInDirectory;\n\nHrisDirectoryListPage page = client.hris().directory().list();\n\n// Process as an Iterable\nfor (IndividualInDirectory directory : page.autoPager()) {\n System.out.println(directory);\n}\n\n// Process as a Stream\npage.autoPager()\n .stream()\n .limit(50)\n .forEach(directory -> System.out.println(directory));\n```\n\nWhen using the asynchronous client, the method returns an [`AsyncStreamResponse`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/http/AsyncStreamResponse.kt):\n\n```java\nimport com.tryfinch.api.core.http.AsyncStreamResponse;\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync;\nimport com.tryfinch.api.models.IndividualInDirectory;\nimport java.util.Optional;\nimport java.util.concurrent.CompletableFuture;\n\nCompletableFuture pageFuture = client.async().hris().directory().list();\n\npageFuture.thenRun(page -> page.autoPager().subscribe(directory -> {\n System.out.println(directory);\n}));\n\n// If you need to handle errors or completion of the stream\npageFuture.thenRun(page -> page.autoPager().subscribe(new AsyncStreamResponse.Handler<>() {\n @Override\n public void onNext(IndividualInDirectory directory) {\n System.out.println(directory);\n }\n\n @Override\n public void onComplete(Optional error) {\n if (error.isPresent()) {\n System.out.println(\"Something went wrong!\");\n throw new RuntimeException(error.get());\n } else {\n System.out.println(\"No more!\");\n }\n }\n}));\n\n// Or use futures\npageFuture.thenRun(page -> page.autoPager()\n .subscribe(directory -> {\n System.out.println(directory);\n })\n .onCompleteFuture()\n .whenComplete((unused, error) -> {\n if (error != null) {\n System.out.println(\"Something went wrong!\");\n throw new RuntimeException(error);\n } else {\n System.out.println(\"No more!\");\n }\n }));\n```\n\n### Manual pagination\n\nTo access individual page items and manually request the next page, use the `items()`,\n`hasNextPage()`, and `nextPage()` methods:\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListPage;\nimport com.tryfinch.api.models.IndividualInDirectory;\n\nHrisDirectoryListPage page = client.hris().directory().list();\nwhile (true) {\n for (IndividualInDirectory directory : page.items()) {\n System.out.println(directory);\n }\n\n if (!page.hasNextPage()) {\n break;\n }\n\n page = page.nextPage();\n}\n```\n\n## Logging\n\nThe SDK uses the standard [OkHttp logging interceptor](https://github.com/square/okhttp/tree/master/okhttp-logging-interceptor).\n\nEnable logging by setting the `FINCH_LOG` environment variable to `info`:\n\n```sh\nexport FINCH_LOG=info\n```\n\nOr to `debug` for more verbose logging:\n\n```sh\nexport FINCH_LOG=debug\n```\n\n## ProGuard and R8\n\nAlthough the SDK uses reflection, it is still usable with [ProGuard](https://github.com/Guardsquare/proguard) and [R8](https://developer.android.com/topic/performance/app-optimization/enable-app-optimization) because `finch-java-core` is published with a [configuration file](finch-java-core/src/main/resources/META-INF/proguard/finch-java-core.pro) containing [keep rules](https://www.guardsquare.com/manual/configuration/usage).\n\nProGuard and R8 should automatically detect and use the published rules, but you can also manually copy the keep rules if necessary.\n\n\n\n\n\n## Jackson\n\nThe SDK depends on [Jackson](https://github.com/FasterXML/jackson) for JSON serialization/deserialization. It is compatible with version 2.13.4 or higher, but depends on version 2.18.2 by default.\n\nThe SDK throws an exception if it detects an incompatible Jackson version at runtime (e.g. if the default version was overridden in your Maven or Gradle config).\n\nIf the SDK threw an exception, but you're _certain_ the version is compatible, then disable the version check using the `checkJacksonVersionCompatibility` on [`FinchOkHttpClient`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt).\n\n> [!CAUTION]\n> We make no guarantee that the SDK works correctly when the Jackson version check is disabled.\n\nAlso note that there are bugs in older Jackson versions that can affect the SDK. We don't work around all Jackson bugs ([example](https://github.com/FasterXML/jackson-databind/issues/3240)) and expect users to upgrade Jackson for those instead.\n\n## Network options\n\n### Retries\n\nThe SDK automatically retries 2 times by default, with a short exponential backoff between requests.\n\nOnly the following error types are retried:\n- Connection errors (for example, due to a network connectivity problem)\n- 408 Request Timeout\n- 409 Conflict\n- 429 Rate Limit\n- 5xx Internal\n\nThe API may also explicitly instruct the SDK to retry or not retry a request.\n\nTo set a custom number of retries, configure the client using the `maxRetries` method:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .maxRetries(4)\n .accessToken(\"My Access Token\")\n .build();\n```\n\n### Timeouts\n\nRequests time out after 1 minute by default.\n\nTo set a custom timeout, configure the method call using the `timeout` method:\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListPage;\n\nHrisDirectoryListPage page = client.hris().directory().list(RequestOptions.builder().timeout(Duration.ofSeconds(30)).build());\n```\n\nOr configure the default for all method calls at the client level:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport java.time.Duration;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .timeout(Duration.ofSeconds(30))\n .accessToken(\"My Access Token\")\n .build();\n```\n\n### Proxies\n\nTo route requests through a proxy, configure the client using the `proxy` method:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport java.net.InetSocketAddress;\nimport java.net.Proxy;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .proxy(new Proxy(\n Proxy.Type.HTTP, new InetSocketAddress(\n \"https://example.com\", 8080\n )\n ))\n .accessToken(\"My Access Token\")\n .build();\n```\n\n### Connection pooling\n\nTo customize the underlying OkHttp connection pool, configure the client using the `maxIdleConnections` and `keepAliveDuration` methods:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport java.time.Duration;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n // If `maxIdleConnections` is set, then `keepAliveDuration` must be set, and vice versa.\n .maxIdleConnections(10)\n .keepAliveDuration(Duration.ofMinutes(2))\n .accessToken(\"My Access Token\")\n .build();\n```\n\nIf both options are unset, OkHttp's default connection pool settings are used.\n\n### HTTPS\n\n> [!NOTE]\n> Most applications should not call these methods, and instead use the system defaults. The defaults include\n> special optimizations that can be lost if the implementations are modified.\n\nTo configure how HTTPS connections are secured, configure the client using the `sslSocketFactory`, `trustManager`, and `hostnameVerifier` methods:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n // If `sslSocketFactory` is set, then `trustManager` must be set, and vice versa.\n .sslSocketFactory(yourSSLSocketFactory)\n .trustManager(yourTrustManager)\n .hostnameVerifier(yourHostnameVerifier)\n .accessToken(\"My Access Token\")\n .build();\n```\n\n\n\n### Custom HTTP client\n\nThe SDK consists of three artifacts:\n- `finch-java-core`\n - Contains core SDK logic\n - Does not depend on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`FinchClient`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClient.kt), [`FinchClientAsync`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsync.kt), [`FinchClientImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt), and [`FinchClientAsyncImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), all of which can work with any HTTP client\n- `finch-java-client-okhttp`\n - Depends on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`FinchOkHttpClient`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) and [`FinchOkHttpClientAsync`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), which provide a way to construct [`FinchClientImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) and [`FinchClientAsyncImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), respectively, using OkHttp\n- `finch-java`\n - Depends on and exposes the APIs of both `finch-java-core` and `finch-java-client-okhttp`\n - Does not have its own logic\n\nThis structure allows replacing the SDK's default HTTP client without pulling in unnecessary dependencies.\n\n#### Customized [`OkHttpClient`](https://square.github.io/okhttp/3.x/okhttp/okhttp3/OkHttpClient.html)\n\n> [!TIP]\n> Try the available [network options](#network-options) before replacing the default client.\n\nTo use a customized `OkHttpClient`:\n\n1. Replace your [`finch-java` dependency](#installation) with `finch-java-core`\n2. Copy `finch-java-client-okhttp`'s [`OkHttpClient`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/OkHttpClient.kt) class into your code and customize it\n3. Construct [`FinchClientImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) or [`FinchClientAsyncImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), similarly to [`FinchOkHttpClient`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), using your customized client\n\n### Completely custom HTTP client\n\nTo use a completely custom HTTP client:\n\n1. Replace your [`finch-java` dependency](#installation) with `finch-java-core`\n2. Write a class that implements the [`HttpClient`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/http/HttpClient.kt) interface\n3. Construct [`FinchClientImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) or [`FinchClientAsyncImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), similarly to [`FinchOkHttpClient`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), using your new client class\n\n## Undocumented API functionality\n\nThe SDK is typed for convenient usage of the documented API. However, it also supports working with undocumented or not yet supported parts of the API.\n\n### Parameters\n\nTo set undocumented parameters, call the `putAdditionalHeader`, `putAdditionalQueryParam`, or `putAdditionalBodyProperty` methods on any `Params` class:\n\n```java\nimport com.tryfinch.api.core.JsonValue;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\nHrisDirectoryListParams params = HrisDirectoryListParams.builder()\n .putAdditionalHeader(\"Secret-Header\", \"42\")\n .putAdditionalQueryParam(\"secret_query_param\", \"42\")\n .putAdditionalBodyProperty(\"secretProperty\", JsonValue.from(\"42\"))\n .build();\n```\n\nThese can be accessed on the built object later using the `_additionalHeaders()`, `_additionalQueryParams()`, and `_additionalBodyProperties()` methods.\n\nTo set a documented parameter or property to an undocumented or not yet supported _value_, pass a [`JsonValue`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/Values.kt) object to its setter:\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\nHrisDirectoryListParams params = HrisDirectoryListParams.builder().build();\n```\n\nThe most straightforward way to create a [`JsonValue`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/Values.kt) is using its `from(...)` method:\n\n```java\nimport com.tryfinch.api.core.JsonValue;\nimport java.util.List;\nimport java.util.Map;\n\n// Create primitive JSON values\nJsonValue nullValue = JsonValue.from(null);\nJsonValue booleanValue = JsonValue.from(true);\nJsonValue numberValue = JsonValue.from(42);\nJsonValue stringValue = JsonValue.from(\"Hello World!\");\n\n// Create a JSON array value equivalent to `[\"Hello\", \"World\"]`\nJsonValue arrayValue = JsonValue.from(List.of(\n \"Hello\", \"World\"\n));\n\n// Create a JSON object value equivalent to `{ \"a\": 1, \"b\": 2 }`\nJsonValue objectValue = JsonValue.from(Map.of(\n \"a\", 1,\n \"b\", 2\n));\n\n// Create an arbitrarily nested JSON equivalent to:\n// {\n// \"a\": [1, 2],\n// \"b\": [3, 4]\n// }\nJsonValue complexValue = JsonValue.from(Map.of(\n \"a\", List.of(\n 1, 2\n ),\n \"b\", List.of(\n 3, 4\n )\n));\n```\n\nNormally a `Builder` class's `build` method will throw [`IllegalStateException`](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) if any required parameter or property is unset.\n\nTo forcibly omit a required parameter or property, pass [`JsonMissing`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/Values.kt):\n\n```java\nimport com.tryfinch.api.core.JsonMissing;\nimport com.tryfinch.api.models.AccessTokenCreateParams;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\nHrisDirectoryListParams params = AccessTokenCreateParams.builder()\n .code(JsonMissing.of())\n .build();\n```\n\n### Response properties\n\nTo access undocumented response properties, call the `_additionalProperties()` method:\n\n```java\nimport com.tryfinch.api.core.JsonValue;\nimport java.util.Map;\n\nMap additionalProperties = client.accessTokens().create(params)._additionalProperties();\nJsonValue secretPropertyValue = additionalProperties.get(\"secretProperty\");\n\nString result = secretPropertyValue.accept(new JsonValue.Visitor<>() {\n @Override\n public String visitNull() {\n return \"It's null!\";\n }\n\n @Override\n public String visitBoolean(boolean value) {\n return \"It's a boolean!\";\n }\n\n @Override\n public String visitNumber(Number value) {\n return \"It's a number!\";\n }\n\n // Other methods include `visitMissing`, `visitString`, `visitArray`, and `visitObject`\n // The default implementation of each unimplemented method delegates to `visitDefault`, which throws by default, but can also be overridden\n});\n```\n\nTo access a property's raw JSON value, which may be undocumented, call its `_` prefixed method:\n\n```java\nimport com.tryfinch.api.core.JsonField;\nimport java.util.Optional;\n\nJsonField code = client.accessTokens().create(params)._code();\n\nif (code.isMissing()) {\n // The property is absent from the JSON response\n} else if (code.isNull()) {\n // The property was set to literal null\n} else {\n // Check if value was provided as a string\n // Other methods include `asNumber()`, `asBoolean()`, etc.\n Optional jsonString = code.asString();\n\n // Try to deserialize into a custom type\n MyClass myObject = code.asUnknown().orElseThrow().convert(MyClass.class);\n}\n```\n\n### Response validation\n\nIn rare cases, the API may return a response that doesn't match the expected type. For example, the SDK may expect a property to contain a `String`, but the API could return something else.\n\nBy default, the SDK will not throw an exception in this case. It will throw [`FinchInvalidDataException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchInvalidDataException.kt) only if you directly access the property.\n\nIf you would prefer to check that the response is completely well-typed upfront, then either call `validate()`:\n\n```java\nimport com.tryfinch.api.models.CreateAccessTokenResponse;\n\nCreateAccessTokenResponse createAccessTokenResponse = client.accessTokens().create(params).validate();\n```\n\nOr configure the method call to validate the response using the `responseValidation` method:\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListPage;\n\nHrisDirectoryListPage page = client.hris().directory().list(RequestOptions.builder().responseValidation(true).build());\n```\n\nOr configure the default for all method calls at the client level:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .responseValidation(true)\n .accessToken(\"My Access Token\")\n .build();\n```\n\n## FAQ\n\n### Why don't you use plain `enum` classes?\n\nJava `enum` classes are not trivially [forwards compatible](https://www.stainless.com/blog/making-java-enums-forwards-compatible). Using them in the SDK could cause runtime exceptions if the API is updated to respond with a new enum value.\n\n### Why do you represent fields using `JsonField` instead of just plain `T`?\n\nUsing `JsonField` enables a few features:\n\n- Allowing usage of [undocumented API functionality](#undocumented-api-functionality)\n- Lazily [validating the API response against the expected shape](#response-validation)\n- Representing absent vs explicitly null values\n\n### Why don't you use [`data` classes](https://kotlinlang.org/docs/data-classes.html)?\n\nIt is not [backwards compatible to add new fields to a data class](https://kotlinlang.org/docs/api-guidelines-backward-compatibility.html#avoid-using-data-classes-in-your-api) and we don't want to introduce a breaking change every time we add a field to a class.\n\n### Why don't you use checked exceptions?\n\nChecked exceptions are widely considered a mistake in the Java programming language. In fact, they were omitted from Kotlin for this reason.\n\nChecked exceptions:\n\n- Are verbose to handle\n- Encourage error handling at the wrong level of abstraction, where nothing can be done about the error\n- Are tedious to propagate due to the [function coloring problem](https://journal.stuffwithstuff.com/2015/02/01/what-color-is-your-function)\n- Don't play well with lambdas (also due to the function coloring problem)\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n2. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Finch-API/finch-api-java/issues) with questions, bugs, or suggestions.\n" + language: 'java', + content: + '# Finch Java API Library\n\n\n[![Maven Central](https://img.shields.io/maven-central/v/com.tryfinch.api/finch-java)](https://central.sonatype.com/artifact/com.tryfinch.api/finch-java/0.0.1)\n[![javadoc](https://javadoc.io/badge2/com.tryfinch.api/finch-java/0.0.1/javadoc.svg)](https://javadoc.io/doc/com.tryfinch.api/finch-java/0.0.1)\n\n\nThe Finch Java SDK provides convenient access to the [Finch REST API](https://developer.tryfinch.com/) from applications written in Java.\n\nThe Finch Java SDK is similar to the Finch Kotlin SDK but with minor differences that make it more ergonomic for use in Java, such as `Optional` instead of nullable values, `Stream` instead of `Sequence`, and `CompletableFuture` instead of suspend functions.\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n\n\nThe REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/). Javadocs are available on [javadoc.io](https://javadoc.io/doc/com.tryfinch.api/finch-java/0.0.1).\n\n\n\n## Installation\n\n\n\n### Gradle\n\n~~~kotlin\nimplementation("com.tryfinch.api:finch-java:0.0.1")\n~~~\n\n### Maven\n\n~~~xml\n\n com.tryfinch.api\n finch-java\n 0.0.1\n\n~~~\n\n\n\n## Requirements\n\nThis library requires Java 8 or later.\n\n## Usage\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisDirectoryListPage;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\nFinchClient client = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\nHrisDirectoryListPage page = client.hris().directory().list();\n```\n\n## Client configuration\n\nConfigure the client using system properties or environment variables:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n```\n\nOr manually:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n .accessToken("My Access Token")\n .build();\n```\n\nOr using a combination of the two approaches:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n```\n\nSee this table for the available options:\n\n| Setter | System property | Environment variable | Required | Default value |\n| --------------- | --------------------- | ---------------------- | -------- | ---------------------------- |\n| `clientId` | `finch.clientId` | `FINCH_CLIENT_ID` | false | - |\n| `clientSecret` | `finch.clientSecret` | `FINCH_CLIENT_SECRET` | false | - |\n| `webhookSecret` | `finch.webhookSecret` | `FINCH_WEBHOOK_SECRET` | false | - |\n| `baseUrl` | `finch.baseUrl` | `FINCH_BASE_URL` | true | `"https://api.tryfinch.com"` |\n\nSystem properties take precedence over environment variables.\n\n> [!TIP]\n> Don\'t create more than one client in the same application. Each client has a connection pool and\n> thread pools, which are more efficient to share between requests.\n\n### Modifying configuration\n\nTo temporarily use a modified client configuration, while reusing the same connection and thread pools, call `withOptions()` on any client or service:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\n\nFinchClient clientWithOptions = client.withOptions(optionsBuilder -> {\n optionsBuilder.baseUrl("https://example.com");\n optionsBuilder.maxRetries(42);\n});\n```\n\nThe `withOptions()` method does not affect the original client or service.\n\n## Requests and responses\n\nTo send a request to the Finch API, build an instance of some `Params` class and pass it to the corresponding client method. When the response is received, it will be deserialized into an instance of a Java class.\n\nFor example, `client.hris().directory().list(...)` should be called with an instance of `HrisDirectoryListParams`, and it will return an instance of `HrisDirectoryListPage`.\n\n## Immutability\n\nEach class in the SDK has an associated [builder](https://blogs.oracle.com/javamagazine/post/exploring-joshua-blochs-builder-design-pattern-in-java) or factory method for constructing it.\n\nEach class is [immutable](https://docs.oracle.com/javase/tutorial/essential/concurrency/immutable.html) once constructed. If the class has an associated builder, then it has a `toBuilder()` method, which can be used to convert it back to a builder for making a modified copy.\n\nBecause each class is immutable, builder modification will _never_ affect already built class instances.\n\n## Asynchronous execution\n\nThe default client is synchronous. To switch to asynchronous execution, call the `async()` method:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\nimport java.util.concurrent.CompletableFuture;\n\nFinchClient client = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\nCompletableFuture page = client.async().hris().directory().list();\n```\n\nOr create an asynchronous client from the beginning:\n\n```java\nimport com.tryfinch.api.client.FinchClientAsync;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClientAsync;\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\nimport java.util.concurrent.CompletableFuture;\n\nFinchClientAsync client = FinchOkHttpClientAsync.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\nCompletableFuture page = client.hris().directory().list();\n```\n\nThe asynchronous client supports the same options as the synchronous one, except most methods return `CompletableFuture`s.\n\n\n\n\n\n\n\n## Raw responses\n\nThe SDK defines methods that deserialize responses into instances of Java classes. However, these methods don\'t provide access to the response headers, status code, or the raw response body.\n\nTo access this data, prefix any HTTP method call on a client or service with `withRawResponse()`:\n\n```java\nimport com.tryfinch.api.core.http.Headers;\nimport com.tryfinch.api.core.http.HttpResponseFor;\nimport com.tryfinch.api.models.HrisDirectoryListPage;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\nHttpResponseFor page = client.hris().directory().withRawResponse().list();\n\nint statusCode = page.statusCode();\nHeaders headers = page.headers();\n```\n\nYou can still deserialize the response into an instance of a Java class if needed:\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListPage;\n\nHrisDirectoryListPage parsedPage = page.parse();\n```\n\n## Error handling\n\nThe SDK throws custom unchecked exception types:\n\n- [`FinchServiceException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchServiceException.kt): Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:\n\n | Status | Exception |\n | ------ | -------------------------------------------------- |\n | 400 | [`BadRequestException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/BadRequestException.kt) |\n | 401 | [`UnauthorizedException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/UnauthorizedException.kt) |\n | 403 | [`PermissionDeniedException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/PermissionDeniedException.kt) |\n | 404 | [`NotFoundException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/NotFoundException.kt) |\n | 422 | [`UnprocessableEntityException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/UnprocessableEntityException.kt) |\n | 429 | [`RateLimitException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/RateLimitException.kt) |\n | 5xx | [`InternalServerException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/InternalServerException.kt) |\n | others | [`UnexpectedStatusCodeException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/UnexpectedStatusCodeException.kt) |\n\n- [`FinchIoException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchIoException.kt): I/O networking errors.\n\n- [`FinchRetryableException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchRetryableException.kt): Generic error indicating a failure that could be retried by the client.\n\n- [`FinchInvalidDataException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchInvalidDataException.kt): Failure to interpret successfully parsed data. For example, when accessing a property that\'s supposed to be required, but the API unexpectedly omitted it from the response.\n\n- [`FinchException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchException.kt): Base class for all exceptions. Most errors will result in one of the previously mentioned ones, but completely generic errors may be thrown using the base class.\n\n## Pagination\n\nThe SDK defines methods that return a paginated lists of results. It provides convenient ways to access the results either one page at a time or item-by-item across all pages.\n\n### Auto-pagination\n\nTo iterate through all results across all pages, use the `autoPager()` method, which automatically fetches more pages as needed.\n\nWhen using the synchronous client, the method returns an [`Iterable`](https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html)\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListPage;\nimport com.tryfinch.api.models.IndividualInDirectory;\n\nHrisDirectoryListPage page = client.hris().directory().list();\n\n// Process as an Iterable\nfor (IndividualInDirectory directory : page.autoPager()) {\n System.out.println(directory);\n}\n\n// Process as a Stream\npage.autoPager()\n .stream()\n .limit(50)\n .forEach(directory -> System.out.println(directory));\n```\n\nWhen using the asynchronous client, the method returns an [`AsyncStreamResponse`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/http/AsyncStreamResponse.kt):\n\n```java\nimport com.tryfinch.api.core.http.AsyncStreamResponse;\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync;\nimport com.tryfinch.api.models.IndividualInDirectory;\nimport java.util.Optional;\nimport java.util.concurrent.CompletableFuture;\n\nCompletableFuture pageFuture = client.async().hris().directory().list();\n\npageFuture.thenRun(page -> page.autoPager().subscribe(directory -> {\n System.out.println(directory);\n}));\n\n// If you need to handle errors or completion of the stream\npageFuture.thenRun(page -> page.autoPager().subscribe(new AsyncStreamResponse.Handler<>() {\n @Override\n public void onNext(IndividualInDirectory directory) {\n System.out.println(directory);\n }\n\n @Override\n public void onComplete(Optional error) {\n if (error.isPresent()) {\n System.out.println("Something went wrong!");\n throw new RuntimeException(error.get());\n } else {\n System.out.println("No more!");\n }\n }\n}));\n\n// Or use futures\npageFuture.thenRun(page -> page.autoPager()\n .subscribe(directory -> {\n System.out.println(directory);\n })\n .onCompleteFuture()\n .whenComplete((unused, error) -> {\n if (error != null) {\n System.out.println("Something went wrong!");\n throw new RuntimeException(error);\n } else {\n System.out.println("No more!");\n }\n }));\n```\n\n### Manual pagination\n\nTo access individual page items and manually request the next page, use the `items()`,\n`hasNextPage()`, and `nextPage()` methods:\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListPage;\nimport com.tryfinch.api.models.IndividualInDirectory;\n\nHrisDirectoryListPage page = client.hris().directory().list();\nwhile (true) {\n for (IndividualInDirectory directory : page.items()) {\n System.out.println(directory);\n }\n\n if (!page.hasNextPage()) {\n break;\n }\n\n page = page.nextPage();\n}\n```\n\n## Logging\n\nThe SDK uses the standard [OkHttp logging interceptor](https://github.com/square/okhttp/tree/master/okhttp-logging-interceptor).\n\nEnable logging by setting the `FINCH_LOG` environment variable to `info`:\n\n```sh\nexport FINCH_LOG=info\n```\n\nOr to `debug` for more verbose logging:\n\n```sh\nexport FINCH_LOG=debug\n```\n\n## ProGuard and R8\n\nAlthough the SDK uses reflection, it is still usable with [ProGuard](https://github.com/Guardsquare/proguard) and [R8](https://developer.android.com/topic/performance/app-optimization/enable-app-optimization) because `finch-java-core` is published with a [configuration file](finch-java-core/src/main/resources/META-INF/proguard/finch-java-core.pro) containing [keep rules](https://www.guardsquare.com/manual/configuration/usage).\n\nProGuard and R8 should automatically detect and use the published rules, but you can also manually copy the keep rules if necessary.\n\n\n\n\n\n## Jackson\n\nThe SDK depends on [Jackson](https://github.com/FasterXML/jackson) for JSON serialization/deserialization. It is compatible with version 2.13.4 or higher, but depends on version 2.18.2 by default.\n\nThe SDK throws an exception if it detects an incompatible Jackson version at runtime (e.g. if the default version was overridden in your Maven or Gradle config).\n\nIf the SDK threw an exception, but you\'re _certain_ the version is compatible, then disable the version check using the `checkJacksonVersionCompatibility` on [`FinchOkHttpClient`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt).\n\n> [!CAUTION]\n> We make no guarantee that the SDK works correctly when the Jackson version check is disabled.\n\nAlso note that there are bugs in older Jackson versions that can affect the SDK. We don\'t work around all Jackson bugs ([example](https://github.com/FasterXML/jackson-databind/issues/3240)) and expect users to upgrade Jackson for those instead.\n\n## Network options\n\n### Retries\n\nThe SDK automatically retries 2 times by default, with a short exponential backoff between requests.\n\nOnly the following error types are retried:\n- Connection errors (for example, due to a network connectivity problem)\n- 408 Request Timeout\n- 409 Conflict\n- 429 Rate Limit\n- 5xx Internal\n\nThe API may also explicitly instruct the SDK to retry or not retry a request.\n\nTo set a custom number of retries, configure the client using the `maxRetries` method:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .maxRetries(4)\n .accessToken("My Access Token")\n .build();\n```\n\n### Timeouts\n\nRequests time out after 1 minute by default.\n\nTo set a custom timeout, configure the method call using the `timeout` method:\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListPage;\n\nHrisDirectoryListPage page = client.hris().directory().list(RequestOptions.builder().timeout(Duration.ofSeconds(30)).build());\n```\n\nOr configure the default for all method calls at the client level:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport java.time.Duration;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .timeout(Duration.ofSeconds(30))\n .accessToken("My Access Token")\n .build();\n```\n\n### Proxies\n\nTo route requests through a proxy, configure the client using the `proxy` method:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport java.net.InetSocketAddress;\nimport java.net.Proxy;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .proxy(new Proxy(\n Proxy.Type.HTTP, new InetSocketAddress(\n "https://example.com", 8080\n )\n ))\n .accessToken("My Access Token")\n .build();\n```\n\n### Connection pooling\n\nTo customize the underlying OkHttp connection pool, configure the client using the `maxIdleConnections` and `keepAliveDuration` methods:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport java.time.Duration;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n // If `maxIdleConnections` is set, then `keepAliveDuration` must be set, and vice versa.\n .maxIdleConnections(10)\n .keepAliveDuration(Duration.ofMinutes(2))\n .accessToken("My Access Token")\n .build();\n```\n\nIf both options are unset, OkHttp\'s default connection pool settings are used.\n\n### HTTPS\n\n> [!NOTE]\n> Most applications should not call these methods, and instead use the system defaults. The defaults include\n> special optimizations that can be lost if the implementations are modified.\n\nTo configure how HTTPS connections are secured, configure the client using the `sslSocketFactory`, `trustManager`, and `hostnameVerifier` methods:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n // If `sslSocketFactory` is set, then `trustManager` must be set, and vice versa.\n .sslSocketFactory(yourSSLSocketFactory)\n .trustManager(yourTrustManager)\n .hostnameVerifier(yourHostnameVerifier)\n .accessToken("My Access Token")\n .build();\n```\n\n\n\n### Custom HTTP client\n\nThe SDK consists of three artifacts:\n- `finch-java-core`\n - Contains core SDK logic\n - Does not depend on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`FinchClient`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClient.kt), [`FinchClientAsync`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsync.kt), [`FinchClientImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt), and [`FinchClientAsyncImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), all of which can work with any HTTP client\n- `finch-java-client-okhttp`\n - Depends on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`FinchOkHttpClient`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) and [`FinchOkHttpClientAsync`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), which provide a way to construct [`FinchClientImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) and [`FinchClientAsyncImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), respectively, using OkHttp\n- `finch-java`\n - Depends on and exposes the APIs of both `finch-java-core` and `finch-java-client-okhttp`\n - Does not have its own logic\n\nThis structure allows replacing the SDK\'s default HTTP client without pulling in unnecessary dependencies.\n\n#### Customized [`OkHttpClient`](https://square.github.io/okhttp/3.x/okhttp/okhttp3/OkHttpClient.html)\n\n> [!TIP]\n> Try the available [network options](#network-options) before replacing the default client.\n\nTo use a customized `OkHttpClient`:\n\n1. Replace your [`finch-java` dependency](#installation) with `finch-java-core`\n2. Copy `finch-java-client-okhttp`\'s [`OkHttpClient`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/OkHttpClient.kt) class into your code and customize it\n3. Construct [`FinchClientImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) or [`FinchClientAsyncImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), similarly to [`FinchOkHttpClient`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), using your customized client\n\n### Completely custom HTTP client\n\nTo use a completely custom HTTP client:\n\n1. Replace your [`finch-java` dependency](#installation) with `finch-java-core`\n2. Write a class that implements the [`HttpClient`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/http/HttpClient.kt) interface\n3. Construct [`FinchClientImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) or [`FinchClientAsyncImpl`](finch-java-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), similarly to [`FinchOkHttpClient`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-java-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), using your new client class\n\n## Undocumented API functionality\n\nThe SDK is typed for convenient usage of the documented API. However, it also supports working with undocumented or not yet supported parts of the API.\n\n### Parameters\n\nTo set undocumented parameters, call the `putAdditionalHeader`, `putAdditionalQueryParam`, or `putAdditionalBodyProperty` methods on any `Params` class:\n\n```java\nimport com.tryfinch.api.core.JsonValue;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\nHrisDirectoryListParams params = HrisDirectoryListParams.builder()\n .putAdditionalHeader("Secret-Header", "42")\n .putAdditionalQueryParam("secret_query_param", "42")\n .putAdditionalBodyProperty("secretProperty", JsonValue.from("42"))\n .build();\n```\n\nThese can be accessed on the built object later using the `_additionalHeaders()`, `_additionalQueryParams()`, and `_additionalBodyProperties()` methods.\n\nTo set a documented parameter or property to an undocumented or not yet supported _value_, pass a [`JsonValue`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/Values.kt) object to its setter:\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\nHrisDirectoryListParams params = HrisDirectoryListParams.builder().build();\n```\n\nThe most straightforward way to create a [`JsonValue`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/Values.kt) is using its `from(...)` method:\n\n```java\nimport com.tryfinch.api.core.JsonValue;\nimport java.util.List;\nimport java.util.Map;\n\n// Create primitive JSON values\nJsonValue nullValue = JsonValue.from(null);\nJsonValue booleanValue = JsonValue.from(true);\nJsonValue numberValue = JsonValue.from(42);\nJsonValue stringValue = JsonValue.from("Hello World!");\n\n// Create a JSON array value equivalent to `["Hello", "World"]`\nJsonValue arrayValue = JsonValue.from(List.of(\n "Hello", "World"\n));\n\n// Create a JSON object value equivalent to `{ "a": 1, "b": 2 }`\nJsonValue objectValue = JsonValue.from(Map.of(\n "a", 1,\n "b", 2\n));\n\n// Create an arbitrarily nested JSON equivalent to:\n// {\n// "a": [1, 2],\n// "b": [3, 4]\n// }\nJsonValue complexValue = JsonValue.from(Map.of(\n "a", List.of(\n 1, 2\n ),\n "b", List.of(\n 3, 4\n )\n));\n```\n\nNormally a `Builder` class\'s `build` method will throw [`IllegalStateException`](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) if any required parameter or property is unset.\n\nTo forcibly omit a required parameter or property, pass [`JsonMissing`](finch-java-core/src/main/kotlin/com/tryfinch/api/core/Values.kt):\n\n```java\nimport com.tryfinch.api.core.JsonMissing;\nimport com.tryfinch.api.models.AccessTokenCreateParams;\nimport com.tryfinch.api.models.HrisDirectoryListParams;\n\nHrisDirectoryListParams params = AccessTokenCreateParams.builder()\n .code(JsonMissing.of())\n .build();\n```\n\n### Response properties\n\nTo access undocumented response properties, call the `_additionalProperties()` method:\n\n```java\nimport com.tryfinch.api.core.JsonValue;\nimport java.util.Map;\n\nMap additionalProperties = client.accessTokens().create(params)._additionalProperties();\nJsonValue secretPropertyValue = additionalProperties.get("secretProperty");\n\nString result = secretPropertyValue.accept(new JsonValue.Visitor<>() {\n @Override\n public String visitNull() {\n return "It\'s null!";\n }\n\n @Override\n public String visitBoolean(boolean value) {\n return "It\'s a boolean!";\n }\n\n @Override\n public String visitNumber(Number value) {\n return "It\'s a number!";\n }\n\n // Other methods include `visitMissing`, `visitString`, `visitArray`, and `visitObject`\n // The default implementation of each unimplemented method delegates to `visitDefault`, which throws by default, but can also be overridden\n});\n```\n\nTo access a property\'s raw JSON value, which may be undocumented, call its `_` prefixed method:\n\n```java\nimport com.tryfinch.api.core.JsonField;\nimport java.util.Optional;\n\nJsonField code = client.accessTokens().create(params)._code();\n\nif (code.isMissing()) {\n // The property is absent from the JSON response\n} else if (code.isNull()) {\n // The property was set to literal null\n} else {\n // Check if value was provided as a string\n // Other methods include `asNumber()`, `asBoolean()`, etc.\n Optional jsonString = code.asString();\n\n // Try to deserialize into a custom type\n MyClass myObject = code.asUnknown().orElseThrow().convert(MyClass.class);\n}\n```\n\n### Response validation\n\nIn rare cases, the API may return a response that doesn\'t match the expected type. For example, the SDK may expect a property to contain a `String`, but the API could return something else.\n\nBy default, the SDK will not throw an exception in this case. It will throw [`FinchInvalidDataException`](finch-java-core/src/main/kotlin/com/tryfinch/api/errors/FinchInvalidDataException.kt) only if you directly access the property.\n\nIf you would prefer to check that the response is completely well-typed upfront, then either call `validate()`:\n\n```java\nimport com.tryfinch.api.models.CreateAccessTokenResponse;\n\nCreateAccessTokenResponse createAccessTokenResponse = client.accessTokens().create(params).validate();\n```\n\nOr configure the method call to validate the response using the `responseValidation` method:\n\n```java\nimport com.tryfinch.api.models.HrisDirectoryListPage;\n\nHrisDirectoryListPage page = client.hris().directory().list(RequestOptions.builder().responseValidation(true).build());\n```\n\nOr configure the default for all method calls at the client level:\n\n```java\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\n\nFinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .responseValidation(true)\n .accessToken("My Access Token")\n .build();\n```\n\n## FAQ\n\n### Why don\'t you use plain `enum` classes?\n\nJava `enum` classes are not trivially [forwards compatible](https://www.stainless.com/blog/making-java-enums-forwards-compatible). Using them in the SDK could cause runtime exceptions if the API is updated to respond with a new enum value.\n\n### Why do you represent fields using `JsonField` instead of just plain `T`?\n\nUsing `JsonField` enables a few features:\n\n- Allowing usage of [undocumented API functionality](#undocumented-api-functionality)\n- Lazily [validating the API response against the expected shape](#response-validation)\n- Representing absent vs explicitly null values\n\n### Why don\'t you use [`data` classes](https://kotlinlang.org/docs/data-classes.html)?\n\nIt is not [backwards compatible to add new fields to a data class](https://kotlinlang.org/docs/api-guidelines-backward-compatibility.html#avoid-using-data-classes-in-your-api) and we don\'t want to introduce a breaking change every time we add a field to a class.\n\n### Why don\'t you use checked exceptions?\n\nChecked exceptions are widely considered a mistake in the Java programming language. In fact, they were omitted from Kotlin for this reason.\n\nChecked exceptions:\n\n- Are verbose to handle\n- Encourage error handling at the wrong level of abstraction, where nothing can be done about the error\n- Are tedious to propagate due to the [function coloring problem](https://journal.stuffwithstuff.com/2015/02/01/what-color-is-your-function)\n- Don\'t play well with lambdas (also due to the function coloring problem)\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n2. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Finch-API/finch-api-java/issues) with questions, bugs, or suggestions.\n', }, { - "language": "kotlin", - "content": "# Finch Kotlin API Library\n\n\n[![Maven Central](https://img.shields.io/maven-central/v/com.tryfinch.api/finch-kotlin)](https://central.sonatype.com/artifact/com.tryfinch.api/finch-kotlin/0.0.1)\n[![javadoc](https://javadoc.io/badge2/com.tryfinch.api/finch-kotlin/0.0.1/javadoc.svg)](https://javadoc.io/doc/com.tryfinch.api/finch-kotlin/0.0.1)\n\n\nThe Finch Kotlin SDK provides convenient access to the [Finch REST API](https://developer.tryfinch.com/) from applications written in Kotlin.\n\nThe Finch Kotlin SDK is similar to the Finch Java SDK but with minor differences that make it more ergonomic for use in Kotlin, such as nullable values instead of `Optional`, `Sequence` instead of `Stream`, and suspend functions instead of `CompletableFuture`.\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n\n\nThe REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/). KDocs are available on [javadoc.io](https://javadoc.io/doc/com.tryfinch.api/finch-kotlin/0.0.1).\n\n\n\n## Installation\n\n\n\n### Gradle\n\n~~~kotlin\nimplementation(\"com.tryfinch.api:finch-kotlin:0.0.1\")\n~~~\n\n### Maven\n\n~~~xml\n\n com.tryfinch.api\n finch-kotlin\n 0.0.1\n\n~~~\n\n\n\n## Requirements\n\nThis library requires Java 8 or later.\n\n## Usage\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisDirectoryListPage\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval client: FinchClient = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\nval page: HrisDirectoryListPage = client.hris().directory().list()\n```\n\n## Client configuration\n\nConfigure the client using system properties or environment variables:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n```\n\nOr manually:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .accessToken(\"My Access Token\")\n .build()\n```\n\nOr using a combination of the two approaches:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n```\n\nSee this table for the available options:\n\n| Setter | System property | Environment variable | Required | Default value |\n| --------------- | --------------------- | ---------------------- | -------- | ---------------------------- |\n| `clientId` | `finch.clientId` | `FINCH_CLIENT_ID` | false | - |\n| `clientSecret` | `finch.clientSecret` | `FINCH_CLIENT_SECRET` | false | - |\n| `webhookSecret` | `finch.webhookSecret` | `FINCH_WEBHOOK_SECRET` | false | - |\n| `baseUrl` | `finch.baseUrl` | `FINCH_BASE_URL` | true | `\"https://api.tryfinch.com\"` |\n\nSystem properties take precedence over environment variables.\n\n> [!TIP]\n> Don't create more than one client in the same application. Each client has a connection pool and\n> thread pools, which are more efficient to share between requests.\n\n### Modifying configuration\n\nTo temporarily use a modified client configuration, while reusing the same connection and thread pools, call `withOptions()` on any client or service:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\n\nval clientWithOptions: FinchClient = client.withOptions {\n it.baseUrl(\"https://example.com\")\n it.maxRetries(42)\n}\n```\n\nThe `withOptions()` method does not affect the original client or service.\n\n## Requests and responses\n\nTo send a request to the Finch API, build an instance of some `Params` class and pass it to the corresponding client method. When the response is received, it will be deserialized into an instance of a Kotlin class.\n\nFor example, `client.hris().directory().list(...)` should be called with an instance of `HrisDirectoryListParams`, and it will return an instance of `HrisDirectoryListPage`.\n\n## Immutability\n\nEach class in the SDK has an associated [builder](https://blogs.oracle.com/javamagazine/post/exploring-joshua-blochs-builder-design-pattern-in-java) or factory method for constructing it.\n\nEach class is [immutable](https://docs.oracle.com/javase/tutorial/essential/concurrency/immutable.html) once constructed. If the class has an associated builder, then it has a `toBuilder()` method, which can be used to convert it back to a builder for making a modified copy.\n\nBecause each class is immutable, builder modification will _never_ affect already built class instances.\n\n## Asynchronous execution\n\nThe default client is synchronous. To switch to asynchronous execution, call the `async()` method:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval client: FinchClient = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\nval page: HrisDirectoryListPageAsync = client.async().hris().directory().list()\n```\n\nOr create an asynchronous client from the beginning:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClientAsync\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClientAsync\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval client: FinchClientAsync = FinchOkHttpClientAsync.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\nval page: HrisDirectoryListPageAsync = client.hris().directory().list()\n```\n\nThe asynchronous client supports the same options as the synchronous one, except most methods are [suspending](https://kotlinlang.org/docs/coroutines-guide.html).\n\n\n\n\n\n\n\n## Raw responses\n\nThe SDK defines methods that deserialize responses into instances of Kotlin classes. However, these methods don't provide access to the response headers, status code, or the raw response body.\n\nTo access this data, prefix any HTTP method call on a client or service with `withRawResponse()`:\n\n```kotlin\nimport com.tryfinch.api.core.http.Headers\nimport com.tryfinch.api.core.http.HttpResponseFor\nimport com.tryfinch.api.models.HrisDirectoryListPage\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval page: HttpResponseFor = client.hris().directory().withRawResponse().list()\n\nval statusCode: Int = page.statusCode()\nval headers: Headers = page.headers()\n```\n\nYou can still deserialize the response into an instance of a Kotlin class if needed:\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPage\n\nval parsedPage: HrisDirectoryListPage = page.parse()\n```\n\n## Error handling\n\nThe SDK throws custom unchecked exception types:\n\n- [`FinchServiceException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchServiceException.kt): Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:\n\n | Status | Exception |\n | ------ | -------------------------------------------------- |\n | 400 | [`BadRequestException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/BadRequestException.kt) |\n | 401 | [`UnauthorizedException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/UnauthorizedException.kt) |\n | 403 | [`PermissionDeniedException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/PermissionDeniedException.kt) |\n | 404 | [`NotFoundException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/NotFoundException.kt) |\n | 422 | [`UnprocessableEntityException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/UnprocessableEntityException.kt) |\n | 429 | [`RateLimitException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/RateLimitException.kt) |\n | 5xx | [`InternalServerException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/InternalServerException.kt) |\n | others | [`UnexpectedStatusCodeException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/UnexpectedStatusCodeException.kt) |\n\n- [`FinchIoException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchIoException.kt): I/O networking errors.\n\n- [`FinchRetryableException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchRetryableException.kt): Generic error indicating a failure that could be retried by the client.\n\n- [`FinchInvalidDataException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchInvalidDataException.kt): Failure to interpret successfully parsed data. For example, when accessing a property that's supposed to be required, but the API unexpectedly omitted it from the response.\n\n- [`FinchException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchException.kt): Base class for all exceptions. Most errors will result in one of the previously mentioned ones, but completely generic errors may be thrown using the base class.\n\n## Pagination\n\nThe SDK defines methods that return a paginated lists of results. It provides convenient ways to access the results either one page at a time or item-by-item across all pages.\n\n### Auto-pagination\n\nTo iterate through all results across all pages, use the `autoPager()` method, which automatically fetches more pages as needed.\n\nWhen using the synchronous client, the method returns a [`Sequence`](https://kotlinlang.org/docs/sequences.html)\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPage\n\nval page: HrisDirectoryListPage = client.hris().directory().list()\npage.autoPager()\n .take(50)\n .forEach { directory -> println(directory) }\n```\n\nWhen using the asynchronous client, the method returns a [`Flow`](https://kotlinlang.org/docs/flow.html):\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync\n\nval page: HrisDirectoryListPageAsync = client.async().hris().directory().list()\npage.autoPager()\n .take(50)\n .forEach { directory -> println(directory) }\n```\n\n### Manual pagination\n\nTo access individual page items and manually request the next page, use the `items()`,\n`hasNextPage()`, and `nextPage()` methods:\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPage\nimport com.tryfinch.api.models.IndividualInDirectory\n\nval page: HrisDirectoryListPage = client.hris().directory().list()\nwhile (true) {\n for (directory in page.items()) {\n println(directory)\n }\n\n if (!page.hasNextPage()) {\n break\n }\n\n page = page.nextPage()\n}\n```\n\n## Logging\n\nThe SDK uses the standard [OkHttp logging interceptor](https://github.com/square/okhttp/tree/master/okhttp-logging-interceptor).\n\nEnable logging by setting the `FINCH_LOG` environment variable to `info`:\n\n```sh\nexport FINCH_LOG=info\n```\n\nOr to `debug` for more verbose logging:\n\n```sh\nexport FINCH_LOG=debug\n```\n\n## ProGuard and R8\n\nAlthough the SDK uses reflection, it is still usable with [ProGuard](https://github.com/Guardsquare/proguard) and [R8](https://developer.android.com/topic/performance/app-optimization/enable-app-optimization) because `finch-kotlin-core` is published with a [configuration file](finch-kotlin-core/src/main/resources/META-INF/proguard/finch-kotlin-core.pro) containing [keep rules](https://www.guardsquare.com/manual/configuration/usage).\n\nProGuard and R8 should automatically detect and use the published rules, but you can also manually copy the keep rules if necessary.\n\n\n\n\n\n## Jackson\n\nThe SDK depends on [Jackson](https://github.com/FasterXML/jackson) for JSON serialization/deserialization. It is compatible with version 2.13.4 or higher, but depends on version 2.18.2 by default.\n\nThe SDK throws an exception if it detects an incompatible Jackson version at runtime (e.g. if the default version was overridden in your Maven or Gradle config).\n\nIf the SDK threw an exception, but you're _certain_ the version is compatible, then disable the version check using the `checkJacksonVersionCompatibility` on [`FinchOkHttpClient`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt).\n\n> [!CAUTION]\n> We make no guarantee that the SDK works correctly when the Jackson version check is disabled.\n\nAlso note that there are bugs in older Jackson versions that can affect the SDK. We don't work around all Jackson bugs ([example](https://github.com/FasterXML/jackson-databind/issues/3240)) and expect users to upgrade Jackson for those instead.\n\n## Network options\n\n### Retries\n\nThe SDK automatically retries 2 times by default, with a short exponential backoff between requests.\n\nOnly the following error types are retried:\n- Connection errors (for example, due to a network connectivity problem)\n- 408 Request Timeout\n- 409 Conflict\n- 429 Rate Limit\n- 5xx Internal\n\nThe API may also explicitly instruct the SDK to retry or not retry a request.\n\nTo set a custom number of retries, configure the client using the `maxRetries` method:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .maxRetries(4)\n .accessToken(\"My Access Token\")\n .build()\n```\n\n### Timeouts\n\nRequests time out after 1 minute by default.\n\nTo set a custom timeout, configure the method call using the `timeout` method:\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPage\n\nval page: HrisDirectoryListPage = client.hris().directory().list(RequestOptions.builder().timeout(Duration.ofSeconds(30)).build())\n```\n\nOr configure the default for all method calls at the client level:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport java.time.Duration\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .timeout(Duration.ofSeconds(30))\n .accessToken(\"My Access Token\")\n .build()\n```\n\n### Proxies\n\nTo route requests through a proxy, configure the client using the `proxy` method:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport java.net.InetSocketAddress\nimport java.net.Proxy\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .proxy(Proxy(\n Proxy.Type.HTTP, InetSocketAddress(\n \"https://example.com\", 8080\n )\n ))\n .accessToken(\"My Access Token\")\n .build()\n```\n\n### Connection pooling\n\nTo customize the underlying OkHttp connection pool, configure the client using the `maxIdleConnections` and `keepAliveDuration` methods:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport java.time.Duration\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n // If `maxIdleConnections` is set, then `keepAliveDuration` must be set, and vice versa.\n .maxIdleConnections(10)\n .keepAliveDuration(Duration.ofMinutes(2))\n .accessToken(\"My Access Token\")\n .build()\n```\n\nIf both options are unset, OkHttp's default connection pool settings are used.\n\n### HTTPS\n\n> [!NOTE]\n> Most applications should not call these methods, and instead use the system defaults. The defaults include\n> special optimizations that can be lost if the implementations are modified.\n\nTo configure how HTTPS connections are secured, configure the client using the `sslSocketFactory`, `trustManager`, and `hostnameVerifier` methods:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n // If `sslSocketFactory` is set, then `trustManager` must be set, and vice versa.\n .sslSocketFactory(yourSSLSocketFactory)\n .trustManager(yourTrustManager)\n .hostnameVerifier(yourHostnameVerifier)\n .accessToken(\"My Access Token\")\n .build()\n```\n\n\n\n### Custom HTTP client\n\nThe SDK consists of three artifacts:\n- `finch-kotlin-core`\n - Contains core SDK logic\n - Does not depend on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`FinchClient`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClient.kt), [`FinchClientAsync`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsync.kt), [`FinchClientImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt), and [`FinchClientAsyncImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), all of which can work with any HTTP client\n- `finch-kotlin-client-okhttp`\n - Depends on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`FinchOkHttpClient`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) and [`FinchOkHttpClientAsync`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), which provide a way to construct [`FinchClientImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) and [`FinchClientAsyncImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), respectively, using OkHttp\n- `finch-kotlin`\n - Depends on and exposes the APIs of both `finch-kotlin-core` and `finch-kotlin-client-okhttp`\n - Does not have its own logic\n\nThis structure allows replacing the SDK's default HTTP client without pulling in unnecessary dependencies.\n\n#### Customized [`OkHttpClient`](https://square.github.io/okhttp/3.x/okhttp/okhttp3/OkHttpClient.html)\n\n> [!TIP]\n> Try the available [network options](#network-options) before replacing the default client.\n\nTo use a customized `OkHttpClient`:\n\n1. Replace your [`finch-kotlin` dependency](#installation) with `finch-kotlin-core`\n2. Copy `finch-kotlin-client-okhttp`'s [`OkHttpClient`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/OkHttpClient.kt) class into your code and customize it\n3. Construct [`FinchClientImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) or [`FinchClientAsyncImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), similarly to [`FinchOkHttpClient`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), using your customized client\n\n### Completely custom HTTP client\n\nTo use a completely custom HTTP client:\n\n1. Replace your [`finch-kotlin` dependency](#installation) with `finch-kotlin-core`\n2. Write a class that implements the [`HttpClient`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/core/http/HttpClient.kt) interface\n3. Construct [`FinchClientImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) or [`FinchClientAsyncImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), similarly to [`FinchOkHttpClient`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), using your new client class\n\n## Undocumented API functionality\n\nThe SDK is typed for convenient usage of the documented API. However, it also supports working with undocumented or not yet supported parts of the API.\n\n### Parameters\n\nTo set undocumented parameters, call the `putAdditionalHeader`, `putAdditionalQueryParam`, or `putAdditionalBodyProperty` methods on any `Params` class:\n\n```kotlin\nimport com.tryfinch.api.core.JsonValue\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval params: HrisDirectoryListParams = HrisDirectoryListParams.builder()\n .putAdditionalHeader(\"Secret-Header\", \"42\")\n .putAdditionalQueryParam(\"secret_query_param\", \"42\")\n .putAdditionalBodyProperty(\"secretProperty\", JsonValue.from(\"42\"))\n .build()\n```\n\nThese can be accessed on the built object later using the `_additionalHeaders()`, `_additionalQueryParams()`, and `_additionalBodyProperties()` methods.\n\nTo set a documented parameter or property to an undocumented or not yet supported _value_, pass a [`JsonValue`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/core/Values.kt) object to its setter:\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval params: HrisDirectoryListParams = HrisDirectoryListParams.builder().build()\n```\n\nThe most straightforward way to create a [`JsonValue`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/core/Values.kt) is using its `from(...)` method:\n\n```kotlin\nimport com.tryfinch.api.core.JsonValue\n\n// Create primitive JSON values\nval nullValue: JsonValue = JsonValue.from(null)\nval booleanValue: JsonValue = JsonValue.from(true)\nval numberValue: JsonValue = JsonValue.from(42)\nval stringValue: JsonValue = JsonValue.from(\"Hello World!\")\n\n// Create a JSON array value equivalent to `[\"Hello\", \"World\"]`\nval arrayValue: JsonValue = JsonValue.from(listOf(\n \"Hello\", \"World\"\n))\n\n// Create a JSON object value equivalent to `{ \"a\": 1, \"b\": 2 }`\nval objectValue: JsonValue = JsonValue.from(mapOf(\n \"a\" to 1, \"b\" to 2\n))\n\n// Create an arbitrarily nested JSON equivalent to:\n// {\n// \"a\": [1, 2],\n// \"b\": [3, 4]\n// }\nval complexValue: JsonValue = JsonValue.from(mapOf(\n \"a\" to listOf(\n 1, 2\n ), \"b\" to listOf(\n 3, 4\n )\n))\n```\n\nNormally a `Builder` class's `build` method will throw [`IllegalStateException`](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) if any required parameter or property is unset.\n\nTo forcibly omit a required parameter or property, pass [`JsonMissing`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/core/Values.kt):\n\n```kotlin\nimport com.tryfinch.api.core.JsonMissing\nimport com.tryfinch.api.models.AccessTokenCreateParams\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval params: HrisDirectoryListParams = AccessTokenCreateParams.builder()\n .code(JsonMissing.of())\n .build()\n```\n\n### Response properties\n\nTo access undocumented response properties, call the `_additionalProperties()` method:\n\n```kotlin\nimport com.tryfinch.api.core.JsonBoolean\nimport com.tryfinch.api.core.JsonNull\nimport com.tryfinch.api.core.JsonNumber\nimport com.tryfinch.api.core.JsonValue\n\nval additionalProperties: Map = client.accessTokens().create(params)._additionalProperties()\nval secretPropertyValue: JsonValue = additionalProperties.get(\"secretProperty\")\n\nval result = when (secretPropertyValue) {\n is JsonNull -> \"It's null!\"\n is JsonBoolean -> \"It's a boolean!\"\n is JsonNumber -> \"It's a number!\"\n // Other types include `JsonMissing`, `JsonString`, `JsonArray`, and `JsonObject`\n else -> \"It's something else!\"\n}\n```\n\nTo access a property's raw JSON value, which may be undocumented, call its `_` prefixed method:\n\n```kotlin\nimport com.tryfinch.api.core.JsonField\n\nval code: JsonField = client.accessTokens().create(params)._code()\n\nif (code.isMissing()) {\n // The property is absent from the JSON response\n} else if (code.isNull()) {\n // The property was set to literal null\n} else {\n // Check if value was provided as a string\n // Other methods include `asNumber()`, `asBoolean()`, etc.\n val jsonString: String? = code.asString();\n\n // Try to deserialize into a custom type\n val myObject: MyClass = code.asUnknown()!!.convert(MyClass::class.java)\n}\n```\n\n### Response validation\n\nIn rare cases, the API may return a response that doesn't match the expected type. For example, the SDK may expect a property to contain a `String`, but the API could return something else.\n\nBy default, the SDK will not throw an exception in this case. It will throw [`FinchInvalidDataException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchInvalidDataException.kt) only if you directly access the property.\n\nIf you would prefer to check that the response is completely well-typed upfront, then either call `validate()`:\n\n```kotlin\nimport com.tryfinch.api.models.CreateAccessTokenResponse\n\nval createAccessTokenResponse: CreateAccessTokenResponse = client.accessTokens().create(params).validate()\n```\n\nOr configure the method call to validate the response using the `responseValidation` method:\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPage\n\nval page: HrisDirectoryListPage = client.hris().directory().list(RequestOptions.builder().responseValidation(true).build())\n```\n\nOr configure the default for all method calls at the client level:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .responseValidation(true)\n .accessToken(\"My Access Token\")\n .build()\n```\n\n## FAQ\n\n### Why don't you use plain `enum` classes?\n\nKotlin `enum` classes are not trivially [forwards compatible](https://www.stainless.com/blog/making-java-enums-forwards-compatible). Using them in the SDK could cause runtime exceptions if the API is updated to respond with a new enum value.\n\n### Why do you represent fields using `JsonField` instead of just plain `T`?\n\nUsing `JsonField` enables a few features:\n\n- Allowing usage of [undocumented API functionality](#undocumented-api-functionality)\n- Lazily [validating the API response against the expected shape](#response-validation)\n- Representing absent vs explicitly null values\n\n### Why don't you use [`data` classes](https://kotlinlang.org/docs/data-classes.html)?\n\nIt is not [backwards compatible to add new fields to a data class](https://kotlinlang.org/docs/api-guidelines-backward-compatibility.html#avoid-using-data-classes-in-your-api) and we don't want to introduce a breaking change every time we add a field to a class.\n\n### Why don't you use checked exceptions?\n\nChecked exceptions are widely considered a mistake in the Java programming language. In fact, they were omitted from Kotlin for this reason.\n\nChecked exceptions:\n\n- Are verbose to handle\n- Encourage error handling at the wrong level of abstraction, where nothing can be done about the error\n- Are tedious to propagate due to the [function coloring problem](https://journal.stuffwithstuff.com/2015/02/01/what-color-is-your-function)\n- Don't play well with lambdas (also due to the function coloring problem)\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n2. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Finch-API/finch-api-kotlin/issues) with questions, bugs, or suggestions.\n" + language: 'kotlin', + content: + '# Finch Kotlin API Library\n\n\n[![Maven Central](https://img.shields.io/maven-central/v/com.tryfinch.api/finch-kotlin)](https://central.sonatype.com/artifact/com.tryfinch.api/finch-kotlin/0.0.1)\n[![javadoc](https://javadoc.io/badge2/com.tryfinch.api/finch-kotlin/0.0.1/javadoc.svg)](https://javadoc.io/doc/com.tryfinch.api/finch-kotlin/0.0.1)\n\n\nThe Finch Kotlin SDK provides convenient access to the [Finch REST API](https://developer.tryfinch.com/) from applications written in Kotlin.\n\nThe Finch Kotlin SDK is similar to the Finch Java SDK but with minor differences that make it more ergonomic for use in Kotlin, such as nullable values instead of `Optional`, `Sequence` instead of `Stream`, and suspend functions instead of `CompletableFuture`.\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n\n\nThe REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/). KDocs are available on [javadoc.io](https://javadoc.io/doc/com.tryfinch.api/finch-kotlin/0.0.1).\n\n\n\n## Installation\n\n\n\n### Gradle\n\n~~~kotlin\nimplementation("com.tryfinch.api:finch-kotlin:0.0.1")\n~~~\n\n### Maven\n\n~~~xml\n\n com.tryfinch.api\n finch-kotlin\n 0.0.1\n\n~~~\n\n\n\n## Requirements\n\nThis library requires Java 8 or later.\n\n## Usage\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisDirectoryListPage\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval client: FinchClient = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\nval page: HrisDirectoryListPage = client.hris().directory().list()\n```\n\n## Client configuration\n\nConfigure the client using system properties or environment variables:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n```\n\nOr manually:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .accessToken("My Access Token")\n .build()\n```\n\nOr using a combination of the two approaches:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n```\n\nSee this table for the available options:\n\n| Setter | System property | Environment variable | Required | Default value |\n| --------------- | --------------------- | ---------------------- | -------- | ---------------------------- |\n| `clientId` | `finch.clientId` | `FINCH_CLIENT_ID` | false | - |\n| `clientSecret` | `finch.clientSecret` | `FINCH_CLIENT_SECRET` | false | - |\n| `webhookSecret` | `finch.webhookSecret` | `FINCH_WEBHOOK_SECRET` | false | - |\n| `baseUrl` | `finch.baseUrl` | `FINCH_BASE_URL` | true | `"https://api.tryfinch.com"` |\n\nSystem properties take precedence over environment variables.\n\n> [!TIP]\n> Don\'t create more than one client in the same application. Each client has a connection pool and\n> thread pools, which are more efficient to share between requests.\n\n### Modifying configuration\n\nTo temporarily use a modified client configuration, while reusing the same connection and thread pools, call `withOptions()` on any client or service:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\n\nval clientWithOptions: FinchClient = client.withOptions {\n it.baseUrl("https://example.com")\n it.maxRetries(42)\n}\n```\n\nThe `withOptions()` method does not affect the original client or service.\n\n## Requests and responses\n\nTo send a request to the Finch API, build an instance of some `Params` class and pass it to the corresponding client method. When the response is received, it will be deserialized into an instance of a Kotlin class.\n\nFor example, `client.hris().directory().list(...)` should be called with an instance of `HrisDirectoryListParams`, and it will return an instance of `HrisDirectoryListPage`.\n\n## Immutability\n\nEach class in the SDK has an associated [builder](https://blogs.oracle.com/javamagazine/post/exploring-joshua-blochs-builder-design-pattern-in-java) or factory method for constructing it.\n\nEach class is [immutable](https://docs.oracle.com/javase/tutorial/essential/concurrency/immutable.html) once constructed. If the class has an associated builder, then it has a `toBuilder()` method, which can be used to convert it back to a builder for making a modified copy.\n\nBecause each class is immutable, builder modification will _never_ affect already built class instances.\n\n## Asynchronous execution\n\nThe default client is synchronous. To switch to asynchronous execution, call the `async()` method:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval client: FinchClient = FinchOkHttpClient.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\nval page: HrisDirectoryListPageAsync = client.async().hris().directory().list()\n```\n\nOr create an asynchronous client from the beginning:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClientAsync\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClientAsync\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval client: FinchClientAsync = FinchOkHttpClientAsync.builder()\n // Configures using the `finch.clientId`, `finch.clientSecret`, `finch.webhookSecret` and `finch.baseUrl` system properties\n // Or configures using the `FINCH_CLIENT_ID`, `FINCH_CLIENT_SECRET`, `FINCH_WEBHOOK_SECRET` and `FINCH_BASE_URL` environment variables\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\nval page: HrisDirectoryListPageAsync = client.hris().directory().list()\n```\n\nThe asynchronous client supports the same options as the synchronous one, except most methods are [suspending](https://kotlinlang.org/docs/coroutines-guide.html).\n\n\n\n\n\n\n\n## Raw responses\n\nThe SDK defines methods that deserialize responses into instances of Kotlin classes. However, these methods don\'t provide access to the response headers, status code, or the raw response body.\n\nTo access this data, prefix any HTTP method call on a client or service with `withRawResponse()`:\n\n```kotlin\nimport com.tryfinch.api.core.http.Headers\nimport com.tryfinch.api.core.http.HttpResponseFor\nimport com.tryfinch.api.models.HrisDirectoryListPage\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval page: HttpResponseFor = client.hris().directory().withRawResponse().list()\n\nval statusCode: Int = page.statusCode()\nval headers: Headers = page.headers()\n```\n\nYou can still deserialize the response into an instance of a Kotlin class if needed:\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPage\n\nval parsedPage: HrisDirectoryListPage = page.parse()\n```\n\n## Error handling\n\nThe SDK throws custom unchecked exception types:\n\n- [`FinchServiceException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchServiceException.kt): Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:\n\n | Status | Exception |\n | ------ | -------------------------------------------------- |\n | 400 | [`BadRequestException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/BadRequestException.kt) |\n | 401 | [`UnauthorizedException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/UnauthorizedException.kt) |\n | 403 | [`PermissionDeniedException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/PermissionDeniedException.kt) |\n | 404 | [`NotFoundException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/NotFoundException.kt) |\n | 422 | [`UnprocessableEntityException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/UnprocessableEntityException.kt) |\n | 429 | [`RateLimitException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/RateLimitException.kt) |\n | 5xx | [`InternalServerException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/InternalServerException.kt) |\n | others | [`UnexpectedStatusCodeException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/UnexpectedStatusCodeException.kt) |\n\n- [`FinchIoException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchIoException.kt): I/O networking errors.\n\n- [`FinchRetryableException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchRetryableException.kt): Generic error indicating a failure that could be retried by the client.\n\n- [`FinchInvalidDataException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchInvalidDataException.kt): Failure to interpret successfully parsed data. For example, when accessing a property that\'s supposed to be required, but the API unexpectedly omitted it from the response.\n\n- [`FinchException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchException.kt): Base class for all exceptions. Most errors will result in one of the previously mentioned ones, but completely generic errors may be thrown using the base class.\n\n## Pagination\n\nThe SDK defines methods that return a paginated lists of results. It provides convenient ways to access the results either one page at a time or item-by-item across all pages.\n\n### Auto-pagination\n\nTo iterate through all results across all pages, use the `autoPager()` method, which automatically fetches more pages as needed.\n\nWhen using the synchronous client, the method returns a [`Sequence`](https://kotlinlang.org/docs/sequences.html)\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPage\n\nval page: HrisDirectoryListPage = client.hris().directory().list()\npage.autoPager()\n .take(50)\n .forEach { directory -> println(directory) }\n```\n\nWhen using the asynchronous client, the method returns a [`Flow`](https://kotlinlang.org/docs/flow.html):\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPageAsync\n\nval page: HrisDirectoryListPageAsync = client.async().hris().directory().list()\npage.autoPager()\n .take(50)\n .forEach { directory -> println(directory) }\n```\n\n### Manual pagination\n\nTo access individual page items and manually request the next page, use the `items()`,\n`hasNextPage()`, and `nextPage()` methods:\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPage\nimport com.tryfinch.api.models.IndividualInDirectory\n\nval page: HrisDirectoryListPage = client.hris().directory().list()\nwhile (true) {\n for (directory in page.items()) {\n println(directory)\n }\n\n if (!page.hasNextPage()) {\n break\n }\n\n page = page.nextPage()\n}\n```\n\n## Logging\n\nThe SDK uses the standard [OkHttp logging interceptor](https://github.com/square/okhttp/tree/master/okhttp-logging-interceptor).\n\nEnable logging by setting the `FINCH_LOG` environment variable to `info`:\n\n```sh\nexport FINCH_LOG=info\n```\n\nOr to `debug` for more verbose logging:\n\n```sh\nexport FINCH_LOG=debug\n```\n\n## ProGuard and R8\n\nAlthough the SDK uses reflection, it is still usable with [ProGuard](https://github.com/Guardsquare/proguard) and [R8](https://developer.android.com/topic/performance/app-optimization/enable-app-optimization) because `finch-kotlin-core` is published with a [configuration file](finch-kotlin-core/src/main/resources/META-INF/proguard/finch-kotlin-core.pro) containing [keep rules](https://www.guardsquare.com/manual/configuration/usage).\n\nProGuard and R8 should automatically detect and use the published rules, but you can also manually copy the keep rules if necessary.\n\n\n\n\n\n## Jackson\n\nThe SDK depends on [Jackson](https://github.com/FasterXML/jackson) for JSON serialization/deserialization. It is compatible with version 2.13.4 or higher, but depends on version 2.18.2 by default.\n\nThe SDK throws an exception if it detects an incompatible Jackson version at runtime (e.g. if the default version was overridden in your Maven or Gradle config).\n\nIf the SDK threw an exception, but you\'re _certain_ the version is compatible, then disable the version check using the `checkJacksonVersionCompatibility` on [`FinchOkHttpClient`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt).\n\n> [!CAUTION]\n> We make no guarantee that the SDK works correctly when the Jackson version check is disabled.\n\nAlso note that there are bugs in older Jackson versions that can affect the SDK. We don\'t work around all Jackson bugs ([example](https://github.com/FasterXML/jackson-databind/issues/3240)) and expect users to upgrade Jackson for those instead.\n\n## Network options\n\n### Retries\n\nThe SDK automatically retries 2 times by default, with a short exponential backoff between requests.\n\nOnly the following error types are retried:\n- Connection errors (for example, due to a network connectivity problem)\n- 408 Request Timeout\n- 409 Conflict\n- 429 Rate Limit\n- 5xx Internal\n\nThe API may also explicitly instruct the SDK to retry or not retry a request.\n\nTo set a custom number of retries, configure the client using the `maxRetries` method:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .maxRetries(4)\n .accessToken("My Access Token")\n .build()\n```\n\n### Timeouts\n\nRequests time out after 1 minute by default.\n\nTo set a custom timeout, configure the method call using the `timeout` method:\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPage\n\nval page: HrisDirectoryListPage = client.hris().directory().list(RequestOptions.builder().timeout(Duration.ofSeconds(30)).build())\n```\n\nOr configure the default for all method calls at the client level:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport java.time.Duration\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .timeout(Duration.ofSeconds(30))\n .accessToken("My Access Token")\n .build()\n```\n\n### Proxies\n\nTo route requests through a proxy, configure the client using the `proxy` method:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport java.net.InetSocketAddress\nimport java.net.Proxy\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .proxy(Proxy(\n Proxy.Type.HTTP, InetSocketAddress(\n "https://example.com", 8080\n )\n ))\n .accessToken("My Access Token")\n .build()\n```\n\n### Connection pooling\n\nTo customize the underlying OkHttp connection pool, configure the client using the `maxIdleConnections` and `keepAliveDuration` methods:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport java.time.Duration\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n // If `maxIdleConnections` is set, then `keepAliveDuration` must be set, and vice versa.\n .maxIdleConnections(10)\n .keepAliveDuration(Duration.ofMinutes(2))\n .accessToken("My Access Token")\n .build()\n```\n\nIf both options are unset, OkHttp\'s default connection pool settings are used.\n\n### HTTPS\n\n> [!NOTE]\n> Most applications should not call these methods, and instead use the system defaults. The defaults include\n> special optimizations that can be lost if the implementations are modified.\n\nTo configure how HTTPS connections are secured, configure the client using the `sslSocketFactory`, `trustManager`, and `hostnameVerifier` methods:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n // If `sslSocketFactory` is set, then `trustManager` must be set, and vice versa.\n .sslSocketFactory(yourSSLSocketFactory)\n .trustManager(yourTrustManager)\n .hostnameVerifier(yourHostnameVerifier)\n .accessToken("My Access Token")\n .build()\n```\n\n\n\n### Custom HTTP client\n\nThe SDK consists of three artifacts:\n- `finch-kotlin-core`\n - Contains core SDK logic\n - Does not depend on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`FinchClient`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClient.kt), [`FinchClientAsync`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsync.kt), [`FinchClientImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt), and [`FinchClientAsyncImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), all of which can work with any HTTP client\n- `finch-kotlin-client-okhttp`\n - Depends on [OkHttp](https://square.github.io/okhttp)\n - Exposes [`FinchOkHttpClient`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) and [`FinchOkHttpClientAsync`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), which provide a way to construct [`FinchClientImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) and [`FinchClientAsyncImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), respectively, using OkHttp\n- `finch-kotlin`\n - Depends on and exposes the APIs of both `finch-kotlin-core` and `finch-kotlin-client-okhttp`\n - Does not have its own logic\n\nThis structure allows replacing the SDK\'s default HTTP client without pulling in unnecessary dependencies.\n\n#### Customized [`OkHttpClient`](https://square.github.io/okhttp/3.x/okhttp/okhttp3/OkHttpClient.html)\n\n> [!TIP]\n> Try the available [network options](#network-options) before replacing the default client.\n\nTo use a customized `OkHttpClient`:\n\n1. Replace your [`finch-kotlin` dependency](#installation) with `finch-kotlin-core`\n2. Copy `finch-kotlin-client-okhttp`\'s [`OkHttpClient`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/OkHttpClient.kt) class into your code and customize it\n3. Construct [`FinchClientImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) or [`FinchClientAsyncImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), similarly to [`FinchOkHttpClient`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), using your customized client\n\n### Completely custom HTTP client\n\nTo use a completely custom HTTP client:\n\n1. Replace your [`finch-kotlin` dependency](#installation) with `finch-kotlin-core`\n2. Write a class that implements the [`HttpClient`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/core/http/HttpClient.kt) interface\n3. Construct [`FinchClientImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientImpl.kt) or [`FinchClientAsyncImpl`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/client/FinchClientAsyncImpl.kt), similarly to [`FinchOkHttpClient`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClient.kt) or [`FinchOkHttpClientAsync`](finch-kotlin-client-okhttp/src/main/kotlin/com/tryfinch/api/client/okhttp/FinchOkHttpClientAsync.kt), using your new client class\n\n## Undocumented API functionality\n\nThe SDK is typed for convenient usage of the documented API. However, it also supports working with undocumented or not yet supported parts of the API.\n\n### Parameters\n\nTo set undocumented parameters, call the `putAdditionalHeader`, `putAdditionalQueryParam`, or `putAdditionalBodyProperty` methods on any `Params` class:\n\n```kotlin\nimport com.tryfinch.api.core.JsonValue\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval params: HrisDirectoryListParams = HrisDirectoryListParams.builder()\n .putAdditionalHeader("Secret-Header", "42")\n .putAdditionalQueryParam("secret_query_param", "42")\n .putAdditionalBodyProperty("secretProperty", JsonValue.from("42"))\n .build()\n```\n\nThese can be accessed on the built object later using the `_additionalHeaders()`, `_additionalQueryParams()`, and `_additionalBodyProperties()` methods.\n\nTo set a documented parameter or property to an undocumented or not yet supported _value_, pass a [`JsonValue`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/core/Values.kt) object to its setter:\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval params: HrisDirectoryListParams = HrisDirectoryListParams.builder().build()\n```\n\nThe most straightforward way to create a [`JsonValue`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/core/Values.kt) is using its `from(...)` method:\n\n```kotlin\nimport com.tryfinch.api.core.JsonValue\n\n// Create primitive JSON values\nval nullValue: JsonValue = JsonValue.from(null)\nval booleanValue: JsonValue = JsonValue.from(true)\nval numberValue: JsonValue = JsonValue.from(42)\nval stringValue: JsonValue = JsonValue.from("Hello World!")\n\n// Create a JSON array value equivalent to `["Hello", "World"]`\nval arrayValue: JsonValue = JsonValue.from(listOf(\n "Hello", "World"\n))\n\n// Create a JSON object value equivalent to `{ "a": 1, "b": 2 }`\nval objectValue: JsonValue = JsonValue.from(mapOf(\n "a" to 1, "b" to 2\n))\n\n// Create an arbitrarily nested JSON equivalent to:\n// {\n// "a": [1, 2],\n// "b": [3, 4]\n// }\nval complexValue: JsonValue = JsonValue.from(mapOf(\n "a" to listOf(\n 1, 2\n ), "b" to listOf(\n 3, 4\n )\n))\n```\n\nNormally a `Builder` class\'s `build` method will throw [`IllegalStateException`](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) if any required parameter or property is unset.\n\nTo forcibly omit a required parameter or property, pass [`JsonMissing`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/core/Values.kt):\n\n```kotlin\nimport com.tryfinch.api.core.JsonMissing\nimport com.tryfinch.api.models.AccessTokenCreateParams\nimport com.tryfinch.api.models.HrisDirectoryListParams\n\nval params: HrisDirectoryListParams = AccessTokenCreateParams.builder()\n .code(JsonMissing.of())\n .build()\n```\n\n### Response properties\n\nTo access undocumented response properties, call the `_additionalProperties()` method:\n\n```kotlin\nimport com.tryfinch.api.core.JsonBoolean\nimport com.tryfinch.api.core.JsonNull\nimport com.tryfinch.api.core.JsonNumber\nimport com.tryfinch.api.core.JsonValue\n\nval additionalProperties: Map = client.accessTokens().create(params)._additionalProperties()\nval secretPropertyValue: JsonValue = additionalProperties.get("secretProperty")\n\nval result = when (secretPropertyValue) {\n is JsonNull -> "It\'s null!"\n is JsonBoolean -> "It\'s a boolean!"\n is JsonNumber -> "It\'s a number!"\n // Other types include `JsonMissing`, `JsonString`, `JsonArray`, and `JsonObject`\n else -> "It\'s something else!"\n}\n```\n\nTo access a property\'s raw JSON value, which may be undocumented, call its `_` prefixed method:\n\n```kotlin\nimport com.tryfinch.api.core.JsonField\n\nval code: JsonField = client.accessTokens().create(params)._code()\n\nif (code.isMissing()) {\n // The property is absent from the JSON response\n} else if (code.isNull()) {\n // The property was set to literal null\n} else {\n // Check if value was provided as a string\n // Other methods include `asNumber()`, `asBoolean()`, etc.\n val jsonString: String? = code.asString();\n\n // Try to deserialize into a custom type\n val myObject: MyClass = code.asUnknown()!!.convert(MyClass::class.java)\n}\n```\n\n### Response validation\n\nIn rare cases, the API may return a response that doesn\'t match the expected type. For example, the SDK may expect a property to contain a `String`, but the API could return something else.\n\nBy default, the SDK will not throw an exception in this case. It will throw [`FinchInvalidDataException`](finch-kotlin-core/src/main/kotlin/com/tryfinch/api/errors/FinchInvalidDataException.kt) only if you directly access the property.\n\nIf you would prefer to check that the response is completely well-typed upfront, then either call `validate()`:\n\n```kotlin\nimport com.tryfinch.api.models.CreateAccessTokenResponse\n\nval createAccessTokenResponse: CreateAccessTokenResponse = client.accessTokens().create(params).validate()\n```\n\nOr configure the method call to validate the response using the `responseValidation` method:\n\n```kotlin\nimport com.tryfinch.api.models.HrisDirectoryListPage\n\nval page: HrisDirectoryListPage = client.hris().directory().list(RequestOptions.builder().responseValidation(true).build())\n```\n\nOr configure the default for all method calls at the client level:\n\n```kotlin\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\n\nval client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .responseValidation(true)\n .accessToken("My Access Token")\n .build()\n```\n\n## FAQ\n\n### Why don\'t you use plain `enum` classes?\n\nKotlin `enum` classes are not trivially [forwards compatible](https://www.stainless.com/blog/making-java-enums-forwards-compatible). Using them in the SDK could cause runtime exceptions if the API is updated to respond with a new enum value.\n\n### Why do you represent fields using `JsonField` instead of just plain `T`?\n\nUsing `JsonField` enables a few features:\n\n- Allowing usage of [undocumented API functionality](#undocumented-api-functionality)\n- Lazily [validating the API response against the expected shape](#response-validation)\n- Representing absent vs explicitly null values\n\n### Why don\'t you use [`data` classes](https://kotlinlang.org/docs/data-classes.html)?\n\nIt is not [backwards compatible to add new fields to a data class](https://kotlinlang.org/docs/api-guidelines-backward-compatibility.html#avoid-using-data-classes-in-your-api) and we don\'t want to introduce a breaking change every time we add a field to a class.\n\n### Why don\'t you use checked exceptions?\n\nChecked exceptions are widely considered a mistake in the Java programming language. In fact, they were omitted from Kotlin for this reason.\n\nChecked exceptions:\n\n- Are verbose to handle\n- Encourage error handling at the wrong level of abstraction, where nothing can be done about the error\n- Are tedious to propagate due to the [function coloring problem](https://journal.stuffwithstuff.com/2015/02/01/what-color-is-your-function)\n- Don\'t play well with lambdas (also due to the function coloring problem)\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n2. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Finch-API/finch-api-kotlin/issues) with questions, bugs, or suggestions.\n', }, { - "language": "python", - "content": "# Finch Python API library\n\n\n[![PyPI version](https://img.shields.io/pypi/v/finch-api.svg?label=pypi%20(stable))](https://pypi.org/project/finch-api/)\n\nThe Finch Python library provides convenient access to the Finch REST API from any Python 3.9+\napplication. The library includes type definitions for all request params and response fields,\nand offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).\n\n\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Documentation\n\nThe REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/). The full API of this library can be found in [api.md](api.md).\n\n## Installation\n\n```sh\n# install from PyPI\npip install finch-api\n```\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n```python\nfrom finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\n\npage = client.hris.directory.list()\nprint(page.individuals)\n```\n\n\n\n## Async usage\n\nSimply import `AsyncFinch` instead of `Finch` and use `await` with each API call:\n\n```python\nimport asyncio\nfrom finch import AsyncFinch\n\nclient = AsyncFinch(\n access_token=\"My Access Token\",\n)\n\nasync def main() -> None:\n page = await client.hris.directory.list()\n print(page.individuals)\n\nasyncio.run(main())\n```\n\nFunctionality between the synchronous and asynchronous clients is otherwise identical.\n\n### With aiohttp\n\nBy default, the async client uses `httpx` for HTTP requests. However, for improved concurrency performance you may also use `aiohttp` as the HTTP backend.\n\nYou can enable this by installing `aiohttp`:\n\n```sh\n# install from PyPI\npip install finch-api[aiohttp]\n```\n\nThen you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:\n\n```python\nimport asyncio\nfrom finch import DefaultAioHttpClient\nfrom finch import AsyncFinch\n\nasync def main() -> None:\n async with AsyncFinch(\n access_token=\"My Access Token\",\n http_client=DefaultAioHttpClient(),\n) as client:\n page = await client.hris.directory.list()\n print(page.individuals)\n\nasyncio.run(main())\n```\n\n\n\n## Using types\n\nNested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:\n\n- Serializing back into JSON, `model.to_json()`\n- Converting to a dictionary, `model.to_dict()`\n\nTyped requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.\n\n## Pagination\n\nList methods in the Finch API are paginated.\n\nThis library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:\n\n```python\nfrom finch import Finch\n\nclient = Finch()\n\nall_directories = []\n# Automatically fetches more pages as needed.\nfor directory in client.hris.directory.list():\n # Do something with directory here\n all_directories.append(directory)\nprint(all_directories)\n```\n\nOr, asynchronously:\n\n```python\nimport asyncio\nfrom finch import AsyncFinch\n\nclient = AsyncFinch()\n\nasync def main() -> None:\n all_directories = []\n # Iterate through items across all pages, issuing requests as needed.\n async for directory in client.hris.directory.list():\n all_directories.append(directory)\n print(all_directories)\n\nasyncio.run(main())\n```\n\nAlternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:\n\n```python\nfirst_page = await client.hris.directory.list()\nif first_page.has_next_page():\n print(f\"will fetch next page using these details: {first_page.next_page_info()}\")\n next_page = await first_page.get_next_page()\n print(f\"number of items we just fetched: {len(next_page.individuals)}\")\n\n# Remove `await` for non-async usage.\n```\n\nOr just work directly with the returned data:\n\n```python\nfirst_page = await client.hris.directory.list()\n\nprint(f\"the current start offset for this page: {first_page.paging.offset}\") # => \"the current start offset for this page: 1\"\nfor directory in first_page.individuals:\n print(directory.id)\n\n# Remove `await` for non-async usage.\n```\n\n\n\n\n\n## Handling errors\n\nWhen the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `finch.APIConnectionError` is raised.\n\nWhen the API returns a non-success status code (that is, 4xx or 5xx\nresponse), a subclass of `finch.APIStatusError` is raised, containing `status_code` and `response` properties.\n\nAll errors inherit from `finch.APIError`.\n\n```python\nimport finch\nfrom finch import Finch\n\nclient = Finch()\n\ntry:\n client.hris.company.retrieve()\nexcept finch.APIConnectionError as e:\n print(\"The server could not be reached\")\n print(e.__cause__) # an underlying Exception, likely raised within httpx.\nexcept finch.RateLimitError as e:\n print(\"A 429 status code was received; we should back off a bit.\")\nexcept finch.APIStatusError as e:\n print(\"Another non-200-range status code was received\")\n print(e.status_code)\n print(e.response)\n```\n\nError codes are as follows:\n\n| Status Code | Error Type |\n| ----------- | -------------------------- |\n| 400 | `BadRequestError` |\n| 401 | `AuthenticationError` |\n| 403 | `PermissionDeniedError` |\n| 404 | `NotFoundError` |\n| 422 | `UnprocessableEntityError` |\n| 429 | `RateLimitError` |\n| >=500 | `InternalServerError` |\n| N/A | `APIConnectionError` |\n\n### Retries\n\nCertain errors are automatically retried 2 times by default, with a short exponential backoff.\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,\n429 Rate Limit, and >=500 Internal errors are all retried by default.\n\nYou can use the `max_retries` option to configure or disable retry settings:\n\n```python\nfrom finch import Finch\n\n# Configure the default for all requests:\nclient = Finch(\n # default is 2\n max_retries=0,\n)\n\n# Or, configure per-request:\nclient.with_options(max_retries = 5).hris.directory.list()\n```\n\n### Timeouts\n\nBy default requests time out after 1 minute. You can configure this with a `timeout` option,\nwhich accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object:\n\n```python\nfrom finch import Finch\n\n# Configure the default for all requests:\nclient = Finch(\n # 20 seconds (default is 1 minute)\n timeout=20.0,\n)\n\n# More granular control:\nclient = Finch(\n timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),\n)\n\n# Override per-request:\nclient.with_options(timeout = 5.0).hris.directory.list()\n```\n\nOn timeout, an `APITimeoutError` is thrown.\n\nNote that requests that time out are [retried twice by default](#retries).\n\n## Default Headers\n\nWe automatically send the `Finch-API-Version` header set to `2020-09-17`.\n\nIf you need to, you can override it by setting default headers per-request or on the client object.\n\nBe aware that doing so may result in incorrect types and other unexpected or undefined behavior in the SDK.\n\n```python\nfrom finch import Finch\n\nclient = Finch(\n default_headers={\n \"Finch-API-Version\": \"My-Custom-Value\"\n },\n)\n```\n\n## Advanced\n\n### Logging\n\nWe use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.\n\nYou can enable logging by setting the environment variable `FINCH_LOG` to `info`.\n\n```shell\n$ export FINCH_LOG=info\n```\n\nOr to `debug` for more verbose logging.\n\n### How to tell whether `None` means `null` or missing\n\nIn an API response, a field may be explicitly `null`, or missing entirely; in either case, its value is `None` in this library. You can differentiate the two cases with `.model_fields_set`:\n\n```py\nif response.my_field is None:\n if 'my_field' not in response.model_fields_set:\n print('Got json like {}, without a \"my_field\" key present at all.')\n else:\n print('Got json like {\"my_field\": null}.')\n```\n\n### Accessing raw response data (e.g. headers)\n\nThe \"raw\" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,\n\n```py\nfrom finch import Finch\n\nclient = Finch()\nresponse = client.hris.directory.with_raw_response.list()\nprint(response.headers.get('X-My-Header'))\n\ndirectory = response.parse() # get the object that `hris.directory.list()` would have returned\nprint(directory.id)\n```\n\nThese methods return a [`LegacyAPIResponse`](https://github.com/Finch-API/finch-api-python/tree/main/src/finch/_legacy_response.py) object. This is a legacy class as we're changing it slightly in the next major version.\n\nFor the sync client this will mostly be the same with the exception\nof `content` & `text` will be methods instead of properties. In the\nasync client, all methods will be async.\n\nA migration script will be provided & the migration in general should\nbe smooth.\n\n#### `.with_streaming_response`\n\nThe above interface eagerly reads the full response body when you make the request, which may not always be what you want.\n\nTo stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.\n\nAs such, `.with_streaming_response` methods return a different [`APIResponse`](https://github.com/Finch-API/finch-api-python/tree/main/src/finch/_response.py) object, and the async client returns an [`AsyncAPIResponse`](https://github.com/Finch-API/finch-api-python/tree/main/src/finch/_response.py) object.\n\n```python\nwith client.hris.directory.with_streaming_response.list() as response :\n print(response.headers.get('X-My-Header'))\n\n for line in response.iter_lines():\n print(line)\n```\n\nThe context manager is required so that the response will reliably be closed.\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API.\n\nIf you need to access undocumented endpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can make requests using `client.get`, `client.post`, and other\nhttp verbs. Options on the client will be respected (such as retries) when making this request.\n\n```py\nimport httpx\n\nresponse = client.post(\n \"/foo\",\n cast_to=httpx.Response,\n body={\"my_param\": True},\n)\n\nprint(response.headers.get(\"x-foo\"))\n```\n\n#### Undocumented request params\n\nIf you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request\noptions.\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You\ncan also get all the extra fields on the Pydantic model as a dict with\n[`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra).\n\n### Configuring the HTTP client\n\nYou can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including:\n\n- Support for [proxies](https://www.python-httpx.org/advanced/proxies/)\n- Custom [transports](https://www.python-httpx.org/advanced/transports/)\n- Additional [advanced](https://www.python-httpx.org/advanced/clients/) functionality\n\n```python\nimport httpx\nfrom finch import Finch, DefaultHttpxClient\n\nclient = Finch(\n # Or use the `FINCH_BASE_URL` env var\n base_url=\"http://my.test.server.example.com:8083\",\n http_client=DefaultHttpxClient(proxy=\"http://my.test.proxy.example.com\", transport=httpx.HTTPTransport(local_address=\"0.0.0.0\")),\n)\n```\n\nYou can also customize the client on a per-request basis by using `with_options()`:\n\n```python\nclient.with_options(http_client=DefaultHttpxClient(...))\n```\n\n### Managing HTTP resources\n\nBy default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.\n\n```py\nfrom finch import Finch\n\nwith Finch() as client:\n # make requests here\n ...\n\n# HTTP client is now closed\n```\n\n## Versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes that only affect static types, without breaking runtime behavior.\n2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n3. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Finch-API/finch-api-python/issues) with questions, bugs, or suggestions.\n\n### Determining the installed version\n\nIf you've upgraded to the latest version but aren't seeing any new features you were expecting then your python environment is likely still using an older version.\n\nYou can determine the version that is being used at runtime with:\n\n```py\nimport finch\nprint(finch.__version__)\n```\n\n## Requirements\n\nPython 3.9 or higher.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n" + language: 'python', + content: + '# Finch Python API library\n\n\n[![PyPI version](https://img.shields.io/pypi/v/finch-api.svg?label=pypi%20(stable))](https://pypi.org/project/finch-api/)\n\nThe Finch Python library provides convenient access to the Finch REST API from any Python 3.9+\napplication. The library includes type definitions for all request params and response fields,\nand offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).\n\n\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Documentation\n\nThe REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/). The full API of this library can be found in [api.md](api.md).\n\n## Installation\n\n```sh\n# install from PyPI\npip install finch-api\n```\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n```python\nfrom finch import Finch\n\nclient = Finch(\n access_token="My Access Token",\n)\n\npage = client.hris.directory.list()\nprint(page.individuals)\n```\n\n\n\n## Async usage\n\nSimply import `AsyncFinch` instead of `Finch` and use `await` with each API call:\n\n```python\nimport asyncio\nfrom finch import AsyncFinch\n\nclient = AsyncFinch(\n access_token="My Access Token",\n)\n\nasync def main() -> None:\n page = await client.hris.directory.list()\n print(page.individuals)\n\nasyncio.run(main())\n```\n\nFunctionality between the synchronous and asynchronous clients is otherwise identical.\n\n### With aiohttp\n\nBy default, the async client uses `httpx` for HTTP requests. However, for improved concurrency performance you may also use `aiohttp` as the HTTP backend.\n\nYou can enable this by installing `aiohttp`:\n\n```sh\n# install from PyPI\npip install finch-api[aiohttp]\n```\n\nThen you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:\n\n```python\nimport asyncio\nfrom finch import DefaultAioHttpClient\nfrom finch import AsyncFinch\n\nasync def main() -> None:\n async with AsyncFinch(\n access_token="My Access Token",\n http_client=DefaultAioHttpClient(),\n) as client:\n page = await client.hris.directory.list()\n print(page.individuals)\n\nasyncio.run(main())\n```\n\n\n\n## Using types\n\nNested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:\n\n- Serializing back into JSON, `model.to_json()`\n- Converting to a dictionary, `model.to_dict()`\n\nTyped requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.\n\n## Pagination\n\nList methods in the Finch API are paginated.\n\nThis library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:\n\n```python\nfrom finch import Finch\n\nclient = Finch()\n\nall_directories = []\n# Automatically fetches more pages as needed.\nfor directory in client.hris.directory.list():\n # Do something with directory here\n all_directories.append(directory)\nprint(all_directories)\n```\n\nOr, asynchronously:\n\n```python\nimport asyncio\nfrom finch import AsyncFinch\n\nclient = AsyncFinch()\n\nasync def main() -> None:\n all_directories = []\n # Iterate through items across all pages, issuing requests as needed.\n async for directory in client.hris.directory.list():\n all_directories.append(directory)\n print(all_directories)\n\nasyncio.run(main())\n```\n\nAlternatively, you can use the `.has_next_page()`, `.next_page_info()`, or `.get_next_page()` methods for more granular control working with pages:\n\n```python\nfirst_page = await client.hris.directory.list()\nif first_page.has_next_page():\n print(f"will fetch next page using these details: {first_page.next_page_info()}")\n next_page = await first_page.get_next_page()\n print(f"number of items we just fetched: {len(next_page.individuals)}")\n\n# Remove `await` for non-async usage.\n```\n\nOr just work directly with the returned data:\n\n```python\nfirst_page = await client.hris.directory.list()\n\nprint(f"the current start offset for this page: {first_page.paging.offset}") # => "the current start offset for this page: 1"\nfor directory in first_page.individuals:\n print(directory.id)\n\n# Remove `await` for non-async usage.\n```\n\n\n\n\n\n## Handling errors\n\nWhen the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `finch.APIConnectionError` is raised.\n\nWhen the API returns a non-success status code (that is, 4xx or 5xx\nresponse), a subclass of `finch.APIStatusError` is raised, containing `status_code` and `response` properties.\n\nAll errors inherit from `finch.APIError`.\n\n```python\nimport finch\nfrom finch import Finch\n\nclient = Finch()\n\ntry:\n client.hris.company.retrieve()\nexcept finch.APIConnectionError as e:\n print("The server could not be reached")\n print(e.__cause__) # an underlying Exception, likely raised within httpx.\nexcept finch.RateLimitError as e:\n print("A 429 status code was received; we should back off a bit.")\nexcept finch.APIStatusError as e:\n print("Another non-200-range status code was received")\n print(e.status_code)\n print(e.response)\n```\n\nError codes are as follows:\n\n| Status Code | Error Type |\n| ----------- | -------------------------- |\n| 400 | `BadRequestError` |\n| 401 | `AuthenticationError` |\n| 403 | `PermissionDeniedError` |\n| 404 | `NotFoundError` |\n| 422 | `UnprocessableEntityError` |\n| 429 | `RateLimitError` |\n| >=500 | `InternalServerError` |\n| N/A | `APIConnectionError` |\n\n### Retries\n\nCertain errors are automatically retried 2 times by default, with a short exponential backoff.\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,\n429 Rate Limit, and >=500 Internal errors are all retried by default.\n\nYou can use the `max_retries` option to configure or disable retry settings:\n\n```python\nfrom finch import Finch\n\n# Configure the default for all requests:\nclient = Finch(\n # default is 2\n max_retries=0,\n)\n\n# Or, configure per-request:\nclient.with_options(max_retries = 5).hris.directory.list()\n```\n\n### Timeouts\n\nBy default requests time out after 1 minute. You can configure this with a `timeout` option,\nwhich accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object:\n\n```python\nfrom finch import Finch\n\n# Configure the default for all requests:\nclient = Finch(\n # 20 seconds (default is 1 minute)\n timeout=20.0,\n)\n\n# More granular control:\nclient = Finch(\n timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),\n)\n\n# Override per-request:\nclient.with_options(timeout = 5.0).hris.directory.list()\n```\n\nOn timeout, an `APITimeoutError` is thrown.\n\nNote that requests that time out are [retried twice by default](#retries).\n\n## Default Headers\n\nWe automatically send the `Finch-API-Version` header set to `2020-09-17`.\n\nIf you need to, you can override it by setting default headers per-request or on the client object.\n\nBe aware that doing so may result in incorrect types and other unexpected or undefined behavior in the SDK.\n\n```python\nfrom finch import Finch\n\nclient = Finch(\n default_headers={\n "Finch-API-Version": "My-Custom-Value"\n },\n)\n```\n\n## Advanced\n\n### Logging\n\nWe use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.\n\nYou can enable logging by setting the environment variable `FINCH_LOG` to `info`.\n\n```shell\n$ export FINCH_LOG=info\n```\n\nOr to `debug` for more verbose logging.\n\n### How to tell whether `None` means `null` or missing\n\nIn an API response, a field may be explicitly `null`, or missing entirely; in either case, its value is `None` in this library. You can differentiate the two cases with `.model_fields_set`:\n\n```py\nif response.my_field is None:\n if \'my_field\' not in response.model_fields_set:\n print(\'Got json like {}, without a "my_field" key present at all.\')\n else:\n print(\'Got json like {"my_field": null}.\')\n```\n\n### Accessing raw response data (e.g. headers)\n\nThe "raw" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,\n\n```py\nfrom finch import Finch\n\nclient = Finch()\nresponse = client.hris.directory.with_raw_response.list()\nprint(response.headers.get(\'X-My-Header\'))\n\ndirectory = response.parse() # get the object that `hris.directory.list()` would have returned\nprint(directory.id)\n```\n\nThese methods return a [`LegacyAPIResponse`](https://github.com/Finch-API/finch-api-python/tree/main/src/finch/_legacy_response.py) object. This is a legacy class as we\'re changing it slightly in the next major version.\n\nFor the sync client this will mostly be the same with the exception\nof `content` & `text` will be methods instead of properties. In the\nasync client, all methods will be async.\n\nA migration script will be provided & the migration in general should\nbe smooth.\n\n#### `.with_streaming_response`\n\nThe above interface eagerly reads the full response body when you make the request, which may not always be what you want.\n\nTo stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.\n\nAs such, `.with_streaming_response` methods return a different [`APIResponse`](https://github.com/Finch-API/finch-api-python/tree/main/src/finch/_response.py) object, and the async client returns an [`AsyncAPIResponse`](https://github.com/Finch-API/finch-api-python/tree/main/src/finch/_response.py) object.\n\n```python\nwith client.hris.directory.with_streaming_response.list() as response :\n print(response.headers.get(\'X-My-Header\'))\n\n for line in response.iter_lines():\n print(line)\n```\n\nThe context manager is required so that the response will reliably be closed.\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API.\n\nIf you need to access undocumented endpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can make requests using `client.get`, `client.post`, and other\nhttp verbs. Options on the client will be respected (such as retries) when making this request.\n\n```py\nimport httpx\n\nresponse = client.post(\n "/foo",\n cast_to=httpx.Response,\n body={"my_param": True},\n)\n\nprint(response.headers.get("x-foo"))\n```\n\n#### Undocumented request params\n\nIf you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request\noptions.\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You\ncan also get all the extra fields on the Pydantic model as a dict with\n[`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra).\n\n### Configuring the HTTP client\n\nYou can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including:\n\n- Support for [proxies](https://www.python-httpx.org/advanced/proxies/)\n- Custom [transports](https://www.python-httpx.org/advanced/transports/)\n- Additional [advanced](https://www.python-httpx.org/advanced/clients/) functionality\n\n```python\nimport httpx\nfrom finch import Finch, DefaultHttpxClient\n\nclient = Finch(\n # Or use the `FINCH_BASE_URL` env var\n base_url="http://my.test.server.example.com:8083",\n http_client=DefaultHttpxClient(proxy="http://my.test.proxy.example.com", transport=httpx.HTTPTransport(local_address="0.0.0.0")),\n)\n```\n\nYou can also customize the client on a per-request basis by using `with_options()`:\n\n```python\nclient.with_options(http_client=DefaultHttpxClient(...))\n```\n\n### Managing HTTP resources\n\nBy default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.\n\n```py\nfrom finch import Finch\n\nwith Finch() as client:\n # make requests here\n ...\n\n# HTTP client is now closed\n```\n\n## Versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes that only affect static types, without breaking runtime behavior.\n2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n3. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Finch-API/finch-api-python/issues) with questions, bugs, or suggestions.\n\n### Determining the installed version\n\nIf you\'ve upgraded to the latest version but aren\'t seeing any new features you were expecting then your python environment is likely still using an older version.\n\nYou can determine the version that is being used at runtime with:\n\n```py\nimport finch\nprint(finch.__version__)\n```\n\n## Requirements\n\nPython 3.9 or higher.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n', }, { - "language": "ruby", - "content": "# Finch Ruby API library\n\nThe Finch Ruby library provides convenient access to the Finch REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/Finch-API/finch-api-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.\n\n\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Documentation\n\nDocumentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/finch-api).\n\nThe REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/).\n\n## Installation\n\nTo use this gem, install via Bundler by adding the following to your application's `Gemfile`:\n\n\n\n```ruby\ngem \"finch-api\", \"~> 0.0.1\"\n```\n\n\n\n## Usage\n\n```ruby\nrequire \"bundler/setup\"\nrequire \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\npage = finch.hris.directory.list\n\nputs(page.id)\n```\n\n\n\n### Pagination\n\nList methods in the Finch API are paginated.\n\nThis library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:\n\n```ruby\npage = finch.hris.directory.list\n\n# Fetch single item from page.\ndirectory = page.individuals[0]\nputs(directory.id)\n\n# Automatically fetches more pages as needed.\npage.auto_paging_each do |directory|\n puts(directory.id)\nend\n```\n\nAlternatively, you can use the `#next_page?` and `#next_page` methods for more granular control working with pages.\n\n```ruby\nif page.next_page?\n new_page = page.next_page\n puts(new_page.individuals[0].id)\nend\n```\n\n\n\n### Handling errors\n\nWhen the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `FinchAPI::Errors::APIError` will be thrown:\n\n```ruby\nbegin\n company = finch.hris.company.retrieve\nrescue FinchAPI::Errors::APIConnectionError => e\n puts(\"The server could not be reached\")\n puts(e.cause) # an underlying Exception, likely raised within `net/http`\nrescue FinchAPI::Errors::RateLimitError => e\n puts(\"A 429 status code was received; we should back off a bit.\")\nrescue FinchAPI::Errors::APIStatusError => e\n puts(\"Another non-200-range status code was received\")\n puts(e.status)\nend\n```\n\nError codes are as follows:\n\n| Cause | Error Type |\n| ---------------- | -------------------------- |\n| HTTP 400 | `BadRequestError` |\n| HTTP 401 | `AuthenticationError` |\n| HTTP 403 | `PermissionDeniedError` |\n| HTTP 404 | `NotFoundError` |\n| HTTP 409 | `ConflictError` |\n| HTTP 422 | `UnprocessableEntityError` |\n| HTTP 429 | `RateLimitError` |\n| HTTP >= 500 | `InternalServerError` |\n| Other HTTP error | `APIStatusError` |\n| Timeout | `APITimeoutError` |\n| Network error | `APIConnectionError` |\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\n\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, >=500 Internal errors, and timeouts will all be retried by default.\n\nYou can use the `max_retries` option to configure or disable this:\n\n```ruby\n# Configure the default for all requests:\nfinch = FinchAPI::Client.new(\n max_retries: 0 # default is 2\n)\n\n# Or, configure per-request:\nfinch.hris.directory.list(request_options: {max_retries: 5})\n```\n\n### Timeouts\n\nBy default, requests will time out after 60 seconds. You can use the timeout option to configure or disable this:\n\n```ruby\n# Configure the default for all requests:\nfinch = FinchAPI::Client.new(\n timeout: nil # default is 60\n)\n\n# Or, configure per-request:\nfinch.hris.directory.list(request_options: {timeout: 5})\n```\n\nOn timeout, `FinchAPI::Errors::APITimeoutError` is raised.\n\nNote that requests that time out are retried by default.\n\n## Advanced concepts\n\n### BaseModel\n\nAll parameter and response objects inherit from `FinchAPI::Internal::Type::BaseModel`, which provides several conveniences, including:\n\n1. All fields, including unknown ones, are accessible with `obj[:prop]` syntax, and can be destructured with `obj => {prop: prop}` or pattern-matching syntax.\n\n2. Structural equivalence for equality; if two API calls return the same values, comparing the responses with == will return true.\n\n3. Both instances and the classes themselves can be pretty-printed.\n\n4. Helpers such as `#to_h`, `#deep_to_h`, `#to_json`, and `#to_yaml`.\n\n### Making custom or undocumented requests\n\n#### Undocumented properties\n\nYou can send undocumented parameters to any endpoint, and read undocumented response properties, like so:\n\nNote: the `extra_` parameters of the same name overrides the documented parameters.\n\n```ruby\npage =\n finch.hris.directory.list(\n request_options: {\n extra_query: {my_query_parameter: value},\n extra_body: {my_body_parameter: value},\n extra_headers: {\"my-header\": value}\n }\n )\n\nputs(page[:my_undocumented_property])\n```\n\n#### Undocumented request params\n\nIf you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request, as seen in the examples above.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints while retaining the benefit of auth, retries, and so on, you can make requests using `client.request`, like so:\n\n```ruby\nresponse = client.request(\n method: :post,\n path: '/undocumented/endpoint',\n query: {\"dog\": \"woof\"},\n headers: {\"useful-header\": \"interesting-value\"},\n body: {\"hello\": \"world\"}\n)\n```\n\n### Concurrency & connection pooling\n\nThe `FinchAPI::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.\n\nEach instance of `FinchAPI::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.\n\nWhen all available connections from the pool are checked out, requests wait for a new connection to become available, with queue time counting towards the request timeout.\n\nUnless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.\n\n## Sorbet\n\nThis library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitions, and has no dependency on sorbet-runtime.\n\nYou can provide typesafe request parameters like so:\n\n```ruby\nfinch.hris.directory.list \n```\n\nOr, equivalently:\n\n```ruby\n# Hashes work, but are not typesafe:\nfinch.hris.directory.list\n\n# You can also splat a full Params class:\nparams = FinchAPI::HRIS::DirectoryListParams.new\nfinch.hris.directory.list(**params)\n```\n\n### Enums\n\nSince this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide \"tagged symbols\" instead, which is always a primitive at runtime:\n\n```ruby\n# :every_paycheck\nputs(FinchAPI::HRIS::BenefitFrequency::EVERY_PAYCHECK)\n\n# Revealed type: `T.all(FinchAPI::HRIS::BenefitFrequency, Symbol)`\nT.reveal_type(FinchAPI::HRIS::BenefitFrequency::EVERY_PAYCHECK)\n```\n\nEnum parameters have a \"relaxed\" type, so you can either pass in enum constants or their literal value:\n\n```ruby\n# Using the enum constants preserves the tagged type information:\nfinch.hris.benefits.create(\n frequency: FinchAPI::HRIS::BenefitFrequency::EVERY_PAYCHECK,\n # …\n)\n\n# Literal values are also permissible:\nfinch.hris.benefits.create(\n frequency: :every_paycheck,\n # …\n)\n```\n\n## Versioning\n\nThis package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time.\n\nThis package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` type definitions to be non-breaking changes.\n\n## Requirements\n\nRuby 3.2.0 or higher.\n\n## Contributing\n\nSee [the contributing documentation](https://github.com/Finch-API/finch-api-ruby/tree/main/CONTRIBUTING.md).\n" + language: 'ruby', + content: + '# Finch Ruby API library\n\nThe Finch Ruby library provides convenient access to the Finch REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/Finch-API/finch-api-ruby#Sorbet) for usage with Sorbet. The standard library\'s `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.\n\n\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Documentation\n\nDocumentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/finch-api).\n\nThe REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/).\n\n## Installation\n\nTo use this gem, install via Bundler by adding the following to your application\'s `Gemfile`:\n\n\n\n```ruby\ngem "finch-api", "~> 0.0.1"\n```\n\n\n\n## Usage\n\n```ruby\nrequire "bundler/setup"\nrequire "finch_api"\n\nfinch = FinchAPI::Client.new(access_token: "My Access Token")\n\npage = finch.hris.directory.list\n\nputs(page.id)\n```\n\n\n\n### Pagination\n\nList methods in the Finch API are paginated.\n\nThis library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:\n\n```ruby\npage = finch.hris.directory.list\n\n# Fetch single item from page.\ndirectory = page.individuals[0]\nputs(directory.id)\n\n# Automatically fetches more pages as needed.\npage.auto_paging_each do |directory|\n puts(directory.id)\nend\n```\n\nAlternatively, you can use the `#next_page?` and `#next_page` methods for more granular control working with pages.\n\n```ruby\nif page.next_page?\n new_page = page.next_page\n puts(new_page.individuals[0].id)\nend\n```\n\n\n\n### Handling errors\n\nWhen the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `FinchAPI::Errors::APIError` will be thrown:\n\n```ruby\nbegin\n company = finch.hris.company.retrieve\nrescue FinchAPI::Errors::APIConnectionError => e\n puts("The server could not be reached")\n puts(e.cause) # an underlying Exception, likely raised within `net/http`\nrescue FinchAPI::Errors::RateLimitError => e\n puts("A 429 status code was received; we should back off a bit.")\nrescue FinchAPI::Errors::APIStatusError => e\n puts("Another non-200-range status code was received")\n puts(e.status)\nend\n```\n\nError codes are as follows:\n\n| Cause | Error Type |\n| ---------------- | -------------------------- |\n| HTTP 400 | `BadRequestError` |\n| HTTP 401 | `AuthenticationError` |\n| HTTP 403 | `PermissionDeniedError` |\n| HTTP 404 | `NotFoundError` |\n| HTTP 409 | `ConflictError` |\n| HTTP 422 | `UnprocessableEntityError` |\n| HTTP 429 | `RateLimitError` |\n| HTTP >= 500 | `InternalServerError` |\n| Other HTTP error | `APIStatusError` |\n| Timeout | `APITimeoutError` |\n| Network error | `APIConnectionError` |\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\n\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, >=500 Internal errors, and timeouts will all be retried by default.\n\nYou can use the `max_retries` option to configure or disable this:\n\n```ruby\n# Configure the default for all requests:\nfinch = FinchAPI::Client.new(\n max_retries: 0 # default is 2\n)\n\n# Or, configure per-request:\nfinch.hris.directory.list(request_options: {max_retries: 5})\n```\n\n### Timeouts\n\nBy default, requests will time out after 60 seconds. You can use the timeout option to configure or disable this:\n\n```ruby\n# Configure the default for all requests:\nfinch = FinchAPI::Client.new(\n timeout: nil # default is 60\n)\n\n# Or, configure per-request:\nfinch.hris.directory.list(request_options: {timeout: 5})\n```\n\nOn timeout, `FinchAPI::Errors::APITimeoutError` is raised.\n\nNote that requests that time out are retried by default.\n\n## Advanced concepts\n\n### BaseModel\n\nAll parameter and response objects inherit from `FinchAPI::Internal::Type::BaseModel`, which provides several conveniences, including:\n\n1. All fields, including unknown ones, are accessible with `obj[:prop]` syntax, and can be destructured with `obj => {prop: prop}` or pattern-matching syntax.\n\n2. Structural equivalence for equality; if two API calls return the same values, comparing the responses with == will return true.\n\n3. Both instances and the classes themselves can be pretty-printed.\n\n4. Helpers such as `#to_h`, `#deep_to_h`, `#to_json`, and `#to_yaml`.\n\n### Making custom or undocumented requests\n\n#### Undocumented properties\n\nYou can send undocumented parameters to any endpoint, and read undocumented response properties, like so:\n\nNote: the `extra_` parameters of the same name overrides the documented parameters.\n\n```ruby\npage =\n finch.hris.directory.list(\n request_options: {\n extra_query: {my_query_parameter: value},\n extra_body: {my_body_parameter: value},\n extra_headers: {"my-header": value}\n }\n )\n\nputs(page[:my_undocumented_property])\n```\n\n#### Undocumented request params\n\nIf you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request, as seen in the examples above.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints while retaining the benefit of auth, retries, and so on, you can make requests using `client.request`, like so:\n\n```ruby\nresponse = client.request(\n method: :post,\n path: \'/undocumented/endpoint\',\n query: {"dog": "woof"},\n headers: {"useful-header": "interesting-value"},\n body: {"hello": "world"}\n)\n```\n\n### Concurrency & connection pooling\n\nThe `FinchAPI::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.\n\nEach instance of `FinchAPI::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.\n\nWhen all available connections from the pool are checked out, requests wait for a new connection to become available, with queue time counting towards the request timeout.\n\nUnless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.\n\n## Sorbet\n\nThis library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitions, and has no dependency on sorbet-runtime.\n\nYou can provide typesafe request parameters like so:\n\n```ruby\nfinch.hris.directory.list \n```\n\nOr, equivalently:\n\n```ruby\n# Hashes work, but are not typesafe:\nfinch.hris.directory.list\n\n# You can also splat a full Params class:\nparams = FinchAPI::HRIS::DirectoryListParams.new\nfinch.hris.directory.list(**params)\n```\n\n### Enums\n\nSince this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:\n\n```ruby\n# :every_paycheck\nputs(FinchAPI::HRIS::BenefitFrequency::EVERY_PAYCHECK)\n\n# Revealed type: `T.all(FinchAPI::HRIS::BenefitFrequency, Symbol)`\nT.reveal_type(FinchAPI::HRIS::BenefitFrequency::EVERY_PAYCHECK)\n```\n\nEnum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:\n\n```ruby\n# Using the enum constants preserves the tagged type information:\nfinch.hris.benefits.create(\n frequency: FinchAPI::HRIS::BenefitFrequency::EVERY_PAYCHECK,\n # …\n)\n\n# Literal values are also permissible:\nfinch.hris.benefits.create(\n frequency: :every_paycheck,\n # …\n)\n```\n\n## Versioning\n\nThis package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time.\n\nThis package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` type definitions to be non-breaking changes.\n\n## Requirements\n\nRuby 3.2.0 or higher.\n\n## Contributing\n\nSee [the contributing documentation](https://github.com/Finch-API/finch-api-ruby/tree/main/CONTRIBUTING.md).\n', }, { - "language": "typescript", - "content": "# Finch TypeScript API Library\n\n[![NPM version](https://img.shields.io/npm/v/@tryfinch/finch-api.svg?label=npm%20(stable))](https://npmjs.org/package/@tryfinch/finch-api) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@tryfinch/finch-api)\n\nThis library provides convenient access to the Finch REST API from server-side TypeScript or JavaScript.\n\n\n\nThe REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/). The full API of this library can be found in [api.md](api.md).\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Installation\n\n```sh\nnpm install @tryfinch/finch-api\n```\n\n\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n\n```js\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst page = await client.hris.directory.list();\nconst individualInDirectory = page.individuals[0];\n\nconsole.log(individualInDirectory.id);\n```\n\n\n\n### Request & Response types\n\nThis library includes TypeScript definitions for all request params and response fields. You may import and use them like so:\n\n\n```ts\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst [individualInDirectory]: [Finch.HRIS.IndividualInDirectory] =\n await client.hris.directory.list();\n```\n\nDocumentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.\n\n\n\n\n\n## Handling errors\n\nWhen the library is unable to connect to the API,\nor if the API returns a non-success status code (i.e., 4xx or 5xx response),\na subclass of `APIError` will be thrown:\n\n\n```ts\nconst company = await client.hris.company.retrieve().catch(async (err) => {\n if (err instanceof Finch.APIError) {\n console.log(err.status); // 400\n console.log(err.name); // BadRequestError\n console.log(err.headers); // {server: 'nginx', ...}\n } else {\n throw err;\n }\n});\n```\n\nError codes are as follows:\n\n| Status Code | Error Type |\n| ----------- | -------------------------- |\n| 400 | `BadRequestError` |\n| 401 | `AuthenticationError` |\n| 403 | `PermissionDeniedError` |\n| 404 | `NotFoundError` |\n| 422 | `UnprocessableEntityError` |\n| 429 | `RateLimitError` |\n| >=500 | `InternalServerError` |\n| N/A | `APIConnectionError` |\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,\n429 Rate Limit, and >=500 Internal errors will all be retried by default.\n\nYou can use the `maxRetries` option to configure or disable this:\n\n\n```js\n// Configure the default for all requests:\nconst client = new Finch({\n maxRetries: 0, // default is 2\n});\n\n// Or, configure per-request:\nawait client.hris.directory.list({\n maxRetries: 5,\n});\n```\n\n### Timeouts\n\nRequests time out after 1 minute by default. You can configure this with a `timeout` option:\n\n\n```ts\n// Configure the default for all requests:\nconst client = new Finch({\n timeout: 20 * 1000, // 20 seconds (default is 1 minute)\n});\n\n// Override per-request:\nawait client.hris.directory.list({\n timeout: 5 * 1000,\n});\n```\n\nOn timeout, an `APIConnectionTimeoutError` is thrown.\n\nNote that requests which time out will be [retried twice by default](#retries).\n\n## Auto-pagination\n\nList methods in the Finch API are paginated.\nYou can use the `for await … of` syntax to iterate through items across all pages:\n\n```ts\nasync function fetchAllIndividualInDirectories(params) {\n const allIndividualInDirectories = [];\n // Automatically fetches more pages as needed.\n for await (const individualInDirectory of client.hris.directory.list()) {\n allIndividualInDirectories.push(individualInDirectory);\n }\n return allIndividualInDirectories;\n}\n```\n\nAlternatively, you can request a single page at a time:\n\n```ts\nlet page = await client.hris.directory.list();\nfor (const individualInDirectory of page.individuals) {\n console.log(individualInDirectory);\n}\n\n// Convenience methods are provided for manually paginating:\nwhile (page.hasNextPage()) {\n page = await page.getNextPage();\n // ...\n}\n```\n\n## Default Headers\n\nWe automatically send the `Finch-API-Version` header set to `2020-09-17`.\n\nIf you need to, you can override it by setting default headers on a per-request basis.\n\nBe aware that doing so may result in incorrect types and other unexpected or undefined behavior in the SDK.\n\n```ts\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst page = await client.hris.directory.list({\n headers: { 'Finch-API-Version': 'My-Custom-Value' },\n});\nconst individualInDirectory = page.individuals[0];\n```\n\n## Advanced Usage\n\n### Accessing raw Response data (e.g., headers)\n\nThe \"raw\" `Response` returned by `fetch()` can be accessed through the `.asResponse()` method on the `APIPromise` type that all methods return.\nThis method returns as soon as the headers for a successful response are received and does not consume the response body, so you are free to write custom parsing or streaming logic.\n\nYou can also use the `.withResponse()` method to get the raw `Response` along with the parsed data.\nUnlike `.asResponse()` this method consumes the body, returning once it is parsed.\n\n\n```ts\nconst client = new Finch();\n\nconst response = await client.hris.directory.list().asResponse();\nconsole.log(response.headers.get('X-My-Header'));\nconsole.log(response.statusText); // access the underlying Response object\n\nconst { data: page, response: raw } = await client.hris.directory.list().withResponse();\nconsole.log(raw.headers.get('X-My-Header'));\nfor await (const individualInDirectory of page) {\n console.log(individualInDirectory.id);\n}\n```\n\n### Logging\n\n> [!IMPORTANT]\n> All log messages are intended for debugging only. The format and content of log messages\n> may change between releases.\n\n#### Log levels\n\nThe log level can be configured in two ways:\n\n1. Via the `FINCH_LOG` environment variable\n2. Using the `logLevel` client option (overrides the environment variable if set)\n\n```ts\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n logLevel: 'debug', // Show all log messages\n});\n```\n\nAvailable log levels, from most to least verbose:\n\n- `'debug'` - Show debug messages, info, warnings, and errors\n- `'info'` - Show info messages, warnings, and errors\n- `'warn'` - Show warnings and errors (default)\n- `'error'` - Show only errors\n- `'off'` - Disable all logging\n\nAt the `'debug'` level, all HTTP requests and responses are logged, including headers and bodies.\nSome authentication-related headers are redacted, but sensitive data in request and response bodies\nmay still be visible.\n\n#### Custom logger\n\nBy default, this library logs to `globalThis.console`. You can also provide a custom logger.\nMost logging libraries are supported, including [pino](https://www.npmjs.com/package/pino), [winston](https://www.npmjs.com/package/winston), [bunyan](https://www.npmjs.com/package/bunyan), [consola](https://www.npmjs.com/package/consola), [signale](https://www.npmjs.com/package/signale), and [@std/log](https://jsr.io/@std/log). If your logger doesn't work, please open an issue.\n\nWhen providing a custom logger, the `logLevel` option still controls which messages are emitted, messages\nbelow the configured level will not be sent to your logger.\n\n```ts\nimport Finch from '@tryfinch/finch-api';\nimport pino from 'pino';\n\nconst logger = pino();\n\nconst client = new Finch({\n logger: logger.child({ name: 'Finch' }),\n logLevel: 'debug', // Send all messages to pino, allowing it to filter\n});\n```\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API. If you need to access undocumented\nendpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can use `client.get`, `client.post`, and other HTTP verbs.\nOptions on the client, such as retries, will be respected when making these requests.\n\n```ts\nawait client.post('/some/path', {\n body: { some_prop: 'foo' },\n query: { some_query_arg: 'bar' },\n});\n```\n\n#### Undocumented request params\n\nTo make requests using undocumented parameters, you may use `// @ts-expect-error` on the undocumented\nparameter. This library doesn't validate at runtime that the request matches the type, so any extra values you\nsend will be sent as-is.\n\n```ts\nclient.hris.directory.list({\n // ...\n // @ts-expect-error baz is not yet public\n baz: 'undocumented option',\n});\n```\n\nFor requests with the `GET` verb, any extra params will be in the query, all other requests will send the\nextra param in the body.\n\nIf you want to explicitly send an extra argument, you can do so with the `query`, `body`, and `headers` request\noptions.\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you may access the response object with `// @ts-expect-error` on\nthe response object, or cast the response object to the requisite type. Like the request params, we do not\nvalidate or strip extra properties from the response from the API.\n\n### Customizing the fetch client\n\nBy default, this library expects a global `fetch` function is defined.\n\nIf you want to use a different `fetch` function, you can either polyfill the global:\n\n```ts\nimport fetch from 'my-fetch';\n\nglobalThis.fetch = fetch;\n```\n\nOr pass it to the client:\n\n```ts\nimport Finch from '@tryfinch/finch-api';\nimport fetch from 'my-fetch';\n\nconst client = new Finch({ fetch });\n```\n\n### Fetch options\n\nIf you want to set custom `fetch` options without overriding the `fetch` function, you can provide a `fetchOptions` object when instantiating the client or making a request. (Request-specific options override client options.)\n\n```ts\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n fetchOptions: {\n // `RequestInit` options\n },\n});\n```\n\n#### Configuring proxies\n\nTo modify proxy behavior, you can provide custom `fetchOptions` that add runtime-specific proxy\noptions to requests:\n\n **Node** [[docs](https://github.com/nodejs/undici/blob/main/docs/docs/api/ProxyAgent.md#example---proxyagent-with-fetch)]\n\n```ts\nimport Finch from '@tryfinch/finch-api';\nimport * as undici from 'undici';\n\nconst proxyAgent = new undici.ProxyAgent('http://localhost:8888');\nconst client = new Finch({\n fetchOptions: {\n dispatcher: proxyAgent,\n },\n});\n```\n\n **Bun** [[docs](https://bun.sh/guides/http/proxy)]\n\n```ts\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n fetchOptions: {\n proxy: 'http://localhost:8888',\n },\n});\n```\n\n **Deno** [[docs](https://docs.deno.com/api/deno/~/Deno.createHttpClient)]\n\n```ts\nimport Finch from 'npm:@tryfinch/finch-api';\n\nconst httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });\nconst client = new Finch({\n fetchOptions: {\n client: httpClient,\n },\n});\n```\n\n## Frequently Asked Questions\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes that only affect static types, without breaking runtime behavior.\n2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n3. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Finch-API/finch-api-node/issues) with questions, bugs, or suggestions.\n\n## Requirements\n\nTypeScript >= 4.9 is supported.\n\nThe following runtimes are supported:\n\n- Node.js 20 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.\n- Deno v1.28.0 or higher.\n- Bun 1.0 or later.\n- Cloudflare Workers.\n- Vercel Edge Runtime.\n- Jest 28 or greater with the `\"node\"` environment (`\"jsdom\"` is not supported at this time).\n- Nitro v2.6 or greater.\n- Web browsers: disabled by default to avoid exposing your secret API credentials. Enable browser support by explicitly setting `dangerouslyAllowBrowser` to true'.\n
\n More explanation\n\n ### Why is this dangerous?\n Enabling the `dangerouslyAllowBrowser` option can be dangerous because it exposes your secret API credentials in the client-side code. Web browsers are inherently less secure than server environments,\n any user with access to the browser can potentially inspect, extract, and misuse these credentials. This could lead to unauthorized access using your credentials and potentially compromise sensitive data or functionality.\n ### When might this not be dangerous?\n In certain scenarios where enabling browser support might not pose significant risks:\n - Internal Tools: If the application is used solely within a controlled internal environment where the users are trusted, the risk of credential exposure can be mitigated.\n - Public APIs with Limited Scope: If your API has very limited scope and the exposed credentials do not grant access to sensitive data or critical operations, the potential impact of exposure is reduced.\n - Development or debugging purpose: Enabling this feature temporarily might be acceptable, provided the credentials are short-lived, aren't also used in production environments, or are frequently rotated.\n\n
\n\nNote that React Native is not supported at this time.\n\nIf you are interested in other runtime environments, please open or upvote an issue on GitHub.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n" - } + language: 'typescript', + content: + "# Finch TypeScript API Library\n\n[![NPM version](https://img.shields.io/npm/v/@tryfinch/finch-api.svg?label=npm%20(stable))](https://npmjs.org/package/@tryfinch/finch-api) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@tryfinch/finch-api)\n\nThis library provides convenient access to the Finch REST API from server-side TypeScript or JavaScript.\n\n\n\nThe REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/). The full API of this library can be found in [api.md](api.md).\n\nIt is generated with [Stainless](https://www.stainless.com/).\n\n## MCP Server\n\nUse the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.\n\n[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl0sImVudiI6eyJGSU5DSF9BQ0NFU1NfVE9LRU4iOiJNeSBBY2Nlc3MgVG9rZW4iLCJGSU5DSF9DTElFTlRfSUQiOiI0YWIxNWU1MS0xMWFkLTQ5ZjQtYWNhZS1mMzQzYjc3OTQzNzUiLCJGSU5DSF9DTElFTlRfU0VDUkVUIjoiTXkgQ2xpZW50IFNlY3JldCIsIkZJTkNIX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)\n[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%2C%22env%22%3A%7B%22FINCH_ACCESS_TOKEN%22%3A%22My%20Access%20Token%22%2C%22FINCH_CLIENT_ID%22%3A%224ab15e51-11ad-49f4-acae-f343b7794375%22%2C%22FINCH_CLIENT_SECRET%22%3A%22My%20Client%20Secret%22%2C%22FINCH_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)\n\n> Note: You may need to set environment variables in your MCP client.\n\n## Installation\n\n```sh\nnpm install @tryfinch/finch-api\n```\n\n\n\n## Usage\n\nThe full API of this library can be found in [api.md](api.md).\n\n\n```js\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst page = await client.hris.directory.list();\nconst individualInDirectory = page.individuals[0];\n\nconsole.log(individualInDirectory.id);\n```\n\n\n\n### Request & Response types\n\nThis library includes TypeScript definitions for all request params and response fields. You may import and use them like so:\n\n\n```ts\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst [individualInDirectory]: [Finch.HRIS.IndividualInDirectory] =\n await client.hris.directory.list();\n```\n\nDocumentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.\n\n\n\n\n\n## Handling errors\n\nWhen the library is unable to connect to the API,\nor if the API returns a non-success status code (i.e., 4xx or 5xx response),\na subclass of `APIError` will be thrown:\n\n\n```ts\nconst company = await client.hris.company.retrieve().catch(async (err) => {\n if (err instanceof Finch.APIError) {\n console.log(err.status); // 400\n console.log(err.name); // BadRequestError\n console.log(err.headers); // {server: 'nginx', ...}\n } else {\n throw err;\n }\n});\n```\n\nError codes are as follows:\n\n| Status Code | Error Type |\n| ----------- | -------------------------- |\n| 400 | `BadRequestError` |\n| 401 | `AuthenticationError` |\n| 403 | `PermissionDeniedError` |\n| 404 | `NotFoundError` |\n| 422 | `UnprocessableEntityError` |\n| 429 | `RateLimitError` |\n| >=500 | `InternalServerError` |\n| N/A | `APIConnectionError` |\n\n### Retries\n\nCertain errors will be automatically retried 2 times by default, with a short exponential backoff.\nConnection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,\n429 Rate Limit, and >=500 Internal errors will all be retried by default.\n\nYou can use the `maxRetries` option to configure or disable this:\n\n\n```js\n// Configure the default for all requests:\nconst client = new Finch({\n maxRetries: 0, // default is 2\n});\n\n// Or, configure per-request:\nawait client.hris.directory.list({\n maxRetries: 5,\n});\n```\n\n### Timeouts\n\nRequests time out after 1 minute by default. You can configure this with a `timeout` option:\n\n\n```ts\n// Configure the default for all requests:\nconst client = new Finch({\n timeout: 20 * 1000, // 20 seconds (default is 1 minute)\n});\n\n// Override per-request:\nawait client.hris.directory.list({\n timeout: 5 * 1000,\n});\n```\n\nOn timeout, an `APIConnectionTimeoutError` is thrown.\n\nNote that requests which time out will be [retried twice by default](#retries).\n\n## Auto-pagination\n\nList methods in the Finch API are paginated.\nYou can use the `for await … of` syntax to iterate through items across all pages:\n\n```ts\nasync function fetchAllIndividualInDirectories(params) {\n const allIndividualInDirectories = [];\n // Automatically fetches more pages as needed.\n for await (const individualInDirectory of client.hris.directory.list()) {\n allIndividualInDirectories.push(individualInDirectory);\n }\n return allIndividualInDirectories;\n}\n```\n\nAlternatively, you can request a single page at a time:\n\n```ts\nlet page = await client.hris.directory.list();\nfor (const individualInDirectory of page.individuals) {\n console.log(individualInDirectory);\n}\n\n// Convenience methods are provided for manually paginating:\nwhile (page.hasNextPage()) {\n page = await page.getNextPage();\n // ...\n}\n```\n\n## Default Headers\n\nWe automatically send the `Finch-API-Version` header set to `2020-09-17`.\n\nIf you need to, you can override it by setting default headers on a per-request basis.\n\nBe aware that doing so may result in incorrect types and other unexpected or undefined behavior in the SDK.\n\n```ts\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch();\n\nconst page = await client.hris.directory.list({\n headers: { 'Finch-API-Version': 'My-Custom-Value' },\n});\nconst individualInDirectory = page.individuals[0];\n```\n\n## Advanced Usage\n\n### Accessing raw Response data (e.g., headers)\n\nThe \"raw\" `Response` returned by `fetch()` can be accessed through the `.asResponse()` method on the `APIPromise` type that all methods return.\nThis method returns as soon as the headers for a successful response are received and does not consume the response body, so you are free to write custom parsing or streaming logic.\n\nYou can also use the `.withResponse()` method to get the raw `Response` along with the parsed data.\nUnlike `.asResponse()` this method consumes the body, returning once it is parsed.\n\n\n```ts\nconst client = new Finch();\n\nconst response = await client.hris.directory.list().asResponse();\nconsole.log(response.headers.get('X-My-Header'));\nconsole.log(response.statusText); // access the underlying Response object\n\nconst { data: page, response: raw } = await client.hris.directory.list().withResponse();\nconsole.log(raw.headers.get('X-My-Header'));\nfor await (const individualInDirectory of page) {\n console.log(individualInDirectory.id);\n}\n```\n\n### Logging\n\n> [!IMPORTANT]\n> All log messages are intended for debugging only. The format and content of log messages\n> may change between releases.\n\n#### Log levels\n\nThe log level can be configured in two ways:\n\n1. Via the `FINCH_LOG` environment variable\n2. Using the `logLevel` client option (overrides the environment variable if set)\n\n```ts\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n logLevel: 'debug', // Show all log messages\n});\n```\n\nAvailable log levels, from most to least verbose:\n\n- `'debug'` - Show debug messages, info, warnings, and errors\n- `'info'` - Show info messages, warnings, and errors\n- `'warn'` - Show warnings and errors (default)\n- `'error'` - Show only errors\n- `'off'` - Disable all logging\n\nAt the `'debug'` level, all HTTP requests and responses are logged, including headers and bodies.\nSome authentication-related headers are redacted, but sensitive data in request and response bodies\nmay still be visible.\n\n#### Custom logger\n\nBy default, this library logs to `globalThis.console`. You can also provide a custom logger.\nMost logging libraries are supported, including [pino](https://www.npmjs.com/package/pino), [winston](https://www.npmjs.com/package/winston), [bunyan](https://www.npmjs.com/package/bunyan), [consola](https://www.npmjs.com/package/consola), [signale](https://www.npmjs.com/package/signale), and [@std/log](https://jsr.io/@std/log). If your logger doesn't work, please open an issue.\n\nWhen providing a custom logger, the `logLevel` option still controls which messages are emitted, messages\nbelow the configured level will not be sent to your logger.\n\n```ts\nimport Finch from '@tryfinch/finch-api';\nimport pino from 'pino';\n\nconst logger = pino();\n\nconst client = new Finch({\n logger: logger.child({ name: 'Finch' }),\n logLevel: 'debug', // Send all messages to pino, allowing it to filter\n});\n```\n\n### Making custom/undocumented requests\n\nThis library is typed for convenient access to the documented API. If you need to access undocumented\nendpoints, params, or response properties, the library can still be used.\n\n#### Undocumented endpoints\n\nTo make requests to undocumented endpoints, you can use `client.get`, `client.post`, and other HTTP verbs.\nOptions on the client, such as retries, will be respected when making these requests.\n\n```ts\nawait client.post('/some/path', {\n body: { some_prop: 'foo' },\n query: { some_query_arg: 'bar' },\n});\n```\n\n#### Undocumented request params\n\nTo make requests using undocumented parameters, you may use `// @ts-expect-error` on the undocumented\nparameter. This library doesn't validate at runtime that the request matches the type, so any extra values you\nsend will be sent as-is.\n\n```ts\nclient.hris.directory.list({\n // ...\n // @ts-expect-error baz is not yet public\n baz: 'undocumented option',\n});\n```\n\nFor requests with the `GET` verb, any extra params will be in the query, all other requests will send the\nextra param in the body.\n\nIf you want to explicitly send an extra argument, you can do so with the `query`, `body`, and `headers` request\noptions.\n\n#### Undocumented response properties\n\nTo access undocumented response properties, you may access the response object with `// @ts-expect-error` on\nthe response object, or cast the response object to the requisite type. Like the request params, we do not\nvalidate or strip extra properties from the response from the API.\n\n### Customizing the fetch client\n\nBy default, this library expects a global `fetch` function is defined.\n\nIf you want to use a different `fetch` function, you can either polyfill the global:\n\n```ts\nimport fetch from 'my-fetch';\n\nglobalThis.fetch = fetch;\n```\n\nOr pass it to the client:\n\n```ts\nimport Finch from '@tryfinch/finch-api';\nimport fetch from 'my-fetch';\n\nconst client = new Finch({ fetch });\n```\n\n### Fetch options\n\nIf you want to set custom `fetch` options without overriding the `fetch` function, you can provide a `fetchOptions` object when instantiating the client or making a request. (Request-specific options override client options.)\n\n```ts\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n fetchOptions: {\n // `RequestInit` options\n },\n});\n```\n\n#### Configuring proxies\n\nTo modify proxy behavior, you can provide custom `fetchOptions` that add runtime-specific proxy\noptions to requests:\n\n **Node** [[docs](https://github.com/nodejs/undici/blob/main/docs/docs/api/ProxyAgent.md#example---proxyagent-with-fetch)]\n\n```ts\nimport Finch from '@tryfinch/finch-api';\nimport * as undici from 'undici';\n\nconst proxyAgent = new undici.ProxyAgent('http://localhost:8888');\nconst client = new Finch({\n fetchOptions: {\n dispatcher: proxyAgent,\n },\n});\n```\n\n **Bun** [[docs](https://bun.sh/guides/http/proxy)]\n\n```ts\nimport Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n fetchOptions: {\n proxy: 'http://localhost:8888',\n },\n});\n```\n\n **Deno** [[docs](https://docs.deno.com/api/deno/~/Deno.createHttpClient)]\n\n```ts\nimport Finch from 'npm:@tryfinch/finch-api';\n\nconst httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });\nconst client = new Finch({\n fetchOptions: {\n client: httpClient,\n },\n});\n```\n\n## Frequently Asked Questions\n\n## Semantic versioning\n\nThis package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:\n\n1. Changes that only affect static types, without breaking runtime behavior.\n2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_\n3. Changes that we do not expect to impact the vast majority of users in practice.\n\nWe take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.\n\nWe are keen for your feedback; please open an [issue](https://www.github.com/Finch-API/finch-api-node/issues) with questions, bugs, or suggestions.\n\n## Requirements\n\nTypeScript >= 4.9 is supported.\n\nThe following runtimes are supported:\n\n- Node.js 20 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.\n- Deno v1.28.0 or higher.\n- Bun 1.0 or later.\n- Cloudflare Workers.\n- Vercel Edge Runtime.\n- Jest 28 or greater with the `\"node\"` environment (`\"jsdom\"` is not supported at this time).\n- Nitro v2.6 or greater.\n- Web browsers: disabled by default to avoid exposing your secret API credentials. Enable browser support by explicitly setting `dangerouslyAllowBrowser` to true'.\n
\n More explanation\n\n ### Why is this dangerous?\n Enabling the `dangerouslyAllowBrowser` option can be dangerous because it exposes your secret API credentials in the client-side code. Web browsers are inherently less secure than server environments,\n any user with access to the browser can potentially inspect, extract, and misuse these credentials. This could lead to unauthorized access using your credentials and potentially compromise sensitive data or functionality.\n ### When might this not be dangerous?\n In certain scenarios where enabling browser support might not pose significant risks:\n - Internal Tools: If the application is used solely within a controlled internal environment where the users are trusted, the risk of credential exposure can be mitigated.\n - Public APIs with Limited Scope: If your API has very limited scope and the exposed credentials do not grant access to sensitive data or critical operations, the potential impact of exposure is reduced.\n - Development or debugging purpose: Enabling this feature temporarily might be acceptable, provided the credentials are short-lived, aren't also used in production environments, or are frequently rotated.\n\n
\n\nNote that React Native is not supported at this time.\n\nIf you are interested in other runtime environments, please open or upvote an issue on GitHub.\n\n## Contributing\n\nSee [the contributing documentation](./CONTRIBUTING.md).\n", + }, ]; const INDEX_OPTIONS = { @@ -2236,21 +2587,18 @@ export class LocalDocsSearch { maxResults?: number; maxLength?: number; }): SearchResult { - const { - query, - language = 'typescript', - detail = 'default', - maxResults = 5, - maxLength = 100_000, - } = props; + const { query, language = 'typescript', detail = 'default', maxResults = 5, maxLength = 100_000 } = props; const useMarkdown = detail === 'verbose' || detail === 'high'; // Search both indices and merge results by score. // Filter prose hits so language-tagged content (READMEs and docs with // frontmatter) only matches the requested language. - const methodHits = this.methodIndex.search(query).map((hit) => ({ ...hit, _kind: 'http_method' as const })); - const proseHits = this.proseIndex.search(query) + const methodHits = this.methodIndex + .search(query) + .map((hit) => ({ ...hit, _kind: 'http_method' as const })); + const proseHits = this.proseIndex + .search(query) .filter((hit) => { const source = ((hit as Record)['_original'] as ProseChunk | undefined)?.source; if (!source) return true; diff --git a/packages/mcp-server/src/methods.ts b/packages/mcp-server/src/methods.ts index 344b7e9f..82258b2f 100644 --- a/packages/mcp-server/src/methods.ts +++ b/packages/mcp-server/src/methods.ts @@ -7,239 +7,290 @@ export type SdkMethod = { fullyQualifiedName: string; httpMethod?: 'get' | 'post' | 'put' | 'patch' | 'delete' | 'query'; httpPath?: string; -} +}; -export const sdkMethods: SdkMethod[] = [{ - clientCallName: 'client.accessTokens.create', - fullyQualifiedName: 'accessTokens.create', - httpMethod: 'post', - httpPath: '/auth/token', -},{ - clientCallName: 'client.hris.company.retrieve', - fullyQualifiedName: 'hris.company.retrieve', - httpMethod: 'get', - httpPath: '/employer/company', -},{ - clientCallName: 'client.hris.company.payStatementItem.list', - fullyQualifiedName: 'hris.company.payStatementItem.list', - httpMethod: 'get', - httpPath: '/employer/pay-statement-item', -},{ - clientCallName: 'client.hris.company.payStatementItem.rules.create', - fullyQualifiedName: 'hris.company.payStatementItem.rules.create', - httpMethod: 'post', - httpPath: '/employer/pay-statement-item/rule', -},{ - clientCallName: 'client.hris.company.payStatementItem.rules.update', - fullyQualifiedName: 'hris.company.payStatementItem.rules.update', - httpMethod: 'put', - httpPath: '/employer/pay-statement-item/rule/{rule_id}', -},{ - clientCallName: 'client.hris.company.payStatementItem.rules.list', - fullyQualifiedName: 'hris.company.payStatementItem.rules.list', - httpMethod: 'get', - httpPath: '/employer/pay-statement-item/rule', -},{ - clientCallName: 'client.hris.company.payStatementItem.rules.delete', - fullyQualifiedName: 'hris.company.payStatementItem.rules.delete', - httpMethod: 'delete', - httpPath: '/employer/pay-statement-item/rule/{rule_id}', -},{ - clientCallName: 'client.hris.directory.list', - fullyQualifiedName: 'hris.directory.list', - httpMethod: 'get', - httpPath: '/employer/directory', -},{ clientCallName: 'client.hris.directory.listIndividuals', fullyQualifiedName: 'hris.directory.listIndividuals' },{ - clientCallName: 'client.hris.individuals.retrieveMany', - fullyQualifiedName: 'hris.individuals.retrieveMany', - httpMethod: 'post', - httpPath: '/employer/individual', -},{ - clientCallName: 'client.hris.employments.retrieveMany', - fullyQualifiedName: 'hris.employments.retrieveMany', - httpMethod: 'post', - httpPath: '/employer/employment', -},{ - clientCallName: 'client.hris.payments.list', - fullyQualifiedName: 'hris.payments.list', - httpMethod: 'get', - httpPath: '/employer/payment', -},{ - clientCallName: 'client.hris.payStatements.retrieveMany', - fullyQualifiedName: 'hris.payStatements.retrieveMany', - httpMethod: 'post', - httpPath: '/employer/pay-statement', -},{ - clientCallName: 'client.hris.documents.list', - fullyQualifiedName: 'hris.documents.list', - httpMethod: 'get', - httpPath: '/employer/documents', -},{ - clientCallName: 'client.hris.documents.retreive', - fullyQualifiedName: 'hris.documents.retreive', - httpMethod: 'get', - httpPath: '/employer/documents/{document_id}', -},{ - clientCallName: 'client.hris.benefits.create', - fullyQualifiedName: 'hris.benefits.create', - httpMethod: 'post', - httpPath: '/employer/benefits', -},{ - clientCallName: 'client.hris.benefits.retrieve', - fullyQualifiedName: 'hris.benefits.retrieve', - httpMethod: 'get', - httpPath: '/employer/benefits/{benefit_id}', -},{ - clientCallName: 'client.hris.benefits.update', - fullyQualifiedName: 'hris.benefits.update', - httpMethod: 'post', - httpPath: '/employer/benefits/{benefit_id}', -},{ - clientCallName: 'client.hris.benefits.list', - fullyQualifiedName: 'hris.benefits.list', - httpMethod: 'get', - httpPath: '/employer/benefits', -},{ - clientCallName: 'client.hris.benefits.listSupportedBenefits', - fullyQualifiedName: 'hris.benefits.listSupportedBenefits', - httpMethod: 'get', - httpPath: '/employer/benefits/meta', -},{ - clientCallName: 'client.hris.benefits.individuals.enrollMany', - fullyQualifiedName: 'hris.benefits.individuals.enrollMany', - httpMethod: 'post', - httpPath: '/employer/benefits/{benefit_id}/individuals', -},{ - clientCallName: 'client.hris.benefits.individuals.enrolledIDs', - fullyQualifiedName: 'hris.benefits.individuals.enrolledIDs', - httpMethod: 'get', - httpPath: '/employer/benefits/{benefit_id}/enrolled', -},{ - clientCallName: 'client.hris.benefits.individuals.retrieveManyBenefits', - fullyQualifiedName: 'hris.benefits.individuals.retrieveManyBenefits', - httpMethod: 'get', - httpPath: '/employer/benefits/{benefit_id}/individuals', -},{ - clientCallName: 'client.hris.benefits.individuals.unenrollMany', - fullyQualifiedName: 'hris.benefits.individuals.unenrollMany', - httpMethod: 'delete', - httpPath: '/employer/benefits/{benefit_id}/individuals', -},{ - clientCallName: 'client.providers.list', - fullyQualifiedName: 'providers.list', - httpMethod: 'get', - httpPath: '/providers', -},{ - clientCallName: 'client.account.disconnect', - fullyQualifiedName: 'account.disconnect', - httpMethod: 'post', - httpPath: '/disconnect', -},{ - clientCallName: 'client.account.introspect', - fullyQualifiedName: 'account.introspect', - httpMethod: 'get', - httpPath: '/introspect', -},{ - clientCallName: 'client.requestForwarding.forward', - fullyQualifiedName: 'requestForwarding.forward', - httpMethod: 'post', - httpPath: '/forward', -},{ - clientCallName: 'client.jobs.automated.create', - fullyQualifiedName: 'jobs.automated.create', - httpMethod: 'post', - httpPath: '/jobs/automated', -},{ - clientCallName: 'client.jobs.automated.retrieve', - fullyQualifiedName: 'jobs.automated.retrieve', - httpMethod: 'get', - httpPath: '/jobs/automated/{job_id}', -},{ - clientCallName: 'client.jobs.automated.list', - fullyQualifiedName: 'jobs.automated.list', - httpMethod: 'get', - httpPath: '/jobs/automated', -},{ - clientCallName: 'client.jobs.manual.retrieve', - fullyQualifiedName: 'jobs.manual.retrieve', - httpMethod: 'get', - httpPath: '/jobs/manual/{job_id}', -},{ - clientCallName: 'client.sandbox.connections.create', - fullyQualifiedName: 'sandbox.connections.create', - httpMethod: 'post', - httpPath: '/sandbox/connections', -},{ - clientCallName: 'client.sandbox.connections.accounts.create', - fullyQualifiedName: 'sandbox.connections.accounts.create', - httpMethod: 'post', - httpPath: '/sandbox/connections/accounts', -},{ - clientCallName: 'client.sandbox.connections.accounts.update', - fullyQualifiedName: 'sandbox.connections.accounts.update', - httpMethod: 'put', - httpPath: '/sandbox/connections/accounts', -},{ - clientCallName: 'client.sandbox.company.update', - fullyQualifiedName: 'sandbox.company.update', - httpMethod: 'put', - httpPath: '/sandbox/company', -},{ - clientCallName: 'client.sandbox.directory.create', - fullyQualifiedName: 'sandbox.directory.create', - httpMethod: 'post', - httpPath: '/sandbox/directory', -},{ - clientCallName: 'client.sandbox.individual.update', - fullyQualifiedName: 'sandbox.individual.update', - httpMethod: 'put', - httpPath: '/sandbox/individual/{individual_id}', -},{ - clientCallName: 'client.sandbox.employment.update', - fullyQualifiedName: 'sandbox.employment.update', - httpMethod: 'put', - httpPath: '/sandbox/employment/{individual_id}', -},{ - clientCallName: 'client.sandbox.payment.create', - fullyQualifiedName: 'sandbox.payment.create', - httpMethod: 'post', - httpPath: '/sandbox/payment', -},{ - clientCallName: 'client.sandbox.jobs.create', - fullyQualifiedName: 'sandbox.jobs.create', - httpMethod: 'post', - httpPath: '/sandbox/jobs', -},{ - clientCallName: 'client.sandbox.jobs.configuration.retrieve', - fullyQualifiedName: 'sandbox.jobs.configuration.retrieve', - httpMethod: 'get', - httpPath: '/sandbox/jobs/configuration', -},{ - clientCallName: 'client.sandbox.jobs.configuration.update', - fullyQualifiedName: 'sandbox.jobs.configuration.update', - httpMethod: 'put', - httpPath: '/sandbox/jobs/configuration', -},{ - clientCallName: 'client.payroll.payGroups.retrieve', - fullyQualifiedName: 'payroll.payGroups.retrieve', - httpMethod: 'get', - httpPath: '/employer/pay-groups/{pay_group_id}', -},{ - clientCallName: 'client.payroll.payGroups.list', - fullyQualifiedName: 'payroll.payGroups.list', - httpMethod: 'get', - httpPath: '/employer/pay-groups', -},{ - clientCallName: 'client.connect.sessions.new', - fullyQualifiedName: 'connect.sessions.new', - httpMethod: 'post', - httpPath: '/connect/sessions', -},{ - clientCallName: 'client.connect.sessions.reauthenticate', - fullyQualifiedName: 'connect.sessions.reauthenticate', - httpMethod: 'post', - httpPath: '/connect/sessions/reauthenticate', -}]; +export const sdkMethods: SdkMethod[] = [ + { + clientCallName: 'client.accessTokens.create', + fullyQualifiedName: 'accessTokens.create', + httpMethod: 'post', + httpPath: '/auth/token', + }, + { + clientCallName: 'client.hris.company.retrieve', + fullyQualifiedName: 'hris.company.retrieve', + httpMethod: 'get', + httpPath: '/employer/company', + }, + { + clientCallName: 'client.hris.company.payStatementItem.list', + fullyQualifiedName: 'hris.company.payStatementItem.list', + httpMethod: 'get', + httpPath: '/employer/pay-statement-item', + }, + { + clientCallName: 'client.hris.company.payStatementItem.rules.create', + fullyQualifiedName: 'hris.company.payStatementItem.rules.create', + httpMethod: 'post', + httpPath: '/employer/pay-statement-item/rule', + }, + { + clientCallName: 'client.hris.company.payStatementItem.rules.update', + fullyQualifiedName: 'hris.company.payStatementItem.rules.update', + httpMethod: 'put', + httpPath: '/employer/pay-statement-item/rule/{rule_id}', + }, + { + clientCallName: 'client.hris.company.payStatementItem.rules.list', + fullyQualifiedName: 'hris.company.payStatementItem.rules.list', + httpMethod: 'get', + httpPath: '/employer/pay-statement-item/rule', + }, + { + clientCallName: 'client.hris.company.payStatementItem.rules.delete', + fullyQualifiedName: 'hris.company.payStatementItem.rules.delete', + httpMethod: 'delete', + httpPath: '/employer/pay-statement-item/rule/{rule_id}', + }, + { + clientCallName: 'client.hris.directory.list', + fullyQualifiedName: 'hris.directory.list', + httpMethod: 'get', + httpPath: '/employer/directory', + }, + { + clientCallName: 'client.hris.directory.listIndividuals', + fullyQualifiedName: 'hris.directory.listIndividuals', + }, + { + clientCallName: 'client.hris.individuals.retrieveMany', + fullyQualifiedName: 'hris.individuals.retrieveMany', + httpMethod: 'post', + httpPath: '/employer/individual', + }, + { + clientCallName: 'client.hris.employments.retrieveMany', + fullyQualifiedName: 'hris.employments.retrieveMany', + httpMethod: 'post', + httpPath: '/employer/employment', + }, + { + clientCallName: 'client.hris.payments.list', + fullyQualifiedName: 'hris.payments.list', + httpMethod: 'get', + httpPath: '/employer/payment', + }, + { + clientCallName: 'client.hris.payStatements.retrieveMany', + fullyQualifiedName: 'hris.payStatements.retrieveMany', + httpMethod: 'post', + httpPath: '/employer/pay-statement', + }, + { + clientCallName: 'client.hris.documents.list', + fullyQualifiedName: 'hris.documents.list', + httpMethod: 'get', + httpPath: '/employer/documents', + }, + { + clientCallName: 'client.hris.documents.retreive', + fullyQualifiedName: 'hris.documents.retreive', + httpMethod: 'get', + httpPath: '/employer/documents/{document_id}', + }, + { + clientCallName: 'client.hris.benefits.create', + fullyQualifiedName: 'hris.benefits.create', + httpMethod: 'post', + httpPath: '/employer/benefits', + }, + { + clientCallName: 'client.hris.benefits.retrieve', + fullyQualifiedName: 'hris.benefits.retrieve', + httpMethod: 'get', + httpPath: '/employer/benefits/{benefit_id}', + }, + { + clientCallName: 'client.hris.benefits.update', + fullyQualifiedName: 'hris.benefits.update', + httpMethod: 'post', + httpPath: '/employer/benefits/{benefit_id}', + }, + { + clientCallName: 'client.hris.benefits.list', + fullyQualifiedName: 'hris.benefits.list', + httpMethod: 'get', + httpPath: '/employer/benefits', + }, + { + clientCallName: 'client.hris.benefits.listSupportedBenefits', + fullyQualifiedName: 'hris.benefits.listSupportedBenefits', + httpMethod: 'get', + httpPath: '/employer/benefits/meta', + }, + { + clientCallName: 'client.hris.benefits.individuals.enrollMany', + fullyQualifiedName: 'hris.benefits.individuals.enrollMany', + httpMethod: 'post', + httpPath: '/employer/benefits/{benefit_id}/individuals', + }, + { + clientCallName: 'client.hris.benefits.individuals.enrolledIDs', + fullyQualifiedName: 'hris.benefits.individuals.enrolledIDs', + httpMethod: 'get', + httpPath: '/employer/benefits/{benefit_id}/enrolled', + }, + { + clientCallName: 'client.hris.benefits.individuals.retrieveManyBenefits', + fullyQualifiedName: 'hris.benefits.individuals.retrieveManyBenefits', + httpMethod: 'get', + httpPath: '/employer/benefits/{benefit_id}/individuals', + }, + { + clientCallName: 'client.hris.benefits.individuals.unenrollMany', + fullyQualifiedName: 'hris.benefits.individuals.unenrollMany', + httpMethod: 'delete', + httpPath: '/employer/benefits/{benefit_id}/individuals', + }, + { + clientCallName: 'client.providers.list', + fullyQualifiedName: 'providers.list', + httpMethod: 'get', + httpPath: '/providers', + }, + { + clientCallName: 'client.account.disconnect', + fullyQualifiedName: 'account.disconnect', + httpMethod: 'post', + httpPath: '/disconnect', + }, + { + clientCallName: 'client.account.introspect', + fullyQualifiedName: 'account.introspect', + httpMethod: 'get', + httpPath: '/introspect', + }, + { + clientCallName: 'client.requestForwarding.forward', + fullyQualifiedName: 'requestForwarding.forward', + httpMethod: 'post', + httpPath: '/forward', + }, + { + clientCallName: 'client.jobs.automated.create', + fullyQualifiedName: 'jobs.automated.create', + httpMethod: 'post', + httpPath: '/jobs/automated', + }, + { + clientCallName: 'client.jobs.automated.retrieve', + fullyQualifiedName: 'jobs.automated.retrieve', + httpMethod: 'get', + httpPath: '/jobs/automated/{job_id}', + }, + { + clientCallName: 'client.jobs.automated.list', + fullyQualifiedName: 'jobs.automated.list', + httpMethod: 'get', + httpPath: '/jobs/automated', + }, + { + clientCallName: 'client.jobs.manual.retrieve', + fullyQualifiedName: 'jobs.manual.retrieve', + httpMethod: 'get', + httpPath: '/jobs/manual/{job_id}', + }, + { + clientCallName: 'client.sandbox.connections.create', + fullyQualifiedName: 'sandbox.connections.create', + httpMethod: 'post', + httpPath: '/sandbox/connections', + }, + { + clientCallName: 'client.sandbox.connections.accounts.create', + fullyQualifiedName: 'sandbox.connections.accounts.create', + httpMethod: 'post', + httpPath: '/sandbox/connections/accounts', + }, + { + clientCallName: 'client.sandbox.connections.accounts.update', + fullyQualifiedName: 'sandbox.connections.accounts.update', + httpMethod: 'put', + httpPath: '/sandbox/connections/accounts', + }, + { + clientCallName: 'client.sandbox.company.update', + fullyQualifiedName: 'sandbox.company.update', + httpMethod: 'put', + httpPath: '/sandbox/company', + }, + { + clientCallName: 'client.sandbox.directory.create', + fullyQualifiedName: 'sandbox.directory.create', + httpMethod: 'post', + httpPath: '/sandbox/directory', + }, + { + clientCallName: 'client.sandbox.individual.update', + fullyQualifiedName: 'sandbox.individual.update', + httpMethod: 'put', + httpPath: '/sandbox/individual/{individual_id}', + }, + { + clientCallName: 'client.sandbox.employment.update', + fullyQualifiedName: 'sandbox.employment.update', + httpMethod: 'put', + httpPath: '/sandbox/employment/{individual_id}', + }, + { + clientCallName: 'client.sandbox.payment.create', + fullyQualifiedName: 'sandbox.payment.create', + httpMethod: 'post', + httpPath: '/sandbox/payment', + }, + { + clientCallName: 'client.sandbox.jobs.create', + fullyQualifiedName: 'sandbox.jobs.create', + httpMethod: 'post', + httpPath: '/sandbox/jobs', + }, + { + clientCallName: 'client.sandbox.jobs.configuration.retrieve', + fullyQualifiedName: 'sandbox.jobs.configuration.retrieve', + httpMethod: 'get', + httpPath: '/sandbox/jobs/configuration', + }, + { + clientCallName: 'client.sandbox.jobs.configuration.update', + fullyQualifiedName: 'sandbox.jobs.configuration.update', + httpMethod: 'put', + httpPath: '/sandbox/jobs/configuration', + }, + { + clientCallName: 'client.payroll.payGroups.retrieve', + fullyQualifiedName: 'payroll.payGroups.retrieve', + httpMethod: 'get', + httpPath: '/employer/pay-groups/{pay_group_id}', + }, + { + clientCallName: 'client.payroll.payGroups.list', + fullyQualifiedName: 'payroll.payGroups.list', + httpMethod: 'get', + httpPath: '/employer/pay-groups', + }, + { + clientCallName: 'client.connect.sessions.new', + fullyQualifiedName: 'connect.sessions.new', + httpMethod: 'post', + httpPath: '/connect/sessions', + }, + { + clientCallName: 'client.connect.sessions.reauthenticate', + fullyQualifiedName: 'connect.sessions.reauthenticate', + httpMethod: 'post', + httpPath: '/connect/sessions/reauthenticate', + }, +]; function allowedMethodsForCodeTool(options: McpOptions | undefined): SdkMethod[] | undefined { if (!options) { @@ -254,9 +305,9 @@ function allowedMethodsForCodeTool(options: McpOptions | undefined): SdkMethod[] if (options.codeAllowHttpGets) { // Add all methods that map to an HTTP GET - sdkMethods.filter((method) => method.httpMethod === 'get').forEach( - (method) => allowedMethodsSet.add(method) - ); + sdkMethods + .filter((method) => method.httpMethod === 'get') + .forEach((method) => allowedMethodsSet.add(method)); } if (options.codeAllowedMethods) { @@ -265,13 +316,15 @@ function allowedMethodsForCodeTool(options: McpOptions | undefined): SdkMethod[] try { return new RegExp(pattern); } catch (e) { - throw new Error(`Invalid regex pattern for allowed method: "${pattern}": ${e instanceof Error ? e.message : e}`); + throw new Error( + `Invalid regex pattern for allowed method: "${pattern}": ${e instanceof Error ? e.message : e}`, + ); } }); - sdkMethods.filter((method) => - allowedRegexps.some((regexp) => regexp.test(method.fullyQualifiedName)) - ).forEach((method) => allowedMethodsSet.add(method)); + sdkMethods + .filter((method) => allowedRegexps.some((regexp) => regexp.test(method.fullyQualifiedName))) + .forEach((method) => allowedMethodsSet.add(method)); } allowedMethods = Array.from(allowedMethodsSet); @@ -286,12 +339,14 @@ function allowedMethodsForCodeTool(options: McpOptions | undefined): SdkMethod[] try { return new RegExp(pattern); } catch (e) { - throw new Error(`Invalid regex pattern for blocked method: "${pattern}": ${e instanceof Error ? e.message : e}`); + throw new Error( + `Invalid regex pattern for blocked method: "${pattern}": ${e instanceof Error ? e.message : e}`, + ); } }); - allowedMethods = allowedMethods.filter((method) => - !blockedRegexps.some((regexp) => regexp.test(method.fullyQualifiedName)) + allowedMethods = allowedMethods.filter( + (method) => !blockedRegexps.some((regexp) => regexp.test(method.fullyQualifiedName)), ); } diff --git a/packages/mcp-server/src/options.ts b/packages/mcp-server/src/options.ts index 873ab8e8..f1518764 100644 --- a/packages/mcp-server/src/options.ts +++ b/packages/mcp-server/src/options.ts @@ -31,31 +31,46 @@ export type McpCodeExecutionMode = 'stainless-sandbox' | 'local'; export function parseCLIOptions(): CLIOptions { const opts = yargs(hideBin(process.argv)) - .option('code-allow-http-gets', { type: 'boolean', description: 'Allow all code tool methods that map to HTTP GET operations. If all code-allow-* flags are unset, then everything is allowed.' }) + .option('code-allow-http-gets', { + type: 'boolean', + description: + 'Allow all code tool methods that map to HTTP GET operations. If all code-allow-* flags are unset, then everything is allowed.', + }) .option('code-allowed-methods', { type: 'string', array: true, - description: 'Methods to explicitly allow for code tool. Evaluated as regular expressions against method fully qualified names. If all code-allow-* flags are unset, then everything is allowed.', + description: + 'Methods to explicitly allow for code tool. Evaluated as regular expressions against method fully qualified names. If all code-allow-* flags are unset, then everything is allowed.', }) .option('code-blocked-methods', { type: 'string', array: true, - description: 'Methods to explicitly block for code tool. Evaluated as regular expressions against method fully qualified names. If all code-allow-* flags are unset, then everything is allowed.', + description: + 'Methods to explicitly block for code tool. Evaluated as regular expressions against method fully qualified names. If all code-allow-* flags are unset, then everything is allowed.', }) .option('code-execution-mode', { type: 'string', choices: ['stainless-sandbox', 'local'], default: 'stainless-sandbox', - description: 'Where to run code execution in code tool; \'stainless-sandbox\' will execute code in Stainless-hosted sandboxes whereas \'local\' will execute code locally on the MCP server machine.', + description: + "Where to run code execution in code tool; 'stainless-sandbox' will execute code in Stainless-hosted sandboxes whereas 'local' will execute code locally on the MCP server machine.", + }) + .option('custom-instructions-path', { + type: 'string', + description: 'Path to custom instructions for the MCP server', }) - .option('custom-instructions-path', { type: 'string', description: 'Path to custom instructions for the MCP server' }) .option('debug', { type: 'boolean', description: 'Enable debug logging' }) - .option('docs-dir', { type: 'string', description: 'Path to a directory of local documentation files (markdown/JSON) to include in local docs search.' }) + .option('docs-dir', { + type: 'string', + description: + 'Path to a directory of local documentation files (markdown/JSON) to include in local docs search.', + }) .option('docs-search-mode', { type: 'string', choices: ['stainless-api', 'local'], default: 'stainless-api', - description: 'Where to search documentation; \'stainless-api\' uses the Stainless-hosted search API whereas \'local\' uses an in-memory search index built from embedded SDK method data and optional local docs files.', + description: + "Where to search documentation; 'stainless-api' uses the Stainless-hosted search API whereas 'local' uses an in-memory search index built from embedded SDK method data and optional local docs files.", }) .option('log-format', { type: 'string', @@ -77,7 +92,8 @@ export function parseCLIOptions(): CLIOptions { .option('stainless-api-key', { type: 'string', default: readEnv('STAINLESS_API_KEY'), - description: 'API key for Stainless. Used to authenticate requests to Stainless-hosted tools endpoints.', + description: + 'API key for Stainless. Used to authenticate requests to Stainless-hosted tools endpoints.', }) .option('tools', { type: 'string', @@ -98,15 +114,18 @@ export function parseCLIOptions(): CLIOptions { const argv = opts.parseSync(); const shouldIncludeToolType = (toolType: 'code' | 'docs') => - argv.noTools?.includes(toolType) ? false - : argv.tools?.includes(toolType) ? true - : undefined; + argv.noTools?.includes(toolType) ? false + : argv.tools?.includes(toolType) ? true + : undefined; const includeCodeTool = shouldIncludeToolType('code'); const includeDocsTools = shouldIncludeToolType('docs'); const transport = argv.transport as 'stdio' | 'http'; - const logFormat = argv.logFormat ? argv.logFormat as 'json' | 'pretty' : (process.stderr.isTTY ? 'pretty' : 'json'); + const logFormat = + argv.logFormat ? (argv.logFormat as 'json' | 'pretty') + : process.stderr.isTTY ? 'pretty' + : 'json'; return { ...(includeCodeTool !== undefined && { includeCodeTool }), @@ -147,8 +166,8 @@ export function parseQueryOptions(defaultOptions: McpOptions, query: unknown): M const queryOptions = QueryOptions.parse(queryObject); let codeTool: boolean | undefined = - queryOptions.no_tools && queryOptions.no_tools?.includes("code") ? false - : queryOptions.tools?.includes("code") ? true + queryOptions.no_tools && queryOptions.no_tools?.includes('code') ? false + : queryOptions.tools?.includes('code') ? true : defaultOptions.includeCodeTool; let docsTools: boolean | undefined = diff --git a/packages/mcp-server/src/server.ts b/packages/mcp-server/src/server.ts index 71e4b1ff..6a26f6c7 100644 --- a/packages/mcp-server/src/server.ts +++ b/packages/mcp-server/src/server.ts @@ -3,7 +3,9 @@ import { Server } from '@modelcontextprotocol/sdk/server/index.js'; import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js'; import { - CallToolRequestSchema,ListToolsRequestSchema,SetLevelRequestSchema + CallToolRequestSchema, + ListToolsRequestSchema, + SetLevelRequestSchema, } from '@modelcontextprotocol/sdk/types.js'; import { ClientOptions } from '@tryfinch/finch-api'; import Finch from '@tryfinch/finch-api'; @@ -14,25 +16,26 @@ import { LocalDocsSearch } from './local-docs-search'; import { getInstructions } from './instructions'; import { McpOptions } from './options'; import { blockedMethodsForCodeTool } from './methods'; -import { HandlerFunction, McpRequestContext, ToolCallResult, McpTool } from "./types" +import { HandlerFunction, McpRequestContext, ToolCallResult, McpTool } from './types'; import { readEnv } from './util'; export const newMcpServer = async ({ stainlessApiKey, customInstructionsPath, }: { - stainlessApiKey?: string | undefined, - customInstructionsPath?: string | undefined, -}) => new McpServer( - { - name: 'tryfinch_finch_api_api', - version: '9.6.0', - }, - { - instructions: await getInstructions({stainlessApiKey, customInstructionsPath}), - capabilities: { tools: {}, logging: {} }, - } -); + stainlessApiKey?: string | undefined; + customInstructionsPath?: string | undefined; +}) => + new McpServer( + { + name: 'tryfinch_finch_api_api', + version: '9.6.0', + }, + { + instructions: await getInstructions({ stainlessApiKey, customInstructionsPath }), + capabilities: { tools: {}, logging: {} }, + }, + ); /** * Initializes the provided MCP Server with the given tools and handlers. @@ -54,15 +57,15 @@ export async function initMcpServer(params: { (message: string, ...rest: unknown[]) => { void server.sendLoggingMessage({ level, - data: {message, rest}, + data: { message, rest }, }); - } + }; const logger = { - debug: logAtLevel("debug"), - info: logAtLevel("info"), - warn: logAtLevel("warning"), - error: logAtLevel("error"), - } + debug: logAtLevel('debug'), + info: logAtLevel('info'), + warn: logAtLevel('warning'), + error: logAtLevel('error'), + }; if (params.mcpOptions?.docsSearchMode === 'local') { const docsDir = params.mcpOptions?.docsDir; @@ -79,14 +82,14 @@ export async function initMcpServer(params: { if (!_client) { try { _client = new Finch({ - ...({ accessToken: readEnv('FINCH_ACCESS_TOKEN') }), - logger, - ...params.clientOptions, - defaultHeaders: { - ...params.clientOptions?.defaultHeaders, - 'X-Stainless-MCP': 'true', - }, -}); + ...{ accessToken: readEnv('FINCH_ACCESS_TOKEN') }, + logger, + ...params.clientOptions, + defaultHeaders: { + ...params.clientOptions?.defaultHeaders, + 'X-Stainless-MCP': 'true', + }, + }); if (_logLevel) { _client = _client.withOptions({ logLevel: _logLevel }); } @@ -119,10 +122,12 @@ export async function initMcpServer(params: { client = getClient(); } catch (error) { return { - content: [{ - type: 'text' as const, - text: `Failed to initialize client: ${error instanceof Error ? error.message : String(error)}`, - }], + content: [ + { + type: 'text' as const, + text: `Failed to initialize client: ${error instanceof Error ? error.message : String(error)}`, + }, + ], isError: true, }; } @@ -172,17 +177,16 @@ export async function initMcpServer(params: { /** * Selects the tools to include in the MCP Server based on the provided options. */ -export function selectTools( - options?: McpOptions -): McpTool[] { - +export function selectTools(options?: McpOptions): McpTool[] { const includedTools = []; if (options?.includeCodeTool ?? true) { - includedTools.push(codeTool({ - blockedMethods: blockedMethodsForCodeTool(options), - codeExecutionMode: options?.codeExecutionMode ?? 'stainless-sandbox', - })); + includedTools.push( + codeTool({ + blockedMethods: blockedMethodsForCodeTool(options), + codeExecutionMode: options?.codeExecutionMode ?? 'stainless-sandbox', + }), + ); } if (options?.includeDocsTools ?? true) { includedTools.push(docsSearchTool); @@ -193,13 +197,14 @@ export function selectTools( /** * Runs the provided handler with the given client and arguments. */ -export async function executeHandler( - {handler, reqContext, args}: - { - handler: HandlerFunction; - reqContext: McpRequestContext; - args: Record | undefined; - } -): Promise { - return await handler({reqContext, args: args || {}}); +export async function executeHandler({ + handler, + reqContext, + args, +}: { + handler: HandlerFunction; + reqContext: McpRequestContext; + args: Record | undefined; +}): Promise { + return await handler({ reqContext, args: args || {} }); } diff --git a/packages/mcp-server/src/types.ts b/packages/mcp-server/src/types.ts index f71be718..667354fc 100644 --- a/packages/mcp-server/src/types.ts +++ b/packages/mcp-server/src/types.ts @@ -4,41 +4,43 @@ import Finch from '@tryfinch/finch-api'; import { Tool } from '@modelcontextprotocol/sdk/types.js'; type TextContentBlock = { - type: "text", - text: string -} + type: 'text'; + text: string; +}; type ImageContentBlock = { - type: "image", - data: string, - mimeType: string -} + type: 'image'; + data: string; + mimeType: string; +}; type AudioContentBlock = { - type: "audio", - data: string, - mimeType: string -} + type: 'audio'; + data: string; + mimeType: string; +}; type ResourceContentBlock = { - type: "resource", - resource: { - uri: string, - mimeType: string, - text: string - } | { - uri: string, - mimeType: string, - blob: string - } -} + type: 'resource'; + resource: + | { + uri: string; + mimeType: string; + text: string; + } + | { + uri: string; + mimeType: string; + blob: string; + }; +}; export type ContentBlock = TextContentBlock | ImageContentBlock | AudioContentBlock | ResourceContentBlock; export type ToolCallResult = { content: ContentBlock[]; isError?: boolean; -} +}; export type McpRequestContext = { client: Finch; @@ -46,7 +48,7 @@ export type McpRequestContext = { upstreamClientEnvs?: Record | undefined; mcpSessionId?: string | undefined; mcpClientInfo?: { name: string; version: string } | undefined; -} +}; export type HandlerFunction = ({ reqContext, @@ -56,9 +58,7 @@ export type HandlerFunction = ({ args: Record | undefined; }) => Promise; -export function asTextContentResult( - result: unknown, -): ToolCallResult { +export function asTextContentResult(result: unknown): ToolCallResult { return { content: [ { @@ -69,24 +69,18 @@ export function asTextContentResult( }; } -export async function asBinaryContentResult( - response: Response, -): Promise { +export async function asBinaryContentResult(response: Response): Promise { const blob = await response.blob(); const mimeType = blob.type; const data = Buffer.from(await blob.arrayBuffer()).toString('base64'); if (mimeType.startsWith('image/')) { return { - content: [ - {type: 'image', mimeType, data} - ] - } + content: [{ type: 'image', mimeType, data }], + }; } else if (mimeType.startsWith('audio/')) { return { - content: [ - {type: 'audio', mimeType, data} - ] - } + content: [{ type: 'audio', mimeType, data }], + }; } else { return { content: [ @@ -104,9 +98,7 @@ export async function asBinaryContentResult( } } -export function asErrorResult( - message: string -): ToolCallResult { +export function asErrorResult(message: string): ToolCallResult { return { content: [ { @@ -128,7 +120,7 @@ export type Metadata = { }; export type McpTool = { - metadata: Metadata, - tool: Tool, - handler: HandlerFunction + metadata: Metadata; + tool: Tool; + handler: HandlerFunction; }; diff --git a/scripts/fast-format b/scripts/fast-format index e1723136..53721ac0 100755 --- a/scripts/fast-format +++ b/scripts/fast-format @@ -31,8 +31,10 @@ if ! [ -z "$ESLINT_FILES" ]; then fi echo "==> Running prettier --write" -PRETTIER_FILES="$(grep '\.\([mc]?tsx?\|[mc]?jsx?\|json\)$' "$FILE_LIST" || true)" +# format things eslint didn't +PRETTIER_FILES="$(grep '\.\(js\|json\)$' "$FILE_LIST" || true)" if ! [ -z "$PRETTIER_FILES" ]; then echo "$PRETTIER_FILES" | xargs ./node_modules/.bin/prettier \ - --write --cache --cache-strategy metadata --no-error-on-unmatched-pattern + --write --cache --cache-strategy metadata --no-error-on-unmatched-pattern \ + '!**/dist' '!**/*.ts' '!**/*.mts' '!**/*.cts' '!**/*.js' '!**/*.mjs' '!**/*.cjs' fi diff --git a/scripts/format b/scripts/format index b1b2c17a..7a756401 100755 --- a/scripts/format +++ b/scripts/format @@ -8,4 +8,5 @@ echo "==> Running eslint --fix" ./node_modules/.bin/eslint --fix . echo "==> Running prettier --write" -./node_modules/.bin/prettier --write --cache --cache-strategy metadata . +# format things eslint didn't +./node_modules/.bin/prettier --write --cache --cache-strategy metadata . '!**/dist' '!**/*.ts' '!**/*.mts' '!**/*.cts' '!**/*.js' '!**/*.mjs' '!**/*.cjs' diff --git a/scripts/lint b/scripts/lint index 1f532548..3ffb78a6 100755 --- a/scripts/lint +++ b/scripts/lint @@ -4,9 +4,6 @@ set -e cd "$(dirname "$0")/.." -echo "==> Running prettier --check" -./node_modules/.bin/prettier --check . - echo "==> Running eslint" ./node_modules/.bin/eslint . diff --git a/scripts/utils/postprocess-files.cjs b/scripts/utils/postprocess-files.cjs index deae575e..a8cdeb7c 100644 --- a/scripts/utils/postprocess-files.cjs +++ b/scripts/utils/postprocess-files.cjs @@ -23,12 +23,19 @@ async function postprocess() { // strip out lib="dom", types="node", and types="react" references; these // are needed at build time, but would pollute the user's TS environment - const transformed = code.replace( + let transformed = code.replace( /^ *\/\/\/ * ' '.repeat(match.length - 1) + '\n', ); + // TypeScript's declaration emitter collapses /** @ts-ignore */ onto the same + // line as the type declaration, which doesn't work. So we convert to // @ts-ignore + // on its own line to properly suppresses errors. + if (file.endsWith('.d.ts') || file.endsWith('.d.mts') || file.endsWith('.d.cts')) { + transformed = transformed.replace(/\/\*\* @ts-ignore\b[^*]*\*\/ /gm, '// @ts-ignore\n'); + } + if (transformed !== code) { console.error(`wrote ${path.relative(process.cwd(), file)}`); await fs.promises.writeFile(file, transformed, 'utf8'); diff --git a/src/api-promise.ts b/src/api-promise.ts index 4e701286..8c775ee6 100644 --- a/src/api-promise.ts +++ b/src/api-promise.ts @@ -1,2 +1,2 @@ /** @deprecated Import from ./core/api-promise instead */ -export * from "./core/api-promise" \ No newline at end of file +export * from './core/api-promise'; diff --git a/src/client.ts b/src/client.ts index 441377c6..48d32320 100644 --- a/src/client.ts +++ b/src/client.ts @@ -15,15 +15,44 @@ import { stringifyQuery } from './internal/utils/query'; import { VERSION } from './version'; import * as Errors from './core/error'; import * as Pagination from './core/pagination'; -import { AbstractPage, type IndividualsPageParams, IndividualsPageResponse, type PageParams, PageResponse, ResponsesPageResponse, SinglePageResponse } from './core/pagination'; +import { + AbstractPage, + type IndividualsPageParams, + IndividualsPageResponse, + type PageParams, + PageResponse, + ResponsesPageResponse, + SinglePageResponse, +} from './core/pagination'; import * as Uploads from './core/uploads'; import * as API from './resources/index'; import { APIPromise } from './core/api-promise'; import { AccessTokenCreateParams, AccessTokens, CreateAccessTokenResponse } from './resources/access-tokens'; import { Account, DisconnectResponse, Introspection } from './resources/account'; -import { Provider, ProviderListResponse, ProviderListResponsesSinglePage, Providers } from './resources/providers'; -import { RequestForwarding, RequestForwardingForwardParams, RequestForwardingForwardResponse } from './resources/request-forwarding'; -import { AccountUpdateEvent, BaseWebhookEvent, CompanyEvent, DirectoryEvent, EmploymentEvent, IndividualEvent, JobCompletionEvent, PayStatementEvent, PaymentEvent, WebhookEvent, Webhooks } from './resources/webhooks'; +import { + Provider, + ProviderListResponse, + ProviderListResponsesSinglePage, + Providers, +} from './resources/providers'; +import { + RequestForwarding, + RequestForwardingForwardParams, + RequestForwardingForwardResponse, +} from './resources/request-forwarding'; +import { + AccountUpdateEvent, + BaseWebhookEvent, + CompanyEvent, + DirectoryEvent, + EmploymentEvent, + IndividualEvent, + JobCompletionEvent, + PayStatementEvent, + PaymentEvent, + WebhookEvent, + Webhooks, +} from './resources/webhooks'; import { Connect } from './resources/connect/connect'; import { HRIS, Income, Location, Money } from './resources/hris/hris'; import { Jobs } from './resources/jobs/jobs'; @@ -35,7 +64,13 @@ import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers'; import { FinalRequestOptions, RequestOptions } from './internal/request-options'; import { toBase64 } from './internal/utils/base64'; import { readEnv } from './internal/utils/env'; -import { type LogLevel, type Logger, formatRequestDetails, loggerFor, parseLogLevel } from './internal/utils/log'; +import { + type LogLevel, + type Logger, + formatRequestDetails, + loggerFor, + parseLogLevel, +} from './internal/utils/log'; import { isEmptyObj } from './internal/utils/values'; export interface ClientOptions { @@ -132,7 +167,7 @@ export interface ClientOptions { } /** - * API Client for interfacing with the Finch API. + * API Client for interfacing with the Finch API. */ export class Finch { accessToken: string | null; @@ -176,7 +211,6 @@ export class Finch { webhookSecret = readEnv('FINCH_WEBHOOK_SECRET') ?? null, ...opts }: ClientOptions = {}) { - const options: ClientOptions = { accessToken, clientID, @@ -187,7 +221,9 @@ export class Finch { }; if (!options.dangerouslyAllowBrowser && isRunningInBrowser()) { - throw new Errors.FinchError('This is disabled by default, as it risks exposing your secret API credentials to attackers.\nIf you understand the risks and have appropriate mitigations in place,\nyou can set the `dangerouslyAllowBrowser` option to `true`, e.g.,\n\nnew Finch({ dangerouslyAllowBrowser: true })') + throw new Errors.FinchError( + 'This is disabled by default, as it risks exposing your secret API credentials to attackers.\nIf you understand the risks and have appropriate mitigations in place,\nyou can set the `dangerouslyAllowBrowser` option to `true`, e.g.,\n\nnew Finch({ dangerouslyAllowBrowser: true })', + ); } this.baseURL = options.baseURL!; @@ -196,7 +232,10 @@ export class Finch { const defaultLogLevel = 'warn'; // Set default logLevel early so that we can log a warning in parseLogLevel. this.logLevel = defaultLogLevel; - this.logLevel = parseLogLevel(options.logLevel, 'ClientOptions.logLevel', this) ?? parseLogLevel(readEnv('FINCH_LOG'), 'process.env[\'FINCH_LOG\']', this) ?? defaultLogLevel; + this.logLevel = + parseLogLevel(options.logLevel, 'ClientOptions.logLevel', this) ?? + parseLogLevel(readEnv('FINCH_LOG'), "process.env['FINCH_LOG']", this) ?? + defaultLogLevel; this.fetchOptions = options.fetchOptions; this.maxRetries = options.maxRetries ?? 2; this.fetch = options.fetch ?? Shims.getDefaultFetch(); @@ -227,7 +266,7 @@ export class Finch { clientID: this.clientID, clientSecret: this.clientSecret, webhookSecret: this.webhookSecret, - ...options + ...options, }); return client; } @@ -240,7 +279,7 @@ export class Finch { } protected defaultQuery(): Record | undefined { - return this._options.defaultQuery + return this._options.defaultQuery; } protected validateHeaders({ values, nulls }: NullableHeaders) { @@ -258,11 +297,19 @@ export class Finch { return; } - throw new Error('Could not resolve authentication method. Expected either accessToken, clientID or clientSecret to be set. Or for one of the "Authorization" or "Authorization" headers to be explicitly omitted') + throw new Error( + 'Could not resolve authentication method. Expected either accessToken, clientID or clientSecret to be set. Or for one of the "Authorization" or "Authorization" headers to be explicitly omitted', + ); } - protected async authHeaders(opts: FinalRequestOptions, schemes: { bearerAuth?: boolean, basicAuth?: boolean }): Promise { - return buildHeaders([schemes.bearerAuth ? await this.bearerAuth(opts) : null, schemes.basicAuth ? await this.basicAuth(opts) : null]); + protected async authHeaders( + opts: FinalRequestOptions, + schemes: { bearerAuth?: boolean; basicAuth?: boolean }, + ): Promise { + return buildHeaders([ + schemes.bearerAuth ? await this.bearerAuth(opts) : null, + schemes.basicAuth ? await this.basicAuth(opts) : null, + ]); } protected async bearerAuth(opts: FinalRequestOptions): Promise { @@ -281,9 +328,9 @@ export class Finch { return undefined; } - const credentials = `${this.clientID}:${this.clientSecret}` - const Authorization = `Basic ${toBase64(credentials)}` - return buildHeaders([{ Authorization }]) + const credentials = `${this.clientID}:${this.clientSecret}`; + const Authorization = `Basic ${toBase64(credentials)}`; + return buildHeaders([{ Authorization }]); } protected stringifyQuery(query: object | Record): string { @@ -307,7 +354,11 @@ export class Finch { return Errors.APIError.generate(status, error, message, headers); } - buildURL(path: string, query: Record | null | undefined, defaultBaseURL?: string | undefined): string { + buildURL( + path: string, + query: Record | null | undefined, + defaultBaseURL?: string | undefined, + ): string { const baseURL = (!this.#baseURLOverridden() && defaultBaseURL) || this.baseURL; const url = isAbsoluteURL(path) ? @@ -395,7 +446,9 @@ export class Finch { await this.prepareOptions(options); - const { req, url, timeout } = await this.buildRequest(options, { retryCount: maxRetries - retriesRemaining }); + const { req, url, timeout } = await this.buildRequest(options, { + retryCount: maxRetries - retriesRemaining, + }); await this.prepareRequest(req, { url, options }); @@ -404,7 +457,16 @@ export class Finch { const retryLogStr = retryOfRequestLogID === undefined ? '' : `, retryOf: ${retryOfRequestLogID}`; const startTime = Date.now(); - loggerFor(this).debug(`[${requestLogID}] sending request`, formatRequestDetails({ retryOfRequestLogID, method: options.method, url, options, headers: req.headers })); + loggerFor(this).debug( + `[${requestLogID}] sending request`, + formatRequestDetails({ + retryOfRequestLogID, + method: options.method, + url, + options, + headers: req.headers, + }), + ); if (options.signal?.aborted) { throw new Errors.APIUserAbortError(); @@ -423,21 +485,45 @@ export class Finch { // deno throws "TypeError: error sending request for url (https://example/): client error (Connect): tcp connect error: Operation timed out (os error 60): Operation timed out (os error 60)" // undici throws "TypeError: fetch failed" with cause "ConnectTimeoutError: Connect Timeout Error (attempted address: example:443, timeout: 1ms)" // others do not provide enough information to distinguish timeouts from other connection errors - const isTimeout = isAbortError(response) || /timed? ?out/i.test(String(response) + ('cause' in response ? String(response.cause) : '')) + const isTimeout = + isAbortError(response) || + /timed? ?out/i.test(String(response) + ('cause' in response ? String(response.cause) : '')); if (retriesRemaining) { - loggerFor(this).info(`[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} - ${retryMessage}`) - loggerFor(this).debug(`[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} (${retryMessage})`, formatRequestDetails({ retryOfRequestLogID, url, durationMs: headersTime - startTime, message: response.message })); + loggerFor(this).info( + `[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} - ${retryMessage}`, + ); + loggerFor(this).debug( + `[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} (${retryMessage})`, + formatRequestDetails({ + retryOfRequestLogID, + url, + durationMs: headersTime - startTime, + message: response.message, + }), + ); return this.retryRequest(options, retriesRemaining, retryOfRequestLogID ?? requestLogID); } - loggerFor(this).info(`[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} - error; no more retries left`) - loggerFor(this).debug(`[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} (error; no more retries left)`, formatRequestDetails({ retryOfRequestLogID, url, durationMs: headersTime - startTime, message: response.message })); + loggerFor(this).info( + `[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} - error; no more retries left`, + ); + loggerFor(this).debug( + `[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} (error; no more retries left)`, + formatRequestDetails({ + retryOfRequestLogID, + url, + durationMs: headersTime - startTime, + message: response.message, + }), + ); if (isTimeout) { throw new Errors.APIConnectionTimeoutError(); } throw new Errors.APIConnectionError({ cause: response }); } - const responseInfo = `[${requestLogID}${retryLogStr}] ${req.method} ${url} ${response.ok ? 'succeeded' : 'failed'} with status ${response.status} in ${headersTime - startTime}ms`; + const responseInfo = `[${requestLogID}${retryLogStr}] ${req.method} ${url} ${ + response.ok ? 'succeeded' : 'failed' + } with status ${response.status} in ${headersTime - startTime}ms`; if (!response.ok) { const shouldRetry = await this.shouldRetry(response); @@ -446,27 +532,60 @@ export class Finch { // We don't need the body of this response. await Shims.CancelReadableStream(response.body); - loggerFor(this).info(`${responseInfo} - ${retryMessage}`) - loggerFor(this).debug(`[${requestLogID}] response error (${retryMessage})`, formatRequestDetails({ retryOfRequestLogID, url: response.url, status: response.status, headers: response.headers, durationMs: headersTime - startTime })); - return this.retryRequest(options, retriesRemaining, retryOfRequestLogID ?? requestLogID, response.headers); + loggerFor(this).info(`${responseInfo} - ${retryMessage}`); + loggerFor(this).debug( + `[${requestLogID}] response error (${retryMessage})`, + formatRequestDetails({ + retryOfRequestLogID, + url: response.url, + status: response.status, + headers: response.headers, + durationMs: headersTime - startTime, + }), + ); + return this.retryRequest( + options, + retriesRemaining, + retryOfRequestLogID ?? requestLogID, + response.headers, + ); } const retryMessage = shouldRetry ? `error; no more retries left` : `error; not retryable`; - loggerFor(this).info(`${responseInfo} - ${retryMessage}`) + loggerFor(this).info(`${responseInfo} - ${retryMessage}`); const errText = await response.text().catch((err: any) => castToError(err).message); const errJSON = safeJSON(errText) as any; const errMessage = errJSON ? undefined : errText; - loggerFor(this).debug(`[${requestLogID}] response error (${retryMessage})`, formatRequestDetails({ retryOfRequestLogID, url: response.url, status: response.status, headers: response.headers, message: errMessage, durationMs: Date.now() - startTime })); + loggerFor(this).debug( + `[${requestLogID}] response error (${retryMessage})`, + formatRequestDetails({ + retryOfRequestLogID, + url: response.url, + status: response.status, + headers: response.headers, + message: errMessage, + durationMs: Date.now() - startTime, + }), + ); const err = this.makeStatusError(response.status, errJSON, errMessage, response.headers); throw err; } - loggerFor(this).info(responseInfo) - loggerFor(this).debug(`[${requestLogID}] response start`, formatRequestDetails({ retryOfRequestLogID, url: response.url, status: response.status, headers: response.headers, durationMs: headersTime - startTime })); + loggerFor(this).info(responseInfo); + loggerFor(this).debug( + `[${requestLogID}] response start`, + formatRequestDetails({ + retryOfRequestLogID, + url: response.url, + status: response.status, + headers: response.headers, + durationMs: headersTime - startTime, + }), + ); return { response, options, controller, requestLogID, retryOfRequestLogID, startTime }; } @@ -484,7 +603,10 @@ export class Finch { ); } - requestAPIList = Pagination.AbstractPage>( + requestAPIList< + Item = unknown, + PageClass extends Pagination.AbstractPage = Pagination.AbstractPage, + >( Page: new (...args: ConstructorParameters) => PageClass, options: PromiseOrValue, ): Pagination.PagePromise { @@ -504,7 +626,9 @@ export class Finch { const timeout = setTimeout(abort, ms); - const isReadableBody = ((globalThis as any).ReadableStream && options.body instanceof (globalThis as any).ReadableStream) || (typeof options.body === "object" && options.body !== null && Symbol.asyncIterator in options.body); + const isReadableBody = + ((globalThis as any).ReadableStream && options.body instanceof (globalThis as any).ReadableStream) || + (typeof options.body === 'object' && options.body !== null && Symbol.asyncIterator in options.body); const fetchOptions: RequestInit = { signal: controller.signal as any, @@ -519,7 +643,6 @@ export class Finch { } try { - // use undefined this binding; fetch errors if bound to something else in browser/cloudflare return await this.fetch.call(undefined, url, fetchOptions); } finally { @@ -620,11 +743,12 @@ export class Finch { const req: FinalizedRequestInit = { method, headers: reqHeaders, - ...(options.signal && { signal: options.signal}), - ...((globalThis as any).ReadableStream && body instanceof (globalThis as any).ReadableStream && { duplex: "half" }), + ...(options.signal && { signal: options.signal }), + ...((globalThis as any).ReadableStream && + body instanceof (globalThis as any).ReadableStream && { duplex: 'half' }), ...(body && { body }), - ...(this.fetchOptions as any ?? {}), - ...(options.fetchOptions as any ?? {}), + ...((this.fetchOptions as any) ?? {}), + ...((options.fetchOptions as any) ?? {}), }; return { req, url, timeout: options.timeout }; @@ -649,16 +773,18 @@ export class Finch { const headers = buildHeaders([ idempotencyHeaders, - {Accept: 'application/json', - 'User-Agent': this.getUserAgent(), - 'X-Stainless-Retry-Count': String(retryCount), - ...(options.timeout ? { 'X-Stainless-Timeout': String(Math.trunc(options.timeout / 1000)) } : {}), - ...getPlatformHeaders(), - 'Finch-API-Version': '2020-09-17'}, - await this.authHeaders(options, options.__security ?? { bearerAuth: true,basicAuth: true }), + { + Accept: 'application/json', + 'User-Agent': this.getUserAgent(), + 'X-Stainless-Retry-Count': String(retryCount), + ...(options.timeout ? { 'X-Stainless-Timeout': String(Math.trunc(options.timeout / 1000)) } : {}), + ...getPlatformHeaders(), + 'Finch-API-Version': '2020-09-17', + }, + await this.authHeaders(options, options.__security ?? { bearerAuth: true, basicAuth: true }), this._options.defaultHeaders, bodyHeaders, - options.headers + options.headers, ]); this.validateHeaders(headers); @@ -685,11 +811,9 @@ export class Finch { ArrayBuffer.isView(body) || body instanceof ArrayBuffer || body instanceof DataView || - ( - typeof body === 'string' && + (typeof body === 'string' && // Preserve legacy string encoding behavior for now - headers.values.has('content-type') - ) || + headers.values.has('content-type')) || // `Blob` is superset of `File` ((globalThis as any).Blob && body instanceof (globalThis as any).Blob) || // `FormData` -> `multipart/form-data` @@ -720,7 +844,7 @@ export class Finch { } static Finch = this; - static DEFAULT_TIMEOUT = 60000 // 1 minute + static DEFAULT_TIMEOUT = 60000; // 1 minute static FinchError = Errors.FinchError; static APIError = Errors.APIError; @@ -797,94 +921,74 @@ Finch.Payroll = Payroll; Finch.Connect = Connect; export declare namespace Finch { - export type RequestOptions = Opts.RequestOptions; - - export import SinglePage = Pagination.SinglePage; -export { - type SinglePageResponse as SinglePageResponse -}; - -export import ResponsesPage = Pagination.ResponsesPage; -export { - type ResponsesPageResponse as ResponsesPageResponse -}; - -export import IndividualsPage = Pagination.IndividualsPage; -export { - type IndividualsPageParams as IndividualsPageParams, - type IndividualsPageResponse as IndividualsPageResponse -}; - -export import Page = Pagination.Page; -export { - type PageParams as PageParams, - type PageResponse as PageResponse -}; - -export { - AccessTokens as AccessTokens, - type CreateAccessTokenResponse as CreateAccessTokenResponse, - type AccessTokenCreateParams as AccessTokenCreateParams -}; - -export { - HRIS as HRIS, - type Income as Income, - type Location as Location, - type Money as Money -}; - -export { - Providers as Providers, - type Provider as Provider, - type ProviderListResponse as ProviderListResponse, - type ProviderListResponsesSinglePage as ProviderListResponsesSinglePage -}; - -export { - Account as Account, - type DisconnectResponse as DisconnectResponse, - type Introspection as Introspection -}; - -export { - Webhooks as Webhooks, - type AccountUpdateEvent as AccountUpdateEvent, - type BaseWebhookEvent as BaseWebhookEvent, - type CompanyEvent as CompanyEvent, - type DirectoryEvent as DirectoryEvent, - type EmploymentEvent as EmploymentEvent, - type IndividualEvent as IndividualEvent, - type JobCompletionEvent as JobCompletionEvent, - type PayStatementEvent as PayStatementEvent, - type PaymentEvent as PaymentEvent, - type WebhookEvent as WebhookEvent -}; - -export { - RequestForwarding as RequestForwarding, - type RequestForwardingForwardResponse as RequestForwardingForwardResponse, - type RequestForwardingForwardParams as RequestForwardingForwardParams -}; - -export { - Jobs as Jobs -}; - -export { - Sandbox as Sandbox -}; - -export { - Payroll as Payroll -}; - -export { - Connect as Connect -}; - -export type ConnectionStatusType = API.ConnectionStatusType; -export type OperationSupport = API.OperationSupport; -export type OperationSupportMatrix = API.OperationSupportMatrix; -export type Paging = API.Paging; - } + export type RequestOptions = Opts.RequestOptions; + + export import SinglePage = Pagination.SinglePage; + export { type SinglePageResponse as SinglePageResponse }; + + export import ResponsesPage = Pagination.ResponsesPage; + export { type ResponsesPageResponse as ResponsesPageResponse }; + + export import IndividualsPage = Pagination.IndividualsPage; + export { + type IndividualsPageParams as IndividualsPageParams, + type IndividualsPageResponse as IndividualsPageResponse, + }; + + export import Page = Pagination.Page; + export { type PageParams as PageParams, type PageResponse as PageResponse }; + + export { + AccessTokens as AccessTokens, + type CreateAccessTokenResponse as CreateAccessTokenResponse, + type AccessTokenCreateParams as AccessTokenCreateParams, + }; + + export { HRIS as HRIS, type Income as Income, type Location as Location, type Money as Money }; + + export { + Providers as Providers, + type Provider as Provider, + type ProviderListResponse as ProviderListResponse, + type ProviderListResponsesSinglePage as ProviderListResponsesSinglePage, + }; + + export { + Account as Account, + type DisconnectResponse as DisconnectResponse, + type Introspection as Introspection, + }; + + export { + Webhooks as Webhooks, + type AccountUpdateEvent as AccountUpdateEvent, + type BaseWebhookEvent as BaseWebhookEvent, + type CompanyEvent as CompanyEvent, + type DirectoryEvent as DirectoryEvent, + type EmploymentEvent as EmploymentEvent, + type IndividualEvent as IndividualEvent, + type JobCompletionEvent as JobCompletionEvent, + type PayStatementEvent as PayStatementEvent, + type PaymentEvent as PaymentEvent, + type WebhookEvent as WebhookEvent, + }; + + export { + RequestForwarding as RequestForwarding, + type RequestForwardingForwardResponse as RequestForwardingForwardResponse, + type RequestForwardingForwardParams as RequestForwardingForwardParams, + }; + + export { Jobs as Jobs }; + + export { Sandbox as Sandbox }; + + export { Payroll as Payroll }; + + export { Connect as Connect }; + + export type ConnectionStatusType = API.ConnectionStatusType; + export type OperationSupport = API.OperationSupport; + export type OperationSupportMatrix = API.OperationSupportMatrix; + export type Paging = API.Paging; +} diff --git a/src/core/api-promise.ts b/src/core/api-promise.ts index ff15d7c3..a3d3ebef 100644 --- a/src/core/api-promise.ts +++ b/src/core/api-promise.ts @@ -16,7 +16,10 @@ export class APIPromise extends Promise { constructor( client: Finch, private responsePromise: Promise, - private parseResponse: (client: Finch, props: APIResponseProps) => PromiseOrValue = defaultParseResponse, + private parseResponse: ( + client: Finch, + props: APIResponseProps, + ) => PromiseOrValue = defaultParseResponse, ) { super((resolve) => { // this is maybe a bit weird but this has to be a no-op to not implicitly @@ -28,7 +31,9 @@ export class APIPromise extends Promise { } _thenUnwrap(transform: (data: T, props: APIResponseProps) => U): APIPromise { - return new APIPromise(this.#client, this.responsePromise, async (client, props) => transform(await this.parseResponse(client, props), props)); + return new APIPromise(this.#client, this.responsePromise, async (client, props) => + transform(await this.parseResponse(client, props), props), + ); } /** diff --git a/src/core/error.ts b/src/core/error.ts index 28ea490f..e969b5f4 100644 --- a/src/core/error.ts +++ b/src/core/error.ts @@ -2,10 +2,13 @@ import { castToError } from '../internal/errors'; -export class FinchError extends Error { -} +export class FinchError extends Error {} -export class APIError extends FinchError { +export class APIError< + TStatus extends number | undefined = number | undefined, + THeaders extends Headers | undefined = Headers | undefined, + TError extends Object | undefined = Object | undefined, +> extends FinchError { /** HTTP status for the response that caused the error */ readonly status: TStatus; /** HTTP headers for the response that caused the error */ @@ -13,9 +16,6 @@ export class APIError { -} +export class BadRequestError extends APIError<400, Headers> {} -export class AuthenticationError extends APIError<401, Headers> { -} +export class AuthenticationError extends APIError<401, Headers> {} -export class PermissionDeniedError extends APIError<403, Headers> { -} +export class PermissionDeniedError extends APIError<403, Headers> {} -export class NotFoundError extends APIError<404, Headers> { -} +export class NotFoundError extends APIError<404, Headers> {} -export class ConflictError extends APIError<409, Headers> { -} +export class ConflictError extends APIError<409, Headers> {} -export class UnprocessableEntityError extends APIError<422, Headers> { -} +export class UnprocessableEntityError extends APIError<422, Headers> {} -export class RateLimitError extends APIError<429, Headers> { -} +export class RateLimitError extends APIError<429, Headers> {} -export class InternalServerError extends APIError { -} +export class InternalServerError extends APIError {} diff --git a/src/core/pagination.ts b/src/core/pagination.ts index 15d024fb..475ff532 100644 --- a/src/core/pagination.ts +++ b/src/core/pagination.ts @@ -89,7 +89,8 @@ export class PagePromise< super( client, request, - async (client, props) => new Page(client, props.response, await defaultParseResponse(client, props), props.options) + async (client, props) => + new Page(client, props.response, await defaultParseResponse(client, props), props.options), ); } @@ -113,7 +114,12 @@ export type SinglePageResponse = Item[]; export class SinglePage extends AbstractPage { items: Array; - constructor(client: Finch, response: Response, body: SinglePageResponse, options: FinalRequestOptions) { + constructor( + client: Finch, + response: Response, + body: SinglePageResponse, + options: FinalRequestOptions, + ) { super(client, response, body, options); this.items = body || []; @@ -135,7 +141,12 @@ export interface ResponsesPageResponse { export class ResponsesPage extends AbstractPage implements ResponsesPageResponse { responses: Array; - constructor(client: Finch, response: Response, body: ResponsesPageResponse, options: FinalRequestOptions) { + constructor( + client: Finch, + response: Response, + body: ResponsesPageResponse, + options: FinalRequestOptions, + ) { super(client, response, body, options); this.responses = body.responses || []; @@ -171,7 +182,10 @@ export interface IndividualsPageParams { offset?: number; } -export class IndividualsPage extends AbstractPage implements IndividualsPageResponse { +export class IndividualsPage + extends AbstractPage + implements IndividualsPageResponse +{ /** * The array of employees. */ @@ -179,7 +193,12 @@ export class IndividualsPage extends AbstractPage extends AbstractPage implements PageResponse if (currentCount < totalCount) { return { - ...this.options, - query: { - ...maybeObj(this.options.query), - offset: currentCount, - }, - }; + ...this.options, + query: { + ...maybeObj(this.options.query), + offset: currentCount, + }, + }; } - return null + return null; } } diff --git a/src/error.ts b/src/error.ts index d0832d34..fc55f46c 100644 --- a/src/error.ts +++ b/src/error.ts @@ -1,2 +1,2 @@ /** @deprecated Import from ./core/error instead */ -export * from "./core/error" \ No newline at end of file +export * from './core/error'; diff --git a/src/index.ts b/src/index.ts index 3cdfba13..ad0e5450 100644 --- a/src/index.ts +++ b/src/index.ts @@ -6,4 +6,18 @@ export { type Uploadable, toFile } from './core/uploads'; export { APIPromise } from './core/api-promise'; export { Finch, type ClientOptions } from './client'; export { PagePromise } from './core/pagination'; -export { FinchError, APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError, NotFoundError, ConflictError, RateLimitError, BadRequestError, AuthenticationError, InternalServerError, PermissionDeniedError, UnprocessableEntityError } from './core/error'; +export { + FinchError, + APIError, + APIConnectionError, + APIConnectionTimeoutError, + APIUserAbortError, + NotFoundError, + ConflictError, + RateLimitError, + BadRequestError, + AuthenticationError, + InternalServerError, + PermissionDeniedError, + UnprocessableEntityError, +} from './core/error'; diff --git a/src/internal/builtin-types.ts b/src/internal/builtin-types.ts index 6059d5db..c23d3bde 100644 --- a/src/internal/builtin-types.ts +++ b/src/internal/builtin-types.ts @@ -1,23 +1,20 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -export type Fetch = ( - input: string | URL | Request, - init?: RequestInit, -) => Promise +export type Fetch = (input: string | URL | Request, init?: RequestInit) => Promise; /** * An alias to the builtin `RequestInit` type so we can * easily alias it in import statements if there are name clashes. - * - * https://developer.mozilla.org/docs/Web/API/RequestInit + * + * https://developer.mozilla.org/docs/Web/API/RequestInit */ type _RequestInit = RequestInit; /** * An alias to the builtin `Response` type so we can * easily alias it in import statements if there are name clashes. - * - * https://developer.mozilla.org/docs/Web/API/Response + * + * https://developer.mozilla.org/docs/Web/API/Response */ type _Response = Response; @@ -54,7 +51,15 @@ type _Array = Array; */ type _Record = Record; -export type { _Array as Array, _BodyInit as BodyInit, _HeadersInit as HeadersInit, _Record as Record, _RequestInfo as RequestInfo, _RequestInit as RequestInit, _Response as Response }; +export type { + _Array as Array, + _BodyInit as BodyInit, + _HeadersInit as HeadersInit, + _Record as Record, + _RequestInfo as RequestInfo, + _RequestInit as RequestInit, + _Response as Response, +}; /** * A copy of the builtin `EndingType` type as it isn't fully supported in certain diff --git a/src/internal/detect-platform.ts b/src/internal/detect-platform.ts index 394ede88..e82d95c9 100644 --- a/src/internal/detect-platform.ts +++ b/src/internal/detect-platform.ts @@ -25,7 +25,11 @@ function getDetectedPlatform(): DetectedPlatform { if (typeof EdgeRuntime !== 'undefined') { return 'edge'; } - if (Object.prototype.toString.call(typeof (globalThis as any).process !== 'undefined' ? (globalThis as any).process : 0) === '[object process]') { + if ( + Object.prototype.toString.call( + typeof (globalThis as any).process !== 'undefined' ? (globalThis as any).process : 0, + ) === '[object process]' + ) { return 'node'; } return 'unknown'; diff --git a/src/internal/errors.ts b/src/internal/errors.ts index c14a742b..82c7b14d 100644 --- a/src/internal/errors.ts +++ b/src/internal/errors.ts @@ -2,12 +2,12 @@ export function isAbortError(err: unknown) { return ( - typeof err === 'object' && err !== null && ( - // Spec-compliant fetch implementations - ('name' in err && (err as any).name === 'AbortError') || + typeof err === 'object' && + err !== null && + // Spec-compliant fetch implementations + (('name' in err && (err as any).name === 'AbortError') || // Expo fetch - ('message' in err && String((err as any).message).includes('FetchRequestCanceledException')) - ) + ('message' in err && String((err as any).message).includes('FetchRequestCanceledException'))) ); } @@ -24,10 +24,10 @@ export const castToError = (err: any): Error => { if (err.name) error.name = err.name; return error; } - } catch { } + } catch {} try { return new Error(JSON.stringify(err)); - } catch { } + } catch {} } return new Error(err); }; diff --git a/src/internal/headers.ts b/src/internal/headers.ts index 54428d74..6d9e48dc 100644 --- a/src/internal/headers.ts +++ b/src/internal/headers.ts @@ -1,6 +1,6 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -import { isReadonlyArray } from "./utils/values"; +import { isReadonlyArray } from './utils/values'; type HeaderValue = string | undefined | null; export type HeadersLike = @@ -51,7 +51,7 @@ function* iterateHeaders(headers: HeadersLike): IterableIterator(client: Finch, props: APIResponseProps): Promise { const { response, requestLogID, retryOfRequestLogID, startTime } = props; const body = await (async () => { - // fetch refuses to read the body when the status code is 204. if (response.status === 204) { return null as T; @@ -43,6 +42,15 @@ export async function defaultParseResponse(client: Finch, props: APIResponseP const text = await response.text(); return text as unknown as T; })(); - loggerFor(client).debug(`[${requestLogID}] response parsed`, formatRequestDetails({ retryOfRequestLogID, url: response.url, status: response.status, body, durationMs: Date.now() - startTime })); + loggerFor(client).debug( + `[${requestLogID}] response parsed`, + formatRequestDetails({ + retryOfRequestLogID, + url: response.url, + status: response.status, + body, + durationMs: Date.now() - startTime, + }), + ); return body; } diff --git a/src/internal/qs/utils.ts b/src/internal/qs/utils.ts index f21d955b..4cd56579 100644 --- a/src/internal/qs/utils.ts +++ b/src/internal/qs/utils.ts @@ -62,10 +62,7 @@ export function merge( if (isArray(target)) { target.push(source); } else if (target && typeof target === 'object') { - if ( - (options && (options.plainObjects || options.allowPrototypes)) || - !has(Object.prototype, source) - ) { + if ((options && (options.plainObjects || options.allowPrototypes)) || !has(Object.prototype, source)) { target[source] = true; } } else { diff --git a/src/internal/request-options.ts b/src/internal/request-options.ts index 77d8d750..21e8c1ba 100644 --- a/src/internal/request-options.ts +++ b/src/internal/request-options.ts @@ -75,17 +75,13 @@ export type RequestOptions = { */ defaultBaseURL?: string | undefined; - __security?: { bearerAuth?: boolean, basicAuth?: boolean }; + __security?: { bearerAuth?: boolean; basicAuth?: boolean }; __binaryResponse?: boolean | undefined; - }; export type EncodedContent = { bodyHeaders: HeadersLike; body: BodyInit }; -export type RequestEncoder = (request: { - headers: NullableHeaders; - body: unknown; -}) => EncodedContent; +export type RequestEncoder = (request: { headers: NullableHeaders; body: unknown }) => EncodedContent; export const FallbackEncoder: RequestEncoder = ({ headers, body }) => { return { diff --git a/src/internal/shim-types.ts b/src/internal/shim-types.ts index accbf576..8ddf7b0a 100644 --- a/src/internal/shim-types.ts +++ b/src/internal/shim-types.ts @@ -19,8 +19,8 @@ type _ConditionalNodeReadableStream = typeof globalThis extends { ReadableStream: any } ? never : _NodeReadableStream; type _ReadableStream = NeverToAny< - ([0] extends [1 & _DOMReadableStream] ? never : _DOMReadableStream) | - ([0] extends [1 & _ConditionalNodeReadableStream] ? never : _ConditionalNodeReadableStream) + | ([0] extends [1 & _DOMReadableStream] ? never : _DOMReadableStream) + | ([0] extends [1 & _ConditionalNodeReadableStream] ? never : _ConditionalNodeReadableStream) >; export type { _ReadableStream as ReadableStream }; diff --git a/src/internal/shims.ts b/src/internal/shims.ts index 91ab751a..5c6104af 100644 --- a/src/internal/shims.ts +++ b/src/internal/shims.ts @@ -27,7 +27,9 @@ export function makeReadableStream(...args: ReadableStreamArgs): ReadableStream if (typeof ReadableStream === 'undefined') { // Note: All of the platforms / runtimes we officially support already define // `ReadableStream` as a global, so this should only ever be hit on unsupported runtimes. - throw new Error('`ReadableStream` is not defined as a global; You will need to polyfill it, `globalThis.ReadableStream = ReadableStream`'); + throw new Error( + '`ReadableStream` is not defined as a global; You will need to polyfill it, `globalThis.ReadableStream = ReadableStream`', + ); } return new ReadableStream(...args); diff --git a/src/internal/to-file.ts b/src/internal/to-file.ts index c72a2b41..30eada32 100644 --- a/src/internal/to-file.ts +++ b/src/internal/to-file.ts @@ -1,4 +1,4 @@ -import { BlobPart, getName, makeFile, isAsyncIterable } from "./uploads"; +import { BlobPart, getName, makeFile, isAsyncIterable } from './uploads'; import type { FilePropertyBag } from './builtin-types'; import { checkFileSupport } from './uploads'; @@ -65,8 +65,11 @@ const isResponseLike = (value: any): value is ResponseLike => typeof value.url === 'string' && typeof value.blob === 'function'; -export type ToFileInput = FileLike | ResponseLike | Exclude | AsyncIterable; - +export type ToFileInput = + | FileLike + | ResponseLike + | Exclude + | AsyncIterable; /** * Helper for creating a {@link File} to pass to an SDK upload method from a variety of different data formats @@ -116,9 +119,7 @@ export async function toFile( return makeFile(parts, name, options); } -async function getBytes( - value: BlobLikePart | AsyncIterable, -): Promise> { +async function getBytes(value: BlobLikePart | AsyncIterable): Promise> { let parts: Array = []; if ( typeof value === 'string' || @@ -151,4 +152,3 @@ function propsForError(value: unknown): string { const props = Object.getOwnPropertyNames(value); return `; props: [${props.map((p) => `"${p}"`).join(', ')}]`; } - diff --git a/src/internal/types.ts b/src/internal/types.ts index c45fee32..b668dfc0 100644 --- a/src/internal/types.ts +++ b/src/internal/types.ts @@ -7,34 +7,40 @@ export type KeysEnum = { [P in keyof Required]: true }; export type FinalizedRequestInit = RequestInit & { headers: Headers }; -type NotAny = [0] extends [(1 & T)] ? never : T; +type NotAny = [0] extends [1 & T] ? never : T; /** * Some environments overload the global fetch function, and Parameters only gets the last signature. */ -type OverloadedParameters = T extends { - (...args: infer A): unknown; - (...args: infer B): unknown; - (...args: infer C): unknown; - (...args: infer D): unknown; -} - ? A | B | C | D - : T extends { +type OverloadedParameters = + T extends ( + { (...args: infer A): unknown; (...args: infer B): unknown; (...args: infer C): unknown; + (...args: infer D): unknown; } - ? A | B | C - : T extends { + ) ? + A | B | C | D + : T extends ( + { + (...args: infer A): unknown; + (...args: infer B): unknown; + (...args: infer C): unknown; + } + ) ? + A | B | C + : T extends ( + { (...args: infer A): unknown; (...args: infer B): unknown; } - ? A | B - : T extends (...args: infer A) => unknown - ? A + ) ? + A | B + : T extends (...args: infer A) => unknown ? A : never; - +/* eslint-disable */ /** * These imports attempt to get types from a parent package's dependencies. * Unresolved bare specifiers can trigger [automatic type acquisition][1] in some projects, which @@ -57,19 +63,19 @@ type OverloadedParameters = T extends { * * [1]: https://www.typescriptlang.org/tsconfig/#typeAcquisition */ -/** @ts-ignore For users with \@types/node */ /* prettier-ignore */ +/** @ts-ignore For users with \@types/node */ type UndiciTypesRequestInit = NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny; -/** @ts-ignore For users with undici */ /* prettier-ignore */ +/** @ts-ignore For users with undici */ type UndiciRequestInit = NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny; -/** @ts-ignore For users with \@types/bun */ /* prettier-ignore */ +/** @ts-ignore For users with \@types/bun */ type BunRequestInit = globalThis.FetchRequestInit; -/** @ts-ignore For users with node-fetch@2 */ /* prettier-ignore */ +/** @ts-ignore For users with node-fetch@2 */ type NodeFetch2RequestInit = NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny; -/** @ts-ignore For users with node-fetch@3, doesn't need file extension because types are at ./@types/index.d.ts */ /* prettier-ignore */ +/** @ts-ignore For users with node-fetch@3, doesn't need file extension because types are at ./@types/index.d.ts */ type NodeFetch3RequestInit = NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny; -/** @ts-ignore For users who use Deno */ /* prettier-ignore */ +/** @ts-ignore For users who use Deno */ type FetchRequestInit = NonNullable[1]>; - +/* eslint-enable */ type RequestInits = | NotAny diff --git a/src/internal/utils/log.ts b/src/internal/utils/log.ts index 34e101ac..55eb21e3 100644 --- a/src/internal/utils/log.ts +++ b/src/internal/utils/log.ts @@ -4,7 +4,7 @@ import { hasOwn } from './values'; import { type Finch } from '../../client'; import { RequestOptions } from '../request-options'; -type LogFn = (message: string, ...rest: unknown[]) => void +type LogFn = (message: string, ...rest: unknown[]) => void; export type Logger = { error: LogFn; warn: LogFn; @@ -21,14 +21,22 @@ const levelNumbers = { debug: 500, }; -export const parseLogLevel = (maybeLevel: string | undefined, sourceName: string, client: Finch): LogLevel | undefined => { +export const parseLogLevel = ( + maybeLevel: string | undefined, + sourceName: string, + client: Finch, +): LogLevel | undefined => { if (!maybeLevel) { return undefined; } if (hasOwn(levelNumbers, maybeLevel)) { return maybeLevel; - }; - loggerFor(client).warn(`${sourceName} was set to ${JSON.stringify(maybeLevel)}, expected one of ${JSON.stringify(Object.keys(levelNumbers))}`); + } + loggerFor(client).warn( + `${sourceName} was set to ${JSON.stringify(maybeLevel)}, expected one of ${JSON.stringify( + Object.keys(levelNumbers), + )}`, + ); return undefined; }; @@ -89,11 +97,24 @@ export const formatRequestDetails = (details: { body?: unknown; }) => { if (details.options) { - details.options = {...details.options}; + details.options = { ...details.options }; delete details.options['headers']; // redundant + leaks internals } if (details.headers) { - details.headers = Object.fromEntries((details.headers instanceof Headers ? [...details.headers] : Object.entries(details.headers)).map(([name, value]) => [name, name.toLowerCase() === 'authorization' || name.toLowerCase() === 'cookie' || name.toLowerCase() === 'set-cookie' ? '***' : value])) + details.headers = Object.fromEntries( + (details.headers instanceof Headers ? [...details.headers] : Object.entries(details.headers)).map( + ([name, value]) => [ + name, + ( + name.toLowerCase() === 'authorization' || + name.toLowerCase() === 'cookie' || + name.toLowerCase() === 'set-cookie' + ) ? + '***' + : value, + ], + ), + ); } if ('retryOfRequestLogID' in details) { if (details.retryOfRequestLogID) { @@ -101,5 +122,5 @@ export const formatRequestDetails = (details: { } delete details.retryOfRequestLogID; } - return details -} + return details; +}; diff --git a/src/internal/utils/query.ts b/src/internal/utils/query.ts index 0f61c00b..f7d1b4b2 100644 --- a/src/internal/utils/query.ts +++ b/src/internal/utils/query.ts @@ -3,5 +3,5 @@ import * as qs from '../qs/stringify'; export function stringifyQuery(query: object | Record) { - return qs.stringify(query, { arrayFormat: 'brackets' }) + return qs.stringify(query, { arrayFormat: 'brackets' }); } diff --git a/src/internal/utils/uuid.ts b/src/internal/utils/uuid.ts index 53708ba6..b0e53aaf 100644 --- a/src/internal/utils/uuid.ts +++ b/src/internal/utils/uuid.ts @@ -10,10 +10,8 @@ export let uuid4 = function () { return crypto.randomUUID(); } const u8 = new Uint8Array(1); - const randomByte = crypto - ? () => crypto.getRandomValues(u8)[0]! - : () => (Math.random() * 0xff) & 0xff; - return "10000000-1000-4000-8000-100000000000".replace(/[018]/g, (c) => + const randomByte = crypto ? () => crypto.getRandomValues(u8)[0]! : () => (Math.random() * 0xff) & 0xff; + return '10000000-1000-4000-8000-100000000000'.replace(/[018]/g, (c) => (+c ^ (randomByte() & (15 >> (+c / 4)))).toString(16), ); -} +}; diff --git a/src/pagination.ts b/src/pagination.ts index e1e5d091..90bf015e 100644 --- a/src/pagination.ts +++ b/src/pagination.ts @@ -1,2 +1,2 @@ /** @deprecated Import from ./core/pagination instead */ -export * from "./core/pagination" \ No newline at end of file +export * from './core/pagination'; diff --git a/src/resource.ts b/src/resource.ts index 57a27a94..363e3516 100644 --- a/src/resource.ts +++ b/src/resource.ts @@ -1,2 +1,2 @@ /** @deprecated Import from ./core/resource instead */ -export * from "./core/resource" \ No newline at end of file +export * from './core/resource'; diff --git a/src/resources/access-tokens.ts b/src/resources/access-tokens.ts index 787873bd..0f9624ba 100644 --- a/src/resources/access-tokens.ts +++ b/src/resources/access-tokens.ts @@ -32,7 +32,7 @@ export class AccessTokens extends APIResource { body: bodyWithReplacements, ...options, headers: headersWithReplacements, - __security: { }, + __security: {}, }); } } @@ -131,6 +131,6 @@ export interface AccessTokenCreateParams { export declare namespace AccessTokens { export { type CreateAccessTokenResponse as CreateAccessTokenResponse, - type AccessTokenCreateParams as AccessTokenCreateParams + type AccessTokenCreateParams as AccessTokenCreateParams, }; } diff --git a/src/resources/account.ts b/src/resources/account.ts index 723b8b11..d8a6a0dc 100644 --- a/src/resources/account.ts +++ b/src/resources/account.ts @@ -10,14 +10,14 @@ export class Account extends APIResource { * Disconnect one or more `access_token`s from your application. */ disconnect(options?: RequestOptions): APIPromise { - return this._client.post('/disconnect', { ...options, __security: { bearerAuth : true } }); + return this._client.post('/disconnect', { ...options, __security: { bearerAuth: true } }); } /** * Read account information associated with an `access_token` */ introspect(options?: RequestOptions): APIPromise { - return this._client.get('/introspect', { ...options, __security: { bearerAuth : true } }); + return this._client.get('/introspect', { ...options, __security: { bearerAuth: true } }); } } @@ -184,13 +184,17 @@ export namespace Introspection { /** * The status of the entity connection */ - status: 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth' | 'disconnected'; + status: + | 'pending' + | 'processing' + | 'connected' + | 'error_no_account_setup' + | 'error_permissions' + | 'reauth' + | 'disconnected'; } } export declare namespace Account { - export { - type DisconnectResponse as DisconnectResponse, - type Introspection as Introspection - }; + export { type DisconnectResponse as DisconnectResponse, type Introspection as Introspection }; } diff --git a/src/resources/connect/connect.ts b/src/resources/connect/connect.ts index b45f2b73..876dad04 100644 --- a/src/resources/connect/connect.ts +++ b/src/resources/connect/connect.ts @@ -2,7 +2,13 @@ import { APIResource } from '../../core/resource'; import * as SessionsAPI from './sessions'; -import { SessionNewParams, SessionNewResponse, SessionReauthenticateParams, SessionReauthenticateResponse, Sessions } from './sessions'; +import { + SessionNewParams, + SessionNewResponse, + SessionReauthenticateParams, + SessionReauthenticateResponse, + Sessions, +} from './sessions'; export class Connect extends APIResource { sessions: SessionsAPI.Sessions = new SessionsAPI.Sessions(this._client); @@ -16,6 +22,6 @@ export declare namespace Connect { type SessionNewResponse as SessionNewResponse, type SessionReauthenticateResponse as SessionReauthenticateResponse, type SessionNewParams as SessionNewParams, - type SessionReauthenticateParams as SessionReauthenticateParams + type SessionReauthenticateParams as SessionReauthenticateParams, }; } diff --git a/src/resources/connect/index.ts b/src/resources/connect/index.ts index c4611a3b..6e29c158 100644 --- a/src/resources/connect/index.ts +++ b/src/resources/connect/index.ts @@ -1,4 +1,10 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -export { Connect } from './connect';; -export { Sessions, type SessionNewResponse, type SessionReauthenticateResponse, type SessionNewParams, type SessionReauthenticateParams } from './sessions';; +export { Connect } from './connect'; +export { + Sessions, + type SessionNewResponse, + type SessionReauthenticateResponse, + type SessionNewParams, + type SessionReauthenticateParams, +} from './sessions'; diff --git a/src/resources/connect/sessions.ts b/src/resources/connect/sessions.ts index 5a1a5550..0132d9de 100644 --- a/src/resources/connect/sessions.ts +++ b/src/resources/connect/sessions.ts @@ -9,14 +9,21 @@ export class Sessions extends APIResource { * Create a new connect session for an employer */ new(body: SessionNewParams, options?: RequestOptions): APIPromise { - return this._client.post('/connect/sessions', { body, ...options, __security: { basicAuth : true } }); + return this._client.post('/connect/sessions', { body, ...options, __security: { basicAuth: true } }); } /** * Create a new Connect session for reauthenticating an existing connection */ - reauthenticate(body: SessionReauthenticateParams, options?: RequestOptions): APIPromise { - return this._client.post('/connect/sessions/reauthenticate', { body, ...options, __security: { basicAuth : true } }); + reauthenticate( + body: SessionReauthenticateParams, + options?: RequestOptions, + ): APIPromise { + return this._client.post('/connect/sessions/reauthenticate', { + body, + ...options, + __security: { basicAuth: true }, + }); } } @@ -60,7 +67,18 @@ export interface SessionNewParams { * endpoints — `deduction` is a deprecated alias that is still accepted but should * not be combined with `benefits`. */ - products: Array<'benefits' | 'company' | 'deduction' | 'directory' | 'documents' | 'employment' | 'individual' | 'payment' | 'pay_statement' | 'ssn'>; + products: Array< + | 'benefits' + | 'company' + | 'deduction' + | 'directory' + | 'documents' + | 'employment' + | 'individual' + | 'payment' + | 'pay_statement' + | 'ssn' + >; /** * Email address of the customer @@ -128,7 +146,18 @@ export interface SessionReauthenticateParams { * `benefits` to access deductions endpoints — `deduction` is a deprecated alias * that is still accepted but should not be combined with `benefits`. */ - products?: Array<'benefits' | 'company' | 'deduction' | 'directory' | 'documents' | 'employment' | 'individual' | 'payment' | 'pay_statement' | 'ssn'> | null; + products?: Array< + | 'benefits' + | 'company' + | 'deduction' + | 'directory' + | 'documents' + | 'employment' + | 'individual' + | 'payment' + | 'pay_statement' + | 'ssn' + > | null; /** * The URI to redirect to after the Connect flow is completed @@ -141,6 +170,6 @@ export declare namespace Sessions { type SessionNewResponse as SessionNewResponse, type SessionReauthenticateResponse as SessionReauthenticateResponse, type SessionNewParams as SessionNewParams, - type SessionReauthenticateParams as SessionReauthenticateParams + type SessionReauthenticateParams as SessionReauthenticateParams, }; } diff --git a/src/resources/hris/benefits/benefits.ts b/src/resources/hris/benefits/benefits.ts index ed90d389..38af20cc 100644 --- a/src/resources/hris/benefits/benefits.ts +++ b/src/resources/hris/benefits/benefits.ts @@ -3,7 +3,18 @@ import { APIResource } from '../../../core/resource'; import * as Shared from '../../shared'; import * as IndividualsAPI from './individuals'; -import { EnrolledIndividualBenefitResponse, IndividualBenefit, IndividualBenefitsSinglePage, IndividualEnrollManyParams, IndividualEnrolledIDsParams, IndividualEnrolledIDsResponse, IndividualRetrieveManyBenefitsParams, IndividualUnenrollManyParams, Individuals, UnenrolledIndividualBenefitResponse } from './individuals'; +import { + EnrolledIndividualBenefitResponse, + IndividualBenefit, + IndividualBenefitsSinglePage, + IndividualEnrollManyParams, + IndividualEnrolledIDsParams, + IndividualEnrolledIDsResponse, + IndividualRetrieveManyBenefitsParams, + IndividualUnenrollManyParams, + Individuals, + UnenrolledIndividualBenefitResponse, +} from './individuals'; import { APIPromise } from '../../../core/api-promise'; import { PagePromise, SinglePage } from '../../../core/pagination'; import { RequestOptions } from '../../../internal/request-options'; @@ -22,9 +33,17 @@ export class Benefits extends APIResource { * await client.hris.benefits.create(); * ``` */ - create(params: BenefitCreateParams | null | undefined = {}, options?: RequestOptions): APIPromise { - const { entity_ids, ...body } = params ?? {} - return this._client.post('/employer/benefits', { query: { entity_ids }, body, ...options, __security: { bearerAuth : true } }); + create( + params: BenefitCreateParams | null | undefined = {}, + options?: RequestOptions, + ): APIPromise { + const { entity_ids, ...body } = params ?? {}; + return this._client.post('/employer/benefits', { + query: { entity_ids }, + body, + ...options, + __security: { bearerAuth: true }, + }); } /** @@ -37,8 +56,16 @@ export class Benefits extends APIResource { * ); * ``` */ - retrieve(benefitID: string, query: BenefitRetrieveParams | null | undefined = {}, options?: RequestOptions): APIPromise { - return this._client.get(path`/employer/benefits/${benefitID}`, { query, ...options, __security: { bearerAuth : true } }); + retrieve( + benefitID: string, + query: BenefitRetrieveParams | null | undefined = {}, + options?: RequestOptions, + ): APIPromise { + return this._client.get(path`/employer/benefits/${benefitID}`, { + query, + ...options, + __security: { bearerAuth: true }, + }); } /** @@ -50,9 +77,18 @@ export class Benefits extends APIResource { * await client.hris.benefits.update('benefit_id'); * ``` */ - update(benefitID: string, params: BenefitUpdateParams | null | undefined = {}, options?: RequestOptions): APIPromise { - const { entity_ids, ...body } = params ?? {} - return this._client.post(path`/employer/benefits/${benefitID}`, { query: { entity_ids }, body, ...options, __security: { bearerAuth : true } }); + update( + benefitID: string, + params: BenefitUpdateParams | null | undefined = {}, + options?: RequestOptions, + ): APIPromise { + const { entity_ids, ...body } = params ?? {}; + return this._client.post(path`/employer/benefits/${benefitID}`, { + query: { entity_ids }, + body, + ...options, + __security: { bearerAuth: true }, + }); } /** @@ -66,8 +102,15 @@ export class Benefits extends APIResource { * } * ``` */ - list(query: BenefitListParams | null | undefined = {}, options?: RequestOptions): PagePromise { - return this._client.getAPIList('/employer/benefits', SinglePage, { query, ...options, __security: { bearerAuth : true } }); + list( + query: BenefitListParams | null | undefined = {}, + options?: RequestOptions, + ): PagePromise { + return this._client.getAPIList('/employer/benefits', SinglePage, { + query, + ...options, + __security: { bearerAuth: true }, + }); } /** @@ -81,16 +124,26 @@ export class Benefits extends APIResource { * } * ``` */ - listSupportedBenefits(query: BenefitListSupportedBenefitsParams | null | undefined = {}, options?: RequestOptions): PagePromise { - return this._client.getAPIList('/employer/benefits/meta', SinglePage, { query, ...options, __security: { bearerAuth : true } }); + listSupportedBenefits( + query: BenefitListSupportedBenefitsParams | null | undefined = {}, + options?: RequestOptions, + ): PagePromise { + return this._client.getAPIList('/employer/benefits/meta', SinglePage, { + query, + ...options, + __security: { bearerAuth: true }, + }); } } -export type CompanyBenefitsSinglePage = SinglePage +export type CompanyBenefitsSinglePage = SinglePage; -export type SupportedBenefitsSinglePage = SinglePage +export type SupportedBenefitsSinglePage = SinglePage; -export type BenefitContribution = BenefitContribution.UnionMember0 | BenefitContribution.UnionMember1 | BenefitContribution.UnionMember2 +export type BenefitContribution = + | BenefitContribution.UnionMember0 + | BenefitContribution.UnionMember1 + | BenefitContribution.UnionMember2; export namespace BenefitContribution { export interface UnionMember0 { @@ -148,12 +201,32 @@ export interface BenefitFeaturesAndOperations { /** * The frequency of the benefit deduction/contribution. */ -export type BenefitFrequency = 'every_paycheck' | 'monthly' | 'one_time' | null +export type BenefitFrequency = 'every_paycheck' | 'monthly' | 'one_time' | null; /** * Type of benefit. */ -export type BenefitType = '457' | '401k' | '401k_roth' | '401k_loan' | '403b' | '403b_roth' | '457_roth' | 'commuter' | 'custom_post_tax' | 'custom_pre_tax' | 'fsa_dependent_care' | 'fsa_medical' | 'hsa_post' | 'hsa_pre' | 's125_dental' | 's125_medical' | 's125_vision' | 'simple' | 'simple_ira' | null +export type BenefitType = + | '457' + | '401k' + | '401k_roth' + | '401k_loan' + | '403b' + | '403b_roth' + | '457_roth' + | 'commuter' + | 'custom_post_tax' + | 'custom_pre_tax' + | 'fsa_dependent_care' + | 'fsa_medical' + | 'hsa_post' + | 'hsa_pre' + | 's125_dental' + | 's125_medical' + | 's125_vision' + | 'simple' + | 'simple_ira' + | null; /** * Each benefit type and their supported features. If the benefit type is not @@ -184,7 +257,7 @@ export interface BenefitsSupport { simple_ira?: BenefitFeaturesAndOperations | null; -[k: string]: BenefitFeaturesAndOperations | null | undefined + [k: string]: BenefitFeaturesAndOperations | null | undefined; } export interface CompanyBenefit { @@ -295,7 +368,7 @@ export interface UpdateCompanyBenefitResponse { /** * @deprecated use `BenefitContribution` instead */ -export type BenfitContribution = BenefitContribution | null +export type BenfitContribution = BenefitContribution | null; export interface BenefitCreateParams { /** @@ -399,7 +472,7 @@ export declare namespace Benefits { type BenefitRetrieveParams as BenefitRetrieveParams, type BenefitUpdateParams as BenefitUpdateParams, type BenefitListParams as BenefitListParams, - type BenefitListSupportedBenefitsParams as BenefitListSupportedBenefitsParams + type BenefitListSupportedBenefitsParams as BenefitListSupportedBenefitsParams, }; export { @@ -412,6 +485,6 @@ export declare namespace Benefits { type IndividualEnrollManyParams as IndividualEnrollManyParams, type IndividualEnrolledIDsParams as IndividualEnrolledIDsParams, type IndividualRetrieveManyBenefitsParams as IndividualRetrieveManyBenefitsParams, - type IndividualUnenrollManyParams as IndividualUnenrollManyParams + type IndividualUnenrollManyParams as IndividualUnenrollManyParams, }; } diff --git a/src/resources/hris/benefits/index.ts b/src/resources/hris/benefits/index.ts index 057dbab3..b754e6cb 100644 --- a/src/resources/hris/benefits/index.ts +++ b/src/resources/hris/benefits/index.ts @@ -1,4 +1,35 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -export { Benefits, type BenefitContribution, type BenefitFeaturesAndOperations, type BenefitFrequency, type BenefitType, type BenefitsSupport, type CompanyBenefit, type CreateCompanyBenefitsResponse, type SupportPerBenefitType, type SupportedBenefit, type UpdateCompanyBenefitResponse, type BenfitContribution, type BenefitCreateParams, type BenefitRetrieveParams, type BenefitUpdateParams, type BenefitListParams, type BenefitListSupportedBenefitsParams, type CompanyBenefitsSinglePage, type SupportedBenefitsSinglePage } from './benefits';; -export { Individuals, type EnrolledIndividualBenefitResponse, type IndividualBenefit, type UnenrolledIndividualBenefitResponse, type IndividualEnrolledIDsResponse, type IndividualEnrollManyParams, type IndividualEnrolledIDsParams, type IndividualRetrieveManyBenefitsParams, type IndividualUnenrollManyParams, type IndividualBenefitsSinglePage } from './individuals';; +export { + Benefits, + type BenefitContribution, + type BenefitFeaturesAndOperations, + type BenefitFrequency, + type BenefitType, + type BenefitsSupport, + type CompanyBenefit, + type CreateCompanyBenefitsResponse, + type SupportPerBenefitType, + type SupportedBenefit, + type UpdateCompanyBenefitResponse, + type BenfitContribution, + type BenefitCreateParams, + type BenefitRetrieveParams, + type BenefitUpdateParams, + type BenefitListParams, + type BenefitListSupportedBenefitsParams, + type CompanyBenefitsSinglePage, + type SupportedBenefitsSinglePage, +} from './benefits'; +export { + Individuals, + type EnrolledIndividualBenefitResponse, + type IndividualBenefit, + type UnenrolledIndividualBenefitResponse, + type IndividualEnrolledIDsResponse, + type IndividualEnrollManyParams, + type IndividualEnrolledIDsParams, + type IndividualRetrieveManyBenefitsParams, + type IndividualUnenrollManyParams, + type IndividualBenefitsSinglePage, +} from './individuals'; diff --git a/src/resources/hris/benefits/individuals.ts b/src/resources/hris/benefits/individuals.ts index 7b69eb1e..c747d92b 100644 --- a/src/resources/hris/benefits/individuals.ts +++ b/src/resources/hris/benefits/individuals.ts @@ -21,9 +21,18 @@ export class Individuals extends APIResource { * ); * ``` */ - enrollMany(benefitID: string, params: IndividualEnrollManyParams | null | undefined = undefined, options?: RequestOptions): APIPromise { - const { entity_ids, individuals } = params ?? {} - return this._client.post(path`/employer/benefits/${benefitID}/individuals`, { query: { entity_ids }, body: individuals, ...options, __security: { bearerAuth : true } }); + enrollMany( + benefitID: string, + params: IndividualEnrollManyParams | null | undefined = undefined, + options?: RequestOptions, + ): APIPromise { + const { entity_ids, individuals } = params ?? {}; + return this._client.post(path`/employer/benefits/${benefitID}/individuals`, { + query: { entity_ids }, + body: individuals, + ...options, + __security: { bearerAuth: true }, + }); } /** @@ -37,8 +46,16 @@ export class Individuals extends APIResource { * ); * ``` */ - enrolledIDs(benefitID: string, query: IndividualEnrolledIDsParams | null | undefined = {}, options?: RequestOptions): APIPromise { - return this._client.get(path`/employer/benefits/${benefitID}/enrolled`, { query, ...options, __security: { bearerAuth : true } }); + enrolledIDs( + benefitID: string, + query: IndividualEnrolledIDsParams | null | undefined = {}, + options?: RequestOptions, + ): APIPromise { + return this._client.get(path`/employer/benefits/${benefitID}/enrolled`, { + query, + ...options, + __security: { bearerAuth: true }, + }); } /** @@ -54,8 +71,16 @@ export class Individuals extends APIResource { * } * ``` */ - retrieveManyBenefits(benefitID: string, query: IndividualRetrieveManyBenefitsParams | null | undefined = {}, options?: RequestOptions): PagePromise { - return this._client.getAPIList(path`/employer/benefits/${benefitID}/individuals`, SinglePage, { query, ...options, __security: { bearerAuth : true } }); + retrieveManyBenefits( + benefitID: string, + query: IndividualRetrieveManyBenefitsParams | null | undefined = {}, + options?: RequestOptions, + ): PagePromise { + return this._client.getAPIList( + path`/employer/benefits/${benefitID}/individuals`, + SinglePage, + { query, ...options, __security: { bearerAuth: true } }, + ); } /** @@ -69,13 +94,22 @@ export class Individuals extends APIResource { * ); * ``` */ - unenrollMany(benefitID: string, params: IndividualUnenrollManyParams | null | undefined = {}, options?: RequestOptions): APIPromise { - const { entity_ids, ...body } = params ?? {} - return this._client.delete(path`/employer/benefits/${benefitID}/individuals`, { query: { entity_ids }, body, ...options, __security: { bearerAuth : true } }); + unenrollMany( + benefitID: string, + params: IndividualUnenrollManyParams | null | undefined = {}, + options?: RequestOptions, + ): APIPromise { + const { entity_ids, ...body } = params ?? {}; + return this._client.delete(path`/employer/benefits/${benefitID}/individuals`, { + query: { entity_ids }, + body, + ...options, + __security: { bearerAuth: true }, + }); } } -export type IndividualBenefitsSinglePage = SinglePage +export type IndividualBenefitsSinglePage = SinglePage; export interface EnrolledIndividualBenefitResponse { job_id: string; @@ -107,7 +141,11 @@ export namespace IndividualBenefit { * percentage-based contributions (in basis points where 100 = 1%), or tiered * matching structures. */ - company_contribution: UnionMember0.UnionMember0 | UnionMember0.UnionMember1 | UnionMember0.UnionMember2 | null; + company_contribution: + | UnionMember0.UnionMember0 + | UnionMember0.UnionMember1 + | UnionMember0.UnionMember2 + | null; /** * Employee deduction configuration. Supports both fixed amounts (in cents) and @@ -361,6 +399,6 @@ export declare namespace Individuals { type IndividualEnrollManyParams as IndividualEnrollManyParams, type IndividualEnrolledIDsParams as IndividualEnrolledIDsParams, type IndividualRetrieveManyBenefitsParams as IndividualRetrieveManyBenefitsParams, - type IndividualUnenrollManyParams as IndividualUnenrollManyParams + type IndividualUnenrollManyParams as IndividualUnenrollManyParams, }; } diff --git a/src/resources/hris/company/company.ts b/src/resources/hris/company/company.ts index 34c16763..bec6a702 100644 --- a/src/resources/hris/company/company.ts +++ b/src/resources/hris/company/company.ts @@ -3,12 +3,19 @@ import { APIResource } from '../../../core/resource'; import * as HRISAPI from '../hris'; import * as PayStatementItemAPI from './pay-statement-item/pay-statement-item'; -import { PayStatementItem, PayStatementItemListParams, PayStatementItemListResponse, PayStatementItemListResponsesPage } from './pay-statement-item/pay-statement-item'; +import { + PayStatementItem, + PayStatementItemListParams, + PayStatementItemListResponse, + PayStatementItemListResponsesPage, +} from './pay-statement-item/pay-statement-item'; import { APIPromise } from '../../../core/api-promise'; import { RequestOptions } from '../../../internal/request-options'; export class CompanyResource extends APIResource { - payStatementItem: PayStatementItemAPI.PayStatementItem = new PayStatementItemAPI.PayStatementItem(this._client); + payStatementItem: PayStatementItemAPI.PayStatementItem = new PayStatementItemAPI.PayStatementItem( + this._client, + ); /** * Read basic company data @@ -18,8 +25,11 @@ export class CompanyResource extends APIResource { * const company = await client.hris.company.retrieve(); * ``` */ - retrieve(query: CompanyRetrieveParams | null | undefined = {}, options?: RequestOptions): APIPromise { - return this._client.get('/employer/company', { query, ...options, __security: { bearerAuth : true } }); + retrieve( + query: CompanyRetrieveParams | null | undefined = {}, + options?: RequestOptions, + ): APIPromise { + return this._client.get('/employer/company', { query, ...options, __security: { bearerAuth: true } }); } } @@ -133,7 +143,15 @@ export namespace Company { /** * The tax payer type of the company. */ - type: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative' | null; + type: + | 'llc' + | 'lp' + | 'corporation' + | 'sole_proprietor' + | 'non_profit' + | 'partnership' + | 'cooperative' + | null; } } @@ -147,15 +165,12 @@ export interface CompanyRetrieveParams { CompanyResource.PayStatementItem = PayStatementItem; export declare namespace CompanyResource { - export { - type Company as Company, - type CompanyRetrieveParams as CompanyRetrieveParams - }; + export { type Company as Company, type CompanyRetrieveParams as CompanyRetrieveParams }; export { PayStatementItem as PayStatementItem, type PayStatementItemListResponse as PayStatementItemListResponse, type PayStatementItemListResponsesPage as PayStatementItemListResponsesPage, - type PayStatementItemListParams as PayStatementItemListParams + type PayStatementItemListParams as PayStatementItemListParams, }; } diff --git a/src/resources/hris/company/index.ts b/src/resources/hris/company/index.ts index 757f7186..94a550df 100644 --- a/src/resources/hris/company/index.ts +++ b/src/resources/hris/company/index.ts @@ -1,4 +1,9 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -export { CompanyResource, type Company, type CompanyRetrieveParams } from './company';; -export { PayStatementItem, type PayStatementItemListResponse, type PayStatementItemListParams, type PayStatementItemListResponsesPage } from './pay-statement-item/index';; +export { CompanyResource, type Company, type CompanyRetrieveParams } from './company'; +export { + PayStatementItem, + type PayStatementItemListResponse, + type PayStatementItemListParams, + type PayStatementItemListResponsesPage, +} from './pay-statement-item/index'; diff --git a/src/resources/hris/company/pay-statement-item/index.ts b/src/resources/hris/company/pay-statement-item/index.ts index affe5b48..e0aab289 100644 --- a/src/resources/hris/company/pay-statement-item/index.ts +++ b/src/resources/hris/company/pay-statement-item/index.ts @@ -1,4 +1,20 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -export { PayStatementItem, type PayStatementItemListResponse, type PayStatementItemListParams, type PayStatementItemListResponsesPage } from './pay-statement-item';; -export { Rules, type RuleCreateResponse, type RuleUpdateResponse, type RuleListResponse, type RuleDeleteResponse, type RuleCreateParams, type RuleUpdateParams, type RuleListParams, type RuleDeleteParams, type RuleListResponsesPage } from './rules';; +export { + PayStatementItem, + type PayStatementItemListResponse, + type PayStatementItemListParams, + type PayStatementItemListResponsesPage, +} from './pay-statement-item'; +export { + Rules, + type RuleCreateResponse, + type RuleUpdateResponse, + type RuleListResponse, + type RuleDeleteResponse, + type RuleCreateParams, + type RuleUpdateParams, + type RuleListParams, + type RuleDeleteParams, + type RuleListResponsesPage, +} from './rules'; diff --git a/src/resources/hris/company/pay-statement-item/pay-statement-item.ts b/src/resources/hris/company/pay-statement-item/pay-statement-item.ts index 7de4e0c8..82c251bd 100644 --- a/src/resources/hris/company/pay-statement-item/pay-statement-item.ts +++ b/src/resources/hris/company/pay-statement-item/pay-statement-item.ts @@ -2,7 +2,18 @@ import { APIResource } from '../../../../core/resource'; import * as RulesAPI from './rules'; -import { RuleCreateParams, RuleCreateResponse, RuleDeleteParams, RuleDeleteResponse, RuleListParams, RuleListResponse, RuleListResponsesPage, RuleUpdateParams, RuleUpdateResponse, Rules } from './rules'; +import { + RuleCreateParams, + RuleCreateResponse, + RuleDeleteParams, + RuleDeleteResponse, + RuleListParams, + RuleListResponse, + RuleListResponsesPage, + RuleUpdateParams, + RuleUpdateResponse, + Rules, +} from './rules'; import { PagePromise, ResponsesPage } from '../../../../core/pagination'; import { RequestOptions } from '../../../../internal/request-options'; @@ -21,12 +32,19 @@ export class PayStatementItem extends APIResource { * } * ``` */ - list(query: PayStatementItemListParams | null | undefined = {}, options?: RequestOptions): PagePromise { - return this._client.getAPIList('/employer/pay-statement-item', ResponsesPage, { query, ...options, __security: { bearerAuth : true } }); + list( + query: PayStatementItemListParams | null | undefined = {}, + options?: RequestOptions, + ): PagePromise { + return this._client.getAPIList( + '/employer/pay-statement-item', + ResponsesPage, + { query, ...options, __security: { bearerAuth: true } }, + ); } } -export type PayStatementItemListResponsesPage = ResponsesPage +export type PayStatementItemListResponsesPage = ResponsesPage; export interface PayStatementItemListResponse { /** @@ -116,7 +134,7 @@ export declare namespace PayStatementItem { export { type PayStatementItemListResponse as PayStatementItemListResponse, type PayStatementItemListResponsesPage as PayStatementItemListResponsesPage, - type PayStatementItemListParams as PayStatementItemListParams + type PayStatementItemListParams as PayStatementItemListParams, }; export { @@ -129,6 +147,6 @@ export declare namespace PayStatementItem { type RuleCreateParams as RuleCreateParams, type RuleUpdateParams as RuleUpdateParams, type RuleListParams as RuleListParams, - type RuleDeleteParams as RuleDeleteParams + type RuleDeleteParams as RuleDeleteParams, }; } diff --git a/src/resources/hris/company/pay-statement-item/rules.ts b/src/resources/hris/company/pay-statement-item/rules.ts index 47fe9034..ed9f9616 100644 --- a/src/resources/hris/company/pay-statement-item/rules.ts +++ b/src/resources/hris/company/pay-statement-item/rules.ts @@ -19,9 +19,17 @@ export class Rules extends APIResource { * await client.hris.company.payStatementItem.rules.create(); * ``` */ - create(params: RuleCreateParams | null | undefined = {}, options?: RequestOptions): APIPromise { - const { entity_ids, ...body } = params ?? {} - return this._client.post('/employer/pay-statement-item/rule', { query: { entity_ids }, body, ...options, __security: { bearerAuth : true } }); + create( + params: RuleCreateParams | null | undefined = {}, + options?: RequestOptions, + ): APIPromise { + const { entity_ids, ...body } = params ?? {}; + return this._client.post('/employer/pay-statement-item/rule', { + query: { entity_ids }, + body, + ...options, + __security: { bearerAuth: true }, + }); } /** @@ -35,9 +43,18 @@ export class Rules extends APIResource { * ); * ``` */ - update(ruleID: string, params: RuleUpdateParams | null | undefined = {}, options?: RequestOptions): APIPromise { - const { entity_ids, ...body } = params ?? {} - return this._client.put(path`/employer/pay-statement-item/rule/${ruleID}`, { query: { entity_ids }, body, ...options, __security: { bearerAuth : true } }); + update( + ruleID: string, + params: RuleUpdateParams | null | undefined = {}, + options?: RequestOptions, + ): APIPromise { + const { entity_ids, ...body } = params ?? {}; + return this._client.put(path`/employer/pay-statement-item/rule/${ruleID}`, { + query: { entity_ids }, + body, + ...options, + __security: { bearerAuth: true }, + }); } /** @@ -51,8 +68,15 @@ export class Rules extends APIResource { * } * ``` */ - list(query: RuleListParams | null | undefined = {}, options?: RequestOptions): PagePromise { - return this._client.getAPIList('/employer/pay-statement-item/rule', ResponsesPage, { query, ...options, __security: { bearerAuth : true } }); + list( + query: RuleListParams | null | undefined = {}, + options?: RequestOptions, + ): PagePromise { + return this._client.getAPIList('/employer/pay-statement-item/rule', ResponsesPage, { + query, + ...options, + __security: { bearerAuth: true }, + }); } /** @@ -66,13 +90,21 @@ export class Rules extends APIResource { * ); * ``` */ - delete(ruleID: string, params: RuleDeleteParams | null | undefined = {}, options?: RequestOptions): APIPromise { - const { entity_ids } = params ?? {} - return this._client.delete(path`/employer/pay-statement-item/rule/${ruleID}`, { query: { entity_ids }, ...options, __security: { bearerAuth : true } }); + delete( + ruleID: string, + params: RuleDeleteParams | null | undefined = {}, + options?: RequestOptions, + ): APIPromise { + const { entity_ids } = params ?? {}; + return this._client.delete(path`/employer/pay-statement-item/rule/${ruleID}`, { + query: { entity_ids }, + ...options, + __security: { bearerAuth: true }, + }); } } -export type RuleListResponsesPage = ResponsesPage +export type RuleListResponsesPage = ResponsesPage; export interface RuleCreateResponse { /** @@ -474,6 +506,6 @@ export declare namespace Rules { type RuleCreateParams as RuleCreateParams, type RuleUpdateParams as RuleUpdateParams, type RuleListParams as RuleListParams, - type RuleDeleteParams as RuleDeleteParams + type RuleDeleteParams as RuleDeleteParams, }; } diff --git a/src/resources/hris/directory.ts b/src/resources/hris/directory.ts index 8e24ba13..8329707f 100644 --- a/src/resources/hris/directory.ts +++ b/src/resources/hris/directory.ts @@ -16,14 +16,21 @@ export class Directory extends APIResource { * } * ``` */ - list(query: DirectoryListParams | null | undefined = {}, options?: RequestOptions): PagePromise { - return this._client.getAPIList('/employer/directory', IndividualsPage, { query, ...options, __security: { bearerAuth : true } }); + list( + query: DirectoryListParams | null | undefined = {}, + options?: RequestOptions, + ): PagePromise { + return this._client.getAPIList('/employer/directory', IndividualsPage, { + query, + ...options, + __security: { bearerAuth: true }, + }); } /** * @deprecated use `list` instead */ - listIndividuals = this.list + listIndividuals = this.list; } export interface IndividualInDirectory { @@ -113,6 +120,6 @@ export declare namespace Directory { export { type IndividualInDirectory as IndividualInDirectory, type DirectoryListParams as DirectoryListParams, - type DirectoryListIndividualsParams as DirectoryListIndividualsParams + type DirectoryListIndividualsParams as DirectoryListIndividualsParams, }; } diff --git a/src/resources/hris/documents.ts b/src/resources/hris/documents.ts index 49bde202..fe02baf2 100644 --- a/src/resources/hris/documents.ts +++ b/src/resources/hris/documents.ts @@ -16,8 +16,11 @@ export class Documents extends APIResource { * const documents = await client.hris.documents.list(); * ``` */ - list(query: DocumentListParams | null | undefined = {}, options?: RequestOptions): APIPromise { - return this._client.get('/employer/documents', { query, ...options, __security: { bearerAuth : true } }); + list( + query: DocumentListParams | null | undefined = {}, + options?: RequestOptions, + ): APIPromise { + return this._client.get('/employer/documents', { query, ...options, __security: { bearerAuth: true } }); } /** @@ -31,8 +34,16 @@ export class Documents extends APIResource { * ); * ``` */ - retreive(documentID: string, query: DocumentRetreiveParams | null | undefined = {}, options?: RequestOptions): APIPromise { - return this._client.get(path`/employer/documents/${documentID}`, { query, ...options, __security: { bearerAuth : true } }); + retreive( + documentID: string, + query: DocumentRetreiveParams | null | undefined = {}, + options?: RequestOptions, + ): APIPromise { + return this._client.get(path`/employer/documents/${documentID}`, { + query, + ...options, + __security: { bearerAuth: true }, + }); } } @@ -168,7 +179,11 @@ export namespace W42020 { /** * The individual's filing status for tax purposes. */ - filing_status: 'head_of_household' | 'married_filing_jointly_or_qualifying_surviving_spouse' | 'single_or_married_filing_separately' | null; + filing_status: + | 'head_of_household' + | 'married_filing_jointly_or_qualifying_surviving_spouse' + | 'single_or_married_filing_separately' + | null; /** * The unique identifier for the individual associated with this document. @@ -197,7 +212,7 @@ export interface DocumentListResponse { * A 2020 version of the W-4 tax form containing information on an individual's * filing status, dependents, and withholding details. */ -export type DocumentRetreiveResponse = W42020 | W42005 +export type DocumentRetreiveResponse = W42020 | W42005; export interface DocumentListParams { /** @@ -243,6 +258,6 @@ export declare namespace Documents { type DocumentListResponse as DocumentListResponse, type DocumentRetreiveResponse as DocumentRetreiveResponse, type DocumentListParams as DocumentListParams, - type DocumentRetreiveParams as DocumentRetreiveParams + type DocumentRetreiveParams as DocumentRetreiveParams, }; } diff --git a/src/resources/hris/employments.ts b/src/resources/hris/employments.ts index 94dbef2e..8d985e1d 100644 --- a/src/resources/hris/employments.ts +++ b/src/resources/hris/employments.ts @@ -19,15 +19,24 @@ export class Employments extends APIResource { * } * ``` */ - retrieveMany(params: EmploymentRetrieveManyParams, options?: RequestOptions): PagePromise { - const { entity_ids, ...body } = params - return this._client.getAPIList('/employer/employment', ResponsesPage, { query: { entity_ids }, body, method: 'post', ...options, __security: { bearerAuth : true } }); + retrieveMany( + params: EmploymentRetrieveManyParams, + options?: RequestOptions, + ): PagePromise { + const { entity_ids, ...body } = params; + return this._client.getAPIList('/employer/employment', ResponsesPage, { + query: { entity_ids }, + body, + method: 'post', + ...options, + __security: { bearerAuth: true }, + }); } } -export type EmploymentDataResponsesPage = ResponsesPage +export type EmploymentDataResponsesPage = ResponsesPage; -export type EmploymentData = EmploymentData.UnionMember0 | EmploymentData.BatchError +export type EmploymentData = EmploymentData.UnionMember0 | EmploymentData.BatchError; export namespace EmploymentData { export interface UnionMember0 { @@ -54,7 +63,15 @@ export namespace EmploymentData { /** * The detailed employment status of the individual. */ - employment_status: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated' | null; + employment_status: + | 'active' + | 'deceased' + | 'leave' + | 'onboarding' + | 'prehire' + | 'retired' + | 'terminated' + | null; end_date: string | null; @@ -224,6 +241,6 @@ export declare namespace Employments { type EmploymentData as EmploymentData, type EmploymentDataResponse as EmploymentDataResponse, type EmploymentDataResponsesPage as EmploymentDataResponsesPage, - type EmploymentRetrieveManyParams as EmploymentRetrieveManyParams + type EmploymentRetrieveManyParams as EmploymentRetrieveManyParams, }; } diff --git a/src/resources/hris/hris.ts b/src/resources/hris/hris.ts index d66b2899..4ecf085c 100644 --- a/src/resources/hris/hris.ts +++ b/src/resources/hris/hris.ts @@ -2,19 +2,73 @@ import { APIResource } from '../../core/resource'; import * as DirectoryAPI from './directory'; -import { Directory, DirectoryListIndividualsParams, DirectoryListParams, IndividualInDirectory } from './directory'; +import { + Directory, + DirectoryListIndividualsParams, + DirectoryListParams, + IndividualInDirectory, +} from './directory'; import * as DocumentsAPI from './documents'; -import { DocumentListParams, DocumentListResponse, DocumentResponse, DocumentRetreiveParams, DocumentRetreiveResponse, Documents, W42005, W42020 } from './documents'; +import { + DocumentListParams, + DocumentListResponse, + DocumentResponse, + DocumentRetreiveParams, + DocumentRetreiveResponse, + Documents, + W42005, + W42020, +} from './documents'; import * as EmploymentsAPI from './employments'; -import { EmploymentData, EmploymentDataResponse, EmploymentDataResponsesPage, EmploymentRetrieveManyParams, Employments } from './employments'; +import { + EmploymentData, + EmploymentDataResponse, + EmploymentDataResponsesPage, + EmploymentRetrieveManyParams, + Employments, +} from './employments'; import * as IndividualsAPI from './individuals'; -import { Individual, IndividualResponse, IndividualResponsesPage, IndividualRetrieveManyParams, Individuals } from './individuals'; +import { + Individual, + IndividualResponse, + IndividualResponsesPage, + IndividualRetrieveManyParams, + Individuals, +} from './individuals'; import * as PayStatementsAPI from './pay-statements'; -import { PayStatement, PayStatementDataSyncInProgress, PayStatementResponse, PayStatementResponseBody, PayStatementResponsesPage, PayStatementRetrieveManyParams, PayStatements } from './pay-statements'; +import { + PayStatement, + PayStatementDataSyncInProgress, + PayStatementResponse, + PayStatementResponseBody, + PayStatementResponsesPage, + PayStatementRetrieveManyParams, + PayStatements, +} from './pay-statements'; import * as PaymentsAPI from './payments'; import { Payment, PaymentListParams, Payments, PaymentsSinglePage } from './payments'; import * as BenefitsAPI from './benefits/benefits'; -import { BenefitContribution, BenefitCreateParams, BenefitFeaturesAndOperations, BenefitFrequency, BenefitListParams, BenefitListSupportedBenefitsParams, BenefitRetrieveParams, BenefitType, BenefitUpdateParams, Benefits, BenefitsSupport, BenfitContribution, CompanyBenefit, CompanyBenefitsSinglePage, CreateCompanyBenefitsResponse, SupportPerBenefitType, SupportedBenefit, SupportedBenefitsSinglePage, UpdateCompanyBenefitResponse } from './benefits/benefits'; +import { + BenefitContribution, + BenefitCreateParams, + BenefitFeaturesAndOperations, + BenefitFrequency, + BenefitListParams, + BenefitListSupportedBenefitsParams, + BenefitRetrieveParams, + BenefitType, + BenefitUpdateParams, + Benefits, + BenefitsSupport, + BenfitContribution, + CompanyBenefit, + CompanyBenefitsSinglePage, + CreateCompanyBenefitsResponse, + SupportPerBenefitType, + SupportedBenefit, + SupportedBenefitsSinglePage, + UpdateCompanyBenefitResponse, +} from './benefits/benefits'; import * as CompanyAPI from './company/company'; import { Company, CompanyResource, CompanyRetrieveParams } from './company/company'; @@ -54,7 +108,17 @@ export interface Income { * The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, * `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`. */ - unit: 'yearly' | 'quarterly' | 'monthly' | 'semi_monthly' | 'bi_weekly' | 'weekly' | 'daily' | 'hourly' | 'fixed' | null; + unit: + | 'yearly' + | 'quarterly' + | 'monthly' + | 'semi_monthly' + | 'bi_weekly' + | 'weekly' + | 'daily' + | 'hourly' + | 'fixed' + | null; } export interface Location { @@ -112,23 +176,19 @@ HRIS.Documents = Documents; HRIS.Benefits = Benefits; export declare namespace HRIS { - export { - type Income as Income, - type Location as Location, - type Money as Money - }; + export { type Income as Income, type Location as Location, type Money as Money }; export { CompanyResource as CompanyResource, type Company as Company, - type CompanyRetrieveParams as CompanyRetrieveParams + type CompanyRetrieveParams as CompanyRetrieveParams, }; export { Directory as Directory, type IndividualInDirectory as IndividualInDirectory, type DirectoryListParams as DirectoryListParams, - type DirectoryListIndividualsParams as DirectoryListIndividualsParams + type DirectoryListIndividualsParams as DirectoryListIndividualsParams, }; export { @@ -136,7 +196,7 @@ export declare namespace HRIS { type Individual as Individual, type IndividualResponse as IndividualResponse, type IndividualResponsesPage as IndividualResponsesPage, - type IndividualRetrieveManyParams as IndividualRetrieveManyParams + type IndividualRetrieveManyParams as IndividualRetrieveManyParams, }; export { @@ -144,14 +204,14 @@ export declare namespace HRIS { type EmploymentData as EmploymentData, type EmploymentDataResponse as EmploymentDataResponse, type EmploymentDataResponsesPage as EmploymentDataResponsesPage, - type EmploymentRetrieveManyParams as EmploymentRetrieveManyParams + type EmploymentRetrieveManyParams as EmploymentRetrieveManyParams, }; export { Payments as Payments, type Payment as Payment, type PaymentsSinglePage as PaymentsSinglePage, - type PaymentListParams as PaymentListParams + type PaymentListParams as PaymentListParams, }; export { @@ -161,7 +221,7 @@ export declare namespace HRIS { type PayStatementResponse as PayStatementResponse, type PayStatementResponseBody as PayStatementResponseBody, type PayStatementResponsesPage as PayStatementResponsesPage, - type PayStatementRetrieveManyParams as PayStatementRetrieveManyParams + type PayStatementRetrieveManyParams as PayStatementRetrieveManyParams, }; export { @@ -172,7 +232,7 @@ export declare namespace HRIS { type DocumentListResponse as DocumentListResponse, type DocumentRetreiveResponse as DocumentRetreiveResponse, type DocumentListParams as DocumentListParams, - type DocumentRetreiveParams as DocumentRetreiveParams + type DocumentRetreiveParams as DocumentRetreiveParams, }; export { @@ -194,6 +254,6 @@ export declare namespace HRIS { type BenefitRetrieveParams as BenefitRetrieveParams, type BenefitUpdateParams as BenefitUpdateParams, type BenefitListParams as BenefitListParams, - type BenefitListSupportedBenefitsParams as BenefitListSupportedBenefitsParams + type BenefitListSupportedBenefitsParams as BenefitListSupportedBenefitsParams, }; } diff --git a/src/resources/hris/index.ts b/src/resources/hris/index.ts index 3d4196a9..391e5a6b 100644 --- a/src/resources/hris/index.ts +++ b/src/resources/hris/index.ts @@ -1,11 +1,65 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -export { Benefits, type BenefitContribution, type BenefitFeaturesAndOperations, type BenefitFrequency, type BenefitType, type BenefitsSupport, type CompanyBenefit, type CreateCompanyBenefitsResponse, type SupportPerBenefitType, type SupportedBenefit, type UpdateCompanyBenefitResponse, type BenfitContribution, type BenefitCreateParams, type BenefitRetrieveParams, type BenefitUpdateParams, type BenefitListParams, type BenefitListSupportedBenefitsParams, type CompanyBenefitsSinglePage, type SupportedBenefitsSinglePage } from './benefits/index';; -export { CompanyResource, type Company, type CompanyRetrieveParams } from './company/index';; -export { Directory, type IndividualInDirectory, type DirectoryListParams, type DirectoryListIndividualsParams } from './directory';; -export { Documents, type DocumentResponse, type W42005, type W42020, type DocumentListResponse, type DocumentRetreiveResponse, type DocumentListParams, type DocumentRetreiveParams } from './documents';; -export { Employments, type EmploymentData, type EmploymentDataResponse, type EmploymentRetrieveManyParams, type EmploymentDataResponsesPage } from './employments';; -export { HRIS, type Income, type Location, type Money } from './hris';; -export { Individuals, type Individual, type IndividualResponse, type IndividualRetrieveManyParams, type IndividualResponsesPage } from './individuals';; -export { PayStatements, type PayStatement, type PayStatementDataSyncInProgress, type PayStatementResponse, type PayStatementResponseBody, type PayStatementRetrieveManyParams, type PayStatementResponsesPage } from './pay-statements';; -export { Payments, type Payment, type PaymentListParams, type PaymentsSinglePage } from './payments';; +export { + Benefits, + type BenefitContribution, + type BenefitFeaturesAndOperations, + type BenefitFrequency, + type BenefitType, + type BenefitsSupport, + type CompanyBenefit, + type CreateCompanyBenefitsResponse, + type SupportPerBenefitType, + type SupportedBenefit, + type UpdateCompanyBenefitResponse, + type BenfitContribution, + type BenefitCreateParams, + type BenefitRetrieveParams, + type BenefitUpdateParams, + type BenefitListParams, + type BenefitListSupportedBenefitsParams, + type CompanyBenefitsSinglePage, + type SupportedBenefitsSinglePage, +} from './benefits/index'; +export { CompanyResource, type Company, type CompanyRetrieveParams } from './company/index'; +export { + Directory, + type IndividualInDirectory, + type DirectoryListParams, + type DirectoryListIndividualsParams, +} from './directory'; +export { + Documents, + type DocumentResponse, + type W42005, + type W42020, + type DocumentListResponse, + type DocumentRetreiveResponse, + type DocumentListParams, + type DocumentRetreiveParams, +} from './documents'; +export { + Employments, + type EmploymentData, + type EmploymentDataResponse, + type EmploymentRetrieveManyParams, + type EmploymentDataResponsesPage, +} from './employments'; +export { HRIS, type Income, type Location, type Money } from './hris'; +export { + Individuals, + type Individual, + type IndividualResponse, + type IndividualRetrieveManyParams, + type IndividualResponsesPage, +} from './individuals'; +export { + PayStatements, + type PayStatement, + type PayStatementDataSyncInProgress, + type PayStatementResponse, + type PayStatementResponseBody, + type PayStatementRetrieveManyParams, + type PayStatementResponsesPage, +} from './pay-statements'; +export { Payments, type Payment, type PaymentListParams, type PaymentsSinglePage } from './payments'; diff --git a/src/resources/hris/individuals.ts b/src/resources/hris/individuals.ts index ef06762c..5f1c2ea7 100644 --- a/src/resources/hris/individuals.ts +++ b/src/resources/hris/individuals.ts @@ -17,15 +17,24 @@ export class Individuals extends APIResource { * } * ``` */ - retrieveMany(params: IndividualRetrieveManyParams | null | undefined = {}, options?: RequestOptions): PagePromise { - const { entity_ids, ...body } = params ?? {} - return this._client.getAPIList('/employer/individual', ResponsesPage, { query: { entity_ids }, body, method: 'post', ...options, __security: { bearerAuth : true } }); + retrieveMany( + params: IndividualRetrieveManyParams | null | undefined = {}, + options?: RequestOptions, + ): PagePromise { + const { entity_ids, ...body } = params ?? {}; + return this._client.getAPIList('/employer/individual', ResponsesPage, { + query: { entity_ids }, + body, + method: 'post', + ...options, + __security: { bearerAuth: true }, + }); } } -export type IndividualResponsesPage = ResponsesPage +export type IndividualResponsesPage = ResponsesPage; -export type Individual = Individual.UnionMember0 | Individual.BatchError +export type Individual = Individual.UnionMember0 | Individual.BatchError; export namespace Individual { export interface UnionMember0 { @@ -39,7 +48,16 @@ export namespace Individual { /** * The EEOC-defined ethnicity of the individual. */ - ethnicity: 'asian' | 'white' | 'black_or_african_american' | 'native_hawaiian_or_pacific_islander' | 'american_indian_or_alaska_native' | 'hispanic_or_latino' | 'two_or_more_races' | 'decline_to_specify' | null; + ethnicity: + | 'asian' + | 'white' + | 'black_or_african_american' + | 'native_hawaiian_or_pacific_islander' + | 'american_indian_or_alaska_native' + | 'hispanic_or_latino' + | 'two_or_more_races' + | 'decline_to_specify' + | null; /** * The legal first name of the individual. @@ -153,6 +171,6 @@ export declare namespace Individuals { type Individual as Individual, type IndividualResponse as IndividualResponse, type IndividualResponsesPage as IndividualResponsesPage, - type IndividualRetrieveManyParams as IndividualRetrieveManyParams + type IndividualRetrieveManyParams as IndividualRetrieveManyParams, }; } diff --git a/src/resources/hris/pay-statements.ts b/src/resources/hris/pay-statements.ts index 6bcb0c42..c256c1f9 100644 --- a/src/resources/hris/pay-statements.ts +++ b/src/resources/hris/pay-statements.ts @@ -29,13 +29,22 @@ export class PayStatements extends APIResource { * } * ``` */ - retrieveMany(params: PayStatementRetrieveManyParams, options?: RequestOptions): PagePromise { - const { entity_ids, ...body } = params - return this._client.getAPIList('/employer/pay-statement', ResponsesPage, { query: { entity_ids }, body, method: 'post', ...options, __security: { bearerAuth : true } }); + retrieveMany( + params: PayStatementRetrieveManyParams, + options?: RequestOptions, + ): PagePromise { + const { entity_ids, ...body } = params; + return this._client.getAPIList('/employer/pay-statement', ResponsesPage, { + query: { entity_ids }, + body, + method: 'post', + ...options, + __security: { bearerAuth: true }, + }); } } -export type PayStatementResponsesPage = ResponsesPage +export type PayStatementResponsesPage = ResponsesPage; export interface PayStatement { /** @@ -106,7 +115,21 @@ export namespace PayStatement { /** * The type of earning. */ - type: 'salary' | 'wage' | 'reimbursement' | 'overtime' | 'severance' | 'double_overtime' | 'pto' | 'sick' | 'bonus' | 'commission' | 'tips' | '1099' | 'other' | null; + type: + | 'salary' + | 'wage' + | 'reimbursement' + | 'overtime' + | 'severance' + | 'double_overtime' + | 'pto' + | 'sick' + | 'bonus' + | 'commission' + | 'tips' + | '1099' + | 'other' + | null; attributes?: Earning.Attributes | null; } @@ -326,6 +349,6 @@ export declare namespace PayStatements { type PayStatementResponse as PayStatementResponse, type PayStatementResponseBody as PayStatementResponseBody, type PayStatementResponsesPage as PayStatementResponsesPage, - type PayStatementRetrieveManyParams as PayStatementRetrieveManyParams + type PayStatementRetrieveManyParams as PayStatementRetrieveManyParams, }; } diff --git a/src/resources/hris/payments.ts b/src/resources/hris/payments.ts index cf9f0f1d..e1f5fec2 100644 --- a/src/resources/hris/payments.ts +++ b/src/resources/hris/payments.ts @@ -21,11 +21,15 @@ export class Payments extends APIResource { * ``` */ list(query: PaymentListParams, options?: RequestOptions): PagePromise { - return this._client.getAPIList('/employer/payment', SinglePage, { query, ...options, __security: { bearerAuth : true } }); + return this._client.getAPIList('/employer/payment', SinglePage, { + query, + ...options, + __security: { bearerAuth: true }, + }); } } -export type PaymentsSinglePage = SinglePage +export type PaymentsSinglePage = SinglePage; export interface Payment { /** @@ -55,7 +59,17 @@ export interface Payment { /** * List of pay frequencies associated with this payment. */ - pay_frequencies: Array<'annually' | 'bi_weekly' | 'daily' | 'monthly' | 'other' | 'quarterly' | 'semi_annually' | 'semi_monthly' | 'weekly'> | null; + pay_frequencies: Array< + | 'annually' + | 'bi_weekly' + | 'daily' + | 'monthly' + | 'other' + | 'quarterly' + | 'semi_annually' + | 'semi_monthly' + | 'weekly' + > | null; /** * Array of the Finch id (uuidv4) of every pay group associated with this payment. @@ -102,6 +116,6 @@ export declare namespace Payments { export { type Payment as Payment, type PaymentsSinglePage as PaymentsSinglePage, - type PaymentListParams as PaymentListParams + type PaymentListParams as PaymentListParams, }; } diff --git a/src/resources/index.ts b/src/resources/index.ts index ee56086b..ff93bb94 100644 --- a/src/resources/index.ts +++ b/src/resources/index.ts @@ -1,13 +1,34 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -export * from './shared';; -export { AccessTokens, type CreateAccessTokenResponse, type AccessTokenCreateParams } from './access-tokens';; -export { Account, type DisconnectResponse, type Introspection } from './account';; -export { Connect } from './connect/connect';; -export { HRIS, type Income, type Location, type Money } from './hris/hris';; -export { Jobs } from './jobs/jobs';; -export { Payroll } from './payroll/payroll';; -export { Providers, type Provider, type ProviderListResponse, type ProviderListResponsesSinglePage } from './providers';; -export { RequestForwarding, type RequestForwardingForwardResponse, type RequestForwardingForwardParams } from './request-forwarding';; -export { Sandbox } from './sandbox/sandbox';; -export { Webhooks, type AccountUpdateEvent, type BaseWebhookEvent, type CompanyEvent, type DirectoryEvent, type EmploymentEvent, type IndividualEvent, type JobCompletionEvent, type PayStatementEvent, type PaymentEvent, type WebhookEvent } from './webhooks';; +export * from './shared'; +export { AccessTokens, type CreateAccessTokenResponse, type AccessTokenCreateParams } from './access-tokens'; +export { Account, type DisconnectResponse, type Introspection } from './account'; +export { Connect } from './connect/connect'; +export { HRIS, type Income, type Location, type Money } from './hris/hris'; +export { Jobs } from './jobs/jobs'; +export { Payroll } from './payroll/payroll'; +export { + Providers, + type Provider, + type ProviderListResponse, + type ProviderListResponsesSinglePage, +} from './providers'; +export { + RequestForwarding, + type RequestForwardingForwardResponse, + type RequestForwardingForwardParams, +} from './request-forwarding'; +export { Sandbox } from './sandbox/sandbox'; +export { + Webhooks, + type AccountUpdateEvent, + type BaseWebhookEvent, + type CompanyEvent, + type DirectoryEvent, + type EmploymentEvent, + type IndividualEvent, + type JobCompletionEvent, + type PayStatementEvent, + type PaymentEvent, + type WebhookEvent, +} from './webhooks'; diff --git a/src/resources/jobs/automated.ts b/src/resources/jobs/automated.ts index 0a9d32a5..534810c5 100644 --- a/src/resources/jobs/automated.ts +++ b/src/resources/jobs/automated.ts @@ -23,14 +23,14 @@ export class Automated extends APIResource { * access to this endpoint, please contact your Finch account manager. */ create(body: AutomatedCreateParams, options?: RequestOptions): APIPromise { - return this._client.post('/jobs/automated', { body, ...options, __security: { bearerAuth : true } }); + return this._client.post('/jobs/automated', { body, ...options, __security: { bearerAuth: true } }); } /** * Get an automated job by `job_id`. */ retrieve(jobID: string, options?: RequestOptions): APIPromise { - return this._client.get(path`/jobs/automated/${jobID}`, { ...options, __security: { bearerAuth : true } }); + return this._client.get(path`/jobs/automated/${jobID}`, { ...options, __security: { bearerAuth: true } }); } /** @@ -38,8 +38,11 @@ export class Automated extends APIResource { * jobs are sorted in descending order by submission time. For scheduled jobs such * as data syncs, only the next scheduled job is shown. */ - list(query: AutomatedListParams | null | undefined = {}, options?: RequestOptions): APIPromise { - return this._client.get('/jobs/automated', { query, ...options, __security: { bearerAuth : true } }); + list( + query: AutomatedListParams | null | undefined = {}, + options?: RequestOptions, + ): APIPromise { + return this._client.get('/jobs/automated', { query, ...options, __security: { bearerAuth: true } }); } } @@ -168,7 +171,9 @@ export namespace AutomatedListResponse { } } -export type AutomatedCreateParams = AutomatedCreateParams.DataSyncAll | AutomatedCreateParams.W4FormEmployeeSync +export type AutomatedCreateParams = + | AutomatedCreateParams.DataSyncAll + | AutomatedCreateParams.W4FormEmployeeSync; export declare namespace AutomatedCreateParams { export interface DataSyncAll { @@ -215,6 +220,6 @@ export declare namespace Automated { type AutomatedCreateResponse as AutomatedCreateResponse, type AutomatedListResponse as AutomatedListResponse, type AutomatedCreateParams as AutomatedCreateParams, - type AutomatedListParams as AutomatedListParams + type AutomatedListParams as AutomatedListParams, }; } diff --git a/src/resources/jobs/index.ts b/src/resources/jobs/index.ts index 88ecc2dd..fc96a5e7 100644 --- a/src/resources/jobs/index.ts +++ b/src/resources/jobs/index.ts @@ -1,5 +1,12 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -export { Automated, type AutomatedAsyncJob, type AutomatedCreateResponse, type AutomatedListResponse, type AutomatedCreateParams, type AutomatedListParams } from './automated';; -export { Jobs } from './jobs';; -export { Manual, type ManualAsyncJob } from './manual';; +export { + Automated, + type AutomatedAsyncJob, + type AutomatedCreateResponse, + type AutomatedListResponse, + type AutomatedCreateParams, + type AutomatedListParams, +} from './automated'; +export { Jobs } from './jobs'; +export { Manual, type ManualAsyncJob } from './manual'; diff --git a/src/resources/jobs/jobs.ts b/src/resources/jobs/jobs.ts index 4a61a5a5..4daaed61 100644 --- a/src/resources/jobs/jobs.ts +++ b/src/resources/jobs/jobs.ts @@ -2,7 +2,14 @@ import { APIResource } from '../../core/resource'; import * as AutomatedAPI from './automated'; -import { Automated, AutomatedAsyncJob, AutomatedCreateParams, AutomatedCreateResponse, AutomatedListParams, AutomatedListResponse } from './automated'; +import { + Automated, + AutomatedAsyncJob, + AutomatedCreateParams, + AutomatedCreateResponse, + AutomatedListParams, + AutomatedListResponse, +} from './automated'; import * as ManualAPI from './manual'; import { Manual, ManualAsyncJob } from './manual'; @@ -21,11 +28,8 @@ export declare namespace Jobs { type AutomatedCreateResponse as AutomatedCreateResponse, type AutomatedListResponse as AutomatedListResponse, type AutomatedCreateParams as AutomatedCreateParams, - type AutomatedListParams as AutomatedListParams + type AutomatedListParams as AutomatedListParams, }; - export { - Manual as Manual, - type ManualAsyncJob as ManualAsyncJob - }; + export { Manual as Manual, type ManualAsyncJob as ManualAsyncJob }; } diff --git a/src/resources/jobs/manual.ts b/src/resources/jobs/manual.ts index 62120b9a..7b3ac406 100644 --- a/src/resources/jobs/manual.ts +++ b/src/resources/jobs/manual.ts @@ -11,7 +11,7 @@ export class Manual extends APIResource { * jobs including those for both automated and assisted integrations. */ retrieve(jobID: string, options?: RequestOptions): APIPromise { - return this._client.get(path`/jobs/manual/${jobID}`, { ...options, __security: { bearerAuth : true } }); + return this._client.get(path`/jobs/manual/${jobID}`, { ...options, __security: { bearerAuth: true } }); } } @@ -27,7 +27,5 @@ export interface ManualAsyncJob { } export declare namespace Manual { - export { - type ManualAsyncJob as ManualAsyncJob - }; + export { type ManualAsyncJob as ManualAsyncJob }; } diff --git a/src/resources/payroll/index.ts b/src/resources/payroll/index.ts index a3b2b637..23896339 100644 --- a/src/resources/payroll/index.ts +++ b/src/resources/payroll/index.ts @@ -1,4 +1,11 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -export { PayGroups, type PayGroupRetrieveResponse, type PayGroupListResponse, type PayGroupRetrieveParams, type PayGroupListParams, type PayGroupListResponsesSinglePage } from './pay-groups';; -export { Payroll } from './payroll';; +export { + PayGroups, + type PayGroupRetrieveResponse, + type PayGroupListResponse, + type PayGroupRetrieveParams, + type PayGroupListParams, + type PayGroupListResponsesSinglePage, +} from './pay-groups'; +export { Payroll } from './payroll'; diff --git a/src/resources/payroll/pay-groups.ts b/src/resources/payroll/pay-groups.ts index 7e833397..ca99eabc 100644 --- a/src/resources/payroll/pay-groups.ts +++ b/src/resources/payroll/pay-groups.ts @@ -10,19 +10,34 @@ export class PayGroups extends APIResource { /** * Read information from a single pay group */ - retrieve(payGroupID: string, query: PayGroupRetrieveParams | null | undefined = {}, options?: RequestOptions): APIPromise { - return this._client.get(path`/employer/pay-groups/${payGroupID}`, { query, ...options, __security: { bearerAuth : true } }); + retrieve( + payGroupID: string, + query: PayGroupRetrieveParams | null | undefined = {}, + options?: RequestOptions, + ): APIPromise { + return this._client.get(path`/employer/pay-groups/${payGroupID}`, { + query, + ...options, + __security: { bearerAuth: true }, + }); } /** * Read company pay groups and frequencies */ - list(query: PayGroupListParams | null | undefined = {}, options?: RequestOptions): PagePromise { - return this._client.getAPIList('/employer/pay-groups', SinglePage, { query, ...options, __security: { bearerAuth : true } }); + list( + query: PayGroupListParams | null | undefined = {}, + options?: RequestOptions, + ): PagePromise { + return this._client.getAPIList('/employer/pay-groups', SinglePage, { + query, + ...options, + __security: { bearerAuth: true }, + }); } } -export type PayGroupListResponsesSinglePage = SinglePage +export type PayGroupListResponsesSinglePage = SinglePage; export interface PayGroupRetrieveResponse { /** @@ -40,7 +55,17 @@ export interface PayGroupRetrieveResponse { /** * List of pay frequencies associated with this pay group */ - pay_frequencies: Array<'annually' | 'bi_weekly' | 'daily' | 'monthly' | 'other' | 'quarterly' | 'semi_annually' | 'semi_monthly' | 'weekly'>; + pay_frequencies: Array< + | 'annually' + | 'bi_weekly' + | 'daily' + | 'monthly' + | 'other' + | 'quarterly' + | 'semi_annually' + | 'semi_monthly' + | 'weekly' + >; } export interface PayGroupListResponse { @@ -57,7 +82,17 @@ export interface PayGroupListResponse { /** * List of pay frequencies associated with this pay group */ - pay_frequencies: Array<'annually' | 'bi_weekly' | 'daily' | 'monthly' | 'other' | 'quarterly' | 'semi_annually' | 'semi_monthly' | 'weekly'>; + pay_frequencies: Array< + | 'annually' + | 'bi_weekly' + | 'daily' + | 'monthly' + | 'other' + | 'quarterly' + | 'semi_annually' + | 'semi_monthly' + | 'weekly' + >; } export interface PayGroupRetrieveParams { @@ -84,6 +119,6 @@ export declare namespace PayGroups { type PayGroupListResponse as PayGroupListResponse, type PayGroupListResponsesSinglePage as PayGroupListResponsesSinglePage, type PayGroupRetrieveParams as PayGroupRetrieveParams, - type PayGroupListParams as PayGroupListParams + type PayGroupListParams as PayGroupListParams, }; } diff --git a/src/resources/payroll/payroll.ts b/src/resources/payroll/payroll.ts index 76caa341..b7ebad3a 100644 --- a/src/resources/payroll/payroll.ts +++ b/src/resources/payroll/payroll.ts @@ -2,7 +2,14 @@ import { APIResource } from '../../core/resource'; import * as PayGroupsAPI from './pay-groups'; -import { PayGroupListParams, PayGroupListResponse, PayGroupListResponsesSinglePage, PayGroupRetrieveParams, PayGroupRetrieveResponse, PayGroups } from './pay-groups'; +import { + PayGroupListParams, + PayGroupListResponse, + PayGroupListResponsesSinglePage, + PayGroupRetrieveParams, + PayGroupRetrieveResponse, + PayGroups, +} from './pay-groups'; export class Payroll extends APIResource { payGroups: PayGroupsAPI.PayGroups = new PayGroupsAPI.PayGroups(this._client); @@ -17,6 +24,6 @@ export declare namespace Payroll { type PayGroupListResponse as PayGroupListResponse, type PayGroupListResponsesSinglePage as PayGroupListResponsesSinglePage, type PayGroupRetrieveParams as PayGroupRetrieveParams, - type PayGroupListParams as PayGroupListParams + type PayGroupListParams as PayGroupListParams, }; } diff --git a/src/resources/providers.ts b/src/resources/providers.ts index 7e3d5e17..0b763a2c 100644 --- a/src/resources/providers.ts +++ b/src/resources/providers.ts @@ -9,11 +9,14 @@ export class Providers extends APIResource { * Return details on all available payroll and HR systems. */ list(options?: RequestOptions): PagePromise { - return this._client.getAPIList('/providers', SinglePage, { ...options, __security: { bearerAuth : true } }); + return this._client.getAPIList('/providers', SinglePage, { + ...options, + __security: { bearerAuth: true }, + }); } } -export type ProviderListResponsesSinglePage = SinglePage +export type ProviderListResponsesSinglePage = SinglePage; export interface Provider { /** @@ -165,6 +168,6 @@ export declare namespace Providers { export { type Provider as Provider, type ProviderListResponse as ProviderListResponse, - type ProviderListResponsesSinglePage as ProviderListResponsesSinglePage + type ProviderListResponsesSinglePage as ProviderListResponsesSinglePage, }; } diff --git a/src/resources/request-forwarding.ts b/src/resources/request-forwarding.ts index 8d2ed36a..83cb3eee 100644 --- a/src/resources/request-forwarding.ts +++ b/src/resources/request-forwarding.ts @@ -11,8 +11,11 @@ export class RequestForwarding extends APIResource { * Forward allows you to push or pull data models directly against an integration's * API. */ - forward(body: RequestForwardingForwardParams, options?: RequestOptions): APIPromise { - return this._client.post('/forward', { body, ...options, __security: { bearerAuth : true } }); + forward( + body: RequestForwardingForwardParams, + options?: RequestOptions, + ): APIPromise { + return this._client.post('/forward', { body, ...options, __security: { bearerAuth: true } }); } } @@ -114,6 +117,6 @@ export interface RequestForwardingForwardParams { export declare namespace RequestForwarding { export { type RequestForwardingForwardResponse as RequestForwardingForwardResponse, - type RequestForwardingForwardParams as RequestForwardingForwardParams + type RequestForwardingForwardParams as RequestForwardingForwardParams, }; } diff --git a/src/resources/sandbox/company.ts b/src/resources/sandbox/company.ts index baee3fa3..5e5b6abe 100644 --- a/src/resources/sandbox/company.ts +++ b/src/resources/sandbox/company.ts @@ -33,7 +33,7 @@ export class Company extends APIResource { * ``` */ update(body: CompanyUpdateParams, options?: RequestOptions): APIPromise { - return this._client.put('/sandbox/company', { body, ...options, __security: { bearerAuth : true } }); + return this._client.put('/sandbox/company', { body, ...options, __security: { bearerAuth: true } }); } } @@ -142,7 +142,15 @@ export namespace CompanyUpdateResponse { /** * The tax payer type of the company. */ - type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative' | null; + type?: + | 'llc' + | 'lp' + | 'corporation' + | 'sole_proprietor' + | 'non_profit' + | 'partnership' + | 'cooperative' + | null; } } @@ -251,13 +259,21 @@ export namespace CompanyUpdateParams { /** * The tax payer type of the company. */ - type?: 'llc' | 'lp' | 'corporation' | 'sole_proprietor' | 'non_profit' | 'partnership' | 'cooperative' | null; + type?: + | 'llc' + | 'lp' + | 'corporation' + | 'sole_proprietor' + | 'non_profit' + | 'partnership' + | 'cooperative' + | null; } } export declare namespace Company { export { type CompanyUpdateResponse as CompanyUpdateResponse, - type CompanyUpdateParams as CompanyUpdateParams + type CompanyUpdateParams as CompanyUpdateParams, }; } diff --git a/src/resources/sandbox/connections/accounts.ts b/src/resources/sandbox/connections/accounts.ts index 13bf1300..83d765d7 100644 --- a/src/resources/sandbox/connections/accounts.ts +++ b/src/resources/sandbox/connections/accounts.ts @@ -19,7 +19,11 @@ export class Accounts extends APIResource { * ``` */ create(body: AccountCreateParams, options?: RequestOptions): APIPromise { - return this._client.post('/sandbox/connections/accounts', { body, ...options, __security: { basicAuth : true } }); + return this._client.post('/sandbox/connections/accounts', { + body, + ...options, + __security: { basicAuth: true }, + }); } /** @@ -34,8 +38,15 @@ export class Accounts extends APIResource { * }); * ``` */ - update(body: AccountUpdateParams | null | undefined = {}, options?: RequestOptions): APIPromise { - return this._client.put('/sandbox/connections/accounts', { body, ...options, __security: { bearerAuth : true } }); + update( + body: AccountUpdateParams | null | undefined = {}, + options?: RequestOptions, + ): APIPromise { + return this._client.put('/sandbox/connections/accounts', { + body, + ...options, + __security: { bearerAuth: true }, + }); } } @@ -133,6 +144,6 @@ export declare namespace Accounts { type AccountCreateResponse as AccountCreateResponse, type AccountUpdateResponse as AccountUpdateResponse, type AccountCreateParams as AccountCreateParams, - type AccountUpdateParams as AccountUpdateParams + type AccountUpdateParams as AccountUpdateParams, }; } diff --git a/src/resources/sandbox/connections/connections.ts b/src/resources/sandbox/connections/connections.ts index 47a6f0d2..c338bbee 100644 --- a/src/resources/sandbox/connections/connections.ts +++ b/src/resources/sandbox/connections/connections.ts @@ -2,7 +2,13 @@ import { APIResource } from '../../../core/resource'; import * as AccountsAPI from './accounts'; -import { AccountCreateParams, AccountCreateResponse, AccountUpdateParams, AccountUpdateResponse, Accounts } from './accounts'; +import { + AccountCreateParams, + AccountCreateResponse, + AccountUpdateParams, + AccountUpdateResponse, + Accounts, +} from './accounts'; import { APIPromise } from '../../../core/api-promise'; import { RequestOptions } from '../../../internal/request-options'; @@ -20,7 +26,7 @@ export class Connections extends APIResource { * ``` */ create(body: ConnectionCreateParams, options?: RequestOptions): APIPromise { - return this._client.post('/sandbox/connections', { body, ...options, __security: { basicAuth : true } }); + return this._client.post('/sandbox/connections', { body, ...options, __security: { basicAuth: true } }); } } @@ -84,7 +90,7 @@ Connections.Accounts = Accounts; export declare namespace Connections { export { type ConnectionCreateResponse as ConnectionCreateResponse, - type ConnectionCreateParams as ConnectionCreateParams + type ConnectionCreateParams as ConnectionCreateParams, }; export { @@ -92,6 +98,6 @@ export declare namespace Connections { type AccountCreateResponse as AccountCreateResponse, type AccountUpdateResponse as AccountUpdateResponse, type AccountCreateParams as AccountCreateParams, - type AccountUpdateParams as AccountUpdateParams + type AccountUpdateParams as AccountUpdateParams, }; } diff --git a/src/resources/sandbox/connections/index.ts b/src/resources/sandbox/connections/index.ts index 0460a8e6..53b8e3d6 100644 --- a/src/resources/sandbox/connections/index.ts +++ b/src/resources/sandbox/connections/index.ts @@ -1,4 +1,10 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -export { Accounts, type AccountCreateResponse, type AccountUpdateResponse, type AccountCreateParams, type AccountUpdateParams } from './accounts';; -export { Connections, type ConnectionCreateResponse, type ConnectionCreateParams } from './connections';; +export { + Accounts, + type AccountCreateResponse, + type AccountUpdateResponse, + type AccountCreateParams, + type AccountUpdateParams, +} from './accounts'; +export { Connections, type ConnectionCreateResponse, type ConnectionCreateParams } from './connections'; diff --git a/src/resources/sandbox/directory.ts b/src/resources/sandbox/directory.ts index de8371aa..22c3fcd3 100644 --- a/src/resources/sandbox/directory.ts +++ b/src/resources/sandbox/directory.ts @@ -14,16 +14,23 @@ export class Directory extends APIResource { * const directories = await client.sandbox.directory.create(); * ``` */ - create(params: DirectoryCreateParams | null | undefined = undefined, options?: RequestOptions): APIPromise { - const { body } = params ?? {} - return this._client.post('/sandbox/directory', { body: body, ...options, __security: { bearerAuth : true } }); + create( + params: DirectoryCreateParams | null | undefined = undefined, + options?: RequestOptions, + ): APIPromise { + const { body } = params ?? {}; + return this._client.post('/sandbox/directory', { + body: body, + ...options, + __security: { bearerAuth: true }, + }); } } /** * The individuals which were created */ -export type DirectoryCreateResponse = Array +export type DirectoryCreateResponse = Array; export interface DirectoryCreateParams { /** @@ -64,7 +71,15 @@ export namespace DirectoryCreateParams { /** * The detailed employment status of the individual. */ - employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated' | null; + employment_status?: + | 'active' + | 'deceased' + | 'leave' + | 'onboarding' + | 'prehire' + | 'retired' + | 'terminated' + | null; /** * Social Security Number of the individual in **encrypted** format. This field is @@ -78,7 +93,16 @@ export namespace DirectoryCreateParams { /** * The EEOC-defined ethnicity of the individual. */ - ethnicity?: 'asian' | 'white' | 'black_or_african_american' | 'native_hawaiian_or_pacific_islander' | 'american_indian_or_alaska_native' | 'hispanic_or_latino' | 'two_or_more_races' | 'decline_to_specify' | null; + ethnicity?: + | 'asian' + | 'white' + | 'black_or_african_american' + | 'native_hawaiian_or_pacific_islander' + | 'american_indian_or_alaska_native' + | 'hispanic_or_latino' + | 'two_or_more_races' + | 'decline_to_specify' + | null; /** * The legal first name of the individual. @@ -222,6 +246,6 @@ export namespace DirectoryCreateParams { export declare namespace Directory { export { type DirectoryCreateResponse as DirectoryCreateResponse, - type DirectoryCreateParams as DirectoryCreateParams + type DirectoryCreateParams as DirectoryCreateParams, }; } diff --git a/src/resources/sandbox/employment.ts b/src/resources/sandbox/employment.ts index 94f80e7e..99a196b5 100644 --- a/src/resources/sandbox/employment.ts +++ b/src/resources/sandbox/employment.ts @@ -17,8 +17,16 @@ export class Employment extends APIResource { * ); * ``` */ - update(individualID: string, body: EmploymentUpdateParams | null | undefined = {}, options?: RequestOptions): APIPromise { - return this._client.put(path`/sandbox/employment/${individualID}`, { body, ...options, __security: { bearerAuth : true } }); + update( + individualID: string, + body: EmploymentUpdateParams | null | undefined = {}, + options?: RequestOptions, + ): APIPromise { + return this._client.put(path`/sandbox/employment/${individualID}`, { + body, + ...options, + __security: { bearerAuth: true }, + }); } } @@ -53,7 +61,15 @@ export interface EmploymentUpdateResponse { /** * The detailed employment status of the individual. */ - employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated' | null; + employment_status?: + | 'active' + | 'deceased' + | 'leave' + | 'onboarding' + | 'prehire' + | 'retired' + | 'terminated' + | null; end_date?: string | null; @@ -187,7 +203,15 @@ export interface EmploymentUpdateParams { /** * The detailed employment status of the individual. */ - employment_status?: 'active' | 'deceased' | 'leave' | 'onboarding' | 'prehire' | 'retired' | 'terminated' | null; + employment_status?: + | 'active' + | 'deceased' + | 'leave' + | 'onboarding' + | 'prehire' + | 'retired' + | 'terminated' + | null; end_date?: string | null; @@ -298,6 +322,6 @@ export namespace EmploymentUpdateParams { export declare namespace Employment { export { type EmploymentUpdateResponse as EmploymentUpdateResponse, - type EmploymentUpdateParams as EmploymentUpdateParams + type EmploymentUpdateParams as EmploymentUpdateParams, }; } diff --git a/src/resources/sandbox/index.ts b/src/resources/sandbox/index.ts index 0bb30828..ad0185c3 100644 --- a/src/resources/sandbox/index.ts +++ b/src/resources/sandbox/index.ts @@ -1,10 +1,10 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -export { Company, type CompanyUpdateResponse, type CompanyUpdateParams } from './company';; -export { Connections, type ConnectionCreateResponse, type ConnectionCreateParams } from './connections/index';; -export { Directory, type DirectoryCreateResponse, type DirectoryCreateParams } from './directory';; -export { Employment, type EmploymentUpdateResponse, type EmploymentUpdateParams } from './employment';; -export { Individual, type IndividualUpdateResponse, type IndividualUpdateParams } from './individual';; -export { Jobs, type JobCreateResponse, type JobCreateParams } from './jobs/index';; -export { Payment, type PaymentCreateResponse, type PaymentCreateParams } from './payment';; -export { Sandbox } from './sandbox';; +export { Company, type CompanyUpdateResponse, type CompanyUpdateParams } from './company'; +export { Connections, type ConnectionCreateResponse, type ConnectionCreateParams } from './connections/index'; +export { Directory, type DirectoryCreateResponse, type DirectoryCreateParams } from './directory'; +export { Employment, type EmploymentUpdateResponse, type EmploymentUpdateParams } from './employment'; +export { Individual, type IndividualUpdateResponse, type IndividualUpdateParams } from './individual'; +export { Jobs, type JobCreateResponse, type JobCreateParams } from './jobs/index'; +export { Payment, type PaymentCreateResponse, type PaymentCreateParams } from './payment'; +export { Sandbox } from './sandbox'; diff --git a/src/resources/sandbox/individual.ts b/src/resources/sandbox/individual.ts index 89c1021d..6db0f550 100644 --- a/src/resources/sandbox/individual.ts +++ b/src/resources/sandbox/individual.ts @@ -17,8 +17,16 @@ export class Individual extends APIResource { * ); * ``` */ - update(individualID: string, body: IndividualUpdateParams | null | undefined = {}, options?: RequestOptions): APIPromise { - return this._client.put(path`/sandbox/individual/${individualID}`, { body, ...options, __security: { bearerAuth : true } }); + update( + individualID: string, + body: IndividualUpdateParams | null | undefined = {}, + options?: RequestOptions, + ): APIPromise { + return this._client.put(path`/sandbox/individual/${individualID}`, { + body, + ...options, + __security: { bearerAuth: true }, + }); } } @@ -42,7 +50,16 @@ export interface IndividualUpdateResponse { /** * The EEOC-defined ethnicity of the individual. */ - ethnicity?: 'asian' | 'white' | 'black_or_african_american' | 'native_hawaiian_or_pacific_islander' | 'american_indian_or_alaska_native' | 'hispanic_or_latino' | 'two_or_more_races' | 'decline_to_specify' | null; + ethnicity?: + | 'asian' + | 'white' + | 'black_or_african_american' + | 'native_hawaiian_or_pacific_islander' + | 'american_indian_or_alaska_native' + | 'hispanic_or_latino' + | 'two_or_more_races' + | 'decline_to_specify' + | null; /** * The legal first name of the individual. @@ -111,7 +128,16 @@ export interface IndividualUpdateParams { /** * The EEOC-defined ethnicity of the individual. */ - ethnicity?: 'asian' | 'white' | 'black_or_african_american' | 'native_hawaiian_or_pacific_islander' | 'american_indian_or_alaska_native' | 'hispanic_or_latino' | 'two_or_more_races' | 'decline_to_specify' | null; + ethnicity?: + | 'asian' + | 'white' + | 'black_or_african_american' + | 'native_hawaiian_or_pacific_islander' + | 'american_indian_or_alaska_native' + | 'hispanic_or_latino' + | 'two_or_more_races' + | 'decline_to_specify' + | null; /** * The legal first name of the individual. @@ -168,6 +194,6 @@ export namespace IndividualUpdateParams { export declare namespace Individual { export { type IndividualUpdateResponse as IndividualUpdateResponse, - type IndividualUpdateParams as IndividualUpdateParams + type IndividualUpdateParams as IndividualUpdateParams, }; } diff --git a/src/resources/sandbox/jobs/configuration.ts b/src/resources/sandbox/jobs/configuration.ts index a2cc6683..75ad1d35 100644 --- a/src/resources/sandbox/jobs/configuration.ts +++ b/src/resources/sandbox/jobs/configuration.ts @@ -15,7 +15,7 @@ export class Configuration extends APIResource { * ``` */ retrieve(options?: RequestOptions): APIPromise { - return this._client.get('/sandbox/jobs/configuration', { ...options, __security: { bearerAuth : true } }); + return this._client.get('/sandbox/jobs/configuration', { ...options, __security: { bearerAuth: true } }); } /** @@ -31,7 +31,11 @@ export class Configuration extends APIResource { * ``` */ update(body: ConfigurationUpdateParams, options?: RequestOptions): APIPromise { - return this._client.put('/sandbox/jobs/configuration', { body, ...options, __security: { bearerAuth : true } }); + return this._client.put('/sandbox/jobs/configuration', { + body, + ...options, + __security: { bearerAuth: true }, + }); } } @@ -41,7 +45,7 @@ export interface SandboxJobConfiguration { type: 'data_sync_all'; } -export type ConfigurationRetrieveResponse = Array +export type ConfigurationRetrieveResponse = Array; export interface ConfigurationUpdateParams { completion_status: 'complete' | 'reauth_error' | 'permissions_error' | 'error'; @@ -53,6 +57,6 @@ export declare namespace Configuration { export { type SandboxJobConfiguration as SandboxJobConfiguration, type ConfigurationRetrieveResponse as ConfigurationRetrieveResponse, - type ConfigurationUpdateParams as ConfigurationUpdateParams + type ConfigurationUpdateParams as ConfigurationUpdateParams, }; } diff --git a/src/resources/sandbox/jobs/index.ts b/src/resources/sandbox/jobs/index.ts index 0dfeff08..6dc11796 100644 --- a/src/resources/sandbox/jobs/index.ts +++ b/src/resources/sandbox/jobs/index.ts @@ -1,4 +1,9 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -export { Configuration, type SandboxJobConfiguration, type ConfigurationRetrieveResponse, type ConfigurationUpdateParams } from './configuration';; -export { Jobs, type JobCreateResponse, type JobCreateParams } from './jobs';; +export { + Configuration, + type SandboxJobConfiguration, + type ConfigurationRetrieveResponse, + type ConfigurationUpdateParams, +} from './configuration'; +export { Jobs, type JobCreateResponse, type JobCreateParams } from './jobs'; diff --git a/src/resources/sandbox/jobs/jobs.ts b/src/resources/sandbox/jobs/jobs.ts index 7ac89807..05ea2721 100644 --- a/src/resources/sandbox/jobs/jobs.ts +++ b/src/resources/sandbox/jobs/jobs.ts @@ -2,7 +2,12 @@ import { APIResource } from '../../../core/resource'; import * as ConfigurationAPI from './configuration'; -import { Configuration, ConfigurationRetrieveResponse, ConfigurationUpdateParams, SandboxJobConfiguration } from './configuration'; +import { + Configuration, + ConfigurationRetrieveResponse, + ConfigurationUpdateParams, + SandboxJobConfiguration, +} from './configuration'; import { APIPromise } from '../../../core/api-promise'; import { RequestOptions } from '../../../internal/request-options'; @@ -20,7 +25,7 @@ export class Jobs extends APIResource { * ``` */ create(body: JobCreateParams, options?: RequestOptions): APIPromise { - return this._client.post('/sandbox/jobs', { body, ...options, __security: { bearerAuth : true } }); + return this._client.post('/sandbox/jobs', { body, ...options, __security: { bearerAuth: true } }); } } @@ -56,15 +61,12 @@ export interface JobCreateParams { Jobs.Configuration = Configuration; export declare namespace Jobs { - export { - type JobCreateResponse as JobCreateResponse, - type JobCreateParams as JobCreateParams - }; + export { type JobCreateResponse as JobCreateResponse, type JobCreateParams as JobCreateParams }; export { Configuration as Configuration, type SandboxJobConfiguration as SandboxJobConfiguration, type ConfigurationRetrieveResponse as ConfigurationRetrieveResponse, - type ConfigurationUpdateParams as ConfigurationUpdateParams + type ConfigurationUpdateParams as ConfigurationUpdateParams, }; } diff --git a/src/resources/sandbox/payment.ts b/src/resources/sandbox/payment.ts index 2bc2c066..b6aa8c2f 100644 --- a/src/resources/sandbox/payment.ts +++ b/src/resources/sandbox/payment.ts @@ -13,8 +13,11 @@ export class Payment extends APIResource { * const payment = await client.sandbox.payment.create(); * ``` */ - create(body: PaymentCreateParams | null | undefined = {}, options?: RequestOptions): APIPromise { - return this._client.post('/sandbox/payment', { body, ...options, __security: { bearerAuth : true } }); + create( + body: PaymentCreateParams | null | undefined = {}, + options?: RequestOptions, + ): APIPromise { + return this._client.post('/sandbox/payment', { body, ...options, __security: { bearerAuth: true } }); } } @@ -72,7 +75,20 @@ export namespace PaymentCreateParams { name?: string; - type?: 'bonus' | 'commission' | 'double_overtime' | 'other' | 'overtime' | 'pto' | 'reimbursement' | 'salary' | 'severance' | 'sick' | 'tips' | 'wage' | '1099'; + type?: + | 'bonus' + | 'commission' + | 'double_overtime' + | 'other' + | 'overtime' + | 'pto' + | 'reimbursement' + | 'salary' + | 'severance' + | 'sick' + | 'tips' + | 'wage' + | '1099'; } export interface EmployeeDeduction { @@ -85,7 +101,26 @@ export namespace PaymentCreateParams { pre_tax?: boolean; - type?: '457' | '401k' | '401k_roth' | '401k_loan' | '403b' | '403b_roth' | '457_roth' | 'commuter' | 'custom_post_tax' | 'custom_pre_tax' | 'fsa_dependent_care' | 'fsa_medical' | 'hsa_post' | 'hsa_pre' | 's125_dental' | 's125_medical' | 's125_vision' | 'simple' | 'simple_ira'; + type?: + | '457' + | '401k' + | '401k_roth' + | '401k_loan' + | '403b' + | '403b_roth' + | '457_roth' + | 'commuter' + | 'custom_post_tax' + | 'custom_pre_tax' + | 'fsa_dependent_care' + | 'fsa_medical' + | 'hsa_post' + | 'hsa_pre' + | 's125_dental' + | 's125_medical' + | 's125_vision' + | 'simple' + | 'simple_ira'; } export interface EmployerContribution { @@ -96,7 +131,26 @@ export namespace PaymentCreateParams { */ name?: string; - type?: '457' | '401k' | '401k_roth' | '401k_loan' | '403b' | '403b_roth' | '457_roth' | 'commuter' | 'custom_post_tax' | 'custom_pre_tax' | 'fsa_dependent_care' | 'fsa_medical' | 'hsa_post' | 'hsa_pre' | 's125_dental' | 's125_medical' | 's125_vision' | 'simple' | 'simple_ira'; + type?: + | '457' + | '401k' + | '401k_roth' + | '401k_loan' + | '403b' + | '403b_roth' + | '457_roth' + | 'commuter' + | 'custom_post_tax' + | 'custom_pre_tax' + | 'fsa_dependent_care' + | 'fsa_medical' + | 'hsa_post' + | 'hsa_pre' + | 's125_dental' + | 's125_medical' + | 's125_vision' + | 'simple' + | 'simple_ira'; } export interface Tax { @@ -114,6 +168,6 @@ export namespace PaymentCreateParams { export declare namespace Payment { export { type PaymentCreateResponse as PaymentCreateResponse, - type PaymentCreateParams as PaymentCreateParams + type PaymentCreateParams as PaymentCreateParams, }; } diff --git a/src/resources/sandbox/sandbox.ts b/src/resources/sandbox/sandbox.ts index 1db2967c..4390b7eb 100644 --- a/src/resources/sandbox/sandbox.ts +++ b/src/resources/sandbox/sandbox.ts @@ -38,42 +38,42 @@ export declare namespace Sandbox { export { Connections as Connections, type ConnectionCreateResponse as ConnectionCreateResponse, - type ConnectionCreateParams as ConnectionCreateParams + type ConnectionCreateParams as ConnectionCreateParams, }; export { Company as Company, type CompanyUpdateResponse as CompanyUpdateResponse, - type CompanyUpdateParams as CompanyUpdateParams + type CompanyUpdateParams as CompanyUpdateParams, }; export { Directory as Directory, type DirectoryCreateResponse as DirectoryCreateResponse, - type DirectoryCreateParams as DirectoryCreateParams + type DirectoryCreateParams as DirectoryCreateParams, }; export { Individual as Individual, type IndividualUpdateResponse as IndividualUpdateResponse, - type IndividualUpdateParams as IndividualUpdateParams + type IndividualUpdateParams as IndividualUpdateParams, }; export { Employment as Employment, type EmploymentUpdateResponse as EmploymentUpdateResponse, - type EmploymentUpdateParams as EmploymentUpdateParams + type EmploymentUpdateParams as EmploymentUpdateParams, }; export { Payment as Payment, type PaymentCreateResponse as PaymentCreateResponse, - type PaymentCreateParams as PaymentCreateParams + type PaymentCreateParams as PaymentCreateParams, }; export { Jobs as Jobs, type JobCreateResponse as JobCreateResponse, - type JobCreateParams as JobCreateParams + type JobCreateParams as JobCreateParams, }; } diff --git a/src/resources/shared.ts b/src/resources/shared.ts index bbae8636..a329d6a6 100644 --- a/src/resources/shared.ts +++ b/src/resources/shared.ts @@ -1,7 +1,12 @@ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. - -export type ConnectionStatusType = 'pending' | 'processing' | 'connected' | 'error_no_account_setup' | 'error_permissions' | 'reauth' +export type ConnectionStatusType = + | 'pending' + | 'processing' + | 'connected' + | 'error_no_account_setup' + | 'error_permissions' + | 'reauth'; /** * - `supported`: This operation is supported by both the provider and Finch @@ -12,7 +17,11 @@ export type ConnectionStatusType = 'pending' | 'processing' | 'connected' | 'err * - `client_access_only`: This behavior is supported by the provider, but only * available to the client and not to Finch */ -export type OperationSupport = 'supported' | 'not_supported_by_finch' | 'not_supported_by_provider' | 'client_access_only' +export type OperationSupport = + | 'supported' + | 'not_supported_by_finch' + | 'not_supported_by_provider' + | 'client_access_only'; export interface OperationSupportMatrix { /** diff --git a/src/resources/webhooks.ts b/src/resources/webhooks.ts index f4e2bded..0e4ce25c 100644 --- a/src/resources/webhooks.ts +++ b/src/resources/webhooks.ts @@ -637,7 +637,16 @@ export namespace IndividualEvent { export interface JobCompletionEvent extends BaseWebhookEvent { data?: JobCompletionEvent.Data; - event_type?: 'job.benefit_create.completed' | 'job.benefit_enroll.completed' | 'job.benefit_register.completed' | 'job.benefit_unenroll.completed' | 'job.benefit_update.completed' | 'job.data_sync_all.completed' | 'job.w4_form_employee_sync.completed' | 'job.initial_data_sync_org.succeeded' | 'job.initial_data_sync_payroll.succeeded'; + event_type?: + | 'job.benefit_create.completed' + | 'job.benefit_enroll.completed' + | 'job.benefit_register.completed' + | 'job.benefit_unenroll.completed' + | 'job.benefit_update.completed' + | 'job.data_sync_all.completed' + | 'job.w4_form_employee_sync.completed' + | 'job.initial_data_sync_org.succeeded' + | 'job.initial_data_sync_payroll.succeeded'; } export namespace JobCompletionEvent { @@ -694,7 +703,15 @@ export namespace PaymentEvent { } } -export type WebhookEvent = AccountUpdateEvent | JobCompletionEvent | CompanyEvent | DirectoryEvent | EmploymentEvent | IndividualEvent | PaymentEvent | PayStatementEvent +export type WebhookEvent = + | AccountUpdateEvent + | JobCompletionEvent + | CompanyEvent + | DirectoryEvent + | EmploymentEvent + | IndividualEvent + | PaymentEvent + | PayStatementEvent; export declare namespace Webhooks { export { @@ -707,6 +724,6 @@ export declare namespace Webhooks { type JobCompletionEvent as JobCompletionEvent, type PayStatementEvent as PayStatementEvent, type PaymentEvent as PaymentEvent, - type WebhookEvent as WebhookEvent + type WebhookEvent as WebhookEvent, }; } diff --git a/src/uploads.ts b/src/uploads.ts index d5437085..b2ef6471 100644 --- a/src/uploads.ts +++ b/src/uploads.ts @@ -1,2 +1,2 @@ /** @deprecated Import from ./core/uploads instead */ -export * from "./core/uploads" \ No newline at end of file +export * from './core/uploads'; diff --git a/src/version.ts b/src/version.ts index bf3532f1..01f3ec2a 100644 --- a/src/version.ts +++ b/src/version.ts @@ -1 +1 @@ -export const VERSION = '9.6.0';// x-release-please-version +export const VERSION = '9.6.0'; // x-release-please-version diff --git a/tests/api-resources/access-tokens.test.ts b/tests/api-resources/access-tokens.test.ts index 42c76e7c..2f11d82a 100644 --- a/tests/api-resources/access-tokens.test.ts +++ b/tests/api-resources/access-tokens.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', }); describe('resource accessTokens', () => { @@ -25,10 +25,10 @@ describe('resource accessTokens', () => { // prism doesnt like the format for the API-Version header test.skip('create: required and optional params', async () => { const response = await client.accessTokens.create({ - code: 'code', - client_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', - client_secret: 'client_secret', - redirect_uri: 'redirect_uri', - }); + code: 'code', + client_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', + client_secret: 'client_secret', + redirect_uri: 'redirect_uri', + }); }); }); diff --git a/tests/api-resources/account.test.ts b/tests/api-resources/account.test.ts index 1d67482a..2d12c264 100644 --- a/tests/api-resources/account.test.ts +++ b/tests/api-resources/account.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', }); describe('resource account', () => { diff --git a/tests/api-resources/connect/sessions.test.ts b/tests/api-resources/connect/sessions.test.ts index 89e7ada4..7f5779c2 100644 --- a/tests/api-resources/connect/sessions.test.ts +++ b/tests/api-resources/connect/sessions.test.ts @@ -6,17 +6,17 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', }); describe('resource sessions', () => { // prism tests are broken test.skip('new: only required params', async () => { const responsePromise = client.connect.sessions.new({ - customer_id: 'x', - customer_name: 'x', - products: ['benefits'], - }); + customer_id: 'x', + customer_name: 'x', + products: ['benefits'], + }); const rawResponse = await responsePromise.asResponse(); expect(rawResponse).toBeInstanceOf(Response); const response = await responsePromise; @@ -29,16 +29,16 @@ describe('resource sessions', () => { // prism tests are broken test.skip('new: required and optional params', async () => { const response = await client.connect.sessions.new({ - customer_id: 'x', - customer_name: 'x', - products: ['benefits'], - customer_email: 'dev@stainless.com', - integration: { provider: 'provider', auth_method: 'assisted' }, - manual: true, - minutes_to_expire: 1, - redirect_uri: 'redirect_uri', - sandbox: 'finch', - }); + customer_id: 'x', + customer_name: 'x', + products: ['benefits'], + customer_email: 'dev@stainless.com', + integration: { provider: 'provider', auth_method: 'assisted' }, + manual: true, + minutes_to_expire: 1, + redirect_uri: 'redirect_uri', + sandbox: 'finch', + }); }); // prism tests are broken @@ -56,10 +56,10 @@ describe('resource sessions', () => { // prism tests are broken test.skip('reauthenticate: required and optional params', async () => { const response = await client.connect.sessions.reauthenticate({ - connection_id: 'connection_id', - minutes_to_expire: 0, - products: ['benefits'], - redirect_uri: 'https://example.com', - }); + connection_id: 'connection_id', + minutes_to_expire: 0, + products: ['benefits'], + redirect_uri: 'https://example.com', + }); }); }); diff --git a/tests/api-resources/hris/benefits/benefits.test.ts b/tests/api-resources/hris/benefits/benefits.test.ts index 562fe531..d1351187 100644 --- a/tests/api-resources/hris/benefits/benefits.test.ts +++ b/tests/api-resources/hris/benefits/benefits.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', }); describe('resource benefits', () => { @@ -23,15 +23,18 @@ describe('resource benefits', () => { test('create: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect(client.hris.benefits.create({ - entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], - company_contribution: { tiers: [{ match: 1, threshold: 1 }], type: 'match' }, - description: 'description', - frequency: 'every_paycheck', - type: '457', - }, { path: '/_stainless_unknown_path' })) - .rejects - .toThrow(Finch.NotFoundError); + await expect( + client.hris.benefits.create( + { + entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], + company_contribution: { tiers: [{ match: 1, threshold: 1 }], type: 'match' }, + description: 'description', + frequency: 'every_paycheck', + type: '457', + }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(Finch.NotFoundError); }); test('retrieve', async () => { @@ -47,9 +50,13 @@ describe('resource benefits', () => { test('retrieve: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect(client.hris.benefits.retrieve('benefit_id', { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, { path: '/_stainless_unknown_path' })) - .rejects - .toThrow(Finch.NotFoundError); + await expect( + client.hris.benefits.retrieve( + 'benefit_id', + { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(Finch.NotFoundError); }); test('update', async () => { @@ -65,9 +72,13 @@ describe('resource benefits', () => { test('update: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect(client.hris.benefits.update('benefit_id', { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], description: 'description' }, { path: '/_stainless_unknown_path' })) - .rejects - .toThrow(Finch.NotFoundError); + await expect( + client.hris.benefits.update( + 'benefit_id', + { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], description: 'description' }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(Finch.NotFoundError); }); test('list', async () => { @@ -83,9 +94,12 @@ describe('resource benefits', () => { test('list: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect(client.hris.benefits.list({ entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, { path: '/_stainless_unknown_path' })) - .rejects - .toThrow(Finch.NotFoundError); + await expect( + client.hris.benefits.list( + { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(Finch.NotFoundError); }); test('listSupportedBenefits', async () => { @@ -101,8 +115,11 @@ describe('resource benefits', () => { test('listSupportedBenefits: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect(client.hris.benefits.listSupportedBenefits({ entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, { path: '/_stainless_unknown_path' })) - .rejects - .toThrow(Finch.NotFoundError); + await expect( + client.hris.benefits.listSupportedBenefits( + { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(Finch.NotFoundError); }); }); diff --git a/tests/api-resources/hris/benefits/individuals.test.ts b/tests/api-resources/hris/benefits/individuals.test.ts index d82401cb..2ad50578 100644 --- a/tests/api-resources/hris/benefits/individuals.test.ts +++ b/tests/api-resources/hris/benefits/individuals.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', }); describe('resource individuals', () => { @@ -23,23 +23,32 @@ describe('resource individuals', () => { test('enrollMany: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect(client.hris.benefits.individuals.enrollMany('benefit_id', { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], individuals: [{ - configuration: { - annual_contribution_limit: 'individual', - annual_maximum: null, - catch_up: true, - company_contribution: { - amount: 0, - tiers: [{ match: 0, threshold: 0 }], - type: 'fixed', - }, - effective_date: '2019-12-27', - employee_deduction: { amount: 10000, type: 'fixed' }, - }, - individual_id: 'd02a6346-1f08-4312-a064-49ff3cafaa7a', - }] }, { path: '/_stainless_unknown_path' })) - .rejects - .toThrow(Finch.NotFoundError); + await expect( + client.hris.benefits.individuals.enrollMany( + 'benefit_id', + { + entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], + individuals: [ + { + configuration: { + annual_contribution_limit: 'individual', + annual_maximum: null, + catch_up: true, + company_contribution: { + amount: 0, + tiers: [{ match: 0, threshold: 0 }], + type: 'fixed', + }, + effective_date: '2019-12-27', + employee_deduction: { amount: 10000, type: 'fixed' }, + }, + individual_id: 'd02a6346-1f08-4312-a064-49ff3cafaa7a', + }, + ], + }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(Finch.NotFoundError); }); test('enrolledIDs', async () => { @@ -55,9 +64,13 @@ describe('resource individuals', () => { test('enrolledIDs: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect(client.hris.benefits.individuals.enrolledIDs('benefit_id', { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, { path: '/_stainless_unknown_path' })) - .rejects - .toThrow(Finch.NotFoundError); + await expect( + client.hris.benefits.individuals.enrolledIDs( + 'benefit_id', + { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(Finch.NotFoundError); }); test('retrieveManyBenefits', async () => { @@ -73,9 +86,16 @@ describe('resource individuals', () => { test('retrieveManyBenefits: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect(client.hris.benefits.individuals.retrieveManyBenefits('benefit_id', { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], individual_ids: 'd675d2b7-6d7b-41a8-b2d3-001eb3fb88f6,d02a6346-1f08-4312-a064-49ff3cafaa7a' }, { path: '/_stainless_unknown_path' })) - .rejects - .toThrow(Finch.NotFoundError); + await expect( + client.hris.benefits.individuals.retrieveManyBenefits( + 'benefit_id', + { + entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], + individual_ids: 'd675d2b7-6d7b-41a8-b2d3-001eb3fb88f6,d02a6346-1f08-4312-a064-49ff3cafaa7a', + }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(Finch.NotFoundError); }); test('unenrollMany', async () => { @@ -91,8 +111,12 @@ describe('resource individuals', () => { test('unenrollMany: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect(client.hris.benefits.individuals.unenrollMany('benefit_id', { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], individual_ids: ['string'] }, { path: '/_stainless_unknown_path' })) - .rejects - .toThrow(Finch.NotFoundError); + await expect( + client.hris.benefits.individuals.unenrollMany( + 'benefit_id', + { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], individual_ids: ['string'] }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(Finch.NotFoundError); }); }); diff --git a/tests/api-resources/hris/company/company.test.ts b/tests/api-resources/hris/company/company.test.ts index 5420d97d..462d62c3 100644 --- a/tests/api-resources/hris/company/company.test.ts +++ b/tests/api-resources/hris/company/company.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', }); describe('resource company', () => { @@ -23,8 +23,11 @@ describe('resource company', () => { test('retrieve: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect(client.hris.company.retrieve({ entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, { path: '/_stainless_unknown_path' })) - .rejects - .toThrow(Finch.NotFoundError); + await expect( + client.hris.company.retrieve( + { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(Finch.NotFoundError); }); }); diff --git a/tests/api-resources/hris/company/pay-statement-item/pay-statement-item.test.ts b/tests/api-resources/hris/company/pay-statement-item/pay-statement-item.test.ts index 609609da..04f11a4c 100644 --- a/tests/api-resources/hris/company/pay-statement-item/pay-statement-item.test.ts +++ b/tests/api-resources/hris/company/pay-statement-item/pay-statement-item.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', }); describe('resource payStatementItem', () => { @@ -23,15 +23,18 @@ describe('resource payStatementItem', () => { test('list: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect(client.hris.company.payStatementItem.list({ - categories: ['earnings'], - end_date: '2024-07-01', - entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], - name: 'name', - start_date: '2024-01-01', - type: 'base_compensation', - }, { path: '/_stainless_unknown_path' })) - .rejects - .toThrow(Finch.NotFoundError); + await expect( + client.hris.company.payStatementItem.list( + { + categories: ['earnings'], + end_date: '2024-07-01', + entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], + name: 'name', + start_date: '2024-01-01', + type: 'base_compensation', + }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(Finch.NotFoundError); }); }); diff --git a/tests/api-resources/hris/company/pay-statement-item/rules.test.ts b/tests/api-resources/hris/company/pay-statement-item/rules.test.ts index 6ab2b16c..3c13638f 100644 --- a/tests/api-resources/hris/company/pay-statement-item/rules.test.ts +++ b/tests/api-resources/hris/company/pay-statement-item/rules.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', }); describe('resource rules', () => { @@ -23,20 +23,25 @@ describe('resource rules', () => { test('create: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect(client.hris.company.payStatementItem.rules.create({ - entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], - attributes: { metadata: { foo: 'bar' } }, - conditions: [{ - field: 'field', - operator: 'equals', - value: 'value', - }], - effective_end_date: 'effective_end_date', - effective_start_date: 'effective_start_date', - entity_type: 'pay_statement_item', - }, { path: '/_stainless_unknown_path' })) - .rejects - .toThrow(Finch.NotFoundError); + await expect( + client.hris.company.payStatementItem.rules.create( + { + entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], + attributes: { metadata: { foo: 'bar' } }, + conditions: [ + { + field: 'field', + operator: 'equals', + value: 'value', + }, + ], + effective_end_date: 'effective_end_date', + effective_start_date: 'effective_start_date', + entity_type: 'pay_statement_item', + }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(Finch.NotFoundError); }); test('update', async () => { @@ -52,12 +57,16 @@ describe('resource rules', () => { test('update: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect(client.hris.company.payStatementItem.rules.update('rule_id', { - entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], - optionalProperty: {}, - }, { path: '/_stainless_unknown_path' })) - .rejects - .toThrow(Finch.NotFoundError); + await expect( + client.hris.company.payStatementItem.rules.update( + 'rule_id', + { + entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], + optionalProperty: {}, + }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(Finch.NotFoundError); }); test('list', async () => { @@ -73,9 +82,12 @@ describe('resource rules', () => { test('list: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect(client.hris.company.payStatementItem.rules.list({ entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, { path: '/_stainless_unknown_path' })) - .rejects - .toThrow(Finch.NotFoundError); + await expect( + client.hris.company.payStatementItem.rules.list( + { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(Finch.NotFoundError); }); test('delete', async () => { @@ -91,8 +103,12 @@ describe('resource rules', () => { test('delete: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect(client.hris.company.payStatementItem.rules.delete('rule_id', { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, { path: '/_stainless_unknown_path' })) - .rejects - .toThrow(Finch.NotFoundError); + await expect( + client.hris.company.payStatementItem.rules.delete( + 'rule_id', + { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(Finch.NotFoundError); }); }); diff --git a/tests/api-resources/hris/directory.test.ts b/tests/api-resources/hris/directory.test.ts index e6474758..0990c668 100644 --- a/tests/api-resources/hris/directory.test.ts +++ b/tests/api-resources/hris/directory.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', }); describe('resource directory', () => { @@ -23,13 +23,16 @@ describe('resource directory', () => { test('list: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect(client.hris.directory.list({ - entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], - limit: 0, - offset: 0, - }, { path: '/_stainless_unknown_path' })) - .rejects - .toThrow(Finch.NotFoundError); + await expect( + client.hris.directory.list( + { + entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], + limit: 0, + offset: 0, + }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(Finch.NotFoundError); }); test('listIndividuals', async () => { @@ -45,12 +48,15 @@ describe('resource directory', () => { test('listIndividuals: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect(client.hris.directory.listIndividuals({ - entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], - limit: 0, - offset: 0, - }, { path: '/_stainless_unknown_path' })) - .rejects - .toThrow(Finch.NotFoundError); + await expect( + client.hris.directory.listIndividuals( + { + entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], + limit: 0, + offset: 0, + }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(Finch.NotFoundError); }); }); diff --git a/tests/api-resources/hris/documents.test.ts b/tests/api-resources/hris/documents.test.ts index 1cad23a7..ade4b651 100644 --- a/tests/api-resources/hris/documents.test.ts +++ b/tests/api-resources/hris/documents.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', }); describe('resource documents', () => { @@ -23,15 +23,18 @@ describe('resource documents', () => { test('list: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect(client.hris.documents.list({ - entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], - individual_ids: ['string'], - limit: 0, - offset: 0, - types: ['w4_2020'], - }, { path: '/_stainless_unknown_path' })) - .rejects - .toThrow(Finch.NotFoundError); + await expect( + client.hris.documents.list( + { + entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], + individual_ids: ['string'], + limit: 0, + offset: 0, + types: ['w4_2020'], + }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(Finch.NotFoundError); }); test('retreive', async () => { @@ -47,8 +50,12 @@ describe('resource documents', () => { test('retreive: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect(client.hris.documents.retreive('document_id', { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, { path: '/_stainless_unknown_path' })) - .rejects - .toThrow(Finch.NotFoundError); + await expect( + client.hris.documents.retreive( + 'document_id', + { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(Finch.NotFoundError); }); }); diff --git a/tests/api-resources/hris/employments.test.ts b/tests/api-resources/hris/employments.test.ts index db9fe870..5d33a634 100644 --- a/tests/api-resources/hris/employments.test.ts +++ b/tests/api-resources/hris/employments.test.ts @@ -6,12 +6,14 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', }); describe('resource employments', () => { test('retrieveMany: only required params', async () => { - const responsePromise = client.hris.employments.retrieveMany({ requests: [{ individual_id: 'individual_id' }] }); + const responsePromise = client.hris.employments.retrieveMany({ + requests: [{ individual_id: 'individual_id' }], + }); const rawResponse = await responsePromise.asResponse(); expect(rawResponse).toBeInstanceOf(Response); const response = await responsePromise; @@ -22,6 +24,9 @@ describe('resource employments', () => { }); test('retrieveMany: required and optional params', async () => { - const response = await client.hris.employments.retrieveMany({ requests: [{ individual_id: 'individual_id' }], entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }); + const response = await client.hris.employments.retrieveMany({ + requests: [{ individual_id: 'individual_id' }], + entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], + }); }); }); diff --git a/tests/api-resources/hris/individuals.test.ts b/tests/api-resources/hris/individuals.test.ts index a940db1e..ff4c0d35 100644 --- a/tests/api-resources/hris/individuals.test.ts +++ b/tests/api-resources/hris/individuals.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', }); describe('resource individuals', () => { @@ -23,12 +23,15 @@ describe('resource individuals', () => { test('retrieveMany: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect(client.hris.individuals.retrieveMany({ - entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], - options: { include: ['string'] }, - requests: [{ individual_id: 'individual_id' }], - }, { path: '/_stainless_unknown_path' })) - .rejects - .toThrow(Finch.NotFoundError); + await expect( + client.hris.individuals.retrieveMany( + { + entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], + options: { include: ['string'] }, + requests: [{ individual_id: 'individual_id' }], + }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(Finch.NotFoundError); }); }); diff --git a/tests/api-resources/hris/pay-statements.test.ts b/tests/api-resources/hris/pay-statements.test.ts index fa64f228..47198b3b 100644 --- a/tests/api-resources/hris/pay-statements.test.ts +++ b/tests/api-resources/hris/pay-statements.test.ts @@ -6,12 +6,14 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', }); describe('resource payStatements', () => { test('retrieveMany: only required params', async () => { - const responsePromise = client.hris.payStatements.retrieveMany({ requests: [{ payment_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }] }); + const responsePromise = client.hris.payStatements.retrieveMany({ + requests: [{ payment_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }], + }); const rawResponse = await responsePromise.asResponse(); expect(rawResponse).toBeInstanceOf(Response); const response = await responsePromise; @@ -22,10 +24,15 @@ describe('resource payStatements', () => { }); test('retrieveMany: required and optional params', async () => { - const response = await client.hris.payStatements.retrieveMany({ requests: [{ - payment_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', - limit: 50, - offset: 0, - }], entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }); + const response = await client.hris.payStatements.retrieveMany({ + requests: [ + { + payment_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', + limit: 50, + offset: 0, + }, + ], + entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], + }); }); }); diff --git a/tests/api-resources/hris/payments.test.ts b/tests/api-resources/hris/payments.test.ts index d166bda6..c6875591 100644 --- a/tests/api-resources/hris/payments.test.ts +++ b/tests/api-resources/hris/payments.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', }); describe('resource payments', () => { @@ -23,9 +23,9 @@ describe('resource payments', () => { test('list: required and optional params', async () => { const response = await client.hris.payments.list({ - end_date: '2021-01-01', - start_date: '2021-01-01', - entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], - }); + end_date: '2021-01-01', + start_date: '2021-01-01', + entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], + }); }); }); diff --git a/tests/api-resources/jobs/automated.test.ts b/tests/api-resources/jobs/automated.test.ts index f0341002..47f86079 100644 --- a/tests/api-resources/jobs/automated.test.ts +++ b/tests/api-resources/jobs/automated.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', }); describe('resource automated', () => { @@ -49,8 +49,8 @@ describe('resource automated', () => { test('list: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect(client.jobs.automated.list({ limit: 0, offset: 0 }, { path: '/_stainless_unknown_path' })) - .rejects - .toThrow(Finch.NotFoundError); + await expect( + client.jobs.automated.list({ limit: 0, offset: 0 }, { path: '/_stainless_unknown_path' }), + ).rejects.toThrow(Finch.NotFoundError); }); }); diff --git a/tests/api-resources/jobs/manual.test.ts b/tests/api-resources/jobs/manual.test.ts index c3d0e5f2..84d7e814 100644 --- a/tests/api-resources/jobs/manual.test.ts +++ b/tests/api-resources/jobs/manual.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', }); describe('resource manual', () => { diff --git a/tests/api-resources/payroll/pay-groups.test.ts b/tests/api-resources/payroll/pay-groups.test.ts index dbc616c0..0e365f3b 100644 --- a/tests/api-resources/payroll/pay-groups.test.ts +++ b/tests/api-resources/payroll/pay-groups.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', }); describe('resource payGroups', () => { @@ -23,9 +23,13 @@ describe('resource payGroups', () => { test('retrieve: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect(client.payroll.payGroups.retrieve('pay_group_id', { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, { path: '/_stainless_unknown_path' })) - .rejects - .toThrow(Finch.NotFoundError); + await expect( + client.payroll.payGroups.retrieve( + 'pay_group_id', + { entity_ids: ['550e8400-e29b-41d4-a716-446655440000'] }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(Finch.NotFoundError); }); test('list', async () => { @@ -41,12 +45,15 @@ describe('resource payGroups', () => { test('list: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect(client.payroll.payGroups.list({ - entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], - individual_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', - pay_frequencies: ['string'], - }, { path: '/_stainless_unknown_path' })) - .rejects - .toThrow(Finch.NotFoundError); + await expect( + client.payroll.payGroups.list( + { + entity_ids: ['550e8400-e29b-41d4-a716-446655440000'], + individual_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', + pay_frequencies: ['string'], + }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(Finch.NotFoundError); }); }); diff --git a/tests/api-resources/providers.test.ts b/tests/api-resources/providers.test.ts index adbaa732..71714371 100644 --- a/tests/api-resources/providers.test.ts +++ b/tests/api-resources/providers.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', }); describe('resource providers', () => { diff --git a/tests/api-resources/request-forwarding.test.ts b/tests/api-resources/request-forwarding.test.ts index 1697a27a..d39e70b6 100644 --- a/tests/api-resources/request-forwarding.test.ts +++ b/tests/api-resources/request-forwarding.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', }); describe('resource requestForwarding', () => { @@ -23,11 +23,11 @@ describe('resource requestForwarding', () => { test('forward: required and optional params', async () => { const response = await client.requestForwarding.forward({ - method: 'method', - route: 'route', - data: 'data', - params: { foo: 'bar' }, - request_headers: { foo: 'bar' }, - }); + method: 'method', + route: 'route', + data: 'data', + params: { foo: 'bar' }, + request_headers: { foo: 'bar' }, + }); }); }); diff --git a/tests/api-resources/sandbox/company.test.ts b/tests/api-resources/sandbox/company.test.ts index 14e5f966..bc620167 100644 --- a/tests/api-resources/sandbox/company.test.ts +++ b/tests/api-resources/sandbox/company.test.ts @@ -6,28 +6,30 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', }); describe('resource company', () => { test('update: only required params', async () => { const responsePromise = client.sandbox.company.update({ - accounts: [{}], - departments: [{}], - ein: 'ein', - entity: {}, - legal_name: 'legal_name', - locations: [{ - city: 'city', - country: 'country', - line1: 'line1', - line2: 'line2', - postal_code: 'postal_code', - state: 'state', - }], - primary_email: 'dev@stainless.com', - primary_phone_number: 'primary_phone_number', - }); + accounts: [{}], + departments: [{}], + ein: 'ein', + entity: {}, + legal_name: 'legal_name', + locations: [ + { + city: 'city', + country: 'country', + line1: 'line1', + line2: 'line2', + postal_code: 'postal_code', + state: 'state', + }, + ], + primary_email: 'dev@stainless.com', + primary_phone_number: 'primary_phone_number', + }); const rawResponse = await responsePromise.asResponse(); expect(rawResponse).toBeInstanceOf(Response); const response = await responsePromise; @@ -39,32 +41,38 @@ describe('resource company', () => { test('update: required and optional params', async () => { const response = await client.sandbox.company.update({ - accounts: [{ - account_name: 'account_name', - account_number: 'account_number', - account_type: 'checking', - institution_name: 'institution_name', - routing_number: 'routing_number', - }], - departments: [{ - name: 'name', - parent: { name: 'name' }, - }], - ein: 'ein', - entity: { subtype: 's_corporation', type: 'llc' }, - legal_name: 'legal_name', - locations: [{ - city: 'city', - country: 'country', - line1: 'line1', - line2: 'line2', - postal_code: 'postal_code', - state: 'state', - name: 'name', - source_id: 'source_id', - }], - primary_email: 'dev@stainless.com', - primary_phone_number: 'primary_phone_number', - }); + accounts: [ + { + account_name: 'account_name', + account_number: 'account_number', + account_type: 'checking', + institution_name: 'institution_name', + routing_number: 'routing_number', + }, + ], + departments: [ + { + name: 'name', + parent: { name: 'name' }, + }, + ], + ein: 'ein', + entity: { subtype: 's_corporation', type: 'llc' }, + legal_name: 'legal_name', + locations: [ + { + city: 'city', + country: 'country', + line1: 'line1', + line2: 'line2', + postal_code: 'postal_code', + state: 'state', + name: 'name', + source_id: 'source_id', + }, + ], + primary_email: 'dev@stainless.com', + primary_phone_number: 'primary_phone_number', + }); }); }); diff --git a/tests/api-resources/sandbox/connections/accounts.test.ts b/tests/api-resources/sandbox/connections/accounts.test.ts index 4eaef486..6291ad89 100644 --- a/tests/api-resources/sandbox/connections/accounts.test.ts +++ b/tests/api-resources/sandbox/connections/accounts.test.ts @@ -6,13 +6,16 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', }); describe('resource accounts', () => { // prism tests are broken test.skip('create: only required params', async () => { - const responsePromise = client.sandbox.connections.accounts.create({ company_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', provider_id: 'provider_id' }); + const responsePromise = client.sandbox.connections.accounts.create({ + company_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', + provider_id: 'provider_id', + }); const rawResponse = await responsePromise.asResponse(); expect(rawResponse).toBeInstanceOf(Response); const response = await responsePromise; @@ -25,11 +28,11 @@ describe('resource accounts', () => { // prism tests are broken test.skip('create: required and optional params', async () => { const response = await client.sandbox.connections.accounts.create({ - company_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', - provider_id: 'provider_id', - authentication_type: 'credential', - products: ['string'], - }); + company_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', + provider_id: 'provider_id', + authentication_type: 'credential', + products: ['string'], + }); }); test('update', async () => { @@ -45,8 +48,11 @@ describe('resource accounts', () => { test('update: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect(client.sandbox.connections.accounts.update({ connection_status: 'reauth' }, { path: '/_stainless_unknown_path' })) - .rejects - .toThrow(Finch.NotFoundError); + await expect( + client.sandbox.connections.accounts.update( + { connection_status: 'reauth' }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(Finch.NotFoundError); }); }); diff --git a/tests/api-resources/sandbox/connections/connections.test.ts b/tests/api-resources/sandbox/connections/connections.test.ts index ada91f27..029a80f8 100644 --- a/tests/api-resources/sandbox/connections/connections.test.ts +++ b/tests/api-resources/sandbox/connections/connections.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', }); describe('resource connections', () => { @@ -25,10 +25,10 @@ describe('resource connections', () => { // prism tests are broken test.skip('create: required and optional params', async () => { const response = await client.sandbox.connections.create({ - provider_id: 'provider_id', - authentication_type: 'credential', - employee_size: 0, - products: ['string'], - }); + provider_id: 'provider_id', + authentication_type: 'credential', + employee_size: 0, + products: ['string'], + }); }); }); diff --git a/tests/api-resources/sandbox/directory.test.ts b/tests/api-resources/sandbox/directory.test.ts index 1a785c36..b2fdecf2 100644 --- a/tests/api-resources/sandbox/directory.test.ts +++ b/tests/api-resources/sandbox/directory.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', }); describe('resource directory', () => { @@ -23,68 +23,79 @@ describe('resource directory', () => { test('create: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect(client.sandbox.directory.create({ body: [{ - class_code: 'class_code', - custom_fields: [{ - name: 'name', - value: {}, - }], - department: { name: 'name' }, - dob: 'dob', - emails: [{ data: 'data', type: 'work' }], - employment: { subtype: 'full_time', type: 'employee' }, - employment_status: 'active', - encrypted_ssn: 'encrypted_ssn', - end_date: 'end_date', - ethnicity: 'asian', - first_name: 'first_name', - flsa_status: 'exempt', - gender: 'female', - income: { - amount: 0, - currency: 'currency', - effective_date: '2019-12-27', - unit: 'yearly', - }, - income_history: [{ - amount: 0, - currency: 'currency', - effective_date: '2019-12-27', - unit: 'yearly', - }], - is_active: true, - last_name: 'last_name', - latest_rehire_date: 'latest_rehire_date', - location: { - city: 'city', - country: 'country', - line1: 'line1', - line2: 'line2', - postal_code: 'postal_code', - state: 'state', - name: 'name', - source_id: 'source_id', - }, - manager: { id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }, - middle_name: 'middle_name', - phone_numbers: [{ data: 'data', type: 'work' }], - preferred_name: 'preferred_name', - residence: { - city: 'city', - country: 'country', - line1: 'line1', - line2: 'line2', - postal_code: 'postal_code', - state: 'state', - name: 'name', - source_id: 'source_id', - }, - source_id: 'source_id', - ssn: 'ssn', - start_date: 'start_date', - title: 'title', - }] }, { path: '/_stainless_unknown_path' })) - .rejects - .toThrow(Finch.NotFoundError); + await expect( + client.sandbox.directory.create( + { + body: [ + { + class_code: 'class_code', + custom_fields: [ + { + name: 'name', + value: {}, + }, + ], + department: { name: 'name' }, + dob: 'dob', + emails: [{ data: 'data', type: 'work' }], + employment: { subtype: 'full_time', type: 'employee' }, + employment_status: 'active', + encrypted_ssn: 'encrypted_ssn', + end_date: 'end_date', + ethnicity: 'asian', + first_name: 'first_name', + flsa_status: 'exempt', + gender: 'female', + income: { + amount: 0, + currency: 'currency', + effective_date: '2019-12-27', + unit: 'yearly', + }, + income_history: [ + { + amount: 0, + currency: 'currency', + effective_date: '2019-12-27', + unit: 'yearly', + }, + ], + is_active: true, + last_name: 'last_name', + latest_rehire_date: 'latest_rehire_date', + location: { + city: 'city', + country: 'country', + line1: 'line1', + line2: 'line2', + postal_code: 'postal_code', + state: 'state', + name: 'name', + source_id: 'source_id', + }, + manager: { id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }, + middle_name: 'middle_name', + phone_numbers: [{ data: 'data', type: 'work' }], + preferred_name: 'preferred_name', + residence: { + city: 'city', + country: 'country', + line1: 'line1', + line2: 'line2', + postal_code: 'postal_code', + state: 'state', + name: 'name', + source_id: 'source_id', + }, + source_id: 'source_id', + ssn: 'ssn', + start_date: 'start_date', + title: 'title', + }, + ], + }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(Finch.NotFoundError); }); }); diff --git a/tests/api-resources/sandbox/employment.test.ts b/tests/api-resources/sandbox/employment.test.ts index 2c48f52f..afe83df9 100644 --- a/tests/api-resources/sandbox/employment.test.ts +++ b/tests/api-resources/sandbox/employment.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', }); describe('resource employment', () => { @@ -23,50 +23,58 @@ describe('resource employment', () => { test('update: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect(client.sandbox.employment.update('individual_id', { - class_code: 'class_code', - custom_fields: [{ - name: 'name', - value: {}, - }], - department: { name: 'name' }, - employment: { subtype: 'full_time', type: 'employee' }, - employment_status: 'active', - end_date: 'end_date', - first_name: 'first_name', - flsa_status: 'exempt', - income: { - amount: 0, - currency: 'currency', - effective_date: '2019-12-27', - unit: 'yearly', - }, - income_history: [{ - amount: 0, - currency: 'currency', - effective_date: '2019-12-27', - unit: 'yearly', - }], - is_active: true, - last_name: 'last_name', - latest_rehire_date: 'latest_rehire_date', - location: { - city: 'city', - country: 'country', - line1: 'line1', - line2: 'line2', - postal_code: 'postal_code', - state: 'state', - name: 'name', - source_id: 'source_id', - }, - manager: { id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }, - middle_name: 'middle_name', - source_id: 'source_id', - start_date: 'start_date', - title: 'title', - }, { path: '/_stainless_unknown_path' })) - .rejects - .toThrow(Finch.NotFoundError); + await expect( + client.sandbox.employment.update( + 'individual_id', + { + class_code: 'class_code', + custom_fields: [ + { + name: 'name', + value: {}, + }, + ], + department: { name: 'name' }, + employment: { subtype: 'full_time', type: 'employee' }, + employment_status: 'active', + end_date: 'end_date', + first_name: 'first_name', + flsa_status: 'exempt', + income: { + amount: 0, + currency: 'currency', + effective_date: '2019-12-27', + unit: 'yearly', + }, + income_history: [ + { + amount: 0, + currency: 'currency', + effective_date: '2019-12-27', + unit: 'yearly', + }, + ], + is_active: true, + last_name: 'last_name', + latest_rehire_date: 'latest_rehire_date', + location: { + city: 'city', + country: 'country', + line1: 'line1', + line2: 'line2', + postal_code: 'postal_code', + state: 'state', + name: 'name', + source_id: 'source_id', + }, + manager: { id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' }, + middle_name: 'middle_name', + source_id: 'source_id', + start_date: 'start_date', + title: 'title', + }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(Finch.NotFoundError); }); }); diff --git a/tests/api-resources/sandbox/individual.test.ts b/tests/api-resources/sandbox/individual.test.ts index 36c773b0..2f3a18e0 100644 --- a/tests/api-resources/sandbox/individual.test.ts +++ b/tests/api-resources/sandbox/individual.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', }); describe('resource individual', () => { @@ -23,30 +23,34 @@ describe('resource individual', () => { test('update: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect(client.sandbox.individual.update('individual_id', { - dob: 'dob', - emails: [{ data: 'data', type: 'work' }], - encrypted_ssn: 'encrypted_ssn', - ethnicity: 'asian', - first_name: 'first_name', - gender: 'female', - last_name: 'last_name', - middle_name: 'middle_name', - phone_numbers: [{ data: 'data', type: 'work' }], - preferred_name: 'preferred_name', - residence: { - city: 'city', - country: 'country', - line1: 'line1', - line2: 'line2', - postal_code: 'postal_code', - state: 'state', - name: 'name', - source_id: 'source_id', - }, - ssn: 'ssn', - }, { path: '/_stainless_unknown_path' })) - .rejects - .toThrow(Finch.NotFoundError); + await expect( + client.sandbox.individual.update( + 'individual_id', + { + dob: 'dob', + emails: [{ data: 'data', type: 'work' }], + encrypted_ssn: 'encrypted_ssn', + ethnicity: 'asian', + first_name: 'first_name', + gender: 'female', + last_name: 'last_name', + middle_name: 'middle_name', + phone_numbers: [{ data: 'data', type: 'work' }], + preferred_name: 'preferred_name', + residence: { + city: 'city', + country: 'country', + line1: 'line1', + line2: 'line2', + postal_code: 'postal_code', + state: 'state', + name: 'name', + source_id: 'source_id', + }, + ssn: 'ssn', + }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(Finch.NotFoundError); }); }); diff --git a/tests/api-resources/sandbox/jobs/configuration.test.ts b/tests/api-resources/sandbox/jobs/configuration.test.ts index 994c98bf..de15bc00 100644 --- a/tests/api-resources/sandbox/jobs/configuration.test.ts +++ b/tests/api-resources/sandbox/jobs/configuration.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', }); describe('resource configuration', () => { @@ -22,7 +22,10 @@ describe('resource configuration', () => { }); test('update: only required params', async () => { - const responsePromise = client.sandbox.jobs.configuration.update({ completion_status: 'complete', type: 'data_sync_all' }); + const responsePromise = client.sandbox.jobs.configuration.update({ + completion_status: 'complete', + type: 'data_sync_all', + }); const rawResponse = await responsePromise.asResponse(); expect(rawResponse).toBeInstanceOf(Response); const response = await responsePromise; @@ -33,6 +36,9 @@ describe('resource configuration', () => { }); test('update: required and optional params', async () => { - const response = await client.sandbox.jobs.configuration.update({ completion_status: 'complete', type: 'data_sync_all' }); + const response = await client.sandbox.jobs.configuration.update({ + completion_status: 'complete', + type: 'data_sync_all', + }); }); }); diff --git a/tests/api-resources/sandbox/jobs/jobs.test.ts b/tests/api-resources/sandbox/jobs/jobs.test.ts index a0abf8b7..5ab4ceda 100644 --- a/tests/api-resources/sandbox/jobs/jobs.test.ts +++ b/tests/api-resources/sandbox/jobs/jobs.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', }); describe('resource jobs', () => { diff --git a/tests/api-resources/sandbox/payment.test.ts b/tests/api-resources/sandbox/payment.test.ts index d1202eb1..a5918dfa 100644 --- a/tests/api-resources/sandbox/payment.test.ts +++ b/tests/api-resources/sandbox/payment.test.ts @@ -6,7 +6,7 @@ const client = new Finch({ accessToken: 'My Access Token', clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', clientSecret: 'My Client Secret', - baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', }); describe('resource payment', () => { @@ -23,42 +23,55 @@ describe('resource payment', () => { test('create: request options and params are passed correctly', async () => { // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error - await expect(client.sandbox.payment.create({ - end_date: '2019-12-27', - pay_statements: [{ - individual_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', - earnings: [{ - amount: 0, - hours: 0, - name: 'x', - type: 'bonus', - }], - employee_deductions: [{ - amount: 0, - name: 'x', - pre_tax: true, - type: '457', - }], - employer_contributions: [{ - amount: 0, - name: 'x', - type: '457', - }], - gross_pay: 1, - net_pay: 9007199254740991, - payment_method: 'check', - taxes: [{ - amount: 0, - employer: true, - name: 'x', - type: 'federal', - }], - total_hours: 1, - type: 'off_cycle_payroll', - }], - start_date: '2019-12-27', - }, { path: '/_stainless_unknown_path' })) - .rejects - .toThrow(Finch.NotFoundError); + await expect( + client.sandbox.payment.create( + { + end_date: '2019-12-27', + pay_statements: [ + { + individual_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', + earnings: [ + { + amount: 0, + hours: 0, + name: 'x', + type: 'bonus', + }, + ], + employee_deductions: [ + { + amount: 0, + name: 'x', + pre_tax: true, + type: '457', + }, + ], + employer_contributions: [ + { + amount: 0, + name: 'x', + type: '457', + }, + ], + gross_pay: 1, + net_pay: 9007199254740991, + payment_method: 'check', + taxes: [ + { + amount: 0, + employer: true, + name: 'x', + type: 'federal', + }, + ], + total_hours: 1, + type: 'off_cycle_payroll', + }, + ], + start_date: '2019-12-27', + }, + { path: '/_stainless_unknown_path' }, + ), + ).rejects.toThrow(Finch.NotFoundError); }); }); diff --git a/tests/index.test.ts b/tests/index.test.ts index 02b4d743..3ef75699 100644 --- a/tests/index.test.ts +++ b/tests/index.test.ts @@ -21,12 +21,12 @@ describe('instantiate client', () => { describe('defaultHeaders', () => { const client = new Finch({ - baseURL: 'http://localhost:5000/', - defaultHeaders: { 'X-My-Default-Header': '2' }, - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', -}) + baseURL: 'http://localhost:5000/', + defaultHeaders: { 'X-My-Default-Header': '2' }, + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); test('they are used in the request', async () => { const { req } = await client.buildRequest({ path: '/foo', method: 'post' }); @@ -51,221 +51,223 @@ describe('instantiate client', () => { expect(req.headers.has('x-my-default-header')).toBe(false); }); }); -describe('logging', () => { - const env = process.env; + describe('logging', () => { + const env = process.env; - beforeEach(() => { - process.env = { ...env }; - process.env['FINCH_LOG'] = undefined; - }); + beforeEach(() => { + process.env = { ...env }; + process.env['FINCH_LOG'] = undefined; + }); - afterEach(() => { - process.env = env; - }); + afterEach(() => { + process.env = env; + }); - const forceAPIResponseForClient = async (client: Finch) => { - await new APIPromise( - client, - Promise.resolve({ - response: new Response(), - controller: new AbortController(), - requestLogID: 'log_000000', - retryOfRequestLogID: undefined, - startTime: Date.now(), - options: { - method: 'get', - path: '/', - }, - }), - ); - }; - - test('debug logs when log level is debug', async () => { - const debugMock = jest.fn(); - const logger = { - debug: debugMock, - info: jest.fn(), - warn: jest.fn(), - error: jest.fn(), + const forceAPIResponseForClient = async (client: Finch) => { + await new APIPromise( + client, + Promise.resolve({ + response: new Response(), + controller: new AbortController(), + requestLogID: 'log_000000', + retryOfRequestLogID: undefined, + startTime: Date.now(), + options: { + method: 'get', + path: '/', + }, + }), + ); }; - const client = new Finch({ - logger: logger, - logLevel: 'debug', - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', -}); + test('debug logs when log level is debug', async () => { + const debugMock = jest.fn(); + const logger = { + debug: debugMock, + info: jest.fn(), + warn: jest.fn(), + error: jest.fn(), + }; - await forceAPIResponseForClient(client); - expect(debugMock).toHaveBeenCalled(); - }); + const client = new Finch({ + logger: logger, + logLevel: 'debug', + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); - test('default logLevel is warn', async () => { - const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', -}); - expect(client.logLevel).toBe('warn'); - }); + await forceAPIResponseForClient(client); + expect(debugMock).toHaveBeenCalled(); + }); - test('debug logs are skipped when log level is info', async () => { - const debugMock = jest.fn(); - const logger = { - debug: debugMock, - info: jest.fn(), - warn: jest.fn(), - error: jest.fn(), - }; + test('default logLevel is warn', async () => { + const client = new Finch({ + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); + expect(client.logLevel).toBe('warn'); + }); - const client = new Finch({ - logger: logger, - logLevel: 'info', - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', -}); + test('debug logs are skipped when log level is info', async () => { + const debugMock = jest.fn(); + const logger = { + debug: debugMock, + info: jest.fn(), + warn: jest.fn(), + error: jest.fn(), + }; - await forceAPIResponseForClient(client); - expect(debugMock).not.toHaveBeenCalled(); - }); + const client = new Finch({ + logger: logger, + logLevel: 'info', + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); - test('debug logs happen with debug env var', async () => { - const debugMock = jest.fn(); - const logger = { - debug: debugMock, - info: jest.fn(), - warn: jest.fn(), - error: jest.fn(), - }; + await forceAPIResponseForClient(client); + expect(debugMock).not.toHaveBeenCalled(); + }); - process.env['FINCH_LOG'] = 'debug'; - const client = new Finch({ - logger: logger, - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', -}); - expect(client.logLevel).toBe('debug'); + test('debug logs happen with debug env var', async () => { + const debugMock = jest.fn(); + const logger = { + debug: debugMock, + info: jest.fn(), + warn: jest.fn(), + error: jest.fn(), + }; - await forceAPIResponseForClient(client); - expect(debugMock).toHaveBeenCalled(); - }); + process.env['FINCH_LOG'] = 'debug'; + const client = new Finch({ + logger: logger, + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); + expect(client.logLevel).toBe('debug'); - test('warn when env var level is invalid', async () => { - const warnMock = jest.fn(); - const logger = { - debug: jest.fn(), - info: jest.fn(), - warn: warnMock, - error: jest.fn(), - }; + await forceAPIResponseForClient(client); + expect(debugMock).toHaveBeenCalled(); + }); - process.env['FINCH_LOG'] = 'not a log level'; - const client = new Finch({ - logger: logger, - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', -}); - expect(client.logLevel).toBe('warn'); - expect(warnMock).toHaveBeenCalledWith('process.env[\'FINCH_LOG\'] was set to "not a log level", expected one of ["off","error","warn","info","debug"]'); - }); + test('warn when env var level is invalid', async () => { + const warnMock = jest.fn(); + const logger = { + debug: jest.fn(), + info: jest.fn(), + warn: warnMock, + error: jest.fn(), + }; - test('client log level overrides env var', async () => { - const debugMock = jest.fn(); - const logger = { - debug: debugMock, - info: jest.fn(), - warn: jest.fn(), - error: jest.fn(), - }; + process.env['FINCH_LOG'] = 'not a log level'; + const client = new Finch({ + logger: logger, + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); + expect(client.logLevel).toBe('warn'); + expect(warnMock).toHaveBeenCalledWith( + 'process.env[\'FINCH_LOG\'] was set to "not a log level", expected one of ["off","error","warn","info","debug"]', + ); + }); - process.env['FINCH_LOG'] = 'debug'; - const client = new Finch({ - logger: logger, - logLevel: 'off', - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', -}); + test('client log level overrides env var', async () => { + const debugMock = jest.fn(); + const logger = { + debug: debugMock, + info: jest.fn(), + warn: jest.fn(), + error: jest.fn(), + }; - await forceAPIResponseForClient(client); - expect(debugMock).not.toHaveBeenCalled(); - }); + process.env['FINCH_LOG'] = 'debug'; + const client = new Finch({ + logger: logger, + logLevel: 'off', + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); - test('no warning logged for invalid env var level + valid client level', async () => { - const warnMock = jest.fn(); - const logger = { - debug: jest.fn(), - info: jest.fn(), - warn: warnMock, - error: jest.fn(), - }; + await forceAPIResponseForClient(client); + expect(debugMock).not.toHaveBeenCalled(); + }); - process.env['FINCH_LOG'] = 'not a log level'; - const client = new Finch({ - logger: logger, - logLevel: 'debug', - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', -}); - expect(client.logLevel).toBe('debug'); - expect(warnMock).not.toHaveBeenCalled(); + test('no warning logged for invalid env var level + valid client level', async () => { + const warnMock = jest.fn(); + const logger = { + debug: jest.fn(), + info: jest.fn(), + warn: warnMock, + error: jest.fn(), + }; + + process.env['FINCH_LOG'] = 'not a log level'; + const client = new Finch({ + logger: logger, + logLevel: 'debug', + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); + expect(client.logLevel).toBe('debug'); + expect(warnMock).not.toHaveBeenCalled(); + }); }); -}); describe('defaultQuery', () => { test('with null query params given', () => { const client = new Finch({ - baseURL: 'http://localhost:5000/', - defaultQuery: { apiVersion: 'foo' }, - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', -}); + baseURL: 'http://localhost:5000/', + defaultQuery: { apiVersion: 'foo' }, + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); expect(client.buildURL('/foo', null)).toEqual('http://localhost:5000/foo?apiVersion=foo'); }); test('multiple default query params', () => { const client = new Finch({ - baseURL: 'http://localhost:5000/', - defaultQuery: { apiVersion: 'foo', hello: 'world' }, - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', -}); + baseURL: 'http://localhost:5000/', + defaultQuery: { apiVersion: 'foo', hello: 'world' }, + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); expect(client.buildURL('/foo', null)).toEqual('http://localhost:5000/foo?apiVersion=foo&hello=world'); }); test('overriding with `undefined`', () => { const client = new Finch({ - baseURL: 'http://localhost:5000/', - defaultQuery: { hello: 'world' }, - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', -}) + baseURL: 'http://localhost:5000/', + defaultQuery: { hello: 'world' }, + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); expect(client.buildURL('/foo', { hello: undefined })).toEqual('http://localhost:5000/foo'); }); }); test('custom fetch', async () => { const client = new Finch({ - baseURL: 'http://localhost:5000/', - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - fetch: (url) => { - return Promise.resolve( - new Response(JSON.stringify({ url, custom: true }), { - headers: { 'Content-Type': 'application/json' }, - }), - ); -}, -}); + baseURL: 'http://localhost:5000/', + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + fetch: (url) => { + return Promise.resolve( + new Response(JSON.stringify({ url, custom: true }), { + headers: { 'Content-Type': 'application/json' }, + }), + ); + }, + }); const response = await client.get('/foo'); expect(response).toEqual({ url: 'http://localhost:5000/foo', custom: true }); @@ -274,41 +276,39 @@ describe('logging', () => { test('explicit global fetch', async () => { // make sure the global fetch type is assignable to our Fetch type const client = new Finch({ - baseURL: 'http://localhost:5000/', - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - fetch: defaultFetch, -}); + baseURL: 'http://localhost:5000/', + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + fetch: defaultFetch, + }); }); test('custom signal', async () => { const client = new Finch({ - baseURL: process.env["TEST_API_BASE_URL"] ?? 'http://127.0.0.1:4010', - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - fetch: (...args) => { - return new Promise((resolve, reject) => - setTimeout( - () => - defaultFetch(...args) - .then(resolve) - .catch(reject), - 300, - ), - ); -}, -}); + baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010', + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + fetch: (...args) => { + return new Promise((resolve, reject) => + setTimeout( + () => + defaultFetch(...args) + .then(resolve) + .catch(reject), + 300, + ), + ); + }, + }); const controller = new AbortController(); setTimeout(() => controller.abort(), 200); const spy = jest.spyOn(client, 'request'); - await expect(client.get('/foo', { signal: controller.signal })).rejects.toThrowError( - APIUserAbortError, - ); + await expect(client.get('/foo', { signal: controller.signal })).rejects.toThrowError(APIUserAbortError); expect(spy).toHaveBeenCalledTimes(1); }); @@ -320,12 +320,12 @@ describe('logging', () => { }; const client = new Finch({ - baseURL: 'http://localhost:5000/', - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - fetch: testFetch, -}); + baseURL: 'http://localhost:5000/', + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + fetch: testFetch, + }); await client.patch('/foo'); expect(capturedRequest?.method).toEqual('PATCH'); @@ -334,21 +334,21 @@ describe('logging', () => { describe('baseUrl', () => { test('trailing slash', () => { const client = new Finch({ - baseURL: 'http://localhost:5000/custom/path/', - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', -}); + baseURL: 'http://localhost:5000/custom/path/', + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); expect(client.buildURL('/foo', null)).toEqual('http://localhost:5000/custom/path/foo'); }); test('no trailing slash', () => { const client = new Finch({ - baseURL: 'http://localhost:5000/custom/path', - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', -}); + baseURL: 'http://localhost:5000/custom/path', + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); expect(client.buildURL('/foo', null)).toEqual('http://localhost:5000/custom/path/foo'); }); @@ -358,101 +358,107 @@ describe('logging', () => { test('explicit option', () => { const client = new Finch({ - baseURL: 'https://example.com', - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', -}); + baseURL: 'https://example.com', + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); expect(client.baseURL).toEqual('https://example.com'); }); test('env variable', () => { process.env['FINCH_BASE_URL'] = 'https://example.com/from_env'; const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', -}); + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); expect(client.baseURL).toEqual('https://example.com/from_env'); }); test('empty env variable', () => { process.env['FINCH_BASE_URL'] = ''; // empty const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); - expect(client.baseURL).toEqual('https://api.tryfinch.com') + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); + expect(client.baseURL).toEqual('https://api.tryfinch.com'); }); test('blank env variable', () => { process.env['FINCH_BASE_URL'] = ' '; // blank const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); - expect(client.baseURL).toEqual('https://api.tryfinch.com') + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); + expect(client.baseURL).toEqual('https://api.tryfinch.com'); }); test('in request options', () => { const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); - expect(client.buildURL('/foo', null, 'http://localhost:5000/option')).toEqual('http://localhost:5000/option/foo'); + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); + expect(client.buildURL('/foo', null, 'http://localhost:5000/option')).toEqual( + 'http://localhost:5000/option/foo', + ); }); test('in request options overridden by client options', () => { const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - baseURL: 'http://localhost:5000/client', - }); - expect(client.buildURL('/foo', null, 'http://localhost:5000/option')).toEqual('http://localhost:5000/client/foo'); + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + baseURL: 'http://localhost:5000/client', + }); + expect(client.buildURL('/foo', null, 'http://localhost:5000/option')).toEqual( + 'http://localhost:5000/client/foo', + ); }); test('in request options overridden by env variable', () => { process.env['FINCH_BASE_URL'] = 'http://localhost:5000/env'; const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); - expect(client.buildURL('/foo', null, 'http://localhost:5000/option')).toEqual('http://localhost:5000/env/foo'); + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); + expect(client.buildURL('/foo', null, 'http://localhost:5000/option')).toEqual( + 'http://localhost:5000/env/foo', + ); }); }); test('maxRetries option is correctly set', () => { const client = new Finch({ - maxRetries: 4, - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', -}); + maxRetries: 4, + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); expect(client.maxRetries).toEqual(4); // default const client2 = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', -}); + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); expect(client2.maxRetries).toEqual(2); }); describe('withOptions', () => { test('creates a new client with overridden options', async () => { const client = new Finch({ - baseURL: 'http://localhost:5000/', - maxRetries: 3, - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); + baseURL: 'http://localhost:5000/', + maxRetries: 3, + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); const newClient = client.withOptions({ maxRetries: 5, @@ -474,13 +480,13 @@ describe('logging', () => { test('inherits options from the parent client', async () => { const client = new Finch({ - baseURL: 'http://localhost:5000/', - defaultHeaders: { 'X-Test-Header': 'test-value' }, - defaultQuery: { 'test-param': 'test-value' }, - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); + baseURL: 'http://localhost:5000/', + defaultHeaders: { 'X-Test-Header': 'test-value' }, + defaultQuery: { 'test-param': 'test-value' }, + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); const newClient = client.withOptions({ baseURL: 'http://localhost:5001/', @@ -495,12 +501,12 @@ describe('logging', () => { test('respects runtime property changes when creating new client', () => { const client = new Finch({ - baseURL: 'http://localhost:5000/', - timeout: 1000, - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - }); + baseURL: 'http://localhost:5000/', + timeout: 1000, + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); // Modify the client properties directly after creation client.baseURL = 'http://localhost:6000/'; @@ -553,28 +559,33 @@ describe('logging', () => { describe('request building', () => { const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', -}); + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); describe('custom headers', () => { test('handles undefined', async () => { - const { req } = await client.buildRequest({ path: '/foo', method: 'post', body: { value: 'hello' }, headers: { 'X-Foo': 'baz', 'x-foo': 'bar', 'x-Foo': undefined, 'x-baz': 'bam', 'X-Baz': null } }); + const { req } = await client.buildRequest({ + path: '/foo', + method: 'post', + body: { value: 'hello' }, + headers: { 'X-Foo': 'baz', 'x-foo': 'bar', 'x-Foo': undefined, 'x-baz': 'bam', 'X-Baz': null }, + }); expect(req.headers.get('x-foo')).toEqual('bar'); expect(req.headers.get('x-Foo')).toEqual('bar'); expect(req.headers.get('X-Foo')).toEqual('bar'); expect(req.headers.get('x-baz')).toEqual(null); }); - }) + }); }); describe('default encoder', () => { const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', -}); + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + }); class Serializable { toJSON() { @@ -647,39 +658,42 @@ describe('default encoder', () => { describe('retries', () => { test('retry on timeout', async () => { let count = 0; - const testFetch = async (url: string | URL | Request, { signal }: RequestInit = {}): Promise => { - if (count++ === 0) { - return new Promise((resolve, reject) => - signal?.addEventListener('abort', () => reject(new Error('timed out'))), - ); - } - return new Response(JSON.stringify({ a: 1 }), { headers: { 'Content-Type': 'application/json' } }); - }; - - const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - timeout: 10, - fetch: testFetch, - }); + const testFetch = async ( + url: string | URL | Request, + { signal }: RequestInit = {}, + ): Promise => { + if (count++ === 0) { + return new Promise( + (resolve, reject) => signal?.addEventListener('abort', () => reject(new Error('timed out'))), + ); + } + return new Response(JSON.stringify({ a: 1 }), { headers: { 'Content-Type': 'application/json' } }); + }; - expect(await client.request({ path: '/foo', method: 'get' })).toEqual({ a: 1 }); - expect(count).toEqual(2); - expect( - await client - .request({ path: '/foo', method: 'get' }) - .asResponse() - .then((r) => r.text()), - ).toEqual(JSON.stringify({ a: 1 })); - expect(count).toEqual(3); + const client = new Finch({ + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + timeout: 10, + fetch: testFetch, }); + expect(await client.request({ path: '/foo', method: 'get' })).toEqual({ a: 1 }); + expect(count).toEqual(2); + expect( + await client + .request({ path: '/foo', method: 'get' }) + .asResponse() + .then((r) => r.text()), + ).toEqual(JSON.stringify({ a: 1 })); + expect(count).toEqual(3); + }); + test('retry count header', async () => { let count = 0; let capturedRequest: RequestInit | undefined; const testFetch = async (url: string | URL | Request, init: RequestInit = {}): Promise => { - count++ + count++; if (count <= 2) { return new Response(undefined, { status: 429, @@ -693,12 +707,12 @@ describe('retries', () => { }; const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - fetch: testFetch, - maxRetries: 4, - }); + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + fetch: testFetch, + maxRetries: 4, + }); expect(await client.request({ path: '/foo', method: 'get' })).toEqual({ a: 1 }); @@ -710,7 +724,7 @@ describe('retries', () => { let count = 0; let capturedRequest: RequestInit | undefined; const testFetch = async (url: string | URL | Request, init: RequestInit = {}): Promise => { - count++ + count++; if (count <= 2) { return new Response(undefined, { status: 429, @@ -723,12 +737,12 @@ describe('retries', () => { return new Response(JSON.stringify({ a: 1 }), { headers: { 'Content-Type': 'application/json' } }); }; const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - fetch: testFetch, - maxRetries: 4, - }); + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + fetch: testFetch, + maxRetries: 4, + }); expect( await client.request({ @@ -745,7 +759,7 @@ describe('retries', () => { let count = 0; let capturedRequest: RequestInit | undefined; const testFetch = async (url: string | URL | Request, init: RequestInit = {}): Promise => { - count++ + count++; if (count <= 2) { return new Response(undefined, { status: 429, @@ -758,13 +772,13 @@ describe('retries', () => { return new Response(JSON.stringify({ a: 1 }), { headers: { 'Content-Type': 'application/json' } }); }; const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - fetch: testFetch, - maxRetries: 4, - defaultHeaders: { 'X-Stainless-Retry-Count': null }, - }); + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + fetch: testFetch, + maxRetries: 4, + defaultHeaders: { 'X-Stainless-Retry-Count': null }, + }); expect( await client.request({ @@ -780,7 +794,7 @@ describe('retries', () => { let count = 0; let capturedRequest: RequestInit | undefined; const testFetch = async (url: string | URL | Request, init: RequestInit = {}): Promise => { - count++ + count++; if (count <= 2) { return new Response(undefined, { status: 429, @@ -793,12 +807,12 @@ describe('retries', () => { return new Response(JSON.stringify({ a: 1 }), { headers: { 'Content-Type': 'application/json' } }); }; const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - fetch: testFetch, - maxRetries: 4, - }); + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + fetch: testFetch, + maxRetries: 4, + }); expect( await client.request({ @@ -813,7 +827,10 @@ describe('retries', () => { test('retry on 429 with retry-after', async () => { let count = 0; - const testFetch = async (url: string | URL | Request, { signal }: RequestInit = {}): Promise => { + const testFetch = async ( + url: string | URL | Request, + { signal }: RequestInit = {}, + ): Promise => { if (count++ === 0) { return new Response(undefined, { status: 429, @@ -826,11 +843,11 @@ describe('retries', () => { }; const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - fetch: testFetch, - }); + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + fetch: testFetch, + }); expect(await client.request({ path: '/foo', method: 'get' })).toEqual({ a: 1 }); expect(count).toEqual(2); @@ -845,7 +862,10 @@ describe('retries', () => { test('retry on 429 with retry-after-ms', async () => { let count = 0; - const testFetch = async (url: string | URL | Request, { signal }: RequestInit = {}): Promise => { + const testFetch = async ( + url: string | URL | Request, + { signal }: RequestInit = {}, + ): Promise => { if (count++ === 0) { return new Response(undefined, { status: 429, @@ -858,11 +878,11 @@ describe('retries', () => { }; const client = new Finch({ - accessToken: 'My Access Token', - clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', - clientSecret: 'My Client Secret', - fetch: testFetch, - }); + accessToken: 'My Access Token', + clientID: '4ab15e51-11ad-49f4-acae-f343b7794375', + clientSecret: 'My Client Secret', + fetch: testFetch, + }); expect(await client.request({ path: '/foo', method: 'get' })).toEqual({ a: 1 }); expect(count).toEqual(2); diff --git a/tests/qs/utils.test.ts b/tests/qs/utils.test.ts index 74dd17c1..6636cee5 100644 --- a/tests/qs/utils.test.ts +++ b/tests/qs/utils.test.ts @@ -66,7 +66,7 @@ describe('merge()', function () { // st.equal(getCount, 1); expect(setCount).toEqual(0); expect(getCount).toEqual(1); - observed[0] = observed[0]; + observed[0] = observed[0]; // st.equal(setCount, 1); // st.equal(getCount, 2); expect(setCount).toEqual(1); diff --git a/tests/stringifyQuery.test.ts b/tests/stringifyQuery.test.ts index 45f878d9..ab8e2f49 100644 --- a/tests/stringifyQuery.test.ts +++ b/tests/stringifyQuery.test.ts @@ -2,18 +2,20 @@ import { stringifyQuery } from '@tryfinch/finch-api/internal/utils/query'; -describe(stringifyQuery, () => { for (const [input, expected] of [ - [{ a: '1', b: 2, c: true }, 'a=1&b=2&c=true'], - [{ a: null, b: false, c: undefined }, 'a=&b=false'], - [{ 'a/b': 1.28341 }, `${encodeURIComponent('a/b')}=1.28341`], - [ - { 'a/b': 'c/d', 'e=f': 'g&h' }, - `${encodeURIComponent('a/b')}=${encodeURIComponent('c/d')}&${encodeURIComponent( - 'e=f', - )}=${encodeURIComponent('g&h')}`, - ], -] as const) { - it(`${JSON.stringify(input)} -> ${expected}`, () => { - expect(stringifyQuery(input)).toEqual(expected); - }); -} }) +describe(stringifyQuery, () => { + for (const [input, expected] of [ + [{ a: '1', b: 2, c: true }, 'a=1&b=2&c=true'], + [{ a: null, b: false, c: undefined }, 'a=&b=false'], + [{ 'a/b': 1.28341 }, `${encodeURIComponent('a/b')}=1.28341`], + [ + { 'a/b': 'c/d', 'e=f': 'g&h' }, + `${encodeURIComponent('a/b')}=${encodeURIComponent('c/d')}&${encodeURIComponent( + 'e=f', + )}=${encodeURIComponent('g&h')}`, + ], + ] as const) { + it(`${JSON.stringify(input)} -> ${expected}`, () => { + expect(stringifyQuery(input)).toEqual(expected); + }); + } +}); diff --git a/yarn.lock b/yarn.lock index efb31bcc..62f7eb60 100644 --- a/yarn.lock +++ b/yarn.lock @@ -714,6 +714,11 @@ "@nodelib/fs.scandir" "2.1.5" fastq "^1.6.0" +"@pkgr/core@^0.2.4": + version "0.2.4" + resolved "https://registry.yarnpkg.com/@pkgr/core/-/core-0.2.4.tgz#d897170a2b0ba51f78a099edccd968f7b103387c" + integrity sha512-ROFF39F6ZrnzSUEmQQZUar0Jt4xVoP9WnDRdWwF4NNcXs3xBTLgBUDoOwW141y1jP+S8nahIbdxbFC7IShw9Iw== + "@sinclair/typebox@^0.27.8": version "0.27.8" resolved "https://registry.yarnpkg.com/@sinclair/typebox/-/typebox-0.27.8.tgz#6667fac16c436b5434a387a34dedb013198f6e6e" @@ -1515,6 +1520,14 @@ escape-string-regexp@^4.0.0: resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz#14ba83a5d373e3d311e5afca29cf5bfad965bf34" integrity sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA== +eslint-plugin-prettier@^5.4.1: + version "5.4.1" + resolved "https://registry.yarnpkg.com/eslint-plugin-prettier/-/eslint-plugin-prettier-5.4.1.tgz#99b55d7dd70047886b2222fdd853665f180b36af" + integrity sha512-9dF+KuU/Ilkq27A8idRP7N2DH8iUR6qXcjF3FR2wETY21PZdBrIjwCau8oboyGj9b7etWmTGEeM8e7oOed6ZWg== + dependencies: + prettier-linter-helpers "^1.0.0" + synckit "^0.11.7" + eslint-plugin-unused-imports@^4.1.4: version "4.1.4" resolved "https://registry.yarnpkg.com/eslint-plugin-unused-imports/-/eslint-plugin-unused-imports-4.1.4.tgz#62ddc7446ccbf9aa7b6f1f0b00a980423cda2738" @@ -1666,6 +1679,11 @@ fast-deep-equal@^3.1.1, fast-deep-equal@^3.1.3: resolved "https://registry.yarnpkg.com/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz#3a7d56b559d6cbc3eb512325244e619a65c6c525" integrity sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q== +fast-diff@^1.1.2: + version "1.3.0" + resolved "https://registry.yarnpkg.com/fast-diff/-/fast-diff-1.3.0.tgz#ece407fa550a64d638536cd727e129c61616e0f0" + integrity sha512-VxPP4NqbUjj6MaAOafWeUn2cXWLcCtljklUtZf0Ind4XQ+QPtmA0b18zZy0jIQx+ExRVCR/ZQpBmik5lXshNsw== + fast-glob@^3.3.2: version "3.3.2" resolved "https://registry.yarnpkg.com/fast-glob/-/fast-glob-3.3.2.tgz#a904501e57cfdd2ffcded45e99a54fef55e46129" @@ -2828,6 +2846,13 @@ prelude-ls@^1.2.1: resolved "https://registry.yarnpkg.com/prelude-ls/-/prelude-ls-1.2.1.tgz#debc6489d7a6e6b0e7611888cec880337d316396" integrity sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g== +prettier-linter-helpers@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/prettier-linter-helpers/-/prettier-linter-helpers-1.0.0.tgz#d23d41fe1375646de2d0104d3454a3008802cf7b" + integrity sha512-GbK2cP9nraSSUF9N2XwUwqfzlAFlMNYYl+ShE/V+H8a9uNl/oUqB1w2EL54Jh0OlyRSd8RfWYJ3coVS4TROP2w== + dependencies: + fast-diff "^1.1.2" + prettier@^3.0.0: version "3.1.1" resolved "https://registry.yarnpkg.com/prettier/-/prettier-3.1.1.tgz#6ba9f23165d690b6cbdaa88cb0807278f7019848" @@ -3124,6 +3149,13 @@ supports-preserve-symlinks-flag@^1.0.0: resolved "https://registry.yarnpkg.com/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz#6eda4bd344a3c94aea376d4cc31bc77311039e09" integrity sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w== +synckit@^0.11.7: + version "0.11.8" + resolved "https://registry.yarnpkg.com/synckit/-/synckit-0.11.8.tgz#b2aaae998a4ef47ded60773ad06e7cb821f55457" + integrity sha512-+XZ+r1XGIJGeQk3VvXhT6xx/VpbHsRzsTkGgF6E5RX9TTXD0118l87puaEBZ566FhqblC6U0d4XnubznJDm30A== + dependencies: + "@pkgr/core" "^0.2.4" + test-exclude@^6.0.0: version "6.0.0" resolved "https://registry.yarnpkg.com/test-exclude/-/test-exclude-6.0.0.tgz#04a8698661d805ea6fa293b6cb9e63ac044ef15e" From ffa9adb334e3a8930dde00608afc58ca975bfb02 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 27 Apr 2026 22:31:02 +0000 Subject: [PATCH 08/14] feat: support setting headers via env --- src/client.ts | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/src/client.ts b/src/client.ts index 48d32320..ad1ad15e 100644 --- a/src/client.ts +++ b/src/client.ts @@ -241,6 +241,18 @@ export class Finch { this.fetch = options.fetch ?? Shims.getDefaultFetch(); this.#encoder = Opts.FallbackEncoder; + const customHeadersEnv = readEnv('FINCH_CUSTOM_HEADERS'); + if (customHeadersEnv) { + const parsed: Record = {}; + for (const line of customHeadersEnv.split('\n')) { + const colon = line.indexOf(':'); + if (colon >= 0) { + parsed[line.substring(0, colon).trim()] = line.substring(colon + 1).trim(); + } + } + options.defaultHeaders = { ...parsed, ...options.defaultHeaders }; + } + this._options = options; this.accessToken = accessToken; From e6ec464462e2e672cffa8c4ab8596ad0d24e54f8 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 28 Apr 2026 17:25:32 +0000 Subject: [PATCH 09/14] chore(internal): codegen related update --- packages/mcp-server/src/local-docs-search.ts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/packages/mcp-server/src/local-docs-search.ts b/packages/mcp-server/src/local-docs-search.ts index e62ea746..ac94ace0 100644 --- a/packages/mcp-server/src/local-docs-search.ts +++ b/packages/mcp-server/src/local-docs-search.ts @@ -1546,12 +1546,12 @@ const EMBEDDED_METHODS: MethodEntry[] = [ java: { method: 'jobs().automated().create', example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.core.JsonValue;\nimport com.tryfinch.api.models.AutomatedCreateResponse;\nimport com.tryfinch.api.models.JobAutomatedCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n JobAutomatedCreateParams.Body params = JobAutomatedCreateParams.Body.ofDataSyncAll();\n AutomatedCreateResponse automated = client.jobs().automated().create(params);\n }\n}', + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.AutomatedCreateResponse;\nimport com.tryfinch.api.models.JobAutomatedCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n JobAutomatedCreateParams.Body params = JobAutomatedCreateParams.Body.ofDataSyncAll();\n AutomatedCreateResponse automated = client.jobs().automated().create(params);\n }\n}', }, kotlin: { method: 'jobs().automated().create', example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.core.JsonValue\nimport com.tryfinch.api.models.AutomatedCreateResponse\nimport com.tryfinch.api.models.JobAutomatedCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val params: JobAutomatedCreateParams.Body = JobAutomatedCreateParams.Body.ofDataSyncAll()\n val automated: AutomatedCreateResponse = client.jobs().automated().create(params)\n}', + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.AutomatedCreateResponse\nimport com.tryfinch.api.models.JobAutomatedCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val params: JobAutomatedCreateParams.Body = JobAutomatedCreateParams.Body.ofDataSyncAll()\n val automated: AutomatedCreateResponse = client.jobs().automated().create(params)\n}', }, go: { method: 'client.Jobs.Automated.New', @@ -2258,12 +2258,12 @@ const EMBEDDED_METHODS: MethodEntry[] = [ java: { method: 'sandbox().jobs().configuration().update', example: - 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.SandboxJobConfiguration;\nimport com.tryfinch.api.models.SandboxJobConfigurationUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SandboxJobConfiguration params = SandboxJobConfiguration.builder()\n .completionStatus(SandboxJobConfiguration.CompletionStatus.COMPLETE)\n .type(SandboxJobConfiguration.Type.DATA_SYNC_ALL)\n .build();\n SandboxJobConfiguration sandboxJobConfiguration = client.sandbox().jobs().configuration().update(params);\n }\n}', + 'package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.SandboxJobConfiguration;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build();\n\n SandboxJobConfiguration params = SandboxJobConfiguration.builder()\n .completionStatus(SandboxJobConfiguration.CompletionStatus.COMPLETE)\n .type(SandboxJobConfiguration.Type.DATA_SYNC_ALL)\n .build();\n SandboxJobConfiguration sandboxJobConfiguration = client.sandbox().jobs().configuration().update(params);\n }\n}', }, kotlin: { method: 'sandbox().jobs().configuration().update', example: - 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.SandboxJobConfiguration\nimport com.tryfinch.api.models.SandboxJobConfigurationUpdateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val params: SandboxJobConfiguration = SandboxJobConfiguration.builder()\n .completionStatus(SandboxJobConfiguration.CompletionStatus.COMPLETE)\n .type(SandboxJobConfiguration.Type.DATA_SYNC_ALL)\n .build()\n val sandboxJobConfiguration: SandboxJobConfiguration = client.sandbox().jobs().configuration().update(params)\n}', + 'package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.SandboxJobConfiguration\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken("My Access Token")\n .build()\n\n val params: SandboxJobConfiguration = SandboxJobConfiguration.builder()\n .completionStatus(SandboxJobConfiguration.CompletionStatus.COMPLETE)\n .type(SandboxJobConfiguration.Type.DATA_SYNC_ALL)\n .build()\n val sandboxJobConfiguration: SandboxJobConfiguration = client.sandbox().jobs().configuration().update(params)\n}', }, go: { method: 'client.Sandbox.Jobs.Configuration.Update', From 52be6e9efd286c77afe5e4ce130135aaa728c596 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 28 Apr 2026 19:51:02 +0000 Subject: [PATCH 10/14] chore(format): run eslint and prettier separately --- bin/cli | 17 ++++++++++++----- eslint.config.mjs | 3 --- package.json | 1 - scripts/fast-format | 9 +++------ scripts/format | 3 +-- scripts/lint | 3 +++ src/internal/types.ts | 14 ++++++-------- yarn.lock | 32 -------------------------------- 8 files changed, 25 insertions(+), 57 deletions(-) diff --git a/bin/cli b/bin/cli index e1cc5d5e..38f15a1d 100755 --- a/bin/cli +++ b/bin/cli @@ -4,19 +4,26 @@ const { spawnSync } = require('child_process'); const commands = { migrate: { - description: 'Run migrations to update your code using @tryfinch/finch-api@6 to be compatible with @tryfinch/finch-api@7', + description: + 'Run migrations to update your code using @tryfinch/finch-api@6 to be compatible with @tryfinch/finch-api@7', fn: () => { const result = spawnSync( 'npx', - ['-y', 'https://github.com/stainless-api/migrate-ts/releases/download/0.0.2/stainless-api-migrate-0.0.2-6.tgz', '--migrationConfig', require.resolve('./migration-config.json'), ...process.argv.slice(3)], + [ + '-y', + 'https://github.com/stainless-api/migrate-ts/releases/download/0.0.2/stainless-api-migrate-0.0.2-6.tgz', + '--migrationConfig', + require.resolve('./migration-config.json'), + ...process.argv.slice(3), + ], { stdio: 'inherit' }, ); if (result.status !== 0) { process.exit(result.status); } - } - } -} + }, + }, +}; function exitWithHelp() { console.log(`Usage: tryfinch-finch-api `); diff --git a/eslint.config.mjs b/eslint.config.mjs index 8dff6305..978d1f73 100644 --- a/eslint.config.mjs +++ b/eslint.config.mjs @@ -1,7 +1,6 @@ // @ts-check import tseslint from 'typescript-eslint'; import unusedImports from 'eslint-plugin-unused-imports'; -import prettier from 'eslint-plugin-prettier'; export default tseslint.config( { @@ -14,11 +13,9 @@ export default tseslint.config( plugins: { '@typescript-eslint': tseslint.plugin, 'unused-imports': unusedImports, - prettier, }, rules: { 'no-unused-vars': 'off', - 'prettier/prettier': 'error', 'unused-imports/no-unused-imports': 'error', 'no-restricted-imports': [ 'error', diff --git a/package.json b/package.json index 896f78bd..1140bba8 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,6 @@ "@typescript-eslint/eslint-plugin": "8.31.1", "@typescript-eslint/parser": "8.31.1", "eslint": "^9.39.1", - "eslint-plugin-prettier": "^5.4.1", "eslint-plugin-unused-imports": "^4.1.4", "iconv-lite": "^0.6.3", "jest": "^29.4.0", diff --git a/scripts/fast-format b/scripts/fast-format index 53721ac0..f1873aef 100755 --- a/scripts/fast-format +++ b/scripts/fast-format @@ -31,10 +31,7 @@ if ! [ -z "$ESLINT_FILES" ]; then fi echo "==> Running prettier --write" -# format things eslint didn't -PRETTIER_FILES="$(grep '\.\(js\|json\)$' "$FILE_LIST" || true)" -if ! [ -z "$PRETTIER_FILES" ]; then - echo "$PRETTIER_FILES" | xargs ./node_modules/.bin/prettier \ - --write --cache --cache-strategy metadata --no-error-on-unmatched-pattern \ - '!**/dist' '!**/*.ts' '!**/*.mts' '!**/*.cts' '!**/*.js' '!**/*.mjs' '!**/*.cjs' +if ! [ -z "$FILE_LIST" ]; then + cat "$FILE_LIST" | xargs ./node_modules/.bin/prettier \ + --write --cache --cache-strategy metadata --no-error-on-unmatched-pattern --ignore-unknown fi diff --git a/scripts/format b/scripts/format index 7a756401..b1b2c17a 100755 --- a/scripts/format +++ b/scripts/format @@ -8,5 +8,4 @@ echo "==> Running eslint --fix" ./node_modules/.bin/eslint --fix . echo "==> Running prettier --write" -# format things eslint didn't -./node_modules/.bin/prettier --write --cache --cache-strategy metadata . '!**/dist' '!**/*.ts' '!**/*.mts' '!**/*.cts' '!**/*.js' '!**/*.mjs' '!**/*.cjs' +./node_modules/.bin/prettier --write --cache --cache-strategy metadata . diff --git a/scripts/lint b/scripts/lint index 3ffb78a6..1f532548 100755 --- a/scripts/lint +++ b/scripts/lint @@ -4,6 +4,9 @@ set -e cd "$(dirname "$0")/.." +echo "==> Running prettier --check" +./node_modules/.bin/prettier --check . + echo "==> Running eslint" ./node_modules/.bin/eslint . diff --git a/src/internal/types.ts b/src/internal/types.ts index b668dfc0..a050513a 100644 --- a/src/internal/types.ts +++ b/src/internal/types.ts @@ -40,7 +40,6 @@ type OverloadedParameters = : T extends (...args: infer A) => unknown ? A : never; -/* eslint-disable */ /** * These imports attempt to get types from a parent package's dependencies. * Unresolved bare specifiers can trigger [automatic type acquisition][1] in some projects, which @@ -63,19 +62,18 @@ type OverloadedParameters = * * [1]: https://www.typescriptlang.org/tsconfig/#typeAcquisition */ -/** @ts-ignore For users with \@types/node */ +/** @ts-ignore For users with \@types/node */ /* prettier-ignore */ type UndiciTypesRequestInit = NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny; -/** @ts-ignore For users with undici */ +/** @ts-ignore For users with undici */ /* prettier-ignore */ type UndiciRequestInit = NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny; -/** @ts-ignore For users with \@types/bun */ +/** @ts-ignore For users with \@types/bun */ /* prettier-ignore */ type BunRequestInit = globalThis.FetchRequestInit; -/** @ts-ignore For users with node-fetch@2 */ +/** @ts-ignore For users with node-fetch@2 */ /* prettier-ignore */ type NodeFetch2RequestInit = NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny; -/** @ts-ignore For users with node-fetch@3, doesn't need file extension because types are at ./@types/index.d.ts */ +/** @ts-ignore For users with node-fetch@3, doesn't need file extension because types are at ./@types/index.d.ts */ /* prettier-ignore */ type NodeFetch3RequestInit = NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny | NotAny; -/** @ts-ignore For users who use Deno */ +/** @ts-ignore For users who use Deno */ /* prettier-ignore */ type FetchRequestInit = NonNullable[1]>; -/* eslint-enable */ type RequestInits = | NotAny diff --git a/yarn.lock b/yarn.lock index 62f7eb60..efb31bcc 100644 --- a/yarn.lock +++ b/yarn.lock @@ -714,11 +714,6 @@ "@nodelib/fs.scandir" "2.1.5" fastq "^1.6.0" -"@pkgr/core@^0.2.4": - version "0.2.4" - resolved "https://registry.yarnpkg.com/@pkgr/core/-/core-0.2.4.tgz#d897170a2b0ba51f78a099edccd968f7b103387c" - integrity sha512-ROFF39F6ZrnzSUEmQQZUar0Jt4xVoP9WnDRdWwF4NNcXs3xBTLgBUDoOwW141y1jP+S8nahIbdxbFC7IShw9Iw== - "@sinclair/typebox@^0.27.8": version "0.27.8" resolved "https://registry.yarnpkg.com/@sinclair/typebox/-/typebox-0.27.8.tgz#6667fac16c436b5434a387a34dedb013198f6e6e" @@ -1520,14 +1515,6 @@ escape-string-regexp@^4.0.0: resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz#14ba83a5d373e3d311e5afca29cf5bfad965bf34" integrity sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA== -eslint-plugin-prettier@^5.4.1: - version "5.4.1" - resolved "https://registry.yarnpkg.com/eslint-plugin-prettier/-/eslint-plugin-prettier-5.4.1.tgz#99b55d7dd70047886b2222fdd853665f180b36af" - integrity sha512-9dF+KuU/Ilkq27A8idRP7N2DH8iUR6qXcjF3FR2wETY21PZdBrIjwCau8oboyGj9b7etWmTGEeM8e7oOed6ZWg== - dependencies: - prettier-linter-helpers "^1.0.0" - synckit "^0.11.7" - eslint-plugin-unused-imports@^4.1.4: version "4.1.4" resolved "https://registry.yarnpkg.com/eslint-plugin-unused-imports/-/eslint-plugin-unused-imports-4.1.4.tgz#62ddc7446ccbf9aa7b6f1f0b00a980423cda2738" @@ -1679,11 +1666,6 @@ fast-deep-equal@^3.1.1, fast-deep-equal@^3.1.3: resolved "https://registry.yarnpkg.com/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz#3a7d56b559d6cbc3eb512325244e619a65c6c525" integrity sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q== -fast-diff@^1.1.2: - version "1.3.0" - resolved "https://registry.yarnpkg.com/fast-diff/-/fast-diff-1.3.0.tgz#ece407fa550a64d638536cd727e129c61616e0f0" - integrity sha512-VxPP4NqbUjj6MaAOafWeUn2cXWLcCtljklUtZf0Ind4XQ+QPtmA0b18zZy0jIQx+ExRVCR/ZQpBmik5lXshNsw== - fast-glob@^3.3.2: version "3.3.2" resolved "https://registry.yarnpkg.com/fast-glob/-/fast-glob-3.3.2.tgz#a904501e57cfdd2ffcded45e99a54fef55e46129" @@ -2846,13 +2828,6 @@ prelude-ls@^1.2.1: resolved "https://registry.yarnpkg.com/prelude-ls/-/prelude-ls-1.2.1.tgz#debc6489d7a6e6b0e7611888cec880337d316396" integrity sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g== -prettier-linter-helpers@^1.0.0: - version "1.0.0" - resolved "https://registry.yarnpkg.com/prettier-linter-helpers/-/prettier-linter-helpers-1.0.0.tgz#d23d41fe1375646de2d0104d3454a3008802cf7b" - integrity sha512-GbK2cP9nraSSUF9N2XwUwqfzlAFlMNYYl+ShE/V+H8a9uNl/oUqB1w2EL54Jh0OlyRSd8RfWYJ3coVS4TROP2w== - dependencies: - fast-diff "^1.1.2" - prettier@^3.0.0: version "3.1.1" resolved "https://registry.yarnpkg.com/prettier/-/prettier-3.1.1.tgz#6ba9f23165d690b6cbdaa88cb0807278f7019848" @@ -3149,13 +3124,6 @@ supports-preserve-symlinks-flag@^1.0.0: resolved "https://registry.yarnpkg.com/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz#6eda4bd344a3c94aea376d4cc31bc77311039e09" integrity sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w== -synckit@^0.11.7: - version "0.11.8" - resolved "https://registry.yarnpkg.com/synckit/-/synckit-0.11.8.tgz#b2aaae998a4ef47ded60773ad06e7cb821f55457" - integrity sha512-+XZ+r1XGIJGeQk3VvXhT6xx/VpbHsRzsTkGgF6E5RX9TTXD0118l87puaEBZ566FhqblC6U0d4XnubznJDm30A== - dependencies: - "@pkgr/core" "^0.2.4" - test-exclude@^6.0.0: version "6.0.0" resolved "https://registry.yarnpkg.com/test-exclude/-/test-exclude-6.0.0.tgz#04a8698661d805ea6fa293b6cb9e63ac044ef15e" From 962ce5ec60fc31eb23821b042294210f93f46e88 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 29 Apr 2026 18:06:39 +0000 Subject: [PATCH 11/14] chore: avoid formatting file that gets changed during releases --- .prettierignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.prettierignore b/.prettierignore index 7cc13dd1..36afd3b3 100644 --- a/.prettierignore +++ b/.prettierignore @@ -2,6 +2,7 @@ CHANGELOG.md /ecosystem-tests/*/** /node_modules /deno +/packages/mcp-server/manifest.json # don't format tsc output, will break source maps dist From fab461d004937f3e7d60708a53ae71b28e1e2317 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 29 Apr 2026 18:17:26 +0000 Subject: [PATCH 12/14] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index 9d95cc59..f81ff4c2 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 46 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-929f30a5a8ed80d2d5def22f9f52464b578a8924db0c2e37bb31f836181aa679.yml +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch/finch-929f30a5a8ed80d2d5def22f9f52464b578a8924db0c2e37bb31f836181aa679.yml openapi_spec_hash: 7559424a86d6c7768cee9c650d0c156c config_hash: d21a244fc073152c8dbecb8ece970209 From 5a97a9f82f7c08fe3c0c0190a725d42e60abeff6 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 30 Apr 2026 16:24:22 +0000 Subject: [PATCH 13/14] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index f81ff4c2..07ec6c10 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 46 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch/finch-929f30a5a8ed80d2d5def22f9f52464b578a8924db0c2e37bb31f836181aa679.yml +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch/finch-326626d329d2a34acc127d7afe18edb068b1c28a8b50fecb4bb9973d3f9337a4.yml openapi_spec_hash: 7559424a86d6c7768cee9c650d0c156c config_hash: d21a244fc073152c8dbecb8ece970209 From 1ea2f5240ab35365da44b213890a6c266b8e6d6b Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 30 Apr 2026 16:27:20 +0000 Subject: [PATCH 14/14] release: 9.7.0 --- .release-please-manifest.json | 2 +- CHANGELOG.md | 22 ++++++++++++++++++++++ package.json | 2 +- packages/mcp-server/manifest.json | 2 +- packages/mcp-server/package.json | 2 +- packages/mcp-server/src/server.ts | 2 +- src/version.ts | 2 +- 7 files changed, 28 insertions(+), 6 deletions(-) diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 7ffaa482..f7114b03 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "9.6.0" + ".": "9.7.0" } diff --git a/CHANGELOG.md b/CHANGELOG.md index 1c8512dc..0107ea2f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,27 @@ # Changelog +## 9.7.0 (2026-04-30) + +Full Changelog: [v9.6.0...v9.7.0](https://github.com/Finch-API/finch-api-node/compare/v9.6.0...v9.7.0) + +### Features + +* **api:** api update ([51aa59a](https://github.com/Finch-API/finch-api-node/commit/51aa59a567ed110144dd1fc6b20308fe026ebef0)) +* support setting headers via env ([ffa9adb](https://github.com/Finch-API/finch-api-node/commit/ffa9adb334e3a8930dde00608afc58ca975bfb02)) + + +### Chores + +* avoid formatting file that gets changed during releases ([962ce5e](https://github.com/Finch-API/finch-api-node/commit/962ce5ec60fc31eb23821b042294210f93f46e88)) +* **format:** run eslint and prettier separately ([52be6e9](https://github.com/Finch-API/finch-api-node/commit/52be6e9efd286c77afe5e4ce130135aaa728c596)) +* **formatter:** run prettier and eslint separately ([b9fffd8](https://github.com/Finch-API/finch-api-node/commit/b9fffd84d80648d59f2ba5c6df4eb57e8ff8d811)) +* **internal:** codegen related update ([e6ec464](https://github.com/Finch-API/finch-api-node/commit/e6ec464462e2e672cffa8c4ab8596ad0d24e54f8)) +* **internal:** codegen related update ([fbbc840](https://github.com/Finch-API/finch-api-node/commit/fbbc840e907f54c6403793a483153aaad9f163dd)) +* **internal:** more robust bootstrap script ([4560fc4](https://github.com/Finch-API/finch-api-node/commit/4560fc4bdad42bc154a70db139d761dcc507431c)) +* **internal:** update docs ordering ([acb12fa](https://github.com/Finch-API/finch-api-node/commit/acb12fa8891902545beec8cf7d34015a24a53b98)) +* restructure docs search code ([5fb6a84](https://github.com/Finch-API/finch-api-node/commit/5fb6a84b620902bbe6695d5bf91d98dd5b89c92b)) +* **tests:** bump steady to v0.22.1 ([eb252a1](https://github.com/Finch-API/finch-api-node/commit/eb252a14302517dfce34fccccd5727cc1aa0bb84)) + ## 9.6.0 (2026-04-16) Full Changelog: [v9.5.1...v9.6.0](https://github.com/Finch-API/finch-api-node/compare/v9.5.1...v9.6.0) diff --git a/package.json b/package.json index 1140bba8..7adea9c4 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@tryfinch/finch-api", - "version": "9.6.0", + "version": "9.7.0", "description": "The official TypeScript library for the Finch API", "author": "Finch ", "types": "dist/index.d.ts", diff --git a/packages/mcp-server/manifest.json b/packages/mcp-server/manifest.json index ebcefb1a..4845fe4a 100644 --- a/packages/mcp-server/manifest.json +++ b/packages/mcp-server/manifest.json @@ -1,7 +1,7 @@ { "dxt_version": "0.2", "name": "@tryfinch/finch-api-mcp", - "version": "9.6.0", + "version": "9.7.0", "description": "The official MCP Server for the Finch API", "author": { "name": "Finch", diff --git a/packages/mcp-server/package.json b/packages/mcp-server/package.json index 47f51e97..3e48c585 100644 --- a/packages/mcp-server/package.json +++ b/packages/mcp-server/package.json @@ -1,6 +1,6 @@ { "name": "@tryfinch/finch-api-mcp", - "version": "9.6.0", + "version": "9.7.0", "description": "The official MCP Server for the Finch API", "author": "Finch ", "types": "dist/index.d.ts", diff --git a/packages/mcp-server/src/server.ts b/packages/mcp-server/src/server.ts index 6a26f6c7..3e7fde8e 100644 --- a/packages/mcp-server/src/server.ts +++ b/packages/mcp-server/src/server.ts @@ -29,7 +29,7 @@ export const newMcpServer = async ({ new McpServer( { name: 'tryfinch_finch_api_api', - version: '9.6.0', + version: '9.7.0', }, { instructions: await getInstructions({ stainlessApiKey, customInstructionsPath }), diff --git a/src/version.ts b/src/version.ts index 01f3ec2a..7de6b271 100644 --- a/src/version.ts +++ b/src/version.ts @@ -1 +1 @@ -export const VERSION = '9.6.0'; // x-release-please-version +export const VERSION = '9.7.0'; // x-release-please-version