@monarkmarkets/api-client 1.2.19 → 1.2.21
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 +24 -2
- package/dist/Client.js +22 -2
- package/package.json +1 -1
package/dist/Client.d.ts
CHANGED
|
@@ -620,9 +620,10 @@ export declare class Client {
|
|
|
620
620
|
* @param includes (optional) Optional list of additional data to include with the response (e.g., News, Research, Investments).
|
|
621
621
|
* @param listingType (optional) Optional listing status filter.
|
|
622
622
|
* @param isActive (optional) Optional active state filter.
|
|
623
|
+
* @param isApproved (optional) Optional spv partner approval state filter.
|
|
623
624
|
* @return Returns the filtered and paginated list of detailed PreIPOCompanies.
|
|
624
625
|
*/
|
|
625
|
-
getAllDetailedPreIPOCompanies(filterId: string | undefined, filterBy: FilterBy | undefined, page: number | undefined, pageSize: number | undefined, includes: Includes[] | undefined, listingType: string | undefined, isActive: boolean | undefined): Promise<BulkPreIPOCompanyApiResponse>;
|
|
626
|
+
getAllDetailedPreIPOCompanies(filterId: string | undefined, filterBy: FilterBy | undefined, page: number | undefined, pageSize: number | undefined, includes: Includes[] | undefined, listingType: string | undefined, isActive: boolean | undefined, isApproved: boolean | undefined): Promise<BulkPreIPOCompanyApiResponse>;
|
|
626
627
|
protected processGetAllDetailedPreIPOCompanies(response: Response): Promise<BulkPreIPOCompanyApiResponse>;
|
|
627
628
|
/**
|
|
628
629
|
* Get the PreIPOCompanyFundingRound by the specified Id.
|
|
@@ -733,6 +734,7 @@ export declare class Client {
|
|
|
733
734
|
* @param nameFilter (optional) Optional param to filter returned spv's based on the company name.
|
|
734
735
|
* @param preIPOCompanyId (optional) Optional param to only return spv's for the preIPOCompany.
|
|
735
736
|
* @param preIPOCompanyInvestmentId (optional) Optional param to only return spv's for the preIPOCompanyInvestment.
|
|
737
|
+
* @param isApproved (optional) Optional param to filter spvs based on partner approvals.
|
|
736
738
|
* @param page (optional) Number of the page to retrieve.
|
|
737
739
|
Defaults to 1 if not specified.
|
|
738
740
|
* @param pageSize (optional) Size of the page to retrieve.
|
|
@@ -741,7 +743,7 @@ export declare class Client {
|
|
|
741
743
|
* @param sortBy (optional)
|
|
742
744
|
* @return OK
|
|
743
745
|
*/
|
|
744
|
-
getAllPreIPOCompanySPVs(investorId: string, monarkStage: MonarkStage | undefined, exemptionsClaimed: ExemptionsClaimed[] | undefined, nameFilter: string | undefined, preIPOCompanyId: string | undefined, preIPOCompanyInvestmentId: string | undefined, page: number | undefined, pageSize: number | undefined, sortOrder: SortOrder12 | undefined, sortBy: SortBy2 | undefined): Promise<PreIPOCompanySPVApiResponse>;
|
|
746
|
+
getAllPreIPOCompanySPVs(investorId: string, monarkStage: MonarkStage | undefined, exemptionsClaimed: ExemptionsClaimed[] | undefined, nameFilter: string | undefined, preIPOCompanyId: string | undefined, preIPOCompanyInvestmentId: string | undefined, isApproved: boolean | undefined, page: number | undefined, pageSize: number | undefined, sortOrder: SortOrder12 | undefined, sortBy: SortBy2 | undefined): Promise<PreIPOCompanySPVApiResponse>;
|
|
745
747
|
protected processGetAllPreIPOCompanySPVs(response: Response): Promise<PreIPOCompanySPVApiResponse>;
|
|
746
748
|
/**
|
|
747
749
|
* Gets all SPVs that have been approved.
|
|
@@ -1325,6 +1327,10 @@ export declare class BulkPreIPOCompanySPV implements IBulkPreIPOCompanySPV {
|
|
|
1325
1327
|
coManagers?: Partner[] | undefined;
|
|
1326
1328
|
/** Optional carry interest. */
|
|
1327
1329
|
carry?: number | undefined;
|
|
1330
|
+
/** The total number of dollars associated with pending subscriptions. */
|
|
1331
|
+
totalPendingSubscriptionDollars?: number | undefined;
|
|
1332
|
+
/** Indicates whether the SPV is approved for the requesting partner. */
|
|
1333
|
+
isApproved?: boolean;
|
|
1328
1334
|
/** Estimated go live date of the SPV. If the exact go live date is not known, an estimate will be provided. */
|
|
1329
1335
|
goLiveDate?: Date | undefined;
|
|
1330
1336
|
/** List of allowed financial institution IDs for this SPV. */
|
|
@@ -1409,6 +1415,10 @@ export interface IBulkPreIPOCompanySPV {
|
|
|
1409
1415
|
coManagers?: Partner[] | undefined;
|
|
1410
1416
|
/** Optional carry interest. */
|
|
1411
1417
|
carry?: number | undefined;
|
|
1418
|
+
/** The total number of dollars associated with pending subscriptions. */
|
|
1419
|
+
totalPendingSubscriptionDollars?: number | undefined;
|
|
1420
|
+
/** Indicates whether the SPV is approved for the requesting partner. */
|
|
1421
|
+
isApproved?: boolean;
|
|
1412
1422
|
/** Estimated go live date of the SPV. If the exact go live date is not known, an estimate will be provided. */
|
|
1413
1423
|
goLiveDate?: Date | undefined;
|
|
1414
1424
|
/** List of allowed financial institution IDs for this SPV. */
|
|
@@ -4362,6 +4372,8 @@ export declare class Partner implements IPartner {
|
|
|
4362
4372
|
executiveTeam?: string[] | undefined;
|
|
4363
4373
|
/** DBA name for the Partner. */
|
|
4364
4374
|
dbaName?: string | undefined;
|
|
4375
|
+
/** The linked AIP Identification number */
|
|
4376
|
+
aipFirmNumber?: string | undefined;
|
|
4365
4377
|
/** Link to representative logo for management firm. */
|
|
4366
4378
|
logoUrl?: string | undefined;
|
|
4367
4379
|
/** Year when management firm was first established. */
|
|
@@ -4400,6 +4412,8 @@ export interface IPartner {
|
|
|
4400
4412
|
executiveTeam?: string[] | undefined;
|
|
4401
4413
|
/** DBA name for the Partner. */
|
|
4402
4414
|
dbaName?: string | undefined;
|
|
4415
|
+
/** The linked AIP Identification number */
|
|
4416
|
+
aipFirmNumber?: string | undefined;
|
|
4403
4417
|
/** Link to representative logo for management firm. */
|
|
4404
4418
|
logoUrl?: string | undefined;
|
|
4405
4419
|
/** Year when management firm was first established. */
|
|
@@ -5362,6 +5376,10 @@ export declare class PreIPOCompanySPV implements IPreIPOCompanySPV {
|
|
|
5362
5376
|
coManagers?: Partner[] | undefined;
|
|
5363
5377
|
/** Optional carry interest. */
|
|
5364
5378
|
carry?: number | undefined;
|
|
5379
|
+
/** The total number of dollars associated with pending subscriptions. */
|
|
5380
|
+
totalPendingSubscriptionDollars?: number | undefined;
|
|
5381
|
+
/** Indicates whether the SPV is approved for the requesting partner. */
|
|
5382
|
+
isApproved?: boolean;
|
|
5365
5383
|
/** Estimated go live date of the SPV. If the exact go live date is not known, an estimate will be provided. */
|
|
5366
5384
|
goLiveDate?: Date | undefined;
|
|
5367
5385
|
constructor(data?: IPreIPOCompanySPV);
|
|
@@ -5445,6 +5463,10 @@ export interface IPreIPOCompanySPV {
|
|
|
5445
5463
|
coManagers?: Partner[] | undefined;
|
|
5446
5464
|
/** Optional carry interest. */
|
|
5447
5465
|
carry?: number | undefined;
|
|
5466
|
+
/** The total number of dollars associated with pending subscriptions. */
|
|
5467
|
+
totalPendingSubscriptionDollars?: number | undefined;
|
|
5468
|
+
/** Indicates whether the SPV is approved for the requesting partner. */
|
|
5469
|
+
isApproved?: boolean;
|
|
5448
5470
|
/** Estimated go live date of the SPV. If the exact go live date is not known, an estimate will be provided. */
|
|
5449
5471
|
goLiveDate?: Date | undefined;
|
|
5450
5472
|
}
|
package/dist/Client.js
CHANGED
|
@@ -3986,9 +3986,10 @@ export class Client {
|
|
|
3986
3986
|
* @param includes (optional) Optional list of additional data to include with the response (e.g., News, Research, Investments).
|
|
3987
3987
|
* @param listingType (optional) Optional listing status filter.
|
|
3988
3988
|
* @param isActive (optional) Optional active state filter.
|
|
3989
|
+
* @param isApproved (optional) Optional spv partner approval state filter.
|
|
3989
3990
|
* @return Returns the filtered and paginated list of detailed PreIPOCompanies.
|
|
3990
3991
|
*/
|
|
3991
|
-
getAllDetailedPreIPOCompanies(filterId, filterBy, page, pageSize, includes, listingType, isActive) {
|
|
3992
|
+
getAllDetailedPreIPOCompanies(filterId, filterBy, page, pageSize, includes, listingType, isActive, isApproved) {
|
|
3992
3993
|
let url_ = this.baseUrl + "/primary/v1/pre-ipo-company/detailed?";
|
|
3993
3994
|
if (filterId === null)
|
|
3994
3995
|
throw new Error("The parameter 'filterId' cannot be null.");
|
|
@@ -4018,6 +4019,10 @@ export class Client {
|
|
|
4018
4019
|
throw new Error("The parameter 'isActive' cannot be null.");
|
|
4019
4020
|
else if (isActive !== undefined)
|
|
4020
4021
|
url_ += "isActive=" + encodeURIComponent("" + isActive) + "&";
|
|
4022
|
+
if (isApproved === null)
|
|
4023
|
+
throw new Error("The parameter 'isApproved' cannot be null.");
|
|
4024
|
+
else if (isApproved !== undefined)
|
|
4025
|
+
url_ += "isApproved=" + encodeURIComponent("" + isApproved) + "&";
|
|
4021
4026
|
url_ = url_.replace(/[?&]$/, "");
|
|
4022
4027
|
let options_ = {
|
|
4023
4028
|
method: "GET",
|
|
@@ -4808,6 +4813,7 @@ export class Client {
|
|
|
4808
4813
|
* @param nameFilter (optional) Optional param to filter returned spv's based on the company name.
|
|
4809
4814
|
* @param preIPOCompanyId (optional) Optional param to only return spv's for the preIPOCompany.
|
|
4810
4815
|
* @param preIPOCompanyInvestmentId (optional) Optional param to only return spv's for the preIPOCompanyInvestment.
|
|
4816
|
+
* @param isApproved (optional) Optional param to filter spvs based on partner approvals.
|
|
4811
4817
|
* @param page (optional) Number of the page to retrieve.
|
|
4812
4818
|
Defaults to 1 if not specified.
|
|
4813
4819
|
* @param pageSize (optional) Size of the page to retrieve.
|
|
@@ -4816,7 +4822,7 @@ export class Client {
|
|
|
4816
4822
|
* @param sortBy (optional)
|
|
4817
4823
|
* @return OK
|
|
4818
4824
|
*/
|
|
4819
|
-
getAllPreIPOCompanySPVs(investorId, monarkStage, exemptionsClaimed, nameFilter, preIPOCompanyId, preIPOCompanyInvestmentId, page, pageSize, sortOrder, sortBy) {
|
|
4825
|
+
getAllPreIPOCompanySPVs(investorId, monarkStage, exemptionsClaimed, nameFilter, preIPOCompanyId, preIPOCompanyInvestmentId, isApproved, page, pageSize, sortOrder, sortBy) {
|
|
4820
4826
|
let url_ = this.baseUrl + "/primary/v1/pre-ipo-company-spv/investor/{investorId}?";
|
|
4821
4827
|
if (investorId === undefined || investorId === null)
|
|
4822
4828
|
throw new Error("The parameter 'investorId' must be defined.");
|
|
@@ -4841,6 +4847,10 @@ export class Client {
|
|
|
4841
4847
|
throw new Error("The parameter 'preIPOCompanyInvestmentId' cannot be null.");
|
|
4842
4848
|
else if (preIPOCompanyInvestmentId !== undefined)
|
|
4843
4849
|
url_ += "preIPOCompanyInvestmentId=" + encodeURIComponent("" + preIPOCompanyInvestmentId) + "&";
|
|
4850
|
+
if (isApproved === null)
|
|
4851
|
+
throw new Error("The parameter 'isApproved' cannot be null.");
|
|
4852
|
+
else if (isApproved !== undefined)
|
|
4853
|
+
url_ += "isApproved=" + encodeURIComponent("" + isApproved) + "&";
|
|
4844
4854
|
if (page === null)
|
|
4845
4855
|
throw new Error("The parameter 'page' cannot be null.");
|
|
4846
4856
|
else if (page !== undefined)
|
|
@@ -7240,6 +7250,8 @@ export class BulkPreIPOCompanySPV {
|
|
|
7240
7250
|
this.coManagers.push(Partner.fromJS(item));
|
|
7241
7251
|
}
|
|
7242
7252
|
this.carry = _data["carry"];
|
|
7253
|
+
this.totalPendingSubscriptionDollars = _data["totalPendingSubscriptionDollars"];
|
|
7254
|
+
this.isApproved = _data["isApproved"];
|
|
7243
7255
|
this.goLiveDate = _data["goLiveDate"] ? new Date(_data["goLiveDate"].toString()) : undefined;
|
|
7244
7256
|
if (Array.isArray(_data["allowedFinancialInstitutions"])) {
|
|
7245
7257
|
this.allowedFinancialInstitutions = [];
|
|
@@ -7309,6 +7321,8 @@ export class BulkPreIPOCompanySPV {
|
|
|
7309
7321
|
data["coManagers"].push(item.toJSON());
|
|
7310
7322
|
}
|
|
7311
7323
|
data["carry"] = this.carry;
|
|
7324
|
+
data["totalPendingSubscriptionDollars"] = this.totalPendingSubscriptionDollars;
|
|
7325
|
+
data["isApproved"] = this.isApproved;
|
|
7312
7326
|
data["goLiveDate"] = this.goLiveDate ? formatDate(this.goLiveDate) : undefined;
|
|
7313
7327
|
if (Array.isArray(this.allowedFinancialInstitutions)) {
|
|
7314
7328
|
data["allowedFinancialInstitutions"] = [];
|
|
@@ -10669,6 +10683,7 @@ export class Partner {
|
|
|
10669
10683
|
this.executiveTeam.push(item);
|
|
10670
10684
|
}
|
|
10671
10685
|
this.dbaName = _data["dbaName"];
|
|
10686
|
+
this.aipFirmNumber = _data["aipFirmNumber"];
|
|
10672
10687
|
this.logoUrl = _data["logoUrl"];
|
|
10673
10688
|
this.foundingDate = _data["foundingDate"] ? new Date(_data["foundingDate"].toString()) : undefined;
|
|
10674
10689
|
this.aum = _data["aum"];
|
|
@@ -10702,6 +10717,7 @@ export class Partner {
|
|
|
10702
10717
|
data["executiveTeam"].push(item);
|
|
10703
10718
|
}
|
|
10704
10719
|
data["dbaName"] = this.dbaName;
|
|
10720
|
+
data["aipFirmNumber"] = this.aipFirmNumber;
|
|
10705
10721
|
data["logoUrl"] = this.logoUrl;
|
|
10706
10722
|
data["foundingDate"] = this.foundingDate ? formatDate(this.foundingDate) : undefined;
|
|
10707
10723
|
data["aum"] = this.aum;
|
|
@@ -11701,6 +11717,8 @@ export class PreIPOCompanySPV {
|
|
|
11701
11717
|
this.coManagers.push(Partner.fromJS(item));
|
|
11702
11718
|
}
|
|
11703
11719
|
this.carry = _data["carry"];
|
|
11720
|
+
this.totalPendingSubscriptionDollars = _data["totalPendingSubscriptionDollars"];
|
|
11721
|
+
this.isApproved = _data["isApproved"];
|
|
11704
11722
|
this.goLiveDate = _data["goLiveDate"] ? new Date(_data["goLiveDate"].toString()) : undefined;
|
|
11705
11723
|
}
|
|
11706
11724
|
}
|
|
@@ -11765,6 +11783,8 @@ export class PreIPOCompanySPV {
|
|
|
11765
11783
|
data["coManagers"].push(item.toJSON());
|
|
11766
11784
|
}
|
|
11767
11785
|
data["carry"] = this.carry;
|
|
11786
|
+
data["totalPendingSubscriptionDollars"] = this.totalPendingSubscriptionDollars;
|
|
11787
|
+
data["isApproved"] = this.isApproved;
|
|
11768
11788
|
data["goLiveDate"] = this.goLiveDate ? formatDate(this.goLiveDate) : undefined;
|
|
11769
11789
|
return data;
|
|
11770
11790
|
}
|