{"id":41654,"library":"oci-cims","title":"OCI NodeJS Client for Cims (Support Management) Service","description":"Oracle Cloud Infrastructure SDK for Node.js to manage Customer Incident Management Service (CIMS) resources like support tickets, incidents, and classifications. Version 2.132.0 is stable with monthly releases alongside the OCI TypeScript SDK monorepo. Supports ESM and CJS, ships TypeScript definitions. Unlike generic HTTP clients, this provides typed methods for OCI API operations, handles signing with API keys, and integrates with OCI IAM policies. Requires an OCI account and configured credentials.","status":"active","version":"2.132.0","language":"javascript","source_language":"en","source_url":"https://github.com/oracle/oci-typescript-sdk","tags":["javascript","typescript"],"install":[{"cmd":"npm install oci-cims","lang":"bash","label":"npm"},{"cmd":"yarn add oci-cims","lang":"bash","label":"yarn"},{"cmd":"pnpm add oci-cims","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Required for authentication, signing requests, and common client infrastructure","package":"oci-common","optional":false}],"imports":[{"note":"ESM import preferred; CommonJS works as well.","wrong":"const CimsClient = require('oci-cims').CimsClient","symbol":"CimsClient","correct":"import { CimsClient } from 'oci-cims'"},{"note":"models is a namespace export from 'oci-cims/lib/models'","wrong":"import { models } from 'oci-cims'","symbol":"models","correct":"import * as models from 'oci-cims/lib/models'"},{"note":"requests is a namespace export from 'oci-cims/lib/requests'","wrong":"import { requests } from 'oci-cims'","symbol":"requests","correct":"import * as requests from 'oci-cims/lib/requests'"}],"quickstart":{"code":"import { CimsClient, models, requests } from 'oci-cims';\nimport common from 'oci-common';\n\nconst provider = new common.ConfigFileAuthenticationDetailsProvider();\nconst client = new CimsClient({ authenticationDetailsProvider: provider });\n\nasync function listIncidents() {\n  const request: requests.ListIncidentsRequest = {\n    compartmentId: 'ocid1.compartment.oc1..example',\n    limit: 10,\n  };\n  const response = await client.listIncidents(request);\n  console.log(response.items);\n}\n\nlistIncidents();","lang":"typescript","description":"Initializes CIMS client with config file auth and lists up to 10 incidents in a compartment."},"warnings":[{"fix":"Use deep imports: import * as models from 'oci-cims/lib/models'","message":"The 'models' and 'requests' modules are not exportable from the package root; they are subpath exports. CommonJS require('oci-cims/lib/models') works, but tree-shaking may fail.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Use listIncidentResourceTypes and getIncidentByKey methods.","message":"Version 2.x removed deprecated methods 'listIncidentTypes' and 'getIncident' without replacement. Use 'listIncidentResourceTypes' and 'getIncidentByKey' instead.","severity":"breaking","affected_versions":">=2.0.0"},{"fix":"Replace all references to IncidentResourceType with IncidentType.","message":"The 'IncidentResourceType' model has been renamed to 'IncidentType' in version 2.5.0.","severity":"deprecated","affected_versions":">=2.5.0"},{"fix":"Always include compartmentId in list requests.","message":"The client requires a compartmentId in all list requests; failing to provide one results in a 400 error.","severity":"gotcha","affected_versions":">=1.0.0"}],"env_vars":null,"search_vec":"'2.132.0':30 'account':75 'alongsid':36 'api':59,64 'cim':5,21 'cjs':45 'classif':28 'client':3,52 'cloud':10 'configur':77 'credenti':78 'custom':17 'definit':48 'esm':43 'generic':50 'handl':61 'http':51 'iam':70 'incid':18,26 'infrastructur':11 'integr':67 'javascript':79 'key':65 'like':23 'manag':7,16,19 'method':56 'monorepo':41 'month':34 'node.js':14 'nodej':2 'oci':1,38,58,69,74 'oper':60 'oracl':9 'polici':71 'provid':54 'releas':35 'requir':72 'resourc':22 'sdk':12,40 'servic':8,20 'ship':46 'sign':62 'stabl':32 'support':6,24,42 'ticket':25 'type':55 'typescript':39,47,80 'unlik':49 'version':29","created_at":"2026-06-04T18:53:27.804674+00:00","updated_at":"2026-06-04T18:53:27.804674+00:00","problems":[{"fix":"Check network connectivity and proxy settings. Set HTTP_PROXY environment variable if behind a proxy.","cause":"OCI SDK cannot resolve the endpoint hostname, often due to proxy or DNS issues.","error":"Error: getaddrinfo ENOTFOUND incidents.us-phoenix-1.oraclecloud.com"},{"fix":"Verify that the request parameters are correct and that the client is properly authenticated. Use try-catch to handle errors.","cause":"The response object may not have 'items' if the call returns an error, or if the method signature is incorrect.","error":"TypeError: Cannot read property 'items' of undefined"},{"fix":"Ensure the compartmentId starts with 'ocid1.compartment.oc1..' and is valid for your tenancy.","cause":"The compartmentId OCID is malformed or belongs to a different tenancy.","error":"Error: Invalid compartmentId provided"}],"ecosystem":"npm","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":null,"cli_name":null,"cli_version":null,"type":"library","homepage":"https://github.com/oracle/oci-typescript-sdk#readme","github":"https://github.com/oracle/oci-typescript-sdk","docs":null,"changelog":null,"pypi":null,"npm":"oci-cims","openapi_spec":null,"status_page":null,"smithery":null,"categories":["crm"],"base_url":null,"auth_type":null,"provenance":{"verified_status":null,"verified_at":null,"last_verified":"2026-06-04","next_check":"2026-09-02","install_tag":null}}