❤
npm
Sign UpSign In

@factset/sdk-procuretopayscim

0.20.0 • Public • Published

FactSet

Procure to Pay SCIM client library for JavaScript

npm Apache-2 license

FactSet's SCIM API implementation.

This TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 0.20.0
  • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Requirements

  • Node.js >= 12

Installation

npm

npm install @factset/sdk-utils @factset/sdk-procuretopayscim

yarn

yarn add @factset/sdk-utils @factset/sdk-procuretopayscim

Usage

  1. Generate authentication credentials.
  2. Setup Node.js environment

    1. Install and activate Node.js >=12. If you're using nvm:

      nvm install 16
nvm use 16

    2. (optional) Install yarn.

  3. Install dependencies.
  4. Run the following:
const { ApiClient, GroupsApi } = require('@factset/sdk-procuretopayscim');
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
// 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 GroupsApi();
const id = "id_example"; // String | ID of resource.

// Call api endpoint
apiInstance.groupIdGet(id).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/scim/v2

Class Method HTTP request Description
procuretopayscim.GroupsApi groupIdGet GET /Group/{id} Get a group.
procuretopayscim.GroupsApi groupIdPatch PATCH /Group/{id} Patch a group (add, replace, or remove attributes of a group.)
procuretopayscim.GroupsApi groupIdPut PUT /Group/{id} Replace a group.
procuretopayscim.GroupsApi groupsGet GET /Groups Get a list of groups.
procuretopayscim.LocationsApi locationsGet GET /Locations Get a list of locations.
procuretopayscim.LocationsApi locationsIdGet GET /Locations/{id} Get a location.
procuretopayscim.LocationsApi locationsIdPatch PATCH /Locations/{id} Patch a location (add, replace, or remove attributes of a location.)
procuretopayscim.LocationsApi locationsIdPut PUT /Locations/{id} Replace a location.
procuretopayscim.ProductsApi productsGet GET /Products Get a list of products.
procuretopayscim.ProductsApi productsIdGet GET /Products/{id} Get a product.
procuretopayscim.SchemasApi schemasGet GET /Schemas Get a list of schemas.
procuretopayscim.SchemasApi schemasIdGet GET /Schemas/{id} Get a schema.
procuretopayscim.ServerConfigurationApi serviceProviderConfigGet GET /ServiceProviderConfig Get server configuration.
procuretopayscim.UsersApi usersGet GET /Users Get a list of users.
procuretopayscim.UsersApi usersIdDelete DELETE /Users/{id} Delete a user
procuretopayscim.UsersApi usersIdGet GET /Users/{id} Get a user.
procuretopayscim.UsersApi usersIdPatch PATCH /Users/{id} Patch a user (add, replace, or remove attributes of a user.)
procuretopayscim.UsersApi usersIdPut PUT /Users/{id} Replace a user.
procuretopayscim.UsersApi usersPost POST /Users Create a user.
procuretopayscim.VermilionGroupsApi vermilionGroupsGet GET /VermilionGroups Get a list of Vermilion groups.
procuretopayscim.VermilionGroupsApi vermilionGroupsIdGet GET /VermilionGroups/{id} Get a Vermilion group.
procuretopayscim.VermilionGroupsApi vermilionGroupsIdPatch PATCH /VermilionGroups/{id} Patch a Vermilion group (add, replace, or remove attributes of a Vermilion group.)
procuretopayscim.VermilionGroupsApi vermilionGroupsIdPut PUT /VermilionGroups/{id} Replace a Vermilion group.
procuretopayscim.VermilionUsersApi vermilionUsersGet GET /VermilionUsers Get a list of Vermilion users.
procuretopayscim.VermilionUsersApi vermilionUsersIdDelete DELETE /VermilionUsers/{id} Delete a Vermilion user
procuretopayscim.VermilionUsersApi vermilionUsersIdGet GET /VermilionUsers/{id} Get a Vermilion user.
procuretopayscim.VermilionUsersApi vermilionUsersIdPatch PATCH /VermilionUsers/{id} Patch a Vermilion user (add, replace, or remove attributes of a Vermilion user.)
procuretopayscim.VermilionUsersApi vermilionUsersIdPut PUT /VermilionUsers/{id} Replace a Vermilion user.
procuretopayscim.VermilionUsersApi vermilionUsersPost POST /VermilionUsers Create a Vermilion user.

Documentation for Models

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.

Readme

Keywords

Package Sidebar

Install

npm i @factset/sdk-procuretopayscim

Weekly Downloads

1

Version

0.20.0

License

Apache-2.0

Unpacked Size

313 kB

Total Files

67

Last publish

Collaborators

  • enterprisesdk
  • fds
  • tsouthmaydfds
Try on RunKit
Report malware