PETOSS-345 - Fix the Idempotency key order in method definitions

[Raghunath-S-S-J]

Recently introduced idempotencyKey for POST, PUT and PATCH requests broke existing invocations, as this optional parameter is added in between of the method definition instead of the end.

Example using node SDK:

Previous:

updateOrCreateInvoices (xeroTenantId: string, invoices: Invoices, idempotencyKey?: string, summarizeErrors?: boolean, unitdp?: number, options: {headers: {[name: string]: string}} = {headers: {}})

Now:

updateOrCreateInvoices (xeroTenantId: string, invoices: Invoices, summarizeErrors?: boolean, unitdp?: number, idempotencyKey?: string, options: {headers: {[name: string]: string}} = {headers: {}})

Description

• Update method definitions to position idempotencyKey as last optional parameter.
• Fix method definitions where required request-body parameters are declared as optional.
  • Below are the methods changed due to request-body
  • Payroll-AU
    • updateEmployee
    • updatePayRun
    • updatePayslip
    • updateSuperfund
    • updateTimesheet
  • Files
    • uploadFile
    • updateFile
    • uploadFileToFolder
    • createFileAssociation
    • createFolder
  • Bankfeeds
    • createStatements
  • Assets
    • createAssetType

Release Notes

This change is required for app partners/SDK users to move to latest versions of SDKs without requiring to change method invocations.
Fixes #649 and #337

Screenshots (if appropriate):

Types of Changes

• Bug fix (non-breaking change that fixes an issue)
• New feature (non-breaking change that adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)

[github-actions]

PETOSS-388

[github-actions]

Thanks for raising an issue, a ticket has been created to track your request

[jameshulse]

I'm a little concerned that the "Breaking change" checkbox isn't checked. It was a breaking change when it went in, and it is surely a breaking change when it gets updated?

[Raghunath-S-S-J]

I'm a little concerned that the "Breaking change" checkbox isn't checked. It was a breaking change when it went in, and it is surely a breaking change when it gets updated?

Hi @jameshulse
Apologies for the inconvenience. Yes, it was a breaking change when it was released and we see people have refrained from using the troubling version. We are discussing internally whether to release this fix as a Patch update or as a Major update.