@thera-hr/api-sdk 0.0.1-prerelease3054-dev-2 → 0.0.1-prerelease3054-dev-4

package/reference.md

@@ -2499,8 +2499,6 @@ await client.api.thera.bank.bankApi.getWorkerWithdrawalDeliveryEstimate("string"
 await client.api.thera.bank.bankApi.getPayInHistory("string", {
     status: "PENDING",
     offPlatformOnly: true,
-    pageSize: 1000000,
-    afterCursor: "string",
 });
 ```
 
@@ -2967,150 +2965,6 @@ await client.api.thera.bank.bankApi.setAutoApproveInvoiceForTeams("string", {
 </dl>
 </details>
 
-<details><summary><code>client.api.thera.bank.bankApi.<a href="/src/api/resources/api/resources/thera/resources/bank/resources/bankApi/client/Client.ts">getPaymentByTypeAndId</a>(companyId, paymentId, { ...params }) -> TheraApi.HistoricPayment</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Get a specific W2 subscription or EOR payment by its ID. This endpoint is optimized for direct retrieval without pagination concerns.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.api.thera.bank.bankApi.getPaymentByTypeAndId("string", "string", {
-    paymentType: "string",
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**companyId:** `string`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**paymentId:** `string`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `TheraApi.api.thera.bank.GetPaymentByTypeRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `BankApi.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.api.thera.bank.bankApi.<a href="/src/api/resources/api/resources/thera/resources/bank/resources/bankApi/client/Client.ts">getPayInCount</a>(companyId) -> TheraApi.GetPayInCountResponse</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Get the total count of pay-ins for a company. This endpoint is optimized for counting large datasets efficiently.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.api.thera.bank.bankApi.getPayInCount("string");
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**companyId:** `string`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `BankApi.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
 ## Bridge APIs
 
 <details><summary><code>client.api.thera.bridge.bridgeApi.<a href="/src/api/resources/api/resources/thera/resources/bridge/resources/bridgeApi/client/Client.ts">requestTosLink</a>() -> TheraApi.TosLinkResponse</code></summary>
@@ -8570,7 +8424,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>
 
@@ -8596,7 +8450,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>
@@ -8620,6 +8474,14 @@ await client.api.thera.payroll.oncycleApi.approveOncycleChecks("string");
 <dl>
 <dd>
 
+**checkPayScheduleId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **requestOptions:** `OncycleApi.RequestOptions`
 
 </dd>
@@ -8631,7 +8493,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>
 
@@ -8692,7 +8554,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>
 
@@ -8718,7 +8649,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>
@@ -8742,6 +8673,14 @@ await client.api.thera.payroll.oncycleApi.cancelCurrentAutopilotPayroll("string"
 <dl>
 <dd>
 
+**checkPayScheduleId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **requestOptions:** `OncycleApi.RequestOptions`
 
 </dd>
@@ -8753,6 +8692,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>