@voiceflow/api-sdk 3.10.5 → 3.11.2

package/build/common/client.d.ts

@@ -1,5 +1,5 @@
-import { ClientOptions, PublicClient } from "./publicclient";
-import { User } from "./resources";
+import { ClientOptions, PublicClient } from './publicClient';
+import { User } from './resources';
 export declare class Client extends PublicClient {
     user: User;
     constructor(options: Omit<ClientOptions, 'authorization'> & {

package/build/common/client.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Client = void 0;
-const publicclient_1 = require("./publicclient");
+const publicClient_1 = require("./publicClient");
 const resources_1 = require("./resources");
-class Client extends publicclient_1.PublicClient {
+class Client extends publicClient_1.PublicClient {
     constructor(options) {
         super(options);
         this.user = new resources_1.User(options.authorization);

package/build/common/index.d.ts

@@ -1,9 +1,9 @@
-import { Client } from "./client";
-import { ClientOptions, PublicClient } from "./publicclient";
 import * as s from 'superstruct';
-export { Client } from "./client";
-export { PublicClient } from "./publicclient";
-export { Flatten } from "./types";
+import { Client } from './client';
+import { ClientOptions, PublicClient } from './publicClient';
+export type { Client } from './client';
+export type { PublicClient } from './publicClient';
+export type { Flatten } from './types';
 export declare const SParams: s.Struct<{
     clientKey: string;
     apiEndpoint: string;

package/build/common/index.js

@@ -20,9 +20,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SGenerateClientParams = exports.SParams = void 0;
-const client_1 = require("./client");
-const publicclient_1 = require("./publicclient");
 const s = __importStar(require("superstruct"));
+const client_1 = require("./client");
+const publicClient_1 = require("./publicClient");
 exports.SParams = s.object({
     clientKey: s.string(),
     apiEndpoint: s.string(),
@@ -37,7 +37,7 @@ class ApiSDK {
         this.apiEndpoint = apiEndpoint;
     }
     generatePublicClient(options = {}) {
-        return new publicclient_1.PublicClient(Object.assign(Object.assign({}, options), { clientKey: this.clientKey, apiEndpoint: this.apiEndpoint }));
+        return new publicClient_1.PublicClient(Object.assign(Object.assign({}, options), { clientKey: this.clientKey, apiEndpoint: this.apiEndpoint }));
     }
     generateClient(options) {
         s.assert({ authorization: options.authorization }, exports.SGenerateClientParams);

package/build/common/{publicclient.d.ts → publicClient.d.ts}

@@ -1,6 +1,6 @@
-import Fetch, { FetchConfig } from "./fetch";
-import { Analytics, APIKey, Diagram, Program, Project, PrototypeProgram, VariableState, Version } from "./resources";
 import { Crypto } from '@voiceflow/common';
+import Fetch, { FetchConfig } from './fetch';
+import { Analytics, APIKey, Diagram, Note, Program, Project, PrototypeProgram, VariableState, Version } from './resources';
 export interface ClientOptions {
     options?: FetchConfig;
     clientKey: string;
@@ -9,14 +9,15 @@ export interface ClientOptions {
     analyticsEncryption?: Crypto.Synchronous;
 }
 export declare class PublicClient {
+    note: Note;
     fetch: Fetch;
+    apiKey: APIKey;
     project: Project;
     version: Version;
     program: Program;
     diagram: Diagram;
     analytics: Analytics;
-    apiKey: APIKey;
-    prototypeProgram: PrototypeProgram;
     variableState: VariableState;
+    prototypeProgram: PrototypeProgram;
     constructor({ clientKey, apiEndpoint, authorization, options, analyticsEncryption }: ClientOptions);
 }

package/build/common/{publicclient.js → publicClient.js}

@@ -9,14 +9,15 @@ const resources_1 = require("./resources");
 class PublicClient {
     constructor({ clientKey, apiEndpoint, authorization, options, analyticsEncryption }) {
         this.fetch = new fetch_1.default({ clientKey, apiEndpoint, authorization, options });
+        this.note = new resources_1.Note(this.fetch);
         this.apiKey = new resources_1.APIKey(this.fetch);
         this.project = new resources_1.Project(this.fetch);
         this.version = new resources_1.Version(this.fetch);
         this.program = new resources_1.Program(this.fetch);
         this.diagram = new resources_1.Diagram(this.fetch);
         this.analytics = new resources_1.Analytics(this.fetch, { encryption: analyticsEncryption });
-        this.prototypeProgram = new resources_1.PrototypeProgram(this.fetch);
         this.variableState = new resources_1.VariableState(this.fetch);
+        this.prototypeProgram = new resources_1.PrototypeProgram(this.fetch);
     }
 }
 exports.PublicClient = PublicClient;

package/build/common/resources/base.d.ts

@@ -1,8 +1,8 @@
 import Fetcher, { FetcherOptions } from './fetcher';
 export declare type Fields = string[] | ReadonlyArray<string>;
-export declare type BaseResourceOptions<C extends Record<string, any>> = FetcherOptions<C>;
-declare class BaseResource<C extends Record<string, any>> extends Fetcher<C> {
-    constructor(options: BaseResourceOptions<C>);
+export declare type BaseResourceOptions<Client extends Record<string, any>> = FetcherOptions<Client>;
+declare class BaseResource<Client extends Record<string, any>> extends Fetcher<Client> {
+    constructor(options: BaseResourceOptions<Client>);
     protected _getFieldsQuery(fields?: Fields): string;
 }
 export default BaseResource;

package/build/common/resources/index.d.ts

@@ -1,6 +1,7 @@
 export { default as Analytics } from './analytics';
 export { default as APIKey } from './apiKey';
 export { default as Diagram } from './diagram';
+export { default as Note } from './note';
 export { default as Program } from './program';
 export { default as Project } from './project';
 export { default as PrototypeProgram } from './prototypeProgram';

package/build/common/resources/index.js

@@ -3,13 +3,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Version = exports.VariableState = exports.User = exports.PrototypeProgram = exports.Project = exports.Program = exports.Diagram = exports.APIKey = exports.Analytics = void 0;
+exports.Version = exports.VariableState = exports.User = exports.PrototypeProgram = exports.Project = exports.Program = exports.Note = exports.Diagram = exports.APIKey = exports.Analytics = void 0;
 var analytics_1 = require("./analytics");
 Object.defineProperty(exports, "Analytics", { enumerable: true, get: function () { return __importDefault(analytics_1).default; } });
 var apiKey_1 = require("./apiKey");
 Object.defineProperty(exports, "APIKey", { enumerable: true, get: function () { return __importDefault(apiKey_1).default; } });
 var diagram_1 = require("./diagram");
 Object.defineProperty(exports, "Diagram", { enumerable: true, get: function () { return __importDefault(diagram_1).default; } });
+var note_1 = require("./note");
+Object.defineProperty(exports, "Note", { enumerable: true, get: function () { return __importDefault(note_1).default; } });
 var program_1 = require("./program");
 Object.defineProperty(exports, "Program", { enumerable: true, get: function () { return __importDefault(program_1).default; } });
 var project_1 = require("./project");

package/build/common/resources/note.d.ts

@@ -0,0 +1,11 @@
+import Fetch from "../fetch";
+import { BaseModels } from '@voiceflow/base-types';
+import BaseResource from './base';
+export declare const ENDPOINT = "notes";
+export declare type ModelKey = 'id';
+declare class NoteResource extends BaseResource<NoteResource> {
+    constructor(fetch: Fetch);
+    upsert<T extends BaseModels.BaseNote = BaseModels.BaseNote>(versionID: string, note: T): Promise<T>;
+    delete(versionID: string, noteID: string): Promise<void>;
+}
+export default NoteResource;

package/build/common/resources/note.js

@@ -0,0 +1,21 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ENDPOINT = void 0;
+const base_1 = __importDefault(require("./base"));
+exports.ENDPOINT = 'notes';
+class NoteResource extends base_1.default {
+    constructor(fetch) {
+        super({ fetch, clazz: NoteResource, endpoint: exports.ENDPOINT });
+    }
+    async upsert(versionID, note) {
+        const { data } = await this.fetch.put(`${this._getEndpoint()}/${versionID}`, { note });
+        return data;
+    }
+    async delete(versionID, noteID) {
+        await this.fetch.delete(`${this._getEndpoint()}/${versionID}/${noteID}`);
+    }
+}
+exports.default = NoteResource;

package/build/esm/client.d.ts

@@ -1,5 +1,5 @@
-import { ClientOptions, PublicClient } from "./publicclient";
-import { User } from "./resources";
+import { ClientOptions, PublicClient } from './publicClient';
+import { User } from './resources';
 export declare class Client extends PublicClient {
     user: User;
     constructor(options: Omit<ClientOptions, 'authorization'> & {

package/build/esm/client.js

@@ -1,5 +1,5 @@
-import { PublicClient } from "./publicclient";
-import { User } from "./resources";
+import { PublicClient } from './publicClient';
+import { User } from './resources';
 export class Client extends PublicClient {
     constructor(options) {
         super(options);

package/build/esm/index.d.ts

@@ -1,9 +1,9 @@
-import { Client } from "./client";
-import { ClientOptions, PublicClient } from "./publicclient";
 import * as s from 'superstruct';
-export { Client } from "./client";
-export { PublicClient } from "./publicclient";
-export { Flatten } from "./types";
+import { Client } from './client';
+import { ClientOptions, PublicClient } from './publicClient';
+export type { Client } from './client';
+export type { PublicClient } from './publicClient';
+export type { Flatten } from './types';
 export declare const SParams: s.Struct<{
     clientKey: string;
     apiEndpoint: string;

package/build/esm/index.js

@@ -1,6 +1,6 @@
-import { Client } from "./client";
-import { PublicClient } from "./publicclient";
 import * as s from 'superstruct';
+import { Client } from './client';
+import { PublicClient } from './publicClient';
 export const SParams = s.object({
     clientKey: s.string(),
     apiEndpoint: s.string(),

package/build/esm/{publicclient.d.ts → publicClient.d.ts}

@@ -1,6 +1,6 @@
-import Fetch, { FetchConfig } from "./fetch";
-import { Analytics, APIKey, Diagram, Program, Project, PrototypeProgram, VariableState, Version } from "./resources";
 import { Crypto } from '@voiceflow/common';
+import Fetch, { FetchConfig } from './fetch';
+import { Analytics, APIKey, Diagram, Note, Program, Project, PrototypeProgram, VariableState, Version } from './resources';
 export interface ClientOptions {
     options?: FetchConfig;
     clientKey: string;
@@ -9,14 +9,15 @@ export interface ClientOptions {
     analyticsEncryption?: Crypto.Synchronous;
 }
 export declare class PublicClient {
+    note: Note;
     fetch: Fetch;
+    apiKey: APIKey;
     project: Project;
     version: Version;
     program: Program;
     diagram: Diagram;
     analytics: Analytics;
-    apiKey: APIKey;
-    prototypeProgram: PrototypeProgram;
     variableState: VariableState;
+    prototypeProgram: PrototypeProgram;
     constructor({ clientKey, apiEndpoint, authorization, options, analyticsEncryption }: ClientOptions);
 }

package/build/esm/{publicclient.js → publicClient.js}

@@ -1,15 +1,16 @@
-import Fetch from "./fetch";
-import { Analytics, APIKey, Diagram, Program, Project, PrototypeProgram, VariableState, Version } from "./resources";
+import Fetch from './fetch';
+import { Analytics, APIKey, Diagram, Note, Program, Project, PrototypeProgram, VariableState, Version } from './resources';
 export class PublicClient {
     constructor({ clientKey, apiEndpoint, authorization, options, analyticsEncryption }) {
         this.fetch = new Fetch({ clientKey, apiEndpoint, authorization, options });
+        this.note = new Note(this.fetch);
         this.apiKey = new APIKey(this.fetch);
         this.project = new Project(this.fetch);
         this.version = new Version(this.fetch);
         this.program = new Program(this.fetch);
         this.diagram = new Diagram(this.fetch);
         this.analytics = new Analytics(this.fetch, { encryption: analyticsEncryption });
-        this.prototypeProgram = new PrototypeProgram(this.fetch);
         this.variableState = new VariableState(this.fetch);
+        this.prototypeProgram = new PrototypeProgram(this.fetch);
     }
 }

package/build/esm/resources/base.d.ts

@@ -1,8 +1,8 @@
 import Fetcher, { FetcherOptions } from './fetcher';
 export declare type Fields = string[] | ReadonlyArray<string>;
-export declare type BaseResourceOptions<C extends Record<string, any>> = FetcherOptions<C>;
-declare class BaseResource<C extends Record<string, any>> extends Fetcher<C> {
-    constructor(options: BaseResourceOptions<C>);
+export declare type BaseResourceOptions<Client extends Record<string, any>> = FetcherOptions<Client>;
+declare class BaseResource<Client extends Record<string, any>> extends Fetcher<Client> {
+    constructor(options: BaseResourceOptions<Client>);
     protected _getFieldsQuery(fields?: Fields): string;
 }
 export default BaseResource;

package/build/esm/resources/index.d.ts

@@ -1,6 +1,7 @@
 export { default as Analytics } from './analytics';
 export { default as APIKey } from './apiKey';
 export { default as Diagram } from './diagram';
+export { default as Note } from './note';
 export { default as Program } from './program';
 export { default as Project } from './project';
 export { default as PrototypeProgram } from './prototypeProgram';

package/build/esm/resources/index.js

@@ -1,6 +1,7 @@
 export { default as Analytics } from './analytics';
 export { default as APIKey } from './apiKey';
 export { default as Diagram } from './diagram';
+export { default as Note } from './note';
 export { default as Program } from './program';
 export { default as Project } from './project';
 export { default as PrototypeProgram } from './prototypeProgram';

package/build/esm/resources/note.d.ts

@@ -0,0 +1,11 @@
+import Fetch from "../fetch";
+import { BaseModels } from '@voiceflow/base-types';
+import BaseResource from './base';
+export declare const ENDPOINT = "notes";
+export declare type ModelKey = 'id';
+declare class NoteResource extends BaseResource<NoteResource> {
+    constructor(fetch: Fetch);
+    upsert<T extends BaseModels.BaseNote = BaseModels.BaseNote>(versionID: string, note: T): Promise<T>;
+    delete(versionID: string, noteID: string): Promise<void>;
+}
+export default NoteResource;

package/build/esm/resources/note.js

@@ -0,0 +1,15 @@
+import BaseResource from './base';
+export const ENDPOINT = 'notes';
+class NoteResource extends BaseResource {
+    constructor(fetch) {
+        super({ fetch, clazz: NoteResource, endpoint: ENDPOINT });
+    }
+    async upsert(versionID, note) {
+        const { data } = await this.fetch.put(`${this._getEndpoint()}/${versionID}`, { note });
+        return data;
+    }
+    async delete(versionID, noteID) {
+        await this.fetch.delete(`${this._getEndpoint()}/${versionID}/${noteID}`);
+    }
+}
+export default NoteResource;

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@voiceflow/api-sdk",
   "description": "wrapper for creator-api",
-  "version": "3.10.5",
+  "version": "3.11.2",
   "author": "Voiceflow",
   "bugs": {
     "url": "https://github.com/voiceflow/libs/issues"
   },
   "dependencies": {
-    "@voiceflow/base-types": "^2.18.0",
-    "@voiceflow/common": "^7.24.0",
+    "@voiceflow/base-types": "^2.19.2",
+    "@voiceflow/common": "^7.25.1",
     "axios": "0.24.0",
     "jwt-decode": "^3.1.2",
     "superstruct": "^0.10.12"
@@ -62,5 +62,5 @@
     "test:single": "NODE_ENV=test ts-mocha --paths --config ./config/tests/.mocharc.json",
     "test:unit": "NODE_ENV=test nyc --report-dir=nyc_coverage_unit ts-mocha --paths --config ./config/tests/.mocharc.json 'tests/**/*.unit.ts'"
   },
-  "gitHead": "8151c9f50f464c63f792373626d50079b0e605d1"
+  "gitHead": "cb46007be51b23d0852dbe4899c55bdc2afcf9bd"
 }