@plentymarkets/shop-api 0.168.1 → 0.170.0

package/lib/getters/manufacturerGetters.d.ts

@@ -1,27 +1,147 @@
 import { Manufacturer, ProducingCountry } from '../types';
+/**
+ * Returns the logo URL of the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The logo URL string, or an empty string if not set.
+ */
 declare function getManufacturerLogo(manufacturer: Manufacturer): string;
+/**
+ * Returns the internal name of the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The name string, or an empty string if not set.
+ */
 declare function getManufacturerName(manufacturer: Manufacturer): string;
+/**
+ * Returns the external name of the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The external name string, or an empty string if not set.
+ */
 declare function getManufacturerExternalName(manufacturer: Manufacturer): string;
+/**
+ * Returns the alternative external name of the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The `nameExternal` string, or an empty string if not set.
+ */
 declare function getManufacturerNameExternal(manufacturer: Manufacturer): string;
+/**
+ * Returns the legal (registered) name of the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The legal name string, or an empty string if not set.
+ */
 declare function getManufacturerLegalName(manufacturer: Manufacturer): string;
+/**
+ * Returns the contact page URL of the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The contact URL string, or an empty string if not set.
+ */
 declare function getManufacturerContactUrl(manufacturer: Manufacturer): string;
+/**
+ * Returns the street address of the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The street name string, or an empty string if not set.
+ */
 declare function getManufacturerStreet(manufacturer: Manufacturer): string;
+/**
+ * Returns the house number of the manufacturer's address.
+ * @param manufacturer - The manufacturer object.
+ * @returns The house number string, or an empty string if not set.
+ */
 declare function getManufacturerHouseNo(manufacturer: Manufacturer): string;
+/**
+ * Returns the postal code of the manufacturer's address.
+ * @param manufacturer - The manufacturer object.
+ * @returns The postcode string, or an empty string if not set.
+ */
 declare function getManufacturerPostCode(manufacturer: Manufacturer): string;
+/**
+ * Returns the town/city of the manufacturer's address.
+ * @param manufacturer - The manufacturer object.
+ * @returns The town string, or an empty string if not set.
+ */
 declare function getManufacturerTown(manufacturer: Manufacturer): string;
+/**
+ * Returns the producing country of the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The {@link ProducingCountry} object, or an empty object cast to `ProducingCountry` if not set.
+ */
 declare function getManufacturerCountry(manufacturer: Manufacturer): ProducingCountry;
+/**
+ * Returns the email address of the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The email string, or an empty string if not set.
+ */
 declare function getManufacturerEmail(manufacturer: Manufacturer): string;
+/**
+ * Returns the phone number of the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The phone number string, or an empty string if not set.
+ */
 declare function getManufacturerPhoneNumber(manufacturer: Manufacturer): string;
+/**
+ * Returns the fax number of the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The fax number string, or an empty string if not set.
+ */
 declare function getManufacturerFaxNumber(manufacturer: Manufacturer): string;
+/**
+ * Returns the website URL of the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The URL string, or an empty string if not set.
+ */
 declare function getManufacturerUrl(manufacturer: Manufacturer): string;
+/**
+ * Returns the name of the responsible person (EU representative) for the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The responsible person's name string, or an empty string if not set.
+ */
 declare function getManufacturerResponsibleName(manufacturer: Manufacturer): string;
+/**
+ * Returns the street address of the responsible person for the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The street string, or an empty string if not set.
+ */
 declare function getManufacturerResponsibleStreet(manufacturer: Manufacturer): string;
+/**
+ * Returns the house number of the responsible person's address for the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The house number string, or an empty string if not set.
+ */
 declare function getManufacturerResponsibleHouseNo(manufacturer: Manufacturer): string;
+/**
+ * Returns the postal code of the responsible person's address for the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The postcode string, or an empty string if not set.
+ */
 declare function getManufacturerResponsiblePostCode(manufacturer: Manufacturer): string;
+/**
+ * Returns the town/city of the responsible person's address for the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The town string, or an empty string if not set.
+ */
 declare function getManufacturerResponsibleTown(manufacturer: Manufacturer): string;
+/**
+ * Returns the country of the responsible person for the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The {@link ProducingCountry} object, or an empty object cast to `ProducingCountry` if not set.
+ */
 declare function getManufacturerResponsibleCountry(manufacturer: Manufacturer): ProducingCountry;
+/**
+ * Returns the email address of the responsible person for the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The email string, or an empty string if not set.
+ */
 declare function getManufacturerResponsibleEmail(manufacturer: Manufacturer): string;
+/**
+ * Returns the phone number of the responsible person for the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The phone number string, or an empty string if not set.
+ */
 declare function getManufacturerResponsiblePhoneNo(manufacturer: Manufacturer): string;
