orb-billing 1.20.2 → 1.22.0

package/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+## 1.22.0 (2023-10-23)
+
+Full Changelog: [v1.21.0...v1.22.0](https://github.com/orbcorp/orb-node/compare/v1.21.0...v1.22.0)
+
+### Features
+
+* **init:** initial commit ([c0c9395](https://github.com/orbcorp/orb-node/commit/c0c93952f0c3e5fabd96c50f2c7ece64ea84a8b7))
+
+
+### Chores
+
+* correct version ([ee0d2f2](https://github.com/orbcorp/orb-node/commit/ee0d2f2a2980c6e8a2f1c34a80062c96efd081da))
+
+
+### Documentation
+
+* improve code examples ([441bf4f](https://github.com/orbcorp/orb-node/commit/441bf4f10f3be6b87a183f6e478687ef62553530))

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023 Orb
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,232 +1,244 @@
-# orb-billing
+# Orb TypeScript API Library
 
-<!-- Start SDK Installation -->
-## SDK Installation
+[![NPM version](https://img.shields.io/npm/v/orb-billing.svg)](https://npmjs.org/package/orb-billing)
 
-### NPM
+This library provides convenient access to the Orb REST API from server-side TypeScript or JavaScript.
 
-```bash
-npm add orb-billing
-```
+The API documentation can be found [here](https://www.withorb.com/https://docs.withorb.com/reference/api-reference).
 
-### Yarn
+## Installation
 
-```bash
+```sh
+npm install --save orb-billing
+# or
 yarn add orb-billing
 ```
-<!-- End SDK Installation -->
 
-## SDK Example Usage
-<!-- Start SDK Example Usage -->
-```typescript
-import { Orb } from "orb-billing";
+## Usage
 
-(async() => {
-  const sdk = new Orb({
-    security: {
-      apiKey: "",
-    },
-  });
+The full API of this library can be found in [api.md](https://www.github.com/orbcorp/orb-node/blob/main/api.md).
 
-  const res = await sdk.availability.ping();
+```js
+import Orb from 'orb-billing';
 
-  if (res.statusCode == 200) {
-    // handle response
-  }
-})();
-```
-<!-- End SDK Example Usage -->
+const orb = new Orb({
+  apiKey: 'My API Key', // defaults to process.env["ORB_API_KEY"]
+});
+
+async function main() {
+  const customer = await orb.customers.create({ email: 'example-customer@withorb.com', name: 'My Customer' });
+
+  console.log(customer);
+}
 
-<!-- Start Pagination -->
-# Pagination
+main();
+```
 
-Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the
-returned response object will have a `next` method that can be called to pull down the next group of results. If the
-return value of `next` is `null`, then there are no more pages to be fetched.
+### Request & Response types
 
-Here's an example of one such pagination call:
-<!-- End Pagination -->
+This library includes TypeScript definitions for all request params and response fields. You may import and use them like so:
 
 ```ts
-/* eslint-disable prefer-const */
-import { Orb } from "orb-billing";
-
-// Initialize the SDK with an API key.
-const sdk = new Orb({
-  security: {
-    apiKeyAuth: "",
-  },
+import Orb from 'orb-billing';
+
+const orb = new Orb({
+  apiKey: 'My API Key', // defaults to process.env["ORB_API_KEY"]
 });
 
-async function paginationDemo() {
-  let cursor: string | undefined;
-
-  // We start by attempting to fetch at least one page of results.
-  do {
-    // The SDK call takes the cursor and any additional arguments to filter the
-    // coupon data.
-    const response = await sdk.coupon.list({ cursor, showArchived: false });
-    const { statusCode } = response;
-    if (statusCode !== 200) {
-      throw new Error(`Unexpected status code sent from server: ${statusCode}`);
-    }
-
-    // We capture the cursor for the next iteration but we also check if we
-    // received an empty page of results as a signal to stop making additional
-    // requests.
-    cursor = response.coupons?.paginationMetadata.nextCursor;
-    const page = response.coupons?.data;
-    if (!page?.length) {
-      break;
-    }
-
-    // At this point we have a page of coupon entries that we can collect or
-    // iterate through as shown below.
-    page.forEach((coupon) => {
-      const { redemptionCode: code, timesRedeemed } = coupon;
-      console.log(`Coupon ${code} was redeemed ${timesRedeemed} times.`);
-    });
+async function main() {
+  const params: Orb.CustomerCreateParams = { email: 'example-customer@withorb.com', name: 'My Customer' };
+  const customer: Orb.Customer = await orb.customers.create(params);
+}
+
+main();
+```
+
+Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
+
+## Handling errors
 
-    // The loop will continue if we received a cursor for additional results.
-  } while (cursor);
+When the library is unable to connect to the API,
+or if the API returns a non-success status code (i.e., 4xx or 5xx response),
+a subclass of `APIError` will be thrown:
+
+```ts
+async function main() {
+  const customer = await orb.customers
+    .create({ email: 'example-customer@withorb.com', name: 'My Customer' })
+    .catch((err) => {
+      if (err instanceof Orb.APIError) {
+        console.log(err.status); // 400
+        console.log(err.name); // BadRequestError
+
+        console.log(err.headers); // {server: 'nginx', ...}
+      } else {
+        throw err;
+      }
+    });
 }
 
-// Run the demo function.
-paginationDemo();
+main();
 ```
 
-<!-- Start SDK Available Operations -->
-## Available Resources and Operations
+Error codes are as followed:
 
+| Status Code | Error Type                 |
+| ----------- | -------------------------- |
+| 400         | `BadRequestError`          |
+| 401         | `AuthenticationError`      |
+| 403         | `PermissionDeniedError`    |
+| 404         | `NotFoundError`            |
+| 422         | `UnprocessableEntityError` |
+| 429         | `RateLimitError`           |
+| >=500       | `InternalServerError`      |
+| N/A         | `APIConnectionError`       |
 
-### [availability](docs/sdks/availability/README.md)
+### Retries
 
-* [ping](docs/sdks/availability/README.md#ping) - Check availability
+Certain errors will be automatically retried 2 times by default, with a short exponential backoff.
+Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,
+429 Rate Limit, and >=500 Internal errors will all be retried by default.
 
-### [coupon](docs/sdks/coupon/README.md)
+You can use the `maxRetries` option to configure or disable this:
 
-* [archive](docs/sdks/coupon/README.md#archive) - Archive coupon
-* [create](docs/sdks/coupon/README.md#create) - Create coupon
-* [fetch](docs/sdks/coupon/README.md#fetch) - Fetch coupon
-* [list](docs/sdks/coupon/README.md#list) - List coupons
-* [listSubscriptions](docs/sdks/coupon/README.md#listsubscriptions) - List coupon subscriptions
-
-### [credit](docs/sdks/credit/README.md)
+<!-- prettier-ignore -->
+```js
+// Configure the default for all requests:
+const orb = new Orb({
+  maxRetries: 0, // default is 2
+});
 
-* [addByExternalId](docs/sdks/credit/README.md#addbyexternalid) - Create ledger entry by external ID
-* [create](docs/sdks/credit/README.md#create) - Create ledger entry
-* [fetchBalance](docs/sdks/credit/README.md#fetchbalance) - Fetch customer credit balance
-* [fetchBalanceByExternalId](docs/sdks/credit/README.md#fetchbalancebyexternalid) - Fetch customer credit balance by external customer id
-* [fetchLedger](docs/sdks/credit/README.md#fetchledger) - Fetch customer credits ledger
-* [fetchLedgerByExternalId](docs/sdks/credit/README.md#fetchledgerbyexternalid) - Fetch customer credits ledger by external ID
+// Or, configure per-request:
+await orb.customers.create({ email: 'example-customer@withorb.com', name: 'My Customer' }, {
+  maxRetries: 5,
+});
+```
 
-### [creditNote](docs/sdks/creditnote/README.md)
+### Timeouts
 
-* [fetch](docs/sdks/creditnote/README.md#fetch) - Fetch credit note
-* [list](docs/sdks/creditnote/README.md#list) - List credit notes
+Requests time out after 1 minute by default. You can configure this with a `timeout` option:
 
-### [customer](docs/sdks/customer/README.md)
+<!-- prettier-ignore -->
+```ts
+// Configure the default for all requests:
+const orb = new Orb({
+  timeout: 20 * 1000, // 20 seconds (default is 1 minute)
+});
 
-* [amend](docs/sdks/customer/README.md#amend) - Amend usage
-* [amendByExternalId](docs/sdks/customer/README.md#amendbyexternalid) - Amend usage by external ID
-* [create](docs/sdks/customer/README.md#create) - Create customer
-* [createBalanceTransaction](docs/sdks/customer/README.md#createbalancetransaction) - Create customer balance transaction
-* [delete](docs/sdks/customer/README.md#delete) - Delete customer
-* [fetch](docs/sdks/customer/README.md#fetch) - Fetch customer
-* [fetchByExternalId](docs/sdks/customer/README.md#fetchbyexternalid) - Fetch customer by external ID
-* [fetchCosts](docs/sdks/customer/README.md#fetchcosts) - Fetch customer costs
-* [fetchCostsByExternalId](docs/sdks/customer/README.md#fetchcostsbyexternalid) - Fetch customer costs by external ID
-* [list](docs/sdks/customer/README.md#list) - List customers
-* [listBalanceTransactions](docs/sdks/customer/README.md#listbalancetransactions) - List balance transactions
-* [updateByExternalId](docs/sdks/customer/README.md#updatebyexternalid) - Update customer by external ID
-* [updateCustomer](docs/sdks/customer/README.md#updatecustomer) - Update customer
+// Override per-request:
+await orb.customers.create({ email: 'example-customer@withorb.com', name: 'My Customer' }, {
+  timeout: 5 * 1000,
+});
+```
+
+On timeout, an `APIConnectionTimeoutError` is thrown.
+
+Note that requests which time out will be [retried twice by default](#retries).
 
-### [event](docs/sdks/event/README.md)
+## Auto-pagination
 
-* [amend](docs/sdks/event/README.md#amend) - Amend event
-* [closeBackfill](docs/sdks/event/README.md#closebackfill) - Close backfill
-* [create](docs/sdks/event/README.md#create) - Create backfill
-* [deprecateEvent](docs/sdks/event/README.md#deprecateevent) - Deprecate event
-* [fetch](docs/sdks/event/README.md#fetch) - Fetch backfill
-* [ingest](docs/sdks/event/README.md#ingest) - Ingest events
-* [listBackfills](docs/sdks/event/README.md#listbackfills) - List backfills
-* [revertBackfill](docs/sdks/event/README.md#revertbackfill) - Revert backfill
-* [search](docs/sdks/event/README.md#search) - Search events
+List methods in the Orb API are paginated.
+You can use `for await … of` syntax to iterate through items across all pages:
+
+```ts
+async function fetchAllCoupons(params) {
+  const allCoupons = [];
+  // Automatically fetches more pages as needed.
+  for await (const coupon of orb.coupons.list()) {
+    allCoupons.push(coupon);
+  }
+  return allCoupons;
+}
+```
 
-### [invoice](docs/sdks/invoice/README.md)
+Alternatively, you can make request a single page at a time:
 
-* [create](docs/sdks/invoice/README.md#create) - Create a one-off invoice
-* [createLineItem](docs/sdks/invoice/README.md#createlineitem) - Create invoice line item
-* [fetch](docs/sdks/invoice/README.md#fetch) - Fetch invoice
-* [fetchUpcoming](docs/sdks/invoice/README.md#fetchupcoming) - Fetch upcoming invoice
-* [issue](docs/sdks/invoice/README.md#issue) - Issue invoice
-* [list](docs/sdks/invoice/README.md#list) - List invoices
-* [markInvoiceAsPaid](docs/sdks/invoice/README.md#markinvoiceaspaid) - Mark invoice as paid
-* [void](docs/sdks/invoice/README.md#void) - Void invoice
+```ts
+let page = await orb.coupons.list();
+for (const coupon of page.data) {
+  console.log(coupon);
+}
 
-### [item](docs/sdks/item/README.md)
+// Convenience methods are provided for manually paginating:
+while (page.hasNextPage()) {
+  page = page.getNextPage();
+  // ...
+}
+```
 
-* [fetch](docs/sdks/item/README.md#fetch) - Fetch item
-* [list](docs/sdks/item/README.md#list) - List items
+## Advanced Usage
 
-### [metric](docs/sdks/metric/README.md)
+### Accessing raw Response data (e.g., headers)
 
-* [create](docs/sdks/metric/README.md#create) - Create metric
-* [fetch](docs/sdks/metric/README.md#fetch) - Get metric
-* [list](docs/sdks/metric/README.md#list) - List metrics
+The "raw" `Response` returned by `fetch()` can be accessed through the `.asResponse()` method on the `APIPromise` type that all methods return.
 
-### [plan](docs/sdks/plan/README.md)
+You can also use the `.withResponse()` method to get the raw `Response` along with the parsed data.
 
-* [create](docs/sdks/plan/README.md#create) - Create plan
-* [fetch](docs/sdks/plan/README.md#fetch) - Fetch plan
-* [fetchByExternalId](docs/sdks/plan/README.md#fetchbyexternalid) - Fetch plan by external ID
-* [list](docs/sdks/plan/README.md#list) - List plans
-* [updatePlan](docs/sdks/plan/README.md#updateplan) - Update plan by id
-* [updatePlanExternal](docs/sdks/plan/README.md#updateplanexternal) - Update plan by external ID
+```ts
+const orb = new Orb();
+
+const response = await orb.customers
+  .create({ email: 'example-customer@withorb.com', name: 'My Customer' })
+  .asResponse();
+console.log(response.headers.get('X-My-Header'));
+console.log(response.statusText); // access the underlying Response object
+
+const { data: customer, response: raw } = await orb.customers
+  .create({ email: 'example-customer@withorb.com', name: 'My Customer' })
+  .withResponse();
+console.log(raw.headers.get('X-My-Header'));
+console.log(customer.id);
+```
+
+## Configuring an HTTP(S) Agent (e.g., for proxies)
+
+By default, this library uses a stable agent for all http/https requests to reuse TCP connections, eliminating many TCP & TLS handshakes and shaving around 100ms off most requests.
+
+If you would like to disable or customize this behavior, for example to use the API behind a proxy, you can pass an `httpAgent` which is used for all requests (be they http or https), for example:
+
+<!-- prettier-ignore -->
+```ts
+import http from 'http';
+import HttpsProxyAgent from 'https-proxy-agent';
+
+// Configure the default for all requests:
+const orb = new Orb({
+  httpAgent: new HttpsProxyAgent(process.env.PROXY_URL),
+});
+
+// Override per-request:
+await orb.customers.create({ email: 'example-customer@withorb.com', name: 'My Customer' }, {
+  baseURL: 'http://localhost:8080/test-api',
+  httpAgent: new http.Agent({ keepAlive: false }),
+})
+```
 
-### [price](docs/sdks/price/README.md)
+## Semantic Versioning
 
-* [create](docs/sdks/price/README.md#create) - Create price
-* [fetch](docs/sdks/price/README.md#fetch) - Fetch price
-* [fetchByExternalId](docs/sdks/price/README.md#fetchbyexternalid) - Fetch price by external price id
-* [list](docs/sdks/price/README.md#list) - List prices
+This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
 
-### [priceInterval](docs/sdks/priceinterval/README.md)
+1. Changes that only affect static types, without breaking runtime behavior.
+2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals)_.
+3. Changes that we do not expect to impact the vast majority of users in practice.
 
-* [addEditPriceIntervals](docs/sdks/priceinterval/README.md#addeditpriceintervals) - Add or edit price intervals
+We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
 
-### [subscription](docs/sdks/subscription/README.md)
+We are keen for your feedback; please open an [issue](https://www.github.com/orbcorp/orb-node/issues) with questions, bugs, or suggestions.
 
-* [cancel](docs/sdks/subscription/README.md#cancel) - Cancel subscription
-* [create](docs/sdks/subscription/README.md#create) - Create subscription
-* [fetch](docs/sdks/subscription/README.md#fetch) - Fetch subscription
-* [fetchCosts](docs/sdks/subscription/README.md#fetchcosts) - Fetch subscription costs
-* [fetchSchedule](docs/sdks/subscription/README.md#fetchschedule) - Fetch subscription schedule
-* [fetchUsage](docs/sdks/subscription/README.md#fetchusage) - Fetch subscription usage
-* [list](docs/sdks/subscription/README.md#list) - List subscriptions
-* [schedulePlanChange](docs/sdks/subscription/README.md#scheduleplanchange) - Schedule plan change
-* [triggerPhase](docs/sdks/subscription/README.md#triggerphase) - Trigger phase
-* [unscheduleCancellation](docs/sdks/subscription/README.md#unschedulecancellation) - Unschedule subscription cancellation
-* [unscheduleFixedFeeQuantity](docs/sdks/subscription/README.md#unschedulefixedfeequantity) - Unschedule fixed fee quantity updates
-* [unschedulePlanChange](docs/sdks/subscription/README.md#unscheduleplanchange) - Unschedule plan change
-* [updateFixedFeeQuantity](docs/sdks/subscription/README.md#updatefixedfeequantity) - Update price quantity
-<!-- End SDK Available Operations -->
+## Requirements
 
-<!-- Start Dev Containers -->
-
-<!-- End Dev Containers -->
+TypeScript >= 4.5 is supported.
 
-<!-- Placeholder for Future Speakeasy SDK Sections -->
+The following runtimes are supported:
 
-### Maturity
+- Node.js 18 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.
+- Deno v1.28.0 or higher, using `import Orb from "npm:orb-billing"`.
+- Bun 1.0 or later.
+- Cloudflare Workers.
+- Vercel Edge Runtime.
+- Jest 28 or greater with the `"node"` environment (`"jsdom"` is not supported at this time).
+- Nitro v2.6 or greater.
 
-This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
-to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
-looking for the latest version.
+Note that React Native is not supported at this time.
 
-### Contributions
-
-While we value open-source contributions to this SDK, this library is generated programmatically.
-Feel 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!
-
-### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
+If you are interested in other runtime environments, please open or upvote an issue on GitHub.

package/_shims/MultipartBody.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+export declare class MultipartBody {
+    body: any;
+    constructor(body: any);
+    get [Symbol.toStringTag](): string;
+}
+//# sourceMappingURL=MultipartBody.d.ts.map