@kombo-api/sdk 0.2.0 → 0.2.1

package/src/models/getatsjobspositiveresponse.ts

@@ -4,7 +4,8 @@
 
 import * as z from "zod/v3";
 import { safeParse } from "../lib/schemas.js";
-import { catchUnrecognizedEnum, ClosedEnum, OpenEnum } from "../types/enums.js";
+import * as openEnums from "../types/enums.js";
+import { ClosedEnum, OpenEnum } from "../types/enums.js";
 import { Result as SafeParseResult } from "../types/fp.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
 
@@ -542,55 +543,35 @@ export const GetAtsJobsPositiveResponseEmploymentType$inboundSchema: z.ZodType<
   GetAtsJobsPositiveResponseEmploymentType,
   z.ZodTypeDef,
   unknown
-> = z
-  .union([
-    z.nativeEnum(GetAtsJobsPositiveResponseEmploymentType),
-    z.string().transform(catchUnrecognizedEnum),
-  ]);
+> = openEnums.inboundSchema(GetAtsJobsPositiveResponseEmploymentType);
 
 /** @internal */
 export const GetAtsJobsPositiveResponseStatus$inboundSchema: z.ZodType<
   GetAtsJobsPositiveResponseStatus,
   z.ZodTypeDef,
   unknown
-> = z
-  .union([
-    z.nativeEnum(GetAtsJobsPositiveResponseStatus),
-    z.string().transform(catchUnrecognizedEnum),
-  ]);
+> = openEnums.inboundSchema(GetAtsJobsPositiveResponseStatus);
 
 /** @internal */
 export const Visibility$inboundSchema: z.ZodType<
   Visibility,
   z.ZodTypeDef,
   unknown
-> = z
-  .union([
-    z.nativeEnum(Visibility),
-    z.string().transform(catchUnrecognizedEnum),
-  ]);
+> = openEnums.inboundSchema(Visibility);
 
 /** @internal */
 export const RemoteWorkStatus$inboundSchema: z.ZodType<
   RemoteWorkStatus,
   z.ZodTypeDef,
   unknown
-> = z
-  .union([
-    z.nativeEnum(RemoteWorkStatus),
-    z.string().transform(catchUnrecognizedEnum),
-  ]);
+> = openEnums.inboundSchema(RemoteWorkStatus);
 
 /** @internal */
 export const SalaryPeriod$inboundSchema: z.ZodType<
   SalaryPeriod,
   z.ZodTypeDef,
   unknown
-> = z
-  .union([
-    z.nativeEnum(SalaryPeriod),
-    z.string().transform(catchUnrecognizedEnum),
-  ]);
+> = openEnums.inboundSchema(SalaryPeriod);
 
 /** @internal */
 export const GetAtsJobsPositiveResponseLocation$inboundSchema: z.ZodType<

package/src/models/gethrisabsencespositiveresponse.ts

@@ -4,7 +4,8 @@
 
 import * as z from "zod/v3";
 import { safeParse } from "../lib/schemas.js";
-import { catchUnrecognizedEnum, ClosedEnum, OpenEnum } from "../types/enums.js";
+import * as openEnums from "../types/enums.js";
+import { ClosedEnum, OpenEnum } from "../types/enums.js";
 import { Result as SafeParseResult } from "../types/fp.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
 
@@ -173,11 +174,7 @@ export const GetHrisAbsencesPositiveResponseStatus$inboundSchema: z.ZodType<
   GetHrisAbsencesPositiveResponseStatus,
   z.ZodTypeDef,
   unknown
-> = z
-  .union([
-    z.nativeEnum(GetHrisAbsencesPositiveResponseStatus),
-    z.string().transform(catchUnrecognizedEnum),
-  ]);
+> = openEnums.inboundSchema(GetHrisAbsencesPositiveResponseStatus);
 
 /** @internal */
 export const GetHrisAbsencesPositiveResponseTypeUnit$inboundSchema:

