@epilot/pricing-client 3.47.3 → 3.48.0-alpha.0

package/dist/openapi.d.ts

@@ -464,6 +464,10 @@ declare namespace Components {
              * An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name.
              */
             description?: string;
+            /**
+             * A detailed description of the price. This is shown on the order document and order table.
+             */
+            long_description?: string;
             price_mappings?: /**
              * example:
              * [
@@ -778,6 +782,10 @@ declare namespace Components {
              * An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name.
              */
             description?: string;
+            /**
+             * A detailed description of the price. This is shown on the order document and order table.
+             */
+            long_description?: string;
             /**
              * Price mapping information required to compute totals
              */
@@ -927,6 +935,10 @@ declare namespace Components {
              * An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name.
              */
             description?: string;
+            /**
+             * A detailed description of the price. This is shown on the order document and order table.
+             */
+            long_description?: string;
             price_mappings?: /**
              * example:
              * [
@@ -1109,9 +1121,6 @@ declare namespace Components {
              */
             Coupon)[];
         }
-        /**
-         * The basic auth credentials
-         */
         export interface BasicAuthCredentials {
             /**
              * The username
@@ -1125,6 +1134,21 @@ declare namespace Components {
              * 123456
              */
             password: string;
+        }
+        export interface BasicAuthIntegration {
+            /**
+             * The username
+             * example:
+             * username
+             */
+            username: string;
+            /**
+             * The password
+             * example:
+             * 123456
+             */
+            password: string;
+            auth_type?: "basic_auth";
             /**
              * The base URL
              * example:
@@ -1596,6 +1620,10 @@ declare namespace Components {
              * An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name.
              */
             description?: string;
+            /**
+             * A detailed description of the price. This is shown on the order document and order table.
+             */
+            long_description?: string;
             price_mappings?: /**
              * example:
              * [
@@ -1922,6 +1950,10 @@ declare namespace Components {
              * An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name.
              */
             description?: string;
+            /**
+             * A detailed description of the price. This is shown on the order document and order table.
+             */
+            long_description?: string;
             price_mappings?: /**
              * example:
              * [
@@ -2831,7 +2863,11 @@ declare namespace Components {
             bidding_zone: /* The bidding zone for a spot market price. */ SpotMarketBiddingZone;
             prices: /* A market price at a given point in time. */ HistoricMarketPriceRecord[];
         }
-        export type IntegrationCredentialsResult = /* The basic auth credentials */ BasicAuthCredentials;
+        /**
+         * The auth credentials for external integrations
+         */
+        export type IntegrationAuthCredentials = /* The auth credentials for external integrations */ BasicAuthIntegration | OAuthIntegration;
+        export type IntegrationCredentialsResult = /* The auth credentials for external integrations */ IntegrationAuthCredentials;
         export type IntegrationId = "getag" | "ikom";
         export interface JourneyContext {
             /**
@@ -2919,6 +2955,64 @@ declare namespace Components {
              */
             value?: string;
         })[];
+        export interface OAuthCredentials {
+            /**
+             * The OAuth client ID
+             * example:
+             * client_id_123
+             */
+            client_id: string;
+            /**
+             * The OAuth client secret
+             * example:
+             * client_secret_456
+             */
+            client_secret: string;
+            /**
+             * The URL to obtain OAuth tokens
+             * example:
+             * https://api.example.com/oauth/token
+             */
+            authorization_url: string;
+            /**
+             * The OAuth grant type
+             */
+            grant_type: "client_credentials";
+            /**
+             * The OAuth scope
+             * example:
+             * read:user write:user
+             */
+            scope?: string;
+            /**
+             * The OAuth access token
+             * example:
+             * access_token_789
+             */
+            access_token?: string;
+            /**
+             * The expiration time of the OAuth access token in seconds
+             * example:
+             * 3600
+             */
+            access_token_expires_in?: number;
+            /**
+             * The expiration time of the OAuth access token
+             * example:
+             * 1715731200
+             */
+            access_token_expires_at?: number;
+        }
+        export interface OAuthIntegration {
+            auth_type: "oauth";
+            oauth: OAuthCredentials;
+            /**
+             * The base URL
+             * example:
+             * https://api.example.com
+             */
+            base_url?: string;
+        }
         /**
          * The opportunity entity
          * example:
@@ -3793,6 +3887,10 @@ declare namespace Components {
              * An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name.
              */
             description?: string;
+            /**
+             * A detailed description of the price. This is shown on the order document and order table.
+             */
+            long_description?: string;
             price_mappings?: /**
              * example:
              * [
@@ -4129,6 +4227,10 @@ declare namespace Components {
              * An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name.
              */
             description?: string;
+            /**
+             * A detailed description of the price. This is shown on the order document and order table.
+             */
+            long_description?: string;
             price_mappings?: /**
              * example:
              * [
@@ -5107,7 +5209,7 @@ declare namespace Components {
             CouponWithoutPromoCodes[];
         }
         export type SalesTax = "nontaxable" | "reduced" | "standard";
-        export type SaveIntegrationCredentialsParams = /* The basic auth credentials */ BasicAuthCredentials;
+        export type SaveIntegrationCredentialsParams = /* The auth credentials for external integrations */ IntegrationAuthCredentials;
         export interface SearchExternalCatalogParams {
             context: JourneyContext;
         }
@@ -6234,6 +6336,7 @@ export type BasePriceItem = Components.Schemas.BasePriceItem;
 export type BasePriceItemCommon = Components.Schemas.BasePriceItemCommon;
 export type BasePriceItemDto = Components.Schemas.BasePriceItemDto;
 export type BasicAuthCredentials = Components.Schemas.BasicAuthCredentials;
