{"id":24452620,"url":"https://github.com/hyperonecom/h1-client-js","last_synced_at":"2025-08-20T05:04:56.034Z","repository":{"id":42679132,"uuid":"165047540","full_name":"hyperonecom/h1-client-js","owner":"hyperonecom","description":null,"archived":false,"fork":false,"pushed_at":"2022-11-10T09:56:40.000Z","size":3729,"stargazers_count":0,"open_issues_count":6,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-08-16T12:37:22.153Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/hyperonecom.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}},"created_at":"2019-01-10T11:25:07.000Z","updated_at":"2021-04-12T00:06:32.000Z","dependencies_parsed_at":"2022-08-30T20:41:16.734Z","dependency_job_id":null,"html_url":"https://github.com/hyperonecom/h1-client-js","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/hyperonecom/h1-client-js","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperonecom%2Fh1-client-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperonecom%2Fh1-client-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperonecom%2Fh1-client-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperonecom%2Fh1-client-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hyperonecom","download_url":"https://codeload.github.com/hyperonecom/h1-client-js/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperonecom%2Fh1-client-js/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271268720,"owners_count":24730023,"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-08-20T02:00:09.606Z","response_time":69,"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":[],"created_at":"2025-01-21T01:16:11.037Z","updated_at":"2025-08-20T05:04:55.942Z","avatar_url":"https://github.com/hyperonecom.png","language":"TypeScript","readme":"# @hyperone/client\n\n@hyperone/client is an automatically generated library used to interact with\n[HyperOne API](https://www.hyperone.com/tools/api/).\n\n## Installation\n\nYou are able to get this library using [npm](https://www.npmjs.com/get-npm),\nor [yarn](https://classic.yarnpkg.com/en/docs/install/).\n\n### Installation using yarn\n\n```shell\nyarn add @hyperone/client\n```\n\n### Installation using npm\n\n```shell\nnpm i @hyperone/client\n```\n\n## Usage\n\nThe recommended way to use this package is to use it along with [@hyperone/credentials](https://www.npmjs.com/package/@hyperone/credentials) library.\nTo to that install _@hyperone/credentials_ using your package manager:\n\n**yarn:**\n\n```shell\nyarn add @hyperone/credentials\n```\n\n**npm:**\n\n```shell\nnpm i @hyperone/credentials\n```\n\nThen import use it as a token provider in your code:\n\n```typescript\nimport { getPassportCredentialsHelper } from \"@hyperone/credentials\";\nimport { Credentials } from \"@hyperone/client\";\n\nconst helper = getPassportCredentialsHelper();\nconst config = new Configuration({\n  accessToken: () =\u003e helper.getToken(\"https://api.hyperone.com/v2\"), // token audience\n});\n```\n\nYou can acquire more knoweledge about [@hyperone/credentials](https://www.npmjs.com/package/@hyperone/credentials)\nlibrary on [its GitHub page](https://github.com/hyperonecom/h1-credentials-helper-ts).\n\nConfiguration object allows you to use choosen API client.\n\nExample:\n\n```typescript\nimport { getPassportCredentialsHelper } from \"@hyperone/credentials\";\nimport { Configuration, IamProjectApi } from \"@hyperone/client\";\n\nconst helper = getPassportCredentialsHelper();\nconst config = new Configuration({\n  accessToken: () =\u003e helper.getToken(\"https://api.hyperone.com/v2\"), // token audience\n});\n\nconst getProjects = async () =\u003e {\n  const projectApiClient = new IamProjectApi(config);\n  const response = await projectApiClient.iamProjectList();\n  console.log(response);\n};\n\ngetProjects();\n```\n\n### \"Prefer\" header\n\nSome operations on API may be time-consuming. In this case server\nmay return [HTTP Status 202](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202)\nwith `x-event-id` header containing request ID, and handle the operation asynchronously.\nIf you want to avoid this behavior, you can send `prefer` header [RFC7240](https://tools.ietf.org/html/rfc7240)\nwith your request, which will cause returning the operation result as response to this request.\n\nTo use this header from sdk simply add `baseOptions` object to your configuration:\n\n```typescript\nconst config = new Configuration({\n  accessToken: () =\u003e helper.getToken(\"https://api.hyperone.com/v2\"),\n  baseOptions: {\n    headers: {\n      Prefer: `respond-async,wait=${60 * 60 * 24}`,\n    },\n  },\n});\n```\n\nYou can get more information about `prefer` usage in HyperOne API\n[in its documentation](https://www.hyperone.com/tools/api/concepts/headers.html#naglowek-prefer).\n\n## Documentation\n\nFor full documentation of this library check [docs directory](docs/).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperonecom%2Fh1-client-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhyperonecom%2Fh1-client-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperonecom%2Fh1-client-js/lists"}