@tryfinch/finch-api 1.0.0

package/api.md

@@ -0,0 +1,186 @@
+# ATS
+
+## Candidates
+
+Models:
+
+- <code><a href="./resources/ats/candidates.ts">Candidate</a></code>
+
+Methods:
+
+- <code title="get /ats/candidates/{candidate_id}">client.ats.candidates.<a href="./resources/ats/candidates.ts">retrieve</a>(candidateId) -> Candidate</code>
+- <code title="get /ats/candidates">client.ats.candidates.<a href="./resources/ats/candidates.ts">list</a>({ ...params }) -> CandidatesPage</code>
+
+## Applications
+
+Models:
+
+- <code><a href="./resources/ats/applications.ts">Application</a></code>
+
+Methods:
+
+- <code title="get /ats/applications/{application_id}">client.ats.applications.<a href="./resources/ats/applications.ts">retrieve</a>(applicationId) -> Application</code>
+- <code title="get /ats/applications">client.ats.applications.<a href="./resources/ats/applications.ts">list</a>({ ...params }) -> ApplicationsPage</code>
+
+## Stages
+
+Models:
+
+- <code><a href="./resources/ats/stages.ts">Stage</a></code>
+
+Methods:
+
+- <code title="get /ats/stages">client.ats.stages.<a href="./resources/ats/stages.ts">list</a>() -> StagesSinglePage</code>
+
+## Jobs
+
+Models:
+
+- <code><a href="./resources/ats/jobs.ts">Job</a></code>
+
+Methods:
+
+- <code title="get /ats/jobs/{job_id}">client.ats.jobs.<a href="./resources/ats/jobs.ts">retrieve</a>(jobId) -> Job</code>
+- <code title="get /ats/jobs">client.ats.jobs.<a href="./resources/ats/jobs.ts">list</a>({ ...params }) -> JobsPage</code>
+
+## Offers
+
+Models:
+
+- <code><a href="./resources/ats/offers.ts">Offer</a></code>
+
+Methods:
+
+- <code title="get /ats/offers/{offer_id}">client.ats.offers.<a href="./resources/ats/offers.ts">retrieve</a>(offerId) -> Offer</code>
+- <code title="get /ats/offers">client.ats.offers.<a href="./resources/ats/offers.ts">list</a>({ ...params }) -> OffersPage</code>
+
+# HRIS
+
+Models:
+
+- <code><a href="./resources/hris/hris.ts">Income</a></code>
+- <code><a href="./resources/hris/hris.ts">Location</a></code>
+- <code><a href="./resources/hris/hris.ts">Money</a></code>
+- <code><a href="./resources/hris/hris.ts">Paging</a></code>
+
+## CompanyResource
+
+Models:
+
+- <code><a href="./resources/hris/company.ts">Company</a></code>
+
+Methods:
+
+- <code title="get /employer/company">client.hris.company.<a href="./resources/hris/company.ts">retrieve</a>() -> Company</code>
+
+## Payments
+
+Models:
+
+- <code><a href="./resources/hris/payments.ts">Payment</a></code>
+
+Methods:
+
+- <code title="get /employer/payment">client.hris.payments.<a href="./resources/hris/payments.ts">list</a>({ ...params }) -> PaymentsSinglePage</code>
+
+## PayStatements
+
+Models:
+
+- <code><a href="./resources/hris/pay-statements.ts">PayStatement</a></code>
+- <code><a href="./resources/hris/pay-statements.ts">PayStatementResponse</a></code>
+- <code><a href="./resources/hris/pay-statements.ts">PayStatementResponseBody</a></code>
+
+Methods:
+
+- <code title="post /employer/pay-statement">client.hris.payStatements.<a href="./resources/hris/pay-statements.ts">retrieveMany</a>({ ...params }) -> PayStatementResponsesResponsesPage</code>
+
+## Directory
+
+Models:
+
+- <code><a href="./resources/hris/directory.ts">IndividualInDirectory</a></code>
+
+Methods:
+
+- <code title="get /employer/directory">client.hris.directory.<a href="./resources/hris/directory.ts">listIndividuals</a>({ ...params }) -> IndividualsPage</code>
+
+## Individuals
+
+Models:
+
+- <code><a href="./resources/hris/individuals/individuals.ts">Individual</a></code>
+- <code><a href="./resources/hris/individuals/individuals.ts">IndividualResponse</a></code>
+
+Methods:
+
+- <code title="post /employer/individual">client.hris.individuals.<a href="./resources/hris/individuals/individuals.ts">retrieveMany</a>({ ...params }) -> IndividualResponsesResponsesPage</code>
+
+### EmploymentData
+
+Models:
+
+- <code><a href="./resources/hris/individuals/employment-data.ts">EmploymentData</a></code>
+- <code><a href="./resources/hris/individuals/employment-data.ts">EmploymentDataResponse</a></code>
+
+Methods:
+
+- <code title="post /employer/employment">client.hris.individuals.employmentData.<a href="./resources/hris/individuals/employment-data.ts">retrieveMany</a>({ ...params }) -> EmploymentDataResponsesResponsesPage</code>
+
+## Benefits
+
+Models:
+
+- <code><a href="./resources/hris/benefits/benefits.ts">BenefitFrequency</a></code>
+- <code><a href="./resources/hris/benefits/benefits.ts">BenefitType</a></code>
+- <code><a href="./resources/hris/benefits/benefits.ts">BenfitContribution</a></code>
+- <code><a href="./resources/hris/benefits/benefits.ts">CompanyBenefit</a></code>
+- <code><a href="./resources/hris/benefits/benefits.ts">CreateCompanyBenefitsResponse</a></code>
+- <code><a href="./resources/hris/benefits/benefits.ts">SupportedBenefit</a></code>
+- <code><a href="./resources/hris/benefits/benefits.ts">UpdateCompanyBenefitResponse</a></code>
+
+Methods:
+
+- <code title="post /employer/benefits">client.hris.benefits.<a href="./resources/hris/benefits/benefits.ts">create</a>({ ...params }) -> CreateCompanyBenefitsResponse</code>
+- <code title="get /employer/benefits/{benefit_id}">client.hris.benefits.<a href="./resources/hris/benefits/benefits.ts">retrieve</a>(benefitId) -> CompanyBenefit</code>
+- <code title="post /employer/benefits/{benefit_id}">client.hris.benefits.<a href="./resources/hris/benefits/benefits.ts">update</a>(benefitId, { ...params }) -> UpdateCompanyBenefitResponse</code>
+- <code title="get /employer/benefits">client.hris.benefits.<a href="./resources/hris/benefits/benefits.ts">list</a>() -> CompanyBenefitsSinglePage</code>
+- <code title="get /employer/benefits/meta">client.hris.benefits.<a href="./resources/hris/benefits/benefits.ts">listSupportedBenefits</a>() -> SupportedBenefitsSinglePage</code>
+
+### Individuals
+
+Models:
+
+- <code><a href="./resources/hris/benefits/individuals.ts">EnrolledIndividual</a></code>
+- <code><a href="./resources/hris/benefits/individuals.ts">IndividualBenefit</a></code>
+- <code><a href="./resources/hris/benefits/individuals.ts">UnenrolledIndividual</a></code>
+- <code><a href="./resources/hris/benefits/individuals.ts">IndividualEnrolledIDsResponse</a></code>
+
+Methods:
+
+- <code title="post /employer/benefits/{benefit_id}/individuals">client.hris.benefits.individuals.<a href="./resources/hris/benefits/individuals.ts">enrollMany</a>(benefitId) -> EnrolledIndividualsSinglePage</code>
+- <code title="get /employer/benefits/{benefit_id}/enrolled">client.hris.benefits.individuals.<a href="./resources/hris/benefits/individuals.ts">enrolledIds</a>(benefitId) -> IndividualEnrolledIDsResponse</code>
+- <code title="get /employer/benefits/{benefit_id}/individuals">client.hris.benefits.individuals.<a href="./resources/hris/benefits/individuals.ts">retrieveManyBenefits</a>(benefitId, { ...params }) -> IndividualBenefitsSinglePage</code>
+- <code title="delete /employer/benefits/{benefit_id}/individuals">client.hris.benefits.individuals.<a href="./resources/hris/benefits/individuals.ts">unenroll</a>(benefitId, { ...params }) -> UnenrolledIndividualsSinglePage</code>
+
+# Providers
+
+Models:
+
+- <code><a href="./resources/providers.ts">Provider</a></code>
+
+Methods:
+
+- <code title="get /providers">client.providers.<a href="./resources/providers.ts">list</a>() -> ProvidersSinglePage</code>
+
+# Account
+
+Models:
+
+- <code><a href="./resources/account.ts">DisconnectResponse</a></code>
+- <code><a href="./resources/account.ts">Introspection</a></code>
+
+Methods:
+
+- <code title="post /disconnect">client.account.<a href="./resources/account.ts">disconnect</a>() -> DisconnectResponse</code>
+- <code title="get /introspect">client.account.<a href="./resources/account.ts">introspect</a>() -> Introspection</code>

