@thera-hr/api-sdk 0.0.1-prerelease3080-dev-3 → 0.0.1-prerelease3082-production

package/dist/api/resources/api/resources/thera/resources/payroll/resources/oncycleApi/client/Client.js

@@ -61,18 +61,19 @@ class OncycleApi {
      *
      *
      * @param {string} companyId
+     * @param {string} checkPayScheduleId
      * @param {OncycleApi.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.api.thera.payroll.oncycleApi.approveOncycleChecks("string")
+     *     await client.api.thera.payroll.oncycleApi.approveOncycleChecks("string", "string")
      */
-    approveOncycleChecks(companyId, requestOptions) {
+    approveOncycleChecks(companyId, checkPayScheduleId, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;
             const _response = yield core.fetcher({
-                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment)), `companies/${encodeURIComponent(companyId)}/w2-payroll/on-cycle-checks/approve`),
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment)), `companies/${encodeURIComponent(companyId)}/w2-payroll/pay-schedules/${encodeURIComponent(checkPayScheduleId)}/on-cycle-checks/approve`),
                 method: "POST",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@thera-hr/api-sdk", "X-Fern-SDK-Version": "0.0.1-prerelease3080-dev-3", "User-Agent": "@thera-hr/api-sdk/0.0.1-prerelease3080-dev-3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@thera-hr/api-sdk", "X-Fern-SDK-Version": "0.0.1-prerelease3082-production", "User-Agent": "@thera-hr/api-sdk/0.0.1-prerelease3082-production", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -101,7 +102,7 @@ class OncycleApi {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.TheraApiTimeoutError("Timeout exceeded when calling POST /companies/{companyID}/w2-payroll/on-cycle-checks/approve.");
+                    throw new errors.TheraApiTimeoutError("Timeout exceeded when calling POST /companies/{companyID}/w2-payroll/pay-schedules/{checkPayScheduleId}/on-cycle-checks/approve.");
                 case "unknown":
                     throw new errors.TheraApiError({
                         message: _response.error.errorMessage,
@@ -124,7 +125,7 @@ class OncycleApi {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment)), `companies/${encodeURIComponent(companyId)}/w2-payroll/on-cycle-checks`),
                 method: "GET",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@thera-hr/api-sdk", "X-Fern-SDK-Version": "0.0.1-prerelease3080-dev-3", "User-Agent": "@thera-hr/api-sdk/0.0.1-prerelease3080-dev-3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@thera-hr/api-sdk", "X-Fern-SDK-Version": "0.0.1-prerelease3082-production", "User-Agent": "@thera-hr/api-sdk/0.0.1-prerelease3082-production", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -165,18 +166,72 @@ class OncycleApi {
      *
      *
      * @param {string} companyId
+     * @param {string} checkPayrollId
      * @param {OncycleApi.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.api.thera.payroll.oncycleApi.cancelCurrentAutopilotPayroll("string")
+     *     await client.api.thera.payroll.oncycleApi.getOnCycleCheckDetails("string", "string")
      */
-    cancelCurrentAutopilotPayroll(companyId, requestOptions) {
+    getOnCycleCheckDetails(companyId, checkPayrollId, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;
             const _response = yield core.fetcher({
-                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment)), `companies/${encodeURIComponent(companyId)}/w2-payroll/on-cycle-checks/cancel`),
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment)), `companies/${encodeURIComponent(companyId)}/w2-payroll/on-cycle-checks/${encodeURIComponent(checkPayrollId)}`),
+                method: "GET",
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@thera-hr/api-sdk", "X-Fern-SDK-Version": "0.0.1-prerelease3082-production", "User-Agent": "@thera-hr/api-sdk/0.0.1-prerelease3082-production", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                contentType: "application/json",
+                requestType: "json",
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return serializers.api.thera.payroll.oncycleApi.getOnCycleCheckDetails.Response.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    skipValidation: true,
+                    breadcrumbsPrefix: ["response"],
+                });
+            }
+            if (_response.error.reason === "status-code") {
+                throw new errors.TheraApiError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                });
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.TheraApiError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.TheraApiTimeoutError("Timeout exceeded when calling GET /companies/{companyID}/w2-payroll/on-cycle-checks/{checkPayrollId}.");
+                case "unknown":
+                    throw new errors.TheraApiError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
+    /**
+     *
+     *
+     * @param {string} companyId
+     * @param {string} checkPayScheduleId
+     * @param {OncycleApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.api.thera.payroll.oncycleApi.cancelCurrentAutopilotPayroll("string", "string")
+     */
+    cancelCurrentAutopilotPayroll(companyId, checkPayScheduleId, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const _response = yield core.fetcher({
+                url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment)), `companies/${encodeURIComponent(companyId)}/w2-payroll/pay-schedules/${encodeURIComponent(checkPayScheduleId)}/on-cycle-checks/cancel`),
                 method: "POST",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@thera-hr/api-sdk", "X-Fern-SDK-Version": "0.0.1-prerelease3080-dev-3", "User-Agent": "@thera-hr/api-sdk/0.0.1-prerelease3080-dev-3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@thera-hr/api-sdk", "X-Fern-SDK-Version": "0.0.1-prerelease3082-production", "User-Agent": "@thera-hr/api-sdk/0.0.1-prerelease3082-production", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -199,7 +254,7 @@ class OncycleApi {
                         body: _response.error.rawBody,
                     });
                 case "timeout":
