apimatic-plaid-sdk 0.0.3 → 0.0.5

package/dist/esm/controllers/processorApi.js

@@ -0,0 +1,169 @@
+/**
+ * Plaid
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+import { processorApexProcessorTokenCreateRequestSchema, } from '../models/processorApexProcessorTokenCreateRequest.js';
+import { processorAuthGetRequestSchema, } from '../models/processorAuthGetRequest.js';
+import { processorAuthGetResponseSchema, } from '../models/processorAuthGetResponse.js';
+import { processorBalanceGetRequestSchema, } from '../models/processorBalanceGetRequest.js';
+import { processorBalanceGetResponseSchema, } from '../models/processorBalanceGetResponse.js';
+import { processorBankTransferCreateRequestSchema, } from '../models/processorBankTransferCreateRequest.js';
+import { processorBankTransferCreateResponseSchema, } from '../models/processorBankTransferCreateResponse.js';
+import { processorIdentityGetRequestSchema, } from '../models/processorIdentityGetRequest.js';
+import { processorIdentityGetResponseSchema, } from '../models/processorIdentityGetResponse.js';
+import { processorStripeBankAccountTokenCreateRequestSchema, } from '../models/processorStripeBankAccountTokenCreateRequest.js';
+import { processorStripeBankAccountTokenCreateResponseSchema, } from '../models/processorStripeBankAccountTokenCreateResponse.js';
+import { processorTokenCreateRequestSchema, } from '../models/processorTokenCreateRequest.js';
+import { processorTokenCreateResponseSchema, } from '../models/processorTokenCreateResponse.js';
+import { BaseApi } from './baseApi.js';
+import { ErrorError } from '../errors/errorError.js';
+export class ProcessorApi extends BaseApi {
+    /**
+     * Use the `/processor/bank_transfer/create` endpoint to initiate a new bank transfer as a processor
+     *
+     * @param body
+     * @return Response from the API call
+     */
+    async processorBankTransferCreate(body, requestOptions) {
+        const req = this.createRequest('POST', '/processor/bank_transfer/create');
+        const mapped = req.prepareArgs({
+            body: [body, processorBankTransferCreateRequestSchema],
+        });
+        req.header('Content-Type', 'application/json');
+        req.json(mapped.body);
+        req.defaultToError(ErrorError, 'Error response');
+        req.authenticate([
+            { plaidClientId: true, plaidSecret: true, plaidVersion: true },
+        ]);
+        return req.callAsJson(processorBankTransferCreateResponseSchema, requestOptions);
+    }
+    /**
+     * The `/processor/balance/get` endpoint returns the real-time balance for each of an Item's accounts.
+     * While other endpoints may return a balance object, only `/processor/balance/get` forces the
+     * available and current balance fields to be refreshed rather than cached.
+     *
+     * @param body         The `/processor/balance/get` endpoint returns the real-
+     *                                                          time balance for the account associated with a given
+     *                                                          `processor_token`.  The current balance is the total
+     *                                                          amount of funds in the account. The available balance is
+     *                                                          the current balance less any outstanding holds or debits
+     *                                                          that have not yet posted to the account.  Note that not
+     *                                                          all institutions calculate the available balance. In the
+     *                                                          event that available balance is unavailable from the
+     *                                                          institution, Plaid will return an available balance value
+     *                                                          of `null`.
+     * @return Response from the API call
+     */
+    async processorBalanceGet(body, requestOptions) {
+        const req = this.createRequest('POST', '/processor/balance/get');
+        const mapped = req.prepareArgs({
+            body: [body, processorBalanceGetRequestSchema],
+        });
+        req.header('Content-Type', 'application/json');
+        req.json(mapped.body);
+        req.authenticate([
+            { plaidClientId: true, plaidSecret: true, plaidVersion: true },
+        ]);
+        return req.callAsJson(processorBalanceGetResponseSchema, requestOptions);
+    }
+    /**
+     * The `/processor/auth/get` endpoint returns the bank account and bank identification number (such as
+     * the routing number, for US accounts), for a checking or savings account that's associated with a
+     * given `processor_token`. The endpoint also returns high-level account data and balances when
+     * available.
+     *
+     * @param body
+     * @return Response from the API call
+     */
+    async processorAuthGet(body, requestOptions) {
+        const req = this.createRequest('POST', '/processor/auth/get');
+        const mapped = req.prepareArgs({
+            body: [body, processorAuthGetRequestSchema],
+        });
+        req.header('Content-Type', 'application/json');
+        req.json(mapped.body);
+        req.authenticate([
+            { plaidClientId: true, plaidSecret: true, plaidVersion: true },
+        ]);
+        return req.callAsJson(processorAuthGetResponseSchema, requestOptions);
+    }
+    /**
+     * The `/processor/identity/get` endpoint allows you to retrieve various account holder information on
+     * file with the financial institution, including names, emails, phone numbers, and addresses.
+     *
+     * @param body
+     * @return Response from the API call
+     */
+    async processorIdentityGet(body, requestOptions) {
+        const req = this.createRequest('POST', '/processor/identity/get');
+        const mapped = req.prepareArgs({
+            body: [body, processorIdentityGetRequestSchema],
+        });
+        req.header('Content-Type', 'application/json');
+        req.json(mapped.body);
+        req.authenticate([
+            { plaidClientId: true, plaidSecret: true, plaidVersion: true },
+        ]);
+        return req.callAsJson(processorIdentityGetResponseSchema, requestOptions);
+    }
+    /**
+     * Used to create a token suitable for sending to Apex to enable Plaid-Apex integrations.
+     *
+     * @param body
+     * @return Response from the API call
+     */
+    async processorApexProcessorTokenCreate(body, requestOptions) {
+        const req = this.createRequest('POST', '/processor/apex/processor_token/create');
+        const mapped = req.prepareArgs({
+            body: [body, processorApexProcessorTokenCreateRequestSchema],
+        });
+        req.header('Content-Type', 'application/json');
+        req.json(mapped.body);
+        req.authenticate([
+            { plaidClientId: true, plaidSecret: true, plaidVersion: true },
+        ]);
+        return req.callAsJson(processorTokenCreateResponseSchema, requestOptions);
+    }
+    /**
+     * Used to create a token suitable for sending to one of Plaid's partners to enable integrations. Note
+     * that Stripe partnerships use bank account tokens instead; see
+     * `/processor/stripe/bank_account_token/create` for creating tokens for use with Stripe integrations.
+     *
+     * @param body
+     * @return Response from the API call
+     */
+    async processorTokenCreate(body, requestOptions) {
+        const req = this.createRequest('POST', '/processor/token/create');
+        const mapped = req.prepareArgs({
+            body: [body, processorTokenCreateRequestSchema],
+        });
+        req.header('Content-Type', 'application/json');
+        req.json(mapped.body);
+        req.authenticate([
+            { plaidClientId: true, plaidSecret: true, plaidVersion: true },
+        ]);
+        return req.callAsJson(processorTokenCreateResponseSchema, requestOptions);
+    }
+    /**
+     * Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a
+     * detailed guide on integrating Stripe, see [Add Stripe to your app](https://plaid.
+     * com/docs/auth/partnerships/stripe/).
+     *
+     * @param body
+     * @return Response from the API call
+     */
+    async processorStripeBankAccountTokenCreate(body, requestOptions) {
+        const req = this.createRequest('POST', '/processor/stripe/bank_account_token/create');
+        const mapped = req.prepareArgs({
+            body: [body, processorStripeBankAccountTokenCreateRequestSchema],
+        });
+        req.header('Content-Type', 'application/json');
+        req.json(mapped.body);
+        req.authenticate([
+            { plaidClientId: true, plaidSecret: true, plaidVersion: true },
+        ]);
+        return req.callAsJson(processorStripeBankAccountTokenCreateResponseSchema, requestOptions);
+    }
+}
+//# sourceMappingURL=processorApi.js.map

