@finbourne/lusid 0.11.3838 → 0.11.3863

package/lib/api/portfoliosApi.d.ts

@@ -1,16 +1,19 @@
 /// <reference types="node" />
 import http from 'http';
+import { AccessMetadataValue } from '../model/accessMetadataValue';
 import { AggregatedReturnsRequest } from '../model/aggregatedReturnsRequest';
 import { DeletedEntityResponse } from '../model/deletedEntityResponse';
 import { PerformanceReturn } from '../model/performanceReturn';
 import { Portfolio } from '../model/portfolio';
 import { PortfolioProperties } from '../model/portfolioProperties';
 import { Property } from '../model/property';
+import { ResourceListOfAccessMetadataValueOf } from '../model/resourceListOfAccessMetadataValueOf';
 import { ResourceListOfAggregatedReturn } from '../model/resourceListOfAggregatedReturn';
 import { ResourceListOfPerformanceReturn } from '../model/resourceListOfPerformanceReturn';
 import { ResourceListOfPortfolio } from '../model/resourceListOfPortfolio';
 import { ResourceListOfProcessedCommand } from '../model/resourceListOfProcessedCommand';
 import { UpdatePortfolioRequest } from '../model/updatePortfolioRequest';
+import { UpsertPortfolioAccessMetadataRequest } from '../model/upsertPortfolioAccessMetadataRequest';
 import { UpsertReturnsResponse } from '../model/upsertReturnsResponse';
 import { Authentication, Interceptor } from '../model/models';
 import { OAuth } from '../model/models';
@@ -35,6 +38,22 @@ export declare class PortfoliosApi {
     setApiKey(key: PortfoliosApiApiKeys, value: string): void;
     set accessToken(token: string);
     addInterceptor(interceptor: Interceptor): void;
+    /**
+     * Delete the Portfolio Access Metadata Rule that exactly matches the provided identifier parts
+     * @summary [EARLY ACCESS] DeleteKeyFromPortfolioAccessMetadata: Delete a Portfolio Access Metadata Rule
+     * @param scope The scope of the Quote Access Metadata Rule to retrieve.
+     * @param code Portfolio code
+     * @param metadataKey The metadataKey identifying the access metadata entry to delete
+     * @param effectiveAt The effective date to delete at, if this is not supplied, it will delete all data found
+     */
+    deleteKeyFromPortfolioAccessMetadata(scope: string, code: string, metadataKey: string, effectiveAt?: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: DeletedEntityResponse;
+    }>;
     /**
      * Delete a particular portfolio.                The deletion will take effect from the portfolio\'s creation datetime. This means that the portfolio will no longer exist at any effective datetime, as per the asAt datetime of deletion.
      * @summary DeletePortfolio: Delete portfolio
@@ -140,6 +159,24 @@ export declare class PortfoliosApi {
         response: http.IncomingMessage;
         body: ResourceListOfProcessedCommand;
     }>;
+    /**
+     * Pass the scope and portfolio code parameters to retrieve the AccessMetadata associated with a portfolio
+     * @summary [EARLY ACCESS] GetPortfolioMetadata: Get access metadata rules for a portfolio
+     * @param scope The scope of the Portfolio Access Metadata Rule to retrieve.
+     * @param code Portfolio code
+     * @param effectiveAt The effectiveAt datetime at which to retrieve the access metadata rule.
+     * @param asAt The asAt datetime at which to retrieve the portfolio access metadata.
+     */
+    getPortfolioMetadata(scope: string, code: string, effectiveAt?: string, asAt?: Date, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: {
+            [key: string]: Array<AccessMetadataValue>;
+        };
+    }>;
     /**
      * List all the properties of a particular portfolio.
      * @summary GetPortfolioProperties: Get portfolio properties
@@ -176,6 +213,23 @@ export declare class PortfoliosApi {
         response: http.IncomingMessage;
         body: ResourceListOfPerformanceReturn;
     }>;
+    /**
+     * Get a specific portfolio access metadata rule by specifying the corresponding identifier parts                No matching will be performed through this endpoint. To retrieve a rule, it is necessary to specify, exactly, the identifier of the rule
+     * @summary [EARLY ACCESS] GetPortfoliosAccessMetadataByKey: Get an entry identified by a metadataKey in the access metadata object
+     * @param scope The scope of the Portfolio Access Metadata Rule to retrieve.
+     * @param code The code of the portfolio
+     * @param metadataKey Key of the metadata to retrieve
+     * @param effectiveAt The effective date of the rule
+     * @param asAt The asAt datetime at which to retrieve the portfolio access metadata.
+     */
+    getPortfoliosAccessMetadataByKey(scope: string, code: string, metadataKey: string, effectiveAt?: string, asAt?: Date, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: Array<AccessMetadataValue>;
+    }>;
     /**
      * List all the portfolios matching particular criteria.
      * @summary ListPortfolios: List portfolios
@@ -232,6 +286,23 @@ export declare class PortfoliosApi {
         response: http.IncomingMessage;
         body: Portfolio;
     }>;
+    /**
+     * Update or insert one Portfolio Access Metadata Rule in a single scope. An item will be updated if it already exists  and inserted if it does not.    The response will return the successfully updated or inserted Portfolio Access Metadata Rule or failure message if unsuccessful    It is important to always check to verify success (or failure).                Multiple rules for a metadataKey can exists with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched
+     * @summary [EARLY ACCESS] UpsertPortfolioAccessMetadata: Upsert a Portfolio Access Metadata Rule associated with specific metadataKey. This creates or updates the data in LUSID.
+     * @param scope The scope to use when updating or inserting the Portfolio Access Metadata Rule.
+     * @param code Portfolio code
+     * @param metadataKey Key of the access metadata to upsert
+     * @param upsertPortfolioAccessMetadataRequest The Portfolio Access Metadata Rule to update or insert
+     * @param effectiveAt The date this rule will effective from
+     */
+    upsertPortfolioAccessMetadata(scope: string, code: string, metadataKey: string, upsertPortfolioAccessMetadataRequest: UpsertPortfolioAccessMetadataRequest, effectiveAt?: string, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<{
+        response: http.IncomingMessage;
+        body: ResourceListOfAccessMetadataValueOf;
+    }>;
     /**
      * Create or update one or more properties for a particular portfolio. A property is updated if it  already exists and created if it does not. All properties must be from the \'Portfolio\' domain.                Properties have an <i>effectiveFrom</i> datetime from which the property is valid, and an <i>effectiveUntil</i>  datetime until which it is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being  valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property.
      * @summary UpsertPortfolioProperties: Upsert portfolio properties