{"id":18941,"library":"yellowgrid-api-ts","title":"YellowGrid API TypeScript Client","description":"OpenAPI-generated TypeScript/JavaScript client library for the YellowGrid API (version 3.2.116, latest stable). Uses Axios for HTTP requests. Supports Node.js, Webpack, and Browserify environments. Ships TypeScript type definitions. Compatible with ES5+ and CommonJS/ES6 module systems. Generated via OpenAPI Generator, providing comprehensive API coverage including accounts, credentials, contacts, and reseller operations.","status":"active","version":"3.2.116","language":"javascript","source_language":"en","source_url":"https://github.com/GIT_USER_ID/GIT_REPO_ID","tags":["javascript","axios","typescript","openapi-client","openapi-generator","yellowgrid-api-ts"],"install":[{"cmd":"npm install yellowgrid-api-ts","lang":"bash","label":"npm"},{"cmd":"yarn add yellowgrid-api-ts","lang":"bash","label":"yarn"},{"cmd":"pnpm add yellowgrid-api-ts","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Runtime dependency for HTTP requests","package":"axios","optional":false}],"imports":[{"note":"CommonJS require also works, but ESM import is preferred.","wrong":"const AccountsApi = require('yellowgrid-api-ts').AccountsApi","symbol":"AccountsApi","correct":"import { AccountsApi } from 'yellowgrid-api-ts'"},{"note":"May not exist in all versions; check API documentation for available classes.","symbol":"DefaultApi","correct":"import { DefaultApi } from 'yellowgrid-api-ts'"},{"note":"Configuration is used to set API keys and base path. Direct import from dist is an internal path.","wrong":"import { Configuration } from 'yellowgrid-api-ts/dist'","symbol":"Configuration","correct":"import { Configuration } from 'yellowgrid-api-ts'"},{"note":"Some older versions use ApiClient; check your generated code.","symbol":"ApiClient","correct":"import { ApiClient } from 'yellowgrid-api-ts'"}],"quickstart":{"code":"import { AccountsApi, Configuration } from 'yellowgrid-api-ts';\n\nconst config = new Configuration({\n  basePath: 'https://api.yellowgrid.com',\n  apiKey: process.env.YELLOWGRID_API_KEY ?? ''\n});\n\nconst api = new AccountsApi(config);\n\nasync function getAccount() {\n  try {\n    const response = await api.getGetAccount();\n    console.log('Account data:', response.data);\n  } catch (error) {\n    console.error('Error fetching account:', error);\n  }\n}\n\ngetAccount();","lang":"typescript","description":"Demonstrates creating a Configuration with an API key and fetching account data using AccountsApi."},"warnings":[{"fix":"Always generate client against the exact API version you are targeting.","message":"The package was generated from an OpenAPI spec; changing the spec may introduce breaking changes in method signatures.","severity":"breaking","affected_versions":">=0"},{"fix":"Upgrade to ES6+ environment or use a promise polyfill.","message":"ES5 support is deprecated; Promises/A+ library may be required in older environments.","severity":"deprecated","affected_versions":">=3.0"},{"fix":"Always set basePath in Configuration to your API server URL.","message":"Base path defaults to 'https://bitbucket.org' which is incorrect for production; must be overridden.","severity":"gotcha","affected_versions":">=0"},{"fix":"Check the auth scheme defined in your OpenAPI spec.","message":"API key authentication may require the 'apiKey' parameter in Configuration, not 'accessToken'.","severity":"gotcha","affected_versions":">=3.2"}],"env_vars":null,"last_verified":"2026-04-25T00:00:00.000Z","next_check":"2026-07-24T00:00:00.000Z","problems":[{"fix":"Run 'npm install yellowgrid-api-ts' and ensure it's in package.json dependencies.","cause":"Package not installed or version mismatch","error":"Cannot find module 'yellowgrid-api-ts'"},{"fix":"Use correct import: import { AccountsApi } from 'yellowgrid-api-ts'","cause":"Using wrong import style (default vs named import)","error":"TypeError: yellowgrid_api_ts_1.AccountsApi is not a constructor"},{"fix":"Upgrade to the latest version: npm install yellowgrid-api-ts@latest","cause":"Outdated version of the package","error":"ERROR: Configuration is not exported from 'yellowgrid-api-ts'"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}