Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(sdk): Auto-created from 'analyticsapi-engines-sdk-generator' repository PR 55 for SDK version v5.6.0 #104

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions auto-generated-sdk/.openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ docs/FIABCalculationStatusSummary.md
docs/FIABCalculationsApi.md
docs/FIABDateParameters.md
docs/FIABIdentifier.md
docs/FIAttributionForJobSettings.md
docs/FIAttributionForSecurities.md
docs/FIBalloonExtension.md
docs/FIBankLoans.md
docs/FICalculationParameters.md
Expand Down Expand Up @@ -182,6 +184,8 @@ docs/SPARBenchmarkRoot.md
docs/SPARCalculationParameters.md
docs/SPARCalculationParametersRoot.md
docs/SPARCalculationsApi.md
docs/SPARComponent.md
docs/SPARComponentRoot.md
docs/SPARDateParameters.md
docs/SPARIdentifier.md
docs/StrategyDocumentsApi.md
Expand Down Expand Up @@ -214,6 +218,9 @@ docs/UnlinkedPATemplateSummaryRoot.md
docs/UnlinkedPATemplateUpdateParameters.md
docs/UnlinkedPATemplateUpdateParametersRoot.md
docs/UnlinkedPATemplatesApi.md
docs/VaultAttributionLoaderApi.md
docs/VaultAttributionLoaderResponse.md
docs/VaultAttributionLoaderResponseRoot.md
docs/VaultCalculationParameters.md
docs/VaultCalculationParametersRoot.md
docs/VaultCalculationsApi.md
Expand Down Expand Up @@ -257,6 +264,7 @@ fds/analyticsapi/engines/api/spar_calculations_api.py
fds/analyticsapi/engines/api/strategy_documents_api.py
fds/analyticsapi/engines/api/templated_pa_components_api.py
fds/analyticsapi/engines/api/unlinked_pa_templates_api.py
fds/analyticsapi/engines/api/vault_attribution_loader_api.py
fds/analyticsapi/engines/api/vault_calculations_api.py
fds/analyticsapi/engines/api_client.py
fds/analyticsapi/engines/apis/__init__.py
Expand Down Expand Up @@ -309,6 +317,8 @@ fds/analyticsapi/engines/model/document_directories_root.py
fds/analyticsapi/engines/model/error.py
fds/analyticsapi/engines/model/error_source.py
fds/analyticsapi/engines/model/event_summary.py
fds/analyticsapi/engines/model/fi_attribution_for_job_settings.py
fds/analyticsapi/engines/model/fi_attribution_for_securities.py
fds/analyticsapi/engines/model/fi_balloon_extension.py
fds/analyticsapi/engines/model/fi_bank_loans.py
fds/analyticsapi/engines/model/fi_calculation_parameters.py
Expand Down Expand Up @@ -417,6 +427,8 @@ fds/analyticsapi/engines/model/spar_benchmark.py
fds/analyticsapi/engines/model/spar_benchmark_root.py
fds/analyticsapi/engines/model/spar_calculation_parameters.py
fds/analyticsapi/engines/model/spar_calculation_parameters_root.py
fds/analyticsapi/engines/model/spar_component.py
fds/analyticsapi/engines/model/spar_component_root.py
fds/analyticsapi/engines/model/spar_date_parameters.py
fds/analyticsapi/engines/model/spar_identifier.py
fds/analyticsapi/engines/model/template_content_types.py
Expand Down Expand Up @@ -446,6 +458,8 @@ fds/analyticsapi/engines/model/unlinked_pa_template_summary.py
fds/analyticsapi/engines/model/unlinked_pa_template_summary_root.py
fds/analyticsapi/engines/model/unlinked_pa_template_update_parameters.py
fds/analyticsapi/engines/model/unlinked_pa_template_update_parameters_root.py
fds/analyticsapi/engines/model/vault_attribution_loader_response.py
fds/analyticsapi/engines/model/vault_attribution_loader_response_root.py
fds/analyticsapi/engines/model/vault_calculation_parameters.py
fds/analyticsapi/engines/model/vault_calculation_parameters_root.py
fds/analyticsapi/engines/model/vault_component.py
Expand Down
8 changes: 8 additions & 0 deletions auto-generated-sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@ Class | Method | HTTP request | Description
*ColumnsApi* | [**get_pa_columns**](docs/ColumnsApi.md#get_pa_columns) | **GET** /analytics/engines/pa/v3/columns | Get PA columns
*ComponentsApi* | [**get_pa_component_by_id**](docs/ComponentsApi.md#get_pa_component_by_id) | **GET** /analytics/engines/pa/v3/components/{id} | Get PA component by id
*ComponentsApi* | [**get_pa_components**](docs/ComponentsApi.md#get_pa_components) | **GET** /analytics/engines/pa/v3/components | Get PA components
*ComponentsApi* | [**get_spar_component_by_id**](docs/ComponentsApi.md#get_spar_component_by_id) | **GET** /analytics/engines/spar/v3/components/{id} | Get SPAR component by id
*ComponentsApi* | [**get_spar_components**](docs/ComponentsApi.md#get_spar_components) | **GET** /analytics/engines/spar/v3/components | Get SPAR components
*ComponentsApi* | [**get_vault_component_by_id**](docs/ComponentsApi.md#get_vault_component_by_id) | **GET** /analytics/engines/vault/v3/components/{id} | Get Vault component by id
*ComponentsApi* | [**get_vault_components**](docs/ComponentsApi.md#get_vault_components) | **GET** /analytics/engines/vault/v3/components | Get Vault components
Expand Down Expand Up @@ -221,6 +222,7 @@ Class | Method | HTTP request | Description
*VaultCalculationsApi* | [**get_calculation_unit_result_by_id**](docs/VaultCalculationsApi.md#get_calculation_unit_result_by_id) | **GET** /analytics/engines/vault/v3/calculations/{id}/units/{unitId}/result | Get Vault calculation result by id
*VaultCalculationsApi* | [**post_and_calculate**](docs/VaultCalculationsApi.md#post_and_calculate) | **POST** /analytics/engines/vault/v3/calculations | Create and Run Vault calculation
*VaultCalculationsApi* | [**put_and_calculate**](docs/VaultCalculationsApi.md#put_and_calculate) | **PUT** /analytics/engines/vault/v3/calculations/{id} | Create or Update Vault calculation and run it.
*VaultAttributionLoaderApi* | [**vault_attribution_loader**](docs/VaultAttributionLoaderApi.md#vault_attribution_loader) | **POST** /analytics/engines/vault/v3/load/{batchId} | Vault - External Attribution Loader


## Documentation For Models
Expand Down Expand Up @@ -276,6 +278,8 @@ Class | Method | HTTP request | Description
- [FIABCalculationStatusSummary](docs/FIABCalculationStatusSummary.md)
- [FIABDateParameters](docs/FIABDateParameters.md)
- [FIABIdentifier](docs/FIABIdentifier.md)
- [FIAttributionForJobSettings](docs/FIAttributionForJobSettings.md)
- [FIAttributionForSecurities](docs/FIAttributionForSecurities.md)
- [FIBalloonExtension](docs/FIBalloonExtension.md)
- [FIBankLoans](docs/FIBankLoans.md)
- [FICalculationParameters](docs/FICalculationParameters.md)
Expand Down Expand Up @@ -379,6 +383,8 @@ Class | Method | HTTP request | Description
- [SPARBenchmarkRoot](docs/SPARBenchmarkRoot.md)
- [SPARCalculationParameters](docs/SPARCalculationParameters.md)
- [SPARCalculationParametersRoot](docs/SPARCalculationParametersRoot.md)
- [SPARComponent](docs/SPARComponent.md)
- [SPARComponentRoot](docs/SPARComponentRoot.md)
- [SPARDateParameters](docs/SPARDateParameters.md)
- [SPARIdentifier](docs/SPARIdentifier.md)
- [TemplateContentTypes](docs/TemplateContentTypes.md)
Expand Down Expand Up @@ -408,6 +414,8 @@ Class | Method | HTTP request | Description
- [UnlinkedPATemplateSummaryRoot](docs/UnlinkedPATemplateSummaryRoot.md)
- [UnlinkedPATemplateUpdateParameters](docs/UnlinkedPATemplateUpdateParameters.md)
- [UnlinkedPATemplateUpdateParametersRoot](docs/UnlinkedPATemplateUpdateParametersRoot.md)
- [VaultAttributionLoaderResponse](docs/VaultAttributionLoaderResponse.md)
- [VaultAttributionLoaderResponseRoot](docs/VaultAttributionLoaderResponseRoot.md)
- [VaultCalculationParameters](docs/VaultCalculationParameters.md)
- [VaultCalculationParametersRoot](docs/VaultCalculationParametersRoot.md)
- [VaultComponent](docs/VaultComponent.md)
Expand Down
2 changes: 1 addition & 1 deletion auto-generated-sdk/docs/AFIOptimizationParametersRoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**AFIOptimizationParameters**](AFIOptimizationParameters.md) | | [optional]
**meta** | **bool, date, datetime, dict, float, int, list, str** | | [optional]
**meta** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**AxiomaEquityOptimizationParameters**](AxiomaEquityOptimizationParameters.md) | | [optional]
**meta** | **bool, date, datetime, dict, float, int, list, str** | | [optional]
**meta** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
2 changes: 1 addition & 1 deletion auto-generated-sdk/docs/BPMOptimizationParametersRoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**BPMOptimizationParameters**](BPMOptimizationParameters.md) | | [optional]
**meta** | **bool, date, datetime, dict, float, int, list, str** | | [optional]
**meta** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
1 change: 1 addition & 0 deletions auto-generated-sdk/docs/CalculationUnitStatus.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Name | Type | Description | Notes
**result** | **str** | The result URL of the calculation. | [optional]
**progress** | **str** | The progress of the calculation unit. | [optional]
**points** | **int** | The points for the calculation unit. | [optional]
**warnings** | **[str]** | The warnings in a calculation unit. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
93 changes: 93 additions & 0 deletions auto-generated-sdk/docs/ComponentsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**get_pa_component_by_id**](ComponentsApi.md#get_pa_component_by_id) | **GET** /analytics/engines/pa/v3/components/{id} | Get PA component by id
[**get_pa_components**](ComponentsApi.md#get_pa_components) | **GET** /analytics/engines/pa/v3/components | Get PA components
[**get_spar_component_by_id**](ComponentsApi.md#get_spar_component_by_id) | **GET** /analytics/engines/spar/v3/components/{id} | Get SPAR component by id
[**get_spar_components**](ComponentsApi.md#get_spar_components) | **GET** /analytics/engines/spar/v3/components | Get SPAR components
[**get_vault_component_by_id**](ComponentsApi.md#get_vault_component_by_id) | **GET** /analytics/engines/vault/v3/components/{id} | Get Vault component by id
[**get_vault_components**](ComponentsApi.md#get_vault_components) | **GET** /analytics/engines/vault/v3/components | Get Vault components
Expand Down Expand Up @@ -196,6 +197,98 @@ Name | Type | Description | Notes

[[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)

# **get_spar_component_by_id**
> SPARComponentRoot get_spar_component_by_id(id)

Get SPAR component by id

This endpoint returns the default settings of a SPAR component.

### Example

* Basic Authentication (Basic):
* Bearer Authentication (Bearer):
```python
import time
import fds.analyticsapi.engines
from fds.analyticsapi.engines.api import components_api
from fds.analyticsapi.engines.model.spar_component_root import SPARComponentRoot
from fds.analyticsapi.engines.model.client_error_response import ClientErrorResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api.factset.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fds.analyticsapi.engines.Configuration(
host = "https://api.factset.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: Basic
configuration = fds.analyticsapi.engines.Configuration(
username = 'YOUR_USERNAME',
password = 'YOUR_PASSWORD'
)

# Configure Bearer authorization: Bearer
configuration = fds.analyticsapi.engines.Configuration(
access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with fds.analyticsapi.engines.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = components_api.ComponentsApi(api_client)
id = "id_example" # str | Unique identifier for a SPAR component

# example passing only required values which don't have defaults set
try:
# Get SPAR component by id
api_response = api_instance.get_spar_component_by_id(id)
pprint(api_response)
except fds.analyticsapi.engines.ApiException as e:
print("Exception when calling ComponentsApi->get_spar_component_by_id: %s\n" % e)
```


### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **str**| Unique identifier for a SPAR component |

### Return type

- A tuple with response data, HTTP status code and response headers.
- **Response datatype**: [**SPARComponentRoot**](SPARComponentRoot.md)

### Authorization

[Basic](../README.md#Basic), [Bearer](../README.md#Bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Expected response, returns the default settings of a SPAR component. | * 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 SPAR component id. | * 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** | Component not found. | * 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> |
**406** | Unsupported Accept 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. Wait till the time specified in Retry-After header value to make further requests. | * 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> * 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)

# **get_spar_components**
> ComponentSummaryRoot get_spar_components(document)

Expand Down
2 changes: 2 additions & 0 deletions auto-generated-sdk/docs/Error.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | | [optional]
**code** | **str** | | [optional]
**title** | **str** | | [optional]
**detail** | **str** | | [optional]
**source** | [**ErrorSource**](ErrorSource.md) | | [optional]

Expand Down
12 changes: 12 additions & 0 deletions auto-generated-sdk/docs/FIAttributionForJobSettings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# FIAttributionForJobSettings


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**start_date** | **str** | Start Date | [optional]
**end_date** | **str** | End Date | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


15 changes: 15 additions & 0 deletions auto-generated-sdk/docs/FIAttributionForSecurities.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# FIAttributionForSecurities


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**start_price** | **float** | Start Price | [optional]
**end_price** | **float** | End Price | [optional]
**start_spread** | **float** | Start Spread | [optional]
**end_spread** | **float** | End Spread | [optional]
**pricing_method** | **str** | Pricing Method | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


Loading