@or-sdk/deployments 2.1.0 → 2.1.1-beta.4013.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.
@@ -3,16 +3,84 @@ import { Deployment, DeploymentsConfig, GetDeploymentParams, ListDeploymentsPara
3
3
  export declare class Deployments {
4
4
  private readonly dataHubSvc;
5
5
  constructor(params: DeploymentsConfig);
6
+ /**
7
+ * List deployments
8
+ * ```typescript
9
+ * const result = await deployments.listDeployments();
10
+ * ```
11
+ */
6
12
  listDeployments(params?: ListDeploymentsParams, paginationOptions?: PaginationOptions): Promise<List<Deployment>>;
13
+ /**
14
+ * List active deployments
15
+ * ```typescript
16
+ * const result = await deployments.listActiveDeployments();
17
+ * ```
18
+ */
7
19
  listActiveDeployments(projection?: string[], paginationOptions?: PaginationOptions): Promise<List<Deployment>>;
20
+ /**
21
+ * List deployments by bot id
22
+ * ```typescript
23
+ * const result = await deployments.listDeploymentsByBotId('bot-id');
24
+ * ```
25
+ */
8
26
  listDeploymentsByBotId(botId: string, projection?: string[]): Promise<List<Deployment>>;
27
+ /**
28
+ * List active deployments by bot id
29
+ * ```typescript
30
+ * const result = await deployments.listActiveDeploymentsByBotId('bot-id');
31
+ * ```
32
+ */
9
33
  listActiveDeploymentsByBotId(botId: string, projection?: string[]): Promise<List<Deployment>>;
34
+ /**
35
+ * List deployments by flow id
36
+ * ```typescript
37
+ * const result = await deployments.listDeploymentsByFlowId('flow-id');
38
+ * ```
39
+ */
10
40
  listDeploymentsByFlowId(flowId: string, projection?: string[]): Promise<List<Deployment>>;
41
+ /**
42
+ * List active deployments by flow id
43
+ * ```typescript
44
+ * const result = await deployments.listActiveDeploymentsByFlowId('flow-id');
45
+ * ```
46
+ */
11
47
  listActiveDeploymentsByFlowId(flowId: string, projection?: string[]): Promise<List<Deployment>>;
48
+ /**
49
+ * Get deployment
50
+ * ```typescript
51
+ * const result = await deployments.getDeployment('deployment-id');
52
+ * ```
53
+ */
12
54
  getDeployment(id: string, params?: GetDeploymentParams): Promise<Deployment>;
55
+ /**
56
+ * Delete deployment
57
+ * ```typescript
58
+ * const result = await deployments.deleteDeployment('deployment-id');
59
+ * ```
60
+ */
13
61
  deleteDeployment(id: string): Promise<Deployment>;
62
+ /**
63
+ * Save deployment
64
+ *
65
+ * If source contains existing id - existing deployment will be updated
66
+ * ```typescript
67
+ * const result = await deployments.saveDeployment(deploymentSource);
68
+ * ```
69
+ */
14
70
  saveDeployment(source: Deployment): Promise<Deployment>;
71
+ /**
72
+ * Create deployment
73
+ * ```typescript
74
+ * const result = await deployments.createDeployment(deploymentSource);
75
+ * ```
76
+ */
15
77
  createDeployment(source: Deployment): Promise<Deployment>;
78
+ /**
79
+ * Update deployment
80
+ * ```typescript
81
+ * const result = await deployments.updateDeployment(deploymentSource);
82
+ * ```
83
+ */
16
84
  updateDeployment(source: Deployment): Promise<Deployment>;
17
85
  }
18
86
  //# sourceMappingURL=Deployments.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Deployments.d.ts","sourceRoot":"","sources":["../../src/Deployments.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAY,MAAM,cAAc,CAAC;AAG9C,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAEvH,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;gBAE5B,MAAM,EAAE,iBAAiB;IAkBxB,eAAe,CAAC,MAAM,GAAE,qBAA0B,EAAE,iBAAiB,GAAE,iBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAoBzH,qBAAqB,CAAC,UAAU,GAAE,MAAM,EAAO,EAAE,iBAAiB,GAAE,iBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAetH,sBAAsB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,GAAE,MAAM,EAAO,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAe3F,4BAA4B,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,GAAE,MAAM,EAAO,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAgBjG,uBAAuB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,GAAE,MAAM,EAAO,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAe7F,6BAA6B,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,GAAE,MAAM,EAAO,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAgBnG,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,GAAE,mBAAwB,GAAG,OAAO,CAAC,UAAU,CAAC;IAiBhF,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAkBjD,cAAc,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IAUvD,gBAAgB,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IAwBzD,gBAAgB,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;CAcvE"}
1
+ {"version":3,"file":"Deployments.d.ts","sourceRoot":"","sources":["../../src/Deployments.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAY,MAAM,cAAc,CAAC;AAG9C,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAEvH,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;gBAE5B,MAAM,EAAE,iBAAiB;IAYrC;;;;;OAKG;IACU,eAAe,CAAC,MAAM,GAAE,qBAA0B,EAAE,iBAAiB,GAAE,iBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IActI;;;;;OAKG;IACU,qBAAqB,CAAC,UAAU,GAAE,MAAM,EAAO,EAAE,iBAAiB,GAAE,iBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IASnI;;;;;OAKG;IACU,sBAAsB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,GAAE,MAAM,EAAO,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IASxG;;;;;OAKG;IACU,4BAA4B,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,GAAE,MAAM,EAAO,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAU9G;;;;;OAKG;IACU,uBAAuB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,GAAE,MAAM,EAAO,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAS1G;;;;;OAKG;IACU,6BAA6B,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,GAAE,MAAM,EAAO,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAUhH;;;;;OAKG;IACU,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,GAAE,mBAAwB,GAAG,OAAO,CAAC,UAAU,CAAC;IAW7F;;;;;OAKG;IACU,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAU9D;;;;;;;OAOG;IACU,cAAc,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IAIpE;;;;;OAKG;IACU,gBAAgB,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IAkBtE;;;;;OAKG;IACU,gBAAgB,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;CAcvE"}
@@ -1,9 +1,24 @@
1
1
  import { Token } from '@or-sdk/base';
2
2
  export type DeploymentsConfig = {
3
+ /**
4
+ * token
5
+ */
3
6
  token: Token;
7
+ /**
8
+ * Url of OneReach service discovery api
9
+ */
4
10
  discoveryUrl?: string;
11
+ /**
12
+ * Account ID for cross-account requests (super admin only)
13
+ */
5
14
  accountId?: string;
15
+ /**
16
+ * Url of OneReach DataHubSvc api
17
+ */
6
18
  dataHubSvcUrl?: string;
19
+ /**
20
+ * Api feature
21
+ */
7
22
  feature?: string;
8
23
  };
9
24
  export type Trigger = {
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErC,MAAM,MAAM,iBAAiB,GAAG;IAI9B,KAAK,EAAE,KAAK,CAAC;IAKb,YAAY,CAAC,EAAE,MAAM,CAAC;IAKtB,SAAS,CAAC,EAAE,MAAM,CAAC;IAKnB,aAAa,CAAC,EAAE,MAAM,CAAC;IAKvB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE;YACN,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,WAAW,CAAC,EAAE,OAAO,CAAC;YACtB,MAAM,CAAC,EAAE,OAAO,CAAC;YACjB,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;SACxB,CAAC;QACF,OAAO,CAAC,EAAE;YACR,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;SACxB,CAAC;QACF,KAAK,CAAC,EAAE;YACN,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;SACxB,CAAC;QACF,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,SAAS,EAAE;QACT,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE;QACJ,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,oBAAoB,EAAE,MAAM,CAAC;QAC7B,WAAW,EAAE,MAAM,CAAC;QACpB,QAAQ,EAAE,OAAO,EAAE,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC;AAElC,MAAM,MAAM,qBAAqB,GAAG;IAClC,KAAK,CAAC,EAAE;QACN,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QACvB,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,KAAK,CAAC,EAAE;QACN,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,GAAG,UAAU,CAAC"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErC,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE;YACN,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,WAAW,CAAC,EAAE,OAAO,CAAC;YACtB,MAAM,CAAC,EAAE,OAAO,CAAC;YACjB,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;SACxB,CAAC;QACF,OAAO,CAAC,EAAE;YACR,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;SACxB,CAAC;QACF,KAAK,CAAC,EAAE;YACN,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;SACxB,CAAC;QACF,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,SAAS,EAAE;QACT,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE;QACJ,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,oBAAoB,EAAE,MAAM,CAAC;QAC7B,WAAW,EAAE,MAAM,CAAC;QACpB,QAAQ,EAAE,OAAO,EAAE,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC;AAElC,MAAM,MAAM,qBAAqB,GAAG;IAClC,KAAK,CAAC,EAAE;QACN,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QACvB,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,KAAK,CAAC,EAAE;QACN,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,GAAG,UAAU,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@or-sdk/deployments",
3
- "version": "2.1.0",
3
+ "version": "2.1.1-beta.4013.0",
4
4
  "license": "Apache-2.0",
5
5
  "main": "dist/cjs/index.js",
6
6
  "module": "dist/esm/index.js",
@@ -18,8 +18,8 @@
18
18
  "dev": "pnpm build:watch:esm"
19
19
  },
20
20
  "dependencies": {
21
- "@or-sdk/base": "^0.43.0",
22
- "@or-sdk/data-hub-svc": "^2.3.0"
21
+ "@or-sdk/base": "^0.44.0-beta.4013.0",
22
+ "@or-sdk/data-hub-svc": "^2.3.1-beta.4013.0"
23
23
  },
24
24
  "devDependencies": {
25
25
  "concurrently": "9.0.1",
@@ -27,6 +27,5 @@
27
27
  },
28
28
  "publishConfig": {
29
29
  "access": "public"
30
- },
31
- "gitHead": "ce62679c119c54ef41fd0d8f7084c563c3b21b24"
30
+ }
32
31
  }