@thera-hr/api-sdk 0.0.1-prerelease3066-dev-3 → 0.0.1-prerelease3067-dev-4

package/reference.md

@@ -8652,7 +8652,7 @@ await client.api.thera.payroll.offcycleApi.getCurrentOffCycleChecks("string");
 
 ## Oncycle API
 
-<details><summary><code>client.api.thera.payroll.oncycleApi.<a href="/src/api/resources/api/resources/thera/resources/payroll/resources/oncycleApi/client/Client.ts">approveOncycleChecks</a>(companyId) -> TheraApi.ApproveOnCycleChecksResponse</code></summary>
+<details><summary><code>client.api.thera.payroll.oncycleApi.<a href="/src/api/resources/api/resources/thera/resources/payroll/resources/oncycleApi/client/Client.ts">approveOncycleChecks</a>(companyId, checkPayScheduleId) -> TheraApi.ApproveOnCycleChecksResponse</code></summary>
 <dl>
 <dd>
 
@@ -8678,7 +8678,7 @@ await client.api.thera.payroll.offcycleApi.getCurrentOffCycleChecks("string");
 <dd>
 
 ```typescript
-await client.api.thera.payroll.oncycleApi.approveOncycleChecks("string");
+await client.api.thera.payroll.oncycleApi.approveOncycleChecks("string", "string");
 ```
 
 </dd>
@@ -8702,6 +8702,14 @@ await client.api.thera.payroll.oncycleApi.approveOncycleChecks("string");
 <dl>
 <dd>
 
+**checkPayScheduleId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **requestOptions:** `OncycleApi.RequestOptions`
 
 </dd>
@@ -8713,7 +8721,7 @@ await client.api.thera.payroll.oncycleApi.approveOncycleChecks("string");
 </dl>
 </details>
 
-<details><summary><code>client.api.thera.payroll.oncycleApi.<a href="/src/api/resources/api/resources/thera/resources/payroll/resources/oncycleApi/client/Client.ts">getOnCycleChecks</a>(companyId) -> TheraApi.OnCycleChecksResponse | undefined</code></summary>
+<details><summary><code>client.api.thera.payroll.oncycleApi.<a href="/src/api/resources/api/resources/thera/resources/payroll/resources/oncycleApi/client/Client.ts">getOnCycleChecks</a>(companyId) -> TheraApi.OnCycleChecksResponse[]</code></summary>
 <dl>
 <dd>
 
@@ -8774,7 +8782,76 @@ await client.api.thera.payroll.oncycleApi.getOnCycleChecks("string");
 </dl>
 </details>
 
-<details><summary><code>client.api.thera.payroll.oncycleApi.<a href="/src/api/resources/api/resources/thera/resources/payroll/resources/oncycleApi/client/Client.ts">cancelCurrentAutopilotPayroll</a>(companyId) -> void</code></summary>
+<details><summary><code>client.api.thera.payroll.oncycleApi.<a href="/src/api/resources/api/resources/thera/resources/payroll/resources/oncycleApi/client/Client.ts">getOnCycleCheckDetails</a>(companyId, checkPayrollId) -> TheraApi.OnCycleChecksResponse | undefined</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.api.thera.payroll.oncycleApi.getOnCycleCheckDetails("string", "string");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**companyId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**checkPayrollId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OncycleApi.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.api.thera.payroll.oncycleApi.<a href="/src/api/resources/api/resources/thera/resources/payroll/resources/oncycleApi/client/Client.ts">cancelCurrentAutopilotPayroll</a>(companyId, checkPayScheduleId) -> void</code></summary>
 <dl>
 <dd>
 
@@ -8800,7 +8877,7 @@ await client.api.thera.payroll.oncycleApi.getOnCycleChecks("string");
 <dd>
 
 ```typescript
-await client.api.thera.payroll.oncycleApi.cancelCurrentAutopilotPayroll("string");
+await client.api.thera.payroll.oncycleApi.cancelCurrentAutopilotPayroll("string", "string");
 ```
 
 </dd>
