@monarkmarkets/api-client 1.3.15 → 1.3.16

package/dist/Client.d.ts

@@ -16,6 +16,7 @@ export declare class Client {
      * Get a Document by ID.
      * @param id The Document ID for the document to retrieve.
      * @return OK
+     * @deprecated
      */
     getDocumentById(id: string): Promise<Document>;
     protected processGetDocumentById(response: Response): Promise<Document>;
@@ -36,6 +37,7 @@ export declare class Client {
      * @param exactMatch (optional) Only returns the items exactly matching the parameters given.
      * @param sortOrder (optional)
      * @return OK
+     * @deprecated
      */
     getAllDocuments(investorId: string | undefined, preIPOCompanyId: string | undefined, preIPOCompanySPVId: string | undefined, preIPOCompanyInvestmentId: string | undefined, investorSubscriptionId: string | undefined, registeredFundId: string | undefined, registeredFundSubscriptionId: string | undefined, documentType: DocumentType | undefined, page: number | undefined, pageSize: number | undefined, exactMatch: boolean | undefined, sortOrder: SortOrder | undefined): Promise<DocumentApiResponse>;
     protected processGetAllDocuments(response: Response): Promise<DocumentApiResponse>;
@@ -44,6 +46,7 @@ export declare class Client {
      * @param id The Document ID for the document to sign.
      * @param body (optional) Data about the signing.
      * @return No Content
+     * @deprecated
      */
     signDocument(id: string, body: SignDocument | undefined): Promise<void>;
     protected processSignDocument(response: Response): Promise<void>;
@@ -51,6 +54,7 @@ export declare class Client {
      * Downloads a document using document ID and token. The document is accessed anonymously using a secure token.
      * @param id The Document ID for the document to download.
      * @param token The secure token required to access the document.
+     * @deprecated
      */
     downloadDocument(id: string, token: string): Promise<void>;
     protected processDownloadDocument(response: Response): Promise<void>;
@@ -1138,9 +1142,10 @@ export declare class Client {
     /**
      * Get an order by ID.
      * @param id The order ID.
+     * @param includeDocuments (optional) Optional flag to include associated documents.
      * @return OK
      */
-    getTransactionById(id: string): Promise<Transaction>;
+    getTransactionById(id: string, includeDocuments: boolean | undefined): Promise<Transaction>;
     protected processGetTransactionById(response: Response): Promise<Transaction>;
     /**
      * Get all transactions for a specific investor filtered by target asset type.
@@ -1792,33 +1797,33 @@ export interface ICookie {
 }
 export declare class CreateFinancialAdvisor implements ICreateFinancialAdvisor {
     /** This is the unique identifier of the Institution that the Financial Advisor is attached to. */
-    financialInstitutionId?: string;
+    financialInstitutionId: string;
     /** CRD Number of the Financial Advisor. */
-    crdNumber: string | undefined;
+    crdNumber?: string | undefined;
     /** IARD Number of the Financial Advisor. */
     iardNumber?: string | undefined;
     /** Financial Advisor first name. */
-    firstName: string | undefined;
+    firstName: string;
     /** Financial advisor middle name. */
     middleName?: string | undefined;
     /** Financial advisor last name. */
-    lastName: string | undefined;
+    lastName: string;
     /** Financial advisor mailing address. */
-    mailingAddress: string | undefined;
+    mailingAddress: string;
     /** Financial advisor mailing city. */
-    mailingCity: string | undefined;
+    mailingCity: string;
     /** Financial advisor mailing state. */
-    mailingState: string | undefined;
+    mailingState: string;
     /** Financial advisor mailing zip code. */
-    mailingZipCode: string | undefined;
+    mailingZipCode: string;
     /** Financial advisor mailing country code. */
-    mailingCountryCode: string | undefined;
+    mailingCountryCode: string;
     /** Financial Advisor branch number. */
-    branchNumber: string | undefined;
+    branchNumber: string;
     /** Financial advisor phone country code. */
-    phoneCountryCode: string | undefined;
+    phoneCountryCode: string;
     /** Financial advisor phone number. */
-    phoneNumber: string | undefined;
+    phoneNumber: string;
     /** Financial advisor phone number extension. */
     phoneExtension?: string | undefined;
     /** Financial advisor email address. */
@@ -1826,9 +1831,9 @@ export declare class CreateFinancialAdvisor implements ICreateFinancialAdvisor {
     /** Financial advisor fax number. */
     fax?: string | undefined;
     /** Prefix for the Financial Advisor. */
-    prefix: string | undefined;
+    prefix: string;
     /** Financial advisor broker. */
-    broker: string | undefined;
+    broker?: string | undefined;
     constructor(data?: ICreateFinancialAdvisor);
     init(_data?: any): void;
     static fromJS(data: any): CreateFinancialAdvisor;
@@ -1836,33 +1841,33 @@ export declare class CreateFinancialAdvisor implements ICreateFinancialAdvisor {
 }
 export interface ICreateFinancialAdvisor {
     /** This is the unique identifier of the Institution that the Financial Advisor is attached to. */
-    financialInstitutionId?: string;
+    financialInstitutionId: string;
     /** CRD Number of the Financial Advisor. */
-    crdNumber: string | undefined;
+    crdNumber?: string | undefined;
     /** IARD Number of the Financial Advisor. */
     iardNumber?: string | undefined;
     /** Financial Advisor first name. */
-    firstName: string | undefined;
+    firstName: string;
     /** Financial advisor middle name. */
     middleName?: string | undefined;
     /** Financial advisor last name. */
-    lastName: string | undefined;
+    lastName: string;
     /** Financial advisor mailing address. */
-    mailingAddress: string | undefined;
+    mailingAddress: string;
     /** Financial advisor mailing city. */
-    mailingCity: string | undefined;
+    mailingCity: string;
     /** Financial advisor mailing state. */
-    mailingState: string | undefined;
+    mailingState: string;
     /** Financial advisor mailing zip code. */
-    mailingZipCode: string | undefined;
+    mailingZipCode: string;
     /** Financial advisor mailing country code. */
-    mailingCountryCode: string | undefined;
+    mailingCountryCode: string;
     /** Financial Advisor branch number. */
-    branchNumber: string | undefined;
+    branchNumber: string;
     /** Financial advisor phone country code. */
-    phoneCountryCode: string | undefined;
+    phoneCountryCode: string;
     /** Financial advisor phone number. */
-    phoneNumber: string | undefined;
+    phoneNumber: string;
     /** Financial advisor phone number extension. */
     phoneExtension?: string | undefined;
     /** Financial advisor email address. */
@@ -1870,9 +1875,9 @@ export interface ICreateFinancialAdvisor {
     /** Financial advisor fax number. */
     fax?: string | undefined;
     /** Prefix for the Financial Advisor. */
-    prefix: string | undefined;
+    prefix: string;
     /** Financial advisor broker. */
-    broker: string | undefined;
+    broker?: string | undefined;
 }
 /** CreateIndicationOfInterest represents the primary offering information to Create an IoI. */
 export declare class CreateIndicationOfInterest implements ICreateIndicationOfInterest {
@@ -2851,7 +2856,7 @@ export declare class FinancialAdvisor implements IFinancialAdvisor {
     /** This is the unique identifier of the Institution that the Financial Advisor is attached to. */
     financialInstitutionId?: string;
     /** CRD Number of the Financial Advisor. */
-    crdNumber: string | undefined;
+    crdNumber?: string | undefined;
     /** IARD Number of the Financial Advisor. */
     iardNumber?: string | undefined;
     /** Financial Advisor first name. */
@@ -2867,7 +2872,7 @@ export declare class FinancialAdvisor implements IFinancialAdvisor {
     /** Prefix for the Financial Advisor. */
     prefix: string | undefined;
     /** Financial advisor broker. */
-    broker: string | undefined;
+    broker?: string | undefined;
     constructor(data?: IFinancialAdvisor);
     init(_data?: any): void;
     static fromJS(data: any): FinancialAdvisor;
@@ -2880,7 +2885,7 @@ export interface IFinancialAdvisor {
     /** This is the unique identifier of the Institution that the Financial Advisor is attached to. */
     financialInstitutionId?: string;
     /** CRD Number of the Financial Advisor. */
-    crdNumber: string | undefined;
+    crdNumber?: string | undefined;
     /** IARD Number of the Financial Advisor. */
     iardNumber?: string | undefined;
     /** Financial Advisor first name. */
@@ -2896,7 +2901,7 @@ export interface IFinancialAdvisor {
     /** Prefix for the Financial Advisor. */
     prefix: string | undefined;
     /** Financial advisor broker. */
-    broker: string | undefined;
+    broker?: string | undefined;
 }
 export declare class FinancialAdvisorApiResponse implements IFinancialAdvisorApiResponse {
     items?: FinancialAdvisor[] | undefined;
@@ -6911,6 +6916,8 @@ export declare class Transaction implements ITransaction {
     companyName?: string | undefined;
     /** The reference ID of an order submitted. */
     referenceId?: string | undefined;
+    /** Optional list of documents associated with this transaction. */
+    documents?: DocumentV2[] | undefined;
     constructor(data?: ITransaction);
     init(_data?: any): void;
     static fromJS(data: any): Transaction;
@@ -6949,6 +6956,8 @@ export interface ITransaction {
     companyName?: string | undefined;
     /** The reference ID of an order submitted. */
     referenceId?: string | undefined;
+    /** Optional list of documents associated with this transaction. */
+    documents?: DocumentV2[] | undefined;
 }
 export declare class TransactionAction implements ITransactionAction {
     /** Unique ID associated with an TransactionAction. */
@@ -7446,33 +7455,33 @@ https://github.com/country-regions/country-region-data/blob/master/data.json for
 }
 export declare class UpdateFinancialAdvisor implements IUpdateFinancialAdvisor {
     /** This is the unique identifier of the Institution that the Financial Advisor is attached to. */
-    financialInstitutionId?: string;
+    financialInstitutionId: string;
     /** CRD Number of the Financial Advisor. */
-    crdNumber: string | undefined;
+    crdNumber?: string | undefined;
     /** IARD Number of the Financial Advisor. */
     iardNumber?: string | undefined;
     /** Financial Advisor first name. */
-    firstName: string | undefined;
+    firstName: string;
     /** Financial advisor middle name. */
     middleName?: string | undefined;
     /** Financial advisor last name. */
-    lastName: string | undefined;
+    lastName: string;
     /** Financial advisor mailing address. */
-    mailingAddress: string | undefined;
+    mailingAddress: string;
     /** Financial advisor mailing city. */
-    mailingCity: string | undefined;
+    mailingCity: string;
     /** Financial advisor mailing state. */
-    mailingState: string | undefined;
+    mailingState: string;
     /** Financial advisor mailing zip code. */
-    mailingZipCode: string | undefined;
+    mailingZipCode: string;
     /** Financial advisor mailing country code. */
-    mailingCountryCode: string | undefined;
+    mailingCountryCode: string;
     /** Financial Advisor branch number. */
-    branchNumber: string | undefined;
+    branchNumber: string;
     /** Financial advisor phone country code. */
-    phoneCountryCode: string | undefined;
+    phoneCountryCode: string;
     /** Financial advisor phone number. */
-    phoneNumber: string | undefined;
+    phoneNumber: string;
     /** Financial advisor phone number extension. */
     phoneExtension?: string | undefined;
     /** Financial advisor email address. */
@@ -7480,11 +7489,11 @@ export declare class UpdateFinancialAdvisor implements IUpdateFinancialAdvisor {
     /** Financial advisor fax number. */
     fax?: string | undefined;
     /** Prefix for the Financial Advisor. */
-    prefix: string | undefined;
+    prefix: string;
     /** Financial advisor broker. */
-    broker: string | undefined;
+    broker?: string | undefined;
     /** ID of the FinancialAdvisor to edit. */
-    id?: string;
+    id: string;
     constructor(data?: IUpdateFinancialAdvisor);
     init(_data?: any): void;
     static fromJS(data: any): UpdateFinancialAdvisor;
@@ -7492,33 +7501,33 @@ export declare class UpdateFinancialAdvisor implements IUpdateFinancialAdvisor {
 }
 export interface IUpdateFinancialAdvisor {
     /** This is the unique identifier of the Institution that the Financial Advisor is attached to. */
-    financialInstitutionId?: string;
+    financialInstitutionId: string;
     /** CRD Number of the Financial Advisor. */
-    crdNumber: string | undefined;
+    crdNumber?: string | undefined;
     /** IARD Number of the Financial Advisor. */
     iardNumber?: string | undefined;
     /** Financial Advisor first name. */
-    firstName: string | undefined;
+    firstName: string;
     /** Financial advisor middle name. */
     middleName?: string | undefined;
     /** Financial advisor last name. */
-    lastName: string | undefined;
+    lastName: string;
     /** Financial advisor mailing address. */
-    mailingAddress: string | undefined;
+    mailingAddress: string;
     /** Financial advisor mailing city. */
-    mailingCity: string | undefined;
+    mailingCity: string;
     /** Financial advisor mailing state. */
-    mailingState: string | undefined;
+    mailingState: string;
     /** Financial advisor mailing zip code. */
-    mailingZipCode: string | undefined;
+    mailingZipCode: string;
     /** Financial advisor mailing country code. */
-    mailingCountryCode: string | undefined;
+    mailingCountryCode: string;
     /** Financial Advisor branch number. */
-    branchNumber: string | undefined;
+    branchNumber: string;
     /** Financial advisor phone country code. */
-    phoneCountryCode: string | undefined;
+    phoneCountryCode: string;
     /** Financial advisor phone number. */
-    phoneNumber: string | undefined;
+    phoneNumber: string;
     /** Financial advisor phone number extension. */
     phoneExtension?: string | undefined;
     /** Financial advisor email address. */
@@ -7526,11 +7535,11 @@ export interface IUpdateFinancialAdvisor {
     /** Financial advisor fax number. */
     fax?: string | undefined;
     /** Prefix for the Financial Advisor. */
-    prefix: string | undefined;
+    prefix: string;
     /** Financial advisor broker. */
-    broker: string | undefined;
+    broker?: string | undefined;
     /** ID of the FinancialAdvisor to edit. */
-    id?: string;
+    id: string;
 }
 export declare class UpdateFinancialInstitutionReferenceId implements IUpdateFinancialInstitutionReferenceId {
     /** ID of the FinancialInstitution to edit. */

package/dist/Client.js

@@ -71,6 +71,7 @@ export class Client {
      * Get a Document by ID.
      * @param id The Document ID for the document to retrieve.
      * @return OK
+     * @deprecated
      */
     getDocumentById(id) {
         let url_ = this.baseUrl + "/primary/v1/document/{id}";
@@ -135,6 +136,7 @@ export class Client {
      * @param exactMatch (optional) Only returns the items exactly matching the parameters given.
      * @param sortOrder (optional)
      * @return OK
+     * @deprecated
      */
     getAllDocuments(investorId, preIPOCompanyId, preIPOCompanySPVId, preIPOCompanyInvestmentId, investorSubscriptionId, registeredFundId, registeredFundSubscriptionId, documentType, page, pageSize, exactMatch, sortOrder) {
         let url_ = this.baseUrl + "/primary/v1/document?";
@@ -224,6 +226,7 @@ export class Client {
      * @param id The Document ID for the document to sign.
      * @param body (optional) Data about the signing.
      * @return No Content
+     * @deprecated
      */
     signDocument(id, body) {
         let url_ = this.baseUrl + "/primary/v1/document/{id}/sign";
@@ -274,6 +277,7 @@ export class Client {
      * Downloads a document using document ID and token. The document is accessed anonymously using a secure token.
      * @param id The Document ID for the document to download.
      * @param token The secure token required to access the document.
+     * @deprecated
      */
     downloadDocument(id, token) {
         let url_ = this.baseUrl + "/primary/v1/document/{id}/download/{token}";
@@ -7392,13 +7396,18 @@ export class Client {
     /**
      * Get an order by ID.
      * @param id The order ID.
+     * @param includeDocuments (optional) Optional flag to include associated documents.
      * @return OK
      */
-    getTransactionById(id) {
-        let url_ = this.baseUrl + "/primary/v2/transaction/{id}";
+    getTransactionById(id, includeDocuments) {
+        let url_ = this.baseUrl + "/primary/v2/transaction/{id}?";
         if (id === undefined || id === null)
             throw new globalThis.Error("The parameter 'id' must be defined.");
         url_ = url_.replace("{id}", encodeURIComponent("" + id));
+        if (includeDocuments === null)
+            throw new globalThis.Error("The parameter 'includeDocuments' cannot be null.");
+        else if (includeDocuments !== undefined)
+            url_ += "includeDocuments=" + encodeURIComponent("" + includeDocuments) + "&";
         url_ = url_.replace(/[?&]$/, "");
         let options_ = {
             method: "GET",
@@ -14745,6 +14754,11 @@ export class Transaction {
             this.targetName = _data["targetName"];
             this.companyName = _data["companyName"];
             this.referenceId = _data["referenceId"];
+            if (Array.isArray(_data["documents"])) {
+                this.documents = [];
+                for (let item of _data["documents"])
+                    this.documents.push(DocumentV2.fromJS(item));
+            }
         }
     }
     static fromJS(data) {
@@ -14771,6 +14785,11 @@ export class Transaction {
         data["targetName"] = this.targetName;
         data["companyName"] = this.companyName;
         data["referenceId"] = this.referenceId;
+        if (Array.isArray(this.documents)) {
+            data["documents"] = [];
+            for (let item of this.documents)
+                data["documents"].push(item ? item.toJSON() : undefined);
+        }
         return data;
     }
 }

package/package.json

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