@unified-api/typescript-sdk 0.0.0 → 1.0.0

package/README.md

@@ -29,27 +29,24 @@ yarn add @unified-api/typescript-sdk
 
 ```typescript
 import { UnifiedTo } from "@unified-api/typescript-sdk";
-import { CreateAccountingAccountSecurity } from "@unified-api/typescript-sdk/dist/sdk/models/operations";
 import { Status, TypeT } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
 
 async function run() {
-    const sdk = new UnifiedTo();
-    const operationSecurity: CreateAccountingAccountSecurity = {
-        jwt: "<YOUR_API_KEY_HERE>",
-    };
+    const sdk = new UnifiedTo({
+        security: {
+            jwt: "<YOUR_API_KEY_HERE>",
+        },
+    });
 
-    const res = await sdk.accounting.createAccountingAccount(
-        {
-            accountingAccount: {
-                name: "<value>",
-                raw: {
-                    key: "<value>",
-                },
+    const res = await sdk.accounting.createAccountingAccount({
+        accountingAccount: {
+            name: "<value>",
+            raw: {
+                key: "<value>",
             },
-            connectionId: "<value>",
         },
-        operationSecurity
-    );
+        connectionId: "<value>",
+    });
 
     if (res.statusCode == 200) {
         // handle response
@@ -697,29 +694,26 @@ Example
 
 ```typescript
 import { UnifiedTo } from "@unified-api/typescript-sdk";
