@finbourne/lusid-sdk-angular6
Version:
An angular (6+) SDK for secure access to the LUSID® by FINBOURNE web API
48 lines (47 loc) • 3.86 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent } from '@angular/common/http';
import { Observable } from 'rxjs';
import { CreateCorporateAction } from '../model/createCorporateAction';
import { ResourceListOfCorporateActionEvent } from '../model/resourceListOfCorporateActionEvent';
import { UpsertCorporateActionsResponse } from '../model/upsertCorporateActionsResponse';
import { Configuration } from '../configuration';
export declare class CorporateActionsService {
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);
/**
* Upsert corporate actions
* Attempt to create/update one or more corporate action in a specified corporate action source. Failed actions will be identified in the body of the response.
* @param scope The scope of corporate action source
* @param code The code of the corporate action source
* @param actions The corporate action definitions
* @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.
*/
batchUpsertCorporateActions(scope: string, code: string, actions?: Array<CreateCorporateAction>, observe?: 'body', reportProgress?: boolean): Observable<UpsertCorporateActionsResponse>;
batchUpsertCorporateActions(scope: string, code: string, actions?: Array<CreateCorporateAction>, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<UpsertCorporateActionsResponse>>;
batchUpsertCorporateActions(scope: string, code: string, actions?: Array<CreateCorporateAction>, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<UpsertCorporateActionsResponse>>;
/**
* Get corporate actions
* Gets corporate actions from a specific corporate action source
* @param scope The scope of the corporate action source
* @param code The code of the corporate action source
* @param effectiveAt Optional. The effective date of the data
* @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.
*/
getCorporateActions(scope: string, code: string, effectiveAt?: Date, asAt?: Date, sortBy?: Array<string>, start?: number, limit?: number, filter?: string, observe?: 'body', reportProgress?: boolean): Observable<ResourceListOfCorporateActionEvent>;
getCorporateActions(scope: string, code: string, effectiveAt?: Date, asAt?: Date, sortBy?: Array<string>, start?: number, limit?: number, filter?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ResourceListOfCorporateActionEvent>>;
getCorporateActions(scope: string, code: string, effectiveAt?: Date, asAt?: Date, sortBy?: Array<string>, start?: number, limit?: number, filter?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ResourceListOfCorporateActionEvent>>;
}