snaptrade-typescript-sdk 8.18.0 → 8.20.0

package/dist/configuration.d.ts

@@ -1,99 +1,99 @@
-/**
- * SnapTrade
- * Connect brokerage accounts to your app for live positions and trading
- *
- * The version of the OpenAPI document: 1.0.0
- * Contact: api@snaptrade.com
- *
- * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
- * Do not edit the class manually.
- */
-type ApiKey = string | ((keyParamName: string) => string) | ((keyParamName: string) => Promise<string>) | {
-    [apiKeyName: string]: string | undefined;
-};
-export interface ConfigurationParameters {
-    consumerKey?: string;
-    clientId?: string;
-    Signature?: string;
-    timestamp?: string;
-    apiKey?: ApiKey;
-    username?: string;
-    password?: string;
-    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
-    basePath?: string;
-    baseOptions?: any;
-    userAgent?: string;
-    formDataCtor?: new () => any;
-}
-export declare class Configuration {
-    /**
-    * Client state
-    */
-    consumerKey?: string;
-    /**
-     * parameter for apiKey security
-     * @param name security name
-     * @memberof Configuration
-     */
-    apiKey?: ApiKey;
-    /**
-     * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    username?: string;
-    /**
-     * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    password?: string;
-    /**
-     * parameter for oauth2 security
-     * @param name security name
-     * @param scopes oauth2 scope
-     * @memberof Configuration
-     */
-    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
-    /**
-     * override base path
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    basePath?: string;
-    /**
-     * base options for axios calls
-     *
-     * @type {any}
-     * @memberof Configuration
-     */
-    baseOptions?: any;
-    /**
-     * The FormData constructor that will be used to create multipart form data
-     * requests. You can inject this here so that execution environments that
-     * do not support the FormData class can still run the generated client.
-     *
-     * @type {new () => FormData}
-     */
-    formDataCtor?: new () => any;
-    /**
-     * Default User-Agent header
-     */
-    userAgent: string;
-    constructor(param?: ConfigurationParameters);
-    /**
-     * Check if the given MIME is a JSON MIME.
-     * JSON MIME examples:
-     *   application/json
-     *   application/json; charset=UTF8
-     *   APPLICATION/JSON
-     *   application/vnd.company+json
-     * @param mime - MIME (Multipurpose Internet Mail Extensions)
-     * @return True if the given MIME is JSON, false otherwise.
-     */
-    isJsonMime(mime: string): boolean;
-}
-export {};
+/**
+ * SnapTrade
+ * Connect brokerage accounts to your app for live positions and trading
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: api@snaptrade.com
+ *
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
+ * Do not edit the class manually.
+ */
+type ApiKey = string | ((keyParamName: string) => string) | ((keyParamName: string) => Promise<string>) | {
+    [apiKeyName: string]: string | undefined;
+};
+export interface ConfigurationParameters {
+    consumerKey?: string;
+    clientId?: string;
+    signature?: string;
+    timestamp?: string;
+    apiKey?: ApiKey;
+    username?: string;
+    password?: string;
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    basePath?: string;
+    baseOptions?: any;
+    userAgent?: string;
+    formDataCtor?: new () => any;
+}
+export declare class Configuration {
+    /**
+    * Client state
+    */
+    consumerKey?: string;
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     * @memberof Configuration
+     */
+    apiKey?: ApiKey;
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    username?: string;
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    password?: string;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     * @memberof Configuration
+     */
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * override base path
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    basePath?: string;
+    /**
+     * base options for axios calls
+     *
+     * @type {any}
+     * @memberof Configuration
+     */
+    baseOptions?: any;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor?: new () => any;
+    /**
+     * Default User-Agent header
+     */
+    userAgent: string;
+    constructor(param?: ConfigurationParameters);
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime: string): boolean;
+}
+export {};

package/dist/configuration.js