package/dist/esm/controllers/processorApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"processorApi.js","sourceRoot":"","sources":["../../../src/controllers/processorApi.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAEL,8CAA8C,GAC/C,MAAM,uDAAuD,CAAC;AAC/D,OAAO,EAEL,6BAA6B,GAC9B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAEL,8BAA8B,GAC/B,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAEL,gCAAgC,GACjC,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAEL,iCAAiC,GAClC,MAAM,0CAA0C,CAAC;AAClD,OAAO,EAEL,wCAAwC,GACzC,MAAM,iDAAiD,CAAC;AACzD,OAAO,EAEL,yCAAyC,GAC1C,MAAM,kDAAkD,CAAC;AAC1D,OAAO,EAEL,iCAAiC,GAClC,MAAM,0CAA0C,CAAC;AAClD,OAAO,EAEL,kCAAkC,GACnC,MAAM,2CAA2C,CAAC;AACnD,OAAO,EAEL,kDAAkD,GACnD,MAAM,2DAA2D,CAAC;AACnE,OAAO,EAEL,mDAAmD,GACpD,MAAM,4DAA4D,CAAC;AACpE,OAAO,EAEL,iCAAiC,GAClC,MAAM,0CAA0C,CAAC;AAClD,OAAO,EAEL,kCAAkC,GACnC,MAAM,2CAA2C,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAErD,MAAM,OAAO,YAAa,SAAQ,OAAO;IACvC;;;;;OAKG;IACH,KAAK,CAAC,2BAA2B,CAC/B,IAAwC,EACxC,cAA+B;QAE/B,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,iCAAiC,CAAC,CAAC;QAC1E,MAAM,MAAM,GAAG,GAAG,CAAC,WAAW,CAAC;YAC7B,IAAI,EAAE,CAAC,IAAI,EAAE,wCAAwC,CAAC;SACvD,CAAC,CAAC;QACH,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC/C,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACtB,GAAG,CAAC,cAAc,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;QACjD,GAAG,CAAC,YAAY,CAAC;YACf,EAAE,aAAa,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE;SAC/D,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,UAAU,CACnB,yCAAyC,EACzC,cAAc,CACf,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,mBAAmB,CACvB,IAAgC,EAChC,cAA+B;QAE/B,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;QACjE,MAAM,MAAM,GAAG,GAAG,CAAC,WAAW,CAAC;YAC7B,IAAI,EAAE,CAAC,IAAI,EAAE,gCAAgC,CAAC;SAC/C,CAAC,CAAC;QACH,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC/C,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACtB,GAAG,CAAC,YAAY,CAAC;YACf,EAAE,aAAa,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE;SAC/D,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,UAAU,CAAC,iCAAiC,EAAE,cAAc,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,gBAAgB,CACpB,IAA6B,EAC7B,cAA+B;QAE/B,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;QAC9D,MAAM,MAAM,GAAG,GAAG,CAAC,WAAW,CAAC;YAC7B,IAAI,EAAE,CAAC,IAAI,EAAE,6BAA6B,CAAC;SAC5C,CAAC,CAAC;QACH,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC/C,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACtB,GAAG,CAAC,YAAY,CAAC;YACf,EAAE,aAAa,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE;SAC/D,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,UAAU,CAAC,8BAA8B,EAAE,cAAc,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,oBAAoB,CACxB,IAAiC,EACjC,cAA+B;QAE/B,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAAC;QAClE,MAAM,MAAM,GAAG,GAAG,CAAC,WAAW,CAAC;YAC7B,IAAI,EAAE,CAAC,IAAI,EAAE,iCAAiC,CAAC;SAChD,CAAC,CAAC;QACH,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC/C,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACtB,GAAG,CAAC,YAAY,CAAC;YACf,EAAE,aAAa,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE;SAC/D,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,UAAU,CAAC,kCAAkC,EAAE,cAAc,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,iCAAiC,CACrC,IAA8C,EAC9C,cAA+B;QAE/B,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAC5B,MAAM,EACN,wCAAwC,CACzC,CAAC;QACF,MAAM,MAAM,GAAG,GAAG,CAAC,WAAW,CAAC;YAC7B,IAAI,EAAE,CAAC,IAAI,EAAE,8CAA8C,CAAC;SAC7D,CAAC,CAAC;QACH,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC/C,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACtB,GAAG,CAAC,YAAY,CAAC;YACf,EAAE,aAAa,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE;SAC/D,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,UAAU,CAAC,kCAAkC,EAAE,cAAc,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,oBAAoB,CACxB,IAAiC,EACjC,cAA+B;QAE/B,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAAC;QAClE,MAAM,MAAM,GAAG,GAAG,CAAC,WAAW,CAAC;YAC7B,IAAI,EAAE,CAAC,IAAI,EAAE,iCAAiC,CAAC;SAChD,CAAC,CAAC;QACH,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC/C,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACtB,GAAG,CAAC,YAAY,CAAC;YACf,EAAE,aAAa,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE;SAC/D,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,UAAU,CAAC,kCAAkC,EAAE,cAAc,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,qCAAqC,CACzC,IAAkD,EAClD,cAA+B;QAE/B,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAC5B,MAAM,EACN,6CAA6C,CAC9C,CAAC;QACF,MAAM,MAAM,GAAG,GAAG,CAAC,WAAW,CAAC;YAC7B,IAAI,EAAE,CAAC,IAAI,EAAE,kDAAkD,CAAC;SACjE,CAAC,CAAC;QACH,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC/C,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACtB,GAAG,CAAC,YAAY,CAAC;YACf,EAAE,aAAa,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE;SAC/D,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,UAAU,CACnB,mDAAmD,EACnD,cAAc,CACf,CAAC;IACJ,CAAC;CACF"}

