@mergeapi/merge-node-client 0.1.1 → 0.1.3

package/api/resources/hris/types/EmployeePayGroup.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Merge from "../../..";
+/**
+ * The employee's pay group
+ */
+export declare type EmployeePayGroup = string | Merge.hris.PayGroup;

package/api/resources/hris/types/EmployeePayGroup.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/hris/types/EmployeePayrollRun.d.ts

@@ -15,26 +15,26 @@ export interface EmployeePayrollRun {
     /** The third-party API ID of the matching object. */
     remoteId?: string;
     /** The employee whose payroll is being run. */
-    employee?: string;
+    employee?: Merge.hris.EmployeePayrollRunEmployee;
     /** The payroll being run. */
-    payrollRun?: string;
+    payrollRun?: Merge.hris.EmployeePayrollRunPayrollRun;
     /** The total earnings throughout a given period for an employee before any deductions are made. */
     grossPay?: number;
     /** The take-home pay throughout a given period for an employee after deductions are made. */
     netPay?: number;
     /** The day and time the payroll run started. */
-    startDate?: string;
+    startDate?: Date;
     /** The day and time the payroll run ended. */
-    endDate?: string;
+    endDate?: Date;
     /** The day and time the payroll run was checked. */
-    checkDate?: string;
+    checkDate?: Date;
     earnings?: Merge.hris.Earning[];
     deductions?: Merge.hris.Deduction[];
     taxes?: Merge.hris.Tax[];
     /** Indicates whether or not this object has been deleted by third party webhooks. */
     remoteWasDeleted?: boolean;
     /** This is the datetime that this object was last updated by Merge */
-    modifiedAt?: string;
+    modifiedAt?: Date;
     fieldMappings?: Record<string, unknown>;
     remoteData?: Merge.hris.RemoteData[];
 }

package/api/resources/hris/types/EmployeePayrollRunEmployee.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Merge from "../../..";
+/**
+ * The employee whose payroll is being run.
+ */
+export declare type EmployeePayrollRunEmployee = string | Merge.hris.Employee;

package/api/resources/hris/types/EmployeePayrollRunEmployee.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/hris/types/EmployeePayrollRunPayrollRun.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Merge from "../../..";
+/**
+ * The payroll being run.
+ */
+export declare type EmployeePayrollRunPayrollRun = string | Merge.hris.PayrollRun;

package/api/resources/hris/types/EmployeePayrollRunPayrollRun.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/hris/types/EmployeeRequest.d.ts

