feat(sdk): Auto-commit from 'analyticsapi-engines-sdk-generator' repo…

…sitory PR 56 for SDK version v5.6.0
factset · Nov 27, 2023 · 463479d · 463479d
1 parent da2e1f3
commit 463479d
Show file tree

Hide file tree

Showing 230 changed files with 300 additions and 286 deletions.
diff --git a/auto-generated-sdk/README.md b/auto-generated-sdk/README.md
@@ -3,7 +3,7 @@
 
 Engines API
 
-- API version: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo],v1:[fiab]
+- API version: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab]
 
 Allow clients to fetch Analytics through APIs.
 

diff --git a/auto-generated-sdk/api/openapi.yaml b/auto-generated-sdk/api/openapi.yaml
@@ -9,7 +9,7 @@ info:
     name: Apache License, Version 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0
   title: Engines API
-  version: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo],v1:[fiab]
+  version: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab]
 externalDocs:
   description: API Documentation
   url: https://developer.factset.com/api-catalog/
@@ -13329,7 +13329,8 @@ paths:
         the post body.
       operationId: postAndCalculate
       parameters:
-      - description: Long running deadline in seconds.
+      - description: Long running deadline in seconds. Example value is set to 10s.
+          Please update it as per requirement before triggering a calculation.
         explode: false
         in: header
         name: X-FactSet-Api-Long-Running-Deadline
@@ -14402,7 +14403,8 @@ paths:
             Run FI calculation endpoint
           type: string
         style: simple
-      - description: Long running deadline in seconds.
+      - description: Long running deadline in seconds. Example value is set to 10s.
+          Please update it as per requirement before triggering a calculation.
         explode: false
         in: header
         name: X-FactSet-Api-Long-Running-Deadline
@@ -15445,7 +15447,8 @@ paths:
         \ the strategy document."
       operationId: postAndOptimize
       parameters:
-      - description: Long running deadline in seconds.
+      - description: Long running deadline in seconds. Example value is set to 10s.
+          Please update it as per requirement before triggering a calculation.
         explode: false
         in: header
         name: X-FactSet-Api-Long-Running-Deadline
@@ -16366,7 +16369,8 @@ paths:
             Run FPO optimization endpoint
           type: string
         style: simple
-      - description: Long running deadline in seconds.
+      - description: Long running deadline in seconds. Example value is set to 10s.
+          Please update it as per requirement before triggering a calculation.
         explode: false
         in: header
         name: X-FactSet-Api-Long-Running-Deadline
@@ -20041,7 +20045,8 @@ paths:
         \ saved in the strategy document."
       operationId: postAndOptimize
       parameters:
-      - description: Long running deadline in seconds.
+      - description: Long running deadline in seconds. Example value is set to 10s.
+          Please update it as per requirement before triggering a calculation.
         explode: false
         in: header
         name: X-FactSet-Api-Long-Running-Deadline
@@ -20962,7 +20967,8 @@ paths:
             Run NPO optimization endpoint
           type: string
         style: simple
-      - description: Long running deadline in seconds.
+      - description: Long running deadline in seconds. Example value is set to 10s.
+          Please update it as per requirement before triggering a calculation.
         explode: false
         in: header
         name: X-FactSet-Api-Long-Running-Deadline
@@ -22289,7 +22295,8 @@ paths:
       operationId: postAndCalculate
       parameters:
       - description: Long running deadline in seconds when only one unit is passed
-          in the POST body.
+          in the POST body. Example value is set to 10s. Please update it as per requirement
+          before triggering a calculation.
         explode: false
         in: header
         name: X-FactSet-Api-Long-Running-Deadline
@@ -23288,7 +23295,8 @@ paths:
           type: string
         style: simple
       - description: Long running deadline in seconds when only one unit is passed
-          in the PUT body.
+          in the PUT body. Example value is set to 10s. Please update it as per requirement
+          before triggering a calculation
         explode: false
         in: header
         name: X-FactSet-Api-Long-Running-Deadline
@@ -25050,7 +25058,8 @@ paths:
       operationId: postAndCalculate
       parameters:
       - description: Long running deadline in seconds when only one unit is passed
-          in the POST body.
+          in the POST body. Example value is set to 10s. Please update it as per requirement
+          before triggering a calculation.
         explode: false
         in: header
         name: X-FactSet-Api-Long-Running-Deadline
