{"id":28208577,"url":"https://github.com/squarecloudofc/api-types","last_synced_at":"2025-06-12T08:31:04.305Z","repository":{"id":203401724,"uuid":"709274816","full_name":"squarecloudofc/api-types","owner":"squarecloudofc","description":"Typings for Square Cloud API","archived":false,"fork":false,"pushed_at":"2025-03-22T18:54:48.000Z","size":406,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-05-17T14:13:37.689Z","etag":null,"topics":["squarecloud","typescript"],"latest_commit_sha":null,"homepage":"https://docs.squarecloud.app/api-reference","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/squarecloudofc.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2023-10-24T11:44:45.000Z","updated_at":"2025-03-22T18:54:29.000Z","dependencies_parsed_at":null,"dependency_job_id":"aef819c3-bd9e-4268-898d-110be97f1d2a","html_url":"https://github.com/squarecloudofc/api-types","commit_stats":null,"previous_names":["squarecloudofc/api-types"],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/squarecloudofc/api-types","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/squarecloudofc%2Fapi-types","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/squarecloudofc%2Fapi-types/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/squarecloudofc%2Fapi-types/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/squarecloudofc%2Fapi-types/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/squarecloudofc","download_url":"https://codeload.github.com/squarecloudofc/api-types/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/squarecloudofc%2Fapi-types/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259429685,"owners_count":22856102,"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":["squarecloud","typescript"],"created_at":"2025-05-17T14:13:34.876Z","updated_at":"2025-06-12T08:31:04.300Z","avatar_url":"https://github.com/squarecloudofc.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Square Cloud API Types\n\nSimple type definitions for the [Square Cloud API](https://docs.squarecloud.app/api-reference/).\n\n[![GitHub](https://img.shields.io/github/license/discordjs/discord-api-types)](https://github.com/discordjs/discord-api-types/blob/main/LICENSE.md)\n[![npm](https://img.shields.io/npm/v/@squarecloud/api-types?color=crimson\u0026logo=npm)](https://www.npmjs.com/package/@squarecloud/api-types)\n\n## Installation\n\nInstall with [npm](https://www.npmjs.com/) / [yarn](https://yarnpkg.com) / [pnpm](https://pnpm.js.org/):\n\n```sh\nnpm install @squarecloud/api-types\nyarn add @squarecloud/api-types\npnpm add @squarecloud/api-types\n```\n\n## Getting Started\n\nUsing these type definitions is straightforward. You just need to specify the desired API version by appending `/v*` to the import path, where `*` represents your chosen API version. Here are some usage examples:\n\n```ts\n// Importing the API definitions for version 2\nimport { APIApplication } from '@squarecloud/api-types/v2';\n```\n\nYou can also opt to import only the specific parts of the module that you need. Your choices include `common`, `utils`, `payloads/v*`, `rest/v*`. Here are examples:\n\n```ts\n// Importing a specific REST endpoint for version 2\nimport { RESTPostAPIApplicationCommitQuery } from '@squarecloud/api-types/rest/v2';\n```\n\n\u003e _**Note:** The `v*` exports (`@squarecloud/api-types/v*`) include the relevant  version of `payloads` and `rest`, alongside the `common` and `utils` exports._\n\n## Project Structure\n\nThe exported types for each API version are organized into two main categories:\n\n- Types with an `API` prefix represent payloads you may receive from the REST API.\n- Types with a `REST` prefix represent data that is sent to and received from the REST API.\n  \nFor endpoint options in the `REST` category, they follow a specific structure: `REST\u003cHTTP Method\u003e\u003cType\u003e\u003cQuery|(JSON|FormData)Body|Result|ResultPayload\u003e`, where the type indicates the expected return data. For example, `RESTPostAPIApplicationCommitQuery` or `RESTPostAPIApplicationUploadResult`.\n\n- If a type name ends with `Result`, it represents the expected result when calling its corresponding route.\n- If a type name ends with `ResultPayload`, it represents the raw result you can expect when calling its corresponding route.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsquarecloudofc%2Fapi-types","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsquarecloudofc%2Fapi-types","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsquarecloudofc%2Fapi-types/lists"}