{"id":21406607,"url":"https://github.com/ringcentral/ringcentral-extensible","last_synced_at":"2025-09-11T23:44:13.705Z","repository":{"id":42045035,"uuid":"260552864","full_name":"ringcentral/ringcentral-extensible","owner":"ringcentral","description":"RingCentral Extensible SDK","archived":false,"fork":false,"pushed_at":"2025-07-11T21:44:58.000Z","size":10192,"stargazers_count":14,"open_issues_count":4,"forks_count":7,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-08-29T17:32:34.530Z","etag":null,"topics":["events","https","notifications","rest","ringcentral","typescript","unified","websocket","wsg"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ringcentral.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-05-01T20:32:20.000Z","updated_at":"2025-07-11T21:45:02.000Z","dependencies_parsed_at":"2023-10-05T00:46:24.955Z","dependency_job_id":"4c706634-6a4c-40d4-944e-2f28b081b96b","html_url":"https://github.com/ringcentral/ringcentral-extensible","commit_stats":{"total_commits":940,"total_committers":5,"mean_commits":188.0,"dds":"0.018085106382978777","last_synced_commit":"b992e8e21a97a1d7dc1e77ae5c6ccb13591839d6"},"previous_names":["ringcentral/ringcentral-unified-ts"],"tags_count":1239,"template":false,"template_full_name":null,"purl":"pkg:github/ringcentral/ringcentral-extensible","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fringcentral-extensible","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fringcentral-extensible/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fringcentral-extensible/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fringcentral-extensible/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ringcentral","download_url":"https://codeload.github.com/ringcentral/ringcentral-extensible/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fringcentral-extensible/sbom","scorecard":{"id":776760,"data":{"date":"2025-08-11","repo":{"name":"github.com/ringcentral/ringcentral-extensible","commit":"6e585bf7ea352c5895b02f6da6b1938a76866a63"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.7,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":5,"reason":"7 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 5","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/node.js.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/node.js.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/ringcentral/ringcentral-extensible/node.js.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/node.js.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/ringcentral/ringcentral-extensible/node.js.yml/master?enable=pin","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":0,"reason":"21 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx","Warn: Project is vulnerable to: GHSA-jr5f-v2jv-69x6","Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc","Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6","Warn: Project is vulnerable to: GHSA-67mh-4wv8-2f99","Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22","Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-x574-m823-4x7w","Warn: Project is vulnerable to: GHSA-4r4m-qw57-chr8","Warn: Project is vulnerable to: GHSA-xcj6-pq6g-qj4x","Warn: Project is vulnerable to: GHSA-356w-63v5-8wf4","Warn: Project is vulnerable to: GHSA-859w-5945-r5v3"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-23T03:49:51.544Z","repository_id":42045035,"created_at":"2025-08-23T03:49:51.547Z","updated_at":"2025-08-23T03:49:51.547Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274727712,"owners_count":25338400,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-11T02:00:13.660Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["events","https","notifications","rest","ringcentral","typescript","unified","websocket","wsg"],"created_at":"2024-11-22T16:40:50.146Z","updated_at":"2025-09-11T23:44:13.626Z","avatar_url":"https://github.com/ringcentral.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RingCentral Extensible SDK\n\n[![Build Status](https://github.com/ringcentral/ringcentral-extensible/actions/workflows/node.js.yml/badge.svg)](https://github.com/ringcentral/ringcentral-extensible/actions)\n\nRingCentral Extensible is a SDK with a tiny core and lots of extensions. It is\nan endeavour to get rid of bloated SDK. You install extensions on demand.\n\n## Getting help and support\n\nIf you are having difficulty using this SDK, or working with the RingCentral\nAPI, please visit our\n[developer community forums](https://community.ringcentral.com/spaces/144/) for\nhelp and to get quick answers to your questions. If you wish to contact the\nRingCentral Developer Support team directly, please\n[submit a help ticket](https://developers.ringcentral.com/support/create-case)\nfrom our developer website.\n\n## Installation\n\n```\nyarn add @rc-ex/core\n```\n\nThen you should be able to import the SDK like this:\n\n```ts\nimport RingCentral from \"@rc-ex/core\";\n```\n\n## Usage\n\n#### [Sample code for all endpoints](./packages/core/src/samples.md)\n\nYou can also find lots of useful code snippets from [test cases](./test).\n\n## [Extensions](./packages/extensions)\n\nThis SDK supports [extensions](./packages/extensions). You can enable features\nby installing extensions.\n\nIf you want to add features to this SDK, create an extension.\n\n## Logging\n\nThe logging implementation copies\n[AWS SDK logging](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/logging-sdk-calls.html).\n\nTo enable logging:\n\n```ts\nRingCentral.config.logger = console;\n```\n\nOr you could use a third-party logger:\n\n```ts\nimport winston from \"winston\";\n\nconst logger = winston.createLogger({\n  transports: [\n    new winston.transports.Console({\n      format: winston.format.simple(),\n    }),\n  ],\n});\nRingCentral.config.logger = logger;\n```\n\nSample log entries:\n\n```\n[3/16/2022, 9:58:47 AM HTTP GET 200 OK] https://platform.devtest.ringcentral.com /restapi/v1.0/account/~/extension/~/call-log\n[3/16/2022, 5:47:53 PM HTTP POST 401 Unauthorized] https://platform.ringcentral.com /restapi/oauth/token\n```\n\n[A demo application printing logs to console](https://github.com/tylerlong/rc-logging-demo-ts).\n\n## Binary content downloading\n\nSome [sample code](./packages/core/src/samples.md) for binary content\ndownloading may not work.\n\nBecause RingCentral is gradually migrating binary content to CDN such as\n`media.ringcentral.com`.\n\nFor example, to download the attachment of a fax:\n\n```ts\n// `message` is the fax message object\nconst r = await rc.get(message.attachments[0].uri, undefined, {\n  responseType: \"arraybuffer\",\n});\nconst content = r.data;\n```\n\nThe following does **NOT** work:\n\n```ts\n// `message` is the fax message object\nconst content = await rc\n  .restapi()\n  .account()\n  .extension()\n  .messageStore(message.id)\n  .content(message.attachments[0].id)\n  .get();\n```\n\n### Rule of thumb\n\nBut not all binary content has been migrated to CDN. If the resource to download\nprovides you with a CDN uri, use that CDN uri. If there is no CDN uri provided,\nconstruct the uri as [sample code](./packages/core/src/samples.md) shows.\n\n## For maintainers\n\n### Regenerate code using latest swagger spec\n\nPlease refer to the\n[RingCentral Code Generator](https://github.com/tylerlong/ringcentral-code-generator-typescript)\nproject.\n\n### Test\n\n```\nyarn reset \u0026\u0026 yarn compile \u0026\u0026 yarn test\n```\n\n### Test one test case\n\n```\nt=auto-recover yarn test\n```\n\n## Publish\n\nUpdate version number in `packages/core/src/Rest.ts`\n\n```\nyarn compile\nyarn lerna publish from-package\n```\n\nBy default lerna check git tag to determine which packages to publish.\n`from-package` will make lerna check npmjs.com instead.\n\nAs I just tried, it works without `from-package` option.\n\n### NPM 2FA\n\nI don't know how to make it work with lerna and I have to disable it via\nnpmjs.com GUI: I disabled \"Require two-factor authentication for write actions\".\n\n## Add dependency\n\n```\nyarn workspace @rc-ex/debug add ramda\n```\n\n### Todo\n\n- Extension to refresh token\n- Extension to do pagination\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fringcentral%2Fringcentral-extensible","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fringcentral%2Fringcentral-extensible","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fringcentral%2Fringcentral-extensible/lists"}