@epilot/pricing-client 2.0.1 → 2.1.0

package/dist/openapi.d.ts

@@ -21,47 +21,47 @@ declare namespace Components {
             /**
              * The first line of the address. Typically the street address or PO Box number.
              */
-            street?: string;
+            street?: string | null;
             /**
              * The second line of the address. Typically the number of the apartment, suite, or unit.
              */
-            street_number?: string;
+            street_number?: string | null;
             /**
              * The postal code for the address.
              */
-            postal_code?: string;
+            postal_code?: string | null;
             /**
              * The name of the city, district, village, or town.
              */
-            city?: string;
+            city?: string | null;
             /**
              * The two-letter code for the country of the address.
              */
-            country?: string;
+            country?: string | null;
             /**
              * An additional description for the address
              */
-            additional_info?: string;
+            additional_info?: string | null;
             /**
              * the company name, usually used as extra delivery instructions
              */
-            company_name?: string;
+            company_name?: string | null;
             /**
              * the first name of the recipient, usually used as extra delivery instructions
              */
-            first_name?: string;
+            first_name?: string | null;
             /**
              * the last name of the recipient, usually used as extra delivery instructions
              */
-            last_name?: string;
+            last_name?: string | null;
             /**
              * the salutation of the recipient, usually used as extra delivery instructions
              */
-            salutation?: string;
+            salutation?: string | null;
             /**
              * the title of the recipient, usually used as extra delivery instructions
              */
-            title?: string;
+            title?: string | null;
         }
         /**
          * Availability check request payload
@@ -353,6 +353,251 @@ declare namespace Components {
          * The checkout mode for the cart checkout.
          */
         export type CheckoutMode = "create_order" | "create_invoice" | "create_quote";
