@orbis-systems/orbis-api-clients 1.1.0 → 1.3.0

package/dist/insight/index.d.ts

@@ -174,7 +174,7 @@ export interface InsightQuote {
     calendar_year_low_date: string;
     /**
      * Change and ChangePercent are new additions to quote
-     * We used to calculate these fields ourselfs
+     * We used to calculate these fields ourselves
      */
     change: number;
     change_percent: number;
@@ -637,6 +637,10 @@ export interface InsightCreateContinentRequest {
     continents: InsightContinent[];
 }
 export interface InsightCreateCustomIndexRequest {
+    access_type: InsightCreateCustomIndexRequestAccessTypeEnum;
+    admin_users?: number[];
+    /** @example "branch_code" */
+    branch_code?: string;
     /**
      * @maxLength 1000
      * @example "description"
@@ -658,6 +662,8 @@ export interface InsightCreateCustomIndexRequest {
      * @example "private_name"
      */
     private_name: string;
+    /** @example "watchman_instance_id" */
+    watchman_instance_id?: string;
 }
 export interface InsightCreateFeaturedArticleConfigRequest {
     /** @example ["web","mobile"] */
@@ -772,6 +778,9 @@ export interface InsightCryptoLogosResponse {
     symbol: string;
 }
 export interface InsightCustomIndex {
+    access_type: string;
+    admin_users: number[];
+    branch_code: string;
     created_at: string;
     description: string;
     equities: string[];
@@ -780,6 +789,7 @@ export interface InsightCustomIndex {
     name: string;
     private_name: string;
     updated_at: string;
+    watchman_instance_id: string;
 }
 export interface InsightDailyPriceEntry {
     price: number;
@@ -909,6 +919,7 @@ export interface InsightExtendedFundData {
     fund_type: string;
     inverse: boolean;
     last_price: number;
+    /** Typo in leverage field name, should be leverage instead of levarage but changing it would be a breaking change */
     levarage: number;
     name: string;
     price_change: number;
@@ -951,10 +962,23 @@ export interface InsightFeaturedArticleSchedule {
     /** @example "2024-01-01T00:00:00Z" */
     start_time: string;
 }
+export interface InsightFilterCustomIndex {
+    created_at?: string;
+    description?: string;
+    equities?: string[];
+    etfs?: string[];
+    id?: string;
+    name?: string;
+    updated_at?: string;
+}
 export interface InsightFilterCustomIndexesRequest {
     paging: InsightPaging;
     symbols?: string[];
 }
+export interface InsightFilterCustomIndexesResponse {
+    count?: number;
+    data?: InsightFilterCustomIndex[];
+}
 export interface InsightFilteredCustomIndexResponse {
     created_at?: string;
     description?: string;
@@ -1699,7 +1723,7 @@ export interface InsightGetPreIPOCompanySPVsWithInvestorIDResponse {
         total_records: number;
     };
 }
-export interface InsightGetProIPOCompabySPVWithInvestorIDResponse {
+export interface InsightGetProIPOCompanySPVWithInvestorIDResponse {
     all_in_price_per_share: number;
     close_date: string;
     co_managers: {
@@ -4553,6 +4577,10 @@ export interface InsightUnderwriteResponse {
     title: string;
 }
 export interface InsightUpdateCustomIndexRequest {
+    access_type: InsightUpdateCustomIndexRequestAccessTypeEnum;
+    admin_users?: number[];
+    /** @example "branch_code" */
+    branch_code?: string;
     /**
      * @maxLength 1000
      * @example "description"
@@ -4582,6 +4610,8 @@ export interface InsightUpdateCustomIndexRequest {
      * @example "private_name"
      */
     private_name: string;
+    /** @example "watchman_instance_id" */
+    watchman_instance_id?: string;
 }
 export interface InsightUpdateFeaturedArticlesRequest {
     /** @example "123e4567-e89b-12d3-a456-426614174000" */
@@ -4736,6 +4766,10 @@ export enum InsightCombinedProfileResponseFundTypeEnum {
     MF = "MF",
     INDEX = "INDEX"
 }
+export enum InsightCreateCustomIndexRequestAccessTypeEnum {
+    Public = "public",
+    Private = "private"
+}
 /** @example "normal" */
 export enum InsightCryptoLogoConvertedRequestConversionEnum {
     Original = "original",
@@ -4871,6 +4905,10 @@ export enum InsightSymbolLogoConvertedRequestConversionEnum {
     SquareStrictOrNormal = "square_strict_or_normal",
     BestMatch = "best_match"
 }
+export enum InsightUpdateCustomIndexRequestAccessTypeEnum {
+    Public = "public",
+    Private = "private"
+}
 /** filter by active status */
 export enum InsightGetPreIpoCompaniesParamsIsActiveEnum {
     True = "true",
@@ -5080,6 +5118,8 @@ export class CustomLists<HandleError extends boolean = boolean, Format extends C
         limit: number;
         /** how many records to skip */
         offset: number;
+        /** access type - public or private */
+        access_type?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError, Format>>;
     /**
      * @description update custom list
@@ -5116,7 +5156,7 @@ export class CustomLists<HandleError extends boolean = boolean, Format extends C
      * @request POST:/custom-lists/filter
      * @secure
      */
-    filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError, Format>>;
+    filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFilterCustomIndexesResponse, HandleError, Format>>;
     /**
      * @description get custom list with quotes
      * @tags Custom Lists
@@ -5631,6 +5671,8 @@ export class Funds<HandleError extends boolean = boolean, Format extends CaseFor
      * @secure
      */
     listOfEtfFunds(query?: {
+        /** Category id */
+        category?: string;
         /** Asset class id */
         asset_class?: string;
         /** Leverage ratios to filter by */
@@ -5679,6 +5721,8 @@ export class Funds<HandleError extends boolean = boolean, Format extends CaseFor
      * @secure
      */
     listOfEtnFunds(query?: {
+        /** Category id */
+        category?: string;
         /** Asset class id */
         asset_class?: string;
         /** Leverage ratios to filter by */
@@ -5726,10 +5770,7 @@ export class Funds<HandleError extends boolean = boolean, Format extends CaseFor
      * @request POST:/funds/funds-for-holding
      * @secure
      */
-    getFundsForHolding(filter: InsightGetFundsForHoldingRequest, headers?: {
-        /** Authorization */
-        Authorization?: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundsForHoldingResponse, HandleError, Format>>;
+    getFundsForHolding(filter: InsightGetFundsForHoldingRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundsForHoldingResponse, HandleError, Format>>;
     /**
      * @description filter funds by params
      * @tags Funds
@@ -5738,10 +5779,7 @@ export class Funds<HandleError extends boolean = boolean, Format extends CaseFor
      * @request POST:/funds/screener
      * @secure
      */
-    fundScreener(filter: InsightFundScreenerRequest, headers?: {
-        /** Authorization */
-        Authorization?: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError, Format>>;
+    fundScreener(filter: InsightFundScreenerRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError, Format>>;
     /**
      * @description get fund screener filters
      * @tags Funds
@@ -5764,6 +5802,8 @@ export class Funds<HandleError extends boolean = boolean, Format extends CaseFor
         limit: number;
         /** how many records to skip */
         offset: number;
+        /** filter by fund type (e.g. ETF, MF) */
+        fund_type?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError, Format>>;
     /**
      * @description update fund screener preset
@@ -5800,10 +5840,7 @@ export class Funds<HandleError extends boolean = boolean, Format extends CaseFor
      * @request POST:/funds/sector-screener
      * @secure
      */
-    fundSectorScreener(filter: InsightFundSectorScreenerRequest, headers?: {
-        /** Authorization */
-        Authorization?: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError, Format>>;
+    fundSectorScreener(filter: InsightFundSectorScreenerRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError, Format>>;
     /**
      * @description get top funds
      * @tags Funds
@@ -5812,10 +5849,7 @@ export class Funds<HandleError extends boolean = boolean, Format extends CaseFor
      * @request POST:/funds/top
      * @secure
      */
-    getTopFunds(filter: InsightGetTopFundsRequest, headers?: {
-        /** Authorization */
-        Authorization?: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError, Format>>;
+    getTopFunds(filter: InsightGetTopFundsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError, Format>>;
     /**
      * @description get fund by symbol
      * @tags Funds
@@ -6621,7 +6655,7 @@ export class PreIpoCompanies<HandleError extends boolean = boolean, Format exten
     getInvestorByIdAndInvestorId(id: string, investorId: string, query?: {
         /** default is false, if true documents will be included in the response */
         include_documents?: boolean;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetProIPOCompabySPVWithInvestorIDResponse, HandleError, Format>>;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetProIPOCompanySPVWithInvestorIDResponse, HandleError, Format>>;
     /**
      * @description get pre ipo company spvs
      * @tags PreIPOCompanies
@@ -6977,10 +7011,7 @@ export class TipRank<HandleError extends boolean = boolean, Format extends CaseF
      * @request POST:/tipranks/analyst-portfolio
      * @secure
      */
-    tiprankPortfolios(filter: InsightPortfoliosRequest, headers?: {
-        /** Authorization */
-        Authorization?: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPortfoliosResponse[], HandleError, Format>>;
+    tiprankPortfolios(filter: InsightPortfoliosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPortfoliosResponse[], HandleError, Format>>;
     /**
      * @description Returns the analyst profile information
      * @tags TipRank
@@ -7166,10 +7197,7 @@ export class TipRank<HandleError extends boolean = boolean, Format extends CaseF
      * @request POST:/tipranks/live-feed
      * @secure
      */
-    tiprankLiveFeed(filter: InsightLiveFeedRequest, headers?: {
-        /** Authorization */
-        Authorization?: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLiveFeedResponse[], HandleError, Format>>;
+    tiprankLiveFeed(filter: InsightLiveFeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLiveFeedResponse[], HandleError, Format>>;
     /**
      * @description Returns the latest news articles on the stock and their sentiment (bullish / neutral or bearish).
      * @tags TipRank
@@ -7309,10 +7337,7 @@ export class TipRank<HandleError extends boolean = boolean, Format extends CaseF
      * @request POST:/tipranks/trending-stocks
      * @secure
      */
-    tiprankTrendingStocks(filter: InsightTrendingStocksRequest, headers?: {
-        /** Authorization */
-        Authorization?: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError, Format>>;
+    tiprankTrendingStocks(filter: InsightTrendingStocksRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError, Format>>;
 }
 export class UsageTracking<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
     protected readonly apiClient: JwtClient<HandleError, Format>;