@epilot/erp-integration-client 0.24.2 → 0.25.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 +343 -40
- package/dist/openapi.json +820 -597
- package/package.json +1 -1
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={
|
|
1
|
+
(()=>{"use strict";var e={390: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":""},"servers":[{"url":"https://erp-integration-api.sls.epilot.io"}],"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":{"deprecated":true,"operationId":"processErpUpdatesEvents","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/erp/updates/events":{"post":{"deprecated":true,"operationId":"processErpUpdatesEventsV2","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v3/erp/updates/events":{"post":{"operationId":"processErpUpdatesEventsV3","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/erp/updates/mapping_simulation":{"post":{"operationId":"simulateMappingV2","requestBody":{"required":true,"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}/events":{"post":{"operationId":"queryEvents","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations/{integrationId}/events/replay":{"post":{"operationId":"replayEvents","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"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":{}}},"/v2/integrations":{"get":{"operationId":"listIntegrationsV2","responses":{}},"post":{"operationId":"createIntegrationV2","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/integrations/{integrationId}":{"get":{"operationId":"getIntegrationV2","parameters":[{"name":"integrationId","in":"path","required":true}],"responses":{}},"put":{"operationId":"updateIntegrationV2","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteIntegrationV2","parameters":[{"name":"integrationId","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":{}}},"/v1/integrations/{integrationId}/monitoring/inbound-events":{"post":{"operationId":"queryInboundMonitoringEvents","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations/{integrationId}/monitoring/stats":{"post":{"operationId":"getMonitoringStats","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations/{integrationId}/monitoring/timeseries":{"post":{"operationId":"getMonitoringTimeSeries","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations/{integrationId}/outbound-status":{"get":{"operationId":"getOutboundStatus","parameters":[{"name":"integrationId","in":"path","required":true}],"responses":{}}},"/v1/integrations/{integrationId}/monitoring/access-logs":{"post":{"operationId":"queryAccessLogs","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations/{integrationId}/monitoring/outbound-events":{"post":{"operationId":"queryOutboundMonitoringEvents","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}}},"components":{"responses":{"BadRequest":{"content":{"application/json":{}}},"NotFound":{"content":{"application/json":{}}},"Unauthorized":{"content":{"application/json":{}}},"InternalServerError":{"content":{"application/json":{}}},"QueryInboundMonitoringEventsResponse":{"content":{"application/json":{}}},"GetMonitoringStatsResponse":{"content":{"application/json":{}}},"GetMonitoringTimeSeriesResponse":{"content":{"application/json":{}}},"QueryAccessLogsResponse":{"content":{"application/json":{}}},"QueryOutboundMonitoringEventsResponse":{"content":{"application/json":{}}},"ReplayEventsResponse":{"content":{"application/json":{}}},"ERPUpdatesResponse":{"content":{"application/json":{}}},"TriggerWebhookResponse":{"content":{"application/json":{}}},"QueryEventsResponse":{"content":{"application/json":{}}}}}}')}},t={},n=function n(r){var o=t[r];if(void 0!==o)return o.exports;var i=t[r]={exports:{}};return e[r].call(i.exports,i,i.exports,n),i.exports}(390),r=exports;for(var o in n)r[o]=n[o];n.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
|
package/dist/openapi.d.ts
CHANGED
|
@@ -187,6 +187,46 @@ declare namespace Components {
|
|
|
187
187
|
*/
|
|
188
188
|
source_ip?: string;
|
|
189
189
|
}
|
|
190
|
+
/**
|
|
191
|
+
* Auto-refresh settings for keeping integration data fresh
|
|
192
|
+
*/
|
|
193
|
+
export interface AutoRefreshSettings {
|
|
194
|
+
/**
|
|
195
|
+
* Whether auto-refresh is enabled
|
|
196
|
+
*/
|
|
197
|
+
enabled?: boolean;
|
|
198
|
+
/**
|
|
199
|
+
* Maximum age (in minutes) of data before it is considered stale and eligible for refresh
|
|
200
|
+
*/
|
|
201
|
+
freshnessThresholdMinutes?: number;
|
|
202
|
+
/**
|
|
203
|
+
* Minimum interval (in minutes) between consecutive sync operations to prevent excessive API calls
|
|
204
|
+
*/
|
|
205
|
+
minIntervalBetweenSyncsMinutes?: number;
|
|
206
|
+
}
|
|
207
|
+
export interface CreateFileProxyUseCaseRequest {
|
|
208
|
+
/**
|
|
209
|
+
* Use case name
|
|
210
|
+
*/
|
|
211
|
+
name: string;
|
|
212
|
+
/**
|
|
213
|
+
* Whether the use case is enabled
|
|
214
|
+
*/
|
|
215
|
+
enabled: boolean;
|
|
216
|
+
/**
|
|
217
|
+
* Use case type
|
|
218
|
+
*/
|
|
219
|
+
type: "file_proxy";
|
|
220
|
+
configuration?: /**
|
|
221
|
+
* Configuration for file_proxy use cases. Defines how to authenticate and fetch files from external document systems.
|
|
222
|
+
*
|
|
223
|
+
* The file proxy download URL always requires `orgId`, `integrationId`, and `useCaseId` as query parameters.
|
|
224
|
+
* The `orgId` is included in the signed URL to establish organization context without requiring authentication.
|
|
225
|
+
* Additional use-case-specific parameters are declared in the `params` array.
|
|
226
|
+
*
|
|
227
|
+
*/
|
|
228
|
+
FileProxyUseCaseConfiguration;
|
|
229
|
+
}
|
|
190
230
|
export interface CreateInboundUseCaseRequest {
|
|
191
231
|
/**
|
|
192
232
|
* Use case name
|
|
@@ -212,17 +252,18 @@ declare namespace Components {
|
|
|
212
252
|
*/
|
|
213
253
|
description?: string;
|
|
214
254
|
/**
|
|
215
|
-
* List of access token IDs
|
|
255
|
+
* List of access token IDs associated with this integration
|
|
216
256
|
*/
|
|
217
257
|
access_token_ids?: string[];
|
|
218
258
|
/**
|
|
219
|
-
* List of app IDs
|
|
259
|
+
* List of app IDs associated with this integration
|
|
220
260
|
*/
|
|
221
261
|
app_ids?: string[];
|
|
222
262
|
/**
|
|
223
|
-
* Configuration defining environment variables needed by this integration
|
|
263
|
+
* Configuration defining environment variables needed by this integration. Values are stored in the Environments API.
|
|
224
264
|
*/
|
|
225
265
|
environment_config?: EnvironmentFieldConfig[];
|
|
266
|
+
settings?: /* Settings for the integration */ IntegrationSettings;
|
|
226
267
|
}
|
|
227
268
|
export interface CreateOutboundUseCaseRequest {
|
|
228
269
|
/**
|
|
@@ -239,7 +280,7 @@ declare namespace Components {
|
|
|
239
280
|
type: "outbound";
|
|
240
281
|
configuration?: /* Configuration for outbound use cases. Defines the event that triggers the flow and the webhook mappings. */ OutboundIntegrationEventConfiguration;
|
|
241
282
|
}
|
|
242
|
-
export type CreateUseCaseRequest = CreateInboundUseCaseRequest | CreateOutboundUseCaseRequest;
|
|
283
|
+
export type CreateUseCaseRequest = CreateInboundUseCaseRequest | CreateOutboundUseCaseRequest | CreateFileProxyUseCaseRequest;
|
|
243
284
|
export interface CreateUseCaseRequestBase {
|
|
244
285
|
/**
|
|
245
286
|
* Use case name
|
|
@@ -498,6 +539,202 @@ declare namespace Components {
|
|
|
498
539
|
*/
|
|
499
540
|
message?: string;
|
|
500
541
|
}
|
|
542
|
+
export interface FileProxyAuth {
|
|
543
|
+
/**
|
|
544
|
+
* Authentication type
|
|
545
|
+
*/
|
|
546
|
+
type: "oauth2_client_credentials";
|
|
547
|
+
/**
|
|
548
|
+
* Handlebars template for the OAuth2 token endpoint URL
|
|
549
|
+
*/
|
|
550
|
+
token_url: string;
|
|
551
|
+
/**
|
|
552
|
+
* Handlebars template for the OAuth2 client ID
|
|
553
|
+
*/
|
|
554
|
+
client_id: string;
|
|
555
|
+
/**
|
|
556
|
+
* Handlebars template for the OAuth2 client secret
|
|
557
|
+
*/
|
|
558
|
+
client_secret: string;
|
|
559
|
+
/**
|
|
560
|
+
* Optional OAuth2 scope
|
|
561
|
+
*/
|
|
562
|
+
scope?: string;
|
|
563
|
+
}
|
|
564
|
+
export interface FileProxyParam {
|
|
565
|
+
/**
|
|
566
|
+
* Parameter name as it appears in the query string
|
|
567
|
+
*/
|
|
568
|
+
name: string;
|
|
569
|
+
/**
|
|
570
|
+
* Whether this parameter is required
|
|
571
|
+
*/
|
|
572
|
+
required: boolean;
|
|
573
|
+
/**
|
|
574
|
+
* Human-readable description of the parameter
|
|
575
|
+
*/
|
|
576
|
+
description?: string;
|
|
577
|
+
}
|
|
578
|
+
export interface FileProxyResponseConfig {
|
|
579
|
+
/**
|
|
580
|
+
* JSONata expression to extract file content from step results
|
|
581
|
+
*/
|
|
582
|
+
body: string;
|
|
583
|
+
/**
|
|
584
|
+
* Encoding of the extracted body
|
|
585
|
+
*/
|
|
586
|
+
encoding: "base64" | "binary";
|
|
587
|
+
/**
|
|
588
|
+
* JSONata expression to extract the filename
|
|
589
|
+
*/
|
|
590
|
+
filename?: string;
|
|
591
|
+
/**
|
|
592
|
+
* JSONata expression to extract the content type
|
|
593
|
+
*/
|
|
594
|
+
content_type?: string;
|
|
595
|
+
}
|
|
596
|
+
export interface FileProxyStep {
|
|
597
|
+
/**
|
|
598
|
+
* Handlebars template for the request URL
|
|
599
|
+
*/
|
|
600
|
+
url: string;
|
|
601
|
+
/**
|
|
602
|
+
* HTTP method
|
|
603
|
+
*/
|
|
604
|
+
method: "GET" | "POST";
|
|
605
|
+
/**
|
|
606
|
+
* Handlebars templates for request headers
|
|
607
|
+
*/
|
|
608
|
+
headers?: {
|
|
609
|
+
[name: string]: string;
|
|
610
|
+
};
|
|
611
|
+
/**
|
|
612
|
+
* Handlebars template for the request body (POST only)
|
|
613
|
+
*/
|
|
614
|
+
body?: string;
|
|
615
|
+
/**
|
|
616
|
+
* Expected response type
|
|
617
|
+
*/
|
|
618
|
+
response_type: "json" | "binary";
|
|
619
|
+
}
|
|
620
|
+
export interface FileProxyUseCase {
|
|
621
|
+
/**
|
|
622
|
+
* Unique identifier for the use case
|
|
623
|
+
*/
|
|
624
|
+
id: string; // uuid
|
|
625
|
+
/**
|
|
626
|
+
* Parent integration ID
|
|
627
|
+
*/
|
|
628
|
+
integrationId: string; // uuid
|
|
629
|
+
/**
|
|
630
|
+
* Use case name
|
|
631
|
+
*/
|
|
632
|
+
name: string;
|
|
633
|
+
/**
|
|
634
|
+
* Use case type
|
|
635
|
+
*/
|
|
636
|
+
type: "inbound" | "outbound" | "file_proxy" | "file_proxy";
|
|
637
|
+
enabled: boolean;
|
|
638
|
+
/**
|
|
639
|
+
* Description of the last change made to this use case
|
|
640
|
+
*/
|
|
641
|
+
change_description?: string;
|
|
642
|
+
/**
|
|
643
|
+
* ISO-8601 timestamp when the use case was created
|
|
644
|
+
*/
|
|
645
|
+
created_at: string; // date-time
|
|
646
|
+
/**
|
|
647
|
+
* ISO-8601 timestamp when the use case was last updated
|
|
648
|
+
*/
|
|
649
|
+
updated_at: string; // date-time
|
|
650
|
+
configuration?: /**
|
|
651
|
+
* Configuration for file_proxy use cases. Defines how to authenticate and fetch files from external document systems.
|
|
652
|
+
*
|
|
653
|
+
* The file proxy download URL always requires `orgId`, `integrationId`, and `useCaseId` as query parameters.
|
|
654
|
+
* The `orgId` is included in the signed URL to establish organization context without requiring authentication.
|
|
655
|
+
* Additional use-case-specific parameters are declared in the `params` array.
|
|
656
|
+
*
|
|
657
|
+
*/
|
|
658
|
+
FileProxyUseCaseConfiguration;
|
|
659
|
+
}
|
|
660
|
+
/**
|
|
661
|
+
* Configuration for file_proxy use cases. Defines how to authenticate and fetch files from external document systems.
|
|
662
|
+
*
|
|
663
|
+
* The file proxy download URL always requires `orgId`, `integrationId`, and `useCaseId` as query parameters.
|
|
664
|
+
* The `orgId` is included in the signed URL to establish organization context without requiring authentication.
|
|
665
|
+
* Additional use-case-specific parameters are declared in the `params` array.
|
|
666
|
+
*
|
|
667
|
+
*/
|
|
668
|
+
export interface FileProxyUseCaseConfiguration {
|
|
669
|
+
/**
|
|
670
|
+
* Whether requests require VPC routing for IP allowlisting
|
|
671
|
+
*/
|
|
672
|
+
requires_vpc?: boolean;
|
|
673
|
+
auth?: FileProxyAuth;
|
|
674
|
+
/**
|
|
675
|
+
* Additional use-case-specific parameters expected in the download URL query string (beyond the required orgId, integrationId, useCaseId)
|
|
676
|
+
*/
|
|
677
|
+
params?: FileProxyParam[];
|
|
678
|
+
/**
|
|
679
|
+
* Ordered list of HTTP steps to execute to retrieve the file
|
|
680
|
+
*/
|
|
681
|
+
steps: [
|
|
682
|
+
FileProxyStep,
|
|
683
|
+
...FileProxyStep[]
|
|
684
|
+
];
|
|
685
|
+
response: FileProxyResponseConfig;
|
|
686
|
+
}
|
|
687
|
+
export interface FileProxyUseCaseHistoryEntry {
|
|
688
|
+
/**
|
|
689
|
+
* Unique identifier for this history entry
|
|
690
|
+
*/
|
|
691
|
+
id: string; // uuid
|
|
692
|
+
/**
|
|
693
|
+
* Reference to the parent use case
|
|
694
|
+
*/
|
|
695
|
+
useCaseId: string; // uuid
|
|
696
|
+
/**
|
|
697
|
+
* Parent integration ID
|
|
698
|
+
*/
|
|
699
|
+
integrationId: string; // uuid
|
|
700
|
+
/**
|
|
701
|
+
* Use case name at this point in history
|
|
702
|
+
*/
|
|
703
|
+
name: string;
|
|
704
|
+
/**
|
|
705
|
+
* Whether the use case was enabled at this point in history
|
|
706
|
+
*/
|
|
707
|
+
enabled: boolean;
|
|
708
|
+
/**
|
|
709
|
+
* Description of the change that was made at this point in history
|
|
710
|
+
*/
|
|
711
|
+
change_description?: string;
|
|
712
|
+
/**
|
|
713
|
+
* ISO-8601 timestamp when the use case was originally created
|
|
714
|
+
*/
|
|
715
|
+
created_at: string; // date-time
|
|
716
|
+
/**
|
|
717
|
+
* ISO-8601 timestamp of this historical snapshot (before the update)
|
|
718
|
+
*/
|
|
719
|
+
updated_at: string; // date-time
|
|
720
|
+
/**
|
|
721
|
+
* ISO-8601 timestamp when this history entry was created
|
|
722
|
+
*/
|
|
723
|
+
history_created_at: string; // date-time
|
|
724
|
+
/**
|
|
725
|
+
* Use case type
|
|
726
|
+
*/
|
|
727
|
+
type: "file_proxy";
|
|
728
|
+
configuration?: /**
|
|
729
|
+
* Configuration for file_proxy use cases. Defines how to authenticate and fetch files from external document systems.
|
|
730
|
+
*
|
|
731
|
+
* The file proxy download URL always requires `orgId`, `integrationId`, and `useCaseId` as query parameters.
|
|
732
|
+
* The `orgId` is included in the signed URL to establish organization context without requiring authentication.
|
|
733
|
+
* Additional use-case-specific parameters are declared in the `params` array.
|
|
734
|
+
*
|
|
735
|
+
*/
|
|
736
|
+
FileProxyUseCaseConfiguration;
|
|
737
|
+
}
|
|
501
738
|
export interface GetMonitoringStatsRequest {
|
|
502
739
|
/**
|
|
503
740
|
* Start date for statistics period (inclusive)
|
|
@@ -647,7 +884,7 @@ declare namespace Components {
|
|
|
647
884
|
/**
|
|
648
885
|
* Use case type
|
|
649
886
|
*/
|
|
650
|
-
type: "inbound" | "outbound" | "inbound";
|
|
887
|
+
type: "inbound" | "outbound" | "file_proxy" | "inbound";
|
|
651
888
|
enabled: boolean;
|
|
652
889
|
/**
|
|
653
890
|
* Description of the last change made to this use case
|
|
@@ -715,6 +952,14 @@ declare namespace Components {
|
|
|
715
952
|
* Organization ID
|
|
716
953
|
*/
|
|
717
954
|
orgId: string;
|
|
955
|
+
/**
|
|
956
|
+
* ISO-8601 timestamp when the integration was created
|
|
957
|
+
*/
|
|
958
|
+
created_at: string; // date-time
|
|
959
|
+
/**
|
|
960
|
+
* ISO-8601 timestamp when the integration was last updated
|
|
961
|
+
*/
|
|
962
|
+
updated_at: string; // date-time
|
|
718
963
|
/**
|
|
719
964
|
* Integration name
|
|
720
965
|
*/
|
|
@@ -735,14 +980,7 @@ declare namespace Components {
|
|
|
735
980
|
* Configuration defining environment variables needed by this integration. Values are stored in the Environments API.
|
|
736
981
|
*/
|
|
737
982
|
environment_config?: EnvironmentFieldConfig[];
|
|
738
|
-
|
|
739
|
-
* ISO-8601 timestamp when the integration was created
|
|
740
|
-
*/
|
|
741
|
-
created_at: string; // date-time
|
|
742
|
-
/**
|
|
743
|
-
* ISO-8601 timestamp when the integration was last updated
|
|
744
|
-
*/
|
|
745
|
-
updated_at: string; // date-time
|
|
983
|
+
settings?: /* Settings for the integration */ IntegrationSettings;
|
|
746
984
|
}
|
|
747
985
|
export interface IntegrationAppMapping {
|
|
748
986
|
/**
|
|
@@ -778,6 +1016,29 @@ declare namespace Components {
|
|
|
778
1016
|
};
|
|
779
1017
|
};
|
|
780
1018
|
}
|
|
1019
|
+
export interface IntegrationEditableFields {
|
|
1020
|
+
/**
|
|
1021
|
+
* Integration name
|
|
1022
|
+
*/
|
|
1023
|
+
name?: string;
|
|
1024
|
+
/**
|
|
1025
|
+
* Optional description of the integration
|
|
1026
|
+
*/
|
|
1027
|
+
description?: string;
|
|
1028
|
+
/**
|
|
1029
|
+
* List of access token IDs associated with this integration
|
|
1030
|
+
*/
|
|
1031
|
+
access_token_ids?: string[];
|
|
1032
|
+
/**
|
|
1033
|
+
* List of app IDs associated with this integration
|
|
1034
|
+
*/
|
|
1035
|
+
app_ids?: string[];
|
|
1036
|
+
/**
|
|
1037
|
+
* Configuration defining environment variables needed by this integration. Values are stored in the Environments API.
|
|
1038
|
+
*/
|
|
1039
|
+
environment_config?: EnvironmentFieldConfig[];
|
|
1040
|
+
settings?: /* Settings for the integration */ IntegrationSettings;
|
|
1041
|
+
}
|
|
781
1042
|
export interface IntegrationEntity {
|
|
782
1043
|
/**
|
|
783
1044
|
* Target entity schema (e.g., 'contact', 'contract')
|
|
@@ -925,6 +1186,12 @@ declare namespace Components {
|
|
|
925
1186
|
*/
|
|
926
1187
|
fields: IntegrationFieldV1[];
|
|
927
1188
|
}
|
|
1189
|
+
/**
|
|
1190
|
+
* Settings for the integration
|
|
1191
|
+
*/
|
|
1192
|
+
export interface IntegrationSettings {
|
|
1193
|
+
autoRefresh?: /* Auto-refresh settings for keeping integration data fresh */ AutoRefreshSettings;
|
|
1194
|
+
}
|
|
928
1195
|
/**
|
|
929
1196
|
* Integration with embedded use cases for atomic CRUD operations
|
|
930
1197
|
*/
|
|
@@ -937,6 +1204,14 @@ declare namespace Components {
|
|
|
937
1204
|
* Organization ID
|
|
938
1205
|
*/
|
|
939
1206
|
orgId: string;
|
|
1207
|
+
/**
|
|
1208
|
+
* ISO-8601 timestamp when the integration was created
|
|
1209
|
+
*/
|
|
1210
|
+
created_at: string; // date-time
|
|
1211
|
+
/**
|
|
1212
|
+
* ISO-8601 timestamp when the integration was last updated
|
|
1213
|
+
*/
|
|
1214
|
+
updated_at: string; // date-time
|
|
940
1215
|
/**
|
|
941
1216
|
* Integration name
|
|
942
1217
|
*/
|
|
@@ -950,17 +1225,18 @@ declare namespace Components {
|
|
|
950
1225
|
*/
|
|
951
1226
|
access_token_ids?: string[];
|
|
952
1227
|
/**
|
|
953
|
-
*
|
|
1228
|
+
* List of app IDs associated with this integration
|
|
954
1229
|
*/
|
|
955
|
-
|
|
1230
|
+
app_ids?: string[];
|
|
956
1231
|
/**
|
|
957
|
-
*
|
|
1232
|
+
* Configuration defining environment variables needed by this integration. Values are stored in the Environments API.
|
|
958
1233
|
*/
|
|
959
|
-
|
|
1234
|
+
environment_config?: EnvironmentFieldConfig[];
|
|
1235
|
+
settings?: /* Settings for the integration */ IntegrationSettings;
|
|
960
1236
|
/**
|
|
961
|
-
*
|
|
1237
|
+
* All use cases belonging to this integration
|
|
962
1238
|
*/
|
|
963
|
-
|
|
1239
|
+
use_cases: UseCase[];
|
|
964
1240
|
}
|
|
965
1241
|
export interface MappingSimulationRequest {
|
|
966
1242
|
mapping_configuration: IntegrationConfigurationV1 | IntegrationConfigurationV2;
|
|
@@ -1282,7 +1558,7 @@ declare namespace Components {
|
|
|
1282
1558
|
/**
|
|
1283
1559
|
* Use case type
|
|
1284
1560
|
*/
|
|
1285
|
-
type: "inbound" | "outbound" | "outbound";
|
|
1561
|
+
type: "inbound" | "outbound" | "file_proxy" | "outbound";
|
|
1286
1562
|
enabled: boolean;
|
|
1287
1563
|
/**
|
|
1288
1564
|
* Description of the last change made to this use case
|
|
@@ -1969,7 +2245,7 @@ declare namespace Components {
|
|
|
1969
2245
|
end_date?: string;
|
|
1970
2246
|
event_id?: string;
|
|
1971
2247
|
}
|
|
1972
|
-
export interface
|
|
2248
|
+
export interface UpdateFileProxyUseCaseRequest {
|
|
1973
2249
|
/**
|
|
1974
2250
|
* Use case name
|
|
1975
2251
|
*/
|
|
@@ -1985,31 +2261,37 @@ declare namespace Components {
|
|
|
1985
2261
|
/**
|
|
1986
2262
|
* Use case type
|
|
1987
2263
|
*/
|
|
1988
|
-
type?: "
|
|
1989
|
-
configuration?:
|
|
2264
|
+
type?: "file_proxy";
|
|
2265
|
+
configuration?: /**
|
|
2266
|
+
* Configuration for file_proxy use cases. Defines how to authenticate and fetch files from external document systems.
|
|
2267
|
+
*
|
|
2268
|
+
* The file proxy download URL always requires `orgId`, `integrationId`, and `useCaseId` as query parameters.
|
|
2269
|
+
* The `orgId` is included in the signed URL to establish organization context without requiring authentication.
|
|
2270
|
+
* Additional use-case-specific parameters are declared in the `params` array.
|
|
2271
|
+
*
|
|
2272
|
+
*/
|
|
2273
|
+
FileProxyUseCaseConfiguration;
|
|
1990
2274
|
}
|
|
1991
|
-
export interface
|
|
2275
|
+
export interface UpdateInboundUseCaseRequest {
|
|
1992
2276
|
/**
|
|
1993
|
-
*
|
|
2277
|
+
* Use case name
|
|
1994
2278
|
*/
|
|
1995
2279
|
name?: string;
|
|
1996
2280
|
/**
|
|
1997
|
-
*
|
|
1998
|
-
*/
|
|
1999
|
-
description?: string;
|
|
2000
|
-
/**
|
|
2001
|
-
* List of access token IDs to associate with this integration
|
|
2281
|
+
* Whether the use case is enabled
|
|
2002
2282
|
*/
|
|
2003
|
-
|
|
2283
|
+
enabled?: boolean;
|
|
2004
2284
|
/**
|
|
2005
|
-
*
|
|
2285
|
+
* Optional description of this change (like a commit message)
|
|
2006
2286
|
*/
|
|
2007
|
-
|
|
2287
|
+
change_description?: string;
|
|
2008
2288
|
/**
|
|
2009
|
-
*
|
|
2289
|
+
* Use case type
|
|
2010
2290
|
*/
|
|
2011
|
-
|
|
2291
|
+
type?: "inbound";
|
|
2292
|
+
configuration?: /* Configuration for inbound use cases (ERP to epilot) */ InboundIntegrationEventConfiguration;
|
|
2012
2293
|
}
|
|
2294
|
+
export type UpdateIntegrationRequest = IntegrationEditableFields;
|
|
2013
2295
|
export interface UpdateOutboundUseCaseRequest {
|
|
2014
2296
|
/**
|
|
2015
2297
|
* Use case name
|
|
@@ -2029,7 +2311,7 @@ declare namespace Components {
|
|
|
2029
2311
|
type?: "outbound";
|
|
2030
2312
|
configuration?: /* Configuration for outbound use cases. Defines the event that triggers the flow and the webhook mappings. */ OutboundIntegrationEventConfiguration;
|
|
2031
2313
|
}
|
|
2032
|
-
export type UpdateUseCaseRequest = UpdateInboundUseCaseRequest | UpdateOutboundUseCaseRequest;
|
|
2314
|
+
export type UpdateUseCaseRequest = UpdateInboundUseCaseRequest | UpdateOutboundUseCaseRequest | UpdateFileProxyUseCaseRequest;
|
|
2033
2315
|
export interface UpdateUseCaseRequestBase {
|
|
2034
2316
|
/**
|
|
2035
2317
|
* Use case name
|
|
@@ -2059,9 +2341,18 @@ declare namespace Components {
|
|
|
2059
2341
|
*/
|
|
2060
2342
|
description?: string;
|
|
2061
2343
|
/**
|
|
2062
|
-
* List of access token IDs
|
|
2344
|
+
* List of access token IDs associated with this integration
|
|
2063
2345
|
*/
|
|
2064
2346
|
access_token_ids?: string[];
|
|
2347
|
+
/**
|
|
2348
|
+
* List of app IDs associated with this integration
|
|
2349
|
+
*/
|
|
2350
|
+
app_ids?: string[];
|
|
2351
|
+
/**
|
|
2352
|
+
* Configuration defining environment variables needed by this integration. Values are stored in the Environments API.
|
|
2353
|
+
*/
|
|
2354
|
+
environment_config?: EnvironmentFieldConfig[];
|
|
2355
|
+
settings?: /* Settings for the integration */ IntegrationSettings;
|
|
2065
2356
|
/**
|
|
2066
2357
|
* Full list of use cases (declarative). This replaces ALL existing use cases.
|
|
2067
2358
|
* - Use cases with an `id` field matching an existing use case will be updated
|
|
@@ -2071,7 +2362,7 @@ declare namespace Components {
|
|
|
2071
2362
|
*/
|
|
2072
2363
|
use_cases?: EmbeddedUseCaseRequest[];
|
|
2073
2364
|
}
|
|
2074
|
-
export type UseCase = InboundUseCase | OutboundUseCase;
|
|
2365
|
+
export type UseCase = InboundUseCase | OutboundUseCase | FileProxyUseCase;
|
|
2075
2366
|
export interface UseCaseBase {
|
|
2076
2367
|
/**
|
|
2077
2368
|
* Unique identifier for the use case
|
|
@@ -2088,7 +2379,7 @@ declare namespace Components {
|
|
|
2088
2379
|
/**
|
|
2089
2380
|
* Use case type
|
|
2090
2381
|
*/
|
|
2091
|
-
type: "inbound" | "outbound";
|
|
2382
|
+
type: "inbound" | "outbound" | "file_proxy";
|
|
2092
2383
|
enabled: boolean;
|
|
2093
2384
|
/**
|
|
2094
2385
|
* Description of the last change made to this use case
|
|
@@ -2103,7 +2394,7 @@ declare namespace Components {
|
|
|
2103
2394
|
*/
|
|
2104
2395
|
updated_at: string; // date-time
|
|
2105
2396
|
}
|
|
2106
|
-
export type UseCaseHistoryEntry = InboundUseCaseHistoryEntry | OutboundUseCaseHistoryEntry;
|
|
2397
|
+
export type UseCaseHistoryEntry = InboundUseCaseHistoryEntry | OutboundUseCaseHistoryEntry | FileProxyUseCaseHistoryEntry;
|
|
2107
2398
|
export interface UseCaseHistoryEntryBase {
|
|
2108
2399
|
/**
|
|
2109
2400
|
* Unique identifier for this history entry
|
|
@@ -3504,6 +3795,8 @@ export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
|
3504
3795
|
|
|
3505
3796
|
|
|
3506
3797
|
export type AccessLogEntry = Components.Schemas.AccessLogEntry;
|
|
3798
|
+
export type AutoRefreshSettings = Components.Schemas.AutoRefreshSettings;
|
|
3799
|
+
export type CreateFileProxyUseCaseRequest = Components.Schemas.CreateFileProxyUseCaseRequest;
|
|
3507
3800
|
export type CreateInboundUseCaseRequest = Components.Schemas.CreateInboundUseCaseRequest;
|
|
3508
3801
|
export type CreateIntegrationRequest = Components.Schemas.CreateIntegrationRequest;
|
|
3509
3802
|
export type CreateOutboundUseCaseRequest = Components.Schemas.CreateOutboundUseCaseRequest;
|
|
@@ -3522,6 +3815,13 @@ export type ErpEventV3 = Components.Schemas.ErpEventV3;
|
|
|
3522
3815
|
export type ErpUpdatesEventsV2Request = Components.Schemas.ErpUpdatesEventsV2Request;
|
|
3523
3816
|
export type ErpUpdatesEventsV3Request = Components.Schemas.ErpUpdatesEventsV3Request;
|
|
3524
3817
|
export type ErrorResponseBase = Components.Schemas.ErrorResponseBase;
|
|
3818
|
+
export type FileProxyAuth = Components.Schemas.FileProxyAuth;
|
|
3819
|
+
export type FileProxyParam = Components.Schemas.FileProxyParam;
|
|
3820
|
+
export type FileProxyResponseConfig = Components.Schemas.FileProxyResponseConfig;
|
|
3821
|
+
export type FileProxyStep = Components.Schemas.FileProxyStep;
|
|
3822
|
+
export type FileProxyUseCase = Components.Schemas.FileProxyUseCase;
|
|
3823
|
+
export type FileProxyUseCaseConfiguration = Components.Schemas.FileProxyUseCaseConfiguration;
|
|
3824
|
+
export type FileProxyUseCaseHistoryEntry = Components.Schemas.FileProxyUseCaseHistoryEntry;
|
|
3525
3825
|
export type GetMonitoringStatsRequest = Components.Schemas.GetMonitoringStatsRequest;
|
|
3526
3826
|
export type GetMonitoringTimeSeriesRequest = Components.Schemas.GetMonitoringTimeSeriesRequest;
|
|
3527
3827
|
export type InboundIntegrationEventConfiguration = Components.Schemas.InboundIntegrationEventConfiguration;
|
|
@@ -3532,11 +3832,13 @@ export type Integration = Components.Schemas.Integration;
|
|
|
3532
3832
|
export type IntegrationAppMapping = Components.Schemas.IntegrationAppMapping;
|
|
3533
3833
|
export type IntegrationConfigurationV1 = Components.Schemas.IntegrationConfigurationV1;
|
|
3534
3834
|
export type IntegrationConfigurationV2 = Components.Schemas.IntegrationConfigurationV2;
|
|
3835
|
+
export type IntegrationEditableFields = Components.Schemas.IntegrationEditableFields;
|
|
3535
3836
|
export type IntegrationEntity = Components.Schemas.IntegrationEntity;
|
|
3536
3837
|
export type IntegrationEntityField = Components.Schemas.IntegrationEntityField;
|
|
3537
3838
|
export type IntegrationFieldV1 = Components.Schemas.IntegrationFieldV1;
|
|
3538
3839
|
export type IntegrationMeterReading = Components.Schemas.IntegrationMeterReading;
|
|
3539
3840
|
export type IntegrationObjectV1 = Components.Schemas.IntegrationObjectV1;
|
|
3841
|
+
export type IntegrationSettings = Components.Schemas.IntegrationSettings;
|
|
3540
3842
|
export type IntegrationWithUseCases = Components.Schemas.IntegrationWithUseCases;
|
|
3541
3843
|
export type MappingSimulationRequest = Components.Schemas.MappingSimulationRequest;
|
|
3542
3844
|
export type MappingSimulationResponse = Components.Schemas.MappingSimulationResponse;
|
|
@@ -3570,6 +3872,7 @@ export type SetIntegrationAppMappingRequest = Components.Schemas.SetIntegrationA
|
|
|
3570
3872
|
export type TimeSeriesBucket = Components.Schemas.TimeSeriesBucket;
|
|
3571
3873
|
export type TriggerErpActionRequest = Components.Schemas.TriggerErpActionRequest;
|
|
3572
3874
|
export type TriggerWebhookResp = Components.Schemas.TriggerWebhookResp;
|
|
3875
|
+
export type UpdateFileProxyUseCaseRequest = Components.Schemas.UpdateFileProxyUseCaseRequest;
|
|
3573
3876
|
export type UpdateInboundUseCaseRequest = Components.Schemas.UpdateInboundUseCaseRequest;
|
|
3574
3877
|
export type UpdateIntegrationRequest = Components.Schemas.UpdateIntegrationRequest;
|
|
3575
3878
|
export type UpdateOutboundUseCaseRequest = Components.Schemas.UpdateOutboundUseCaseRequest;
|