@kombo-api/sdk 0.1.1

package/src/funcs/atsGetInterviews.ts

@@ -0,0 +1,253 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { KomboCore } from "../core.js";
+import { dlv } from "../lib/dlv.js";
+import { encodeFormQuery, encodeSimple, queryJoin } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { KomboError } from "../models/errors/komboerror.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+import {
+  createPageIterator,
+  haltIterator,
+  PageIterator,
+  Paginator,
+} from "../types/operations.js";
+
+/**
+ * Get interviews
+ *
+ * @remarks
+ * Retrieve all interviews.
+ *
+ * Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`
+ */
+export function atsGetInterviews(
+  client: KomboCore,
+  request?: operations.GetAtsInterviewsRequest | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  PageIterator<
+    Result<
+      operations.GetAtsInterviewsResponse,
+      | errors.KomboAtsError
+      | KomboError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    { cursor: string }
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: KomboCore,
+  request?: operations.GetAtsInterviewsRequest | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    PageIterator<
+      Result<
+        operations.GetAtsInterviewsResponse,
+        | errors.KomboAtsError
+        | KomboError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >,
+      { cursor: string }
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.GetAtsInterviewsRequest$outboundSchema.optional().parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [haltIterator(parsed), { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/ats/interviews")();
+
+  const query = queryJoin(
+    encodeFormQuery({
+      "ids": payload?.ids,
+      "job_ids": payload?.job_ids,
+      "remote_ids": payload?.remote_ids,
+    }, { explode: false }),
+    encodeFormQuery({
+      "cursor": payload?.cursor,
+      "include_deleted": payload?.include_deleted,
+      "page_size": payload?.page_size,
+      "updated_after": payload?.updated_after,
+    }),
+  );
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+    "X-Integration-Id": encodeSimple(
+      "X-Integration-Id",
+      client._options.integration_id,
+      { explode: false, charEncoding: "none" },
+    ),
+  }));
+
+  const secConfig = await extractSecurity(client._options.api_key);
+  const securityInput = secConfig == null ? {} : { api_key: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    base_url: options?.server_url ?? client._baseURL ?? "",
+    operation_id: "GetAtsInterviews",
+    o_auth2_scopes: null,
+
+    resolved_security: requestSecurity,
+
+    security_source: client._options.api_key,
+    retry_config: options?.retries
+      || client._options.retry_config
+      || { strategy: "none" },
+    retry_codes: options?.retry_codes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.server_url,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.user_agent,
+    timeout_ms: options?.timeout_ms || client._options.timeout_ms || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [haltIterator(requestRes), { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["default"],
+    retryConfig: context.retry_config,
+    retryCodes: context.retry_codes,
+  });
+  if (!doResult.ok) {
+    return [haltIterator(doResult), { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result, raw] = await M.match<
+    operations.GetAtsInterviewsResponse,
+    | errors.KomboAtsError
+    | KomboError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.GetAtsInterviewsResponse$inboundSchema, {
+      key: "Result",
+    }),
+    M.jsonErr("default", errors.KomboAtsError$inboundSchema),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [haltIterator(result), {
+      status: "complete",
+      request: req,
+      response,
+    }];
+  }
+
+  const nextFunc = (
+    responseData: unknown,
+  ): {
+    next: Paginator<
+      Result<
+        operations.GetAtsInterviewsResponse,
+        | errors.KomboAtsError
+        | KomboError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >
+    >;
+    "~next"?: { cursor: string };
+  } => {
+    const nextCursor = dlv(responseData, "next");
+    if (typeof nextCursor !== "string") {
+      return { next: () => null };
+    }
+    if (nextCursor.trim() === "") {
+      return { next: () => null };
+    }
+
+    const nextVal = () =>
+      atsGetInterviews(
+        client,
+        {
+          ...request,
+          cursor: nextCursor,
+        },
+        options,
+      );
+
+    return { next: nextVal, "~next": { cursor: nextCursor } };
+  };
+
+  const page = { ...result, ...nextFunc(raw) };
+  return [{ ...page, ...createPageIterator(page, (v) => !v.ok) }, {
+    status: "complete",
+    request: req,
+    response,
+  }];
+}

package/src/funcs/atsGetJobs.ts

