@thera-hr/api-sdk 0.0.1-prerelease2986-staging → 0.0.1-prerelease2987-dev

package/reference.md

@@ -3231,6 +3231,7 @@ Links an external crypto wallet to a customer.
 
 ```typescript
 await client.api.thera.bridge.bridgeApi.createExternalAccount("string", {
+    id: "string",
     walletAddress: "string",
     currency: "string",
     paymentRail: "string",
@@ -4580,6 +4581,181 @@ await client.api.thera.bridge.bridgeApi.listHistoryOfVirtualAccounts("string");
 </dl>
 </details>
 
+<details><summary><code>client.api.thera.bridge.bridgeApi.<a href="/src/api/resources/api/resources/thera/resources/bridge/resources/bridgeApi/client/Client.ts">createCards</a>(userId) -> TheraApi.CardAccount</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Creates a bridge cards for a customer.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.api.thera.bridge.bridgeApi.createCards("string");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**userId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `BridgeApi.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.api.thera.bridge.bridgeApi.<a href="/src/api/resources/api/resources/thera/resources/bridge/resources/bridgeApi/client/Client.ts">retrieveCardById</a>(customerId, cardAccountId) -> TheraApi.CardAccount</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.api.thera.bridge.bridgeApi.retrieveCardById("string", "string");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**customerId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**cardAccountId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `BridgeApi.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.api.thera.bridge.bridgeApi.<a href="/src/api/resources/api/resources/thera/resources/bridge/resources/bridgeApi/client/Client.ts">cardTransactions</a>(customerId, cardAccountId) -> TheraApi.CardTransactionList</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.api.thera.bridge.bridgeApi.cardTransactions("string", "string");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**customerId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**cardAccountId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `BridgeApi.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Company
 
 <details><summary><code>client.api.thera.company.companyApi.<a href="/src/api/resources/api/resources/thera/resources/company/resources/companyApi/client/Client.ts">getMoniteToken</a>(companyId, { ...params }) -> TheraApi.GetMoniteTokenResponse</code></summary>
