@monarkmarkets/api-client 1.1.123 → 1.1.125

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/Client.d.ts CHANGED
@@ -5,6 +5,12 @@ export declare class Client {
5
5
  constructor(baseUrl?: string, http?: {
6
6
  fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
7
7
  });
8
+ /**
9
+ * @param body (optional)
10
+ * @return OK
11
+ */
12
+ normalize(body: NormalizeAddressRequest | undefined): Promise<NormalizeAddressResponse>;
13
+ protected processNormalize(response: Response): Promise<NormalizeAddressResponse>;
8
14
  /**
9
15
  * Get a Document by ID.
10
16
  * @param id The Document ID for the document to retrieve.
@@ -19,7 +25,8 @@ export declare class Client {
19
25
  * @param preIPOCompanySPVId (optional) PreIPOCompanySPVId to filter by.
20
26
  * @param preIPOCompanyInvestmentId (optional) PreIPOCompanyInvestmentId to filter by.
21
27
  * @param investorSubscriptionId (optional) InvestorSubscriptionId to filter by.
22
- * @param registeredFundId (optional)
28
+ * @param registeredFundId (optional) RegisteredFundId to filter by.
29
+ * @param registeredFundSubscriptionId (optional) RegisteredFundSubscriptionId to filter by.
23
30
  * @param documentType (optional) Type of document to filter by.
24
31
  * @param exactMatch (optional) Only returns the items exactly matching the parameters given.
25
32
  * @param page (optional) Page number for pagination.
@@ -27,7 +34,7 @@ export declare class Client {
27
34
  * @param sortOrder (optional)
28
35
  * @return OK
29
36
  */
30
- 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>;
37
+ 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>;
31
38
  protected processDocument2(response: Response): Promise<DocumentApiResponse>;
32
39
  /**
33
40
  * Signs a document by a document ID.
@@ -84,13 +91,21 @@ export declare class Client {
84
91
  protected processFinancialInstitution(response: Response): Promise<FinancialInstitution>;
85
92
  /**
86
93
  * Get all Financial Institutions
94
+ * @param referenceId (optional) Optional reference Id to filter by.
87
95
  * @param page (optional)
88
96
  * @param pageSize (optional)
89
97
  * @param sortOrder (optional)
90
98
  * @return OK
91
99
  */
92
- financialInstitution2(page: number | undefined, pageSize: number | undefined, sortOrder: SortOrder3 | undefined): Promise<FinancialInstitutionApiResponse>;
100
+ financialInstitution2(referenceId: string | undefined, page: number | undefined, pageSize: number | undefined, sortOrder: SortOrder3 | undefined): Promise<FinancialInstitutionApiResponse>;
93
101
  protected processFinancialInstitution2(response: Response): Promise<FinancialInstitutionApiResponse>;
102
+ /**
103
+ * Update an Financial Institution's Reference ID.
104
+ * @param body (optional) The request containing the updated reference information.
105
+ * @return No Content
106
+ */
107
+ reference(body: UpdateFinancialInstitutionReferenceId | undefined): Promise<void>;
108
+ protected processReference(response: Response): Promise<void>;
94
109
  /**
95
110
  * Create an Indication of Interest
96
111
  * @param body (optional) create IndicationOfInterest information.
@@ -221,12 +236,13 @@ export declare class Client {
221
236
  * @param preIPOCompanyName (optional) Optional Company Name to filter on.
222
237
  * @param preIPOCompanySPVName (optional) Optional SPV Name to filter on.
223
238
  * @param tradingSymbol (optional) Optional Trading Symbol to filter on.
239
+ * @param orderReferenceId (optional)
224
240
  * @param page (optional)
225
241
  * @param pageSize (optional)
226
242
  * @param sortOrder (optional)
227
243
  * @return OK
228
244
  */
229
- 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>;
245
+ 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>;
230
246
  protected processInvestorSubscriptionGET(response: Response): Promise<InvestorSubscriptionApiResponse>;
231
247
  /**
232
248
  * Update an InvestorSubscription.
@@ -522,7 +538,7 @@ export declare class Client {
522
538
  getAllPmiValuations(financialInstitutionId: string, preIPOCompanyId: string | undefined, pmiId: string | undefined, displayName: string | undefined, fromDate: Date | undefined, toDate: Date | undefined, pageNumber: number | undefined, pageSize: number | undefined): Promise<PmiValuationApiResponse>;
523
539
  protected processGetAllPmiValuations(response: Response): Promise<PmiValuationApiResponse>;
524
540
  /**
525
- * Get a PreIPOCompany by Id
541
+ * Get a PreIPOCompany by Id.
526
542
  * @param id ID of the PreIPOCompany to find.
527
543
  * @return Returns the PreIPOCompany with the specified Id.
528
544
  */
@@ -538,19 +554,27 @@ export declare class Client {
538
554
  * @param maxLastValuation (optional) Maximum last valuation filter.
539
555
  * @param minTotalFunding (optional) Minimum total funding filter.
540
556
  * @param maxTotalFunding (optional) Maximum total funding filter.
557
+ * @param listingType (optional) Optional listing status filter.
558
+ * @param isActive (optional) Optional active state filter.
541
559
  * @param page (optional) Which page number to return.
542
560
  * @param pageSize (optional) The maximum number of items to return in each page, defaults to 25.
543
561
  * @return OK
544
562
  */
545
- 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, page: number | undefined, pageSize: number | undefined): Promise<PreIPOCompanyApiResponse>;
563
+ 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>;
546
564
  protected processPreIpoCompany2(response: Response): Promise<PreIPOCompanyApiResponse>;
547
565
  /**
548
- * @param includes (optional)
549
- * @param page (optional)
550
- * @param pageSize (optional)
551
- * @return OK
566
+ * Retrieves a paginated list of detailed PreIPOCompanies with optional filters and includes.
567
+ Includes More detail such as News, Research, Investments, Spv's and Funding Rounds.
568
+ * @param filterId (optional) Optional filter ID to narrow down the PreIPOCompanies.
569
+ * @param filterBy (optional) Optional filter type to categorize the PreIPOCompanies (e.g., Company, Investment, Spv).
570
+ * @param includes (optional) Optional list of additional data to include with the response (e.g., News, Research, Investments).
571
+ * @param listingType (optional) Optional listing status filter.
572
+ * @param isActive (optional) Optional active state filter.
573
+ * @param page (optional) Page number for pagination, starting from 1.
574
+ * @param pageSize (optional) Number of items per page for pagination, Default = 25.
575
+ * @return Returns the filtered and paginated list of detailed PreIPOCompanies.
552
576
  */
553
- detailed(includes: Includes[] | undefined, page: number | undefined, pageSize: number | undefined): Promise<BulkPreIPOCompanyApiResponse>;
577
+ detailed(filterId: string | undefined, filterBy: FilterBy | undefined, includes: Includes[] | undefined, listingType: string | undefined, isActive: boolean | undefined, page: number | undefined, pageSize: number | undefined): Promise<BulkPreIPOCompanyApiResponse>;
554
578
  protected processDetailed(response: Response): Promise<BulkPreIPOCompanyApiResponse>;
555
579
  /**
556
580
  * Get the PreIPOCompanyFundingRound by the specified Id.
@@ -887,7 +911,7 @@ export declare class BulkPreIPOCompany implements IBulkPreIPOCompany {
887
911
  /** Type of entity of the PreIPOCompany. */
888
912
  type?: BulkPreIPOCompanyType;
889
913
  /** The year the PreIPOCompany was established. */
890
- yearEst?: Date | undefined;
914
+ yearEst?: number | undefined;
891
915
  /** The number of employees at the PreIPO Company. */
892
916
  numJobs?: number | undefined;
893
917
  /** Short description of the PreIPOCompany. */
@@ -970,7 +994,7 @@ export interface IBulkPreIPOCompany {
970
994
  /** Type of entity of the PreIPOCompany. */
971
995
  type?: BulkPreIPOCompanyType;
972
996
  /** The year the PreIPOCompany was established. */
973
- yearEst?: Date | undefined;
997
+ yearEst?: number | undefined;
974
998
  /** The number of employees at the PreIPO Company. */
975
999
  numJobs?: number | undefined;
976
1000
  /** Short description of the PreIPOCompany. */
@@ -1074,7 +1098,7 @@ export declare class BulkPreIPOCompanySPV implements IBulkPreIPOCompanySPV {
1074
1098
  exemptionsClaimed?: exemptionsClaimed[] | undefined;
1075
1099
  /** The stage that an SPV is in. Refer to the “SPV Status Transitions” page in our Guides for a detailed description of each stage. */
1076
1100
  monarkStage: BulkPreIPOCompanySPVMonarkStage;
1077
- /** CUSIP assigned to the SPV. Monark acquires and assigns the CUSIP after the first trade has been executed through our ATS. */
1101
+ /** CUSIP assigned to the SPV. */
1078
1102
  cusip?: string | undefined;
1079
1103
  /** 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. */
1080
1104
  tradingSymbol?: string | undefined;
@@ -1152,7 +1176,7 @@ export interface IBulkPreIPOCompanySPV {
1152
1176
  exemptionsClaimed?: exemptionsClaimed[] | undefined;
1153
1177
  /** The stage that an SPV is in. Refer to the “SPV Status Transitions” page in our Guides for a detailed description of each stage. */
1154
1178
  monarkStage: BulkPreIPOCompanySPVMonarkStage;
1155
- /** CUSIP assigned to the SPV. Monark acquires and assigns the CUSIP after the first trade has been executed through our ATS. */
1179
+ /** CUSIP assigned to the SPV. */
1156
1180
  cusip?: string | undefined;
1157
1181
  /** 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. */
1158
1182
  tradingSymbol?: string | undefined;
@@ -1372,6 +1396,8 @@ export declare class CreateInvestorSubscription implements ICreateInvestorSubscr
1372
1396
  investorId: string;
1373
1397
  /** Describes the amount, in dollars, an Investor intends to invest into an SPV. */
1374
1398
  amountReservedDollars: number;
1399
+ /** The reference ID of an order submitted. */
1400
+ orderReferenceId?: string | undefined;
1375
1401
  constructor(data?: ICreateInvestorSubscription);
1376
1402
  init(_data?: any): void;
1377
1403
  static fromJS(data: any): CreateInvestorSubscription;
@@ -1384,6 +1410,8 @@ export interface ICreateInvestorSubscription {
1384
1410
  investorId: string;
1385
1411
  /** Describes the amount, in dollars, an Investor intends to invest into an SPV. */
1386
1412
  amountReservedDollars: number;
1413
+ /** The reference ID of an order submitted. */
1414
+ orderReferenceId?: string | undefined;
1387
1415
  }
1388
1416
  /** Create Questionnaire allows the creation of a questionaire with the primary offerring. */
1389
1417
  export declare class CreateQuestionnaire implements ICreateQuestionnaire {
@@ -1557,6 +1585,8 @@ export declare class Document implements IDocument {
1557
1585
  partnerId?: string | undefined;
1558
1586
  /** Unique identifier of the registered fund, if any. */
1559
1587
  registeredFundId?: string | undefined;
1588
+ /** Unique identifier of the registered fund subscription, if any. */
1589
+ registeredFundSubscriptionId?: string | undefined;
1560
1590
  /** The type of Document. */
1561
1591
  type?: DocumentType2;
1562
1592
  /** Boolean value to dictate if this is a template. */
@@ -1592,6 +1622,8 @@ export interface IDocument {
1592
1622
  partnerId?: string | undefined;
1593
1623
  /** Unique identifier of the registered fund, if any. */
1594
1624
  registeredFundId?: string | undefined;
1625
+ /** Unique identifier of the registered fund subscription, if any. */
1626
+ registeredFundSubscriptionId?: string | undefined;
1595
1627
  /** The type of Document. */
1596
1628
  type?: DocumentType2;
1597
1629
  /** Boolean value to dictate if this is a template. */
@@ -1853,6 +1885,8 @@ See https://github.com/country-regions/country-region-data/blob/master/data.json
1853
1885
  updatedAt?: Date;
1854
1886
  /** The linked Partner. */
1855
1887
  partner?: Partner | undefined;
1888
+ /** Optional reference field for this Financial Institution. */
1889
+ financialInstitutionReferenceId?: string | undefined;
1856
1890
  constructor(data?: IFinancialInstitution);
1857
1891
  init(_data?: any): void;
1858
1892
  static fromJS(data: any): FinancialInstitution;
@@ -1888,6 +1922,8 @@ See https://github.com/country-regions/country-region-data/blob/master/data.json
1888
1922
  updatedAt?: Date;
1889
1923
  /** The linked Partner. */
1890
1924
  partner?: Partner | undefined;
1925
+ /** Optional reference field for this Financial Institution. */
1926
+ financialInstitutionReferenceId?: string | undefined;
1891
1927
  }
1892
1928
  export declare class FinancialInstitutionApiResponse implements IFinancialInstitutionApiResponse {
1893
1929
  items?: FinancialInstitution[] | undefined;
@@ -2095,9 +2131,9 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
2095
2131
  isSubscriptionAdvisorOrERA?: boolean;
2096
2132
  /** Email address associated with an Investor. */
2097
2133
  email: string | undefined;
2098
- /** Investors Social Security Number. */
2134
+ /** 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. */
2099
2135
  taxId: string | undefined;
2100
- /** Investor Passport Number. - Only Required for Non-US Investors. */
2136
+ /** Investor Passport Number. Pass "N/A" if there is no `passportNumber`. */
2101
2137
  passportNumber?: string | undefined;
2102
2138
  /** Country code of the Investor’s citizenship. Check https://github.com/country-regions/country-region-data/blob/master/data.json for valid country codes */
2103
2139
  citizenship: string | undefined;
@@ -2107,6 +2143,8 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
2107
2143
  entityInvestorType?: IndividualEntityInvestorEntityInvestorType;
2108
2144
  /** The percentage of the entity owned by the investor. */
2109
2145
  percentageOwned?: number;
2146
+ /** Represents the title of the individual investor. */
2147
+ title?: string | undefined;
2110
2148
  /** Id of the individual investor. */
2111
2149
  id?: string;
2112
2150
  constructor(data?: IIndividualEntityInvestor);
@@ -2164,9 +2202,9 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
2164
2202
  isSubscriptionAdvisorOrERA?: boolean;
2165
2203
  /** Email address associated with an Investor. */
2166
2204
  email: string | undefined;
2167
- /** Investors Social Security Number. */
2205
+ /** 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. */
2168
2206
  taxId: string | undefined;
2169
- /** Investor Passport Number. - Only Required for Non-US Investors. */
2207
+ /** Investor Passport Number. Pass "N/A" if there is no `passportNumber`. */
2170
2208
  passportNumber?: string | undefined;
2171
2209
  /** Country code of the Investor’s citizenship. Check https://github.com/country-regions/country-region-data/blob/master/data.json for valid country codes */
2172
2210
  citizenship: string | undefined;
@@ -2176,6 +2214,8 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
2176
2214
  entityInvestorType?: IndividualEntityInvestorEntityInvestorType;
2177
2215
  /** The percentage of the entity owned by the investor. */
2178
2216
  percentageOwned?: number;
2217
+ /** Represents the title of the individual investor. */
2218
+ title?: string | undefined;
2179
2219
  /** Id of the individual investor. */
2180
2220
  id?: string;
2181
2221
  }
@@ -2229,9 +2269,9 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
2229
2269
  isSubscriptionAdvisorOrERA: boolean;
2230
2270
  /** Email address associated with an Investor. */
2231
2271
  email: string;
2232
- /** Investors Social Security Number. */
2272
+ /** 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. */
2233
2273
  taxId: string | undefined;
2234
- /** Investor Passport Number. - Only Required for Non-US Investors. */
2274
+ /** Investor Passport Number. Pass "N/A" if there is no `passportNumber`. */
2235
2275
  passportNumber?: string | undefined;
2236
2276
  /** Country code of the Investor’s citizenship. Check https://github.com/country-regions/country-region-data/blob/master/data.json for valid country codes */
2237
2277
  citizenship: string;
@@ -2241,6 +2281,8 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
2241
2281
  entityInvestorType?: IndividualEntityInvestorBaseEntityInvestorType;
2242
2282
  /** The percentage of the entity owned by the investor. */
2243
2283
  percentageOwned?: number;
2284
+ /** Represents the title of the individual investor. */
2285
+ title?: string | undefined;
2244
2286
  constructor(data?: IIndividualEntityInvestorBase);
2245
2287
  init(_data?: any): void;
2246
2288
  static fromJS(data: any): IndividualEntityInvestorBase;
@@ -2296,9 +2338,9 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
2296
2338
  isSubscriptionAdvisorOrERA: boolean;
2297
2339
  /** Email address associated with an Investor. */
2298
2340
  email: string;
2299
- /** Investors Social Security Number. */
2341
+ /** 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. */
2300
2342
  taxId: string | undefined;
2301
- /** Investor Passport Number. - Only Required for Non-US Investors. */
2343
+ /** Investor Passport Number. Pass "N/A" if there is no `passportNumber`. */
2302
2344
  passportNumber?: string | undefined;
2303
2345
  /** Country code of the Investor’s citizenship. Check https://github.com/country-regions/country-region-data/blob/master/data.json for valid country codes */
2304
2346
  citizenship: string;
@@ -2308,6 +2350,8 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
2308
2350
  entityInvestorType?: IndividualEntityInvestorBaseEntityInvestorType;
2309
2351
  /** The percentage of the entity owned by the investor. */
2310
2352
  percentageOwned?: number;
2353
+ /** Represents the title of the individual investor. */
2354
+ title?: string | undefined;
2311
2355
  }
2312
2356
  export declare class IndividualInvestor implements IIndividualInvestor {
2313
2357
  /** First name of the Investor. */
@@ -2359,9 +2403,9 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
2359
2403
  isSubscriptionAdvisorOrERA?: boolean;
2360
2404
  /** Email address associated with an Investor. */
2361
2405
  email: string | undefined;
2362
- /** Investors Social Security Number. */
2406
+ /** 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. */
2363
2407
  taxId: string | undefined;
2364
- /** Investor Passport Number. - Only Required for Non-US Investors. */
2408
+ /** Investor Passport Number. Pass "N/A" if there is no `passportNumber`. */
2365
2409
  passportNumber?: string | undefined;
2366
2410
  /** Country code of the Investor’s citizenship. Check https://github.com/country-regions/country-region-data/blob/master/data.json for valid country codes */
2367
2411
  citizenship: string | undefined;
@@ -2428,9 +2472,9 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
2428
2472
  isSubscriptionAdvisorOrERA?: boolean;
2429
2473
  /** Email address associated with an Investor. */
2430
2474
  email: string | undefined;
2431
- /** Investors Social Security Number. */
2475
+ /** 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. */
2432
2476
  taxId: string | undefined;
2433
- /** Investor Passport Number. - Only Required for Non-US Investors. */
2477
+ /** Investor Passport Number. Pass "N/A" if there is no `passportNumber`. */
2434
2478
  passportNumber?: string | undefined;
2435
2479
  /** Country code of the Investor’s citizenship. Check https://github.com/country-regions/country-region-data/blob/master/data.json for valid country codes */
2436
2480
  citizenship: string | undefined;
@@ -2799,9 +2843,9 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
2799
2843
  isSubscriptionAdvisorOrERA: boolean;
2800
2844
  /** Email address associated with an Investor. */
2801
2845
  email: string;
2802
- /** Investors Social Security Number. */
2846
+ /** 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. */
2803
2847
  taxId: string | undefined;
2804
- /** Investor Passport Number. - Only Required for Non-US Investors. */
2848
+ /** Investor Passport Number. Pass "N/A" if there is no `passportNumber`. */
2805
2849
  passportNumber?: string | undefined;
2806
2850
  /** Country code of the Investor’s citizenship. Check https://github.com/country-regions/country-region-data/blob/master/data.json for valid country codes */
2807
2851
  citizenship: string;
@@ -2862,9 +2906,9 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
2862
2906
  isSubscriptionAdvisorOrERA: boolean;
2863
2907
  /** Email address associated with an Investor. */
2864
2908
  email: string;
2865
- /** Investors Social Security Number. */
2909
+ /** 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. */
2866
2910
  taxId: string | undefined;
2867
- /** Investor Passport Number. - Only Required for Non-US Investors. */
2911
+ /** Investor Passport Number. Pass "N/A" if there is no `passportNumber`. */
2868
2912
  passportNumber?: string | undefined;
2869
2913
  /** Country code of the Investor’s citizenship. Check https://github.com/country-regions/country-region-data/blob/master/data.json for valid country codes */
2870
2914
  citizenship: string;
@@ -2923,6 +2967,44 @@ export interface INAVReport {
2923
2967
  /** Net Asset Value as of the reported date */
2924
2968
  nav: number;
2925
2969
  }
2970
+ export declare class NormalizeAddressRequest implements INormalizeAddressRequest {
2971
+ street1?: string | undefined;
2972
+ city?: string | undefined;
2973
+ zipCode?: string | undefined;
2974
+ country: string;
2975
+ state?: string | undefined;
2976
+ hint?: string | undefined;
2977
+ constructor(data?: INormalizeAddressRequest);
2978
+ init(_data?: any): void;
2979
+ static fromJS(data: any): NormalizeAddressRequest;
2980
+ toJSON(data?: any): any;
2981
+ }
2982
+ export interface INormalizeAddressRequest {
2983
+ street1?: string | undefined;
2984
+ city?: string | undefined;
2985
+ zipCode?: string | undefined;
2986
+ country: string;
2987
+ state?: string | undefined;
2988
+ hint?: string | undefined;
2989
+ }
2990
+ export declare class NormalizeAddressResponse implements INormalizeAddressResponse {
2991
+ countryCode?: string | undefined;
2992
+ stateCode?: string | undefined;
2993
+ countryName?: string | undefined;
2994
+ stateName?: string | undefined;
2995
+ confidence?: number;
2996
+ constructor(data?: INormalizeAddressResponse);
2997
+ init(_data?: any): void;
2998
+ static fromJS(data: any): NormalizeAddressResponse;
2999
+ toJSON(data?: any): any;
3000
+ }
3001
+ export interface INormalizeAddressResponse {
3002
+ countryCode?: string | undefined;
3003
+ stateCode?: string | undefined;
3004
+ countryName?: string | undefined;
3005
+ stateName?: string | undefined;
3006
+ confidence?: number;
3007
+ }
2926
3008
  /** Represents a 409A valuation (NPM/FMV). */
2927
3009
  export declare class Npm409AValuation implements INpm409AValuation {
2928
3010
  /** Unique identification number for the 409A valuation. */
@@ -3520,7 +3602,7 @@ export declare class Partner implements IPartner {
3520
3602
  /** Legal Entity Name of the partner. */
3521
3603
  legalEntityName: string | undefined;
3522
3604
  /** Country code of the investor. */
3523
- countryCode: string | undefined;
3605
+ countryCode?: string | undefined;
3524
3606
  /** Website of the Partner. */
3525
3607
  website?: string | undefined;
3526
3608
  /** Executive Team of the partner. */
@@ -3558,7 +3640,7 @@ export interface IPartner {
3558
3640
  /** Legal Entity Name of the partner. */
3559
3641
  legalEntityName: string | undefined;
3560
3642
  /** Country code of the investor. */
3561
- countryCode: string | undefined;
3643
+ countryCode?: string | undefined;
3562
3644
  /** Website of the Partner. */
3563
3645
  website?: string | undefined;
3564
3646
  /** Executive Team of the partner. */
@@ -4018,7 +4100,7 @@ export declare class PreIPOCompany implements IPreIPOCompany {
4018
4100
  /** Type of entity of the PreIPOCompany. */
4019
4101
  type?: PreIPOCompanyType;
4020
4102
  /** The year the PreIPOCompany was established. */
4021
- yearEst?: Date | undefined;
4103
+ yearEst?: number | undefined;
4022
4104
  /** The number of employees at the PreIPO Company. */
4023
4105
  numJobs?: number | undefined;
4024
4106
  /** Short description of the PreIPOCompany. */
@@ -4097,7 +4179,7 @@ export interface IPreIPOCompany {
4097
4179
  /** Type of entity of the PreIPOCompany. */
4098
4180
  type?: PreIPOCompanyType;
4099
4181
  /** The year the PreIPOCompany was established. */
4100
- yearEst?: Date | undefined;
4182
+ yearEst?: number | undefined;
4101
4183
  /** The number of employees at the PreIPO Company. */
4102
4184
  numJobs?: number | undefined;
4103
4185
  /** Short description of the PreIPOCompany. */
@@ -4481,7 +4563,7 @@ export declare class PreIPOCompanySPV implements IPreIPOCompanySPV {
4481
4563
  exemptionsClaimed?: exemptionsClaimed2[] | undefined;
4482
4564
  /** The stage that an SPV is in. Refer to the “SPV Status Transitions” page in our Guides for a detailed description of each stage. */
4483
4565
  monarkStage: PreIPOCompanySPVMonarkStage;
4484
- /** CUSIP assigned to the SPV. Monark acquires and assigns the CUSIP after the first trade has been executed through our ATS. */
4566
+ /** CUSIP assigned to the SPV. */
4485
4567
  cusip?: string | undefined;
4486
4568
  /** 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. */
4487
4569
  tradingSymbol?: string | undefined;
@@ -4558,7 +4640,7 @@ export interface IPreIPOCompanySPV {
4558
4640
  exemptionsClaimed?: exemptionsClaimed2[] | undefined;
4559
4641
  /** The stage that an SPV is in. Refer to the “SPV Status Transitions” page in our Guides for a detailed description of each stage. */
4560
4642
  monarkStage: PreIPOCompanySPVMonarkStage;
4561
- /** CUSIP assigned to the SPV. Monark acquires and assigns the CUSIP after the first trade has been executed through our ATS. */
4643
+ /** CUSIP assigned to the SPV. */
4562
4644
  cusip?: string | undefined;
4563
4645
  /** 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. */
4564
4646
  tradingSymbol?: string | undefined;
@@ -5160,7 +5242,7 @@ export interface IShareDetail {
5160
5242
  /** Model for signing a document. */
5161
5243
  export declare class SignDocument implements ISignDocument {
5162
5244
  /** The investorId associated with the document. */
5163
- investorId?: string;
5245
+ investorId: string;
5164
5246
  /** Metadata about the signing. */
5165
5247
  metadata?: string | undefined;
5166
5248
  constructor(data?: ISignDocument);
@@ -5171,7 +5253,7 @@ export declare class SignDocument implements ISignDocument {
5171
5253
  /** Model for signing a document. */
5172
5254
  export interface ISignDocument {
5173
5255
  /** The investorId associated with the document. */
5174
- investorId?: string;
5256
+ investorId: string;
5175
5257
  /** Metadata about the signing. */
5176
5258
  metadata?: string | undefined;
5177
5259
  }
@@ -5389,6 +5471,22 @@ export interface IUpdateFinancialAdvisor {
5389
5471
  /** ID of the FinancialAdvisor to edit. */
5390
5472
  id?: string;
5391
5473
  }
5474
+ export declare class UpdateFinancialInstitutionReferenceId implements IUpdateFinancialInstitutionReferenceId {
5475
+ /** ID of the FinancialInstitution to edit. */
5476
+ financialInstitutionId?: string;
5477
+ /** Reference field for the Financial Institution. */
5478
+ financialInstitutionReferenceId?: string | undefined;
5479
+ constructor(data?: IUpdateFinancialInstitutionReferenceId);
5480
+ init(_data?: any): void;
5481
+ static fromJS(data: any): UpdateFinancialInstitutionReferenceId;
5482
+ toJSON(data?: any): any;
5483
+ }
5484
+ export interface IUpdateFinancialInstitutionReferenceId {
5485
+ /** ID of the FinancialInstitution to edit. */
5486
+ financialInstitutionId?: string;
5487
+ /** Reference field for the Financial Institution. */
5488
+ financialInstitutionReferenceId?: string | undefined;
5489
+ }
5392
5490
  /** IndicationOfInterest represents the primary offering information on the IoI. */
5393
5491
  export declare class UpdateIndicationOfInterest implements IUpdateIndicationOfInterest {
5394
5492
  /** Unique ID associated with an IOI. */
@@ -5469,9 +5567,9 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
5469
5567
  isSubscriptionAdvisorOrERA: boolean;
5470
5568
  /** Email address associated with an Investor. */
5471
5569
  email: string;
5472
- /** Investors Social Security Number. */
5570
+ /** 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. */
5473
5571
  taxId: string | undefined;
5474
- /** Investor Passport Number. - Only Required for Non-US Investors. */
5572
+ /** Investor Passport Number. Pass "N/A" if there is no `passportNumber`. */
5475
5573
  passportNumber?: string | undefined;
5476
5574
  /** Country code of the Investor’s citizenship. Check https://github.com/country-regions/country-region-data/blob/master/data.json for valid country codes */
5477
5575
  citizenship: string;
@@ -5481,6 +5579,8 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
5481
5579
  entityInvestorType?: UpdateIndividualEntityInvestorEntityInvestorType;
5482
5580
  /** The percentage of the entity owned by the investor. */
5483
5581
  percentageOwned?: number;
5582
+ /** Represents the title of the individual investor. */
5583
+ title?: string | undefined;
5484
5584
  /** Identifier for the individual investor. */
5485
5585
  id: string;
5486
5586
  constructor(data?: IUpdateIndividualEntityInvestor);
@@ -5538,9 +5638,9 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
5538
5638
  isSubscriptionAdvisorOrERA: boolean;
5539
5639
  /** Email address associated with an Investor. */
5540
5640
  email: string;
5541
- /** Investors Social Security Number. */
5641
+ /** 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. */
5542
5642
  taxId: string | undefined;
5543
- /** Investor Passport Number. - Only Required for Non-US Investors. */
5643
+ /** Investor Passport Number. Pass "N/A" if there is no `passportNumber`. */
5544
5644
  passportNumber?: string | undefined;
5545
5645
  /** Country code of the Investor’s citizenship. Check https://github.com/country-regions/country-region-data/blob/master/data.json for valid country codes */
5546
5646
  citizenship: string;
@@ -5550,6 +5650,8 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
5550
5650
  entityInvestorType?: UpdateIndividualEntityInvestorEntityInvestorType;
5551
5651
  /** The percentage of the entity owned by the investor. */
5552
5652
  percentageOwned?: number;
5653
+ /** Represents the title of the individual investor. */
5654
+ title?: string | undefined;
5553
5655
  /** Identifier for the individual investor. */
5554
5656
  id: string;
5555
5657
  }
@@ -5925,7 +6027,8 @@ export declare enum Status {
5925
6027
  Pending = "Pending",
5926
6028
  Processing = "Processing",
5927
6029
  Complete = "Complete",
5928
- Rejected = "Rejected"
6030
+ Rejected = "Rejected",
6031
+ Failed = "Failed"
5929
6032
  }
5930
6033
  export declare enum SortOrder6 {
5931
6034
  Ascending = "Ascending",
@@ -5941,6 +6044,11 @@ export declare enum SortOrder7 {
5941
6044
  Ascending = "Ascending",
5942
6045
  Descending = "Descending"
5943
6046
  }
6047
+ export declare enum FilterBy {
6048
+ Company = "Company",
6049
+ Investment = "Investment",
6050
+ Spv = "Spv"
6051
+ }
5944
6052
  export declare enum Includes {
5945
6053
  News = "News",
5946
6054
  Research = "Research",
@@ -6317,7 +6425,8 @@ export declare enum InvestorSubscriptionStatus {
6317
6425
  Pending = "Pending",
6318
6426
  Processing = "Processing",
6319
6427
  Complete = "Complete",
6320
- Rejected = "Rejected"
6428
+ Rejected = "Rejected",
6429
+ Failed = "Failed"
6321
6430
  }
6322
6431
  export declare enum InvestorSubscriptionActionStatus {
6323
6432
  Pending = "Pending",
package/dist/Client.js CHANGED
@@ -12,6 +12,61 @@ export class Client {
12
12
  this.http = http ? http : window;
13
13
  this.baseUrl = baseUrl ?? "";
14
14
  }
15
+ /**
16
+ * @param body (optional)
17
+ * @return OK
18
+ */
19
+ normalize(body) {
20
+ let url_ = this.baseUrl + "/primary/v1/address/normalize";
21
+ url_ = url_.replace(/[?&]$/, "");
22
+ const content_ = JSON.stringify(body);
23
+ let options_ = {
24
+ body: content_,
25
+ method: "POST",
26
+ headers: {
27
+ "Content-Type": "application/json",
28
+ "Accept": "application/json"
29
+ }
30
+ };
31
+ return this.http.fetch(url_, options_).then((_response) => {
32
+ return this.processNormalize(_response);
33
+ });
34
+ }
35
+ processNormalize(response) {
36
+ const status = response.status;
37
+ let _headers = {};
38
+ if (response.headers && response.headers.forEach) {
39
+ response.headers.forEach((v, k) => _headers[k] = v);
40
+ }
41
+ ;
42
+ if (status === 200) {
43
+ return response.text().then((_responseText) => {
44
+ let result200 = null;
45
+ let resultData200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
46
+ result200 = NormalizeAddressResponse.fromJS(resultData200);
47
+ return result200;
48
+ });
49
+ }
50
+ else if (status === 400) {
51
+ return response.text().then((_responseText) => {
52
+ let result400 = null;
53
+ let resultData400 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
54
+ result400 = ProblemDetails.fromJS(resultData400);
55
+ return throwException("Bad Request", status, _responseText, _headers, result400);
56
+ });
57
+ }
58
+ else if (status === 500) {
59
+ return response.text().then((_responseText) => {
60
+ return throwException("Internal Server Error", status, _responseText, _headers);
61
+ });
62
+ }
63
+ else if (status !== 200 && status !== 204) {
64
+ return response.text().then((_responseText) => {
65
+ return throwException("An unexpected server error occurred.", status, _responseText, _headers);
66
+ });
67
+ }
68
+ return Promise.resolve(null);
69
+ }
15
70
  /**
16
71
  * Get a Document by ID.
17
72
  * @param id The Document ID for the document to retrieve.
@@ -70,7 +125,8 @@ export class Client {
70
125
  * @param preIPOCompanySPVId (optional) PreIPOCompanySPVId to filter by.
71
126
  * @param preIPOCompanyInvestmentId (optional) PreIPOCompanyInvestmentId to filter by.
72
127
  * @param investorSubscriptionId (optional) InvestorSubscriptionId to filter by.
73
- * @param registeredFundId (optional)
128
+ * @param registeredFundId (optional) RegisteredFundId to filter by.
129
+ * @param registeredFundSubscriptionId (optional) RegisteredFundSubscriptionId to filter by.
74
130
  * @param documentType (optional) Type of document to filter by.
75
131
  * @param exactMatch (optional) Only returns the items exactly matching the parameters given.
76
132
  * @param page (optional) Page number for pagination.
@@ -78,7 +134,7 @@ export class Client {
78
134
  * @param sortOrder (optional)
79
135
  * @return OK
80
136
  */
81
- document2(investorId, preIPOCompanyId, preIPOCompanySPVId, preIPOCompanyInvestmentId, investorSubscriptionId, registeredFundId, documentType, exactMatch, page, pageSize, sortOrder) {
137
+ document2(investorId, preIPOCompanyId, preIPOCompanySPVId, preIPOCompanyInvestmentId, investorSubscriptionId, registeredFundId, registeredFundSubscriptionId, documentType, exactMatch, page, pageSize, sortOrder) {
82
138
  let url_ = this.baseUrl + "/primary/v1/document?";
83
139
  if (investorId === null)
84
140
  throw new Error("The parameter 'investorId' cannot be null.");
@@ -104,6 +160,10 @@ export class Client {
104
160
  throw new Error("The parameter 'registeredFundId' cannot be null.");
105
161
  else if (registeredFundId !== undefined)
106
162
  url_ += "registeredFundId=" + encodeURIComponent("" + registeredFundId) + "&";
163
+ if (registeredFundSubscriptionId === null)
164
+ throw new Error("The parameter 'registeredFundSubscriptionId' cannot be null.");
165
+ else if (registeredFundSubscriptionId !== undefined)
166
+ url_ += "registeredFundSubscriptionId=" + encodeURIComponent("" + registeredFundSubscriptionId) + "&";
107
167
  if (documentType === null)
108
168
  throw new Error("The parameter 'documentType' cannot be null.");
109
169
  else if (documentType !== undefined)
@@ -530,13 +590,18 @@ export class Client {
530
590
  }
531
591
  /**
532
592
  * Get all Financial Institutions
593
+ * @param referenceId (optional) Optional reference Id to filter by.
533
594
  * @param page (optional)
534
595
  * @param pageSize (optional)
535
596
  * @param sortOrder (optional)
536
597
  * @return OK
537
598
  */
538
- financialInstitution2(page, pageSize, sortOrder) {
599
+ financialInstitution2(referenceId, page, pageSize, sortOrder) {
539
600
  let url_ = this.baseUrl + "/primary/v1/financial-institution?";
601
+ if (referenceId === null)
602
+ throw new Error("The parameter 'referenceId' cannot be null.");
603
+ else if (referenceId !== undefined)
604
+ url_ += "referenceId=" + encodeURIComponent("" + referenceId) + "&";
540
605
  if (page === null)
541
606
  throw new Error("The parameter 'page' cannot be null.");
542
607
  else if (page !== undefined)
@@ -582,6 +647,53 @@ export class Client {
582
647
  }
583
648
  return Promise.resolve(null);
584
649
  }
650
+ /**
651
+ * Update an Financial Institution's Reference ID.
652
+ * @param body (optional) The request containing the updated reference information.
653
+ * @return No Content
654
+ */
655
+ reference(body) {
656
+ let url_ = this.baseUrl + "/primary/v1/financial-institution/reference";
657
+ url_ = url_.replace(/[?&]$/, "");
658
+ const content_ = JSON.stringify(body);
659
+ let options_ = {
660
+ body: content_,
661
+ method: "PUT",
662
+ headers: {
663
+ "Content-Type": "application/json",
664
+ }
665
+ };
666
+ return this.http.fetch(url_, options_).then((_response) => {
667
+ return this.processReference(_response);
668
+ });
669
+ }
670
+ processReference(response) {
671
+ const status = response.status;
672
+ let _headers = {};
673
+ if (response.headers && response.headers.forEach) {
674
+ response.headers.forEach((v, k) => _headers[k] = v);
675
+ }
676
+ ;
677
+ if (status === 204) {
678
+ return response.text().then((_responseText) => {
679
+ return;
680
+ });
681
+ }
682
+ else if (status === 404) {
683
+ return response.text().then((_responseText) => {
684
+ let result404 = null;
685
+ let resultData404 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
686
+ result404 = ProblemDetails.fromJS(resultData404);
687
+ return throwException("Not Found", status, _responseText, _headers, result404);
688
+ });
689
+ }
690
+ else if (status !== 200 && status !== 204) {
691
+ return response.text().then((_responseText) => {
692
+ return throwException("An unexpected server error occurred.", status, _responseText, _headers);
693
+ });
694
+ }
695
+ return Promise.resolve(null);
696
+ }
585
697
  /**
586
698
  * Create an Indication of Interest
587
699
  * @param body (optional) create IndicationOfInterest information.
@@ -1498,12 +1610,13 @@ export class Client {
1498
1610
  * @param preIPOCompanyName (optional) Optional Company Name to filter on.
1499
1611
  * @param preIPOCompanySPVName (optional) Optional SPV Name to filter on.
1500
1612
  * @param tradingSymbol (optional) Optional Trading Symbol to filter on.
1613
+ * @param orderReferenceId (optional)
1501
1614
  * @param page (optional)
1502
1615
  * @param pageSize (optional)
1503
1616
  * @param sortOrder (optional)
1504
1617
  * @return OK
1505
1618
  */
1506
- investorSubscriptionGET(preIpoCompanySpvId, investorId, status, preIPOCompanyName, preIPOCompanySPVName, tradingSymbol, page, pageSize, sortOrder) {
1619
+ investorSubscriptionGET(preIpoCompanySpvId, investorId, status, preIPOCompanyName, preIPOCompanySPVName, tradingSymbol, orderReferenceId, page, pageSize, sortOrder) {
1507
1620
  let url_ = this.baseUrl + "/primary/v1/investor-subscription?";
1508
1621
  if (preIpoCompanySpvId === null)
1509
1622
  throw new Error("The parameter 'preIpoCompanySpvId' cannot be null.");
@@ -1529,6 +1642,10 @@ export class Client {
1529
1642
  throw new Error("The parameter 'tradingSymbol' cannot be null.");
1530
1643
  else if (tradingSymbol !== undefined)
1531
1644
  url_ += "tradingSymbol=" + encodeURIComponent("" + tradingSymbol) + "&";
1645
+ if (orderReferenceId === null)
1646
+ throw new Error("The parameter 'orderReferenceId' cannot be null.");
1647
+ else if (orderReferenceId !== undefined)
1648
+ url_ += "orderReferenceId=" + encodeURIComponent("" + orderReferenceId) + "&";
1532
1649
  if (page === null)
1533
1650
  throw new Error("The parameter 'page' cannot be null.");
1534
1651
  else if (page !== undefined)
@@ -3581,7 +3698,7 @@ export class Client {
3581
3698
  return Promise.resolve(null);
3582
3699
  }
3583
3700
  /**
3584
- * Get a PreIPOCompany by Id
3701
+ * Get a PreIPOCompany by Id.
3585
3702
  * @param id ID of the PreIPOCompany to find.
3586
3703
  * @return Returns the PreIPOCompany with the specified Id.
3587
3704
  */
@@ -3649,11 +3766,13 @@ export class Client {
3649
3766
  * @param maxLastValuation (optional) Maximum last valuation filter.
3650
3767
  * @param minTotalFunding (optional) Minimum total funding filter.
3651
3768
  * @param maxTotalFunding (optional) Maximum total funding filter.
3769
+ * @param listingType (optional) Optional listing status filter.
3770
+ * @param isActive (optional) Optional active state filter.
3652
3771
  * @param page (optional) Which page number to return.
3653
3772
  * @param pageSize (optional) The maximum number of items to return in each page, defaults to 25.
3654
3773
  * @return OK
3655
3774
  */
3656
- preIpoCompany2(searchTerm, searchCategories, sortBy, sortOrder, minLastValuation, maxLastValuation, minTotalFunding, maxTotalFunding, page, pageSize) {
3775
+ preIpoCompany2(searchTerm, searchCategories, sortBy, sortOrder, minLastValuation, maxLastValuation, minTotalFunding, maxTotalFunding, listingType, isActive, page, pageSize) {
3657
3776
  let url_ = this.baseUrl + "/primary/v1/pre-ipo-company?";
3658
3777
  if (searchTerm === null)
3659
3778
  throw new Error("The parameter 'searchTerm' cannot be null.");
@@ -3687,6 +3806,14 @@ export class Client {
3687
3806
  throw new Error("The parameter 'maxTotalFunding' cannot be null.");
3688
3807
  else if (maxTotalFunding !== undefined)
3689
3808
  url_ += "maxTotalFunding=" + encodeURIComponent("" + maxTotalFunding) + "&";
3809
+ if (listingType === null)
3810
+ throw new Error("The parameter 'listingType' cannot be null.");
3811
+ else if (listingType !== undefined)
3812
+ url_ += "listingType=" + encodeURIComponent("" + listingType) + "&";
3813
+ if (isActive === null)
3814
+ throw new Error("The parameter 'isActive' cannot be null.");
3815
+ else if (isActive !== undefined)
3816
+ url_ += "isActive=" + encodeURIComponent("" + isActive) + "&";
3690
3817
  if (page === null)
3691
3818
  throw new Error("The parameter 'page' cannot be null.");
3692
3819
  else if (page !== undefined)
@@ -3745,17 +3872,39 @@ export class Client {
3745
3872
  return Promise.resolve(null);
3746
3873
  }
3747
3874
  /**
3748
- * @param includes (optional)
3749
- * @param page (optional)
3750
- * @param pageSize (optional)
3751
- * @return OK
3875
+ * Retrieves a paginated list of detailed PreIPOCompanies with optional filters and includes.
3876
+ Includes More detail such as News, Research, Investments, Spv's and Funding Rounds.
3877
+ * @param filterId (optional) Optional filter ID to narrow down the PreIPOCompanies.
3878
+ * @param filterBy (optional) Optional filter type to categorize the PreIPOCompanies (e.g., Company, Investment, Spv).
3879
+ * @param includes (optional) Optional list of additional data to include with the response (e.g., News, Research, Investments).
3880
+ * @param listingType (optional) Optional listing status filter.
3881
+ * @param isActive (optional) Optional active state filter.
3882
+ * @param page (optional) Page number for pagination, starting from 1.
3883
+ * @param pageSize (optional) Number of items per page for pagination, Default = 25.
3884
+ * @return Returns the filtered and paginated list of detailed PreIPOCompanies.
3752
3885
  */
3753
- detailed(includes, page, pageSize) {
3886
+ detailed(filterId, filterBy, includes, listingType, isActive, page, pageSize) {
3754
3887
  let url_ = this.baseUrl + "/primary/v1/pre-ipo-company/detailed?";
3888
+ if (filterId === null)
3889
+ throw new Error("The parameter 'filterId' cannot be null.");
3890
+ else if (filterId !== undefined)
3891
+ url_ += "filterId=" + encodeURIComponent("" + filterId) + "&";
3892
+ if (filterBy === null)
3893
+ throw new Error("The parameter 'filterBy' cannot be null.");
3894
+ else if (filterBy !== undefined)
3895
+ url_ += "filterBy=" + encodeURIComponent("" + filterBy) + "&";
3755
3896
  if (includes === null)
3756
3897
  throw new Error("The parameter 'includes' cannot be null.");
3757
3898
  else if (includes !== undefined)
3758
3899
  includes && includes.forEach(item => { url_ += "includes=" + encodeURIComponent("" + item) + "&"; });
3900
+ if (listingType === null)
3901
+ throw new Error("The parameter 'listingType' cannot be null.");
3902
+ else if (listingType !== undefined)
3903
+ url_ += "listingType=" + encodeURIComponent("" + listingType) + "&";
3904
+ if (isActive === null)
3905
+ throw new Error("The parameter 'isActive' cannot be null.");
3906
+ else if (isActive !== undefined)
3907
+ url_ += "isActive=" + encodeURIComponent("" + isActive) + "&";
3759
3908
  if (page === null)
3760
3909
  throw new Error("The parameter 'page' cannot be null.");
3761
3910
  else if (page !== undefined)
@@ -3790,6 +3939,22 @@ export class Client {
3790
3939
  return result200;
3791
3940
  });
3792
3941
  }
3942
+ else if (status === 404) {
3943
+ return response.text().then((_responseText) => {
3944
+ let result404 = null;
3945
+ let resultData404 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
3946
+ result404 = ProblemDetails.fromJS(resultData404);
3947
+ return throwException("Not Found", status, _responseText, _headers, result404);
3948
+ });
3949
+ }
3950
+ else if (status === 400) {
3951
+ return response.text().then((_responseText) => {
3952
+ let result400 = null;
3953
+ let resultData400 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
3954
+ result400 = ProblemDetails.fromJS(resultData400);
3955
+ return throwException("Bad Request", status, _responseText, _headers, result400);
3956
+ });
3957
+ }
3793
3958
  else if (status !== 200 && status !== 204) {
3794
3959
  return response.text().then((_responseText) => {
3795
3960
  return throwException("An unexpected server error occurred.", status, _responseText, _headers);
@@ -6111,7 +6276,7 @@ export class BulkPreIPOCompany {
6111
6276
  this.country = _data["country"];
6112
6277
  this.address = _data["address"];
6113
6278
  this.type = _data["type"];
6114
- this.yearEst = _data["yearEst"] ? new Date(_data["yearEst"].toString()) : undefined;
6279
+ this.yearEst = _data["yearEst"];
6115
6280
  this.numJobs = _data["numJobs"];
6116
6281
  this.description = _data["description"];
6117
6282
  this.founder = _data["founder"];
@@ -6202,7 +6367,7 @@ export class BulkPreIPOCompany {
6202
6367
  data["country"] = this.country;
6203
6368
  data["address"] = this.address;
6204
6369
  data["type"] = this.type;
6205
- data["yearEst"] = this.yearEst ? formatDate(this.yearEst) : undefined;
6370
+ data["yearEst"] = this.yearEst;
6206
6371
  data["numJobs"] = this.numJobs;
6207
6372
  data["description"] = this.description;
6208
6373
  data["founder"] = this.founder;
@@ -6657,6 +6822,7 @@ export class CreateInvestorSubscription {
6657
6822
  this.preIPOCompanySPVId = _data["preIPOCompanySPVId"];
6658
6823
  this.investorId = _data["investorId"];
6659
6824
  this.amountReservedDollars = _data["amountReservedDollars"];
6825
+ this.orderReferenceId = _data["orderReferenceId"];
6660
6826
  }
6661
6827
  }
6662
6828
  static fromJS(data) {
@@ -6670,6 +6836,7 @@ export class CreateInvestorSubscription {
6670
6836
  data["preIPOCompanySPVId"] = this.preIPOCompanySPVId;
6671
6837
  data["investorId"] = this.investorId;
6672
6838
  data["amountReservedDollars"] = this.amountReservedDollars;
6839
+ data["orderReferenceId"] = this.orderReferenceId;
6673
6840
  return data;
6674
6841
  }
6675
6842
  }
@@ -6920,6 +7087,7 @@ export class Document {
6920
7087
  this.investorSubscriptionId = _data["investorSubscriptionId"];
6921
7088
  this.partnerId = _data["partnerId"];
6922
7089
  this.registeredFundId = _data["registeredFundId"];
7090
+ this.registeredFundSubscriptionId = _data["registeredFundSubscriptionId"];
6923
7091
  this.type = _data["type"];
6924
7092
  this.templateDocument = _data["templateDocument"];
6925
7093
  this.taxYear = _data["taxYear"];
@@ -6944,6 +7112,7 @@ export class Document {
6944
7112
  data["investorSubscriptionId"] = this.investorSubscriptionId;
6945
7113
  data["partnerId"] = this.partnerId;
6946
7114
  data["registeredFundId"] = this.registeredFundId;
7115
+ data["registeredFundSubscriptionId"] = this.registeredFundSubscriptionId;
6947
7116
  data["type"] = this.type;
6948
7117
  data["templateDocument"] = this.templateDocument;
6949
7118
  data["taxYear"] = this.taxYear;
@@ -7201,6 +7370,7 @@ export class FinancialInstitution {
7201
7370
  this.createdAt = _data["createdAt"] ? new Date(_data["createdAt"].toString()) : undefined;
7202
7371
  this.updatedAt = _data["updatedAt"] ? new Date(_data["updatedAt"].toString()) : undefined;
7203
7372
  this.partner = _data["partner"] ? Partner.fromJS(_data["partner"]) : undefined;
7373
+ this.financialInstitutionReferenceId = _data["financialInstitutionReferenceId"];
7204
7374
  }
7205
7375
  }
7206
7376
  static fromJS(data) {
@@ -7225,6 +7395,7 @@ export class FinancialInstitution {
7225
7395
  data["createdAt"] = this.createdAt ? this.createdAt.toISOString() : undefined;
7226
7396
  data["updatedAt"] = this.updatedAt ? this.updatedAt.toISOString() : undefined;
7227
7397
  data["partner"] = this.partner ? this.partner.toJSON() : undefined;
7398
+ data["financialInstitutionReferenceId"] = this.financialInstitutionReferenceId;
7228
7399
  return data;
7229
7400
  }
7230
7401
  }
@@ -7446,6 +7617,7 @@ export class IndividualEntityInvestor {
7446
7617
  this.qualifiedStatus = _data["qualifiedStatus"];
7447
7618
  this.entityInvestorType = _data["entityInvestorType"];
7448
7619
  this.percentageOwned = _data["percentageOwned"];
7620
+ this.title = _data["title"];
7449
7621
  this.id = _data["id"];
7450
7622
  }
7451
7623
  }
@@ -7486,6 +7658,7 @@ export class IndividualEntityInvestor {
7486
7658
  data["qualifiedStatus"] = this.qualifiedStatus;
7487
7659
  data["entityInvestorType"] = this.entityInvestorType;
7488
7660
  data["percentageOwned"] = this.percentageOwned;
7661
+ data["title"] = this.title;
7489
7662
  data["id"] = this.id;
7490
7663
  return data;
7491
7664
  }
@@ -7530,6 +7703,7 @@ export class IndividualEntityInvestorBase {
7530
7703
  this.qualifiedStatus = _data["qualifiedStatus"];
7531
7704
  this.entityInvestorType = _data["entityInvestorType"];
7532
7705
  this.percentageOwned = _data["percentageOwned"];
7706
+ this.title = _data["title"];
7533
7707
  }
7534
7708
  }
7535
7709
  static fromJS(data) {
@@ -7569,6 +7743,7 @@ export class IndividualEntityInvestorBase {
7569
7743
  data["qualifiedStatus"] = this.qualifiedStatus;
7570
7744
  data["entityInvestorType"] = this.entityInvestorType;
7571
7745
  data["percentageOwned"] = this.percentageOwned;
7746
+ data["title"] = this.title;
7572
7747
  return data;
7573
7748
  }
7574
7749
  }
@@ -8153,6 +8328,76 @@ export class NAVReport {
8153
8328
  return data;
8154
8329
  }
8155
8330
  }
8331
+ export class NormalizeAddressRequest {
8332
+ constructor(data) {
8333
+ if (data) {
8334
+ for (var property in data) {
8335
+ if (data.hasOwnProperty(property))
8336
+ this[property] = data[property];
8337
+ }
8338
+ }
8339
+ }
8340
+ init(_data) {
8341
+ if (_data) {
8342
+ this.street1 = _data["street1"];
8343
+ this.city = _data["city"];
8344
+ this.zipCode = _data["zipCode"];
8345
+ this.country = _data["country"];
8346
+ this.state = _data["state"];
8347
+ this.hint = _data["hint"];
8348
+ }
8349
+ }
8350
+ static fromJS(data) {
8351
+ data = typeof data === 'object' ? data : {};
8352
+ let result = new NormalizeAddressRequest();
8353
+ result.init(data);
8354
+ return result;
8355
+ }
8356
+ toJSON(data) {
8357
+ data = typeof data === 'object' ? data : {};
8358
+ data["street1"] = this.street1;
8359
+ data["city"] = this.city;
8360
+ data["zipCode"] = this.zipCode;
8361
+ data["country"] = this.country;
8362
+ data["state"] = this.state;
8363
+ data["hint"] = this.hint;
8364
+ return data;
8365
+ }
8366
+ }
8367
+ export class NormalizeAddressResponse {
8368
+ constructor(data) {
8369
+ if (data) {
8370
+ for (var property in data) {
8371
+ if (data.hasOwnProperty(property))
8372
+ this[property] = data[property];
8373
+ }
8374
+ }
8375
+ }
8376
+ init(_data) {
8377
+ if (_data) {
8378
+ this.countryCode = _data["countryCode"];
8379
+ this.stateCode = _data["stateCode"];
8380
+ this.countryName = _data["countryName"];
8381
+ this.stateName = _data["stateName"];
8382
+ this.confidence = _data["confidence"];
8383
+ }
8384
+ }
8385
+ static fromJS(data) {
8386
+ data = typeof data === 'object' ? data : {};
8387
+ let result = new NormalizeAddressResponse();
8388
+ result.init(data);
8389
+ return result;
8390
+ }
8391
+ toJSON(data) {
8392
+ data = typeof data === 'object' ? data : {};
8393
+ data["countryCode"] = this.countryCode;
8394
+ data["stateCode"] = this.stateCode;
8395
+ data["countryName"] = this.countryName;
8396
+ data["stateName"] = this.stateName;
8397
+ data["confidence"] = this.confidence;
8398
+ return data;
8399
+ }
8400
+ }
8156
8401
  /** Represents a 409A valuation (NPM/FMV). */
8157
8402
  export class Npm409AValuation {
8158
8403
  constructor(data) {
@@ -9257,7 +9502,7 @@ export class PreIPOCompany {
9257
9502
  this.country = _data["country"];
9258
9503
  this.address = _data["address"];
9259
9504
  this.type = _data["type"];
9260
- this.yearEst = _data["yearEst"] ? new Date(_data["yearEst"].toString()) : undefined;
9505
+ this.yearEst = _data["yearEst"];
9261
9506
  this.numJobs = _data["numJobs"];
9262
9507
  this.description = _data["description"];
9263
9508
  this.founder = _data["founder"];
@@ -9323,7 +9568,7 @@ export class PreIPOCompany {
9323
9568
  data["country"] = this.country;
9324
9569
  data["address"] = this.address;
9325
9570
  data["type"] = this.type;
9326
- data["yearEst"] = this.yearEst ? formatDate(this.yearEst) : undefined;
9571
+ data["yearEst"] = this.yearEst;
9327
9572
  data["numJobs"] = this.numJobs;
9328
9573
  data["description"] = this.description;
9329
9574
  data["founder"] = this.founder;
@@ -10796,6 +11041,34 @@ export class UpdateFinancialAdvisor {
10796
11041
  return data;
10797
11042
  }
10798
11043
  }
11044
+ export class UpdateFinancialInstitutionReferenceId {
11045
+ constructor(data) {
11046
+ if (data) {
11047
+ for (var property in data) {
11048
+ if (data.hasOwnProperty(property))
11049
+ this[property] = data[property];
11050
+ }
11051
+ }
11052
+ }
11053
+ init(_data) {
11054
+ if (_data) {
11055
+ this.financialInstitutionId = _data["financialInstitutionId"];
11056
+ this.financialInstitutionReferenceId = _data["financialInstitutionReferenceId"];
11057
+ }
11058
+ }
11059
+ static fromJS(data) {
11060
+ data = typeof data === 'object' ? data : {};
11061
+ let result = new UpdateFinancialInstitutionReferenceId();
11062
+ result.init(data);
11063
+ return result;
11064
+ }
11065
+ toJSON(data) {
11066
+ data = typeof data === 'object' ? data : {};
11067
+ data["financialInstitutionId"] = this.financialInstitutionId;
11068
+ data["financialInstitutionReferenceId"] = this.financialInstitutionReferenceId;
11069
+ return data;
11070
+ }
11071
+ }
10799
11072
  /** IndicationOfInterest represents the primary offering information on the IoI. */
10800
11073
  export class UpdateIndicationOfInterest {
10801
11074
  constructor(data) {
@@ -10871,6 +11144,7 @@ export class UpdateIndividualEntityInvestor {
10871
11144
  this.qualifiedStatus = _data["qualifiedStatus"];
10872
11145
  this.entityInvestorType = _data["entityInvestorType"];
10873
11146
  this.percentageOwned = _data["percentageOwned"];
11147
+ this.title = _data["title"];
10874
11148
  this.id = _data["id"];
10875
11149
  }
10876
11150
  }
@@ -10911,6 +11185,7 @@ export class UpdateIndividualEntityInvestor {
10911
11185
  data["qualifiedStatus"] = this.qualifiedStatus;
10912
11186
  data["entityInvestorType"] = this.entityInvestorType;
10913
11187
  data["percentageOwned"] = this.percentageOwned;
11188
+ data["title"] = this.title;
10914
11189
  data["id"] = this.id;
10915
11190
  return data;
10916
11191
  }
@@ -11423,6 +11698,7 @@ export var Status;
11423
11698
  Status["Processing"] = "Processing";
11424
11699
  Status["Complete"] = "Complete";
11425
11700
  Status["Rejected"] = "Rejected";
11701
+ Status["Failed"] = "Failed";
11426
11702
  })(Status || (Status = {}));
11427
11703
  export var SortOrder6;
11428
11704
  (function (SortOrder6) {
@@ -11441,6 +11717,12 @@ export var SortOrder7;
11441
11717
  SortOrder7["Ascending"] = "Ascending";
11442
11718
  SortOrder7["Descending"] = "Descending";
11443
11719
  })(SortOrder7 || (SortOrder7 = {}));
11720
+ export var FilterBy;
11721
+ (function (FilterBy) {
11722
+ FilterBy["Company"] = "Company";
11723
+ FilterBy["Investment"] = "Investment";
11724
+ FilterBy["Spv"] = "Spv";
11725
+ })(FilterBy || (FilterBy = {}));
11444
11726
  export var Includes;
11445
11727
  (function (Includes) {
11446
11728
  Includes["News"] = "News";
@@ -11861,6 +12143,7 @@ export var InvestorSubscriptionStatus;
11861
12143
  InvestorSubscriptionStatus["Processing"] = "Processing";
11862
12144
  InvestorSubscriptionStatus["Complete"] = "Complete";
11863
12145
  InvestorSubscriptionStatus["Rejected"] = "Rejected";
12146
+ InvestorSubscriptionStatus["Failed"] = "Failed";
11864
12147
  })(InvestorSubscriptionStatus || (InvestorSubscriptionStatus = {}));
11865
12148
  export var InvestorSubscriptionActionStatus;
11866
12149
  (function (InvestorSubscriptionActionStatus) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@monarkmarkets/api-client",
3
- "version": "1.1.123",
3
+ "version": "1.1.125",
4
4
  "main": "dist/index.js",
5
5
  "module": "dist/index.js",
6
6
  "types": "dist/index.d.ts",