@finbourne/lusid-sdk-angular16

import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http'; import { Observable } from 'rxjs'; import { Abor } from '../model/abor'; import { AborProperties } from '../model/aborProperties'; import { AborRequest } from '../model/aborRequest'; import { ClosePeriodDiaryEntryRequest } from '../model/closePeriodDiaryEntryRequest'; import { DeletedEntityResponse } from '../model/deletedEntityResponse'; import { DiaryEntry } from '../model/diaryEntry'; import { DiaryEntryRequest } from '../model/diaryEntryRequest'; import { JournalEntryLinesQueryParameters } from '../model/journalEntryLinesQueryParameters'; import { LockPeriodDiaryEntryRequest } from '../model/lockPeriodDiaryEntryRequest'; import { Operation } from '../model/operation'; import { PagedResourceListOfAbor } from '../model/pagedResourceListOfAbor'; import { PagedResourceListOfDiaryEntry } from '../model/pagedResourceListOfDiaryEntry'; import { PeriodDiaryEntriesReopenedResponse } from '../model/periodDiaryEntriesReopenedResponse'; import { Property } from '../model/property'; import { ReOpenPeriodDiaryEntryRequest } from '../model/reOpenPeriodDiaryEntryRequest'; import { TrialBalanceQueryParameters } from '../model/trialBalanceQueryParameters'; import { VersionedResourceListOfJournalEntryLine } from '../model/versionedResourceListOfJournalEntryLine'; import { VersionedResourceListOfTrialBalance } from '../model/versionedResourceListOfTrialBalance'; import { Configuration } from '../configuration'; import * as i0 from "@angular/core"; export declare class AborService { protected httpClient: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; encoder: HttpParameterCodec; constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration); private addToHttpParams; private addToHttpParamsRecursive; /** * [EXPERIMENTAL] AddDiaryEntry: Add a diary entry to the specified Abor. * Adds a new diary entry to the specified Abor * @param scope The scope of the Abor. * @param code The code of the Abor. * @param diaryEntryRequest The diary entry to add. * @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. */ addDiaryEntry(scope: string, code: string, diaryEntryRequest: DiaryEntryRequest, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<DiaryEntry>; addDiaryEntry(scope: string, code: string, diaryEntryRequest: DiaryEntryRequest, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<DiaryEntry>>; addDiaryEntry(scope: string, code: string, diaryEntryRequest: DiaryEntryRequest, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<DiaryEntry>>; /** * [EXPERIMENTAL] ClosePeriod: Closes or locks the current period for the given Abor. * Closes or Locks the current open period for the given Abor. * @param scope The scope of the Abor. * @param code The code of the Abor. * @param closePeriodDiaryEntryRequest The request body, containing details to apply to the closing/locking period. * @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. */ closePeriod(scope: string, code: string, closePeriodDiaryEntryRequest: ClosePeriodDiaryEntryRequest, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<DiaryEntry>; closePeriod(scope: string, code: string, closePeriodDiaryEntryRequest: ClosePeriodDiaryEntryRequest, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<DiaryEntry>>; closePeriod(scope: string, code: string, closePeriodDiaryEntryRequest: ClosePeriodDiaryEntryRequest, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<DiaryEntry>>; /** * [EXPERIMENTAL] CreateAbor: Create an Abor. * Create the given Abor. * @param scope The scope of the Abor. * @param aborRequest The definition of the Abor. * @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. */ createAbor(scope: string, aborRequest: AborRequest, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<Abor>; createAbor(scope: string, aborRequest: AborRequest, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<Abor>>; createAbor(scope: string, aborRequest: AborRequest, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<Abor>>; /** * [EXPERIMENTAL] DeleteAbor: Delete an Abor. * Delete the given Abor. * @param scope The scope of the Abor to be deleted. * @param code The code of the Abor to be deleted. Together with the scope this uniquely identifies the Abor. * @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. */ deleteAbor(scope: string, code: string, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<DeletedEntityResponse>; deleteAbor(scope: string, code: string, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<DeletedEntityResponse>>; deleteAbor(scope: string, code: string, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<DeletedEntityResponse>>; /** * [EXPERIMENTAL] GetAbor: Get Abor. * Retrieve the definition of a particular Abor. * @param scope The scope of the Abor. * @param code The code of the Abor. Together with the scope this uniquely identifies the Abor. * @param effectiveAt The effective datetime or cut label at which to retrieve the Abor properties. Defaults to the current LUSID system datetime if not specified. * @param asAt The asAt datetime at which to retrieve the Abor definition. Defaults to returning the latest version of the Abor definition if not specified. * @param propertyKeys A list of property keys from the \'Abor\' domain to decorate onto the Abor. These must take the format {domain}/{scope}/{code}, for example \'Abor/Manager/Id\'. If no properties are specified, then no properties will 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. */ getAbor(scope: string, code: string, effectiveAt?: string, asAt?: string, propertyKeys?: Array<string>, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<Abor>; getAbor(scope: string, code: string, effectiveAt?: string, asAt?: string, propertyKeys?: Array<string>, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<Abor>>; getAbor(scope: string, code: string, effectiveAt?: string, asAt?: string, propertyKeys?: Array<string>, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<Abor>>; /** * [EXPERIMENTAL] GetJournalEntryLines: Get the Journal Entry lines for the given Abor. * Gets the Journal Entry lines for the given Abor The Journal Entry lines have been generated from transactions and translated via posting rules * @param scope The scope of the Abor. * @param code The code of the Abor. Together with the scope is creating the unique identifier for the given Abor. * @param journalEntryLinesQueryParameters The query parameters used in running the generation of the Journal Entry lines. * @param asAt The asAt datetime at which to retrieve Journal Entry lines. Defaults to returning the latest version of each transaction if not specified. * @param filter \"Expression to filter the result set.\" * @param limit When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. * @param page The pagination token to use to continue listing Journal Entry lines from a previous call to GetJournalEntryLines. * @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. */ getJournalEntryLines(scope: string, code: string, journalEntryLinesQueryParameters: JournalEntryLinesQueryParameters, asAt?: string, filter?: string, limit?: number, page?: string, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<VersionedResourceListOfJournalEntryLine>; getJournalEntryLines(scope: string, code: string, journalEntryLinesQueryParameters: JournalEntryLinesQueryParameters, asAt?: string, filter?: string, limit?: number, page?: string, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<VersionedResourceListOfJournalEntryLine>>; getJournalEntryLines(scope: string, code: string, journalEntryLinesQueryParameters: JournalEntryLinesQueryParameters, asAt?: string, filter?: string, limit?: number, page?: string, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<VersionedResourceListOfJournalEntryLine>>; /** * [EXPERIMENTAL] GetTrialBalance: Get the Trial balance for the given Abor. * Gets the Trial balance for the given Abor The Trial balance has been generated from transactions, translated via posting rules and aggregated based on a General Ledger Profile (where specified) * @param scope The scope of the Abor. * @param code The code of the Abor. Together with the scope is the unique identifier for the given Abor. * @param trialBalanceQueryParameters The query parameters used in running the generation of the Trial Balance. * @param asAt The asAt datetime at which to retrieve trial balance. Defaults to returning the latest version of each transaction if not specified. * @param filter \"Expression to filter the result set.\" * @param limit When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. * @param page The pagination token to use to continue listing Trial balance from a previous call to Trial balance. * @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. */ getTrialBalance(scope: string, code: string, trialBalanceQueryParameters: TrialBalanceQueryParameters, asAt?: string, filter?: string, limit?: number, page?: string, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<VersionedResourceListOfTrialBalance>; getTrialBalance(scope: string, code: string, trialBalanceQueryParameters: TrialBalanceQueryParameters, asAt?: string, filter?: string, limit?: number, page?: string, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<VersionedResourceListOfTrialBalance>>; getTrialBalance(scope: string, code: string, trialBalanceQueryParameters: TrialBalanceQueryParameters, asAt?: string, filter?: string, limit?: number, page?: string, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<VersionedResourceListOfTrialBalance>>; /** * [EXPERIMENTAL] ListAbors: List Abors. * List all the Abors matching particular criteria. * @param effectiveAt The effective datetime or cut label at which to list the TimeVariant properties for the Abor. Defaults to the current LUSID system datetime if not specified. * @param asAt The asAt datetime at which to list the Abor. Defaults to returning the latest version of each Abor if not specified. * @param page The pagination token to use to continue listing Abor; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. * @param limit When paginating, limit the results to this number. Defaults to 100 if not specified. * @param filter Expression to filter the results. For example, to filter on the Abor type, specify \"id.Code eq \'Abor1\'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. * @param sortBy A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\". * @param propertyKeys A list of property keys from the \'Abor\' domain to decorate onto each Abor. These must take the format {domain}/{scope}/{code}, for example \'Abor/Manager/Id\'. * @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. */ listAbors(effectiveAt?: string, asAt?: string, page?: string, limit?: number, filter?: string, sortBy?: Array<string>, propertyKeys?: Array<string>, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<PagedResourceListOfAbor>; listAbors(effectiveAt?: string, asAt?: string, page?: string, limit?: number, filter?: string, sortBy?: Array<string>, propertyKeys?: Array<string>, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<PagedResourceListOfAbor>>; listAbors(effectiveAt?: string, asAt?: string, page?: string, limit?: number, filter?: string, sortBy?: Array<string>, propertyKeys?: Array<string>, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<PagedResourceListOfAbor>>; /** * [EXPERIMENTAL] ListDiaryEntries: List diary entries. * List all the diary entries matching particular criteria. * @param scope The scope of the Abor. * @param code The code of the Abor. * @param effectiveAt The effective datetime or cut label at which to list the TimeVariant properties for the Diary Entries. Defaults to the current LUSID system datetime if not specified. * @param asAt The asAt datetime at which to list the DiaryEntry. Defaults to returning the latest version of each DiaryEntry if not specified. * @param page The pagination token to use to continue listing diary entries; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. * @param limit When paginating, limit the results to this number. Defaults to 100 if not specified. * @param filter Expression to filter the results. For example, to filter on the DiaryEntry type, specify \"type eq \'PeriodBoundary\'\". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. * @param sortBy A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\". * @param propertyKeys A list of property keys from the \'DiaryEntry\' domain to decorate onto each DiaryEntry. These must take the format {domain}/{scope}/{code}, for example \'DiaryEntry/Report/Id\'. * @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. */ listDiaryEntries(scope: string, code: string, effectiveAt?: string, asAt?: string, page?: string, limit?: number, filter?: string, sortBy?: Array<string>, propertyKeys?: Array<string>, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<PagedResourceListOfDiaryEntry>; listDiaryEntries(scope: string, code: string, effectiveAt?: string, asAt?: string, page?: string, limit?: number, filter?: string, sortBy?: Array<string>, propertyKeys?: Array<string>, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<PagedResourceListOfDiaryEntry>>; listDiaryEntries(scope: string, code: string, effectiveAt?: string, asAt?: string, page?: string, limit?: number, filter?: string, sortBy?: Array<string>, propertyKeys?: Array<string>, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<PagedResourceListOfDiaryEntry>>; /** * [EXPERIMENTAL] LockPeriod: Locks the last Closed or given Closed Period. * Locks the specified or last locked period for the given Abor. * @param scope The scope of the Abor. * @param code The code of the Abor. * @param lockPeriodDiaryEntryRequest The request body, detailing lock details * @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. */ lockPeriod(scope: string, code: string, lockPeriodDiaryEntryRequest?: LockPeriodDiaryEntryRequest, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<DiaryEntry>; lockPeriod(scope: string, code: string, lockPeriodDiaryEntryRequest?: LockPeriodDiaryEntryRequest, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<DiaryEntry>>; lockPeriod(scope: string, code: string, lockPeriodDiaryEntryRequest?: LockPeriodDiaryEntryRequest, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<DiaryEntry>>; /** * [EXPERIMENTAL] PatchAbor: Patch Abor. * Create or update certain fields for a particular Abor. The behaviour is defined by the JSON Patch specification. Currently supported fields are: PortfolioIds. * @param scope The scope of the Abor. * @param code The code of the Abor. Together with the scope this uniquely identifies the Abor. * @param operation The json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902. * @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. */ patchAbor(scope: string, code: string, operation: Array<Operation>, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<Abor>; patchAbor(scope: string, code: string, operation: Array<Operation>, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<Abor>>; patchAbor(scope: string, code: string, operation: Array<Operation>, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<Abor>>; /** * [EXPERIMENTAL] ReOpenPeriods: Reopen periods from a seed Diary Entry Code or when not specified, the last Closed Period for the given Abor. * Reopens one or more periods. * @param scope The scope of the Abor to be deleted. * @param code The code of the Abor to be deleted. Together with the scope this uniquely identifies the Abor. * @param reOpenPeriodDiaryEntryRequest The request body, detailing re open details * @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. */ reOpenPeriods(scope: string, code: string, reOpenPeriodDiaryEntryRequest?: ReOpenPeriodDiaryEntryRequest, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<PeriodDiaryEntriesReopenedResponse>; reOpenPeriods(scope: string, code: string, reOpenPeriodDiaryEntryRequest?: ReOpenPeriodDiaryEntryRequest, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<PeriodDiaryEntriesReopenedResponse>>; reOpenPeriods(scope: string, code: string, reOpenPeriodDiaryEntryRequest?: ReOpenPeriodDiaryEntryRequest, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<PeriodDiaryEntriesReopenedResponse>>; /** * [EXPERIMENTAL] UpsertAborProperties: Upsert Abor properties * Update or insert one or more properties onto a single Abor. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain \'Abor\'. Upserting a property that exists for an Abor, with a null value, will delete the instance of the property for that group. Properties have an effectiveFrom datetime for which the property is valid, and an effectiveUntil datetime until which the property is valid. Not supplying an effectiveUntil datetime results in the property being valid indefinitely, or until the next effectiveFrom datetime of the property. * @param scope The scope of the Abor to update or insert the properties onto. * @param code The code of the Abor to update or insert the properties onto. Together with the scope this uniquely identifies the Abor. * @param requestBody The properties to be updated or inserted onto the Abor. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. \"Abor/Manager/Id\". * @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. */ upsertAborProperties(scope: string, code: string, requestBody?: { [key: string]: Property; }, observe?: 'body', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<AborProperties>; upsertAborProperties(scope: string, code: string, requestBody?: { [key: string]: Property; }, observe?: 'response', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpResponse<AborProperties>>; upsertAborProperties(scope: string, code: string, requestBody?: { [key: string]: Property; }, observe?: 'events', reportProgress?: boolean, options?: { httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json'; context?: HttpContext; }): Observable<HttpEvent<AborProperties>>; static ɵfac: i0.ɵɵFactoryDeclaration<AborService, [null, { optional: true; }, { optional: true; }]>; static ɵprov: i0.ɵɵInjectableDeclaration<AborService>; }