@monarkmarkets/api-client 1.3.51 → 1.3.53

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
@@ -234,6 +234,7 @@ export declare class Client {
234
234
  * @param searchTerm (optional) Optional search term on the company/target name.
235
235
  * @param investorId (optional) Filter the returned IndicationOfInterests by an InvestorId.
236
236
  * @param targetAssetType (optional) Filter the returned IndicationOfInterests by the primary_offering_api_models.IndicationOfInterests.Enums.IndicationOfInterestTargetAssetType.
237
+ * @param isActive (optional) Filter the IndicationOfInterests by whether it is in the active state.
237
238
  * @param page (optional) Number of the page to retrieve.
238
239
  Defaults to 1 if not specified.
239
240
  * @param pageSize (optional) Size of the page to retrieve.
@@ -242,7 +243,7 @@ export declare class Client {
242
243
  * @param sortOrder (optional) Which direction to sort by.
243
244
  * @return Returns the list of IndicationOfInterest.
244
245
  */
245
- getAllIndicationOfInterestsV2(searchTerm: string | undefined, investorId: string | undefined, targetAssetType: TargetAssetType | undefined, page: number | undefined, pageSize: number | undefined, sortProperty: SortProperty2 | undefined, sortOrder: SortOrder6 | undefined): Promise<IndicationOfInterestV2ApiResponse>;
246
+ getAllIndicationOfInterestsV2(searchTerm: string | undefined, investorId: string | undefined, targetAssetType: TargetAssetType | undefined, isActive: boolean | undefined, page: number | undefined, pageSize: number | undefined, sortProperty: SortProperty2 | undefined, sortOrder: SortOrder6 | undefined): Promise<IndicationOfInterestV2ApiResponse>;
246
247
  protected processGetAllIndicationOfInterestsV2(response: Response): Promise<IndicationOfInterestV2ApiResponse>;
247
248
  /**
248
249
  * Get an IndicationOfInterest by Id.
@@ -1081,9 +1082,10 @@ export declare class Client {
1081
1082
  * Get a Questionnaire by Id
1082
1083
  * @param id ID of the Questionnaire to find.
1083
1084
  * @param investorId (optional) Optional investor ID to filter questions based on Investor details.
1085
+ * @param financialAdvisorId (optional) Optional financial advisor ID to filter questions based on advisor details. Requires investorId to be specified.
1084
1086
  * @return Returns the Questionnaire with the specified Id.
1085
1087
  */
1086
- getQuestionnaireById(id: string, investorId: string | undefined): Promise<Questionnaire>;
1088
+ getQuestionnaireById(id: string, investorId: string | undefined, financialAdvisorId: string | undefined): Promise<Questionnaire>;
1087
1089
  protected processGetQuestionnaireById(response: Response): Promise<Questionnaire>;
1088
1090
  /**
1089
1091
  * Create a QuestionnaireAnswer
@@ -2184,8 +2186,13 @@ export declare class CreateInvestor implements ICreateInvestor {
2184
2186
  /** The Financial Institution ID associated with the Investor.
2185
2187
  If not provided, the default Financial Institution for the Partner will be used. */
2186
2188
  financialInstitutionId?: string | undefined;
2187
- /** The Financial Advisor ID associated with the Investor. */
2189
+ /** The Financial Advisor ID associated with the Investor.
2190
+ For backward compatibility: use this field to assign a single advisor. */
2188
2191
  financialAdvisorId?: string | undefined;
2192
+ /** List of Financial Advisor IDs to associate with the Investor.
2193
+ The first advisor in the list will be marked as primary.
2194
+ Cannot be used together with FinancialAdvisorId. */
2195
+ financialAdvisorIds?: string[] | undefined;
2189
2196
  /** Represents the unique ID provided by a Partner, used to identify an Investor. */
2190
2197
  investorReferenceId: string;
2191
2198
  /** Type of the Investor. */
@@ -2202,8 +2209,13 @@ export interface ICreateInvestor {
2202
2209
  /** The Financial Institution ID associated with the Investor.
2203
2210
  If not provided, the default Financial Institution for the Partner will be used. */
2204
2211
  financialInstitutionId?: string | undefined;
2205
- /** The Financial Advisor ID associated with the Investor. */
2212
+ /** The Financial Advisor ID associated with the Investor.
2213
+ For backward compatibility: use this field to assign a single advisor. */
2206
2214
  financialAdvisorId?: string | undefined;
2215
+ /** List of Financial Advisor IDs to associate with the Investor.
2216
+ The first advisor in the list will be marked as primary.
2217
+ Cannot be used together with FinancialAdvisorId. */
2218
+ financialAdvisorIds?: string[] | undefined;
2207
2219
  /** Represents the unique ID provided by a Partner, used to identify an Investor. */
2208
2220
  investorReferenceId: string;
2209
2221
  /** Type of the Investor. */
@@ -2392,6 +2404,9 @@ export declare class CreateTransaction implements ICreateTransaction {
2392
2404
  isFullExit?: boolean | undefined;
2393
2405
  /** The reference ID of an order submitted. */
2394
2406
  referenceId?: string | undefined;
2407
+ /** The financial advisor ID to assign to this transaction.
2408
+ If not provided, no advisor will be assigned. */
2409
+ financialAdvisorId?: string | undefined;
2395
2410
  constructor(data?: ICreateTransaction);
2396
2411
  init(_data?: any): void;
2397
2412
  static fromJS(data: any): CreateTransaction;
@@ -2414,6 +2429,9 @@ export interface ICreateTransaction {
2414
2429
  isFullExit?: boolean | undefined;
2415
2430
  /** The reference ID of an order submitted. */
2416
2431
  referenceId?: string | undefined;
2432
+ /** The financial advisor ID to assign to this transaction.
2433
+ If not provided, no advisor will be assigned. */
2434
+ financialAdvisorId?: string | undefined;
2417
2435
  }
2418
2436
  /** CreateWatchlist represents the request to create or update a watchlist item. */
2419
2437
  export declare class CreateWatchlist implements ICreateWatchlist {
@@ -3465,6 +3483,8 @@ export declare class IndicationOfInterestV2 implements IIndicationOfInterestV2 {
3465
3483
  investorLastName?: string | undefined;
3466
3484
  /** The name of the target asset (for display purposes). */
3467
3485
  targetName?: string | undefined;
3486
+ /** Specifies whether the IOI is currently available. */
3487
+ isActive?: boolean;
3468
3488
  constructor(data?: IIndicationOfInterestV2);
3469
3489
  init(_data?: any): void;
3470
3490
  static fromJS(data: any): IndicationOfInterestV2;
@@ -3500,6 +3520,8 @@ export interface IIndicationOfInterestV2 {
3500
3520
  investorLastName?: string | undefined;
3501
3521
  /** The name of the target asset (for display purposes). */
3502
3522
  targetName?: string | undefined;
3523
+ /** Specifies whether the IOI is currently available. */
3524
+ isActive?: boolean;
3503
3525
  }
3504
3526
  export declare class IndicationOfInterestV2ApiResponse implements IIndicationOfInterestV2ApiResponse {
3505
3527
  items?: IndicationOfInterestV2[] | undefined;
@@ -3945,8 +3967,12 @@ export declare class Investor implements IInvestor {
3945
3967
  partnerId: string;
3946
3968
  /** The Financial Institution ID associated with the Investor. */
3947
3969
  financialInstitutionId: string | undefined;
3948
- /** The Financial Advisor ID associated with the Investor. */
3970
+ /** The Financial Advisor ID associated with the Investor.
3971
+ For backward compatibility: returns the single advisor ID if investor has exactly one advisor, otherwise null. */
3949
3972
  financialAdvisorId: string | undefined;
3973
+ /** List of Financial Advisor IDs associated with the Investor.
3974
+ Supports many-to-many relationship between investors and advisors. */
3975
+ financialAdvisorIds?: string[] | undefined;
3950
3976
  /** Updated at the specified date. */
3951
3977
  updatedAt?: Date | undefined;
3952
3978
  /** Represents the unique ID provided by a Partner, used to identify an Investor. */
@@ -3982,8 +4008,12 @@ export interface IInvestor {
3982
4008
  partnerId: string;
3983
4009
  /** The Financial Institution ID associated with the Investor. */
3984
4010
  financialInstitutionId: string | undefined;
3985
- /** The Financial Advisor ID associated with the Investor. */
4011
+ /** The Financial Advisor ID associated with the Investor.
4012
+ For backward compatibility: returns the single advisor ID if investor has exactly one advisor, otherwise null. */
3986
4013
  financialAdvisorId: string | undefined;
4014
+ /** List of Financial Advisor IDs associated with the Investor.
4015
+ Supports many-to-many relationship between investors and advisors. */
4016
+ financialAdvisorIds?: string[] | undefined;
3987
4017
  /** Updated at the specified date. */
3988
4018
  updatedAt?: Date | undefined;
3989
4019
  /** Represents the unique ID provided by a Partner, used to identify an Investor. */
@@ -8334,8 +8364,14 @@ export declare class UpdateInvestor implements IUpdateInvestor {
8334
8364
  id: string;
8335
8365
  /** Represents the unique ID provided by a Partner, used to identify an Investor. */
8336
8366
  investorReferenceId?: string | undefined;
8337
- /** The Financial Advisor ID associated with the Investor. */
8367
+ /** The Financial Advisor ID associated with the Investor.
8368
+ For backward compatibility: use this field to update to a single advisor. */
8338
8369
  financialAdvisorId?: string | undefined;
8370
+ /** List of Financial Advisor IDs to associate with the Investor.
8371
+ When provided, replaces all existing advisor associations.
8372
+ The first advisor in the list will be marked as primary.
8373
+ Cannot be used together with FinancialAdvisorId. */
8374
+ financialAdvisorIds?: string[] | undefined;
8339
8375
  constructor(data?: IUpdateInvestor);
8340
8376
  init(_data?: any): void;
8341
8377
  static fromJS(data: any): UpdateInvestor;
@@ -8350,8 +8386,14 @@ export interface IUpdateInvestor {
8350
8386
  id: string;
8351
8387
  /** Represents the unique ID provided by a Partner, used to identify an Investor. */
8352
8388
  investorReferenceId?: string | undefined;
8353
- /** The Financial Advisor ID associated with the Investor. */
8389
+ /** The Financial Advisor ID associated with the Investor.
8390
+ For backward compatibility: use this field to update to a single advisor. */
8354
8391
  financialAdvisorId?: string | undefined;
8392
+ /** List of Financial Advisor IDs to associate with the Investor.
8393
+ When provided, replaces all existing advisor associations.
8394
+ The first advisor in the list will be marked as primary.
8395
+ Cannot be used together with FinancialAdvisorId. */
8396
+ financialAdvisorIds?: string[] | undefined;
8355
8397
  }
8356
8398
  export declare class UpdateInvestorAccreditation implements IUpdateInvestorAccreditation {
8357
8399
  investorId: string;
package/dist/Client.js CHANGED
@@ -1434,6 +1434,7 @@ export class Client {
1434
1434
  * @param searchTerm (optional) Optional search term on the company/target name.
1435
1435
  * @param investorId (optional) Filter the returned IndicationOfInterests by an InvestorId.
1436
1436
  * @param targetAssetType (optional) Filter the returned IndicationOfInterests by the primary_offering_api_models.IndicationOfInterests.Enums.IndicationOfInterestTargetAssetType.
1437
+ * @param isActive (optional) Filter the IndicationOfInterests by whether it is in the active state.
1437
1438
  * @param page (optional) Number of the page to retrieve.
1438
1439
  Defaults to 1 if not specified.
1439
1440
  * @param pageSize (optional) Size of the page to retrieve.
@@ -1442,7 +1443,7 @@ export class Client {
1442
1443
  * @param sortOrder (optional) Which direction to sort by.
1443
1444
  * @return Returns the list of IndicationOfInterest.
1444
1445
  */
1445
- getAllIndicationOfInterestsV2(searchTerm, investorId, targetAssetType, page, pageSize, sortProperty, sortOrder) {
1446
+ getAllIndicationOfInterestsV2(searchTerm, investorId, targetAssetType, isActive, page, pageSize, sortProperty, sortOrder) {
1446
1447
  let url_ = this.baseUrl + "/primary/v2/indication-of-interest?";
1447
1448
  if (searchTerm === null)
1448
1449
  throw new globalThis.Error("The parameter 'searchTerm' cannot be null.");
@@ -1456,6 +1457,10 @@ export class Client {
1456
1457
  throw new globalThis.Error("The parameter 'targetAssetType' cannot be null.");
1457
1458
  else if (targetAssetType !== undefined)
1458
1459
  url_ += "targetAssetType=" + encodeURIComponent("" + targetAssetType) + "&";
1460
+ if (isActive === null)
1461
+ throw new globalThis.Error("The parameter 'isActive' cannot be null.");
1462
+ else if (isActive !== undefined)
1463
+ url_ += "isActive=" + encodeURIComponent("" + isActive) + "&";
1459
1464
  if (page === null)
1460
1465
  throw new globalThis.Error("The parameter 'page' cannot be null.");
1461
1466
  else if (page !== undefined)
@@ -6935,9 +6940,10 @@ export class Client {
6935
6940
  * Get a Questionnaire by Id
6936
6941
  * @param id ID of the Questionnaire to find.
6937
6942
  * @param investorId (optional) Optional investor ID to filter questions based on Investor details.
6943
+ * @param financialAdvisorId (optional) Optional financial advisor ID to filter questions based on advisor details. Requires investorId to be specified.
6938
6944
  * @return Returns the Questionnaire with the specified Id.
6939
6945
  */
6940
- getQuestionnaireById(id, investorId) {
6946
+ getQuestionnaireById(id, investorId, financialAdvisorId) {
6941
6947
  let url_ = this.baseUrl + "/primary/v1/questionnaire/{id}?";
6942
6948
  if (id === undefined || id === null)
6943
6949
  throw new globalThis.Error("The parameter 'id' must be defined.");
@@ -6946,6 +6952,10 @@ export class Client {
6946
6952
  throw new globalThis.Error("The parameter 'investorId' cannot be null.");
6947
6953
  else if (investorId !== undefined)
6948
6954
  url_ += "investorId=" + encodeURIComponent("" + investorId) + "&";
6955
+ if (financialAdvisorId === null)
6956
+ throw new globalThis.Error("The parameter 'financialAdvisorId' cannot be null.");
6957
+ else if (financialAdvisorId !== undefined)
6958
+ url_ += "financialAdvisorId=" + encodeURIComponent("" + financialAdvisorId) + "&";
6949
6959
  url_ = url_.replace(/[?&]$/, "");
6950
6960
  let options_ = {
6951
6961
  method: "GET",
@@ -6972,6 +6982,14 @@ export class Client {
6972
6982
  return result200;
6973
6983
  });
6974
6984
  }
6985
+ else if (status === 400) {
6986
+ return response.text().then((_responseText) => {
6987
+ let result400 = null;
6988
+ let resultData400 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
6989
+ result400 = ProblemDetails.fromJS(resultData400);
6990
+ return throwException("financialAdvisorId was provided without investorId.", status, _responseText, _headers, result400);
6991
+ });
6992
+ }
6975
6993
  else if (status === 404) {
6976
6994
  return response.text().then((_responseText) => {
6977
6995
  let result404 = null;
@@ -10499,6 +10517,11 @@ export class CreateInvestor {
10499
10517
  if (_data) {
10500
10518
  this.financialInstitutionId = _data["financialInstitutionId"];
10501
10519
  this.financialAdvisorId = _data["financialAdvisorId"];
10520
+ if (Array.isArray(_data["financialAdvisorIds"])) {
10521
+ this.financialAdvisorIds = [];
10522
+ for (let item of _data["financialAdvisorIds"])
10523
+ this.financialAdvisorIds.push(item);
10524
+ }
10502
10525
  this.investorReferenceId = _data["investorReferenceId"];
10503
10526
  this.type = _data["type"];
10504
10527
  this.pii = _data["pii"] ? InvestorPii.fromJS(_data["pii"]) : undefined;
@@ -10514,6 +10537,11 @@ export class CreateInvestor {
10514
10537
  data = typeof data === 'object' ? data : {};
10515
10538
  data["financialInstitutionId"] = this.financialInstitutionId;
10516
10539
  data["financialAdvisorId"] = this.financialAdvisorId;
10540
+ if (Array.isArray(this.financialAdvisorIds)) {
10541
+ data["financialAdvisorIds"] = [];
10542
+ for (let item of this.financialAdvisorIds)
10543
+ data["financialAdvisorIds"].push(item);
10544
+ }
10517
10545
  data["investorReferenceId"] = this.investorReferenceId;
10518
10546
  data["type"] = this.type;
10519
10547
  data["pii"] = this.pii ? this.pii.toJSON() : undefined;
@@ -10792,6 +10820,7 @@ export class CreateTransaction {
10792
10820
  this.amountShares = _data["amountShares"];
10793
10821
  this.isFullExit = _data["isFullExit"];
10794
10822
  this.referenceId = _data["referenceId"];
10823
+ this.financialAdvisorId = _data["financialAdvisorId"];
10795
10824
  }
10796
10825
  }
10797
10826
  static fromJS(data) {
@@ -10810,6 +10839,7 @@ export class CreateTransaction {
10810
10839
  data["amountShares"] = this.amountShares;
10811
10840
  data["isFullExit"] = this.isFullExit;
10812
10841
  data["referenceId"] = this.referenceId;
10842
+ data["financialAdvisorId"] = this.financialAdvisorId;
10813
10843
  return data;
10814
10844
  }
10815
10845
  }
@@ -12131,6 +12161,7 @@ export class IndicationOfInterestV2 {
12131
12161
  this.investorFirstName = _data["investorFirstName"];
12132
12162
  this.investorLastName = _data["investorLastName"];
12133
12163
  this.targetName = _data["targetName"];
12164
+ this.isActive = _data["isActive"];
12134
12165
  }
12135
12166
  }
12136
12167
  static fromJS(data) {
@@ -12155,6 +12186,7 @@ export class IndicationOfInterestV2 {
12155
12186
  data["investorFirstName"] = this.investorFirstName;
12156
12187
  data["investorLastName"] = this.investorLastName;
12157
12188
  data["targetName"] = this.targetName;
12189
+ data["isActive"] = this.isActive;
12158
12190
  return data;
12159
12191
  }
12160
12192
  }
@@ -12491,6 +12523,11 @@ export class Investor {
12491
12523
  this.partnerId = _data["partnerId"];
12492
12524
  this.financialInstitutionId = _data["financialInstitutionId"];
12493
12525
  this.financialAdvisorId = _data["financialAdvisorId"];
12526
+ if (Array.isArray(_data["financialAdvisorIds"])) {
12527
+ this.financialAdvisorIds = [];
12528
+ for (let item of _data["financialAdvisorIds"])
12529
+ this.financialAdvisorIds.push(item);
12530
+ }
12494
12531
  this.updatedAt = _data["updatedAt"] ? new Date(_data["updatedAt"].toString()) : undefined;
12495
12532
  this.investorReferenceId = _data["investorReferenceId"];
12496
12533
  this.status = _data["status"];
@@ -12516,6 +12553,11 @@ export class Investor {
12516
12553
  data["partnerId"] = this.partnerId;
12517
12554
  data["financialInstitutionId"] = this.financialInstitutionId;
12518
12555
  data["financialAdvisorId"] = this.financialAdvisorId;
12556
+ if (Array.isArray(this.financialAdvisorIds)) {
12557
+ data["financialAdvisorIds"] = [];
12558
+ for (let item of this.financialAdvisorIds)
12559
+ data["financialAdvisorIds"].push(item);
12560
+ }
12519
12561
  data["updatedAt"] = this.updatedAt ? this.updatedAt.toISOString() : undefined;
12520
12562
  data["investorReferenceId"] = this.investorReferenceId;
12521
12563
  data["status"] = this.status;
@@ -17518,6 +17560,11 @@ export class UpdateInvestor {
17518
17560
  this.id = _data["id"];
17519
17561
  this.investorReferenceId = _data["investorReferenceId"];
17520
17562
  this.financialAdvisorId = _data["financialAdvisorId"];
17563
+ if (Array.isArray(_data["financialAdvisorIds"])) {
17564
+ this.financialAdvisorIds = [];
17565
+ for (let item of _data["financialAdvisorIds"])
17566
+ this.financialAdvisorIds.push(item);
17567
+ }
17521
17568
  }
17522
17569
  }
17523
17570
  static fromJS(data) {
@@ -17533,6 +17580,11 @@ export class UpdateInvestor {
17533
17580
  data["id"] = this.id;
17534
17581
  data["investorReferenceId"] = this.investorReferenceId;
17535
17582
  data["financialAdvisorId"] = this.financialAdvisorId;
17583
+ if (Array.isArray(this.financialAdvisorIds)) {
17584
+ data["financialAdvisorIds"] = [];
17585
+ for (let item of this.financialAdvisorIds)
17586
+ data["financialAdvisorIds"].push(item);
17587
+ }
17536
17588
  return data;
17537
17589
  }
17538
17590
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@monarkmarkets/api-client",
3
- "version": "1.3.51",
3
+ "version": "1.3.53",
4
4
  "main": "dist/index.js",
5
5
  "module": "dist/index.js",
6
6
  "types": "dist/index.d.ts",