@@ -26036,7 +26045,8 @@ paths:
           type: string
         style: simple
       - description: Long running deadline in seconds when only one unit is passed
-          in the PUT body.
+          in the PUT body. Example value is set to 10s. Please update it as per requirement
+          before triggering a calculation.
         explode: false
         in: header
         name: X-FactSet-Api-Long-Running-Deadline
@@ -30411,7 +30421,8 @@ paths:
       operationId: postAndCalculate
       parameters:
       - description: Long running deadline in seconds when only one unit is passed
-          in the POST body.
+          in the POST body. Example value is set to 10s. Please update it as per requirement
+          before triggering a calculation.
         explode: false
         in: header
         name: X-FactSet-Api-Long-Running-Deadline
@@ -31395,7 +31406,8 @@ paths:
           type: string
         style: simple
       - description: Long running deadline in seconds when only one unit is passed
-          in the PUT body.
+          in the PUT body. Example value is set to 10s. Please update it as per requirement
+          before triggering a calculation.
         explode: false
         in: header
         name: X-FactSet-Api-Long-Running-Deadline
@@ -38228,7 +38240,8 @@ paths:
       operationId: postAndCalculate
       parameters:
       - description: Long running deadline in seconds when only one unit is passed
-          in the POST body.
+          in the POST body. Example value is set to 10s. Please update it as per requirement
+          before triggering a calculation.
         explode: false
         in: header
         name: X-FactSet-Api-Long-Running-Deadline
@@ -39212,7 +39225,8 @@ paths:
           type: string
         style: simple
       - description: Long running deadline in seconds when only one unit is passed
-          in the PUT body.
+          in the PUT body. Example value is set to 10s. Please update it as per requirement
+          before triggering a calculation.
         explode: false
         in: header
         name: X-FactSet-Api-Long-Running-Deadline