+export type BasicAuthIntegration = Components.Schemas.BasicAuthIntegration;
 export type BillingPeriod = Components.Schemas.BillingPeriod;
 export type Cart = Components.Schemas.Cart;
 export type CartDto = Components.Schemas.CartDto;
@@ -6274,11 +6377,14 @@ export type File = Components.Schemas.File;
 export type GasConcessionType = Components.Schemas.GasConcessionType;
 export type HistoricMarketPriceRecord = Components.Schemas.HistoricMarketPriceRecord;
 export type HistoricMarketPricesResult = Components.Schemas.HistoricMarketPricesResult;
+export type IntegrationAuthCredentials = Components.Schemas.IntegrationAuthCredentials;
 export type IntegrationCredentialsResult = Components.Schemas.IntegrationCredentialsResult;
 export type IntegrationId = Components.Schemas.IntegrationId;
 export type JourneyContext = Components.Schemas.JourneyContext;
 export type MarkupPricingModel = Components.Schemas.MarkupPricingModel;
 export type MetaData = Components.Schemas.MetaData;
+export type OAuthCredentials = Components.Schemas.OAuthCredentials;
+export type OAuthIntegration = Components.Schemas.OAuthIntegration;
 export type Opportunity = Components.Schemas.Opportunity;
 export type OpportunitySource = Components.Schemas.OpportunitySource;
 export type Order = Components.Schemas.Order;

package/dist/openapi.json

@@ -3298,10 +3298,10 @@
         ]
       },
       "IntegrationCredentialsResult": {
-        "$ref": "#/components/schemas/BasicAuthCredentials"
+        "$ref": "#/components/schemas/IntegrationAuthCredentials"
       },
       "SaveIntegrationCredentialsParams": {
-        "$ref": "#/components/schemas/BasicAuthCredentials"
+        "$ref": "#/components/schemas/IntegrationAuthCredentials"
       },
       "ComputePriceParamsBase": {
         "type": "object",
@@ -3733,8 +3733,61 @@
           "unit_amount_currency"
         ]
       },
+      "OAuthCredentials": {
+        "type": "object",
+        "properties": {
+          "client_id": {
+            "description": "The OAuth client ID",
+            "type": "string",
+            "example": "client_id_123"
+          },
+          "client_secret": {
+            "description": "The OAuth client secret",
+            "type": "string",
+            "example": "client_secret_456"
+          },
+          "authorization_url": {
+            "description": "The URL to obtain OAuth tokens",
+            "type": "string",
+            "example": "https://api.example.com/oauth/token"
+          },
+          "grant_type": {
+            "description": "The OAuth grant type",
+            "type": "string",
+            "enum": [
+              "client_credentials"
+            ],
+            "default": "client_credentials"
+          },
+          "scope": {
+            "description": "The OAuth scope",
+            "type": "string",
+            "example": "read:user write:user"
+          },
+          "access_token": {
+            "description": "The OAuth access token",
+            "type": "string",
+            "example": "access_token_789"
+          },
+          "access_token_expires_in": {
+            "description": "The expiration time of the OAuth access token in seconds",
+            "type": "number",
+            "example": 3600
+          },
+          "access_token_expires_at": {
+            "description": "The expiration time of the OAuth access token",
+            "type": "number",
+            "example": 1715731200
+          }
+        },
+        "required": [
+          "client_id",
+          "client_secret",
+          "authorization_url",
+          "grant_type"
+        ]
+      },
       "BasicAuthCredentials": {
-        "description": "The basic auth credentials",
         "type": "object",
         "properties": {
           "username": {
@@ -3746,6 +3799,48 @@
             "description": "The password",
             "type": "string",
             "example": "123456"
+          }
+        },
+        "required": [
+          "username",
+          "password"
+        ]
+      },
+      "BasicAuthIntegration": {
+        "type": "object",
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/BasicAuthCredentials"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "auth_type": {
+                "type": "string",
+                "enum": [
+                  "basic_auth"
+                ]
+              },
+              "base_url": {
+                "description": "The base URL",
+                "type": "string",
+                "example": "https://api.example.com"
+              }
+            }
+          }
+        ]
+      },
+      "OAuthIntegration": {
+        "type": "object",
+        "properties": {
+          "auth_type": {
+            "type": "string",
+            "enum": [
+              "oauth"
+            ]
+          },
+          "oauth": {
+            "$ref": "#/components/schemas/OAuthCredentials"
           },
           "base_url": {
             "description": "The base URL",
@@ -3754,8 +3849,20 @@
           }
         },
         "required": [
-          "username",
-          "password"
+          "auth_type",
+          "oauth"
+        ]
+      },
+      "IntegrationAuthCredentials": {
+        "description": "The auth credentials for external integrations",
+        "type": "object",
+        "oneOf": [
+          {
+            "$ref": "#/components/schemas/BasicAuthIntegration"
+          },
+          {
+            "$ref": "#/components/schemas/OAuthIntegration"
+          }
         ]
       },
       "SearchStreetsResult": {
@@ -3993,6 +4100,10 @@
             "type": "string",
             "description": "An arbitrary string attached to the price item. Often useful for displaying to users. Defaults to product name."
           },
+          "long_description": {
+            "type": "string",
+            "description": "A detailed description of the price. This is shown on the order document and order table."
+          },
           "price_mappings": {
             "description": "Price mapping information required to compute totals",
             "$ref": "#/components/schemas/PriceInputMappings"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/pricing-client",
-  "version": "3.47.3",
+  "version": "3.48.0-alpha.0",
   "description": "Client for epilot Pricing APIs",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",