@@ -1,55 +1,53 @@
-"use strict";
-/* tslint:disable */
-/* eslint-disable */
-/**
- * SnapTrade
- * Connect brokerage accounts to your app for live positions and trading
- *
- * The version of the OpenAPI document: 1.0.0
- * Contact: api@snaptrade.com
- *
- * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
- * Do not edit the class manually.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Configuration = void 0;
-var Configuration = /** @class */ (function () {
-    function Configuration(param) {
-        if (param === void 0) { param = {}; }
-        var _a;
-        this.consumerKey = param.consumerKey;
-        this.apiKey = param.apiKey;
-        if (this.apiKey === undefined) {
-            this.apiKey = {};
-            if (param.clientId !== undefined)
-                this.apiKey["clientId"] = param.clientId;
-            if (param.Signature !== undefined)
-                this.apiKey["Signature"] = param.Signature;
-            if (param.timestamp !== undefined)
-                this.apiKey["timestamp"] = param.timestamp;
-        }
-        this.username = param.username;
-        this.password = param.password;
-        this.accessToken = param.accessToken;
-        this.basePath = param.basePath;
-        this.baseOptions = (_a = param.baseOptions) !== null && _a !== void 0 ? _a : {};
-        this.userAgent = param.userAgent === undefined ? "Konfig/8.18.0/typescript" : param.userAgent;
-        this.formDataCtor = param.formDataCtor;
-    }
-    /**
-     * Check if the given MIME is a JSON MIME.
-     * JSON MIME examples:
-     *   application/json
-     *   application/json; charset=UTF8
-     *   APPLICATION/JSON
-     *   application/vnd.company+json
-     * @param mime - MIME (Multipurpose Internet Mail Extensions)
-     * @return True if the given MIME is JSON, false otherwise.
-     */
-    Configuration.prototype.isJsonMime = function (mime) {
-        var jsonMime = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
-        return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
-    };
-    return Configuration;
-}());
-exports.Configuration = Configuration;
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SnapTrade
+ * Connect brokerage accounts to your app for live positions and trading
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: api@snaptrade.com
+ *
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Configuration = void 0;
+class Configuration {
+    constructor(param = {}) {
+        var _a;
+        this.consumerKey = param.consumerKey;
+        this.apiKey = param.apiKey;
+        if (this.apiKey === undefined) {
+            this.apiKey = {};
+            if (param.clientId !== undefined)
+                this.apiKey["clientId"] = param.clientId;
+            if (param.signature !== undefined)
+                this.apiKey["Signature"] = param.signature;
+            if (param.timestamp !== undefined)
+                this.apiKey["timestamp"] = param.timestamp;
+        }
+        this.username = param.username;
+        this.password = param.password;
+        this.accessToken = param.accessToken;
+        this.basePath = param.basePath;
+        this.baseOptions = (_a = param.baseOptions) !== null && _a !== void 0 ? _a : {};
+        this.userAgent = param.userAgent === undefined ? "Konfig/8.20.0/typescript" : param.userAgent;
+        this.formDataCtor = param.formDataCtor;
+    }
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime) {
+        const jsonMime = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
+        return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
+    }
+}
+exports.Configuration = Configuration;

package/dist/error.d.ts

@@ -0,0 +1,56 @@
+/**
+ * SnapTrade
+ * Connect brokerage accounts to your app for live positions and trading
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: api@snaptrade.com
+ *
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
+ * Do not edit the class manually.
+ */
+import type { AxiosError } from "axios";
+/**
+ * This class provides a wrapper for network errors when making requests to SnapTrade
+ */
+export declare class SnaptradeError extends Error {
+    /**
+     * The response body
+     */
+    readonly responseBody: unknown;
+    /**
+     * The error code provided from the underlying "axios" library which can be
+     * more descriptive than the HTTP status descriptions.
+     */
+    readonly code?: string;
+    /**
+     * The status code from the response.
+     * For explanations, refer to https://developer.mozilla.org/en-US/docs/Web/HTTP/Status
+     */
+    readonly status?: number;
+    /**
+     * The status text from the response.
+     * For explanations, refer to https://developer.mozilla.org/en-US/docs/Web/HTTP/Status
+     */
+    readonly statusText?: string;
+    /**
+     * The URL that the original request was sent to
+     */
+    readonly url?: string;
+    /**
+     * HTTP request method (see https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods)
+     */
+    readonly method?: string;
+    constructor(axiosError: AxiosError, responseBody: unknown);
+    toJSON(): {
+        name: string;
+        message: string;
+        method: string;
+        url: string;
+        code: string;
+        status: number;
+        statusText: string;
+        responseBody: unknown;
+    };
+}
+export declare function readableStreamToString(stream: ReadableStream): Promise<string>;
+export declare function parseIfJson(input: unknown): object | unknown;

package/dist/error.js

