@kombo-api/sdk 1.0.1 → 1.0.2

package/src/models/getatsrolespositiveresponse.ts

@@ -0,0 +1,167 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { ClosedEnum } from "../types/enums.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+/**
+ * Whether the role applies globally or is scoped to a specific job.
+ */
+export const GetAtsRolesPositiveResponseScope = {
+  System: "SYSTEM",
+  Job: "JOB",
+} as const;
+/**
+ * Whether the role applies globally or is scoped to a specific job.
+ */
+export type GetAtsRolesPositiveResponseScope = ClosedEnum<
+  typeof GetAtsRolesPositiveResponseScope
+>;
+
+/**
+ * Unified role type if Kombo can map it.
+ */
+export const GetAtsRolesPositiveResponseUnifiedType = {
+  HiringManager: "HIRING_MANAGER",
+  Recruiter: "RECRUITER",
+  Coordinator: "COORDINATOR",
+  Sourcer: "SOURCER",
+  Interviewer: "INTERVIEWER",
+  Admin: "ADMIN",
+} as const;
+/**
+ * Unified role type if Kombo can map it.
+ */
+export type GetAtsRolesPositiveResponseUnifiedType = ClosedEnum<
+  typeof GetAtsRolesPositiveResponseUnifiedType
+>;
+
+export type GetAtsRolesPositiveResponseResult = {
+  /**
+   * The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.
+   */
+  id: string;
+  /**
+   * The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key.
+   */
+  remote_id: string | null;
+  /**
+   * The label of the role.
+   */
+  remote_label: string | null;
+  /**
+   * Whether the role applies globally or is scoped to a specific job.
+   */
+  scope: GetAtsRolesPositiveResponseScope | null;
+  /**
+   * Unified role type if Kombo can map it.
+   */
+  unified_type: GetAtsRolesPositiveResponseUnifiedType | null;
+  /**
+   * The timestamp when this specific record was last modified. This field only updates when properties directly on this record change, NOT when related or nested models change. For filtering that considers nested data changes, use the `updated_after` parameter which will return records when either the record itself OR its related models have been updated.
+   */
+  changed_at: Date;
+  /**
+   * The date and time the object was deleted in the remote system. Objects are automatically marked as deleted when Kombo can't retrieve them from the remote system anymore. Kombo will also anonymize entries 14 days after they disappear.
+   */
+  remote_deleted_at: Date | null;
+};
+
+export type GetAtsRolesPositiveResponseData = {
+  /**
+   * Cursor string that can be passed to the `cursor` query parameter to get the next page. If this is `null`, then there are no more pages.
+   */
+  next: string | null;
+  results: Array<GetAtsRolesPositiveResponseResult>;
+};
+
+export type GetAtsRolesPositiveResponse = {
+  status: "success";
+  data: GetAtsRolesPositiveResponseData;
+};
+
+/** @internal */
+export const GetAtsRolesPositiveResponseScope$inboundSchema: z.ZodNativeEnum<
+  typeof GetAtsRolesPositiveResponseScope
+> = z.nativeEnum(GetAtsRolesPositiveResponseScope);
+
+/** @internal */
+export const GetAtsRolesPositiveResponseUnifiedType$inboundSchema:
+  z.ZodNativeEnum<typeof GetAtsRolesPositiveResponseUnifiedType> = z.nativeEnum(
+    GetAtsRolesPositiveResponseUnifiedType,
+  );
+
+/** @internal */
+export const GetAtsRolesPositiveResponseResult$inboundSchema: z.ZodType<
+  GetAtsRolesPositiveResponseResult,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  remote_id: z.nullable(z.string()),
+  remote_label: z.nullable(z.string()),
+  scope: z.nullable(GetAtsRolesPositiveResponseScope$inboundSchema),
+  unified_type: z.nullable(
+    GetAtsRolesPositiveResponseUnifiedType$inboundSchema,
+  ),
+  changed_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  remote_deleted_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+});
+
+export function getAtsRolesPositiveResponseResultFromJSON(
+  jsonString: string,
+): SafeParseResult<GetAtsRolesPositiveResponseResult, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetAtsRolesPositiveResponseResult$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetAtsRolesPositiveResponseResult' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetAtsRolesPositiveResponseData$inboundSchema: z.ZodType<
+  GetAtsRolesPositiveResponseData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  next: z.nullable(z.string()),
+  results: z.array(
+    z.lazy(() => GetAtsRolesPositiveResponseResult$inboundSchema),
+  ),
+});
+
+export function getAtsRolesPositiveResponseDataFromJSON(
+  jsonString: string,
+): SafeParseResult<GetAtsRolesPositiveResponseData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetAtsRolesPositiveResponseData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetAtsRolesPositiveResponseData' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetAtsRolesPositiveResponse$inboundSchema: z.ZodType<
+  GetAtsRolesPositiveResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  status: z.literal("success"),
+  data: z.lazy(() => GetAtsRolesPositiveResponseData$inboundSchema),
+});
+
+export function getAtsRolesPositiveResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetAtsRolesPositiveResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetAtsRolesPositiveResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetAtsRolesPositiveResponse' from JSON`,
+  );
+}

