xero-node 4.34.0 → 4.36.0

package/dist/gen/api/payrollUKApi.d.ts

@@ -2,7 +2,7 @@
  * Xero Payroll UK
  * This is the Xero Payroll API for orgs in the UK region.
  *
- * The version of the OpenAPI document: 2.37.0
+ * The version of the OpenAPI document: 2.40.0
  * Contact: api@xero.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -97,8 +97,9 @@ export declare class PayrollUkApi {
      * @summary Approves a specific timesheet
      * @param xeroTenantId Xero identifier for Tenant
      * @param timesheetID Identifier for the timesheet
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    approveTimesheet(xeroTenantId: string, timesheetID: string, options?: {
+    approveTimesheet(xeroTenantId: string, timesheetID: string, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -111,8 +112,9 @@ export declare class PayrollUkApi {
      * @summary Creates a new employee benefit
      * @param xeroTenantId Xero identifier for Tenant
      * @param benefit
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createBenefit(xeroTenantId: string, benefit: Benefit, options?: {
+    createBenefit(xeroTenantId: string, benefit: Benefit, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -125,8 +127,9 @@ export declare class PayrollUkApi {
      * @summary Creates a new deduction
      * @param xeroTenantId Xero identifier for Tenant
      * @param deduction
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createDeduction(xeroTenantId: string, deduction: Deduction, options?: {
+    createDeduction(xeroTenantId: string, deduction: Deduction, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -139,8 +142,9 @@ export declare class PayrollUkApi {
      * @summary Creates a new earnings rate
      * @param xeroTenantId Xero identifier for Tenant
      * @param earningsRate
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createEarningsRate(xeroTenantId: string, earningsRate: EarningsRate, options?: {
+    createEarningsRate(xeroTenantId: string, earningsRate: EarningsRate, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -153,8 +157,9 @@ export declare class PayrollUkApi {
      * @summary Creates employees
      * @param xeroTenantId Xero identifier for Tenant
      * @param employee
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createEmployee(xeroTenantId: string, employee: Employee, options?: {
+    createEmployee(xeroTenantId: string, employee: Employee, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -168,8 +173,9 @@ export declare class PayrollUkApi {
      * @param xeroTenantId Xero identifier for Tenant
      * @param employeeID Employee id for single object
      * @param earningsTemplate
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createEmployeeEarningsTemplate(xeroTenantId: string, employeeID: string, earningsTemplate: EarningsTemplate, options?: {
+    createEmployeeEarningsTemplate(xeroTenantId: string, employeeID: string, earningsTemplate: EarningsTemplate, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -183,8 +189,9 @@ export declare class PayrollUkApi {
      * @param xeroTenantId Xero identifier for Tenant
      * @param employeeID Employee id for single object
      * @param employeeLeave
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createEmployeeLeave(xeroTenantId: string, employeeID: string, employeeLeave: EmployeeLeave, options?: {
+    createEmployeeLeave(xeroTenantId: string, employeeID: string, employeeLeave: EmployeeLeave, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -198,8 +205,9 @@ export declare class PayrollUkApi {
      * @param xeroTenantId Xero identifier for Tenant
      * @param employeeID Employee id for single object
      * @param employeeLeaveType
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createEmployeeLeaveType(xeroTenantId: string, employeeID: string, employeeLeaveType: EmployeeLeaveType, options?: {
+    createEmployeeLeaveType(xeroTenantId: string, employeeID: string, employeeLeaveType: EmployeeLeaveType, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -213,8 +221,9 @@ export declare class PayrollUkApi {
      * @param xeroTenantId Xero identifier for Tenant
      * @param employeeID Employee id for single object
      * @param employeeOpeningBalances
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createEmployeeOpeningBalances(xeroTenantId: string, employeeID: string, employeeOpeningBalances: EmployeeOpeningBalances, options?: {
+    createEmployeeOpeningBalances(xeroTenantId: string, employeeID: string, employeeOpeningBalances: EmployeeOpeningBalances, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -228,8 +237,9 @@ export declare class PayrollUkApi {
      * @param xeroTenantId Xero identifier for Tenant
      * @param employeeID Employee id for single object
      * @param paymentMethod
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createEmployeePaymentMethod(xeroTenantId: string, employeeID: string, paymentMethod: PaymentMethod, options?: {
+    createEmployeePaymentMethod(xeroTenantId: string, employeeID: string, paymentMethod: PaymentMethod, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -243,8 +253,9 @@ export declare class PayrollUkApi {
      * @param xeroTenantId Xero identifier for Tenant
      * @param employeeID Employee id for single object
      * @param salaryAndWage
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createEmployeeSalaryAndWage(xeroTenantId: string, employeeID: string, salaryAndWage: SalaryAndWage, options?: {
+    createEmployeeSalaryAndWage(xeroTenantId: string, employeeID: string, salaryAndWage: SalaryAndWage, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -257,8 +268,9 @@ export declare class PayrollUkApi {
      * @summary Creates statutory sick leave records
      * @param xeroTenantId Xero identifier for Tenant
      * @param employeeStatutorySickLeave
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createEmployeeStatutorySickLeave(xeroTenantId: string, employeeStatutorySickLeave: EmployeeStatutorySickLeave, options?: {
+    createEmployeeStatutorySickLeave(xeroTenantId: string, employeeStatutorySickLeave: EmployeeStatutorySickLeave, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -272,8 +284,9 @@ export declare class PayrollUkApi {
      * @param xeroTenantId Xero identifier for Tenant
      * @param employeeID Employee id for single object
      * @param employment
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createEmployment(xeroTenantId: string, employeeID: string, employment: Employment, options?: {
+    createEmployment(xeroTenantId: string, employeeID: string, employment: Employment, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -286,8 +299,9 @@ export declare class PayrollUkApi {
      * @summary Creates a new leave type
      * @param xeroTenantId Xero identifier for Tenant
      * @param leaveType
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createLeaveType(xeroTenantId: string, leaveType: LeaveType, options?: {
+    createLeaveType(xeroTenantId: string, leaveType: LeaveType, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -301,8 +315,9 @@ export declare class PayrollUkApi {
      * @param xeroTenantId Xero identifier for Tenant
      * @param employeeID Employee id for single object
      * @param earningsTemplate
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createMultipleEmployeeEarningsTemplate(xeroTenantId: string, employeeID: string, earningsTemplate: Array<EarningsTemplate>, options?: {
+    createMultipleEmployeeEarningsTemplate(xeroTenantId: string, employeeID: string, earningsTemplate: Array<EarningsTemplate>, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -315,8 +330,9 @@ export declare class PayrollUkApi {
      * @summary Creates a new payrun calendar
      * @param xeroTenantId Xero identifier for Tenant
      * @param payRunCalendar
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createPayRunCalendar(xeroTenantId: string, payRunCalendar: PayRunCalendar, options?: {
+    createPayRunCalendar(xeroTenantId: string, payRunCalendar: PayRunCalendar, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -329,8 +345,9 @@ export declare class PayrollUkApi {
      * @summary Creates a new reimbursement
      * @param xeroTenantId Xero identifier for Tenant
      * @param reimbursement
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createReimbursement(xeroTenantId: string, reimbursement: Reimbursement, options?: {
+    createReimbursement(xeroTenantId: string, reimbursement: Reimbursement, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -343,8 +360,9 @@ export declare class PayrollUkApi {
      * @summary Creates a new timesheet
      * @param xeroTenantId Xero identifier for Tenant
      * @param timesheet
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createTimesheet(xeroTenantId: string, timesheet: Timesheet, options?: {
+    createTimesheet(xeroTenantId: string, timesheet: Timesheet, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -358,8 +376,9 @@ export declare class PayrollUkApi {
      * @param xeroTenantId Xero identifier for Tenant
      * @param timesheetID Identifier for the timesheet
      * @param timesheetLine
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    createTimesheetLine(xeroTenantId: string, timesheetID: string, timesheetLine: TimesheetLine, options?: {
+    createTimesheetLine(xeroTenantId: string, timesheetID: string, timesheetLine: TimesheetLine, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -993,8 +1012,9 @@ export declare class PayrollUkApi {
      * @summary Reverts a specific timesheet to draft
      * @param xeroTenantId Xero identifier for Tenant
      * @param timesheetID Identifier for the timesheet
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    revertTimesheet(xeroTenantId: string, timesheetID: string, options?: {
+    revertTimesheet(xeroTenantId: string, timesheetID: string, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -1008,8 +1028,9 @@ export declare class PayrollUkApi {
      * @param xeroTenantId Xero identifier for Tenant
      * @param employeeID Employee id for single object
      * @param employee
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    updateEmployee(xeroTenantId: string, employeeID: string, employee: Employee, options?: {
+    updateEmployee(xeroTenantId: string, employeeID: string, employee: Employee, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -1024,8 +1045,9 @@ export declare class PayrollUkApi {
      * @param employeeID Employee id for single object
      * @param payTemplateEarningID Id for single pay template earnings object
      * @param earningsTemplate
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    updateEmployeeEarningsTemplate(xeroTenantId: string, employeeID: string, payTemplateEarningID: string, earningsTemplate: EarningsTemplate, options?: {
+    updateEmployeeEarningsTemplate(xeroTenantId: string, employeeID: string, payTemplateEarningID: string, earningsTemplate: EarningsTemplate, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -1040,8 +1062,9 @@ export declare class PayrollUkApi {
      * @param employeeID Employee id for single object
      * @param leaveID Leave id for single object
      * @param employeeLeave
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    updateEmployeeLeave(xeroTenantId: string, employeeID: string, leaveID: string, employeeLeave: EmployeeLeave, options?: {
+    updateEmployeeLeave(xeroTenantId: string, employeeID: string, leaveID: string, employeeLeave: EmployeeLeave, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -1055,8 +1078,9 @@ export declare class PayrollUkApi {
      * @param xeroTenantId Xero identifier for Tenant
      * @param employeeID Employee id for single object
      * @param employeeOpeningBalances
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    updateEmployeeOpeningBalances(xeroTenantId: string, employeeID: string, employeeOpeningBalances: EmployeeOpeningBalances, options?: {
+    updateEmployeeOpeningBalances(xeroTenantId: string, employeeID: string, employeeOpeningBalances: EmployeeOpeningBalances, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -1071,8 +1095,9 @@ export declare class PayrollUkApi {
      * @param employeeID Employee id for single object
      * @param salaryAndWagesID Id for single pay template earnings object
      * @param salaryAndWage
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    updateEmployeeSalaryAndWage(xeroTenantId: string, employeeID: string, salaryAndWagesID: string, salaryAndWage: SalaryAndWage, options?: {
+    updateEmployeeSalaryAndWage(xeroTenantId: string, employeeID: string, salaryAndWagesID: string, salaryAndWage: SalaryAndWage, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -1086,8 +1111,9 @@ export declare class PayrollUkApi {
      * @param xeroTenantId Xero identifier for Tenant
      * @param payRunID Identifier for the pay run
      * @param payRun
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    updatePayRun(xeroTenantId: string, payRunID: string, payRun: PayRun, options?: {
+    updatePayRun(xeroTenantId: string, payRunID: string, payRun: PayRun, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };
@@ -1102,8 +1128,9 @@ export declare class PayrollUkApi {
      * @param timesheetID Identifier for the timesheet
      * @param timesheetLineID Identifier for the timesheet line
      * @param timesheetLine
+     * @param idempotencyKey This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
      */
-    updateTimesheetLine(xeroTenantId: string, timesheetID: string, timesheetLineID: string, timesheetLine: TimesheetLine, options?: {
+    updateTimesheetLine(xeroTenantId: string, timesheetID: string, timesheetLineID: string, timesheetLine: TimesheetLine, idempotencyKey?: string, options?: {
         headers: {
             [name: string]: string;
         };