-import { CreateAccountingAccountSecurity } from "@unified-api/typescript-sdk/dist/sdk/models/operations";
 import { Status, TypeT } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
 
 async function run() {
-    const sdk = new UnifiedTo();
-    const operationSecurity: CreateAccountingAccountSecurity = {
-        jwt: "<YOUR_API_KEY_HERE>",
-    };
+    const sdk = new UnifiedTo({
+        security: {
+            jwt: "<YOUR_API_KEY_HERE>",
+        },
+    });
 
     let res;
     try {
-        res = await sdk.accounting.createAccountingAccount(
-            {
-                accountingAccount: {
-                    name: "<value>",
-                    raw: {
-                        key: "<value>",
-                    },
+        res = await sdk.accounting.createAccountingAccount({
+            accountingAccount: {
+                name: "<value>",
+                raw: {
+                    key: "<value>",
                 },
-                connectionId: "<value>",
             },
-            operationSecurity
-        );
+            connectionId: "<value>",
+        });
     } catch (err) {
         if (err instanceof errors.SDKError) {
             console.error(err); // handle exception
@@ -755,29 +749,25 @@ You can override the default server globally by passing a server index to the `s
 
 ```typescript
 import { UnifiedTo } from "@unified-api/typescript-sdk";
-import { CreateAccountingAccountSecurity } from "@unified-api/typescript-sdk/dist/sdk/models/operations";
 import { Status, TypeT } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
 
 async function run() {
     const sdk = new UnifiedTo({
         serverIdx: 1,
+        security: {
+            jwt: "<YOUR_API_KEY_HERE>",
+        },
     });
-    const operationSecurity: CreateAccountingAccountSecurity = {
-        jwt: "<YOUR_API_KEY_HERE>",
-    };
 
-    const res = await sdk.accounting.createAccountingAccount(
-        {
-            accountingAccount: {
-                name: "<value>",
-                raw: {
-                    key: "<value>",
-                },
+    const res = await sdk.accounting.createAccountingAccount({
+        accountingAccount: {
+            name: "<value>",
+            raw: {
+                key: "<value>",
             },
-            connectionId: "<value>",
         },
-        operationSecurity
-    );
+        connectionId: "<value>",
+    });
 
     if (res.statusCode == 200) {
         // handle response
@@ -794,29 +784,25 @@ run();
 The default server can also be overridden globally by passing a URL to the `serverURL: str` optional parameter when initializing the SDK client instance. For example:
 ```typescript
 import { UnifiedTo } from "@unified-api/typescript-sdk";
-import { CreateAccountingAccountSecurity } from "@unified-api/typescript-sdk/dist/sdk/models/operations";
 import { Status, TypeT } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
 
 async function run() {
     const sdk = new UnifiedTo({
         serverURL: "https://api.unified.to",
+        security: {
+            jwt: "<YOUR_API_KEY_HERE>",
+        },
     });
-    const operationSecurity: CreateAccountingAccountSecurity = {
-        jwt: "<YOUR_API_KEY_HERE>",
-    };
 
-    const res = await sdk.accounting.createAccountingAccount(
-        {
-            accountingAccount: {
-                name: "<value>",
-                raw: {
-                    key: "<value>",
-                },
+    const res = await sdk.accounting.createAccountingAccount({
+        accountingAccount: {
+            name: "<value>",
+            raw: {
+                key: "<value>",
             },
-            connectionId: "<value>",
         },
-        operationSecurity
-    );
+        connectionId: "<value>",
+    });
 
     if (res.statusCode == 200) {
         // handle response
@@ -851,6 +837,49 @@ const sdk = new UnifiedTo({defaultClient: httpClient});
 
 
 
+<!-- Start Authentication [security] -->
+## Authentication
+
+### Per-Client Security Schemes
+
+This SDK supports the following security scheme globally:
+
+| Name    | Type    | Scheme  |
+| ------- | ------- | ------- |
+| `jwt`   | apiKey  | API key |
+
+You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. For example:
+```typescript
+import { UnifiedTo } from "@unified-api/typescript-sdk";
+import { Status, TypeT } from "@unified-api/typescript-sdk/dist/sdk/models/shared";
+
+async function run() {
+    const sdk = new UnifiedTo({
+        security: {
+            jwt: "<YOUR_API_KEY_HERE>",
+        },
+    });
+
+    const res = await sdk.accounting.createAccountingAccount({
+        accountingAccount: {
+            name: "<value>",
+            raw: {
+                key: "<value>",
+            },
+        },
+        connectionId: "<value>",
+    });
+
+    if (res.statusCode == 200) {
+        // handle response
+    }
+}
+
+run();
+
+```
+<!-- End Authentication [security] -->
+
 <!-- Placeholder for Future Speakeasy SDK Sections -->
 
 # Development

package/dist/sdk/account.d.ts

@@ -7,25 +7,25 @@ export declare class Account {
     /**
      * Create an account
      */
-    createAccountingAccount(req: operations.CreateAccountingAccountRequest, security: operations.CreateAccountingAccountSecurity, config?: AxiosRequestConfig): Promise<operations.CreateAccountingAccountResponse>;
+    createAccountingAccount(req: operations.CreateAccountingAccountRequest, config?: AxiosRequestConfig): Promise<operations.CreateAccountingAccountResponse>;
     /**
      * Retrieve an account
      */
-    getAccountingAccount(req: operations.GetAccountingAccountRequest, security: operations.GetAccountingAccountSecurity, config?: AxiosRequestConfig): Promise<operations.GetAccountingAccountResponse>;
+    getAccountingAccount(req: operations.GetAccountingAccountRequest, config?: AxiosRequestConfig): Promise<operations.GetAccountingAccountResponse>;
     /**
      * List all accounts
      */
-    listAccountingAccounts(req: operations.ListAccountingAccountsRequest, security: operations.ListAccountingAccountsSecurity, config?: AxiosRequestConfig): Promise<operations.ListAccountingAccountsResponse>;
+    listAccountingAccounts(req: operations.ListAccountingAccountsRequest, config?: AxiosRequestConfig): Promise<operations.ListAccountingAccountsResponse>;
     /**
      * Update an account
      */
-    patchAccountingAccount(req: operations.PatchAccountingAccountRequest, security: operations.PatchAccountingAccountSecurity, config?: AxiosRequestConfig): Promise<operations.PatchAccountingAccountResponse>;
+    patchAccountingAccount(req: operations.PatchAccountingAccountRequest, config?: AxiosRequestConfig): Promise<operations.PatchAccountingAccountResponse>;
     /**
      * Remove an account
      */
-    removeAccountingAccount(req: operations.RemoveAccountingAccountRequest, security: operations.RemoveAccountingAccountSecurity, config?: AxiosRequestConfig): Promise<operations.RemoveAccountingAccountResponse>;
+    removeAccountingAccount(req: operations.RemoveAccountingAccountRequest, config?: AxiosRequestConfig): Promise<operations.RemoveAccountingAccountResponse>;
     /**
      * Update an account
      */
-    updateAccountingAccount(req: operations.UpdateAccountingAccountRequest, security: operations.UpdateAccountingAccountSecurity, config?: AxiosRequestConfig): Promise<operations.UpdateAccountingAccountResponse>;
+    updateAccountingAccount(req: operations.UpdateAccountingAccountRequest, config?: AxiosRequestConfig): Promise<operations.UpdateAccountingAccountResponse>;
 }

package/dist/sdk/account.js

@@ -101,10 +101,10 @@ var Account = /** @class */ (function () {
     /**
      * Create an account
      */
-    Account.prototype.createAccountingAccount = function (req, security, config) {
+    Account.prototype.createAccountingAccount = function (req, config) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function () {
-            var baseURL, operationUrl, _c, reqBodyHeaders, reqBody, client, properties, headers, httpRes, responseContentType, res, decodedRes;
+            var baseURL, operationUrl, _c, reqBodyHeaders, reqBody, client, globalSecurity, properties, headers, httpRes, responseContentType, res, decodedRes;
             var _d;
             return __generator(this, function (_e) {
                 switch (_e.label) {
@@ -124,15 +124,22 @@ var Account = /** @class */ (function () {
                             }
                         }
                         client = this.sdkConfiguration.defaultClient;
-                        if (!(security instanceof utils.SpeakeasyBase)) {
-                            security = new operations.CreateAccountingAccountSecurity(security);
+                        globalSecurity = this.sdkConfiguration.security;
+                        if (!(typeof globalSecurity === "function")) return [3 /*break*/, 2];
+                        return [4 /*yield*/, globalSecurity()];
+                    case 1:
+                        globalSecurity = _e.sent();
+                        _e.label = 2;
+                    case 2:
+                        if (!(globalSecurity instanceof utils.SpeakeasyBase)) {
+                            globalSecurity = new shared.Security(globalSecurity);
                         }
-                        properties = utils.parseSecurityProperties(security);
+                        properties = utils.parseSecurityProperties(globalSecurity);
                         headers = __assign(__assign(__assign({}, reqBodyHeaders), config === null || config === void 0 ? void 0 : config.headers), properties.headers);
                         headers["Accept"] = "application/json";
                         headers["user-agent"] = this.sdkConfiguration.userAgent;
                         return [4 /*yield*/, client.request(__assign({ validateStatus: function () { return true; }, url: operationUrl, method: "post", headers: headers, responseType: "arraybuffer", data: reqBody }, config))];
-                    case 1:
+                    case 3:
                         httpRes = _e.sent();
                         responseContentType = (_b = (_a = httpRes === null || httpRes === void 0 ? void 0 : httpRes.headers) === null || _a === void 0 ? void 0 : _a["content-type"]) !== null && _b !== void 0 ? _b : "";
                         if ((httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == null) {
@@ -165,10 +172,10 @@ var Account = /** @class */ (function () {
     /**
      * Retrieve an account
      */
-    Account.prototype.getAccountingAccount = function (req, security, config) {
+    Account.prototype.getAccountingAccount = function (req, config) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function () {
-            var baseURL, operationUrl, client, properties, headers, queryParams, httpRes, responseContentType, res, decodedRes;
+            var baseURL, operationUrl, client, globalSecurity, properties, headers, queryParams, httpRes, responseContentType, res, decodedRes;
             return __generator(this, function (_c) {
                 switch (_c.label) {
                     case 0:
@@ -178,16 +185,23 @@ var Account = /** @class */ (function () {
                         baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
                         operationUrl = utils.generateURL(baseURL, "/accounting/{connection_id}/account/{id}", req);
                         client = this.sdkConfiguration.defaultClient;
-                        if (!(security instanceof utils.SpeakeasyBase)) {
-                            security = new operations.GetAccountingAccountSecurity(security);
+                        globalSecurity = this.sdkConfiguration.security;
+                        if (!(typeof globalSecurity === "function")) return [3 /*break*/, 2];
+                        return [4 /*yield*/, globalSecurity()];
+                    case 1:
+                        globalSecurity = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (!(globalSecurity instanceof utils.SpeakeasyBase)) {
+                            globalSecurity = new shared.Security(globalSecurity);
                         }
-                        properties = utils.parseSecurityProperties(security);
+                        properties = utils.parseSecurityProperties(globalSecurity);
                         headers = __assign(__assign({}, config === null || config === void 0 ? void 0 : config.headers), properties.headers);
                         queryParams = utils.serializeQueryParams(req);
                         headers["Accept"] = "application/json";
                         headers["user-agent"] = this.sdkConfiguration.userAgent;
                         return [4 /*yield*/, client.request(__assign({ validateStatus: function () { return true; }, url: operationUrl + queryParams, method: "get", headers: headers, responseType: "arraybuffer" }, config))];
-                    case 1:
+                    case 3:
                         httpRes = _c.sent();
                         responseContentType = (_b = (_a = httpRes === null || httpRes === void 0 ? void 0 : httpRes.headers) === null || _a === void 0 ? void 0 : _a["content-type"]) !== null && _b !== void 0 ? _b : "";
                         if ((httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == null) {
@@ -220,10 +234,10 @@ var Account = /** @class */ (function () {
     /**
      * List all accounts
      */
-    Account.prototype.listAccountingAccounts = function (req, security, config) {
+    Account.prototype.listAccountingAccounts = function (req, config) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function () {
-            var baseURL, operationUrl, client, properties, headers, queryParams, httpRes, responseContentType, res, decodedRes, resFieldDepth;
+            var baseURL, operationUrl, client, globalSecurity, properties, headers, queryParams, httpRes, responseContentType, res, decodedRes, resFieldDepth;
             return __generator(this, function (_c) {
                 switch (_c.label) {
                     case 0:
@@ -233,16 +247,23 @@ var Account = /** @class */ (function () {
                         baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
                         operationUrl = utils.generateURL(baseURL, "/accounting/{connection_id}/account", req);
                         client = this.sdkConfiguration.defaultClient;
-                        if (!(security instanceof utils.SpeakeasyBase)) {
-                            security = new operations.ListAccountingAccountsSecurity(security);
+                        globalSecurity = this.sdkConfiguration.security;
+                        if (!(typeof globalSecurity === "function")) return [3 /*break*/, 2];
+                        return [4 /*yield*/, globalSecurity()];
+                    case 1:
+                        globalSecurity = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (!(globalSecurity instanceof utils.SpeakeasyBase)) {
+                            globalSecurity = new shared.Security(globalSecurity);
                         }
-                        properties = utils.parseSecurityProperties(security);
+                        properties = utils.parseSecurityProperties(globalSecurity);
                         headers = __assign(__assign({}, config === null || config === void 0 ? void 0 : config.headers), properties.headers);
                         queryParams = utils.serializeQueryParams(req);
                         headers["Accept"] = "application/json";
                         headers["user-agent"] = this.sdkConfiguration.userAgent;
                         return [4 /*yield*/, client.request(__assign({ validateStatus: function () { return true; }, url: operationUrl + queryParams, method: "get", headers: headers, responseType: "arraybuffer" }, config))];
-                    case 1:
+                    case 3:
                         httpRes = _c.sent();
                         responseContentType = (_b = (_a = httpRes === null || httpRes === void 0 ? void 0 : httpRes.headers) === null || _a === void 0 ? void 0 : _a["content-type"]) !== null && _b !== void 0 ? _b : "";
                         if ((httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == null) {
@@ -277,10 +298,10 @@ var Account = /** @class */ (function () {
     /**
      * Update an account
      */
-    Account.prototype.patchAccountingAccount = function (req, security, config) {
+    Account.prototype.patchAccountingAccount = function (req, config) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function () {
-            var baseURL, operationUrl, _c, reqBodyHeaders, reqBody, client, properties, headers, httpRes, responseContentType, res, decodedRes;
+            var baseURL, operationUrl, _c, reqBodyHeaders, reqBody, client, globalSecurity, properties, headers, httpRes, responseContentType, res, decodedRes;
             var _d;
             return __generator(this, function (_e) {
                 switch (_e.label) {
@@ -300,15 +321,22 @@ var Account = /** @class */ (function () {
                             }
                         }
                         client = this.sdkConfiguration.defaultClient;
-                        if (!(security instanceof utils.SpeakeasyBase)) {
-                            security = new operations.PatchAccountingAccountSecurity(security);
+                        globalSecurity = this.sdkConfiguration.security;
+                        if (!(typeof globalSecurity === "function")) return [3 /*break*/, 2];
+                        return [4 /*yield*/, globalSecurity()];
+                    case 1:
+                        globalSecurity = _e.sent();
+                        _e.label = 2;
+                    case 2:
+                        if (!(globalSecurity instanceof utils.SpeakeasyBase)) {
+                            globalSecurity = new shared.Security(globalSecurity);
                         }
-                        properties = utils.parseSecurityProperties(security);
+                        properties = utils.parseSecurityProperties(globalSecurity);
                         headers = __assign(__assign(__assign({}, reqBodyHeaders), config === null || config === void 0 ? void 0 : config.headers), properties.headers);
                         headers["Accept"] = "application/json";
                         headers["user-agent"] = this.sdkConfiguration.userAgent;
                         return [4 /*yield*/, client.request(__assign({ validateStatus: function () { return true; }, url: operationUrl, method: "patch", headers: headers, responseType: "arraybuffer", data: reqBody }, config))];
-                    case 1:
+                    case 3:
                         httpRes = _e.sent();
                         responseContentType = (_b = (_a = httpRes === null || httpRes === void 0 ? void 0 : httpRes.headers) === null || _a === void 0 ? void 0 : _a["content-type"]) !== null && _b !== void 0 ? _b : "";
                         if ((httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == null) {
@@ -341,10 +369,10 @@ var Account = /** @class */ (function () {
     /**
      * Remove an account
      */
-    Account.prototype.removeAccountingAccount = function (req, security, config) {
+    Account.prototype.removeAccountingAccount = function (req, config) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function () {
-            var baseURL, operationUrl, client, properties, headers, httpRes, responseContentType, res, decodedRes;
+            var baseURL, operationUrl, client, globalSecurity, properties, headers, httpRes, responseContentType, res, decodedRes;
             return __generator(this, function (_c) {
                 switch (_c.label) {
                     case 0:
@@ -354,15 +382,22 @@ var Account = /** @class */ (function () {
                         baseURL = utils.templateUrl(this.sdkConfiguration.serverURL, this.sdkConfiguration.serverDefaults);
                         operationUrl = utils.generateURL(baseURL, "/accounting/{connection_id}/account/{id}", req);
                         client = this.sdkConfiguration.defaultClient;
-                        if (!(security instanceof utils.SpeakeasyBase)) {
-                            security = new operations.RemoveAccountingAccountSecurity(security);
+                        globalSecurity = this.sdkConfiguration.security;
+                        if (!(typeof globalSecurity === "function")) return [3 /*break*/, 2];
+                        return [4 /*yield*/, globalSecurity()];
+                    case 1:
+                        globalSecurity = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (!(globalSecurity instanceof utils.SpeakeasyBase)) {
+                            globalSecurity = new shared.Security(globalSecurity);
                         }
-                        properties = utils.parseSecurityProperties(security);
+                        properties = utils.parseSecurityProperties(globalSecurity);
                         headers = __assign(__assign({}, config === null || config === void 0 ? void 0 : config.headers), properties.headers);
                         headers["Accept"] = "application/json";
                         headers["user-agent"] = this.sdkConfiguration.userAgent;
                         return [4 /*yield*/, client.request(__assign({ validateStatus: function () { return true; }, url: operationUrl, method: "delete", headers: headers, responseType: "arraybuffer" }, config))];
-                    case 1:
+                    case 3:
                         httpRes = _c.sent();
                         responseContentType = (_b = (_a = httpRes === null || httpRes === void 0 ? void 0 : httpRes.headers) === null || _a === void 0 ? void 0 : _a["content-type"]) !== null && _b !== void 0 ? _b : "";
                         if ((httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == null) {
@@ -395,10 +430,10 @@ var Account = /** @class */ (function () {
     /**
      * Update an account
      */
-    Account.prototype.updateAccountingAccount = function (req, security, config) {
+    Account.prototype.updateAccountingAccount = function (req, config) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function () {
-            var baseURL, operationUrl, _c, reqBodyHeaders, reqBody, client, properties, headers, httpRes, responseContentType, res, decodedRes;
+            var baseURL, operationUrl, _c, reqBodyHeaders, reqBody, client, globalSecurity, properties, headers, httpRes, responseContentType, res, decodedRes;
             var _d;
             return __generator(this, function (_e) {
                 switch (_e.label) {
@@ -418,15 +453,22 @@ var Account = /** @class */ (function () {
                             }
                         }
                         client = this.sdkConfiguration.defaultClient;
-                        if (!(security instanceof utils.SpeakeasyBase)) {
-                            security = new operations.UpdateAccountingAccountSecurity(security);
+                        globalSecurity = this.sdkConfiguration.security;
+                        if (!(typeof globalSecurity === "function")) return [3 /*break*/, 2];
+                        return [4 /*yield*/, globalSecurity()];
+                    case 1:
+                        globalSecurity = _e.sent();
+                        _e.label = 2;
+                    case 2:
+                        if (!(globalSecurity instanceof utils.SpeakeasyBase)) {
+                            globalSecurity = new shared.Security(globalSecurity);
                         }
-                        properties = utils.parseSecurityProperties(security);
+                        properties = utils.parseSecurityProperties(globalSecurity);
                         headers = __assign(__assign(__assign({}, reqBodyHeaders), config === null || config === void 0 ? void 0 : config.headers), properties.headers);
                         headers["Accept"] = "application/json";
                         headers["user-agent"] = this.sdkConfiguration.userAgent;
                         return [4 /*yield*/, client.request(__assign({ validateStatus: function () { return true; }, url: operationUrl, method: "put", headers: headers, responseType: "arraybuffer", data: reqBody }, config))];
-                    case 1:
+                    case 3:
                         httpRes = _e.sent();
                         responseContentType = (_b = (_a = httpRes === null || httpRes === void 0 ? void 0 : httpRes.headers) === null || _a === void 0 ? void 0 : _a["content-type"]) !== null && _b !== void 0 ? _b : "";
                         if ((httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == null) {