package/src/models/getatsuserspositiveresponse.ts

@@ -22,6 +22,57 @@ export type GetAtsUsersPositiveResponseStatus = ClosedEnum<
   typeof GetAtsUsersPositiveResponseStatus
 >;
 
+/**
+ * Whether the role applies globally or is scoped to a specific job.
+ */
+export const GetAtsUsersPositiveResponseScope = {
+  System: "SYSTEM",
+  Job: "JOB",
+} as const;
+/**
+ * Whether the role applies globally or is scoped to a specific job.
+ */
+export type GetAtsUsersPositiveResponseScope = ClosedEnum<
+  typeof GetAtsUsersPositiveResponseScope
+>;
+
+/**
+ * Unified role type if Kombo can map it.
+ */
+export const GetAtsUsersPositiveResponseUnifiedType = {
+  HiringManager: "HIRING_MANAGER",
+  Recruiter: "RECRUITER",
+  Coordinator: "COORDINATOR",
+  Sourcer: "SOURCER",
+  Interviewer: "INTERVIEWER",
+  Admin: "ADMIN",
+} as const;
+/**
+ * Unified role type if Kombo can map it.
+ */
+export type GetAtsUsersPositiveResponseUnifiedType = ClosedEnum<
+  typeof GetAtsUsersPositiveResponseUnifiedType
+>;
+
+export type SystemRole = {
+  /**
+   * The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key.
+   */
+  remote_id: string | null;
+  /**
+   * The label of the role.
+   */
+  remote_label: string | null;
+  /**
+   * Whether the role applies globally or is scoped to a specific job.
+   */
+  scope: GetAtsUsersPositiveResponseScope | null;
+  /**
+   * Unified role type if Kombo can map it.
+   */
+  unified_type: GetAtsUsersPositiveResponseUnifiedType | null;
+};
+
 export type GetAtsUsersPositiveResponseResult = {
   /**
    * The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.
@@ -55,6 +106,16 @@ export type GetAtsUsersPositiveResponseResult = {
    * The date and time the object was deleted in the remote system. Objects are automatically marked as deleted when Kombo can't retrieve them from the remote system anymore. Kombo will also anonymize entries 14 days after they disappear.
    */
   remote_deleted_at: Date | null;
+  /**
+   * System-wide roles assigned to this user in the ATS.
+   *
+   * @remarks
+   *
+   * Visit our in-depth guide about [roles](/ats/features/roles) to learn more.
+   *
+   * Note: Use `job_roles` on the `/v1/ats/jobs` endpoint for job-specific roles.
+   */
+  system_roles: Array<SystemRole>;
 };
 
 export type GetAtsUsersPositiveResponseData = {
@@ -75,6 +136,41 @@ export const GetAtsUsersPositiveResponseStatus$inboundSchema: z.ZodNativeEnum<
   typeof GetAtsUsersPositiveResponseStatus
 > = z.nativeEnum(GetAtsUsersPositiveResponseStatus);
 
+/** @internal */
+export const GetAtsUsersPositiveResponseScope$inboundSchema: z.ZodNativeEnum<
+  typeof GetAtsUsersPositiveResponseScope
+> = z.nativeEnum(GetAtsUsersPositiveResponseScope);
+
+/** @internal */
+export const GetAtsUsersPositiveResponseUnifiedType$inboundSchema:
+  z.ZodNativeEnum<typeof GetAtsUsersPositiveResponseUnifiedType> = z.nativeEnum(
+    GetAtsUsersPositiveResponseUnifiedType,
+  );
+
+/** @internal */
+export const SystemRole$inboundSchema: z.ZodType<
+  SystemRole,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  remote_id: z.nullable(z.string()),
+  remote_label: z.nullable(z.string()),
+  scope: z.nullable(GetAtsUsersPositiveResponseScope$inboundSchema),
+  unified_type: z.nullable(
+    GetAtsUsersPositiveResponseUnifiedType$inboundSchema,
+  ),
+});
+
+export function systemRoleFromJSON(
+  jsonString: string,
+): SafeParseResult<SystemRole, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SystemRole$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SystemRole' from JSON`,
+  );
+}
+
 /** @internal */
 export const GetAtsUsersPositiveResponseResult$inboundSchema: z.ZodType<
   GetAtsUsersPositiveResponseResult,