+        /**
+         * The price entity schema for dynamic pricing
+         * example:
+         * {
+         *   "$ref": "#/components/examples/composite-price"
+         * }
+         */
+        export interface CompositePrice {
+            [name: string]: any;
+            /**
+             * Whether the price can be used for new purchases.
+             */
+            active?: boolean;
+            /**
+             * A brief description of the price.
+             */
+            description?: string;
+            /**
+             * A set of [price](/api/pricing#tag/simple_price_schema) components that define the composite price.
+             */
+            price_components?: {
+                $relation?: PriceComponentRelation[];
+            };
+            /**
+             * Three-letter ISO currency code, in lowercase.
+             */
+            unit_amount_currency?: /* Three-letter ISO currency code, in lowercase. */ /**
+             * Three-letter ISO currency code, in lowercase. Must be a supported currency.
+             * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
+             *
+             * example:
+             * EUR
+             */
+            Currency;
+            /**
+             * The price creation date
+             */
+            _created_at?: string;
+            /**
+             * The price id
+             */
+            _id?: string;
+            /**
+             * The price autogenerated title
+             */
+            _title?: string;
+            /**
+             * The price last update date
+             */
+            _updated_at?: string;
+            /**
+             * The organization id the price belongs to
+             */
+            _org_id?: string;
+            /**
+             * An arbitrary set of tags attached to the composite price
+             */
+            _tags?: string[];
+        }
+        /**
+         * Represents a composite price input to the pricing library.
+         * example:
+         * {
+         *   "$ref": "#/components/examples/price-item"
+         * }
+         */
+        export interface CompositePriceItem {
+            /**
+             * price item id
+             */
+            id?: string;
+            metadata?: /* A set of key-value pairs used to store meta data information about an entity. */ MetaData;
+            /**
+             * The unit amount value
+             */
+            unit_amount?: number;
+            /**
+             * Total before any (discounts or) taxes are applied.
+             */
+            amount_subtotal?: number;
+            /**
+             * Net unit amount without taxes or discounts.
+             */
+            unit_amount_net?: number;
+            /**
+             * Total after (discounts and) taxes.
+             */
+            amount_total?: number;
+            currency?: /**
+             * Three-letter ISO currency code, in lowercase. Must be a supported currency.
+             * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
+             *
+             * example:
+             * EUR
+             */
+            Currency;
+            /**
+             * An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name.
+             */
+            description?: string;
+            /**
+             * The quantity of products being purchased.
+             */
+            quantity?: number;
+            /**
+             * The id of the product.
+             */
+            product_id?: string;
+            /**
+             * The id of the price.
+             */
+            price_id?: string;
+            /**
+             * The flag for prices that contain price components.
+             */
+            is_composite_price?: boolean;
+            /**
+             * The price snapshot data.
+             */
+            _price?: /* The price snapshot data. */ /**
+             * The price entity schema for simple pricing
+             * example:
+             * {
+             *   "$ref": "#/components/examples/price"
+             * }
+             */
+            Price | /**
+             * The price entity schema for dynamic pricing
+             * example:
+             * {
+             *   "$ref": "#/components/examples/composite-price"
+             * }
+             */
+            CompositePrice;
+            /**
+             * The product snapshot data.
+             */
+            _product?: /* The product snapshot data. */ /**
+             * The product entity
+             * example:
+             * {
+             *   "$ref": "#/components/examples/product"
+             * }
+             */
+            Product;
+            /**
+             * The taxes applied to the price item.
+             */
+            taxes?: (/* A tax amount associated with a specific tax rate. */ TaxAmount)[];
+            /**
+             * The sum of amounts of the price items by recurrence.
+             */
+            recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmount)[];
+            /**
+             * Contains price item configurations, per price component, when the main price item is a [composite price](/api/pricing#tag/dynamic_price_schema).
+             */
+            item_components?: /**
+             * Represents a price item
+             * example:
+             * {
+             *   "$ref": "#/components/examples/price-item"
+             * }
+             */
+            PriceItem[];
+        }
+        /**
+         * Represents a composite price input to the pricing library.
+         */
+        export interface CompositePriceItemDto {
+            metadata?: /* A set of key-value pairs used to store meta data information about an entity. */ MetaData;
+            /**
+             * The quantity of products being purchased.
+             */
+            quantity?: number;
+            /**
+             * An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name.
+             */
+            description?: string;
+            /**
+             * The id of the product.
+             */
+            product_id?: string;
+            /**
+             * The id of the price.
+             */
+            price_id?: string;
+            /**
+             * The unit amount value
+             */
+            unit_amount?: number;
+            /**
+             * Three-letter ISO currency code, in lowercase.
+             */
+            unit_amount_currency?: /* Three-letter ISO currency code, in lowercase. */ /**
+             * Three-letter ISO currency code, in lowercase. Must be a supported currency.
+             * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
+             *
+             * example:
+             * EUR
+             */
+            Currency;
+            /**
+             * The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places.
+             */
+            unit_amount_decimal?: string;
+            /**
+             * The flag for prices that contain price components.
+             */
+            is_composite_price?: boolean;
+            /**
+             * The taxes applied to the price item.
+             */
+            taxes?: (/* A valid tax rate from a client. */ TaxAmountDto)[];
+            /**
+             * The taxes applied to the price item.
+             */
+            recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmountDto)[];
+            _price?: /**
+             * The price entity schema for simple pricing
+             * example:
+             * {
+             *   "$ref": "#/components/examples/price"
+             * }
+             */
+            Price | /**
+             * The price entity schema for dynamic pricing
+             * example:
+             * {
+             *   "$ref": "#/components/examples/composite-price"
+             * }
+             */
+            CompositePrice;
+            _product?: /**
+             * The product entity
+             * example:
+             * {
+             *   "$ref": "#/components/examples/product"
+             * }
+             */
+            Product;
+            /**
+             * Contains price item configurations, per price component, when the main price item is a [composite price](/api/pricing#tag/dynamic_price_schema).
+             */
+            item_components?: /* Represents a valid price item from a client. */ PriceItemDto[];
+        }
         /**
          * Three-letter ISO currency code, in lowercase. Must be a supported currency.
          * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
@@ -971,54 +1216,6 @@ declare namespace Components {
              */
             _tags?: string[];
         }
-        /**
-         * The price entity schema for dynamic pricing
-         * example:
-         * {
-         *   "$ref": "#/components/examples/price-bundle"
-         * }
-         */
-        export interface PriceBundle {
-            [name: string]: any;
-            /**
-             * Whether the price can be used for new purchases.
-             */
-            active?: boolean;
-            /**
-             * A brief description of the price.
-             */
-            description?: string;
-            /**
-             * A set of [price](/api/pricing#tag/simple_price_schema) components that define the price bundle.
-             */
-            price_components?: {
-                $relation?: PriceComponentRelation[];
-            };
-            /**
-             * The price creation date
-             */
-            _created_at?: string;
-            /**
-             * The price id
-             */
-            _id?: string;
-            /**
-             * The price autogenerated title
-             */
-            _title?: string;
-            /**
-             * The price last update date
-             */
-            _updated_at?: string;
-            /**
-             * The organization id the price belongs to
-             */
-            _org_id?: string;
-            /**
-             * An arbitrary set of tags attached to the price bundle
-             */
-            _tags?: string[];
-        }
         export interface PriceComponentRelation {
             /**
              * The id of the price component
@@ -1030,8 +1227,16 @@ declare namespace Components {
              *
              */
             quantity?: number;
+            item?: /**
+             * The price entity schema for simple pricing
+             * example:
+             * {
+             *   "$ref": "#/components/examples/price"
+             * }
+             */
+            Price;
             /**
-             * An arbitrary set of tags attached to the bundle - component relation
+             * An arbitrary set of tags attached to the composite price - component relation
              */
             _tags?: string[];
         }