@@ -7889,6 +8065,234 @@ await client.api.thera.eor.eorTrackerApi.getLatestEorEmployeeEmailByCompanyId("s
 </dl>
 </details>
 
+## Incorporation Integration
+
+<details><summary><code>client.api.thera.incorporation.incorporationApi.<a href="/src/api/resources/api/resources/thera/resources/incorporation/resources/incorporationApi/client/Client.ts">incorporationSignup</a>({ ...params }) -> TheraApi.IncorporationSignupResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Create a new user account and company for someone who has incorporated
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.api.thera.incorporation.incorporationApi.incorporationSignup({
+    businessName: "string",
+    state: "string",
+    firstName: "string",
+    lastName: "string",
+    email: "string",
+    phone: "string",
+    experience: "string",
+    progress: "string",
+    industry: "string",
+    agent: "string",
+    packageType: "string",
+    dbaService: true,
+    worryFreeCompliance: true,
+    einDocuments: ["string"],
+    tradeMarkCompany: true,
+    appointedAgent: true,
+    registrationDate: "string",
+    status: "string",
+    userPersonalAddress: {
+        city: "string",
+        country: "string",
+        line1: "string",
+        line2: "string",
+        postalCode: "string",
+        state: "string",
+    },
+    password: "string",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `TheraApi.IncorporationSignupRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `IncorporationApi.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.api.thera.incorporation.incorporationApi.<a href="/src/api/resources/api/resources/thera/resources/incorporation/resources/incorporationApi/client/Client.ts">createCheckoutSession</a>({ ...params }) -> TheraApi.CheckoutSessionResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Create a Stripe checkout session for payment
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.api.thera.incorporation.incorporationApi.createCheckoutSession({
+    amount: 1.1,
+    productName: "string",
+    currency: "string",
+    successUrl: "string",
+    cancelUrl: "string",
+    metadata: {
+        string: "string",
+    },
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `TheraApi.CheckoutSessionRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `IncorporationApi.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.api.thera.incorporation.incorporationApi.<a href="/src/api/resources/api/resources/thera/resources/incorporation/resources/incorporationApi/client/Client.ts">checkPaymentStatus</a>(sessionId) -> TheraApi.PaymentStatusResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Check the status of a Stripe payment session
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.api.thera.incorporation.incorporationApi.checkPaymentStatus("string");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**sessionId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `IncorporationApi.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Miscellaneous API
 
 <details><summary><code>client.api.thera.misc.misc.<a href="/src/api/resources/api/resources/thera/resources/misc/resources/misc/client/Client.ts">regularCron</a>({ ...params }) -> TheraApi.DailyCronResponse</code></summary>
@@ -10706,6 +11110,7 @@ await client.api.thera.tp.tpApi.processTreasuryPrimePayment("string", {
     secCode: "string",
     service: "string",
     revenueAmount: "string",
+    cashDeposit: true,
 });
 ```
 
@@ -11254,6 +11659,106 @@ await client.api.thera.tp.tpApi.externalTransferFund({
 </dl>
 </details>
 
+<details><summary><code>client.api.thera.tp.tpApi.<a href="/src/api/resources/api/resources/thera/resources/tp/resources/tpApi/client/Client.ts">withdrawalTheraCash</a>(companyId, { ...params }) -> unknown</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Withdrawal funds from thera cash to user's personal account via ach or wire
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.api.thera.tp.tpApi.withdrawalTheraCash("string", {
+    nameOnAccount: "string",
+    amount: "string",
+    ach: {
+        accountNumber: "string",
+        accountType: "string",
+        routingNumber: "string",
+    },
+    wire: {
+        accountNumber: "string",
+        routingNumber: "string",
+        addressOnAccount: {
+            streetLine1: "string",
+            streetLine2: "string",
+            city: "string",
+            state: "string",
+            postalCode: "string",
+            country: "string",
+        },
+        bankName: "string",
+        bankAddress: {
+            streetLine1: "string",
+            streetLine2: "string",
+            city: "string",
+            state: "string",
+            postalCode: "string",
+            country: "string",
+        },
+    },
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**companyId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `TheraApi.WithdrawalTheraCash`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `TpApi.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## User API
 
 <details><summary><code>client.api.thera.user.userApi.<a href="/src/api/resources/api/resources/thera/resources/user/resources/userApi/client/Client.ts">setUserComplianceSetting</a>(userId, companyId, { ...params }) -> void</code></summary>

package/serialization/resources/api/resources/thera/resources/bank/resources/bankApi/types/EorPayIn.d.ts

@@ -7,6 +7,7 @@ import * as core from "../../../../../../../../../../core";
 export declare const EorPayIn: core.serialization.ObjectSchema<serializers.api.thera.bank.EorPayIn.Raw, TheraApi.api.thera.bank.EorPayIn>;
 export declare namespace EorPayIn {
     interface Raw {
-        receiptS3Key: string;
+        receiptS3Key?: string | null;
+        userMap?: Record<string, string> | null;
     }
 }

package/serialization/resources/api/resources/thera/resources/bank/resources/bankApi/types/EorPayIn.js

@@ -39,5 +39,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.EorPayIn = void 0;
 const core = __importStar(require("../../../../../../../../../../core"));
 exports.EorPayIn = core.serialization.object({
-    receiptS3Key: core.serialization.string(),
+    receiptS3Key: core.serialization.string().optional(),
+    userMap: core.serialization.record(core.serialization.string(), core.serialization.string()).optional(),
 });

package/serialization/resources/api/resources/thera/resources/bridge/resources/bridgeApi/types/BlockChain.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../../../../../../../../../index";
+import * as TheraApi from "../../../../../../../../../../api/index";
+import * as core from "../../../../../../../../../../core";
+export declare const BlockChain: core.serialization.Schema<serializers.api.thera.bridge.BlockChain.Raw, TheraApi.api.thera.bridge.BlockChain>;
+export declare namespace BlockChain {
+    type Raw = "arbitrum" | "avalanche_c_chain" | "base" | "ethereum" | "optimism" | "polygon" | "solana" | "stellar" | "tron";
+}

package/serialization/resources/api/resources/thera/resources/bridge/resources/bridgeApi/types/BlockChain.js

@@ -0,0 +1,51 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BlockChain = void 0;
+const core = __importStar(require("../../../../../../../../../../core"));
+exports.BlockChain = core.serialization.enum_([
+    "arbitrum",
+    "avalanche_c_chain",
+    "base",
+    "ethereum",
+    "optimism",
+    "polygon",
+    "solana",
+    "stellar",
+    "tron",
+]);

package/serialization/resources/api/resources/thera/resources/bridge/resources/bridgeApi/types/CardAccount.d.ts

@@ -0,0 +1,29 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../../../../../../../../../index";
+import * as TheraApi from "../../../../../../../../../../api/index";
+import * as core from "../../../../../../../../../../core";
+import { CardStatus } from "./CardStatus";
+import { CardDetails } from "./CardDetails";
+import { CardBalances } from "./CardBalances";
+import { CardFreeze } from "./CardFreeze";
+import { CryptoAccount } from "./CryptoAccount";
+import { FundingInstructions } from "./FundingInstructions";
+export declare const CardAccount: core.serialization.ObjectSchema<serializers.api.thera.bridge.CardAccount.Raw, TheraApi.api.thera.bridge.CardAccount>;
+export declare namespace CardAccount {
+    interface Raw {
+        id: string;
+        client_reference_id?: string | null;
+        customer_id: string;
+        card_image_url: string;
+        status: CardStatus.Raw;
+        status_reason?: string | null;
+        card_details: CardDetails.Raw;
+        balances: CardBalances.Raw;
+        freezes: CardFreeze.Raw[];
+        card_account_id: string;
+        crypto_account?: CryptoAccount.Raw | null;
+        funding_instructions?: FundingInstructions.Raw | null;
+    }
+}

package/serialization/resources/api/resources/thera/resources/bridge/resources/bridgeApi/types/CardAccount.js

@@ -0,0 +1,60 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CardAccount = void 0;
+const core = __importStar(require("../../../../../../../../../../core"));
+const CardStatus_1 = require("./CardStatus");
+const CardDetails_1 = require("./CardDetails");
+const CardBalances_1 = require("./CardBalances");
+const CardFreeze_1 = require("./CardFreeze");
+const CryptoAccount_1 = require("./CryptoAccount");
+const FundingInstructions_1 = require("./FundingInstructions");
+exports.CardAccount = core.serialization.object({
+    id: core.serialization.string(),
+    clientReferenceId: core.serialization.property("client_reference_id", core.serialization.string().optional()),
+    customerId: core.serialization.property("customer_id", core.serialization.string()),
+    cardImageUrl: core.serialization.property("card_image_url", core.serialization.string()),
+    status: CardStatus_1.CardStatus,
+    statusReason: core.serialization.property("status_reason", core.serialization.string().optional()),
+    cardDetails: core.serialization.property("card_details", CardDetails_1.CardDetails),
+    balances: CardBalances_1.CardBalances,
+    freezes: core.serialization.list(CardFreeze_1.CardFreeze),
+    cardAccountId: core.serialization.property("card_account_id", core.serialization.string()),
+    cryptoAccount: core.serialization.property("crypto_account", CryptoAccount_1.CryptoAccount.optional()),
+    fundingInstructions: core.serialization.property("funding_instructions", FundingInstructions_1.FundingInstructions.optional()),
+});