@checkoutpage/sdk 0.1.31 → 0.1.33

package/dist/index.mjs

@@ -65,14 +65,19 @@ var InvoiceResource = class {
    *
    * @example
    * const { data: invoice } = await client.invoices.get(invoiceId);
+   *
+   * @example
+   * // A test invoice
+   * const { data: testInvoice } = await client.invoices.get(invoiceId, { livemode: false });
    */
-  async get(id) {
+  async get(id, options = {}) {
     if (!id) {
       throw new Error("Invoice ID is required");
     }
     return this.client.request({
       method: "GET",
-      path: `/v1/invoices/${id}`
+      path: `/v1/invoices/${id}`,
+      query: { livemode: options.livemode?.toString() }
     });
   }
   async list(args = {}) {
@@ -86,7 +91,8 @@ var InvoiceResource = class {
       chargeId: args.chargeId,
       poNumber: args.poNumber,
       createdAfter: args.createdAfter,
-      createdBefore: args.createdBefore
+      createdBefore: args.createdBefore,
+      livemode: args.livemode?.toString()
     };
     return this.client.request({
       method: "GET",
@@ -248,6 +254,8 @@ var CustomerResource = class {
   async list(args = {}) {
     const query = {
       search: args.search,
+      createdAfter: args.createdAfter,
+      createdBefore: args.createdBefore,
       limit: args.limit?.toString(),
       starting_after: args.starting_after,
       ending_before: args.ending_before
@@ -313,8 +321,10 @@ var CouponResource = class {
   /**
    * Update an existing coupon. Only the fields you supply are changed.
    *
-   * `pageIds` and `ticketTypeIds` replace the existing lists rather than
-   * merging — pass an empty array to clear one.
+   * `rules` replaces every stored rule rather than merging; an empty list makes
+   * the coupon work on every checkout page and event. `pageIds` and
+   * `ticketTypeIds` are deprecated: they are accepted only without `rules`, and
+   * the API refuses them with a 400 when the coupon has rules they can't express.
    *
    * The discount itself (`code`, `amountOff`, `percentOff`, `currency`,
    * `duration`) is fixed once the coupon is mirrored into Stripe. To change a
@@ -333,6 +343,24 @@ var CouponResource = class {
       body: params
     });
   }
+  /**
+   * Create a coupon. `rules` says where it works and what it discounts, one rule
+   * per checkout page or event; omit it for a coupon that discounts the whole
+   * order everywhere. `pageIds` and `ticketTypeIds` are deprecated in favour of
+   * `rules` and cannot be sent with it.
+   *
+   * @example
+   * await client.coupons.create({
+   *   type: 'percent',
+   *   label: 'Monthly plus workbook',
+   *   code: 'BUNDLE20',
+   *   percentOff: 20,
+   *   duration: 'once',
+   *   rules: [
+   *     { pageId, appliesTo: 'pricesAndBumps', priceIds: [monthlyPriceId], bumpProductIds: [workbookId] },
+   *   ],
+   * });
+   */
   async create(params) {
     const body = {
       label: params.label,
@@ -345,6 +373,12 @@ var CouponResource = class {
     if (params.appliesToSetupFee !== void 0) {
       body.appliesToSetupFee = params.appliesToSetupFee;
     }
+    if (params.appliesToTicketFees !== void 0) {
+      body.appliesToTicketFees = params.appliesToTicketFees;
+    }
+    if (params.rules !== void 0) {
+      body.rules = params.rules;
+    }
     if (params.pageIds !== void 0) {
       body.pageIds = params.pageIds;
     }
@@ -382,20 +416,26 @@ var PaymentResource = class {
    *
    * @example
    * const { data: payment } = await client.payments.get(paymentId);
+   *
+   * @example
+   * // A test payment
+   * const { data: testPayment } = await client.payments.get(paymentId, { livemode: false });
    */
-  async get(paymentId) {
+  async get(paymentId, options = {}) {
     if (!paymentId) {
       throw new Error("Payment ID is required");
     }
     return this.client.request({
       method: "GET",
-      path: `/v1/payments/${paymentId}`
+      path: `/v1/payments/${paymentId}`,
+      query: { livemode: options.livemode?.toString() }
     });
   }
   async list(args = {}) {
     const query = {
       search: args.search,
       status: args.status,
+      orderStatus: args.orderStatus,
       pageId: args.pageId,
       customerId: args.customerId,
       orderId: args.orderId,
@@ -404,6 +444,7 @@ var PaymentResource = class {
       createdAfter: args.createdAfter,
       createdBefore: args.createdBefore,
       abandonmentStatus: args.abandonmentStatus,
+      livemode: args.livemode?.toString(),
       limit: args.limit?.toString(),
       starting_after: args.starting_after,
       ending_before: args.ending_before
@@ -426,21 +467,34 @@ var SubscriptionResource = class {
    *
    * @example
    * const { data: subscription } = await client.subscriptions.get(subscriptionId);
+   *
+   * @example
+   * // A test subscription
+   * const { data: testSubscription } = await client.subscriptions.get(subscriptionId, {
+   *   livemode: false,
+   * });
    */
-  async get(subscriptionId) {
+  async get(subscriptionId, options = {}) {
     if (!subscriptionId) {
       throw new Error("Subscription ID is required");
     }
     return this.client.request({
       method: "GET",
-      path: `/v1/subscriptions/${subscriptionId}`
+      path: `/v1/subscriptions/${subscriptionId}`,
+      query: { livemode: options.livemode?.toString() }
     });
   }
   async list(args = {}) {
     const query = {
       search: args.search,
       pageId: args.pageId,
+      customerId: args.customerId,
+      orderId: args.orderId,
+      createdAfter: args.createdAfter,
+      createdBefore: args.createdBefore,
+      abandonmentStatus: args.abandonmentStatus,
       status: args.status,
+      livemode: args.livemode?.toString(),
       limit: args.limit?.toString(),
       starting_after: args.starting_after,
       ending_before: args.ending_before
@@ -485,14 +539,21 @@ var SubscriptionPaymentResource = class {
    *
    * @example
    * const { data: payment } = await client.subscriptionPayments.get(paymentId);
+   *
+   * @example
+   * // A test subscription payment
+   * const { data: testPayment } = await client.subscriptionPayments.get(paymentId, {
+   *   livemode: false,
+   * });
    */
-  async get(subscriptionPaymentId) {
+  async get(subscriptionPaymentId, options = {}) {
     if (!subscriptionPaymentId) {
       throw new Error("Subscription payment ID is required");
     }
     return this.client.request({
       method: "GET",
-      path: `/v1/subscription-payments/${subscriptionPaymentId}`
+      path: `/v1/subscription-payments/${subscriptionPaymentId}`,
+      query: { livemode: options.livemode?.toString() }
     });
   }
   async list(args = {}) {
@@ -508,7 +569,8 @@ var SubscriptionPaymentResource = class {
       refunded: args.refunded,
       billingReason: args.billingReason,
       createdAfter: args.createdAfter,
-      createdBefore: args.createdBefore
+      createdBefore: args.createdBefore,
+      livemode: args.livemode?.toString()
     };
     return this.client.request({
       method: "GET",
@@ -523,20 +585,70 @@ var BookingResource = class {
   constructor(client) {
     this.client = client;
   }
+  /**
+   * Create an event booking without collecting card payment. This is a real
+   * booking: tickets are issued, the customer receives a confirmation email
+   * with the ticket PDF, live-mode bookings decrement capacity, and booking webhooks fire.
+   * There are two ways to settle it. With `paymentOption.manualType` the
+   * booking is recorded as `unpaid`, to be settled outside checkout via the
+   * chosen manual option; a free booking simply has nothing due. With
+   * `complimentary: true` the tickets are issued at no charge: the booking is
+   * recorded as `paid` with `amount`, `amountPaid` and `amountDue` of 0 and
+   * `isComplimentary: true`, while the ticket lines keep their face value and
+   * `complimentaryDiscountAmount` records what they would have cost.
+   * `complimentary` is mutually exclusive with `paymentOption` and `couponId`,
+   * and one of `paymentOption` or `complimentary` is required.
+   *
+   * Field entries carry a `fieldId` plus the value. Every required field on
+   * the event must be supplied, and a stock event requires name, email and a
+   * billing address. The ids come from `GET /v1/events/{eventId}/fields`,
+   * which this client does not yet wrap.
+   *
+   * @example
+   * const { data: booking } = await client.bookings.create({
+   *   eventId,
+   *   tickets: { [ticketTypeId]: 2 },
+   *   fields: [
+   *     { fieldId: emailFieldId, value: 'ada@example.com' },
+   *     { fieldId: nameFieldId, value: 'Ada Lovelace' },
+   *   ],
+   *   paymentOption: { manualType: 'invoice' },
+   * });
+   *
+   * @example
+   * const { data: booking } = await client.bookings.create({
+   *   eventId,
+   *   tickets: { [ticketTypeId]: 2 },
+   *   fields: [{ fieldId: emailFieldId, value: 'ada@example.com' }],
+   *   complimentary: true,
+   * });
+   */
+  async create(params) {
+    return this.client.request({
+      method: "POST",
+      path: "/v1/bookings/",
+      body: params
+    });
+  }
   /**
    * Retrieve a single booking by ID. Only event bookings are returned —
    * a checkout charge is a payment, and 404s here.
    *
    * @example
    * const { data: booking } = await client.bookings.get(bookingId);
+   *
+   * @example
+   * // A test booking
+   * const { data: testBooking } = await client.bookings.get(bookingId, { livemode: false });
    */
-  async get(bookingId) {
+  async get(bookingId, options = {}) {
     if (!bookingId) {
       throw new Error("Booking ID is required");
     }
     return this.client.request({
       method: "GET",
-      path: `/v1/bookings/${bookingId}`
+      path: `/v1/bookings/${bookingId}`,
+      query: { livemode: options.livemode?.toString() }
     });
   }
   /**
@@ -548,20 +660,26 @@ var BookingResource = class {
    * @example
    * const pdf = await client.bookings.downloadTicketPdf(bookingId);
    * fs.writeFileSync('tickets.pdf', Buffer.from(pdf));
+   *
+   * @example
+   * // The tickets of a test booking
+   * const testPdf = await client.bookings.downloadTicketPdf(bookingId, { livemode: false });
    */
-  async downloadTicketPdf(bookingId) {
+  async downloadTicketPdf(bookingId, options = {}) {
     if (!bookingId) {
       throw new Error("Booking ID is required");
     }
     return this.client.requestRaw({
       method: "GET",
-      path: `/v1/bookings/${bookingId}/ticket-pdf`
+      path: `/v1/bookings/${bookingId}/ticket-pdf`,
+      query: { livemode: options.livemode?.toString() }
     });
   }
   async list(args = {}) {
     const query = {
       search: args.search,
       status: args.status,
+      orderStatus: args.orderStatus,
       pageId: args.pageId,
       customerId: args.customerId,
       orderId: args.orderId,
@@ -569,6 +687,8 @@ var BookingResource = class {
       createdAfter: args.createdAfter,
       createdBefore: args.createdBefore,
       abandonmentStatus: args.abandonmentStatus,
+      isComplimentary: args.isComplimentary,
+      livemode: args.livemode?.toString(),
       limit: args.limit?.toString(),
       starting_after: args.starting_after,
       ending_before: args.ending_before
@@ -598,6 +718,7 @@ var TicketResource = class {
       createdAfter: args.createdAfter,
       createdBefore: args.createdBefore,
       search: args.search,
+      livemode: args.livemode?.toString(),
       limit: args.limit?.toString(),
       starting_after: args.starting_after,
       ending_before: args.ending_before
@@ -640,10 +761,59 @@ var TicketResource = class {
 };
 
 // src/resources/products/products.ts
+var ORDER_BUMP_CARD_FIELDS = [
+  "shortDescription",
+  "callToActionText",
+  "headingText",
+  "features",
+  "calloutText",
+  "calloutIcon"
+];
 var ProductResource = class {
   constructor(client) {
     this.client = client;
   }
+  async list(args = {}) {
+    const query = {
+      limit: args.limit?.toString(),
+      starting_after: args.starting_after,
+      ending_before: args.ending_before,
+      role: args.role,
+      search: args.search
+    };
+    return this.client.request({
+      method: "GET",
+      path: "/v1/products/",
+      query
+    });
+  }
+  /**
+   * Creates an order bump product (`role: 'orderbump'`). Order bump products use
+   * a single one-time price; page products are created with their page.
+   */
+  async create(params) {
+    return this.client.request({
+      method: "POST",
+      path: "/v1/products/",
+      body: params
+    });
+  }
+  /**
+   * Deletes an order bump product that has never been bought. Pass
+   * `fromAllPages: true` to remove it from the pages offering it first.
+   */
+  async delete(productId, options = {}) {
+    if (!productId) {
+      throw new Error("Product ID is required");
+    }
+    return this.client.request({
+      method: "DELETE",
+      path: `/v1/products/${productId}`,
+      query: {
+        fromAllPages: options.fromAllPages === void 0 ? void 0 : String(options.fromAllPages)
+      }
+    });
+  }
   async get(productId) {
     if (!productId) {
       throw new Error("Product ID is required");
@@ -700,6 +870,9 @@ var ProductResource = class {
     if (params.limitSubscriptions !== void 0) {
       body.limitSubscriptions = params.limitSubscriptions;
     }
+    if (params.limitPayments !== void 0) {
+      body.limitPayments = params.limitPayments;
+    }
     if (params.enableFileAccessForInactiveSubscriptions !== void 0) {
       body.enableFileAccessForInactiveSubscriptions = params.enableFileAccessForInactiveSubscriptions;
     }
@@ -715,6 +888,14 @@ var ProductResource = class {
     if (params.defaultPriceId !== void 0) {
       body.defaultPriceId = params.defaultPriceId;
     }
+    if (params.pricePicker !== void 0) {
+      body.pricePicker = params.pricePicker;
+    }
+    for (const field of ORDER_BUMP_CARD_FIELDS) {
+      if (params[field] !== void 0) {
+        body[field] = params[field];
+      }
+    }
     return this.client.request({
       method: "PATCH",
       path: `/v1/products/${productId}`,
@@ -764,6 +945,66 @@ var FileResource = class {
   }
 };
 
+// src/resources/order-bumps/order-bumps.ts
+var OrderBumpsResource = class {
+  constructor(client, pageResource) {
+    this.client = client;
+    this.pageResource = pageResource;
+  }
+  basePath(pageId) {
+    if (!pageId) {
+      throw new Error("Page ID is required");
+    }
+    return `/v1/${this.pageResource}/${pageId}/order-bumps`;
+  }
+  /** Lists the order bumps on the page in display order, including unavailable ones. */
+  async list(pageId) {
+    return this.client.request({
+      method: "GET",
+      path: this.basePath(pageId)
+    });
+  }
+  /** Offers an order bump product on the page. It is added last. */
+  async create(pageId, params) {
+    return this.client.request({
+      method: "POST",
+      path: this.basePath(pageId),
+      body: params
+    });
+  }
+  /** Updates how the order bump is offered on the page. `showHideLogic` is replaced whole. */
+  async update(pageId, productId, params) {
+    const path = this.basePath(pageId);
+    if (!productId) {
+      throw new Error("Product ID is required");
+    }
+    return this.client.request({
+      method: "PATCH",
+      path: `${path}/${productId}`,
+      body: params
+    });
+  }
+  /** Stops offering the order bump on the page. The product is kept. */
+  async delete(pageId, productId) {
+    const path = this.basePath(pageId);
+    if (!productId) {
+      throw new Error("Product ID is required");
+    }
+    return this.client.request({
+      method: "DELETE",
+      path: `${path}/${productId}`
+    });
+  }
+  /** Sets the display order. `productIds` must list every order bump on the page exactly once. */
+  async reorder(pageId, params) {
+    return this.client.request({
+      method: "POST",
+      path: `${this.basePath(pageId)}/reorder`,
+      body: params
+    });
+  }
+};
+
 // src/resources/checkout-pages/checkout-pages.ts
 var CheckoutPageFieldsResource = class {
   constructor(client) {
@@ -828,10 +1069,12 @@ var CheckoutPageFieldsResource = class {
 };
 var CheckoutPagesResource = class {
   fields;
+  orderBumps;
   client;
   constructor(client) {
     this.client = client;
     this.fields = new CheckoutPageFieldsResource(client);
+    this.orderBumps = new OrderBumpsResource(client, "checkout-pages");
   }
   async list(args = {}) {
     const query = {
@@ -839,7 +1082,8 @@ var CheckoutPagesResource = class {
       starting_after: args.starting_after,
       ending_before: args.ending_before,
       status: args.status,
-      search: args.search
+      search: args.search,
+      testmode: args.testmode?.toString()
     };
     return this.client.request({
       method: "GET",
@@ -1090,16 +1334,19 @@ var EventsResource = class {
     this.client = client;
     this.ticketGroups = new EventTicketGroupsResource(client);
     this.fields = new EventFieldsResource(client);
+    this.orderBumps = new OrderBumpsResource(client, "events");
   }
   ticketGroups;
   fields;
+  orderBumps;
   async list(args = {}) {
     const query = {
       limit: args.limit?.toString(),
       starting_after: args.starting_after,
       ending_before: args.ending_before,
       status: args.status,
-      search: args.search
+      search: args.search,
+      testmode: args.testmode?.toString()
     };
     return this.client.request({
       method: "GET",
@@ -1218,7 +1465,8 @@ var FormsResource = class {
       starting_after: args.starting_after,
       ending_before: args.ending_before,
       status: args.status,
-      search: args.search
+      search: args.search,
+      testmode: args.testmode?.toString()
     };
     return this.client.request({
       method: "GET",
@@ -1268,13 +1516,14 @@ var SubmissionResource = class {
   constructor(client) {
     this.client = client;
   }
-  async get(submissionId) {
+  async get(submissionId, options = {}) {
     if (!submissionId) {
       throw new Error("Submission ID is required");
     }
     return this.client.request({
       method: "GET",
-      path: `/v1/submissions/${submissionId}`
+      path: `/v1/submissions/${submissionId}`,
+      query: { livemode: options.livemode?.toString() }
     });
   }
   async list(args = {}) {
@@ -1285,6 +1534,7 @@ var SubmissionResource = class {
       status: args.status,
       createdAfter: args.createdAfter,
       createdBefore: args.createdBefore,
+      livemode: args.livemode?.toString(),
       limit: args.limit?.toString(),
       starting_after: args.starting_after,
       ending_before: args.ending_before
@@ -1340,6 +1590,16 @@ var TaxRateResource = class {
       body
     });
   }
+  /** Removes the rate from list(); pages and products that used it stop charging that tax. */
+  async delete(taxRateId) {
+    if (!taxRateId) {
+      throw new Error("Tax rate ID is required");
+    }
+    return this.client.request({
+      method: "DELETE",
+      path: `/v1/tax-rates/${taxRateId}`
+    });
+  }
 };
 
 // src/resources/webhooks/webhooks.ts
@@ -1388,6 +1648,45 @@ var WebhookResource = class {
       body: params
     });
   }
+  /**
+   * Retrieve a webhook endpoint by id, with its events, status and delivery
+   * counters. The signing `secret` is not returned.
+   *
+   * @example
+   * const { data: webhook } = await client.webhooks.get('6a1f0c2e9b1d4a0012345678');
+   */
+  async get(webhookId) {
+    if (!webhookId) {
+      throw new Error("Webhook ID is required");
+    }
+    return this.client.request({
+      method: "GET",
+      path: `/v1/webhooks/${encodeURIComponent(webhookId)}`
+    });
+  }
+  /**
+   * Update a webhook endpoint. Only the fields you send change; `events` and
+   * `customHeaders` replace the existing values. Set `status` to `'inactive'`
+   * to pause deliveries and `'active'` to resume. A new `url` must use https
+   * and must not already be registered on another of your webhooks. The
+   * signing secret cannot be changed here.
+   *
+   * @example
+   * const { data: webhook } = await client.webhooks.update(webhookId, {
+   *   events: ['payment.paid', 'checkout_page.updated'],
+   *   status: 'inactive',
+   * });
+   */
+  async update(webhookId, params) {
+    if (!webhookId) {
+      throw new Error("Webhook ID is required");
+    }
+    return this.client.request({
+      method: "PATCH",
+      path: `/v1/webhooks/${encodeURIComponent(webhookId)}`,
+      body: params
+    });
+  }
   /**
    * Delete a webhook endpoint. Deliveries stop immediately; the returned
    * object is its final state. The webhook no longer appears in `list()`,
@@ -1404,6 +1703,105 @@ var WebhookResource = class {
   }
 };
 
+// src/resources/themes/themes.ts
+var ThemeResource = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * List the themes your pages can use, newest first: your own themes and the
+   * built-in (`global`) ones. A retired built-in theme is only listed while one
+   * of your pages uses it.
+   *
+   * @example
+   * const { data: themes, has_more } = await client.themes.list({ scope: 'seller' });
+   */
+  async list(args = {}) {
+    const query = {
+      scope: args.scope,
+      limit: args.limit?.toString(),
+      starting_after: args.starting_after,
+      ending_before: args.ending_before
+    };
+    return this.client.request({
+      method: "GET",
+      path: "/v1/themes/",
+      query
+    });
+  }
+  /**
+   * Retrieve one of your themes or a built-in theme.
+   *
+   * @example
+   * const { data: theme } = await client.themes.get(themeId);
+   */
+  async get(themeId) {
+    if (!themeId) {
+      throw new Error("Theme ID is required");
+    }
+    return this.client.request({
+      method: "GET",
+      path: `/v1/themes/${encodeURIComponent(themeId)}`
+    });
+  }
+  /**
+   * Create a theme. Pass `baseThemeId` to start from a copy of one of your
+   * themes or a built-in theme, then set what should differ in `variables`.
+   * `variables` takes the same shape as a page's `themeOverrides`. A copy of a
+   * built-in theme does not follow your store's brand colour, so set
+   * `tokens.colorPrimary` if you want it.
+   *
+   * @example
+   * const { data: theme } = await client.themes.create({
+   *   name: 'Brand',
+   *   baseThemeId: builtInThemeId,
+   *   variables: { tokens: { colorPrimary: { light: '#4f46e5' } } },
+   * });
+   */
+  async create(params) {
+    return this.client.request({
+      method: "POST",
+      path: "/v1/themes/",
+      body: params
+    });
+  }
+  /**
+   * Update one of your themes. Every page that uses it changes too. Keys left
+   * out of `variables` keep their value, and `null` resets a property or
+   * everything under a key. Built-in themes are read-only.
+   *
+   * @example
+   * const { data: theme } = await client.themes.update(themeId, {
+   *   variables: { tokens: { colorPrimary: { light: '#0f766e' } } },
+   * });
+   */
+  async update(themeId, params) {
+    if (!themeId) {
+      throw new Error("Theme ID is required");
+    }
+    return this.client.request({
+      method: "PATCH",
+      path: `/v1/themes/${encodeURIComponent(themeId)}`,
+      body: params
+    });
+  }
+  /**
+   * Delete one of your themes and return its final state. A theme that any of
+   * your pages uses, archived ones included, or that is your store's default
+   * theme, can't be deleted (a `ConflictError`): move those pages to another
+   * theme with `themeId` first.
+   */
+  async delete(themeId) {
+    if (!themeId) {
+      throw new Error("Theme ID is required");
+    }
+    return this.client.request({
+      method: "DELETE",
+      path: `/v1/themes/${encodeURIComponent(themeId)}`
+    });
+  }
+};
+
 // src/index.ts
 var CheckoutPageClient = class {
   accounts;
@@ -1423,6 +1821,7 @@ var CheckoutPageClient = class {
   taxRates;
   invoices;
   webhooks;
+  themes;
   client;
   constructor(options) {
     this.client = new CheckoutPageApiClient(options);
@@ -1443,6 +1842,7 @@ var CheckoutPageClient = class {
     this.taxRates = new TaxRateResource(this.client);
     this.invoices = new InvoiceResource(this.client);
     this.webhooks = new WebhookResource(this.client);
+    this.themes = new ThemeResource(this.client);
   }
 };
 var createCheckoutPageClient = (options) => {