package/bin/check-release-environment

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+
+errors=()
+
+if [ -z "${STAINLESS_API_KEY}" ]; then
+  errors+=("The STAINLESS_API_KEY secret has not been set. Please contact Stainless for an API key & set it in your organisation secrets on GitHub.")
+fi
+
+if [ -z "${NPM_TOKEN}" ]; then
+  errors+=("The FINCH_NPM_TOKEN secret has not been set. Please set it in either this repository's secrets or your organisation secrets")
+fi
+
+len=${#errors[@]}
+
+if [[ len -gt 0 ]]; then
+  echo -e "Found the following errors in the release environment:\n"
+
+  for error in "${errors[@]}"; do
+    echo -e "- $error\n"
+  done
+
+  exit 1
+fi
+
+echo "The environment is ready to push releases!"

package/bin/check-test-server

@@ -0,0 +1,50 @@
+#!/usr/bin/env bash
+
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[0;33m'
+NC='\033[0m' # No Color
+
+function prism_is_running() {
+  curl --silent "http://localhost:4010" >/dev/null 2>&1
+}
+
+function is_overriding_api_base_url() {
+  [ -n "$API_BASE_URL" ]
+}
+
+if is_overriding_api_base_url ; then
+  # If someone is running the tests against the live API, we can trust they know
+  # what they're doing and exit early.
+  echo -e "${GREEN}✔ Running tests against ${API_BASE_URL}${NC}"
+
+  exit 0
+elif prism_is_running ; then
+  echo -e "${GREEN}✔ Mock prism server is running with your OpenAPI spec${NC}"
+  echo
+
+  exit 0
+else
+  echo -e "${RED}ERROR:${NC} The test suite will not run without a mock Prism server"
+  echo -e "running against your OpenAPI spec."
+  echo
+  echo -e "${YELLOW}To fix:${NC}"
+  echo
+  echo -e "1. Install Prism (requires Node 16+):"
+  echo
+  echo -e "  With npm:"
+  echo -e "    \$ ${YELLOW}npm install -g @stoplight/prism-cli${NC}"
+  echo
+  echo -e "  With yarn:"
+  echo -e "    \$ ${YELLOW}yarn global add @stoplight/prism-cli${NC}"
+  echo
+  echo -e "2. Run the mock server"
+  echo
+  echo -e "  To run the server, pass in the path of your OpenAPI"
+  echo -e "  spec to the prism command:"
+  echo
+  echo -e "    \$ ${YELLOW}prism mock path/to/your.openapi.yml${NC}"
+  echo
+
+  exit 1
+fi

package/bin/publish-npm

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+set -eux
+
+npm config set //registry.npmjs.org/:_authToken $NPM_TOKEN
+yarn publish --build --access public

package/build

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+rm -rf dist/*
+
+yarn tsn check-version.ts
+
+# build node:
+yarn tsc -p tsconfig.cjs.json
+yarn tsc-alias -p tsconfig.cjs.json
+
+yarn prettier --write .

package/check-version.ts

@@ -0,0 +1,18 @@
+import fs from 'fs';
+
+const main = () => {
+  const pkg = JSON.parse(fs.readFileSync('package.json').toString()) as Record<string, unknown>;
+  const version = pkg['version'];
+  if (!version) throw 'The version property is not set in the package.json file';
+  if (typeof version !== 'string') {
+    throw `Unexpected type for the package.json version field; got ${typeof version}, expected string`;
+  }
+
+  const contents = fs.readFileSync('version.ts', 'utf8');
+  const output = contents.replace(/(export const VERSION = ')(.*)(')/g, `$1${version}$3`);
+  fs.writeFileSync('version.ts', output);
+};
+
+if (require.main === module) {
+  main();
+}