@orbis-systems/orbis-api-clients 1.0.0 → 1.2.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;
@@ -391,6 +391,12 @@ export interface InsightAuthorProfileResponse {
     articles: InsightArticle[];
     author: InsightAuthorInfo;
 }
+export interface InsightBasicSecurityProfile {
+    mic: string;
+    share_class_description: string;
+    share_class_status: string;
+    symbol: string;
+}
 export interface InsightBeforeAndAfter {
     after?: string;
     before?: string;
@@ -548,6 +554,7 @@ export interface InsightCombinedProfileResponse {
     /** @example "CA" */
     province: string;
     sector: InsightSymbolIndustries;
+    securities: InsightBasicSecurityProfile[];
     /** @example "Apple" */
     short_company_name: string;
     /** @example "Manufactures mobile communication and media device" */
@@ -589,6 +596,7 @@ export interface InsightCompanyProfile {
     market_cap: number;
     phone: string;
     sector: InsightSymbolIndustries;
+    securities: InsightBasicSecurityProfile[];
     short_company_name: string;
     short_description: string;
     symbol: string;
@@ -901,6 +909,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;
@@ -1557,7 +1566,7 @@ export interface InsightGetOwnershipsBySymbolAsDashboardFieldsResponse {
 }
 export interface InsightGetOwnershipsBySymbolRequest {
     order?: InsightOrdering;
-    /** @example "institutional" */
+    /** @example "INSTITUTIONAL" */
     owner_type: InsightGetOwnershipsBySymbolRequestOwnerTypeEnum;
     paging: InsightPaging;
     /** @example "Apple Inc" */
@@ -1571,7 +1580,7 @@ export interface InsightGetOwnershipsBySymbolResponse {
 }
 export interface InsightGetOwnershipsBySymbolWithoutSearchQueryRequest {
     order?: InsightOrdering;
-    /** @example "institutional" */
+    /** @example "INSTITUTIONAL" */
     owner_type: InsightGetOwnershipsBySymbolWithoutSearchQueryRequestOwnerTypeEnum;
     paging: InsightPaging;
     /** @example ["AAPL","GOOGL"] */
@@ -1691,7 +1700,7 @@ export interface InsightGetPreIPOCompanySPVsWithInvestorIDResponse {
         total_records: number;
     };
 }
-export interface InsightGetProIPOCompabySPVWithInvestorIDResponse {
+export interface InsightGetProIPOCompanySPVWithInvestorIDResponse {
     all_in_price_per_share: number;
     close_date: string;
     co_managers: {
@@ -4788,14 +4797,14 @@ export enum InsightGetFundsForHoldingRequestLeverageEnum {
     LEVERAGE_III = "LEVERAGE_III",
     LEVERAGE_II_AND_III = "LEVERAGE_II_AND_III"
 }
-/** @example "institutional" */
+/** @example "INSTITUTIONAL" */
 export enum InsightGetOwnershipsBySymbolRequestOwnerTypeEnum {
     All = "all",
     Institutional = "institutional",
     Fund = "fund",
     Insider = "insider"
 }
-/** @example "institutional" */
+/** @example "INSTITUTIONAL" */
 export enum InsightGetOwnershipsBySymbolWithoutSearchQueryRequestOwnerTypeEnum {
     All = "all",
     Institutional = "institutional",
@@ -5623,6 +5632,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 */
@@ -5671,6 +5682,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 */
@@ -5718,10 +5731,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
@@ -5730,10 +5740,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
@@ -5756,6 +5763,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
@@ -5792,10 +5801,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
@@ -5804,10 +5810,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
@@ -6613,7 +6616,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
@@ -6969,10 +6972,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
@@ -7158,10 +7158,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
@@ -7301,10 +7298,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>;