@voiceflow/api-sdk 3.12.9 → 3.13.1

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,8 +1,9 @@
1
1
  import Fetcher, { FetcherOptions } from './fetcher';
2
- export declare type Fields = string[] | ReadonlyArray<string>;
2
+ export declare type Fields = readonly string[];
3
3
  export declare type BaseResourceOptions<Client extends Record<string, any>> = FetcherOptions<Client>;
4
4
  declare class BaseResource<Client extends Record<string, any>> extends Fetcher<Client> {
5
5
  constructor(options: BaseResourceOptions<Client>);
6
6
  protected _getFieldsQuery(fields?: Fields): string;
7
+ protected _getIDsQuery(ids: string[]): string;
7
8
  }
8
9
  export default BaseResource;
@@ -11,5 +11,12 @@ class BaseResource extends fetcher_1.default {
11
11
  _getFieldsQuery(fields) {
12
12
  return fields ? `?fields=${fields.join(',')}` : '';
13
13
  }
14
+ _getIDsQuery(ids) {
15
+ if (ids.length > 0) {
16
+ // eslint-disable-next-line prefer-template
17
+ return '?' + ids.map((id) => `diagramID=${id}`).join('&');
18
+ }
19
+ return '';
20
+ }
14
21
  }
15
22
  exports.default = BaseResource;
@@ -13,6 +13,7 @@ declare class ProgramResource extends CrudResource<BaseModels.Program.Model, Mod
13
13
  get<T extends BaseModels.Program.Model<any, any> = BaseModels.Program.Model>(id: string): Promise<T>;
14
14
  create<T extends BaseModels.BaseNode, C extends BaseModels.BaseCommand>(body: Omit<BaseModels.Program.Model<T, C>, ModelIDKey>): Promise<BaseModels.Program.Model<T, C>>;
15
15
  create<T extends Omit<BaseModels.Program.Model<any, any>, ModelIDKey>>(body: T): Promise<T & Pick<BaseModels.Program.Model<any, any>, ModelIDKey>>;
16
+ createMany(body: Omit<BaseModels.Program.Model<any, any>, ModelIDKey>[]): Promise<BaseModels.Program.Model<any, any>[]>;
16
17
  update<T extends BaseModels.BaseNode, C extends BaseModels.BaseCommand>(id: string, body: Omit<BaseModels.Program.Model<T, C>, ModelIDKey>): Promise<Omit<BaseModels.Program.Model<T, C>, ModelIDKey>>;
17
18
  update<T extends Omit<BaseModels.Program.Model<any, any>, ModelIDKey>>(id: string, body: T): Promise<T>;
18
19
  delete(id: string): Promise<string>;
