Skip to content
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 @@ -185,6 +187,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 @@ -217,6 +221,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 @@ src/FactSet.AnalyticsAPI.Engines/Api/SPARCalculationsApi.cs
src/FactSet.AnalyticsAPI.Engines/Api/StrategyDocumentsApi.cs
src/FactSet.AnalyticsAPI.Engines/Api/TemplatedPAComponentsApi.cs
src/FactSet.AnalyticsAPI.Engines/Api/UnlinkedPATemplatesApi.cs
src/FactSet.AnalyticsAPI.Engines/Api/VaultAttributionLoaderApi.cs
src/FactSet.AnalyticsAPI.Engines/Api/VaultCalculationsApi.cs
src/FactSet.AnalyticsAPI.Engines/Client/ApiClient.cs
src/FactSet.AnalyticsAPI.Engines/Client/ApiException.cs
Expand Down Expand Up @@ -327,6 +335,8 @@ src/FactSet.AnalyticsAPI.Engines/Model/FIABCalculationStatus.cs
src/FactSet.AnalyticsAPI.Engines/Model/FIABCalculationStatusSummary.cs
src/FactSet.AnalyticsAPI.Engines/Model/FIABDateParameters.cs
src/FactSet.AnalyticsAPI.Engines/Model/FIABIdentifier.cs
src/FactSet.AnalyticsAPI.Engines/Model/FIAttributionForJobSettings.cs
src/FactSet.AnalyticsAPI.Engines/Model/FIAttributionForSecurities.cs
src/FactSet.AnalyticsAPI.Engines/Model/FIBalloonExtension.cs
src/FactSet.AnalyticsAPI.Engines/Model/FIBankLoans.cs
src/FactSet.AnalyticsAPI.Engines/Model/FICalculationParameters.cs
Expand Down Expand Up @@ -433,6 +443,8 @@ src/FactSet.AnalyticsAPI.Engines/Model/SPARBenchmark.cs
src/FactSet.AnalyticsAPI.Engines/Model/SPARBenchmarkRoot.cs
src/FactSet.AnalyticsAPI.Engines/Model/SPARCalculationParameters.cs
src/FactSet.AnalyticsAPI.Engines/Model/SPARCalculationParametersRoot.cs
src/FactSet.AnalyticsAPI.Engines/Model/SPARComponent.cs
src/FactSet.AnalyticsAPI.Engines/Model/SPARComponentRoot.cs
src/FactSet.AnalyticsAPI.Engines/Model/SPARDateParameters.cs
src/FactSet.AnalyticsAPI.Engines/Model/SPARIdentifier.cs
src/FactSet.AnalyticsAPI.Engines/Model/TemplateContentTypes.cs
Expand Down Expand Up @@ -462,6 +474,8 @@ src/FactSet.AnalyticsAPI.Engines/Model/UnlinkedPATemplateSummary.cs
src/FactSet.AnalyticsAPI.Engines/Model/UnlinkedPATemplateSummaryRoot.cs
src/FactSet.AnalyticsAPI.Engines/Model/UnlinkedPATemplateUpdateParameters.cs
src/FactSet.AnalyticsAPI.Engines/Model/UnlinkedPATemplateUpdateParametersRoot.cs
src/FactSet.AnalyticsAPI.Engines/Model/VaultAttributionLoaderResponse.cs
src/FactSet.AnalyticsAPI.Engines/Model/VaultAttributionLoaderResponseRoot.cs
src/FactSet.AnalyticsAPI.Engines/Model/VaultCalculationParameters.cs
src/FactSet.AnalyticsAPI.Engines/Model/VaultCalculationParametersRoot.cs
src/FactSet.AnalyticsAPI.Engines/Model/VaultComponent.cs
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 @@ -132,6 +132,7 @@ Class | Method | HTTP request | Description
*ColumnsApi* | [**GetPAColumns**](docs/ColumnsApi.md#getpacolumns) | **GET** /analytics/engines/pa/v3/columns | Get PA columns
*ComponentsApi* | [**GetPAComponentById**](docs/ComponentsApi.md#getpacomponentbyid) | **GET** /analytics/engines/pa/v3/components/{id} | Get PA component by id
*ComponentsApi* | [**GetPAComponents**](docs/ComponentsApi.md#getpacomponents) | **GET** /analytics/engines/pa/v3/components | Get PA components
*ComponentsApi* | [**GetSPARComponentById**](docs/ComponentsApi.md#getsparcomponentbyid) | **GET** /analytics/engines/spar/v3/components/{id} | Get SPAR component by id
*ComponentsApi* | [**GetSPARComponents**](docs/ComponentsApi.md#getsparcomponents) | **GET** /analytics/engines/spar/v3/components | Get SPAR components
*ComponentsApi* | [**GetVaultComponentById**](docs/ComponentsApi.md#getvaultcomponentbyid) | **GET** /analytics/engines/vault/v3/components/{id} | Get Vault component by id
*ComponentsApi* | [**GetVaultComponents**](docs/ComponentsApi.md#getvaultcomponents) | **GET** /analytics/engines/vault/v3/components | Get Vault components
Expand Down Expand Up @@ -223,6 +224,7 @@ Class | Method | HTTP request | Description
*UnlinkedPATemplatesApi* | [**GetUnlinkedPATemplates**](docs/UnlinkedPATemplatesApi.md#getunlinkedpatemplates) | **GET** /analytics/engines/pa/v3/unlinked-templates | Get unlinked PA templates
*UnlinkedPATemplatesApi* | [**GetUnlinkedPATemplatesById**](docs/UnlinkedPATemplatesApi.md#getunlinkedpatemplatesbyid) | **GET** /analytics/engines/pa/v3/unlinked-templates/{id} | Get unlinked PA template details by id
*UnlinkedPATemplatesApi* | [**UpdateUnlinkedPATemplates**](docs/UnlinkedPATemplatesApi.md#updateunlinkedpatemplates) | **PUT** /analytics/engines/pa/v3/unlinked-templates/{id} | Update unlinked PA template
*VaultAttributionLoaderApi* | [**VaultAttributionLoader**](docs/VaultAttributionLoaderApi.md#vaultattributionloader) | **POST** /analytics/engines/vault/v3/load/{batchId} | Vault - External Attribution Loader
*VaultCalculationsApi* | [**CancelCalculationById**](docs/VaultCalculationsApi.md#cancelcalculationbyid) | **DELETE** /analytics/engines/vault/v3/calculations/{id} | Cancel Vault calculation by id
*VaultCalculationsApi* | [**GetAllCalculations**](docs/VaultCalculationsApi.md#getallcalculations) | **GET** /analytics/engines/vault/v3/calculations | Get all calculations
*VaultCalculationsApi* | [**GetCalculationParameters**](docs/VaultCalculationsApi.md#getcalculationparameters) | **GET** /analytics/engines/vault/v3/calculations/{id} | Get Vault calculation parameters by id
Expand Down Expand Up @@ -286,6 +288,8 @@ Class | Method | HTTP request | Description
- [Model.FIABCalculationStatusSummary](docs/FIABCalculationStatusSummary.md)
- [Model.FIABDateParameters](docs/FIABDateParameters.md)
- [Model.FIABIdentifier](docs/FIABIdentifier.md)
- [Model.FIAttributionForJobSettings](docs/FIAttributionForJobSettings.md)
- [Model.FIAttributionForSecurities](docs/FIAttributionForSecurities.md)
- [Model.FIBalloonExtension](docs/FIBalloonExtension.md)
- [Model.FIBankLoans](docs/FIBankLoans.md)
- [Model.FICalculationParameters](docs/FICalculationParameters.md)
Expand Down Expand Up @@ -392,6 +396,8 @@ Class | Method | HTTP request | Description
- [Model.SPARBenchmarkRoot](docs/SPARBenchmarkRoot.md)
- [Model.SPARCalculationParameters](docs/SPARCalculationParameters.md)
- [Model.SPARCalculationParametersRoot](docs/SPARCalculationParametersRoot.md)
- [Model.SPARComponent](docs/SPARComponent.md)
- [Model.SPARComponentRoot](docs/SPARComponentRoot.md)
- [Model.SPARDateParameters](docs/SPARDateParameters.md)
- [Model.SPARIdentifier](docs/SPARIdentifier.md)
- [Model.TemplateContentTypes](docs/TemplateContentTypes.md)
Expand Down Expand Up @@ -421,6 +427,8 @@ Class | Method | HTTP request | Description
- [Model.UnlinkedPATemplateSummaryRoot](docs/UnlinkedPATemplateSummaryRoot.md)
- [Model.UnlinkedPATemplateUpdateParameters](docs/UnlinkedPATemplateUpdateParameters.md)
- [Model.UnlinkedPATemplateUpdateParametersRoot](docs/UnlinkedPATemplateUpdateParametersRoot.md)
- [Model.VaultAttributionLoaderResponse](docs/VaultAttributionLoaderResponse.md)
- [Model.VaultAttributionLoaderResponseRoot](docs/VaultAttributionLoaderResponseRoot.md)
- [Model.VaultCalculationParameters](docs/VaultCalculationParameters.md)
- [Model.VaultCalculationParametersRoot](docs/VaultCalculationParametersRoot.md)
- [Model.VaultComponent](docs/VaultComponent.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** | **string** | The result URL of the calculation. | [optional]
**Progress** | **string** | The progress of the calculation unit. | [optional]
**Points** | **int** | The points for the calculation unit. | [optional]
**Warnings** | **List<string>** | 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)

86 changes: 86 additions & 0 deletions auto-generated-sdk/docs/ComponentsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**GetPAComponentById**](ComponentsApi.md#getpacomponentbyid) | **GET** /analytics/engines/pa/v3/components/{id} | Get PA component by id
[**GetPAComponents**](ComponentsApi.md#getpacomponents) | **GET** /analytics/engines/pa/v3/components | Get PA components
[**GetSPARComponentById**](ComponentsApi.md#getsparcomponentbyid) | **GET** /analytics/engines/spar/v3/components/{id} | Get SPAR component by id
[**GetSPARComponents**](ComponentsApi.md#getsparcomponents) | **GET** /analytics/engines/spar/v3/components | Get SPAR components
[**GetVaultComponentById**](ComponentsApi.md#getvaultcomponentbyid) | **GET** /analytics/engines/vault/v3/components/{id} | Get Vault component by id
[**GetVaultComponents**](ComponentsApi.md#getvaultcomponents) | **GET** /analytics/engines/vault/v3/components | Get Vault components
Expand Down Expand Up @@ -181,6 +182,91 @@ 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)

<a name="getsparcomponentbyid"></a>
# **GetSPARComponentById**
> SPARComponentRoot GetSPARComponentById (string id)

Get SPAR component by id

This endpoint returns the default settings of a SPAR component.

### Example
```csharp
using System.Collections.Generic;
using System.Diagnostics;
using FactSet.AnalyticsAPI.Engines.Api;
using FactSet.AnalyticsAPI.Engines.Client;
using FactSet.AnalyticsAPI.Engines.Model;

namespace Example
{
public class GetSPARComponentByIdExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.factset.com";
// Configure HTTP basic authorization: Basic
config.Username = "YOUR_USERNAME";
config.Password = "YOUR_PASSWORD";
// Configure Bearer token for authorization: Bearer
config.AccessToken = "YOUR_BEARER_TOKEN";

var apiInstance = new ComponentsApi(config);
var id = id_example; // string | Unique identifier for a SPAR component

try
{
// Get SPAR component by id
SPARComponentRoot result = apiInstance.GetSPARComponentById(id);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling ComponentsApi.GetSPARComponentById: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
```

### Parameters

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

### Return type

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

<a name="getsparcomponents"></a>
# **GetSPARComponents**
> ComponentSummaryRoot GetSPARComponents (string 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** | **string** | | [optional]
**Code** | **string** | | [optional]
**Title** | **string** | | [optional]
**Detail** | **string** | | [optional]
**Source** | [**ErrorSource**](ErrorSource.md) | | [optional]

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

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**StartDate** | **string** | Start Date | [optional]
**EndDate** | **string** | 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)

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

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**StartPrice** | **double** | Start Price | [optional]
**EndPrice** | **double** | End Price | [optional]
**StartSpread** | **double** | Start Spread | [optional]
**EndSpread** | **double** | End Spread | [optional]
**PricingMethod** | **string** | 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)

1 change: 1 addition & 0 deletions auto-generated-sdk/docs/FIJobSettings.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Name | Type | Description | Notes
**MunicipalBonds** | [**FIMunicipalBondsForJobSettings**](FIMunicipalBondsForJobSettings.md) | | [optional]
**MarketEnvironment** | [**FIMarketEnvironment**](FIMarketEnvironment.md) | | [optional]
**StructuredProducts** | [**FIStructuredProductsForJobSettings**](FIStructuredProductsForJobSettings.md) | | [optional]
**Attribution** | [**FIAttributionForJobSettings**](FIAttributionForJobSettings.md) | | [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)

1 change: 1 addition & 0 deletions auto-generated-sdk/docs/FISecurity.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Name | Type | Description | Notes
**MatrixSpreadAdjustment** | **double** | Matrix Spread Adjustment | [optional]
**MatrixMultiplier** | **double** | Matrix Multiplier | [optional]
**StructuredProducts** | [**FIStructuredProductsForSecurities**](FIStructuredProductsForSecurities.md) | | [optional]
**Attribution** | [**FIAttributionForSecurities**](FIAttributionForSecurities.md) | | [optional]
**CalcFromMethod** | **string** | Calculation Method. Methods : Active Spread, Actual Spread, Actual Spread To Worst Call, OAS, Price, Yield, Yield To No Call, Act/Act Yield To No Call, Bond Equivalent Yield, Yield To Worst Call, Discount Yield, Discount Margin, Implied Volatility, Bullet Spread, Bullet Spread To Worst Call, Pricing Matrix | [optional]
**CalcFromValue** | **double** | Calculation from value |
**Face** | **double** | Face | [optional] [default to 1D]
Expand Down
Loading