@or-sdk/card-templates 2.2.0 → 2.2.1-beta.4012.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,12 +3,54 @@ import { Card, CardTemplatesConfig, GetCardTemplateByIdParams, ListCardTemplates
3
3
  export declare class CardTemplates {
4
4
  private readonly dataHubSvc;
5
5
  constructor(params: CardTemplatesConfig);
6
+ /**
7
+ * List card templates
8
+ * ```typescript
9
+ * const result = await cardTemplates.listCardTemplates();
10
+ * ```
11
+ */
6
12
  listCardTemplates(params?: ListCardTemplatesParams, paginationOptions?: PaginationOptions): Promise<List<Card>>;
13
+ /**
14
+ * List new card templates
15
+ * ```typescript
16
+ * const result = await cardTemplates.listNewCardTemplates();
17
+ * ```
18
+ */
7
19
  listNewCardTemplates(params?: ListCardTemplatesParams, paginationOptions?: PaginationOptions): Promise<List<Card>>;
20
+ /**
21
+ * List popular card templates
22
+ * ```typescript
23
+ * const result = await cardTemplates.listPopularCardTemplates();
24
+ * ```
25
+ */
8
26
  listPopularCardTemplates(paginationOptions?: PaginationOptions): Promise<List<Card>>;
27
+ /**
28
+ * Get card template
29
+ * ```typescript
30
+ * const card = await cardTemplates.getCardTemplateById('card-id');
31
+ * ```
32
+ */
9
33
  getCardTemplateById(id: string, params?: GetCardTemplateByIdParams): Promise<Card>;
34
+ /**
35
+ * Download card template
36
+ * ```typescript
37
+ * const result = await cardTemplates.download('card-template-id');
38
+ * ```
39
+ */
10
40
  download(cardTemplateId: string, targetViewId?: string, sandbox?: boolean): Promise<Card>;
41
+ /**
42
+ * Upgrade card template
43
+ * ```typescript
44
+ * const result = await cardTemplates.upgrade('card-template-id');
45
+ * ```
46
+ */
11
47
  upgrade(cardTemplateId: string, options?: {}): Promise<Card>;
48
+ /**
49
+ * Generate new card template
50
+ * ```typescript
51
+ * const result = CardTemplates.getNewCardTemplate();
52
+ * ```
53
+ */
12
54
  static getNewCardTemplate(stepId?: string): {
13
55
  id: string;
14
56
  version: string;
@@ -1 +1 @@
1
- {"version":3,"file":"CardTemplates.d.ts","sourceRoot":"","sources":["../../src/CardTemplates.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAY,MAAM,cAAc,CAAC;AAG9C,OAAO,EAAE,IAAI,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAG3H,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;gBAE5B,MAAM,EAAE,mBAAmB;IAkB1B,iBAAiB,CAC5B,MAAM,GAAE,uBAEP,EACD,iBAAiB,GAAE,iBAAsB,GACxC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IA6BT,oBAAoB,CAC/B,MAAM,GAAE,uBAEP,EACD,iBAAiB,GAAE,iBAAsB,GACxC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IA8BT,wBAAwB,CACnC,iBAAiB,GAAE,iBAAsB,GACxC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAmBT,mBAAmB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,GAAE,yBAA8B,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBtF,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,OAAO,UAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBtF,OAAO,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;WAmB3D,kBAAkB,CAAC,MAAM,CAAC,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAIjD"}
1
+ {"version":3,"file":"CardTemplates.d.ts","sourceRoot":"","sources":["../../src/CardTemplates.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAY,MAAM,cAAc,CAAC;AAG9C,OAAO,EAAE,IAAI,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAG3H,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;gBAE5B,MAAM,EAAE,mBAAmB;IAYvC;;;;;OAKG;IACU,iBAAiB,CAC5B,MAAM,GAAE,uBAEP,EACD,iBAAiB,GAAE,iBAAsB,GACxC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAuBtB;;;;;OAKG;IACU,oBAAoB,CAC/B,MAAM,GAAE,uBAEP,EACD,iBAAiB,GAAE,iBAAsB,GACxC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAwBtB;;;;;OAKG;IACU,wBAAwB,CACnC,iBAAiB,GAAE,iBAAsB,GACxC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAatB;;;;;OAKG;IACU,mBAAmB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,GAAE,yBAA8B,GAAG,OAAO,CAAC,IAAI,CAAC;IAWnG;;;;;OAKG;IACU,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,OAAO,UAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAenG;;;;;OAKG;IACU,OAAO,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;IAazE;;;;;OAKG;WACW,kBAAkB,CAAC,MAAM,CAAC,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAIjD"}
@@ -1,9 +1,24 @@
1
1
  import { Token } from '@or-sdk/base';
2
2
  export type CardTemplatesConfig = {
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 Card = {
@@ -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,mBAAmB,GAAG;IAIhC,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,IAAI,GAAG;IACjB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,EAAE;QACJ,YAAY,EAAE;YACZ,QAAQ,EAAE,MAAM,CAAC;YACjB,IAAI,EAAE,MAAM,CAAC;YACb,KAAK,EAAE,MAAM,CAAC;YACd,IAAI,EAAE;gBACJ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;aACxB,GAAG,IAAI,CAAC;SACV,CAAC;QACF,IAAI,EAAE;YACJ,QAAQ,EAAE,MAAM,CAAC;YACjB,IAAI,EAAE,MAAM,CAAC;YACb,KAAK,EAAE,MAAM,CAAC;YACd,IAAI,EAAE;gBACJ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;aACxB,CAAC;SACH,CAAC;QACF,IAAI,EAAE;YACJ,WAAW,EAAE,MAAM,CAAC;YACpB,MAAM,EAAE,MAAM,CAAC;YACf,YAAY,EAAE,MAAM,CAAC;YACrB,KAAK,EAAE,MAAM,CAAC;YACd,WAAW,EAAE,MAAM,EAAE,CAAC;YACtB,KAAK,EAAE,MAAM,CAAC;YACd,WAAW,EAAE,MAAM,CAAC;SACrB,CAAC;QACF,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;KAC1B,CAAC;IACF,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,WAAW,CAAC,EAAE;QACZ,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,KAAK,CAAC,EAAE;QACN,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,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,yBAAyB,GAAG;IACtC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACvB,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,mBAAmB,GAAG;IAChC;;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,IAAI,GAAG;IACjB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,EAAE;QACJ,YAAY,EAAE;YACZ,QAAQ,EAAE,MAAM,CAAC;YACjB,IAAI,EAAE,MAAM,CAAC;YACb,KAAK,EAAE,MAAM,CAAC;YACd,IAAI,EAAE;gBACJ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;aACxB,GAAG,IAAI,CAAC;SACV,CAAC;QACF,IAAI,EAAE;YACJ,QAAQ,EAAE,MAAM,CAAC;YACjB,IAAI,EAAE,MAAM,CAAC;YACb,KAAK,EAAE,MAAM,CAAC;YACd,IAAI,EAAE;gBACJ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;aACxB,CAAC;SACH,CAAC;QACF,IAAI,EAAE;YACJ,WAAW,EAAE,MAAM,CAAC;YACpB,MAAM,EAAE,MAAM,CAAC;YACf,YAAY,EAAE,MAAM,CAAC;YACrB,KAAK,EAAE,MAAM,CAAC;YACd,WAAW,EAAE,MAAM,EAAE,CAAC;YACtB,KAAK,EAAE,MAAM,CAAC;YACd,WAAW,EAAE,MAAM,CAAC;SACrB,CAAC;QACF,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;KAC1B,CAAC;IACF,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,WAAW,CAAC,EAAE;QACZ,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,KAAK,CAAC,EAAE;QACN,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,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,yBAAyB,GAAG;IACtC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACvB,CAAC"}
@@ -1,2 +1,5 @@
1
+ /**
2
+ * @internal
3
+ */
1
4
  export { default as getNewCardTemplate } from './getNewCardTemplate';
2
5
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,sBAAsB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,sBAAsB,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@or-sdk/card-templates",
3
- "version": "2.2.0",
3
+ "version": "2.2.1-beta.4012.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.4012.0",
22
+ "@or-sdk/data-hub-svc": "^2.3.1-beta.4012.0",
23
23
  "uuid": "^8.3.2"
24
24
  },
25
25
  "devDependencies": {
@@ -29,6 +29,5 @@
29
29
  },
30
30
  "publishConfig": {
31
31
  "access": "public"
32
- },
33
- "gitHead": "ce62679c119c54ef41fd0d8f7084c563c3b21b24"
32
+ }
34
33
  }