@monarkmarkets/api-client 1.1.124 → 1.1.125

package/dist/Client.d.ts

@@ -25,7 +25,8 @@ export declare class Client {
      * @param preIPOCompanySPVId (optional) PreIPOCompanySPVId to filter by.
      * @param preIPOCompanyInvestmentId (optional) PreIPOCompanyInvestmentId to filter by.
      * @param investorSubscriptionId (optional) InvestorSubscriptionId to filter by.
-     * @param registeredFundId (optional)
+     * @param registeredFundId (optional) RegisteredFundId to filter by.
+     * @param registeredFundSubscriptionId (optional) RegisteredFundSubscriptionId to filter by.
      * @param documentType (optional) Type of document to filter by.
      * @param exactMatch (optional) Only returns the items exactly matching the parameters given.
      * @param page (optional) Page number for pagination.
@@ -33,7 +34,7 @@ export declare class Client {
      * @param sortOrder (optional)
      * @return OK
      */
-    document2(investorId: string | undefined, preIPOCompanyId: string | undefined, preIPOCompanySPVId: string | undefined, preIPOCompanyInvestmentId: string | undefined, investorSubscriptionId: string | undefined, registeredFundId: string | undefined, documentType: DocumentType | undefined, exactMatch: boolean | undefined, page: number | undefined, pageSize: number | undefined, sortOrder: SortOrder | undefined): Promise<DocumentApiResponse>;
+    document2(investorId: string | undefined, preIPOCompanyId: string | undefined, preIPOCompanySPVId: string | undefined, preIPOCompanyInvestmentId: string | undefined, investorSubscriptionId: string | undefined, registeredFundId: string | undefined, registeredFundSubscriptionId: string | undefined, documentType: DocumentType | undefined, exactMatch: boolean | undefined, page: number | undefined, pageSize: number | undefined, sortOrder: SortOrder | undefined): Promise<DocumentApiResponse>;
     protected processDocument2(response: Response): Promise<DocumentApiResponse>;
     /**
      * Signs a document by a document ID.
@@ -90,13 +91,21 @@ export declare class Client {
     protected processFinancialInstitution(response: Response): Promise<FinancialInstitution>;
     /**
      * Get all Financial Institutions
+     * @param referenceId (optional) Optional reference Id to filter by.
      * @param page (optional)
      * @param pageSize (optional)
      * @param sortOrder (optional)
      * @return OK
      */
-    financialInstitution2(page: number | undefined, pageSize: number | undefined, sortOrder: SortOrder3 | undefined): Promise<FinancialInstitutionApiResponse>;
+    financialInstitution2(referenceId: string | undefined, page: number | undefined, pageSize: number | undefined, sortOrder: SortOrder3 | undefined): Promise<FinancialInstitutionApiResponse>;
     protected processFinancialInstitution2(response: Response): Promise<FinancialInstitutionApiResponse>;
+    /**
+     * Update an Financial Institution's Reference ID.
+     * @param body (optional) The request containing the updated reference information.
+     * @return No Content
+     */
+    reference(body: UpdateFinancialInstitutionReferenceId | undefined): Promise<void>;
+    protected processReference(response: Response): Promise<void>;
     /**
      * Create an Indication of Interest
      * @param body (optional) create IndicationOfInterest information.
@@ -227,12 +236,13 @@ export declare class Client {
      * @param preIPOCompanyName (optional) Optional Company Name to filter on.
      * @param preIPOCompanySPVName (optional) Optional SPV Name to filter on.
      * @param tradingSymbol (optional) Optional Trading Symbol to filter on.
+     * @param orderReferenceId (optional)
      * @param page (optional)
      * @param pageSize (optional)
      * @param sortOrder (optional)
      * @return OK
      */
-    investorSubscriptionGET(preIpoCompanySpvId: string | undefined, investorId: string | undefined, status: Status | undefined, preIPOCompanyName: string | undefined, preIPOCompanySPVName: string | undefined, tradingSymbol: string | undefined, page: number | undefined, pageSize: number | undefined, sortOrder: SortOrder6 | undefined): Promise<InvestorSubscriptionApiResponse>;
+    investorSubscriptionGET(preIpoCompanySpvId: string | undefined, investorId: string | undefined, status: Status | undefined, preIPOCompanyName: string | undefined, preIPOCompanySPVName: string | undefined, tradingSymbol: string | undefined, orderReferenceId: string | undefined, page: number | undefined, pageSize: number | undefined, sortOrder: SortOrder6 | undefined): Promise<InvestorSubscriptionApiResponse>;
     protected processInvestorSubscriptionGET(response: Response): Promise<InvestorSubscriptionApiResponse>;
     /**
      * Update an InvestorSubscription.
@@ -553,15 +563,18 @@ export declare class Client {
     preIpoCompany2(searchTerm: string | undefined, searchCategories: string[] | undefined, sortBy: SortBy | undefined, sortOrder: SortOrder7 | undefined, minLastValuation: number | undefined, maxLastValuation: number | undefined, minTotalFunding: number | undefined, maxTotalFunding: number | undefined, listingType: string | undefined, isActive: boolean | undefined, page: number | undefined, pageSize: number | undefined): Promise<PreIPOCompanyApiResponse>;
     protected processPreIpoCompany2(response: Response): Promise<PreIPOCompanyApiResponse>;
     /**
-     * Get all PreIPOCompanies with extra details.
-     * @param includes (optional) List of elements to include in the result.
+     * Retrieves a paginated list of detailed PreIPOCompanies with optional filters and includes.
+    Includes More detail such as News, Research, Investments, Spv's and Funding Rounds.
+     * @param filterId (optional) Optional filter ID to narrow down the PreIPOCompanies.
+     * @param filterBy (optional) Optional filter type to categorize the PreIPOCompanies (e.g., Company, Investment, Spv).
+     * @param includes (optional) Optional list of additional data to include with the response (e.g., News, Research, Investments).
      * @param listingType (optional) Optional listing status filter.
      * @param isActive (optional) Optional active state filter.
-     * @param page (optional) Which page number to return.
-     * @param pageSize (optional) The maximum number of items to return in each page, defaults to 25.
-     * @return OK
+     * @param page (optional) Page number for pagination, starting from 1.
+     * @param pageSize (optional) Number of items per page for pagination, Default = 25.
+     * @return Returns the filtered and paginated list of detailed PreIPOCompanies.
      */
-    detailed(includes: Includes[] | undefined, listingType: string | undefined, isActive: boolean | undefined, page: number | undefined, pageSize: number | undefined): Promise<BulkPreIPOCompanyApiResponse>;
+    detailed(filterId: string | undefined, filterBy: FilterBy | undefined, includes: Includes[] | undefined, listingType: string | undefined, isActive: boolean | undefined, page: number | undefined, pageSize: number | undefined): Promise<BulkPreIPOCompanyApiResponse>;
     protected processDetailed(response: Response): Promise<BulkPreIPOCompanyApiResponse>;
     /**
      * Get the PreIPOCompanyFundingRound by the specified Id.
@@ -898,7 +911,7 @@ export declare class BulkPreIPOCompany implements IBulkPreIPOCompany {
     /** Type of entity of the PreIPOCompany. */
     type?: BulkPreIPOCompanyType;
     /** The year the PreIPOCompany was established. */
-    yearEst?: Date | undefined;
+    yearEst?: number | undefined;
     /** The number of employees at the PreIPO Company. */
     numJobs?: number | undefined;
     /** Short description of the PreIPOCompany. */
@@ -981,7 +994,7 @@ export interface IBulkPreIPOCompany {
     /** Type of entity of the PreIPOCompany. */
     type?: BulkPreIPOCompanyType;
     /** The year the PreIPOCompany was established. */
-    yearEst?: Date | undefined;
+    yearEst?: number | undefined;
     /** The number of employees at the PreIPO Company. */
     numJobs?: number | undefined;
     /** Short description of the PreIPOCompany. */
@@ -1085,7 +1098,7 @@ export declare class BulkPreIPOCompanySPV implements IBulkPreIPOCompanySPV {
     exemptionsClaimed?: exemptionsClaimed[] | undefined;
     /** The stage that an SPV is in. Refer to the “SPV Status Transitions” page in our Guides for a detailed description of each stage. */
     monarkStage: BulkPreIPOCompanySPVMonarkStage;
-    /** CUSIP assigned to the SPV. Monark acquires and assigns the CUSIP after the first trade has been executed through our ATS. */
+    /** CUSIP assigned to the SPV. */
     cusip?: string | undefined;
     /** Symbol assigned to the SPV. This symbol is created and assigned to the SPV upon its creation. See the [Symbology guide](https://api-docs.monark-markets.com/docs/symbology) for a more detailed description of how symbols are generated. */
     tradingSymbol?: string | undefined;
@@ -1163,7 +1176,7 @@ export interface IBulkPreIPOCompanySPV {
     exemptionsClaimed?: exemptionsClaimed[] | undefined;
     /** The stage that an SPV is in. Refer to the “SPV Status Transitions” page in our Guides for a detailed description of each stage. */
     monarkStage: BulkPreIPOCompanySPVMonarkStage;
-    /** CUSIP assigned to the SPV. Monark acquires and assigns the CUSIP after the first trade has been executed through our ATS. */
+    /** CUSIP assigned to the SPV. */
     cusip?: string | undefined;
     /** Symbol assigned to the SPV. This symbol is created and assigned to the SPV upon its creation. See the [Symbology guide](https://api-docs.monark-markets.com/docs/symbology) for a more detailed description of how symbols are generated. */
     tradingSymbol?: string | undefined;
@@ -1383,6 +1396,8 @@ export declare class CreateInvestorSubscription implements ICreateInvestorSubscr
     investorId: string;
     /** Describes the amount, in dollars, an Investor intends to invest into an SPV. */
     amountReservedDollars: number;
+    /** The reference ID of an order submitted. */
+    orderReferenceId?: string | undefined;
     constructor(data?: ICreateInvestorSubscription);
     init(_data?: any): void;
     static fromJS(data: any): CreateInvestorSubscription;
@@ -1395,6 +1410,8 @@ export interface ICreateInvestorSubscription {
     investorId: string;
     /** Describes the amount, in dollars, an Investor intends to invest into an SPV. */
     amountReservedDollars: number;
+    /** The reference ID of an order submitted. */
+    orderReferenceId?: string | undefined;
 }
 /** Create Questionnaire allows the creation of a questionaire with the primary offerring. */
 export declare class CreateQuestionnaire implements ICreateQuestionnaire {
@@ -1568,6 +1585,8 @@ export declare class Document implements IDocument {
     partnerId?: string | undefined;
     /** Unique identifier of the registered fund, if any. */
     registeredFundId?: string | undefined;
+    /** Unique identifier of the registered fund subscription, if any. */
+    registeredFundSubscriptionId?: string | undefined;
     /** The type of Document. */
     type?: DocumentType2;
     /** Boolean value to dictate if this is a template. */
@@ -1603,6 +1622,8 @@ export interface IDocument {
     partnerId?: string | undefined;
     /** Unique identifier of the registered fund, if any. */
     registeredFundId?: string | undefined;
+    /** Unique identifier of the registered fund subscription, if any. */
+    registeredFundSubscriptionId?: string | undefined;
     /** The type of Document. */
     type?: DocumentType2;
     /** Boolean value to dictate if this is a template. */
@@ -1864,6 +1885,8 @@ See https://github.com/country-regions/country-region-data/blob/master/data.json
     updatedAt?: Date;
     /** The linked Partner. */
     partner?: Partner | undefined;
+    /** Optional reference field for this Financial Institution. */
+    financialInstitutionReferenceId?: string | undefined;
     constructor(data?: IFinancialInstitution);
     init(_data?: any): void;
     static fromJS(data: any): FinancialInstitution;
@@ -1899,6 +1922,8 @@ See https://github.com/country-regions/country-region-data/blob/master/data.json
     updatedAt?: Date;
     /** The linked Partner. */
     partner?: Partner | undefined;
+    /** Optional reference field for this Financial Institution. */
+    financialInstitutionReferenceId?: string | undefined;
 }
 export declare class FinancialInstitutionApiResponse implements IFinancialInstitutionApiResponse {
     items?: FinancialInstitution[] | undefined;
@@ -2106,9 +2131,9 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
     isSubscriptionAdvisorOrERA?: boolean;
     /** Email address associated with an Investor. */
     email: string | undefined;
-    /** Investor’s Social Security Number. */
+    /** Investor's Social Security Number if `isUsBased` is true. Follow SSN format (XXX-XX-XXXX). If `isUsBased` is false, please provide the relevant tax id number. No formatting validation applies if `isUsBased` is false. */
     taxId: string | undefined;
-    /** Investor Passport Number. - Only Required for Non-US Investors. */
+    /** Investor Passport Number. Pass "N/A" if there is no `passportNumber`. */
     passportNumber?: string | undefined;
     /** Country code of the Investor’s citizenship. Check https://github.com/country-regions/country-region-data/blob/master/data.json for valid country codes */
     citizenship: string | undefined;
@@ -2118,6 +2143,8 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
     entityInvestorType?: IndividualEntityInvestorEntityInvestorType;
     /** The percentage of the entity owned by the investor. */
     percentageOwned?: number;
+    /** Represents the title of the individual investor. */
+    title?: string | undefined;
     /** Id of the individual investor. */
     id?: string;
     constructor(data?: IIndividualEntityInvestor);
@@ -2175,9 +2202,9 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
     isSubscriptionAdvisorOrERA?: boolean;
     /** Email address associated with an Investor. */
     email: string | undefined;
-    /** Investor’s Social Security Number. */
+    /** Investor's Social Security Number if `isUsBased` is true. Follow SSN format (XXX-XX-XXXX). If `isUsBased` is false, please provide the relevant tax id number. No formatting validation applies if `isUsBased` is false. */
     taxId: string | undefined;
-    /** Investor Passport Number. - Only Required for Non-US Investors. */
+    /** Investor Passport Number. Pass "N/A" if there is no `passportNumber`. */
     passportNumber?: string | undefined;
     /** Country code of the Investor’s citizenship. Check https://github.com/country-regions/country-region-data/blob/master/data.json for valid country codes */
     citizenship: string | undefined;
@@ -2187,6 +2214,8 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
     entityInvestorType?: IndividualEntityInvestorEntityInvestorType;
     /** The percentage of the entity owned by the investor. */
     percentageOwned?: number;
+    /** Represents the title of the individual investor. */
+    title?: string | undefined;
     /** Id of the individual investor. */
     id?: string;
 }
@@ -2240,9 +2269,9 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
     isSubscriptionAdvisorOrERA: boolean;
     /** Email address associated with an Investor. */
     email: string;
-    /** Investor’s Social Security Number. */
+    /** Investor's Social Security Number if `isUsBased` is true. Follow SSN format (XXX-XX-XXXX). If `isUsBased` is false, please provide the relevant tax id number. No formatting validation applies if `isUsBased` is false. */
     taxId: string | undefined;
-    /** Investor Passport Number. - Only Required for Non-US Investors. */
+    /** Investor Passport Number. Pass "N/A" if there is no `passportNumber`. */
     passportNumber?: string | undefined;
     /** Country code of the Investor’s citizenship. Check https://github.com/country-regions/country-region-data/blob/master/data.json for valid country codes */
     citizenship: string;
@@ -2252,6 +2281,8 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
     entityInvestorType?: IndividualEntityInvestorBaseEntityInvestorType;
     /** The percentage of the entity owned by the investor. */
     percentageOwned?: number;
+    /** Represents the title of the individual investor. */
+    title?: string | undefined;
     constructor(data?: IIndividualEntityInvestorBase);
     init(_data?: any): void;
     static fromJS(data: any): IndividualEntityInvestorBase;
@@ -2307,9 +2338,9 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
     isSubscriptionAdvisorOrERA: boolean;
     /** Email address associated with an Investor. */
     email: string;
-    /** Investor’s Social Security Number. */
+    /** Investor's Social Security Number if `isUsBased` is true. Follow SSN format (XXX-XX-XXXX). If `isUsBased` is false, please provide the relevant tax id number. No formatting validation applies if `isUsBased` is false. */
     taxId: string | undefined;
-    /** Investor Passport Number. - Only Required for Non-US Investors. */
+    /** Investor Passport Number. Pass "N/A" if there is no `passportNumber`. */
     passportNumber?: string | undefined;
     /** Country code of the Investor’s citizenship. Check https://github.com/country-regions/country-region-data/blob/master/data.json for valid country codes */
     citizenship: string;
@@ -2319,6 +2350,8 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
     entityInvestorType?: IndividualEntityInvestorBaseEntityInvestorType;
     /** The percentage of the entity owned by the investor. */
     percentageOwned?: number;
+    /** Represents the title of the individual investor. */
+    title?: string | undefined;
 }
 export declare class IndividualInvestor implements IIndividualInvestor {
     /** First name of the Investor. */
@@ -2370,9 +2403,9 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
     isSubscriptionAdvisorOrERA?: boolean;
     /** Email address associated with an Investor. */
     email: string | undefined;
-    /** Investor’s Social Security Number. */
+    /** Investor's Social Security Number if `isUsBased` is true. Follow SSN format (XXX-XX-XXXX). If `isUsBased` is false, please provide the relevant tax id number. No formatting validation applies if `isUsBased` is false. */
     taxId: string | undefined;
-    /** Investor Passport Number. - Only Required for Non-US Investors. */
+    /** Investor Passport Number. Pass "N/A" if there is no `passportNumber`. */
     passportNumber?: string | undefined;
     /** Country code of the Investor’s citizenship. Check https://github.com/country-regions/country-region-data/blob/master/data.json for valid country codes */
     citizenship: string | undefined;
@@ -2439,9 +2472,9 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
     isSubscriptionAdvisorOrERA?: boolean;
     /** Email address associated with an Investor. */
     email: string | undefined;
-    /** Investor’s Social Security Number. */
+    /** Investor's Social Security Number if `isUsBased` is true. Follow SSN format (XXX-XX-XXXX). If `isUsBased` is false, please provide the relevant tax id number. No formatting validation applies if `isUsBased` is false. */
     taxId: string | undefined;
-    /** Investor Passport Number. - Only Required for Non-US Investors. */
+    /** Investor Passport Number. Pass "N/A" if there is no `passportNumber`. */
     passportNumber?: string | undefined;
     /** Country code of the Investor’s citizenship. Check https://github.com/country-regions/country-region-data/blob/master/data.json for valid country codes */
     citizenship: string | undefined;
@@ -2810,9 +2843,9 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
     isSubscriptionAdvisorOrERA: boolean;
     /** Email address associated with an Investor. */
     email: string;
-    /** Investor’s Social Security Number. */
+    /** Investor's Social Security Number if `isUsBased` is true. Follow SSN format (XXX-XX-XXXX). If `isUsBased` is false, please provide the relevant tax id number. No formatting validation applies if `isUsBased` is false. */
     taxId: string | undefined;
-    /** Investor Passport Number. - Only Required for Non-US Investors. */
+    /** Investor Passport Number. Pass "N/A" if there is no `passportNumber`. */
     passportNumber?: string | undefined;
     /** Country code of the Investor’s citizenship. Check https://github.com/country-regions/country-region-data/blob/master/data.json for valid country codes */
     citizenship: string;
@@ -2873,9 +2906,9 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
     isSubscriptionAdvisorOrERA: boolean;
     /** Email address associated with an Investor. */
     email: string;
-    /** Investor’s Social Security Number. */
+    /** Investor's Social Security Number if `isUsBased` is true. Follow SSN format (XXX-XX-XXXX). If `isUsBased` is false, please provide the relevant tax id number. No formatting validation applies if `isUsBased` is false. */
     taxId: string | undefined;
-    /** Investor Passport Number. - Only Required for Non-US Investors. */
+    /** Investor Passport Number. Pass "N/A" if there is no `passportNumber`. */
     passportNumber?: string | undefined;
     /** Country code of the Investor’s citizenship. Check https://github.com/country-regions/country-region-data/blob/master/data.json for valid country codes */
     citizenship: string;
@@ -3569,7 +3602,7 @@ export declare class Partner implements IPartner {
     /** Legal Entity Name of the partner. */
     legalEntityName: string | undefined;
     /** Country code of the investor. */
-    countryCode: string | undefined;
+    countryCode?: string | undefined;
     /** Website of the Partner. */
     website?: string | undefined;
     /** Executive Team of the partner. */
@@ -3607,7 +3640,7 @@ export interface IPartner {
     /** Legal Entity Name of the partner. */
     legalEntityName: string | undefined;
     /** Country code of the investor. */
-    countryCode: string | undefined;
+    countryCode?: string | undefined;
     /** Website of the Partner. */
     website?: string | undefined;
     /** Executive Team of the partner. */
@@ -4067,7 +4100,7 @@ export declare class PreIPOCompany implements IPreIPOCompany {
     /** Type of entity of the PreIPOCompany. */
     type?: PreIPOCompanyType;
     /** The year the PreIPOCompany was established. */
-    yearEst?: Date | undefined;
+    yearEst?: number | undefined;
     /** The number of employees at the PreIPO Company. */
     numJobs?: number | undefined;
     /** Short description of the PreIPOCompany. */
@@ -4146,7 +4179,7 @@ export interface IPreIPOCompany {
     /** Type of entity of the PreIPOCompany. */
     type?: PreIPOCompanyType;
     /** The year the PreIPOCompany was established. */
-    yearEst?: Date | undefined;
+    yearEst?: number | undefined;
     /** The number of employees at the PreIPO Company. */
     numJobs?: number | undefined;
     /** Short description of the PreIPOCompany. */
@@ -4530,7 +4563,7 @@ export declare class PreIPOCompanySPV implements IPreIPOCompanySPV {
     exemptionsClaimed?: exemptionsClaimed2[] | undefined;
     /** The stage that an SPV is in. Refer to the “SPV Status Transitions” page in our Guides for a detailed description of each stage. */
     monarkStage: PreIPOCompanySPVMonarkStage;
-    /** CUSIP assigned to the SPV. Monark acquires and assigns the CUSIP after the first trade has been executed through our ATS. */
+    /** CUSIP assigned to the SPV. */
     cusip?: string | undefined;
     /** Symbol assigned to the SPV. This symbol is created and assigned to the SPV upon its creation. See the [Symbology guide](https://api-docs.monark-markets.com/docs/symbology) for a more detailed description of how symbols are generated. */
     tradingSymbol?: string | undefined;
@@ -4607,7 +4640,7 @@ export interface IPreIPOCompanySPV {
     exemptionsClaimed?: exemptionsClaimed2[] | undefined;
     /** The stage that an SPV is in. Refer to the “SPV Status Transitions” page in our Guides for a detailed description of each stage. */
     monarkStage: PreIPOCompanySPVMonarkStage;
-    /** CUSIP assigned to the SPV. Monark acquires and assigns the CUSIP after the first trade has been executed through our ATS. */
+    /** CUSIP assigned to the SPV. */
     cusip?: string | undefined;
     /** Symbol assigned to the SPV. This symbol is created and assigned to the SPV upon its creation. See the [Symbology guide](https://api-docs.monark-markets.com/docs/symbology) for a more detailed description of how symbols are generated. */
     tradingSymbol?: string | undefined;
@@ -5209,7 +5242,7 @@ export interface IShareDetail {
 /** Model for signing a document. */
 export declare class SignDocument implements ISignDocument {
     /** The investorId associated with the document. */
-    investorId?: string;
+    investorId: string;
     /** Metadata about the signing. */
     metadata?: string | undefined;
     constructor(data?: ISignDocument);
@@ -5220,7 +5253,7 @@ export declare class SignDocument implements ISignDocument {
 /** Model for signing a document. */
 export interface ISignDocument {
     /** The investorId associated with the document. */
-    investorId?: string;
+    investorId: string;
     /** Metadata about the signing. */
     metadata?: string | undefined;
 }
@@ -5438,6 +5471,22 @@ export interface IUpdateFinancialAdvisor {
     /** ID of the FinancialAdvisor to edit. */
     id?: string;
 }
+export declare class UpdateFinancialInstitutionReferenceId implements IUpdateFinancialInstitutionReferenceId {
+    /** ID of the FinancialInstitution to edit. */
+    financialInstitutionId?: string;
+    /** Reference field for the Financial Institution. */
+    financialInstitutionReferenceId?: string | undefined;
+    constructor(data?: IUpdateFinancialInstitutionReferenceId);
+    init(_data?: any): void;
+    static fromJS(data: any): UpdateFinancialInstitutionReferenceId;
+    toJSON(data?: any): any;
+}
+export interface IUpdateFinancialInstitutionReferenceId {
+    /** ID of the FinancialInstitution to edit. */
+    financialInstitutionId?: string;
+    /** Reference field for the Financial Institution. */
+    financialInstitutionReferenceId?: string | undefined;
+}
 /** IndicationOfInterest represents the primary offering information on the IoI. */
 export declare class UpdateIndicationOfInterest implements IUpdateIndicationOfInterest {
     /** Unique ID associated with an IOI. */
@@ -5518,9 +5567,9 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
     isSubscriptionAdvisorOrERA: boolean;
     /** Email address associated with an Investor. */
     email: string;
-    /** Investor’s Social Security Number. */
+    /** Investor's Social Security Number if `isUsBased` is true. Follow SSN format (XXX-XX-XXXX). If `isUsBased` is false, please provide the relevant tax id number. No formatting validation applies if `isUsBased` is false. */
     taxId: string | undefined;
-    /** Investor Passport Number. - Only Required for Non-US Investors. */
+    /** Investor Passport Number. Pass "N/A" if there is no `passportNumber`. */
     passportNumber?: string | undefined;
     /** Country code of the Investor’s citizenship. Check https://github.com/country-regions/country-region-data/blob/master/data.json for valid country codes */
     citizenship: string;
@@ -5530,6 +5579,8 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
     entityInvestorType?: UpdateIndividualEntityInvestorEntityInvestorType;
     /** The percentage of the entity owned by the investor. */
     percentageOwned?: number;
+    /** Represents the title of the individual investor. */
+    title?: string | undefined;
     /** Identifier for the individual investor. */
     id: string;
     constructor(data?: IUpdateIndividualEntityInvestor);
@@ -5587,9 +5638,9 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
     isSubscriptionAdvisorOrERA: boolean;
     /** Email address associated with an Investor. */
     email: string;
-    /** Investor’s Social Security Number. */
+    /** Investor's Social Security Number if `isUsBased` is true. Follow SSN format (XXX-XX-XXXX). If `isUsBased` is false, please provide the relevant tax id number. No formatting validation applies if `isUsBased` is false. */
     taxId: string | undefined;
-    /** Investor Passport Number. - Only Required for Non-US Investors. */
+    /** Investor Passport Number. Pass "N/A" if there is no `passportNumber`. */
     passportNumber?: string | undefined;
     /** Country code of the Investor’s citizenship. Check https://github.com/country-regions/country-region-data/blob/master/data.json for valid country codes */
     citizenship: string;
@@ -5599,6 +5650,8 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
     entityInvestorType?: UpdateIndividualEntityInvestorEntityInvestorType;
     /** The percentage of the entity owned by the investor. */
     percentageOwned?: number;
+    /** Represents the title of the individual investor. */
+    title?: string | undefined;
     /** Identifier for the individual investor. */
     id: string;
 }
@@ -5974,7 +6027,8 @@ export declare enum Status {
     Pending = "Pending",
     Processing = "Processing",
     Complete = "Complete",
-    Rejected = "Rejected"
+    Rejected = "Rejected",
+    Failed = "Failed"
 }
 export declare enum SortOrder6 {
     Ascending = "Ascending",
@@ -5990,6 +6044,11 @@ export declare enum SortOrder7 {
     Ascending = "Ascending",
     Descending = "Descending"
 }
+export declare enum FilterBy {
+    Company = "Company",
+    Investment = "Investment",
+    Spv = "Spv"
+}
 export declare enum Includes {
     News = "News",
     Research = "Research",
@@ -6366,7 +6425,8 @@ export declare enum InvestorSubscriptionStatus {
     Pending = "Pending",
     Processing = "Processing",
     Complete = "Complete",
-    Rejected = "Rejected"
+    Rejected = "Rejected",
+    Failed = "Failed"
 }
 export declare enum InvestorSubscriptionActionStatus {
     Pending = "Pending",

package/dist/Client.js

@@ -125,7 +125,8 @@ export class Client {
      * @param preIPOCompanySPVId (optional) PreIPOCompanySPVId to filter by.
      * @param preIPOCompanyInvestmentId (optional) PreIPOCompanyInvestmentId to filter by.
      * @param investorSubscriptionId (optional) InvestorSubscriptionId to filter by.
-     * @param registeredFundId (optional)
+     * @param registeredFundId (optional) RegisteredFundId to filter by.
+     * @param registeredFundSubscriptionId (optional) RegisteredFundSubscriptionId to filter by.
      * @param documentType (optional) Type of document to filter by.
      * @param exactMatch (optional) Only returns the items exactly matching the parameters given.
      * @param page (optional) Page number for pagination.
@@ -133,7 +134,7 @@ export class Client {
      * @param sortOrder (optional)
      * @return OK
      */
-    document2(investorId, preIPOCompanyId, preIPOCompanySPVId, preIPOCompanyInvestmentId, investorSubscriptionId, registeredFundId, documentType, exactMatch, page, pageSize, sortOrder) {
+    document2(investorId, preIPOCompanyId, preIPOCompanySPVId, preIPOCompanyInvestmentId, investorSubscriptionId, registeredFundId, registeredFundSubscriptionId, documentType, exactMatch, page, pageSize, sortOrder) {
         let url_ = this.baseUrl + "/primary/v1/document?";
         if (investorId === null)
             throw new Error("The parameter 'investorId' cannot be null.");
@@ -159,6 +160,10 @@ export class Client {
             throw new Error("The parameter 'registeredFundId' cannot be null.");
         else if (registeredFundId !== undefined)
             url_ += "registeredFundId=" + encodeURIComponent("" + registeredFundId) + "&";
+        if (registeredFundSubscriptionId === null)
+            throw new Error("The parameter 'registeredFundSubscriptionId' cannot be null.");
+        else if (registeredFundSubscriptionId !== undefined)
+            url_ += "registeredFundSubscriptionId=" + encodeURIComponent("" + registeredFundSubscriptionId) + "&";
         if (documentType === null)
             throw new Error("The parameter 'documentType' cannot be null.");
         else if (documentType !== undefined)
@@ -585,13 +590,18 @@ export class Client {
     }
     /**
      * Get all Financial Institutions
+     * @param referenceId (optional) Optional reference Id to filter by.
      * @param page (optional)
      * @param pageSize (optional)
      * @param sortOrder (optional)
      * @return OK
      */
-    financialInstitution2(page, pageSize, sortOrder) {
+    financialInstitution2(referenceId, page, pageSize, sortOrder) {
         let url_ = this.baseUrl + "/primary/v1/financial-institution?";
+        if (referenceId === null)
+            throw new Error("The parameter 'referenceId' cannot be null.");
+        else if (referenceId !== undefined)
+            url_ += "referenceId=" + encodeURIComponent("" + referenceId) + "&";
         if (page === null)
             throw new Error("The parameter 'page' cannot be null.");
         else if (page !== undefined)
@@ -637,6 +647,53 @@ export class Client {
         }
         return Promise.resolve(null);
     }
+    /**
+     * Update an Financial Institution's Reference ID.
+     * @param body (optional) The request containing the updated reference information.
+     * @return No Content
+     */
+    reference(body) {
+        let url_ = this.baseUrl + "/primary/v1/financial-institution/reference";
+        url_ = url_.replace(/[?&]$/, "");
+        const content_ = JSON.stringify(body);
+        let options_ = {
+            body: content_,
+            method: "PUT",
+            headers: {
+                "Content-Type": "application/json",
+            }
+        };
+        return this.http.fetch(url_, options_).then((_response) => {
+            return this.processReference(_response);
+        });
+    }
+    processReference(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);
+    }
     /**
      * Create an Indication of Interest
      * @param body (optional) create IndicationOfInterest information.
@@ -1553,12 +1610,13 @@ export class Client {
      * @param preIPOCompanyName (optional) Optional Company Name to filter on.
      * @param preIPOCompanySPVName (optional) Optional SPV Name to filter on.
      * @param tradingSymbol (optional) Optional Trading Symbol to filter on.
+     * @param orderReferenceId (optional)
      * @param page (optional)
      * @param pageSize (optional)
      * @param sortOrder (optional)
      * @return OK
      */
-    investorSubscriptionGET(preIpoCompanySpvId, investorId, status, preIPOCompanyName, preIPOCompanySPVName, tradingSymbol, page, pageSize, sortOrder) {
+    investorSubscriptionGET(preIpoCompanySpvId, investorId, status, preIPOCompanyName, preIPOCompanySPVName, tradingSymbol, orderReferenceId, page, pageSize, sortOrder) {
         let url_ = this.baseUrl + "/primary/v1/investor-subscription?";
         if (preIpoCompanySpvId === null)
             throw new Error("The parameter 'preIpoCompanySpvId' cannot be null.");
@@ -1584,6 +1642,10 @@ export class Client {
             throw new Error("The parameter 'tradingSymbol' cannot be null.");
         else if (tradingSymbol !== undefined)
             url_ += "tradingSymbol=" + encodeURIComponent("" + tradingSymbol) + "&";
+        if (orderReferenceId === null)
+            throw new Error("The parameter 'orderReferenceId' cannot be null.");
+        else if (orderReferenceId !== undefined)
+            url_ += "orderReferenceId=" + encodeURIComponent("" + orderReferenceId) + "&";
         if (page === null)
             throw new Error("The parameter 'page' cannot be null.");
         else if (page !== undefined)
@@ -3810,16 +3872,27 @@ export class Client {
         return Promise.resolve(null);
     }
     /**
-     * Get all PreIPOCompanies with extra details.
-     * @param includes (optional) List of elements to include in the result.
+     * Retrieves a paginated list of detailed PreIPOCompanies with optional filters and includes.
+    Includes More detail such as News, Research, Investments, Spv's and Funding Rounds.
+     * @param filterId (optional) Optional filter ID to narrow down the PreIPOCompanies.
+     * @param filterBy (optional) Optional filter type to categorize the PreIPOCompanies (e.g., Company, Investment, Spv).
+     * @param includes (optional) Optional list of additional data to include with the response (e.g., News, Research, Investments).
      * @param listingType (optional) Optional listing status filter.
      * @param isActive (optional) Optional active state filter.
-     * @param page (optional) Which page number to return.
-     * @param pageSize (optional) The maximum number of items to return in each page, defaults to 25.
-     * @return OK
+     * @param page (optional) Page number for pagination, starting from 1.
+     * @param pageSize (optional) Number of items per page for pagination, Default = 25.
+     * @return Returns the filtered and paginated list of detailed PreIPOCompanies.
      */
-    detailed(includes, listingType, isActive, page, pageSize) {
+    detailed(filterId, filterBy, includes, listingType, isActive, page, pageSize) {
         let url_ = this.baseUrl + "/primary/v1/pre-ipo-company/detailed?";
+        if (filterId === null)
+            throw new Error("The parameter 'filterId' cannot be null.");
+        else if (filterId !== undefined)
+            url_ += "filterId=" + encodeURIComponent("" + filterId) + "&";
+        if (filterBy === null)
+            throw new Error("The parameter 'filterBy' cannot be null.");
+        else if (filterBy !== undefined)
+            url_ += "filterBy=" + encodeURIComponent("" + filterBy) + "&";
         if (includes === null)
             throw new Error("The parameter 'includes' cannot be null.");
         else if (includes !== undefined)
@@ -3866,6 +3939,22 @@ export class Client {
                 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 === 400) {
+            return response.text().then((_responseText) => {
+                let result400 = null;
+                let resultData400 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+                result400 = ProblemDetails.fromJS(resultData400);
+                return throwException("Bad Request", status, _responseText, _headers, result400);
+            });
+        }
         else if (status !== 200 && status !== 204) {
             return response.text().then((_responseText) => {
                 return throwException("An unexpected server error occurred.", status, _responseText, _headers);
@@ -6187,7 +6276,7 @@ export class BulkPreIPOCompany {
             this.country = _data["country"];
             this.address = _data["address"];
             this.type = _data["type"];
-            this.yearEst = _data["yearEst"] ? new Date(_data["yearEst"].toString()) : undefined;
+            this.yearEst = _data["yearEst"];
             this.numJobs = _data["numJobs"];
             this.description = _data["description"];
             this.founder = _data["founder"];
@@ -6278,7 +6367,7 @@ export class BulkPreIPOCompany {
         data["country"] = this.country;
         data["address"] = this.address;
         data["type"] = this.type;
-        data["yearEst"] = this.yearEst ? formatDate(this.yearEst) : undefined;
+        data["yearEst"] = this.yearEst;
         data["numJobs"] = this.numJobs;
         data["description"] = this.description;
         data["founder"] = this.founder;
@@ -6733,6 +6822,7 @@ export class CreateInvestorSubscription {
             this.preIPOCompanySPVId = _data["preIPOCompanySPVId"];
             this.investorId = _data["investorId"];
             this.amountReservedDollars = _data["amountReservedDollars"];
+            this.orderReferenceId = _data["orderReferenceId"];
         }
     }
     static fromJS(data) {
@@ -6746,6 +6836,7 @@ export class CreateInvestorSubscription {
         data["preIPOCompanySPVId"] = this.preIPOCompanySPVId;
         data["investorId"] = this.investorId;
         data["amountReservedDollars"] = this.amountReservedDollars;
+        data["orderReferenceId"] = this.orderReferenceId;
         return data;
     }
 }
@@ -6996,6 +7087,7 @@ export class Document {
             this.investorSubscriptionId = _data["investorSubscriptionId"];
             this.partnerId = _data["partnerId"];
             this.registeredFundId = _data["registeredFundId"];
+            this.registeredFundSubscriptionId = _data["registeredFundSubscriptionId"];
             this.type = _data["type"];
             this.templateDocument = _data["templateDocument"];
             this.taxYear = _data["taxYear"];
@@ -7020,6 +7112,7 @@ export class Document {
         data["investorSubscriptionId"] = this.investorSubscriptionId;
         data["partnerId"] = this.partnerId;
         data["registeredFundId"] = this.registeredFundId;
+        data["registeredFundSubscriptionId"] = this.registeredFundSubscriptionId;
         data["type"] = this.type;
         data["templateDocument"] = this.templateDocument;
         data["taxYear"] = this.taxYear;
@@ -7277,6 +7370,7 @@ export class FinancialInstitution {
             this.createdAt = _data["createdAt"] ? new Date(_data["createdAt"].toString()) : undefined;
             this.updatedAt = _data["updatedAt"] ? new Date(_data["updatedAt"].toString()) : undefined;
             this.partner = _data["partner"] ? Partner.fromJS(_data["partner"]) : undefined;
+            this.financialInstitutionReferenceId = _data["financialInstitutionReferenceId"];
         }
     }
     static fromJS(data) {
@@ -7301,6 +7395,7 @@ export class FinancialInstitution {
         data["createdAt"] = this.createdAt ? this.createdAt.toISOString() : undefined;
         data["updatedAt"] = this.updatedAt ? this.updatedAt.toISOString() : undefined;
         data["partner"] = this.partner ? this.partner.toJSON() : undefined;
+        data["financialInstitutionReferenceId"] = this.financialInstitutionReferenceId;
         return data;
     }
 }
@@ -7522,6 +7617,7 @@ export class IndividualEntityInvestor {
             this.qualifiedStatus = _data["qualifiedStatus"];
             this.entityInvestorType = _data["entityInvestorType"];
             this.percentageOwned = _data["percentageOwned"];
+            this.title = _data["title"];
             this.id = _data["id"];
         }
     }
@@ -7562,6 +7658,7 @@ export class IndividualEntityInvestor {
         data["qualifiedStatus"] = this.qualifiedStatus;
         data["entityInvestorType"] = this.entityInvestorType;
         data["percentageOwned"] = this.percentageOwned;
+        data["title"] = this.title;
         data["id"] = this.id;
         return data;
     }
@@ -7606,6 +7703,7 @@ export class IndividualEntityInvestorBase {
             this.qualifiedStatus = _data["qualifiedStatus"];
             this.entityInvestorType = _data["entityInvestorType"];
             this.percentageOwned = _data["percentageOwned"];
+            this.title = _data["title"];
         }
     }
     static fromJS(data) {
@@ -7645,6 +7743,7 @@ export class IndividualEntityInvestorBase {
         data["qualifiedStatus"] = this.qualifiedStatus;
         data["entityInvestorType"] = this.entityInvestorType;
         data["percentageOwned"] = this.percentageOwned;
+        data["title"] = this.title;
         return data;
     }
 }
@@ -9403,7 +9502,7 @@ export class PreIPOCompany {
             this.country = _data["country"];
             this.address = _data["address"];
             this.type = _data["type"];
-            this.yearEst = _data["yearEst"] ? new Date(_data["yearEst"].toString()) : undefined;
+            this.yearEst = _data["yearEst"];
             this.numJobs = _data["numJobs"];
             this.description = _data["description"];
             this.founder = _data["founder"];
@@ -9469,7 +9568,7 @@ export class PreIPOCompany {
         data["country"] = this.country;
         data["address"] = this.address;
         data["type"] = this.type;
-        data["yearEst"] = this.yearEst ? formatDate(this.yearEst) : undefined;
+        data["yearEst"] = this.yearEst;
         data["numJobs"] = this.numJobs;
         data["description"] = this.description;
         data["founder"] = this.founder;
@@ -10942,6 +11041,34 @@ export class UpdateFinancialAdvisor {
         return data;
     }
 }
+export class UpdateFinancialInstitutionReferenceId {
+    constructor(data) {
+        if (data) {
+            for (var property in data) {
+                if (data.hasOwnProperty(property))
+                    this[property] = data[property];
+            }
+        }
+    }
+    init(_data) {
+        if (_data) {
+            this.financialInstitutionId = _data["financialInstitutionId"];
+            this.financialInstitutionReferenceId = _data["financialInstitutionReferenceId"];
+        }
+    }
+    static fromJS(data) {
+        data = typeof data === 'object' ? data : {};
+        let result = new UpdateFinancialInstitutionReferenceId();
+        result.init(data);
+        return result;
+    }
+    toJSON(data) {
+        data = typeof data === 'object' ? data : {};
+        data["financialInstitutionId"] = this.financialInstitutionId;
+        data["financialInstitutionReferenceId"] = this.financialInstitutionReferenceId;
+        return data;
+    }
+}
 /** IndicationOfInterest represents the primary offering information on the IoI. */
 export class UpdateIndicationOfInterest {
     constructor(data) {
@@ -11017,6 +11144,7 @@ export class UpdateIndividualEntityInvestor {
             this.qualifiedStatus = _data["qualifiedStatus"];
             this.entityInvestorType = _data["entityInvestorType"];
             this.percentageOwned = _data["percentageOwned"];
+            this.title = _data["title"];
             this.id = _data["id"];
         }
     }
@@ -11057,6 +11185,7 @@ export class UpdateIndividualEntityInvestor {
         data["qualifiedStatus"] = this.qualifiedStatus;
         data["entityInvestorType"] = this.entityInvestorType;
         data["percentageOwned"] = this.percentageOwned;
+        data["title"] = this.title;
         data["id"] = this.id;
         return data;
     }
@@ -11569,6 +11698,7 @@ export var Status;
     Status["Processing"] = "Processing";
     Status["Complete"] = "Complete";
     Status["Rejected"] = "Rejected";
+    Status["Failed"] = "Failed";
 })(Status || (Status = {}));
 export var SortOrder6;
 (function (SortOrder6) {
@@ -11587,6 +11717,12 @@ export var SortOrder7;
     SortOrder7["Ascending"] = "Ascending";
     SortOrder7["Descending"] = "Descending";
 })(SortOrder7 || (SortOrder7 = {}));
+export var FilterBy;
+(function (FilterBy) {
+    FilterBy["Company"] = "Company";
+    FilterBy["Investment"] = "Investment";
+    FilterBy["Spv"] = "Spv";
+})(FilterBy || (FilterBy = {}));
 export var Includes;
 (function (Includes) {
     Includes["News"] = "News";
@@ -12007,6 +12143,7 @@ export var InvestorSubscriptionStatus;
     InvestorSubscriptionStatus["Processing"] = "Processing";
     InvestorSubscriptionStatus["Complete"] = "Complete";
     InvestorSubscriptionStatus["Rejected"] = "Rejected";
+    InvestorSubscriptionStatus["Failed"] = "Failed";
 })(InvestorSubscriptionStatus || (InvestorSubscriptionStatus = {}));
 export var InvestorSubscriptionActionStatus;
 (function (InvestorSubscriptionActionStatus) {

package/package.json

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