@epilot/app-client 0.0.18 → 0.0.20

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.
@@ -1 +1 @@
1
- (()=>{"use strict";var e={187:function(e,r,t){var p=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var n=p(t(466));r.default=n.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"servers":[{"url":"https://app.sls.epilot.io"}],"paths":{"/v1/app-configurations":{"get":{"operationId":"listAppConfigurations","parameters":[{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}},"post":{"operationId":"createAppConfiguration","requestBody":{"$ref":"#/components/requestBodies/CreateConfigRequest"},"responses":{}}},"/v1/app-configurations/{appId}":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration"}],"get":{"operationId":"getAppConfiguration","parameters":[{"name":"version","in":"query"}],"responses":{}},"put":{"operationId":"updateAppConfigurationMetadata","requestBody":{"$ref":"#/components/requestBodies/UpdateConfigMetadataRequest"},"responses":{}}},"/v1/app-configurations/{appId}/logo":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration"}],"post":{"operationId":"createLogoUploadUrl","requestBody":{"$ref":"#/components/requestBodies/CreateLogoRequest"},"responses":{}},"delete":{"operationId":"deleteLogo","responses":{}}},"/v1/app-configurations/{appId}/versions":{"get":{"operationId":"listAppVersions","parameters":[{"name":"appId","in":"path","required":true},{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}}},"/v1/app-configurations/{appId}/versions/{version}":{"get":{"operationId":"getAppConfigurationVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}},"delete":{"operationId":"deleteAppVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}},"put":{"operationId":"updateAppVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/UpdateVersionRequest"},"responses":{}}},"/v1/app-configurations/{appId}/versions/{sourceVersion}/clone-to/{targetVersion}":{"post":{"operationId":"cloneAppVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"sourceVersion","in":"path","required":true},{"name":"targetVersion","in":"path","required":true}],"responses":{}}},"/v1/app":{"get":{"operationId":"listInstalledApps","parameters":[{"name":"componentType","in":"query"},{"name":"enabled","in":"query"},{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}}},"/v1/app/{appId}":{"get":{"operationId":"getInstalledApp","parameters":[{"name":"appId","in":"path","required":true}],"responses":{}},"put":{"operationId":"installApp","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/InstallAppRequest"},"responses":{}},"delete":{"operationId":"uninstallApp","parameters":[{"name":"appId","in":"path","required":true}],"responses":{}}},"/v1/app/{appId}/promote-to/{version}":{"post":{"operationId":"promoteAppVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}}}},"components":{"requestBodies":{"CreateLogoRequest":{"required":true,"content":{"application/json":{}}},"UpdateConfigMetadataRequest":{"required":true,"content":{"application/json":{}}},"UpdateVersionRequest":{"required":true,"content":{"application/json":{}}},"CreateConfigRequest":{"required":true,"content":{"application/json":{}}},"InstallAppRequest":{"content":{"application/json":{}}}}}}')}},r={},t=function t(p){var n=r[p];if(void 0!==n)return n.exports;var a=r[p]={exports:{}};return e[p].call(a.exports,a,a.exports,t),a.exports}(187),p=exports;for(var n in t)p[n]=t[n];t.__esModule&&Object.defineProperty(p,"__esModule",{value:!0})})();
1
+ (()=>{"use strict";var e={187:function(e,r,t){var p=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var n=p(t(466));r.default=n.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"servers":[{"url":"https://app.sls.epilot.io"}],"paths":{"/v1/app-configurations":{"get":{"operationId":"listAppConfigurations","parameters":[{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}},"post":{"operationId":"createAppConfiguration","requestBody":{"$ref":"#/components/requestBodies/CreateConfigRequest"},"responses":{}}},"/v1/app-configurations/{appId}":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration"}],"get":{"operationId":"getAppConfiguration","parameters":[{"name":"version","in":"query"}],"responses":{}},"patch":{"operationId":"patchConfigurationMetadata","requestBody":{"$ref":"#/components/requestBodies/PatchConfigMetadataRequest"},"responses":{}}},"/v1/app-configurations/{appId}/logo":{"parameters":[{"name":"appId","in":"path","required":true,"description":"ID of the app configuration"}],"post":{"operationId":"createLogoUploadUrl","requestBody":{"$ref":"#/components/requestBodies/CreateLogoRequest"},"responses":{}},"delete":{"operationId":"deleteLogo","responses":{}}},"/v1/app-configurations/{appId}/versions":{"get":{"operationId":"listAppVersions","parameters":[{"name":"appId","in":"path","required":true},{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}}},"/v1/app-configurations/{appId}/versions/{version}":{"get":{"operationId":"getAppConfigurationVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}},"delete":{"operationId":"deleteAppVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}},"put":{"operationId":"updateAppVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/UpdateVersionRequest"},"responses":{}}},"/v1/app-configurations/{appId}/versions/{sourceVersion}/clone-to/{targetVersion}":{"post":{"operationId":"cloneAppVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"sourceVersion","in":"path","required":true},{"name":"targetVersion","in":"path","required":true}],"responses":{}}},"/v1/app":{"get":{"operationId":"listInstalledApps","parameters":[{"name":"componentType","in":"query"},{"name":"enabled","in":"query"},{"name":"page","in":"query"},{"name":"pageSize","in":"query"}],"responses":{}}},"/v1/app/{appId}":{"get":{"operationId":"getInstalledApp","parameters":[{"name":"appId","in":"path","required":true}],"responses":{}},"put":{"operationId":"installApp","parameters":[{"name":"appId","in":"path","required":true}],"requestBody":{"$ref":"#/components/requestBodies/InstallAppRequest"},"responses":{}},"delete":{"operationId":"uninstallApp","parameters":[{"name":"appId","in":"path","required":true}],"responses":{}}},"/v1/app/{appId}/promote-to/{version}":{"post":{"operationId":"promoteAppVersion","parameters":[{"name":"appId","in":"path","required":true},{"name":"version","in":"path","required":true}],"responses":{}}}},"components":{"requestBodies":{"CreateLogoRequest":{"required":true,"content":{"application/json":{}}},"PatchConfigMetadataRequest":{"required":true,"content":{"application/json":{}}},"UpdateVersionRequest":{"required":true,"content":{"application/json":{}}},"CreateConfigRequest":{"required":true,"content":{"application/json":{}}},"InstallAppRequest":{"content":{"application/json":{}}}}}}')}},r={},t=function t(p){var n=r[p];if(void 0!==n)return n.exports;var a=r[p]={exports:{}};return e[p].call(a.exports,a,a.exports,t),a.exports}(187),p=exports;for(var n in t)p[n]=t[n];t.__esModule&&Object.defineProperty(p,"__esModule",{value:!0})})();
@@ -52,10 +52,10 @@
52
52
  ],
53
53
  "responses": {}
54
54
  },
55
- "put": {
56
- "operationId": "updateAppConfigurationMetadata",
55
+ "patch": {
56
+ "operationId": "patchConfigurationMetadata",
57
57
  "requestBody": {
58
- "$ref": "#/components/requestBodies/UpdateConfigMetadataRequest"
58
+ "$ref": "#/components/requestBodies/PatchConfigMetadataRequest"
59
59
  },
60
60
  "responses": {}
61
61
  }
@@ -267,7 +267,7 @@
267
267
  "application/json": {}
268
268
  }
269
269
  },
270
- "UpdateConfigMetadataRequest": {
270
+ "PatchConfigMetadataRequest": {
271
271
  "required": true,
272
272
  "content": {
273
273
  "application/json": {}
package/dist/openapi.d.ts CHANGED
@@ -39,9 +39,9 @@ declare namespace Components {
39
39
  */
40
40
  option_values?: Schemas.OptionsRef[];
41
41
  }
42
- export interface UpdateConfigMetadataRequest {
43
- name: Schemas.TranslatedString;
44
- description: Schemas.TranslatedString;
42
+ export interface PatchConfigMetadataRequest {
43
+ name?: Schemas.TranslatedString;
44
+ description?: Schemas.TranslatedString;
45
45
  category?: string;
46
46
  documentation_url?: string;
47
47
  homepage_url?: string;
@@ -460,9 +460,6 @@ declare namespace Components {
460
460
  }[]
461
461
  ];
462
462
  }
463
- export interface FreePricing {
464
- pricing_type: "FREE";
465
- }
466
463
  export interface JourneyBlockComponent {
467
464
  component_type: "CUSTOM_JOURNEY_BLOCK";
468
465
  configuration: JourneyBlockConfig;
@@ -604,7 +601,10 @@ declare namespace Components {
604
601
  };
605
602
  }[];
606
603
  }
607
- export type Pricing = FreePricing | SubscriptionPricing | UsageBasedPricing;
604
+ export interface Pricing {
605
+ pricing_type?: "FREE" | "SUBSCRIPTION" | "USAGE_BASED";
606
+ billing_frequency?: /* How often the subscription is billed */ BillingFrequency;
607
+ }
608
608
  export interface S3Reference {
609
609
  /**
610
610
  * The name of the S3 bucket where the JSON file for import is stored.
@@ -619,10 +619,6 @@ declare namespace Components {
619
619
  */
620
620
  key: string;
621
621
  }
622
- export interface SubscriptionPricing {
623
- pricing_type: "SUBSCRIPTION";
624
- billing_frequency: /* How often the subscription is billed */ BillingFrequency;
625
- }
626
622
  export interface TextArg {
627
623
  type?: "text";
628
624
  }
@@ -642,9 +638,6 @@ declare namespace Components {
642
638
  */
643
639
  app_id?: string;
644
640
  }
645
- export interface UsageBasedPricing {
646
- pricing_type: "USAGE_BASED";
647
- }
648
641
  }
649
642
  }
650
643
  declare namespace Paths {
@@ -849,6 +842,15 @@ declare namespace Paths {
849
842
  }
850
843
  }
851
844
  }
845
+ namespace PatchConfigurationMetadata {
846
+ export type RequestBody = Components.RequestBodies.PatchConfigMetadataRequest;
847
+ namespace Responses {
848
+ export interface $204 {
849
+ }
850
+ export interface $404 {
851
+ }
852
+ }
853
+ }
852
854
  namespace PromoteAppVersion {
853
855
  namespace Parameters {
854
856
  export type AppId = string;
@@ -880,15 +882,6 @@ declare namespace Paths {
880
882
  }
881
883
  }
882
884
  }
883
- namespace UpdateAppConfigurationMetadata {
884
- export type RequestBody = Components.RequestBodies.UpdateConfigMetadataRequest;
885
- namespace Responses {
886
- export interface $204 {
887
- }
888
- export interface $404 {
889
- }
890
- }
891
- }
892
885
  namespace UpdateAppVersion {
893
886
  namespace Parameters {
894
887
  export type AppId = string;
@@ -958,15 +951,15 @@ export interface OperationMethods {
958
951
  config?: AxiosRequestConfig
959
952
  ): OperationResponse<Paths.GetAppConfiguration.Responses.$200>
960
953
  /**
961
- * updateAppConfigurationMetadata - updateAppConfigurationMetadata
954
+ * patchConfigurationMetadata - patchConfigurationMetadata
962
955
  *
963
- * Update non-versioned configuration metadata of a given app configuration.
956
+ * Patch non-versioned configuration metadata of a given app configuration.
964
957
  */
965
- 'updateAppConfigurationMetadata'(
958
+ 'patchConfigurationMetadata'(
966
959
  parameters?: Parameters<Paths.V1AppConfigurations$AppId.PathParameters> | null,
967
- data?: Paths.UpdateAppConfigurationMetadata.RequestBody,
960
+ data?: Paths.PatchConfigurationMetadata.RequestBody,
968
961
  config?: AxiosRequestConfig
969
- ): OperationResponse<Paths.UpdateAppConfigurationMetadata.Responses.$204>
962
+ ): OperationResponse<Paths.PatchConfigurationMetadata.Responses.$204>
970
963
  /**
971
964
  * createLogoUploadUrl - createLogoUploadUrl
972
965
  *
@@ -1124,15 +1117,15 @@ export interface PathsDictionary {
1124
1117
  config?: AxiosRequestConfig
1125
1118
  ): OperationResponse<Paths.GetAppConfiguration.Responses.$200>
1126
1119
  /**
1127
- * updateAppConfigurationMetadata - updateAppConfigurationMetadata
1120
+ * patchConfigurationMetadata - patchConfigurationMetadata
1128
1121
  *
1129
- * Update non-versioned configuration metadata of a given app configuration.
1122
+ * Patch non-versioned configuration metadata of a given app configuration.
1130
1123
  */
1131
- 'put'(
1124
+ 'patch'(
1132
1125
  parameters?: Parameters<Paths.V1AppConfigurations$AppId.PathParameters> | null,
1133
- data?: Paths.UpdateAppConfigurationMetadata.RequestBody,
1126
+ data?: Paths.PatchConfigurationMetadata.RequestBody,
1134
1127
  config?: AxiosRequestConfig
1135
- ): OperationResponse<Paths.UpdateAppConfigurationMetadata.Responses.$204>
1128
+ ): OperationResponse<Paths.PatchConfigurationMetadata.Responses.$204>
1136
1129
  }
1137
1130
  ['/v1/app-configurations/{appId}/logo']: {
1138
1131
  /**
@@ -1284,7 +1277,6 @@ export type BooleanArg = Components.Schemas.BooleanArg;
1284
1277
  export type CallerIdentity = Components.Schemas.CallerIdentity;
1285
1278
  export type ComponentType = Components.Schemas.ComponentType;
1286
1279
  export type EnumArg = Components.Schemas.EnumArg;
1287
- export type FreePricing = Components.Schemas.FreePricing;
1288
1280
  export type JourneyBlockComponent = Components.Schemas.JourneyBlockComponent;
1289
1281
  export type JourneyBlockComponentArgs = Components.Schemas.JourneyBlockComponentArgs;
1290
1282
  export type JourneyBlockConfig = Components.Schemas.JourneyBlockConfig;
@@ -1298,8 +1290,6 @@ export type PortalExtensionComponent = Components.Schemas.PortalExtensionCompone
1298
1290
  export type PortalExtensionConfig = Components.Schemas.PortalExtensionConfig;
1299
1291
  export type Pricing = Components.Schemas.Pricing;
1300
1292
  export type S3Reference = Components.Schemas.S3Reference;
1301
- export type SubscriptionPricing = Components.Schemas.SubscriptionPricing;
1302
1293
  export type TextArg = Components.Schemas.TextArg;
1303
1294
  export type TranslatedString = Components.Schemas.TranslatedString;
1304
1295
  export type UploadFilePayload = Components.Schemas.UploadFilePayload;
1305
- export type UsageBasedPricing = Components.Schemas.UsageBasedPricing;
package/dist/openapi.json CHANGED
@@ -153,16 +153,16 @@
153
153
  }
154
154
  }
155
155
  },
156
- "put": {
157
- "summary": "updateAppConfigurationMetadata",
158
- "description": "Update non-versioned configuration metadata of a given app configuration.",
159
- "operationId": "updateAppConfigurationMetadata",
156
+ "patch": {
157
+ "summary": "patchConfigurationMetadata",
158
+ "description": "Patch non-versioned configuration metadata of a given app configuration.",
159
+ "operationId": "patchConfigurationMetadata",
160
160
  "requestBody": {
161
- "$ref": "#/components/requestBodies/UpdateConfigMetadataRequest"
161
+ "$ref": "#/components/requestBodies/PatchConfigMetadataRequest"
162
162
  },
163
163
  "responses": {
164
164
  "204": {
165
- "description": "Configuration updated successfully"
165
+ "description": "Configuration patched successfully"
166
166
  },
167
167
  "404": {
168
168
  "description": "App configuration not found"
@@ -731,16 +731,12 @@
731
731
  }
732
732
  }
733
733
  },
734
- "UpdateConfigMetadataRequest": {
734
+ "PatchConfigMetadataRequest": {
735
735
  "required": true,
736
736
  "content": {
737
737
  "application/json": {
738
738
  "schema": {
739
739
  "type": "object",
740
- "required": [
741
- "name",
742
- "description"
743
- ],
744
740
  "properties": {
745
741
  "name": {
746
742
  "$ref": "#/components/schemas/TranslatedString"
@@ -1396,72 +1392,20 @@
1396
1392
  "description": "How often the subscription is billed"
1397
1393
  },
1398
1394
  "Pricing": {
1399
- "type": "object",
1400
- "discriminator": {
1401
- "propertyName": "pricing_type",
1402
- "mapping": {
1403
- "FREE": "#/components/schemas/FreePricing",
1404
- "SUBSCRIPTION": "#/components/schemas/SubscriptionPricing",
1405
- "USAGE_BASED": "#/components/schemas/UsageBasedPricing"
1406
- }
1407
- },
1408
- "oneOf": [
1409
- {
1410
- "$ref": "#/components/schemas/FreePricing"
1411
- },
1412
- {
1413
- "$ref": "#/components/schemas/SubscriptionPricing"
1414
- },
1415
- {
1416
- "$ref": "#/components/schemas/UsageBasedPricing"
1417
- }
1418
- ]
1419
- },
1420
- "FreePricing": {
1421
- "type": "object",
1422
- "properties": {
1423
- "pricing_type": {
1424
- "type": "string",
1425
- "enum": [
1426
- "FREE"
1427
- ]
1428
- }
1429
- },
1430
- "required": [
1431
- "pricing_type"
1432
- ]
1433
- },
1434
- "SubscriptionPricing": {
1435
1395
  "type": "object",
1436
1396
  "properties": {
1437
1397
  "pricing_type": {
1438
1398
  "type": "string",
1439
1399
  "enum": [
1440
- "SUBSCRIPTION"
1400
+ "FREE",
1401
+ "SUBSCRIPTION",
1402
+ "USAGE_BASED"
1441
1403
  ]
1442
1404
  },
1443
1405
  "billing_frequency": {
1444
1406
  "$ref": "#/components/schemas/BillingFrequency"
1445
1407
  }
1446
- },
1447
- "required": [
1448
- "pricing_type",
1449
- "billing_frequency"
1450
- ]
1451
- },
1452
- "UsageBasedPricing": {
1453
- "type": "object",
1454
- "properties": {
1455
- "pricing_type": {
1456
- "type": "string",
1457
- "enum": [
1458
- "USAGE_BASED"
1459
- ]
1460
- }
1461
- },
1462
- "required": [
1463
- "pricing_type"
1464
- ]
1408
+ }
1465
1409
  },
1466
1410
  "AppMetadata": {
1467
1411
  "description": "Basic metadata about your app configuration which does not get versioned",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/app-client",
3
- "version": "0.0.18",
3
+ "version": "0.0.20",
4
4
  "description": "JavaScript client library for the epilot App API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",