package/dist/esm/controllers/sandboxApi.js

@@ -0,0 +1,257 @@
+/**
+ * Plaid
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+import { sandboxBankTransferFireWebhookRequestSchema, } from '../models/sandboxBankTransferFireWebhookRequest.js';
+import { sandboxBankTransferFireWebhookResponseSchema, } from '../models/sandboxBankTransferFireWebhookResponse.js';
+import { sandboxBankTransferSimulateRequestSchema, } from '../models/sandboxBankTransferSimulateRequest.js';
+import { sandboxBankTransferSimulateResponseSchema, } from '../models/sandboxBankTransferSimulateResponse.js';
+import { sandboxIncomeFireWebhookRequestSchema, } from '../models/sandboxIncomeFireWebhookRequest.js';
+import { sandboxIncomeFireWebhookResponseSchema, } from '../models/sandboxIncomeFireWebhookResponse.js';
+import { sandboxItemFireWebhookRequestSchema, } from '../models/sandboxItemFireWebhookRequest.js';
+import { sandboxItemFireWebhookResponseSchema, } from '../models/sandboxItemFireWebhookResponse.js';
+import { sandboxItemResetLoginRequestSchema, } from '../models/sandboxItemResetLoginRequest.js';
+import { sandboxItemResetLoginResponseSchema, } from '../models/sandboxItemResetLoginResponse.js';
+import { sandboxItemSetVerificationStatusRequestSchema, } from '../models/sandboxItemSetVerificationStatusRequest.js';
+import { sandboxItemSetVerificationStatusResponseSchema, } from '../models/sandboxItemSetVerificationStatusResponse.js';
+import { sandboxOauthSelectAccountsRequestSchema, } from '../models/sandboxOauthSelectAccountsRequest.js';
+import { sandboxProcessorTokenCreateRequestSchema, } from '../models/sandboxProcessorTokenCreateRequest.js';
+import { sandboxProcessorTokenCreateResponseSchema, } from '../models/sandboxProcessorTokenCreateResponse.js';
+import { sandboxPublicTokenCreateRequestSchema, } from '../models/sandboxPublicTokenCreateRequest.js';
+import { sandboxPublicTokenCreateResponseSchema, } from '../models/sandboxPublicTokenCreateResponse.js';
+import { sandboxTransferSimulateRequestSchema, } from '../models/sandboxTransferSimulateRequest.js';
+import { sandboxTransferSimulateResponseSchema, } from '../models/sandboxTransferSimulateResponse.js';
+import { optional, unknown } from '../schema.js';
+import { BaseApi } from './baseApi.js';
+import { ErrorError } from '../errors/errorError.js';
+export class SandboxApi extends BaseApi {
+    /**
+     * The `/sandbox/item/set_verification_status` endpoint can be used to change the verification status
+     * of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow.
+     *
+     * Note that not all Plaid developer accounts are enabled for micro-deposit based verification by
+     * default. Your account must be enabled for this feature in order to test it in Sandbox. To enable
+     * this features or check your status, contact your account manager or [submit a product access Support
+     * ticket](https://dashboard.plaid.com/support/new/product-and-development/product-
+     * troubleshooting/request-product-access).
+     *
+     * For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage
+     * testing](https://plaid.com/docs/auth/coverage/testing#).
+     *
+     * @param body
+     * @return Response from the API call
+     */
+    async sandboxItemSetVerificationStatus(body, requestOptions) {
+        const req = this.createRequest('POST', '/sandbox/item/set_verification_status');
+        const mapped = req.prepareArgs({
+            body: [body, sandboxItemSetVerificationStatusRequestSchema],
+        });
+        req.header('Content-Type', 'application/json');
+        req.json(mapped.body);
+        req.authenticate([
+            { plaidClientId: true, plaidSecret: true, plaidVersion: true },
+        ]);
+        return req.callAsJson(sandboxItemSetVerificationStatusResponseSchema, requestOptions);
+    }
+    /**
+     * Use the `/sandbox/public_token/create`  endpoint to create a valid `public_token`  for an arbitrary
+     * institution ID, initial products, and test credentials. The created `public_token` maps to a new
+     * Sandbox Item. You can then call `/item/public_token/exchange` to exchange the `public_token` for an
+     * `access_token` and perform all API actions. `/sandbox/public_token/create` can also be used with the
+     * [`user_custom` test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account
+     * with custom data.
+     *
+     * @param body
+     * @return Response from the API call
+     */
+    async sandboxPublicTokenCreate(body, requestOptions) {
+        const req = this.createRequest('POST', '/sandbox/public_token/create');
+        const mapped = req.prepareArgs({
+            body: [body, sandboxPublicTokenCreateRequestSchema],
+        });
+        req.header('Content-Type', 'application/json');
+        req.json(mapped.body);
+        req.defaultToError(ErrorError, 'Error response.');
+        req.authenticate([
+            { plaidClientId: true, plaidSecret: true, plaidVersion: true },
+        ]);
+        return req.callAsJson(sandboxPublicTokenCreateResponseSchema, requestOptions);
+    }
+    /**
+     * Use the `/sandbox/processor_token/create` endpoint to create a valid `processor_token` for an
+     * arbitrary institution ID and test credentials. The created `processor_token` corresponds to a new
+     * Sandbox Item. You can then use this `processor_token` with the `/processor/` API endpoints in
+     * Sandbox. You can also use `/sandbox/processor_token/create` with the [`user_custom` test
+     * username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data.
+     *
+     * @param body
+     * @return Response from the API call
+     */
+    async sandboxProcessorTokenCreate(body, requestOptions) {
+        const req = this.createRequest('POST', '/sandbox/processor_token/create');
+        const mapped = req.prepareArgs({
+            body: [body, sandboxProcessorTokenCreateRequestSchema],
+        });
+        req.header('Content-Type', 'application/json');
+        req.json(mapped.body);
+        req.defaultToError(ErrorError, 'Error response.');
+        req.authenticate([
+            { plaidClientId: true, plaidSecret: true, plaidVersion: true },
+        ]);
+        return req.callAsJson(sandboxProcessorTokenCreateResponseSchema, requestOptions);
+    }
+    /**
+     * The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks.
+     * Calling this endpoint triggers a Transactions `DEFAULT_UPDATE` webhook to be fired for a given
+     * Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will
+     * result.
+     *
+     * @param body
+     * @return Response from the API call
+     */
+    async sandboxItemFireWebhook(body, requestOptions) {
+        const req = this.createRequest('POST', '/sandbox/item/fire_webhook');
+        const mapped = req.prepareArgs({
+            body: [body, sandboxItemFireWebhookRequestSchema],
+        });
+        req.header('Content-Type', 'application/json');
+        req.json(mapped.body);
+        req.defaultToError(ErrorError, 'Error response.');
+        req.authenticate([
+            { plaidClientId: true, plaidSecret: true, plaidVersion: true },
+        ]);
+        return req.callAsJson(sandboxItemFireWebhookResponseSchema, requestOptions);
+    }
+    /**
+     * `/sandbox/item/reset_login/` forces an Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate
+     * an Item whose login is no longer valid. This makes it easy to test Link's [update mode](https:
+     * //plaid.com/docs/link/update-mode) flow in the Sandbox environment.  After calling
+     * `/sandbox/item/reset_login`, You can then use Plaid Link update mode to restore the Item to a good
+     * state. An `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this endpoint, if one is
+     * associated with the Item.
+     *
+     *
+     * In the Sandbox, Items will transition to an `ITEM_LOGIN_REQUIRED` error state automatically after 30
+     * days, even if this endpoint is not called.
+     *
+     * @param body
+     * @return Response from the API call
+     */
+    async sandboxItemResetLogin(body, requestOptions) {
+        const req = this.createRequest('POST', '/sandbox/item/reset_login');
+        const mapped = req.prepareArgs({
+            body: [body, sandboxItemResetLoginRequestSchema],
+        });
+        req.header('Content-Type', 'application/json');
+        req.json(mapped.body);
+        req.authenticate([
+            { plaidClientId: true, plaidSecret: true, plaidVersion: true },
+        ]);
+        return req.callAsJson(sandboxItemResetLoginResponseSchema, requestOptions);
+    }
+    /**
+     * Use the `/sandbox/income/fire_webhook` endpoint to manually trigger an Income webhook in the Sandbox
+     * environment.
+     *
+     * @param body
+     * @return Response from the API call
+     */
+    async sandboxIncomeFireWebhook(body, requestOptions) {
+        const req = this.createRequest('POST', '/sandbox/income/fire_webhook');
+        const mapped = req.prepareArgs({
+            body: [body, sandboxIncomeFireWebhookRequestSchema],
+        });
+        req.header('Content-Type', 'application/json');
+        req.json(mapped.body);
+        req.defaultToError(ErrorError, 'Error response');
+        req.authenticate([
+            { plaidClientId: true, plaidSecret: true, plaidVersion: true },
+        ]);
+        return req.callAsJson(sandboxIncomeFireWebhookResponseSchema, requestOptions);
+    }
+    /**
+     * Save the selected accounts when connecting to the Platypus Oauth institution
+     *
+     * @param body
+     * @return Response from the API call
+     */
+    async sandboxOauthSelectAccounts(body, requestOptions) {
+        const req = this.createRequest('POST', '/sandbox/oauth/select_accounts');
+        const mapped = req.prepareArgs({
+            body: [body, sandboxOauthSelectAccountsRequestSchema],
+        });
+        req.header('Content-Type', 'application/json');
+        req.json(mapped.body);
+        req.defaultToError(ErrorError, 'Error response.');
+        req.authenticate([
+            { plaidClientId: true, plaidSecret: true, plaidVersion: true },
+        ]);
+        return req.callAsJson(optional(unknown()), requestOptions);
+    }
+    /**
+     * Use the `/sandbox/transfer/simulate` endpoint to simulate a transfer event in the Sandbox
+     * environment.  Note that while an event will be simulated and will appear when using endpoints such
+     * as `/transfer/event/sync` or `/transfer/event/list`, no transactions will actually take place and
+     * funds will not move between accounts, even within the Sandbox.
+     *
+     * @param body
+     * @return Response from the API call
+     */
+    async sandboxTransferSimulate(body, requestOptions) {
+        const req = this.createRequest('POST', '/sandbox/transfer/simulate');
+        const mapped = req.prepareArgs({
+            body: [body, sandboxTransferSimulateRequestSchema],
+        });
+        req.header('Content-Type', 'application/json');
+        req.json(mapped.body);
+        req.defaultToError(ErrorError, 'Error response');
+        req.authenticate([
+            { plaidClientId: true, plaidSecret: true, plaidVersion: true },
+        ]);
+        return req.callAsJson(sandboxTransferSimulateResponseSchema, requestOptions);
+    }
+    /**
+     * Use the `/sandbox/bank_transfer/fire_webhook` endpoint to manually trigger a Bank Transfers webhook
+     * in the Sandbox environment.
+     *
+     * @param body
+     * @return Response from the API call
+     */
+    async sandboxBankTransferFireWebhook(body, requestOptions) {
+        const req = this.createRequest('POST', '/sandbox/bank_transfer/fire_webhook');
+        const mapped = req.prepareArgs({
+            body: [body, sandboxBankTransferFireWebhookRequestSchema],
+        });
+        req.header('Content-Type', 'application/json');
+        req.json(mapped.body);
+        req.defaultToError(ErrorError, 'Error response');
+        req.authenticate([
+            { plaidClientId: true, plaidSecret: true, plaidVersion: true },
+        ]);
+        return req.callAsJson(sandboxBankTransferFireWebhookResponseSchema, requestOptions);
+    }
+    /**
+     * Use the `/sandbox/bank_transfer/simulate` endpoint to simulate a bank transfer event in the Sandbox
+     * environment.  Note that while an event will be simulated and will appear when using endpoints such
+     * as `/bank_transfer/event/sync` or `/bank_transfer/event/list`, no transactions will actually take
+     * place and funds will not move between accounts, even within the Sandbox.
+     *
+     * @param body
+     * @return Response from the API call
+     */
+    async sandboxBankTransferSimulate(body, requestOptions) {
+        const req = this.createRequest('POST', '/sandbox/bank_transfer/simulate');
+        const mapped = req.prepareArgs({
+            body: [body, sandboxBankTransferSimulateRequestSchema],
+        });
+        req.header('Content-Type', 'application/json');
+        req.json(mapped.body);
+        req.defaultToError(ErrorError, 'Error response');
+        req.authenticate([
+            { plaidClientId: true, plaidSecret: true, plaidVersion: true },
+        ]);
+        return req.callAsJson(sandboxBankTransferSimulateResponseSchema, requestOptions);
+    }
+}
+//# sourceMappingURL=sandboxApi.js.map