+/**
+ * Returns the contact URL of the responsible person for the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The contact URL string, or an empty string if not set.
+ */
 declare function getManufacturerResponsibleContactUrl(manufacturer: Manufacturer): string;
 export declare const manufacturerGetters: {
     getManufacturerLogo: typeof getManufacturerLogo;

package/lib/getters/manufacturerGetters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"manufacturerGetters.d.ts","sourceRoot":"","sources":["../../src/getters/manufacturerGetters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE1D,iBAAS,mBAAmB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE/D;AAED,iBAAS,mBAAmB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE/D;AAED,iBAAS,2BAA2B,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEvE;AAED,iBAAS,2BAA2B,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEvE;AAED,iBAAS,wBAAwB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEpE;AAED,iBAAS,yBAAyB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAErE;AAED,iBAAS,qBAAqB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEjE;AAED,iBAAS,sBAAsB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAElE;AAED,iBAAS,uBAAuB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEnE;AAED,iBAAS,mBAAmB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE/D;AAED,iBAAS,sBAAsB,CAAC,YAAY,EAAE,YAAY,GAAG,gBAAgB,CAE5E;AAED,iBAAS,oBAAoB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEhE;AAED,iBAAS,0BAA0B,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEtE;AAED,iBAAS,wBAAwB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEpE;AAED,iBAAS,kBAAkB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE9D;AAED,iBAAS,8BAA8B,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE1E;AAED,iBAAS,gCAAgC,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE5E;AAED,iBAAS,iCAAiC,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE7E;AAED,iBAAS,kCAAkC,CACzC,YAAY,EAAE,YAAY,GACzB,MAAM,CAER;AAED,iBAAS,8BAA8B,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE1E;AAED,iBAAS,iCAAiC,CACxC,YAAY,EAAE,YAAY,GACzB,gBAAgB,CAElB;AAED,iBAAS,+BAA+B,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE3E;AAED,iBAAS,iCAAiC,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE7E;AAED,iBAAS,oCAAoC,CAC3C,YAAY,EAAE,YAAY,GACzB,MAAM,CAER;AAED,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;CAyB/B,CAAC"}
+{"version":3,"file":"manufacturerGetters.d.ts","sourceRoot":"","sources":["../../src/getters/manufacturerGetters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE1D;;;;GAIG;AACH,iBAAS,mBAAmB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE/D;AAED;;;;GAIG;AACH,iBAAS,mBAAmB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE/D;AAED;;;;GAIG;AACH,iBAAS,2BAA2B,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEvE;AAED;;;;GAIG;AACH,iBAAS,2BAA2B,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEvE;AAED;;;;GAIG;AACH,iBAAS,wBAAwB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEpE;AAED;;;;GAIG;AACH,iBAAS,yBAAyB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAErE;AAED;;;;GAIG;AACH,iBAAS,qBAAqB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEjE;AAED;;;;GAIG;AACH,iBAAS,sBAAsB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAElE;AAED;;;;GAIG;AACH,iBAAS,uBAAuB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEnE;AAED;;;;GAIG;AACH,iBAAS,mBAAmB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE/D;AAED;;;;GAIG;AACH,iBAAS,sBAAsB,CAAC,YAAY,EAAE,YAAY,GAAG,gBAAgB,CAE5E;AAED;;;;GAIG;AACH,iBAAS,oBAAoB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEhE;AAED;;;;GAIG;AACH,iBAAS,0BAA0B,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEtE;AAED;;;;GAIG;AACH,iBAAS,wBAAwB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEpE;AAED;;;;GAIG;AACH,iBAAS,kBAAkB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE9D;AAED;;;;GAIG;AACH,iBAAS,8BAA8B,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE1E;AAED;;;;GAIG;AACH,iBAAS,gCAAgC,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE5E;AAED;;;;GAIG;AACH,iBAAS,iCAAiC,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE7E;AAED;;;;GAIG;AACH,iBAAS,kCAAkC,CACzC,YAAY,EAAE,YAAY,GACzB,MAAM,CAER;AAED;;;;GAIG;AACH,iBAAS,8BAA8B,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE1E;AAED;;;;GAIG;AACH,iBAAS,iCAAiC,CACxC,YAAY,EAAE,YAAY,GACzB,gBAAgB,CAElB;AAED;;;;GAIG;AACH,iBAAS,+BAA+B,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE3E;AAED;;;;GAIG;AACH,iBAAS,iCAAiC,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE7E;AAED;;;;GAIG;AACH,iBAAS,oCAAoC,CAC3C,YAAY,EAAE,YAAY,GACzB,MAAM,CAER;AAED,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;CAyB/B,CAAC"}

package/lib/getters/offerGetters.d.ts

@@ -1,18 +1,96 @@
 import { Offer, OrderItem, Product, type Address } from '../types';
+/**
+ * Returns the mapped shipping address from the offer, or `null` if not set.
+ * @param offer - The offer object.
+ * @returns The shipping {@link Address}, or `null` if delivery address data is not available.
+ */
 declare function getShippingAddress(offer: Offer): Address | null;
+/**
+ * Returns the mapped billing address from the offer, or `null` if not set.
+ * @param offer - The offer object.
+ * @returns The billing {@link Address}, or `null` if billing address data is not available.
+ */
 declare function getBillingAddress(offer: Offer): Address | null;
+/**
+ * Returns the display name of the payment method used in the offer.
+ * @param offer - The offer object.
+ * @returns The payment method name string.
+ */
 declare function getPaymentMethodName(offer: Offer): string;
+/**
+ * Returns the icon path/URL for the payment method used in the offer.
+ * @param offer - The offer object.
+ * @returns The payment method icon path string.
+ */
 declare function getPaymentMethodIconPath(offer: Offer): string;
+/**
+ * Returns the combined shipping method name in `"<profileName> - <providerName>"` format.
+ * @param offer - The offer object.
+ * @returns The combined shipping method name, or an empty string if either part is missing.
+ */
 declare function getShippingMethodName(offer: Offer): string;
+/**
+ * Returns the gross shipping costs for the offer.
+ * @param offer - The offer object.
+ * @returns The shipping gross amount as a number.
+ */
 declare function getShippingMethodCosts(offer: Offer): number;
+/**
+ * Returns the number of order items in the offer, excluding one reserved/administrative item.
+ * @param offer - The offer object.
+ * @returns The item count (at least `0`).
+ */
 declare function getOfferItemsCount(offer: Offer): number;
+/**
+ * Returns the original gross unit price of an offer item.
+ * @param offerItem - The offer order item.
+ * @returns The gross price as a number.
+ */
 declare function getOfferItemOriginalPrice(offerItem: OrderItem): number;
+/**
+ * Returns the display name (`name1`) of the product variation in an offer item.
+ * @param variation - The product variation object.
+ * @returns The variation name string, or an empty string if not set.
+ */
 declare function getOfferItemVariationName(variation: Product): string;
+/**
+ * Returns whether the offer is of type "offer" (type ID `7`).
+ * @param offer - The offer object.
+ * @returns `true` if the order type ID is `7`, otherwise `false`.
+ */
 declare function isTypeOffer(offer: Offer): boolean;
+/**
+ * Returns the quantity of an offer item.
+ * @param item - The offer order item.
+ * @returns The item quantity.
+ */
 declare function getOfferItemQty(item: OrderItem): number;
+/**
+ * Returns the total quantity of items in the offer (excluding the last administrative item).
+ * Returns `0` if the offer has fewer than two items.
+ * @param items - The array of offer order items.
+ * @returns The summed quantity of all items except the last one.
+ */
 declare function getItemsCountInOffer(items: OrderItem[]): number;
+/**
+ * Returns the gross line total (unit price × quantity) for an offer item.
+ * @param item - The offer order item.
+ * @returns The line total as a number.
+ */
 declare function getOfferItemOriginalPriceWithQuantity(item: OrderItem): number;
+/**
+ * Returns the email address from the offer's billing address, validated before returning.
+ * @param offer - The offer object.
+ * @returns A valid email address string, or an empty string if the email is invalid or not set.
+ */
 declare function getOfferEmail(offer: Offer): string;
+/**
+ * Returns the "valid until" date of the offer formatted as a localised date string.
+ * Uses the date with type ID `20` from the order dates.
+ * @param offer - The offer object.
+ * @param locale - The BCP 47 locale string to use for date formatting (defaults to `"en"`).
+ * @returns The formatted date string, or `null` if the valid-until date is not set.
+ */
 declare function getValidUntil(offer: Offer, locale?: string): string | null;
 export declare const offerGetters: {
     getShippingAddress: typeof getShippingAddress;

package/lib/getters/offerGetters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"offerGetters.d.ts","sourceRoot":"","sources":["../../src/getters/offerGetters.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,UAAU,CAAC;AAGnE,iBAAS,kBAAkB,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,GAAG,IAAI,CAIxD;AAED,iBAAS,iBAAiB,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,GAAG,IAAI,CAIvD;AAED,iBAAS,oBAAoB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAElD;AAED,iBAAS,wBAAwB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAEtD;AAED,iBAAS,qBAAqB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAInD;AAED,iBAAS,sBAAsB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAEpD;AAED,iBAAS,kBAAkB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAIhD;AAED,iBAAS,yBAAyB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,CAE/D;AAED,iBAAS,yBAAyB,CAAC,SAAS,EAAE,OAAO,GAAG,MAAM,CAE7D;AAED,iBAAS,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAE1C;AAED,iBAAS,eAAe,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,CAEhD;AAED,iBAAS,oBAAoB,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,MAAM,CAMxD;AAED,iBAAS,qCAAqC,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,CAEtE;AAED,iBAAS,aAAa,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAI3C;AAED,iBAAS,aAAa,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,GAAE,MAAa,GAAG,MAAM,GAAG,IAAI,CAQzE;AAED,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;CAgBxB,CAAC"}
+{"version":3,"file":"offerGetters.d.ts","sourceRoot":"","sources":["../../src/getters/offerGetters.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,UAAU,CAAC;AAGnE;;;;GAIG;AACH,iBAAS,kBAAkB,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,GAAG,IAAI,CAIxD;AAED;;;;GAIG;AACH,iBAAS,iBAAiB,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,GAAG,IAAI,CAIvD;AAED;;;;GAIG;AACH,iBAAS,oBAAoB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAElD;AAED;;;;GAIG;AACH,iBAAS,wBAAwB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAEtD;AAED;;;;GAIG;AACH,iBAAS,qBAAqB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAInD;AAED;;;;GAIG;AACH,iBAAS,sBAAsB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAEpD;AAED;;;;GAIG;AACH,iBAAS,kBAAkB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAIhD;AAED;;;;GAIG;AACH,iBAAS,yBAAyB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,CAE/D;AAED;;;;GAIG;AACH,iBAAS,yBAAyB,CAAC,SAAS,EAAE,OAAO,GAAG,MAAM,CAE7D;AAED;;;;GAIG;AACH,iBAAS,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAE1C;AAED;;;;GAIG;AACH,iBAAS,eAAe,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,CAEhD;AAED;;;;;GAKG;AACH,iBAAS,oBAAoB,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,MAAM,CAMxD;AAED;;;;GAIG;AACH,iBAAS,qCAAqC,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,CAEtE;AAED;;;;GAIG;AACH,iBAAS,aAAa,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAI3C;AAED;;;;;;GAMG;AACH,iBAAS,aAAa,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,GAAE,MAAa,GAAG,MAAM,GAAG,IAAI,CAQzE;AAED,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;CAgBxB,CAAC"}

package/lib/getters/orderConfirmationGetters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"orderConfirmationGetters.d.ts","sourceRoot":"","sources":["../../src/getters/orderConfirmationGetters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAiBlC,eAAO,MAAM,wBAAwB;wCAXM,KAAK,KAAG,OAAO;yBAO9B,KAAK,KAAG,OAAO;CAO1C,CAAC"}
+{"version":3,"file":"orderConfirmationGetters.d.ts","sourceRoot":"","sources":["../../src/getters/orderConfirmationGetters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAqBlC,eAAO,MAAM,wBAAwB;wCAbM,KAAK,KAAG,OAAO;yBAS9B,KAAK,KAAG,OAAO;CAO1C,CAAC"}

package/lib/getters/orderDocumentGetters.d.ts

@@ -1,5 +1,15 @@
 import type { OrderDocument } from '../types';
+/**
+ * Returns the type of an order document (e.g. `"invoice"`, `"delivery_note"`).
+ * @param document - The order document object.
+ * @returns The document type string, or an empty string if not set.
+ */
 declare function getType(document: OrderDocument): string;
+/**
+ * Returns the document number with its type prefix (e.g. `"INV-12345"`).
+ * @param document - The order document object.
+ * @returns The number-with-prefix string, or an empty string if not set.
+ */
 declare function getNumberWithPrefix(document: OrderDocument): string;
 export declare const orderDocumentGetters: {
     getType: typeof getType;

package/lib/getters/orderDocumentGetters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"orderDocumentGetters.d.ts","sourceRoot":"","sources":["../../src/getters/orderDocumentGetters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAE9C,iBAAS,OAAO,CAAC,QAAQ,EAAE,aAAa,GAAG,MAAM,CAEhD;AAED,iBAAS,mBAAmB,CAAC,QAAQ,EAAE,aAAa,GAAG,MAAM,CAE5D;AAED,eAAO,MAAM,oBAAoB;;;CAGhC,CAAC"}
+{"version":3,"file":"orderDocumentGetters.d.ts","sourceRoot":"","sources":["../../src/getters/orderDocumentGetters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAE9C;;;;GAIG;AACH,iBAAS,OAAO,CAAC,QAAQ,EAAE,aAAa,GAAG,MAAM,CAEhD;AAED;;;;GAIG;AACH,iBAAS,mBAAmB,CAAC,QAAQ,EAAE,aAAa,GAAG,MAAM,CAE5D;AAED,eAAO,MAAM,oBAAoB;;;CAGhC,CAAC"}