@orbis-systems/orbis-api-clients 1.3.1 → 1.4.0

package/dist/orbis/index.d.ts

@@ -1,4 +1,4 @@
-import { AxiosError, AxiosInstance, AxiosRequestConfig, HttpStatusCode } from "axios";
+import { AxiosError, AxiosInstance, AxiosRequestConfig, AxiosResponseHeaders, HttpStatusCode } from "axios";
 enum CaseFormat {
     Camel = "camel",
     Snake = "snake",
@@ -44,12 +44,14 @@ type SuccessClientResponse<Data = unknown, RawData = unknown> = ResponseStatus &
     success: true;
     data: Data;
     rawData: RawData;
+    headers: AxiosResponseHeaders;
 };
 type ErrorClientResponse = ResponseStatus & {
     success: false;
     data?: any;
     rawData?: any;
     error: unknown;
+    headers?: AxiosResponseHeaders;
 };
 type ClientResponse<Data = unknown, HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> = HandleError extends true ? SuccessClientResponse<TransformData<Data, Format>, Data> | ErrorClientResponse : SuccessClientResponse<TransformData<Data, Format>, Data>;
 declare abstract class BaseClient<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original, AuthData = unknown> {
@@ -360,7 +362,7 @@ export class AdvisoryCharges<HandleError extends boolean = boolean, Format exten
     /**
      * @tags Advisory Charges
      * @name Search
-     * @summary /search
+     * @summary Search
      * @request GET:/v2/charges/search
      * @secure
      */
@@ -394,7 +396,7 @@ export class AdvisoryCharges<HandleError extends boolean = boolean, Format exten
     /**
      * @tags Advisory Charges
      * @name Apply
-     * @summary /apply
+     * @summary Apply
      * @request POST:/v2/charges/apply
      * @secure
      */
@@ -409,7 +411,7 @@ export class AdvisoryCharges<HandleError extends boolean = boolean, Format exten
     /**
      * @tags Advisory Charges
      * @name Cancel
-     * @summary /cancel
+     * @summary Cancel
      * @request POST:/v2/charges/cancel
      * @secure
      */
@@ -420,32 +422,36 @@ export class AdvisoryGroups<HandleError extends boolean = boolean, Format extend
     constructor(apiClient: JwtClient<HandleError, Format>);
     /**
      * @tags Advisory Groups
-     * @name GroupsManage
+     * @name Manage
+     * @summary Manage
      * @request POST:/v1/groups/manage/{action}
      * @secure
      */
-    groupsManage(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
+    manage(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
     /**
      * @tags Advisory Groups
-     * @name GroupsList
+     * @name List
+     * @summary List
      * @request GET:/v1/groups/list
      * @secure
      */
-    groupsList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
+    list(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
     /**
      * @tags Advisory Groups
-     * @name GroupAccountsStats
+     * @name AccountStats
+     * @summary Account Stats
      * @request GET:/v2/advisory/group/accounts/stats/{groupsId}
      * @secure
      */
-    groupAccountsStats(groupsId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
+    accountStats(groupsId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
     /**
      * @tags Advisory Groups
-     * @name GroupPortfolios
+     * @name Portfolios
+     * @summary Portfolios
      * @request GET:/v2/advisory/group/portfolios/{groupId}
      * @secure
      */
-    groupPortfolios(groupId: string, query?: {
+    portfolios(groupId: string, query?: {
         /**
          * Should load quotes or not.
          * @example "false"
@@ -479,18 +485,20 @@ export class AdvisoryGroups<HandleError extends boolean = boolean, Format extend
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
     /**
      * @tags Advisory Groups
-     * @name GroupRtb
+     * @name Balance
+     * @summary Balance
      * @request GET:/v2/advisory/group/rtb/{groupId}
      * @secure
      */
-    groupRtb(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
+    balance(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
     /**
      * @tags Advisory Groups
-     * @name GroupRtbs
+     * @name Balances
+     * @summary Balances
      * @request GET:/v2/advisory/group/rtbs/{groupId}
      * @secure
      */
-    groupRtbs(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
+    balances(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
 }
 export class AdvisoryModels<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
     protected readonly apiClient: JwtClient<HandleError, Format>;
@@ -772,16 +780,16 @@ export class AdvisoryUserAccountManagement<HandleError extends boolean = boolean
     constructor(apiClient: JwtClient<HandleError, Format>);
     /**
      * @tags Advisory User Account Management
-     * @name List
-     * @summary /list
+     * @name UsersList
+     * @summary Users list
      * @request GET:/v2/advisory/users/list
      * @secure
      */
-    list(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
+    usersList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
     /**
      * @tags Advisory User Account Management
      * @name Accounts
-     * @summary /accounts
+     * @summary Accounts
      * @request GET:/v2/advisory/users/accounts
      * @secure
      */
@@ -796,16 +804,16 @@ export class AdvisoryUserAccountManagement<HandleError extends boolean = boolean
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
     /**
      * @tags Advisory User Account Management
-     * @name AccountsStats
-     * @summary /accounts/stats
+     * @name AccountStats
+     * @summary Account stats
      * @request GET:/v2/advisory/users/accounts/stats
      * @secure
      */
-    accountsStats(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
+    accountStats(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
     /**
      * @tags Advisory User Account Management
      * @name AccountNotes
-     * @summary /account/notes
+     * @summary Account notes
      * @request GET:/v2/advisory/users/account/notes
      * @secure
      */
@@ -818,12 +826,12 @@ export class AdvisoryUserAccountManagement<HandleError extends boolean = boolean
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
     /**
      * @tags Advisory User Account Management
-     * @name Notes
-     * @summary /notes
+     * @name UsersNotes
+     * @summary Users notes
      * @request GET:/v2/advisory/users/notes
      * @secure
      */
-    notes(query?: {
+    usersNotes(query?: {
         /**
          * User's ID
          * @example "1234"
@@ -832,11 +840,11 @@ export class AdvisoryUserAccountManagement<HandleError extends boolean = boolean
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
     /**
      * @tags Advisory User Account Management
-     * @name NotesPost
+     * @name Notes
      * @request POST:/v2/advisory/users/notes/{action}
      * @secure
      */
-    notesPost(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
+    notes(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
 }
 export class Advisory<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
     protected readonly apiClient: JwtClient<HandleError, Format>;
@@ -1593,28 +1601,28 @@ export class Miscellaneous<HandleError extends boolean = boolean, Format extends
     constructor(apiClient: JwtClient<HandleError, Format>);
     /**
      * @tags Miscellaneous
-     * @name ResearchMarketdate
-     * @summary /research/marketDate
+     * @name MarketDate
+     * @summary Market Date
      * @request GET:/research/marketDate
      * @secure
      */
-    researchMarketdate(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
+    marketDate(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
     /**
      * @tags Miscellaneous
-     * @name ResearchDatesMarkets
-     * @summary /research/dates/markets
+     * @name MarketList
+     * @summary Market List
      * @request GET:/research/dates/markets
      * @secure
      */
-    researchDatesMarkets(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
+    marketList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
     /**
      * @tags Miscellaneous
-     * @name ResearchDatesLastopen
-     * @summary /research/dates/lastOpen
+     * @name MarketLastOpenDate
+     * @summary Market Last Open Date
      * @request GET:/research/dates/lastOpen
      * @secure
      */
-    researchDatesLastopen(query?: {
+    marketLastOpenDate(query?: {
         /**
          * Optional value for the market
          * @example "U"
@@ -1623,12 +1631,12 @@ export class Miscellaneous<HandleError extends boolean = boolean, Format extends
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
     /**
      * @tags Miscellaneous
-     * @name ResearchDatesCheck
-     * @summary /research/dates/check
+     * @name MarketDataCheck
+     * @summary Market Data Check
      * @request GET:/research/dates/check
      * @secure
      */
-    researchDatesCheck(query?: {
+    marketDataCheck(query?: {
         /**
          * Optional value for the market
          * @example "U"
@@ -1997,7 +2005,7 @@ export class OrdersV2MutualFunds<HandleError extends boolean = boolean, Format e
     /**
      * @tags Orders V2 Mutual Funds
      * @name MutualFundPlacement
-     * @summary Mutual fund placement
+     * @summary Mutual Fund Placement
      * @request POST:/orders/v2/mf/place
      * @secure
      */
@@ -2005,7 +2013,7 @@ export class OrdersV2MutualFunds<HandleError extends boolean = boolean, Format e
     /**
      * @tags Orders V2 Mutual Funds
      * @name MutualFundPreview
-     * @summary Mutual fund preview
+     * @summary Mutual Fund Preview
      * @request POST:/orders/v2/mf/preview
      * @secure
      */
@@ -5447,6 +5455,14 @@ export class User<HandleError extends boolean = boolean, Format extends CaseForm
         /** @example "2/2/2018" */
         dateTo?: any;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
+    /**
+     * @tags User
+     * @name PreferencesView
+     * @summary Preferences (view)
+     * @request GET:/user/preferences
+     * @secure
+     */
+    preferencesView(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
     /**
      * @tags User
      * @name AccountPortfolioHistory
@@ -5604,14 +5620,6 @@ export class User<HandleError extends boolean = boolean, Format extends CaseForm
         account?: any;
         accountId?: any;
     }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
-    /**
-     * @tags User
-     * @name PreferencesView
-     * @summary Preferences (view)
-     * @request GET:/user/preferences
-     * @secure
-     */
-    preferencesView(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
     /**
      * @tags User
      * @name PreferencesChange