@monarkmarkets/api-client 1.2.21 → 1.3.1

package/dist/Client.d.ts

@@ -55,21 +55,21 @@ export declare class Client {
     downloadDocument(id: string, token: string): Promise<void>;
     protected processDownloadDocument(response: Response): Promise<void>;
     /**
-     * Create a Financial Advisor in the primary offering.
+     * Create a Financial Advisor.
      * @param body (optional) create Financial Advisor information.
      * @return The newly created Financial Advisor.
      */
     createFinancialAdvisor(body: CreateFinancialAdvisor | undefined): Promise<FinancialAdvisor>;
     protected processCreateFinancialAdvisor(response: Response): Promise<FinancialAdvisor>;
     /**
-     * Update an entire Financial Advisor in the primary offering.
+     * Update a Financial Advisor.
      * @param body (optional) update Financial Advisor information.
      * @return The updated Financial Advisor.
      */
     updateFinancialAdvisor(body: UpdateFinancialAdvisor | undefined): Promise<FinancialAdvisor>;
     protected processUpdateFinancialAdvisor(response: Response): Promise<FinancialAdvisor>;
     /**
-     * Get all Financial Advisors for the authenticated partner's financial institutions.
+     * Get all Financial Advisors.
      * @param page (optional) Number of the page to retrieve.
     Defaults to 1 if not specified.
      * @param pageSize (optional) Size of the page to retrieve.
@@ -81,7 +81,7 @@ export declare class Client {
     getAllFinancialAdvisors(page: number | undefined, pageSize: number | undefined, sortOrder: SortOrder2 | undefined, financialInstitutionId: string | undefined): Promise<FinancialAdvisorApiResponse>;
     protected processGetAllFinancialAdvisors(response: Response): Promise<FinancialAdvisorApiResponse>;
     /**
-     * Get the Financial Advisor by the specified Id.
+     * Get a Financial Advisor by Id.
      * @param id Id of the Financial Advisor to find.
      * @return Returns the Financial Advisor with the specified Id.
      */
@@ -745,6 +745,28 @@ export declare class Client {
      */
     getAllPreIPOCompanySPVs(investorId: string, monarkStage: MonarkStage | undefined, exemptionsClaimed: ExemptionsClaimed[] | undefined, nameFilter: string | undefined, preIPOCompanyId: string | undefined, preIPOCompanyInvestmentId: string | undefined, isApproved: boolean | undefined, page: number | undefined, pageSize: number | undefined, sortOrder: SortOrder12 | undefined, sortBy: SortBy2 | undefined): Promise<PreIPOCompanySPVApiResponse>;
     protected processGetAllPreIPOCompanySPVs(response: Response): Promise<PreIPOCompanySPVApiResponse>;
+    /**
+     * Gets all Financial Institutions that have access to a specific SPV
+     * @param spvId ID of the SPV to find Financial Institutions for
+     * @param page (optional) Number of the page to retrieve.
+    Defaults to 1 if not specified.
+     * @param pageSize (optional) Size of the page to retrieve.
+    Defaults to 25 if not specified.
+     * @return Returns the list of Financial Institutions
+     */
+    getFinancialInstitutionsForSPV(spvId: string, page: number | undefined, pageSize: number | undefined): Promise<FinancialInstitutionApiResponse>;
+    protected processGetFinancialInstitutionsForSPV(response: Response): Promise<FinancialInstitutionApiResponse>;
+    /**
+     * Gets all SPVs that a Financial Institution has access to
+     * @param financialInstitutionId ID of the Financial Institution
+     * @param page (optional) Number of the page to retrieve.
+    Defaults to 1 if not specified.
+     * @param pageSize (optional) Size of the page to retrieve.
+    Defaults to 25 if not specified.
+     * @return Returns the list of SPVs
+     */
+    getSPVsForFinancialInstitution(financialInstitutionId: string, page: number | undefined, pageSize: number | undefined): Promise<PreIPOCompanySPV[]>;
+    protected processGetSPVsForFinancialInstitution(response: Response): Promise<PreIPOCompanySPV[]>;
     /**
      * Gets all SPVs that have been approved.
      * @param page (optional) Number of the page to retrieve.
@@ -795,14 +817,16 @@ export declare class Client {
     getAllPartnerSpvApprovals(page: number | undefined, pageSize: number | undefined, sortOrder: SortOrder13 | undefined): Promise<PreIPOCompanySPVPartnerApprovalApiResponse>;
     protected processGetAllPartnerSpvApprovals(response: Response): Promise<PreIPOCompanySPVPartnerApprovalApiResponse>;
     /**
-     * @param body (optional)
-     * @return Created
+     * Create a Questionnaire.
+     * @param body (optional) Payload describing the questionnaire to create.
+     * @return Returns the created questionnaire.
      */
     createQuestionnaire(body: CreateQuestionnaire | undefined): Promise<Questionnaire>;
     protected processCreateQuestionnaire(response: Response): Promise<Questionnaire>;
     /**
-     * @param body (optional)
-     * @return OK
+     * Update a Questionnaire.
+     * @param body (optional) Payload containing questionnaire updates.
+     * @return Returns the updated questionnaire.
      */
     updateQuestionnaire(body: UpdateQuestionnaire | undefined): Promise<Questionnaire>;
     protected processUpdateQuestionnaire(response: Response): Promise<Questionnaire>;
@@ -818,7 +842,9 @@ export declare class Client {
     getAllQuestionnaires(page: number | undefined, pageSize: number | undefined, sortOrder: SortOrder14 | undefined): Promise<QuestionnaireApiResponse>;
     protected processGetAllQuestionnaires(response: Response): Promise<QuestionnaireApiResponse>;
     /**
-     * @return No Content
+     * Delete a Questionnaire.
+     * @param id Identifier of the questionnaire to remove.
+     * @return Questionnaire deleted successfully.
      */
     deleteQuestionnaire(id: string): Promise<void>;
     protected processDeleteQuestionnaire(response: Response): Promise<void>;
@@ -7817,13 +7843,9 @@ export declare enum InvestorSubscriptionActionStatus {
     Complete = "Complete"
 }
 export declare enum InvestorSubscriptionActionType {
-    Other = "Other",
     DocumentSign = "DocumentSign",
     DocumentAcknowledge = "DocumentAcknowledge",
-    CashMovement = "CashMovement",
-    ApiCall = "ApiCall",
-    TextAcknowledge = "TextAcknowledge",
-    KYCAML = "KYCAML"
+    TextAcknowledge = "TextAcknowledge"
 }
 export declare enum InvestorSubscriptionActionResponsibleParty {
     Partner = "Partner",
@@ -8234,13 +8256,9 @@ export declare enum RegisteredFundSubscriptionActionStatus {
     Complete = "Complete"
 }
 export declare enum RegisteredFundSubscriptionActionType {
-    Other = "Other",
     DocumentSign = "DocumentSign",
     DocumentAcknowledge = "DocumentAcknowledge",
-    CashMovement = "CashMovement",
-    ApiCall = "ApiCall",
-    TextAcknowledge = "TextAcknowledge",
-    KYCAML = "KYCAML"
+    TextAcknowledge = "TextAcknowledge"
 }
 export declare enum RegisteredFundSubscriptionActionResponsibleParty {
     Partner = "Partner",

package/dist/Client.js

@@ -329,7 +329,7 @@ export class Client {
         return Promise.resolve(null);
     }
     /**
-     * Create a Financial Advisor in the primary offering.
+     * Create a Financial Advisor.
      * @param body (optional) create Financial Advisor information.
      * @return The newly created Financial Advisor.
      */
@@ -380,7 +380,7 @@ export class Client {
         return Promise.resolve(null);
     }
     /**
-     * Update an entire Financial Advisor in the primary offering.
+     * Update a Financial Advisor.
      * @param body (optional) update Financial Advisor information.
      * @return The updated Financial Advisor.
      */
@@ -431,7 +431,7 @@ export class Client {
         return Promise.resolve(null);
     }
     /**
-     * Get all Financial Advisors for the authenticated partner's financial institutions.
+     * Get all Financial Advisors.
      * @param page (optional) Number of the page to retrieve.
     Defaults to 1 if not specified.
      * @param pageSize (optional) Size of the page to retrieve.
@@ -492,7 +492,7 @@ export class Client {
         return Promise.resolve(null);
     }
     /**
-     * Get the Financial Advisor by the specified Id.
+     * Get a Financial Advisor by Id.
      * @param id Id of the Financial Advisor to find.
      * @return Returns the Financial Advisor with the specified Id.
      */
@@ -4916,6 +4916,139 @@ export class Client {
         }
         return Promise.resolve(null);
     }
+    /**
+     * Gets all Financial Institutions that have access to a specific SPV
+     * @param spvId ID of the SPV to find Financial Institutions for
+     * @param page (optional) Number of the page to retrieve.
+    Defaults to 1 if not specified.
+     * @param pageSize (optional) Size of the page to retrieve.
+    Defaults to 25 if not specified.
+     * @return Returns the list of Financial Institutions
+     */
+    getFinancialInstitutionsForSPV(spvId, page, pageSize) {
+        let url_ = this.baseUrl + "/primary/v1/pre-ipo-company-spv/{spvId}/financial-institutions?";
+        if (spvId === undefined || spvId === null)
+            throw new Error("The parameter 'spvId' must be defined.");
+        url_ = url_.replace("{spvId}", encodeURIComponent("" + spvId));
+        if (page === null)
+            throw new Error("The parameter 'page' cannot be null.");
+        else if (page !== undefined)
+            url_ += "page=" + encodeURIComponent("" + page) + "&";
+        if (pageSize === null)
+            throw new Error("The parameter 'pageSize' cannot be null.");
+        else if (pageSize !== undefined)
+            url_ += "pageSize=" + encodeURIComponent("" + pageSize) + "&";
+        url_ = url_.replace(/[?&]$/, "");
+        let options_ = {
+            method: "GET",
+            headers: {
+                "Accept": "application/json"
+            }
+        };
+        return this.http.fetch(url_, options_).then((_response) => {
+            return this.processGetFinancialInstitutionsForSPV(_response);
+        });
+    }
+    processGetFinancialInstitutionsForSPV(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 = FinancialInstitutionApiResponse.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("SPV 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);
+    }
+    /**
+     * Gets all SPVs that a Financial Institution has access to
+     * @param financialInstitutionId ID of the Financial Institution
+     * @param page (optional) Number of the page to retrieve.
+    Defaults to 1 if not specified.
+     * @param pageSize (optional) Size of the page to retrieve.
+    Defaults to 25 if not specified.
+     * @return Returns the list of SPVs
+     */
+    getSPVsForFinancialInstitution(financialInstitutionId, page, pageSize) {
+        let url_ = this.baseUrl + "/primary/v1/pre-ipo-company-spv/financial-institution/{financialInstitutionId}/spvs?";
+        if (financialInstitutionId === undefined || financialInstitutionId === null)
+            throw new Error("The parameter 'financialInstitutionId' must be defined.");
+        url_ = url_.replace("{financialInstitutionId}", encodeURIComponent("" + financialInstitutionId));
+        if (page === null)
+            throw new Error("The parameter 'page' cannot be null.");
+        else if (page !== undefined)
+            url_ += "page=" + encodeURIComponent("" + page) + "&";
+        if (pageSize === null)
+            throw new Error("The parameter 'pageSize' cannot be null.");
+        else if (pageSize !== undefined)
+            url_ += "pageSize=" + encodeURIComponent("" + pageSize) + "&";
+        url_ = url_.replace(/[?&]$/, "");
+        let options_ = {
+            method: "GET",
+            headers: {
+                "Accept": "application/json"
+            }
+        };
+        return this.http.fetch(url_, options_).then((_response) => {
+            return this.processGetSPVsForFinancialInstitution(_response);
+        });
+    }
+    processGetSPVsForFinancialInstitution(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(PreIPOCompanySPV.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("Financial Institution 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);
+    }
     /**
      * Gets all SPVs that have been approved.
      * @param page (optional) Number of the page to retrieve.
@@ -5247,8 +5380,9 @@ export class Client {
         return Promise.resolve(null);
     }
     /**
-     * @param body (optional)
-     * @return Created
+     * Create a Questionnaire.
+     * @param body (optional) Payload describing the questionnaire to create.
+     * @return Returns the created questionnaire.
      */
     createQuestionnaire(body) {
         let url_ = this.baseUrl + "/primary/v1/questionnaire";
@@ -5286,7 +5420,7 @@ export class Client {
                 let result400 = null;
                 let resultData400 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
                 result400 = ProblemDetails.fromJS(resultData400);
-                return throwException("Bad Request", status, _responseText, _headers, result400);
+                return throwException("Validation failed for the payload.", status, _responseText, _headers, result400);
             });
         }
         else if (status !== 200 && status !== 204) {
@@ -5297,8 +5431,9 @@ export class Client {
         return Promise.resolve(null);
     }
     /**
-     * @param body (optional)
-     * @return OK
+     * Update a Questionnaire.
+     * @param body (optional) Payload containing questionnaire updates.
+     * @return Returns the updated questionnaire.
      */
     updateQuestionnaire(body) {
         let url_ = this.baseUrl + "/primary/v1/questionnaire";
@@ -5336,7 +5471,7 @@ export class Client {
                 let result400 = null;
                 let resultData400 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
                 result400 = ProblemDetails.fromJS(resultData400);
-                return throwException("Bad Request", status, _responseText, _headers, result400);
+                return throwException("Validation failed for the payload.", status, _responseText, _headers, result400);
             });
         }
         else if (status === 404) {
@@ -5344,7 +5479,7 @@ export class Client {
                 let result404 = null;
                 let resultData404 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
                 result404 = ProblemDetails.fromJS(resultData404);
-                return throwException("Not Found", status, _responseText, _headers, result404);
+                return throwException("Questionnaire not found.", status, _responseText, _headers, result404);
             });
         }
         else if (status !== 200 && status !== 204) {
@@ -5427,7 +5562,9 @@ export class Client {
         return Promise.resolve(null);
     }
     /**
-     * @return No Content
+     * Delete a Questionnaire.
+     * @param id Identifier of the questionnaire to remove.
+     * @return Questionnaire deleted successfully.
      */
     deleteQuestionnaire(id) {
         let url_ = this.baseUrl + "/primary/v1/questionnaire/{id}";
@@ -5460,7 +5597,7 @@ export class Client {
                 let result404 = null;
                 let resultData404 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
                 result404 = ProblemDetails.fromJS(resultData404);
-                return throwException("Not Found", status, _responseText, _headers, result404);
+                return throwException("Questionnaire not found.", status, _responseText, _headers, result404);
             });
         }
         else if (status !== 200 && status !== 204) {
@@ -14672,13 +14809,9 @@ export var InvestorSubscriptionActionStatus;
 })(InvestorSubscriptionActionStatus || (InvestorSubscriptionActionStatus = {}));
 export var InvestorSubscriptionActionType;
 (function (InvestorSubscriptionActionType) {
-    InvestorSubscriptionActionType["Other"] = "Other";
     InvestorSubscriptionActionType["DocumentSign"] = "DocumentSign";
     InvestorSubscriptionActionType["DocumentAcknowledge"] = "DocumentAcknowledge";
-    InvestorSubscriptionActionType["CashMovement"] = "CashMovement";
-    InvestorSubscriptionActionType["ApiCall"] = "ApiCall";
     InvestorSubscriptionActionType["TextAcknowledge"] = "TextAcknowledge";
-    InvestorSubscriptionActionType["KYCAML"] = "KYCAML";
 })(InvestorSubscriptionActionType || (InvestorSubscriptionActionType = {}));
 export var InvestorSubscriptionActionResponsibleParty;
 (function (InvestorSubscriptionActionResponsibleParty) {
@@ -15125,13 +15258,9 @@ export var RegisteredFundSubscriptionActionStatus;
 })(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) {

package/package.json

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