@epilot/erp-integration-client 0.7.0 → 0.9.0

package/dist/definition.js

@@ -1 +1 @@
-(()=>{"use strict";var e={330:function(e,t,n){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var o=r(n(466));t.default=o.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v1/erp/tracking/acknowledgement":{"post":{"operationId":"acknowledgeTracking","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/erp/trigger":{"post":{"operationId":"triggerErp","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/erp/updates/events":{"post":{"operationId":"processErpUpdatesEvents","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/erp/updates/events":{"post":{"operationId":"processErpUpdatesEventsV2","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/erp/updates/mapping_simulation":{"post":{"operationId":"simulateMapping","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations":{"get":{"operationId":"listIntegrations","responses":{}},"post":{"operationId":"createIntegration","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations/{integrationId}":{"get":{"operationId":"getIntegration","parameters":[{"name":"integrationId","in":"path","required":true}],"responses":{}},"put":{"operationId":"updateIntegration","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteIntegration","parameters":[{"name":"integrationId","in":"path","required":true}],"responses":{}}},"/v1/integrations/{integrationId}/use-cases":{"get":{"operationId":"listUseCases","parameters":[{"name":"integrationId","in":"path","required":true}],"responses":{}},"post":{"operationId":"createUseCase","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations/{integrationId}/use-cases/{useCaseId}":{"get":{"operationId":"getUseCase","parameters":[{"name":"integrationId","in":"path","required":true},{"name":"useCaseId","in":"path","required":true}],"responses":{}},"put":{"operationId":"updateUseCase","parameters":[{"name":"integrationId","in":"path","required":true},{"name":"useCaseId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteUseCase","parameters":[{"name":"integrationId","in":"path","required":true},{"name":"useCaseId","in":"path","required":true}],"responses":{}}},"/v1/integrations/{integrationId}/app-mapping":{"put":{"operationId":"setIntegrationAppMapping","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteIntegrationAppMapping","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}}},"components":{"responses":{"BadRequest":{"content":{"application/json":{}}},"Unauthorized":{"content":{"application/json":{}}},"InternalServerError":{"content":{"application/json":{}}},"ERPUpdatesResponse":{"content":{"application/json":{}}},"TriggerWebhookResponse":{"content":{"application/json":{}}}}},"servers":[{"url":"https://erp-integration-api.sls.epilot.io"}]}')}},t={},n=function n(r){var o=t[r];if(void 0!==o)return o.exports;var s=t[r]={exports:{}};return e[r].call(s.exports,s,s.exports,n),s.exports}(330),r=exports;for(var o in n)r[o]=n[o];n.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
+(()=>{"use strict";var e={390:function(e,t,r){var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var s=n(r(466));t.default=s.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v1/erp/tracking/acknowledgement":{"post":{"operationId":"acknowledgeTracking","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/erp/trigger":{"post":{"operationId":"triggerErp","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/erp/updates/events":{"post":{"operationId":"processErpUpdatesEvents","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/erp/updates/events":{"post":{"operationId":"processErpUpdatesEventsV2","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/erp/updates/mapping_simulation":{"post":{"operationId":"simulateMapping","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations":{"get":{"operationId":"listIntegrations","responses":{}},"post":{"operationId":"createIntegration","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations/{integrationId}":{"get":{"operationId":"getIntegration","parameters":[{"name":"integrationId","in":"path","required":true}],"responses":{}},"put":{"operationId":"updateIntegration","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteIntegration","parameters":[{"name":"integrationId","in":"path","required":true}],"responses":{}}},"/v1/integrations/{integrationId}/use-cases":{"get":{"operationId":"listUseCases","parameters":[{"name":"integrationId","in":"path","required":true}],"responses":{}},"post":{"operationId":"createUseCase","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations/{integrationId}/use-cases/{useCaseId}":{"get":{"operationId":"getUseCase","parameters":[{"name":"integrationId","in":"path","required":true},{"name":"useCaseId","in":"path","required":true}],"responses":{}},"put":{"operationId":"updateUseCase","parameters":[{"name":"integrationId","in":"path","required":true},{"name":"useCaseId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteUseCase","parameters":[{"name":"integrationId","in":"path","required":true},{"name":"useCaseId","in":"path","required":true}],"responses":{}}},"/v1/integrations/{integrationId}/use-cases/{useCaseId}/history":{"get":{"operationId":"listUseCaseHistory","parameters":[{"name":"integrationId","in":"path","required":true},{"name":"useCaseId","in":"path","required":true},{"name":"cursor","in":"query","required":false}],"responses":{}}},"/v1/integrations/{integrationId}/app-mapping":{"put":{"operationId":"setIntegrationAppMapping","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteIntegrationAppMapping","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}}},"components":{"responses":{"BadRequest":{"content":{"application/json":{}}},"Unauthorized":{"content":{"application/json":{}}},"InternalServerError":{"content":{"application/json":{}}},"ERPUpdatesResponse":{"content":{"application/json":{}}},"TriggerWebhookResponse":{"content":{"application/json":{}}}}},"servers":[{"url":"https://erp-integration-api.sls.epilot.io"}]}')}},t={},r=function r(n){var s=t[n];if(void 0!==s)return s.exports;var a=t[n]={exports:{}};return e[n].call(a.exports,a,a.exports,r),a.exports}(390),n=exports;for(var s in r)n[s]=r[s];r.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();

package/dist/openapi-runtime.json

@@ -205,6 +205,29 @@
         "responses": {}
       }
     },