package/dist/esm/controllers/sandboxApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sandboxApi.js","sourceRoot":"","sources":["../../../src/controllers/sandboxApi.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAEL,2CAA2C,GAC5C,MAAM,oDAAoD,CAAC;AAC5D,OAAO,EAEL,4CAA4C,GAC7C,MAAM,qDAAqD,CAAC;AAC7D,OAAO,EAEL,wCAAwC,GACzC,MAAM,iDAAiD,CAAC;AACzD,OAAO,EAEL,yCAAyC,GAC1C,MAAM,kDAAkD,CAAC;AAC1D,OAAO,EAEL,qCAAqC,GACtC,MAAM,8CAA8C,CAAC;AACtD,OAAO,EAEL,sCAAsC,GACvC,MAAM,+CAA+C,CAAC;AACvD,OAAO,EAEL,mCAAmC,GACpC,MAAM,4CAA4C,CAAC;AACpD,OAAO,EAEL,oCAAoC,GACrC,MAAM,6CAA6C,CAAC;AACrD,OAAO,EAEL,kCAAkC,GACnC,MAAM,2CAA2C,CAAC;AACnD,OAAO,EAEL,mCAAmC,GACpC,MAAM,4CAA4C,CAAC;AACpD,OAAO,EAEL,6CAA6C,GAC9C,MAAM,sDAAsD,CAAC;AAC9D,OAAO,EAEL,8CAA8C,GAC/C,MAAM,uDAAuD,CAAC;AAC/D,OAAO,EAEL,uCAAuC,GACxC,MAAM,gDAAgD,CAAC;AACxD,OAAO,EAEL,wCAAwC,GACzC,MAAM,iDAAiD,CAAC;AACzD,OAAO,EAEL,yCAAyC,GAC1C,MAAM,kDAAkD,CAAC;AAC1D,OAAO,EAEL,qCAAqC,GACtC,MAAM,8CAA8C,CAAC;AACtD,OAAO,EAEL,sCAAsC,GACvC,MAAM,+CAA+C,CAAC;AACvD,OAAO,EAEL,oCAAoC,GACrC,MAAM,6CAA6C,CAAC;AACrD,OAAO,EAEL,qCAAqC,GACtC,MAAM,8CAA8C,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAErD,MAAM,OAAO,UAAW,SAAQ,OAAO;IACrC;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,gCAAgC,CACpC,IAA6C,EAC7C,cAA+B;QAE/B,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAC5B,MAAM,EACN,uCAAuC,CACxC,CAAC;QACF,MAAM,MAAM,GAAG,GAAG,CAAC,WAAW,CAAC;YAC7B,IAAI,EAAE,CAAC,IAAI,EAAE,6CAA6C,CAAC;SAC5D,CAAC,CAAC;QACH,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC/C,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACtB,GAAG,CAAC,YAAY,CAAC;YACf,EAAE,aAAa,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE;SAC/D,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,UAAU,CACnB,8CAA8C,EAC9C,cAAc,CACf,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,wBAAwB,CAC5B,IAAqC,EACrC,cAA+B;QAE/B,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,8BAA8B,CAAC,CAAC;QACvE,MAAM,MAAM,GAAG,GAAG,CAAC,WAAW,CAAC;YAC7B,IAAI,EAAE,CAAC,IAAI,EAAE,qCAAqC,CAAC;SACpD,CAAC,CAAC;QACH,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC/C,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACtB,GAAG,CAAC,cAAc,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;QAClD,GAAG,CAAC,YAAY,CAAC;YACf,EAAE,aAAa,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE;SAC/D,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,UAAU,CACnB,sCAAsC,EACtC,cAAc,CACf,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,2BAA2B,CAC/B,IAAwC,EACxC,cAA+B;QAE/B,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,iCAAiC,CAAC,CAAC;QAC1E,MAAM,MAAM,GAAG,GAAG,CAAC,WAAW,CAAC;YAC7B,IAAI,EAAE,CAAC,IAAI,EAAE,wCAAwC,CAAC;SACvD,CAAC,CAAC;QACH,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC/C,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACtB,GAAG,CAAC,cAAc,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;QAClD,GAAG,CAAC,YAAY,CAAC;YACf,EAAE,aAAa,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE;SAC/D,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,UAAU,CACnB,yCAAyC,EACzC,cAAc,CACf,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,sBAAsB,CAC1B,IAAmC,EACnC,cAA+B;QAE/B,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,4BAA4B,CAAC,CAAC;QACrE,MAAM,MAAM,GAAG,GAAG,CAAC,WAAW,CAAC;YAC7B,IAAI,EAAE,CAAC,IAAI,EAAE,mCAAmC,CAAC;SAClD,CAAC,CAAC;QACH,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC/C,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACtB,GAAG,CAAC,cAAc,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;QAClD,GAAG,CAAC,YAAY,CAAC;YACf,EAAE,aAAa,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE;SAC/D,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,UAAU,CAAC,oCAAoC,EAAE,cAAc,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,qBAAqB,CACzB,IAAkC,EAClC,cAA+B;QAE/B,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,2BAA2B,CAAC,CAAC;QACpE,MAAM,MAAM,GAAG,GAAG,CAAC,WAAW,CAAC;YAC7B,IAAI,EAAE,CAAC,IAAI,EAAE,kCAAkC,CAAC;SACjD,CAAC,CAAC;QACH,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC/C,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACtB,GAAG,CAAC,YAAY,CAAC;YACf,EAAE,aAAa,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE;SAC/D,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,UAAU,CAAC,mCAAmC,EAAE,cAAc,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,wBAAwB,CAC5B,IAAqC,EACrC,cAA+B;QAE/B,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,8BAA8B,CAAC,CAAC;QACvE,MAAM,MAAM,GAAG,GAAG,CAAC,WAAW,CAAC;YAC7B,IAAI,EAAE,CAAC,IAAI,EAAE,qCAAqC,CAAC;SACpD,CAAC,CAAC;QACH,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC/C,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACtB,GAAG,CAAC,cAAc,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;QACjD,GAAG,CAAC,YAAY,CAAC;YACf,EAAE,aAAa,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE;SAC/D,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,UAAU,CACnB,sCAAsC,EACtC,cAAc,CACf,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,0BAA0B,CAC9B,IAAuC,EACvC,cAA+B;QAE/B,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,gCAAgC,CAAC,CAAC;QACzE,MAAM,MAAM,GAAG,GAAG,CAAC,WAAW,CAAC;YAC7B,IAAI,EAAE,CAAC,IAAI,EAAE,uCAAuC,CAAC;SACtD,CAAC,CAAC;QACH,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC/C,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACtB,GAAG,CAAC,cAAc,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;QAClD,GAAG,CAAC,YAAY,CAAC;YACf,EAAE,aAAa,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE;SAC/D,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,EAAE,cAAc,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,uBAAuB,CAC3B,IAAoC,EACpC,cAA+B;QAE/B,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,4BAA4B,CAAC,CAAC;QACrE,MAAM,MAAM,GAAG,GAAG,CAAC,WAAW,CAAC;YAC7B,IAAI,EAAE,CAAC,IAAI,EAAE,oCAAoC,CAAC;SACnD,CAAC,CAAC;QACH,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC/C,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACtB,GAAG,CAAC,cAAc,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;QACjD,GAAG,CAAC,YAAY,CAAC;YACf,EAAE,aAAa,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE;SAC/D,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,UAAU,CACnB,qCAAqC,EACrC,cAAc,CACf,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,8BAA8B,CAClC,IAA2C,EAC3C,cAA+B;QAE/B,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAC5B,MAAM,EACN,qCAAqC,CACtC,CAAC;QACF,MAAM,MAAM,GAAG,GAAG,CAAC,WAAW,CAAC;YAC7B,IAAI,EAAE,CAAC,IAAI,EAAE,2CAA2C,CAAC;SAC1D,CAAC,CAAC;QACH,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC/C,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACtB,GAAG,CAAC,cAAc,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;QACjD,GAAG,CAAC,YAAY,CAAC;YACf,EAAE,aAAa,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE;SAC/D,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,UAAU,CACnB,4CAA4C,EAC5C,cAAc,CACf,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,2BAA2B,CAC/B,IAAwC,EACxC,cAA+B;QAE/B,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,iCAAiC,CAAC,CAAC;QAC1E,MAAM,MAAM,GAAG,GAAG,CAAC,WAAW,CAAC;YAC7B,IAAI,EAAE,CAAC,IAAI,EAAE,wCAAwC,CAAC;SACvD,CAAC,CAAC;QACH,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC/C,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACtB,GAAG,CAAC,cAAc,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;QACjD,GAAG,CAAC,YAAY,CAAC;YACf,EAAE,aAAa,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE;SAC/D,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,UAAU,CACnB,yCAAyC,EACzC,cAAc,CACf,CAAC;IACJ,CAAC;CACF"}

