@orbis-systems/orbis-api-clients 0.4.4 → 0.5.0

package/dist/aesmidas/index.d.ts

@@ -1,7 +1,7 @@
 import { AxiosError, AxiosInstance, AxiosRequestConfig, HttpStatusCode } from "axios";
 interface BaseClientConfig<HandleError extends boolean = boolean> {
     baseUrl: string;
-    errorHandling?: HandleError;
+    handleError?: HandleError;
     storage?: Storage;
     defaultHeaders?: Record<string, string>;
     defaultSecure?: boolean;
@@ -18,6 +18,7 @@ enum ContentType {
 type RequestConfig<Body = unknown> = AxiosRequestConfig<Body> & {
     secure?: boolean;
     contentType?: ContentType;
+    handleError?: boolean;
 };
 type ResponseStatus = {
     status: HttpStatusCode | -1;
@@ -52,7 +53,7 @@ declare abstract class BaseClient<HandleError extends boolean = boolean, AuthDat
     setAuthData(data: AuthData | null): void;
     getAuthData(): AuthData | null;
     getConfig(): BaseClientConfig<HandleError>;
-    abstract prepareAuthRequestConfig(): Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>;
+    protected abstract prepareAuthRequestConfig(): Promise<Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>>;
 }
 declare class BaseApi<HandleError extends boolean = boolean, ApiClient extends BaseClient<HandleError> = BaseClient<HandleError>> {
     protected readonly apiClient: ApiClient;
@@ -61,18 +62,19 @@ declare class BaseApi<HandleError extends boolean = boolean, ApiClient extends B
 }
 interface JwtClientConfig<HandleError extends boolean = boolean> extends BaseClientConfig<HandleError> {
     authSchema?: string;
+    autoRenewToken?: boolean;
 }
 interface JwtAuthData {
     accessToken: string;
-    refreshToken: string;
+    refreshToken?: string;
 }
-declare class JwtClient<HandleError extends boolean = boolean> extends BaseClient<HandleError, JwtAuthData> {
+declare class JwtClient<HandleError extends boolean = boolean, AuthData extends JwtAuthData = JwtAuthData> extends BaseClient<HandleError, AuthData> {
     protected readonly config: JwtClientConfig<HandleError>;
     constructor(config: JwtClientConfig<HandleError>);
     getConfig(): JwtClientConfig<HandleError>;
-    prepareAuthRequestConfig(): Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>;
-    scheduleTokenRenewal(renewTokenCallback: () => Promise<JwtAuthData>): void;
-    cancelTokenRenewal(): void;
+    setRenewTokenCallback(renewTokenCallback: () => Promise<AuthData>): void;
+    protected prepareAuthRequestConfig(): Promise<Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>>;
+    renewToken(): Promise<void>;
 }
 export interface AesMidasActionLog {
     id?: string | null;
@@ -219,6 +221,43 @@ export interface AesMidasBond {
     source?: string | null;
     settlement_convention?: string | null;
 }
+export interface AesMidasBondMarksApex {
+    isin?: string | null;
+    cusip?: string | null;
+    timestamp?: string | null;
+    /** @format double */
+    price?: number | null;
+    /** @format double */
+    dirty_price?: number | null;
+    /** @format double */
+    accrued_interest?: number | null;
+    /** @format double */
+    yield_to_worst?: number | null;
+    error?: string | null;
+}
+export interface AesMidasBondQuotesApex {
+    timestamp?: string | null;
+    /** @format double */
+    bid_price?: number | null;
+    /** @format double */
+    bid_yield_to_worst?: number | null;
+    /** @format double */
+    bid_size?: number | null;
+    /** @format double */
+    bid_min_size?: number | null;
+    /** @format double */
+    ask_price?: number | null;
+    /** @format double */
+    ask_yield_to_worst?: number | null;
+    /** @format double */
+    ask_size?: number | null;
+    /** @format double */
+    ask_min_size?: number | null;
+    /** @format double */
+    bid_yield_to_maturity?: number | null;
+    /** @format double */
+    ask_yield_to_maturity?: number | null;
+}
 export interface AesMidasBondReformat {
     symbol?: string | null;
     not_permissioned?: boolean;
@@ -403,6 +442,11 @@ export interface AesMidasBondReformat {
     issue_minimum_denomination?: number | null;
     puttable?: boolean | null;
 }
+export interface AesMidasBondWholeApex {
+    basic?: AesMidasBond;
+    mark?: AesMidasBondMarksApex;
+    quote?: AesMidasBondQuotesApex;
+}
 export interface AesMidasCandelstick {
     /** @format double */
     open?: number;
@@ -1059,51 +1103,56 @@ export interface AesMidasOptionChain {
     vol?: number;
     /** @format int32 */
     open_inst?: number;
+    /** @format double */
+    strike?: number;
+    expire?: string | null;
     data_source?: string | null;
 }
-export interface AesMidasOptionChainResponsewithPagination {
-    /** @format int32 */
-    total_items?: number;
-    /** @format int32 */
-    total_pages?: number;
-    /** @format int32 */
-    current_pages?: number;
-    /** @format int32 */
-    page_size?: number;
-    data?: AesMidasOptionChain[] | null;
+export interface AesMidasOptionChainDates {
+    dates_dictionary?: Record<string, string | null>;
+}
+export interface AesMidasOptionChainDatesReformat {
+    quarterlys?: string[] | null;
+    weeklies?: string[] | null;
+    monthlies?: string[] | null;
+    leaps?: string[] | null;
+    dates?: string[] | null;
+    first?: string | null;
 }
 export interface AesMidasOptionGreek {
     /** @format double */
-    delta?: number;
+    delta?: number | null;
     /** @format double */
-    gamma?: number;
+    gamma?: number | null;
     /** @format double */
-    theta?: number;
+    theta?: number | null;
     /** @format double */
-    vega?: number;
+    vega?: number | null;
     /** @format double */
-    rho?: number;
+    rho?: number | null;
     /** @format double */
-    implied_volatility?: number;
+    implied_volatility?: number | null;
     /** @format double */
-    risk_free_rate?: number;
+    risk_free_rate?: number | null;
     not_found?: boolean;
 }
 export interface AesMidasOptionGreekReformat {
     /** @format double */
-    delta?: number;
+    delta?: number | null;
     /** @format double */
-    gamma?: number;
+    gamma?: number | null;
     /** @format double */
-    theta?: number;
+    theta?: number | null;
     /** @format double */
-    vega?: number;
+    vega?: number | null;
     /** @format double */
-    rho?: number;
+    rho?: number | null;
     not_found?: boolean;
 }
 export interface AesMidasOptionL1 {
     symbol?: string | null;
+    not_found?: boolean;
+    exch?: string | null;
     bid_exch?: string | null;
     /** @format double */
     bid_px?: number;
@@ -1136,6 +1185,8 @@ export interface AesMidasOptionL1 {
     strike?: number;
     /** @format int32 */
     prime_share?: number;
+    prime_exch?: string | null;
+    prime_exch_name?: string | null;
     expire?: string | null;
     data_source?: string | null;
 }
@@ -2727,36 +2778,14 @@ export class Quote<HandleError extends boolean = boolean> {
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasTop20[], HandleError>>;
     /**
      * @tags Quote
-     * @name GetOptionChain
-     * @summary Query Option Chain data - All users - available in Microservice
-     * @request GET:/api/quote/option-chain
+     * @name GetOptionChainDates
+     * @summary Query Option Chain dates - All users - available in Microservice
+     * @request GET:/api/quote/option-chain-dates
      * @secure
      */
-    getOptionChain(query?: {
+    getOptionChainDates(query?: {
         /** Allow one underlying symbol */
-        underlying?: string;
-        /**
-         * optional
-         * @format double
-         * @default -1
-         */
-        strike_low?: number;
-        /**
-         * optional
-         * @format double
-         * @default -1
-         */
-        strike_high?: number;
-        /**
-         * optional
-         * @format date-time
-         */
-        'start_date(UTC)'?: string;
-        /**
-         * optional
-         * @format date-time
-         */
-        'end_date(UTC)'?: string;
+        symbol?: string;
         /**
          * Optional. Default is false. If true, response will be camel case
          * @default false
@@ -2769,39 +2798,19 @@ export class Quote<HandleError extends boolean = boolean> {
         user_name?: string;
         /** @default "" */
         platform?: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasOptionChain[], HandleError>>;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasOptionChainDates[], HandleError>>;
     /**
      * @tags Quote
-     * @name GetOptionChainWithPaging
+     * @name GetOptionChain
      * @summary Query Option Chain data - All users - available in Microservice
-     * @request GET:/api/quote/option-chain-with-paging
+     * @request GET:/api/quote/option-chain
      * @secure
      */
-    getOptionChainWithPaging(data: AesMidasQueryPostBody, query?: {
+    getOptionChain(query?: {
         /** Allow one underlying symbol */
         underlying?: string;
-        /**
-         * optional
-         * @format double
-         * @default -1
-         */
-        strike_low?: number;
-        /**
-         * optional
-         * @format double
-         * @default -1
-         */
-        strike_high?: number;
-        /**
-         * optional
-         * @format date-time
-         */
-        'start_date(UTC)'?: string;
-        /**
-         * optional
-         * @format date-time
-         */
-        'end_date(UTC)'?: string;
+        /** allow one date, format YYYY-MM-DD */
+        date?: string;
         /**
          * Optional. Default is false. If true, response will be camel case
          * @default false
@@ -2814,7 +2823,7 @@ export class Quote<HandleError extends boolean = boolean> {
         user_name?: string;
         /** @default "" */
         platform?: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasOptionChainResponsewithPagination, HandleError>>;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasOptionChain[], HandleError>>;
     /**
      * @tags Quote
      * @name GetOptionLevel1
@@ -2823,8 +2832,8 @@ export class Quote<HandleError extends boolean = boolean> {
      * @secure
      */
     getOptionLevel1(query?: {
-        /** Allow one option symbol. Format {Underlying Symbol}yymmdd{C/P}{Strike price*1000, total 8 digits} */
-        option_name?: string;
+        /** Allow multiple option symbols, separated by ','. Format {Underlying Symbol}yymmdd{C/P}{Strike price*1000, total 8 digits} */
+        option_names?: string;
         /**
          * Optional. Default is false. If true, response will be camel case
          * @default false
@@ -2837,7 +2846,7 @@ export class Quote<HandleError extends boolean = boolean> {
         user_name?: string;
         /** @default "" */
         platform?: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasOptionL1, HandleError>>;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasOptionL1[], HandleError>>;
     /**
      * @tags Quote
      * @name GetOptionLevel1WithGreek
@@ -2846,8 +2855,8 @@ export class Quote<HandleError extends boolean = boolean> {
      * @secure
      */
     getOptionLevel1WithGreek(query?: {
-        /** Allow one option symbol. Format {Underlying Symbol}yymmdd{C/P}{Strike price*1000, total 8 digits} */
-        option_name?: string;
+        /** Allow multiple symbols, separated by ','. Format {Underlying Symbol}yymmdd{C/P}{Strike price*1000, total 8 digits} */
+        option_names?: string;
         /**
          * Optional. Default is false. If true, response will be camel case
          * @default false
@@ -2865,7 +2874,7 @@ export class Quote<HandleError extends boolean = boolean> {
         user_name?: string;
         /** @default "" */
         platform?: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasOptionL1WithGreeks, HandleError>>;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasOptionL1WithGreeks[], HandleError>>;
     /**
      * @tags Quote
      * @name GetEquiductLevel1
@@ -2906,7 +2915,7 @@ export class Quote<HandleError extends boolean = boolean> {
         response_camel_case?: boolean;
         /** @default "" */
         platform?: string;
-    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasBond[], HandleError>>;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasBondWholeApex[], HandleError>>;
     /**
      * @tags Quote
      * @name GetBondsSearch
@@ -3190,6 +3199,17 @@ export class QuotesReformat<HandleError extends boolean = boolean> {
         /** @default "" */
         platform?: string;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
+    /**
+     * @tags QuotesReformat
+     * @name GetOptionChainDates
+     * @summary Query Option Chain dates - All users - available in Microservice
+     * @request GET:/api/quotes/option/chain/dates/{symbol}
+     * @secure
+     */
+    getOptionChainDates(symbol: string, query?: {
+        /** @default "" */
+        platform?: string;
+    }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
     /**
      * @tags QuotesReformat
      * @name GetOptionChain