@finbourne/lusid-sdk-angular6

import { HttpClient, HttpHeaders, HttpResponse, HttpEvent } from '@angular/common/http'; import { Observable } from 'rxjs'; import { CreatePortfolioGroupRequest } from '../model/createPortfolioGroupRequest'; import { DeletedEntityResponse } from '../model/deletedEntityResponse'; import { ExpandedGroup } from '../model/expandedGroup'; import { PortfolioGroup } from '../model/portfolioGroup'; import { ResourceId } from '../model/resourceId'; import { ResourceListOfPortfolioGroup } from '../model/resourceListOfPortfolioGroup'; import { ResourceListOfProcessedCommand } from '../model/resourceListOfProcessedCommand'; import { UpdatePortfolioGroupRequest } from '../model/updatePortfolioGroupRequest'; import { Configuration } from '../configuration'; export declare class PortfolioGroupsService { protected httpClient: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(httpClient: HttpClient, basePath: string, configuration: Configuration); /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm(consumes); /** * Add portfolio to group * Adds a portfolio to a previously defined portfolio group * @param scope The scope of the portfolio group to which a portfolio is being added * @param code The code of the portfolio group to which a portfolio is being added * @param portfolioId The id of the portfolio * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ addPortfolioToGroup(scope: string, code: string, portfolioId?: ResourceId, observe?: 'body', reportProgress?: boolean): Observable<PortfolioGroup>; addPortfolioToGroup(scope: string, code: string, portfolioId?: ResourceId, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<PortfolioGroup>>; addPortfolioToGroup(scope: string, code: string, portfolioId?: ResourceId, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<PortfolioGroup>>; /** * Add group to group * Adds a portfolio group, as a sub-group, to an existing portfolio group * @param scope The scope of the portfolio group to which a sub-group is being added * @param code The code of the portfolio group to which a sub-group is being added * @param portfolioGroupId The id of the portfolio group being added as a sub-group * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ addSubGroupToGroup(scope: string, code: string, portfolioGroupId?: ResourceId, observe?: 'body', reportProgress?: boolean): Observable<PortfolioGroup>; addSubGroupToGroup(scope: string, code: string, portfolioGroupId?: ResourceId, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<PortfolioGroup>>; addSubGroupToGroup(scope: string, code: string, portfolioGroupId?: ResourceId, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<PortfolioGroup>>; /** * Create group * Create a new portfolio group. * @param scope The scope into which the portfolio group will be created * @param request The definition of the new portfolio group * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ createPortfolioGroup(scope: string, request?: CreatePortfolioGroupRequest, observe?: 'body', reportProgress?: boolean): Observable<PortfolioGroup>; createPortfolioGroup(scope: string, request?: CreatePortfolioGroupRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<PortfolioGroup>>; createPortfolioGroup(scope: string, request?: CreatePortfolioGroupRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<PortfolioGroup>>; /** * Remove portfolio from group * Removes a portfolio from a portfolio group * @param scope The scope of the portfolio group * @param code The code of the portfolio group * @param portfolioScope The scope of the portfolio being removed * @param portfolioCode The code of the portfolio being removed * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ deletePortfolioFromGroup(scope: string, code: string, portfolioScope: string, portfolioCode: string, observe?: 'body', reportProgress?: boolean): Observable<PortfolioGroup>; deletePortfolioFromGroup(scope: string, code: string, portfolioScope: string, portfolioCode: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<PortfolioGroup>>; deletePortfolioFromGroup(scope: string, code: string, portfolioScope: string, portfolioCode: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<PortfolioGroup>>; /** * Delete group * Deletes the definition of the specified portfolio group * @param scope The scope of the portfolio group * @param code The code of the portfolio group * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ deletePortfolioGroup(scope: string, code: string, observe?: 'body', reportProgress?: boolean): Observable<DeletedEntityResponse>; deletePortfolioGroup(scope: string, code: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<DeletedEntityResponse>>; deletePortfolioGroup(scope: string, code: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<DeletedEntityResponse>>; /** * Remove group from group * Remove a portfolio group (sub-group) from a parent portfolio group * @param scope The scope of the portfolio group * @param code The code of the portfolio group * @param subgroupScope The scope of the sub-group being removed * @param subgroupCode The code of the sub-group being removed * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ deleteSubGroupFromGroup(scope: string, code: string, subgroupScope: string, subgroupCode: string, observe?: 'body', reportProgress?: boolean): Observable<PortfolioGroup>; deleteSubGroupFromGroup(scope: string, code: string, subgroupScope: string, subgroupCode: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<PortfolioGroup>>; deleteSubGroupFromGroup(scope: string, code: string, subgroupScope: string, subgroupCode: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<PortfolioGroup>>; /** * Get portfolio group * Get the definition of the specified portfolio group * @param scope The scope of the portfolio group * @param code The code of the portfolio group * @param asAt Optional. The AsAt date of the data * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ getPortfolioGroup(scope: string, code: string, asAt?: Date, observe?: 'body', reportProgress?: boolean): Observable<PortfolioGroup>; getPortfolioGroup(scope: string, code: string, asAt?: Date, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<PortfolioGroup>>; getPortfolioGroup(scope: string, code: string, asAt?: Date, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<PortfolioGroup>>; /** * Get commands * Gets all commands that modified a specific portfolio group * @param scope The scope of the portfolio group * @param code The code of the portfolio group * @param fromAsAt Optional. Filters commands by those that were processed at or after this date and time * @param toAsAt Optional. Filters commands by those that were processed at or before this date and time * @param sortBy Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName * @param start Optional. When paginating, skip this number of results * @param limit Optional. When paginating, limit the number of returned results to this many. * @param filter Optional. Expression to filter the result set * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ getPortfolioGroupCommands(scope: string, code: string, fromAsAt?: Date, toAsAt?: Date, sortBy?: Array<string>, start?: number, limit?: number, filter?: string, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfProcessedCommand>; getPortfolioGroupCommands(scope: string, code: string, fromAsAt?: Date, toAsAt?: Date, sortBy?: Array<string>, start?: number, limit?: number, filter?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfProcessedCommand>>; getPortfolioGroupCommands(scope: string, code: string, fromAsAt?: Date, toAsAt?: Date, sortBy?: Array<string>, start?: number, limit?: number, filter?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfProcessedCommand>>; /** * Get a full expansion of a portfolio group * Lists all portfolios in a group, and all sub groups. Portfolios are decorated with their properties. * @param scope The scope of the portfolio * @param code The code of the portfolio * @param effectiveAt Optional. The effective date of the data * @param asAt Optional. The AsAt date of the data * @param propertyFilter Optional. The restricted set of properties that should be returned * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ getPortfolioGroupExpansion(scope: string, code: string, effectiveAt?: Date, asAt?: Date, propertyFilter?: Array<string>, observe?: 'body', reportProgress?: boolean): Observable<ExpandedGroup>; getPortfolioGroupExpansion(scope: string, code: string, effectiveAt?: Date, asAt?: Date, propertyFilter?: Array<string>, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ExpandedGroup>>; getPortfolioGroupExpansion(scope: string, code: string, effectiveAt?: Date, asAt?: Date, propertyFilter?: Array<string>, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ExpandedGroup>>; /** * List groups in scope * Lists all portfolio groups in a specified scope * @param scope The scope * @param asAt Optional. The AsAt date of the data * @param sortBy Optional. Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName * @param start Optional. When paginating, skip this number of results * @param limit Optional. When paginating, limit the number of returned results to this many. * @param filter Optional. Expression to filter the result set * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ listPortfolioGroups(scope: string, asAt?: Date, sortBy?: Array<string>, start?: number, limit?: number, filter?: string, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfPortfolioGroup>; listPortfolioGroups(scope: string, asAt?: Date, sortBy?: Array<string>, start?: number, limit?: number, filter?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfPortfolioGroup>>; listPortfolioGroups(scope: string, asAt?: Date, sortBy?: Array<string>, start?: number, limit?: number, filter?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfPortfolioGroup>>; /** * Update group * Update the definition of the specified existing portfolio group. Not all elements within a portfolio group definition are modifiable after creation. * @param scope The scope of the portfolio group * @param code The code of the portfolio group * @param request The updated definition of the portfolio group * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ updatePortfolioGroup(scope: string, code: string, request?: UpdatePortfolioGroupRequest, observe?: 'body', reportProgress?: boolean): Observable<PortfolioGroup>; updatePortfolioGroup(scope: string, code: string, request?: UpdatePortfolioGroupRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<PortfolioGroup>>; updatePortfolioGroup(scope: string, code: string, request?: UpdatePortfolioGroupRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<PortfolioGroup>>; }