@unified-api/typescript-sdk 2.83.5 → 2.83.7

package/src/sdk/models/shared/hrisbankaccount.ts

@@ -0,0 +1,150 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.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";
+
+export const AccountType = {
+  Checking: "CHECKING",
+  Savings: "SAVINGS",
+} as const;
+export type AccountType = OpenEnum<typeof AccountType>;
+
+/**
+ * Employee payroll bank account for direct deposit.
+ */
+export type HrisBankaccount = {
+  accountNumber?: string | undefined;
+  accountNumberLast4?: string | undefined;
+  accountType?: AccountType | undefined;
+  bankName?: string | undefined;
+  companyId?: string | undefined;
+  createdAt?: Date | undefined;
+  id?: string | undefined;
+  isPrimary?: boolean | undefined;
+  name?: string | undefined;
+  raw?: { [k: string]: any } | undefined;
+  routingNumber?: string | undefined;
+  updatedAt?: Date | undefined;
+  userId?: string | undefined;
+};
+
+/** @internal */
+export const AccountType$inboundSchema: z.ZodType<
+  AccountType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(AccountType);
+/** @internal */
+export const AccountType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  AccountType
+> = openEnums.outboundSchema(AccountType);
+
+/** @internal */
+export const HrisBankaccount$inboundSchema: z.ZodType<
+  HrisBankaccount,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  account_number: z.string().optional(),
+  account_number_last4: z.string().optional(),
+  account_type: AccountType$inboundSchema.optional(),
+  bank_name: z.string().optional(),
+  company_id: z.string().optional(),
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  id: z.string().optional(),
+  is_primary: z.boolean().optional(),
+  name: z.string().optional(),
+  raw: z.record(z.any()).optional(),
+  routing_number: z.string().optional(),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  user_id: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "account_number": "accountNumber",
+    "account_number_last4": "accountNumberLast4",
+    "account_type": "accountType",
+    "bank_name": "bankName",
+    "company_id": "companyId",
+    "created_at": "createdAt",
+    "is_primary": "isPrimary",
+    "routing_number": "routingNumber",
+    "updated_at": "updatedAt",
+    "user_id": "userId",
+  });
+});
+/** @internal */
+export type HrisBankaccount$Outbound = {
+  account_number?: string | undefined;
+  account_number_last4?: string | undefined;
+  account_type?: string | undefined;
+  bank_name?: string | undefined;
+  company_id?: string | undefined;
+  created_at?: string | undefined;
+  id?: string | undefined;
+  is_primary?: boolean | undefined;
+  name?: string | undefined;
+  raw?: { [k: string]: any } | undefined;
+  routing_number?: string | undefined;
+  updated_at?: string | undefined;
+  user_id?: string | undefined;
+};
+
+/** @internal */
+export const HrisBankaccount$outboundSchema: z.ZodType<
+  HrisBankaccount$Outbound,
+  z.ZodTypeDef,
+  HrisBankaccount
+> = z.object({
+  accountNumber: z.string().optional(),
+  accountNumberLast4: z.string().optional(),
+  accountType: AccountType$outboundSchema.optional(),
+  bankName: z.string().optional(),
+  companyId: z.string().optional(),
+  createdAt: z.date().transform(v => v.toISOString()).optional(),
+  id: z.string().optional(),
+  isPrimary: z.boolean().optional(),
+  name: z.string().optional(),
+  raw: z.record(z.any()).optional(),
+  routingNumber: z.string().optional(),
+  updatedAt: z.date().transform(v => v.toISOString()).optional(),
+  userId: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    accountNumber: "account_number",
+    accountNumberLast4: "account_number_last4",
+    accountType: "account_type",
+    bankName: "bank_name",
+    companyId: "company_id",
+    createdAt: "created_at",
+    isPrimary: "is_primary",
+    routingNumber: "routing_number",
+    updatedAt: "updated_at",
+    userId: "user_id",
+  });
+});
+
+export function hrisBankaccountToJSON(
+  hrisBankaccount: HrisBankaccount,
+): string {
+  return JSON.stringify(HrisBankaccount$outboundSchema.parse(hrisBankaccount));
+}
+export function hrisBankaccountFromJSON(
+  jsonString: string,
+): SafeParseResult<HrisBankaccount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => HrisBankaccount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'HrisBankaccount' from JSON`,
+  );
+}

package/src/sdk/models/shared/hriscompensation.ts

@@ -37,6 +37,7 @@ export type HrisCompensation = {
   currency?: string | undefined;
   frequency?: HrisCompensationFrequency | undefined;
   groupId?: string | undefined;
+  notes?: string | undefined;
   type?: HrisCompensationType | undefined;
 };
 
@@ -76,6 +77,7 @@ export const HrisCompensation$inboundSchema: z.ZodType<
   currency: z.string().optional(),
   frequency: HrisCompensationFrequency$inboundSchema.optional(),
   group_id: z.string().optional(),
+  notes: z.string().optional(),
   type: HrisCompensationType$inboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
@@ -88,6 +90,7 @@ export type HrisCompensation$Outbound = {
   currency?: string | undefined;
   frequency?: string | undefined;
   group_id?: string | undefined;
+  notes?: string | undefined;
   type?: string | undefined;
 };
 
@@ -101,6 +104,7 @@ export const HrisCompensation$outboundSchema: z.ZodType<
   currency: z.string().optional(),
   frequency: HrisCompensationFrequency$outboundSchema.optional(),
   groupId: z.string().optional(),
+  notes: z.string().optional(),
   type: HrisCompensationType$outboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {

package/src/sdk/models/shared/hrisdeduction.ts

@@ -53,6 +53,7 @@ export type HrisDeduction = {
   frequency?: HrisDeductionFrequency | undefined;
   id?: string | undefined;
   isActive?: boolean | undefined;
+  notes?: string | undefined;
   raw?: { [k: string]: any } | undefined;
   startAt?: Date | undefined;
   type?: HrisDeductionType | undefined;
@@ -116,6 +117,7 @@ export const HrisDeduction$inboundSchema: z.ZodType<
   frequency: HrisDeductionFrequency$inboundSchema.optional(),
   id: z.string().optional(),
   is_active: z.boolean().optional(),
+  notes: z.string().optional(),
   raw: z.record(z.any()).optional(),
   start_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),
@@ -147,6 +149,7 @@ export type HrisDeduction$Outbound = {
   frequency?: string | undefined;
   id?: string | undefined;
   is_active?: boolean | undefined;
+  notes?: string | undefined;
   raw?: { [k: string]: any } | undefined;
   start_at?: string | undefined;
   type?: string | undefined;
@@ -169,6 +172,7 @@ export const HrisDeduction$outboundSchema: z.ZodType<
   frequency: HrisDeductionFrequency$outboundSchema.optional(),
   id: z.string().optional(),
   isActive: z.boolean().optional(),
+  notes: z.string().optional(),
   raw: z.record(z.any()).optional(),
   startAt: z.date().transform(v => v.toISOString()).optional(),
   type: HrisDeductionType$outboundSchema.optional(),

package/src/sdk/models/shared/hrispayslip.ts

@@ -30,7 +30,7 @@ export type HrisPayslip = {
   createdAt?: Date | undefined;
   currency?: string | undefined;
   /**
-   * // The ID (and optionally name) of the employee deduction (if this detail represents a deduction)
+   * The ID (and optionally name) of the employee deduction (if this detail represents a deduction)
    */
   deduction?: PropertyHrisPayslipDeduction | undefined;
   details?: Array<HrisPayslipDetail> | undefined;

package/src/sdk/models/shared/index.ts

@@ -137,6 +137,7 @@ export * from "./genaiembedding.js";
 export * from "./genaiembeddingcontent.js";
 export * from "./genaimodel.js";
 export * from "./genaiprompt.js";
+export * from "./hrisbankaccount.js";
 export * from "./hrisbenefit.js";
 export * from "./hriscompany.js";
 export * from "./hriscompensation.js";

package/src/sdk/models/shared/integrationsupport.ts

@@ -616,6 +616,13 @@ export const NativeWebhookTaskId = {
 } as const;
 export type NativeWebhookTaskId = OpenEnum<typeof NativeWebhookTaskId>;
 
+export const NativeWebhookType = {
+  SupportedRequired: "supported-required",
+  Supported: "supported",
+  NotSupported: "not-supported",
+} as const;
+export type NativeWebhookType = OpenEnum<typeof NativeWebhookType>;
+
 export const SearchDomain = {
   SupportedRequired: "supported-required",
   Supported: "supported",
@@ -1109,6 +1116,7 @@ export type IntegrationSupport = {
   nativeWebhookShipmentId?: NativeWebhookShipmentId | undefined;
   nativeWebhookStudentId?: NativeWebhookStudentId | undefined;
   nativeWebhookTaskId?: NativeWebhookTaskId | undefined;
+  nativeWebhookType?: NativeWebhookType | undefined;
   outboundFields?: { [k: string]: string } | undefined;
   /**
    * objects that we map from in the integration
@@ -1774,6 +1782,13 @@ export const NativeWebhookTaskId$inboundSchema: z.ZodType<
   unknown
 > = openEnums.inboundSchema(NativeWebhookTaskId);
 
+/** @internal */
+export const NativeWebhookType$inboundSchema: z.ZodType<
+  NativeWebhookType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(NativeWebhookType);
+
 /** @internal */
 export const SearchDomain$inboundSchema: z.ZodType<
   SearchDomain,
@@ -2246,6 +2261,7 @@ export const IntegrationSupport$inboundSchema: z.ZodType<
   native_webhook_shipment_id: NativeWebhookShipmentId$inboundSchema.optional(),
   native_webhook_student_id: NativeWebhookStudentId$inboundSchema.optional(),
   native_webhook_task_id: NativeWebhookTaskId$inboundSchema.optional(),
+  native_webhook_type: NativeWebhookType$inboundSchema.optional(),
   outbound_fields: z.record(z.string()).optional(),
   raw_objects: z.array(z.string()).optional(),
   search_domain: SearchDomain$inboundSchema.optional(),
@@ -2407,6 +2423,7 @@ export const IntegrationSupport$inboundSchema: z.ZodType<
     "native_webhook_shipment_id": "nativeWebhookShipmentId",
     "native_webhook_student_id": "nativeWebhookStudentId",
     "native_webhook_task_id": "nativeWebhookTaskId",
+    "native_webhook_type": "nativeWebhookType",
     "outbound_fields": "outboundFields",
     "raw_objects": "rawObjects",
     "search_domain": "searchDomain",

package/src/sdk/models/shared/propertyadsreportmetricscampaign.ts

@@ -57,6 +57,7 @@ export type PropertyAdsReportMetricsCampaign = {
   budgetAmount?: number | undefined;
   budgetPeriod?: PropertyAdsReportMetricsCampaignBudgetPeriod | undefined;
   createdAt?: Date | undefined;
+  currency?: string | undefined;
   endAt?: Date | undefined;
   frequencyCap?: PropertyAdsReportMetricsCampaignFrequencyCap | undefined;
   goal?: PropertyAdsReportMetricsCampaignGoal | undefined;
@@ -106,6 +107,7 @@ export const PropertyAdsReportMetricsCampaign$inboundSchema: z.ZodType<
     .optional(),
   created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),
+  currency: z.string().optional(),
   end_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),
   frequency_cap: PropertyAdsReportMetricsCampaignFrequencyCap$inboundSchema

package/src/sdk/models/shared/propertyadsreportmetricsgroup.ts

@@ -93,6 +93,7 @@ export type PropertyAdsReportMetricsGroup = {
   campaignId?: string | undefined;
   createdAt?: Date | undefined;
   creativeIds?: Array<string> | undefined;
+  currency?: string | undefined;
   endAt?: Date | undefined;
   frequencyCap?: PropertyAdsReportMetricsGroupFrequencyCap | undefined;
   hasEuPoliticalAds?: boolean | undefined;
@@ -169,6 +170,7 @@ export const PropertyAdsReportMetricsGroup$inboundSchema: z.ZodType<
   created_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),
   creative_ids: z.array(z.string()).optional(),
+  currency: z.string().optional(),
   end_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),
   frequency_cap: PropertyAdsReportMetricsGroupFrequencyCap$inboundSchema

package/src/sdk/models/shared/propertyconnectionpermissions.ts

@@ -137,6 +137,8 @@ export const PropertyConnectionPermissions = {
   HrisDeductionWrite: "hris_deduction_write",
   HrisBenefitRead: "hris_benefit_read",
   HrisBenefitWrite: "hris_benefit_write",
+  HrisBankaccountRead: "hris_bankaccount_read",
+  HrisBankaccountWrite: "hris_bankaccount_write",
   UcCallRead: "uc_call_read",
   UcContactRead: "uc_contact_read",
   UcContactWrite: "uc_contact_write",

package/src/sdk/models/shared/propertyhrispayslipdeduction.ts

@@ -45,7 +45,7 @@ export type PropertyHrisPayslipDeductionType = OpenEnum<
 >;
 
 /**
- * // The ID (and optionally name) of the employee deduction (if this detail represents a deduction)
+ * The ID (and optionally name) of the employee deduction (if this detail represents a deduction)
  */
 export type PropertyHrisPayslipDeduction = {
   amount?: number | undefined;
@@ -57,6 +57,7 @@ export type PropertyHrisPayslipDeduction = {
   frequency?: PropertyHrisPayslipDeductionFrequency | undefined;
   id?: string | undefined;
   isActive?: boolean | undefined;
+  notes?: string | undefined;
   raw?: { [k: string]: any } | undefined;
   startAt?: Date | undefined;
   type?: PropertyHrisPayslipDeductionType | undefined;
@@ -103,6 +104,7 @@ export const PropertyHrisPayslipDeduction$inboundSchema: z.ZodType<
   frequency: PropertyHrisPayslipDeductionFrequency$inboundSchema.optional(),
   id: z.string().optional(),
   is_active: z.boolean().optional(),
+  notes: z.string().optional(),
   raw: z.record(z.any()).optional(),
   start_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),

package/src/sdk/models/shared/webhook.ts

@@ -88,6 +88,7 @@ export const ObjectType = {
   HrisTimeshift: "hris_timeshift",
   HrisDeduction: "hris_deduction",
   HrisBenefit: "hris_benefit",
+  HrisBankaccount: "hris_bankaccount",
   MartechList: "martech_list",
   MartechMember: "martech_member",
   MartechCampaign: "martech_campaign",

package/src/sdk/sdk.ts

@@ -15,6 +15,7 @@ import { Assessment } from "./assessment.js";
 import { Ats } from "./ats.js";
 import { Auth } from "./auth.js";
 import { Balancesheet } from "./balancesheet.js";
+import { Bankaccount } from "./bankaccount.js";
 import { Benefit } from "./benefit.js";
 import { Bill } from "./bill.js";
 import { Branch } from "./branch.js";
@@ -465,6 +466,11 @@ export class UnifiedTo extends ClientSDK {
     return (this._hris ??= new Hris(this._options));
   }
 
+  private _bankaccount?: Bankaccount;
+  get bankaccount(): Bankaccount {
+    return (this._bankaccount ??= new Bankaccount(this._options));
+  }
+
   private _benefit?: Benefit;
   get benefit(): Benefit {
     return (this._benefit ??= new Benefit(this._options));