@flexprice/sdk 2.1.39 → 2.1.40

package/src/funcs/customers-create-customer-portal-session.ts

@@ -0,0 +1,182 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { FlexpriceCore } from "../core.js";
+import { 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";
+
+/**
+ * Create customer portal session
+ *
+ * @remarks
+ * Use when sending a customer to their self-serve billing portal (invoices, usage, payment methods). Returns a short-lived URL and token scoped to that customer.
+ */
+export function customersCreateCustomerPortalSession(
+  client: FlexpriceCore,
+  externalId: string,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.PortalSessionResponse,
+    | models.ErrorsErrorResponse
+    | FlexPriceError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    externalId,
+    options,
+  ));
+}
+
+async function $do(
+  client: FlexpriceCore,
+  externalId: string,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.PortalSessionResponse,
+      | models.ErrorsErrorResponse
+      | FlexPriceError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input: models.CreateCustomerPortalSessionRequest = {
+    externalId: externalId,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      z.parse(models.CreateCustomerPortalSessionRequest$outboundSchema, value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    external_id: encodeSimple("external_id", payload.external_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/customers/portal/{external_id}")(pathParams);
+
+  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: "createCustomerPortalSession",
+    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: "GET",
+    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.PortalSessionResponse,
+    | models.ErrorsErrorResponse
+    | FlexPriceError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.PortalSessionResponse$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.39",
+  sdkVersion: "2.1.40",
   genVersion: "2.948.4",
-  userAgent: "speakeasy-sdk/typescript 2.1.39 2.948.4 1.0 @flexprice/sdk",
+  userAgent: "speakeasy-sdk/typescript 2.1.40 2.948.4 1.0 @flexprice/sdk",
 } as const;

package/src/sdk/customers.ts

@@ -2,6 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { customersCreateCustomerPortalSession } from "../funcs/customers-create-customer-portal-session.js";
 import { customersCreateCustomer } from "../funcs/customers-create-customer.js";
 import { customersDeleteCustomer } from "../funcs/customers-delete-customer.js";
 import { customersGetCustomerByExternalId } from "../funcs/customers-get-customer-by-external-id.js";
@@ -110,6 +111,23 @@ export class Customers extends ClientSDK {
     ));
   }
 
+  /**
+   * Create customer portal session
+   *
+   * @remarks
+   * Use when sending a customer to their self-serve billing portal (invoices, usage, payment methods). Returns a short-lived URL and token scoped to that customer.
+   */
+  async createCustomerPortalSession(
+    externalId: string,
+    options?: RequestOptions,
+  ): Promise<models.PortalSessionResponse> {
+    return unwrapAsync(customersCreateCustomerPortalSession(
+      this,
+      externalId,
+      options,
+    ));
+  }
+
   /**
    * Query customers
    *

package/src/sdk/models/analytics-view-definition.ts

@@ -30,6 +30,11 @@ import {
   AnalyticsVariable$Outbound,
   AnalyticsVariable$outboundSchema,
 } from "./analytics-variable.js";
+import {
+  Family,
+  Family$inboundSchema,
+  Family$outboundSchema,
+} from "./family.js";
 import {
   Metric,
   Metric$inboundSchema,
@@ -40,6 +45,7 @@ import { Shape, Shape$inboundSchema, Shape$outboundSchema } from "./shape.js";
 
 export type AnalyticsViewDefinition = {
   dimensions?: Array<string> | undefined;
+  family?: Family | undefined;
   filters?: Array<AnalyticsFilter> | undefined;
   limit?: number | undefined;
   metrics: Array<Metric>;
@@ -55,6 +61,7 @@ export const AnalyticsViewDefinition$inboundSchema: z.ZodMiniType<
   unknown
 > = z.object({
   dimensions: types.optional(z.array(types.string())),
+  family: types.optional(Family$inboundSchema),
   filters: types.optional(z.array(AnalyticsFilter$inboundSchema)),
   limit: types.optional(types.number()),
   metrics: z.array(Metric$inboundSchema),
@@ -66,6 +73,7 @@ export const AnalyticsViewDefinition$inboundSchema: z.ZodMiniType<
 /** @internal */
 export type AnalyticsViewDefinition$Outbound = {
   dimensions?: Array<string> | undefined;
+  family?: string | undefined;
   filters?: Array<AnalyticsFilter$Outbound> | undefined;
   limit?: number | undefined;
   metrics: Array<string>;
@@ -81,6 +89,7 @@ export const AnalyticsViewDefinition$outboundSchema: z.ZodMiniType<
   AnalyticsViewDefinition
 > = z.object({
   dimensions: z.optional(z.array(z.string())),
+  family: z.optional(Family$outboundSchema),
   filters: z.optional(z.array(AnalyticsFilter$outboundSchema)),
   limit: z.optional(z.int()),
   metrics: z.array(Metric$outboundSchema),

package/src/sdk/models/create-customer-portal-session-op.ts

@@ -0,0 +1,43 @@
+/*
+ * 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";
+
+export type CreateCustomerPortalSessionRequest = {
+  /**
+   * Customer external ID
+   */
+  externalId: string;
+};
+
+/** @internal */
+export type CreateCustomerPortalSessionRequest$Outbound = {
+  external_id: string;
+};
+
+/** @internal */
+export const CreateCustomerPortalSessionRequest$outboundSchema: z.ZodMiniType<
+  CreateCustomerPortalSessionRequest$Outbound,
+  CreateCustomerPortalSessionRequest
+> = z.pipe(
+  z.object({
+    externalId: z.string(),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      externalId: "external_id",
+    });
+  }),
+);
+
+export function createCustomerPortalSessionRequestToJSON(
+  createCustomerPortalSessionRequest: CreateCustomerPortalSessionRequest,
+): string {
+  return JSON.stringify(
+    CreateCustomerPortalSessionRequest$outboundSchema.parse(
+      createCustomerPortalSessionRequest,
+    ),
+  );
+}

package/src/sdk/models/family.ts

@@ -0,0 +1,20 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+export const Family = {
+  Usage: "usage",
+  Billing: "billing",
+} as const;
+export type Family = OpenEnum<typeof Family>;
+
+/** @internal */
+export const Family$inboundSchema: z.ZodMiniType<Family, unknown> = openEnums
+  .inboundSchema(Family);
+/** @internal */
+export const Family$outboundSchema: z.ZodMiniType<string, Family> = openEnums
+  .outboundSchema(Family);

package/src/sdk/models/index.ts

@@ -134,6 +134,7 @@ export * from "./create-coupon-request.js";
 export * from "./create-credit-grant-request.js";
 export * from "./create-credit-note-line-item-request.js";
 export * from "./create-credit-note-request.js";
+export * from "./create-customer-portal-session-op.js";
 export * from "./create-customer-request.js";
 export * from "./create-entitlement-request.js";
 export * from "./create-entity-integration-mapping-request.js";
@@ -258,6 +259,7 @@ export * from "./external-tax-details.js";
 export * from "./fact-status.js";
 export * from "./failure-point-type.js";
 export * from "./failure-point.js";
+export * from "./family.js";
 export * from "./feature-filter.js";
 export * from "./feature-response.js";
 export * from "./feature-type.js";
@@ -483,6 +485,7 @@ export * from "./plan-response.js";
 export * from "./plan-summary.js";
 export * from "./plan.js";
 export * from "./point-bucket.js";
+export * from "./portal-session-response.js";
 export * from "./preview-subscription-change-op.js";
 export * from "./preview-subscription-modify-op.js";
 export * from "./preview-subscription-plan-change-v2-op.js";

package/src/sdk/models/metric.ts

@@ -9,6 +9,7 @@ import { OpenEnum } from "../../types/enums.js";
 export const Metric = {
   UsageQuantity: "usage_quantity",
   EventCount: "event_count",
+  InvoiceTotal: "invoice_total",
 } as const;
 export type Metric = OpenEnum<typeof Metric>;
 

package/src/sdk/models/modify-subscription-params.ts

@@ -18,6 +18,10 @@ export type ModifySubscriptionParams = {
   lineItemModifications?: Array<ModifySubscriptionLineItem> | undefined;
   modifyType?: ModifySubscriptionType | undefined;
   subscriptionId?: string | undefined;
+  /**
+   * TrialEndAt is where a trial_end checkout starts the first paid period.
+   */
+  trialEndAt?: Date | undefined;
 };
 
 /** @internal */
@@ -27,6 +31,7 @@ export type ModifySubscriptionParams$Outbound = {
     | undefined;
   modify_type?: string | undefined;
   subscription_id?: string | undefined;
+  trial_end_at?: string | undefined;
 };
 
 /** @internal */
@@ -40,12 +45,14 @@ export const ModifySubscriptionParams$outboundSchema: z.ZodMiniType<
     ),
     modifyType: z.optional(ModifySubscriptionType$outboundSchema),
     subscriptionId: z.optional(z.string()),
