@monarkmarkets/api-client 1.1.108 → 1.1.110

package/dist/Client.d.ts

@@ -682,6 +682,28 @@ export declare class Client {
      */
     document3(id: string): Promise<FileResponse>;
     protected processDocument3(response: Response): Promise<FileResponse>;
+    /**
+     * Get all RegisteredFundSubscriptionActions by RegisteredFundSubscription.
+     * @param registeredFundSubscriptionId The ID of the RegisteredFundSubscription to get the actions for.
+     * @param responsibleParty (optional) Optional filter by responsible party.
+     * @return OK
+     */
+    registeredFundSubscriptionAll(registeredFundSubscriptionId: string, responsibleParty: ResponsibleParty | undefined): Promise<RegisteredFundSubscriptionAction[]>;
+    protected processRegisteredFundSubscriptionAll(response: Response): Promise<RegisteredFundSubscriptionAction[]>;
+    /**
+     * Get a RegisteredFundSubscriptionAction by Id
+     * @param id ID of the RegisteredFundSubscriptionAction to find.
+     * @return OK
+     */
+    registeredFundSubscriptionAction(id: string): Promise<RegisteredFundSubscriptionAction>;
+    protected processRegisteredFundSubscriptionAction(response: Response): Promise<RegisteredFundSubscriptionAction>;
+    /**
+     * Complete a RegisteredFundSubscriptionAction.
+     * @param id The ID of the RegisteredFundSubscriptionAction to complete.
+     * @return No Content
+     */
+    complete2(id: string): Promise<void>;
+    protected processComplete2(response: Response): Promise<void>;
     /**
      * Get the API version
      * @return Returns the API version
@@ -3494,12 +3516,6 @@ export declare class PreIPOCompanySPV implements IPreIPOCompanySPV {
     remainingShareAllocation?: number;
     /** Indicates whether the SPV will be prefunded. */
     preFundedInventory?: boolean;
-    /** Size, in USD, of the brokerage commission associated with this PreIPOCompanySPV. This is the amount left over after the ERA pays its fees out of the cash withheld from the up front management fee. */
-    totalCommission?: number | undefined;
-    /** The percentage of the TotalCommission that will be paid to MMM Securities LLC. */
-    monarkCommissionSplit?: number | undefined;
-    /** The percentage of the TotalCommission that will be paid to the Partner distributing the SPV. */
-    demandSideCommissionSplit?: number | undefined;
     /** The price per share of the PreIPOCompany, excluding fees, that an investor will pay when they invest in an SPV. */
     investorPricePerShare?: number | undefined;
     /** The fee per share of the PreIPOCompany, that an Investor will pay when they invest in an SPV on the primary issuance. The InvestorPricePerShare plus the InvestorFeePerShare will determine the AllInPricePerShare. */
@@ -3575,12 +3591,6 @@ export interface IPreIPOCompanySPV {
     remainingShareAllocation?: number;
     /** Indicates whether the SPV will be prefunded. */
     preFundedInventory?: boolean;
-    /** Size, in USD, of the brokerage commission associated with this PreIPOCompanySPV. This is the amount left over after the ERA pays its fees out of the cash withheld from the up front management fee. */
-    totalCommission?: number | undefined;
-    /** The percentage of the TotalCommission that will be paid to MMM Securities LLC. */
-    monarkCommissionSplit?: number | undefined;
-    /** The percentage of the TotalCommission that will be paid to the Partner distributing the SPV. */
-    demandSideCommissionSplit?: number | undefined;
     /** The price per share of the PreIPOCompany, excluding fees, that an investor will pay when they invest in an SPV. */
     investorPricePerShare?: number | undefined;
     /** The fee per share of the PreIPOCompany, that an Investor will pay when they invest in an SPV on the primary issuance. The InvestorPricePerShare plus the InvestorFeePerShare will determine the AllInPricePerShare. */
@@ -4020,6 +4030,50 @@ export interface IRegisteredFundSubscription {
     /** Full name of the associated investor. */
     investorFullName?: string | undefined;
 }
+export declare class RegisteredFundSubscriptionAction implements IRegisteredFundSubscriptionAction {
+    /** Unique ID associated with an InvestorSubscriptionAction. */
+    id?: string;
+    /** RegisteredFund SubscriptionId for the RegisteredFundSubscriptionAction record. */
+    registeredFundSubscriptionId?: string;
+    /** The name of this RegisteredFundSubscriptionAction. */
+    name: string | undefined;
+    /** A description for this action. */
+    description?: string | undefined;
+    /** Optional DataId for related object. */
+    dataId?: string | undefined;
+    /** The current status of this RegisteredFund SubscriptionAction. */
+    status: RegisteredFundSubscriptionActionStatus;
+    /** The type of action required to be performed by the Investor, as part of executing the Subscription. DocumentSign and DocumentAcknowledge can both be completed by “signing” the associated document. RegisteredFundSubscriptionActions with a type of DocumentSign mean that the associated document, once signed, will be populated with an automatically generated signature. InvestorSubscriptionActions with a type of DocumentAcknowledge mean that the associated document, once signed, will be counted as acknowledged but are not required to be populated by a signature. */
+    type: RegisteredFundSubscriptionActionType;
+    /** This describes the entity responsible for acknowledging that the Action has been completed. Partners acknowledge that actions have been completed on behalf of their Investors. */
+    responsibleParty: RegisteredFundSubscriptionActionResponsibleParty;
+    /** Text for an action that is a text acknowledgement. */
+    actionText?: string | undefined;
+    constructor(data?: IRegisteredFundSubscriptionAction);
+    init(_data?: any): void;
+    static fromJS(data: any): RegisteredFundSubscriptionAction;
+    toJSON(data?: any): any;
+}
+export interface IRegisteredFundSubscriptionAction {
+    /** Unique ID associated with an InvestorSubscriptionAction. */
+    id?: string;
+    /** RegisteredFund SubscriptionId for the RegisteredFundSubscriptionAction record. */
+    registeredFundSubscriptionId?: string;
+    /** The name of this RegisteredFundSubscriptionAction. */
+    name: string | undefined;
+    /** A description for this action. */
+    description?: string | undefined;
+    /** Optional DataId for related object. */
+    dataId?: string | undefined;
+    /** The current status of this RegisteredFund SubscriptionAction. */
+    status: RegisteredFundSubscriptionActionStatus;
+    /** The type of action required to be performed by the Investor, as part of executing the Subscription. DocumentSign and DocumentAcknowledge can both be completed by “signing” the associated document. RegisteredFundSubscriptionActions with a type of DocumentSign mean that the associated document, once signed, will be populated with an automatically generated signature. InvestorSubscriptionActions with a type of DocumentAcknowledge mean that the associated document, once signed, will be counted as acknowledged but are not required to be populated by a signature. */
+    type: RegisteredFundSubscriptionActionType;
+    /** This describes the entity responsible for acknowledging that the Action has been completed. Partners acknowledge that actions have been completed on behalf of their Investors. */
+    responsibleParty: RegisteredFundSubscriptionActionResponsibleParty;
+    /** Text for an action that is a text acknowledgement. */
+    actionText?: string | undefined;
+}
 export declare class RegisteredFundSubscriptionApiResponse implements IRegisteredFundSubscriptionApiResponse {
     items?: RegisteredFundSubscription[] | undefined;
     pagination?: Pagination | undefined;
@@ -4912,6 +4966,12 @@ export declare enum SortOrder15 {
     Ascending = "Ascending",
     Descending = "Descending"
 }
+export declare enum ResponsibleParty {
+    Partner = "Partner",
+    Monark = "Monark",
+    Investor = "Investor",
+    Advisor = "Advisor"
+}
 export declare enum SortOrder16 {
     Ascending = "Ascending",
     Descending = "Descending"
@@ -5126,7 +5186,9 @@ export declare enum InvestorSubscriptionActionType {
 }
 export declare enum InvestorSubscriptionActionResponsibleParty {
     Partner = "Partner",
-    Monark = "Monark"
+    Monark = "Monark",
+    Investor = "Investor",
+    Advisor = "Advisor"
 }
 export declare enum LayeredSPVFundStructure {
     ThreeCOne = "ThreeCOne",
@@ -5298,6 +5360,25 @@ export declare enum RegisteredFundSubscriptionStatus {
     InvestorSigned = "InvestorSigned",
     AdvisorSigned = "AdvisorSigned"
 }
+export declare enum RegisteredFundSubscriptionActionStatus {
+    Pending = "Pending",
+    Complete = "Complete"
+}
+export declare enum RegisteredFundSubscriptionActionType {
+    Other = "Other",
+    DocumentSign = "DocumentSign",
+    DocumentAcknowledge = "DocumentAcknowledge",
+    CashMovement = "CashMovement",
+    ApiCall = "ApiCall",
+    TextAcknowledge = "TextAcknowledge",
+    KYCAML = "KYCAML"
+}
+export declare enum RegisteredFundSubscriptionActionResponsibleParty {
+    Partner = "Partner",
+    Monark = "Monark",
+    Investor = "Investor",
+    Advisor = "Advisor"
+}
 export declare enum UpdateEntityInvestorEntityType {
     SOLE_PROPRIETOR = "SOLE_PROPRIETOR",
     SINGLE_MEMBER_LLC = "SINGLE_MEMBER_LLC",

package/dist/Client.js

@@ -4847,6 +4847,166 @@ export class Client {
         }
         return Promise.resolve(null);
     }
+    /**
+     * Get all RegisteredFundSubscriptionActions by RegisteredFundSubscription.
+     * @param registeredFundSubscriptionId The ID of the RegisteredFundSubscription to get the actions for.
+     * @param responsibleParty (optional) Optional filter by responsible party.
+     * @return OK
+     */
+    registeredFundSubscriptionAll(registeredFundSubscriptionId, responsibleParty) {
+        let url_ = this.baseUrl + "/primary/v1/registered-fund-subscription-action/registered-fund-subscription/{registeredFundSubscriptionId}?";
+        if (registeredFundSubscriptionId === undefined || registeredFundSubscriptionId === null)
+            throw new Error("The parameter 'registeredFundSubscriptionId' must be defined.");
+        url_ = url_.replace("{registeredFundSubscriptionId}", encodeURIComponent("" + registeredFundSubscriptionId));
+        if (responsibleParty === null)
+            throw new Error("The parameter 'responsibleParty' cannot be null.");
+        else if (responsibleParty !== undefined)
+            url_ += "responsibleParty=" + encodeURIComponent("" + responsibleParty) + "&";
+        url_ = url_.replace(/[?&]$/, "");
+        let options_ = {
+            method: "GET",
+            headers: {
+                "Accept": "application/json"
+            }
+        };
+        return this.http.fetch(url_, options_).then((_response) => {
+            return this.processRegisteredFundSubscriptionAll(_response);
+        });
+    }
+    processRegisteredFundSubscriptionAll(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) => {
+                let result200 = null;
+                let resultData200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+                if (Array.isArray(resultData200)) {
+                    result200 = [];
+                    for (let item of resultData200)
+                        result200.push(RegisteredFundSubscriptionAction.fromJS(item));
+                }
+                else {
+                    result200 = null;
+                }
+                return result200;
+            });
+        }
+        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 !== 200 && status !== 204) {
+            return response.text().then((_responseText) => {
+                return throwException("An unexpected server error occurred.", status, _responseText, _headers);
+            });
+        }
+        return Promise.resolve(null);
+    }
+    /**
+     * Get a RegisteredFundSubscriptionAction by Id
+     * @param id ID of the RegisteredFundSubscriptionAction to find.
+     * @return OK
+     */
+    registeredFundSubscriptionAction(id) {
+        let url_ = this.baseUrl + "/primary/v1/registered-fund-subscription-action/{id}";
+        if (id === undefined || id === null)
+            throw new Error("The parameter 'id' must be defined.");
+        url_ = url_.replace("{id}", encodeURIComponent("" + id));
+        url_ = url_.replace(/[?&]$/, "");
+        let options_ = {
+            method: "GET",
+            headers: {
+                "Accept": "application/json"
+            }
+        };
+        return this.http.fetch(url_, options_).then((_response) => {
+            return this.processRegisteredFundSubscriptionAction(_response);
+        });
+    }
+    processRegisteredFundSubscriptionAction(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) => {
+                let result200 = null;
+                let resultData200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+                result200 = RegisteredFundSubscriptionAction.fromJS(resultData200);
+                return result200;
+            });
+        }
+        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 !== 200 && status !== 204) {
+            return response.text().then((_responseText) => {
+                return throwException("An unexpected server error occurred.", status, _responseText, _headers);
+            });
+        }
+        return Promise.resolve(null);
+    }
+    /**
+     * Complete a RegisteredFundSubscriptionAction.
+     * @param id The ID of the RegisteredFundSubscriptionAction to complete.
+     * @return No Content
+     */
+    complete2(id) {
+        let url_ = this.baseUrl + "/primary/v1/registered-fund-subscription-action/{id}/complete";
+        if (id === undefined || id === null)
+            throw new Error("The parameter 'id' must be defined.");
+        url_ = url_.replace("{id}", encodeURIComponent("" + id));
+        url_ = url_.replace(/[?&]$/, "");
+        let options_ = {
+            method: "PUT",
+            headers: {}
+        };
+        return this.http.fetch(url_, options_).then((_response) => {
+            return this.processComplete2(_response);
+        });
+    }
+    processComplete2(response) {
+        const status = response.status;
+        let _headers = {};
+        if (response.headers && response.headers.forEach) {
+            response.headers.forEach((v, k) => _headers[k] = v);
+        }
+        ;
+        if (status === 204) {
+            return response.text().then((_responseText) => {
+                return;
+            });
+        }
+        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 !== 200 && status !== 204) {
+            return response.text().then((_responseText) => {
+                return throwException("An unexpected server error occurred.", status, _responseText, _headers);
+            });
+        }
+        return Promise.resolve(null);
+    }
     /**
      * Get the API version
      * @return Returns the API version
@@ -8130,9 +8290,6 @@ export class PreIPOCompanySPV {
             this.remainingDollarAllocation = _data["remainingDollarAllocation"];
             this.remainingShareAllocation = _data["remainingShareAllocation"];
             this.preFundedInventory = _data["preFundedInventory"];
-            this.totalCommission = _data["totalCommission"];
-            this.monarkCommissionSplit = _data["monarkCommissionSplit"];
-            this.demandSideCommissionSplit = _data["demandSideCommissionSplit"];
             this.investorPricePerShare = _data["investorPricePerShare"];
             this.investorFeePerShare = _data["investorFeePerShare"];
             this.allInPricePerShare = _data["allInPricePerShare"];
@@ -8193,9 +8350,6 @@ export class PreIPOCompanySPV {
         data["remainingDollarAllocation"] = this.remainingDollarAllocation;
         data["remainingShareAllocation"] = this.remainingShareAllocation;
         data["preFundedInventory"] = this.preFundedInventory;
-        data["totalCommission"] = this.totalCommission;
-        data["monarkCommissionSplit"] = this.monarkCommissionSplit;
-        data["demandSideCommissionSplit"] = this.demandSideCommissionSplit;
         data["investorPricePerShare"] = this.investorPricePerShare;
         data["investorFeePerShare"] = this.investorFeePerShare;
         data["allInPricePerShare"] = this.allInPricePerShare;
@@ -8724,6 +8878,48 @@ export class RegisteredFundSubscription {
         return data;
     }
 }
+export class RegisteredFundSubscriptionAction {
+    constructor(data) {
+        if (data) {
+            for (var property in data) {
+                if (data.hasOwnProperty(property))
+                    this[property] = data[property];
+            }
+        }
+    }
+    init(_data) {
+        if (_data) {
+            this.id = _data["id"];
+            this.registeredFundSubscriptionId = _data["registeredFundSubscriptionId"];
+            this.name = _data["name"];
+            this.description = _data["description"];
+            this.dataId = _data["dataId"];
+            this.status = _data["status"];
+            this.type = _data["type"];
+            this.responsibleParty = _data["responsibleParty"];
+            this.actionText = _data["actionText"];
+        }
+    }
+    static fromJS(data) {
+        data = typeof data === 'object' ? data : {};
+        let result = new RegisteredFundSubscriptionAction();
+        result.init(data);
+        return result;
+    }
+    toJSON(data) {
+        data = typeof data === 'object' ? data : {};
+        data["id"] = this.id;
+        data["registeredFundSubscriptionId"] = this.registeredFundSubscriptionId;
+        data["name"] = this.name;
+        data["description"] = this.description;
+        data["dataId"] = this.dataId;
+        data["status"] = this.status;
+        data["type"] = this.type;
+        data["responsibleParty"] = this.responsibleParty;
+        data["actionText"] = this.actionText;
+        return data;
+    }
+}
 export class RegisteredFundSubscriptionApiResponse {
     constructor(data) {
         if (data) {
@@ -9698,6 +9894,13 @@ export var SortOrder15;
     SortOrder15["Ascending"] = "Ascending";
     SortOrder15["Descending"] = "Descending";
 })(SortOrder15 || (SortOrder15 = {}));
+export var ResponsibleParty;
+(function (ResponsibleParty) {
+    ResponsibleParty["Partner"] = "Partner";
+    ResponsibleParty["Monark"] = "Monark";
+    ResponsibleParty["Investor"] = "Investor";
+    ResponsibleParty["Advisor"] = "Advisor";
+})(ResponsibleParty || (ResponsibleParty = {}));
 export var SortOrder16;
 (function (SortOrder16) {
     SortOrder16["Ascending"] = "Ascending";
@@ -9939,6 +10142,8 @@ export var InvestorSubscriptionActionResponsibleParty;
 (function (InvestorSubscriptionActionResponsibleParty) {
     InvestorSubscriptionActionResponsibleParty["Partner"] = "Partner";
     InvestorSubscriptionActionResponsibleParty["Monark"] = "Monark";
+    InvestorSubscriptionActionResponsibleParty["Investor"] = "Investor";
+    InvestorSubscriptionActionResponsibleParty["Advisor"] = "Advisor";
 })(InvestorSubscriptionActionResponsibleParty || (InvestorSubscriptionActionResponsibleParty = {}));
 export var LayeredSPVFundStructure;
 (function (LayeredSPVFundStructure) {
@@ -10130,6 +10335,28 @@ export var RegisteredFundSubscriptionStatus;
     RegisteredFundSubscriptionStatus["InvestorSigned"] = "InvestorSigned";
     RegisteredFundSubscriptionStatus["AdvisorSigned"] = "AdvisorSigned";
 })(RegisteredFundSubscriptionStatus || (RegisteredFundSubscriptionStatus = {}));
+export var RegisteredFundSubscriptionActionStatus;
+(function (RegisteredFundSubscriptionActionStatus) {
+    RegisteredFundSubscriptionActionStatus["Pending"] = "Pending";
+    RegisteredFundSubscriptionActionStatus["Complete"] = "Complete";
+})(RegisteredFundSubscriptionActionStatus || (RegisteredFundSubscriptionActionStatus = {}));
+export var RegisteredFundSubscriptionActionType;
+(function (RegisteredFundSubscriptionActionType) {
+    RegisteredFundSubscriptionActionType["Other"] = "Other";
+    RegisteredFundSubscriptionActionType["DocumentSign"] = "DocumentSign";
+    RegisteredFundSubscriptionActionType["DocumentAcknowledge"] = "DocumentAcknowledge";
+    RegisteredFundSubscriptionActionType["CashMovement"] = "CashMovement";
+    RegisteredFundSubscriptionActionType["ApiCall"] = "ApiCall";
+    RegisteredFundSubscriptionActionType["TextAcknowledge"] = "TextAcknowledge";
+    RegisteredFundSubscriptionActionType["KYCAML"] = "KYCAML";
+})(RegisteredFundSubscriptionActionType || (RegisteredFundSubscriptionActionType = {}));
+export var RegisteredFundSubscriptionActionResponsibleParty;
+(function (RegisteredFundSubscriptionActionResponsibleParty) {
+    RegisteredFundSubscriptionActionResponsibleParty["Partner"] = "Partner";
+    RegisteredFundSubscriptionActionResponsibleParty["Monark"] = "Monark";
+    RegisteredFundSubscriptionActionResponsibleParty["Investor"] = "Investor";
+    RegisteredFundSubscriptionActionResponsibleParty["Advisor"] = "Advisor";
+})(RegisteredFundSubscriptionActionResponsibleParty || (RegisteredFundSubscriptionActionResponsibleParty = {}));
 export var UpdateEntityInvestorEntityType;
 (function (UpdateEntityInvestorEntityType) {
     UpdateEntityInvestorEntityType["SOLE_PROPRIETOR"] = "SOLE_PROPRIETOR";

package/package.json

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