@factset/sdk-paengine v1.0.2
PA Engine client library for JavaScript
Allow clients to fetch Analytics through APIs.
This TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:
- API version: 3.14.1
- Package version: 1.0.2
- Build package: com.factset.sdk.codegen.FactSetJavascriptClientCodegen
For more information, please visit https://developer.factset.com/contact
Requirements
- Node.js >= 14
Installation
npm
npm install @factset/sdk-utils @factset/sdk-paengine@1.0.2
yarn
yarn add @factset/sdk-utils @factset/sdk-paengine@1.0.2
Usage
- Generate authentication credentials.
Setup Node.js environment
Install and activate Node.js >=14. If you're using nvm:
nvm install 16 nvm use 16
(optional) Install yarn.
- Run the following:
!IMPORTANT The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.
Example Code
const { ApiClient, AccountsApi } = require('@factset/sdk-paengine');
const { ConfidentialClient } = require('@factset/sdk-utils');
const apiClient = ApiClient.instance;
// Examples for each supported authentication method are below,
// choose one that satisfies your use case.
// (Preferred) OAuth 2.0: FactSetOAuth2
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');
// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';
const apiInstance = new AccountsApi();
const path = Client:; // String | The directory to get the accounts and sub-directories in
// Call api endpoint
apiInstance.getAccounts(path).then(
data => {
console.log('API called successfully. Returned data:');
console.log(data);
},
error => {
console.error(error);
},
);
Documentation for API Endpoints
All URIs are relative to https://api.factset.com
Class | Method | HTTP request | Description |
---|---|---|---|
paengine.AccountsApi | getAccounts | GET /analytics/lookups/v3/accounts/{path} | Get accounts and sub-directories in a directory |
paengine.ColumnStatisticsApi | getPAColumnStatistics | GET /analytics/engines/pa/v3/columnstatistics | Get PA column statistics |
paengine.ColumnsApi | getPAColumnById | GET /analytics/engines/pa/v3/columns/{id} | Get PA column settings |
paengine.ColumnsApi | getPAColumns | GET /analytics/engines/pa/v3/columns | Get PA columns |
paengine.ComponentsApi | getPAComponentById | GET /analytics/engines/pa/v3/components/{id} | Get PA component by id |
paengine.ComponentsApi | getPAComponents | GET /analytics/engines/pa/v3/components | Get PA components |
paengine.CurrenciesApi | getCurrencies | GET /analytics/lookups/v3/currencies | Get currencies |
paengine.DatesApi | convertPADatesToAbsoluteFormat | GET /analytics/engines/pa/v3/dates | Convert PA dates to absolute format |
paengine.DocumentsApi | getPA3Documents | GET /analytics/engines/pa/v3/documents/{path} | Get PA3 documents and sub-directories in a directory |
paengine.FrequenciesApi | getPAFrequencies | GET /analytics/engines/pa/v3/frequencies | Get PA frequencies |
paengine.GroupsApi | getPAGroupingFrequencies | GET /analytics/engines/pa/v3/grouping-frequencies | Get PA grouping frequencies |
paengine.GroupsApi | getPAGroups | GET /analytics/engines/pa/v3/groups | Get PA groups |
paengine.LinkedPATemplatesApi | createLinkedPATemplates | POST /analytics/engines/pa/v3/linked-templates | Create a linked PA template |
paengine.LinkedPATemplatesApi | deleteLinkedPATemplates | DELETE /analytics/engines/pa/v3/linked-templates/{id} | Delete a linked PA template. |
paengine.LinkedPATemplatesApi | getLinkedPATemplates | GET /analytics/engines/pa/v3/linked-templates | Get linked PA templates |
paengine.LinkedPATemplatesApi | getLinkedPATemplatesById | GET /analytics/engines/pa/v3/linked-templates/{id} | Get linked PA template by id |
paengine.LinkedPATemplatesApi | updateLinkedPATemplates | PUT /analytics/engines/pa/v3/linked-templates/{id} | Update a linked PA template |
paengine.PACalculationsApi | cancelCalculationById | DELETE /analytics/engines/pa/v3/calculations/{id} | Cancel PA calculation by id |
paengine.PACalculationsApi | getAllCalculations | GET /analytics/engines/pa/v3/calculations | Get all calculations |
paengine.PACalculationsApi | getCalculationParameters | GET /analytics/engines/pa/v3/calculations/{id} | Get PA calculation parameters by id |
paengine.PACalculationsApi | getCalculationStatusById | GET /analytics/engines/pa/v3/calculations/{id}/status | Get PA calculation status by id |
paengine.PACalculationsApi | getCalculationUnitResultById | GET /analytics/engines/pa/v3/calculations/{id}/units/{unitId}/result | Get PA calculation result by id |
paengine.PACalculationsApi | postAndCalculate | POST /analytics/engines/pa/v3/calculations | Create and Run PA calculation |
paengine.PACalculationsApi | putAndCalculate | PUT /analytics/engines/pa/v3/calculations/{id} | Create or Update PA calculation and run it. |
paengine.PricingSourcesApi | getPAPricingSources | GET /analytics/engines/pa/v3/pricing-sources | Get PA pricing sources |
paengine.TemplatedPAComponentsApi | createTemplatedPAComponents | POST /analytics/engines/pa/v3/templated-components | Create templated PA component |
paengine.TemplatedPAComponentsApi | deleteTemplatedPAComponents | DELETE /analytics/engines/pa/v3/templated-components/{id} | Delete templated PA component |
paengine.TemplatedPAComponentsApi | getTemplatedPAComponentById | GET /analytics/engines/pa/v3/templated-components/{id} | Get templated PA component by id |
paengine.TemplatedPAComponentsApi | getTemplatedPAComponentsInPath | GET /analytics/engines/pa/v3/templated-components | Get templated PA components in path |
paengine.TemplatedPAComponentsApi | updateTemplatedPAComponents | PUT /analytics/engines/pa/v3/templated-components/{id} | Update templated PA component |
paengine.UnlinkedPATemplatesApi | createUnlinkedPATemplates | POST /analytics/engines/pa/v3/unlinked-templates | Create unlinked PA template |
paengine.UnlinkedPATemplatesApi | deleteUnlinkedPATemplates | DELETE /analytics/engines/pa/v3/unlinked-templates/{id} | Delete unlinked PA template |
paengine.UnlinkedPATemplatesApi | getDefaultUnlinkedPATemplateTypes | GET /analytics/engines/pa/v3/unlinked-templates/template-types | Get default unlinked PA template types. |
paengine.UnlinkedPATemplatesApi | getDetailsType | GET /analytics/engines/pa/v3/unlinked-templates/template-types/{id} | Get unlinked PA template type details by id. |
paengine.UnlinkedPATemplatesApi | getUnlinkedPATemplates | GET /analytics/engines/pa/v3/unlinked-templates | Get unlinked PA templates |
paengine.UnlinkedPATemplatesApi | getUnlinkedPATemplatesById | GET /analytics/engines/pa/v3/unlinked-templates/{id} | Get unlinked PA template details by id |
paengine.UnlinkedPATemplatesApi | updateUnlinkedPATemplates | PUT /analytics/engines/pa/v3/unlinked-templates/{id} | Update unlinked PA template |
Documentation for Models
- paengine.AccountDirectories
- paengine.AccountDirectoriesRoot
- paengine.CalculationMeta
- paengine.CalculationStatus
- paengine.CalculationStatusMeta
- paengine.CalculationStatusRoot
- paengine.CalculationUnitStatus
- paengine.CalculationUnitStatusMeta
- paengine.CalculationsSummary
- paengine.CalculationsSummaryRoot
- paengine.ClientErrorResponse
- paengine.Column
- paengine.ColumnRoot
- paengine.ColumnStatistic
- paengine.ColumnStatisticRoot
- paengine.ColumnSummary
- paengine.ColumnSummaryRoot
- paengine.ComponentSummary
- paengine.ComponentSummaryRoot
- paengine.Currency
- paengine.CurrencyRoot
- paengine.DateParametersSummary
- paengine.DateParametersSummaryRoot
- paengine.DocumentDirectories
- paengine.DocumentDirectoriesRoot
- paengine.Error
- paengine.ErrorSource
- paengine.Frequency
- paengine.FrequencyRoot
- paengine.Group
- paengine.GroupRoot
- paengine.LinkedPATemplate
- paengine.LinkedPATemplateParameters
- paengine.LinkedPATemplateParametersRoot
- paengine.LinkedPATemplatePostSummary
- paengine.LinkedPATemplatePostSummaryRoot
- paengine.LinkedPATemplateRoot
- paengine.LinkedPATemplateSummary
- paengine.LinkedPATemplateSummaryRoot
- paengine.LinkedPATemplateUpdateParameters
- paengine.LinkedPATemplateUpdateParametersRoot
- paengine.ObjectRoot
- paengine.PACalculationColumn
- paengine.PACalculationDataSources
- paengine.PACalculationGroup
- paengine.PACalculationParameters
- paengine.PACalculationParametersRoot
- paengine.PACalculationPricingSource
- paengine.PAComponent
- paengine.PAComponentData
- paengine.PAComponentRoot
- paengine.PADateParameters
- paengine.PAIdentifier
- paengine.PAPricingSource
- paengine.PAPricingSourceRoot
- paengine.PaginationInfo
- paengine.PaginationMeta
- paengine.TemplateContentTypes
- paengine.TemplatedPAComponent
- paengine.TemplatedPAComponentParameters
- paengine.TemplatedPAComponentParametersRoot
- paengine.TemplatedPAComponentPostSummary
- paengine.TemplatedPAComponentPostSummaryRoot
- paengine.TemplatedPAComponentRoot
- paengine.TemplatedPAComponentSummary
- paengine.TemplatedPAComponentSummaryRoot
- paengine.TemplatedPAComponentUpdateParameters
- paengine.TemplatedPAComponentUpdateParametersRoot
- paengine.UnlinkedPATemplate
- paengine.UnlinkedPATemplateCategoryAndType
- paengine.UnlinkedPATemplateCategoryAndTypeDetails
- paengine.UnlinkedPATemplateCategoryAndTypeDetailsRoot
- paengine.UnlinkedPATemplateCategoryAndTypeRoot
- paengine.UnlinkedPATemplateColumnDetails
- paengine.UnlinkedPATemplateGroupDetails
- paengine.UnlinkedPATemplateParameters
- paengine.UnlinkedPATemplateParametersRoot
- paengine.UnlinkedPATemplatePostSummary
- paengine.UnlinkedPATemplatePostSummaryRoot
- paengine.UnlinkedPATemplateRoot
- paengine.UnlinkedPATemplateSummary
- paengine.UnlinkedPATemplateSummaryRoot
- paengine.UnlinkedPATemplateUpdateParameters
- paengine.UnlinkedPATemplateUpdateParametersRoot
Documentation for Authorization
FactSetApiKey
- Type: HTTP basic authentication
FactSetOAuth2
- Type: OAuth
- Flow: application
- Authorization URL:
- Scopes: N/A
Contributing
Please refer to the contributing guide.
Copyright
Copyright 2022 FactSet Research Systems Inc
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
2 months ago
5 months ago
7 months ago
8 months ago
8 months ago
8 months ago
9 months ago
11 months ago
11 months ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago