@monarkmarkets/api-client 1.3.40 → 1.3.42

package/dist/Client.d.ts

@@ -100,6 +100,15 @@ export declare class Client {
      */
     downloadDocumentV2(id: string, token: string): Promise<void>;
     protected processDownloadDocumentV2(response: Response): Promise<void>;
+    /**
+     * Streams a document using document ID and token. Supports Range requests for PDF viewers.
+    Anonymous endpoint; CORS allows any origin for browser-based streaming.
+     * @param id The Document ID for the document to stream.
+     * @param token The secure token required to access the document.
+     * @return OK
+     */
+    streamDocumentV2(id: string, token: string): Promise<void>;
+    protected processStreamDocumentV2(response: Response): Promise<void>;
     /**
      * Create a Financial Advisor.
      * @param body (optional) create Financial Advisor information.
@@ -1215,9 +1224,10 @@ export declare class Client {
      * @param referenceId (optional) Optional: Filter by order reference ID.
      * @param managerId (optional) Optional: Filter by manager ID. For SPVs, filters by Manager. For RegisteredFunds, filters by Fund Manager.
      * @param includeDocuments (optional) Optional flag to include associated documents.
+     * @param side (optional) Optional: Filter by transaction side. (Currently only supported for registered funds)
      * @return OK
      */
-    getTransactions(targetAssetType: TargetAssetType, page: number | undefined, pageSize: number | undefined, targetId: string | undefined, investorId: string | undefined, status: string | undefined, referenceId: string | undefined, managerId: string | undefined, includeDocuments: boolean | undefined): Promise<TransactionApiResponse>;
+    getTransactions(targetAssetType: TargetAssetType, page: number | undefined, pageSize: number | undefined, targetId: string | undefined, investorId: string | undefined, status: string | undefined, referenceId: string | undefined, managerId: string | undefined, includeDocuments: boolean | undefined, side: Side | undefined): Promise<TransactionApiResponse>;
     protected processGetTransactions(response: Response): Promise<TransactionApiResponse>;
     /**
      * Update an existing transaction.
@@ -2308,7 +2318,11 @@ export declare class CreateTransaction implements ICreateTransaction {
     /** ID of the Investor associated with this Order. */
     investorId: string;
     /** Describes the amount, in dollars, an Investor intends to invest into a Target. */
-    amountReservedDollars: number;
+    amountReservedDollars?: number | undefined;
+    /** Described the amount, in shares, an investor can redeem from a Target. */
+    amountShares?: number | undefined;
+    /** Describes whether the transaction is a full exit in terms of redemption. */
+    isFullExit?: boolean | undefined;
     /** The reference ID of an order submitted. */
     referenceId?: string | undefined;
     constructor(data?: ICreateTransaction);
@@ -2326,7 +2340,11 @@ export interface ICreateTransaction {
     /** ID of the Investor associated with this Order. */
     investorId: string;
     /** Describes the amount, in dollars, an Investor intends to invest into a Target. */
-    amountReservedDollars: number;
+    amountReservedDollars?: number | undefined;
+    /** Described the amount, in shares, an investor can redeem from a Target. */
+    amountShares?: number | undefined;
+    /** Describes whether the transaction is a full exit in terms of redemption. */
+    isFullExit?: boolean | undefined;
     /** The reference ID of an order submitted. */
     referenceId?: string | undefined;
 }
@@ -2502,6 +2520,8 @@ export declare class DocumentV2 implements IDocumentV2 {
     name?: string | undefined;
     /** URL link to view the document. */
     url: string | undefined;
+    /** URL link to stream the document. */
+    streamUrl?: string | undefined;
     /** Unique identifier of the associated investor, if any. */
     investorId?: string | undefined;
     /** Unique identifier of the associated PreIPOCompany, if any. */
@@ -2535,6 +2555,8 @@ export interface IDocumentV2 {
     name?: string | undefined;
     /** URL link to view the document. */
     url: string | undefined;
+    /** URL link to stream the document. */
+    streamUrl?: string | undefined;
     /** Unique identifier of the associated investor, if any. */
     investorId?: string | undefined;
     /** Unique identifier of the associated PreIPOCompany, if any. */
@@ -7217,6 +7239,8 @@ export declare class Transaction implements ITransaction {
     companyName?: string | undefined;
     /** The reference ID of an order submitted. */
     referenceId?: string | undefined;
+    /** Indicates if this order is a full exit. */
+    isFullExit?: boolean | undefined;
     /** Optional list of documents associated with this transaction. */
     documents?: DocumentV2[] | undefined;
     constructor(data?: ITransaction);
@@ -7259,6 +7283,8 @@ export interface ITransaction {
     companyName?: string | undefined;
     /** The reference ID of an order submitted. */
     referenceId?: string | undefined;
+    /** Indicates if this order is a full exit. */
+    isFullExit?: boolean | undefined;
     /** Optional list of documents associated with this transaction. */
     documents?: DocumentV2[] | undefined;
 }
@@ -8226,7 +8252,11 @@ export declare class UpdateTransaction implements IUpdateTransaction {
     /** ID of the Investor associated with this Order. */
     investorId: string;
     /** Describes the amount, in dollars, an Investor intends to invest into a Target. */
-    amountReservedDollars: number;
+    amountReservedDollars?: number | undefined;
+    /** Described the amount, in shares, an investor can redeem from a Target. */
+    amountShares?: number | undefined;
+    /** Describes whether the transaction is a full exit in terms of redemption. */
+    isFullExit?: boolean | undefined;
     /** ID of the Order to edit. */
     id: string;
     /** The type of asset being targeted with this Order. */
@@ -8244,7 +8274,11 @@ export interface IUpdateTransaction {
     /** ID of the Investor associated with this Order. */
     investorId: string;
     /** Describes the amount, in dollars, an Investor intends to invest into a Target. */
-    amountReservedDollars: number;
+    amountReservedDollars?: number | undefined;
+    /** Described the amount, in shares, an investor can redeem from a Target. */
+    amountShares?: number | undefined;
+    /** Describes whether the transaction is a full exit in terms of redemption. */
+    isFullExit?: boolean | undefined;
     /** ID of the Order to edit. */
     id: string;
     /** The type of asset being targeted with this Order. */
@@ -8477,7 +8511,9 @@ export declare enum DocumentType {
     RegisteredFundProspectus_Monark = "RegisteredFundProspectus_Monark",
     RegisteredFundFactCard_Monark = "RegisteredFundFactCard_Monark",
     RegisteredFundQuiltChart_Monark = "RegisteredFundQuiltChart_Monark",
-    RegisteredFundMarketingDocument_Monark = "RegisteredFundMarketingDocument_Monark"
+    RegisteredFundMarketingDocument_Monark = "RegisteredFundMarketingDocument_Monark",
+    RegisteredFundRedemptionAgreement_Monark = "RegisteredFundRedemptionAgreement_Monark",
+    RegisteredFundTransferAgreement_Monark = "RegisteredFundTransferAgreement_Monark"
 }
 export declare enum SortOrder {
     Ascending = "Ascending",
@@ -8522,7 +8558,9 @@ export declare enum DocumentType2 {
     RegisteredFundProspectus_Monark = "RegisteredFundProspectus_Monark",
     RegisteredFundFactCard_Monark = "RegisteredFundFactCard_Monark",
     RegisteredFundQuiltChart_Monark = "RegisteredFundQuiltChart_Monark",
-    RegisteredFundMarketingDocument_Monark = "RegisteredFundMarketingDocument_Monark"
+    RegisteredFundMarketingDocument_Monark = "RegisteredFundMarketingDocument_Monark",
+    RegisteredFundRedemptionAgreement_Monark = "RegisteredFundRedemptionAgreement_Monark",
+    RegisteredFundTransferAgreement_Monark = "RegisteredFundTransferAgreement_Monark"
 }
 export declare enum SortOrder2 {
     Ascending = "Ascending",
@@ -8747,6 +8785,10 @@ export declare enum TargetAssetType {
     RegisteredFund = "RegisteredFund",
     PreIPOCompany = "PreIPOCompany"
 }
+export declare enum Side {
+    Subscription = "Subscription",
+    Redemption = "Redemption"
+}
 export declare enum TargetAssetType2 {
     PreIPOCompanySPV = "PreIPOCompanySPV",
     RegisteredFund = "RegisteredFund",
@@ -8993,7 +9035,9 @@ export declare enum DocumentType3 {
     RegisteredFundProspectus_Monark = "RegisteredFundProspectus_Monark",
     RegisteredFundFactCard_Monark = "RegisteredFundFactCard_Monark",
     RegisteredFundQuiltChart_Monark = "RegisteredFundQuiltChart_Monark",
-    RegisteredFundMarketingDocument_Monark = "RegisteredFundMarketingDocument_Monark"
+    RegisteredFundMarketingDocument_Monark = "RegisteredFundMarketingDocument_Monark",
+    RegisteredFundRedemptionAgreement_Monark = "RegisteredFundRedemptionAgreement_Monark",
+    RegisteredFundTransferAgreement_Monark = "RegisteredFundTransferAgreement_Monark"
 }
 export declare enum DocumentV2Type {
     BUSINESS_FORMATION = "BUSINESS_FORMATION",
@@ -9034,7 +9078,9 @@ export declare enum DocumentV2Type {
     RegisteredFundProspectus_Monark = "RegisteredFundProspectus_Monark",
     RegisteredFundFactCard_Monark = "RegisteredFundFactCard_Monark",
     RegisteredFundQuiltChart_Monark = "RegisteredFundQuiltChart_Monark",
-    RegisteredFundMarketingDocument_Monark = "RegisteredFundMarketingDocument_Monark"
+    RegisteredFundMarketingDocument_Monark = "RegisteredFundMarketingDocument_Monark",
+    RegisteredFundRedemptionAgreement_Monark = "RegisteredFundRedemptionAgreement_Monark",
+    RegisteredFundTransferAgreement_Monark = "RegisteredFundTransferAgreement_Monark"
 }
 export declare enum EntityInvestorEntityType {
     SOLE_PROPRIETOR = "SOLE_PROPRIETOR",

package/dist/Client.js

@@ -591,6 +591,78 @@ export class Client {
         }
         return Promise.resolve(null);
     }
+    /**
+     * Streams a document using document ID and token. Supports Range requests for PDF viewers.
+    Anonymous endpoint; CORS allows any origin for browser-based streaming.
+     * @param id The Document ID for the document to stream.
+     * @param token The secure token required to access the document.
+     * @return OK
+     */
+    streamDocumentV2(id, token) {
+        let url_ = this.baseUrl + "/primary/v2/document/{id}/stream/{token}";
+        if (id === undefined || id === null)
+            throw new globalThis.Error("The parameter 'id' must be defined.");
+        url_ = url_.replace("{id}", encodeURIComponent("" + id));
+        if (token === undefined || token === null)
+            throw new globalThis.Error("The parameter 'token' must be defined.");
+        url_ = url_.replace("{token}", encodeURIComponent("" + token));
+        url_ = url_.replace(/[?&]$/, "");
+        let options_ = {
+            method: "GET",
+            headers: {}
+        };
+        return this.http.fetch(url_, options_).then((_response) => {
+            return this.processStreamDocumentV2(_response);
+        });
+    }
+    processStreamDocumentV2(response) {
+        const status = response.status;
+        let _headers = {};
+        if (response.headers && response.headers.forEach) {
+            response.headers.forEach((v, k) => _headers[k] = v);
+        }
+        ;
+        if (status === 200) {
+            return response.text().then((_responseText) => {
+                return;
+            });
+        }
+        else if (status === 206) {
+            return response.text().then((_responseText) => {
+                return;
+            });
+        }
+        else if (status === 403) {
+            return response.text().then((_responseText) => {
+                let result403 = null;
+                let resultData403 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+                result403 = ProblemDetails.fromJS(resultData403);
+                return throwException("Forbidden", status, _responseText, _headers, result403);
+            });
+        }
+        else if (status === 404) {
+            return response.text().then((_responseText) => {
+                let result404 = null;
+                let resultData404 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+                result404 = ProblemDetails.fromJS(resultData404);
+                return throwException("Not Found", status, _responseText, _headers, result404);
+            });
+        }
+        else if (status === 416) {
+            return response.text().then((_responseText) => {
+                let result416 = null;
+                let resultData416 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+                result416 = ProblemDetails.fromJS(resultData416);
+                return throwException("Range Not Satisfiable", status, _responseText, _headers, result416);
+            });
+        }
+        else if (status !== 200 && status !== 204) {
+            return response.text().then((_responseText) => {
+                return throwException("An unexpected server error occurred.", status, _responseText, _headers);
+            });
+        }
+        return Promise.resolve(null);
+    }
     /**
      * Create a Financial Advisor.
      * @param body (optional) create Financial Advisor information.
@@ -7749,9 +7821,10 @@ export class Client {
      * @param referenceId (optional) Optional: Filter by order reference ID.
      * @param managerId (optional) Optional: Filter by manager ID. For SPVs, filters by Manager. For RegisteredFunds, filters by Fund Manager.
      * @param includeDocuments (optional) Optional flag to include associated documents.
+     * @param side (optional) Optional: Filter by transaction side. (Currently only supported for registered funds)
      * @return OK
      */
-    getTransactions(targetAssetType, page, pageSize, targetId, investorId, status, referenceId, managerId, includeDocuments) {
+    getTransactions(targetAssetType, page, pageSize, targetId, investorId, status, referenceId, managerId, includeDocuments, side) {
         let url_ = this.baseUrl + "/primary/v2/transaction?";
         if (targetAssetType === undefined || targetAssetType === null)
             throw new globalThis.Error("The parameter 'targetAssetType' must be defined and cannot be null.");
@@ -7789,6 +7862,10 @@ export class Client {
             throw new globalThis.Error("The parameter 'includeDocuments' cannot be null.");
         else if (includeDocuments !== undefined)
             url_ += "includeDocuments=" + encodeURIComponent("" + includeDocuments) + "&";
+        if (side === null)
+            throw new globalThis.Error("The parameter 'side' cannot be null.");
+        else if (side !== undefined)
+            url_ += "side=" + encodeURIComponent("" + side) + "&";
         url_ = url_.replace(/[?&]$/, "");
         let options_ = {
             method: "GET",
@@ -10337,6 +10414,8 @@ export class CreateTransaction {
             this.side = _data["side"];
             this.investorId = _data["investorId"];
             this.amountReservedDollars = _data["amountReservedDollars"];
+            this.amountShares = _data["amountShares"];
+            this.isFullExit = _data["isFullExit"];
             this.referenceId = _data["referenceId"];
         }
     }
@@ -10353,6 +10432,8 @@ export class CreateTransaction {
         data["side"] = this.side;
         data["investorId"] = this.investorId;
         data["amountReservedDollars"] = this.amountReservedDollars;
+        data["amountShares"] = this.amountShares;
+        data["isFullExit"] = this.isFullExit;
         data["referenceId"] = this.referenceId;
         return data;
     }
@@ -10630,6 +10711,7 @@ export class DocumentV2 {
             this.id = _data["id"];
             this.name = _data["name"];
             this.url = _data["url"];
+            this.streamUrl = _data["streamUrl"];
             this.investorId = _data["investorId"];
             this.preIPOCompanyId = _data["preIPOCompanyId"];
             this.preIPOCompanyInvestmentId = _data["preIPOCompanyInvestmentId"];
@@ -10653,6 +10735,7 @@ export class DocumentV2 {
         data["id"] = this.id;
         data["name"] = this.name;
         data["url"] = this.url;
+        data["streamUrl"] = this.streamUrl;
         data["investorId"] = this.investorId;
         data["preIPOCompanyId"] = this.preIPOCompanyId;
         data["preIPOCompanyInvestmentId"] = this.preIPOCompanyInvestmentId;
@@ -15929,6 +16012,7 @@ export class Transaction {
             this.targetName = _data["targetName"];
             this.companyName = _data["companyName"];
             this.referenceId = _data["referenceId"];
+            this.isFullExit = _data["isFullExit"];
             if (Array.isArray(_data["documents"])) {
                 this.documents = [];
                 for (let item of _data["documents"])
@@ -15961,6 +16045,7 @@ export class Transaction {
         data["targetName"] = this.targetName;
         data["companyName"] = this.companyName;
         data["referenceId"] = this.referenceId;
+        data["isFullExit"] = this.isFullExit;
         if (Array.isArray(this.documents)) {
             data["documents"] = [];
             for (let item of this.documents)
@@ -17066,6 +17151,8 @@ export class UpdateTransaction {
             this.side = _data["side"];
             this.investorId = _data["investorId"];
             this.amountReservedDollars = _data["amountReservedDollars"];
+            this.amountShares = _data["amountShares"];
+            this.isFullExit = _data["isFullExit"];
             this.id = _data["id"];
             this.targetAssetType = _data["targetAssetType"];
         }
@@ -17082,6 +17169,8 @@ export class UpdateTransaction {
         data["side"] = this.side;
         data["investorId"] = this.investorId;
         data["amountReservedDollars"] = this.amountReservedDollars;
+        data["amountShares"] = this.amountShares;
+        data["isFullExit"] = this.isFullExit;
         data["id"] = this.id;
         data["targetAssetType"] = this.targetAssetType;
         return data;
@@ -17412,6 +17501,8 @@ export var DocumentType;
     DocumentType["RegisteredFundFactCard_Monark"] = "RegisteredFundFactCard_Monark";
     DocumentType["RegisteredFundQuiltChart_Monark"] = "RegisteredFundQuiltChart_Monark";
     DocumentType["RegisteredFundMarketingDocument_Monark"] = "RegisteredFundMarketingDocument_Monark";
+    DocumentType["RegisteredFundRedemptionAgreement_Monark"] = "RegisteredFundRedemptionAgreement_Monark";
+    DocumentType["RegisteredFundTransferAgreement_Monark"] = "RegisteredFundTransferAgreement_Monark";
 })(DocumentType || (DocumentType = {}));
 export var SortOrder;
 (function (SortOrder) {
@@ -17459,6 +17550,8 @@ export var DocumentType2;
     DocumentType2["RegisteredFundFactCard_Monark"] = "RegisteredFundFactCard_Monark";
     DocumentType2["RegisteredFundQuiltChart_Monark"] = "RegisteredFundQuiltChart_Monark";
     DocumentType2["RegisteredFundMarketingDocument_Monark"] = "RegisteredFundMarketingDocument_Monark";
+    DocumentType2["RegisteredFundRedemptionAgreement_Monark"] = "RegisteredFundRedemptionAgreement_Monark";
+    DocumentType2["RegisteredFundTransferAgreement_Monark"] = "RegisteredFundTransferAgreement_Monark";
 })(DocumentType2 || (DocumentType2 = {}));
 export var SortOrder2;
 (function (SortOrder2) {
@@ -17724,6 +17817,11 @@ export var TargetAssetType;
     TargetAssetType["RegisteredFund"] = "RegisteredFund";
     TargetAssetType["PreIPOCompany"] = "PreIPOCompany";
 })(TargetAssetType || (TargetAssetType = {}));
+export var Side;
+(function (Side) {
+    Side["Subscription"] = "Subscription";
+    Side["Redemption"] = "Redemption";
+})(Side || (Side = {}));
 export var TargetAssetType2;
 (function (TargetAssetType2) {
     TargetAssetType2["PreIPOCompanySPV"] = "PreIPOCompanySPV";
@@ -17995,6 +18093,8 @@ export var DocumentType3;
     DocumentType3["RegisteredFundFactCard_Monark"] = "RegisteredFundFactCard_Monark";
     DocumentType3["RegisteredFundQuiltChart_Monark"] = "RegisteredFundQuiltChart_Monark";
     DocumentType3["RegisteredFundMarketingDocument_Monark"] = "RegisteredFundMarketingDocument_Monark";
+    DocumentType3["RegisteredFundRedemptionAgreement_Monark"] = "RegisteredFundRedemptionAgreement_Monark";
+    DocumentType3["RegisteredFundTransferAgreement_Monark"] = "RegisteredFundTransferAgreement_Monark";
 })(DocumentType3 || (DocumentType3 = {}));
 export var DocumentV2Type;
 (function (DocumentV2Type) {
@@ -18037,6 +18137,8 @@ export var DocumentV2Type;
     DocumentV2Type["RegisteredFundFactCard_Monark"] = "RegisteredFundFactCard_Monark";
     DocumentV2Type["RegisteredFundQuiltChart_Monark"] = "RegisteredFundQuiltChart_Monark";
     DocumentV2Type["RegisteredFundMarketingDocument_Monark"] = "RegisteredFundMarketingDocument_Monark";
+    DocumentV2Type["RegisteredFundRedemptionAgreement_Monark"] = "RegisteredFundRedemptionAgreement_Monark";
+    DocumentV2Type["RegisteredFundTransferAgreement_Monark"] = "RegisteredFundTransferAgreement_Monark";
 })(DocumentV2Type || (DocumentV2Type = {}));
 export var EntityInvestorEntityType;
 (function (EntityInvestorEntityType) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@monarkmarkets/api-client",
-  "version": "1.3.40",
+  "version": "1.3.42",
   "main": "dist/index.js",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",