@monarkmarkets/api-client 1.1.113 → 1.1.115

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.
Files changed (3) hide show
  1. package/dist/Client.d.ts +689 -8
  2. package/dist/Client.js +2423 -1244
  3. package/package.json +1 -1
package/dist/Client.d.ts CHANGED
@@ -220,12 +220,13 @@ export declare class Client {
220
220
  * @param status (optional) Optional subscription status to filter on.
221
221
  * @param preIPOCompanyName (optional) Optional Company Name to filter on.
222
222
  * @param preIPOCompanySPVName (optional) Optional SPV Name to filter on.
223
+ * @param tradingSymbol (optional) Optional Trading Symbol to filter on.
223
224
  * @param page (optional)
224
225
  * @param pageSize (optional)
225
226
  * @param sortOrder (optional)
226
227
  * @return OK
227
228
  */
228
- investorSubscriptionGET(preIpoCompanySpvId: string | undefined, investorId: string | undefined, status: Status | undefined, preIPOCompanyName: string | undefined, preIPOCompanySPVName: string | undefined, page: number | undefined, pageSize: number | undefined, sortOrder: SortOrder6 | undefined): Promise<InvestorSubscriptionApiResponse>;
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>;
229
230
  protected processInvestorSubscriptionGET(response: Response): Promise<InvestorSubscriptionApiResponse>;
230
231
  /**
231
232
  * Update an InvestorSubscription.
@@ -455,6 +456,71 @@ export declare class Client {
455
456
  */
456
457
  partner(): Promise<Partner>;
457
458
  protected processPartner(response: Response): Promise<Partner>;
459
+ /**
460
+ * Gets a PMI feed pricing record by ID.
461
+ * @param id The PMI feed pricing ID.
462
+ * @param financialInstitutionId The financial institution ID.
463
+ * @return Returns the PmiFeedPricing with the specified Id.
464
+ */
465
+ getPmiFeedPricingById(id: string, financialInstitutionId: string): Promise<PmiFeedPricing>;
466
+ protected processGetPmiFeedPricingById(response: Response): Promise<PmiFeedPricing>;
467
+ /**
468
+ * Gets all PMI feed pricing records with optional filtering.
469
+ * @param financialInstitutionId The financial institution ID.
470
+ * @param preIPOCompanyId (optional) Optional filter by PreIPO Company ID.
471
+ * @param pmiId (optional) Optional filter by PMI Id.
472
+ * @param displayName (optional) Optional filter by Display Name.
473
+ * @param currency (optional) Optional filter by Currency (e.g., USD, EUR).
474
+ * @param fromDate (optional) Optional filter by minimum date (YYYY-MM-DD).
475
+ * @param toDate (optional) Optional filter by maximum date (YYYY-MM-DD).
476
+ * @param pageNumber (optional) Pagination page number.
477
+ * @param pageSize (optional) Pagination page size.
478
+ * @return Returns the list of PmiFeedPricing.
479
+ */
480
+ getAllPmiFeedPricing(financialInstitutionId: string, preIPOCompanyId: string | undefined, pmiId: string | undefined, displayName: string | undefined, currency: string | undefined, fromDate: Date | undefined, toDate: Date | undefined, pageNumber: number | undefined, pageSize: number | undefined): Promise<PmiFeedPricingApiResponse>;
481
+ protected processGetAllPmiFeedPricing(response: Response): Promise<PmiFeedPricingApiResponse>;
482
+ /**
483
+ * Gets a PMI issuer record by ID.
484
+ * @param id The PMI issuer ID.
485
+ * @param financialInstitutionId The financial institution ID.
486
+ * @return Returns the PmiIssuer with the specified Id.
487
+ */
488
+ getPmiIssuerById(id: string, financialInstitutionId: string): Promise<PmiIssuer>;
489
+ protected processGetPmiIssuerById(response: Response): Promise<PmiIssuer>;
490
+ /**
491
+ * Gets all PMI issuer records with optional filtering.
492
+ * @param financialInstitutionId The financial institution ID.
493
+ * @param preIPOCompanyId (optional) Optional filter by PreIPO Company ID.
494
+ * @param infoId (optional) Optional filter by PMI Id.
495
+ * @param infoDisplayName (optional) Optional filter by Display Name.
496
+ * @param pageNumber (optional) Pagination page number.
497
+ * @param pageSize (optional) Pagination page size.
498
+ * @return Returns the list of PmiIssuer.
499
+ */
500
+ getAllPmiIssuers(financialInstitutionId: string, preIPOCompanyId: string | undefined, infoId: string | undefined, infoDisplayName: string | undefined, pageNumber: number | undefined, pageSize: number | undefined): Promise<PmiIssuerApiResponse>;
501
+ protected processGetAllPmiIssuers(response: Response): Promise<PmiIssuerApiResponse>;
502
+ /**
503
+ * Gets a PMI valuation record by ID.
504
+ * @param id The PMI valuation ID.
505
+ * @param financialInstitutionId The financial institution ID.
506
+ * @return Returns the PmiValuation with the specified Id.
507
+ */
508
+ getPmiValuationById(id: string, financialInstitutionId: string): Promise<PmiValuation>;
509
+ protected processGetPmiValuationById(response: Response): Promise<PmiValuation>;
510
+ /**
511
+ * Gets all PMI valuation records with optional filtering.
512
+ * @param financialInstitutionId The financial institution ID.
513
+ * @param preIPOCompanyId (optional) Optional filter by PreIPO Company ID.
514
+ * @param pmiId (optional) Optional filter by PMI Id.
515
+ * @param displayName (optional) Optional filter by Display Name.
516
+ * @param fromDate (optional) Optional filter by minimum date (YYYY-MM-DD).
517
+ * @param toDate (optional) Optional filter by maximum date (YYYY-MM-DD).
518
+ * @param pageNumber (optional) Pagination page number.
519
+ * @param pageSize (optional) Pagination page size.
520
+ * @return Returns the list of PmiValuation.
521
+ */
522
+ 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
+ protected processGetAllPmiValuations(response: Response): Promise<PmiValuationApiResponse>;
458
524
  /**
459
525
  * Get a PreIPOCompany by Id
460
526
  * @param id ID of the PreIPOCompany to find.
@@ -587,12 +653,17 @@ export declare class Client {
587
653
  investorGET6(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>;
588
654
  protected processInvestorGET6(response: Response): Promise<PreIPOCompanySPVApiResponse>;
589
655
  /**
590
- * Get a Questionnaire by Id
591
- * @param id ID of the Questionnaire to find.
592
- * @return Returns the Questionnaire with the specified Id.
656
+ * @param body (optional)
657
+ * @return Created
593
658
  */
594
- questionnaire(id: string): Promise<Questionnaire>;
595
- protected processQuestionnaire(response: Response): Promise<Questionnaire>;
659
+ questionnairePOST(body: CreateQuestionnaire | undefined): Promise<Questionnaire>;
660
+ protected processQuestionnairePOST(response: Response): Promise<Questionnaire>;
661
+ /**
662
+ * @param body (optional)
663
+ * @return OK
664
+ */
665
+ questionnairePUT(body: UpdateQuestionnaire | undefined): Promise<Questionnaire>;
666
+ protected processQuestionnairePUT(response: Response): Promise<Questionnaire>;
596
667
  /**
597
668
  * Get all Questionnaires
598
669
  * @param page (optional)
@@ -600,8 +671,20 @@ export declare class Client {
600
671
  * @param sortOrder (optional)
601
672
  * @return Returns the list of Questionnaires.
602
673
  */
603
- questionnaire2(page: number | undefined, pageSize: number | undefined, sortOrder: SortOrder13 | undefined): Promise<QuestionnaireApiResponse>;
604
- protected processQuestionnaire2(response: Response): Promise<QuestionnaireApiResponse>;
674
+ questionnaireGET(page: number | undefined, pageSize: number | undefined, sortOrder: SortOrder13 | undefined): Promise<QuestionnaireApiResponse>;
675
+ protected processQuestionnaireGET(response: Response): Promise<QuestionnaireApiResponse>;
676
+ /**
677
+ * @return No Content
678
+ */
679
+ questionnaireDELETE(id: string): Promise<void>;
680
+ protected processQuestionnaireDELETE(response: Response): Promise<void>;
681
+ /**
682
+ * Get a Questionnaire by Id
683
+ * @param id ID of the Questionnaire to find.
684
+ * @return Returns the Questionnaire with the specified Id.
685
+ */
686
+ questionnaireGET2(id: string): Promise<Questionnaire>;
687
+ protected processQuestionnaireGET2(response: Response): Promise<Questionnaire>;
605
688
  /**
606
689
  * Create a QuestionnaireAnswer
607
690
  * @param body (optional) create QuestionnaireAnswer information.
@@ -1302,6 +1385,28 @@ export interface ICreateInvestorSubscription {
1302
1385
  /** Describes the amount, in dollars, an Investor intends to invest into an SPV. */
1303
1386
  amountReservedDollars: number;
1304
1387
  }
