orb-billing 1.19.5 → 1.20.1

package/README.md

@@ -20,21 +20,80 @@ yarn add orb-billing
 <!-- Start SDK Example Usage -->
 ```typescript
 import { Orb } from "orb-billing";
-import { PingResponse } from "orb-billing/dist/sdk/models/operations";
 
+(async() => {
+  const sdk = new Orb({
+    security: {
+      apiKeyAuth: "",
+    },
+  });
+
+  const res = await sdk.availability.ping();
+
+  if (res.statusCode == 200) {
+    // handle response
+  }
+})();
+```
+<!-- End SDK Example Usage -->
+
+<!-- Start Pagination -->
+# Pagination
+
+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.
+
+Here's an example of one such pagination call:
+<!-- End Pagination -->
+
+```ts
+/* eslint-disable prefer-const */
+import { Orb } from "orb-billing";
+
+// Initialize the SDK with an API key.
 const sdk = new Orb({
   security: {
     apiKeyAuth: "",
   },
 });
 
-sdk.availability.ping().then((res: PingResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
+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.`);
+    });
+
+    // The loop will continue if we received a cursor for additional results.
+  } while (cursor);
+}
+
+// Run the demo function.
+paginationDemo();
 ```
-<!-- End SDK Example Usage -->
 
 <!-- Start SDK Available Operations -->
 ## Available Resources and Operations
@@ -153,28 +212,12 @@ sdk.availability.ping().then((res: PingResponse) => {
 * [updateFixedFeeQuantity](docs/sdks/subscription/README.md#updatefixedfeequantity) - Update price quantity
 <!-- End SDK Available Operations -->
 
-
-
 <!-- Start Dev Containers -->
 
 <!-- End Dev Containers -->
 
-
-
-<!-- Start Pagination -->
-# Pagination
-
-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.
-
-Here's an example of one such pagination call:
-<!-- End Pagination -->
-
 <!-- Placeholder for Future Speakeasy SDK Sections -->
 
-
-
 ### Maturity
 
 This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage

package/dist/sdk/availability.js

@@ -95,7 +95,7 @@ var Availability = /** @class */ (function () {
     Availability.prototype.ping = function (config) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function () {
-            var baseURL, url, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes;
+            var baseURL, url, client, globalSecurity, properties, headers, httpRes, contentType, res, decodedRes, err, err, err;
             return __generator(this, function (_c) {
                 switch (_c.label) {
                     case 0:
@@ -138,41 +138,18 @@ var Availability = /** @class */ (function () {
                                     throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
                                 }
                                 break;
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 400:
-                                if (utils.matchContentType(contentType, "application/json")) {
-                                    res.fourHundredError = JSON.parse(decodedRes);
-                                }
-                                else {
-                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
-                                }
-                                break;
+                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 400 ||
+                                (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 404 ||
+                                (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 409 ||
+                                (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 413 ||
+                                ((httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) >= 400 && (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) < 500) ||
+                                ((httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) >= 500 && (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) < 600):
+                                throw new errors.SDKError("API error occurred", httpRes.status, decodedRes, httpRes);
                             case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 401:
                                 if (utils.matchContentType(contentType, "application/json")) {
-                                    res.fourHundredAndOneError = utils.objectToClass(JSON.parse(decodedRes), shared.FourHundredAndOneError);
-                                }
-                                else {
-                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
-                                }
-                                break;
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 404:
-                                if (utils.matchContentType(contentType, "application/json")) {
-                                    res.fourHundredAndFourError = JSON.parse(decodedRes);
-                                }
-                                else {
-                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
-                                }
-                                break;
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 409:
-                                if (utils.matchContentType(contentType, "application/json")) {
-                                    res.fourHundredAndNineError = JSON.parse(decodedRes);
-                                }
-                                else {
-                                    throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
-                                }
-                                break;
-                            case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 413:
-                                if (utils.matchContentType(contentType, "application/json")) {
-                                    res.fourHundredAndThirteenError = JSON.parse(decodedRes);
+                                    err = utils.objectToClass(JSON.parse(decodedRes), errors.FourHundredAndOneError);
+                                    err.rawResponse = httpRes;
+                                    throw new errors.FourHundredAndOneError(err);
                                 }
                                 else {
                                     throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
@@ -180,7 +157,9 @@ var Availability = /** @class */ (function () {
                                 break;
                             case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 429:
                                 if (utils.matchContentType(contentType, "application/json")) {
-                                    res.fourHundredAndTwentyNineError = utils.objectToClass(JSON.parse(decodedRes), shared.FourHundredAndTwentyNineError);
+                                    err = utils.objectToClass(JSON.parse(decodedRes), errors.FourHundredAndTwentyNineError);
+                                    err.rawResponse = httpRes;
+                                    throw new errors.FourHundredAndTwentyNineError(err);
                                 }
                                 else {
                                     throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);
@@ -188,7 +167,9 @@ var Availability = /** @class */ (function () {
                                 break;
                             case (httpRes === null || httpRes === void 0 ? void 0 : httpRes.status) == 500:
                                 if (utils.matchContentType(contentType, "application/json")) {
-                                    res.fiveHundredError = utils.objectToClass(JSON.parse(decodedRes), shared.FiveHundredError);
+                                    err = utils.objectToClass(JSON.parse(decodedRes), errors.FiveHundredError);
+                                    err.rawResponse = httpRes;
+                                    throw new errors.FiveHundredError(err);
                                 }
                                 else {
                                     throw new errors.SDKError("unknown content-type received: " + contentType, httpRes.status, decodedRes, httpRes);

package/dist/sdk/coupon.d.ts

@@ -23,7 +23,7 @@ export declare class Coupon {
      * will be hidden from lists of active coupons. Additionally, once a coupon is archived, its redemption
      * code can be reused for a different coupon.
      */
-    archive(req: operations.ArchiveCouponRequest, config?: AxiosRequestConfig): Promise<operations.ArchiveCouponResponse>;
+    archive(couponId: string, config?: AxiosRequestConfig): Promise<operations.ArchiveCouponResponse>;
     /**
      * Create coupon
      *
@@ -38,7 +38,7 @@ export declare class Coupon {
      * This endpoint retrieves a coupon by its ID. To fetch coupons by their redemption code, use the
      * [List coupons](list-coupons) endpoint with the redemption_code parameter.
      */
-    fetch(req: operations.FetchCouponRequest, config?: AxiosRequestConfig): Promise<operations.FetchCouponResponse>;
+    fetch(couponId: string, config?: AxiosRequestConfig): Promise<operations.FetchCouponResponse>;
     /**
      * List coupons
      *
@@ -49,7 +49,7 @@ export declare class Coupon {
      * `pagination_metadata`, which lets the caller retrieve the next page of results if they exist. More information
      * about pagination can be found in the Pagination-metadata schema.
      */
-    list(req: operations.ListCouponsRequest, config?: AxiosRequestConfig): Promise<operations.ListCouponsResponse>;
+    list(cursor?: string, limit?: number, redemptionCode?: string, showArchived?: boolean, config?: AxiosRequestConfig): Promise<operations.ListCouponsResponse>;
     /**
      * List coupon subscriptions
      *
@@ -58,5 +58,5 @@ export declare class Coupon {
      * [paginated](../reference/pagination) list, ordered starting from the most recently created subscription. For a full
      * discussion of the subscription resource, see [Subscription](../guides/concepts#subscription).
      */
-    listSubscriptions(req: operations.ListCouponSubscriptionsRequest, config?: AxiosRequestConfig): Promise<operations.ListCouponSubscriptionsResponse>;
+    listSubscriptions(couponId: string, cursor?: string, limit?: number, config?: AxiosRequestConfig): Promise<operations.ListCouponSubscriptionsResponse>;
 }