@epilot/pricing-client 1.7.0 → 1.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/definition.js +1 -1
- package/dist/openapi.d.ts +203 -2
- package/package.json +2 -2
- package/src/openapi.d.ts +203 -2
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
!function(e,t){for(var r in t)e[r]=t[r];t.__esModule&&Object.defineProperty(e,"__esModule",{value:!0})}(exports,(()=>{"use strict";var e={914:function(e,t,r){var i=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});const a=i(r(279));t.default=a.default},279:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"Pricing API","description":"This API hub sets the foundations for the following Pricing APIs:\\n\\n- Shopping Cart API, used to interact with a cart during a customer\'s checkout session, and it\'s responsible for providing the following set of features:\\n - A unified data model to model a Shopping Cart\\n - Cart abandonment recovery\\n - Pricing features such as automatic calculation of totals and price breakdowns for taxes\\n - Product and pricing data validation\\n - Checkout a cart into an order, invoice, or quote\\n\\n- Product Catalog API, provides a way to query the entire catalog of products and prices.\\n - Exposes querying operations to access the customer Product Catalog\\n\\n- Opportunity API, provides a way for journey users to initiate a sales process with an opportunity, responsible for holding something as simple as a lead (no quote) or a quote.\\n","contact":{"name":"Maintainers Channel","url":"https://epilot.slack.com/archives/C020B4URQNS"},"version":"1.0.0"},"externalDocs":{"description":"Read the full docs here","url":"https://e-pilot.atlassian.net/wiki/spaces/EO/pages/5459705918/Shopping+Cart+Orders+API"},"tags":[{"name":"Public","description":"Customer-facing Endpoints (requiring a X-Ivy-Org-ID identification)"},{"name":"Cart","description":"The shopping cart & checkout management operations"},{"name":"Opportunity","description":"Opportunity management operations"},{"name":"Product Catalog","description":"Product querying operations"}],"security":[{"EpilotAuth":[]},{"AsOrganization":[]}],"paths":{"/v1/public/cart:checkout":{"post":{"description":"Checkouts a cart and executes the specified checkout `mode` process.\\n\\nA Checkout implicitly finalizes the provided cart (if not transient from a fast-checkout) and behaves in one of the following modes:\\n- `create_order` (**default**): the payment happens at a later date or managed by 3rd-party CRM (SAP)\\n- `create_invoice`: the payment happens on the online checkout (paypal, stripe, adyen)\\n- `create_quote`: the checkout represents a price quote request\\n\\nFast checkout is also supported, by passing the Cart contents directly.\\nWhen a fast checkout is performed the cart is considered transient and there is no cart persistance.\\n\\nIf the checkout `mode` is omitted, the `mode` will default to `create_order`.\\n","operationId":"$checkoutCart","summary":"checkoutCart","security":[],"tags":["Cart","Public"],"parameters":[{"in":"header","name":"X-Ivy-Org-ID","description":"The target Organization Id represented by the caller","schema":{"type":"string"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutCart"},"examples":{"Checkout with a CartID":{"$ref":"#/components/examples/checkoutWithCartId"},"Fast Checkout with a transient Cart":{"$ref":"#/components/examples/checkoutWithTransientCart"}}}}},"responses":{"200":{"description":"The checkout result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutCartResult"},"examples":{"Checkout with created order":{"$ref":"#/components/examples/checkoutResult"}}}}},"400":{"description":"Invalid payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/public/catalog":{"post":{"description":"Provides a querying functionalities over products and prices of the Catalog for a given organization.","operationId":"$searchCatalog","summary":"searchCatalog","security":[],"tags":["Product Catalog","Public"],"parameters":[{"in":"header","name":"X-Ivy-Org-ID","description":"The target Organization Id represented by the caller","schema":{"type":"string"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogSearch"}}}},"responses":{"200":{"description":"The search result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogSearchResult"}}}},"400":{"description":"Invalid payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/public/opportunity":{"post":{"description":"Creates a new opportunity. During the creation of an opportunity, an unique customer-readable `opportunity_number` will be generated.\\nThe `opportunity_number` can be used to universally identify an opportunity within epilot platform.\\n","operationId":"$createOpportunity","summary":"createOpportunity","security":[],"tags":["Opportunity","Public"],"parameters":[{"in":"header","name":"X-Ivy-Org-ID","description":"The target Organization Id represented by the caller","schema":{"type":"string"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Opportunity"},"examples":{"Opportunity containing one Order":{"value":{"billing_address":{"street":"sdf","street_number":"1","city":"Berlin","postal_code":"12045","country":"de","additional_info":"adasd"},"delivery_address":{"street":"sdf","street_number":"1","city":"Berlin","postal_code":"12045","country":"de","additional_info":"adasd"},"items":{"$relation":[{"entity_id":"c8dbe8f3-28b6-4d77-aae8-47bc24a2532f","_tags":["journey"]}]},"_tags":["journey","ORWNr4iCN"]}}}}}},"responses":{"201":{"description":"The new Opportunity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Opportunity"}}}},"400":{"description":"Invalid payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"securitySchemes":{"EpilotAuth":{"type":"http","scheme":"bearer","description":"Epilot Bearer Token"},"AsOrganization":{"type":"apiKey","in":"header","name":"x-ivy-org-id","description":"Set organization id when using internal auth"},"AsUser":{"type":"apiKey","in":"header","name":"x-ivy-user-id","description":"Set user id when using internal auth"}},"schemas":{"Error":{"required":["message"],"properties":{"message":{"type":"string","description":"Error message"}}},"MetaData":{"description":"A set of key-value pairs.","type":"array","items":{"oneOf":[{"type":"object","description":"Key value pair entry","properties":{"key":{"type":"string","description":"Item key"},"value":{"type":"string","description":"Item value"}}}]}},"CatalogSearch":{"description":"A catalog search payload","type":"object","properties":{"q":{"description":"The query to perform using lucene query syntax.","type":"string"},"sort":{"description":"The sort expression to sort the results.","type":"string"},"from":{"description":"The index from which to query, used for pagination purposes. Defaults to 0","type":"number"},"size":{"description":"The max size of the response, defaults to 2000.","type":"number"},"hydrate":{"type":"boolean","description":"When true, enables entity hydration to resolve nested $relation references in-place.","default":false}},"example":{"q":"_id:1233432 OR _id:123432454 OR _id:23445433","sort":"description ASC","from":0,"size":200},"required":["q"]},"CatalogSearchResult":{"description":"The query result payload","type":"object","properties":{"hits":{"type":"number","description":"The number os results returned."},"results":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/Product"},{"$ref":"#/components/schemas/Price"}]}}},"example":{"hits":2,"results":[{"schema":"product","description":"product a"},{"schema":"price","unit_amount_decimal":"124.342343434"}]}},"CartDto":{"description":"A valid cart payload from a client.","properties":{"metadata":{"$ref":"#/components/schemas/MetaData"},"customer":{"$ref":"#/components/schemas/Customer"},"billing_address":{"$ref":"#/components/schemas/Address"},"delivery_address":{"$ref":"#/components/schemas/Address"},"payment_method":{"$ref":"#/components/schemas/PaymentMethod"},"line_items":{"$ref":"#/components/schemas/PriceItemsDto"},"files":{"type":"array","description":"An array of file IDs, already upload into the File API, that are related with this cart","items":{"type":"string","description":"a string representing a file ID as received from the File API"}},"status":{"$ref":"#/components/schemas/OrderStatus"},"tags":{"type":"array","items":{"type":"string"}}},"required":["line_items"]},"CheckoutCart":{"type":"object","description":"The cart checkout request payload","properties":{"cart":{"anyOf":[{"description":"the cart id","type":"string"},{"$ref":"#/components/schemas/CartDto"}]},"mode":{"$ref":"#/components/schemas/CheckoutMode"}}},"CheckoutCartResult":{"type":"object","description":"The cart checkout result","properties":{"order":{"$ref":"#/components/schemas/Order"}}},"CheckoutMode":{"type":"string","description":"The checkout mode for the cart checkout.","enum":["create_order","create_invoice","create_quote"]},"OrderStatus":{"type":"string","enum":["draft","quote","placed","cancelled","completed"],"description":"The order status"},"PriceItemsDto":{"description":"A valid set of product prices, quantities, (discounts) and taxes from a client.","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/PriceItemDto"}]}},"PriceItemDto":{"description":"Represents a valid price item from a client.","type":"object","properties":{"metadata":{"$ref":"#/components/schemas/MetaData"},"quantity":{"type":"integer","description":"The quantity of products being purchased."},"description":{"type":"string","description":"An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name."},"product_id":{"type":"string","description":"The id of the product."},"price_id":{"type":"string","description":"The id of the price."},"taxes":{"type":"array","description":"The taxes applied to the price item.","readOnly":true,"items":{"oneOf":[{"$ref":"#/components/schemas/TaxAmountDto"}]}},"recurrences":{"type":"array","description":"The taxes applied to the price item.","readOnly":true,"items":{"oneOf":[{"$ref":"#/components/schemas/RecurrenceAmountDto"}]}},"_price":{"$ref":"#/components/schemas/Price"},"_product":{"description":"The product linked to the price item.","$ref":"#/components/schemas/Product"}}},"TaxAmountDto":{"type":"object","description":"A valid tax rate from a client.","properties":{"rate":{"type":"string","description":"The tax rate applied."},"tax":{"description":"The tax applied.","oneOf":[{"$ref":"#/components/schemas/Tax"}]}}},"RecurrenceAmountDto":{"type":"object","description":"An amount associated with a specific recurrence.","properties":{"type":{"type":"string","description":"The price type."},"billing_period":{"type":"string","description":"The price billing period."},"amount_subtotal":{"type":"integer","description":"Total of all items, with same recurrence, before (discounts or) taxes are applied."},"amount_total":{"type":"integer","description":"Total of all items, with same recurrence, after (discounts and) taxes are applied."},"amount_tax":{"type":"integer","description":"Total of all items taxes, with same recurrence."}},"required":["type","amount_subtotal","amount_total"]},"Cart":{"description":"Supports shopping for products and services until ready for checkout.","properties":{"id":{"type":"string","description":"The cart identifier"},"org_id":{"type":"string","description":"The user\'s Organization Id the cart belongs to","readOnly":true},"status":{"enum":["open","complete","expired"],"type":"string","readOnly":true,"description":"The status of the Cart:\\n- open - the cart checkout is still in progress. Payment processing has not started\\n- complete - the cart checkout is complete. Payment processing may still be in progress\\n- expired - the cart checkout has expired. No further processing will occur\\n"},"customer":{"$ref":"#/components/schemas/Customer"},"billing_address":{"$ref":"#/components/schemas/Address"},"delivery_address":{"$ref":"#/components/schemas/Address"},"metadata":{"$ref":"#/components/schemas/MetaData"},"line_items":{"$ref":"#/components/schemas/PriceItems"},"amount_subtotal":{"readOnly":true,"type":"integer","description":"Total of all items before (discounts or) taxes are applied."},"amount_total":{"readOnly":true,"type":"integer","description":"Total of all items after (discounts and) taxes are applied."},"total_details":{"$ref":"#/components/schemas/TotalDetails"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"}}},"Currency":{"type":"string","description":"Three-letter ISO currency code, in lowercase. Must be a supported currency.\\nISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html\\n"},"Opportunity":{"type":"object","description":"The opportunity entity","additionalProperties":true,"properties":{"opportunity_number":{"type":"string","description":"The opportunity id number for the customer (autogenerated if left blank)"},"description":{"type":"string","description":"A description to frame this opportunity within its sales process"},"status":{"type":"string","description":"The opportunity status","enum":["lead","qualification","validation","offering","supply","approval","operations","complete"]},"items":{"oneOf":[{"type":"array","description":"An array of order when the opportunity entity is hydrated","items":{"$ref":"#/components/schemas/Order"}},{"type":"object","description":"The order relations items, representing quotes or orders associated with the opportunity","properties":{"$relation":{"type":"array","items":{"$ref":"#/components/schemas/OrderRelation"}}}}]},"_org_id":{"type":"string","description":"Organization Id the order belongs to"},"_id":{"type":"string","readOnly":true},"_created_at":{"type":"string","readOnly":true},"_updated_at":{"type":"string","readOnly":true},"_tags":{"type":"array","items":{"type":"string"}}}},"OrderRelation":{"type":"object","description":"An order relation reference","properties":{"entity_id":{"type":"string","description":"The relation order id"},"_tags":{"type":"array","items":{"type":"string","description":"The tags array associated with the relation"}}}},"Order":{"type":"object","description":"The order entity","additionalProperties":true,"properties":{"order_number":{"type":"string","description":"The order id number for the customer"},"cart_id":{"type":"string","description":"The cart id that originated or is associated with the order"},"status":{"$ref":"#/components/schemas/OrderStatus"},"metadata":{"$ref":"#/components/schemas/MetaData"},"billing_first_name":{"type":"string"},"billing_last_name":{"type":"string"},"billing_company_name":{"type":"string"},"billing_vat":{"type":"string"},"billing_email":{"type":"string"},"billing_phone":{"type":"string"},"billing_address":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"currency":{"$ref":"#/components/schemas/Currency"},"delivery_address":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"payment_method":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"contact":{"readOnly":true,"type":"string","description":"The id of an existing contact."},"line_items":{"$ref":"#/components/schemas/PriceItems"},"amount_subtotal":{"readOnly":true,"type":"integer","description":"Total of all items before (discounts or) taxes are applied."},"amount_total":{"readOnly":true,"type":"integer","description":"Total of all items after (discounts and) taxes are applied."},"total_details":{"$ref":"#/components/schemas/TotalDetails"},"_org_id":{"type":"string","description":"Organization Id the order belongs to"},"_id":{"type":"string","readOnly":true},"_created_at":{"type":"string","readOnly":true},"_updated_at":{"type":"string","readOnly":true},"_tags":{"type":"array","items":{"type":"string"}}}},"PriceItems":{"description":"Tracks a set of product prices, quantities, (discounts) and taxes.","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/PriceItem"}]}},"PriceItem":{"description":"Represents a price item","type":"object","properties":{"id":{"type":"string","description":"price item id","readOnly":true},"metadata":{"$ref":"#/components/schemas/MetaData"},"unit_amount":{"type":"integer","description":"The unit amount value","readOnly":true},"amount_subtotal":{"type":"integer","description":"Total before any (discounts or) taxes are applied.","readOnly":true},"amount_total":{"type":"integer","description":"Total after (discounts and) taxes.","readOnly":true},"currency":{"$ref":"#/components/schemas/Currency"},"description":{"type":"string","description":"An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name."},"quantity":{"type":"integer","description":"The quantity of products being purchased."},"product_id":{"type":"string","description":"The id of the product."},"price_id":{"type":"string","description":"The id of the price."},"_price":{"$ref":"#/components/schemas/Price"},"_product":{"$ref":"#/components/schemas/Product"},"taxes":{"type":"array","description":"The taxes applied to the price item.","readOnly":true,"items":{"oneOf":[{"$ref":"#/components/schemas/TaxAmount"}]}},"recurrences":{"type":"array","description":"The sum of amounts of the price items by recurrence.","readOnly":true,"items":{"oneOf":[{"$ref":"#/components/schemas/RecurrenceAmount"}]}}}},"TaxAmount":{"type":"object","description":"A tax amount associated with a specific tax rate.","readOnly":true,"properties":{"amount":{"type":"integer","description":"The tax amount."},"rate":{"type":"string","description":"The tax rate applied."},"tax":{"description":"The tax applied.","oneOf":[{"$ref":"#/components/schemas/Tax"}]}}},"RecurrenceAmount":{"type":"object","description":"An amount associated with a specific recurrence.","readOnly":true,"properties":{"type":{"type":"string","description":"The price type."},"billing_period":{"type":"string","description":"The price billing period."},"amount_subtotal":{"type":"integer","description":"Total of all items, with same recurrence, before (discounts or) taxes are applied."},"amount_total":{"type":"integer","description":"Total of all items, with same recurrence, after (discounts and) taxes are applied."},"amount_tax":{"type":"integer","description":"Total of all items taxes, with same recurrence."}},"required":["type","amount_subtotal","amount_total"]},"TotalDetails":{"type":"object","description":"The total details with tax (and discount) aggregated totals.","readOnly":true,"properties":{"amount_shipping":{"type":"integer","description":"This is the sum of all the price item shipping amounts."},"amount_tax":{"type":"integer","description":"This is the sum of all the price item tax amounts."},"breakdown":{"type":"object","description":"Breakdown of individual tax (and discount) amounts that add up to the totals.","properties":{"taxes":{"type":"array","description":"The aggregated price items tax amount per rate.","items":{"oneOf":[{"$ref":"#/components/schemas/TaxAmount"}]}},"recurrences":{"type":"array","description":"The aggregated price items tax amount per rate.","items":{"oneOf":[{"$ref":"#/components/schemas/RecurrenceAmount"}]}}}}}},"PricingDetails":{"type":"object","description":"The result from the calculation of a set of price items.","properties":{"items":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/PriceItem"}]}},"amount_subtotal":{"type":"integer","description":"Total of all items before (discounts or) taxes are applied."},"amount_total":{"type":"integer","description":"Total of all items after (discounts and) taxes are applied."},"total_details":{"$ref":"#/components/schemas/TotalDetails"}}},"BillingPeriod":{"type":"string","enum":["weekly","monthly","every_quarter","every_6_months","yearly","one_time"]},"SalesTax":{"type":"string","enum":["nontaxable","reduced","standard"]},"Price":{"type":"object","description":"The price configuration","additionalProperties":true,"readOnly":true,"properties":{"active":{"type":"boolean"},"billing_scheme":{"type":"string","enum":["Per Unit"]},"description":{"type":"string"},"sales_tax":{"$ref":"#/components/schemas/SalesTax"},"tax_behavior":{"type":"string","enum":["inclusive","exclusive"]},"tiers_mode":{"type":"string","enum":["Standard"]},"type":{"type":"string","enum":["one_time","recurring"]},"billing_period":{"$ref":"#/components/schemas/BillingPeriod"},"unit_amount":{"type":"number"},"unit_amount_decimal":{"type":"string"},"unit_amount_currency":{"$ref":"#/components/schemas/Currency"},"billing_duration_amount":{"type":"number"},"billing_duration_unit":{"type":"string","enum":["weeks","months","years"]},"notice_time_amount":{"type":"number"},"notice_time_unit":{"type":"string","enum":["weeks","months","years"]},"termination_time_amount":{"type":"number"},"termination_time_unit":{"type":"string","enum":["weeks","months","years"]},"renewal_duration_amount":{"type":"number"},"renewal_duration_unit":{"type":"string","enum":["weeks","months","years"]},"_created_at":{"type":"string"},"_id":{"type":"string"},"_title":{"type":"string"},"_updated_at":{"type":"string"}}},"Address":{"type":"object","additionalProperties":true,"properties":{"street":{"type":"string","description":"The first line of the address. Typically the street address or PO Box number."},"street_number":{"type":"string","description":"The second line of the address. Typically the number of the apartment, suite, or unit."},"postal_code":{"type":"string","description":"The postal code for the address."},"city":{"type":"string","description":"The name of the city, district, village, or town."},"country":{"type":"string","description":"The two-letter code for the country of the address."},"additional_info":{"type":"string","description":"An additional description for the address"}}},"PaymentMethod":{"type":"object","description":"A PaymentMethod represent your customer\'s payment instruments.\\n","properties":{"type":{"type":"string","description":"The type of the PaymentMethod."},"details":{"type":"object","description":"Contains relevant data associated with the payment method type.","additionalProperties":true}}},"Customer":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"company_name":{"type":"string"},"vat_id":{"type":"string"},"email":{"type":"string","description":"A valid email identifying the customer."},"phone":{"type":"string"}}},"Product":{"type":"object","description":"The product configuration","readOnly":true,"additionalProperties":true,"properties":{"code":{"type":"string"},"type":{"type":"string","enum":["Product","Service"]},"name":{"type":"string"},"_id":{"type":"string"},"_title":{"type":"string"}}},"Tax":{"type":"object","description":"the tax configuration","additionalProperties":true,"required":["type","rate","behavior"],"properties":{"type":{"type":"string","enum":["VAT","GST","Custom"]},"description":{"type":"string"},"rate":{"type":"number"},"behavior":{"type":"string","enum":["Exclusive","Inclusive"]},"active":{"type":"boolean"},"region":{"type":"string"},"region_label":{"type":"string"}}}},"examples":{"checkoutWithCartId":{"value":{"mode":"create_order","cart":"pZ324jnndf"}},"checkoutWithTransientCart":{"value":{"mode":"create_order","cart":{"metadata":[{"key":"journey-id","value":"8d0a2235-97ce-42d0-88a3-e374634ca44e"}],"customer":{"first_name":"john","last_name":"doe","company_name":"company limited","vat_id":"123892321","email":"johndoe@company.com","phone":"+44233242423"},"billing_address":{"street1":"wallstreet","street2":1,"city":"new york city","country":"united states","country_code":"US","additional_info":"headquarters office"},"delivery_address":{"street1":"berverly hills avenue","street2":"block 1","city":"berverly hills","country":"california","country_code":"CA","additional_info":"remote cowork place"},"line_items":[{"quantity":1,"product":"b7185fb7-b10f-4875-bda7-288631446555","price":"df240bab-9f71-4a9a-a9e1-59f18827dbf9"},{"quantity":1,"product":"zzzzzz-b10f-4875-bda7-288631446555","price":"zzzzz-9f71-4a9a-a9e1-59f18827dbf9"}],"files":["xf240bab-9f71-4a9a-a9e1-59f18827dbf9","yf240bab-9f71-4a9a-a9e1-59f18827dbf9","zf240bab-9f71-4a9a-a9e1-59f18827dbf9"]}}},"checkoutResult":{"value":{"order":{"_id":"d1ZoC1FwZ6","type":"Draft","cart_id":"p0ZoB1FwH6","order_number":"20201021-234324","_org_id":123,"metadata":[{"key":"journey-id","value":"8d0a2235-97ce-42d0-88a3-e374634ca44e"}],"billing_first_name":"john","billing_last_name":"doe","billing_company_name":"i me and myself","billing_vat":"234823948","billing_email":"johndoe@nowhere.com","currency":"EUR","billing_phone":"+1234234545","billing_address":"wallstreet, 1","billing_contact":"villy or zilly","line_items":[{"id":"mSjGCTfn8w","metadata":[{"cart_id":"p0ZoB1FwH6"}],"description":"Wallbox Premium - Premium Price","currency":"EUR","unit_amount":78900,"amount_subtotal":50000,"amount_total":61500,"quantity":1,"product_id":"b7185fb7-b10f-4875-bda7-288631446555","price_id":"df240bab-9f71-4a9a-a9e1-59f18827dbf9","taxes":[{"amount":11500,"rate":"MwSt. 23%"}],"_price":{"_id":"df240bab-9f71-4a9a-a9e1-59f18827dbf9","unit_amount":"€ 789","type":"one_time","active":true,"sales_tax":"standard","tax_behavior":"inclusive","description":"Winter Sale","billing_scheme":"Per Unit","tiers_mode":"Standard","_created_at":"2021-11-10T18:02:58.318Z","_updated_at":"2021-11-10T18:02:58.318Z","_title":"Winter Sale"}},{"id":"mZkGCTfn6p","metadata":[{"cart_id":"p0ZoB1FwH6"}],"description":"Wallbox Basic with Full Add-ons - Basic Price","currency":"EUR","unit_amount":78900,"amount_subtotal":50000,"amount_total":53500,"quantity":1,"product_id":"zzzzzz-b10f-4875-bda7-288631446555","price_id":"zzzzz-9f71-4a9a-a9e1-59f18827dbf9","taxes":[{"amount":3500,"rate":"MwSt. 7%"}],"_price":{"_id":"zzzzz-9f71-4a9a-a9e1-59f18827dbf9","unit_amount":"€ 789","type":"one_time","active":true,"sales_tax":"standard","tax_behavior":"inclusive","description":"Winter Sale","billing_scheme":"Per Unit","tiers_mode":"Standard","_created_at":"2021-11-10T18:02:58.318Z","_updated_at":"2021-11-10T18:02:58.318Z","_title":"Winter Sale"}}],"amount_subtotal":100000,"amount_total":115000,"total_details":{"amount_shipping":10000,"amount_tax":15000,"breakdown":[{"amount":11500,"rate":"MwSt. 23%"},{"amount":3500,"rate":"MwSt. 7%"}]},"_created_at":"2021-11-10T18:02:58.318Z","_updated_at":"2021-11-10T18:02:58.318Z"}}}}}}')}},t={};return function r(i){if(t[i])return t[i].exports;var a=t[i]={exports:{}};return e[i].call(a.exports,a,a.exports,r),a.exports}(914)})());
|
|
1
|
+
!function(e,t){for(var r in t)e[r]=t[r];t.__esModule&&Object.defineProperty(e,"__esModule",{value:!0})}(exports,(()=>{"use strict";var e={914:function(e,t,r){var i=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});const a=i(r(279));t.default=a.default},279:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"Pricing API","description":"This API hub sets the foundations for the following Pricing APIs:\\n\\n- Shopping Cart API, used to interact with a cart during a customer\'s checkout session, and it\'s responsible for providing the following set of features:\\n - A unified data model to model a Shopping Cart\\n - Cart abandonment recovery\\n - Pricing features such as automatic calculation of totals and price breakdowns for taxes\\n - Product and pricing data validation\\n - Checkout a cart into an order, invoice, or quote\\n\\n- Product Catalog API, provides a way to query the entire catalog of products and prices.\\n - Exposes querying operations to access the customer Product Catalog\\n\\n- Product Availability Service, provides a way to check for products availability by a set of predefined dimensions.\\n","contact":{"name":"Maintainers Channel","url":"https://epilot.slack.com/archives/C020B4URQNS"},"version":"1.0.0"},"externalDocs":{"description":"Read the full docs here","url":"https://e-pilot.atlassian.net/wiki/spaces/EO/pages/5459705918/Shopping+Cart+Orders+API"},"tags":[{"name":"Cart","description":"The shopping cart & checkout management operations"},{"name":"Product Catalog","description":"Product querying operations"}],"security":[{"EpilotAuth":[]},{"AsOrganization":[]}],"paths":{"/v1/public/cart:checkout":{"post":{"description":"Checkouts a cart and executes the specified checkout `mode` process.\\n\\nA Checkout implicitly finalizes the provided cart (if not transient from a fast-checkout) and behaves in one of the following modes:\\n- `create_order` (**default**): the payment happens at a later date or managed by 3rd-party CRM (SAP)\\n- `create_invoice`: the payment happens on the online checkout (paypal, stripe, adyen)\\n- `create_quote`: the checkout represents a price quote request\\n\\nFast checkout is also supported, by passing the Cart contents directly.\\nWhen a fast checkout is performed the cart is considered transient and there is no cart persistance.\\n\\nIf the checkout `mode` is omitted, the `mode` will default to `create_order`.\\n","operationId":"$checkoutCart","summary":"checkoutCart","security":[],"tags":["Cart"],"parameters":[{"in":"header","name":"X-Ivy-Org-ID","description":"The target Organization Id represented by the caller","schema":{"type":"string"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutCart"},"examples":{"Checkout with a CartID":{"$ref":"#/components/examples/checkoutWithCartId"},"Fast Checkout with a transient Cart":{"$ref":"#/components/examples/checkoutWithTransientCart"}}}}},"responses":{"200":{"description":"The checkout result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckoutCartResult"},"examples":{"Checkout with created order":{"$ref":"#/components/examples/checkoutResult"}}}}},"400":{"description":"Invalid payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/public/catalog":{"post":{"description":"Provides a querying functionalities over products and prices of the Catalog for a given organization.","operationId":"$searchCatalog","summary":"searchCatalog","security":[],"tags":["Product Catalog"],"parameters":[{"in":"header","name":"X-Ivy-Org-ID","description":"The target Organization Id represented by the caller","schema":{"type":"string"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogSearch"}}}},"responses":{"200":{"description":"The search result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogSearchResult"}}}},"400":{"description":"Invalid payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/public/availability:check":{"post":{"description":"The availability check endpoint","operationId":"$availabilityCheck","summary":"availabilityCheck","security":[],"tags":["Product Catalog"],"parameters":[{"in":"header","name":"X-Ivy-Org-ID","description":"The target Organization Id represented by the caller","schema":{"type":"string"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailabilityCheckParams"},"examples":{"Check availability with location dimension":{"value":{"products":["cd75456a-30e4-4912-95be-e743d5ea175b"],"filters":{"location":{"postal_code":"57008","city":"Cologne","street":"Media Park","street_number":"8a"}}}},"Check availability with location & available date dimension":{"value":{"products":["cd75456a-30e4-4912-95be-e743d5ea175b"],"filters":{"location":{"postal_code":"57008","city":"Cologne","street":"Media Park","street_number":"8a"},"available_date":"2022-05-01"}}}}}}},"responses":{"200":{"description":"The availability check result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailabilityResult"},"examples":{"Response with available products":{"value":{"available_products":["cd75456a-30e4-4912-95be-e743d5ea175b"],"check_results":[{"product_id":"cd75456a-30e4-4912-95be-e743d5ea175b","matching_hits":1}]}},"Response with no available products":{"value":{"available_products":[]}},"Response with available and unavailable products":{"value":{"availableProducts":["my-product-id-123-2"],"checkResults":[{"productId":"my-product-id-123-1","matchingError":{"msg":"Error - Unknown file extension for availability file."}},{"matchingHits":1,"productId":"my-product-id-123-2"}]}}}}}},"400":{"description":"Invalid payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/public/opportunity":{"post":{"deprecated":true,"description":"Creates a new opportunity. During the creation of an opportunity, an unique customer-readable `opportunity_number` will be generated.\\nThe `opportunity_number` can be used to universally identify an opportunity within epilot platform.\\n","operationId":"$createOpportunity","summary":"createOpportunity","security":[],"parameters":[{"in":"header","name":"X-Ivy-Org-ID","description":"The target Organization Id represented by the caller","schema":{"type":"string"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Opportunity"},"examples":{"Opportunity containing one Order":{"value":{"billing_address":{"street":"sdf","street_number":"1","city":"Berlin","postal_code":"12045","country":"de","additional_info":"adasd"},"delivery_address":{"street":"sdf","street_number":"1","city":"Berlin","postal_code":"12045","country":"de","additional_info":"adasd"},"items":{"$relation":[{"entity_id":"c8dbe8f3-28b6-4d77-aae8-47bc24a2532f","_tags":["journey"]}]},"_tags":["journey","ORWNr4iCN"]}}}}}},"responses":{"201":{"description":"The new Opportunity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Opportunity"}}}},"400":{"description":"Invalid payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"securitySchemes":{"EpilotAuth":{"type":"http","scheme":"bearer","description":"Epilot Bearer Token"},"AsOrganization":{"type":"apiKey","in":"header","name":"x-ivy-org-id","description":"Set organization id when using internal auth"},"AsUser":{"type":"apiKey","in":"header","name":"x-ivy-user-id","description":"Set user id when using internal auth"}},"schemas":{"Error":{"required":["message"],"properties":{"message":{"type":"string","description":"Error message"}}},"MetaData":{"description":"A set of key-value pairs.","type":"array","items":{"oneOf":[{"type":"object","description":"Key value pair entry","properties":{"key":{"type":"string","description":"Item key"},"value":{"type":"string","description":"Item value"}}}]}},"CatalogSearch":{"description":"A catalog search payload","type":"object","properties":{"q":{"description":"The query to perform using lucene query syntax.","type":"string"},"sort":{"description":"The sort expression to sort the results.","type":"string"},"from":{"description":"The index from which to query, used for pagination purposes. Defaults to 0","type":"number"},"size":{"description":"The max size of the response, defaults to 2000.","type":"number"},"hydrate":{"type":"boolean","description":"When true, enables entity hydration to resolve nested $relation references in-place.","default":false},"availability":{"$ref":"#/components/schemas/AvailabilityFilters"}},"example":{"q":"_id:1233432 OR _id:123432454 OR _id:23445433","sort":"description ASC","from":0,"size":200,"availability":{"location":{"postal_code":"57008,","city":"Cologne,","street":"Media Park,","street_number":"8a"},"available_date":{"value":"2022-05-01"}}},"required":["q"]},"CatalogSearchResult":{"description":"The query result payload","type":"object","properties":{"hits":{"type":"number","description":"The number os results returned."},"results":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/Product"},{"$ref":"#/components/schemas/Price"}]}}},"example":{"hits":2,"results":[{"schema":"product","description":"product a"},{"schema":"price","unit_amount_decimal":"124.342343434"}]}},"AvailabilityCheckParams":{"description":"Availability check request payload","type":"object","properties":{"products":{"description":"Products to check availability","type":"array","items":{"type":"string","description":"Product under availability check"}},"filters":{"$ref":"#/components/schemas/AvailabilityFilters"}},"required":["products","filters"]},"AvailabilityResult":{"description":"The availability check result payload","type":"object","properties":{"available_products":{"type":"array","items":{"type":"string","description":"Available Products"}},"check_results":{"description":"The check result details","type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"matching_hits":{"description":"The number of rules matched","type":"number"},"matching_error":{"description":"A set of matching errors when checking availability","type":"object","additionalProperties":true}},"required":["product_id"]}}},"required":["available_products"],"example":{"available_products":[],"check_results":[{"product_id":"my-product-id-123-1","matching_hits":0},{"product_id":"my-product-id-123-2","matching_hits":0}]}},"CartDto":{"description":"A valid cart payload from a client.","properties":{"metadata":{"$ref":"#/components/schemas/MetaData"},"customer":{"$ref":"#/components/schemas/Customer"},"billing_address":{"$ref":"#/components/schemas/Address"},"delivery_address":{"$ref":"#/components/schemas/Address"},"additional_addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"payment_method":{"$ref":"#/components/schemas/PaymentMethod"},"line_items":{"$ref":"#/components/schemas/PriceItemsDto"},"files":{"type":"array","description":"An array of file IDs, already upload into the File API, that are related with this cart","items":{"type":"string","description":"a string representing a file ID as received from the File API"}},"status":{"$ref":"#/components/schemas/OrderStatus"},"tags":{"type":"array","items":{"type":"string"}},"journey_data":{"type":"object","additionalProperties":true},"consents":{"type":"object","additionalProperties":true}},"required":["line_items"]},"CheckoutCart":{"type":"object","description":"The cart checkout request payload","properties":{"cart":{"anyOf":[{"description":"the cart id","type":"string"},{"$ref":"#/components/schemas/CartDto"}]},"mode":{"$ref":"#/components/schemas/CheckoutMode"}}},"CheckoutCartResult":{"type":"object","description":"The cart checkout result","properties":{"order":{"$ref":"#/components/schemas/Order"}}},"CheckoutMode":{"type":"string","description":"The checkout mode for the cart checkout.","enum":["create_order","create_invoice","create_quote"]},"OrderStatus":{"type":"string","enum":["draft","quote","placed","cancelled","completed"],"description":"The order status"},"PriceItemsDto":{"description":"A valid set of product prices, quantities, (discounts) and taxes from a client.","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/PriceItemDto"}]}},"PriceItemDto":{"description":"Represents a valid price item from a client.","type":"object","properties":{"metadata":{"$ref":"#/components/schemas/MetaData"},"quantity":{"type":"integer","description":"The quantity of products being purchased."},"description":{"type":"string","description":"An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name."},"product_id":{"type":"string","description":"The id of the product."},"price_id":{"type":"string","description":"The id of the price."},"taxes":{"type":"array","description":"The taxes applied to the price item.","readOnly":true,"items":{"oneOf":[{"$ref":"#/components/schemas/TaxAmountDto"}]}},"recurrences":{"type":"array","description":"The taxes applied to the price item.","readOnly":true,"items":{"oneOf":[{"$ref":"#/components/schemas/RecurrenceAmountDto"}]}},"_price":{"$ref":"#/components/schemas/Price"},"_product":{"description":"The product linked to the price item.","$ref":"#/components/schemas/Product"}}},"TaxAmountDto":{"type":"object","description":"A valid tax rate from a client.","properties":{"rate":{"type":"string","description":"The tax rate applied."},"tax":{"description":"The tax applied.","oneOf":[{"$ref":"#/components/schemas/Tax"}]}}},"RecurrenceAmountDto":{"type":"object","description":"An amount associated with a specific recurrence.","properties":{"type":{"type":"string","description":"The price type."},"billing_period":{"type":"string","description":"The price billing period."},"amount_subtotal":{"type":"integer","description":"Total of all items, with same recurrence, before (discounts or) taxes are applied."},"amount_total":{"type":"integer","description":"Total of all items, with same recurrence, after (discounts and) taxes are applied."},"amount_tax":{"type":"integer","description":"Total of all items taxes, with same recurrence."}},"required":["type","amount_subtotal","amount_total"]},"Cart":{"description":"Supports shopping for products and services until ready for checkout.","properties":{"id":{"type":"string","description":"The cart identifier"},"org_id":{"type":"string","description":"The user\'s Organization Id the cart belongs to","readOnly":true},"status":{"enum":["open","complete","expired"],"type":"string","readOnly":true,"description":"The status of the Cart:\\n- open - the cart checkout is still in progress. Payment processing has not started\\n- complete - the cart checkout is complete. Payment processing may still be in progress\\n- expired - the cart checkout has expired. No further processing will occur\\n"},"customer":{"$ref":"#/components/schemas/Customer"},"billing_address":{"$ref":"#/components/schemas/Address"},"delivery_address":{"$ref":"#/components/schemas/Address"},"metadata":{"$ref":"#/components/schemas/MetaData"},"line_items":{"$ref":"#/components/schemas/PriceItems"},"amount_subtotal":{"readOnly":true,"type":"integer","description":"Total of all items before (discounts or) taxes are applied."},"amount_total":{"readOnly":true,"type":"integer","description":"Total of all items after (discounts and) taxes are applied."},"total_details":{"$ref":"#/components/schemas/TotalDetails"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"}}},"Currency":{"type":"string","description":"Three-letter ISO currency code, in lowercase. Must be a supported currency.\\nISO 4217 CURRENCY CODES as specified in the documentation: https://www.iso.org/iso-4217-currency-codes.html\\n"},"Opportunity":{"type":"object","description":"The opportunity entity","additionalProperties":true,"properties":{"opportunity_number":{"type":"string","description":"The opportunity id number for the customer (autogenerated if left blank)"},"description":{"type":"string","description":"A description to frame this opportunity within its sales process"},"status":{"type":"string","description":"The opportunity status","enum":["lead","qualification","validation","offering","supply","approval","operations","complete"]},"items":{"oneOf":[{"type":"array","description":"An array of order when the opportunity entity is hydrated","items":{"$ref":"#/components/schemas/Order"}},{"type":"object","description":"The order relations items, representing quotes or orders associated with the opportunity","properties":{"$relation":{"type":"array","items":{"$ref":"#/components/schemas/OrderRelation"}}}}]},"_org_id":{"type":"string","description":"Organization Id the order belongs to"},"_id":{"type":"string","readOnly":true},"_created_at":{"type":"string","readOnly":true},"_updated_at":{"type":"string","readOnly":true},"_tags":{"type":"array","items":{"type":"string"}}}},"OrderRelation":{"type":"object","description":"An order relation reference","properties":{"entity_id":{"type":"string","description":"The relation order id"},"_tags":{"type":"array","items":{"type":"string","description":"The tags array associated with the relation"}}}},"Order":{"type":"object","description":"The order entity","additionalProperties":true,"properties":{"order_number":{"type":"string","description":"The order id number for the customer"},"cart_id":{"type":"string","description":"The cart id that originated or is associated with the order"},"status":{"$ref":"#/components/schemas/OrderStatus"},"metadata":{"$ref":"#/components/schemas/MetaData"},"billing_first_name":{"type":"string"},"billing_last_name":{"type":"string"},"billing_company_name":{"type":"string"},"billing_vat":{"type":"string"},"billing_email":{"type":"string"},"billing_phone":{"type":"string"},"billing_address":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"currency":{"$ref":"#/components/schemas/Currency"},"delivery_address":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"payment_method":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"contact":{"readOnly":true,"type":"string","description":"The id of an existing contact."},"line_items":{"$ref":"#/components/schemas/PriceItems"},"amount_subtotal":{"readOnly":true,"type":"integer","description":"Total of all items before (discounts or) taxes are applied."},"amount_total":{"readOnly":true,"type":"integer","description":"Total of all items after (discounts and) taxes are applied."},"total_details":{"$ref":"#/components/schemas/TotalDetails"},"_org_id":{"type":"string","description":"Organization Id the order belongs to"},"_id":{"type":"string","readOnly":true},"_created_at":{"type":"string","readOnly":true},"_updated_at":{"type":"string","readOnly":true},"_tags":{"type":"array","items":{"type":"string"}}}},"PriceItems":{"description":"Tracks a set of product prices, quantities, (discounts) and taxes.","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/PriceItem"}]}},"PriceItem":{"description":"Represents a price item","type":"object","properties":{"id":{"type":"string","description":"price item id","readOnly":true},"metadata":{"$ref":"#/components/schemas/MetaData"},"unit_amount":{"type":"integer","description":"The unit amount value","readOnly":true},"amount_subtotal":{"type":"integer","description":"Total before any (discounts or) taxes are applied.","readOnly":true},"amount_total":{"type":"integer","description":"Total after (discounts and) taxes.","readOnly":true},"currency":{"$ref":"#/components/schemas/Currency"},"description":{"type":"string","description":"An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name."},"quantity":{"type":"integer","description":"The quantity of products being purchased."},"product_id":{"type":"string","description":"The id of the product."},"price_id":{"type":"string","description":"The id of the price."},"_price":{"$ref":"#/components/schemas/Price"},"_product":{"$ref":"#/components/schemas/Product"},"taxes":{"type":"array","description":"The taxes applied to the price item.","readOnly":true,"items":{"oneOf":[{"$ref":"#/components/schemas/TaxAmount"}]}},"recurrences":{"type":"array","description":"The sum of amounts of the price items by recurrence.","readOnly":true,"items":{"oneOf":[{"$ref":"#/components/schemas/RecurrenceAmount"}]}}}},"TaxAmount":{"type":"object","description":"A tax amount associated with a specific tax rate.","readOnly":true,"properties":{"amount":{"type":"integer","description":"The tax amount."},"rate":{"type":"string","description":"The tax rate applied."},"tax":{"description":"The tax applied.","oneOf":[{"$ref":"#/components/schemas/Tax"}]}}},"RecurrenceAmount":{"type":"object","description":"An amount associated with a specific recurrence.","readOnly":true,"properties":{"type":{"type":"string","description":"The price type."},"billing_period":{"type":"string","description":"The price billing period."},"amount_subtotal":{"type":"integer","description":"Total of all items, with same recurrence, before (discounts or) taxes are applied."},"amount_total":{"type":"integer","description":"Total of all items, with same recurrence, after (discounts and) taxes are applied."},"amount_tax":{"type":"integer","description":"Total of all items taxes, with same recurrence."}},"required":["type","amount_subtotal","amount_total"]},"TotalDetails":{"type":"object","description":"The total details with tax (and discount) aggregated totals.","readOnly":true,"properties":{"amount_shipping":{"type":"integer","description":"This is the sum of all the price item shipping amounts."},"amount_tax":{"type":"integer","description":"This is the sum of all the price item tax amounts."},"breakdown":{"type":"object","description":"Breakdown of individual tax (and discount) amounts that add up to the totals.","properties":{"taxes":{"type":"array","description":"The aggregated price items tax amount per rate.","items":{"oneOf":[{"$ref":"#/components/schemas/TaxAmount"}]}},"recurrences":{"type":"array","description":"The aggregated price items tax amount per rate.","items":{"oneOf":[{"$ref":"#/components/schemas/RecurrenceAmount"}]}}}}}},"PricingDetails":{"type":"object","description":"The result from the calculation of a set of price items.","properties":{"items":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/PriceItem"}]}},"amount_subtotal":{"type":"integer","description":"Total of all items before (discounts or) taxes are applied."},"amount_total":{"type":"integer","description":"Total of all items after (discounts and) taxes are applied."},"total_details":{"$ref":"#/components/schemas/TotalDetails"}}},"BillingPeriod":{"type":"string","enum":["weekly","monthly","every_quarter","every_6_months","yearly","one_time"]},"SalesTax":{"type":"string","enum":["nontaxable","reduced","standard"]},"Price":{"type":"object","description":"The price configuration","additionalProperties":true,"readOnly":true,"properties":{"active":{"type":"boolean"},"billing_scheme":{"type":"string","enum":["Per Unit"]},"description":{"type":"string"},"sales_tax":{"$ref":"#/components/schemas/SalesTax"},"tax_behavior":{"type":"string","enum":["inclusive","exclusive"]},"tiers_mode":{"type":"string","enum":["Standard"]},"type":{"type":"string","enum":["one_time","recurring"]},"billing_period":{"$ref":"#/components/schemas/BillingPeriod"},"unit_amount":{"type":"number"},"unit_amount_decimal":{"type":"string"},"unit_amount_currency":{"$ref":"#/components/schemas/Currency"},"billing_duration_amount":{"type":"number"},"billing_duration_unit":{"type":"string","enum":["weeks","months","years"]},"notice_time_amount":{"type":"number"},"notice_time_unit":{"type":"string","enum":["weeks","months","years"]},"termination_time_amount":{"type":"number"},"termination_time_unit":{"type":"string","enum":["weeks","months","years"]},"renewal_duration_amount":{"type":"number"},"renewal_duration_unit":{"type":"string","enum":["weeks","months","years"]},"_created_at":{"type":"string"},"_id":{"type":"string"},"_title":{"type":"string"},"_updated_at":{"type":"string"}}},"AvailabilityLocation":{"type":"object","properties":{"street":{"type":"string","description":"The first line of the address. Typically the street address or PO Box number."},"street_number":{"type":"string","description":"The second line of the address. Typically the number of the apartment, suite, or unit."},"postal_code":{"type":"string","description":"The postal code for the address."},"city":{"type":"string","description":"The name of the city, district, village, or town."},"country":{"type":"string","description":"The name of the country."}}},"AvailabilityDate":{"type":"object","properties":{"available_start_date":{"type":"string","format":"date","description":"The availability interval start date","example":"2017-07-21"},"available_end_date":{"type":"string","format":"date","description":"The availability interval end date","example":"2017-07-21"}}},"AvailabilityFilters":{"description":"Availability filters dimensions","type":"object","properties":{"location":{"$ref":"#/components/schemas/AvailabilityLocation"},"available_date":{"type":"string","format":"date","example":"2017-07-21","description":"A value to be matched against the availability window (start & end date)"}},"required":["location"]},"Address":{"type":"object","additionalProperties":true,"properties":{"street":{"type":"string","description":"The first line of the address. Typically the street address or PO Box number."},"street_number":{"type":"string","description":"The second line of the address. Typically the number of the apartment, suite, or unit."},"postal_code":{"type":"string","description":"The postal code for the address."},"city":{"type":"string","description":"The name of the city, district, village, or town."},"country":{"type":"string","description":"The two-letter code for the country of the address."},"additional_info":{"type":"string","description":"An additional description for the address"}}},"PaymentMethod":{"type":"object","description":"A PaymentMethod represent your customer\'s payment instruments.\\n","properties":{"type":{"type":"string","description":"The type of the PaymentMethod."},"details":{"type":"object","description":"Contains relevant data associated with the payment method type.","additionalProperties":true}}},"Customer":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"company_name":{"type":"string"},"vat_id":{"type":"string"},"email":{"type":"string","description":"A valid email identifying the customer."},"phone":{"type":"string"}}},"Product":{"type":"object","description":"The product configuration","readOnly":true,"additionalProperties":true,"properties":{"code":{"type":"string"},"type":{"type":"string","enum":["Product","Service"]},"name":{"type":"string"},"_id":{"type":"string"},"_title":{"type":"string"},"_availability_files":{"type":"array","items":{"$ref":"#/components/schemas/File"}}}},"File":{"type":"object","additionalProperties":true,"properties":{"_id":{"type":"string"},"filename":{"type":"string"},"mime_type":{"type":"string"},"versions":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"s3ref":{"type":"object","properties":{"bucket":{"type":"string"},"key":{"type":"string"}},"required":["bucket","key"]}},"required":["s3ref"]}},"_schema":{"type":"string"},"_org":{"type":"string"},"_created_at":{"type":"string","format":"date-time"},"_updated_at":{"type":"string","format":"date-time"},"_title":{"type":"string"},"$relation":{"$ref":"#/components/schemas/EntityRelation"}},"required":["versions","_id","_schema","_created_at","_updated_at","_org","mime_type","filename"]},"EntityRelation":{"type":"object","additionalProperties":true,"properties":{"entity_id":{"type":"string"},"_tags":{"type":"array","items":{"type":"string"}}}},"Tax":{"type":"object","description":"the tax configuration","additionalProperties":true,"required":["type","rate","behavior"],"properties":{"type":{"type":"string","enum":["VAT","GST","Custom"]},"description":{"type":"string"},"rate":{"type":"number"},"behavior":{"type":"string","enum":["Exclusive","Inclusive"]},"active":{"type":"boolean"},"region":{"type":"string"},"region_label":{"type":"string"}}}},"examples":{"checkoutWithCartId":{"value":{"mode":"create_order","cart":"pZ324jnndf"}},"checkoutWithTransientCart":{"value":{"mode":"create_order","cart":{"metadata":[{"key":"journey-id","value":"8d0a2235-97ce-42d0-88a3-e374634ca44e"}],"customer":{"first_name":"john","last_name":"doe","company_name":"company limited","vat_id":"123892321","email":"johndoe@company.com","phone":"+44233242423"},"billing_address":{"street1":"wallstreet","street2":1,"city":"new york city","country":"united states","country_code":"US","additional_info":"headquarters office"},"delivery_address":{"street1":"berverly hills avenue","street2":"block 1","city":"berverly hills","country":"california","country_code":"CA","additional_info":"remote cowork place"},"line_items":[{"quantity":1,"product":"b7185fb7-b10f-4875-bda7-288631446555","price":"df240bab-9f71-4a9a-a9e1-59f18827dbf9"},{"quantity":1,"product":"zzzzzz-b10f-4875-bda7-288631446555","price":"zzzzz-9f71-4a9a-a9e1-59f18827dbf9"}],"files":["xf240bab-9f71-4a9a-a9e1-59f18827dbf9","yf240bab-9f71-4a9a-a9e1-59f18827dbf9","zf240bab-9f71-4a9a-a9e1-59f18827dbf9"]}}},"checkoutResult":{"value":{"order":{"_id":"d1ZoC1FwZ6","type":"Draft","cart_id":"p0ZoB1FwH6","order_number":"20201021-234324","_org_id":123,"metadata":[{"key":"journey-id","value":"8d0a2235-97ce-42d0-88a3-e374634ca44e"}],"billing_first_name":"john","billing_last_name":"doe","billing_company_name":"i me and myself","billing_vat":"234823948","billing_email":"johndoe@nowhere.com","currency":"EUR","billing_phone":"+1234234545","billing_address":"wallstreet, 1","billing_contact":"villy or zilly","line_items":[{"id":"mSjGCTfn8w","metadata":[{"cart_id":"p0ZoB1FwH6"}],"description":"Wallbox Premium - Premium Price","currency":"EUR","unit_amount":78900,"amount_subtotal":50000,"amount_total":61500,"quantity":1,"product_id":"b7185fb7-b10f-4875-bda7-288631446555","price_id":"df240bab-9f71-4a9a-a9e1-59f18827dbf9","taxes":[{"amount":11500,"rate":"MwSt. 23%"}],"_price":{"_id":"df240bab-9f71-4a9a-a9e1-59f18827dbf9","unit_amount":"€ 789","type":"one_time","active":true,"sales_tax":"standard","tax_behavior":"inclusive","description":"Winter Sale","billing_scheme":"Per Unit","tiers_mode":"Standard","_created_at":"2021-11-10T18:02:58.318Z","_updated_at":"2021-11-10T18:02:58.318Z","_title":"Winter Sale"}},{"id":"mZkGCTfn6p","metadata":[{"cart_id":"p0ZoB1FwH6"}],"description":"Wallbox Basic with Full Add-ons - Basic Price","currency":"EUR","unit_amount":78900,"amount_subtotal":50000,"amount_total":53500,"quantity":1,"product_id":"zzzzzz-b10f-4875-bda7-288631446555","price_id":"zzzzz-9f71-4a9a-a9e1-59f18827dbf9","taxes":[{"amount":3500,"rate":"MwSt. 7%"}],"_price":{"_id":"zzzzz-9f71-4a9a-a9e1-59f18827dbf9","unit_amount":"€ 789","type":"one_time","active":true,"sales_tax":"standard","tax_behavior":"inclusive","description":"Winter Sale","billing_scheme":"Per Unit","tiers_mode":"Standard","_created_at":"2021-11-10T18:02:58.318Z","_updated_at":"2021-11-10T18:02:58.318Z","_title":"Winter Sale"}}],"amount_subtotal":100000,"amount_total":115000,"total_details":{"amount_shipping":10000,"amount_tax":15000,"breakdown":[{"amount":11500,"rate":"MwSt. 23%"},{"amount":3500,"rate":"MwSt. 7%"}]},"_created_at":"2021-11-10T18:02:58.318Z","_updated_at":"2021-11-10T18:02:58.318Z"}}}}}}')}},t={};return function r(i){if(t[i])return t[i].exports;var a=t[i]={exports:{}};return e[i].call(a.exports,a,a.exports,r),a.exports}(914)})());
|
package/dist/openapi.d.ts
CHANGED
|
@@ -36,6 +36,100 @@ declare namespace Components {
|
|
|
36
36
|
*/
|
|
37
37
|
additional_info?: string;
|
|
38
38
|
}
|
|
39
|
+
/**
|
|
40
|
+
* Availability check request payload
|
|
41
|
+
*/
|
|
42
|
+
export interface AvailabilityCheckParams {
|
|
43
|
+
/**
|
|
44
|
+
* Products to check availability
|
|
45
|
+
*/
|
|
46
|
+
products: string[];
|
|
47
|
+
filters: /* Availability filters dimensions */ AvailabilityFilters;
|
|
48
|
+
}
|
|
49
|
+
export interface AvailabilityDate {
|
|
50
|
+
/**
|
|
51
|
+
* The availability interval start date
|
|
52
|
+
* example:
|
|
53
|
+
* 2017-07-21
|
|
54
|
+
*/
|
|
55
|
+
available_start_date?: string; // date
|
|
56
|
+
/**
|
|
57
|
+
* The availability interval end date
|
|
58
|
+
* example:
|
|
59
|
+
* 2017-07-21
|
|
60
|
+
*/
|
|
61
|
+
available_end_date?: string; // date
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* Availability filters dimensions
|
|
65
|
+
*/
|
|
66
|
+
export interface AvailabilityFilters {
|
|
67
|
+
location: AvailabilityLocation;
|
|
68
|
+
/**
|
|
69
|
+
* A value to be matched against the availability window (start & end date)
|
|
70
|
+
* example:
|
|
71
|
+
* 2017-07-21
|
|
72
|
+
*/
|
|
73
|
+
available_date?: string; // date
|
|
74
|
+
}
|
|
75
|
+
export interface AvailabilityLocation {
|
|
76
|
+
/**
|
|
77
|
+
* The first line of the address. Typically the street address or PO Box number.
|
|
78
|
+
*/
|
|
79
|
+
street?: string;
|
|
80
|
+
/**
|
|
81
|
+
* The second line of the address. Typically the number of the apartment, suite, or unit.
|
|
82
|
+
*/
|
|
83
|
+
street_number?: string;
|
|
84
|
+
/**
|
|
85
|
+
* The postal code for the address.
|
|
86
|
+
*/
|
|
87
|
+
postal_code?: string;
|
|
88
|
+
/**
|
|
89
|
+
* The name of the city, district, village, or town.
|
|
90
|
+
*/
|
|
91
|
+
city?: string;
|
|
92
|
+
/**
|
|
93
|
+
* The name of the country.
|
|
94
|
+
*/
|
|
95
|
+
country?: string;
|
|
96
|
+
}
|
|
97
|
+
/**
|
|
98
|
+
* The availability check result payload
|
|
99
|
+
* example:
|
|
100
|
+
* {
|
|
101
|
+
* "available_products": [],
|
|
102
|
+
* "check_results": [
|
|
103
|
+
* {
|
|
104
|
+
* "product_id": "my-product-id-123-1",
|
|
105
|
+
* "matching_hits": 0
|
|
106
|
+
* },
|
|
107
|
+
* {
|
|
108
|
+
* "product_id": "my-product-id-123-2",
|
|
109
|
+
* "matching_hits": 0
|
|
110
|
+
* }
|
|
111
|
+
* ]
|
|
112
|
+
* }
|
|
113
|
+
*/
|
|
114
|
+
export interface AvailabilityResult {
|
|
115
|
+
available_products: string[];
|
|
116
|
+
/**
|
|
117
|
+
* The check result details
|
|
118
|
+
*/
|
|
119
|
+
check_results?: {
|
|
120
|
+
product_id: string;
|
|
121
|
+
/**
|
|
122
|
+
* The number of rules matched
|
|
123
|
+
*/
|
|
124
|
+
matching_hits?: number;
|
|
125
|
+
/**
|
|
126
|
+
* A set of matching errors when checking availability
|
|
127
|
+
*/
|
|
128
|
+
matching_error?: {
|
|
129
|
+
[name: string]: any;
|
|
130
|
+
};
|
|
131
|
+
}[];
|
|
132
|
+
}
|
|
39
133
|
export type BillingPeriod = "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly" | "one_time";
|
|
40
134
|
/**
|
|
41
135
|
* Supports shopping for products and services until ready for checkout.
|
|
@@ -82,6 +176,7 @@ declare namespace Components {
|
|
|
82
176
|
customer?: Customer;
|
|
83
177
|
billing_address?: Address;
|
|
84
178
|
delivery_address?: Address;
|
|
179
|
+
additional_addresses?: Address[];
|
|
85
180
|
payment_method?: /**
|
|
86
181
|
* A PaymentMethod represent your customer's payment instruments.
|
|
87
182
|
*
|
|
@@ -94,6 +189,12 @@ declare namespace Components {
|
|
|
94
189
|
files?: string[];
|
|
95
190
|
status?: /* The order status */ OrderStatus;
|
|
96
191
|
tags?: string[];
|
|
192
|
+
journey_data?: {
|
|
193
|
+
[name: string]: any;
|
|
194
|
+
};
|
|
195
|
+
consents?: {
|
|
196
|
+
[name: string]: any;
|
|
197
|
+
};
|
|
97
198
|
}
|
|
98
199
|
/**
|
|
99
200
|
* A catalog search payload
|
|
@@ -102,7 +203,18 @@ declare namespace Components {
|
|
|
102
203
|
* "q": "_id:1233432 OR _id:123432454 OR _id:23445433",
|
|
103
204
|
* "sort": "description ASC",
|
|
104
205
|
* "from": 0,
|
|
105
|
-
* "size": 200
|
|
206
|
+
* "size": 200,
|
|
207
|
+
* "availability": {
|
|
208
|
+
* "location": {
|
|
209
|
+
* "postal_code": "57008,",
|
|
210
|
+
* "city": "Cologne,",
|
|
211
|
+
* "street": "Media Park,",
|
|
212
|
+
* "street_number": "8a"
|
|
213
|
+
* },
|
|
214
|
+
* "available_date": {
|
|
215
|
+
* "value": "2022-05-01"
|
|
216
|
+
* }
|
|
217
|
+
* }
|
|
106
218
|
* }
|
|
107
219
|
*/
|
|
108
220
|
export interface CatalogSearch {
|
|
@@ -126,6 +238,7 @@ declare namespace Components {
|
|
|
126
238
|
* When true, enables entity hydration to resolve nested $relation references in-place.
|
|
127
239
|
*/
|
|
128
240
|
hydrate?: boolean;
|
|
241
|
+
availability?: /* Availability filters dimensions */ AvailabilityFilters;
|
|
129
242
|
}
|
|
130
243
|
/**
|
|
131
244
|
* The query result payload
|
|
@@ -185,12 +298,36 @@ declare namespace Components {
|
|
|
185
298
|
email?: string;
|
|
186
299
|
phone?: string;
|
|
187
300
|
}
|
|
301
|
+
export interface EntityRelation {
|
|
302
|
+
[name: string]: any;
|
|
303
|
+
entity_id?: string;
|
|
304
|
+
_tags?: string[];
|
|
305
|
+
}
|
|
188
306
|
export interface Error {
|
|
189
307
|
/**
|
|
190
308
|
* Error message
|
|
191
309
|
*/
|
|
192
310
|
message: string;
|
|
193
311
|
}
|
|
312
|
+
export interface File {
|
|
313
|
+
[name: string]: any;
|
|
314
|
+
_id: string;
|
|
315
|
+
filename: string;
|
|
316
|
+
mime_type: string;
|
|
317
|
+
versions: {
|
|
318
|
+
[name: string]: any;
|
|
319
|
+
s3ref: {
|
|
320
|
+
bucket: string;
|
|
321
|
+
key: string;
|
|
322
|
+
};
|
|
323
|
+
}[];
|
|
324
|
+
_schema: string;
|
|
325
|
+
_org: string;
|
|
326
|
+
_created_at: string; // date-time
|
|
327
|
+
_updated_at: string; // date-time
|
|
328
|
+
_title?: string;
|
|
329
|
+
$relation?: EntityRelation;
|
|
330
|
+
}
|
|
194
331
|
/**
|
|
195
332
|
* A set of key-value pairs.
|
|
196
333
|
*/
|
|
@@ -476,6 +613,7 @@ declare namespace Components {
|
|
|
476
613
|
name?: string;
|
|
477
614
|
_id?: string;
|
|
478
615
|
_title?: string;
|
|
616
|
+
_availability_files?: File[];
|
|
479
617
|
}
|
|
480
618
|
/**
|
|
481
619
|
* An amount associated with a specific recurrence.
|
|
@@ -600,6 +738,36 @@ declare namespace Components {
|
|
|
600
738
|
}
|
|
601
739
|
}
|
|
602
740
|
declare namespace Paths {
|
|
741
|
+
namespace $AvailabilityCheck {
|
|
742
|
+
export interface HeaderParameters {
|
|
743
|
+
"X-Ivy-Org-ID": Parameters.XIvyOrgID;
|
|
744
|
+
}
|
|
745
|
+
namespace Parameters {
|
|
746
|
+
export type XIvyOrgID = string;
|
|
747
|
+
}
|
|
748
|
+
export type RequestBody = /* Availability check request payload */ Components.Schemas.AvailabilityCheckParams;
|
|
749
|
+
namespace Responses {
|
|
750
|
+
export type $200 = /**
|
|
751
|
+
* The availability check result payload
|
|
752
|
+
* example:
|
|
753
|
+
* {
|
|
754
|
+
* "available_products": [],
|
|
755
|
+
* "check_results": [
|
|
756
|
+
* {
|
|
757
|
+
* "product_id": "my-product-id-123-1",
|
|
758
|
+
* "matching_hits": 0
|
|
759
|
+
* },
|
|
760
|
+
* {
|
|
761
|
+
* "product_id": "my-product-id-123-2",
|
|
762
|
+
* "matching_hits": 0
|
|
763
|
+
* }
|
|
764
|
+
* ]
|
|
765
|
+
* }
|
|
766
|
+
*/
|
|
767
|
+
Components.Schemas.AvailabilityResult;
|
|
768
|
+
export type $400 = Components.Schemas.Error;
|
|
769
|
+
}
|
|
770
|
+
}
|
|
603
771
|
namespace $CheckoutCart {
|
|
604
772
|
export interface HeaderParameters {
|
|
605
773
|
"X-Ivy-Org-ID": Parameters.XIvyOrgID;
|
|
@@ -640,7 +808,18 @@ declare namespace Paths {
|
|
|
640
808
|
* "q": "_id:1233432 OR _id:123432454 OR _id:23445433",
|
|
641
809
|
* "sort": "description ASC",
|
|
642
810
|
* "from": 0,
|
|
643
|
-
* "size": 200
|
|
811
|
+
* "size": 200,
|
|
812
|
+
* "availability": {
|
|
813
|
+
* "location": {
|
|
814
|
+
* "postal_code": "57008,",
|
|
815
|
+
* "city": "Cologne,",
|
|
816
|
+
* "street": "Media Park,",
|
|
817
|
+
* "street_number": "8a"
|
|
818
|
+
* },
|
|
819
|
+
* "available_date": {
|
|
820
|
+
* "value": "2022-05-01"
|
|
821
|
+
* }
|
|
822
|
+
* }
|
|
644
823
|
* }
|
|
645
824
|
*/
|
|
646
825
|
Components.Schemas.CatalogSearch;
|
|
@@ -700,6 +879,16 @@ export interface OperationMethods {
|
|
|
700
879
|
data?: Paths.$SearchCatalog.RequestBody,
|
|
701
880
|
config?: AxiosRequestConfig
|
|
702
881
|
): OperationResponse<Paths.$SearchCatalog.Responses.$200>
|
|
882
|
+
/**
|
|
883
|
+
* $availabilityCheck - availabilityCheck
|
|
884
|
+
*
|
|
885
|
+
* The availability check endpoint
|
|
886
|
+
*/
|
|
887
|
+
'$availabilityCheck'(
|
|
888
|
+
parameters?: Parameters<Paths.$AvailabilityCheck.HeaderParameters> | null,
|
|
889
|
+
data?: Paths.$AvailabilityCheck.RequestBody,
|
|
890
|
+
config?: AxiosRequestConfig
|
|
891
|
+
): OperationResponse<Paths.$AvailabilityCheck.Responses.$200>
|
|
703
892
|
/**
|
|
704
893
|
* $createOpportunity - createOpportunity
|
|
705
894
|
*
|
|
@@ -750,6 +939,18 @@ export interface PathsDictionary {
|
|
|
750
939
|
config?: AxiosRequestConfig
|
|
751
940
|
): OperationResponse<Paths.$SearchCatalog.Responses.$200>
|
|
752
941
|
}
|
|
942
|
+
['/v1/public/availability:check']: {
|
|
943
|
+
/**
|
|
944
|
+
* $availabilityCheck - availabilityCheck
|
|
945
|
+
*
|
|
946
|
+
* The availability check endpoint
|
|
947
|
+
*/
|
|
948
|
+
'post'(
|
|
949
|
+
parameters?: Parameters<Paths.$AvailabilityCheck.HeaderParameters> | null,
|
|
950
|
+
data?: Paths.$AvailabilityCheck.RequestBody,
|
|
951
|
+
config?: AxiosRequestConfig
|
|
952
|
+
): OperationResponse<Paths.$AvailabilityCheck.Responses.$200>
|
|
953
|
+
}
|
|
753
954
|
['/v1/public/opportunity']: {
|
|
754
955
|
/**
|
|
755
956
|
* $createOpportunity - createOpportunity
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@epilot/pricing-client",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.10.0",
|
|
4
4
|
"description": "Client for epilot Pricing APIs",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -63,5 +63,5 @@
|
|
|
63
63
|
"webpack": "~5.18.0",
|
|
64
64
|
"webpack-cli": "^4.4.0"
|
|
65
65
|
},
|
|
66
|
-
"gitHead": "
|
|
66
|
+
"gitHead": "23ae1836081b6c05cc2f9f05649cf10ab4c430c8"
|
|
67
67
|
}
|
package/src/openapi.d.ts
CHANGED
|
@@ -36,6 +36,100 @@ declare namespace Components {
|
|
|
36
36
|
*/
|
|
37
37
|
additional_info?: string;
|
|
38
38
|
}
|
|
39
|
+
/**
|
|
40
|
+
* Availability check request payload
|
|
41
|
+
*/
|
|
42
|
+
export interface AvailabilityCheckParams {
|
|
43
|
+
/**
|
|
44
|
+
* Products to check availability
|
|
45
|
+
*/
|
|
46
|
+
products: string[];
|
|
47
|
+
filters: /* Availability filters dimensions */ AvailabilityFilters;
|
|
48
|
+
}
|
|
49
|
+
export interface AvailabilityDate {
|
|
50
|
+
/**
|
|
51
|
+
* The availability interval start date
|
|
52
|
+
* example:
|
|
53
|
+
* 2017-07-21
|
|
54
|
+
*/
|
|
55
|
+
available_start_date?: string; // date
|
|
56
|
+
/**
|
|
57
|
+
* The availability interval end date
|
|
58
|
+
* example:
|
|
59
|
+
* 2017-07-21
|
|
60
|
+
*/
|
|
61
|
+
available_end_date?: string; // date
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* Availability filters dimensions
|
|
65
|
+
*/
|
|
66
|
+
export interface AvailabilityFilters {
|
|
67
|
+
location: AvailabilityLocation;
|
|
68
|
+
/**
|
|
69
|
+
* A value to be matched against the availability window (start & end date)
|
|
70
|
+
* example:
|
|
71
|
+
* 2017-07-21
|
|
72
|
+
*/
|
|
73
|
+
available_date?: string; // date
|
|
74
|
+
}
|
|
75
|
+
export interface AvailabilityLocation {
|
|
76
|
+
/**
|
|
77
|
+
* The first line of the address. Typically the street address or PO Box number.
|
|
78
|
+
*/
|
|
79
|
+
street?: string;
|
|
80
|
+
/**
|
|
81
|
+
* The second line of the address. Typically the number of the apartment, suite, or unit.
|
|
82
|
+
*/
|
|
83
|
+
street_number?: string;
|
|
84
|
+
/**
|
|
85
|
+
* The postal code for the address.
|
|
86
|
+
*/
|
|
87
|
+
postal_code?: string;
|
|
88
|
+
/**
|
|
89
|
+
* The name of the city, district, village, or town.
|
|
90
|
+
*/
|
|
91
|
+
city?: string;
|
|
92
|
+
/**
|
|
93
|
+
* The name of the country.
|
|
94
|
+
*/
|
|
95
|
+
country?: string;
|
|
96
|
+
}
|
|
97
|
+
/**
|
|
98
|
+
* The availability check result payload
|
|
99
|
+
* example:
|
|
100
|
+
* {
|
|
101
|
+
* "available_products": [],
|
|
102
|
+
* "check_results": [
|
|
103
|
+
* {
|
|
104
|
+
* "product_id": "my-product-id-123-1",
|
|
105
|
+
* "matching_hits": 0
|
|
106
|
+
* },
|
|
107
|
+
* {
|
|
108
|
+
* "product_id": "my-product-id-123-2",
|
|
109
|
+
* "matching_hits": 0
|
|
110
|
+
* }
|
|
111
|
+
* ]
|
|
112
|
+
* }
|
|
113
|
+
*/
|
|
114
|
+
export interface AvailabilityResult {
|
|
115
|
+
available_products: string[];
|
|
116
|
+
/**
|
|
117
|
+
* The check result details
|
|
118
|
+
*/
|
|
119
|
+
check_results?: {
|
|
120
|
+
product_id: string;
|
|
121
|
+
/**
|
|
122
|
+
* The number of rules matched
|
|
123
|
+
*/
|
|
124
|
+
matching_hits?: number;
|
|
125
|
+
/**
|
|
126
|
+
* A set of matching errors when checking availability
|
|
127
|
+
*/
|
|
128
|
+
matching_error?: {
|
|
129
|
+
[name: string]: any;
|
|
130
|
+
};
|
|
131
|
+
}[];
|
|
132
|
+
}
|
|
39
133
|
export type BillingPeriod = "weekly" | "monthly" | "every_quarter" | "every_6_months" | "yearly" | "one_time";
|
|
40
134
|
/**
|
|
41
135
|
* Supports shopping for products and services until ready for checkout.
|
|
@@ -82,6 +176,7 @@ declare namespace Components {
|
|
|
82
176
|
customer?: Customer;
|
|
83
177
|
billing_address?: Address;
|
|
84
178
|
delivery_address?: Address;
|
|
179
|
+
additional_addresses?: Address[];
|
|
85
180
|
payment_method?: /**
|
|
86
181
|
* A PaymentMethod represent your customer's payment instruments.
|
|
87
182
|
*
|
|
@@ -94,6 +189,12 @@ declare namespace Components {
|
|
|
94
189
|
files?: string[];
|
|
95
190
|
status?: /* The order status */ OrderStatus;
|
|
96
191
|
tags?: string[];
|
|
192
|
+
journey_data?: {
|
|
193
|
+
[name: string]: any;
|
|
194
|
+
};
|
|
195
|
+
consents?: {
|
|
196
|
+
[name: string]: any;
|
|
197
|
+
};
|
|
97
198
|
}
|
|
98
199
|
/**
|
|
99
200
|
* A catalog search payload
|
|
@@ -102,7 +203,18 @@ declare namespace Components {
|
|
|
102
203
|
* "q": "_id:1233432 OR _id:123432454 OR _id:23445433",
|
|
103
204
|
* "sort": "description ASC",
|
|
104
205
|
* "from": 0,
|
|
105
|
-
* "size": 200
|
|
206
|
+
* "size": 200,
|
|
207
|
+
* "availability": {
|
|
208
|
+
* "location": {
|
|
209
|
+
* "postal_code": "57008,",
|
|
210
|
+
* "city": "Cologne,",
|
|
211
|
+
* "street": "Media Park,",
|
|
212
|
+
* "street_number": "8a"
|
|
213
|
+
* },
|
|
214
|
+
* "available_date": {
|
|
215
|
+
* "value": "2022-05-01"
|
|
216
|
+
* }
|
|
217
|
+
* }
|
|
106
218
|
* }
|
|
107
219
|
*/
|
|
108
220
|
export interface CatalogSearch {
|
|
@@ -126,6 +238,7 @@ declare namespace Components {
|
|
|
126
238
|
* When true, enables entity hydration to resolve nested $relation references in-place.
|
|
127
239
|
*/
|
|
128
240
|
hydrate?: boolean;
|
|
241
|
+
availability?: /* Availability filters dimensions */ AvailabilityFilters;
|
|
129
242
|
}
|
|
130
243
|
/**
|
|
131
244
|
* The query result payload
|
|
@@ -185,12 +298,36 @@ declare namespace Components {
|
|
|
185
298
|
email?: string;
|
|
186
299
|
phone?: string;
|
|
187
300
|
}
|
|
301
|
+
export interface EntityRelation {
|
|
302
|
+
[name: string]: any;
|
|
303
|
+
entity_id?: string;
|
|
304
|
+
_tags?: string[];
|
|
305
|
+
}
|
|
188
306
|
export interface Error {
|
|
189
307
|
/**
|
|
190
308
|
* Error message
|
|
191
309
|
*/
|
|
192
310
|
message: string;
|
|
193
311
|
}
|
|
312
|
+
export interface File {
|
|
313
|
+
[name: string]: any;
|
|
314
|
+
_id: string;
|
|
315
|
+
filename: string;
|
|
316
|
+
mime_type: string;
|
|
317
|
+
versions: {
|
|
318
|
+
[name: string]: any;
|
|
319
|
+
s3ref: {
|
|
320
|
+
bucket: string;
|
|
321
|
+
key: string;
|
|
322
|
+
};
|
|
323
|
+
}[];
|
|
324
|
+
_schema: string;
|
|
325
|
+
_org: string;
|
|
326
|
+
_created_at: string; // date-time
|
|
327
|
+
_updated_at: string; // date-time
|
|
328
|
+
_title?: string;
|
|
329
|
+
$relation?: EntityRelation;
|
|
330
|
+
}
|
|
194
331
|
/**
|
|
195
332
|
* A set of key-value pairs.
|
|
196
333
|
*/
|
|
@@ -476,6 +613,7 @@ declare namespace Components {
|
|
|
476
613
|
name?: string;
|
|
477
614
|
_id?: string;
|
|
478
615
|
_title?: string;
|
|
616
|
+
_availability_files?: File[];
|
|
479
617
|
}
|
|
480
618
|
/**
|
|
481
619
|
* An amount associated with a specific recurrence.
|
|
@@ -600,6 +738,36 @@ declare namespace Components {
|
|
|
600
738
|
}
|
|
601
739
|
}
|
|
602
740
|
declare namespace Paths {
|
|
741
|
+
namespace $AvailabilityCheck {
|
|
742
|
+
export interface HeaderParameters {
|
|
743
|
+
"X-Ivy-Org-ID": Parameters.XIvyOrgID;
|
|
744
|
+
}
|
|
745
|
+
namespace Parameters {
|
|
746
|
+
export type XIvyOrgID = string;
|
|
747
|
+
}
|
|
748
|
+
export type RequestBody = /* Availability check request payload */ Components.Schemas.AvailabilityCheckParams;
|
|
749
|
+
namespace Responses {
|
|
750
|
+
export type $200 = /**
|
|
751
|
+
* The availability check result payload
|
|
752
|
+
* example:
|
|
753
|
+
* {
|
|
754
|
+
* "available_products": [],
|
|
755
|
+
* "check_results": [
|
|
756
|
+
* {
|
|
757
|
+
* "product_id": "my-product-id-123-1",
|
|
758
|
+
* "matching_hits": 0
|
|
759
|
+
* },
|
|
760
|
+
* {
|
|
761
|
+
* "product_id": "my-product-id-123-2",
|
|
762
|
+
* "matching_hits": 0
|
|
763
|
+
* }
|
|
764
|
+
* ]
|
|
765
|
+
* }
|
|
766
|
+
*/
|
|
767
|
+
Components.Schemas.AvailabilityResult;
|
|
768
|
+
export type $400 = Components.Schemas.Error;
|
|
769
|
+
}
|
|
770
|
+
}
|
|
603
771
|
namespace $CheckoutCart {
|
|
604
772
|
export interface HeaderParameters {
|
|
605
773
|
"X-Ivy-Org-ID": Parameters.XIvyOrgID;
|
|
@@ -640,7 +808,18 @@ declare namespace Paths {
|
|
|
640
808
|
* "q": "_id:1233432 OR _id:123432454 OR _id:23445433",
|
|
641
809
|
* "sort": "description ASC",
|
|
642
810
|
* "from": 0,
|
|
643
|
-
* "size": 200
|
|
811
|
+
* "size": 200,
|
|
812
|
+
* "availability": {
|
|
813
|
+
* "location": {
|
|
814
|
+
* "postal_code": "57008,",
|
|
815
|
+
* "city": "Cologne,",
|
|
816
|
+
* "street": "Media Park,",
|
|
817
|
+
* "street_number": "8a"
|
|
818
|
+
* },
|
|
819
|
+
* "available_date": {
|
|
820
|
+
* "value": "2022-05-01"
|
|
821
|
+
* }
|
|
822
|
+
* }
|
|
644
823
|
* }
|
|
645
824
|
*/
|
|
646
825
|
Components.Schemas.CatalogSearch;
|
|
@@ -700,6 +879,16 @@ export interface OperationMethods {
|
|
|
700
879
|
data?: Paths.$SearchCatalog.RequestBody,
|
|
701
880
|
config?: AxiosRequestConfig
|
|
702
881
|
): OperationResponse<Paths.$SearchCatalog.Responses.$200>
|
|
882
|
+
/**
|
|
883
|
+
* $availabilityCheck - availabilityCheck
|
|
884
|
+
*
|
|
885
|
+
* The availability check endpoint
|
|
886
|
+
*/
|
|
887
|
+
'$availabilityCheck'(
|
|
888
|
+
parameters?: Parameters<Paths.$AvailabilityCheck.HeaderParameters> | null,
|
|
889
|
+
data?: Paths.$AvailabilityCheck.RequestBody,
|
|
890
|
+
config?: AxiosRequestConfig
|
|
891
|
+
): OperationResponse<Paths.$AvailabilityCheck.Responses.$200>
|
|
703
892
|
/**
|
|
704
893
|
* $createOpportunity - createOpportunity
|
|
705
894
|
*
|
|
@@ -750,6 +939,18 @@ export interface PathsDictionary {
|
|
|
750
939
|
config?: AxiosRequestConfig
|
|
751
940
|
): OperationResponse<Paths.$SearchCatalog.Responses.$200>
|
|
752
941
|
}
|
|
942
|
+
['/v1/public/availability:check']: {
|
|
943
|
+
/**
|
|
944
|
+
* $availabilityCheck - availabilityCheck
|
|
945
|
+
*
|
|
946
|
+
* The availability check endpoint
|
|
947
|
+
*/
|
|
948
|
+
'post'(
|
|
949
|
+
parameters?: Parameters<Paths.$AvailabilityCheck.HeaderParameters> | null,
|
|
950
|
+
data?: Paths.$AvailabilityCheck.RequestBody,
|
|
951
|
+
config?: AxiosRequestConfig
|
|
952
|
+
): OperationResponse<Paths.$AvailabilityCheck.Responses.$200>
|
|
953
|
+
}
|
|
753
954
|
['/v1/public/opportunity']: {
|
|
754
955
|
/**
|
|
755
956
|
* $createOpportunity - createOpportunity
|