package/dist/esm/controllers/signalApi.js

@@ -0,0 +1,83 @@
+/**
+ * Plaid
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+import { signalDecisionReportRequestSchema, } from '../models/signalDecisionReportRequest.js';
+import { signalDecisionReportResponseSchema, } from '../models/signalDecisionReportResponse.js';
+import { signalEvaluateRequestSchema, } from '../models/signalEvaluateRequest.js';
+import { signalEvaluateResponseSchema, } from '../models/signalEvaluateResponse.js';
+import { signalReturnReportRequestSchema, } from '../models/signalReturnReportRequest.js';
+import { signalReturnReportResponseSchema, } from '../models/signalReturnReportResponse.js';
+import { BaseApi } from './baseApi.js';
+import { ErrorError } from '../errors/errorError.js';
+export class SignalApi extends BaseApi {
+    /**
+     * Use `/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment (such
+     * as a risk score and risk tier) and additional risk signals.
+     *
+     * In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the
+     * account, and the Item must be healthy (receiving product updates) or have recently been in a healthy
+     * state. If the transaction does not meet eligibility requirements, an error will be returned
+     * corresponding to the underlying cause.
+     *
+     * @param body
+     * @return Response from the API call
+     */
+    async signalEvaluate(body, requestOptions) {
+        const req = this.createRequest('POST', '/signal/evaluate');
+        const mapped = req.prepareArgs({
+            body: [body, signalEvaluateRequestSchema],
+        });
+        req.header('Content-Type', 'application/json');
+        req.json(mapped.body);
+        req.defaultToError(ErrorError, 'Error response.');
+        req.authenticate([
+            { plaidClientId: true, plaidSecret: true, plaidVersion: true },
+        ]);
+        return req.callAsJson(signalEvaluateResponseSchema, requestOptions);
+    }
+    /**
+     * After calling `/signal/evaluate`, call `/signal/decision/report` to report whether the transaction
+     * was initiated. This endpoint will return an `INVALID_REQUEST` error if called a second time with a
+     * different value for `initiated`.
+     *
+     * @param body
+     * @return Response from the API call
+     */
+    async signalDecisionReport(body, requestOptions) {
+        const req = this.createRequest('POST', '/signal/decision/report');
+        const mapped = req.prepareArgs({
+            body: [body, signalDecisionReportRequestSchema],
+        });
+        req.header('Content-Type', 'application/json');
+        req.json(mapped.body);
+        req.defaultToError(ErrorError, 'Error response.');
+        req.authenticate([
+            { plaidClientId: true, plaidSecret: true, plaidVersion: true },
+        ]);
+        return req.callAsJson(signalDecisionReportResponseSchema, requestOptions);
+    }
+    /**
+     * Call the `/signal/return/report` endpoint to report a returned transaction that was previously sent
+     * to the `/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the
+     * latest risk trend in your portfolio.
+     *
+     * @param body
+     * @return Response from the API call
+     */
+    async signalReturnReport(body, requestOptions) {
+        const req = this.createRequest('POST', '/signal/return/report');
+        const mapped = req.prepareArgs({
+            body: [body, signalReturnReportRequestSchema],
+        });
+        req.header('Content-Type', 'application/json');
+        req.json(mapped.body);
+        req.defaultToError(ErrorError, 'Error response.');
+        req.authenticate([
+            { plaidClientId: true, plaidSecret: true, plaidVersion: true },
+        ]);
+        return req.callAsJson(signalReturnReportResponseSchema, requestOptions);
+    }
+}
+//# sourceMappingURL=signalApi.js.map