@@ -8824,6 +8901,14 @@ await client.api.thera.payroll.oncycleApi.cancelCurrentAutopilotPayroll("string"
 <dl>
 <dd>
 
+**checkPayScheduleId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **requestOptions:** `OncycleApi.RequestOptions`
 
 </dd>
@@ -8835,6 +8920,518 @@ await client.api.thera.payroll.oncycleApi.cancelCurrentAutopilotPayroll("string"
 </dl>
 </details>
 
+## W2 Pay Schedule APIs
+
+<details><summary><code>client.api.thera.payroll.payscheduleApi.<a href="/src/api/resources/api/resources/thera/resources/payroll/resources/payscheduleApi/client/Client.ts">createW2PaySchedule</a>(companyId, { ...params }) -> TheraApi.GetPayScheduleResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.api.thera.payroll.payscheduleApi.createW2PaySchedule("string", {
+    name: "string",
+    payFrequency: "weekly",
+    firstPayDate: "2023-01-15",
+    secondPayDate: "2023-01-15",
+    firstPeriodEndDate: "2023-01-15",
+    autopilotEnabled: true,
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**companyId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `TheraApi.api.thera.payroll.CreatePayScheduleRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `PayscheduleApi.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.api.thera.payroll.payscheduleApi.<a href="/src/api/resources/api/resources/thera/resources/payroll/resources/payscheduleApi/client/Client.ts">getW2PaySchedule</a>(companyId, checkPayScheduleId) -> TheraApi.GetPayScheduleResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.api.thera.payroll.payscheduleApi.getW2PaySchedule("string", "string");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**companyId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**checkPayScheduleId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `PayscheduleApi.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.api.thera.payroll.payscheduleApi.<a href="/src/api/resources/api/resources/thera/resources/payroll/resources/payscheduleApi/client/Client.ts">listW2PaySchedules</a>(companyId) -> TheraApi.GetPayScheduleResponse[]</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.api.thera.payroll.payscheduleApi.listW2PaySchedules("string");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**companyId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `PayscheduleApi.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.api.thera.payroll.payscheduleApi.<a href="/src/api/resources/api/resources/thera/resources/payroll/resources/payscheduleApi/client/Client.ts">deleteW2PaySchedule</a>(companyId, checkPayScheduleId) -> void</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Delete W2 Pay Schedule in Check by setting the metadata flag, as we can't delete Check W2 Pay Schedule by API. https://support.checkhq.com/hc/en-us/articles/24948436554263-Pay-Schedules
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.api.thera.payroll.payscheduleApi.deleteW2PaySchedule("string", "string");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**companyId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**checkPayScheduleId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `PayscheduleApi.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.api.thera.payroll.payscheduleApi.<a href="/src/api/resources/api/resources/thera/resources/payroll/resources/payscheduleApi/client/Client.ts">updateW2PaySchedule</a>(companyId, checkPayScheduleId, { ...params }) -> TheraApi.GetPayScheduleResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.api.thera.payroll.payscheduleApi.updateW2PaySchedule("string", "string", {
+    name: "string",
+    payFrequency: "weekly",
+    firstPeriodEndDate: "2023-01-15",
+    firstPayDate: "2023-01-15",
+    secondPayDate: "2023-01-15",
+    metadata: {
+        deleted: "string",
+        autopilotEnabled: "string",
+    },
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**companyId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**checkPayScheduleId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `TheraApi.api.thera.payroll.UpdatePayScheduleRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `PayscheduleApi.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.api.thera.payroll.payscheduleApi.<a href="/src/api/resources/api/resources/thera/resources/payroll/resources/payscheduleApi/client/Client.ts">assignW2EmployeesPaySchedule</a>(companyId, { ...params }) -> TheraApi.AssignW2EmployeeToPayScheduleResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+If user ID is not provided in the request, it'll use the old value in DB. The response body always return the schedules for all employees
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.api.thera.payroll.payscheduleApi.assignW2EmployeesPaySchedule("string", {
+    checkPayScheduleIdByUserId: {
+        string: "string",
+    },
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**companyId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `TheraApi.api.thera.payroll.AssignW2EmployeeToPayScheduleRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `PayscheduleApi.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.api.thera.payroll.payscheduleApi.<a href="/src/api/resources/api/resources/thera/resources/payroll/resources/payscheduleApi/client/Client.ts">getSomePaySchedulePaydays</a>(companyId, checkPayScheduleId) -> TheraApi.GetPaySchedulePaydaysResponse[]</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Return several upcoming paydays (not all of them!)
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.api.thera.payroll.payscheduleApi.getSomePaySchedulePaydays("string", "string");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**companyId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**checkPayScheduleId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `PayscheduleApi.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Time Off Management
 
 <details><summary><code>client.api.thera.timeoff.timeoffApi.<a href="/src/api/resources/api/resources/thera/resources/timeoff/resources/timeoffApi/client/Client.ts">calculatePtoDeduction</a>(companyId, { ...params }) -> TheraApi.SuggestedDeductionResponse</code></summary>

package/serialization/resources/api/resources/thera/resources/payroll/resources/index.d.ts

@@ -2,3 +2,6 @@ export * as offcycleApi from "./offcycleApi";
 export * from "./offcycleApi/types";
 export * as oncycleApi from "./oncycleApi";
 export * from "./oncycleApi/types";
+export * as payscheduleApi from "./payscheduleApi";
+export * from "./payscheduleApi/types";
+export * from "./payscheduleApi/client/requests";

package/serialization/resources/api/resources/thera/resources/payroll/resources/index.js

@@ -36,8 +36,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.oncycleApi = exports.offcycleApi = void 0;
+exports.payscheduleApi = exports.oncycleApi = exports.offcycleApi = void 0;
 exports.offcycleApi = __importStar(require("./offcycleApi"));
 __exportStar(require("./offcycleApi/types"), exports);
 exports.oncycleApi = __importStar(require("./oncycleApi"));
 __exportStar(require("./oncycleApi/types"), exports);
+exports.payscheduleApi = __importStar(require("./payscheduleApi"));
+__exportStar(require("./payscheduleApi/types"), exports);
+__exportStar(require("./payscheduleApi/client/requests"), exports);

package/serialization/resources/api/resources/thera/resources/payroll/resources/oncycleApi/client/getOnCycleCheckDetails.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../../../../../../../../../index";
+import * as TheraApi from "../../../../../../../../../../api/index";
+import * as core from "../../../../../../../../../../core";
+import { OnCycleChecksResponse } from "../types/OnCycleChecksResponse";
+export declare const Response: core.serialization.Schema<serializers.api.thera.payroll.oncycleApi.getOnCycleCheckDetails.Response.Raw, TheraApi.api.thera.payroll.OnCycleChecksResponse | undefined>;
+export declare namespace Response {
+    type Raw = OnCycleChecksResponse.Raw | null | undefined;
+}

package/serialization/resources/api/resources/thera/resources/payroll/resources/oncycleApi/client/getOnCycleCheckDetails.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Response = void 0;
+const OnCycleChecksResponse_1 = require("../types/OnCycleChecksResponse");
+exports.Response = OnCycleChecksResponse_1.OnCycleChecksResponse.optional();

package/serialization/resources/api/resources/thera/resources/payroll/resources/oncycleApi/client/getOnCycleChecks.d.ts

@@ -5,7 +5,7 @@ import * as serializers from "../../../../../../../../../index";
 import * as TheraApi from "../../../../../../../../../../api/index";
 import * as core from "../../../../../../../../../../core";
 import { OnCycleChecksResponse } from "../types/OnCycleChecksResponse";
-export declare const Response: core.serialization.Schema<serializers.api.thera.payroll.oncycleApi.getOnCycleChecks.Response.Raw, TheraApi.api.thera.payroll.OnCycleChecksResponse | undefined>;
+export declare const Response: core.serialization.Schema<serializers.api.thera.payroll.oncycleApi.getOnCycleChecks.Response.Raw, TheraApi.api.thera.payroll.OnCycleChecksResponse[]>;
 export declare namespace Response {
-    type Raw = OnCycleChecksResponse.Raw | null | undefined;
+    type Raw = OnCycleChecksResponse.Raw[];
 }