@finbourne/lusid-sdk-angular18
Version:
An Angular (18) SDK for secure access to the LUSID® by FINBOURNE web API
525 lines (524 loc) • 32.5 kB
TypeScript
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 interface AddDiaryEntryRequestParams {
/** The scope of the Abor. */
scope: string;
/** The code of the Abor. */
code: string;
/** The diary entry to add. */
diaryEntryRequest: DiaryEntryRequest;
}
export interface ClosePeriodRequestParams {
/** The scope of the Abor. */
scope: string;
/** The code of the Abor. */
code: string;
/** The request body, containing details to apply to the closing/locking period. */
closePeriodDiaryEntryRequest: ClosePeriodDiaryEntryRequest;
}
export interface CreateAborRequestParams {
/** The scope of the Abor. */
scope: string;
/** The definition of the Abor. */
aborRequest: AborRequest;
}
export interface DeleteAborRequestParams {
/** The scope of the Abor to be deleted. */
scope: string;
/** The code of the Abor to be deleted. Together with the scope this uniquely identifies the Abor. */
code: string;
}
export interface DeleteDiaryEntryRequestParams {
/** The scope of the Abor. */
scope: string;
/** The code of the Abor. */
code: string;
/** The diary entry code to be deleted. */
diaryEntryCode: string;
}
export interface GetAborRequestParams {
/** The scope of the Abor. */
scope: string;
/** The code of the Abor. Together with the scope this uniquely identifies the Abor. */
code: string;
/** The effective datetime or cut label at which to retrieve the Abor properties. Defaults to the current LUSID system datetime if not specified. */
effectiveAt?: string;
/** The asAt datetime at which to retrieve the Abor definition. Defaults to returning the latest version of the Abor definition if not specified. */
asAt?: string;
/** 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. */
propertyKeys?: Array<string>;
}
export interface GetAborPropertiesRequestParams {
/** The scope of the Abor to list the properties for. */
scope: string;
/** The code of the Abor to list the properties for. Together with the scope this uniquely identifies the Abor. */
code: string;
/** The effective datetime or cut label at which to list the Abor\'s properties. Defaults to the current LUSID system datetime if not specified. */
effectiveAt?: string;
/** The asAt datetime at which to list the Abor\'s properties. Defaults to return the latest version of each property if not specified. */
asAt?: string;
}
export interface GetJournalEntryLinesRequestParams {
/** The scope of the Abor. */
scope: string;
/** The code of the Abor. Together with the scope is creating the unique identifier for the given Abor. */
code: string;
/** The query parameters used in running the generation of the Journal Entry lines. */
journalEntryLinesQueryParameters: JournalEntryLinesQueryParameters;
/** The asAt datetime at which to retrieve Journal Entry lines. Defaults to returning the latest version of each transaction if not specified. */
asAt?: string;
/** \"Expression to filter the result set.\" */
filter?: string;
/** When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. */
limit?: number;
/** The pagination token to use to continue listing Journal Entry lines from a previous call to GetJournalEntryLines. */
page?: string;
}
export interface GetTrialBalanceRequestParams {
/** The scope of the Abor. */
scope: string;
/** The code of the Abor. Together with the scope this uniquely identifies the Abor. */
code: string;
/** The query parameters used in running the generation of the Trial Balance. */
trialBalanceQueryParameters: TrialBalanceQueryParameters;
/** The asAt datetime at which to retrieve the Trial Balance. Defaults to returning the latest version if not specified. */
asAt?: string;
/** Expression to filter the results by. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. */
filter?: string;
/** When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. */
limit?: number;
/** The pagination token to use to continue listing Trial Balances. This token 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. */
page?: string;
}
export interface ListAborsRequestParams {
/** 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. */
effectiveAt?: string;
/** The asAt datetime at which to list the Abor. Defaults to returning the latest version of each Abor if not specified. */
asAt?: string;
/** 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. */
page?: string;
/** When paginating, limit the results to this number. Defaults to 100 if not specified. */
limit?: number;
/** 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. */
filter?: string;
/** A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\". */
sortBy?: Array<string>;
/** 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\'. */
propertyKeys?: Array<string>;
}
export interface ListDiaryEntriesRequestParams {
/** The scope of the Abor. */
scope: string;
/** The code of the Abor. */
code: string;
/** 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. */
effectiveAt?: string;
/** The asAt datetime at which to list the DiaryEntry. Defaults to returning the latest version of each DiaryEntry if not specified. */
asAt?: string;
/** 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. */
page?: string;
/** When paginating, limit the results to this number. Defaults to 100 if not specified. */
limit?: number;
/** 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. */
filter?: string;
/** A list of field names or properties to sort by, each suffixed by \" ASC\" or \" DESC\". */
sortBy?: Array<string>;
/** 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\'. */
propertyKeys?: Array<string>;
}
export interface LockPeriodRequestParams {
/** The scope of the Abor. */
scope: string;
/** The code of the Abor. */
code: string;
/** The request body, detailing lock details */
lockPeriodDiaryEntryRequest?: LockPeriodDiaryEntryRequest;
}
export interface PatchAborRequestParams {
/** The scope of the Abor. */
scope: string;
/** The code of the Abor. Together with the scope this uniquely identifies the Abor. */
code: string;
/** The json patch document. For more information see: https://datatracker.ietf.org/doc/html/rfc6902. */
operation: Array<Operation>;
}
export interface ReOpenPeriodsRequestParams {
/** The scope of the Abor. */
scope: string;
/** The code of the Abor. Together with the scope this uniquely identifies the Abor. */
code: string;
/** The request body, containing details about the period to be re-opened. */
reOpenPeriodDiaryEntryRequest?: ReOpenPeriodDiaryEntryRequest;
}
export interface UpsertAborPropertiesRequestParams {
/** The scope of the Abor to update or insert the properties onto. */
scope: string;
/** The code of the Abor to update or insert the properties onto. Together with the scope this uniquely identifies the Abor. */
code: string;
/** 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\". */
requestBody?: {
[key: string]: Property;
};
}
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. This would be type \'Other\'.
* Adds a new diary entry to the specified Abor
* @param requestParameters
* @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(requestParameters?: AddDiaryEntryRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<DiaryEntry>;
addDiaryEntry(requestParameters?: AddDiaryEntryRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<DiaryEntry>>;
addDiaryEntry(requestParameters?: AddDiaryEntryRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): 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 requestParameters
* @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(requestParameters?: ClosePeriodRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<DiaryEntry>;
closePeriod(requestParameters?: ClosePeriodRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<DiaryEntry>>;
closePeriod(requestParameters?: ClosePeriodRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<DiaryEntry>>;
/**
* [EXPERIMENTAL] CreateAbor: Create an Abor.
* Create the given Abor.
* @param requestParameters
* @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(requestParameters?: CreateAborRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<Abor>;
createAbor(requestParameters?: CreateAborRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<Abor>>;
createAbor(requestParameters?: CreateAborRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<Abor>>;
/**
* [EXPERIMENTAL] DeleteAbor: Delete an Abor.
* Delete the given Abor.
* @param requestParameters
* @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(requestParameters?: DeleteAborRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<DeletedEntityResponse>;
deleteAbor(requestParameters?: DeleteAborRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<DeletedEntityResponse>>;
deleteAbor(requestParameters?: DeleteAborRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<DeletedEntityResponse>>;
/**
* [EXPERIMENTAL] DeleteDiaryEntry: Delete a diary entry type \'Other\' from the specified Abor.
* Delete a diary entry type \'Other\' from the specified Abor.
* @param requestParameters
* @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.
*/
deleteDiaryEntry(requestParameters?: DeleteDiaryEntryRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<DeletedEntityResponse>;
deleteDiaryEntry(requestParameters?: DeleteDiaryEntryRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<DeletedEntityResponse>>;
deleteDiaryEntry(requestParameters?: DeleteDiaryEntryRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<DeletedEntityResponse>>;
/**
* [EXPERIMENTAL] GetAbor: Get Abor.
* Retrieve the definition of a particular Abor.
* @param requestParameters
* @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(requestParameters?: GetAborRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<Abor>;
getAbor(requestParameters?: GetAborRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<Abor>>;
getAbor(requestParameters?: GetAborRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<Abor>>;
/**
* [EXPERIMENTAL] GetAborProperties: Get Abor properties
* Get all the properties of a single abor.
* @param requestParameters
* @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.
*/
getAborProperties(requestParameters?: GetAborPropertiesRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<AborProperties>;
getAborProperties(requestParameters?: GetAborPropertiesRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<AborProperties>>;
getAborProperties(requestParameters?: GetAborPropertiesRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<AborProperties>>;
/**
* [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 requestParameters
* @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(requestParameters?: GetJournalEntryLinesRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<VersionedResourceListOfJournalEntryLine>;
getJournalEntryLines(requestParameters?: GetJournalEntryLinesRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<VersionedResourceListOfJournalEntryLine>>;
getJournalEntryLines(requestParameters?: GetJournalEntryLinesRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): 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 requestParameters
* @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(requestParameters?: GetTrialBalanceRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<VersionedResourceListOfTrialBalance>;
getTrialBalance(requestParameters?: GetTrialBalanceRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<VersionedResourceListOfTrialBalance>>;
getTrialBalance(requestParameters?: GetTrialBalanceRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<VersionedResourceListOfTrialBalance>>;
/**
* [EXPERIMENTAL] ListAbors: List Abors.
* List all the Abors matching particular criteria.
* @param requestParameters
* @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(requestParameters?: ListAborsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<PagedResourceListOfAbor>;
listAbors(requestParameters?: ListAborsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<PagedResourceListOfAbor>>;
listAbors(requestParameters?: ListAborsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<PagedResourceListOfAbor>>;
/**
* [EXPERIMENTAL] ListDiaryEntries: List diary entries.
* List all the diary entries matching particular criteria.
* @param requestParameters
* @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(requestParameters?: ListDiaryEntriesRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<PagedResourceListOfDiaryEntry>;
listDiaryEntries(requestParameters?: ListDiaryEntriesRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<PagedResourceListOfDiaryEntry>>;
listDiaryEntries(requestParameters?: ListDiaryEntriesRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): 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 requestParameters
* @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(requestParameters?: LockPeriodRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<DiaryEntry>;
lockPeriod(requestParameters?: LockPeriodRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<DiaryEntry>>;
lockPeriod(requestParameters?: LockPeriodRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): 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 requestParameters
* @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(requestParameters?: PatchAborRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<Abor>;
patchAbor(requestParameters?: PatchAborRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<Abor>>;
patchAbor(requestParameters?: PatchAborRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): 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 requestParameters
* @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(requestParameters?: ReOpenPeriodsRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<PeriodDiaryEntriesReopenedResponse>;
reOpenPeriods(requestParameters?: ReOpenPeriodsRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<PeriodDiaryEntriesReopenedResponse>>;
reOpenPeriods(requestParameters?: ReOpenPeriodsRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): 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 <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property 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.
* @param requestParameters
* @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(requestParameters?: UpsertAborPropertiesRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<AborProperties>;
upsertAborProperties(requestParameters?: UpsertAborPropertiesRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<AborProperties>>;
upsertAborProperties(requestParameters?: UpsertAborPropertiesRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<AborProperties>>;
static ɵfac: i0.ɵɵFactoryDeclaration<AborService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDeclaration<AborService>;
}