package/dist/esm/controllers/signalApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"signalApi.js","sourceRoot":"","sources":["../../../src/controllers/signalApi.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAEL,iCAAiC,GAClC,MAAM,0CAA0C,CAAC;AAClD,OAAO,EAEL,kCAAkC,GACnC,MAAM,2CAA2C,CAAC;AACnD,OAAO,EAEL,2BAA2B,GAC5B,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAEL,4BAA4B,GAC7B,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAEL,+BAA+B,GAChC,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAEL,gCAAgC,GACjC,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAErD,MAAM,OAAO,SAAU,SAAQ,OAAO;IACpC;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,cAAc,CAClB,IAA2B,EAC3B,cAA+B;QAE/B,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;QAC3D,MAAM,MAAM,GAAG,GAAG,CAAC,WAAW,CAAC;YAC7B,IAAI,EAAE,CAAC,IAAI,EAAE,2BAA2B,CAAC;SAC1C,CAAC,CAAC;QACH,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC/C,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACtB,GAAG,CAAC,cAAc,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;QAClD,GAAG,CAAC,YAAY,CAAC;YACf,EAAE,aAAa,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE;SAC/D,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,UAAU,CAAC,4BAA4B,EAAE,cAAc,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,oBAAoB,CACxB,IAAiC,EACjC,cAA+B;QAE/B,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAAC;QAClE,MAAM,MAAM,GAAG,GAAG,CAAC,WAAW,CAAC;YAC7B,IAAI,EAAE,CAAC,IAAI,EAAE,iCAAiC,CAAC;SAChD,CAAC,CAAC;QACH,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC/C,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACtB,GAAG,CAAC,cAAc,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;QAClD,GAAG,CAAC,YAAY,CAAC;YACf,EAAE,aAAa,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE;SAC/D,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,UAAU,CAAC,kCAAkC,EAAE,cAAc,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,kBAAkB,CACtB,IAA+B,EAC/B,cAA+B;QAE/B,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAC;QAChE,MAAM,MAAM,GAAG,GAAG,CAAC,WAAW,CAAC;YAC7B,IAAI,EAAE,CAAC,IAAI,EAAE,+BAA+B,CAAC;SAC9C,CAAC,CAAC;QACH,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC/C,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACtB,GAAG,CAAC,cAAc,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;QAClD,GAAG,CAAC,YAAY,CAAC;YACf,EAAE,aAAa,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE;SAC/D,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,UAAU,CAAC,gCAAgC,EAAE,cAAc,CAAC,CAAC;IAC1E,CAAC;CACF"}