1388
+ /** Create Questionnaire allows the creation of a questionaire with the primary offerring. */
1389
+ export declare class CreateQuestionnaire implements ICreateQuestionnaire {
1390
+ /** Name of Questionnaire. */
1391
+ name: string;
1392
+ /** Title of Questionnaire. */
1393
+ title: string;
1394
+ /** Questions to create with the questionnaire. */
1395
+ createQuestions: CreateQuestionnaireQuestion[];
1396
+ constructor(data?: ICreateQuestionnaire);
1397
+ init(_data?: any): void;
1398
+ static fromJS(data: any): CreateQuestionnaire;
1399
+ toJSON(data?: any): any;
1400
+ }
1401
+ /** Create Questionnaire allows the creation of a questionaire with the primary offerring. */
1402
+ export interface ICreateQuestionnaire {
1403
+ /** Name of Questionnaire. */
1404
+ name: string;
1405
+ /** Title of Questionnaire. */
1406
+ title: string;
1407
+ /** Questions to create with the questionnaire. */
1408
+ createQuestions: CreateQuestionnaireQuestion[];
1409
+ }
1305
1410
  /** Create the Questionnaire answer. */
1306
1411
  export declare class CreateQuestionnaireAnswer implements ICreateQuestionnaireAnswer {
1307
1412
  /** Unique ID of the Questionnaire being answered. */
@@ -1324,6 +1429,56 @@ export interface ICreateQuestionnaireAnswer {
1324
1429
  /** Pairing of all the Questions and Investor-provided responses associated with the Questionnaire. */
1325
1430
  createQuestionAnswers: CreateQuestionnaireQuestionAnswer[];
1326
1431
  }
1432
+ /** Create Questionnaire Question. */
1433
+ export declare class CreateQuestionnaireQuestion implements ICreateQuestionnaireQuestion {
1434
+ /** Identifier for the question. */
1435
+ identifier: string;
1436
+ /** Order sequence of the question within the Questionnaire. */
1437
+ sequence: number;
1438
+ /** Question status, could be active or disabled. Questions can be set to disabled and new questions created if a Partners elects to edit one or more of the questions presented to their Investors. */
1439
+ status: CreateQuestionnaireQuestionStatus;
1440
+ /** Text of the question. */
1441
+ text: string;
1442
+ /** An explanation of the question presented within a Questionnaire. Helps the Investor understand the question being asked by providing additional context. */
1443
+ explanation: string | undefined;
1444
+ /** Format of the question. */
1445
+ format: CreateQuestionnaireQuestionFormat;
1446
+ /** A list of potential answers associated with a question. */
1447
+ options?: string[] | undefined;
1448
+ /** Optional minimum value for a scale question. */
1449
+ scaleMin?: number | undefined;
1450
+ /** Optional maximum value for a scale question. */
1451
+ scaleMax?: number | undefined;
1452
+ /** Optional step value for a scale question. */
1453
+ scaleStep?: number | undefined;
1454
+ constructor(data?: ICreateQuestionnaireQuestion);
1455
+ init(_data?: any): void;
1456
+ static fromJS(data: any): CreateQuestionnaireQuestion;
1457
+ toJSON(data?: any): any;
1458
+ }
1459
+ /** Create Questionnaire Question. */
1460
+ export interface ICreateQuestionnaireQuestion {
1461
+ /** Identifier for the question. */
1462
+ identifier: string;
1463
+ /** Order sequence of the question within the Questionnaire. */
1464
+ sequence: number;
1465
+ /** Question status, could be active or disabled. Questions can be set to disabled and new questions created if a Partners elects to edit one or more of the questions presented to their Investors. */
1466
+ status: CreateQuestionnaireQuestionStatus;
1467
+ /** Text of the question. */
1468
+ text: string;
1469
+ /** An explanation of the question presented within a Questionnaire. Helps the Investor understand the question being asked by providing additional context. */
1470
+ explanation: string | undefined;
1471
+ /** Format of the question. */
1472
+ format: CreateQuestionnaireQuestionFormat;
1473
+ /** A list of potential answers associated with a question. */
1474
+ options?: string[] | undefined;
1475
+ /** Optional minimum value for a scale question. */
1476
+ scaleMin?: number | undefined;
1477
+ /** Optional maximum value for a scale question. */
1478
+ scaleMax?: number | undefined;
1479
+ /** Optional step value for a scale question. */
1480
+ scaleStep?: number | undefined;
1481
+ }
1327
1482
  /** Create the Questionnaire Question Answer. */
1328
1483
  export declare class CreateQuestionnaireQuestionAnswer implements ICreateQuestionnaireQuestionAnswer {
1329
1484
  /** Questionnaire QuestionId of the question being answered. */
@@ -3426,6 +3581,422 @@ export interface IPartner {
3426
3581
  all CRD numbers can be listed here. */
3427
3582
  managerCRD?: string[] | undefined;
3428
3583
  }
3584
+ /** Read model representing a PMI feed composite derived pricing record returned by the API. */
3585
+ export declare class PmiFeedPricing implements IPmiFeedPricing {
3586
+ /** Unique identifier of this record. */
3587
+ id: string;
3588
+ /** The unique ID of the PreIPOCompany associated with this record. */
3589
+ preIPOCompanyId: string;
3590
+ /** Date when data was updated by PMI. */
3591
+ pmiUpdatedAt?: Date | undefined;
3592
+ /** Unique ID given to each company by PMI - used as business key for upsert operations. */
3593
+ pmiId: string | undefined;
3594
+ /** Name commonly used by issuer. */
3595
+ displayName: string | undefined;
3596
+ /** Date of composite price. */
3597
+ date: Date;
3598
+ /** Composite price calculated from broker contributed data. */
3599
+ price?: number | undefined;
3600
+ derivedPrice?: number | undefined;
3601
+ /** Uses composite price when depth_90_day is 2+, otherwise uses derived price if available. */
3602
+ combinedPrice?: number | undefined;
3603
+ /** Composite price calculated from broker contributed data, unadjusted for splits. */
3604
+ unadjustedPrice?: number | undefined;
3605
+ unadjustedDerivedPrice?: number | undefined;
3606
+ /** Uses composite price when depth_90_day is 2+, otherwise uses derived price if available. Unadjusted for splits. */
3607
+ unadjustedCombinedPrice?: number | undefined;
3608
+ /** Number of transactions. */
3609
+ depth90Day?: number | undefined;
3610
+ /** Standard deviation within last 90 days of date or ingestion_date. */
3611
+ stdev90Day?: number | undefined;
3612
+ /** Standard deviation within last 5 days of date or ingestion_date. */
3613
+ stdevRecent5?: number | undefined;
3614
+ /** Volatility based on composite price within last 90 days of date or ingestion_date. */
3615
+ volatility90Day?: number | undefined;
3616
+ /** Volatility based on underlying contributions within last 90 days of date or ingestion_date. */
3617
+ underlyingVolatility90Day?: number | undefined;
3618
+ /** Total bid volume at the end of month and if latest date then the last n days where n is the number of days in prior month. */
3619
+ bidVolume?: number | undefined;
3620
+ /** Total bid count at the end of month and if latest date then the last n days where n is the number of days in prior month. */
3621
+ numberOfBids?: number | undefined;
3622
+ /** Total ask volume at the end of month and if latest date then the last n days where n is the number of days in prior month. */
3623
+ askVolume?: number | undefined;
3624
+ /** Total ask count at the end of month and if latest date then the last n days where n is the number of days in prior month. */
3625
+ numberOfAsks?: number | undefined;
3626
+ /** Total trade volume at the end of month and if latest date then the last n days where n is the number of days in prior month. */
3627
+ tradeVolume?: number | undefined;
3628
+ /** Total trade count at the end of month and if latest date then the last n days where n is the number of days in prior month. */
3629
+ numberOfTrades?: number | undefined;
3630
+ /** Type of currency such as EUR, AUD and USD. */
3631
+ currency?: string | undefined;
3632
+ constructor(data?: IPmiFeedPricing);
3633
+ init(_data?: any): void;
3634
+ static fromJS(data: any): PmiFeedPricing;
3635
+ toJSON(data?: any): any;
3636
+ }
3637
+ /** Read model representing a PMI feed composite derived pricing record returned by the API. */
3638
+ export interface IPmiFeedPricing {
3639
+ /** Unique identifier of this record. */
3640
+ id: string;
3641
+ /** The unique ID of the PreIPOCompany associated with this record. */
3642
+ preIPOCompanyId: string;
3643
+ /** Date when data was updated by PMI. */
3644
+ pmiUpdatedAt?: Date | undefined;
3645
+ /** Unique ID given to each company by PMI - used as business key for upsert operations. */
3646
+ pmiId: string | undefined;
3647
+ /** Name commonly used by issuer. */
3648
+ displayName: string | undefined;
3649
+ /** Date of composite price. */
3650
+ date: Date;
3651
+ /** Composite price calculated from broker contributed data. */
3652
+ price?: number | undefined;
3653
+ derivedPrice?: number | undefined;
3654
+ /** Uses composite price when depth_90_day is 2+, otherwise uses derived price if available. */
3655
+ combinedPrice?: number | undefined;
3656
+ /** Composite price calculated from broker contributed data, unadjusted for splits. */
3657
+ unadjustedPrice?: number | undefined;
3658
+ unadjustedDerivedPrice?: number | undefined;
3659
+ /** Uses composite price when depth_90_day is 2+, otherwise uses derived price if available. Unadjusted for splits. */
3660
+ unadjustedCombinedPrice?: number | undefined;
3661
+ /** Number of transactions. */
3662
+ depth90Day?: number | undefined;
3663
+ /** Standard deviation within last 90 days of date or ingestion_date. */
3664
+ stdev90Day?: number | undefined;
3665
+ /** Standard deviation within last 5 days of date or ingestion_date. */
3666
+ stdevRecent5?: number | undefined;
3667
+ /** Volatility based on composite price within last 90 days of date or ingestion_date. */
3668
+ volatility90Day?: number | undefined;
3669
+ /** Volatility based on underlying contributions within last 90 days of date or ingestion_date. */
3670
+ underlyingVolatility90Day?: number | undefined;
3671
+ /** Total bid volume at the end of month and if latest date then the last n days where n is the number of days in prior month. */
3672
+ bidVolume?: number | undefined;
3673
+ /** Total bid count at the end of month and if latest date then the last n days where n is the number of days in prior month. */
3674
+ numberOfBids?: number | undefined;
3675
+ /** Total ask volume at the end of month and if latest date then the last n days where n is the number of days in prior month. */
3676
+ askVolume?: number | undefined;
3677
+ /** Total ask count at the end of month and if latest date then the last n days where n is the number of days in prior month. */
3678
+ numberOfAsks?: number | undefined;
3679
+ /** Total trade volume at the end of month and if latest date then the last n days where n is the number of days in prior month. */
3680
+ tradeVolume?: number | undefined;
3681
+ /** Total trade count at the end of month and if latest date then the last n days where n is the number of days in prior month. */
3682
+ numberOfTrades?: number | undefined;
3683
+ /** Type of currency such as EUR, AUD and USD. */
3684
+ currency?: string | undefined;
3685
+ }
3686
+ export declare class PmiFeedPricingApiResponse implements IPmiFeedPricingApiResponse {
3687
+ items?: PmiFeedPricing[] | undefined;
3688
+ pagination?: Pagination | undefined;
3689
+ constructor(data?: IPmiFeedPricingApiResponse);
3690
+ init(_data?: any): void;
3691
+ static fromJS(data: any): PmiFeedPricingApiResponse;
3692
+ toJSON(data?: any): any;
3693
+ }
3694
+ export interface IPmiFeedPricingApiResponse {
3695
+ items?: PmiFeedPricing[] | undefined;
3696
+ pagination?: Pagination | undefined;
3697
+ }
3698
+ /** Read model representing a PMI issuer record returned by the API. */
3699
+ export declare class PmiIssuer implements IPmiIssuer {
3700
+ /** Unique identifier of this record. */
3701
+ id: string;
3702
+ /** The unique ID of the PreIPOCompany associated with this record. */
3703
+ preIPOCompanyId: string;
3704
+ /** Date when data was updated by PMI. */
3705
+ pmiUpdatedAt?: Date | undefined;
3706
+ /** Unique ID given to each issuer by PMI - used as business key for upsert operations. */
3707
+ infoId: string | undefined;
3708
+ /** Name commonly used by issuer. */
3709
+ infoDisplayName: string | undefined;
3710
+ /** List of other names used by issuer (stored as JSON). */
3711
+ infoAksNamesJson?: string | undefined;
3712
+ /** Short description about the issuer. */
3713
+ infoDescription?: string | undefined;
3714
+ /** Website of the issuer. */
3715
+ infoUrl?: string | undefined;
3716
+ /** Headquarter address excluding the country. */
3717
+ infoHqAddress?: string | undefined;
3718
+ /** Country where headquarter is located. */
3719
+ infoHqCountry?: string | undefined;
3720
+ /** Year of incorporation or founding. */
3721
+ infoIncorporationDate?: number | undefined;
3722
+ /** Lower bound of number of employees. */
3723
+ infoNumberOfEmployees?: number | undefined;
3724
+ /** Share split date and ratio (stored as JSON list). */
3725
+ infoSplitsJson?: string | undefined;
3726
+ /** Dates the company went public, bankrupt, or was acquired (JSON list). */
3727
+ infoNotPrivateMarketDatesJson?: string | undefined;
3728
+ /** List of sectors the issuer falls into (JSON list). */
3729
+ infoSectorsJson?: string | undefined;
3730
+ /** Currency of the share pricing data collected. */
3731
+ infoCurrency?: string | undefined;
3732
+ /** Legal name of the issuer. */
3733
+ infoLegalName?: string | undefined;
3734
+ /** List of current CEOs (stored as JSON). */
3735
+ infoCeosJson?: string | undefined;
3736
+ /** Latest composite or derived price for the issuer. */
3737
+ pricePrice?: number | undefined;
3738
+ /** Whether the price is derived. */
3739
+ priceIsDerived?: boolean | undefined;
3740
+ /** Currency of the price. */
3741
+ priceCurrency?: string | undefined;
3742
+ /** Price year-to-date. */
3743
+ priceYtd?: number | undefined;
3744
+ /** ROI year-to-date. */
3745
+ priceYtdRoi?: number | undefined;
3746
+ /** Total bid volume within the last three months. */
3747
+ volumeThreeMonthsBid?: number | undefined;
3748
+ /** Total ask volume within the last three months. */
3749
+ volumeThreeMonthsAsk?: number | undefined;
3750
+ /** Total bid volume within the last six months. */
3751
+ volumeSixMonthsBid?: number | undefined;
3752
+ /** Total ask volume within the last six months. */
3753
+ volumeSixMonthsAsk?: number | undefined;
3754
+ /** Total year-to-date bid volume. */
3755
+ volumeYtdBid?: number | undefined;
3756
+ /** Total year-to-date ask volume. */
3757
+ volumeYtdAsk?: number | undefined;
3758
+ /** Total bid volume in the last year. */
3759
+ volumeYearBid?: number | undefined;
3760
+ /** Total ask volume in the last year. */
3761
+ volumeYearAsk?: number | undefined;
3762
+ /** Total bid volume in the last two years. */
3763
+ volumeTwoYearBid?: number | undefined;
3764
+ /** Total ask volume in the last two years. */
3765
+ volumeTwoYearAsk?: number | undefined;
3766
+ /** Current implied valuation based on latest filing. */
3767
+ valuationCurrentImpliedFiling?: number | undefined;
3768
+ /** Current implied valuation based on latest news. */
3769
+ valuationCurrentImpliedNews?: number | undefined;
3770
+ /** Date for current implied valuation. */
3771
+ valuationCurrentImpliedDate?: Date | undefined;
3772
+ /** Last round valuation from filings. */
3773
+ valuationLastRoundFiling?: number | undefined;
3774
+ /** Last round valuation from news. */
3775
+ valuationLastRoundNews?: number | undefined;
3776
+ /** Date for last round valuation. */
3777
+ valuationLastRoundDate?: Date | undefined;
3778
+ /** Share count from latest filing. */
3779
+ valuationShareCountFiling?: number | undefined;
3780
+ /** Share count from latest news. */
3781
+ valuationShareCountNews?: number | undefined;
3782
+ /** Date for share count data. */
3783
+ valuationShareCountDate?: Date | undefined;
3784
+ /** Share class of the last round. */
3785
+ valuationLastRoundShareClass?: string | undefined;
3786
+ /** Last round price per share. */
3787
+ valuationLastRoundPrice?: number | undefined;
3788
+ /** Change since last round in implied valuation. */
3789
+ valuationCurrentImpliedChangeSinceLastRound?: number | undefined;
3790
+ /** Latest revenue reported. */
3791
+ valuationLatestRevenue?: number | undefined;
3792
+ /** Percent change in latest revenue. */
3793
+ valuationLatestRevenuePercentChange?: number | undefined;
3794
+ /** Fiscal year of the latest revenue. */
3795
+ valuationLatestRevenueYear?: number | undefined;
3796
+ /** Currency of latest revenue. */
3797
+ valuationLatestRevenueCurrency?: string | undefined;
3798
+ /** Source of latest revenue data. */
3799
+ valuationLatestRevenueSource?: string | undefined;
3800
+ constructor(data?: IPmiIssuer);
3801
+ init(_data?: any): void;
3802
+ static fromJS(data: any): PmiIssuer;
3803
+ toJSON(data?: any): any;
3804
+ }
3805
+ /** Read model representing a PMI issuer record returned by the API. */
3806
+ export interface IPmiIssuer {
3807
+ /** Unique identifier of this record. */
3808
+ id: string;
3809
+ /** The unique ID of the PreIPOCompany associated with this record. */
3810
+ preIPOCompanyId: string;
3811
+ /** Date when data was updated by PMI. */
3812
+ pmiUpdatedAt?: Date | undefined;
3813
+ /** Unique ID given to each issuer by PMI - used as business key for upsert operations. */
3814
+ infoId: string | undefined;
3815
+ /** Name commonly used by issuer. */
3816
+ infoDisplayName: string | undefined;
3817
+ /** List of other names used by issuer (stored as JSON). */
3818
+ infoAksNamesJson?: string | undefined;
3819
+ /** Short description about the issuer. */
3820
+ infoDescription?: string | undefined;
3821
+ /** Website of the issuer. */
3822
+ infoUrl?: string | undefined;
3823
+ /** Headquarter address excluding the country. */
3824
+ infoHqAddress?: string | undefined;
3825
+ /** Country where headquarter is located. */
3826
+ infoHqCountry?: string | undefined;
3827
+ /** Year of incorporation or founding. */
3828
+ infoIncorporationDate?: number | undefined;
3829
+ /** Lower bound of number of employees. */
3830
+ infoNumberOfEmployees?: number | undefined;
3831
+ /** Share split date and ratio (stored as JSON list). */
3832
+ infoSplitsJson?: string | undefined;
3833
+ /** Dates the company went public, bankrupt, or was acquired (JSON list). */
3834
+ infoNotPrivateMarketDatesJson?: string | undefined;
3835
+ /** List of sectors the issuer falls into (JSON list). */
3836
+ infoSectorsJson?: string | undefined;
3837
+ /** Currency of the share pricing data collected. */
3838
+ infoCurrency?: string | undefined;
3839
+ /** Legal name of the issuer. */
3840
+ infoLegalName?: string | undefined;
3841
+ /** List of current CEOs (stored as JSON). */
3842
+ infoCeosJson?: string | undefined;
3843
+ /** Latest composite or derived price for the issuer. */
3844
+ pricePrice?: number | undefined;
3845
+ /** Whether the price is derived. */
3846
+ priceIsDerived?: boolean | undefined;
3847
+ /** Currency of the price. */
3848
+ priceCurrency?: string | undefined;
3849
+ /** Price year-to-date. */
3850
+ priceYtd?: number | undefined;
3851
+ /** ROI year-to-date. */
3852
+ priceYtdRoi?: number | undefined;
3853
+ /** Total bid volume within the last three months. */
3854
+ volumeThreeMonthsBid?: number | undefined;
3855
+ /** Total ask volume within the last three months. */
3856
+ volumeThreeMonthsAsk?: number | undefined;
3857
+ /** Total bid volume within the last six months. */
3858
+ volumeSixMonthsBid?: number | undefined;
3859
+ /** Total ask volume within the last six months. */
3860
+ volumeSixMonthsAsk?: number | undefined;
3861
+ /** Total year-to-date bid volume. */
3862
+ volumeYtdBid?: number | undefined;
3863
+ /** Total year-to-date ask volume. */
3864
+ volumeYtdAsk?: number | undefined;
3865
+ /** Total bid volume in the last year. */
3866
+ volumeYearBid?: number | undefined;
3867
+ /** Total ask volume in the last year. */
3868
+ volumeYearAsk?: number | undefined;
3869
+ /** Total bid volume in the last two years. */
3870
+ volumeTwoYearBid?: number | undefined;
3871
+ /** Total ask volume in the last two years. */
3872
+ volumeTwoYearAsk?: number | undefined;
3873
+ /** Current implied valuation based on latest filing. */
3874
+ valuationCurrentImpliedFiling?: number | undefined;
3875
+ /** Current implied valuation based on latest news. */
3876
+ valuationCurrentImpliedNews?: number | undefined;
3877
+ /** Date for current implied valuation. */
3878
+ valuationCurrentImpliedDate?: Date | undefined;
3879
+ /** Last round valuation from filings. */
3880
+ valuationLastRoundFiling?: number | undefined;
3881
+ /** Last round valuation from news. */
3882
+ valuationLastRoundNews?: number | undefined;
3883
+ /** Date for last round valuation. */
3884
+ valuationLastRoundDate?: Date | undefined;
3885
+ /** Share count from latest filing. */
3886
+ valuationShareCountFiling?: number | undefined;
3887
+ /** Share count from latest news. */
3888
+ valuationShareCountNews?: number | undefined;
3889
+ /** Date for share count data. */
3890
+ valuationShareCountDate?: Date | undefined;
3891
+ /** Share class of the last round. */
3892
+ valuationLastRoundShareClass?: string | undefined;
3893
+ /** Last round price per share. */
3894
+ valuationLastRoundPrice?: number | undefined;
3895
+ /** Change since last round in implied valuation. */
3896
+ valuationCurrentImpliedChangeSinceLastRound?: number | undefined;
3897
+ /** Latest revenue reported. */
3898
+ valuationLatestRevenue?: number | undefined;
3899
+ /** Percent change in latest revenue. */
3900
+ valuationLatestRevenuePercentChange?: number | undefined;
3901
+ /** Fiscal year of the latest revenue. */
3902
+ valuationLatestRevenueYear?: number | undefined;
3903
+ /** Currency of latest revenue. */
3904
+ valuationLatestRevenueCurrency?: string | undefined;
3905
+ /** Source of latest revenue data. */
3906
+ valuationLatestRevenueSource?: string | undefined;
3907
+ }
3908
+ export declare class PmiIssuerApiResponse implements IPmiIssuerApiResponse {
3909
+ items?: PmiIssuer[] | undefined;
3910
+ pagination?: Pagination | undefined;
3911
+ constructor(data?: IPmiIssuerApiResponse);
3912
+ init(_data?: any): void;
3913
+ static fromJS(data: any): PmiIssuerApiResponse;
3914
+ toJSON(data?: any): any;
3915
+ }
3916
+ export interface IPmiIssuerApiResponse {
3917
+ items?: PmiIssuer[] | undefined;
3918
+ pagination?: Pagination | undefined;
3919
+ }
3920
+ /** Read model representing a PMI valuation record returned by the API. */
3921
+ export declare class PmiValuation implements IPmiValuation {
3922
+ /** Unique identifier of this record. */
3923
+ id: string;
3924
+ /** The unique ID of the PreIPOCompany associated with this record. */
3925
+ preIPOCompanyId: string;
3926
+ /** Date when data was updated by PMI. */
3927
+ pmiUpdatedAt?: Date | undefined;
3928
+ /** Unique ID given to each issuer by PMI - used as business key for upsert operations. */
3929
+ pmiId: string | undefined;
3930
+ /** Name commonly used by issuer. */
3931
+ displayName: string | undefined;
3932
+ /** Date of funding round filing or PM Insight's implied valuation. */
3933
+ date: Date;
3934
+ /** Valuation in USD. */
3935
+ valuationUsd: number;
3936
+ /** The multiplier rate used to convert from base currency to USD (if base currency is non-USD). */
3937
+ currencyMultiplier?: number | undefined;
3938
+ /** Whether the valuation is for a funding round or implied using price (derived or composite),
3939
+ and funding round whether the share count used was from filing or news. */
3940
+ description?: string | undefined;
3941
+ /** The composite (depth 2+) or derived price (depth 1/0) used to produce the valuation, adjusted for splits. */
3942
+ splitAdjustedPriceUsd?: number | undefined;
3943
+ /** The share count used to produce the valuation, adjusted for splits. */
3944
+ splitAdjustedShareCount?: number | undefined;
3945
+ /** The composite (depth 2+) or derived price (depth 1/0) used to produce the valuation, not adjusted for splits. */
3946
+ unadjustedPriceUsd?: number | undefined;
3947
+ /** The share count used to produce the valuation, not adjusted for splits. */
3948
+ unadjustedShareCount?: number | undefined;
3949
+ /** The ratio of a share split, populating on the day a split occurs. */
3950
+ splitAtRatio?: number | undefined;
3951
+ constructor(data?: IPmiValuation);
3952
+ init(_data?: any): void;
3953
+ static fromJS(data: any): PmiValuation;
3954
+ toJSON(data?: any): any;
3955
+ }
3956
+ /** Read model representing a PMI valuation record returned by the API. */
3957
+ export interface IPmiValuation {
3958
+ /** Unique identifier of this record. */
3959
+ id: string;
3960
+ /** The unique ID of the PreIPOCompany associated with this record. */
3961
+ preIPOCompanyId: string;
3962
+ /** Date when data was updated by PMI. */
3963
+ pmiUpdatedAt?: Date | undefined;
3964
+ /** Unique ID given to each issuer by PMI - used as business key for upsert operations. */
3965
+ pmiId: string | undefined;
3966
+ /** Name commonly used by issuer. */
3967
+ displayName: string | undefined;
3968
+ /** Date of funding round filing or PM Insight's implied valuation. */
3969
+ date: Date;
3970
+ /** Valuation in USD. */
3971
+ valuationUsd: number;
3972
+ /** The multiplier rate used to convert from base currency to USD (if base currency is non-USD). */
3973
+ currencyMultiplier?: number | undefined;
3974
+ /** Whether the valuation is for a funding round or implied using price (derived or composite),
3975
+ and funding round whether the share count used was from filing or news. */
3976
+ description?: string | undefined;
3977
+ /** The composite (depth 2+) or derived price (depth 1/0) used to produce the valuation, adjusted for splits. */
3978
+ splitAdjustedPriceUsd?: number | undefined;
3979
+ /** The share count used to produce the valuation, adjusted for splits. */
3980
+ splitAdjustedShareCount?: number | undefined;
3981
+ /** The composite (depth 2+) or derived price (depth 1/0) used to produce the valuation, not adjusted for splits. */
3982
+ unadjustedPriceUsd?: number | undefined;
3983
+ /** The share count used to produce the valuation, not adjusted for splits. */
3984
+ unadjustedShareCount?: number | undefined;
3985
+ /** The ratio of a share split, populating on the day a split occurs. */
3986
+ splitAtRatio?: number | undefined;
3987
+ }
3988
+ export declare class PmiValuationApiResponse implements IPmiValuationApiResponse {
3989
+ items?: PmiValuation[] | undefined;
3990
+ pagination?: Pagination | undefined;
3991
+ constructor(data?: IPmiValuationApiResponse);
3992
+ init(_data?: any): void;
3993
+ static fromJS(data: any): PmiValuationApiResponse;
3994
+ toJSON(data?: any): any;
3995
+ }
3996
+ export interface IPmiValuationApiResponse {
3997
+ items?: PmiValuation[] | undefined;
3998
+ pagination?: Pagination | undefined;
3999
+ }
3429
4000
  /** PreIPOCompany represents the public information we provide for a PreIPOCompany in the Primary Offering. */
3430
4001
  export declare class PreIPOCompany implements IPreIPOCompany {
3431
4002
  /** Unique ID associated with a PreIPOCompany. */
@@ -5060,6 +5631,84 @@ export interface IUpdateInvestorSubscriptionOrderReference {
5060
5631
  investorSubscriptionId: string;
5061
5632
  orderReferenceId: string;
5062
5633
  }
5634
+ /** Update Questionnaire allows the update of a questionnaire with the primary offerring. */
5635
+ export declare class UpdateQuestionnaire implements IUpdateQuestionnaire {
5636
+ id: string;
5637
+ /** Name of Questionnaire. */
5638
+ name: string;
5639
+ /** Title of Questionnaire. */
5640
+ title: string;
5641
+ /** Questions to update with the questionnaire. */
5642
+ questions: UpdateQuestionnaireQuestion[];
5643
+ constructor(data?: IUpdateQuestionnaire);
5644
+ init(_data?: any): void;
5645
+ static fromJS(data: any): UpdateQuestionnaire;
5646
+ toJSON(data?: any): any;
5647
+ }
5648
+ /** Update Questionnaire allows the update of a questionnaire with the primary offerring. */
5649
+ export interface IUpdateQuestionnaire {
5650
+ id: string;
5651
+ /** Name of Questionnaire. */
5652
+ name: string;
5653
+ /** Title of Questionnaire. */
5654
+ title: string;
5655
+ /** Questions to update with the questionnaire. */
5656
+ questions: UpdateQuestionnaireQuestion[];
5657
+ }
5658
+ /** Questionnaire Question. */
5659
+ export declare class UpdateQuestionnaireQuestion implements IUpdateQuestionnaireQuestion {
5660
+ /** Unique ID associated with a Questionnaire question. */
5661
+ id?: string | undefined;
5662
+ /** Identifier for the question. */
5663
+ identifier: string;
5664
+ /** Order sequence of the question within the Questionnaire. */
5665
+ sequence: number;
5666
+ /** Question status, could be active or disabled. Questions can be set to disabled and new questions created if a Partners elects to edit one or more of the questions presented to their Investors. */
5667
+ status?: UpdateQuestionnaireQuestionStatus;
5668
+ /** Text of the question. */
5669
+ text: string;
5670
+ /** An explanation of the question presented within a Questionnaire. Helps the Investor understand the question being asked by providing additional context. */
5671
+ explanation: string | undefined;
5672
+ /** Format of the question. */
5673
+ format: UpdateQuestionnaireQuestionFormat;
5674
+ /** A list of potential answers associated with a question. */
5675
+ options?: string[] | undefined;
5676
+ /** Optional minimum value for a scale question. */
5677
+ scaleMin?: number | undefined;
5678
+ /** Optional maximum value for a scale question. */
5679
+ scaleMax?: number | undefined;
5680
+ /** Optional step value for a scale question. */
5681
+ scaleStep?: number | undefined;
5682
+ constructor(data?: IUpdateQuestionnaireQuestion);
5683
+ init(_data?: any): void;
5684
+ static fromJS(data: any): UpdateQuestionnaireQuestion;
5685
+ toJSON(data?: any): any;
5686
+ }
5687
+ /** Questionnaire Question. */
5688
+ export interface IUpdateQuestionnaireQuestion {
5689
+ /** Unique ID associated with a Questionnaire question. */
5690
+ id?: string | undefined;
5691
+ /** Identifier for the question. */
5692
+ identifier: string;
5693
+ /** Order sequence of the question within the Questionnaire. */
5694
+ sequence: number;
5695
+ /** Question status, could be active or disabled. Questions can be set to disabled and new questions created if a Partners elects to edit one or more of the questions presented to their Investors. */
5696
+ status?: UpdateQuestionnaireQuestionStatus;
5697
+ /** Text of the question. */
5698
+ text: string;
5699
+ /** An explanation of the question presented within a Questionnaire. Helps the Investor understand the question being asked by providing additional context. */
5700
+ explanation: string | undefined;
5701
+ /** Format of the question. */
5702
+ format: UpdateQuestionnaireQuestionFormat;
5703
+ /** A list of potential answers associated with a question. */
5704
+ options?: string[] | undefined;
5705
+ /** Optional minimum value for a scale question. */
5706
+ scaleMin?: number | undefined;
5707
+ /** Optional maximum value for a scale question. */
5708
+ scaleMax?: number | undefined;
5709
+ /** Optional step value for a scale question. */
5710
+ scaleStep?: number | undefined;
5711
+ }
5063
5712
  export declare class UpdateWebhook implements IUpdateWebhook {
5064
5713
  /** Unique ID associated with a Webhook. */
5065
5714
  id: string;
@@ -5481,6 +6130,22 @@ export declare enum CreateInvestorType {
5481
6130
  IndividualInvestor = "IndividualInvestor",
5482
6131
  EntityInvestor = "EntityInvestor"
5483
6132
  }
6133
+ export declare enum CreateQuestionnaireQuestionStatus {
6134
+ DISABLED = "DISABLED",
6135
+ ACTIVE = "ACTIVE"
6136
+ }
6137
+ export declare enum CreateQuestionnaireQuestionFormat {
6138
+ Integer = "Integer",
6139
+ Float = "Float",
6140
+ Percentage = "Percentage",
6141
+ MultipleChoiceSingle = "MultipleChoiceSingle",
6142
+ MultipleChoiceMultiple = "MultipleChoiceMultiple",
6143
+ Boolean = "Boolean",
6144
+ Date = "Date",
6145
+ Text = "Text",
6146
+ Email = "Email",
6147
+ Scale = "Scale"
6148
+ }
5484
6149
  export declare enum DocumentType2 {
5485
6150
  BUSINESS_FORMATION = "BUSINESS_FORMATION",
5486
6151
  BANK_STATEMENT = "BANK_STATEMENT",
@@ -5915,6 +6580,22 @@ export declare enum UpdateInvestorAccreditationAccreditationStatus {
5915
6580
  FAMILY_OFFICE_GT_5M = "FAMILY_OFFICE_GT_5M",
5916
6581
  NOT_APPLICABLE = "NOT_APPLICABLE"
5917
6582
  }
6583
+ export declare enum UpdateQuestionnaireQuestionStatus {
6584
+ DISABLED = "DISABLED",
6585
+ ACTIVE = "ACTIVE"
6586
+ }
6587
+ export declare enum UpdateQuestionnaireQuestionFormat {
6588
+ Integer = "Integer",
6589
+ Float = "Float",
6590
+ Percentage = "Percentage",
6591
+ MultipleChoiceSingle = "MultipleChoiceSingle",
6592
+ MultipleChoiceMultiple = "MultipleChoiceMultiple",
6593
+ Boolean = "Boolean",
6594
+ Date = "Date",
6595
+ Text = "Text",
6596
+ Email = "Email",
6597
+ Scale = "Scale"
6598
+ }
5918
6599
  export declare enum WebhookEventDeliveryStatus {
5919
6600
  Pending = "Pending",
5920
6601
  Delivered = "Delivered",