Merge pull request #218 from orbcorp/release-please--branches--main--changes--next--components--orb-billing

release: 3.0.0

Author: sskhandek

.github/workflows/ci.yml

@@ -6,6 +6,7 @@ on:
   pull_request:
     branches:
       - main
+      - next
 
 jobs:
   lint:

.github/workflows/release-doctor.yml

@@ -1,6 +1,8 @@
 name: Release Doctor
 on:
   pull_request:
+    branches:
+      - main
   workflow_dispatch:
 
 jobs:

.gitignore

@@ -1,3 +1,4 @@
+.prism.log
 node_modules
 yarn-error.log
 codegen.log

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "2.11.2"
+  ".": "3.0.0"
 }

.stats.yml

@@ -1,2 +1,2 @@
-configured_endpoints: 90
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb-a6a1b7ffd49d131bfc4a1e8e508ac1fe23875c64b27c99f97dd4df06ea5e3ff5.yml
+configured_endpoints: 93
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb-36672419987ce3762474f5fe41ded634068ca8780d7e2a835943ff294a88d031.yml

CHANGELOG.md

@@ -1,5 +1,49 @@
 # Changelog
 
+## 3.0.0 (2024-07-18)
+
+Full Changelog: [v2.11.2...v3.0.0](https://github.com/orbcorp/orb-node/compare/v2.11.2...v3.0.0)
+
+### ⚠ BREAKING CHANGES
+
+* **api:** endpoint expects amount of new allocation price to be a string, not a number ([#226](https://github.com/orbcorp/orb-node/issues/226))
+* **api:** add semi_annual cadence and remove metadata from update items ([#217](https://github.com/orbcorp/orb-node/issues/217))
+
+### Features
+
+* **api:** add 'status' to plan creation params ([#230](https://github.com/orbcorp/orb-node/issues/230)) ([0d738b9](https://github.com/orbcorp/orb-node/commit/0d738b9fb973d56e081901264253886718fdc270))
+* **api:** add methods to prices and invoices ([#235](https://github.com/orbcorp/orb-node/issues/235)) ([1c50e27](https://github.com/orbcorp/orb-node/commit/1c50e27f94d60647bdf99bbd2eef9c7cd0539190))
+* **api:** add semi_annual cadence and remove metadata from update items ([#217](https://github.com/orbcorp/orb-node/issues/217)) ([c1134f1](https://github.com/orbcorp/orb-node/commit/c1134f19e4d29b422fa601874b62a5894959f9a5))
+* **api:** add support for adding allocation price to subscription ([#223](https://github.com/orbcorp/orb-node/issues/223)) ([2b73c46](https://github.com/orbcorp/orb-node/commit/2b73c469e6b19ea95ff5c7ced1f6c556eaec6f25))
+* **api:** add support for query param include_all_blocks ([#227](https://github.com/orbcorp/orb-node/issues/227)) ([cbf7f33](https://github.com/orbcorp/orb-node/commit/cbf7f33382499d8d5196c74ac95f5e032fb4a258))
+* **api:** external connections made optional when updating items ([#224](https://github.com/orbcorp/orb-node/issues/224)) ([1fada3b](https://github.com/orbcorp/orb-node/commit/1fada3b670af7bfd426678b111511f8202047ad3))
+* **api:** updates ([#221](https://github.com/orbcorp/orb-node/issues/221)) ([69af019](https://github.com/orbcorp/orb-node/commit/69af019189172ffd10d418b9aead6b6ca6b1f326))
+* support `application/octet-stream` request bodies ([#219](https://github.com/orbcorp/orb-node/issues/219)) ([d4dbb98](https://github.com/orbcorp/orb-node/commit/d4dbb9885cbd6c5f123234827fb8772c234e3bdd))
+
+
+### Bug Fixes
+
+* **api:** endpoint expects amount of new allocation price to be a string, not a number ([#226](https://github.com/orbcorp/orb-node/issues/226)) ([2595cad](https://github.com/orbcorp/orb-node/commit/2595cadb368f042cfdc16720f30afd520046a92d))
+* **api:** escape browser check string ([#220](https://github.com/orbcorp/orb-node/issues/220)) ([ce68fda](https://github.com/orbcorp/orb-node/commit/ce68fdacc0b32cffac21c045f62a8bfdfe827d93))
+
+
+### Chores
+
+* **ci:** also run workflows for PRs targeting `next` ([#231](https://github.com/orbcorp/orb-node/issues/231)) ([bf5cbd5](https://github.com/orbcorp/orb-node/commit/bf5cbd59fb5e93200d024395fecc423287e9f3a5))
+* **ci:** limit release doctor target branches ([#237](https://github.com/orbcorp/orb-node/issues/237)) ([91cd764](https://github.com/orbcorp/orb-node/commit/91cd7642cbb8beaa0b3ffb04f4a0f0dd491a6fa4))
+* **docs:** improve Coupon description ([#222](https://github.com/orbcorp/orb-node/issues/222)) ([df63181](https://github.com/orbcorp/orb-node/commit/df631819cd356a83fe2b64879480eed963707edf))
+* **docs:** mention support of web browser runtimes ([#234](https://github.com/orbcorp/orb-node/issues/234)) ([60a2812](https://github.com/orbcorp/orb-node/commit/60a2812d215238569787787233c5fdd4fdffe293))
+* **docs:** minor update to formatting of API link in README ([#233](https://github.com/orbcorp/orb-node/issues/233)) ([bc2ab56](https://github.com/orbcorp/orb-node/commit/bc2ab563a742a31df5994c028004020ab5724123))
+* **docs:** updates price intervals docs ([#228](https://github.com/orbcorp/orb-node/issues/228)) ([e640a63](https://github.com/orbcorp/orb-node/commit/e640a63783cd6d141e7947348bcc22bf0908c574))
+* **docs:** use client instead of package name in Node examples ([#236](https://github.com/orbcorp/orb-node/issues/236)) ([15ec443](https://github.com/orbcorp/orb-node/commit/15ec443a3a31b2f27ac9d203543e57d078446838))
+* gitignore test server logs ([#229](https://github.com/orbcorp/orb-node/issues/229)) ([6e9959f](https://github.com/orbcorp/orb-node/commit/6e9959f99678f58b9febe2e642913e2a662b50a1))
+* **internal:** minor reformatting ([#225](https://github.com/orbcorp/orb-node/issues/225)) ([1a7b1c3](https://github.com/orbcorp/orb-node/commit/1a7b1c3b19c839161e010c4bd38a3aad9ca6a5e8))
+
+
+### Documentation
+
+* **examples:** update example values ([#232](https://github.com/orbcorp/orb-node/issues/232)) ([7315dbc](https://github.com/orbcorp/orb-node/commit/7315dbc65581cbfbb4270d909345c66857e9889a))
+
 ## 2.11.2 (2024-06-04)
 
 Full Changelog: [v2.11.1...v2.11.2](https://github.com/orbcorp/orb-node/compare/v2.11.1...v2.11.2)

README.md

@@ -4,7 +4,7 @@
 
 This library provides convenient access to the Orb REST API from server-side TypeScript or JavaScript.
 
-The REST API documentation can be found [on docs.withorb.com](https://docs.withorb.com/reference/api-reference). The full API of this library can be found in [api.md](api.md).
+The REST API documentation can be found on [docs.withorb.com](https://docs.withorb.com/reference/api-reference). The full API of this library can be found in [api.md](api.md).
 
 ## Installation
 
@@ -20,7 +20,7 @@ The full API of this library can be found in [api.md](api.md).
 ```js
 import Orb from 'orb-billing';
 
-const orb = new Orb({
+const client = new Orb({
   apiKey: process.env['ORB_API_KEY'], // This is the default and can be omitted
 });
 
@@ -41,7 +41,7 @@ This library includes TypeScript definitions for all request params and response
 ```ts
 import Orb from 'orb-billing';
 
-const orb = new Orb({
+const client = new Orb({
   apiKey: process.env['ORB_API_KEY'], // This is the default and can be omitted
 });
 
@@ -104,7 +104,7 @@ You can use the `maxRetries` option to configure or disable this:
 <!-- prettier-ignore -->
 ```js
 // Configure the default for all requests:
-const orb = new Orb({
+const client = new Orb({
   maxRetries: 0, // default is 2
 });
 
@@ -121,7 +121,7 @@ Requests time out after 1 minute by default. You can configure this with a `time
 <!-- prettier-ignore -->
 ```ts
 // Configure the default for all requests:
-const orb = new Orb({
+const client = new Orb({
   timeout: 20 * 1000, // 20 seconds (default is 1 minute)
 });
 
@@ -205,7 +205,7 @@ You can also use the `.withResponse()` method to get the raw `Response` along wi
 
 <!-- prettier-ignore -->
 ```ts
-const orb = new Orb();
+const client = new Orb();
 
 const response = await orb.customers
   .create({ email: 'example-customer@withorb.com', name: 'My Customer' })
@@ -316,7 +316,7 @@ import http from 'http';
 import { HttpsProxyAgent } from 'https-proxy-agent';
 
 // Configure the default for all requests:
-const orb = new Orb({
+const client = new Orb({
   httpAgent: new HttpsProxyAgent(process.env.PROXY_URL),
 });
 
@@ -347,14 +347,6 @@ TypeScript >= 4.5 is supported.
 
 The following runtimes are supported:
 
-- 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.
-
 Note that React Native is not supported at this time.
 
 If you are interested in other runtime environments, please open or upvote an issue on GitHub.

api.md

@@ -198,6 +198,7 @@ Types:
 Methods:
 
 - <code title="post /invoices">client.invoices.<a href="./src/resources/invoices.ts">create</a>({ ...params }) -> Invoice</code>
+- <code title="put /invoices/{invoice_id}">client.invoices.<a href="./src/resources/invoices.ts">update</a>(invoiceId, { ...params }) -> Invoice</code>
 - <code title="get /invoices">client.invoices.<a href="./src/resources/invoices.ts">list</a>({ ...params }) -> InvoicesPage</code>
 - <code title="get /invoices/{invoice_id}">client.invoices.<a href="./src/resources/invoices.ts">fetch</a>(invoiceId) -> Invoice</code>
 - <code title="get /invoices/upcoming">client.invoices.<a href="./src/resources/invoices.ts">fetchUpcoming</a>({ ...params }) -> InvoiceFetchUpcomingResponse</code>
@@ -263,6 +264,7 @@ Types:
 Methods:
 
 - <code title="post /prices">client.prices.<a href="./src/resources/prices/prices.ts">create</a>({ ...params }) -> Price</code>
+- <code title="put /prices/{price_id}">client.prices.<a href="./src/resources/prices/prices.ts">update</a>(priceId, { ...params }) -> Price</code>
 - <code title="get /prices">client.prices.<a href="./src/resources/prices/prices.ts">list</a>({ ...params }) -> PricesPage</code>
 - <code title="post /prices/{price_id}/evaluate">client.prices.<a href="./src/resources/prices/prices.ts">evaluate</a>(priceId, { ...params }) -> PriceEvaluateResponse</code>
 - <code title="get /prices/{price_id}">client.prices.<a href="./src/resources/prices/prices.ts">fetch</a>(priceId) -> Price</code>
@@ -271,6 +273,7 @@ Methods:
 
 Methods:
 
+- <code title="put /prices/external_price_id/{external_price_id}">client.prices.externalPriceId.<a href="./src/resources/prices/external-price-id.ts">update</a>(externalPriceId, { ...params }) -> Price</code>
 - <code title="get /prices/external_price_id/{external_price_id}">client.prices.externalPriceId.<a href="./src/resources/prices/external-price-id.ts">fetch</a>(externalPriceId) -> Price</code>
 
 # Subscriptions

package.json

@@ -1,6 +1,6 @@
 {
   "name": "orb-billing",
-  "version": "2.11.2",
+  "version": "3.0.0",
   "description": "The official TypeScript library for the Orb API",
   "author": "Orb <team@withorb.com>",
   "types": "dist/index.d.ts",

src/core.ts

@@ -18,7 +18,7 @@ import {
   type HeadersInit,
 } from './_shims/index';
 export { type Response };
-import { isMultipartBody } from './uploads';
+import { BlobLike, isBlobLike, isMultipartBody } from './uploads';
 export {
   maybeMultipartFormRequestOptions,
   multipartFormRequestOptions,
@@ -235,7 +235,17 @@ export abstract class APIClient {
     path: string,
     opts?: PromiseOrValue<RequestOptions<Req>>,
   ): APIPromise<Rsp> {
-    return this.request(Promise.resolve(opts).then((opts) => ({ method, path, ...opts })));
+    return this.request(
+      Promise.resolve(opts).then(async (opts) => {
+        const body =
+          opts && isBlobLike(opts?.body) ? new DataView(await opts.body.arrayBuffer())
+          : opts?.body instanceof DataView ? opts.body
+          : opts?.body instanceof ArrayBuffer ? new DataView(opts.body)
+          : opts && ArrayBuffer.isView(opts?.body) ? new DataView(opts.body.buffer)
+          : opts?.body;
+        return { method, path, ...opts, body };
+      }),
+    );
   }
 
   getAPIList<Item, PageClass extends AbstractPage<Item> = AbstractPage<Item>>(
@@ -257,6 +267,8 @@ export abstract class APIClient {
         const encoded = encoder.encode(body);
         return encoded.length.toString();
       }
+    } else if (ArrayBuffer.isView(body)) {
+      return body.byteLength.toString();
     }
 
     return null;
@@ -266,7 +278,9 @@ export abstract class APIClient {
     const { method, path, query, headers: headers = {} } = options;
 
     const body =
-      isMultipartBody(options.body) ? options.body.body
+      ArrayBuffer.isView(options.body) || (options.__binaryRequest && typeof options.body === 'string') ?
+        options.body
+      : isMultipartBody(options.body) ? options.body.body
       : options.body ? JSON.stringify(options.body, null, 2)
       : null;
     const contentLength = this.calculateContentLength(body);
@@ -721,7 +735,9 @@ export type Headers = Record<string, string | null | undefined>;
 export type DefaultQuery = Record<string, string | undefined>;
 export type KeysEnum<T> = { [P in keyof Required<T>]: true };
 
-export type RequestOptions<Req = unknown | Record<string, unknown> | Readable> = {
+export type RequestOptions<
+  Req = unknown | Record<string, unknown> | Readable | BlobLike | ArrayBufferView | ArrayBuffer,
+> = {
   method?: HTTPMethod;
   path?: string;
   query?: Req | undefined;
@@ -735,6 +751,7 @@ export type RequestOptions<Req = unknown | Record<string, unknown> | Readable> =
   signal?: AbortSignal | undefined | null;
   idempotencyKey?: string;
 
+  __binaryRequest?: boolean | undefined;
   __binaryResponse?: boolean | undefined;
 };
 
@@ -755,6 +772,7 @@ const requestOptionsKeys: KeysEnum<RequestOptions> = {
   signal: true,
   idempotencyKey: true,
 
+  __binaryRequest: true,
   __binaryResponse: true,
 };
 
@@ -767,10 +785,11 @@ export const isRequestOptions = (obj: unknown): obj is RequestOptions => {
   );
 };
 
-export type FinalRequestOptions<Req = unknown | Record<string, unknown> | Readable> = RequestOptions<Req> & {
-  method: HTTPMethod;
-  path: string;
-};
+export type FinalRequestOptions<Req = unknown | Record<string, unknown> | Readable | DataView> =
+  RequestOptions<Req> & {
+    method: HTTPMethod;
+    path: string;
+  };
 
 declare const Deno: any;
 declare const EdgeRuntime: any;