@@ -91,6 +187,7 @@ export const GetAtsUsersPositiveResponseResult$inboundSchema: z.ZodType<
   remote_deleted_at: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ),
+  system_roles: z.array(z.lazy(() => SystemRole$inboundSchema)),
 });
 
 export function getAtsUsersPositiveResponseResultFromJSON(

package/src/models/gethrisemployeespositiveresponse.ts

@@ -390,7 +390,7 @@ export type Manager = {
 /**
  * Type of the group.
  */
-export const GroupType = {
+export const GetHrisEmployeesPositiveResponseGroupType = {
   Department: "DEPARTMENT",
   Team: "TEAM",
   CostCenter: "COST_CENTER",
@@ -398,9 +398,11 @@ export const GroupType = {
 /**
  * Type of the group.
  */
-export type GroupType = ClosedEnum<typeof GroupType>;
+export type GetHrisEmployeesPositiveResponseGroupType = ClosedEnum<
+  typeof GetHrisEmployeesPositiveResponseGroupType
+>;
 
-export type Group = {
+export type GetHrisEmployeesPositiveResponseGroup = {
   /**
    * The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.
    */
@@ -416,7 +418,7 @@ export type Group = {
   /**
    * Type of the group.
    */
-  type: GroupType | null;
+  type: GetHrisEmployeesPositiveResponseGroupType | null;
 };
 
 /**
@@ -441,7 +443,7 @@ export type LegalEntityAddress = {
   zip_code?: string | null | undefined;
 };
 
-export type LegalEntity = {
+export type GetHrisEmployeesPositiveResponseLegalEntity = {
   /**
    * The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.
    */
@@ -670,8 +672,8 @@ export type GetHrisEmployeesPositiveResponseResult = {
   employments: Array<Employment>;
   time_off_balances: Array<TimeOffBalance>;
   manager: Manager | null;
-  groups: Array<Group>;
-  legal_entity: LegalEntity | null;
+  groups: Array<GetHrisEmployeesPositiveResponseGroup>;
+  legal_entity: GetHrisEmployeesPositiveResponseLegalEntity | null;
   work_location: WorkLocation | null;
 };
 
@@ -939,25 +941,30 @@ export function managerFromJSON(
 }
 
 /** @internal */
-export const GroupType$inboundSchema: z.ZodNativeEnum<typeof GroupType> = z
-  .nativeEnum(GroupType);
+export const GetHrisEmployeesPositiveResponseGroupType$inboundSchema:
+  z.ZodNativeEnum<typeof GetHrisEmployeesPositiveResponseGroupType> = z
+    .nativeEnum(GetHrisEmployeesPositiveResponseGroupType);
 
 /** @internal */
-export const Group$inboundSchema: z.ZodType<Group, z.ZodTypeDef, unknown> = z
-  .object({
-    id: z.string(),
-    remote_id: z.string(),
-    name: z.nullable(z.string()),
-    type: z.nullable(GroupType$inboundSchema),
-  });
+export const GetHrisEmployeesPositiveResponseGroup$inboundSchema: z.ZodType<
+  GetHrisEmployeesPositiveResponseGroup,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  remote_id: z.string(),
+  name: z.nullable(z.string()),
+  type: z.nullable(GetHrisEmployeesPositiveResponseGroupType$inboundSchema),
+});
 
-export function groupFromJSON(
+export function getHrisEmployeesPositiveResponseGroupFromJSON(
   jsonString: string,
-): SafeParseResult<Group, SDKValidationError> {
+): SafeParseResult<GetHrisEmployeesPositiveResponseGroup, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Group$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Group' from JSON`,
+    (x) =>
+      GetHrisEmployeesPositiveResponseGroup$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetHrisEmployeesPositiveResponseGroup' from JSON`,
   );
 }
 
@@ -987,25 +994,32 @@ export function legalEntityAddressFromJSON(
 }
 
 /** @internal */
-export const LegalEntity$inboundSchema: z.ZodType<
-  LegalEntity,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  id: z.string(),
-  remote_id: z.nullable(z.string()),
-  name: z.nullable(z.string()),
-  address: z.nullable(z.lazy(() => LegalEntityAddress$inboundSchema))
-    .optional(),
-});
+export const GetHrisEmployeesPositiveResponseLegalEntity$inboundSchema:
+  z.ZodType<
+    GetHrisEmployeesPositiveResponseLegalEntity,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    id: z.string(),
+    remote_id: z.nullable(z.string()),
+    name: z.nullable(z.string()),
+    address: z.nullable(z.lazy(() => LegalEntityAddress$inboundSchema))
+      .optional(),
+  });
 