@@ -0,0 +1,265 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { KomboCore } from "../core.js";
+import { dlv } from "../lib/dlv.js";
+import { encodeFormQuery, encodeSimple, queryJoin } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { KomboError } from "../models/errors/komboerror.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+import {
+  createPageIterator,
+  haltIterator,
+  PageIterator,
+  Paginator,
+} from "../types/operations.js";
+
+/**
+ * Get jobs
+ *
+ * @remarks
+ * Retrieve all jobs.
+ *
+ * Visit our in-depth guides to learn more about:
+ *
+ * - 🔄 [Getting updates of the data](/ats/features/implementation-guide/reading-jobs#getting-updates-of-the-data)
+ * - ❗ [Handling failing syncs](/ats/features/implementation-guide/reading-jobs#handling-failing-syncs)
+ * - 🔍 [Letting your customer choose which jobs to expose](/ats/features/implementation-guide/reading-jobs#let-your-customer-choose-which-jobs-to-expose-to-you)
+ * - 🔗 [Matching jobs in your database to ATS jobs](/ats/features/implementation-guide/reading-jobs#match-jobs-in-your-database-to-ats-jobs)
+ * - 🗑️ [Reacting to deleted/closed jobs](/ats/features/implementation-guide/reading-jobs#reacting-to-deleted-closed-jobs)
+ *
+ * Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: `(id IN ids) AND (remote_id IN remote_ids)`
+ */
+export function atsGetJobs(
+  client: KomboCore,
+  request?: operations.GetAtsJobsRequest | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  PageIterator<
+    Result<
+      operations.GetAtsJobsResponse,
+      | errors.KomboAtsError
+      | KomboError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    { cursor: string }
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: KomboCore,
+  request?: operations.GetAtsJobsRequest | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    PageIterator<
+      Result<
+        operations.GetAtsJobsResponse,
+        | errors.KomboAtsError
+        | KomboError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >,
+      { cursor: string }
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.GetAtsJobsRequest$outboundSchema.optional().parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [haltIterator(parsed), { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/ats/jobs")();
+
+  const query = queryJoin(
+    encodeFormQuery({
+      "employment_types": payload?.employment_types,
+      "ids": payload?.ids,
+      "job_codes": payload?.job_codes,
+      "remote_ids": payload?.remote_ids,
+      "statuses": payload?.statuses,
+      "visibilities": payload?.visibilities,
+    }, { explode: false }),
+    encodeFormQuery({
+      "cursor": payload?.cursor,
+      "include_deleted": payload?.include_deleted,
+      "name_contains": payload?.name_contains,
+      "page_size": payload?.page_size,
+      "post_url": payload?.post_url,
+      "remote_created_after": payload?.remote_created_after,
+      "updated_after": payload?.updated_after,
+    }),
+  );
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+    "X-Integration-Id": encodeSimple(
+      "X-Integration-Id",
+      client._options.integration_id,
+      { explode: false, charEncoding: "none" },
+    ),
+  }));
+
+  const secConfig = await extractSecurity(client._options.api_key);
+  const securityInput = secConfig == null ? {} : { api_key: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    base_url: options?.server_url ?? client._baseURL ?? "",
+    operation_id: "GetAtsJobs",
+    o_auth2_scopes: null,
+
+    resolved_security: requestSecurity,
+
+    security_source: client._options.api_key,
+    retry_config: options?.retries
+      || client._options.retry_config
+      || { strategy: "none" },
+    retry_codes: options?.retry_codes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.server_url,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.user_agent,
+    timeout_ms: options?.timeout_ms || client._options.timeout_ms || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [haltIterator(requestRes), { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["default"],
+    retryConfig: context.retry_config,
+    retryCodes: context.retry_codes,
+  });
+  if (!doResult.ok) {
+    return [haltIterator(doResult), { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result, raw] = await M.match<
+    operations.GetAtsJobsResponse,
+    | errors.KomboAtsError
+    | KomboError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.GetAtsJobsResponse$inboundSchema, { key: "Result" }),
+    M.jsonErr("default", errors.KomboAtsError$inboundSchema),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [haltIterator(result), {
+      status: "complete",
+      request: req,
+      response,
+    }];
+  }
+
+  const nextFunc = (
+    responseData: unknown,
+  ): {
+    next: Paginator<
+      Result<
+        operations.GetAtsJobsResponse,
+        | errors.KomboAtsError
+        | KomboError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >
+    >;
+    "~next"?: { cursor: string };
+  } => {
+    const nextCursor = dlv(responseData, "next");
+    if (typeof nextCursor !== "string") {
+      return { next: () => null };
+    }
+    if (nextCursor.trim() === "") {
+      return { next: () => null };
+    }
+
+    const nextVal = () =>
+      atsGetJobs(
+        client,
+        {
+          ...request,
+          cursor: nextCursor,
+        },
+        options,
+      );
+
+    return { next: nextVal, "~next": { cursor: nextCursor } };
+  };
+
+  const page = { ...result, ...nextFunc(raw) };
+  return [{ ...page, ...createPageIterator(page, (v) => !v.ok) }, {
+    status: "complete",
+    request: req,
+    response,
+  }];
+}