@@ -0,0 +1,104 @@
+"use strict";
+/**
+ * SnapTrade
+ * Connect brokerage accounts to your app for live positions and trading
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: api@snaptrade.com
+ *
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseIfJson = exports.readableStreamToString = exports.SnaptradeError = void 0;
+/**
+ * This class provides a wrapper for network errors when making requests to SnapTrade
+ */
+class SnaptradeError extends Error {
+    constructor(axiosError, responseBody) {
+        var _a, _b, _c;
+        super(axiosError.message);
+        this.name = "SnaptradeError";
+        this.code = axiosError.code;
+        this.method = (_a = axiosError.config.method) === null || _a === void 0 ? void 0 : _a.toUpperCase();
+        this.url = axiosError.config.url;
+        this.status = (_b = axiosError.response) === null || _b === void 0 ? void 0 : _b.status;
+        this.statusText = (_c = axiosError.response) === null || _c === void 0 ? void 0 : _c.statusText;
+        this.responseBody = responseBody;
+    }
+    toJSON() {
+        return {
+            name: this.name,
+            message: this.message,
+            method: this.method,
+            url: this.url,
+            code: this.code,
+            status: this.status,
+            statusText: this.statusText,
+            responseBody: this.responseBody,
+        };
+    }
+}
+exports.SnaptradeError = SnaptradeError;
+function readableStreamToString(stream) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // Step 1: Create a new TextDecoder
+        const decoder = new TextDecoder();
+        // Step 2: Create a new ReadableStreamDefaultReader
+        const reader = stream.getReader();
+        // Step 3: Initialize an empty string to hold the result
+        let result = "";
+        try {
+            while (true) {
+                // Step 4: Read data from the stream
+                const { done, value } = yield reader.read();
+                // If there is no more data to read, break the loop
+                if (done)
+                    break;
+                // Convert the chunk of data to a string using the TextDecoder
+                const chunk = decoder.decode(value, { stream: true });
+                // Concatenate the chunk to the result
+                result += chunk;
+            }
+        }
+        finally {
+            // Step 5: Release the ReadableStreamDefaultReader when done or in case of an error
+            reader.releaseLock();
+        }
+        // Return the final result as a string
+        return result;
+    });
+}
+exports.readableStreamToString = readableStreamToString;
+function parseIfJson(input) {
+    if (typeof input !== "string") {
+        // If the input is not a string, return the original input
+        return input;
+    }
+    try {
+        // Attempt to parse the input as JSON
+        const parsedJSON = JSON.parse(input);
+        // Check if the parsed result is an object (not an array or primitive value)
+        if (typeof parsedJSON === "object" && parsedJSON !== null) {
+            return parsedJSON;
+        }
+        else {
+            // Return the original input if the parsed result is not an object
+            return input;
+        }
+    }
+    catch (error) {
+        // Return the original input if parsing fails (invalid JSON)
+        return input;
+    }
+}
+exports.parseIfJson = parseIfJson;

package/dist/index.d.ts

@@ -1,14 +1,15 @@
-/**
- * SnapTrade
- * Connect brokerage accounts to your app for live positions and trading
- *
- * The version of the OpenAPI document: 1.0.0
- * Contact: api@snaptrade.com
- *
- * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
- * Do not edit the class manually.
- */
-export * from "./api";
-export * from "./configuration";
-export * from "./models";
-export * from "./client";
+/**
+ * SnapTrade
+ * Connect brokerage accounts to your app for live positions and trading
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: api@snaptrade.com
+ *
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
+ * Do not edit the class manually.
+ */
+export * from "./api";
+export * from "./configuration";
+export * from "./models";
+export * from "./client";
+export * from "./error";

package/dist/index.js

@@ -1,32 +1,33 @@
-"use strict";
-/* tslint:disable */
-/* eslint-disable */
-/**
- * SnapTrade
- * Connect brokerage accounts to your app for live positions and trading
- *
- * The version of the OpenAPI document: 1.0.0
- * Contact: api@snaptrade.com
- *
- * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
- * Do not edit the class manually.
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./api"), exports);
-__exportStar(require("./configuration"), exports);
-__exportStar(require("./models"), exports);
-__exportStar(require("./client"), exports);
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SnapTrade
+ * Connect brokerage accounts to your app for live positions and trading
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: api@snaptrade.com
+ *
+ * NOTE: This file is auto generated by Konfig (https://konfigthis.com).
+ * Do not edit the class manually.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./api"), exports);
+__exportStar(require("./configuration"), exports);
+__exportStar(require("./models"), exports);
+__exportStar(require("./client"), exports);
+__exportStar(require("./error"), exports);

package/dist/jest.config.d.ts

@@ -1,3 +1,3 @@
-import type { Config } from "@jest/types";
-declare const config: Config.InitialOptions;
-export default config;
+import type { Config } from "@jest/types";
+declare const config: Config.InitialOptions;
+export default config;

package/dist/jest.config.js

@@ -1,13 +1,13 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var config = {
-    verbose: true,
-    preset: "ts-jest",
-    testEnvironment: "node",
-    testPathIgnorePatterns: ["dist/"],
-    testTimeout: 60 * 1000,
-    transform: {
-        "^.+\\.ts?$": ["ts-jest", { tsconfig: "./tsconfig.test.json" }],
-    },
-};
-exports.default = config;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const config = {
+    verbose: true,
+    preset: "ts-jest",
+    testEnvironment: "node",
+    testPathIgnorePatterns: ["dist/"],
+    testTimeout: 60 * 1000,
+    transform: {
+        "^.+\\.ts?$": ["ts-jest", { tsconfig: "./tsconfig.test.json" }],
+    },
+};
+exports.default = config;