@greensecurity/javascript-sdk 0.43.1-beta.80 → 0.43.1-beta.82

package/src/react-query/vendorsListVendorInvoices.ts

@@ -53,12 +53,16 @@ export {
  * List vendor invoices
  *
  * @remarks
- * List invoices for Vendors
+ * List invoices for Vendors.
+ *
+ * Deprecated: use `GET /invoices` instead, which supports both vendors and other roles through role-based scoping and the `id` query parameter for vendors.
  *
  * Available `expand` scopes are:
  *
  * invoice.line_items
  * invoice.may_pay_invoice
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export function useVendorsListVendorInvoices(
   request: operations.ListVendorInvoicesRequest,
@@ -79,12 +83,16 @@ export function useVendorsListVendorInvoices(
  * List vendor invoices
  *
  * @remarks
- * List invoices for Vendors
+ * List invoices for Vendors.
+ *
+ * Deprecated: use `GET /invoices` instead, which supports both vendors and other roles through role-based scoping and the `id` query parameter for vendors.
  *
  * Available `expand` scopes are:
  *
  * invoice.line_items
  * invoice.may_pay_invoice
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export function useVendorsListVendorInvoicesSuspense(
   request: operations.ListVendorInvoicesRequest,
@@ -105,12 +113,16 @@ export function useVendorsListVendorInvoicesSuspense(
  * List vendor invoices
  *
  * @remarks
- * List invoices for Vendors
+ * List invoices for Vendors.
+ *
+ * Deprecated: use `GET /invoices` instead, which supports both vendors and other roles through role-based scoping and the `id` query parameter for vendors.
  *
  * Available `expand` scopes are:
  *
  * invoice.line_items
  * invoice.may_pay_invoice
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export function useVendorsListVendorInvoicesInfinite(
   request: operations.ListVendorInvoicesRequest,
@@ -150,12 +162,16 @@ export function useVendorsListVendorInvoicesInfinite(
  * List vendor invoices
  *
  * @remarks
- * List invoices for Vendors
+ * List invoices for Vendors.
+ *
+ * Deprecated: use `GET /invoices` instead, which supports both vendors and other roles through role-based scoping and the `id` query parameter for vendors.
  *
  * Available `expand` scopes are:
  *
  * invoice.line_items
  * invoice.may_pay_invoice
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export function useVendorsListVendorInvoicesInfiniteSuspense(
   request: operations.ListVendorInvoicesRequest,

package/src/sdk/invoices.ts

@@ -32,6 +32,13 @@ export class Invoices extends ClientSDK {
    * - invoice.custom_fields
    * - invoice.invoice_type
    * - invoice.may_pay_invoice
+   *
+   * Available `sort` values are:
+   * - id (default)
+   * - invoice_number
+   * - date (processed date)
+   * - financial_status
+   * - amount
    */
   async listInvoices(
     request: operations.ListInvoicesRequest,

package/src/sdk/vendors.ts

@@ -524,12 +524,16 @@ export class Vendors extends ClientSDK {
    * List vendor invoices
    *
    * @remarks
-   * List invoices for Vendors
+   * List invoices for Vendors.
+   *
+   * Deprecated: use `GET /invoices` instead, which supports both vendors and other roles through role-based scoping and the `id` query parameter for vendors.
    *
    * Available `expand` scopes are:
    *
    * invoice.line_items
    * invoice.may_pay_invoice
+   *
+   * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   async listVendorInvoices(
     request: operations.ListVendorInvoicesRequest,