@flexprice/sdk 2.1.30 → 2.1.34

package/src/funcs/fx-rates-update-fx-rate.ts

@@ -0,0 +1,186 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { FlexpriceCore } from "../core.js";
+import { encodeJSON, encodeSimple } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { FlexPriceError } from "../sdk/models/flex-price-error.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../sdk/models/http-client-errors.js";
+import * as models from "../sdk/models/index.js";
+import { ResponseValidationError } from "../sdk/models/response-validation-error.js";
+import { SDKValidationError } from "../sdk/models/sdk-validation-error.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Update an FX rate
+ *
+ * @remarks
+ * Update a rate's value, validity window (overrides only) or metadata. Scope, scope_id and the currency pair are immutable.
+ */
+export function fxRatesUpdateFXRate(
+  client: FlexpriceCore,
+  id: string,
+  body: models.UpdateFXRateRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.FXRateResponse,
+    | models.ErrorsErrorResponse
+    | FlexPriceError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    id,
+    body,
+    options,
+  ));
+}
+
+async function $do(
+  client: FlexpriceCore,
+  id: string,
+  body: models.UpdateFXRateRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.FXRateResponse,
+      | models.ErrorsErrorResponse
+      | FlexPriceError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input: models.UpdateFXRateRequestRequest = {
+    id: id,
+    body: body,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) => z.parse(models.UpdateFXRateRequestRequest$outboundSchema, value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body$ = encodeJSON("body", payload.body, { explode: true });
+
+  const pathParams = {
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/forex/{id}")(pathParams);
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKeyAuth);
+  const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "updateFXRate",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "PUT",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body$,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    models.FXRateResponse,
+    | models.ErrorsErrorResponse
+    | FlexPriceError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.FXRateResponse$inboundSchema),
+    M.jsonErr(400, models.ErrorsErrorResponse$inboundSchema),
+    M.jsonErr(500, models.ErrorsErrorResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/invoices-create-invoice.ts

@@ -31,6 +31,7 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  * Use when creating a manual or one-off invoice (e.g. custom charge or non-recurring billing). Invoice is created in draft; finalize when ready.
+ * Pass a `checkout` object to gate the invoice behind a hosted payment session: the invoice stays DRAFT with no invoice number, and the response carries `checkout_session.payment_action.url` for the customer to pay. It finalizes only when the payment webhook lands; if the session expires the invoice is voided and archived. Poll `GET /checkout/sessions/{id}` until `terminal` is true. One-off invoices only.
  */
 export function invoicesCreateInvoice(
   client: FlexpriceCore,

package/src/funcs/subscriptions-execute-subscription-modify.ts

@@ -30,7 +30,8 @@ import { Result } from "../types/fp.js";
  * Execute subscription modification
  *
  * @remarks
- * Execute a mid-cycle subscription modification (inheritance, quantity change, grouped invoicing, trial end, coupon, tax, or addon add/remove).
+ * Execute a mid-cycle subscription modification (inheritance, line item change, grouped invoicing, trial end, coupon, tax, a single addon add/remove, or a batch of addon adds and removes settled as one netted document).
+ * Type "quantity_change" is deprecated: use "line_item_change", which changes a fixed charge's quantity, price, or both, with the same proration and checkout behaviour.
  */
 export function subscriptionsExecuteSubscriptionModify(
   client: FlexpriceCore,

package/src/funcs/subscriptions-list-all-subscription-schedules.ts

@@ -34,10 +34,7 @@ import { Result } from "../types/fp.js";
  */
 export function subscriptionsListAllSubscriptionSchedules(
   client: FlexpriceCore,
-  pendingOnly?: boolean | undefined,
-  subscriptionId?: string | undefined,
-  limit?: number | undefined,
-  offset?: number | undefined,
+  request?: models.ListAllSubscriptionSchedulesRequest | undefined,
   options?: RequestOptions,
 ): APIPromise<
   Result<
@@ -54,20 +51,14 @@ export function subscriptionsListAllSubscriptionSchedules(
 > {
   return new APIPromise($do(
     client,
-    pendingOnly,
-    subscriptionId,
-    limit,
-    offset,
+    request,
     options,
   ));
 }
 
 async function $do(
   client: FlexpriceCore,
-  pendingOnly?: boolean | undefined,
-  subscriptionId?: string | undefined,
-  limit?: number | undefined,
-  offset?: number | undefined,
+  request?: models.ListAllSubscriptionSchedulesRequest | undefined,
   options?: RequestOptions,
 ): Promise<
   [
@@ -85,15 +76,8 @@ async function $do(
     APICall,
   ]
 > {
-  const input: models.ListAllSubscriptionSchedulesRequest | undefined = {
-    pendingOnly: pendingOnly,
-    subscriptionId: subscriptionId,
-    limit: limit,
-    offset: offset,
-  };
-
   const parsed = safeParse(
-    input,
+    request,
     (value) =>
       z.parse(
         z.optional(models.ListAllSubscriptionSchedulesRequest$outboundSchema),
@@ -113,7 +97,10 @@ async function $do(
     "limit": payload?.limit,
     "offset": payload?.offset,
     "pending_only": payload?.pending_only,
+    "schedule_status": payload?.schedule_status,
+    "schedule_type": payload?.schedule_type,
     "subscription_id": payload?.subscription_id,
+    "subscription_ids": payload?.subscription_ids,
   });
 
   const headers = new Headers(compactMap({

package/src/funcs/subscriptions-preview-subscription-modify.ts

@@ -30,7 +30,8 @@ import { Result } from "../types/fp.js";
  * Preview subscription modification
  *
  * @remarks
- * Preview the impact of a mid-cycle subscription modification (inheritance, quantity change, grouped invoicing, trial end, coupon, tax, or addon add/remove) without committing changes.
+ * Preview the impact of a mid-cycle subscription modification (inheritance, line item change, grouped invoicing, trial end, coupon, tax, a single addon add/remove, or a batch of addon adds and removes) without committing changes.
+ * Type "quantity_change" is deprecated: use "line_item_change".
  */
 export function subscriptionsPreviewSubscriptionModify(
   client: FlexpriceCore,

package/src/funcs/webhook-events-post-webhook-events-invoice-sync-failed.ts

@@ -0,0 +1,144 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { FlexpriceCore } from "../core.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { FlexPriceError } from "../sdk/models/flex-price-error.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../sdk/models/http-client-errors.js";
+import * as models from "../sdk/models/index.js";
+import { ResponseValidationError } from "../sdk/models/response-validation-error.js";
+import { SDKValidationError } from "../sdk/models/sdk-validation-error.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * invoice.sync.failed
+ *
+ * @remarks
+ * Fired once per provider when an invoice sync fails after its last retry.
+ */
+export function webhookEventsPostWebhookEventsInvoiceSyncFailed(
+  client: FlexpriceCore,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.WebhookDtoInvoiceSyncWebhookPayload,
+    | FlexPriceError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    options,
+  ));
+}
+
+async function $do(
+  client: FlexpriceCore,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.WebhookDtoInvoiceSyncWebhookPayload,
+      | FlexPriceError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const path = pathToFunc("/webhook-events/invoice.sync.failed")();
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKeyAuth);
+  const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "post_/webhook-events/invoice.sync.failed",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    models.WebhookDtoInvoiceSyncWebhookPayload,
+    | FlexPriceError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.WebhookDtoInvoiceSyncWebhookPayload$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/webhook-events-post-webhook-events-invoice-sync-success.ts

@@ -0,0 +1,144 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { FlexpriceCore } from "../core.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { FlexPriceError } from "../sdk/models/flex-price-error.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../sdk/models/http-client-errors.js";
+import * as models from "../sdk/models/index.js";
+import { ResponseValidationError } from "../sdk/models/response-validation-error.js";
+import { SDKValidationError } from "../sdk/models/sdk-validation-error.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * invoice.sync.success
+ *
+ * @remarks
+ * Fired once per provider when an invoice is synced to that provider.
+ */
+export function webhookEventsPostWebhookEventsInvoiceSyncSuccess(
+  client: FlexpriceCore,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.WebhookDtoInvoiceSyncWebhookPayload,
+    | FlexPriceError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    options,
+  ));
+}
+
+async function $do(
+  client: FlexpriceCore,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.WebhookDtoInvoiceSyncWebhookPayload,
+      | FlexPriceError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const path = pathToFunc("/webhook-events/invoice.sync.success")();
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKeyAuth);
+  const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "post_/webhook-events/invoice.sync.success",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    models.WebhookDtoInvoiceSyncWebhookPayload,
+    | FlexPriceError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.WebhookDtoInvoiceSyncWebhookPayload$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -65,7 +65,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0",
-  sdkVersion: "2.1.30",
-  genVersion: "2.935.1",
-  userAgent: "speakeasy-sdk/typescript 2.1.30 2.935.1 1.0 @flexprice/sdk",
+  sdkVersion: "2.1.34",
+  genVersion: "2.943.0",
+  userAgent: "speakeasy-sdk/typescript 2.1.34 2.943.0 1.0 @flexprice/sdk",
 } as const;

package/src/sdk/analytics.ts

@@ -0,0 +1,83 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { analyticsCreateAnalyticsView } from "../funcs/analytics-create-analytics-view.js";
+import { analyticsGetRevenueAnalytics } from "../funcs/analytics-get-revenue-analytics.js";
+import { analyticsQueryAnalyticsView } from "../funcs/analytics-query-analytics-view.js";
+import { analyticsQueryAnalytics } from "../funcs/analytics-query-analytics.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import { unwrapAsync } from "../types/fp.js";
+import * as models from "./models/index.js";
+
+export class Analytics extends ClientSDK {
+  /**
+   * Run an ad-hoc analytics query
+   *
+   * @remarks
+   * Resolves the given view definition against the supplied variables and executes it.
+   */
+  async queryAnalytics(
+    request: models.AnalyticsQueryRequest,
+    options?: RequestOptions,
+  ): Promise<models.AnalyticsQueryResult> {
+    return unwrapAsync(analyticsQueryAnalytics(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Query revenue analytics
+   *
+   * @remarks
+   * Aggregates revenue_facts by the requested dimensions at day/period/total granularity. allocation_policy places whole-period charges on their booked day (billed) or spreads them across the period (amortized); include_adjustments breaks out true-up/overage/revert amounts as labeled rows. Requires the tenant's revenue analytics setting.
+   */
+  async getRevenueAnalytics(
+    request: models.RevenueAnalyticsRequest,
+    options?: RequestOptions,
+  ): Promise<models.RevenueAnalyticsResponse> {
+    return unwrapAsync(analyticsGetRevenueAnalytics(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create an analytics view
+   *
+   * @remarks
+   * Persists a named view definition that can later be queried by ID.
+   */
+  async createAnalyticsView(
+    request: models.CreateViewRequest,
+    options?: RequestOptions,
+  ): Promise<models.ViewResponse> {
+    return unwrapAsync(analyticsCreateAnalyticsView(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Query an analytics view
+   *
+   * @remarks
+   * Resolves the view's definition against the supplied variables and executes it.
+   */
+  async queryAnalyticsView(
+    id: string,
+    body: models.ViewQueryRequest,
+    options?: RequestOptions,
+  ): Promise<models.AnalyticsQueryResult> {
+    return unwrapAsync(analyticsQueryAnalyticsView(
+      this,
+      id,
+      body,
+      options,
+    ));
+  }
+}

package/src/sdk/checkout.ts

@@ -2,6 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { checkoutCancelCheckoutSession } from "../funcs/checkout-cancel-checkout-session.js";
 import { checkoutCreateCheckoutSession } from "../funcs/checkout-create-checkout-session.js";
 import { checkoutDeleteCheckoutSession } from "../funcs/checkout-delete-checkout-session.js";
 import { checkoutGetCheckoutSession } from "../funcs/checkout-get-checkout-session.js";
@@ -51,4 +52,18 @@ export class Checkout extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Cancel checkout session
+   */
+  async cancelCheckoutSession(
+    id: string,
+    options?: RequestOptions,
+  ): Promise<models.CheckoutSessionResponse> {
+    return unwrapAsync(checkoutCancelCheckoutSession(
+      this,
+      id,
+      options,
+    ));
+  }
 }