@orbis-systems/orbis-api-clients 0.6.0 → 0.6.2

package/dist/insight/index.d.ts

@@ -802,6 +802,18 @@ export interface InsightFilterCustomIndexesRequest {
     paging?: InsightPaging;
     symbols?: string[];
 }
+export interface InsightFilteredCustomIndexResponse {
+    created_at?: string;
+    description?: string;
+    equities?: string[];
+    etfs?: string[];
+    excluded_symbols?: string[];
+    id?: string;
+    included_symbols?: string[];
+    name?: string;
+    symbols?: string[];
+    updated_at?: string;
+}
 export interface InsightFixedIncome {
     a144: boolean;
     accrued_interest: number;
@@ -4085,14 +4097,23 @@ export class CustomLists<HandleError extends boolean = boolean> {
      */
     removeCustomList(filter: InsightRemoveCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
     /**
-     * @description get custom list
+     * @description filter custom lists
      * @tags Custom Lists
-     * @name GetCustomList
-     * @summary get custom list
-     * @request GET:/custom-lists/:id
+     * @name FilterCustomLists
+     * @summary filter custom lists
+     * @request POST:/custom-lists/filter
      * @secure
      */
-    getCustomList(id: string, query: {
+    filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
+    /**
+     * @description get custom list with quotes
+     * @tags Custom Lists
+     * @name GetCustomListWithQuotes
+     * @summary get custom list with quotes
+     * @request GET:/custom-lists/{id-or-slug}
+     * @secure
+     */
+    getCustomListWithQuotes(idOrSlug: string, query: {
         /** sort direction - asc or desc */
         order_direction: string;
         /** sort field  - volume, symbol(alphabetical), market_cap, dividend_percent */
@@ -4103,14 +4124,17 @@ export class CustomLists<HandleError extends boolean = boolean> {
         offset: number;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
     /**
-     * @description filter custom lists
+     * @description filter custom list
      * @tags Custom Lists
-     * @name FilterCustomLists
-     * @summary filter custom lists
-     * @request POST:/custom-lists/filter
+     * @name FilterCustomList
+     * @summary filter custom list
+     * @request GET:/custom-lists/{id-or-slug}/filter
      * @secure
      */
-    filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
+    filterCustomList(idOrSlug: string, query?: {
+        /** symbols to check inclusion */
+        symbols?: string[];
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFilteredCustomIndexResponse, HandleError>>;
 }
 export class Dashboard<HandleError extends boolean = boolean> {
     protected readonly apiClient: JwtClient<HandleError>;
@@ -5849,6 +5873,7 @@ export class WorldMarkets<HandleError extends boolean = boolean> {
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
 }
 export class InsightApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
+    readonly config: JwtClientConfig<HandleError>;
     alphaTools: AlphaTools<HandleError>;
     companyProfile: CompanyProfile<HandleError>;
     customList: CustomLists<HandleError>;