@ampsec/platform-client 27.2.0 → 27.4.0

package/build/src/dto/findings.dto.d.ts

@@ -2,6 +2,12 @@ import { BaseDto, BaseUpsertDto } from './base.dto';
 import { Category, FindingKind } from './enums';
 import { FindingSeverity } from './enums/finding.severity';
 import { FindingStatus } from './enums/finding.status';
+export type FindingsStatusPathDto = {
+    /** Id of the connector to which the finding applies */
+    id: string;
+    /** Status of the finding, e.g. OPEN */
+    status: FindingStatus.PENDING_VERIFICATION | FindingStatus.OPEN;
+};
 export type FindingUpsertDto = BaseUpsertDto & {
     /** Date the finding was closed */
     closedAt?: string;

package/build/src/services/AmpApi.d.ts

@@ -6,6 +6,7 @@ import { AmpReportService } from './reports.service';
 import { EnumService } from './rest/EnumService';
 import { AmpSettingsService } from './settings.service';
 import { AgentIdentityService } from './rest/AgentIdentityService';
+import { ConnectorInstallService } from './rest/ConnectorInstallService';
 export type AmpApiOptions = AmpRestClientOptions;
 /**
  * AMP API
@@ -26,6 +27,7 @@ export declare class AmpApi {
     readonly enums: EnumService;
     readonly findings: AmpDataService<FindingDto>;
     readonly identity: AgentIdentityService;
+    readonly install: ConnectorInstallService;
     readonly notifications: AmpDataService<NotificationDto>;
     readonly providers: AmpDataService<ProviderDto>;
     readonly reportResults: AmpDataService<ReportResultDto>;

package/build/src/services/AmpApi.js

@@ -9,6 +9,7 @@ const reports_service_1 = require("./reports.service");
 const EnumService_1 = require("./rest/EnumService");
 const settings_service_1 = require("./settings.service");
 const AgentIdentityService_1 = require("./rest/AgentIdentityService");
+const ConnectorInstallService_1 = require("./rest/ConnectorInstallService");
 /**
  * AMP API
  * This client is a wrapper around the AMP REST API meant to be used by
@@ -29,6 +30,7 @@ class AmpApi {
         this.enums = new EnumService_1.DefaultEnumService(rest);
         this.findings = new data_service_1.AmpDataServiceImpl(rest, constants_1.KIND.FINDINGS);
         this.identity = new AgentIdentityService_1.AgentIdentityService(rest);
+        this.install = new ConnectorInstallService_1.ConnectorInstallService(rest);
         this.notifications = new data_service_1.AmpDataServiceImpl(rest, constants_1.KIND.NOTIFICATIONS);
         this.providers = new data_service_1.AmpDataServiceImpl(rest, constants_1.KIND.PROVIDERS);
         this.reportResults = new data_service_1.AmpDataServiceImpl(rest, constants_1.KIND.REPORT_RESULTS);

package/build/src/services/AmpApi.js.map

@@ -1 +1 @@
-{"version":3,"file":"AmpApi.js","sourceRoot":"","sources":["../../../src/services/AmpApi.ts"],"names":[],"mappings":";;;AAiBA,qDAAwE;AACxE,iDAAkE;AAClE,iCAA0E;AAC1E,2CAAiC;AACjC,uDAAyE;AACzE,oDAAmE;AACnE,yDAAsD;AACtD,sEAAiE;AAIjE;;;;;;;;;;;GAWG;AACH,MAAa,MAAM;IAkBjB,YAAY,IAAgB;QAC1B,IAAI,CAAC,MAAM,GAAG,IAAI,qCAAoB,CAA2B,IAAI,EAAE,gBAAI,CAAC,MAAM,CAAC,CAAC;QACpF,IAAI,CAAC,KAAK,GAAG,IAAI,iCAAkB,CAAW,IAAI,EAAE,gBAAI,CAAC,MAAM,CAAC,CAAC;QACjE,IAAI,CAAC,UAAU,GAAG,IAAI,qCAAoB,CAAmC,IAAI,EAAE,gBAAI,CAAC,UAAU,CAAC,CAAC;QACpG,IAAI,CAAC,KAAK,GAAG,IAAI,gCAAkB,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,CAAC,QAAQ,GAAG,IAAI,iCAAkB,CAAa,IAAI,EAAE,gBAAI,CAAC,QAAQ,CAAC,CAAC;QACxE,IAAI,CAAC,QAAQ,GAAG,IAAI,2CAAoB,CAAC,IAAI,CAAC,CAAC;QAC/C,IAAI,CAAC,aAAa,GAAG,IAAI,iCAAkB,CAAkB,IAAI,EAAE,gBAAI,CAAC,aAAa,CAAC,CAAC;QACvF,IAAI,CAAC,SAAS,GAAG,IAAI,iCAAkB,CAAc,IAAI,EAAE,gBAAI,CAAC,SAAS,CAAC,CAAC;QAC3E,IAAI,CAAC,aAAa,GAAG,IAAI,iCAAkB,CAAkB,IAAI,EAAE,gBAAI,CAAC,cAAc,CAAC,CAAC;QACxF,IAAI,CAAC,OAAO,GAAG,IAAI,sCAAoB,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,UAAU,GAAG,IAAI,iCAAkB,CAAe,IAAI,EAAE,gBAAI,CAAC,WAAW,CAAC,CAAC;QAC/E,IAAI,CAAC,cAAc,GAAG,IAAI,iCAAkB,CAAmB,IAAI,EAAE,gBAAI,CAAC,eAAe,CAAC,CAAC;QAC3F,IAAI,CAAC,SAAS,GAAG,IAAI,iCAAkB,CAAc,IAAI,EAAE,gBAAI,CAAC,UAAU,CAAC,CAAC;QAC5E,IAAI,CAAC,QAAQ,GAAG,IAAI,qCAAkB,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,CAAC,OAAO,GAAG,IAAI,qCAAoB,CAA6B,IAAI,EAAE,gBAAI,CAAC,OAAO,CAAC,CAAC;QACxF,IAAI,CAAC,KAAK,GAAG,IAAI,iCAAkB,CAAU,IAAI,EAAE,gBAAI,CAAC,KAAK,CAAC,CAAC;IACjE,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,OAAsB;QACpC,MAAM,IAAI,GAAG,IAAA,uBAAgB,EAAC,OAAO,CAAC,CAAC;QACvC,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;CACF;AAzCD,wBAyCC"}
+{"version":3,"file":"AmpApi.js","sourceRoot":"","sources":["../../../src/services/AmpApi.ts"],"names":[],"mappings":";;;AAiBA,qDAAwE;AACxE,iDAAkE;AAClE,iCAA0E;AAC1E,2CAAiC;AACjC,uDAAyE;AACzE,oDAAmE;AACnE,yDAAsD;AACtD,sEAAiE;AACjE,4EAAuE;AAIvE;;;;;;;;;;;GAWG;AACH,MAAa,MAAM;IAmBjB,YAAY,IAAgB;QAC1B,IAAI,CAAC,MAAM,GAAG,IAAI,qCAAoB,CAA2B,IAAI,EAAE,gBAAI,CAAC,MAAM,CAAC,CAAC;QACpF,IAAI,CAAC,KAAK,GAAG,IAAI,iCAAkB,CAAW,IAAI,EAAE,gBAAI,CAAC,MAAM,CAAC,CAAC;QACjE,IAAI,CAAC,UAAU,GAAG,IAAI,qCAAoB,CAAmC,IAAI,EAAE,gBAAI,CAAC,UAAU,CAAC,CAAC;QACpG,IAAI,CAAC,KAAK,GAAG,IAAI,gCAAkB,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,CAAC,QAAQ,GAAG,IAAI,iCAAkB,CAAa,IAAI,EAAE,gBAAI,CAAC,QAAQ,CAAC,CAAC;QACxE,IAAI,CAAC,QAAQ,GAAG,IAAI,2CAAoB,CAAC,IAAI,CAAC,CAAC;QAC/C,IAAI,CAAC,OAAO,GAAG,IAAI,iDAAuB,CAAC,IAAI,CAAC,CAAC;QACjD,IAAI,CAAC,aAAa,GAAG,IAAI,iCAAkB,CAAkB,IAAI,EAAE,gBAAI,CAAC,aAAa,CAAC,CAAC;QACvF,IAAI,CAAC,SAAS,GAAG,IAAI,iCAAkB,CAAc,IAAI,EAAE,gBAAI,CAAC,SAAS,CAAC,CAAC;QAC3E,IAAI,CAAC,aAAa,GAAG,IAAI,iCAAkB,CAAkB,IAAI,EAAE,gBAAI,CAAC,cAAc,CAAC,CAAC;QACxF,IAAI,CAAC,OAAO,GAAG,IAAI,sCAAoB,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,UAAU,GAAG,IAAI,iCAAkB,CAAe,IAAI,EAAE,gBAAI,CAAC,WAAW,CAAC,CAAC;QAC/E,IAAI,CAAC,cAAc,GAAG,IAAI,iCAAkB,CAAmB,IAAI,EAAE,gBAAI,CAAC,eAAe,CAAC,CAAC;QAC3F,IAAI,CAAC,SAAS,GAAG,IAAI,iCAAkB,CAAc,IAAI,EAAE,gBAAI,CAAC,UAAU,CAAC,CAAC;QAC5E,IAAI,CAAC,QAAQ,GAAG,IAAI,qCAAkB,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,CAAC,OAAO,GAAG,IAAI,qCAAoB,CAA6B,IAAI,EAAE,gBAAI,CAAC,OAAO,CAAC,CAAC;QACxF,IAAI,CAAC,KAAK,GAAG,IAAI,iCAAkB,CAAU,IAAI,EAAE,gBAAI,CAAC,KAAK,CAAC,CAAC;IACjE,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,OAAsB;QACpC,MAAM,IAAI,GAAG,IAAA,uBAAgB,EAAC,OAAO,CAAC,CAAC;QACvC,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;CACF;AA3CD,wBA2CC"}

package/build/src/services/AmpSdk.d.ts

@@ -11,7 +11,7 @@ export type AmpSdkOptions = AmpRestClientOptions;
  * This client is a wrapper around the AMP REST API meant to be used by
  * service accounts, i.e. plugins and platform extensions. If you are
  * trying to implement a simple web client you should leverage the AmpApi
- * instead (see {@link AmpApi} ).
+ * of EngageApi instead (see {@link AmpApi} and {@link EngageApi} ).
  *
  * This client provides CRUD access to all of the AMP API.
  */

package/build/src/services/AmpSdk.js

@@ -11,7 +11,7 @@ const settings_service_1 = require("./settings.service");
  * This client is a wrapper around the AMP REST API meant to be used by
  * service accounts, i.e. plugins and platform extensions. If you are
  * trying to implement a simple web client you should leverage the AmpApi
- * instead (see {@link AmpApi} ).
+ * of EngageApi instead (see {@link AmpApi} and {@link EngageApi} ).
  *
  * This client provides CRUD access to all of the AMP API.
  */

package/build/src/services/EngageApi.d.ts

@@ -0,0 +1,37 @@
+import { ConnectorDto, FindingDto, FindingsStatusPathDto as FindingsStatusPatchDto, NotificationDto, ProviderDto } from '../dto';
+import { AmpDataService, AmpPatchDataService } from './data.service';
+import { AmpRestClientOptions, RestClient } from './rest';
+import { AmpReportService } from './reports.service';
+import { AmpSettingsService } from './settings.service';
+import { UserIdentityService } from './rest/UserIdentityService';
+export type EngageApiOptions = AmpRestClientOptions;
+/**
+ * Engage API
+ * This client is a wrapper around the AMP REST API meant to be used by
+ * end users, i.e. Amplifier Security's managed users. If you are trying to implement
+ * a plugin leverage the AmpSdk instead (see {@link AmpSdkServices} ), or
+ * a an extension for Agents use AmpApi instead (see {@link AmpApi}).
+ *
+ * This client provides READ_ONLY access to The folloing resoureces:
+ * - Connectors: {@link EngageApi.connectors}
+ * - Findings: {@link EngageApi.findings}
+ * - Identity: {@link EngageApi.identity}
+ * - Notifications: {@link EngageApi.notifications}
+ * - Providers: {@link EngageApi.providers}
+ * - Reporting: {@link EngageApi.reports}
+ * - Settings: {@link EngageApi.settings}
+ *
+ * This client provides PATCH access to The folloing resoureces:
+ * - Findings: {@link EngageApi.findings}
+ */
+export declare class EngageApi {
+    readonly connectors: AmpDataService<ConnectorDto>;
+    readonly findings: AmpPatchDataService<FindingsStatusPatchDto, FindingDto>;
+    readonly identity: UserIdentityService;
+    readonly notifications: AmpDataService<NotificationDto>;
+    readonly providers: AmpDataService<ProviderDto>;
+    readonly reports: AmpReportService;
+    readonly settings: AmpSettingsService;
+    constructor(rest: RestClient);
+    static instance(options: EngageApiOptions): EngageApi;
+}

package/build/src/services/EngageApi.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EngageApi = void 0;
+const entity_service_1 = require("./entity.service");
+const data_service_1 = require("./data.service");
+const rest_1 = require("./rest");
+const constants_1 = require("./constants");
+const reports_service_1 = require("./reports.service");
+const settings_service_1 = require("./settings.service");
+const UserIdentityService_1 = require("./rest/UserIdentityService");
+/**
+ * Engage API
+ * This client is a wrapper around the AMP REST API meant to be used by
+ * end users, i.e. Amplifier Security's managed users. If you are trying to implement
+ * a plugin leverage the AmpSdk instead (see {@link AmpSdkServices} ), or
+ * a an extension for Agents use AmpApi instead (see {@link AmpApi}).
+ *
+ * This client provides READ_ONLY access to The folloing resoureces:
+ * - Connectors: {@link EngageApi.connectors}
+ * - Findings: {@link EngageApi.findings}
+ * - Identity: {@link EngageApi.identity}
+ * - Notifications: {@link EngageApi.notifications}
+ * - Providers: {@link EngageApi.providers}
+ * - Reporting: {@link EngageApi.reports}
+ * - Settings: {@link EngageApi.settings}
+ *
+ * This client provides PATCH access to The folloing resoureces:
+ * - Findings: {@link EngageApi.findings}
+ */
+class EngageApi {
+    constructor(rest) {
+        this.connectors = new entity_service_1.AmpEntityServiceImpl(rest, constants_1.KIND.CONNECTORS, constants_1.TARGET_API_ENGAGE); // TODO: add /eng endpoint... needed?
+        this.findings = new data_service_1.AmpPatchDataServiceImpl(rest, constants_1.KIND.FINDINGS, constants_1.TARGET_API_ENGAGE);
+        this.identity = new UserIdentityService_1.UserIdentityService(rest);
+        this.notifications = new data_service_1.AmpDataServiceImpl(rest, constants_1.KIND.NOTIFICATIONS, constants_1.TARGET_API_ENGAGE); // TODO: add /eng endpoint
+        this.providers = new data_service_1.AmpDataServiceImpl(rest, constants_1.KIND.PROVIDERS, constants_1.TARGET_API_ENGAGE); // TODO: add /eng endpoint... needed?
+        this.reports = new reports_service_1.AmpReportServiceImpl(rest);
+        this.settings = new settings_service_1.AmpSettingsService(rest); // TODO: add /eng endpoint
+    }
+    static instance(options) {
+        const rest = (0, rest_1.getAmpRestClient)(options);
+        return new EngageApi(rest);
+    }
+}
+exports.EngageApi = EngageApi;
+//# sourceMappingURL=EngageApi.js.map

package/build/src/services/EngageApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EngageApi.js","sourceRoot":"","sources":["../../../src/services/EngageApi.ts"],"names":[],"mappings":";;;AACA,qDAAsD;AACtD,iDAAgH;AAChH,iCAA0E;AAC1E,2CAAoD;AACpD,uDAAyE;AACzE,yDAAsD;AACtD,oEAA+D;AAI/D;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAa,SAAS;IASpB,YAAY,IAAgB;QAC1B,IAAI,CAAC,UAAU,GAAG,IAAI,qCAAoB,CAAmC,IAAI,EAAE,gBAAI,CAAC,UAAU,EAAE,6BAAiB,CAAC,CAAC,CAAC,qCAAqC;QAC7J,IAAI,CAAC,QAAQ,GAAG,IAAI,sCAAuB,CAAqC,IAAI,EAAE,gBAAI,CAAC,QAAQ,EAAE,6BAAiB,CAAC,CAAC;QACxH,IAAI,CAAC,QAAQ,GAAG,IAAI,yCAAmB,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,aAAa,GAAG,IAAI,iCAAkB,CAAkB,IAAI,EAAE,gBAAI,CAAC,aAAa,EAAE,6BAAiB,CAAC,CAAC,CAAC,0BAA0B;QACrI,IAAI,CAAC,SAAS,GAAG,IAAI,iCAAkB,CAAc,IAAI,EAAE,gBAAI,CAAC,SAAS,EAAE,6BAAiB,CAAC,CAAC,CAAC,qCAAqC;QACpI,IAAI,CAAC,OAAO,GAAG,IAAI,sCAAoB,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,QAAQ,GAAG,IAAI,qCAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,0BAA0B;IAC1E,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,OAAyB;QACvC,MAAM,IAAI,GAAG,IAAA,uBAAgB,EAAC,OAAO,CAAC,CAAC;QACvC,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;CACF;AAvBD,8BAuBC"}

package/build/src/services/constants.d.ts

@@ -2,9 +2,10 @@ export interface ErrorHandler<T> {
     (_error: unknown): T;
 }
 export declare const DEFAULT_TREND_WINDOW_MONTHS = 6;
-export type TargetApi = 'api' | 'platform';
+export type TargetApi = 'api' | 'platform' | 'eng';
 export declare const TARGET_API_PLATFORM: TargetApi;
 export declare const TARGET_API_AGENT: TargetApi;
+export declare const TARGET_API_ENGAGE: TargetApi;
 export declare const KIND: {
     AGENTS: string;
     ASSETS: string;

package/build/src/services/constants.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.REPORTS = exports.KIND = exports.TARGET_API_AGENT = exports.TARGET_API_PLATFORM = exports.DEFAULT_TREND_WINDOW_MONTHS = void 0;
+exports.REPORTS = exports.KIND = exports.TARGET_API_ENGAGE = exports.TARGET_API_AGENT = exports.TARGET_API_PLATFORM = exports.DEFAULT_TREND_WINDOW_MONTHS = void 0;
 exports.DEFAULT_TREND_WINDOW_MONTHS = 6;
 exports.TARGET_API_PLATFORM = 'platform';
 exports.TARGET_API_AGENT = 'api';
+exports.TARGET_API_ENGAGE = 'eng';
 exports.KIND = {
     AGENTS: 'agents',
     ASSETS: 'assets',

package/build/src/services/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/services/constants.ts"],"names":[],"mappings":";;;AAIa,QAAA,2BAA2B,GAAG,CAAC,CAAC;AAGhC,QAAA,mBAAmB,GAAc,UAAU,CAAC;AAC5C,QAAA,gBAAgB,GAAc,KAAK,CAAC;AAEpC,QAAA,IAAI,GAAG;IAClB,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,UAAU,EAAE,YAAY;IACxB,gBAAgB,EAAE,aAAa;IAC/B,kBAAkB,EAAE,eAAe;IACnC,WAAW,EAAE,QAAQ;IACrB,QAAQ,EAAE,UAAU;IACpB,cAAc,EAAE,gBAAgB;IAChC,QAAQ,EAAE,MAAM;IAChB,aAAa,EAAE,eAAe;IAC9B,SAAS,EAAE,WAAW;IACtB,cAAc,EAAE,gBAAgB;IAChC,iBAAiB,EAAE,mBAAmB;IACtC,WAAW,EAAE,aAAa;IAC1B,eAAe,EAAE,iBAAiB;IAClC,UAAU,EAAE,YAAY;IACxB,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;IACd,iBAAiB,EAAE,oBAAoB;CACxC,CAAC;AAEW,QAAA,OAAO,GAAG;IACrB,YAAY,EAAE,cAAc;IAC5B,yBAAyB,EAAE,qCAAqC;IAChE,yBAAyB,EAAE,qCAAqC;IAChE,gBAAgB,EAAE,kBAAkB;IACpC,iBAAiB,EAAE,mBAAmB;IACtC,qBAAqB,EAAE,uBAAuB;IAC9C,2BAA2B,EAAE,6BAA6B;IAC1D,YAAY,EAAE,0BAA0B;IACxC,qBAAqB,EAAE,uBAAuB;IAC9C,gBAAgB,EAAE,kBAAkB;IACpC,WAAW,EAAE,aAAa;IAC1B,mBAAmB;IACnB,kBAAkB,EAAE,sBAAsB;CAC3C,CAAC"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/services/constants.ts"],"names":[],"mappings":";;;AAIa,QAAA,2BAA2B,GAAG,CAAC,CAAC;AAGhC,QAAA,mBAAmB,GAAc,UAAU,CAAC;AAC5C,QAAA,gBAAgB,GAAc,KAAK,CAAC;AACpC,QAAA,iBAAiB,GAAc,KAAK,CAAC;AAErC,QAAA,IAAI,GAAG;IAClB,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,UAAU,EAAE,YAAY;IACxB,gBAAgB,EAAE,aAAa;IAC/B,kBAAkB,EAAE,eAAe;IACnC,WAAW,EAAE,QAAQ;IACrB,QAAQ,EAAE,UAAU;IACpB,cAAc,EAAE,gBAAgB;IAChC,QAAQ,EAAE,MAAM;IAChB,aAAa,EAAE,eAAe;IAC9B,SAAS,EAAE,WAAW;IACtB,cAAc,EAAE,gBAAgB;IAChC,iBAAiB,EAAE,mBAAmB;IACtC,WAAW,EAAE,aAAa;IAC1B,eAAe,EAAE,iBAAiB;IAClC,UAAU,EAAE,YAAY;IACxB,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;IACd,iBAAiB,EAAE,oBAAoB;CACxC,CAAC;AAEW,QAAA,OAAO,GAAG;IACrB,YAAY,EAAE,cAAc;IAC5B,yBAAyB,EAAE,qCAAqC;IAChE,yBAAyB,EAAE,qCAAqC;IAChE,gBAAgB,EAAE,kBAAkB;IACpC,iBAAiB,EAAE,mBAAmB;IACtC,qBAAqB,EAAE,uBAAuB;IAC9C,2BAA2B,EAAE,6BAA6B;IAC1D,YAAY,EAAE,0BAA0B;IACxC,qBAAqB,EAAE,uBAAuB;IAC9C,gBAAgB,EAAE,kBAAkB;IACpC,WAAW,EAAE,aAAa;IAC1B,mBAAmB;IACnB,kBAAkB,EAAE,sBAAsB;CAC3C,CAAC"}

package/build/src/services/data.service.d.ts

@@ -1,11 +1,17 @@
-import { BaseDto, Page } from '../dto';
+import { BaseDto, BaseUpsertDto, Page } from '../dto';
 import { FilterCriteria } from '../FilterCriteria';
 import { ErrorHandler, TargetApi } from './constants';
 import { RestClient, RestRequest } from './rest';
+export type DataServiceCallOptions = {
+    params: unknown;
+};
 export interface AmpDataService<ReadT extends BaseDto> {
     list(_filter: FilterCriteria): Promise<Page<ReadT>>;
     getById(_id: string): Promise<Page<ReadT>>;
 }
+export interface AmpPatchDataService<WriteT extends BaseUpsertDto, ReadT extends BaseDto> extends AmpDataService<ReadT> {
+    patch(_model: WriteT | WriteT[], _options: DataServiceCallOptions): Promise<Page<ReadT>>;
+}
 export declare class AmpDataServiceImpl<ReadT extends BaseDto> implements AmpDataService<ReadT> {
     protected readonly rest: RestClient;
     protected readonly kind: string;
@@ -16,3 +22,7 @@ export declare class AmpDataServiceImpl<ReadT extends BaseDto> implements AmpDat
     list(filter: FilterCriteria): Promise<Page<ReadT>>;
     getById(id: string): Promise<Page<ReadT>>;
 }
+export declare class AmpPatchDataServiceImpl<WriteT extends BaseUpsertDto, ReadT extends BaseDto> extends AmpDataServiceImpl<ReadT> implements AmpPatchDataService<WriteT, ReadT> {
+    constructor(rest: RestClient, kind: string, targetApi?: TargetApi);
+    patch(model: WriteT | WriteT[], options: DataServiceCallOptions): Promise<Page<ReadT>>;
+}

package/build/src/services/data.service.js

@@ -1,6 +1,10 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AmpDataServiceImpl = void 0;
+exports.AmpPatchDataServiceImpl = exports.AmpDataServiceImpl = void 0;
+const lodash_1 = __importDefault(require("lodash"));
 class AmpDataServiceImpl {
     constructor(rest, kind, targetApi = 'api') {
         this.rest = rest;
@@ -45,4 +49,19 @@ class AmpDataServiceImpl {
     }
 }
 exports.AmpDataServiceImpl = AmpDataServiceImpl;
+class AmpPatchDataServiceImpl extends AmpDataServiceImpl {
+    constructor(rest, kind, targetApi = 'api') {
+        super(rest, kind, targetApi);
+    }
+    patch(model, options) {
+        const url = lodash_1.default.isArray(model) ? `/${this.targetApi}/v1/${this.kind}` : `/${this.targetApi}/v1/${this.kind}/${model.id}`;
+        return this.getPage({
+            url,
+            method: 'PATCH',
+            params: options.params,
+            data: model,
+        });
+    }
+}
+exports.AmpPatchDataServiceImpl = AmpPatchDataServiceImpl;
 //# sourceMappingURL=data.service.js.map

package/build/src/services/data.service.js.map

@@ -1 +1 @@
-{"version":3,"file":"data.service.js","sourceRoot":"","sources":["../../../src/services/data.service.ts"],"names":[],"mappings":";;;AAUA,MAAa,kBAAkB;IAK7B,YAAY,IAAgB,EAAE,IAAY,EAAE,YAAuB,KAAK;QACtE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAES,KAAK,CAAC,IAAI,CAAI,GAAgB,EAAE,YAA6B;QACrE,IAAI;YACF,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACtC,OAAO,GAAG,CAAC,IAAS,CAAC;SACtB;QAAC,OAAO,KAAc,EAAE;YACvB,IAAI,KAAK,YAAY,KAAK,EAAE;gBAC1B,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;aAC9B;YACD,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC;SAC5B;IACH,CAAC;IAES,KAAK,CAAC,OAAO,CAAC,GAAgB;QACtC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,KAAc,EAAE,EAAE;YACvC,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC;YACzE,OAAO;gBACL,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;gBAC7B,KAAK,EAAE,OAAO;gBACd,KAAK,EAAE,EAAE;aACV,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC,MAAsB;QACzB,OAAO,IAAI,CAAC,OAAO,CAAC;YAClB,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,EAAE;YACzC,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,MAAM;SACf,CAAC,CAAC;IACL,CAAC;IAED,OAAO,CAAC,EAAU;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC;YAClB,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,IAAI,EAAE,EAAE;YAC/C,MAAM,EAAE,KAAK;SACd,CAAC,CAAC;IACL,CAAC;CACF;AAjDD,gDAiDC"}
+{"version":3,"file":"data.service.js","sourceRoot":"","sources":["../../../src/services/data.service.ts"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AAoBvB,MAAa,kBAAkB;IAK7B,YAAY,IAAgB,EAAE,IAAY,EAAE,YAAuB,KAAK;QACtE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAES,KAAK,CAAC,IAAI,CAAI,GAAgB,EAAE,YAA6B;QACrE,IAAI;YACF,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACtC,OAAO,GAAG,CAAC,IAAS,CAAC;SACtB;QAAC,OAAO,KAAc,EAAE;YACvB,IAAI,KAAK,YAAY,KAAK,EAAE;gBAC1B,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;aAC9B;YACD,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC;SAC5B;IACH,CAAC;IAES,KAAK,CAAC,OAAO,CAAC,GAAgB;QACtC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,KAAc,EAAE,EAAE;YACvC,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC;YACzE,OAAO;gBACL,IAAI,EAAE,EAAE;gBACR,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;gBAC7B,KAAK,EAAE,OAAO;gBACd,KAAK,EAAE,EAAE;aACV,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC,MAAsB;QACzB,OAAO,IAAI,CAAC,OAAO,CAAC;YAClB,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,EAAE;YACzC,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,MAAM;SACf,CAAC,CAAC;IACL,CAAC;IAED,OAAO,CAAC,EAAU;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC;YAClB,GAAG,EAAE,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,IAAI,EAAE,EAAE;YAC/C,MAAM,EAAE,KAAK;SACd,CAAC,CAAC;IACL,CAAC;CACF;AAjDD,gDAiDC;AAED,MAAa,uBAA6E,SAAQ,kBAAyB;IACzH,YAAY,IAAgB,EAAE,IAAY,EAAE,YAAuB,KAAK;QACtE,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAC/B,CAAC;IAED,KAAK,CAAC,KAAwB,EAAE,OAA+B;QAC7D,MAAM,GAAG,GAAG,gBAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,IAAI,IAAI,KAAK,CAAC,EAAE,EAAE,CAAC;QACvH,OAAO,IAAI,CAAC,OAAO,CAAC;YAClB,GAAG;YACH,MAAM,EAAE,OAAO;YACf,MAAM,EAAE,OAAO,CAAC,MAAkB;YAClC,IAAI,EAAE,KAAK;SACZ,CAAC,CAAC;IACL,CAAC;CACF;AAdD,0DAcC"}

package/build/src/services/rest/ConnectorInstallService.d.ts

@@ -0,0 +1,7 @@
+import { RestClient } from './RestClient';
+export declare class ConnectorInstallService {
+    private readonly rest;
+    constructor(rest: RestClient);
+    getInstallToken(cid: string): Promise<string>;
+    buildInstallOAuthUrl(apiBaseUrl: string, token: string, redirectUrl: string): string;
+}

package/build/src/services/rest/ConnectorInstallService.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConnectorInstallService = void 0;
+class ConnectorInstallService {
+    constructor(rest) {
+        this.rest = rest;
+    }
+    async getInstallToken(cid) {
+        const res = await this.rest.call({
+            url: '/install/oauth/token',
+            method: 'POST',
+            data: { cid },
+        });
+        const token = res.data.token;
+        return token;
+    }
+    buildInstallOAuthUrl(apiBaseUrl, token, redirectUrl) {
+        return `${apiBaseUrl}/install/oauth?token=${token}&redirect=${encodeURIComponent(redirectUrl)}`;
+    }
+}
+exports.ConnectorInstallService = ConnectorInstallService;
+//# sourceMappingURL=ConnectorInstallService.js.map

package/build/src/services/rest/ConnectorInstallService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConnectorInstallService.js","sourceRoot":"","sources":["../../../../src/services/rest/ConnectorInstallService.ts"],"names":[],"mappings":";;;AAEA,MAAa,uBAAuB;IAGlC,YAAY,IAAgB;QAC1B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,GAAW;QAC/B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;YAC/B,GAAG,EAAE,sBAAsB;YAC3B,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,EAAC,GAAG,EAAC;SACZ,CAAC,CAAC;QACH,MAAM,KAAK,GAAI,GAAG,CAAC,IAAwB,CAAC,KAAK,CAAC;QAClD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,oBAAoB,CAAC,UAAkB,EAAE,KAAa,EAAE,WAAmB;QACzE,OAAO,GAAG,UAAU,wBAAwB,KAAK,aAAa,kBAAkB,CAAC,WAAW,CAAC,EAAE,CAAC;IAClG,CAAC;CACF;AApBD,0DAoBC"}

package/build/src/services/rest/RestRequest.d.ts

@@ -4,5 +4,5 @@ export type RestRequest = {
     headers?: HeadersMap;
     params?: QueryMap;
     data?: unknown;
-    method?: 'GET' | 'POST' | 'PUT' | 'DELETE';
+    method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
 };

package/build/src/services/rest/UserIdentityService.d.ts

@@ -0,0 +1,10 @@
+import { AmpJwtToken } from '../../dto';
+import { RestClient } from './RestClient';
+export type TokenResponse = {
+    token: string;
+};
+export declare class UserIdentityService {
+    protected readonly rest: RestClient;
+    constructor(rest: RestClient);
+    me(): Promise<AmpJwtToken>;
+}

package/build/src/services/rest/UserIdentityService.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserIdentityService = void 0;
+class UserIdentityService {
+    constructor(rest) {
+        this.rest = rest;
+    }
+    async me() {
+        const res = await this.rest.call({
+            url: '/eng/v1/me',
+            method: 'GET',
+        });
+        return res.data;
+    }
+}
+exports.UserIdentityService = UserIdentityService;
+//# sourceMappingURL=UserIdentityService.js.map

package/build/src/services/rest/UserIdentityService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserIdentityService.js","sourceRoot":"","sources":["../../../../src/services/rest/UserIdentityService.ts"],"names":[],"mappings":";;;AAOA,MAAa,mBAAmB;IAE9B,YAAY,IAAgB;QAC1B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IACD,KAAK,CAAC,EAAE;QACN,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;YAC/B,GAAG,EAAE,YAAY;YACjB,MAAM,EAAE,KAAK;SACd,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,IAAmB,CAAC;IACjC,CAAC;CACF;AAZD,kDAYC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ampsec/platform-client",
-  "version": "27.2.0",
+  "version": "27.4.0",
   "description": "",
   "main": "build/src/index.js",
   "runkitExampleFilename": "example/main.js",

package/src/dto/findings.dto.ts

@@ -3,6 +3,13 @@ import {Category, FindingKind} from './enums';
 import {FindingSeverity} from './enums/finding.severity';
 import {FindingStatus} from './enums/finding.status';
 
+export type FindingsStatusPathDto = {
+  /** Id of the connector to which the finding applies */
+  id: string;
+  /** Status of the finding, e.g. OPEN */
+  status: FindingStatus.PENDING_VERIFICATION | FindingStatus.OPEN;
+};
+
 export type FindingUpsertDto = BaseUpsertDto & {
   /** Date the finding was closed */
   closedAt?: string;

package/src/services/AmpApi.ts

@@ -23,6 +23,7 @@ import {AmpReportService, AmpReportServiceImpl} from './reports.service';
 import {DefaultEnumService, EnumService} from './rest/EnumService';
 import {AmpSettingsService} from './settings.service';
 import {AgentIdentityService} from './rest/AgentIdentityService';
+import {ConnectorInstallService} from './rest/ConnectorInstallService';
 
 export type AmpApiOptions = AmpRestClientOptions;
 
@@ -45,6 +46,7 @@ export class AmpApi {
   readonly enums: EnumService;
   readonly findings: AmpDataService<FindingDto>;
   readonly identity: AgentIdentityService;
+  readonly install: ConnectorInstallService;
   readonly notifications: AmpDataService<NotificationDto>;
   readonly providers: AmpDataService<ProviderDto>;
   readonly reportResults: AmpDataService<ReportResultDto>;
@@ -63,6 +65,7 @@ export class AmpApi {
     this.enums = new DefaultEnumService(rest);
     this.findings = new AmpDataServiceImpl<FindingDto>(rest, KIND.FINDINGS);
     this.identity = new AgentIdentityService(rest);
+    this.install = new ConnectorInstallService(rest);
     this.notifications = new AmpDataServiceImpl<NotificationDto>(rest, KIND.NOTIFICATIONS);
     this.providers = new AmpDataServiceImpl<ProviderDto>(rest, KIND.PROVIDERS);
     this.reportResults = new AmpDataServiceImpl<ReportResultDto>(rest, KIND.REPORT_RESULTS);

package/src/services/AmpSdk.ts

@@ -51,7 +51,7 @@ export type AmpSdkOptions = AmpRestClientOptions;
  * This client is a wrapper around the AMP REST API meant to be used by
  * service accounts, i.e. plugins and platform extensions. If you are
  * trying to implement a simple web client you should leverage the AmpApi
- * instead (see {@link AmpApi} ).
+ * of EngageApi instead (see {@link AmpApi} and {@link EngageApi} ).
  *
  * This client provides CRUD access to all of the AMP API.
  */

package/src/services/EngageApi.ts

@@ -0,0 +1,54 @@
+import {ConnectorDto, ConnectorUpsertDto, FindingDto, FindingsStatusPathDto as FindingsStatusPatchDto, NotificationDto, ProviderDto} from '../dto';
+import {AmpEntityServiceImpl} from './entity.service';
+import {AmpDataService, AmpDataServiceImpl, AmpPatchDataService, AmpPatchDataServiceImpl} from './data.service';
+import {AmpRestClientOptions, RestClient, getAmpRestClient} from './rest';
+import {KIND, TARGET_API_ENGAGE} from './constants';
+import {AmpReportService, AmpReportServiceImpl} from './reports.service';
+import {AmpSettingsService} from './settings.service';
+import {UserIdentityService} from './rest/UserIdentityService';
+
+export type EngageApiOptions = AmpRestClientOptions;
+
+/**
+ * Engage API
+ * This client is a wrapper around the AMP REST API meant to be used by
+ * end users, i.e. Amplifier Security's managed users. If you are trying to implement
+ * a plugin leverage the AmpSdk instead (see {@link AmpSdkServices} ), or
+ * a an extension for Agents use AmpApi instead (see {@link AmpApi}).
+ *
+ * This client provides READ_ONLY access to The folloing resoureces:
+ * - Connectors: {@link EngageApi.connectors}
+ * - Findings: {@link EngageApi.findings}
+ * - Identity: {@link EngageApi.identity}
+ * - Notifications: {@link EngageApi.notifications}
+ * - Providers: {@link EngageApi.providers}
+ * - Reporting: {@link EngageApi.reports}
+ * - Settings: {@link EngageApi.settings}
+ *
+ * This client provides PATCH access to The folloing resoureces:
+ * - Findings: {@link EngageApi.findings}
+ */
+export class EngageApi {
+  readonly connectors: AmpDataService<ConnectorDto>;
+  readonly findings: AmpPatchDataService<FindingsStatusPatchDto, FindingDto>;
+  readonly identity: UserIdentityService;
+  readonly notifications: AmpDataService<NotificationDto>;
+  readonly providers: AmpDataService<ProviderDto>;
+  readonly reports: AmpReportService;
+  readonly settings: AmpSettingsService;
+
+  constructor(rest: RestClient) {
+    this.connectors = new AmpEntityServiceImpl<ConnectorUpsertDto, ConnectorDto>(rest, KIND.CONNECTORS, TARGET_API_ENGAGE); // TODO: add /eng endpoint... needed?
+    this.findings = new AmpPatchDataServiceImpl<FindingsStatusPatchDto, FindingDto>(rest, KIND.FINDINGS, TARGET_API_ENGAGE);
+    this.identity = new UserIdentityService(rest);
+    this.notifications = new AmpDataServiceImpl<NotificationDto>(rest, KIND.NOTIFICATIONS, TARGET_API_ENGAGE); // TODO: add /eng endpoint
+    this.providers = new AmpDataServiceImpl<ProviderDto>(rest, KIND.PROVIDERS, TARGET_API_ENGAGE); // TODO: add /eng endpoint... needed?
+    this.reports = new AmpReportServiceImpl(rest);
+    this.settings = new AmpSettingsService(rest); // TODO: add /eng endpoint
+  }
+
+  static instance(options: EngageApiOptions): EngageApi {
+    const rest = getAmpRestClient(options);
+    return new EngageApi(rest);
+  }
+}

package/src/services/constants.ts

@@ -4,9 +4,10 @@ export interface ErrorHandler<T> {
 
 export const DEFAULT_TREND_WINDOW_MONTHS = 6;
 
-export type TargetApi = 'api' | 'platform';
+export type TargetApi = 'api' | 'platform' | 'eng';
 export const TARGET_API_PLATFORM: TargetApi = 'platform';
 export const TARGET_API_AGENT: TargetApi = 'api';
+export const TARGET_API_ENGAGE: TargetApi = 'eng';
 
 export const KIND = {
   AGENTS: 'agents',

package/src/services/data.service.ts

@@ -1,13 +1,23 @@
-import {BaseDto, Page} from '../dto';
+import _ from 'lodash';
+import {BaseDto, BaseUpsertDto, Page} from '../dto';
 import {FilterCriteria} from '../FilterCriteria';
 import {ErrorHandler, TargetApi} from './constants';
 import {RestClient, RestRequest} from './rest';
+import {QueryMap} from './rest/utils';
+
+export type DataServiceCallOptions = {
+  params: unknown;
+};
 
 export interface AmpDataService<ReadT extends BaseDto> {
   list(_filter: FilterCriteria): Promise<Page<ReadT>>;
   getById(_id: string): Promise<Page<ReadT>>;
 }
 
+export interface AmpPatchDataService<WriteT extends BaseUpsertDto, ReadT extends BaseDto> extends AmpDataService<ReadT> {
+  patch(_model: WriteT | WriteT[], _options: DataServiceCallOptions): Promise<Page<ReadT>>;
+}
+
 export class AmpDataServiceImpl<ReadT extends BaseDto> implements AmpDataService<ReadT> {
   protected readonly rest: RestClient;
   protected readonly kind: string;
@@ -58,3 +68,19 @@ export class AmpDataServiceImpl<ReadT extends BaseDto> implements AmpDataService
     });
   }
 }
+
+export class AmpPatchDataServiceImpl<WriteT extends BaseUpsertDto, ReadT extends BaseDto> extends AmpDataServiceImpl<ReadT> implements AmpPatchDataService<WriteT, ReadT> {
+  constructor(rest: RestClient, kind: string, targetApi: TargetApi = 'api') {
+    super(rest, kind, targetApi);
+  }
+
+  patch(model: WriteT | WriteT[], options: DataServiceCallOptions): Promise<Page<ReadT>> {
+    const url = _.isArray(model) ? `/${this.targetApi}/v1/${this.kind}` : `/${this.targetApi}/v1/${this.kind}/${model.id}`;
+    return this.getPage({
+      url,
+      method: 'PATCH',
+      params: options.params as QueryMap,
+      data: model,
+    });
+  }
+}

package/src/services/rest/ConnectorInstallService.ts

@@ -0,0 +1,23 @@
+import {RestClient} from './RestClient';
+
+export class ConnectorInstallService {
+  private readonly rest: RestClient;
+
+  constructor(rest: RestClient) {
+    this.rest = rest;
+  }
+
+  async getInstallToken(cid: string): Promise<string> {
+    const res = await this.rest.call({
+      url: '/install/oauth/token',
+      method: 'POST',
+      data: {cid},
+    });
+    const token = (res.data as {token: string}).token;
+    return token;
+  }
+
+  buildInstallOAuthUrl(apiBaseUrl: string, token: string, redirectUrl: string): string {
+    return `${apiBaseUrl}/install/oauth?token=${token}&redirect=${encodeURIComponent(redirectUrl)}`;
+  }
+}

package/src/services/rest/RestRequest.ts

@@ -5,5 +5,5 @@ export type RestRequest = {
   headers?: HeadersMap;
   params?: QueryMap;
   data?: unknown;
-  method?: 'GET' | 'POST' | 'PUT' | 'DELETE';
+  method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
 };

package/src/services/rest/UserIdentityService.ts

@@ -0,0 +1,20 @@
+import {AmpJwtToken} from '../../dto';
+import {RestClient} from './RestClient';
+
+export type TokenResponse = {
+  token: string;
+};
+
+export class UserIdentityService {
+  protected readonly rest: RestClient;
+  constructor(rest: RestClient) {
+    this.rest = rest;
+  }
+  async me(): Promise<AmpJwtToken> {
+    const res = await this.rest.call({
+      url: '/eng/v1/me',
+      method: 'GET',
+    });
+    return res.data as AmpJwtToken;
+  }
+}