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

package/reference.md

@@ -7889,9 +7889,9 @@ await client.api.thera.eor.eorTrackerApi.getLatestEorEmployeeEmailByCompanyId("s
 </dl>
 </details>
 
-## Incorporation Integration
+## Miscellaneous API
 
-<details><summary><code>client.api.thera.incorporation.incorporationApi.<a href="/src/api/resources/api/resources/thera/resources/incorporation/resources/incorporationApi/client/Client.ts">incorporationSignup</a>({ ...params }) -> TheraApi.IncorporationSignupResponse</code></summary>
+<details><summary><code>client.api.thera.misc.misc.<a href="/src/api/resources/api/resources/thera/resources/misc/resources/misc/client/Client.ts">regularCron</a>({ ...params }) -> TheraApi.DailyCronResponse</code></summary>
 <dl>
 <dd>
 
@@ -7903,7 +7903,7 @@ await client.api.thera.eor.eorTrackerApi.getLatestEorEmployeeEmailByCompanyId("s
 <dl>
 <dd>
 
-Create a new user account and company for someone who has incorporated
+Calling this API will trigger automatic payouts for all workers that have auto-withdrawals turned on. This cron may be re-used for other daily tasks in the future
 
 </dd>
 </dl>
@@ -7919,34 +7919,8 @@ Create a new user account and company for someone who has incorporated
 <dd>
 
 ```typescript
-await client.api.thera.incorporation.incorporationApi.incorporationSignup({
-    businessName: "string",
-    state: "string",
-    firstName: "string",
-    lastName: "string",
-    email: "string",
-    phone: "string",
-    experience: "string",
-    progress: "string",
-    industry: "string",
-    agent: "string",
-    packageType: "string",
-    dbaService: true,
-    worryFreeCompliance: true,
-    einDocuments: ["string"],
-    tradeMarkCompany: true,
-    appointedAgent: true,
-    registrationDate: "string",
-    status: "string",
-    userPersonalAddress: {
-        city: "string",
-        country: "string",
-        line1: "string",
-        line2: "string",
-        postalCode: "string",
-        state: "string",
-    },
-    password: "string",
+await client.api.thera.misc.misc.regularCron({
+    theraWebhookSignatureHeader: "string",
 });
 ```
 
@@ -7963,7 +7937,7 @@ await client.api.thera.incorporation.incorporationApi.incorporationSignup({
 <dl>
 <dd>
 
-**request:** `TheraApi.IncorporationSignupRequest`
+**request:** `TheraApi.api.thera.misc.DailyCronRequest`
 
 </dd>
 </dl>
@@ -7971,7 +7945,7 @@ await client.api.thera.incorporation.incorporationApi.incorporationSignup({
 <dl>
 <dd>
 
-**requestOptions:** `IncorporationApi.RequestOptions`
+**requestOptions:** `Misc.RequestOptions`
 
 </dd>
 </dl>
@@ -7982,7 +7956,7 @@ await client.api.thera.incorporation.incorporationApi.incorporationSignup({
 </dl>
 </details>
 
-<details><summary><code>client.api.thera.incorporation.incorporationApi.<a href="/src/api/resources/api/resources/thera/resources/incorporation/resources/incorporationApi/client/Client.ts">createCheckoutSession</a>({ ...params }) -> TheraApi.CheckoutSessionResponse</code></summary>
+<details><summary><code>client.api.thera.misc.misc.<a href="/src/api/resources/api/resources/thera/resources/misc/resources/misc/client/Client.ts">autoWithdrawalCron</a>({ ...params }) -> TheraApi.AutoWithdrawalResults</code></summary>
 <dl>
 <dd>
 
@@ -7994,7 +7968,7 @@ await client.api.thera.incorporation.incorporationApi.incorporationSignup({
 <dl>
 <dd>
 
-Create a Stripe checkout session for payment
+Calling this API will trigger automatic withdrawals for all workers that have auto-withdrawals turned on.
 
 </dd>
 </dl>
@@ -8010,15 +7984,8 @@ Create a Stripe checkout session for payment
 <dd>
 
 ```typescript
-await client.api.thera.incorporation.incorporationApi.createCheckoutSession({
-    amount: 1.1,
-    productName: "string",
-    currency: "string",
-    successUrl: "string",
-    cancelUrl: "string",
-    metadata: {
-        string: "string",
-    },
+await client.api.thera.misc.misc.autoWithdrawalCron({
+    theraWebhookSignatureHeader: "string",
 });
 ```
 
@@ -8035,7 +8002,7 @@ await client.api.thera.incorporation.incorporationApi.createCheckoutSession({
 <dl>
 <dd>
 
-**request:** `TheraApi.CheckoutSessionRequest`
+**request:** `TheraApi.api.thera.misc.AutoWithdrawalCronRequest`
 
 </dd>
 </dl>
@@ -8043,7 +8010,7 @@ await client.api.thera.incorporation.incorporationApi.createCheckoutSession({
 <dl>
 <dd>
 
-**requestOptions:** `IncorporationApi.RequestOptions`
+**requestOptions:** `Misc.RequestOptions`
 
 </dd>
 </dl>
@@ -8054,7 +8021,7 @@ await client.api.thera.incorporation.incorporationApi.createCheckoutSession({
 </dl>
 </details>
 
-<details><summary><code>client.api.thera.incorporation.incorporationApi.<a href="/src/api/resources/api/resources/thera/resources/incorporation/resources/incorporationApi/client/Client.ts">checkPaymentStatus</a>(sessionId) -> TheraApi.PaymentStatusResponse</code></summary>
+<details><summary><code>client.api.thera.misc.misc.<a href="/src/api/resources/api/resources/thera/resources/misc/resources/misc/client/Client.ts">autoPayCron</a>({ ...params }) -> void</code></summary>
 <dl>
 <dd>
 
@@ -8066,7 +8033,7 @@ await client.api.thera.incorporation.incorporationApi.createCheckoutSession({
 <dl>
 <dd>
 
-Check the status of a Stripe payment session
+Calling this API will trigger automatic auto payment of invoices for all companies that have auto-pay turned on.
 
 </dd>
 </dl>
@@ -8082,7 +8049,9 @@ Check the status of a Stripe payment session
 <dd>
 
 ```typescript
-await client.api.thera.incorporation.incorporationApi.checkPaymentStatus("string");
+await client.api.thera.misc.misc.autoPayCron({
+    theraWebhookSignatureHeader: "string",
+});
 ```
 
 </dd>
@@ -8098,7 +8067,7 @@ await client.api.thera.incorporation.incorporationApi.checkPaymentStatus("string
 <dl>
 <dd>
 
-**sessionId:** `string`
+**request:** `TheraApi.api.thera.misc.AutoPayCronRequest`
 
 </dd>
 </dl>
@@ -8106,7 +8075,7 @@ await client.api.thera.incorporation.incorporationApi.checkPaymentStatus("string
 <dl>
 <dd>
 
-**requestOptions:** `IncorporationApi.RequestOptions`
+**requestOptions:** `Misc.RequestOptions`
 
 </dd>
 </dl>
@@ -8117,9 +8086,7 @@ await client.api.thera.incorporation.incorporationApi.checkPaymentStatus("string
 </dl>
 </details>
 
-## Miscellaneous API
-
-<details><summary><code>client.api.thera.misc.misc.<a href="/src/api/resources/api/resources/thera/resources/misc/resources/misc/client/Client.ts">regularCron</a>({ ...params }) -> TheraApi.DailyCronResponse</code></summary>
+<details><summary><code>client.api.thera.misc.misc.<a href="/src/api/resources/api/resources/thera/resources/misc/resources/misc/client/Client.ts">autoPayEmailNotificationCron</a>({ ...params }) -> void</code></summary>
 <dl>
 <dd>
 
@@ -8131,7 +8098,7 @@ await client.api.thera.incorporation.incorporationApi.checkPaymentStatus("string
 <dl>
 <dd>
 
-Calling this API will trigger automatic payouts for all workers that have auto-withdrawals turned on. This cron may be re-used for other daily tasks in the future
+Calling this API will trigger automatic email notifications for all companies that have auto-pay turned on.
 
 </dd>
 </dl>
@@ -8147,7 +8114,7 @@ Calling this API will trigger automatic payouts for all workers that have auto-w
 <dd>
 
 ```typescript
-await client.api.thera.misc.misc.regularCron({
+await client.api.thera.misc.misc.autoPayEmailNotificationCron({
     theraWebhookSignatureHeader: "string",
 });
 ```
@@ -8165,7 +8132,7 @@ await client.api.thera.misc.misc.regularCron({
 <dl>
 <dd>
 
-**request:** `TheraApi.api.thera.misc.DailyCronRequest`
+**request:** `TheraApi.api.thera.misc.EmailNotificationCronRequest`
 
 </dd>
 </dl>
@@ -8184,7 +8151,7 @@ await client.api.thera.misc.misc.regularCron({
 </dl>
 </details>
 
-<details><summary><code>client.api.thera.misc.misc.<a href="/src/api/resources/api/resources/thera/resources/misc/resources/misc/client/Client.ts">autoWithdrawalCron</a>({ ...params }) -> TheraApi.AutoWithdrawalResults</code></summary>
+<details><summary><code>client.api.thera.misc.misc.<a href="/src/api/resources/api/resources/thera/resources/misc/resources/misc/client/Client.ts">contractRenewalCron</a>({ ...params }) -> TheraApi.ContractRenewalCronResponse</code></summary>
 <dl>
 <dd>
 
@@ -8196,7 +8163,7 @@ await client.api.thera.misc.misc.regularCron({
 <dl>
 <dd>
 
-Calling this API will trigger automatic withdrawals for all workers that have auto-withdrawals turned on.
+Calling this API will trigger a check for contracts that need renewal and notify the Slack TODO channel.
 
 </dd>
 </dl>
@@ -8212,7 +8179,7 @@ Calling this API will trigger automatic withdrawals for all workers that have au
 <dd>
 
 ```typescript
-await client.api.thera.misc.misc.autoWithdrawalCron({
+await client.api.thera.misc.misc.contractRenewalCron({
     theraWebhookSignatureHeader: "string",
 });
 ```
@@ -8230,7 +8197,7 @@ await client.api.thera.misc.misc.autoWithdrawalCron({
 <dl>
 <dd>
 
-**request:** `TheraApi.api.thera.misc.AutoWithdrawalCronRequest`
+**request:** `TheraApi.api.thera.misc.ContractRenewalCronRequest`
 
 </dd>
 </dl>
@@ -8249,7 +8216,7 @@ await client.api.thera.misc.misc.autoWithdrawalCron({
 </dl>
 </details>
 
-<details><summary><code>client.api.thera.misc.misc.<a href="/src/api/resources/api/resources/thera/resources/misc/resources/misc/client/Client.ts">autoPayCron</a>({ ...params }) -> void</code></summary>
+<details><summary><code>client.api.thera.misc.misc.<a href="/src/api/resources/api/resources/thera/resources/misc/resources/misc/client/Client.ts">processAchTpInvoices</a>({ ...params }) -> void</code></summary>
 <dl>
 <dd>
 
@@ -8261,7 +8228,7 @@ await client.api.thera.misc.misc.autoWithdrawalCron({
 <dl>
 <dd>
 
-Calling this API will trigger automatic auto payment of invoices for all companies that have auto-pay turned on.
+Calling this API will trigger automatic transfer of funds from fbo to omnibus for invoices with ach payment.
 
 </dd>
 </dl>
@@ -8277,7 +8244,7 @@ Calling this API will trigger automatic auto payment of invoices for all compani
 <dd>
 
 ```typescript
-await client.api.thera.misc.misc.autoPayCron({
+await client.api.thera.misc.misc.processAchTpInvoices({
     theraWebhookSignatureHeader: "string",
 });
 ```
@@ -8295,7 +8262,7 @@ await client.api.thera.misc.misc.autoPayCron({
 <dl>
 <dd>
 
-**request:** `TheraApi.api.thera.misc.AutoPayCronRequest`
+**request:** `TheraApi.api.thera.misc.ProcessAchTpInvoicesCronRequest`
 
 </dd>
 </dl>
@@ -8314,7 +8281,7 @@ await client.api.thera.misc.misc.autoPayCron({
 </dl>
 </details>
 
-<details><summary><code>client.api.thera.misc.misc.<a href="/src/api/resources/api/resources/thera/resources/misc/resources/misc/client/Client.ts">autoPayEmailNotificationCron</a>({ ...params }) -> void</code></summary>
+<details><summary><code>client.api.thera.misc.misc.<a href="/src/api/resources/api/resources/thera/resources/misc/resources/misc/client/Client.ts">filloutEorEmployeeWebhook</a>({ ...params }) -> TheraApi.FilloutEorEmployeeWebhookResponse</code></summary>
 <dl>
 <dd>
 
@@ -8326,7 +8293,7 @@ await client.api.thera.misc.misc.autoPayCron({
 <dl>
 <dd>
 
-Calling this API will trigger automatic email notifications for all companies that have auto-pay turned on.
+Webhook endpoint that receives submissions from Fillout forms to create EOR employees. This endpoint accepts the same request structure as the AddEorEmployeeRequest.
 
 </dd>
 </dl>
@@ -8342,8 +8309,21 @@ Calling this API will trigger automatic email notifications for all companies th
 <dd>
 
 ```typescript
-await client.api.thera.misc.misc.autoPayEmailNotificationCron({
+await client.api.thera.misc.misc.filloutEorEmployeeWebhook({
     theraWebhookSignatureHeader: "string",
+    body: {
+        firstName: "string",
+        lastName: "string",
+        email: "string",
+        country: "string",
+        companyId: "string",
+        teamId: "string",
+        jobTitle: "string",
+        startDate: "2023-01-15",
+        rate: 1.1,
+        wageType: "HOURLY",
+        currency: "string",
+    },
 });
 ```
 
@@ -8360,7 +8340,7 @@ await client.api.thera.misc.misc.autoPayEmailNotificationCron({
 <dl>
 <dd>
 
-**request:** `TheraApi.api.thera.misc.EmailNotificationCronRequest`
+**request:** `TheraApi.api.thera.misc.FilloutEorEmployeeRequest`
 
 </dd>
 </dl>
@@ -8379,7 +8359,9 @@ await client.api.thera.misc.misc.autoPayEmailNotificationCron({
 </dl>
 </details>
 
-<details><summary><code>client.api.thera.misc.misc.<a href="/src/api/resources/api/resources/thera/resources/misc/resources/misc/client/Client.ts">contractRenewalCron</a>({ ...params }) -> TheraApi.ContractRenewalCronResponse</code></summary>
+## Offcycle API
+
+<details><summary><code>client.api.thera.payroll.offcycleApi.<a href="/src/api/resources/api/resources/thera/resources/payroll/resources/offcycleApi/client/Client.ts">getCurrentOffCycleChecks</a>(companyId) -> TheraApi.CheckPayrollResponse | undefined</code></summary>
 <dl>
 <dd>
 
@@ -8391,7 +8373,68 @@ await client.api.thera.misc.misc.autoPayEmailNotificationCron({
 <dl>
 <dd>
 
-Calling this API will trigger a check for contracts that need renewal and notify the Slack TODO channel.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.api.thera.payroll.offcycleApi.getCurrentOffCycleChecks("string");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**companyId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OffcycleApi.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## 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, checkPayScheduleId) -> TheraApi.ApproveOnCycleChecksResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
 
 </dd>
 </dl>
@@ -8407,9 +8450,7 @@ Calling this API will trigger a check for contracts that need renewal and notify
 <dd>
 
 ```typescript
-await client.api.thera.misc.misc.contractRenewalCron({
-    theraWebhookSignatureHeader: "string",
-});
+await client.api.thera.payroll.oncycleApi.approveOncycleChecks("string", "string");
 ```
 
 </dd>
@@ -8425,7 +8466,7 @@ await client.api.thera.misc.misc.contractRenewalCron({
 <dl>
 <dd>
 
-**request:** `TheraApi.api.thera.misc.ContractRenewalCronRequest`
+**companyId:** `string`
 
 </dd>
 </dl>
@@ -8433,7 +8474,15 @@ await client.api.thera.misc.misc.contractRenewalCron({
 <dl>
 <dd>
 
-**requestOptions:** `Misc.RequestOptions`
+**checkPayScheduleId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OncycleApi.RequestOptions`
 
 </dd>
 </dl>
@@ -8444,7 +8493,7 @@ await client.api.thera.misc.misc.contractRenewalCron({
 </dl>
 </details>
 
-<details><summary><code>client.api.thera.misc.misc.<a href="/src/api/resources/api/resources/thera/resources/misc/resources/misc/client/Client.ts">processAchTpInvoices</a>({ ...params }) -> 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">getOnCycleChecks</a>(companyId) -> TheraApi.OnCycleChecksResponse[]</code></summary>
 <dl>
 <dd>
 
@@ -8456,7 +8505,66 @@ await client.api.thera.misc.misc.contractRenewalCron({
 <dl>
 <dd>
 
-Calling this API will trigger automatic transfer of funds from fbo to omnibus for invoices with ach payment.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.api.thera.payroll.oncycleApi.getOnCycleChecks("string");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**companyId:** `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">getOnCycleCheckDetails</a>(companyId, checkPayrollId) -> TheraApi.OnCycleChecksResponse | undefined</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
 
 </dd>
 </dl>
@@ -8472,9 +8580,7 @@ Calling this API will trigger automatic transfer of funds from fbo to omnibus fo
 <dd>
 
 ```typescript
-await client.api.thera.misc.misc.processAchTpInvoices({
-    theraWebhookSignatureHeader: "string",
-});
+await client.api.thera.payroll.oncycleApi.getOnCycleCheckDetails("string", "string");
 ```
 
 </dd>
@@ -8490,7 +8596,7 @@ await client.api.thera.misc.misc.processAchTpInvoices({
 <dl>
 <dd>
 
-**request:** `TheraApi.api.thera.misc.ProcessAchTpInvoicesCronRequest`
+**companyId:** `string`
 
 </dd>
 </dl>
@@ -8498,7 +8604,15 @@ await client.api.thera.misc.misc.processAchTpInvoices({
 <dl>
 <dd>
 
-**requestOptions:** `Misc.RequestOptions`
+**checkPayrollId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OncycleApi.RequestOptions`
 
 </dd>
 </dl>
@@ -8509,7 +8623,7 @@ await client.api.thera.misc.misc.processAchTpInvoices({
 </dl>
 </details>
 
-<details><summary><code>client.api.thera.misc.misc.<a href="/src/api/resources/api/resources/thera/resources/misc/resources/misc/client/Client.ts">filloutEorEmployeeWebhook</a>({ ...params }) -> TheraApi.FilloutEorEmployeeWebhookResponse</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">cancelCurrentAutopilotPayroll</a>(companyId, checkPayScheduleId) -> void</code></summary>
 <dl>
 <dd>
 
@@ -8521,7 +8635,76 @@ await client.api.thera.misc.misc.processAchTpInvoices({
 <dl>
 <dd>
 
-Webhook endpoint that receives submissions from Fillout forms to create EOR employees. This endpoint accepts the same request structure as the AddEorEmployeeRequest.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.api.thera.payroll.oncycleApi.cancelCurrentAutopilotPayroll("string", "string");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**companyId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**checkPayScheduleId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `OncycleApi.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</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>
@@ -8537,21 +8720,13 @@ Webhook endpoint that receives submissions from Fillout forms to create EOR empl
 <dd>
 
 ```typescript
-await client.api.thera.misc.misc.filloutEorEmployeeWebhook({
-    theraWebhookSignatureHeader: "string",
-    body: {
-        firstName: "string",
-        lastName: "string",
-        email: "string",
-        country: "string",
-        companyId: "string",
-        teamId: "string",
-        jobTitle: "string",
-        startDate: "2023-01-15",
-        rate: 1.1,
-        wageType: "HOURLY",
-        currency: "string",
-    },
+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,
 });
 ```
 
@@ -8568,7 +8743,7 @@ await client.api.thera.misc.misc.filloutEorEmployeeWebhook({
 <dl>
 <dd>
 
-**request:** `TheraApi.api.thera.misc.FilloutEorEmployeeRequest`
+**companyId:** `string`
 
 </dd>
 </dl>
@@ -8576,7 +8751,15 @@ await client.api.thera.misc.misc.filloutEorEmployeeWebhook({
 <dl>
 <dd>
 
-**requestOptions:** `Misc.RequestOptions`
+**request:** `TheraApi.api.thera.payroll.CreatePayScheduleRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `PayscheduleApi.RequestOptions`
 
 </dd>
 </dl>
@@ -8587,9 +8770,76 @@ await client.api.thera.misc.misc.filloutEorEmployeeWebhook({
 </dl>
 </details>
 
-## Offcycle API
+<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>
 
-<details><summary><code>client.api.thera.payroll.offcycleApi.<a href="/src/api/resources/api/resources/thera/resources/payroll/resources/offcycleApi/client/Client.ts">getCurrentOffCycleChecks</a>(companyId) -> TheraApi.CheckPayrollResponse | undefined</code></summary>
+#### 📝 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>
 
@@ -8615,7 +8865,7 @@ await client.api.thera.misc.misc.filloutEorEmployeeWebhook({
 <dd>
 
 ```typescript
-await client.api.thera.payroll.offcycleApi.getCurrentOffCycleChecks("string");
+await client.api.thera.payroll.payscheduleApi.listW2PaySchedules("string");
 ```
 
 </dd>
@@ -8639,7 +8889,7 @@ await client.api.thera.payroll.offcycleApi.getCurrentOffCycleChecks("string");
 <dl>
 <dd>
 
-**requestOptions:** `OffcycleApi.RequestOptions`
+**requestOptions:** `PayscheduleApi.RequestOptions`
 
 </dd>
 </dl>
@@ -8650,9 +8900,78 @@ await client.api.thera.payroll.offcycleApi.getCurrentOffCycleChecks("string");
 </dl>
 </details>
 
-## Oncycle API
+<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>
 
-<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>
+<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>
 
@@ -8678,7 +8997,17 @@ await client.api.thera.payroll.offcycleApi.getCurrentOffCycleChecks("string");
 <dd>
 
 ```typescript
-await client.api.thera.payroll.oncycleApi.approveOncycleChecks("string");
+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>
@@ -8702,7 +9031,23 @@ await client.api.thera.payroll.oncycleApi.approveOncycleChecks("string");
 <dl>
 <dd>
 
-**requestOptions:** `OncycleApi.RequestOptions`
+**checkPayScheduleId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `TheraApi.api.thera.payroll.UpdatePayScheduleRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `PayscheduleApi.RequestOptions`
 
 </dd>
 </dl>
@@ -8713,7 +9058,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.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>
 
@@ -8725,6 +9070,8 @@ await client.api.thera.payroll.oncycleApi.approveOncycleChecks("string");
 <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>
@@ -8739,7 +9086,11 @@ await client.api.thera.payroll.oncycleApi.approveOncycleChecks("string");
 <dd>
 
 ```typescript
-await client.api.thera.payroll.oncycleApi.getOnCycleChecks("string");
+await client.api.thera.payroll.payscheduleApi.assignW2EmployeesPaySchedule("string", {
+    checkPayScheduleIdByUserId: {
+        string: "string",
+    },
+});
 ```
 
 </dd>
@@ -8763,7 +9114,15 @@ await client.api.thera.payroll.oncycleApi.getOnCycleChecks("string");
 <dl>
 <dd>
 
-**requestOptions:** `OncycleApi.RequestOptions`
+**request:** `TheraApi.api.thera.payroll.AssignW2EmployeeToPayScheduleRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `PayscheduleApi.RequestOptions`
 
 </dd>
 </dl>
@@ -8774,7 +9133,7 @@ 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.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>
 
@@ -8786,6 +9145,8 @@ await client.api.thera.payroll.oncycleApi.getOnCycleChecks("string");
 <dl>
 <dd>
 
+Return several upcoming paydays (not all of them!)
+
 </dd>
 </dl>
 </dd>
@@ -8800,7 +9161,7 @@ await client.api.thera.payroll.oncycleApi.getOnCycleChecks("string");
 <dd>
 
 ```typescript
-await client.api.thera.payroll.oncycleApi.cancelCurrentAutopilotPayroll("string");
+await client.api.thera.payroll.payscheduleApi.getSomePaySchedulePaydays("string", "string");
 ```
 
 </dd>
@@ -8824,7 +9185,15 @@ await client.api.thera.payroll.oncycleApi.cancelCurrentAutopilotPayroll("string"
 <dl>
 <dd>
 
-**requestOptions:** `OncycleApi.RequestOptions`
+**checkPayScheduleId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `PayscheduleApi.RequestOptions`
 
 </dd>
 </dl>