@@ -14,7 +14,7 @@ export interface EmployeeRequest {
     /** The employee's number that appears in the third-party integration's UI. */
     employeeNumber?: string;
     /** The ID of the employee's company. */
-    company?: string;
+    company?: Merge.hris.EmployeeRequestCompany;
     /** The employee's first name. */
     firstName?: string;
     /** The employee's last name. */
@@ -23,7 +23,7 @@ export interface EmployeeRequest {
     displayFullName?: string;
     /** The employee's username that appears in the remote UI. */
     username?: string;
-    groups?: (string | undefined)[];
+    groups?: (Merge.hris.EmployeeRequestGroupsItem | undefined)[];
     /** The employee's work email. */
     workEmail?: string;
     /** The employee's personal email. */
@@ -31,17 +31,17 @@ export interface EmployeeRequest {
     /** The employee's mobile phone number. */
     mobilePhoneNumber?: string;
     /** Array of `Employment` IDs for this Employee. */
-    employments?: (string | undefined)[];
+    employments?: (Merge.hris.EmployeeRequestEmploymentsItem | undefined)[];
     /** The employee's home address. */
-    homeLocation?: string;
+    homeLocation?: Merge.hris.EmployeeRequestHomeLocation;
     /** The employee's work address. */
-    workLocation?: string;
+    workLocation?: Merge.hris.EmployeeRequestWorkLocation;
     /** The employee ID of the employee's manager. */
-    manager?: string;
+    manager?: Merge.hris.EmployeeRequestManager;
     /** The employee's team. */
-    team?: string;
+    team?: Merge.hris.EmployeeRequestTeam;
     /** The employee's pay group */
-    payGroup?: string;
+    payGroup?: Merge.hris.EmployeeRequestPayGroup;
     /** The employee's social security number. */
     ssn?: string;
     /**
@@ -78,11 +78,11 @@ export interface EmployeeRequest {
      */
     maritalStatus?: Merge.hris.EmployeeRequestMaritalStatus;
     /** The employee's date of birth. */
-    dateOfBirth?: string;
+    dateOfBirth?: Date;
     /** The date that the employee was hired, usually the day that an offer letter is signed. If an employee has multiple hire dates from previous employments, this represents the most recent hire date. Note: If you're looking for the employee's start date, refer to the start_date field. */
-    hireDate?: string;
+    hireDate?: Date;
     /** The date that the employee started working. If an employee was rehired, the most recent start date will be returned. */
-    startDate?: string;
+    startDate?: Date;
     /**
      * The employment status of the employee.
      *
@@ -92,7 +92,7 @@ export interface EmployeeRequest {
      */
     employmentStatus?: Merge.hris.EmployeeRequestEmploymentStatus;
     /** The employee's termination date. */
-    terminationDate?: string;
+    terminationDate?: Date;
     /** The URL of the employee's avatar image. */
     avatar?: string;
     integrationParams?: Record<string, unknown>;

package/api/resources/hris/types/EmployeeRequestCompany.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Merge from "../../..";
+/**
+ * The ID of the employee's company.
+ */
+export declare type EmployeeRequestCompany = string | Merge.hris.Company;

package/api/resources/hris/types/EmployeeRequestCompany.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/hris/types/EmployeeRequestEmploymentsItem.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Merge from "../../..";
+export declare type EmployeeRequestEmploymentsItem = string | Merge.hris.Employment;

package/api/resources/hris/types/EmployeeRequestEmploymentsItem.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/hris/types/EmployeeRequestGroupsItem.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Merge from "../../..";
+export declare type EmployeeRequestGroupsItem = string | Merge.hris.Group;

package/api/resources/hris/types/EmployeeRequestGroupsItem.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/hris/types/EmployeeRequestHomeLocation.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Merge from "../../..";
+/**
+ * The employee's home address.
+ */
+export declare type EmployeeRequestHomeLocation = string | Merge.hris.Location;

package/api/resources/hris/types/EmployeeRequestHomeLocation.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/hris/types/EmployeeRequestManager.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Merge from "../../..";
+/**
+ * The employee ID of the employee's manager.
+ */
+export declare type EmployeeRequestManager = string | Merge.hris.Employee;

package/api/resources/hris/types/EmployeeRequestManager.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/hris/types/EmployeeRequestPayGroup.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Merge from "../../..";
+/**
+ * The employee's pay group
+ */
+export declare type EmployeeRequestPayGroup = string | Merge.hris.PayGroup;

package/api/resources/hris/types/EmployeeRequestPayGroup.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/hris/types/EmployeeRequestTeam.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Merge from "../../..";
+/**
+ * The employee's team.
+ */
+export declare type EmployeeRequestTeam = string | Merge.hris.Team;

package/api/resources/hris/types/EmployeeRequestTeam.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/hris/types/EmployeeRequestWorkLocation.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Merge from "../../..";
+/**
+ * The employee's work address.
+ */
+export declare type EmployeeRequestWorkLocation = string | Merge.hris.Location;

package/api/resources/hris/types/EmployeeRequestWorkLocation.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/hris/types/EmployeeTeam.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Merge from "../../..";
+/**
+ * The employee's team.
+ */
+export declare type EmployeeTeam = string | Merge.hris.Team;

package/api/resources/hris/types/EmployeeTeam.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/hris/types/EmployeeWorkLocation.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Merge from "../../..";
+/**
+ * The employee's work address.
+ */
+export declare type EmployeeWorkLocation = string | Merge.hris.Location;

package/api/resources/hris/types/EmployeeWorkLocation.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/hris/types/EmployerBenefit.d.ts

@@ -0,0 +1,39 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Merge from "../../..";
+/**
+ * # The EmployerBenefit Object
+ * ### Description
+ * The `Employer Benefit` object is used to represent a benefit plan offered by a company.
+ *
+ * ### Usage Example
+ * Fetch from the `LIST EmployerBenefits` endpoint and filter by `ID` to show all EmployerBenefits.
+ */
+export interface EmployerBenefit {
+    id?: string;
+    /** The third-party API ID of the matching object. */
+    remoteId?: string;
+    /**
+     * The type of benefit plan.
+     *
+     * * `MEDICAL` - MEDICAL
+     * * `HEALTH_SAVINGS` - HEALTH_SAVINGS
+     * * `INSURANCE` - INSURANCE
+     * * `RETIREMENT` - RETIREMENT
+     * * `OTHER` - OTHER
+     */
+    benefitPlanType?: Merge.hris.EmployerBenefitBenefitPlanType;
+    /** The employer benefit's name - typically the carrier or network name. */
+    name?: string;
+    /** The employer benefit's description. */
+    description?: string;
+    /** The employer benefit's deduction code. */
+    deductionCode?: string;
+    /** Indicates whether or not this object has been deleted by third party webhooks. */
+    remoteWasDeleted?: boolean;
+    /** This is the datetime that this object was last updated by Merge */
+    modifiedAt?: Date;
+    fieldMappings?: Record<string, unknown>;
+    remoteData?: (Record<string, unknown> | undefined)[];
+}

package/api/resources/hris/types/EmployerBenefit.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/hris/types/EmployerBenefitBenefitPlanType.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Merge from "../../..";
+/**
+ * The type of benefit plan.
+ *
+ * * `MEDICAL` - MEDICAL
+ * * `HEALTH_SAVINGS` - HEALTH_SAVINGS
+ * * `INSURANCE` - INSURANCE
+ * * `RETIREMENT` - RETIREMENT
+ * * `OTHER` - OTHER
+ */
+export declare type EmployerBenefitBenefitPlanType = Merge.hris.BenefitPlanTypeEnum | string;

package/api/resources/hris/types/EmployerBenefitBenefitPlanType.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/hris/types/Employment.d.ts

@@ -17,7 +17,7 @@ export interface Employment {
     /** The third-party API ID of the matching object. */
     remoteId?: string;
     /** The employee holding this position. */
-    employee?: string;
+    employee?: Merge.hris.EmploymentEmployee;
     /** The position's title. */
     jobTitle?: string;
     /** The position's pay rate in dollars. */
@@ -362,7 +362,7 @@ export interface Employment {
      */
     payCurrency?: Merge.hris.EmploymentPayCurrency;
     /** The employment's pay group */
-    payGroup?: string;
+    payGroup?: Merge.hris.EmploymentPayGroup;
     /**
      * The position's FLSA status.
      *
@@ -373,7 +373,7 @@ export interface Employment {
      */
     flsaStatus?: Merge.hris.EmploymentFlsaStatus;
     /** The position's effective date. */
-    effectiveDate?: string;
+    effectiveDate?: Date;
     /**
      * The position's type of employment.
      *
@@ -387,7 +387,7 @@ export interface Employment {
     /** Indicates whether or not this object has been deleted by third party webhooks. */
     remoteWasDeleted?: boolean;
     /** This is the datetime that this object was last updated by Merge */
-    modifiedAt?: string;
+    modifiedAt?: Date;
     fieldMappings?: Record<string, unknown>;
     remoteData?: Merge.hris.RemoteData[];
 }

package/api/resources/hris/types/EmploymentEmployee.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Merge from "../../..";
+/**
+ * The employee holding this position.
+ */
+export declare type EmploymentEmployee = string | Merge.hris.Employee;

package/api/resources/hris/types/EmploymentEmployee.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/hris/types/EmploymentPayGroup.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Merge from "../../..";
+/**
+ * The employment's pay group
+ */
+export declare type EmploymentPayGroup = string | Merge.hris.PayGroup;

package/api/resources/hris/types/EmploymentPayGroup.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/hris/types/Group.d.ts

@@ -31,7 +31,7 @@ export interface Group {
     /** Indicates whether or not this object has been deleted by third party webhooks. */
     remoteWasDeleted?: boolean;
     /** This is the datetime that this object was last updated by Merge */
-    modifiedAt?: string;
+    modifiedAt?: Date;
     fieldMappings?: Record<string, unknown>;
     remoteData?: Merge.hris.RemoteData[];
 }

package/api/resources/hris/types/Issue.d.ts

@@ -13,8 +13,8 @@ export interface Issue {
     status?: Merge.hris.IssueStatus;
     errorDescription: string;
     endUser?: Record<string, unknown>;
-    firstIncidentTime?: string;
-    lastIncidentTime?: string;
+    firstIncidentTime?: Date;
+    lastIncidentTime?: Date;
     isMuted?: boolean;
     errorDetails?: string[];
 }

package/api/resources/hris/types/Location.d.ts

@@ -292,7 +292,7 @@ export interface Location {
     /** Indicates whether or not this object has been deleted by third party webhooks. */
     remoteWasDeleted?: boolean;
     /** This is the datetime that this object was last updated by Merge */
-    modifiedAt?: string;
+    modifiedAt?: Date;
     fieldMappings?: Record<string, unknown>;
     remoteData?: Merge.hris.RemoteData[];
 }

package/api/resources/hris/types/PaginatedDependentList.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Merge from "../../..";
+export interface PaginatedDependentList {
+    next?: string;
+    previous?: string;
+    results?: Merge.hris.Dependent[];
+}

package/api/resources/hris/types/PaginatedDependentList.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/hris/types/PaginatedEmployerBenefitList.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Merge from "../../..";
+export interface PaginatedEmployerBenefitList {
+    next?: string;
+    previous?: string;
+    results?: Merge.hris.EmployerBenefit[];
+}

package/api/resources/hris/types/PaginatedEmployerBenefitList.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/hris/types/PayGroup.d.ts

@@ -19,7 +19,7 @@ export interface PayGroup {
     /** Indicates whether or not this object has been deleted by third party webhooks. */
     remoteWasDeleted?: boolean;
     /** This is the datetime that this object was last updated by Merge */
-    modifiedAt?: string;
+    modifiedAt?: Date;
     fieldMappings?: Record<string, unknown>;
     remoteData?: Merge.hris.RemoteData[];
 }

package/api/resources/hris/types/PayrollRun.d.ts

@@ -35,15 +35,15 @@ export interface PayrollRun {
      */
     runType?: Merge.hris.PayrollRunRunType;
     /** The day and time the payroll run started. */
-    startDate?: string;
+    startDate?: Date;
     /** The day and time the payroll run ended. */
-    endDate?: string;
+    endDate?: Date;
     /** The day and time the payroll run was checked. */
-    checkDate?: string;
+    checkDate?: Date;
     /** Indicates whether or not this object has been deleted by third party webhooks. */
     remoteWasDeleted?: boolean;
     /** This is the datetime that this object was last updated by Merge */
-    modifiedAt?: string;
+    modifiedAt?: Date;
     fieldMappings?: Record<string, unknown>;
     remoteData?: Merge.hris.RemoteData[];
 }

package/api/resources/hris/types/RelationshipEnum.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * * `CHILD` - CHILD
+ * * `SPOUSE` - SPOUSE
+ * * `DOMESTIC_PARTNER` - DOMESTIC_PARTNER
+ */
+export declare type RelationshipEnum = "CHILD" | "SPOUSE" | "DOMESTIC_PARTNER";
+export declare const RelationshipEnum: {
+    readonly Child: "CHILD";
+    readonly Spouse: "SPOUSE";
+    readonly DomesticPartner: "DOMESTIC_PARTNER";
+};

package/api/resources/hris/types/RelationshipEnum.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RelationshipEnum = void 0;
+exports.RelationshipEnum = {
+    Child: "CHILD",
+    Spouse: "SPOUSE",
+    DomesticPartner: "DOMESTIC_PARTNER",
+};

package/api/resources/hris/types/SyncStatus.d.ts

@@ -13,8 +13,8 @@ import * as Merge from "../../..";
 export interface SyncStatus {
     modelName: string;
     modelId: string;
-    lastSyncStart?: string;
-    nextSyncStart?: string;
+    lastSyncStart?: Date;
+    nextSyncStart?: Date;
     status: Merge.hris.SyncStatusStatusEnum;
     isInitialSync: boolean;
     selectiveSyncConfigurationsUsage?: Merge.hris.SelectiveSyncConfigurationsUsageEnum;

package/api/resources/hris/types/Tax.d.ts

@@ -24,7 +24,7 @@ export interface Tax {
     /** Indicates whether or not this object has been deleted by third party webhooks. */
     remoteWasDeleted?: boolean;
     /** This is the datetime that this object was last updated by Merge */
-    modifiedAt?: string;
+    modifiedAt?: Date;
     fieldMappings?: Record<string, unknown>;
     remoteData?: Merge.hris.RemoteData[];
 }

package/api/resources/hris/types/Team.d.ts

@@ -17,11 +17,11 @@ export interface Team {
     /** The team's name. */
     name?: string;
     /** The team's parent team. */
-    parentTeam?: string;
+    parentTeam?: Merge.hris.TeamParentTeam;
     /** Indicates whether or not this object has been deleted by third party webhooks. */
     remoteWasDeleted?: boolean;
     /** This is the datetime that this object was last updated by Merge */
-    modifiedAt?: string;
+    modifiedAt?: Date;
     fieldMappings?: Record<string, unknown>;
     remoteData?: Merge.hris.RemoteData[];
 }

package/api/resources/hris/types/TeamParentTeam.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Merge from "../../..";
+/**
+ * The team's parent team.
+ */
+export declare type TeamParentTeam = string | Merge.hris.Team;

package/api/resources/hris/types/TeamParentTeam.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });