feat(sdk): Auto-created from 'analyticsapi-engines-sdk-generator' repository PR 30 for SDK version v5.0.1 (#49)

factset-sdk-bot · web-flow · commit 3ba9fe7f010b · 2021-06-30T13:23:07.000-04:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,17 @@
+5.0.1 (06/30/2021)
+
+Supported API versions:
+
+* v3: [pa,spar,vault,pub,fi,axp,fpo,afi,npo,bpm,quant],v1:[fiab]
+
+Summmary:
+* In POST/PUT engines methods deprecated ContentOrganization and added StachContentOrganization
+* In POST/PUT engines methods deprecated ContentType and added CalculationFormat as replacement
+* The deprecated properties are still available and supported for backwards compatability
+* Deprecated some CalculationFormats that were unused
+
+-----------------------
+
 5.0.0 (06/17/2021)
 
 Supported API versions:
@@ -7,6 +21,12 @@ Supported API versions:
 Summmary:
 * Add support for v3 API's
 
+Breaking changes:
+* No changes
+
+Bug Fixes:
+* No changes
+
 -----------------------
 
 4.2.0 (01/19/2021)
diff --git a/auto-generated-sdk/README.md b/auto-generated-sdk/README.md
@@ -4,7 +4,7 @@ Allow clients to fetch Analytics through APIs.
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab]
-- Package version: 5.0.0
+- Package version: 5.0.1
 - Build package: CustomPythonClientCodegen
 For more information, please visit [https://developer.factset.com/contact](https://developer.factset.com/contact)
 
diff --git a/auto-generated-sdk/docs/AFIOptimizerApi.md b/auto-generated-sdk/docs/AFIOptimizerApi.md
@@ -472,16 +472,16 @@ Name | Type | Description  | Notes
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-**202** | Expected response, contains the poll URL in the Location header. |  * Location - URL to poll for the resulting optimization <br>  * X-DataDirect-Request-Key - FactSet’s request key header. <br>  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br>  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. <br>  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. <br>  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. <br>  |
-**201** | Expected response, returns json if optimization is completed in a short span. |  * X-DataDirect-Request-Key - FactSet’s request key header. <br>  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br>  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. <br>  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. <br>  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. <br>  |
-**400** | Invalid optimization parameters. |  * X-DataDirect-Request-Key - FactSet’s request key header. <br>  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br>  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. <br>  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. <br>  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. <br>  |
-**404** | One or more optimization settings were unavailable. |  * X-DataDirect-Request-Key - FactSet’s request key header. <br>  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br>  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. <br>  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. <br>  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. <br>  |
-**401** | Missing or invalid authentication. |  * X-DataDirect-Request-Key - FactSet’s request key header. <br>  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br>  |
-**403** | User is forbidden with current credentials |  * X-DataDirect-Request-Key - FactSet’s request key header. <br>  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br>  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. <br>  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. <br>  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. <br>  |
-**415** | Missing/Invalid Content-Type header. Header needs to be set to application/json. |  * X-DataDirect-Request-Key - FactSet’s request key header. <br>  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br>  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. <br>  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. <br>  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. <br>  |
-**429** | Rate limit reached. Cancel older requests using Cancel optimization endpoint or wait for older requests to finish/expire. |  * X-DataDirect-Request-Key - FactSet’s request key header. <br>  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br>  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. <br>  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. <br>  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. <br>  * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached. <br>  |
-**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. |  * X-DataDirect-Request-Key - FactSet’s request key header. <br>  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br>  |
-**503** | Request timed out. Retry the request in sometime. |  * X-DataDirect-Request-Key - FactSet’s request key header. <br>  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br>  |
+**202** | Expected response, contains the poll URL in the Location header. |  * Location - URL to poll for the resulting optimization <br>  * X-DataDirect-Request-Key - FactSet&#39;s request key header. <br>  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br>  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. <br>  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. <br>  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. <br>  |
+**201** | Expected response, returns json if optimization is completed in a short span. |  * X-DataDirect-Request-Key - FactSet&#39;s request key header. <br>  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br>  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. <br>  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. <br>  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. <br>  |
+**400** | Invalid optimization parameters. |  * X-DataDirect-Request-Key - FactSet&#39;s request key header. <br>  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br>  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. <br>  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. <br>  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. <br>  |
+**404** | One or more optimization settings were unavailable. |  * X-DataDirect-Request-Key - FactSet&#39;s request key header. <br>  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br>  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. <br>  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. <br>  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. <br>  |
+**401** | Missing or invalid authentication. |  * X-DataDirect-Request-Key - FactSet&#39;s request key header. <br>  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br>  |
+**403** | User is forbidden with current credentials |  * X-DataDirect-Request-Key - FactSet&#39;s request key header. <br>  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br>  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. <br>  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. <br>  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. <br>  |
+**415** | Missing/Invalid Content-Type header. Header needs to be set to application/json. |  * X-DataDirect-Request-Key - FactSet&#39;s request key header. <br>  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br>  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. <br>  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. <br>  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. <br>  |
+**429** | Rate limit reached. Cancel older requests using Cancel optimization endpoint or wait for older requests to finish/expire. |  * X-DataDirect-Request-Key - FactSet&#39;s request key header. <br>  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br>  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. <br>  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. <br>  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. <br>  * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached. <br>  |
+**500** | Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. |  * X-DataDirect-Request-Key - FactSet&#39;s request key header. <br>  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br>  |
+**503** | Request timed out. Retry the request in sometime. |  * X-DataDirect-Request-Key - FactSet&#39;s request key header. <br>  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. <br>  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
diff --git a/auto-generated-sdk/docs/CalculationMeta.md b/auto-generated-sdk/docs/CalculationMeta.md
@@ -5,7 +5,9 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **contentorganization** | **str** |  | [optional]  if omitted the server will use the default value of "SimplifiedRow"
+**stach_content_organization** | **str** |  | [optional]  if omitted the server will use the default value of "SimplifiedRow"
 **contenttype** | **str** |  | [optional]  if omitted the server will use the default value of "Json"
+**format** | **str** |  | [optional]  if omitted the server will use the default value of "JsonStach"
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/auto-generated-sdk/docs/FICalculationsApi.md b/auto-generated-sdk/docs/FICalculationsApi.md
@@ -411,7 +411,9 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
         ),
         meta=CalculationMeta(
             contentorganization="SimplifiedRow",
+            stach_content_organization="SimplifiedRow",
             contenttype="Json",
+            format="JsonStach",
         ),
     ) # FICalculationParametersRoot | Calculation Parameters (optional)
 
@@ -532,7 +534,9 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
         ),
         meta=CalculationMeta(
             contentorganization="SimplifiedRow",
+            stach_content_organization="SimplifiedRow",
             contenttype="Json",
+            format="JsonStach",
         ),
     ) # FICalculationParametersRoot | Calculation Parameters (optional)
 
diff --git a/auto-generated-sdk/docs/PACalculationsApi.md b/auto-generated-sdk/docs/PACalculationsApi.md
@@ -428,7 +428,9 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
         },
         meta=CalculationMeta(
             contentorganization="SimplifiedRow",
+            stach_content_organization="SimplifiedRow",
             contenttype="Json",
+            format="JsonStach",
         ),
     ) # PACalculationParametersRoot | Calculation Parameters (optional)
 
@@ -565,7 +567,9 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
         },
         meta=CalculationMeta(
             contentorganization="SimplifiedRow",
+            stach_content_organization="SimplifiedRow",
             contenttype="Json",
+            format="JsonStach",
         ),
     ) # PACalculationParametersRoot | Calculation Parameters (optional)
 
diff --git a/auto-generated-sdk/docs/QuantCalculationMeta.md b/auto-generated-sdk/docs/QuantCalculationMeta.md
@@ -4,10 +4,11 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**format** | **str** |  | [optional] 
 **allow_array_data** | **bool** |  | [optional] 
 **contentorganization** | **str** |  | [optional]  if omitted the server will use the default value of "SimplifiedRow"
+**stach_content_organization** | **str** |  | [optional]  if omitted the server will use the default value of "SimplifiedRow"
 **contenttype** | **str** |  | [optional]  if omitted the server will use the default value of "Json"
+**format** | **str** |  | [optional]  if omitted the server will use the default value of "JsonStach"
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/auto-generated-sdk/docs/QuantCalculationsApi.md b/auto-generated-sdk/docs/QuantCalculationsApi.md
@@ -443,10 +443,11 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
             ),
         },
         meta=QuantCalculationMeta(
-            format="JsonStach",
             allow_array_data=True,
             contentorganization="SimplifiedRow",
+            stach_content_organization="SimplifiedRow",
             contenttype="Json",
+            format="JsonStach",
         ),
     ) # QuantCalculationParametersRoot |  (optional)
 
@@ -595,10 +596,11 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
             ),
         },
         meta=QuantCalculationMeta(
-            format="JsonStach",
             allow_array_data=True,
             contentorganization="SimplifiedRow",
+            stach_content_organization="SimplifiedRow",
             contenttype="Json",
+            format="JsonStach",
         ),
     ) # QuantCalculationParametersRoot | Calculation Parameters (optional)
 
diff --git a/auto-generated-sdk/docs/SPARCalculationsApi.md b/auto-generated-sdk/docs/SPARCalculationsApi.md
@@ -413,7 +413,9 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
         },
         meta=CalculationMeta(
             contentorganization="SimplifiedRow",
+            stach_content_organization="SimplifiedRow",
             contenttype="Json",
+            format="JsonStach",
         ),
     ) # SPARCalculationParametersRoot | Calculation Parameters (optional)
 
@@ -535,7 +537,9 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
         },
         meta=CalculationMeta(
             contentorganization="SimplifiedRow",
+            stach_content_organization="SimplifiedRow",
             contenttype="Json",
+            format="JsonStach",
         ),
     ) # SPARCalculationParametersRoot | Calculation Parameters (optional)
 
diff --git a/auto-generated-sdk/docs/VaultCalculationsApi.md b/auto-generated-sdk/docs/VaultCalculationsApi.md
@@ -406,7 +406,9 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
         },
         meta=CalculationMeta(
             contentorganization="SimplifiedRow",
+            stach_content_organization="SimplifiedRow",
             contenttype="Json",
+            format="JsonStach",
         ),
     ) # VaultCalculationParametersRoot | Calculation Parameters (optional)
 
@@ -521,7 +523,9 @@ with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
         },
         meta=CalculationMeta(
             contentorganization="SimplifiedRow",
+            stach_content_organization="SimplifiedRow",
             contenttype="Json",
+            format="JsonStach",
         ),
     ) # VaultCalculationParametersRoot | Calculation Parameters (optional)
 
diff --git a/auto-generated-sdk/fds/analyticsapi/engines/__init__.py b/auto-generated-sdk/fds/analyticsapi/engines/__init__.py
@@ -11,7 +11,7 @@
 """
 
 
-__version__ = "5.0.0"
+__version__ = "5.0.1"
 
 # import ApiClient
 from fds.analyticsapi.engines.api_client import ApiClient
diff --git a/auto-generated-sdk/fds/analyticsapi/engines/api_client.py b/auto-generated-sdk/fds/analyticsapi/engines/api_client.py
@@ -77,7 +77,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None,
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'engines-api/5.0.0/python'
+        self.user_agent = 'engines-api/5.0.1/python'
 
     def __enter__(self):
         return self
diff --git a/auto-generated-sdk/fds/analyticsapi/engines/configuration.py b/auto-generated-sdk/fds/analyticsapi/engines/configuration.py
@@ -402,7 +402,7 @@ def to_debug_report(self):
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: v3:[pa,spar,vault,pub,quant,fi,axp,afi,npo,bpm,fpo,others],v1:[fiab]\n"\
-               "SDK Package Version: 5.0.0".\
+               "SDK Package Version: 5.0.1".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):
diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/calculation_meta.py b/auto-generated-sdk/fds/analyticsapi/engines/model/calculation_meta.py
@@ -59,10 +59,27 @@ class CalculationMeta(ModelNormal):
             'COLUMN': "Column",
             'SIMPLIFIEDROW': "SimplifiedRow",
         },
+        ('stach_content_organization',): {
+            'NONE': "None",
+            'ROW': "Row",
+            'COLUMN': "Column",
+            'SIMPLIFIEDROW': "SimplifiedRow",
+        },
         ('contenttype',): {
             'JSON': "Json",
             'BINARY': "Binary",
         },
+        ('format',): {
+            'JSONSTACH': "JsonStach",
+            'TABLE': "Table",
+            'TABLEAU': "Tableau",
+            'BINARYSTACH': "BinaryStach",
+            'BISON': "Bison",
+            'BINARY': "Binary",
+            'PDF': "Pdf",
+            'PPTX': "Pptx",
+            'FEATHER': "Feather",
+        },
     }
 
     validations = {
@@ -84,7 +101,9 @@ def openapi_types():
         """
         return {
             'contentorganization': (str,),  # noqa: E501
+            'stach_content_organization': (str,),  # noqa: E501
             'contenttype': (str,),  # noqa: E501
+            'format': (str,),  # noqa: E501
         }
 
     @cached_property
@@ -94,7 +113,9 @@ def discriminator():
 
     attribute_map = {
         'contentorganization': 'contentorganization',  # noqa: E501
+        'stach_content_organization': 'stachContentOrganization',  # noqa: E501
         'contenttype': 'contenttype',  # noqa: E501
+        'format': 'format',  # noqa: E501
     }
 
     _composed_schemas = {}
@@ -144,7 +165,9 @@ def __init__(self, *args, **kwargs):  # noqa: E501
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
             contentorganization (str): [optional] if omitted the server will use the default value of "SimplifiedRow"  # noqa: E501
+            stach_content_organization (str): [optional] if omitted the server will use the default value of "SimplifiedRow"  # noqa: E501
             contenttype (str): [optional] if omitted the server will use the default value of "Json"  # noqa: E501
+            format (str): [optional] if omitted the server will use the default value of "JsonStach"  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
diff --git a/auto-generated-sdk/fds/analyticsapi/engines/model/quant_calculation_meta.py b/auto-generated-sdk/fds/analyticsapi/engines/model/quant_calculation_meta.py
diff --git a/auto-generated-sdk/setup.py b/auto-generated-sdk/setup.py