+    "/v1/integrations/{integrationId}/use-cases/{useCaseId}/history": {
+      "get": {
+        "operationId": "listUseCaseHistory",
+        "parameters": [
+          {
+            "name": "integrationId",
+            "in": "path",
+            "required": true
+          },
+          {
+            "name": "useCaseId",
+            "in": "path",
+            "required": true
+          },
+          {
+            "name": "cursor",
+            "in": "query",
+            "required": false
+          }
+        ],
+        "responses": {}
+      }
+    },
     "/v1/integrations/{integrationId}/app-mapping": {
       "put": {
         "operationId": "setIntegrationAppMapping",

package/dist/openapi.d.ts

@@ -29,6 +29,21 @@ declare namespace Components {
         export type Unauthorized = Schemas.ErrorResponseBase;
     }
     namespace Schemas {
+        export interface CreateInboundUseCaseRequest {
+            /**
+             * Use case name
+             */
+            name: string;
+            /**
+             * Whether the use case is enabled
+             */
+            enabled: boolean;
+            /**
+             * Use case type
+             */
+            type: "inbound";
+            configuration?: /* Configuration for inbound use cases (ERP to epilot) */ InboundIntegrationEventConfiguration;
+        }
         export interface CreateIntegrationRequest {
             /**
              * Integration name
@@ -39,25 +54,31 @@ declare namespace Components {
              */
             description?: string;
         }
-        export interface CreateUseCaseRequest {
+        export interface CreateOutboundUseCaseRequest {
             /**
              * Use case name
              */
             name: string;
+            /**
+             * Whether the use case is enabled
+             */
+            enabled: boolean;
             /**
              * Use case type
              */
-            type: "inbound" | "outbound";
+            type: "outbound";
+            configuration?: /* Configuration for outbound use cases (epilot to ERP). Structure TBD. */ OutboundIntegrationEventConfiguration;
+        }
+        export type CreateUseCaseRequest = CreateInboundUseCaseRequest | CreateOutboundUseCaseRequest;
+        export interface CreateUseCaseRequestBase {
             /**
-             * Whether the use case is enabled
+             * Use case name
              */
-            enabled: boolean;
+            name: string;
             /**
-             * Use case specific configuration
+             * Whether the use case is enabled
              */
-            configuration?: {
-                [name: string]: any;
-            };
+            enabled: boolean;
         }
         export interface DeleteIntegrationAppMappingRequest {
             /**
@@ -142,6 +163,19 @@ declare namespace Components {
              */
             message?: string;
         }
+        /**
+         * Configuration for inbound use cases (ERP to epilot)
+         */
+        export interface InboundIntegrationEventConfiguration {
+            /**
+             * Array of entity configurations for this event
+             */
+            entities?: IntegrationEntity[];
+            /**
+             * Array of meter reading configurations for this event
+             */
+            meter_readings?: IntegrationMeterReading[];
+        }
         export interface InboundUseCase {
             /**
              * Unique identifier for the use case
@@ -163,7 +197,11 @@ declare namespace Components {
              * Whether the use case is enabled
              */
             enabled: boolean;
-            configuration?: IntegrationEvent;
+            configuration?: /* Configuration for inbound use cases (ERP to epilot) */ InboundIntegrationEventConfiguration;
+            /**
+             * Description of the last change made to this use case
+             */
+            change_description?: string;
             /**
              * ISO-8601 timestamp when the use case was created
              */
@@ -173,6 +211,49 @@ declare namespace Components {
              */
             updated_at: string; // date-time
         }
+        export interface InboundUseCaseHistoryEntry {
+            /**
+             * Unique identifier for this history entry
+             */
+            id: string; // uuid
+            /**
+             * Reference to the parent use case
+             */
+            useCaseId: string; // uuid
+            /**
+             * Parent integration ID
+             */
+            integrationId: string; // uuid
+            /**
+             * Use case name at this point in history
+             */
+            name: string;
+            /**
+             * Whether the use case was enabled at this point in history
+             */
+            enabled: boolean;
+            /**
+             * Description of the change that was made at this point in history
+             */
+            change_description?: string;
+            /**
+             * ISO-8601 timestamp when the use case was originally created
+             */
+            created_at: string; // date-time
+            /**
+             * ISO-8601 timestamp of this historical snapshot (before the update)
+             */
+            updated_at: string; // date-time
+            /**
+             * ISO-8601 timestamp when this history entry was created
+             */
+            history_created_at: string; // date-time
+            /**
+             * Use case type
+             */
+            type: "inbound";
+            configuration?: /* Configuration for inbound use cases (ERP to epilot) */ InboundIntegrationEventConfiguration;
+        }
         export interface Integration {
             /**
              * Unique identifier for the integration
@@ -229,7 +310,7 @@ declare namespace Components {
                  * [v2.0] Event type mappings
                  */
                 events: {
-                    [name: string]: IntegrationEvent;
+                    [name: string]: /* Configuration for inbound use cases (ERP to epilot) */ InboundIntegrationEventConfiguration;
                 };
             };
         }
@@ -278,16 +359,6 @@ declare namespace Components {
             enabled?: /* Controls whether this field mapping should be processed. Can be a boolean or a JSONata expression (string) that evaluates to a boolean. Defaults to true if omitted. */ boolean | string;
             relations?: RelationConfig;
         }
-        export interface IntegrationEvent {
-            /**
-             * Array of entity configurations for this event
-             */
-            entities?: IntegrationEntity[];
-            /**
-             * Array of meter reading configurations for this event
-             */
-            meter_readings?: IntegrationMeterReading[];
-        }
         export interface IntegrationFieldV1 {
             /**
              * Target entity slug
@@ -389,6 +460,12 @@ declare namespace Components {
                 ...RelationUniqueIdField[]
             ];
         }
+        /**
+         * Configuration for outbound use cases (epilot to ERP). Structure TBD.
+         */
+        export interface OutboundIntegrationEventConfiguration {
+            [name: string]: any;
+        }
         export interface OutboundUseCase {
             /**
              * Unique identifier for the use case
@@ -410,12 +487,11 @@ declare namespace Components {
              * Whether the use case is enabled
              */
             enabled: boolean;
+            configuration?: /* Configuration for outbound use cases (epilot to ERP). Structure TBD. */ OutboundIntegrationEventConfiguration;
             /**
-             * Use case specific configuration
+             * Description of the last change made to this use case
              */
-            configuration?: {
-                [name: string]: any;
-            };
+            change_description?: string;
             /**
              * ISO-8601 timestamp when the use case was created
              */
@@ -425,6 +501,49 @@ declare namespace Components {
              */
             updated_at: string; // date-time
         }
+        export interface OutboundUseCaseHistoryEntry {
+            /**
+             * Unique identifier for this history entry
+             */
+            id: string; // uuid
+            /**
+             * Reference to the parent use case
+             */
+            useCaseId: string; // uuid
+            /**
+             * Parent integration ID
+             */
+            integrationId: string; // uuid
+            /**
+             * Use case name at this point in history
+             */
+            name: string;
+            /**
+             * Whether the use case was enabled at this point in history
+             */
+            enabled: boolean;
+            /**
+             * Description of the change that was made at this point in history
+             */
+            change_description?: string;
+            /**
+             * ISO-8601 timestamp when the use case was originally created
+             */
+            created_at: string; // date-time
+            /**
+             * ISO-8601 timestamp of this historical snapshot (before the update)
+             */
+            updated_at: string; // date-time
+            /**
+             * ISO-8601 timestamp when this history entry was created
+             */
+            history_created_at: string; // date-time
+            /**
+             * Use case type
+             */
+            type: "outbound";
+            configuration?: /* Configuration for outbound use cases (epilot to ERP). Structure TBD. */ OutboundIntegrationEventConfiguration;
+        }
         export interface RelationConfig {
             /**
              * Relation operation:
@@ -542,6 +661,25 @@ declare namespace Components {
             end_date?: string;
             event_id?: string;
         }
+        export interface UpdateInboundUseCaseRequest {
+            /**
+             * Use case name
+             */
+            name?: string;
+            /**
+             * Whether the use case is enabled
+             */
+            enabled?: boolean;
+            /**
+             * Optional description of this change (like a commit message)
+             */
+            change_description?: string;
+            /**
+             * Use case type
+             */
+            type?: "inbound";
+            configuration?: /* Configuration for inbound use cases (ERP to epilot) */ InboundIntegrationEventConfiguration;
+        }
         export interface UpdateIntegrationRequest {
             /**
              * Integration name
@@ -552,27 +690,80 @@ declare namespace Components {
              */
             description?: string;
         }
-        export interface UpdateUseCaseRequest {
+        export interface UpdateOutboundUseCaseRequest {
             /**
              * Use case name
              */
             name?: string;
+            /**
+             * Whether the use case is enabled
+             */
+            enabled?: boolean;
+            /**
+             * Optional description of this change (like a commit message)
+             */
+            change_description?: string;
             /**
              * Use case type
              */
-            type?: "inbound" | "outbound";
+            type?: "outbound";
+            configuration?: /* Configuration for outbound use cases (epilot to ERP). Structure TBD. */ OutboundIntegrationEventConfiguration;
+        }
+        export type UpdateUseCaseRequest = UpdateInboundUseCaseRequest | UpdateOutboundUseCaseRequest;
+        export interface UpdateUseCaseRequestBase {
+            /**
+             * Use case name
+             */
+            name?: string;
             /**
              * Whether the use case is enabled
              */
             enabled?: boolean;
             /**
-             * Use case specific configuration
+             * Optional description of this change (like a commit message)
              */
-            configuration?: {
-                [name: string]: any;
-            };
+            change_description?: string;
         }
         export type UseCase = InboundUseCase | OutboundUseCase;
+        export type UseCaseHistoryEntry = InboundUseCaseHistoryEntry | OutboundUseCaseHistoryEntry;
+        export interface UseCaseHistoryEntryBase {
+            /**
+             * Unique identifier for this history entry
+             */
+            id: string; // uuid
+            /**
+             * Reference to the parent use case
+             */
+            useCaseId: string; // uuid
+            /**
+             * Parent integration ID
+             */
+            integrationId: string; // uuid
+            /**
+             * Use case name at this point in history
+             */
+            name: string;
+            /**
+             * Whether the use case was enabled at this point in history
+             */
+            enabled: boolean;
+            /**
+             * Description of the change that was made at this point in history
+             */
+            change_description?: string;
+            /**
+             * ISO-8601 timestamp when the use case was originally created
+             */
+            created_at: string; // date-time
+            /**
+             * ISO-8601 timestamp of this historical snapshot (before the update)
+             */
+            updated_at: string; // date-time
+            /**
+             * ISO-8601 timestamp when this history entry was created
+             */
+            history_created_at: string; // date-time
+        }
     }
 }
 declare namespace Paths {
@@ -719,6 +910,36 @@ declare namespace Paths {
             export type $500 = Components.Responses.InternalServerError;
         }
     }
+    namespace ListUseCaseHistory {
+        namespace Parameters {
+            export type Cursor = string;
+            export type IntegrationId = string; // uuid
+            export type UseCaseId = string; // uuid
+        }
+        export interface PathParameters {
+            integrationId: Parameters.IntegrationId /* uuid */;
+            useCaseId: Parameters.UseCaseId /* uuid */;
+        }
+        export interface QueryParameters {
+            cursor?: Parameters.Cursor;
+        }
+        namespace Responses {
+            export interface $200 {
+                /**
+                 * History entries in reverse chronological order (newest first)
+                 */
+                history: Components.Schemas.UseCaseHistoryEntry[];
+                /**
+                 * Opaque cursor for fetching the next page. Absent if no more pages.
+                 */
+                next_cursor?: string;
+            }
+            export type $401 = Components.Responses.Unauthorized;
+            export interface $404 {
+            }
+            export type $500 = Components.Responses.InternalServerError;
+        }
+    }
     namespace ListUseCases {
         namespace Parameters {
             export type IntegrationId = string; // uuid
@@ -915,7 +1136,7 @@ export interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.SimulateMapping.Responses.$200>
   /**
-   * listIntegrations - List all integrations
+   * listIntegrations - listIntegrations
    * 
    * Retrieve all integrations for the authenticated organization
    */
@@ -925,7 +1146,7 @@ export interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.ListIntegrations.Responses.$200>
   /**
-   * createIntegration - Create a new integration
+   * createIntegration - createIntegration
    * 
    * Create a new integration configuration
    */
@@ -935,7 +1156,7 @@ export interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.CreateIntegration.Responses.$201>
   /**
-   * getIntegration - Get an integration by ID
+   * getIntegration - getIntegration
    * 
    * Retrieve a specific integration by its ID
    */
@@ -945,7 +1166,7 @@ export interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetIntegration.Responses.$200>
   /**
-   * updateIntegration - Update an integration
+   * updateIntegration - updateIntegration
    * 
    * Update an existing integration configuration
    */
@@ -955,7 +1176,7 @@ export interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.UpdateIntegration.Responses.$200>
   /**
-   * deleteIntegration - Delete an integration
+   * deleteIntegration - deleteIntegration
    * 
    * Delete an integration and all its use cases
    */
@@ -965,7 +1186,7 @@ export interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.DeleteIntegration.Responses.$200>
   /**
-   * listUseCases - List all use cases for an integration
+   * listUseCases - listUseCases
    * 
    * Retrieve all use cases for a specific integration
    */
@@ -975,7 +1196,7 @@ export interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.ListUseCases.Responses.$200>
   /**
-   * createUseCase - Create a new use case
+   * createUseCase - createUseCase
    * 
    * Create a new use case for an integration
    */
@@ -985,7 +1206,7 @@ export interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.CreateUseCase.Responses.$201>
   /**
-   * getUseCase - Get a use case by ID
+   * getUseCase - getUseCase
    * 
    * Retrieve a specific use case by its ID
    */
@@ -995,7 +1216,7 @@ export interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.GetUseCase.Responses.$200>
   /**
-   * updateUseCase - Update a use case
+   * updateUseCase - updateUseCase
    * 
    * Update an existing use case configuration
    */
@@ -1005,7 +1226,7 @@ export interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.UpdateUseCase.Responses.$200>
   /**
-   * deleteUseCase - Delete a use case
+   * deleteUseCase - deleteUseCase
    * 
    * Delete a use case from an integration
    */
@@ -1015,7 +1236,20 @@ export interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.DeleteUseCase.Responses.$200>
   /**
-   * setIntegrationAppMapping - Set integration app mapping
+   * listUseCaseHistory - listUseCaseHistory
+   * 
+   * Retrieve historical versions of a use case's configuration.
+   * History entries are returned in reverse chronological order (newest first).
+   * Use the 'cursor' parameter for pagination to fetch additional entries.
+   * 
+   */
+  'listUseCaseHistory'(
+    parameters?: Parameters<Paths.ListUseCaseHistory.QueryParameters & Paths.ListUseCaseHistory.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.ListUseCaseHistory.Responses.$200>
+  /**
+   * setIntegrationAppMapping - setIntegrationAppMapping
    * 
    * Creates or updates a mapping from an app/component to an integration.
    * This allows ERP updates sent via app_id and component_id to be associated
@@ -1028,7 +1262,7 @@ export interface OperationMethods {
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.SetIntegrationAppMapping.Responses.$200>
   /**
-   * deleteIntegrationAppMapping - Delete integration app mapping
+   * deleteIntegrationAppMapping - deleteIntegrationAppMapping
    * 
    * Removes a mapping from an app/component to an integration.
    * 
@@ -1110,7 +1344,7 @@ export interface PathsDictionary {
   }
   ['/v1/integrations']: {
     /**
-     * listIntegrations - List all integrations
+     * listIntegrations - listIntegrations
      * 
      * Retrieve all integrations for the authenticated organization
      */
@@ -1120,7 +1354,7 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.ListIntegrations.Responses.$200>
     /**
-     * createIntegration - Create a new integration
+     * createIntegration - createIntegration
      * 
      * Create a new integration configuration
      */
@@ -1132,7 +1366,7 @@ export interface PathsDictionary {
   }
   ['/v1/integrations/{integrationId}']: {
     /**
-     * getIntegration - Get an integration by ID
+     * getIntegration - getIntegration
      * 
      * Retrieve a specific integration by its ID
      */
@@ -1142,7 +1376,7 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.GetIntegration.Responses.$200>
     /**
-     * updateIntegration - Update an integration
+     * updateIntegration - updateIntegration
      * 
      * Update an existing integration configuration
      */
@@ -1152,7 +1386,7 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.UpdateIntegration.Responses.$200>
     /**
-     * deleteIntegration - Delete an integration
+     * deleteIntegration - deleteIntegration
      * 
      * Delete an integration and all its use cases
      */
@@ -1164,7 +1398,7 @@ export interface PathsDictionary {
   }
   ['/v1/integrations/{integrationId}/use-cases']: {
     /**
-     * listUseCases - List all use cases for an integration
+     * listUseCases - listUseCases
      * 
      * Retrieve all use cases for a specific integration
      */
@@ -1174,7 +1408,7 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.ListUseCases.Responses.$200>
     /**
-     * createUseCase - Create a new use case
+     * createUseCase - createUseCase
      * 
      * Create a new use case for an integration
      */
@@ -1186,7 +1420,7 @@ export interface PathsDictionary {
   }
   ['/v1/integrations/{integrationId}/use-cases/{useCaseId}']: {
     /**
-     * getUseCase - Get a use case by ID
+     * getUseCase - getUseCase
      * 
      * Retrieve a specific use case by its ID
      */
@@ -1196,7 +1430,7 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.GetUseCase.Responses.$200>
     /**
-     * updateUseCase - Update a use case
+     * updateUseCase - updateUseCase
      * 
      * Update an existing use case configuration
      */
@@ -1206,7 +1440,7 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.UpdateUseCase.Responses.$200>
     /**
-     * deleteUseCase - Delete a use case
+     * deleteUseCase - deleteUseCase
      * 
      * Delete a use case from an integration
      */
@@ -1216,9 +1450,24 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.DeleteUseCase.Responses.$200>
   }
+  ['/v1/integrations/{integrationId}/use-cases/{useCaseId}/history']: {
+    /**
+     * listUseCaseHistory - listUseCaseHistory
+     * 
+     * Retrieve historical versions of a use case's configuration.
+     * History entries are returned in reverse chronological order (newest first).
+     * Use the 'cursor' parameter for pagination to fetch additional entries.
+     * 
+     */
+    'get'(
+      parameters?: Parameters<Paths.ListUseCaseHistory.QueryParameters & Paths.ListUseCaseHistory.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.ListUseCaseHistory.Responses.$200>
+  }
   ['/v1/integrations/{integrationId}/app-mapping']: {
     /**
-     * setIntegrationAppMapping - Set integration app mapping
+     * setIntegrationAppMapping - setIntegrationAppMapping
      * 
      * Creates or updates a mapping from an app/component to an integration.
      * This allows ERP updates sent via app_id and component_id to be associated
@@ -1231,7 +1480,7 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.SetIntegrationAppMapping.Responses.$200>
     /**
-     * deleteIntegrationAppMapping - Delete integration app mapping
+     * deleteIntegrationAppMapping - deleteIntegrationAppMapping
      * 
      * Removes a mapping from an app/component to an integration.
      * 
@@ -1247,21 +1496,25 @@ export interface PathsDictionary {
 export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
 
 
+export type CreateInboundUseCaseRequest = Components.Schemas.CreateInboundUseCaseRequest;
 export type CreateIntegrationRequest = Components.Schemas.CreateIntegrationRequest;
+export type CreateOutboundUseCaseRequest = Components.Schemas.CreateOutboundUseCaseRequest;
 export type CreateUseCaseRequest = Components.Schemas.CreateUseCaseRequest;
+export type CreateUseCaseRequestBase = Components.Schemas.CreateUseCaseRequestBase;
 export type DeleteIntegrationAppMappingRequest = Components.Schemas.DeleteIntegrationAppMappingRequest;
 export type EntityUpdate = Components.Schemas.EntityUpdate;
 export type ErpEvent = Components.Schemas.ErpEvent;
 export type ErpUpdatesEventsV2Request = Components.Schemas.ErpUpdatesEventsV2Request;
 export type ErrorResponseBase = Components.Schemas.ErrorResponseBase;
+export type InboundIntegrationEventConfiguration = Components.Schemas.InboundIntegrationEventConfiguration;
 export type InboundUseCase = Components.Schemas.InboundUseCase;
+export type InboundUseCaseHistoryEntry = Components.Schemas.InboundUseCaseHistoryEntry;
 export type Integration = Components.Schemas.Integration;
 export type IntegrationAppMapping = Components.Schemas.IntegrationAppMapping;
 export type IntegrationConfigurationV1 = Components.Schemas.IntegrationConfigurationV1;
 export type IntegrationConfigurationV2 = Components.Schemas.IntegrationConfigurationV2;
 export type IntegrationEntity = Components.Schemas.IntegrationEntity;
 export type IntegrationEntityField = Components.Schemas.IntegrationEntityField;
-export type IntegrationEvent = Components.Schemas.IntegrationEvent;
 export type IntegrationFieldV1 = Components.Schemas.IntegrationFieldV1;
 export type IntegrationMeterReading = Components.Schemas.IntegrationMeterReading;
 export type IntegrationObjectV1 = Components.Schemas.IntegrationObjectV1;
@@ -1269,13 +1522,20 @@ export type MappingSimulationRequest = Components.Schemas.MappingSimulationReque
 export type MappingSimulationResponse = Components.Schemas.MappingSimulationResponse;
 export type MeterReadingUpdate = Components.Schemas.MeterReadingUpdate;
 export type MeterUniqueIdsConfig = Components.Schemas.MeterUniqueIdsConfig;
+export type OutboundIntegrationEventConfiguration = Components.Schemas.OutboundIntegrationEventConfiguration;
 export type OutboundUseCase = Components.Schemas.OutboundUseCase;
+export type OutboundUseCaseHistoryEntry = Components.Schemas.OutboundUseCaseHistoryEntry;
 export type RelationConfig = Components.Schemas.RelationConfig;
 export type RelationItemConfig = Components.Schemas.RelationItemConfig;
 export type RelationUniqueIdField = Components.Schemas.RelationUniqueIdField;
 export type SetIntegrationAppMappingRequest = Components.Schemas.SetIntegrationAppMappingRequest;
 export type TriggerErpActionRequest = Components.Schemas.TriggerErpActionRequest;
 export type TriggerWebhookResp = Components.Schemas.TriggerWebhookResp;
+export type UpdateInboundUseCaseRequest = Components.Schemas.UpdateInboundUseCaseRequest;
 export type UpdateIntegrationRequest = Components.Schemas.UpdateIntegrationRequest;
+export type UpdateOutboundUseCaseRequest = Components.Schemas.UpdateOutboundUseCaseRequest;
 export type UpdateUseCaseRequest = Components.Schemas.UpdateUseCaseRequest;
+export type UpdateUseCaseRequestBase = Components.Schemas.UpdateUseCaseRequestBase;
 export type UseCase = Components.Schemas.UseCase;
+export type UseCaseHistoryEntry = Components.Schemas.UseCaseHistoryEntry;
+export type UseCaseHistoryEntryBase = Components.Schemas.UseCaseHistoryEntryBase;

package/dist/openapi.json

@@ -2,7 +2,7 @@
   "openapi": "3.0.3",
   "info": {
     "title": "ERP Integration API",
-    "version": "0.12.0",
+    "version": "0.13.0",
     "description": "API for integrating with ERP systems, handling tracking acknowledgments, triggering ERP processes, and processing ERP updates."
   },
   "tags": [
@@ -608,7 +608,7 @@
     "/v1/integrations": {
       "get": {
         "operationId": "listIntegrations",
-        "summary": "List all integrations",
+        "summary": "listIntegrations",
         "description": "Retrieve all integrations for the authenticated organization",
         "tags": [
           "integrations"
@@ -645,7 +645,7 @@
       },
       "post": {
         "operationId": "createIntegration",
-        "summary": "Create a new integration",
+        "summary": "createIntegration",
         "description": "Create a new integration configuration",
         "tags": [
           "integrations"
@@ -686,7 +686,7 @@
     "/v1/integrations/{integrationId}": {
       "get": {
         "operationId": "getIntegration",
-        "summary": "Get an integration by ID",
+        "summary": "getIntegration",
         "description": "Retrieve a specific integration by its ID",
         "tags": [
           "integrations"
@@ -727,7 +727,7 @@
       },
       "put": {
         "operationId": "updateIntegration",
-        "summary": "Update an integration",
+        "summary": "updateIntegration",
         "description": "Update an existing integration configuration",
         "tags": [
           "integrations"
@@ -781,7 +781,7 @@
       },
       "delete": {
         "operationId": "deleteIntegration",
-        "summary": "Delete an integration",
+        "summary": "deleteIntegration",
         "description": "Delete an integration and all its use cases",
         "tags": [
           "integrations"
@@ -829,7 +829,7 @@
     "/v1/integrations/{integrationId}/use-cases": {
       "get": {
         "operationId": "listUseCases",
-        "summary": "List all use cases for an integration",
+        "summary": "listUseCases",
         "description": "Retrieve all use cases for a specific integration",
         "tags": [
           "integrations"
@@ -878,7 +878,7 @@
       },
       "post": {
         "operationId": "createUseCase",
-        "summary": "Create a new use case",
+        "summary": "createUseCase",
         "description": "Create a new use case for an integration",
         "tags": [
           "integrations"
@@ -934,7 +934,7 @@
     "/v1/integrations/{integrationId}/use-cases/{useCaseId}": {
       "get": {
         "operationId": "getUseCase",
-        "summary": "Get a use case by ID",
+        "summary": "getUseCase",
         "description": "Retrieve a specific use case by its ID",
         "tags": [
           "integrations"
@@ -985,7 +985,7 @@
       },
       "put": {
         "operationId": "updateUseCase",
-        "summary": "Update a use case",
+        "summary": "updateUseCase",
         "description": "Update an existing use case configuration",
         "tags": [
           "integrations"
@@ -1049,7 +1049,7 @@
       },
       "delete": {
         "operationId": "deleteUseCase",
-        "summary": "Delete a use case",
+        "summary": "deleteUseCase",
         "description": "Delete a use case from an integration",
         "tags": [
           "integrations"
@@ -1104,10 +1104,89 @@
         }
       }
     },
+    "/v1/integrations/{integrationId}/use-cases/{useCaseId}/history": {
+      "get": {
+        "operationId": "listUseCaseHistory",
+        "summary": "listUseCaseHistory",
+        "description": "Retrieve historical versions of a use case's configuration.\nHistory entries are returned in reverse chronological order (newest first).\nUse the 'cursor' parameter for pagination to fetch additional entries.\n",
+        "tags": [
+          "integrations"
+        ],
+        "parameters": [
+          {
+            "name": "integrationId",
+            "in": "path",
+            "required": true,
+            "description": "The integration ID",
+            "schema": {
+              "type": "string",
+              "format": "uuid"
+            }
+          },
+          {
+            "name": "useCaseId",
+            "in": "path",
+            "required": true,
+            "description": "The use case ID",
+            "schema": {
+              "type": "string",
+              "format": "uuid"
+            }
+          },
+          {
+            "name": "cursor",
+            "in": "query",
+            "required": false,
+            "description": "Opaque pagination cursor. Pass the 'next_cursor' value from a previous\nresponse to fetch the next page of results.\n",
+            "schema": {
+              "type": "string"
+            },
+            "example": "eyJwayI6Ik9SRyMxMjM0NSIsInNrIjoiSU5URUdSQVRJT04jLi4uIn0="
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successfully retrieved use case history",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "required": [
+                    "history"
+                  ],
+                  "properties": {
+                    "history": {
+                      "type": "array",
+                      "description": "History entries in reverse chronological order (newest first)",
+                      "items": {
+                        "$ref": "#/components/schemas/UseCaseHistoryEntry"
+                      }
+                    },
+                    "next_cursor": {
+                      "type": "string",
+                      "description": "Opaque cursor for fetching the next page. Absent if no more pages."
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "401": {
+            "$ref": "#/components/responses/Unauthorized"
+          },
+          "404": {
+            "description": "Use case not found"
+          },
+          "500": {
+            "$ref": "#/components/responses/InternalServerError"
+          }
+        }
+      }
+    },
     "/v1/integrations/{integrationId}/app-mapping": {
       "put": {
         "operationId": "setIntegrationAppMapping",
-        "summary": "Set integration app mapping",
+        "summary": "setIntegrationAppMapping",
         "description": "Creates or updates a mapping from an app/component to an integration.\nThis allows ERP updates sent via app_id and component_id to be associated\nwith a specific integration configuration.\n",
         "tags": [
           "integrations"
@@ -1171,7 +1250,7 @@
       },
       "delete": {
         "operationId": "deleteIntegrationAppMapping",
-        "summary": "Delete integration app mapping",
+        "summary": "deleteIntegrationAppMapping",
         "description": "Removes a mapping from an app/component to an integration.\n",
         "tags": [
           "integrations"
@@ -1615,7 +1694,12 @@
             "description": "Whether the use case is enabled"
           },
           "configuration": {
-            "$ref": "#/components/schemas/IntegrationEvent"
+            "$ref": "#/components/schemas/InboundIntegrationEventConfiguration"
+          },
+          "change_description": {
+            "type": "string",
+            "maxLength": 2000,
+            "description": "Description of the last change made to this use case"
           },
           "created_at": {
             "type": "string",
@@ -1667,9 +1751,12 @@
             "description": "Whether the use case is enabled"
           },
           "configuration": {
-            "type": "object",
-            "description": "Use case specific configuration",
-            "additionalProperties": true
+            "$ref": "#/components/schemas/OutboundIntegrationEventConfiguration"
+          },
+          "change_description": {
+            "type": "string",
+            "maxLength": 2000,
+            "description": "Description of the last change made to this use case"
           },
           "created_at": {
             "type": "string",
@@ -1684,6 +1771,23 @@
         }
       },
       "CreateUseCaseRequest": {
+        "oneOf": [
+          {
+            "$ref": "#/components/schemas/CreateInboundUseCaseRequest"
+          },
+          {
+            "$ref": "#/components/schemas/CreateOutboundUseCaseRequest"
+          }
+        ],
+        "discriminator": {
+          "propertyName": "type",
+          "mapping": {
+            "inbound": "#/components/schemas/CreateInboundUseCaseRequest",
+            "outbound": "#/components/schemas/CreateOutboundUseCaseRequest"
+          }
+        }
+      },
+      "CreateUseCaseRequestBase": {
         "type": "object",
         "required": [
           "name",
@@ -1697,26 +1801,80 @@
             "maxLength": 255,
             "description": "Use case name"
           },
-          "type": {
-            "type": "string",
-            "enum": [
-              "inbound",
-              "outbound"
-            ],
-            "description": "Use case type"
-          },
           "enabled": {
             "type": "boolean",
             "description": "Whether the use case is enabled"
+          }
+        }
+      },
+      "CreateInboundUseCaseRequest": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/CreateUseCaseRequestBase"
           },
-          "configuration": {
+          {
             "type": "object",
-            "description": "Use case specific configuration",
-            "additionalProperties": true
+            "required": [
+              "type"
+            ],
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": [
+                  "inbound"
+                ],
+                "description": "Use case type"
+              },
+              "configuration": {
+                "$ref": "#/components/schemas/InboundIntegrationEventConfiguration"
+              }
+            }
           }
-        }
+        ]
+      },
+      "CreateOutboundUseCaseRequest": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/CreateUseCaseRequestBase"
+          },
+          {
+            "type": "object",
+            "required": [
+              "type"
+            ],
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": [
+                  "outbound"
+                ],
+                "description": "Use case type"
+              },
+              "configuration": {
+                "$ref": "#/components/schemas/OutboundIntegrationEventConfiguration"
+              }
+            }
+          }
+        ]
       },
       "UpdateUseCaseRequest": {
+        "oneOf": [
+          {
+            "$ref": "#/components/schemas/UpdateInboundUseCaseRequest"
+          },
+          {
+            "$ref": "#/components/schemas/UpdateOutboundUseCaseRequest"
+          }
+        ],
+        "discriminator": {
+          "propertyName": "type",
+          "mapping": {
+            "inbound": "#/components/schemas/UpdateInboundUseCaseRequest",
+            "outbound": "#/components/schemas/UpdateOutboundUseCaseRequest"
+          }
+        }
+      },
+      "UpdateUseCaseRequestBase": {
         "type": "object",
         "properties": {
           "name": {
@@ -1725,25 +1883,186 @@
             "maxLength": 255,
             "description": "Use case name"
           },
-          "type": {
-            "type": "string",
-            "enum": [
-              "inbound",
-              "outbound"
-            ],
-            "description": "Use case type"
-          },
           "enabled": {
             "type": "boolean",
             "description": "Whether the use case is enabled"
           },
-          "configuration": {
+          "change_description": {
+            "type": "string",
+            "maxLength": 2000,
+            "description": "Optional description of this change (like a commit message)"
+          }
+        }
+      },
+      "UpdateInboundUseCaseRequest": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/UpdateUseCaseRequestBase"
+          },
+          {
             "type": "object",
-            "description": "Use case specific configuration",
-            "additionalProperties": true
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": [
+                  "inbound"
+                ],
+                "description": "Use case type"
+              },
+              "configuration": {
+                "$ref": "#/components/schemas/InboundIntegrationEventConfiguration"
+              }
+            }
+          }
+        ]
+      },
+      "UpdateOutboundUseCaseRequest": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/UpdateUseCaseRequestBase"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": [
+                  "outbound"
+                ],
+                "description": "Use case type"
+              },
+              "configuration": {
+                "$ref": "#/components/schemas/OutboundIntegrationEventConfiguration"
+              }
+            }
+          }
+        ]
+      },
+      "UseCaseHistoryEntry": {
+        "oneOf": [
+          {
+            "$ref": "#/components/schemas/InboundUseCaseHistoryEntry"
+          },
+          {
+            "$ref": "#/components/schemas/OutboundUseCaseHistoryEntry"
+          }
+        ],
+        "discriminator": {
+          "propertyName": "type",
+          "mapping": {
+            "inbound": "#/components/schemas/InboundUseCaseHistoryEntry",
+            "outbound": "#/components/schemas/OutboundUseCaseHistoryEntry"
           }
         }
       },
+      "UseCaseHistoryEntryBase": {
+        "type": "object",
+        "required": [
+          "id",
+          "useCaseId",
+          "integrationId",
+          "name",
+          "type",
+          "enabled",
+          "created_at",
+          "updated_at",
+          "history_created_at"
+        ],
+        "properties": {
+          "id": {
+            "type": "string",
+            "format": "uuid",
+            "description": "Unique identifier for this history entry"
+          },
+          "useCaseId": {
+            "type": "string",
+            "format": "uuid",
+            "description": "Reference to the parent use case"
+          },
+          "integrationId": {
+            "type": "string",
+            "format": "uuid",
+            "description": "Parent integration ID"
+          },
+          "name": {
+            "type": "string",
+            "description": "Use case name at this point in history"
+          },
+          "enabled": {
+            "type": "boolean",
+            "description": "Whether the use case was enabled at this point in history"
+          },
+          "change_description": {
+            "type": "string",
+            "description": "Description of the change that was made at this point in history"
+          },
+          "created_at": {
+            "type": "string",
+            "format": "date-time",
+            "description": "ISO-8601 timestamp when the use case was originally created"
+          },
+          "updated_at": {
+            "type": "string",
+            "format": "date-time",
+            "description": "ISO-8601 timestamp of this historical snapshot (before the update)"
+          },
+          "history_created_at": {
+            "type": "string",
+            "format": "date-time",
+            "description": "ISO-8601 timestamp when this history entry was created"
+          }
+        }
+      },
+      "InboundUseCaseHistoryEntry": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/UseCaseHistoryEntryBase"
+          },
+          {
+            "type": "object",
+            "required": [
+              "type"
+            ],
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": [
+                  "inbound"
+                ],
+                "description": "Use case type"
+              },
+              "configuration": {
+                "$ref": "#/components/schemas/InboundIntegrationEventConfiguration"
+              }
+            }
+          }
+        ]
+      },
+      "OutboundUseCaseHistoryEntry": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/UseCaseHistoryEntryBase"
+          },
+          {
+            "type": "object",
+            "required": [
+              "type"
+            ],
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": [
+                  "outbound"
+                ],
+                "description": "Use case type"
+              },
+              "configuration": {
+                "$ref": "#/components/schemas/OutboundIntegrationEventConfiguration"
+              }
+            }
+          }
+        ]
+      },
       "MappingSimulationRequest": {
         "type": "object",
         "required": [
@@ -1991,15 +2310,16 @@
                 "type": "object",
                 "description": "[v2.0] Event type mappings",
                 "additionalProperties": {
-                  "$ref": "#/components/schemas/IntegrationEvent"
+                  "$ref": "#/components/schemas/InboundIntegrationEventConfiguration"
                 }
               }
             }
           }
         }
       },
-      "IntegrationEvent": {
+      "InboundIntegrationEventConfiguration": {
         "type": "object",
+        "description": "Configuration for inbound use cases (ERP to epilot)",
         "properties": {
           "entities": {
             "type": "array",
@@ -2017,6 +2337,11 @@
           }
         }
       },
+      "OutboundIntegrationEventConfiguration": {
+        "type": "object",
+        "description": "Configuration for outbound use cases (epilot to ERP). Structure TBD.",
+        "additionalProperties": true
+      },
       "IntegrationEntity": {
         "type": "object",
         "required": [
@@ -2302,6 +2627,9 @@
     }
   },
   "servers": [
+    {
+      "url": "https://erp-integration-api.sls.epilot.io"
+    },
     {
       "url": "https://erp-integration-api.sls.epilot.io"
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/erp-integration-client",
-  "version": "0.7.0",
+  "version": "0.9.0",
   "description": "Client library for ePilot ERP Integration API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",