snaptrade-typescript-sdk 2.4.0 → 4.0.0

package/dist/models/usexchange.d.ts

@@ -0,0 +1,73 @@
+/**
+ * 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).
+ * https://konfigthis.com
+ * Do not edit the class manually.
+ */
+/**
+ * US Stock Exchange
+ * @export
+ * @interface USExchange
+ */
+export interface USExchange {
+    [key: string]: any;
+    /**
+     *
+     * @type {string}
+     * @memberof USExchange
+     */
+    'id'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof USExchange
+     */
+    'code'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof USExchange
+     */
+    'mic_code'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof USExchange
+     */
+    'name'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof USExchange
+     */
+    'timezone'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof USExchange
+     */
+    'start_time'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof USExchange
+     */
+    'close_time'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof USExchange
+     */
+    'suffix'?: string | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof USExchange
+     */
+    'allows_cryptocurrency_symbols'?: boolean;
+}

package/dist/models/usexchange.js

@@ -0,0 +1,15 @@
+"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).
+ * https://konfigthis.com
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/pagination/page.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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).
+ * https://konfigthis.com
+ * Do not edit the class manually.
+ */
+import { Pageable, PageParametersBase } from "./pageable";
+/**
+ * The set of parameters that appear in a paginated operation (requestBody or parameters)
+ */
+export type PageParameterProperties = {
+    [key: string]: any;
+};
+export type PageParameters = PageParametersBase<PageParameterProperties>;
+/**
+ * The set of properties that appear in a paginated operation's response
+ */
+export interface PageInfo {
+    [key: string]: any;
+}
+export declare class Page<Data extends PageInfo, Parameters extends PageParameters> extends Pageable<Data, Parameters> {
+    protected get previousParameters(): PageParameterProperties | null;
+    protected get nextParameters(): PageParameterProperties | null;
+    hasPrevious(): boolean;
+    hasNext(): boolean;
+}

package/dist/pagination/page.js

@@ -0,0 +1,58 @@
+"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).
+ * https://konfigthis.com
+ * Do not edit the class manually.
+ */
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Page = void 0;
+var pageable_1 = require("./pageable");
+var Page = /** @class */ (function (_super) {
+    __extends(Page, _super);
+    function Page() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    Object.defineProperty(Page.prototype, "previousParameters", {
+        get: function () {
+            throw Error("Stub");
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Page.prototype, "nextParameters", {
+        get: function () {
+            throw Error("Stub");
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Page.prototype.hasPrevious = function () {
+        throw Error("Stub");
+    };
+    Page.prototype.hasNext = function () {
+        throw Error("Stub");
+    };
+    return Page;
+}(pageable_1.Pageable));
+exports.Page = Page;

package/dist/pagination/pageable.d.ts

@@ -0,0 +1,53 @@
+/**
+ * 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).
+ * https://konfigthis.com
+ * Do not edit the class manually.
+ */
+import { AxiosPromise } from "axios";
+import { Page, PageInfo, PageParameterProperties, PageParameters } from "./Page";
+export type PageParametersBase<Parameters> = Parameters & {
+    requestBody?: Parameters;
+};
+export type PageRequest<Data extends PageInfo, Parameters extends PageParameters> = (parameters: Parameters) => AxiosPromise<Data>;
+export declare abstract class Pageable<Data extends PageInfo, Parameters extends PageParameters> {
+    readonly data: Data;
+    protected readonly initialParameters: Parameters;
+    private readonly _request;
+    previous(): Promise<Page<Data, Parameters> | null>;
+    next(): Promise<Page<Data, Parameters> | null>;
+    /**
+     * Generate minimal set of parameters needed to get the previous page
+     */
+    protected abstract get previousParameters(): PageParameterProperties | null;
+    /**
+     * Generate minimal set of parameters needed to get the next page
+     */
+    protected abstract get nextParameters(): PageParameterProperties | null;
+    /**
+     * Is there a previous page based on PageInfo?
+     */
+    abstract hasPrevious(): boolean;
+    /**
+     * Is there a next page based on PageInfo?
+     */
+    abstract hasNext(): boolean;
+    /**
+     * Helper for invoking a request. Handles request body and parameter based pagination
+     */
+    private makeRequest;
+    /**
+     * Helper for creating new page
+     */
+    private withData;
+    constructor({ data, initialParameters, request, }: {
+        data: Data;
+        initialParameters: Parameters;
+        request: PageRequest<Data, Parameters>;
+    });
+}

package/dist/pagination/pageable.js

@@ -0,0 +1,128 @@
+"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).
+ * https://konfigthis.com
+ * Do not edit the class manually.
+ */
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+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());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Pageable = void 0;
+var Page_1 = require("./Page");
+var Pageable = /** @class */ (function () {
+    function Pageable(_a) {
+        var data = _a.data, initialParameters = _a.initialParameters, request = _a.request;
+        this.data = data;
+        this._request = request;
+        this.initialParameters = initialParameters;
+    }
+    Pageable.prototype.previous = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!this.hasPrevious())
+                            return [2 /*return*/, null];
+                        if (this.previousParameters === null)
+                            return [2 /*return*/, null];
+                        return [4 /*yield*/, this.makeRequest(this.previousParameters)];
+                    case 1:
+                        response = _a.sent();
+                        return [2 /*return*/, this.withData(response.data)];
+                }
+            });
+        });
+    };
+    Pageable.prototype.next = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!this.hasNext())
+                            return [2 /*return*/, null];
+                        if (this.nextParameters === null)
+                            return [2 /*return*/, null];
+                        return [4 /*yield*/, this.makeRequest(this.nextParameters)];
+                    case 1:
+                        response = _a.sent();
+                        return [2 /*return*/, this.withData(response.data)];
+                }
+            });
+        });
+    };
+    /**
+     * Helper for invoking a request. Handles request body and parameter based pagination
+     */
+    Pageable.prototype.makeRequest = function (parameters) {
+        // Handle request body pagination
+        if (this.initialParameters.requestBody !== undefined) {
+            return this._request(__assign(__assign({}, this.initialParameters), { requestBody: __assign(__assign({}, this.initialParameters.requestBody), parameters) }));
+        }
+        return this._request(__assign(__assign({}, this.initialParameters), parameters));
+    };
+    /**
+     * Helper for creating new page
+     */
+    Pageable.prototype.withData = function (data) {
+        return new Page_1.Page({
+            data: data,
+            initialParameters: this.initialParameters,
+            request: this._request,
+        });
+    };
+    return Pageable;
+}());
+exports.Pageable = Pageable;

