fds.sdk.FactSetProgrammaticEnvironment 0.21.13__tar.gz → 0.22.0__tar.gz

{fds.sdk.FactSetProgrammaticEnvironment-0.21.13 → fds.sdk.FactSetProgrammaticEnvironment-0.22.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fds.sdk.FactSetProgrammaticEnvironment
-Version: 0.21.13
+Version: 0.22.0
 Summary: FactSet Programmatic Environment client library for Python
 Home-page: https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1
 Author: FactSet Research Systems
@@ -15,8 +15,8 @@ License-File: LICENSE
 
 # FactSet Programmatic Environment client library for Python
 
-[![API Version](https://img.shields.io/badge/api-v1.0.0-blue)]()
-[![PyPi](https://img.shields.io/pypi/v/fds.sdk.FactSetProgrammaticEnvironment)](https://pypi.org/project/fds.sdk.FactSetProgrammaticEnvironment/)
+[![API Version](https://img.shields.io/badge/api-v1.0.0-blue)](https://developer.factset.com/api-catalog/factset-programmatic-environment-api)
+[![PyPi](https://img.shields.io/pypi/v/fds.sdk.FactSetProgrammaticEnvironment/0.22.0)](https://pypi.org/project/fds.sdk.FactSetProgrammaticEnvironment/v/0.22.0)
 [![Apache-2 license](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0)
 
 FactSet Programmatic Environment (FPE) API is an API for users to interact with FPE programmatically, streamlining path from research to production.
@@ -24,9 +24,11 @@ FactSet Programmatic Environment (FPE) API is an API for users to interact with
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0.0
-- SDK version: 0.21.13
+- SDK version: 0.22.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 
+For more information, please visit [https://developer.factset.com/contact](https://developer.factset.com/contact)
+
 ## Requirements
 
 * Python >= 3.7
@@ -36,13 +38,13 @@ This Python package is automatically generated by the [OpenAPI Generator](https:
 ### Poetry
 
 ```shell
-poetry add fds.sdk.utils fds.sdk.FactSetProgrammaticEnvironment==0.21.13
+poetry add fds.sdk.utils fds.sdk.FactSetProgrammaticEnvironment==0.22.0
 ```
 
 ### pip
 
 ```shell
-pip install fds.sdk.utils fds.sdk.FactSetProgrammaticEnvironment==0.21.13
+pip install fds.sdk.utils fds.sdk.FactSetProgrammaticEnvironment==0.22.0
 ```
 
 ## Usage
@@ -102,44 +104,49 @@ configuration = fds.sdk.FactSetProgrammaticEnvironment.Configuration(
 with fds.sdk.FactSetProgrammaticEnvironment.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = calculations_api.CalculationsApi(api_client)
-    id = "id_example" # str | From url, provided by location header or response body in the calculation start endpoint
+    calculation = Calculation(
+        script="script_example",
+        notebook="notebook_example",
+        kernel="python-3-7",
+    ) # Calculation |  (optional)
 
     try:
-        # Get calculation status by id
+        # Starts a new script calculation
         # example passing only required values which don't have defaults set
-        api_response = api_instance.analytics_quant_fpe_v1_calculations_id_get(id)
+        # and optional values
+        api_response = api_instance.create_calculations(calculation=calculation)
 
         pprint(api_response)
     except fds.sdk.FactSetProgrammaticEnvironment.ApiException as e:
-        print("Exception when calling CalculationsApi->analytics_quant_fpe_v1_calculations_id_get: %s\n" % e)
+        print("Exception when calling CalculationsApi->create_calculations: %s\n" % e)
 
     # # Get response, http status code and response headers
     # try:
-    #     # Get calculation status by id
-    #     api_response, http_status_code, response_headers = api_instance.analytics_quant_fpe_v1_calculations_id_get_with_http_info(id)
+    #     # Starts a new script calculation
+    #     api_response, http_status_code, response_headers = api_instance.create_calculations_with_http_info(calculation=calculation)
 
 
     #     pprint(api_response)
     #     pprint(http_status_code)
     #     pprint(response_headers)
     # except fds.sdk.FactSetProgrammaticEnvironment.ApiException as e:
-    #     print("Exception when calling CalculationsApi->analytics_quant_fpe_v1_calculations_id_get: %s\n" % e)
+    #     print("Exception when calling CalculationsApi->create_calculations: %s\n" % e)
 
     # # Get response asynchronous
     # try:
-    #     # Get calculation status by id
-    #     async_result = api_instance.analytics_quant_fpe_v1_calculations_id_get_async(id)
+    #     # Starts a new script calculation
+    #     async_result = api_instance.create_calculations_async(calculation=calculation)
     #     api_response = async_result.get()
 
 
     #     pprint(api_response)
     # except fds.sdk.FactSetProgrammaticEnvironment.ApiException as e:
-    #     print("Exception when calling CalculationsApi->analytics_quant_fpe_v1_calculations_id_get: %s\n" % e)
+    #     print("Exception when calling CalculationsApi->create_calculations: %s\n" % e)
 
     # # Get response, http status code and response headers asynchronous
     # try:
-    #     # Get calculation status by id
-    #     async_result = api_instance.analytics_quant_fpe_v1_calculations_id_get_with_http_info_async(id)
+    #     # Starts a new script calculation
+    #     async_result = api_instance.create_calculations_with_http_info_async(calculation=calculation)
     #     api_response, http_status_code, response_headers = async_result.get()
 
 
@@ -147,7 +154,7 @@ with fds.sdk.FactSetProgrammaticEnvironment.ApiClient(configuration) as api_clie
     #     pprint(http_status_code)
     #     pprint(response_headers)
     # except fds.sdk.FactSetProgrammaticEnvironment.ApiException as e:
-    #     print("Exception when calling CalculationsApi->analytics_quant_fpe_v1_calculations_id_get: %s\n" % e)
+    #     print("Exception when calling CalculationsApi->create_calculations: %s\n" % e)
 
 ```
 
@@ -237,16 +244,16 @@ configuration.retries = Retry(total=3, status_forcelist=[500, 502, 503, 504])
 
 ## Documentation for API Endpoints
 
-All URIs are relative to *https://api.factset.com*
+All URIs are relative to *https://api.factset.com/analytics/quant/fpe/v1*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*CalculationsApi* | [**analytics_quant_fpe_v1_calculations_id_get**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/CalculationsApi.md#analytics_quant_fpe_v1_calculations_id_get) | **GET** /analytics/quant/fpe/v1/calculations/{id} | Get calculation status by id
-*CalculationsApi* | [**analytics_quant_fpe_v1_calculations_id_log_get**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/CalculationsApi.md#analytics_quant_fpe_v1_calculations_id_log_get) | **GET** /analytics/quant/fpe/v1/calculations/{id}/log | Get calculation log for a specific calculation
-*CalculationsApi* | [**analytics_quant_fpe_v1_calculations_id_output_get**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/CalculationsApi.md#analytics_quant_fpe_v1_calculations_id_output_get) | **GET** /analytics/quant/fpe/v1/calculations/{id}/output | Get calculation output for a specific calculation
-*CalculationsApi* | [**analytics_quant_fpe_v1_calculations_post**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/CalculationsApi.md#analytics_quant_fpe_v1_calculations_post) | **POST** /analytics/quant/fpe/v1/calculations | Starts a new script calculation
-*FilesApi* | [**analytics_quant_fpe_v1_files_server_file_post**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/FilesApi.md#analytics_quant_fpe_v1_files_server_file_post) | **POST** /analytics/quant/fpe/v1/files/{server}/{file} | Starts a file upload
-*FilesApi* | [**analytics_quant_fpe_v1_files_uploads_id_get**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/FilesApi.md#analytics_quant_fpe_v1_files_uploads_id_get) | **GET** /analytics/quant/fpe/v1/files/uploads/{id} | Get upload status by id
+*CalculationsApi* | [**create_calculations**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/CalculationsApi.md#create_calculations) | **POST** /calculations | Starts a new script calculation
+*CalculationsApi* | [**get_calculations**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/CalculationsApi.md#get_calculations) | **GET** /calculations/{id} | Get calculation status by id
+*CalculationsApi* | [**get_calculations_log**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/CalculationsApi.md#get_calculations_log) | **GET** /calculations/{id}/log | Get calculation log for a specific calculation
+*CalculationsApi* | [**get_calculations_output**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/CalculationsApi.md#get_calculations_output) | **GET** /calculations/{id}/output | Get calculation output for a specific calculation
+*FilesApi* | [**get_upload_file_status**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/FilesApi.md#get_upload_file_status) | **GET** /files/uploads/{id} | Get upload status by id
+*FilesApi* | [**upload_file**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/FilesApi.md#upload_file) | **POST** /files/{server}/{file} | Starts a file upload
 
 
 ## Documentation For Models

{fds.sdk.FactSetProgrammaticEnvironment-0.21.13 → fds.sdk.FactSetProgrammaticEnvironment-0.22.0}/README.md

@@ -2,8 +2,8 @@
 
 # FactSet Programmatic Environment client library for Python
 
-[![API Version](https://img.shields.io/badge/api-v1.0.0-blue)]()
-[![PyPi](https://img.shields.io/pypi/v/fds.sdk.FactSetProgrammaticEnvironment)](https://pypi.org/project/fds.sdk.FactSetProgrammaticEnvironment/)
+[![API Version](https://img.shields.io/badge/api-v1.0.0-blue)](https://developer.factset.com/api-catalog/factset-programmatic-environment-api)
+[![PyPi](https://img.shields.io/pypi/v/fds.sdk.FactSetProgrammaticEnvironment/0.22.0)](https://pypi.org/project/fds.sdk.FactSetProgrammaticEnvironment/v/0.22.0)
 [![Apache-2 license](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0)
 
 FactSet Programmatic Environment (FPE) API is an API for users to interact with FPE programmatically, streamlining path from research to production.
@@ -11,9 +11,11 @@ FactSet Programmatic Environment (FPE) API is an API for users to interact with
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0.0
-- SDK version: 0.21.13
+- SDK version: 0.22.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 
+For more information, please visit [https://developer.factset.com/contact](https://developer.factset.com/contact)
+
 ## Requirements
 
 * Python >= 3.7
@@ -23,13 +25,13 @@ This Python package is automatically generated by the [OpenAPI Generator](https:
 ### Poetry
 
 ```shell
-poetry add fds.sdk.utils fds.sdk.FactSetProgrammaticEnvironment==0.21.13
+poetry add fds.sdk.utils fds.sdk.FactSetProgrammaticEnvironment==0.22.0
 ```
 
 ### pip
 
 ```shell
-pip install fds.sdk.utils fds.sdk.FactSetProgrammaticEnvironment==0.21.13
+pip install fds.sdk.utils fds.sdk.FactSetProgrammaticEnvironment==0.22.0
 ```
 
 ## Usage
@@ -89,44 +91,49 @@ configuration = fds.sdk.FactSetProgrammaticEnvironment.Configuration(
 with fds.sdk.FactSetProgrammaticEnvironment.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = calculations_api.CalculationsApi(api_client)
-    id = "id_example" # str | From url, provided by location header or response body in the calculation start endpoint
+    calculation = Calculation(
+        script="script_example",
+        notebook="notebook_example",
+        kernel="python-3-7",
+    ) # Calculation |  (optional)
 
     try:
-        # Get calculation status by id
+        # Starts a new script calculation
         # example passing only required values which don't have defaults set
-        api_response = api_instance.analytics_quant_fpe_v1_calculations_id_get(id)
+        # and optional values
+        api_response = api_instance.create_calculations(calculation=calculation)
 
         pprint(api_response)
     except fds.sdk.FactSetProgrammaticEnvironment.ApiException as e:
-        print("Exception when calling CalculationsApi->analytics_quant_fpe_v1_calculations_id_get: %s\n" % e)
+        print("Exception when calling CalculationsApi->create_calculations: %s\n" % e)
 
     # # Get response, http status code and response headers
     # try:
-    #     # Get calculation status by id
-    #     api_response, http_status_code, response_headers = api_instance.analytics_quant_fpe_v1_calculations_id_get_with_http_info(id)
+    #     # Starts a new script calculation
+    #     api_response, http_status_code, response_headers = api_instance.create_calculations_with_http_info(calculation=calculation)
 
 
     #     pprint(api_response)
     #     pprint(http_status_code)
     #     pprint(response_headers)
     # except fds.sdk.FactSetProgrammaticEnvironment.ApiException as e:
-    #     print("Exception when calling CalculationsApi->analytics_quant_fpe_v1_calculations_id_get: %s\n" % e)
+    #     print("Exception when calling CalculationsApi->create_calculations: %s\n" % e)
 
     # # Get response asynchronous
     # try:
-    #     # Get calculation status by id
-    #     async_result = api_instance.analytics_quant_fpe_v1_calculations_id_get_async(id)
+    #     # Starts a new script calculation
+    #     async_result = api_instance.create_calculations_async(calculation=calculation)
     #     api_response = async_result.get()
 
 
     #     pprint(api_response)
     # except fds.sdk.FactSetProgrammaticEnvironment.ApiException as e:
-    #     print("Exception when calling CalculationsApi->analytics_quant_fpe_v1_calculations_id_get: %s\n" % e)
+    #     print("Exception when calling CalculationsApi->create_calculations: %s\n" % e)
 
     # # Get response, http status code and response headers asynchronous
     # try:
-    #     # Get calculation status by id
-    #     async_result = api_instance.analytics_quant_fpe_v1_calculations_id_get_with_http_info_async(id)
+    #     # Starts a new script calculation
+    #     async_result = api_instance.create_calculations_with_http_info_async(calculation=calculation)
     #     api_response, http_status_code, response_headers = async_result.get()
 
 
@@ -134,7 +141,7 @@ with fds.sdk.FactSetProgrammaticEnvironment.ApiClient(configuration) as api_clie
     #     pprint(http_status_code)
     #     pprint(response_headers)
     # except fds.sdk.FactSetProgrammaticEnvironment.ApiException as e:
-    #     print("Exception when calling CalculationsApi->analytics_quant_fpe_v1_calculations_id_get: %s\n" % e)
+    #     print("Exception when calling CalculationsApi->create_calculations: %s\n" % e)
 
 ```
 
@@ -224,16 +231,16 @@ configuration.retries = Retry(total=3, status_forcelist=[500, 502, 503, 504])
 
 ## Documentation for API Endpoints
 
-All URIs are relative to *https://api.factset.com*
+All URIs are relative to *https://api.factset.com/analytics/quant/fpe/v1*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*CalculationsApi* | [**analytics_quant_fpe_v1_calculations_id_get**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/CalculationsApi.md#analytics_quant_fpe_v1_calculations_id_get) | **GET** /analytics/quant/fpe/v1/calculations/{id} | Get calculation status by id
-*CalculationsApi* | [**analytics_quant_fpe_v1_calculations_id_log_get**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/CalculationsApi.md#analytics_quant_fpe_v1_calculations_id_log_get) | **GET** /analytics/quant/fpe/v1/calculations/{id}/log | Get calculation log for a specific calculation
-*CalculationsApi* | [**analytics_quant_fpe_v1_calculations_id_output_get**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/CalculationsApi.md#analytics_quant_fpe_v1_calculations_id_output_get) | **GET** /analytics/quant/fpe/v1/calculations/{id}/output | Get calculation output for a specific calculation
-*CalculationsApi* | [**analytics_quant_fpe_v1_calculations_post**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/CalculationsApi.md#analytics_quant_fpe_v1_calculations_post) | **POST** /analytics/quant/fpe/v1/calculations | Starts a new script calculation
-*FilesApi* | [**analytics_quant_fpe_v1_files_server_file_post**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/FilesApi.md#analytics_quant_fpe_v1_files_server_file_post) | **POST** /analytics/quant/fpe/v1/files/{server}/{file} | Starts a file upload
-*FilesApi* | [**analytics_quant_fpe_v1_files_uploads_id_get**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/FilesApi.md#analytics_quant_fpe_v1_files_uploads_id_get) | **GET** /analytics/quant/fpe/v1/files/uploads/{id} | Get upload status by id
+*CalculationsApi* | [**create_calculations**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/CalculationsApi.md#create_calculations) | **POST** /calculations | Starts a new script calculation
+*CalculationsApi* | [**get_calculations**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/CalculationsApi.md#get_calculations) | **GET** /calculations/{id} | Get calculation status by id
+*CalculationsApi* | [**get_calculations_log**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/CalculationsApi.md#get_calculations_log) | **GET** /calculations/{id}/log | Get calculation log for a specific calculation
+*CalculationsApi* | [**get_calculations_output**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/CalculationsApi.md#get_calculations_output) | **GET** /calculations/{id}/output | Get calculation output for a specific calculation
+*FilesApi* | [**get_upload_file_status**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/FilesApi.md#get_upload_file_status) | **GET** /files/uploads/{id} | Get upload status by id
+*FilesApi* | [**upload_file**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/FilesApi.md#upload_file) | **POST** /files/{server}/{file} | Starts a file upload
 
 
 ## Documentation For Models

{fds.sdk.FactSetProgrammaticEnvironment-0.21.13 → fds.sdk.FactSetProgrammaticEnvironment-0.22.0}/fds/sdk/FactSetProgrammaticEnvironment/__init__.py

@@ -6,11 +6,12 @@
     FactSet Programmatic Environment (FPE) API is an API for users to interact with FPE programmatically, streamlining path from research to production.  # noqa: E501
 
     The version of the OpenAPI document: 1.0.0
+    Contact: api@factset.com
     Generated by: https://openapi-generator.tech
 """
 
 
-__version__ = "0.21.13"
+__version__ = "0.22.0"
 
 # import ApiClient
 from fds.sdk.FactSetProgrammaticEnvironment.api_client import ApiClient