@orbis-systems/orbis-api-clients 0.8.8 → 0.8.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -5026,81 +5026,6 @@ export class CompanyProfile<HandleError extends boolean = boolean> {
5026
5026
  */
5027
5027
  getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
5028
5028
  }
5029
- export class Dashboard<HandleError extends boolean = boolean> {
5030
- protected readonly apiClient: JwtClient<HandleError>;
5031
- constructor(apiClient: JwtClient<HandleError>);
5032
- /**
5033
- * @description get ownerships by symbol
5034
- * @tags Dashboard
5035
- * @name DashboardGetOwnershipsBySymbol
5036
- * @summary get ownerships by symbol
5037
- * @request POST:/dashboard/ownerships
5038
- * @secure
5039
- */
5040
- dashboardGetOwnershipsBySymbol(filter: InsightGetOwnershipsBySymbolRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolAsDashboardFieldsResponse, HandleError>>;
5041
- /**
5042
- * @description rewrite field value
5043
- * @tags Dashboard
5044
- * @name RewriteFieldValue
5045
- * @summary rewrite field value
5046
- * @request POST:/rewrite-field
5047
- * @secure
5048
- */
5049
- rewriteFieldValue(input: InsightRewriteFieldValueRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5050
- /**
5051
- * @description remove rewritten value
5052
- * @tags Dashboard
5053
- * @name CreateRewriteField
5054
- * @summary remove rewritten value
5055
- * @request DELETE:/rewrite-field
5056
- * @secure
5057
- */
5058
- createRewriteField(input: InsightRemoveRewrittenFieldValueRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5059
- /**
5060
- * @description Get rewritten field action log
5061
- * @tags Dashboard
5062
- * @name GetRewrittenFieldActionLog
5063
- * @summary get rewritten field action log
5064
- * @request GET:/rewritten-field-action-log
5065
- * @secure
5066
- */
5067
- getRewrittenFieldActionLog(query: {
5068
- /** Internal UUID */
5069
- internal_id: string;
5070
- /** Field ID */
5071
- field_id: string;
5072
- /** how many records to return. Max value is 50 */
5073
- limit: number;
5074
- /** how many records to skip */
5075
- offset: number;
5076
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5077
- /**
5078
- * @description Get rewritten values
5079
- * @tags Dashboard
5080
- * @name GetRewrittenValues
5081
- * @summary get rewritten values
5082
- * @request GET:/rewritten-fields
5083
- * @secure
5084
- */
5085
- getRewrittenValues(query: {
5086
- /** how many records to return. Max value is 50 */
5087
- limit: number;
5088
- /** how many records to skip */
5089
- offset: number;
5090
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5091
- /**
5092
- * @description get symbol-related fields
5093
- * @tags Dashboard
5094
- * @name GetSymbolRelatedFields
5095
- * @summary get symbol-related fields
5096
- * @request GET:/symbol-related-fields
5097
- * @secure
5098
- */
5099
- getSymbolRelatedFields(query: {
5100
- /** Symbol */
5101
- symbol: string;
5102
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolRelatedFieldsResponse, HandleError>>;
5103
- }
5104
5029
  export class CustomLists<HandleError extends boolean = boolean> {
5105
5030
  protected readonly apiClient: JwtClient<HandleError>;
5106
5031
  constructor(apiClient: JwtClient<HandleError>);
@@ -5185,43 +5110,80 @@ export class CustomLists<HandleError extends boolean = boolean> {
5185
5110
  symbols?: string[];
5186
5111
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFilteredCustomIndexResponse, HandleError>>;
5187
5112
  }
5188
- export class Earnings<HandleError extends boolean = boolean> {
5113
+ export class Dashboard<HandleError extends boolean = boolean> {
5189
5114
  protected readonly apiClient: JwtClient<HandleError>;
5190
5115
  constructor(apiClient: JwtClient<HandleError>);
5191
5116
  /**
5192
- * @description get earnings releases count per day
5193
- * @tags Earnings
5194
- * @name GetEarningsReleasesCountPerDay
5195
- * @summary get earnings releases count per day
5196
- * @request GET:/earnings-calendar
5117
+ * @description get ownerships by symbol
5118
+ * @tags Dashboard
5119
+ * @name DashboardGetOwnershipsBySymbol
5120
+ * @summary get ownerships by symbol
5121
+ * @request POST:/dashboard/ownerships
5197
5122
  * @secure
5198
5123
  */
5199
- getEarningsReleasesCountPerDay(query?: {
5200
- /**
5201
- * Start date in format YYYY-MM-DD
5202
- * @example ""2024-01-01""
5203
- */
5204
- start_date?: string;
5205
- /**
5206
- * End date in format YYYY-MM-DD
5207
- * @example ""2024-01-31""
5208
- */
5209
- end_date?: string;
5210
- /**
5211
- * Filter by exchanges
5212
- * @example ""NYSE,NAS""
5213
- */
5214
- exchanges?: string[];
5215
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, number>, HandleError>>;
5124
+ dashboardGetOwnershipsBySymbol(filter: InsightGetOwnershipsBySymbolRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolAsDashboardFieldsResponse, HandleError>>;
5216
5125
  /**
5217
- * @description get earnings release dates for symbols
5218
- * @tags Earnings
5219
- * @name GetEarningsCalendar
5220
- * @summary get earnings calendar data
5221
- * @request POST:/earnings-calendar
5126
+ * @description rewrite field value
5127
+ * @tags Dashboard
5128
+ * @name RewriteFieldValue
5129
+ * @summary rewrite field value
5130
+ * @request POST:/rewrite-field
5222
5131
  * @secure
5223
5132
  */
5224
- getEarningsCalendar(filter: InsightEarningReleasesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEarningReleasesResponse, HandleError>>;
5133
+ rewriteFieldValue(input: InsightRewriteFieldValueRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5134
+ /**
5135
+ * @description remove rewritten value
5136
+ * @tags Dashboard
5137
+ * @name CreateRewriteField
5138
+ * @summary remove rewritten value
5139
+ * @request DELETE:/rewrite-field
5140
+ * @secure
5141
+ */
5142
+ createRewriteField(input: InsightRemoveRewrittenFieldValueRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5143
+ /**
5144
+ * @description Get rewritten field action log
5145
+ * @tags Dashboard
5146
+ * @name GetRewrittenFieldActionLog
5147
+ * @summary get rewritten field action log
5148
+ * @request GET:/rewritten-field-action-log
5149
+ * @secure
5150
+ */
5151
+ getRewrittenFieldActionLog(query: {
5152
+ /** Internal UUID */
5153
+ internal_id: string;
5154
+ /** Field ID */
5155
+ field_id: string;
5156
+ /** how many records to return. Max value is 50 */
5157
+ limit: number;
5158
+ /** how many records to skip */
5159
+ offset: number;
5160
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5161
+ /**
5162
+ * @description Get rewritten values
5163
+ * @tags Dashboard
5164
+ * @name GetRewrittenValues
5165
+ * @summary get rewritten values
5166
+ * @request GET:/rewritten-fields
5167
+ * @secure
5168
+ */
5169
+ getRewrittenValues(query: {
5170
+ /** how many records to return. Max value is 50 */
5171
+ limit: number;
5172
+ /** how many records to skip */
5173
+ offset: number;
5174
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5175
+ /**
5176
+ * @description get symbol-related fields
5177
+ * @tags Dashboard
5178
+ * @name GetSymbolRelatedFields
5179
+ * @summary get symbol-related fields
5180
+ * @request GET:/symbol-related-fields
5181
+ * @secure
5182
+ */
5183
+ getSymbolRelatedFields(query: {
5184
+ /** Symbol */
5185
+ symbol: string;
5186
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolRelatedFieldsResponse, HandleError>>;
5225
5187
  }
5226
5188
  export class FixedIncome<HandleError extends boolean = boolean> {
5227
5189
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5326,6 +5288,44 @@ export class Fundamentals<HandleError extends boolean = boolean> {
5326
5288
  */
5327
5289
  getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
5328
5290
  }
5291
+ export class Earnings<HandleError extends boolean = boolean> {
5292
+ protected readonly apiClient: JwtClient<HandleError>;
5293
+ constructor(apiClient: JwtClient<HandleError>);
5294
+ /**
5295
+ * @description get earnings releases count per day
5296
+ * @tags Earnings
5297
+ * @name GetEarningsReleasesCountPerDay
5298
+ * @summary get earnings releases count per day
5299
+ * @request GET:/earnings-calendar
5300
+ * @secure
5301
+ */
5302
+ getEarningsReleasesCountPerDay(query?: {
5303
+ /**
5304
+ * Start date in format YYYY-MM-DD
5305
+ * @example ""2024-01-01""
5306
+ */
5307
+ start_date?: string;
5308
+ /**
5309
+ * End date in format YYYY-MM-DD
5310
+ * @example ""2024-01-31""
5311
+ */
5312
+ end_date?: string;
5313
+ /**
5314
+ * Filter by exchanges
5315
+ * @example ""NYSE,NAS""
5316
+ */
5317
+ exchanges?: string[];
5318
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, number>, HandleError>>;
5319
+ /**
5320
+ * @description get earnings release dates for symbols
5321
+ * @tags Earnings
5322
+ * @name GetEarningsCalendar
5323
+ * @summary get earnings calendar data
5324
+ * @request POST:/earnings-calendar
5325
+ * @secure
5326
+ */
5327
+ getEarningsCalendar(filter: InsightEarningReleasesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEarningReleasesResponse, HandleError>>;
5328
+ }
5329
5329
  export class Funds<HandleError extends boolean = boolean> {
5330
5330
  protected readonly apiClient: JwtClient<HandleError>;
5331
5331
  constructor(apiClient: JwtClient<HandleError>);