+    trialEndAt: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
   }),
   z.transform((v) => {
     return remap$(v, {
       lineItemModifications: "line_item_modifications",
       modifyType: "modify_type",
       subscriptionId: "subscription_id",
+      trialEndAt: "trial_end_at",
     });
   }),
 );

package/src/sdk/models/modify-subscription-type.ts

@@ -8,6 +8,7 @@ import { ClosedEnum } from "../../types/enums.js";
 export const ModifySubscriptionType = {
   QuantityChange: "quantity_change",
   LineItemChange: "line_item_change",
+  TrialEnd: "trial_end",
 } as const;
 export type ModifySubscriptionType = ClosedEnum<typeof ModifySubscriptionType>;
 

package/src/sdk/models/portal-session-response.ts

@@ -0,0 +1,43 @@
+/*
+ * 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 { 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";
+
+export type PortalSessionResponse = {
+  expiresAt?: Date | undefined;
+  token?: string | undefined;
+  url?: string | undefined;
+};
+
+/** @internal */
+export const PortalSessionResponse$inboundSchema: z.ZodMiniType<
+  PortalSessionResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    expires_at: types.optional(types.date()),
+    token: types.optional(types.string()),
+    url: types.optional(types.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "expires_at": "expiresAt",
+    });
+  }),
+);
+
+export function portalSessionResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PortalSessionResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PortalSessionResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PortalSessionResponse' from JSON`,
+  );
+}

package/src/sdk/models/shape.ts

@@ -9,6 +9,7 @@ import { OpenEnum } from "../../types/enums.js";
 export const Shape = {
   Timeseries: "timeseries",
   Breakdown: "breakdown",
+  Scalar: "scalar",
 } as const;
 export type Shape = OpenEnum<typeof Shape>;