diff --git a/auto-generated-sdk/docs/FiCalculationsApi.md b/auto-generated-sdk/docs/FiCalculationsApi.md
@@ -375,7 +375,7 @@ public class Example {
         Bearer.setBearerToken("BEARER TOKEN");
 
         FiCalculationsApi apiInstance = new FiCalculationsApi(defaultClient);
-        Integer xFactSetApiLongRunningDeadline = 10; // Integer | Long running deadline in seconds.
+        Integer xFactSetApiLongRunningDeadline = 10; // Integer | Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.
         String cacheControl = "cacheControl_example"; // String | Standard HTTP header.  Accepts max-stale.
         FICalculationParametersRoot fiCalculationParametersRoot = new FICalculationParametersRoot(); // FICalculationParametersRoot | Calculation Parameters
         try {
@@ -397,7 +397,7 @@ public class Example {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **xFactSetApiLongRunningDeadline** | **Integer**| Long running deadline in seconds. | [optional]
+ **xFactSetApiLongRunningDeadline** | **Integer**| Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. | [optional]
  **cacheControl** | **String**| Standard HTTP header.  Accepts max-stale. | [optional]
  **fiCalculationParametersRoot** | [**FICalculationParametersRoot**](FICalculationParametersRoot.md)| Calculation Parameters | [optional]
 
@@ -464,7 +464,7 @@ public class Example {
 
         FiCalculationsApi apiInstance = new FiCalculationsApi(defaultClient);
         String id = "id_example"; // String | from url, provided from the location header in the Create and Run FI calculation endpoint
-        Integer xFactSetApiLongRunningDeadline = 10; // Integer | Long running deadline in seconds.
+        Integer xFactSetApiLongRunningDeadline = 10; // Integer | Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.
         String cacheControl = "cacheControl_example"; // String | Standard HTTP header.  Accepts max-stale.
         FICalculationParametersRoot fiCalculationParametersRoot = new FICalculationParametersRoot(); // FICalculationParametersRoot | Calculation Parameters
         try {
@@ -487,7 +487,7 @@ public class Example {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **String**| from url, provided from the location header in the Create and Run FI calculation endpoint |
- **xFactSetApiLongRunningDeadline** | **Integer**| Long running deadline in seconds. | [optional]
+ **xFactSetApiLongRunningDeadline** | **Integer**| Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. | [optional]
  **cacheControl** | **String**| Standard HTTP header.  Accepts max-stale. | [optional]
  **fiCalculationParametersRoot** | [**FICalculationParametersRoot**](FICalculationParametersRoot.md)| Calculation Parameters | [optional]
 

diff --git a/auto-generated-sdk/docs/FpoOptimizerApi.md b/auto-generated-sdk/docs/FpoOptimizerApi.md
@@ -381,7 +381,7 @@ public class Example {
         Bearer.setBearerToken("BEARER TOKEN");
 
         FpoOptimizerApi apiInstance = new FpoOptimizerApi(defaultClient);
-        Integer xFactSetApiLongRunningDeadline = 10; // Integer | Long running deadline in seconds.
+        Integer xFactSetApiLongRunningDeadline = 10; // Integer | Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.
         String cacheControl = "cacheControl_example"; // String | Standard HTTP header.  Accepts max-stale.
         FPOOptimizationParametersRoot fpOOptimizationParametersRoot = new FPOOptimizationParametersRoot(); // FPOOptimizationParametersRoot | Optimization Parameters
         try {
@@ -403,7 +403,7 @@ public class Example {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **xFactSetApiLongRunningDeadline** | **Integer**| Long running deadline in seconds. | [optional]
+ **xFactSetApiLongRunningDeadline** | **Integer**| Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. | [optional]
  **cacheControl** | **String**| Standard HTTP header.  Accepts max-stale. | [optional]
  **fpOOptimizationParametersRoot** | [**FPOOptimizationParametersRoot**](FPOOptimizationParametersRoot.md)| Optimization Parameters | [optional]
 
@@ -470,7 +470,7 @@ public class Example {
 
         FpoOptimizerApi apiInstance = new FpoOptimizerApi(defaultClient);
         String id = "id_example"; // String | from url, provided from the location header in the Create and Run FPO optimization endpoint
-        Integer xFactSetApiLongRunningDeadline = 10; // Integer | Long running deadline in seconds.
+        Integer xFactSetApiLongRunningDeadline = 10; // Integer | Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.
         String cacheControl = "cacheControl_example"; // String | Standard HTTP header.  Accepts max-stale.
         FPOOptimizationParametersRoot fpOOptimizationParametersRoot = new FPOOptimizationParametersRoot(); // FPOOptimizationParametersRoot | Optimization Parameters
         try {
@@ -493,7 +493,7 @@ public class Example {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **String**| from url, provided from the location header in the Create and Run FPO optimization endpoint |
- **xFactSetApiLongRunningDeadline** | **Integer**| Long running deadline in seconds. | [optional]
+ **xFactSetApiLongRunningDeadline** | **Integer**| Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. | [optional]
  **cacheControl** | **String**| Standard HTTP header.  Accepts max-stale. | [optional]
  **fpOOptimizationParametersRoot** | [**FPOOptimizationParametersRoot**](FPOOptimizationParametersRoot.md)| Optimization Parameters | [optional]
 

diff --git a/auto-generated-sdk/docs/NpoOptimizerApi.md b/auto-generated-sdk/docs/NpoOptimizerApi.md
@@ -378,7 +378,7 @@ public class Example {
         Bearer.setBearerToken("BEARER TOKEN");
 
         NpoOptimizerApi apiInstance = new NpoOptimizerApi(defaultClient);
-        Integer xFactSetApiLongRunningDeadline = 10; // Integer | Long running deadline in seconds.
+        Integer xFactSetApiLongRunningDeadline = 10; // Integer | Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.
         String cacheControl = "cacheControl_example"; // String | Standard HTTP header.  Accepts max-stale.
         NPOOptimizationParametersRoot npOOptimizationParametersRoot = new NPOOptimizationParametersRoot(); // NPOOptimizationParametersRoot | Optimization Parameters
         try {
@@ -400,7 +400,7 @@ public class Example {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **xFactSetApiLongRunningDeadline** | **Integer**| Long running deadline in seconds. | [optional]
+ **xFactSetApiLongRunningDeadline** | **Integer**| Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. | [optional]
  **cacheControl** | **String**| Standard HTTP header.  Accepts max-stale. | [optional]
  **npOOptimizationParametersRoot** | [**NPOOptimizationParametersRoot**](NPOOptimizationParametersRoot.md)| Optimization Parameters | [optional]
 
@@ -467,7 +467,7 @@ public class Example {
 
         NpoOptimizerApi apiInstance = new NpoOptimizerApi(defaultClient);
         String id = "id_example"; // String | from url, provided from the location header in the Create and Run NPO optimization endpoint
-        Integer xFactSetApiLongRunningDeadline = 10; // Integer | Long running deadline in seconds.
+        Integer xFactSetApiLongRunningDeadline = 10; // Integer | Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation.
         String cacheControl = "cacheControl_example"; // String | Standard HTTP header.  Accepts max-stale.
         NPOOptimizationParametersRoot npOOptimizationParametersRoot = new NPOOptimizationParametersRoot(); // NPOOptimizationParametersRoot | Optimization Parameters
         try {
@@ -490,7 +490,7 @@ public class Example {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **String**| from url, provided from the location header in the Create and Run NPO optimization endpoint |
- **xFactSetApiLongRunningDeadline** | **Integer**| Long running deadline in seconds. | [optional]
+ **xFactSetApiLongRunningDeadline** | **Integer**| Long running deadline in seconds. Example value is set to 10s. Please update it as per requirement before triggering a calculation. | [optional]
  **cacheControl** | **String**| Standard HTTP header.  Accepts max-stale. | [optional]
  **npOOptimizationParametersRoot** | [**NPOOptimizationParametersRoot**](NPOOptimizationParametersRoot.md)| Optimization Parameters | [optional]
 

diff --git a/auto-generated-sdk/docs/PaCalculationsApi.md b/auto-generated-sdk/docs/PaCalculationsApi.md
@@ -479,7 +479,7 @@ public class Example {
         Bearer.setBearerToken("BEARER TOKEN");
 
         PaCalculationsApi apiInstance = new PaCalculationsApi(defaultClient);
-        Integer xFactSetApiLongRunningDeadline = 10; // Integer | Long running deadline in seconds when only one unit is passed in the POST body.
+        Integer xFactSetApiLongRunningDeadline = 10; // Integer | Long running deadline in seconds when only one unit is passed in the POST body. Example value is set to 10s. Please update it as per requirement before triggering a calculation.
         String cacheControl = "cacheControl_example"; // String | Standard HTTP header.  Accepts max-stale.
         PACalculationParametersRoot paCalculationParametersRoot = new PACalculationParametersRoot(); // PACalculationParametersRoot | Calculation Parameters
         try {
@@ -501,7 +501,7 @@ public class Example {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **xFactSetApiLongRunningDeadline** | **Integer**| Long running deadline in seconds when only one unit is passed in the POST body. | [optional]
+ **xFactSetApiLongRunningDeadline** | **Integer**| Long running deadline in seconds when only one unit is passed in the POST body. Example value is set to 10s. Please update it as per requirement before triggering a calculation. | [optional]
  **cacheControl** | **String**| Standard HTTP header.  Accepts max-stale. | [optional]
  **paCalculationParametersRoot** | [**PACalculationParametersRoot**](PACalculationParametersRoot.md)| Calculation Parameters | [optional]
 
@@ -587,7 +587,7 @@ public class Example {
 
         PaCalculationsApi apiInstance = new PaCalculationsApi(defaultClient);
         String id = "id_example"; // String | from url, provided from the location header in the Create and Run PA calculation endpoint
-        Integer xFactSetApiLongRunningDeadline = 10; // Integer | Long running deadline in seconds when only one unit is passed in the PUT body.
+        Integer xFactSetApiLongRunningDeadline = 10; // Integer | Long running deadline in seconds when only one unit is passed in the PUT body. Example value is set to 10s. Please update it as per requirement before triggering a calculation
         String cacheControl = "cacheControl_example"; // String | Standard HTTP header.  Accepts max-stale.
         PACalculationParametersRoot paCalculationParametersRoot = new PACalculationParametersRoot(); // PACalculationParametersRoot | Calculation Parameters
         try {
@@ -610,7 +610,7 @@ public class Example {
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **String**| from url, provided from the location header in the Create and Run PA calculation endpoint |
- **xFactSetApiLongRunningDeadline** | **Integer**| Long running deadline in seconds when only one unit is passed in the PUT body. | [optional]
+ **xFactSetApiLongRunningDeadline** | **Integer**| Long running deadline in seconds when only one unit is passed in the PUT body. Example value is set to 10s. Please update it as per requirement before triggering a calculation | [optional]
  **cacheControl** | **String**| Standard HTTP header.  Accepts max-stale. | [optional]
  **paCalculationParametersRoot** | [**PACalculationParametersRoot**](PACalculationParametersRoot.md)| Calculation Parameters | [optional]