{"id":24960418,"url":"https://github.com/upryzing/api-typescript","last_synced_at":"2025-03-28T21:24:36.394Z","repository":{"id":255857528,"uuid":"853755918","full_name":"upryzing/api-typescript","owner":"upryzing","description":"TypeScript typings for Upryzing's API","archived":false,"fork":false,"pushed_at":"2024-12-17T03:16:22.000Z","size":578,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-28T13:21:25.750Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/upryzing.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}},"created_at":"2024-09-07T12:57:25.000Z","updated_at":"2024-12-17T03:16:25.000Z","dependencies_parsed_at":null,"dependency_job_id":"32b2d0f3-e49e-4dae-8be3-d2f93b7b09c0","html_url":"https://github.com/upryzing/api-typescript","commit_stats":null,"previous_names":["upryzing/api-typescript","upryzing/api-types"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/upryzing%2Fapi-typescript","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/upryzing%2Fapi-typescript/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/upryzing%2Fapi-typescript/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/upryzing%2Fapi-typescript/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/upryzing","download_url":"https://codeload.github.com/upryzing/api-typescript/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246101983,"owners_count":20723739,"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","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-02-03T08:08:02.264Z","updated_at":"2025-03-28T21:24:36.374Z","avatar_url":"https://github.com/upryzing.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @upryzing/api\n\n![@upryzing/api](https://img.shields.io/npm/v/@upryzing/api)\n\nThis package contains typings for objects in the Upryzing API\u003c!-- ToDO: set up dev docs --\u003e and a fully typed API request builder.\n\n### Example Usage\n\nIf you just need access to types:\n\n```typescript\nimport type { User } from '@upryzing/api';\n```\n\nIf you want to send requests:\n\n```typescript\nimport { API } from '@upryzing/api';\n\n// Initialise a new API client:\nconst client = new API();\n\n// or with authentication:\nconst client = new API({ authentication: { revolt: 'bot-token' } });\n\n// Make requests with ease:\nclient.get('/users/@me')\n    // Fully typed responses!\n    .then(user =\u003e user.username);\n\n// No need to worry about the details:\nlet channel_id = \"some channel id\";\nclient.post(`/channels/${channel_id}/messages`, {\n    // Parameters given are fully typed as well!\n    content: \"some content\"\n});\n```\n\nFor more details on how this works, see the [README of @insertish/oapi](https://github.com/insertish/oapi#example).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fupryzing%2Fapi-typescript","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fupryzing%2Fapi-typescript","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fupryzing%2Fapi-typescript/lists"}