package/dist/pagination/paginate.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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).
+ * https://konfigthis.com
+ * Do not edit the class manually.
+ */
+import { PageInfo, PageParameters, Page } from "./page";
+import { PageRequest } from "./pageable";
+export declare const paginate: <Data extends PageInfo, Parameters_1 extends PageParameters>({ request, initialParameters, }: {
+    request: PageRequest<Data, Parameters_1>;
+    initialParameters: Parameters_1;
+}) => Promise<Page<Data, Parameters_1>>;

package/dist/pagination/paginate.js

@@ -0,0 +1,78 @@
+"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).
+ * 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());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.paginate = void 0;
+var page_1 = require("./page");
+var paginate = function (_a) {
+    var request = _a.request, initialParameters = _a.initialParameters;
+    return new Promise(function (resolve, reject) { return __awaiter(void 0, void 0, void 0, function () {
+        var data, error_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    _a.trys.push([0, 2, , 3]);
+                    return [4 /*yield*/, request(initialParameters)];
+                case 1:
+                    data = _a.sent();
+                    resolve(new page_1.Page({
+                        data: data.data,
+                        initialParameters: initialParameters,
+                        request: function (parameters) { return request(parameters); },
+                    }));
+                    return [3 /*break*/, 3];
+                case 2:
+                    error_1 = _a.sent();
+                    reject(error_1);
+                    return [3 /*break*/, 3];
+                case 3: return [2 /*return*/];
+            }
+        });
+    }); });
+};
+exports.paginate = paginate;

package/dist/requestAfterHook.d.ts

@@ -0,0 +1,8 @@
+import { RequestArgs } from "./base";
+import { Configuration } from "./configuration";
+export declare function requestAfterHook(request: {
+    axiosArgs: RequestArgs;
+    basePath: string;
+    url: string;
+    configuration?: Configuration;
+}): void;

package/dist/requestAfterHook.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requestAfterHook = void 0;
+var crypto = require("crypto");
+var JSONstringifyOrder = function (obj) {
+    var allKeys = [];
+    var seen = {};
+    JSON.stringify(obj, function (key, value) {
+        if (!(key in seen)) {
+            allKeys.push(key);
+            seen[key] = null;
+        }
+        return value;
+    });
+    allKeys.sort();
+    return JSON.stringify(obj, allKeys);
+};
+function requestAfterHook(request) {
+    var configuration = request.configuration, basePath = request.basePath, axiosArgs = request.axiosArgs, url = request.url;
+    if ((configuration === null || configuration === void 0 ? void 0 : configuration.consumerKey) === undefined)
+        throw Error("Consumer key is required");
+    var consumerKey = encodeURI(configuration.consumerKey);
+    var requestData = axiosArgs.options.data === undefined || axiosArgs.options.data === "{}"
+        ? null
+        : JSON.parse(axiosArgs.options.data);
+    var path = axiosArgs.url.indexOf("?") === -1
+        ? "".concat(axiosArgs.url)
+        : "".concat(axiosArgs.url.split("?")[0]);
+    var requestPath = "/api/v1".concat(path);
+    var requestQuery = url
+        .replace(basePath, "")
+        .replace(path, "")
+        .replace("?", "");
+    var sigObject = {
+        content: requestData,
+        path: requestPath,
+        query: requestQuery,
+    };
+    var sigContent = JSONstringifyOrder(sigObject);
+    var hmac = crypto.createHmac("sha256", consumerKey);
+    var signature = hmac.update(sigContent).digest("base64");
+    if (axiosArgs.options.headers)
+        axiosArgs.options.headers["Signature"] = signature;
+}
+exports.requestAfterHook = requestAfterHook;

package/dist/requestBeforeHook.d.ts

@@ -0,0 +1,8 @@
+import { Configuration } from "./configuration";
+import { AxiosRequestConfig } from "axios";
+export declare function requestBeforeHook(request: {
+    queryParameters: Record<string, any>;
+    path: string;
+    requestConfig: AxiosRequestConfig;
+    configuration?: Configuration;
+}): void;

package/dist/requestBeforeHook.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requestBeforeHook = void 0;
+function requestBeforeHook(request) {
+    var queryParameters = request.queryParameters;
+    queryParameters["timestamp"] = Math.round(new Date().getTime() / 1000).toString();
+}
+exports.requestBeforeHook = requestBeforeHook;