@@ -21,6 +21,10 @@ class ProgramResource extends crud_1.default {
21
21
  async create(body) {
22
22
  return super._post(body);
23
23
  }
24
+ async createMany(body) {
25
+ const { data } = await this.fetch.post(`${super._getCRUDEndpoint()}/batch`, { programs: body });
26
+ return data;
27
+ }
24
28
  async update(id, body) {
25
29
  return super._put(id, body);
26
30
  }
@@ -23,6 +23,9 @@ declare class VersionResource extends CrudResource<BaseModels.Version.Model<Base
23
23
  getPrototypePrograms<T extends BaseModels.Program.Model<any> = BaseModels.Program.Model>(id: string): Promise<T[]>;
24
24
  getDiagrams<T extends Partial<BaseModels.Diagram.Model>>(id: string, fields: Fields): Promise<T[]>;
25
25
  getDiagrams<T extends BaseModels.Diagram.Model<any> = BaseModels.Diagram.Model>(id: string): Promise<T[]>;
26
+ getDiagramsByIDs<T extends Partial<BaseModels.Diagram.Model>>(versionId: string, diagramIds: string[]): Promise<T[]>;
27
+ getDiagramsByIDs<T extends BaseModels.BaseDiagramNode = BaseModels.BaseDiagramNode>(versionId: string, diagramIds: string[]): Promise<BaseModels.Diagram.Model<T>[]>;
28
+ getDiagramsByIDs<T extends BaseModels.Diagram.Model<any> = BaseModels.Diagram.Model>(versionId: string, diagramIds: string[]): Promise<T[]>;
26
29
  export<P extends BaseModels.Project.Model<any, any> = BaseModels.Project.Model<AnyRecord, AnyRecord>, V extends BaseModels.Version.Model<any> = BaseModels.Version.Model<BaseModels.Version.PlatformData>, D extends BaseModels.Diagram.Model = BaseModels.Diagram.Model, PM extends BaseModels.Program.Model = BaseModels.Program.Model>(id: string, options: {
27
30
  programs: true;
28
31
  }): Promise<{
@@ -50,6 +50,10 @@ class VersionResource extends crud_1.default {
50
50
  const { data } = await this.fetch.get(`${this._getCRUDEndpoint(id)}/diagrams${this._getFieldsQuery(fields)}`);
51
51
  return data;
52
52
  }
53
+ async getDiagramsByIDs(versionId, diagramIds) {
54
+ const { data } = await this.fetch.get(`${this._getCRUDEndpoint(versionId)}/diagrams${this._getIDsQuery(diagramIds)}`);
55
+ return data;
56
+ }
53
57
  async export(id, options) {
54
58
  const { data } = await this.fetch.get(`${this._getCRUDEndpoint(id)}/export${(options === null || options === void 0 ? void 0 : options.programs) ? '?programs=1' : ''}`);
55
59
  return data;
@@ -1,8 +1,9 @@
1
1
  import Fetcher, { FetcherOptions } from './fetcher';
2
- export declare type Fields = string[] | ReadonlyArray<string>;
2
+ export declare type Fields = readonly string[];
3
3
  export declare type BaseResourceOptions<Client extends Record<string, any>> = FetcherOptions<Client>;
4
4
  declare class BaseResource<Client extends Record<string, any>> extends Fetcher<Client> {
5
5
  constructor(options: BaseResourceOptions<Client>);
6
6
  protected _getFieldsQuery(fields?: Fields): string;
7
+ protected _getIDsQuery(ids: string[]): string;
7
8
  }
8
9
  export default BaseResource;
@@ -6,5 +6,12 @@ class BaseResource extends Fetcher {
6
6
  _getFieldsQuery(fields) {
7
7
  return fields ? `?fields=${fields.join(',')}` : '';
8
8
  }
9
+ _getIDsQuery(ids) {
10
+ if (ids.length > 0) {
11
+ // eslint-disable-next-line prefer-template
12
+ return '?' + ids.map((id) => `diagramID=${id}`).join('&');
13
+ }
14
+ return '';
15
+ }
9
16
  }
10
17
  export default BaseResource;
@@ -13,6 +13,7 @@ declare class ProgramResource extends CrudResource<BaseModels.Program.Model, Mod
13
13
  get<T extends BaseModels.Program.Model<any, any> = BaseModels.Program.Model>(id: string): Promise<T>;
14
14
  create<T extends BaseModels.BaseNode, C extends BaseModels.BaseCommand>(body: Omit<BaseModels.Program.Model<T, C>, ModelIDKey>): Promise<BaseModels.Program.Model<T, C>>;
15
15
  create<T extends Omit<BaseModels.Program.Model<any, any>, ModelIDKey>>(body: T): Promise<T & Pick<BaseModels.Program.Model<any, any>, ModelIDKey>>;
16
+ createMany(body: Omit<BaseModels.Program.Model<any, any>, ModelIDKey>[]): Promise<BaseModels.Program.Model<any, any>[]>;
16
17
  update<T extends BaseModels.BaseNode, C extends BaseModels.BaseCommand>(id: string, body: Omit<BaseModels.Program.Model<T, C>, ModelIDKey>): Promise<Omit<BaseModels.Program.Model<T, C>, ModelIDKey>>;
17
18
  update<T extends Omit<BaseModels.Program.Model<any, any>, ModelIDKey>>(id: string, body: T): Promise<T>;
18
19
  delete(id: string): Promise<string>;
@@ -15,6 +15,10 @@ class ProgramResource extends CrudResource {
15
15
  async create(body) {
16
16
  return super._post(body);
17
17
  }
18
+ async createMany(body) {
19
+ const { data } = await this.fetch.post(`${super._getCRUDEndpoint()}/batch`, { programs: body });
20
+ return data;
21
+ }
18
22
  async update(id, body) {
19
23
  return super._put(id, body);
20
24
  }
@@ -23,6 +23,9 @@ declare class VersionResource extends CrudResource<BaseModels.Version.Model<Base
23
23
  getPrototypePrograms<T extends BaseModels.Program.Model<any> = BaseModels.Program.Model>(id: string): Promise<T[]>;
24
24
  getDiagrams<T extends Partial<BaseModels.Diagram.Model>>(id: string, fields: Fields): Promise<T[]>;
25
25
  getDiagrams<T extends BaseModels.Diagram.Model<any> = BaseModels.Diagram.Model>(id: string): Promise<T[]>;
26
+ getDiagramsByIDs<T extends Partial<BaseModels.Diagram.Model>>(versionId: string, diagramIds: string[]): Promise<T[]>;
27
+ getDiagramsByIDs<T extends BaseModels.BaseDiagramNode = BaseModels.BaseDiagramNode>(versionId: string, diagramIds: string[]): Promise<BaseModels.Diagram.Model<T>[]>;
28
+ getDiagramsByIDs<T extends BaseModels.Diagram.Model<any> = BaseModels.Diagram.Model>(versionId: string, diagramIds: string[]): Promise<T[]>;
26
29
  export<P extends BaseModels.Project.Model<any, any> = BaseModels.Project.Model<AnyRecord, AnyRecord>, V extends BaseModels.Version.Model<any> = BaseModels.Version.Model<BaseModels.Version.PlatformData>, D extends BaseModels.Diagram.Model = BaseModels.Diagram.Model, PM extends BaseModels.Program.Model = BaseModels.Program.Model>(id: string, options: {
27
30
  programs: true;
28
31
  }): Promise<{
@@ -44,6 +44,10 @@ class VersionResource extends CrudResource {
44
44
  const { data } = await this.fetch.get(`${this._getCRUDEndpoint(id)}/diagrams${this._getFieldsQuery(fields)}`);
45
45
  return data;
46
46
  }
47
+ async getDiagramsByIDs(versionId, diagramIds) {
48
+ const { data } = await this.fetch.get(`${this._getCRUDEndpoint(versionId)}/diagrams${this._getIDsQuery(diagramIds)}`);
49
+ return data;
50
+ }
47
51
  async export(id, options) {
48
52
  const { data } = await this.fetch.get(`${this._getCRUDEndpoint(id)}/export${(options === null || options === void 0 ? void 0 : options.programs) ? '?programs=1' : ''}`);
49
53
  return data;
package/package.json CHANGED
@@ -1,13 +1,13 @@
1
1
  {
2
2
  "name": "@voiceflow/api-sdk",
3
3
  "description": "wrapper for creator-api",
4
- "version": "3.12.9",
4
+ "version": "3.13.1",
5
5
  "author": "Voiceflow",
6
6
  "bugs": {
7
7
  "url": "https://github.com/voiceflow/libs/issues"
8
8
  },
9
9
  "dependencies": {
10
- "@voiceflow/base-types": "^2.24.1",
10
+ "@voiceflow/base-types": "^2.25.0",
11
11
  "@voiceflow/common": "^7.26.1",
12
12
  "axios": "0.24.0",
13
13
  "jwt-decode": "^3.1.2",
@@ -62,5 +62,5 @@
62
62
  "test:single": "NODE_ENV=test ts-mocha --paths --config ./config/tests/.mocharc.json",
63
63
  "test:unit": "NODE_ENV=test nyc --report-dir=nyc_coverage_unit ts-mocha --paths --config ./config/tests/.mocharc.json 'tests/**/*.unit.ts'"
64
64
  },
65
- "gitHead": "b6dac7585a9e1812f6af9dd7e349893f0c5561c9"
65
+ "gitHead": "001c3bfb3c45d7496cc8010611d9fd1c9f452bba"
66
66
  }