@getyetty-sdk/pennylane 2026.1.22 → 2026.1.28

package/README.md

@@ -1,6 +1,6 @@
 # @getyetty-sdk/pennylane
 
-TypeScript client for the [Pennylane Accounting API](https://pennylane.readme.io/reference/introduction), auto-generated from the official OpenAPI specification.
+TypeScript client for the [Pennylane Accounting API](https://pennylane.readme.io/reference), auto-generated from the official OpenAPI specification.
 
 ## ⚠️ Disclaimer
 
@@ -73,7 +73,12 @@ const newCustomer = await postCompanyCustomer({
 ### Creating a Custom Client Instance
 
 ```typescript
-import { createClient, createClientWithApiKey, createConfig, getCustomers } from '@getyetty-sdk/pennylane';
+import {
+  createClient,
+  createClientWithApiKey,
+  createConfig,
+  getCustomers,
+} from '@getyetty-sdk/pennylane';
 
 const pennylane = createClient(
   createConfig({
@@ -81,11 +86,11 @@ const pennylane = createClient(
     headers: {
       Authorization: `Bearer ${process.env.PENNYLANE_API_KEY}`,
     },
-  })
+  }),
 );
 
 // Or alternatively if you just have to provide an API key
-const pennylane = createClientWithApiKey(process.env.PENNYLANE_API_KEY)
+const pennylane = createClientWithApiKey(process.env.PENNYLANE_API_KEY);
 
 // Use the custom client
 const customers = await getCustomers({
@@ -96,7 +101,7 @@ const customers = await getCustomers({
 
 ## 📚 API Documentation
 
-For detailed API documentation, please refer to the [official Pennylane API docs](https://pennylane.readme.io/reference/introduction).
+For detailed API documentation, please refer to the [official Pennylane API docs](https://pennylane.readme.io).
 
 ## 📄 License
 

package/dist/index.d.mts

@@ -90,18 +90,18 @@ declare const buildClientParams: (args: ReadonlyArray<unknown>, fields: FieldsCo
 //#endregion
 //#region src/generated/core/types.gen.d.ts
 type HttpMethod = 'connect' | 'delete' | 'get' | 'head' | 'options' | 'patch' | 'post' | 'put' | 'trace';
-type Client$1<RequestFn$1 = never, Config$2 = unknown, MethodFn$1 = never, BuildUrlFn$1 = never, SseFn$1 = never> = {
+type Client$1<RequestFn = never, Config = unknown, MethodFn = never, BuildUrlFn = never, SseFn = never> = {
   /**
    * Returns the final request URL.
    */
-  buildUrl: BuildUrlFn$1;
-  getConfig: () => Config$2;
-  request: RequestFn$1;
-  setConfig: (config: Config$2) => Config$2;
-} & { [K in HttpMethod]: MethodFn$1 } & ([SseFn$1] extends [never] ? {
+  buildUrl: BuildUrlFn;
+  getConfig: () => Config;
+  request: RequestFn;
+  setConfig: (config: Config) => Config;
+} & { [K in HttpMethod]: MethodFn } & ([SseFn] extends [never] ? {
   sse?: never;
 } : {
-  sse: { [K in HttpMethod]: SseFn$1 };
+  sse: { [K in HttpMethod]: SseFn };
 });
 interface Config$1 {
   /**
@@ -230,9 +230,9 @@ type ServerSentEventsResult<TData = unknown, TReturn = void, TNext = unknown> =
 //#endregion
 //#region src/generated/client/utils.gen.d.ts
 declare const mergeHeaders: (...headers: Array<Required<Config>["headers"] | undefined>) => Headers;
-type ErrInterceptor<Err, Res, Req, Options$2> = (error: Err, response: Res, request: Req, options: Options$2) => Err | Promise<Err>;
-type ReqInterceptor<Req, Options$2> = (request: Req, options: Options$2) => Req | Promise<Req>;
-type ResInterceptor<Res, Req, Options$2> = (response: Res, request: Req, options: Options$2) => Res | Promise<Res>;
+type ErrInterceptor<Err, Res, Req, Options> = (error: Err, response: Res, request: Req, options: Options) => Err | Promise<Err>;
+type ReqInterceptor<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>;
+type ResInterceptor<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
 declare class Interceptors<Interceptor> {
   fns: Array<Interceptor | null>;
   clear(): void;
@@ -242,10 +242,10 @@ declare class Interceptors<Interceptor> {
   update(id: number | Interceptor, fn: Interceptor): number | Interceptor | false;
   use(fn: Interceptor): number;
 }
-interface Middleware<Req, Res, Err, Options$2> {
-  error: Interceptors<ErrInterceptor<Err, Res, Req, Options$2>>;
-  request: Interceptors<ReqInterceptor<Req, Options$2>>;
-  response: Interceptors<ResInterceptor<Res, Req, Options$2>>;
+interface Middleware<Req, Res, Err, Options> {
+  error: Interceptors<ErrInterceptor<Err, Res, Req, Options>>;
+  request: Interceptors<ReqInterceptor<Req, Options>>;
+  response: Interceptors<ResInterceptor<Res, Req, Options>>;
 }
 declare const createConfig: <T extends ClientOptions = ClientOptions>(override?: Config<Omit<ClientOptions, keyof T> & T>) => Config<Omit<ClientOptions, keyof T> & T>;
 //#endregion
@@ -360,7 +360,7 @@ interface TDataShape {
   query?: unknown;
   url: string;
 }
-type OmitKeys<T, K$1> = Pick<T, Exclude<keyof T, K$1>>;
+type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
 type Options$1<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown, TResponseStyle extends ResponseStyle = 'fields'> = OmitKeys<RequestOptions<TResponse, TResponseStyle, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & ([TData] extends [never] ? unknown : Omit<TData, 'url'>);
 //#endregion
 //#region src/generated/client/client.gen.d.ts
@@ -400,7 +400,7 @@ declare const BadRequestCodeEnum: {
   readonly NOT_ONE_OF: "NotOneOf";
   readonly VALIDATE_ERROR: "ValidateError";
 };
-type BadRequestCodeEnum = typeof BadRequestCodeEnum[keyof typeof BadRequestCodeEnum];
+type BadRequestCodeEnum = (typeof BadRequestCodeEnum)[keyof typeof BadRequestCodeEnum];
 type LedgerAccountsResponse = {
   id: number;
   number: string;
@@ -566,7 +566,7 @@ declare const VatRateWithAnyAndMixed: {
   readonly ANY: "any";
   readonly MIXED: "mixed";
 };
-type VatRateWithAnyAndMixed = typeof VatRateWithAnyAndMixed[keyof typeof VatRateWithAnyAndMixed];
+type VatRateWithAnyAndMixed = (typeof VatRateWithAnyAndMixed)[keyof typeof VatRateWithAnyAndMixed];
 declare const AuthorizedCountryAlpha2WithAny: {
   readonly AT: "AT";
   readonly BE: "BE";
@@ -603,7 +603,7 @@ declare const AuthorizedCountryAlpha2WithAny: {
   readonly NO: "NO";
   readonly ANY: "any";
 };
-type AuthorizedCountryAlpha2WithAny = typeof AuthorizedCountryAlpha2WithAny[keyof typeof AuthorizedCountryAlpha2WithAny];
+type AuthorizedCountryAlpha2WithAny = (typeof AuthorizedCountryAlpha2WithAny)[keyof typeof AuthorizedCountryAlpha2WithAny];
 type LedgerEntriesCategories = Array<{
   id: number;
   label: string;
@@ -785,7 +785,7 @@ declare const Currency: {
   readonly ZMW: "ZMW";
   readonly ZWL: "ZWL";
 };
-type Currency = typeof Currency[keyof typeof Currency];
+type Currency = (typeof Currency)[keyof typeof Currency];
 type LedgerEntriesResponse = {
   /**
    * ID of the ledger entry
@@ -1000,7 +1000,7 @@ declare const UnbalancedLetteringStrategy: {
  * - `partial`: a potentially unbalanced lettering will be created.
  *
  */
-type UnbalancedLetteringStrategy = typeof UnbalancedLetteringStrategy[keyof typeof UnbalancedLetteringStrategy];
+type UnbalancedLetteringStrategy = (typeof UnbalancedLetteringStrategy)[keyof typeof UnbalancedLetteringStrategy];
 type LedgerEntryLinesLetteredLedgerEntryLinesCategoriesResponse = Array<{
   id: number;
   label: string;
@@ -1274,12 +1274,12 @@ declare const SchemasCurrency: {
   readonly ZMW: "ZMW";
   readonly ZWL: "ZWL";
 };
-type SchemasCurrency = typeof SchemasCurrency[keyof typeof SchemasCurrency];
+type SchemasCurrency = (typeof SchemasCurrency)[keyof typeof SchemasCurrency];
 declare const TemplatesAvailablesLocales: {
   readonly FR_FR: "fr_FR";
   readonly EN_GB: "en_GB";
 };
-type TemplatesAvailablesLocales = typeof TemplatesAvailablesLocales[keyof typeof TemplatesAvailablesLocales];
+type TemplatesAvailablesLocales = (typeof TemplatesAvailablesLocales)[keyof typeof TemplatesAvailablesLocales];
 declare const InvoiceStatuses: {
   readonly ARCHIVED: "archived";
   readonly INCOMPLETE: "incomplete";
@@ -1291,7 +1291,7 @@ declare const InvoiceStatuses: {
   readonly DRAFT: "draft";
   readonly CREDIT_NOTE: "credit_note";
 };
-type InvoiceStatuses = typeof InvoiceStatuses[keyof typeof InvoiceStatuses];
+type InvoiceStatuses = (typeof InvoiceStatuses)[keyof typeof InvoiceStatuses];
 /**
  * Discount type.
  * - absolute if it is an amount
@@ -1308,7 +1308,7 @@ declare const DiscountType: {
  * - relative if it is a percentage
  *
  */
-type DiscountType = typeof DiscountType[keyof typeof DiscountType];
+type DiscountType = (typeof DiscountType)[keyof typeof DiscountType];
 type CustomerInvoicesResponse = {
   /**
    * Invoice identifier
@@ -1652,7 +1652,7 @@ declare const VatRate: {
 /**
  * Product VAT rate. A 20% VAT in France is FR_200.
  */
-type VatRate = typeof VatRate[keyof typeof VatRate];
+type VatRate = (typeof VatRate)[keyof typeof VatRate];
 /**
  * Customer Invoice Line
  */
@@ -2608,7 +2608,7 @@ declare const BillingSubscriptionStatus: {
   readonly NOT_STARTED: "not_started";
   readonly IN_PROGRESS: "in_progress";
 };
-type BillingSubscriptionStatus = typeof BillingSubscriptionStatus[keyof typeof BillingSubscriptionStatus];
+type BillingSubscriptionStatus = (typeof BillingSubscriptionStatus)[keyof typeof BillingSubscriptionStatus];
 /**
  * - `awaiting_validation`: generated invoices will be in draft
  * - `finalized`: generated invoices will be finalized
@@ -2626,7 +2626,7 @@ declare const BillingSubscriptionMode: {
  * - `email`: generated invoices will be finalized and sent by email to the recipients configured on the subscription
  *
  */
-type BillingSubscriptionMode = typeof BillingSubscriptionMode[keyof typeof BillingSubscriptionMode];
+type BillingSubscriptionMode = (typeof BillingSubscriptionMode)[keyof typeof BillingSubscriptionMode];
 declare const BillingSubscriptionPaymentConditions: {
   readonly UPON_RECEIPT: "upon_receipt";
   readonly '7_DAYS': "7_days";
@@ -2637,11 +2637,11 @@ declare const BillingSubscriptionPaymentConditions: {
   readonly '45_DAYS_END_OF_MONTH': "45_days_end_of_month";
   readonly '60_DAYS': "60_days";
 };
-type BillingSubscriptionPaymentConditions = typeof BillingSubscriptionPaymentConditions[keyof typeof BillingSubscriptionPaymentConditions];
+type BillingSubscriptionPaymentConditions = (typeof BillingSubscriptionPaymentConditions)[keyof typeof BillingSubscriptionPaymentConditions];
 declare const Null: {
   readonly NULL: null;
 };
-type Null = typeof Null[keyof typeof Null];
+type Null = (typeof Null)[keyof typeof Null];
 /**
  * Payment method
  * offline means the subscription is not linked to a payment method
@@ -2658,13 +2658,13 @@ declare const BillingSubscriptionPaymentMethod: {
  * gocardless_direct-debit means at each new occurrence the client will be automatically debited thanks to GoCardless. To do so, you need a GoCardless account properly configured.
  *
  */
-type BillingSubscriptionPaymentMethod = typeof BillingSubscriptionPaymentMethod[keyof typeof BillingSubscriptionPaymentMethod];
+type BillingSubscriptionPaymentMethod = (typeof BillingSubscriptionPaymentMethod)[keyof typeof BillingSubscriptionPaymentMethod];
 declare const BillingSubscriptionOcurrenceRuleType: {
   readonly WEEKLY: "weekly";
   readonly MONTHLY: "monthly";
   readonly YEARLY: "yearly";
 };
-type BillingSubscriptionOcurrenceRuleType = typeof BillingSubscriptionOcurrenceRuleType[keyof typeof BillingSubscriptionOcurrenceRuleType];
+type BillingSubscriptionOcurrenceRuleType = (typeof BillingSubscriptionOcurrenceRuleType)[keyof typeof BillingSubscriptionOcurrenceRuleType];
 type BillingSubscriptionsResponse = {
   /**
    * Billing subscription identifier
@@ -2882,7 +2882,7 @@ declare const ExportStatus: {
 /**
  * The state of the export
  */
-type ExportStatus = typeof ExportStatus[keyof typeof ExportStatus];
+type ExportStatus = (typeof ExportStatus)[keyof typeof ExportStatus];
 /**
  * Note that the `custom` option is only used on Pennylane's web app to avoid pre-filling the deadline when creating an invoice. On the API it has no effect and you will still have to provide a deadline when creating an invoice.
  */
@@ -2900,7 +2900,7 @@ declare const PaymentConditions: {
 /**
  * Note that the `custom` option is only used on Pennylane's web app to avoid pre-filling the deadline when creating an invoice. On the API it has no effect and you will still have to provide a deadline when creating an invoice.
  */
-type PaymentConditions = typeof PaymentConditions[keyof typeof PaymentConditions];
+type PaymentConditions = (typeof PaymentConditions)[keyof typeof PaymentConditions];
 /**
  * The language in which the customer will receive invoices. Default is `fr_FR`
  */
@@ -2912,7 +2912,7 @@ declare const CustomerBillingLanguage: {
 /**
  * The language in which the customer will receive invoices. Default is `fr_FR`
  */
-type CustomerBillingLanguage = typeof CustomerBillingLanguage[keyof typeof CustomerBillingLanguage];
+type CustomerBillingLanguage = (typeof CustomerBillingLanguage)[keyof typeof CustomerBillingLanguage];
 type CompanyCustomersResponse = {
   id: number;
   name: string;
@@ -3164,12 +3164,12 @@ declare const SupplierPaymentMethod: {
   readonly CASH: "cash";
   readonly CARD: "card";
 };
-type SupplierPaymentMethod = typeof SupplierPaymentMethod[keyof typeof SupplierPaymentMethod];
+type SupplierPaymentMethod = (typeof SupplierPaymentMethod)[keyof typeof SupplierPaymentMethod];
 declare const SupplierDueDateRule: {
   readonly DAYS: "days";
   readonly DAYS_OR_END_OF_MONTH: "days_or_end_of_month";
 };
-type SupplierDueDateRule = typeof SupplierDueDateRule[keyof typeof SupplierDueDateRule];
+type SupplierDueDateRule = (typeof SupplierDueDateRule)[keyof typeof SupplierDueDateRule];
 type SuppliersResponse = {
   id: number;
   name: string;
@@ -3233,7 +3233,7 @@ declare const PaymentStatus: {
   readonly CHARGED_BACK: "charged_back";
   readonly RESUBMISSION_REQUESTED: "resubmission_requested";
 };
-type PaymentStatus = typeof PaymentStatus[keyof typeof PaymentStatus];
+type PaymentStatus = (typeof PaymentStatus)[keyof typeof PaymentStatus];
 type CustomerInvoicesMatchedTransactionsCategoriesResponse = {
   id: number;
   label: string;
@@ -3636,7 +3636,7 @@ declare const InvoiceAccountantsStatus: {
  * - `complete`: The invoice has been validated by the accountant.
  *
  */
-type InvoiceAccountantsStatus = typeof InvoiceAccountantsStatus[keyof typeof InvoiceAccountantsStatus];
+type InvoiceAccountantsStatus = (typeof InvoiceAccountantsStatus)[keyof typeof InvoiceAccountantsStatus];
 declare const InvoicePaymentStatus: {
   readonly TO_BE_PROCESSED: "to_be_processed";
   readonly TO_BE_PAID: "to_be_paid";
@@ -3649,7 +3649,7 @@ declare const InvoicePaymentStatus: {
   readonly PAID_OFFLINE: "paid_offline";
   readonly FULLY_PAID: "fully_paid";
 };
-type InvoicePaymentStatus = typeof InvoicePaymentStatus[keyof typeof InvoicePaymentStatus];
+type InvoicePaymentStatus = (typeof InvoicePaymentStatus)[keyof typeof InvoicePaymentStatus];
 type SupplierInvoicesResponse = {
   /**
    * The ID of the supplier invoice
@@ -3906,11 +3906,11 @@ declare const CategoryDirection: {
 /**
  * Only applicable for _treasury_ categories
  */
-type CategoryDirection = typeof CategoryDirection[keyof typeof CategoryDirection];
+type CategoryDirection = (typeof CategoryDirection)[keyof typeof CategoryDirection];
 declare const Null2: {
   readonly NULL: null;
 };
-type Null2 = typeof Null2[keyof typeof Null2];
+type Null2 = (typeof Null2)[keyof typeof Null2];
 type CategoriesResponse = {
   id: number;
   label: string;
@@ -3949,7 +3949,7 @@ declare const AccountType: {
   readonly OTHER: "other";
   readonly CHECKING: "checking";
 };
-type AccountType = typeof AccountType[keyof typeof AccountType];
+type AccountType = (typeof AccountType)[keyof typeof AccountType];
 type TransactionsCategoriesResponse = {
   id: number;
   label: string;
@@ -4074,7 +4074,7 @@ declare const QuoteStatus: {
  * - pending: quote to be denied or accepted
  *
  */
-type QuoteStatus = typeof QuoteStatus[keyof typeof QuoteStatus];
+type QuoteStatus = (typeof QuoteStatus)[keyof typeof QuoteStatus];
 type QuotesResponse = {
   /**
    * Quote identifier
@@ -4614,7 +4614,7 @@ declare const CommercialDocumentType: {
   readonly SHIPPING_ORDER: "shipping_order";
   readonly PURCHASING_ORDER: "purchasing_order";
 };
-type CommercialDocumentType = typeof CommercialDocumentType[keyof typeof CommercialDocumentType];
+type CommercialDocumentType = (typeof CommercialDocumentType)[keyof typeof CommercialDocumentType];
 type CommercialDocumentsResponse = {
   /**
    * Commercial document identifier
@@ -4769,7 +4769,7 @@ declare const SepaSequenceType: {
  * - `FNAL`: Final payment in a series of recurring payments
  *
  */
-type SepaSequenceType = typeof SepaSequenceType[keyof typeof SepaSequenceType];
+type SepaSequenceType = (typeof SepaSequenceType)[keyof typeof SepaSequenceType];
 type SepaMandatesResponse = {
   /**
    * ID of the created SEPA mandate
@@ -4833,7 +4833,7 @@ declare const MandateStatus: {
   readonly BLOCKED: "blocked";
   readonly BANK_DISCONNECTED: "bank_disconnected";
 };
-type MandateStatus = typeof MandateStatus[keyof typeof MandateStatus];
+type MandateStatus = (typeof MandateStatus)[keyof typeof MandateStatus];
 type GocardlessMandatesResponse = {
   id: number;
   /**
@@ -4877,14 +4877,14 @@ declare const PurchaseRequestLineUnit: {
   readonly MG: "mg";
   readonly NO_UNIT: "no_unit";
 };
-type PurchaseRequestLineUnit = typeof PurchaseRequestLineUnit[keyof typeof PurchaseRequestLineUnit];
+type PurchaseRequestLineUnit = (typeof PurchaseRequestLineUnit)[keyof typeof PurchaseRequestLineUnit];
 declare const PurchaseRequestStatuses: {
   readonly TO_BE_VALIDATED: "to_be_validated";
   readonly APPROVED: "approved";
   readonly REJECTED: "rejected";
   readonly INVOICED: "invoiced";
 };
-type PurchaseRequestStatuses = typeof PurchaseRequestStatuses[keyof typeof PurchaseRequestStatuses];
+type PurchaseRequestStatuses = (typeof PurchaseRequestStatuses)[keyof typeof PurchaseRequestStatuses];
 type PurchaseRequestsResponse = {
   /**
    * Purchase request identifier