-export function legalEntityFromJSON(
+export function getHrisEmployeesPositiveResponseLegalEntityFromJSON(
   jsonString: string,
-): SafeParseResult<LegalEntity, SDKValidationError> {
+): SafeParseResult<
+  GetHrisEmployeesPositiveResponseLegalEntity,
+  SDKValidationError
+> {
   return safeParse(
     jsonString,
-    (x) => LegalEntity$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'LegalEntity' from JSON`,
+    (x) =>
+      GetHrisEmployeesPositiveResponseLegalEntity$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetHrisEmployeesPositiveResponseLegalEntity' from JSON`,
   );
 }
 
@@ -1117,8 +1131,12 @@ export const GetHrisEmployeesPositiveResponseResult$inboundSchema: z.ZodType<
   employments: z.array(z.lazy(() => Employment$inboundSchema)),
   time_off_balances: z.array(z.lazy(() => TimeOffBalance$inboundSchema)),
   manager: z.nullable(z.lazy(() => Manager$inboundSchema)),
-  groups: z.array(z.lazy(() => Group$inboundSchema)),
-  legal_entity: z.nullable(z.lazy(() => LegalEntity$inboundSchema)),
+  groups: z.array(
+    z.lazy(() => GetHrisEmployeesPositiveResponseGroup$inboundSchema),
+  ),
+  legal_entity: z.nullable(
+    z.lazy(() => GetHrisEmployeesPositiveResponseLegalEntity$inboundSchema),
+  ),
   work_location: z.nullable(z.lazy(() => WorkLocation$inboundSchema)),
 });