Skip to content

Commit 5cb751d

Browse files
factset-sdk-botfactset-sdk-bot
authored
feat(sdk): Auto-created from 'analyticsapi-engines-sdk-generator' repository PR 33 for SDK version v5.0.1 (#52)
* Fixing the return types in API docs.
1 parent 7fdefa7 commit 5cb751d

24 files changed

+194
-97
lines changed

‎auto-generated-sdk/docs/AFIOptimizerApi.md‎

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,8 @@ Name | Type | Description | Notes
6969

7070
### Return type
7171

72-
void (empty response body)
72+
- A tuple with response data, HTTP status code and response headers.
73+
- **Response datatype**: None (empty response body)
7374

7475
### Authorization
7576

@@ -152,7 +153,8 @@ Name | Type | Description | Notes
152153

153154
### Return type
154155

155-
[**AFIOptimizationParametersRoot**](AFIOptimizationParametersRoot.md)
156+
- A tuple with response data, HTTP status code and response headers.
157+
- **Response datatype**: [**AFIOptimizationParametersRoot**](AFIOptimizationParametersRoot.md)
156158

157159
### Authorization
158160

@@ -235,7 +237,8 @@ Name | Type | Description | Notes
235237

236238
### Return type
237239

238-
[**ObjectRoot**](ObjectRoot.md)
240+
- A tuple with response data, HTTP status code and response headers.
241+
- **Response datatype**: [**ObjectRoot**](ObjectRoot.md)
239242

240243
### Authorization
241244

@@ -318,7 +321,8 @@ Name | Type | Description | Notes
318321

319322
### Return type
320323

321-
[**ObjectRoot**](ObjectRoot.md)
324+
- A tuple with response data, HTTP status code and response headers.
325+
- **Response datatype**: (For 201 status - [**ObjectRoot**](ObjectRoot.md))(For 202 status - None (empty response body) )
322326

323327
### Authorization
324328

@@ -457,7 +461,8 @@ Name | Type | Description | Notes
457461

458462
### Return type
459463

460-
[**ObjectRoot**](ObjectRoot.md)
464+
- A tuple with response data, HTTP status code and response headers.
465+
- **Response datatype**: (For 202 status - [**CalculationInfoRoot**](CalculationInfoRoot.md))(For 201 status - [**ObjectRoot**](ObjectRoot.md))
461466

462467
### Authorization
463468

@@ -608,7 +613,8 @@ Name | Type | Description | Notes
608613

609614
### Return type
610615

611-
[**ObjectRoot**](ObjectRoot.md)
616+
- A tuple with response data, HTTP status code and response headers.
617+
- **Response datatype**: (For 202 status - [**CalculationInfoRoot**](CalculationInfoRoot.md))(For 201 status - [**ObjectRoot**](ObjectRoot.md))
612618

613619
### Authorization
614620

‎auto-generated-sdk/docs/AXPOptimizerApi.md‎

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,8 @@ Name | Type | Description | Notes
6969

7070
### Return type
7171

72-
void (empty response body)
72+
- A tuple with response data, HTTP status code and response headers.
73+
- **Response datatype**: None (empty response body)
7374

7475
### Authorization
7576

@@ -152,7 +153,8 @@ Name | Type | Description | Notes
152153

153154
### Return type
154155

155-
[**AxiomaEquityOptimizationParametersRoot**](AxiomaEquityOptimizationParametersRoot.md)
156+
- A tuple with response data, HTTP status code and response headers.
157+
- **Response datatype**: [**AxiomaEquityOptimizationParametersRoot**](AxiomaEquityOptimizationParametersRoot.md)
156158

157159
### Authorization
158160

@@ -235,7 +237,8 @@ Name | Type | Description | Notes
235237

236238
### Return type
237239

238-
[**ObjectRoot**](ObjectRoot.md)
240+
- A tuple with response data, HTTP status code and response headers.
241+
- **Response datatype**: [**ObjectRoot**](ObjectRoot.md)
239242

240243
### Authorization
241244

@@ -318,7 +321,8 @@ Name | Type | Description | Notes
318321

319322
### Return type
320323

321-
[**ObjectRoot**](ObjectRoot.md)
324+
- A tuple with response data, HTTP status code and response headers.
325+
- **Response datatype**: (For 201 status - [**ObjectRoot**](ObjectRoot.md))(For 202 status - None (empty response body) )
322326

323327
### Authorization
324328

@@ -457,7 +461,8 @@ Name | Type | Description | Notes
457461

458462
### Return type
459463

460-
[**ObjectRoot**](ObjectRoot.md)
464+
- A tuple with response data, HTTP status code and response headers.
465+
- **Response datatype**: (For 202 status - [**CalculationInfoRoot**](CalculationInfoRoot.md))(For 201 status - [**ObjectRoot**](ObjectRoot.md))
461466

462467
### Authorization
463468

@@ -608,7 +613,8 @@ Name | Type | Description | Notes
608613

609614
### Return type
610615

611-
[**ObjectRoot**](ObjectRoot.md)
616+
- A tuple with response data, HTTP status code and response headers.
617+
- **Response datatype**: (For 202 status - [**CalculationInfoRoot**](CalculationInfoRoot.md))(For 201 status - [**ObjectRoot**](ObjectRoot.md))
612618

613619
### Authorization
614620

‎auto-generated-sdk/docs/AccountsApi.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,8 @@ Name | Type | Description | Notes
6565

6666
### Return type
6767

68-
[**AccountDirectoriesRoot**](AccountDirectoriesRoot.md)
68+
- A tuple with response data, HTTP status code and response headers.
69+
- **Response datatype**: [**AccountDirectoriesRoot**](AccountDirectoriesRoot.md)
6970

7071
### Authorization
7172

‎auto-generated-sdk/docs/BPMOptimizerApi.md‎

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,8 @@ Name | Type | Description | Notes
6969

7070
### Return type
7171

72-
void (empty response body)
72+
- A tuple with response data, HTTP status code and response headers.
73+
- **Response datatype**: None (empty response body)
7374

7475
### Authorization
7576

@@ -152,7 +153,8 @@ Name | Type | Description | Notes
152153

153154
### Return type
154155

155-
[**BPMOptimizationParametersRoot**](BPMOptimizationParametersRoot.md)
156+
- A tuple with response data, HTTP status code and response headers.
157+
- **Response datatype**: [**BPMOptimizationParametersRoot**](BPMOptimizationParametersRoot.md)
156158

157159
### Authorization
158160

@@ -235,7 +237,8 @@ Name | Type | Description | Notes
235237

236238
### Return type
237239

238-
[**ObjectRoot**](ObjectRoot.md)
240+
- A tuple with response data, HTTP status code and response headers.
241+
- **Response datatype**: [**ObjectRoot**](ObjectRoot.md)
239242

240243
### Authorization
241244

@@ -318,7 +321,8 @@ Name | Type | Description | Notes
318321

319322
### Return type
320323

321-
[**ObjectRoot**](ObjectRoot.md)
324+
- A tuple with response data, HTTP status code and response headers.
325+
- **Response datatype**: (For 201 status - [**ObjectRoot**](ObjectRoot.md))(For 202 status - None (empty response body) )
322326

323327
### Authorization
324328

@@ -465,7 +469,8 @@ Name | Type | Description | Notes
465469

466470
### Return type
467471

468-
[**ObjectRoot**](ObjectRoot.md)
472+
- A tuple with response data, HTTP status code and response headers.
473+
- **Response datatype**: (For 202 status - [**CalculationInfoRoot**](CalculationInfoRoot.md))(For 201 status - [**ObjectRoot**](ObjectRoot.md))
469474

470475
### Authorization
471476

@@ -624,7 +629,8 @@ Name | Type | Description | Notes
624629

625630
### Return type
626631

627-
[**ObjectRoot**](ObjectRoot.md)
632+
- A tuple with response data, HTTP status code and response headers.
633+
- **Response datatype**: (For 202 status - [**CalculationInfoRoot**](CalculationInfoRoot.md))(For 201 status - [**ObjectRoot**](ObjectRoot.md))
628634

629635
### Authorization
630636

‎auto-generated-sdk/docs/BenchmarksApi.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,8 @@ Name | Type | Description | Notes
6666

6767
### Return type
6868

69-
[**SPARBenchmarkRoot**](SPARBenchmarkRoot.md)
69+
- A tuple with response data, HTTP status code and response headers.
70+
- **Response datatype**: [**SPARBenchmarkRoot**](SPARBenchmarkRoot.md)
7071

7172
### Authorization
7273

‎auto-generated-sdk/docs/ColumnStatisticsApi.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,8 @@ This endpoint does not need any parameter.
6161

6262
### Return type
6363

64-
[**ColumnStatisticRoot**](ColumnStatisticRoot.md)
64+
- A tuple with response data, HTTP status code and response headers.
65+
- **Response datatype**: [**ColumnStatisticRoot**](ColumnStatisticRoot.md)
6566

6667
### Authorization
6768

‎auto-generated-sdk/docs/ColumnsApi.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,8 @@ Name | Type | Description | Notes
6767

6868
### Return type
6969

70-
[**ColumnRoot**](ColumnRoot.md)
70+
- A tuple with response data, HTTP status code and response headers.
71+
- **Response datatype**: [**ColumnRoot**](ColumnRoot.md)
7172

7273
### Authorization
7374

@@ -156,7 +157,8 @@ Name | Type | Description | Notes
156157

157158
### Return type
158159

159-
[**ColumnSummaryRoot**](ColumnSummaryRoot.md)
160+
- A tuple with response data, HTTP status code and response headers.
161+
- **Response datatype**: [**ColumnSummaryRoot**](ColumnSummaryRoot.md)
160162

161163
### Authorization
162164

‎auto-generated-sdk/docs/ComponentsApi.md‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,8 @@ Name | Type | Description | Notes
7070

7171
### Return type
7272

73-
[**PAComponentRoot**](PAComponentRoot.md)
73+
- A tuple with response data, HTTP status code and response headers.
74+
- **Response datatype**: [**PAComponentRoot**](PAComponentRoot.md)
7475

7576
### Authorization
7677

@@ -155,7 +156,8 @@ Name | Type | Description | Notes
155156

156157
### Return type
157158

158-
[**ComponentSummaryRoot**](ComponentSummaryRoot.md)
159+
- A tuple with response data, HTTP status code and response headers.
160+
- **Response datatype**: [**ComponentSummaryRoot**](ComponentSummaryRoot.md)
159161

160162
### Authorization
161163

@@ -240,7 +242,8 @@ Name | Type | Description | Notes
240242

241243
### Return type
242244

243-
[**ComponentSummaryRoot**](ComponentSummaryRoot.md)
245+
- A tuple with response data, HTTP status code and response headers.
246+
- **Response datatype**: [**ComponentSummaryRoot**](ComponentSummaryRoot.md)
244247

245248
### Authorization
246249

@@ -325,7 +328,8 @@ Name | Type | Description | Notes
325328

326329
### Return type
327330

328-
[**VaultComponentRoot**](VaultComponentRoot.md)
331+
- A tuple with response data, HTTP status code and response headers.
332+
- **Response datatype**: [**VaultComponentRoot**](VaultComponentRoot.md)
329333

330334
### Authorization
331335

@@ -410,7 +414,8 @@ Name | Type | Description | Notes
410414

411415
### Return type
412416

413-
[**ComponentSummaryRoot**](ComponentSummaryRoot.md)
417+
- A tuple with response data, HTTP status code and response headers.
418+
- **Response datatype**: [**ComponentSummaryRoot**](ComponentSummaryRoot.md)
414419

415420
### Authorization
416421

‎auto-generated-sdk/docs/ConfigurationsApi.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,8 @@ Name | Type | Description | Notes
6767

6868
### Return type
6969

70-
[**VaultConfigurationRoot**](VaultConfigurationRoot.md)
70+
- A tuple with response data, HTTP status code and response headers.
71+
- **Response datatype**: [**VaultConfigurationRoot**](VaultConfigurationRoot.md)
7172

7273
### Authorization
7374

@@ -152,7 +153,8 @@ Name | Type | Description | Notes
152153

153154
### Return type
154155

155-
[**VaultConfigurationSummaryRoot**](VaultConfigurationSummaryRoot.md)
156+
- A tuple with response data, HTTP status code and response headers.
157+
- **Response datatype**: [**VaultConfigurationSummaryRoot**](VaultConfigurationSummaryRoot.md)
156158

157159
### Authorization
158160

‎auto-generated-sdk/docs/CurrenciesApi.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,8 @@ This endpoint does not need any parameter.
6161

6262
### Return type
6363

64-
[**CurrencyRoot**](CurrencyRoot.md)
64+
- A tuple with response data, HTTP status code and response headers.
65+
- **Response datatype**: [**CurrencyRoot**](CurrencyRoot.md)
6566

6667
### Authorization
6768

0 commit comments

Comments
 (0)