@epilot/pricing-client 3.27.8 → 3.28.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/openapi.d.ts CHANGED
@@ -3396,6 +3396,15 @@ declare namespace Paths {
3396
3396
  export type $400 = Components.Schemas.Error;
3397
3397
  }
3398
3398
  }
3399
+ namespace $CalculatePricingDetails {
3400
+ export interface RequestBody {
3401
+ line_items?: /* A valid set of product prices, quantities, (discounts) and taxes from a client. */ Components.Schemas.PriceItemsDto;
3402
+ }
3403
+ namespace Responses {
3404
+ export type $200 = /* The result from the calculation of a set of price items. */ Components.Schemas.PricingDetails;
3405
+ export type $400 = Components.Schemas.Error;
3406
+ }
3407
+ }
3399
3408
  namespace $CheckoutCart {
3400
3409
  export interface HeaderParameters {
3401
3410
  "X-Ivy-Org-ID": Parameters.XIvyOrgID;
@@ -3427,33 +3436,6 @@ declare namespace Paths {
3427
3436
  export type $403 = Components.Schemas.Error;
3428
3437
  }
3429
3438
  }
3430
- namespace $CreateOpportunity {
3431
- export interface HeaderParameters {
3432
- "X-Ivy-Org-ID": Parameters.XIvyOrgID;
3433
- }
3434
- namespace Parameters {
3435
- export type XIvyOrgID = string;
3436
- }
3437
- export type RequestBody = /**
3438
- * The opportunity entity
3439
- * example:
3440
- * {
3441
- * "$ref": "#/components/examples/opportunity"
3442
- * }
3443
- */
3444
- Components.Schemas.Opportunity;
3445
- namespace Responses {
3446
- export type $201 = /**
3447
- * The opportunity entity
3448
- * example:
3449
- * {
3450
- * "$ref": "#/components/examples/opportunity"
3451
- * }
3452
- */
3453
- Components.Schemas.Opportunity;
3454
- export type $400 = Components.Schemas.Error;
3455
- }
3456
- }
3457
3439
  namespace $DeleteCredentials {
3458
3440
  namespace Parameters {
3459
3441
  export type IntegrationId = Components.Schemas.IntegrationId;
@@ -3671,6 +3653,16 @@ declare namespace Paths {
3671
3653
  }
3672
3654
 
3673
3655
  export interface OperationMethods {
3656
+ /**
3657
+ * $calculatePricingDetails - calculatePricingDetails
3658
+ *
3659
+ * Compute price
3660
+ */
3661
+ '$calculatePricingDetails'(
3662
+ parameters?: Parameters<UnknownParamsObject> | null,
3663
+ data?: Paths.$CalculatePricingDetails.RequestBody,
3664
+ config?: AxiosRequestConfig
3665
+ ): OperationResponse<Paths.$CalculatePricingDetails.Responses.$200>
3674
3666
  /**
3675
3667
  * createOrder - createOrder
3676
3668
  *
@@ -3812,23 +3804,21 @@ export interface OperationMethods {
3812
3804
  data?: any,
3813
3805
  config?: AxiosRequestConfig
3814
3806
  ): OperationResponse<Paths.$DeleteCredentials.Responses.$204>
3815
- /**
3816
- * $createOpportunity - createOpportunity
3817
- *
3818
- * This API is Deprecated. Please use the Entity API or Submission API to create opportunities.
3819
- *
3820
- * Enables the creation of a new opportunity. During the creation of an opportunity, an unique customer-readable `opportunity_number` will be generated.
3821
- * The `opportunity_number` can be used to universally identify an opportunity within epilot platform.
3822
- *
3823
- */
3824
- '$createOpportunity'(
3825
- parameters?: Parameters<Paths.$CreateOpportunity.HeaderParameters> | null,
3826
- data?: Paths.$CreateOpportunity.RequestBody,
3827
- config?: AxiosRequestConfig
3828
- ): OperationResponse<Paths.$CreateOpportunity.Responses.$201>
3829
3807
  }
3830
3808
 
3831
3809
  export interface PathsDictionary {
3810
+ ['/v1/pricing:compute']: {
3811
+ /**
3812
+ * $calculatePricingDetails - calculatePricingDetails
3813
+ *
3814
+ * Compute price
3815
+ */
3816
+ 'post'(
3817
+ parameters?: Parameters<UnknownParamsObject> | null,
3818
+ data?: Paths.$CalculatePricingDetails.RequestBody,
3819
+ config?: AxiosRequestConfig
3820
+ ): OperationResponse<Paths.$CalculatePricingDetails.Responses.$200>
3821
+ }
3832
3822
  ['/v1/order']: {
3833
3823
  /**
3834
3824
  * createOrder - createOrder
@@ -3996,22 +3986,6 @@ export interface PathsDictionary {
3996
3986
  config?: AxiosRequestConfig
3997
3987
  ): OperationResponse<Paths.$DeleteCredentials.Responses.$204>
3998
3988
  }
3999
- ['/v1/public/opportunity']: {
4000
- /**
4001
- * $createOpportunity - createOpportunity
4002
- *
4003
- * This API is Deprecated. Please use the Entity API or Submission API to create opportunities.
4004
- *
4005
- * Enables the creation of a new opportunity. During the creation of an opportunity, an unique customer-readable `opportunity_number` will be generated.
4006
- * The `opportunity_number` can be used to universally identify an opportunity within epilot platform.
4007
- *
4008
- */
4009
- 'post'(
4010
- parameters?: Parameters<Paths.$CreateOpportunity.HeaderParameters> | null,
4011
- data?: Paths.$CreateOpportunity.RequestBody,
4012
- config?: AxiosRequestConfig
4013
- ): OperationResponse<Paths.$CreateOpportunity.Responses.$201>
4014
- }
4015
3989
  }
4016
3990
 
4017
3991
  export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
package/dist/openapi.json CHANGED
@@ -111,6 +111,82 @@
111
111
  }
112
112
  ],
113
113
  "paths": {
114
+ "/v1/pricing:compute": {
115
+ "post": {
116
+ "description": "Compute price",
117
+ "summary": "calculatePricingDetails",
118
+ "operationId": "$calculatePricingDetails",
119
+ "tags": [
120
+ "Order API"
121
+ ],
122
+ "requestBody": {
123
+ "required": false,
124
+ "content": {
125
+ "application/json": {
126
+ "schema": {
127
+ "properties": {
128
+ "line_items": {
129
+ "$ref": "#/components/schemas/PriceItemsDto"
130
+ }
131
+ }
132
+ },
133
+ "examples": {
134
+ "Compute price": {
135
+ "value": {
136
+ "line_items": [
137
+ {
138
+ "product_id": "c5695fb5-f02d-4e46-9fb2-a36dc4e9876f",
139
+ "price_id": "396cb5f3-ea0b-4629-99ca-303661de5a9b",
140
+ "quantity": 2
141
+ },
142
+ {
143
+ "product_id": "c5695fb5-f02d-4e46-9fb2-a36dc4e9876f",
144
+ "price_id": "2abe0c6f-63ef-417b-8c85-5546359382d9",
145
+ "quantity": 1,
146
+ "price_mappings": [
147
+ {
148
+ "price_id": "2abe0c6f-63ef-417b-8c85-5546359382d9",
149
+ "frequency_unit": "one_time",
150
+ "value": 2,
151
+ "name": "Estimated consumption",
152
+ "metadata": {
153
+ "journey_title": "P&G",
154
+ "step_name": "Number Inputs"
155
+ }
156
+ }
157
+ ]
158
+ }
159
+ ]
160
+ }
161
+ }
162
+ }
163
+ }
164
+ }
165
+ },
166
+ "responses": {
167
+ "200": {
168
+ "description": "Pricing details result",
169
+ "content": {
170
+ "application/json": {
171
+ "schema": {
172
+ "$ref": "#/components/schemas/PricingDetails"
173
+ }
174
+ }
175
+ }
176
+ },
177
+ "400": {
178
+ "description": "Invalid payload",
179
+ "content": {
180
+ "application/json": {
181
+ "schema": {
182
+ "$ref": "#/components/schemas/Error"
183
+ }
184
+ }
185
+ }
186
+ }
187
+ }
188
+ }
189
+ },
114
190
  "/v1/order": {
115
191
  "post": {
116
192
  "description": "Create an order",
@@ -1353,102 +1429,6 @@
1353
1429
  }
1354
1430
  }
1355
1431
  }
1356
- },
1357
- "/v1/public/opportunity": {
1358
- "post": {
1359
- "deprecated": true,
1360
- "description": "This API is Deprecated. Please use the Entity API or Submission API to create opportunities.\n\nEnables the creation of 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",
1361
- "operationId": "$createOpportunity",
1362
- "summary": "createOpportunity",
1363
- "security": [
1364
- {},
1365
- {
1366
- "EpilotPublicAuth": []
1367
- }
1368
- ],
1369
- "tags": [
1370
- "Deprecated"
1371
- ],
1372
- "parameters": [
1373
- {
1374
- "in": "header",
1375
- "name": "X-Ivy-Org-ID",
1376
- "description": "The target Organization Id represented by the caller",
1377
- "schema": {
1378
- "type": "string"
1379
- },
1380
- "required": true
1381
- }
1382
- ],
1383
- "requestBody": {
1384
- "required": true,
1385
- "content": {
1386
- "application/json": {
1387
- "schema": {
1388
- "$ref": "#/components/schemas/Opportunity"
1389
- },
1390
- "examples": {
1391
- "Opportunity containing one Order": {
1392
- "value": {
1393
- "billing_address": {
1394
- "street": "sdf",
1395
- "street_number": "1",
1396
- "city": "Berlin",
1397
- "postal_code": "12045",
1398
- "country": "de",
1399
- "additional_info": "adasd"
1400
- },
1401
- "delivery_address": {
1402
- "street": "sdf",
1403
- "street_number": "1",
1404
- "city": "Berlin",
1405
- "postal_code": "12045",
1406
- "country": "de",
1407
- "additional_info": "adasd"
1408
- },
1409
- "items": {
1410
- "$relation": [
1411
- {
1412
- "entity_id": "c8dbe8f3-28b6-4d77-aae8-47bc24a2532f",
1413
- "_tags": [
1414
- "journey"
1415
- ]
1416
- }
1417
- ]
1418
- },
1419
- "_tags": [
1420
- "journey",
1421
- "ORWNr4iCN"
1422
- ]
1423
- }
1424
- }
1425
- }
1426
- }
1427
- }
1428
- },
1429
- "responses": {
1430
- "201": {
1431
- "description": "The new Opportunity.",
1432
- "content": {
1433
- "application/json": {
1434
- "schema": {
1435
- "$ref": "#/components/schemas/Opportunity"
1436
- }
1437
- }
1438
- }
1439
- },
1440
- "400": {
1441
- "description": "Invalid payload",
1442
- "content": {
1443
- "application/json": {
1444
- "schema": {
1445
- "$ref": "#/components/schemas/Error"
1446
- }
1447
- }
1448
- }
1449
- }
1450
- }
1451
- }
1452
1432
  }
1453
1433
  },
1454
1434
  "components": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/pricing-client",
3
- "version": "3.27.8",
3
+ "version": "3.28.0",
4
4
  "description": "Client for epilot Pricing APIs",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",