package/dist/esm/controllers/transactionsApi.js

@@ -0,0 +1,95 @@
+/**
+ * Plaid
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+import { transactionsGetRequestSchema, } from '../models/transactionsGetRequest.js';
+import { transactionsGetResponseSchema, } from '../models/transactionsGetResponse.js';
+import { transactionsRefreshRequestSchema, } from '../models/transactionsRefreshRequest.js';
+import { transactionsRefreshResponseSchema, } from '../models/transactionsRefreshResponse.js';
+import { BaseApi } from './baseApi.js';
+import { ErrorError } from '../errors/errorError.js';
+export class TransactionsApi extends BaseApi {
+    /**
+     * `/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates
+     * an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction
+     * takes place in addition to the periodic extractions that automatically occur multiple times a day
+     * for any Transactions-enabled Item. If changes to transactions are discovered after calling
+     * `/transactions/refresh`, Plaid will fire a webhook: [`TRANSACTIONS_REMOVED`](https://plaid.
+     * com/docs/api/webhooks#deleted-transactions-detected) will be fired if any removed transactions are
+     * detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/webhooks#transactions-default_update)
+     * will be fired if any new transactions are detected. New transactions can be fetched by calling
+     * `/transactions/get`.
+     *
+     * Access to `/transactions/refresh` in Production is specific to certain pricing plans. If you cannot
+     * access `/transactions/refresh` in Production, [contact Sales](https://www.plaid.com/contact) for
+     * assistance.
+     *
+     * @param body
+     * @return Response from the API call
+     */
+    async transactionsRefresh(body, requestOptions) {
+        const req = this.createRequest('POST', '/transactions/refresh');
+        const mapped = req.prepareArgs({
+            body: [body, transactionsRefreshRequestSchema],
+        });
+        req.header('Content-Type', 'application/json');
+        req.json(mapped.body);
+        req.defaultToError(ErrorError, 'Error response');
+        req.authenticate([
+            { plaidClientId: true, plaidSecret: true, plaidVersion: true },
+        ]);
+        return req.callAsJson(transactionsRefreshResponseSchema, requestOptions);
+    }
+    /**
+     * The `/transactions/get` endpoint allows developers to receive user-authorized transaction data for
+     * credit, depository, and some loan-type accounts (only those with account subtype `student`; coverage
+     * may be limited). For transaction history from investments accounts, use the [Investments
+     * endpoint](https://plaid.com/docs/api/products#investments) instead. Transaction data is standardized
+     * across financial institutions, and in many cases transactions are linked to a clean name, entity
+     * type, location, and category. Similarly, account data is standardized and returned with a clean name,
+     * number, balance, and other meta information where available.
+     *
+     * Transactions are returned in reverse-chronological order, and the sequence of transaction ordering
+     * is stable and will not shift.  Transactions are not immutable and can also be removed altogether by
+     * the institution; a removed transaction will no longer appear in `/transactions/get`.  For more
+     * details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-
+     * data/#pending-and-posted-transactions).
+     *
+     * Due to the potentially large number of transactions associated with an Item, results are paginated.
+     * Manipulate the `count` and `offset` parameters in conjunction with the `total_transactions` response
+     * body field to fetch all available transactions.
+     *
+     * Data returned by `/transactions/get` will be the data available for the Item as of the most recent
+     * successful check for new transactions. Plaid typically checks for new data multiple times a day, but
+     * these checks may occur less frequently, such as once a day, depending on the institution. An Item's
+     * `status.transactions.last_successful_update` field will show the timestamp of the most recent
+     * successful update. To force Plaid to check for new transactions, you can use the
+     * `/transactions/refresh` endpoint.
+     *
+     * Note that data may not be immediately available to `/transactions/get`. Plaid will begin to prepare
+     * transactions data upon Item link, if Link was initialized with `transactions`, or upon the first
+     * call to `/transactions/get`, if it wasn't. To be alerted when transaction data is ready to be
+     * fetched, listen for the [`INITIAL_UPDATE`](https://plaid.com/docs/api/webhooks#transactions-
+     * initial_update) and [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/webhooks#transactions-
+     * historical_update) webhooks. If no transaction history is ready when `/transactions/get` is called,
+     * it will return a `PRODUCT_NOT_READY` error.
+     *
+     * @param body
+     * @return Response from the API call
+     */
+    async transactionsGet(body, requestOptions) {
+        const req = this.createRequest('POST', '/transactions/get');
+        const mapped = req.prepareArgs({
+            body: [body, transactionsGetRequestSchema],
+        });
+        req.header('Content-Type', 'application/json');
+        req.json(mapped.body);
+        req.defaultToError(ErrorError, 'Error response');
+        req.authenticate([
+            { plaidClientId: true, plaidSecret: true, plaidVersion: true },
+        ]);
+        return req.callAsJson(transactionsGetResponseSchema, requestOptions);
+    }
+}
+//# sourceMappingURL=transactionsApi.js.map

