{"id":34216484,"url":"https://github.com/flowcommerce/node-sdk","last_synced_at":"2026-04-01T23:34:32.327Z","repository":{"id":8703821,"uuid":"59052433","full_name":"flowcommerce/node-sdk","owner":"flowcommerce","description":"node apidoc clients","archived":false,"fork":false,"pushed_at":"2026-03-05T17:50:54.000Z","size":2737,"stargazers_count":2,"open_issues_count":5,"forks_count":0,"subscribers_count":10,"default_branch":"main","last_synced_at":"2026-03-05T20:27:31.262Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/flowcommerce.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2016-05-17T19:29:04.000Z","updated_at":"2026-03-05T17:50:57.000Z","dependencies_parsed_at":"2024-06-21T20:28:46.998Z","dependency_job_id":"ff089bf9-0e88-4baf-9426-5f3d3d53ca45","html_url":"https://github.com/flowcommerce/node-sdk","commit_stats":{"total_commits":333,"total_committers":15,"mean_commits":22.2,"dds":0.6276276276276276,"last_synced_commit":"2622811ba166be6a2a4c7cc8b3b73dc6a1b08d00"},"previous_names":[],"tags_count":104,"template":false,"template_full_name":null,"purl":"pkg:github/flowcommerce/node-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flowcommerce%2Fnode-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flowcommerce%2Fnode-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flowcommerce%2Fnode-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flowcommerce%2Fnode-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flowcommerce","download_url":"https://codeload.github.com/flowcommerce/node-sdk/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flowcommerce%2Fnode-sdk/sbom","scorecard":{"id":404307,"data":{"date":"2025-08-11","repo":{"name":"github.com/flowcommerce/node-sdk","commit":"51645422bf40ccd5c2bbb5786e77b5bde49cd88d"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.9,"checks":[{"name":"Code-Review","score":1,"reason":"Found 3/18 approved changesets -- score normalized to 1","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":2,"reason":"3 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 2","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":-1,"reason":"No tokens found","details":null,"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":-1,"reason":"no workflows found","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":"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":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"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":"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":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"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":"Branch-Protection","score":6,"reason":"branch protection is not maximal on development and all release branches","details":["Info: 'allow deletion' disabled on branch 'main'","Info: 'force pushes' disabled on branch 'main'","Info: 'branch protection settings apply to administrators' is required to merge on branch 'main'","Info: 'stale review dismissal' is required to merge on branch 'main'","Warn: required approving review count is 1 on branch 'main'","Warn: codeowners review is not required on branch 'main'","Info: 'last push approval' is required to merge on branch 'main'","Warn: no status checks found to merge onto branch 'main'","Info: PRs are required in order to make changes on branch 'main'"],"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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 22 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"55 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-6chw-6frg-f759","Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx","Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-2j2x-2gpw-g8fm","Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3","Warn: Project is vulnerable to: MAL-2023-462","Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9","Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f","Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p","Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv","Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8","Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65","Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh","Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44","Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37","Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546","Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-ch52-vgq2-943f","Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj","Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9","Warn: Project is vulnerable to: GHSA-w7rc-rwvf-8q5r","Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp","Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr","Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9","Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw","Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc","Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh","Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh","Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp"],"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-18T20:49:54.743Z","repository_id":8703821,"created_at":"2025-08-18T20:49:54.744Z","updated_at":"2025-08-18T20:49:54.744Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31292970,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-01T21:15:39.731Z","status":"ssl_error","status_checked_at":"2026-04-01T21:15:34.046Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":[],"created_at":"2025-12-15T22:09:42.232Z","updated_at":"2026-04-01T23:34:32.318Z","avatar_url":"https://github.com/flowcommerce.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# node-sdk\n\nNode SDK for the Flow Commerce API.\n\n## Installation\n\n    npm install @flowio/node-sdk\n\n## Documentation / API\n\nThe official documentation can be found at [docs.flow.io](https://docs.flow.io).\nThis will cover in detail all of the resources of the api.\n\nSee [API Resources](docs/README.md) for the documentation of the Node SDK API\nand its functions.\n\n### Getting Started\n\n#### Authentication\n\nVisit [console.flow.io](https://console.flow.io) to create an account and\ngenerate an API key.\n\n#### Making an authenticated request\n\nMost requests to `api.flow.io` require _Basic Authentication_. Here is how to\nmake and authenticated request with JavaScript.\n\n```JavaScript\nimport client from '@flowio/node-sdk';\n\nconst token = process.env.FLOW_TOKEN;\nconst api = client(token);\n\napi.organizations.get().then((response) =\u003e {\n  switch(response.status) {\n    case 200:\n      response.result.map((organization) =\u003e\n        console.log(`Found Organization: ${organization.name}`))\n    case 401:\n      throw new Error('Was not authorized to get organizations!');\n    default:\n      throw new Error(`Response code[${response.status}] not handled!`);\n  }\n});\n```\n\n#### Anatomy\n\nLet's break down the example above!\n\n```JavaScript\nconst token = process.env.FLOW_IO_API_TOKEN;\nconst api = client(token);\n```\n\nYou need two things to make a request to the api. An instance of the client\nand an authorization token. We recommend _not_ storing your token in code, but\nreferencing it via an environment variable.\n\n```JavaScript\napi.organizations.get()\n```\n\nNext the syntax for the client is `client.{resource}.{method}`. You can find a\nlist of resources and their methods [here](docs/README.md). The parameters for\neach resource method can vary, so be sure to pay attention to the docs to see\nwhat is required.\n\nWhatever the parameters for a method, it always ends with an options parameter.\n`fetch` is used under the hood, so anything you add to the `options` parameter will\nbe forwarded to the underlying [node-fetch](https://github.com/bitinn/node-fetch)\nimplementation. The following are the most common options:\n\n| option  | Type   | Description |\n| :------ | :----- | :---------- |\n| params  | Object | An object of `paramName`:`paramValue` used as query parameters in the request.\n| body    | string | A JSON string representation of the body, e.g, `JSON.stringify(model_form)`.\n\n```JavaScript\n).then((response) =\u003e {\n  switch(response.status) {\n    case 200:\n      response.result.map((organization) =\u003e\n        console.log(`Found Organization: ${organization.name}`))\n    case 401:\n      throw new Error('Was not authorized to get organizations!');\n    default:\n      throw new Error(`Response code[${response.status}] not handled!`);\n  }\n});\n```\n\nEach method of the SDK returns a `Promise` of the response. The response will\ncontain two properties: `status` and `result`. `response.status` is the HTTP\nstatus code of the response. `response.result` contains the data (if any) returned by\nthe api. At Flow we feel it is critical to handle every known response from an\nAPI to prevent unexpected behavior. We also do not want to make assumptions on\nhow you may wish to handle those responses. The pattern we recommend adopting\nis to explicitly handle each response code that is documented in the API.\n\n**Common HTTP Response Codes**\n\n| Code  | Description |\n| :---- | :---------- |\n| 200\t  | HTTP response completed successfully. Common with GET, PUT |\n| 201\t  | HTTP response completed successfully and a resource was created. Common with POST |\n| 204   |\tHTTP response completed successfully and there is no content to return. Common with DELETE |\n| 404\t  | Resource not found. Common with GET, PUT, and DELETE (when specifying :id of resource) |\n| 422\t  | Validation error of some kind. Body will be a list of type error with specific details |\n\n\n#### Getting Help\n\nWe are in the process of setting up a slack channel. In the interim,\nplease feel free to open an issue on this github repository.\n\n## Development / Release\n\nSee [DEVELOPER](DEVELOPER.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflowcommerce%2Fnode-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflowcommerce%2Fnode-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflowcommerce%2Fnode-sdk/lists"}