@getyetty-sdk/pennylane 2026.3.18 → 2026.3.20

package/dist/index.d.mts

@@ -370,15 +370,17 @@ declare const createClient: (config?: Config) => Client;
 declare const CompanyWebhookSubscriptionEvents: {
   readonly CUSTOMER_INVOICE_CREATED: "customer_invoice.created";
   readonly QUOTE_CREATED: "quote.created";
+  readonly DMS_FILE_CREATED: "dms_file.created";
 };
 type CompanyWebhookSubscriptionEvents = (typeof CompanyWebhookSubscriptionEvents)[keyof typeof CompanyWebhookSubscriptionEvents];
 /**
  * Array of event types to subscribe to.
  * - `customer_invoice.created`: the event is triggered when a customer invoice is created.
  * - `quote.created`: the event is triggered when a quote is created.
+ * - `dms_file.created`: the event is triggered when a dms file is created.
  *
  */
-type WebhookSubscriptionsEvents = Array<'customer_invoice.created' | 'quote.created'>;
+type WebhookSubscriptionsEvents = Array<'customer_invoice.created' | 'quote.created' | 'dms_file.created'>;
 type WebhookSubscriptionsResponse = {
   /**
    * ID of the webhook subscription
@@ -392,9 +394,10 @@ type WebhookSubscriptionsResponse = {
    * Array of event types to subscribe to.
    * - `customer_invoice.created`: the event is triggered when a customer invoice is created.
    * - `quote.created`: the event is triggered when a quote is created.
+   * - `dms_file.created`: the event is triggered when a dms file is created.
    *
    */
-  events: Array<'customer_invoice.created' | 'quote.created'>;
+  events: Array<'customer_invoice.created' | 'quote.created' | 'dms_file.created'>;
   /**
    * Indicates whether the webhook subscription is active
    */
@@ -449,9 +452,10 @@ type WebhookSubscriptionsCreateResponse = {
    * Array of event types to subscribe to.
    * - `customer_invoice.created`: the event is triggered when a customer invoice is created.
    * - `quote.created`: the event is triggered when a quote is created.
+   * - `dms_file.created`: the event is triggered when a dms file is created.
    *
    */
-  events: Array<'customer_invoice.created' | 'quote.created'>;
+  events: Array<'customer_invoice.created' | 'quote.created' | 'dms_file.created'>;
   /**
    * Indicates whether the webhook subscription is active
    */
@@ -2279,6 +2283,10 @@ type CustomerInvoicesPostDraftRequest = {
      */
     rank: number;
   }>;
+  /**
+   * Custom label for the invoice used on accounting (ledger) entries. If not provided, Pennylane generates a label automatically.
+   */
+  label?: string | null;
   /**
    * A unique external reference you can provide to track this customer invoice. If not provided, Pennylane will generate an identifier for you.
    */
@@ -2556,6 +2564,10 @@ type CustomerInvoicesPostFinalizedRequest = {
    */
   special_mention?: string | null;
   language?: 'fr_FR' | 'en_GB';
+  /**
+   * Custom label for the invoice used on accounting (ledger) entries. If not provided, Pennylane generates a label automatically.
+   */
+  label?: string | null;
   discount?: {
     /**
      * Discount type.
@@ -3763,6 +3775,10 @@ type CustomerInvoicesPutDraftRequest = {
       id: number;
     }>;
   };
+  /**
+   * Custom label for the invoice used on accounting (ledger) entries. If not provided, Pennylane generates a label automatically.
+   */
+  label?: string | null;
   /**
    * The unique external reference that was assigned during creation either by you or Pennylane.
    */
@@ -3772,6 +3788,10 @@ type CustomerInvoicesPutDraftRequest = {
  * Finalized Customer Invoice
  */
 type CustomerInvoicesPutFinalizedRequest = {
+  /**
+   * Custom label for the invoice used on accounting (ledger) entries. If not provided, Pennylane generates a label automatically.
+   */
+  label?: string | null;
   /**
    * Schema for creating/updating a transaction reference
    */
@@ -5735,9 +5755,10 @@ type GetWebhookSubscriptionResponses = {
      * Array of event types to subscribe to.
      * - `customer_invoice.created`: the event is triggered when a customer invoice is created.
      * - `quote.created`: the event is triggered when a quote is created.
+     * - `dms_file.created`: the event is triggered when a dms file is created.
      *
      */
-    events: Array<'customer_invoice.created' | 'quote.created'>;
+    events: Array<'customer_invoice.created' | 'quote.created' | 'dms_file.created'>;
     /**
      * Indicates whether the webhook subscription is active
      */
@@ -5763,9 +5784,10 @@ type PostWebhookSubscriptionData = {
      * Array of event types to subscribe to.
      * - `customer_invoice.created`: the event is triggered when a customer invoice is created.
      * - `quote.created`: the event is triggered when a quote is created.
+     * - `dms_file.created`: the event is triggered when a dms file is created.
      *
      */
-    events: Array<'customer_invoice.created' | 'quote.created'>;
+    events: Array<'customer_invoice.created' | 'quote.created' | 'dms_file.created'>;
     /**
      * Indicates whether the webhook subscription is active
      */
@@ -5855,9 +5877,10 @@ type PostWebhookSubscriptionResponses = {
      * Array of event types to subscribe to.
      * - `customer_invoice.created`: the event is triggered when a customer invoice is created.
      * - `quote.created`: the event is triggered when a quote is created.
+     * - `dms_file.created`: the event is triggered when a dms file is created.
      *
      */
-    events: Array<'customer_invoice.created' | 'quote.created'>;
+    events: Array<'customer_invoice.created' | 'quote.created' | 'dms_file.created'>;
     /**
      * Indicates whether the webhook subscription is active
      */
@@ -5889,9 +5912,10 @@ type PutWebhookSubscriptionData = {
      * Array of event types to subscribe to.
      * - `customer_invoice.created`: the event is triggered when a customer invoice is created.
      * - `quote.created`: the event is triggered when a quote is created.
+     * - `dms_file.created`: the event is triggered when a dms file is created.
      *
      */
-    events?: Array<'customer_invoice.created' | 'quote.created'>;
+    events?: Array<'customer_invoice.created' | 'quote.created' | 'dms_file.created'>;
     /**
      * Indicates whether the webhook subscription is active
      */
@@ -5974,9 +5998,10 @@ type PutWebhookSubscriptionResponses = {
      * Array of event types to subscribe to.
      * - `customer_invoice.created`: the event is triggered when a customer invoice is created.
      * - `quote.created`: the event is triggered when a quote is created.
+     * - `dms_file.created`: the event is triggered when a dms file is created.
      *
      */
-    events: Array<'customer_invoice.created' | 'quote.created'>;
+    events: Array<'customer_invoice.created' | 'quote.created' | 'dms_file.created'>;
     /**
      * Indicates whether the webhook subscription is active
      */
@@ -10128,6 +10153,10 @@ type PostCustomerInvoicesData = {
        */
       rank: number;
     }>;
+    /**
+     * Custom label for the invoice used on accounting (ledger) entries. If not provided, Pennylane generates a label automatically.
+     */
+    label?: string | null;
     /**
      * A unique external reference you can provide to track this customer invoice. If not provided, Pennylane will generate an identifier for you.
      */
@@ -10268,6 +10297,10 @@ type PostCustomerInvoicesData = {
      */
     special_mention?: string | null;
     language?: 'fr_FR' | 'en_GB';
+    /**
+     * Custom label for the invoice used on accounting (ledger) entries. If not provided, Pennylane generates a label automatically.
+     */
+    label?: string | null;
     discount?: {
       /**
        * Discount type.
@@ -10781,6 +10814,10 @@ type ImportCustomerInvoicesData = {
      * Invoice taxable amount (in euros). If the currency is euro, `currency_tax` and `tax` are identical.
      */
     tax?: string;
+    /**
+     * Custom label for the invoice used on accounting (ledger) entries. If not provided, Pennylane generates a label automatically.
+     */
+    label?: string | null;
     /**
      * By adding this field you can automatically reconcile the newly imported invoice with a transaction. See documentation about [automatic payment matching](https://pennylane.readme.io/v2.0/docs/automating-payment-matching).
      */
@@ -18756,11 +18793,19 @@ type UpdateCustomerInvoiceData = {
         id: number;
       }>;
     };
+    /**
+     * Custom label for the invoice used on accounting (ledger) entries. If not provided, Pennylane generates a label automatically.
+     */
+    label?: string | null;
     /**
      * The unique external reference that was assigned during creation either by you or Pennylane.
      */
     external_reference?: string;
   } | {
+    /**
+     * Custom label for the invoice used on accounting (ledger) entries. If not provided, Pennylane generates a label automatically.
+     */
+    label?: string | null;
     /**
      * Schema for creating/updating a transaction reference
      */
@@ -21307,6 +21352,10 @@ type PutSupplierInvoiceData = {
      * The invoice number
      */
     invoice_number?: string;
+    /**
+     * Custom label for the invoice used on accounting (ledger) entries. If not provided, Pennylane generates a label automatically.
+     */
+    label?: string | null;
     currency?: 'EUR' | 'USD' | 'GBP' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GEL' | 'GGP' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'IMP' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JEP' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XDR' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMK' | 'ZMW' | 'ZWL';
     /**
      * Invoice currency amount before tax (total value before tax of the invoice in the currency of the invoice)
@@ -22520,6 +22569,10 @@ type ImportSupplierInvoiceData = {
      * Invoice taxable amount (in euros). If the currency is euro, `currency_tax` and `tax` are identical.
      */
     tax?: string;
+    /**
+     * Custom label for the invoice used on accounting (ledger) entries. If not provided, Pennylane generates a label automatically.
+     */
+    label?: string | null;
     /**
      * By adding this field you can automatically reconcile the newly imported invoice with a transaction. See documentation about [automatic payment matching](https://pennylane.readme.io/v2.0/docs/automating-payment-matching).
      */
@@ -32001,14 +32054,14 @@ declare const client: Client;
 //#region src/generated/schemas.gen.d.ts
 declare const CompanyWebhookSubscriptionEventsSchema: {
   readonly type: "string";
-  readonly enum: readonly ["customer_invoice.created", "quote.created"];
+  readonly enum: readonly ["customer_invoice.created", "quote.created", "dms_file.created"];
 };
 declare const WebhookSubscriptions__EventsSchema: {
-  readonly description: "Array of event types to subscribe to.\n- `customer_invoice.created`: the event is triggered when a customer invoice is created.\n- `quote.created`: the event is triggered when a quote is created.\n";
+  readonly description: "Array of event types to subscribe to.\n- `customer_invoice.created`: the event is triggered when a customer invoice is created.\n- `quote.created`: the event is triggered when a quote is created.\n- `dms_file.created`: the event is triggered when a dms file is created.\n";
   readonly type: "array";
   readonly items: {
     readonly type: "string";
-    readonly enum: readonly ["customer_invoice.created", "quote.created"];
+    readonly enum: readonly ["customer_invoice.created", "quote.created", "dms_file.created"];
   };
   readonly example: readonly ["customer_invoice.created", "quote.created"];
   readonly minItems: 1;
@@ -32029,11 +32082,11 @@ declare const WebhookSubscriptions__ResponseSchema: {
       readonly example: "https://example.com/webhooks";
     };
     readonly events: {
-      readonly description: "Array of event types to subscribe to.\n- `customer_invoice.created`: the event is triggered when a customer invoice is created.\n- `quote.created`: the event is triggered when a quote is created.\n";
+      readonly description: "Array of event types to subscribe to.\n- `customer_invoice.created`: the event is triggered when a customer invoice is created.\n- `quote.created`: the event is triggered when a quote is created.\n- `dms_file.created`: the event is triggered when a dms file is created.\n";
       readonly type: "array";
       readonly items: {
         readonly type: "string";
-        readonly enum: readonly ["customer_invoice.created", "quote.created"];
+        readonly enum: readonly ["customer_invoice.created", "quote.created", "dms_file.created"];
       };
       readonly example: readonly ["customer_invoice.created", "quote.created"];
       readonly minItems: 1;
@@ -32078,11 +32131,11 @@ declare const WebhookSubscriptions__CreateResponseSchema: {
       readonly example: "https://example.com/webhooks";
     };
     readonly events: {
-      readonly description: "Array of event types to subscribe to.\n- `customer_invoice.created`: the event is triggered when a customer invoice is created.\n- `quote.created`: the event is triggered when a quote is created.\n";
+      readonly description: "Array of event types to subscribe to.\n- `customer_invoice.created`: the event is triggered when a customer invoice is created.\n- `quote.created`: the event is triggered when a quote is created.\n- `dms_file.created`: the event is triggered when a dms file is created.\n";
       readonly type: "array";
       readonly items: {
         readonly type: "string";
-        readonly enum: readonly ["customer_invoice.created", "quote.created"];
+        readonly enum: readonly ["customer_invoice.created", "quote.created", "dms_file.created"];
       };
       readonly example: readonly ["customer_invoice.created", "quote.created"];
       readonly minItems: 1;
@@ -34094,6 +34147,13 @@ declare const CustomerInvoices__PostDraft_RequestSchema: {
         readonly required: readonly ["rank"];
       };
     };
+    readonly label: {
+      readonly description: "Custom label for the invoice used on accounting (ledger) entries. If not provided, Pennylane generates a label automatically.";
+      readonly type: "string";
+      readonly maxLength: 2000;
+      readonly nullable: true;
+      readonly example: "Custom accounting label";
+    };
     readonly external_reference: {
       readonly description: "A unique external reference you can provide to track this customer invoice. If not provided, Pennylane will generate an identifier for you.";
       readonly type: "string";
@@ -34499,6 +34559,13 @@ declare const CustomerInvoices__PostFinalized_RequestSchema: {
       readonly default: "fr_FR";
       readonly enum: readonly ["fr_FR", "en_GB"];
     };
+    readonly label: {
+      readonly description: "Custom label for the invoice used on accounting (ledger) entries. If not provided, Pennylane generates a label automatically.";
+      readonly type: "string";
+      readonly maxLength: 2000;
+      readonly nullable: true;
+      readonly example: "Custom accounting label";
+    };
     readonly discount: {
       readonly type: "object";
       readonly additionalProperties: false;
@@ -36875,6 +36942,13 @@ declare const CustomerInvoices__PutDraft_RequestSchema: {
         };
       };
     };
+    readonly label: {
+      readonly description: "Custom label for the invoice used on accounting (ledger) entries. If not provided, Pennylane generates a label automatically.";
+      readonly type: "string";
+      readonly maxLength: 2000;
+      readonly nullable: true;
+      readonly example: "Custom accounting label";
+    };
     readonly external_reference: {
       readonly description: "The unique external reference that was assigned during creation either by you or Pennylane.";
       readonly type: "string";
@@ -36887,6 +36961,13 @@ declare const CustomerInvoices__PutFinalized_RequestSchema: {
   readonly type: "object";
   readonly additionalProperties: false;
   readonly properties: {
+    readonly label: {
+      readonly description: "Custom label for the invoice used on accounting (ledger) entries. If not provided, Pennylane generates a label automatically.";
+      readonly type: "string";
+      readonly maxLength: 2000;
+      readonly nullable: true;
+      readonly example: "Custom accounting label";
+    };
     readonly transaction_reference: {
       readonly description: "Schema for creating/updating a transaction reference";
       readonly type: "object";