package/dist/esm/controllers/transactionsApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transactionsApi.js","sourceRoot":"","sources":["../../../src/controllers/transactionsApi.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAEL,4BAA4B,GAC7B,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAEL,6BAA6B,GAC9B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAEL,gCAAgC,GACjC,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAEL,iCAAiC,GAClC,MAAM,0CAA0C,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAErD,MAAM,OAAO,eAAgB,SAAQ,OAAO;IAC1C;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,mBAAmB,CACvB,IAAgC,EAChC,cAA+B;QAE/B,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAC;QAChE,MAAM,MAAM,GAAG,GAAG,CAAC,WAAW,CAAC;YAC7B,IAAI,EAAE,CAAC,IAAI,EAAE,gCAAgC,CAAC;SAC/C,CAAC,CAAC;QACH,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC/C,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACtB,GAAG,CAAC,cAAc,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;QACjD,GAAG,CAAC,YAAY,CAAC;YACf,EAAE,aAAa,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE;SAC/D,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,UAAU,CAAC,iCAAiC,EAAE,cAAc,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,KAAK,CAAC,eAAe,CACnB,IAA4B,EAC5B,cAA+B;QAE/B,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;QAC5D,MAAM,MAAM,GAAG,GAAG,CAAC,WAAW,CAAC;YAC7B,IAAI,EAAE,CAAC,IAAI,EAAE,4BAA4B,CAAC;SAC3C,CAAC,CAAC;QACH,GAAG,CAAC,MAAM,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC/C,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACtB,GAAG,CAAC,cAAc,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;QACjD,GAAG,CAAC,YAAY,CAAC;YACf,EAAE,aAAa,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE;SAC/D,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,UAAU,CAAC,6BAA6B,EAAE,cAAc,CAAC,CAAC;IACvE,CAAC;CACF"}