@flexprice/sdk 2.1.33 → 2.1.35

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/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/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/hooks/auth-headers.ts

@@ -0,0 +1,47 @@
+import type { BeforeRequestContext, BeforeRequestHook } from "./types.js";
+
+type Credential = string | (() => string | undefined | Promise<string | undefined>) | undefined;
+
+// One environment per API call. Every attempt of a call gets the same context, so retries reuse it.
+const environmentByCall = new WeakMap<BeforeRequestContext, string | undefined>();
+
+async function resolveCredential(value: Credential): Promise<string | undefined> {
+  const resolved = typeof value === "function" ? await value() : value;
+  return resolved || undefined;
+}
+
+async function environmentFor(
+  hookCtx: BeforeRequestContext,
+  environmentId: Credential,
+): Promise<string | undefined> {
+  if (!environmentByCall.has(hookCtx)) {
+    environmentByCall.set(hookCtx, await resolveCredential(environmentId));
+  }
+  return environmentByCall.get(hookCtx);
+}
+
+/** Sends bearerAuth and environmentId as headers. Headers passed on a call take precedence. */
+export const authHeadersHook: BeforeRequestHook = {
+  async beforeRequest(hookCtx, request) {
+    const { apiKeyAuth, bearerAuth, environmentId } = hookCtx.options;
+    if (apiKeyAuth && bearerAuth) {
+      throw new Error("set either apiKeyAuth or bearerAuth, not both.");
+    }
+
+    if (!request.headers.has("Authorization")) {
+      const token = await resolveCredential(bearerAuth);
+      if (token) {
+        request.headers.set("Authorization", `Bearer ${token}`);
+      }
+    }
+
+    if (!request.headers.has("X-Environment-ID")) {
+      const envId = await environmentFor(hookCtx, environmentId);
+      if (envId) {
+        request.headers.set("X-Environment-ID", envId);
+      }
+    }
+
+    return request;
+  },
+};

package/src/hooks/registration.ts

@@ -1,9 +1,9 @@
+import { authHeadersHook } from "./auth-headers.js";
 import type { Hooks } from "./types.js";
 
 /**
- * No-op hook registration. The generated SDK calls initHooks(this) from hooks/hooks.ts.
- * Customize here only if you need to register debug or instrumentation hooks.
+ * Registers FlexPrice's custom hooks. The generated SDK calls initHooks(this) from hooks/hooks.ts.
  */
-export function initHooks(_hooks: Hooks): void {
-  // No hooks registered.
+export function initHooks(hooks: Hooks): void {
+  hooks.registerBeforeRequestHook(authHeadersHook);
 }

package/src/lib/config.ts

@@ -23,6 +23,10 @@ export const ServerList = [
 
 export type SDKOptions = {
   apiKeyAuth?: string | (() => Promise<string>) | undefined;
+  /** Signed-in user's JWT, sent as `Authorization: Bearer <token>`. Use instead of apiKeyAuth. */
+  bearerAuth?: string | (() => string | undefined | Promise<string | undefined>) | undefined;
+  /** Sent as `X-Environment-ID`. Needed with bearerAuth on environment-scoped endpoints. */
+  environmentId?: string | (() => string | undefined | Promise<string | undefined>) | undefined;
 
   httpClient?: HTTPClient;
   /**
@@ -65,7 +69,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0",
-  sdkVersion: "2.1.33",
-  genVersion: "2.941.0",
-  userAgent: "speakeasy-sdk/typescript 2.1.33 2.941.0 1.0 @flexprice/sdk",
+  sdkVersion: "2.1.35",
+  genVersion: "2.946.0",
+  userAgent: "speakeasy-sdk/typescript 2.1.35 2.946.0 1.0 @flexprice/sdk",
 } as const;

package/src/sdk/customers.ts

@@ -11,6 +11,7 @@ import { customersGetCustomerUpcomingGrants } from "../funcs/customers-get-custo
 import { customersGetCustomerUsageSummary } from "../funcs/customers-get-customer-usage-summary.js";
 import { customersGetCustomer } from "../funcs/customers-get-customer.js";
 import { customersGetSubscriptionsForCustomer } from "../funcs/customers-get-subscriptions-for-customer.js";
+import { customersListCustomerPaymentMethods } from "../funcs/customers-list-customer-payment-methods.js";
 import { customersQueryCustomer } from "../funcs/customers-query-customer.js";
 import { customersUpdateCustomer } from "../funcs/customers-update-customer.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
@@ -210,4 +211,23 @@ export class Customers extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * List customer payment methods
+   *
+   * @remarks
+   * Use when you need a customer's saved payment methods across every connected gateway, including whether each can be auto-charged. Only gateways that can list saved methods are included.
+   */
+  async listCustomerPaymentMethods(
+    id: string,
+    providers?: Array<string> | undefined,
+    options?: RequestOptions,
+  ): Promise<models.SavedPaymentMethodsResponse> {
+    return unwrapAsync(customersListCustomerPaymentMethods(
+      this,
+      id,
+      providers,
+      options,
+    ));
+  }
 }