@epilot/pricing-client 1.13.3 → 2.0.1

package/dist/openapi.d.ts

@@ -181,7 +181,7 @@ declare namespace Components {
             customer?: Customer;
             billing_address?: Address;
             delivery_address?: Address;
-            metadata?: /* A set of key-value pairs. */ MetaData;
+            metadata?: /* A set of key-value pairs used to store meta data information about an entity. */ MetaData;
             line_items?: /* Tracks a set of product prices, quantities, (discounts) and taxes. */ PriceItems;
             /**
              * Total of all items before (discounts or) taxes are applied.
@@ -199,7 +199,7 @@ declare namespace Components {
          * A valid cart payload from a client.
          */
         export interface CartDto {
-            metadata?: /* A set of key-value pairs. */ MetaData;
+            metadata?: /* A set of key-value pairs used to store meta data information about an entity. */ MetaData;
             customer?: Customer;
             billing_address?: Address;
             delivery_address?: Address;
@@ -215,7 +215,7 @@ declare namespace Components {
              * ce99875f-fba9-4fe2-a8f9-afaf52059051
              */
             source_id?: string;
-            source?: /* Order Source */ OrderSource;
+            source?: /* The order generation source */ OrderSource;
             additional_addresses?: Address[];
             payment_method?: /**
              * A PaymentMethod represent your customer's payment instruments.
@@ -227,7 +227,18 @@ declare namespace Components {
              * An array of file IDs, already upload into the File API, that are related with this cart
              */
             files?: string[];
-            status?: /* The order status */ OrderStatus;
+            status?: /**
+             *
+             * | status      | description |
+             * |-------------|-------|
+             * | `draft`     | ​​Starting state for all orders, at this point we can still edit the order |
+             * | `quote`     | The order is in a quoting phase, bound to an expiration date |
+             * | `placed`    | The order has been paid and can now be fulfilled (shipped, delivered, complete) or canceled |
+             * | `cancelled` | The order has been cancelled |
+             * | `completed` | The order is now closed and finalized |
+             *
+             */
+            OrderStatus;
             tags?: string[];
             journey_data?: {
                 [name: string]: any;
@@ -302,7 +313,21 @@ declare namespace Components {
              * The number os results returned.
              */
             hits?: number;
-            results?: (/* The product configuration */ Product | /* The price configuration */ Price)[];
+            results?: (/**
+             * The product entity
+             * example:
+             * {
+             *   "$ref": "#/components/examples/product"
+             * }
+             */
+            Product | /**
+             * The price entity schema for simple pricing
+             * example:
+             * {
+             *   "$ref": "#/components/examples/price"
+             * }
+             */
+            Price)[];
         }
         /**
          * The cart checkout request payload
@@ -315,7 +340,14 @@ declare namespace Components {
          * The cart checkout result
          */
         export interface CheckoutCartResult {
-            order?: /* The order entity */ Order;
+            order?: /**
+             * The order entity
+             * example:
+             * {
+             *   "$ref": "#/components/examples/order-with-simple-prices"
+             * }
+             */
+            Order;
         }
         /**
          * The checkout mode for the cart checkout.
@@ -371,7 +403,7 @@ declare namespace Components {
             $relation?: EntityRelation;
         }
         /**
-         * A set of key-value pairs.
+         * A set of key-value pairs used to store meta data information about an entity.
          */
         export type MetaData = ({
             /**
@@ -385,6 +417,10 @@ declare namespace Components {
         })[];
         /**
          * The opportunity entity
+         * example:
+         * {
+         *   "$ref": "#/components/examples/opportunity"
+         * }
          */
         export interface Opportunity {
             [name: string]: any;
@@ -392,41 +428,157 @@ declare namespace Components {
              * The opportunity id number for the customer (autogenerated if left blank)
              */
             opportunity_number?: string;
+            /**
+             * The opportunity title for the opportunity
+             */
+            opportunity_title?: string;
             /**
              * A description to frame this opportunity within its sales process
              */
             description?: string;
             /**
-             * The opportunity status
+             * The opportunity status (defined by the opportunity workflow)
+             */
+            status?: string;
+            /**
+             * The expiration date
+             */
+            due_date?: string;
+            /**
+             * The opportunity assignees
+             */
+            assignee?: {
+                id?: string;
+                email?: string;
+                display_name?: string;
+                token?: string;
+                image_uri?: string;
+                organization_id?: string;
+                department?: string;
+                preferred_language?: string;
+                status?: string;
+                phone?: string;
+                email_notification_settings?: {
+                    [key: string]: any;
+                };
+                is_signature_enabled?: boolean;
+                created_at?: string;
+            }[];
+            /**
+             * A list of customers related with the opportunity
+             */
+            customer?: {
+                $relation?: EntityRelation[];
+            };
+            /**
+             * A set of dates associated with the opportunity
+             */
+            dates?: ({
+                /**
+                 * The date tags
+                 */
+                _tags?: string[];
+                /**
+                 * The date value
+                 */
+                value?: string;
+            })[];
+            /**
+             * The billing address
+             */
+            billing_address?: {
+                /**
+                 * The relation from which a field is being referenced
+                 */
+                $relation_ref?: ({
+                    /**
+                     * The id of the referenced entity
+                     */
+                    entity_id?: string;
+                    /**
+                     * The path to the target attribute being referenced
+                     */
+                    path?: string;
+                })[];
+            };
+            /**
+             * The delivery address
+             */
+            delivery_address?: {
+                /**
+                 * The relation from which a field is being referenced
+                 */
+                $relation_ref?: ({
+                    /**
+                     * The id of the referenced entity
+                     */
+                    entity_id?: string;
+                    /**
+                     * The path to the target attribute being referenced
+                     */
+                    path?: string;
+                })[];
+            };
+            /**
+             * A list of additional addresses
+             */
+            address?: {
+                /**
+                 * The relation from which a field is being referenced
+                 */
+                $relation_ref?: ({
+                    /**
+                     * The id of the referenced entity
+                     */
+                    entity_id?: string;
+                    /**
+                     * The path to the target attribute being referenced
+                     */
+                    path?: string;
+                })[];
+            };
+            /**
+             * The order relations items, representing quotes or orders associated with the opportunity
              */
-            status?: "lead" | "qualification" | "validation" | "offering" | "supply" | "approval" | "operations" | "complete";
-            items?: /* The order entity */ Order[] | {
+            items?: {
                 $relation?: /* An order relation reference */ OrderRelation[];
             };
             /**
              * Organization Id the order belongs to
              */
             _org_id?: string;
+            /**
+             * The opportunity id
+             */
             _id?: string;
+            /**
+             * The opportunity creation date
+             */
             _created_at?: string;
+            /**
+             * The opportunity last update date
+             */
             _updated_at?: string;
             /**
-             * type of source, e.g. journey or manual
+             * Type of source, e.g. journey or manual
              * example:
              * journey
              */
             source_type?: string;
             /**
-             * identifier for source e.g. journey ID
+             * Identifier for source e.g. journey ID
              * example:
              * ce99875f-fba9-4fe2-a8f9-afaf52059051
              */
             source_id?: string;
-            source?: /* Order Source */ OpportunitySource;
+            source?: /* The opportunity generation source */ OpportunitySource;
+            /**
+             * An arbitrary set of tags attached to the opportunity
+             */
             _tags?: string[];
         }
         /**
-         * Order Source
+         * The opportunity generation source
          */
         export interface OpportunitySource {
             /**
@@ -444,40 +596,85 @@ declare namespace Components {
         }
         /**
          * The order entity
+         * example:
+         * {
+         *   "$ref": "#/components/examples/order-with-simple-prices"
+         * }
          */
         export interface Order {
             [name: string]: any;
             /**
-             * The order id number for the customer
+             * The order number (customer facing)
              */
             order_number?: string;
             /**
-             * The cart id that originated or is associated with the order
+             * The cart id that originated or is associated with the this order
              */
             cart_id?: string;
-            status?: /* The order status */ OrderStatus;
+            status?: /**
+             *
+             * | status      | description |
+             * |-------------|-------|
+             * | `draft`     | ​​Starting state for all orders, at this point we can still edit the order |
+             * | `quote`     | The order is in a quoting phase, bound to an expiration date |
+             * | `placed`    | The order has been paid and can now be fulfilled (shipped, delivered, complete) or canceled |
+             * | `cancelled` | The order has been cancelled |
+             * | `completed` | The order is now closed and finalized |
+             *
+             */
+            OrderStatus;
             /**
-             * type of source, e.g. journey or manual
+             * Type of source, e.g. journey or manual
              * example:
              * journey
              */
             source_type?: string;
             /**
-             * identifier for source e.g. journey ID
+             * Identifier for source e.g. journey ID
              * example:
              * ce99875f-fba9-4fe2-a8f9-afaf52059051
              */
             source_id?: string;
-            source?: /* Order Source */ OrderSource;
-            metadata?: /* A set of key-value pairs. */ MetaData;
+            source?: /* The order generation source */ OrderSource;
+            metadata?: /* A set of key-value pairs used to store meta data information about an entity. */ MetaData;
+            /**
+             * A list of customers related with the opportunity
+             */
+            customer?: {
+                $relation?: EntityRelation[];
+            };
+            /**
+             * The billing contact first name
+             */
             billing_first_name?: string;
+            /**
+             * The billing contact last name
+             */
             billing_last_name?: string;
+            /**
+             * The billing account name
+             */
             billing_company_name?: string;
+            /**
+             * The billing account VAT
+             */
             billing_vat?: string;
+            /**
+             * The billing email
+             */
             billing_email?: string;
+            /**
+             * The billing phone
+             */
             billing_phone?: string;
+            /**
+             * The billing address
+             */
             billing_address?: Address[];
-            currency?: /**
+            /**
+             * The order main currency
+             */
+            currency?: /* The order main 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
              *
@@ -485,16 +682,18 @@ declare namespace Components {
              * EUR
              */
             Currency;
+            /**
+             * The delivery address
+             */
             delivery_address?: Address[];
+            /**
+             * The payment method details for the order
+             */
             payment_method?: /**
              * A PaymentMethod represent your customer's payment instruments.
              *
              */
             PaymentMethod[];
-            /**
-             * The id of an existing contact.
-             */
-            contact?: string;
             line_items?: /* Tracks a set of product prices, quantities, (discounts) and taxes. */ PriceItems;
             /**
              * Total of all items before (discounts or) taxes are applied.
@@ -509,16 +708,39 @@ declare namespace Components {
              * Organization Id the order belongs to
              */
             _org_id?: string;
+            /**
+             * The order id
+             */
             _id?: string;
+            /**
+             * The order creation date
+             */
             _created_at?: string;
+            /**
+             * The order last update date
+             */
             _updated_at?: string;
+            /**
+             * An arbitrary set of tags attached to the order
+             */
             _tags?: string[];
         }
         /**
          * Order Entity Payload
          */
         export interface OrderPayload {
-            status?: /* The order status */ OrderStatus;
+            status?: /**
+             *
+             * | status      | description |
+             * |-------------|-------|
+             * | `draft`     | ​​Starting state for all orders, at this point we can still edit the order |
+             * | `quote`     | The order is in a quoting phase, bound to an expiration date |
+             * | `placed`    | The order has been paid and can now be fulfilled (shipped, delivered, complete) or canceled |
+             * | `cancelled` | The order has been cancelled |
+             * | `completed` | The order is now closed and finalized |
+             *
+             */
+            OrderStatus;
             line_items?: /* Tracks a set of product prices, quantities, (discounts) and taxes. */ PriceItems;
             /**
              * type of source, e.g. journey or manual
@@ -564,7 +786,7 @@ declare namespace Components {
             _tags?: string[];
         }
         /**
-         * Order Source
+         * The order generation source
          */
         export interface OrderSource {
             /**
@@ -581,7 +803,15 @@ declare namespace Components {
             title?: string;
         }
         /**
-         * The order status
+         *
+         * | status      | description |
+         * |-------------|-------|
+         * | `draft`     | ​​Starting state for all orders, at this point we can still edit the order |
+         * | `quote`     | The order is in a quoting phase, bound to an expiration date |
+         * | `placed`    | The order has been paid and can now be fulfilled (shipped, delivered, complete) or canceled |
+         * | `cancelled` | The order has been cancelled |
+         * | `completed` | The order is now closed and finalized |
+         *
          */
         export type OrderStatus = "draft" | "quote" | "placed" | "cancelled" | "completed";
         /**
@@ -601,21 +831,78 @@ declare namespace Components {
             };
         }
         /**
-         * The price configuration
+         * The price entity schema for simple pricing
+         * example:
+         * {
+         *   "$ref": "#/components/examples/price"
+         * }
          */
         export interface Price {
             [name: string]: any;
+            /**
+             * Whether the price can be used for new purchases.
+             */
             active?: boolean;
-            billing_scheme?: "Per Unit";
+            /**
+             * Describes how to compute the price per period. Either `per_unit` or `tiered`.
+             * - `per_unit` indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity
+             * - `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers and tiers_mode attributes.
+             *
+             * ⚠️ Tiered pricing is **not supported** yet.
+             *
+             */
+            billing_scheme?: "per_unit";
+            /**
+             * A brief description of the price.
+             */
             description?: string;
-            sales_tax?: SalesTax;
+            /**
+             * The default tax rate applicable to the product.
+             * This field is deprecated, use the new `tax` attribute.
+             *
+             */
+            sales_tax?: /**
+             * The default tax rate applicable to the product.
+             * This field is deprecated, use the new `tax` attribute.
+             *
+             */
+            SalesTax;
+            /**
+             * The default tax rate applied to the price
+             */
+            tax?: {
+                $relation?: EntityRelation[];
+            };
+            /**
+             * Specifies whether the price is considered `inclusive` of taxes or `exclusive` of taxes.
+             * One of `inclusive`, `exclusive`, or `unspecified`.
+             *
+             */
             tax_behavior?: "inclusive" | "exclusive";
-            tiers_mode?: "Standard";
+            /**
+             * Defines the tiered pricing type of the price.
+             */
+            tiers_mode?: "standard";
+            /**
+             * One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
+             */
             type?: "one_time" | "recurring";
-            billing_period?: BillingPeriod;
+            /**
+             * For recurring prices `billing_period` defines the default extent of the recurrence.
+             */
+            billing_period?: /* For recurring prices `billing_period` defines the default extent of the recurrence. */ BillingPeriod;
+            /**
+             * The unit amount in cents to be charged, represented as a whole integer if possible.
+             */
             unit_amount?: number;
+            /**
+             * The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places.
+             */
             unit_amount_decimal?: string;
-            unit_amount_currency?: /**
+            /**
+             * 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
              *
@@ -623,28 +910,148 @@ declare namespace Components {
              * EUR
              */
             Currency;
+            /**
+             * Defines the way the price amount is display in epilot journeys.
+             */
+            price_display_in_journeys?: "show_price" | "show_as_starting_price" | "show_as_on_request";
+            /**
+             * The billing period duration
+             */
             billing_duration_amount?: number;
+            /**
+             * The billing period duration unit
+             */
             billing_duration_unit?: "weeks" | "months" | "years";
+            /**
+             * The notice period duration
+             */
             notice_time_amount?: number;
+            /**
+             * The notice period duration unit
+             */
             notice_time_unit?: "weeks" | "months" | "years";
+            /**
+             * The termination period duration
+             */
             termination_time_amount?: number;
+            /**
+             * The termination period duration unit
+             */
             termination_time_unit?: "weeks" | "months" | "years";
+            /**
+             * The renewal period duration
+             */
             renewal_duration_amount?: number;
+            /**
+             * The renewal period duration unit
+             */
             renewal_duration_unit?: "weeks" | "months" | "years";
+            /**
+             * 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
+             */
+            _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
+             */
+            entity_id?: string;
+            /**
+             * By default, the quantity is set to 1, when greater than 1 this value is used as a multiplicative factor.
+             * E.g: 16 x Solar Modules - Premium price.
+             *
+             */
+            quantity?: number;
+            /**
+             * An arbitrary set of tags attached to the bundle - component relation
+             */
+            _tags?: string[];
         }
         /**
          * Represents a price item
+         * example:
+         * {
+         *   "$ref": "#/components/examples/order-with-simple-prices"
+         * }
          */
         export interface PriceItem {
             /**
              * price item id
              */
             id?: string;
-            metadata?: /* A set of key-value pairs. */ MetaData;
+            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
              */
@@ -654,7 +1061,7 @@ declare namespace Components {
              */
             amount_subtotal?: number;
             /**
-             * Net unit amount without taxes.
+             * Net unit amount without taxes or discounts.
              */
             unit_amount_net?: number;
             /**
@@ -685,8 +1092,28 @@ declare namespace Components {
              * The id of the price.
              */
             price_id?: string;
-            _price?: /* The price configuration */ Price;
-            _product?: /* The product configuration */ Product;
+            /**
+             * The price snapshot data.
+             */
+            _price?: /* The price snapshot data. */ /**
+             * The price entity schema for simple pricing
+             * example:
+             * {
+             *   "$ref": "#/components/examples/price"
+             * }
+             */
+            Price;
+            /**
+             * 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.
              */
@@ -696,11 +1123,19 @@ 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.
          */
         export interface PriceItemDto {
-            metadata?: /* A set of key-value pairs. */ MetaData;
+            metadata?: /* A set of key-value pairs used to store meta data information about an entity. */ MetaData;
             /**
              * The quantity of products being purchased.
              */
@@ -725,16 +1160,37 @@ declare namespace Components {
              * The taxes applied to the price item.
              */
             recurrences?: (/* An amount associated with a specific recurrence. */ RecurrenceAmountDto)[];
-            _price?: /* The price configuration */ Price;
+            _price?: /**
+             * The price entity schema for simple pricing
+             * example:
+             * {
+             *   "$ref": "#/components/examples/price"
+             * }
+             */
+            Price;
             /**
              * The product linked to the price item.
              */
-            _product?: /* The product configuration */ Product;
+            _product?: /**
+             * The product entity
+             * example:
+             * {
+             *   "$ref": "#/components/examples/product"
+             * }
+             */
+            Product;
         }
         /**
          * Tracks a set of product prices, quantities, (discounts) and taxes.
          */
-        export type PriceItems = (/* Represents a price item */ PriceItem)[];
+        export type PriceItems = (/**
+         * Represents a price item
+         * example:
+         * {
+         *   "$ref": "#/components/examples/order-with-simple-prices"
+         * }
+         */
+        PriceItem)[];
         /**
          * A valid set of product prices, quantities, (discounts) and taxes from a client.
          */
@@ -743,7 +1199,14 @@ declare namespace Components {
          * The result from the calculation of a set of price items.
          */
         export interface PricingDetails {
-            items?: (/* Represents a price item */ PriceItem)[];
+            items?: (/**
+             * Represents a price item
+             * example:
+             * {
+             *   "$ref": "#/components/examples/order-with-simple-prices"
+             * }
+             */
+            PriceItem)[];
             /**
              * Total of all items before (discounts or) taxes are applied.
              */
@@ -755,16 +1218,91 @@ declare namespace Components {
             total_details?: /* The total details with tax (and discount) aggregated totals. */ TotalDetails;
         }
         /**
-         * The product configuration
+         * The product entity
+         * example:
+         * {
+         *   "$ref": "#/components/examples/product"
+         * }
          */
         export interface Product {
             [name: string]: any;
+            /**
+             * The product code
+             */
             code?: string;
-            type?: "Product" | "Service";
+            /**
+             * The type of Product:
+             *
+             * | type | description |
+             * |----| ----|
+             * | `product` | Represents a physical good |
+             * | `service` | Represents a service or virtual product |
+             *
+             */
+            type?: "product" | "service";
+            /**
+             * The product main name
+             */
             name?: string;
+            feature?: {
+                /**
+                 * An arbitrary set of tags attached to a feature
+                 */
+                _tags?: string[];
+                feature?: string;
+            }[];
+            /**
+             * Stores references to products that can be cross sold with the current product.
+             */
+            cross_sellable_products?: {
+                $relation?: EntityRelation[];
+            };
+            /**
+             * Stores references to a set of file images of the product
+             */
+            product_images?: {
+                $relation?: EntityRelation[];
+            };
+            /**
+             * Stores references to a set of files downloadable from the product.
+             * e.g: tech specifications, quality control sheets, privacy policy agreements
+             *
+             */
+            product_downloads?: {
+                $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.
+             */
+            price_options?: {
+                $relation?: EntityRelation[];
+            };
+            /**
+             * Stores references to the availability files that define where this product is available.
+             * These files are used when interacting with products via epilot Journeys, thought the AvailabilityCheck block.
+             *
+             */
+            _availability_files?: File[];
+            /**
+             * The product id
+             */
             _id?: string;
+            /**
+             * The autogenerated product title
+             */
             _title?: string;
-            _availability_files?: File[];
+            /**
+             * The organization id the product belongs to
+             */
+            _org_id?: string;
+            /**
+             * The product creation date
+             */
+            _created_at?: string;
+            /**
+             * The product last update date
+             */
+            _updated_at?: string;
         }
         /**
          * An amount associated with a specific recurrence.
@@ -939,9 +1477,23 @@ declare namespace Paths {
         namespace Parameters {
             export type XIvyOrgID = string;
         }
-        export type RequestBody = /* The opportunity entity */ Components.Schemas.Opportunity;
+        export type RequestBody = /**
+         * The opportunity entity
+         * example:
+         * {
+         *   "$ref": "#/components/examples/opportunity"
+         * }
+         */
+        Components.Schemas.Opportunity;
         namespace Responses {
-            export type $201 = /* The opportunity entity */ Components.Schemas.Opportunity;
+            export type $201 = /**
+             * The opportunity entity
+             * example:
+             * {
+             *   "$ref": "#/components/examples/opportunity"
+             * }
+             */
+            Components.Schemas.Opportunity;
             export type $400 = Components.Schemas.Error;
         }
     }
@@ -999,7 +1551,14 @@ declare namespace Paths {
     namespace CreateOrder {
         export type RequestBody = /* Order Entity Payload */ Components.Schemas.OrderPayload;
         namespace Responses {
-            export type $201 = /* The order entity */ Components.Schemas.Order;
+            export type $201 = /**
+             * The order entity
+             * example:
+             * {
+             *   "$ref": "#/components/examples/order-with-simple-prices"
+             * }
+             */
+            Components.Schemas.Order;
             export type $400 = Components.Schemas.Error;
         }
     }
@@ -1012,7 +1571,14 @@ declare namespace Paths {
         }
         export type RequestBody = /* Order Entity Payload */ Components.Schemas.OrderPayload;
         namespace Responses {
-            export type $200 = /* The order entity */ Components.Schemas.Order;
+            export type $200 = /**
+             * The order entity
+             * example:
+             * {
+             *   "$ref": "#/components/examples/order-with-simple-prices"
+             * }
+             */
+            Components.Schemas.Order;
             export type $400 = Components.Schemas.Error;
         }
     }
@@ -1083,7 +1649,9 @@ export interface OperationMethods {
   /**
    * $createOpportunity - createOpportunity
    * 
-   * This API is Deprecated. Please use the Entity API or Submission API to create opportunities. Creates a new opportunity. During the creation of an opportunity, an unique customer-readable `opportunity_number` will be generated.
+   * This API is Deprecated. Please use the Entity API or Submission API to create opportunities.
+   * 
+   * Enables the creation of a new opportunity. During the creation of an opportunity, an unique customer-readable `opportunity_number` will be generated.
    * The `opportunity_number` can be used to universally identify an opportunity within epilot platform.
    * 
    */
@@ -1170,7 +1738,9 @@ export interface PathsDictionary {
     /**
      * $createOpportunity - createOpportunity
      * 
-     * This API is Deprecated. Please use the Entity API or Submission API to create opportunities. Creates a new opportunity. During the creation of an opportunity, an unique customer-readable `opportunity_number` will be generated.
+     * This API is Deprecated. Please use the Entity API or Submission API to create opportunities.
+     * 
+     * Enables the creation of a new opportunity. During the creation of an opportunity, an unique customer-readable `opportunity_number` will be generated.
      * The `opportunity_number` can be used to universally identify an opportunity within epilot platform.
      * 
      */