@flexprice/sdk 2.1.38 → 2.1.39

package/src/funcs/subscriptions-pause-subscription.ts

@@ -0,0 +1,187 @@
+/*
+ * 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";
+
+/**
+ * Pause subscription
+ *
+ * @remarks
+ * Use when a customer stops temporarily. Pauses an active subscription now: usage and arrear fixed charges up to the pause are billed on a closing invoice, and every paused period after it gets a $0 skipped invoice.
+ */
+export function subscriptionsPauseSubscription(
+  client: FlexpriceCore,
+  id: string,
+  body: models.PauseSubscriptionRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.PauseSubscriptionResponse,
+    | 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.PauseSubscriptionRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.PauseSubscriptionResponse,
+      | models.ErrorsErrorResponse
+      | FlexPriceError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input: models.PauseSubscriptionRequestRequest = {
+    id: id,
+    body: body,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      z.parse(models.PauseSubscriptionRequestRequest$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("/subscriptions/{id}/pause")(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: "pauseSubscription",
+    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,
+    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.PauseSubscriptionResponse,
+    | models.ErrorsErrorResponse
+    | FlexPriceError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.PauseSubscriptionResponse$inboundSchema),
+    M.jsonErr([400, 404], 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-resume-subscription.ts

@@ -0,0 +1,187 @@
+/*
+ * 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";
+
+/**
+ * Resume subscription
+ *
+ * @remarks
+ * Use when a paused customer comes back. Resumes a paused subscription now on its existing billing anchor: the first period runs from the resume to the next billing date and its advance charges are invoiced at once.
+ */
+export function subscriptionsResumeSubscription(
+  client: FlexpriceCore,
+  id: string,
+  body: models.ResumeSubscriptionRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.ResumeSubscriptionResponse,
+    | 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.ResumeSubscriptionRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.ResumeSubscriptionResponse,
+      | models.ErrorsErrorResponse
+      | FlexPriceError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input: models.ResumeSubscriptionRequestRequest = {
+    id: id,
+    body: body,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      z.parse(models.ResumeSubscriptionRequestRequest$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("/subscriptions/{id}/resume")(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: "resumeSubscription",
+    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,
+    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.ResumeSubscriptionResponse,
+    | models.ErrorsErrorResponse
+    | FlexPriceError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.ResumeSubscriptionResponse$inboundSchema),
+    M.jsonErr([400, 404], 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/lib/config.ts

@@ -69,7 +69,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0",
-  sdkVersion: "2.1.38",
+  sdkVersion: "2.1.39",
   genVersion: "2.948.4",
-  userAgent: "speakeasy-sdk/typescript 2.1.38 2.948.4 1.0 @flexprice/sdk",
+  userAgent: "speakeasy-sdk/typescript 2.1.39 2.948.4 1.0 @flexprice/sdk",
 } as const;

package/src/sdk/models/index.ts

@@ -459,6 +459,9 @@ export * from "./override-line-item-request.js";
 export * from "./pagination-response.js";
 export * from "./pause-mode.js";
 export * from "./pause-status.js";
+export * from "./pause-subscription-op.js";
+export * from "./pause-subscription-request.js";
+export * from "./pause-subscription-response.js";
 export * from "./pay-invoice-params.js";
 export * from "./payment-action-type.js";
 export * from "./payment-action.js";
@@ -524,6 +527,9 @@ export * from "./reporting-unit.js";
 export * from "./reset-usage.js";
 export * from "./response-validation-error.js";
 export * from "./resume-mode.js";
+export * from "./resume-subscription-op.js";
+export * from "./resume-subscription-request.js";
+export * from "./resume-subscription-response.js";
 export * from "./retry-refund-op.js";
 export * from "./revenue-allocation-policy.js";
 export * from "./revenue-analytics-request.js";
@@ -592,6 +598,7 @@ export * from "./subscription-line-item-response.js";
 export * from "./subscription-modification-action.js";
 export * from "./subscription-modify-response.js";
 export * from "./subscription-modify-type.js";
+export * from "./subscription-pause-response.js";
 export * from "./subscription-phase-create-request.js";
 export * from "./subscription-phase-response.js";
 export * from "./subscription-price-create-request.js";

package/src/sdk/models/invoice-billing-reason.ts

@@ -15,6 +15,8 @@ export const InvoiceBillingReason = {
   Manual: "MANUAL",
   AutoInvoiceThreshold: "AUTO_INVOICE_THRESHOLD",
   WalletAutoTopup: "WALLET_AUTO_TOPUP",
+  SubscriptionPaused: "SUBSCRIPTION_PAUSED",
+  SubscriptionResume: "SUBSCRIPTION_RESUME",
 } as const;
 export type InvoiceBillingReason = ClosedEnum<typeof InvoiceBillingReason>;
 

package/src/sdk/models/pause-subscription-op.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import {
+  PauseSubscriptionRequest,
+  PauseSubscriptionRequest$Outbound,
+  PauseSubscriptionRequest$outboundSchema,
+} from "./pause-subscription-request.js";
+
+export type PauseSubscriptionRequestRequest = {
+  /**
+   * Subscription ID
+   */
+  id: string;
+  /**
+   * Pause subscription request
+   */
+  body: PauseSubscriptionRequest;
+};
+
+/** @internal */
+export type PauseSubscriptionRequestRequest$Outbound = {
+  id: string;
+  body: PauseSubscriptionRequest$Outbound;
+};
+
+/** @internal */
+export const PauseSubscriptionRequestRequest$outboundSchema: z.ZodMiniType<
+  PauseSubscriptionRequestRequest$Outbound,
+  PauseSubscriptionRequestRequest
+> = z.object({
+  id: z.string(),
+  body: PauseSubscriptionRequest$outboundSchema,
+});
+
+export function pauseSubscriptionRequestRequestToJSON(
+  pauseSubscriptionRequestRequest: PauseSubscriptionRequestRequest,
+): string {
+  return JSON.stringify(
+    PauseSubscriptionRequestRequest$outboundSchema.parse(
+      pauseSubscriptionRequestRequest,
+    ),
+  );
+}

package/src/sdk/models/pause-subscription-request.ts

@@ -0,0 +1,64 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+import {
+  ProrationBehavior,
+  ProrationBehavior$outboundSchema,
+} from "./proration-behavior.js";
+
+/**
+ * Pauses an active subscription now. Usage and arrear fixed charges up to the pause are billed on a closing invoice.
+ */
+export type PauseSubscriptionRequest = {
+  /**
+   * Metadata stored on the pause
+   *
+   * @remarks
+   * @Example {"requested_by": "customer", "channel": "support_ticket"}
+   */
+  metadata?: { [k: string]: string } | undefined;
+  prorationBehavior?: ProrationBehavior | undefined;
+  /**
+   * Reason for pausing the subscription
+   *
+   * @remarks
+   * @Description Optional reason for the pause. Maximum 255 characters
+   * @Example "Customer requested temporary suspension"
+   */
+  reason?: string | undefined;
+};
+
+/** @internal */
+export type PauseSubscriptionRequest$Outbound = {
+  metadata?: { [k: string]: string } | undefined;
+  proration_behavior?: string | undefined;
+  reason?: string | undefined;
+};
+
+/** @internal */
+export const PauseSubscriptionRequest$outboundSchema: z.ZodMiniType<
+  PauseSubscriptionRequest$Outbound,
+  PauseSubscriptionRequest
+> = z.pipe(
+  z.object({
+    metadata: z.optional(z.record(z.string(), z.string())),
+    prorationBehavior: z.optional(ProrationBehavior$outboundSchema),
+    reason: z.optional(z.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      prorationBehavior: "proration_behavior",
+    });
+  }),
+);
+
+export function pauseSubscriptionRequestToJSON(
+  pauseSubscriptionRequest: PauseSubscriptionRequest,
+): string {
+  return JSON.stringify(
+    PauseSubscriptionRequest$outboundSchema.parse(pauseSubscriptionRequest),
+  );
+}

package/src/sdk/models/pause-subscription-response.ts

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+import {
+  SubscriptionPauseResponse,
+  SubscriptionPauseResponse$inboundSchema,
+} from "./subscription-pause-response.js";
+import {
+  SubscriptionResponse,
+  SubscriptionResponse$inboundSchema,
+} from "./subscription-response.js";
+
+/**
+ * The paused subscription and its pause
+ */
+export type PauseSubscriptionResponse = {
+  /**
+   * Response object containing subscription pause information
+   */
+  pause?: SubscriptionPauseResponse | undefined;
+  subscription?: SubscriptionResponse | undefined;
+};
+
+/** @internal */
+export const PauseSubscriptionResponse$inboundSchema: z.ZodMiniType<
+  PauseSubscriptionResponse,
+  unknown
+> = z.object({
+  pause: types.optional(SubscriptionPauseResponse$inboundSchema),
+  subscription: types.optional(SubscriptionResponse$inboundSchema),
+});
+
+export function pauseSubscriptionResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PauseSubscriptionResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PauseSubscriptionResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PauseSubscriptionResponse' from JSON`,
+  );
+}

package/src/sdk/models/resume-subscription-op.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import {
+  ResumeSubscriptionRequest,
+  ResumeSubscriptionRequest$Outbound,
+  ResumeSubscriptionRequest$outboundSchema,
+} from "./resume-subscription-request.js";
+
+export type ResumeSubscriptionRequestRequest = {
+  /**
+   * Subscription ID
+   */
+  id: string;
+  /**
+   * Resume subscription request
+   */
+  body: ResumeSubscriptionRequest;
+};
+
+/** @internal */
+export type ResumeSubscriptionRequestRequest$Outbound = {
+  id: string;
+  body: ResumeSubscriptionRequest$Outbound;
+};
+
+/** @internal */
+export const ResumeSubscriptionRequestRequest$outboundSchema: z.ZodMiniType<
+  ResumeSubscriptionRequestRequest$Outbound,
+  ResumeSubscriptionRequestRequest
+> = z.object({
+  id: z.string(),
+  body: ResumeSubscriptionRequest$outboundSchema,
+});
+
+export function resumeSubscriptionRequestRequestToJSON(
+  resumeSubscriptionRequestRequest: ResumeSubscriptionRequestRequest,
+): string {
+  return JSON.stringify(
+    ResumeSubscriptionRequestRequest$outboundSchema.parse(
+      resumeSubscriptionRequestRequest,
+    ),
+  );
+}

package/src/sdk/models/resume-subscription-request.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+import {
+  ProrationBehavior,
+  ProrationBehavior$outboundSchema,
+} from "./proration-behavior.js";
+
+/**
+ * Resumes a paused subscription now. The billing anchor is kept, so the first period runs from the resume time to the next billing date.
+ */
+export type ResumeSubscriptionRequest = {
+  /**
+   * Metadata merged into the pause
+   *
+   * @remarks
+   * @Example {"resumed_by": "admin"}
+   */
+  metadata?: { [k: string]: string } | undefined;
+  prorationBehavior?: ProrationBehavior | undefined;
+};
+
+/** @internal */
+export type ResumeSubscriptionRequest$Outbound = {
+  metadata?: { [k: string]: string } | undefined;
+  proration_behavior?: string | undefined;
+};
+
+/** @internal */
+export const ResumeSubscriptionRequest$outboundSchema: z.ZodMiniType<
+  ResumeSubscriptionRequest$Outbound,
+  ResumeSubscriptionRequest
+> = z.pipe(
+  z.object({
+    metadata: z.optional(z.record(z.string(), z.string())),
+    prorationBehavior: z.optional(ProrationBehavior$outboundSchema),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      prorationBehavior: "proration_behavior",
+    });
+  }),
+);
+
+export function resumeSubscriptionRequestToJSON(
+  resumeSubscriptionRequest: ResumeSubscriptionRequest,
+): string {
+  return JSON.stringify(
+    ResumeSubscriptionRequest$outboundSchema.parse(resumeSubscriptionRequest),
+  );
+}