@schematichq/schematic-typescript-node 1.1.10 → 1.1.12

package/Client.d.ts

@@ -6,12 +6,14 @@ import * as core from "./core";
 import { Accounts } from "./api/resources/accounts/client/Client";
 import { Features } from "./api/resources/features/client/Client";
 import { Billing } from "./api/resources/billing/client/Client";
+import { Credits } from "./api/resources/credits/client/Client";
 import { Checkout } from "./api/resources/checkout/client/Client";
 import { Companies } from "./api/resources/companies/client/Client";
 import { Entitlements } from "./api/resources/entitlements/client/Client";
 import { Plans } from "./api/resources/plans/client/Client";
 import { Components } from "./api/resources/components/client/Client";
 import { Crm } from "./api/resources/crm/client/Client";
+import { Dataexports } from "./api/resources/dataexports/client/Client";
 import { Events } from "./api/resources/events/client/Client";
 import { Plangroups } from "./api/resources/plangroups/client/Client";
 import { Accesstokens } from "./api/resources/accesstokens/client/Client";
@@ -40,12 +42,14 @@ export declare class SchematicClient {
     protected _accounts: Accounts | undefined;
     protected _features: Features | undefined;
     protected _billing: Billing | undefined;
+    protected _credits: Credits | undefined;
     protected _checkout: Checkout | undefined;
     protected _companies: Companies | undefined;
     protected _entitlements: Entitlements | undefined;
     protected _plans: Plans | undefined;
     protected _components: Components | undefined;
     protected _crm: Crm | undefined;
+    protected _dataexports: Dataexports | undefined;
     protected _events: Events | undefined;
     protected _plangroups: Plangroups | undefined;
     protected _accesstokens: Accesstokens | undefined;
@@ -54,12 +58,14 @@ export declare class SchematicClient {
     get accounts(): Accounts;
     get features(): Features;
     get billing(): Billing;
+    get credits(): Credits;
     get checkout(): Checkout;
     get companies(): Companies;
     get entitlements(): Entitlements;
     get plans(): Plans;
     get components(): Components;
     get crm(): Crm;
+    get dataexports(): Dataexports;
     get events(): Events;
     get plangroups(): Plangroups;
     get accesstokens(): Accesstokens;

package/Client.js

@@ -7,16 +7,18 @@ exports.SchematicClient = void 0;
 const Client_1 = require("./api/resources/accounts/client/Client");
 const Client_2 = require("./api/resources/features/client/Client");
 const Client_3 = require("./api/resources/billing/client/Client");
-const Client_4 = require("./api/resources/checkout/client/Client");
-const Client_5 = require("./api/resources/companies/client/Client");
-const Client_6 = require("./api/resources/entitlements/client/Client");
-const Client_7 = require("./api/resources/plans/client/Client");
-const Client_8 = require("./api/resources/components/client/Client");
-const Client_9 = require("./api/resources/crm/client/Client");
-const Client_10 = require("./api/resources/events/client/Client");
-const Client_11 = require("./api/resources/plangroups/client/Client");
-const Client_12 = require("./api/resources/accesstokens/client/Client");
-const Client_13 = require("./api/resources/webhooks/client/Client");
+const Client_4 = require("./api/resources/credits/client/Client");
+const Client_5 = require("./api/resources/checkout/client/Client");
+const Client_6 = require("./api/resources/companies/client/Client");
+const Client_7 = require("./api/resources/entitlements/client/Client");
+const Client_8 = require("./api/resources/plans/client/Client");
+const Client_9 = require("./api/resources/components/client/Client");
+const Client_10 = require("./api/resources/crm/client/Client");
+const Client_11 = require("./api/resources/dataexports/client/Client");
+const Client_12 = require("./api/resources/events/client/Client");
+const Client_13 = require("./api/resources/plangroups/client/Client");
+const Client_14 = require("./api/resources/accesstokens/client/Client");
+const Client_15 = require("./api/resources/webhooks/client/Client");
 class SchematicClient {
     constructor(_options) {
         this._options = _options;
@@ -33,45 +35,53 @@ class SchematicClient {
         var _a;
         return ((_a = this._billing) !== null && _a !== void 0 ? _a : (this._billing = new Client_3.Billing(this._options)));
     }
+    get credits() {
+        var _a;
+        return ((_a = this._credits) !== null && _a !== void 0 ? _a : (this._credits = new Client_4.Credits(this._options)));
+    }
     get checkout() {
         var _a;
-        return ((_a = this._checkout) !== null && _a !== void 0 ? _a : (this._checkout = new Client_4.Checkout(this._options)));
+        return ((_a = this._checkout) !== null && _a !== void 0 ? _a : (this._checkout = new Client_5.Checkout(this._options)));
     }
     get companies() {
         var _a;
-        return ((_a = this._companies) !== null && _a !== void 0 ? _a : (this._companies = new Client_5.Companies(this._options)));
+        return ((_a = this._companies) !== null && _a !== void 0 ? _a : (this._companies = new Client_6.Companies(this._options)));
     }
     get entitlements() {
         var _a;
-        return ((_a = this._entitlements) !== null && _a !== void 0 ? _a : (this._entitlements = new Client_6.Entitlements(this._options)));
+        return ((_a = this._entitlements) !== null && _a !== void 0 ? _a : (this._entitlements = new Client_7.Entitlements(this._options)));
     }
     get plans() {
         var _a;
-        return ((_a = this._plans) !== null && _a !== void 0 ? _a : (this._plans = new Client_7.Plans(this._options)));
+        return ((_a = this._plans) !== null && _a !== void 0 ? _a : (this._plans = new Client_8.Plans(this._options)));
     }
     get components() {
         var _a;
-        return ((_a = this._components) !== null && _a !== void 0 ? _a : (this._components = new Client_8.Components(this._options)));
+        return ((_a = this._components) !== null && _a !== void 0 ? _a : (this._components = new Client_9.Components(this._options)));
     }
     get crm() {
         var _a;
-        return ((_a = this._crm) !== null && _a !== void 0 ? _a : (this._crm = new Client_9.Crm(this._options)));
+        return ((_a = this._crm) !== null && _a !== void 0 ? _a : (this._crm = new Client_10.Crm(this._options)));
+    }
+    get dataexports() {
+        var _a;
+        return ((_a = this._dataexports) !== null && _a !== void 0 ? _a : (this._dataexports = new Client_11.Dataexports(this._options)));
     }
     get events() {
         var _a;
-        return ((_a = this._events) !== null && _a !== void 0 ? _a : (this._events = new Client_10.Events(this._options)));
+        return ((_a = this._events) !== null && _a !== void 0 ? _a : (this._events = new Client_12.Events(this._options)));
     }
     get plangroups() {
         var _a;
-        return ((_a = this._plangroups) !== null && _a !== void 0 ? _a : (this._plangroups = new Client_11.Plangroups(this._options)));
+        return ((_a = this._plangroups) !== null && _a !== void 0 ? _a : (this._plangroups = new Client_13.Plangroups(this._options)));
     }
     get accesstokens() {
         var _a;
-        return ((_a = this._accesstokens) !== null && _a !== void 0 ? _a : (this._accesstokens = new Client_12.Accesstokens(this._options)));
+        return ((_a = this._accesstokens) !== null && _a !== void 0 ? _a : (this._accesstokens = new Client_14.Accesstokens(this._options)));
     }
     get webhooks() {
         var _a;
-        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_13.Webhooks(this._options)));
+        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_15.Webhooks(this._options)));
     }
 }
 exports.SchematicClient = SchematicClient;