-                    throw new errors.TheraApiTimeoutError("Timeout exceeded when calling POST /companies/{companyID}/w2-payroll/on-cycle-checks/cancel.");
+                    throw new errors.TheraApiTimeoutError("Timeout exceeded when calling POST /companies/{companyID}/w2-payroll/pay-schedules/{checkPayScheduleId}/on-cycle-checks/cancel.");
                 case "unknown":
                     throw new errors.TheraApiError({
                         message: _response.error.errorMessage,

package/dist/api/resources/api/resources/thera/resources/payroll/resources/oncycleApi/types/OnCycleChecksResponse.d.ts

@@ -2,6 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface OnCycleChecksResponse {
+    checkPayrollId: string;
     checkPayrollStatus: string;
     checkItemPayDate: string;
     checkItemIdByContractId: Record<string, string>;

package/dist/api/resources/api/resources/thera/resources/payroll/resources/payscheduleApi/client/Client.d.ts

@@ -0,0 +1,126 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as core from "../../../../../../../../../../core";
+import * as TheraApi from "../../../../../../../../../index";
+export declare namespace PayscheduleApi {
+    interface Options {
+        environment: core.Supplier<string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        token?: core.Supplier<core.BearerToken | undefined>;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
+    }
+}
+export declare class PayscheduleApi {
+    protected readonly _options: PayscheduleApi.Options;
+    constructor(_options: PayscheduleApi.Options);
+    /**
+     *
+     *
+     * @param {string} companyId
+     * @param {TheraApi.api.thera.payroll.CreatePayScheduleRequest} request
+     * @param {PayscheduleApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     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
+     *     })
+     */
+    createW2PaySchedule(companyId: string, request: TheraApi.api.thera.payroll.CreatePayScheduleRequest, requestOptions?: PayscheduleApi.RequestOptions): Promise<TheraApi.api.thera.payroll.GetPayScheduleResponse>;
+    /**
+     *
+     *
+     * @param {string} companyId
+     * @param {string} checkPayScheduleId
+     * @param {PayscheduleApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.api.thera.payroll.payscheduleApi.getW2PaySchedule("string", "string")
+     */
+    getW2PaySchedule(companyId: string, checkPayScheduleId: string, requestOptions?: PayscheduleApi.RequestOptions): Promise<TheraApi.api.thera.payroll.GetPayScheduleResponse>;
+    /**
+     *
+     *
+     * @param {string} companyId
+     * @param {PayscheduleApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.api.thera.payroll.payscheduleApi.listW2PaySchedules("string")
+     */
+    listW2PaySchedules(companyId: string, requestOptions?: PayscheduleApi.RequestOptions): Promise<TheraApi.api.thera.payroll.GetPayScheduleResponse[]>;
+    /**
+     * 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
+     *
+     * @param {string} companyId
+     * @param {string} checkPayScheduleId
+     * @param {PayscheduleApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.api.thera.payroll.payscheduleApi.deleteW2PaySchedule("string", "string")
+     */
+    deleteW2PaySchedule(companyId: string, checkPayScheduleId: string, requestOptions?: PayscheduleApi.RequestOptions): Promise<void>;
+    /**
+     *
+     *
+     * @param {string} companyId
+     * @param {string} checkPayScheduleId
+     * @param {TheraApi.api.thera.payroll.UpdatePayScheduleRequest} request
+     * @param {PayscheduleApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     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"
+     *         }
+     *     })
+     */
+    updateW2PaySchedule(companyId: string, checkPayScheduleId: string, request?: TheraApi.api.thera.payroll.UpdatePayScheduleRequest, requestOptions?: PayscheduleApi.RequestOptions): Promise<TheraApi.api.thera.payroll.GetPayScheduleResponse>;
+    /**
+     * 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
+     *
+     * @param {string} companyId
+     * @param {TheraApi.api.thera.payroll.AssignW2EmployeeToPayScheduleRequest} request
+     * @param {PayscheduleApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.api.thera.payroll.payscheduleApi.assignW2EmployeesPaySchedule("string", {
+     *         checkPayScheduleIdByUserId: {
+     *             "string": "string"
+     *         }
+     *     })
+     */
+    assignW2EmployeesPaySchedule(companyId: string, request: TheraApi.api.thera.payroll.AssignW2EmployeeToPayScheduleRequest, requestOptions?: PayscheduleApi.RequestOptions): Promise<TheraApi.api.thera.payroll.AssignW2EmployeeToPayScheduleResponse>;
+    /**
+     * Return several upcoming paydays (not all of them!)
+     *
+     * @param {string} companyId
+     * @param {string} checkPayScheduleId
+     * @param {PayscheduleApi.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.api.thera.payroll.payscheduleApi.getSomePaySchedulePaydays("string", "string")
+     */
+    getSomePaySchedulePaydays(companyId: string, checkPayScheduleId: string, requestOptions?: PayscheduleApi.RequestOptions): Promise<TheraApi.api.thera.payroll.GetPaySchedulePaydaysResponse[]>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}