oci-cims

library2.132.0jsnpmunverified

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.

crm

npm install oci-cims

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · OCI-CIMS

oci-cims

crmjavascriptv2.132.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

CimsClient

✓ import { CimsClient } from 'oci-cims'

✗ const CimsClient = require('oci-cims').CimsClient

ESM import preferred; CommonJS works as well.

models

✓ import * as models from 'oci-cims/lib/models'

✗ import { models } from 'oci-cims'

models is a namespace export from 'oci-cims/lib/models'

requests

✓ import * as requests from 'oci-cims/lib/requests'

✗ import { requests } from 'oci-cims'

requests is a namespace export from 'oci-cims/lib/requests'

Initializes CIMS client with config file auth and lists up to 10 incidents in a compartment.

import { CimsClient, models, requests } from 'oci-cims'; import common from 'oci-common'; const provider = new common.ConfigFileAuthenticationDetailsProvider(); const client = new CimsClient({ authenticationDetailsProvider: provider }); async function listIncidents() { const request: requests.ListIncidentsRequest = { compartmentId: 'ocid1.compartment.oc1..example', limit: 10, }; const response = await client.listIncidents(request); console.log(response.items); } listIncidents();

Debug

Known issues

gotchaThe '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.

fix

Use deep imports: import * as models from 'oci-cims/lib/models'

affects: >=1.0.0

breakingVersion 2.x removed deprecated methods 'listIncidentTypes' and 'getIncident' without replacement. Use 'listIncidentResourceTypes' and 'getIncidentByKey' instead.

fix

Use listIncidentResourceTypes and getIncidentByKey methods.

affects: >=2.0.0

deprecatedThe 'IncidentResourceType' model has been renamed to 'IncidentType' in version 2.5.0.

fix

Replace all references to IncidentResourceType with IncidentType.

affects: >=2.5.0

gotchaThe client requires a compartmentId in all list requests; failing to provide one results in a 400 error.

fix

Always include compartmentId in list requests.

affects: >=1.0.0

Errors

Common errors & fixes

Error: getaddrinfo ENOTFOUND incidents.us-phoenix-1.oraclecloud.com

OCI SDK cannot resolve the endpoint hostname, often due to proxy or DNS issues.

fix

Check network connectivity and proxy settings. Set HTTP_PROXY environment variable if behind a proxy.

TypeError: Cannot read property 'items' of undefined

The response object may not have 'items' if the call returns an error, or if the method signature is incorrect.

fix

Verify that the request parameters are correct and that the client is properly authenticated. Use try-catch to handle errors.

Error: Invalid compartmentId provided

The compartmentId OCID is malformed or belongs to a different tenancy.

fix

Ensure the compartmentId starts with 'ocid1.compartment.oc1..' and is valid for your tenancy.

Upgrade

Version history

2.132.0latest on npm

Audit

Dependencies

oci-commonrequiredRequired for authentication, signing requests, and common client infrastructure

Agent activity

29 hits · last 30 days

node

Amazon

OpenAI (training)

Resources

githubhttps://github.com/oracle/oci-typescript-sdk ↗

packageoci-cims ↗

homepagehttps://github.com/oracle/oci-typescript-sdk#readme ↗