package/src/models/gethrisemployeespositiveresponse.ts

@@ -4,7 +4,8 @@
 
 import * as z from "zod/v3";
 import { safeParse } from "../lib/schemas.js";
-import { catchUnrecognizedEnum, ClosedEnum, OpenEnum } from "../types/enums.js";
+import * as openEnums from "../types/enums.js";
+import { ClosedEnum, OpenEnum } from "../types/enums.js";
 import { Result as SafeParseResult } from "../types/fp.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
 
@@ -355,6 +356,10 @@ export type Manager = {
    * The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.
    */
   id: string;
+  /**
+   * The employee’s organization-internal employee number.
+   */
+  employee_number: string | null;
   /**
    * The employee’s work email address. If the email address is invalid, we will set this to `null`.
    */
@@ -688,44 +693,28 @@ export const GetHrisEmployeesPositiveResponseGender$inboundSchema: z.ZodType<
   GetHrisEmployeesPositiveResponseGender,
   z.ZodTypeDef,
   unknown
-> = z
-  .union([
-    z.nativeEnum(GetHrisEmployeesPositiveResponseGender),
-    z.string().transform(catchUnrecognizedEnum),
-  ]);
+> = openEnums.inboundSchema(GetHrisEmployeesPositiveResponseGender);
 
 /** @internal */
 export const Ethnicity$inboundSchema: z.ZodType<
   Ethnicity,
   z.ZodTypeDef,
   unknown
-> = z
-  .union([
-    z.nativeEnum(Ethnicity),
-    z.string().transform(catchUnrecognizedEnum),
-  ]);
+> = openEnums.inboundSchema(Ethnicity);
 
 /** @internal */
 export const MaritalStatus$inboundSchema: z.ZodType<
   MaritalStatus,
   z.ZodTypeDef,
   unknown
-> = z
-  .union([
-    z.nativeEnum(MaritalStatus),
-    z.string().transform(catchUnrecognizedEnum),
-  ]);
+> = openEnums.inboundSchema(MaritalStatus);
 
 /** @internal */
 export const EmploymentStatus$inboundSchema: z.ZodType<
   EmploymentStatus,
   z.ZodTypeDef,
   unknown
-> = z
-  .union([
-    z.nativeEnum(EmploymentStatus),
-    z.string().transform(catchUnrecognizedEnum),
-  ]);
+> = openEnums.inboundSchema(EmploymentStatus);
 
 /** @internal */
 export const GetHrisEmployeesPositiveResponseEmploymentType$inboundSchema:
@@ -733,11 +722,7 @@ export const GetHrisEmployeesPositiveResponseEmploymentType$inboundSchema:
     GetHrisEmployeesPositiveResponseEmploymentType,
     z.ZodTypeDef,
     unknown
-  > = z
-    .union([
-      z.nativeEnum(GetHrisEmployeesPositiveResponseEmploymentType),
-      z.string().transform(catchUnrecognizedEnum),
-    ]);
+  > = openEnums.inboundSchema(GetHrisEmployeesPositiveResponseEmploymentType);
 
 /** @internal */
 export const HomeAddress$inboundSchema: z.ZodType<
@@ -820,11 +805,7 @@ export const GetHrisEmployeesPositiveResponsePayPeriod$inboundSchema: z.ZodType<
   GetHrisEmployeesPositiveResponsePayPeriod,
   z.ZodTypeDef,
   unknown
-> = z
-  .union([
-    z.nativeEnum(GetHrisEmployeesPositiveResponsePayPeriod),
-    z.string().transform(catchUnrecognizedEnum),
-  ]);
+> = openEnums.inboundSchema(GetHrisEmployeesPositiveResponsePayPeriod);
 
 /** @internal */
 export const GetHrisEmployeesPositiveResponsePayFrequency$inboundSchema:
@@ -832,22 +813,14 @@ export const GetHrisEmployeesPositiveResponsePayFrequency$inboundSchema:
     GetHrisEmployeesPositiveResponsePayFrequency,
     z.ZodTypeDef,
     unknown
-  > = z
-    .union([
-      z.nativeEnum(GetHrisEmployeesPositiveResponsePayFrequency),
-      z.string().transform(catchUnrecognizedEnum),
-    ]);
+  > = openEnums.inboundSchema(GetHrisEmployeesPositiveResponsePayFrequency);
 
 /** @internal */
 export const EmploymentEmploymentType$inboundSchema: z.ZodType<
   EmploymentEmploymentType,
   z.ZodTypeDef,
   unknown
-> = z
-  .union([
-    z.nativeEnum(EmploymentEmploymentType),
-    z.string().transform(catchUnrecognizedEnum),
-  ]);
+> = openEnums.inboundSchema(EmploymentEmploymentType);
 
 /** @internal */
 export const Employment$inboundSchema: z.ZodType<
@@ -936,11 +909,7 @@ export const ManagerEmploymentStatus$inboundSchema: z.ZodType<
   ManagerEmploymentStatus,
   z.ZodTypeDef,
   unknown
-> = z
-  .union([
-    z.nativeEnum(ManagerEmploymentStatus),
-    z.string().transform(catchUnrecognizedEnum),
-  ]);
+> = openEnums.inboundSchema(ManagerEmploymentStatus);
 
 /** @internal */
 export const Manager$inboundSchema: z.ZodType<Manager, z.ZodTypeDef, unknown> =
@@ -949,6 +918,7 @@ export const Manager$inboundSchema: z.ZodType<Manager, z.ZodTypeDef, unknown> =
     last_name: z.nullable(z.string()),
     display_full_name: z.nullable(z.string()),
     id: z.string(),
+    employee_number: z.nullable(z.string()),
     work_email: z.nullable(z.string()).optional(),
     remote_id: z.string(),
     employment_status: z.nullable(ManagerEmploymentStatus$inboundSchema)

package/src/models/gethrisemploymentspositiveresponse.ts

@@ -4,7 +4,8 @@
 
 import * as z from "zod/v3";
 import { safeParse } from "../lib/schemas.js";
-import { catchUnrecognizedEnum, OpenEnum } from "../types/enums.js";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
 import { Result as SafeParseResult } from "../types/fp.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
 
@@ -154,11 +155,7 @@ export const GetHrisEmploymentsPositiveResponsePayPeriod$inboundSchema:
     GetHrisEmploymentsPositiveResponsePayPeriod,
     z.ZodTypeDef,
     unknown
-  > = z
-    .union([
-      z.nativeEnum(GetHrisEmploymentsPositiveResponsePayPeriod),
-      z.string().transform(catchUnrecognizedEnum),
-    ]);
+  > = openEnums.inboundSchema(GetHrisEmploymentsPositiveResponsePayPeriod);
 
 /** @internal */
 export const GetHrisEmploymentsPositiveResponsePayFrequency$inboundSchema:
@@ -166,11 +163,7 @@ export const GetHrisEmploymentsPositiveResponsePayFrequency$inboundSchema:
     GetHrisEmploymentsPositiveResponsePayFrequency,
     z.ZodTypeDef,
     unknown
-  > = z
-    .union([
-      z.nativeEnum(GetHrisEmploymentsPositiveResponsePayFrequency),
-      z.string().transform(catchUnrecognizedEnum),
-    ]);
+  > = openEnums.inboundSchema(GetHrisEmploymentsPositiveResponsePayFrequency);
 
 /** @internal */
 export const GetHrisEmploymentsPositiveResponseEmploymentType$inboundSchema:
@@ -178,11 +171,7 @@ export const GetHrisEmploymentsPositiveResponseEmploymentType$inboundSchema:
     GetHrisEmploymentsPositiveResponseEmploymentType,
     z.ZodTypeDef,
     unknown
-  > = z
-    .union([
-      z.nativeEnum(GetHrisEmploymentsPositiveResponseEmploymentType),
-      z.string().transform(catchUnrecognizedEnum),
-    ]);
+  > = openEnums.inboundSchema(GetHrisEmploymentsPositiveResponseEmploymentType);
 
 /** @internal */
 export const GetHrisEmploymentsPositiveResponseResult$inboundSchema: z.ZodType<

package/src/models/postconnectcreatelinkrequestbody.ts

@@ -172,6 +172,8 @@ export const IntegrationTool = {
   Absenceio: "absenceio",
   Manatal: "manatal",
   Avionte: "avionte",
+  A3innuvanomina: "a3innuvanomina",
+  Mhmhr: "mhmhr",
   Scim: "scim",
   Softgardenpartner: "softgardenpartner",
   Datevhr: "datevhr",

package/src/models/posthrisabsencespositiveresponse.ts

@@ -4,7 +4,8 @@
 
 import * as z from "zod/v3";
 import { safeParse } from "../lib/schemas.js";
-import { catchUnrecognizedEnum, ClosedEnum, OpenEnum } from "../types/enums.js";
+import * as openEnums from "../types/enums.js";
+import { ClosedEnum, OpenEnum } from "../types/enums.js";
 import { Result as SafeParseResult } from "../types/fp.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
 
@@ -124,11 +125,7 @@ export const PostHrisAbsencesPositiveResponseStatus$inboundSchema: z.ZodType<
   PostHrisAbsencesPositiveResponseStatus,
   z.ZodTypeDef,
   unknown
-> = z
-  .union([
-    z.nativeEnum(PostHrisAbsencesPositiveResponseStatus),
-    z.string().transform(catchUnrecognizedEnum),
-  ]);
+> = openEnums.inboundSchema(PostHrisAbsencesPositiveResponseStatus);
 
 /** @internal */
 export const PostHrisAbsencesPositiveResponseData$inboundSchema: z.ZodType<

package/src/sdk/general.ts

@@ -198,6 +198,7 @@ export class General extends ClientSDK {
    * |Manatal|`manatal/open-api-v3`|[Manatal's Open API v3](https://developers.manatal.com/reference/getting-started). We automatically authenticate all requests and use `https://api.manatal.com/open/v3` as the base URL.|
    * |Manatal|`manatal/career-page`|Manatal's Career Page API. We use `https://api.manatal.com/open/v3/career-page/\{client_slug\}` as the base URL.|
    * |Avionté|`avionte/front-office-v1`|Avionte's API. We automatically authenticate all requests and use `https://api.avionte.com/front-office/v1` as the base URL. Documentation for the BOLD Front Office API: https://developer.avionte.com/reference/get-all-talent-tags|
+   * |a3innuva Nómina|`a3innuvanomina/laboral`|a3innuva Nómina API [docs](https://a3developers.wolterskluwer.es/). Requests are automatically authenticated using OAuth access tokens (refreshed when needed). Base URL: `https://a3api.wolterskluwer.es/Laboral/api`.|
    * |DATEV|`datevhr/hr-exports`|DATEV's [hr-exports](https://developer.datev.de/en/product-detail/hr-exports/1.0.0/overview). We automatically authenticate all requests and use `https://hr-exports.api.datev.de/\{platform|platform-sandbox\}/v1/clients/\{client-id\}` as the base URL.|
    * |DATEV|`datevhr/hr:payrollreports`|DATEV's [hr:payrollreports](https://developer.datev.de/en/product-detail/hr-payrollreports/2.0.0/overview) API. We automatically authenticate all requests and use `https://hr-payrollreports.api.datev.de/\{platform|platform-sandbox\}/v1/clients/\{client-id\}/` as the base URL.|
    * |DATEV|`datevhr/eau`|DATEV's [eau](https://developer.datev.de/en/product-detail/eau-api/1.0.0/overview) API. We automatically authenticate all requests and use `https://eau.api.datev.de/\{platform|platform-sandbox\}/v1/clients/\{client-id\}/` as the base URL.|

package/src/types/enums.ts

@@ -2,15 +2,64 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import * as z from "zod/v3";
+
 declare const __brand: unique symbol;
 export type Unrecognized<T> = T & { [__brand]: "unrecognized" };
+export type ClosedEnum<T extends Readonly<Record<string, string | number>>> =
+  T[keyof T];
+export type OpenEnum<T extends Readonly<Record<string, string | number>>> =
+  | T[keyof T]
+  | Unrecognized<T[keyof T] extends number ? number : string>;
 
-export function catchUnrecognizedEnum<T>(value: T): Unrecognized<T> {
+function unrecognized<T>(value: T): Unrecognized<T> {
+  unrecognizedCount++;
   return value as Unrecognized<T>;
 }
 
-type Prettify<T> = { [K in keyof T]: T[K] } & {};
-export type ClosedEnum<T> = T[keyof T];
-export type OpenEnum<T> =
-  | Prettify<T[keyof T]>
-  | Unrecognized<T[keyof T] extends number ? number : string>;
+let unrecognizedCount = 0;
+let refCount = 0;
+export function unrecognizedCounter() {
+  refCount++;
+  const start = unrecognizedCount;
+  return {
+    count: () => {
+      const count = unrecognizedCount - start;
+      if (--refCount === 0) unrecognizedCount = 0;
+      return count;
+    },
+  };
+}
+
+export function inboundSchema<T extends Record<string, string>>(
+  enumObj: T,
+): z.ZodType<OpenEnum<T>, z.ZodTypeDef, unknown> {
+  const options = Object.values(enumObj);
+  return z.union([
+    ...options.map(x => z.literal(x)),
+    z.string().transform(x => unrecognized(x)),
+  ] as any);
+}
+
+export function inboundSchemaInt<T extends Record<string, number | string>>(
+  enumObj: T,
+): z.ZodType<OpenEnum<T>, z.ZodTypeDef, unknown> {
+  // For numeric enums, Object.values returns both numbers and string keys
+  const options = Object.values(enumObj).filter(v => typeof v === "number");
+  return z.union([
+    ...options.map(x => z.literal(x)),
+    z.number().int().transform(x => unrecognized(x)),
+  ] as any);
+}
+
+export function outboundSchema<T extends Record<string, string>>(
+  _: T,
+): z.ZodType<string, z.ZodTypeDef, OpenEnum<T>> {
+  return z.string() as any;
+}
+
+export function outboundSchemaInt<T extends Record<string, number | string>>(
+  _: T,
+): z.ZodType<number, z.ZodTypeDef, OpenEnum<T>> {
+  return z.number().int() as any;
+}

package/src/types/index.ts

@@ -3,7 +3,6 @@
  */
 
 export { blobLikeSchema, isBlobLike } from "./blobs.js";
-export { catchUnrecognizedEnum } from "./enums.js";
 export type { ClosedEnum, OpenEnum, Unrecognized } from "./enums.js";
 export type { Result } from "./fp.js";
 export type { PageIterator, Paginator } from "./operations.js";

package/tests/basic-behavior.spec.ts

@@ -0,0 +1,162 @@
+import { it, expect } from "vitest";
+import { TestContext, describeSdkSuite } from "./helpers/test-context";
+
+// TODO: test basic error handling behavior
+describeSdkSuite("Basic SDK Behavior", () => {
+  it("should include API key in Authorization header", async () => {
+    const ctx = new TestContext({ apiKey: "my-custom-api-key" });
+
+    ctx.mockEndpoint({
+      method: "GET",
+      path: "/v1/ats/jobs",
+      response: {
+        body: {
+          status: "success",
+          data: { results: [], next: null },
+        },
+      },
+    });
+
+    const jobs = await ctx.kombo.ats.getJobs({});
+    for await (const _page of jobs) {
+      break;
+    }
+
+    const request = ctx.getLastRequest();
+    expect(request?.headers.authorization).toBe("Bearer my-custom-api-key");
+  });
+
+  it("should include integration ID in X-Integration-Id header when specified", async () => {
+    const ctx = new TestContext({
+      apiKey: "test-key",
+      integrationId: "my-integration-123",
+    });
+
+    ctx.mockEndpoint({
+      method: "GET",
+      path: "/v1/ats/jobs",
+      response: {
+        body: {
+          status: "success",
+          data: { results: [], next: null },
+        },
+      },
+    });
+
+    const jobs = await ctx.kombo.ats.getJobs({});
+    for await (const _page of jobs) {
+      break;
+    }
+
+    const request = ctx.getLastRequest();
+    expect(request?.headers["x-integration-id"]).toBe("my-integration-123");
+  });
+
+  it("should not include X-Integration-Id header when not provided", async () => {
+    const ctx = new TestContext({
+      apiKey: "test-key",
+      integrationId: undefined,
+    });
+
+    ctx.mockEndpoint({
+      method: "GET",
+      path: "/v1/ats/jobs",
+      response: {
+        body: {
+          status: "success",
+          data: { results: [], next: null },
+        },
+      },
+    });
+
+    // TODO: shouldn't this throw an error?
+    const jobs = await ctx.kombo.ats.getJobs({});
+    for await (const _page of jobs) {
+      break;
+    }
+
+    const request = ctx.getLastRequest();
+    // When integration ID is undefined, the header is not set
+    expect(request?.headers["x-integration-id"]).toBeUndefined();
+  });
+
+  it("should correctly encode comma-separated query parameters", async () => {
+    const ctx = new TestContext();
+
+    ctx.mockEndpoint({
+      method: "GET",
+      path: "/v1/ats/jobs",
+      response: {
+        body: {
+          status: "success",
+          data: {
+            results: [],
+            next: null,
+          },
+        },
+      },
+    });
+
+    // Make the API call
+    const _jobs = await ctx.kombo.ats.getJobs({
+      statuses: ["OPEN", "CLOSED"],
+      ids: ["CPDifhHr7izJhKHmGPkXqknC", "J7znt8TJRiwPVA7paC2iCh8u"],
+    });
+
+    // Verify and snapshot the request details
+    const request = ctx.getLastRequest();
+    expect(request.path).toMatchInlineSnapshot(
+      `"/v1/ats/jobs?ids=CPDifhHr7izJhKHmGPkXqknC%2CJ7znt8TJRiwPVA7paC2iCh8u&statuses=OPEN%2CCLOSED&include_deleted=false&page_size=100"`
+    );
+  });
+
+  it("should correctly encode boolean query parameters", async () => {
+    const ctx = new TestContext();
+
+    ctx.mockEndpoint({
+      method: "GET",
+      path: "/v1/ats/jobs",
+      response: {
+        body: {
+          status: "success",
+          data: { results: [], next: null },
+        },
+      },
+    });
+
+    // Test with boolean true
+    const jobsWithDeleted = await ctx.kombo.ats.getJobs({
+      include_deleted: true,
+    });
+    for await (const _page of jobsWithDeleted) {
+      break;
+    }
+
+    const requestWithDeleted = ctx.getLastRequest();
+    expect(requestWithDeleted.path).toContain("include_deleted=true");
+
+    ctx.clear();
+
+    ctx.mockEndpoint({
+      method: "GET",
+      path: "/v1/ats/jobs",
+      response: {
+        body: {
+          status: "success",
+          data: { results: [], next: null },
+        },
+      },
+    });
+
+    // Test with boolean false
+    const jobsWithoutDeleted = await ctx.kombo.ats.getJobs({
+      include_deleted: false,
+    });
+    for await (const _page of jobsWithoutDeleted) {
+      break;
+    }
+
+    const requestWithoutDeleted = ctx.getLastRequest();
+    expect(requestWithoutDeleted.path).toContain("include_deleted=false");
+  });
+});