@finbourne/lusid-sdk-angular18
Version:
An Angular (18) SDK for secure access to the LUSID® by FINBOURNE web API
76 lines (75 loc) • 4.55 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
import { Observable } from 'rxjs';
import { ResourceListOfScopeDefinition } from '../model/resourceListOfScopeDefinition';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export interface ListEntityScopesRequestParams {
/** The entity type to list scopes for. */
entityType: string;
/** The asAt datetime at which to retrieve scopes. Defaults to latest datetime if not specified. */
asAt?: string;
/** The pagination token to use to continue listing scopes from a previous call to list scopes. This value is returned from the previous call. If a pagination token is provided, the limit and asAt fields must not have changed since the original request. */
page?: string;
/** When paginating, limit the number of returned results to this number. Defaults to 100 if not specified. */
limit?: number;
}
export interface ListScopesRequestParams {
/** Expression to filter the result set. For example, to filter on the Scope, use \"scope eq \'string\'\" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. */
filter?: string;
}
export declare class ScopesService {
protected httpClient: HttpClient;
protected basePath: string;
defaultHeaders: HttpHeaders;
configuration: Configuration;
encoder: HttpParameterCodec;
constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
private addToHttpParams;
private addToHttpParamsRecursive;
/**
* ListEntityScopes: List Entity Scopes
* List all the scopes for a given entity type that contain data.
* @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.
*/
listEntityScopes(requestParameters?: ListEntityScopesRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<ResourceListOfScopeDefinition>;
listEntityScopes(requestParameters?: ListEntityScopesRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<ResourceListOfScopeDefinition>>;
listEntityScopes(requestParameters?: ListEntityScopesRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<ResourceListOfScopeDefinition>>;
/**
* ListScopes: List Scopes
* List all the scopes that contain data.
* @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.
*/
listScopes(requestParameters?: ListScopesRequestParams, observe?: 'body', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<ResourceListOfScopeDefinition>;
listScopes(requestParameters?: ListScopesRequestParams, observe?: 'response', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpResponse<ResourceListOfScopeDefinition>>;
listScopes(requestParameters?: ListScopesRequestParams, observe?: 'events', reportProgress?: boolean, options?: {
httpHeaderAccept?: 'text/plain' | 'application/json' | 'text/json';
context?: HttpContext;
transferCache?: boolean;
}): Observable<HttpEvent<ResourceListOfScopeDefinition>>;
static ɵfac: i0.ɵɵFactoryDeclaration<ScopesService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDeclaration<ScopesService>;
}