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

release: 2.3.0

Author: pascualcam

.devcontainer/Dockerfile

@@ -7,6 +7,10 @@ RUN apt-get update && apt-get install -y \
   yarnpkg \
   && apt-get clean autoclean
 
+# Ensure UTF-8 encoding
+ENV LANG=C.UTF-8
+ENV LC_ALL=C.UTF-8
+
 # Yarn
 RUN ln -sf /usr/bin/yarnpkg /usr/bin/yarn
 

.github/workflows/ci.yml

@@ -28,3 +28,5 @@ jobs:
       - name: Check types
         run: |
           yarn build
+
+  

.gitignore

@@ -5,3 +5,4 @@ dist
 /deno
 /*.tgz
 .idea/
+

.prettierignore

@@ -1,5 +1,5 @@
 CHANGELOG.md
-/ecosystem-tests
+/ecosystem-tests/*/**
 /node_modules
 /deno
 

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "2.2.0"
+  ".": "2.3.0"
 }

.stats.yml

@@ -1 +1 @@
-configured_endpoints: 81
+configured_endpoints: 82

CHANGELOG.md

@@ -1,5 +1,38 @@
 # Changelog
 
+## 2.3.0 (2024-04-24)
+
+Full Changelog: [v2.2.0...v2.3.0](https://github.com/orbcorp/orb-node/compare/v2.2.0...v2.3.0)
+
+### Features
+
+* **api:** add effective_date field ([#163](https://github.com/orbcorp/orb-node/issues/163)) ([96a98bd](https://github.com/orbcorp/orb-node/commit/96a98bd315ceb6f2239dee6267bcf0b3a7e84a39))
+* **api:** add subscription update endpoint ([#168](https://github.com/orbcorp/orb-node/issues/168)) ([09b5798](https://github.com/orbcorp/orb-node/commit/09b5798769187bcb18c92210c8b336b169f72343))
+* **api:** add the shared model PaginationMetadata ([#164](https://github.com/orbcorp/orb-node/issues/164)) ([15f5af3](https://github.com/orbcorp/orb-node/commit/15f5af31b39a66ef8a626af50d09abf3202afc8f))
+* **api:** price evaluation endpoint generally available ([#169](https://github.com/orbcorp/orb-node/issues/169)) ([492a728](https://github.com/orbcorp/orb-node/commit/492a72833150267df706054e5d8c1ce998b27999))
+* **api:** updates ([#154](https://github.com/orbcorp/orb-node/issues/154)) ([01aef6d](https://github.com/orbcorp/orb-node/commit/01aef6d41d2fd0f6174eb6116ac2a670cfc96882))
+* **api:** updates ([#159](https://github.com/orbcorp/orb-node/issues/159)) ([5b6287c](https://github.com/orbcorp/orb-node/commit/5b6287c047ed1a5eab7e498690838062c233a1a7))
+
+
+### Bug Fixes
+
+* **api:** add shared model BillingCycleRelativeDate ([#167](https://github.com/orbcorp/orb-node/issues/167)) ([8677375](https://github.com/orbcorp/orb-node/commit/867737537ddecdfcaaf33bb0bd3fe29532f265c4))
+* **api:** some path params were incorrectly typed as nullable ([#166](https://github.com/orbcorp/orb-node/issues/166)) ([eeb81d4](https://github.com/orbcorp/orb-node/commit/eeb81d4ade556528cf564b850b0d1b932fbfd999))
+* use UTC timezone for verifying webhook signature ([9a0b87a](https://github.com/orbcorp/orb-node/commit/9a0b87a704a84608383c66cb5acb73f55aa97b3c)), closes [#156](https://github.com/orbcorp/orb-node/issues/156)
+
+
+### Chores
+
+* **internal:** formatting ([#161](https://github.com/orbcorp/orb-node/issues/161)) ([db765d8](https://github.com/orbcorp/orb-node/commit/db765d86efc540e6301fc15912360ba66218c673))
+* **internal:** update gitignore ([#160](https://github.com/orbcorp/orb-node/issues/160)) ([7a2c39f](https://github.com/orbcorp/orb-node/commit/7a2c39f468ea6aba7133d6fdfd28c632c119e145))
+* **internal:** use @swc/jest for running tests ([#165](https://github.com/orbcorp/orb-node/issues/165)) ([c744e70](https://github.com/orbcorp/orb-node/commit/c744e70bf74385171fea39d73c9611f792661a3c))
+* use debug instead of console log for webhook signature logging ([590cbf1](https://github.com/orbcorp/orb-node/commit/590cbf17e37a7eb071d6d31295b3f9cc9bb46579))
+
+
+### Build System
+
+* configure UTF-8 locale in devcontainer ([#162](https://github.com/orbcorp/orb-node/issues/162)) ([aa09c7d](https://github.com/orbcorp/orb-node/commit/aa09c7dfc261b6e05e8e944f23a55463f80d13da))
+
 ## 2.2.0 (2024-04-08)
 
 Full Changelog: [v2.1.2...v2.2.0](https://github.com/orbcorp/orb-node/compare/v2.1.2...v2.2.0)

api.md

@@ -2,7 +2,9 @@
 
 Types:
 
+- <code><a href="./src/resources/shared.ts">BillingCycleRelativeDate</a></code>
 - <code><a href="./src/resources/shared.ts">Discount</a></code>
+- <code><a href="./src/resources/shared.ts">PaginationMetadata</a></code>
 
 # TopLevel
 
@@ -253,12 +255,15 @@ Methods:
 
 Types:
 
+- <code><a href="./src/resources/prices/prices.ts">EvaluatePriceGroup</a></code>
 - <code><a href="./src/resources/prices/prices.ts">Price</a></code>
+- <code><a href="./src/resources/prices/prices.ts">PriceEvaluateResponse</a></code>
 
 Methods:
 
 - <code title="post /prices">client.prices.<a href="./src/resources/prices/prices.ts">create</a>({ ...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>
 
 ## ExternalPriceID
@@ -280,6 +285,7 @@ Types:
 Methods:
 
 - <code title="post /subscriptions">client.subscriptions.<a href="./src/resources/subscriptions.ts">create</a>({ ...params }) -> Subscription</code>
+- <code title="put /subscriptions/{subscription_id}">client.subscriptions.<a href="./src/resources/subscriptions.ts">update</a>(subscriptionId, { ...params }) -> Subscription</code>
 - <code title="get /subscriptions">client.subscriptions.<a href="./src/resources/subscriptions.ts">list</a>({ ...params }) -> SubscriptionsPage</code>
 - <code title="post /subscriptions/{subscription_id}/cancel">client.subscriptions.<a href="./src/resources/subscriptions.ts">cancel</a>(subscriptionId, { ...params }) -> Subscription</code>
 - <code title="get /subscriptions/{subscription_id}">client.subscriptions.<a href="./src/resources/subscriptions.ts">fetch</a>(subscriptionId) -> Subscription</code>
@@ -292,24 +298,4 @@ Methods:
 - <code title="post /subscriptions/{subscription_id}/unschedule_cancellation">client.subscriptions.<a href="./src/resources/subscriptions.ts">unscheduleCancellation</a>(subscriptionId) -> Subscription</code>
 - <code title="post /subscriptions/{subscription_id}/unschedule_fixed_fee_quantity_updates">client.subscriptions.<a href="./src/resources/subscriptions.ts">unscheduleFixedFeeQuantityUpdates</a>(subscriptionId, { ...params }) -> Subscription</code>
 - <code title="post /subscriptions/{subscription_id}/unschedule_pending_plan_changes">client.subscriptions.<a href="./src/resources/subscriptions.ts">unschedulePendingPlanChanges</a>(subscriptionId) -> Subscription</code>
-- <code title="post /subscriptions/{subscription_id}/update_fixed_fee_quantity">client.subscriptions.<a href="./src/resources/subscriptions.ts">updateFixedFeeQuantity</a>(subscriptionId, { ...params }) -> Subscription</code>
-
-# Webhooks
-
-Methods:
-
-- <code>client.webhooks.<a href="./src/resources/webhooks.ts">unwrap</a>(payload, headers, secret) -> Object</code>
-- <code>client.webhooks.<a href="./src/resources/webhooks.ts">verifySignature</a>(body, headers, secret) -> void</code>
-
-# Beta
-
-## Price
-
-Types:
-
-- <code><a href="./src/resources/beta/price.ts">EvaluatePriceGroup</a></code>
-- <code><a href="./src/resources/beta/price.ts">PriceEvaluateResponse</a></code>
-
-Methods:
-
-- <code title="post /prices/{price_id}/evaluate">client.beta.price.<a href="./src/resources/beta/price.ts">evaluate</a>(priceId, { ...params }) -> PriceEvaluateResponse</code>
+- <code title="post /subscriptions/{subscription_id}/update_fixed_fee_quantity">client.subscriptions.<a href="./src/resources/subscriptions.ts">updateFixedFeeQuantity</a>(subscriptionId, { ...params }) -> Subscription</code>

jest.config.ts

@@ -3,6 +3,9 @@ import type { JestConfigWithTsJest } from 'ts-jest';
 const config: JestConfigWithTsJest = {
   preset: 'ts-jest/presets/default-esm',
   testEnvironment: 'node',
+  transform: {
+    '^.+\\.(t|j)sx?$': ['@swc/jest', { sourceMaps: 'inline' }],
+  },
   moduleNameMapper: {
     '^orb-billing$': '<rootDir>/src/index.ts',
     '^orb-billing/_shims/auto/(.*)$': '<rootDir>/src/_shims/auto/$1-node',

package.json

@@ -1,6 +1,6 @@
 {
   "name": "orb-billing",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "The official TypeScript library for the Orb API",
   "author": "Orb <[email protected]>",
   "types": "dist/index.d.ts",
@@ -37,6 +37,8 @@
     "web-streams-polyfill": "^3.2.1"
   },
   "devDependencies": {
+    "@swc/core": "^1.3.102",
+    "@swc/jest": "^0.2.29",
     "@types/jest": "^29.4.0",
     "@typescript-eslint/eslint-plugin": "^6.7.0",
     "@typescript-eslint/parser": "^6.7.0",

src/index.ts

@@ -141,7 +141,6 @@ export class Orb extends Core.APIClient {
   plans: API.Plans = new API.Plans(this);
   prices: API.Prices = new API.Prices(this);
   subscriptions: API.Subscriptions = new API.Subscriptions(this);
-  beta: API.Beta = new API.Beta(this);
   webhooks: API.Webhooks = new API.Webhooks(this);
 
   protected override defaultQuery(): Core.DefaultQuery | undefined {
@@ -190,6 +189,9 @@ export class Orb extends Core.APIClient {
   static OrbInternalServerError = Errors.OrbInternalServerError;
   static UnprocessableEntityError = Errors.UnprocessableEntityError;
   static DuplicateResourceCreation = Errors.DuplicateResourceCreation;
+
+  static toFile = Uploads.toFile;
+  static fileFromPath = Uploads.fileFromPath;
 }
 
 export const {
@@ -224,10 +226,6 @@ export import toFile = Uploads.toFile;
 export import fileFromPath = Uploads.fileFromPath;
 
 export namespace Orb {
-  // Helper functions
-  export import toFile = Uploads.toFile;
-  export import fileFromPath = Uploads.fileFromPath;
-
   export import RequestOptions = Core.RequestOptions;
 
   export import Page = Pagination.Page;
@@ -300,10 +298,13 @@ export namespace Orb {
   export import PlanListParams = API.PlanListParams;
 
   export import Prices = API.Prices;
+  export import EvaluatePriceGroup = API.EvaluatePriceGroup;
   export import Price = API.Price;
+  export import PriceEvaluateResponse = API.PriceEvaluateResponse;
   export import PricesPage = API.PricesPage;
   export import PriceCreateParams = API.PriceCreateParams;
   export import PriceListParams = API.PriceListParams;
+  export import PriceEvaluateParams = API.PriceEvaluateParams;
 
   export import Subscriptions = API.Subscriptions;
   export import Subscription = API.Subscription;
@@ -313,6 +314,7 @@ export namespace Orb {
   export import SubscriptionsPage = API.SubscriptionsPage;
   export import SubscriptionFetchScheduleResponsesPage = API.SubscriptionFetchScheduleResponsesPage;
   export import SubscriptionCreateParams = API.SubscriptionCreateParams;
+  export import SubscriptionUpdateParams = API.SubscriptionUpdateParams;
   export import SubscriptionListParams = API.SubscriptionListParams;
   export import SubscriptionCancelParams = API.SubscriptionCancelParams;
   export import SubscriptionFetchCostsParams = API.SubscriptionFetchCostsParams;
@@ -324,9 +326,9 @@ export namespace Orb {
   export import SubscriptionUnscheduleFixedFeeQuantityUpdatesParams = API.SubscriptionUnscheduleFixedFeeQuantityUpdatesParams;
   export import SubscriptionUpdateFixedFeeQuantityParams = API.SubscriptionUpdateFixedFeeQuantityParams;
 
-  export import Beta = API.Beta;
-
+  export import BillingCycleRelativeDate = API.BillingCycleRelativeDate;
   export import Discount = API.Discount;
+  export import PaginationMetadata = API.PaginationMetadata;
 }
 
 export default Orb;

src/resources/coupons/coupons.ts

@@ -144,7 +144,7 @@ export namespace Coupon {
 }
 
 export interface CouponCreateParams {
-  discount: CouponCreateParams.PercentageDiscount | CouponCreateParams.AmountDiscount;
+  discount: CouponCreateParams.NewCouponPercentageDiscount | CouponCreateParams.NewCouponAmountDiscount;
 
   /**
    * This string can be used to redeem this coupon for a given subscription.
@@ -165,39 +165,16 @@ export interface CouponCreateParams {
 }
 
 export namespace CouponCreateParams {
-  export interface PercentageDiscount {
-    /**
-     * List of price_ids that this discount applies to. For plan/plan phase discounts,
-     * this can be a subset of prices.
-     */
-    applies_to_price_ids: Array<string>;
-
+  export interface NewCouponPercentageDiscount {
     discount_type: 'percentage';
 
-    /**
-     * Only available if discount_type is `percentage`. This is a number between 0
-     * and 1.
-     */
     percentage_discount: number;
-
-    reason?: string | null;
   }
 
-  export interface AmountDiscount {
-    /**
-     * Only available if discount_type is `amount`.
-     */
+  export interface NewCouponAmountDiscount {
     amount_discount: string;
 
-    /**
-     * List of price_ids that this discount applies to. For plan/plan phase discounts,
-     * this can be a subset of prices.
-     */
-    applies_to_price_ids: Array<string>;
-
     discount_type: 'amount';
-
-    reason?: string | null;
   }
 }
 

src/resources/customers/costs.ts

@@ -144,13 +144,13 @@ export class Costs extends APIResource {
    * `grouping_value` and `secondary_grouping_value` available.
    */
   list(
-    customerId: string | null,
+    customerId: string,
     query?: CostListParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<CostListResponse>;
-  list(customerId: string | null, options?: Core.RequestOptions): Core.APIPromise<CostListResponse>;
+  list(customerId: string, options?: Core.RequestOptions): Core.APIPromise<CostListResponse>;
   list(
-    customerId: string | null,
+    customerId: string,
     query: CostListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
   ): Core.APIPromise<CostListResponse> {
@@ -297,16 +297,16 @@ export class Costs extends APIResource {
    * `grouping_value` and `secondary_grouping_value` available.
    */
   listByExternalId(
-    externalCustomerId: string | null,
+    externalCustomerId: string,
     query?: CostListByExternalIDParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<CostListByExternalIDResponse>;
   listByExternalId(
-    externalCustomerId: string | null,
+    externalCustomerId: string,
     options?: Core.RequestOptions,
   ): Core.APIPromise<CostListByExternalIDResponse>;
   listByExternalId(
-    externalCustomerId: string | null,
+    externalCustomerId: string,
     query: CostListByExternalIDParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
   ): Core.APIPromise<CostListByExternalIDResponse> {

src/resources/customers/credits/credits.ts

@@ -16,16 +16,16 @@ export class Credits extends APIResource {
    * Returns a paginated list of unexpired, non-zero credit blocks for a customer.
    */
   list(
-    customerId: string | null,
+    customerId: string,
     query?: CreditListParams,
     options?: Core.RequestOptions,
   ): Core.PagePromise<CreditListResponsesPage, CreditListResponse>;
   list(
-    customerId: string | null,
+    customerId: string,
     options?: Core.RequestOptions,
   ): Core.PagePromise<CreditListResponsesPage, CreditListResponse>;
   list(
-    customerId: string | null,
+    customerId: string,
     query: CreditListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
   ): Core.PagePromise<CreditListResponsesPage, CreditListResponse> {
@@ -42,16 +42,16 @@ export class Credits extends APIResource {
    * Returns a paginated list of unexpired, non-zero credit blocks for a customer.
    */
   listByExternalId(
-    externalCustomerId: string | null,
+    externalCustomerId: string,
     query?: CreditListByExternalIDParams,
     options?: Core.RequestOptions,
   ): Core.PagePromise<CreditListByExternalIDResponsesPage, CreditListByExternalIDResponse>;
   listByExternalId(
-    externalCustomerId: string | null,
+    externalCustomerId: string,
     options?: Core.RequestOptions,
   ): Core.PagePromise<CreditListByExternalIDResponsesPage, CreditListByExternalIDResponse>;
   listByExternalId(
-    externalCustomerId: string | null,
+    externalCustomerId: string,
     query: CreditListByExternalIDParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
   ): Core.PagePromise<CreditListByExternalIDResponsesPage, CreditListByExternalIDResponse> {
@@ -75,6 +75,8 @@ export interface CreditListResponse {
 
   balance: number;
 
+  effective_date: string | null;
+
   expiry_date: string | null;
 
   per_unit_cost_basis: string | null;
@@ -87,6 +89,8 @@ export interface CreditListByExternalIDResponse {
 
   balance: number;
 
+  effective_date: string | null;
+
   expiry_date: string | null;
 
   per_unit_cost_basis: string | null;