package/README.md

@@ -85,6 +85,8 @@ client.close();
 
 ## Usage examples
 
+A number of these examples use `keys` to identify companies and users. Learn more about keys [here](https://docs.schematichq.com/developer_resources/key_management).
+
 ### Sending identify events
 
 Create or update users and companies using identify events.

package/api/errors/BadRequestError.d.ts

@@ -3,6 +3,7 @@
  */
 import * as errors from "../../errors/index";
 import * as Schematic from "../index";
+import * as core from "../../core";
 export declare class BadRequestError extends errors.SchematicError {
-    constructor(body: Schematic.ApiError);
+    constructor(body: Schematic.ApiError, rawResponse?: core.RawResponse);
 }

package/api/errors/BadRequestError.js

@@ -39,11 +39,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BadRequestError = void 0;
 const errors = __importStar(require("../../errors/index"));
 class BadRequestError extends errors.SchematicError {
-    constructor(body) {
+    constructor(body, rawResponse) {
         super({
             message: "BadRequestError",
             statusCode: 400,
             body: body,
+            rawResponse: rawResponse,
         });
         Object.setPrototypeOf(this, BadRequestError.prototype);
     }

package/api/errors/ForbiddenError.d.ts

@@ -3,6 +3,7 @@
  */
 import * as errors from "../../errors/index";
 import * as Schematic from "../index";
+import * as core from "../../core";
 export declare class ForbiddenError extends errors.SchematicError {
-    constructor(body: Schematic.ApiError);
+    constructor(body: Schematic.ApiError, rawResponse?: core.RawResponse);
 }

package/api/errors/ForbiddenError.js

@@ -39,11 +39,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ForbiddenError = void 0;
 const errors = __importStar(require("../../errors/index"));
 class ForbiddenError extends errors.SchematicError {
-    constructor(body) {
+    constructor(body, rawResponse) {
         super({
             message: "ForbiddenError",
             statusCode: 403,
             body: body,
+            rawResponse: rawResponse,
         });
         Object.setPrototypeOf(this, ForbiddenError.prototype);
     }

package/api/errors/InternalServerError.d.ts

@@ -3,6 +3,7 @@
  */
 import * as errors from "../../errors/index";
 import * as Schematic from "../index";
+import * as core from "../../core";
 export declare class InternalServerError extends errors.SchematicError {
-    constructor(body: Schematic.ApiError);
+    constructor(body: Schematic.ApiError, rawResponse?: core.RawResponse);
 }

package/api/errors/InternalServerError.js

@@ -39,11 +39,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.InternalServerError = void 0;
 const errors = __importStar(require("../../errors/index"));
 class InternalServerError extends errors.SchematicError {
-    constructor(body) {
+    constructor(body, rawResponse) {
         super({
             message: "InternalServerError",
             statusCode: 500,
             body: body,
+            rawResponse: rawResponse,
         });
         Object.setPrototypeOf(this, InternalServerError.prototype);
     }

package/api/errors/NotFoundError.d.ts

@@ -3,6 +3,7 @@
  */
 import * as errors from "../../errors/index";
 import * as Schematic from "../index";
+import * as core from "../../core";
 export declare class NotFoundError extends errors.SchematicError {
-    constructor(body: Schematic.ApiError);
+    constructor(body: Schematic.ApiError, rawResponse?: core.RawResponse);
 }

package/api/errors/NotFoundError.js

@@ -39,11 +39,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.NotFoundError = void 0;
 const errors = __importStar(require("../../errors/index"));
 class NotFoundError extends errors.SchematicError {
-    constructor(body) {
+    constructor(body, rawResponse) {
         super({
             message: "NotFoundError",
             statusCode: 404,
             body: body,
+            rawResponse: rawResponse,
         });
         Object.setPrototypeOf(this, NotFoundError.prototype);
     }

package/api/errors/UnauthorizedError.d.ts

@@ -3,6 +3,7 @@
  */
 import * as errors from "../../errors/index";
 import * as Schematic from "../index";
+import * as core from "../../core";
 export declare class UnauthorizedError extends errors.SchematicError {
-    constructor(body: Schematic.ApiError);
+    constructor(body: Schematic.ApiError, rawResponse?: core.RawResponse);
 }

package/api/errors/UnauthorizedError.js

@@ -39,11 +39,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.UnauthorizedError = void 0;
 const errors = __importStar(require("../../errors/index"));
 class UnauthorizedError extends errors.SchematicError {
-    constructor(body) {
+    constructor(body, rawResponse) {
         super({
             message: "UnauthorizedError",
             statusCode: 401,
             body: body,
+            rawResponse: rawResponse,
         });
         Object.setPrototypeOf(this, UnauthorizedError.prototype);
     }

package/api/errors/index.d.ts

@@ -1,5 +1,5 @@
 export * from "./BadRequestError";
 export * from "./UnauthorizedError";
 export * from "./ForbiddenError";
-export * from "./InternalServerError";
 export * from "./NotFoundError";
+export * from "./InternalServerError";

package/api/errors/index.js

@@ -17,5 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./BadRequestError"), exports);
 __exportStar(require("./UnauthorizedError"), exports);
 __exportStar(require("./ForbiddenError"), exports);
-__exportStar(require("./InternalServerError"), exports);
 __exportStar(require("./NotFoundError"), exports);
+__exportStar(require("./InternalServerError"), exports);

package/api/resources/accesstokens/client/Client.d.ts

@@ -33,17 +33,18 @@ export declare class Accesstokens {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.accesstokens.issueTemporaryAccessToken({
      *         lookup: {
      *             "key": "value"
-     *         },
-     *         resourceType: "resource_type"
+     *         }
      *     })
      */
-    issueTemporaryAccessToken(request: Schematic.IssueTemporaryAccessTokenRequestBody, requestOptions?: Accesstokens.RequestOptions): Promise<Schematic.IssueTemporaryAccessTokenResponse>;
+    issueTemporaryAccessToken(request: Schematic.IssueTemporaryAccessTokenRequestBody, requestOptions?: Accesstokens.RequestOptions): core.HttpResponsePromise<Schematic.IssueTemporaryAccessTokenResponse>;
+    private __issueTemporaryAccessToken;
     protected _getCustomAuthorizationHeaders(): Promise<{
         "X-Schematic-Api-Key": string;
     }>;

package/api/resources/accesstokens/client/Client.js

@@ -66,40 +66,46 @@ class Accesstokens {
      * @throws {@link Schematic.BadRequestError}
      * @throws {@link Schematic.UnauthorizedError}
      * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
      *
      * @example
      *     await client.accesstokens.issueTemporaryAccessToken({
      *         lookup: {
      *             "key": "value"
-     *         },
-     *         resourceType: "resource_type"
+     *         }
      *     })
      */
     issueTemporaryAccessToken(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__issueTemporaryAccessToken(request, requestOptions));
+    }
+    __issueTemporaryAccessToken(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c;
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.SchematicEnvironment.Default, "temporary-access-tokens"),
                 method: "POST",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@schematichq/schematic-typescript-node", "X-Fern-SDK-Version": "1.1.10", "User-Agent": "@schematichq/schematic-typescript-node/1.1.10", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@schematichq/schematic-typescript-node", "X-Fern-SDK-Version": "1.1.12", "User-Agent": "@schematichq/schematic-typescript-node/1.1.12", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
-                body: serializers.IssueTemporaryAccessTokenRequestBody.jsonOrThrow(request, {
+                body: Object.assign(Object.assign({}, serializers.IssueTemporaryAccessTokenRequestBody.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "strip",
-                }),
+                })), { resource_type: "company" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
-                return serializers.IssueTemporaryAccessTokenResponse.parseOrThrow(_response.body, {
-                    unrecognizedObjectKeys: "passthrough",
-                    allowUnrecognizedUnionMembers: true,
-                    allowUnrecognizedEnumValues: true,
-                    skipValidation: true,
-                    breadcrumbsPrefix: ["response"],
-                });
+                return {
+                    data: serializers.IssueTemporaryAccessTokenResponse.parseOrThrow(_response.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        skipValidation: true,
+                        breadcrumbsPrefix: ["response"],
+                    }),
+                    rawResponse: _response.rawResponse,
+                };
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
@@ -110,7 +116,7 @@ class Accesstokens {
                             allowUnrecognizedEnumValues: true,
                             skipValidation: true,
                             breadcrumbsPrefix: ["response"],
-                        }));
+                        }), _response.rawResponse);
                     case 401:
                         throw new Schematic.UnauthorizedError(serializers.ApiError.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
@@ -118,7 +124,7 @@ class Accesstokens {
                             allowUnrecognizedEnumValues: true,
                             skipValidation: true,
                             breadcrumbsPrefix: ["response"],
-                        }));
+                        }), _response.rawResponse);
                     case 403:
                         throw new Schematic.ForbiddenError(serializers.ApiError.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
@@ -126,7 +132,15 @@ class Accesstokens {
                             allowUnrecognizedEnumValues: true,
                             skipValidation: true,
                             breadcrumbsPrefix: ["response"],
-                        }));
+                        }), _response.rawResponse);
+                    case 404:
+                        throw new Schematic.NotFoundError(serializers.ApiError.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
                     case 500:
                         throw new Schematic.InternalServerError(serializers.ApiError.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
@@ -134,11 +148,12 @@ class Accesstokens {
                             allowUnrecognizedEnumValues: true,
                             skipValidation: true,
                             breadcrumbsPrefix: ["response"],
-                        }));
+                        }), _response.rawResponse);
                     default:
                         throw new errors.SchematicError({
                             statusCode: _response.error.statusCode,
                             body: _response.error.body,
+                            rawResponse: _response.rawResponse,
                         });
                 }
             }
@@ -147,12 +162,14 @@ class Accesstokens {
                     throw new errors.SchematicError({
                         statusCode: _response.error.statusCode,
                         body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
                     });
                 case "timeout":
                     throw new errors.SchematicTimeoutError("Timeout exceeded when calling POST /temporary-access-tokens.");
                 case "unknown":
                     throw new errors.SchematicError({
                         message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
                     });
             }
         });

package/api/resources/accesstokens/client/requests/IssueTemporaryAccessTokenRequestBody.d.ts

@@ -6,11 +6,9 @@
  *     {
  *         lookup: {
  *             "key": "value"
- *         },
- *         resourceType: "resource_type"
+ *         }
  *     }
  */
 export interface IssueTemporaryAccessTokenRequestBody {
     lookup: Record<string, string>;
-    resourceType: string;
 }