@@ -1039,7 +1244,7 @@ declare namespace Components {
          * Represents a price item
          * example:
          * {
-         *   "$ref": "#/components/examples/order-with-simple-prices"
+         *   "$ref": "#/components/examples/price-item"
          * }
          */
         export interface PriceItem {
@@ -1048,10 +1253,6 @@ declare namespace Components {
              */
             id?: string;
             metadata?: /* A set of key-value pairs used to store meta data information about an entity. */ MetaData;
-            /**
-             * Contains price item configurations, per price component, when the main price item is a [price bundle](/api/pricing#tag/dynamic_price_schema).
-             */
-            item_components?: PriceItemComponent[];
             /**
              * The unit amount value
              */
@@ -1092,6 +1293,10 @@ declare namespace Components {
              * The id of the price.
              */
             price_id?: string;
+            /**
+             * The flag for prices that contain price components.
+             */
+            is_composite_price?: boolean;
             /**
              * The price snapshot data.
              */
@@ -1102,7 +1307,14 @@ declare namespace Components {
              *   "$ref": "#/components/examples/price"
              * }
              */
-            Price;
+            Price | /**
+             * The price entity schema for dynamic pricing
+             * example:
+             * {
+             *   "$ref": "#/components/examples/composite-price"
+             * }
+             */
+            CompositePrice;
             /**
              * The product snapshot data.
              */
@@ -1123,14 +1335,6 @@ declare namespace Components {
              */
             recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmount)[];
         }
-        export type PriceItemComponent = /**
-         * Represents a price item
-         * example:
-         * {
-         *   "$ref": "#/components/examples/order-with-simple-prices"
-         * }
-         */
-        PriceItem;
         /**
          * Represents a valid price item from a client.
          */
@@ -1152,6 +1356,29 @@ declare namespace Components {
              * The id of the price.
              */
             price_id?: string;
+            /**
+             * The unit amount value
+             */
+            unit_amount?: number;
+            /**
+             * Three-letter ISO currency code, in lowercase.
+             */
+            unit_amount_currency?: /* Three-letter ISO currency code, in lowercase. */ /**
+             * Three-letter ISO currency code, in lowercase. Must be a supported currency.
+             * ISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html
+             *
+             * example:
+             * EUR
+             */
+            Currency;
+            /**
+             * The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places.
+             */
+            unit_amount_decimal?: string;
+            /**
+             * The flag for prices that contain price components.
+             */
+            is_composite_price?: boolean;
             /**
              * The taxes applied to the price item.
              */
@@ -1167,7 +1394,14 @@ declare namespace Components {
              *   "$ref": "#/components/examples/price"
              * }
              */
-            Price;
+            Price | /**
+             * The price entity schema for dynamic pricing
+             * example:
+             * {
+             *   "$ref": "#/components/examples/composite-price"
+             * }
+             */
+            CompositePrice;
             /**
              * The product linked to the price item.
              */
@@ -1187,10 +1421,17 @@ declare namespace Components {
          * Represents a price item
          * example:
          * {
-         *   "$ref": "#/components/examples/order-with-simple-prices"
+         *   "$ref": "#/components/examples/price-item"
          * }
          */
-        PriceItem)[];
+        PriceItem | /**
+         * Represents a composite price input to the pricing library.
+         * example:
+         * {
+         *   "$ref": "#/components/examples/price-item"
+         * }
+         */
+        CompositePriceItem)[];
         /**
          * A valid set of product prices, quantities, (discounts) and taxes from a client.
          */
@@ -1203,7 +1444,7 @@ declare namespace Components {
              * Represents a price item
              * example:
              * {
-             *   "$ref": "#/components/examples/order-with-simple-prices"
+             *   "$ref": "#/components/examples/price-item"
              * }
              */
             PriceItem)[];
@@ -1272,7 +1513,7 @@ declare namespace Components {
                 $relation?: EntityRelation[];
             };
             /**
-             * A set of [prices](/api/pricing#tag/simple_price_schema) or [price bundles](/api/pricing#tag/dynamic_price_schema) for the current product.
+             * A set of [prices](/api/pricing#tag/simple_price_schema) or [composite prices](/api/pricing#tag/dynamic_price_schema) for the current product.
              */
             price_options?: {
                 $relation?: EntityRelation[];