{"id":18384369,"url":"https://github.com/speakeasy-sdks/orb-ts","last_synced_at":"2025-04-11T23:47:33.589Z","repository":{"id":155703336,"uuid":"623422565","full_name":"speakeasy-sdks/orb-ts","owner":"speakeasy-sdks","description":"A typescript SDK for accessing the orb-ts API.","archived":false,"fork":false,"pushed_at":"2024-04-02T21:19:44.000Z","size":454,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-11T23:47:30.507Z","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/speakeasy-sdks.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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}},"created_at":"2023-04-04T10:44:16.000Z","updated_at":"2023-04-04T11:25:53.000Z","dependencies_parsed_at":"2024-04-02T21:50:55.318Z","dependency_job_id":"52e726b7-f146-4b8a-8e4d-1fb228ec79ba","html_url":"https://github.com/speakeasy-sdks/orb-ts","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-sdks%2Forb-ts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-sdks%2Forb-ts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-sdks%2Forb-ts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-sdks%2Forb-ts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/speakeasy-sdks","download_url":"https://codeload.github.com/speakeasy-sdks/orb-ts/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248497891,"owners_count":21113983,"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":"2024-11-06T01:14:21.230Z","updated_at":"2025-04-11T23:47:33.559Z","avatar_url":"https://github.com/speakeasy-sdks.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n    \u003cpicture\u003e\n        \u003csource srcset=\"https://user-images.githubusercontent.com/6267663/229776363-b219eaec-e1aa-4192-9123-d8a8e0ab997d.svg\" media=\"(prefers-color-scheme: dark)\"\u003e\n        \u003cimg src=\"https://user-images.githubusercontent.com/6267663/229776275-b670d564-fc2e-4843-b061-adf230737e3f.svg\"\u003e\n    \u003c/picture\u003e\n    \u003ch1\u003eTypescript SDK\u003c/h1\u003e\n   \u003cp\u003eThe modern pricing platform to bill for seats, consumption, and everything in between.\u003c/p\u003e\n   \u003ca href=\"https://docs.withorb.com/docs/orb-docs/overview\"\u003e\u003cimg src=\"https://img.shields.io/static/v1?label=Docs\u0026message=API Ref\u0026color=5444e4\u0026style=for-the-badge\" /\u003e\u003c/a\u003e\n   \u003ca href=\"https://github.com/speakeasy-sdks/orb-ts/actions\"\u003e\u003cimg src=\"https://img.shields.io/github/actions/workflow/status/speakeasy-sdks/orb-ts/speakeasy_sdk_generation.yml?style=for-the-badge\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://opensource.org/licenses/MIT\"\u003e\u003cimg src=\"https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/speakeasy-sdks/orb-ts/releases\"\u003e\u003cimg src=\"https://img.shields.io/github/v/release/speakeasy-sdks/orb-ts?sort=semver\u0026style=for-the-badge\" /\u003e\u003c/a\u003e\n\u003c/div\u003e\n\n\u003c!-- Start SDK Installation --\u003e\n## SDK Installation\n\n### NPM\n\n```bash\nnpm add https://github.com/speakeasy-sdks/orb-ts\n```\n\n### Yarn\n\n```bash\nyarn add https://github.com/speakeasy-sdks/orb-ts\n```\n\u003c!-- End SDK Installation --\u003e\n\n## SDK Example Usage\n\u003c!-- Start SDK Example Usage --\u003e\n```typescript\nimport {\n  PostCustomersRequestBody,\n  PostCustomersResponse,\n  PostCustomersRequestBodyPaymentProviderEnum,\n} from \"Orb/dist/sdk/models/operations\";\n\nimport { AxiosError } from \"axios\";\nimport { SDK } from \"Orb\";\nconst sdk = new SDK({\n  security: {\n    bearerAuth: \"Bearer YOUR_BEARER_TOKEN_HERE\",\n  },\n});\n\nconst req: PostCustomersRequestBody = {\n  billingAddress: {\n    city: \"Laruecester\",\n    country: \"US\",\n    line1: \"quibusdam\",\n    line2: \"unde\",\n    postalCode: \"58466-3428\",\n    state: \"ipsa\",\n  },\n  currency: \"delectus\",\n  email: \"Geraldine_Kreiger52@gmail.com\",\n  externalCustomerId: \"iusto\",\n  name: \"excepturi\",\n  paymentProvider: PostCustomersRequestBodyPaymentProviderEnum.BillCom,\n  paymentProviderId: \"recusandae\",\n  shippingAddress: {\n    city: \"Belleville\",\n    country: \"US\",\n    line1: \"quis\",\n    line2: \"veritatis\",\n    postalCode: \"03897-1889\",\n    state: \"molestiae\",\n  },\n  timezone: \"Etc/UTC\",\n};\n\nsdk.customer.create(req).then((res: PostCustomersResponse | AxiosError) =\u003e {\n   // handle response\n});\n```\n\u003c!-- End SDK Example Usage --\u003e\n\n\u003c!-- Start SDK Available Operations --\u003e\n## Available Resources and Operations\n\n\n### availability\n\n* `ping` - Check availability\n\n### credits\n\n* `create` - Add credit ledger entry\n* `getCredits` - Retrieve credit balance\n* `getCreditsLedger` - View credits ledger\n\n### customer\n\n* `create` - Create customer\n* `get` - Retrieve a customer\n* `getBalance` - Get customer balance transactions\n* `getByExternalId` - Retrieve a customer by external ID\n* `getCosts` - View customer costs\n* `getCostsByExternalId` - View customer costs by external customer ID\n* `list` - List customers\n* `update` - Update customer\n* `updateByExternalId` - Update a customer by external ID\n* `updateUsage` - Amend customer usage\n* `updateUsageByExternalId` - Amend customer usage by external ID\n\n### event\n\n* `deprecate` - Deprecate single event\n* `ingest` - Ingest events\n* `search` - Search events\n* `update` - Amend single event\n\n### invoice\n\n* `get` - Retrieve an Invoice\n* `getUpcoming` - Retrieve upcoming invoice\n* `list` - List invoices\n\n### plan\n\n* `get` - Retrieve a plan\n\n### subscription\n\n* `cancel` - Cancel subscription\n* `changeSchedule` - Schedule plan change\n* `create` - Create subscription\n* `get` - Retrieve a subscription\n* `getCost` - View subscription costs\n* `getSchedule` - View subscription schedule\n* `getUsage` - View subscription usage\n* `list` - List subscriptions\n* `unschedule` - Unschedule pending plan changes\n\u003c!-- End SDK Available Operations --\u003e\n\n### Maturity\n\nThis SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage\nto a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally\nlooking for the latest version.\n\n### Contributions\n\nWhile we value open-source contributions to this SDK, this library is generated programmatically.\nFeel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release !\n\n### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspeakeasy-sdks%2Forb-ts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspeakeasy-sdks%2Forb-ts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspeakeasy-sdks%2Forb-ts/lists"}