@flexprice/sdk 2.1.48 → 2.1.49-dev.10

package/src/funcs/billing-entities-update-billing-entity.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";
+
+/**
+ * Update a billing entity
+ *
+ * @remarks
+ * Edit a billing entity. Drafts and future invoices use the new details; finalized invoices keep theirs.
+ */
+export function billingEntitiesUpdateBillingEntity(
+  client: FlexpriceCore,
+  id: string,
+  body: models.UpdateBillingEntityRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.BillingEntityResponse,
+    | 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.UpdateBillingEntityRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.BillingEntityResponse,
+      | models.ErrorsErrorResponse
+      | FlexPriceError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input: models.UpdateBillingEntityRequestRequest = {
+    id: id,
+    body: body,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      z.parse(models.UpdateBillingEntityRequestRequest$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("/billing-entities/{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: "updateBillingEntity",
+    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.BillingEntityResponse,
+    | models.ErrorsErrorResponse
+    | FlexPriceError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.BillingEntityResponse$inboundSchema),
+    M.jsonErr([400, 404, 409], 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-cancel-subscription.ts

@@ -174,7 +174,7 @@ async function $do(
     | SDKValidationError
   >(
     M.json(200, models.CancelSubscriptionResponse$inboundSchema),
-    M.jsonErr(400, models.ErrorsErrorResponse$inboundSchema),
+    M.jsonErr([400, 409], models.ErrorsErrorResponse$inboundSchema),
     M.jsonErr(500, models.ErrorsErrorResponse$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/src/lib/config.ts

@@ -77,7 +77,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0",
-  sdkVersion: "2.1.48",
+  sdkVersion: "2.1.49-dev.10",
   genVersion: "2.948.4",
-  userAgent: "speakeasy-sdk/typescript 2.1.48 2.948.4 1.0 @flexprice/sdk",
+  userAgent:
+    "speakeasy-sdk/typescript 2.1.49-dev.10 2.948.4 1.0 @flexprice/sdk",
 } as const;

package/src/sdk/billing-entities.ts

@@ -0,0 +1,115 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { billingEntitiesCreateBillingEntity } from "../funcs/billing-entities-create-billing-entity.js";
+import { billingEntitiesEnableBillingEntities } from "../funcs/billing-entities-enable-billing-entities.js";
+import { billingEntitiesGetBillingEntitiesStatus } from "../funcs/billing-entities-get-billing-entities-status.js";
+import { billingEntitiesGetBillingEntity } from "../funcs/billing-entities-get-billing-entity.js";
+import { billingEntitiesListBillingEntities } from "../funcs/billing-entities-list-billing-entities.js";
+import { billingEntitiesUpdateBillingEntity } from "../funcs/billing-entities-update-billing-entity.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import { unwrapAsync } from "../types/fp.js";
+import * as models from "./models/index.js";
+
+export class BillingEntities extends ClientSDK {
+  /**
+   * List billing entities
+   *
+   * @remarks
+   * List the billing entities of this environment.
+   */
+  async listBillingEntities(
+    request?: models.ListBillingEntitiesRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<models.ListBillingEntitiesResponse> {
+    return unwrapAsync(billingEntitiesListBillingEntities(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create a billing entity
+   *
+   * @remarks
+   * Create a legal entity that bills customers in this environment. Requires billing entities to be enabled.
+   */
+  async createBillingEntity(
+    request: models.CreateBillingEntityRequest,
+    options?: RequestOptions,
+  ): Promise<models.BillingEntityResponse> {
+    return unwrapAsync(billingEntitiesCreateBillingEntity(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Enable billing entities
+   *
+   * @remarks
+   * Start enabling billing entities in the environment. The environment gets a default entity and its existing customers are assigned to it. Irreversible.
+   */
+  async enableBillingEntities(
+    options?: RequestOptions,
+  ): Promise<models.BillingEntityModeResponse> {
+    return unwrapAsync(billingEntitiesEnableBillingEntities(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * Get billing entities status
+   *
+   * @remarks
+   * Whether billing entities are off, enabling or enabled in the environment.
+   */
+  async getBillingEntitiesStatus(
+    options?: RequestOptions,
+  ): Promise<models.BillingEntityModeResponse> {
+    return unwrapAsync(billingEntitiesGetBillingEntitiesStatus(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * Get a billing entity
+   *
+   * @remarks
+   * Load a single billing entity by ID.
+   */
+  async getBillingEntity(
+    id: string,
+    options?: RequestOptions,
+  ): Promise<models.BillingEntityResponse> {
+    return unwrapAsync(billingEntitiesGetBillingEntity(
+      this,
+      id,
+      options,
+    ));
+  }
+
+  /**
+   * Update a billing entity
+   *
+   * @remarks
+   * Edit a billing entity. Drafts and future invoices use the new details; finalized invoices keep theirs.
+   */
+  async updateBillingEntity(
+    id: string,
+    body: models.UpdateBillingEntityRequest,
+    options?: RequestOptions,
+  ): Promise<models.BillingEntityResponse> {
+    return unwrapAsync(billingEntitiesUpdateBillingEntity(
+      this,
+      id,
+      body,
+      options,
+    ));
+  }
+}

package/src/sdk/models/billing-address.ts

@@ -0,0 +1,91 @@
+/*
+ * 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 BillingAddress = {
+  addressCity?: string | undefined;
+  addressCountry?: string | undefined;
+  addressLine1?: string | undefined;
+  addressLine2?: string | undefined;
+  addressPostalCode?: string | undefined;
+  addressState?: string | undefined;
+};
+
+/** @internal */
+export const BillingAddress$inboundSchema: z.ZodMiniType<
+  BillingAddress,
+  unknown
+> = z.pipe(
+  z.object({
+    address_city: types.optional(types.string()),
+    address_country: types.optional(types.string()),
+    address_line1: types.optional(types.string()),
+    address_line2: types.optional(types.string()),
+    address_postal_code: types.optional(types.string()),
+    address_state: types.optional(types.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "address_city": "addressCity",
+      "address_country": "addressCountry",
+      "address_line1": "addressLine1",
+      "address_line2": "addressLine2",
+      "address_postal_code": "addressPostalCode",
+      "address_state": "addressState",
+    });
+  }),
+);
+/** @internal */
+export type BillingAddress$Outbound = {
+  address_city?: string | undefined;
+  address_country?: string | undefined;
+  address_line1?: string | undefined;
+  address_line2?: string | undefined;
+  address_postal_code?: string | undefined;
+  address_state?: string | undefined;
+};
+
+/** @internal */
+export const BillingAddress$outboundSchema: z.ZodMiniType<
+  BillingAddress$Outbound,
+  BillingAddress
+> = z.pipe(
+  z.object({
+    addressCity: z.optional(z.string()),
+    addressCountry: z.optional(z.string()),
+    addressLine1: z.optional(z.string()),
+    addressLine2: z.optional(z.string()),
+    addressPostalCode: z.optional(z.string()),
+    addressState: z.optional(z.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      addressCity: "address_city",
+      addressCountry: "address_country",
+      addressLine1: "address_line1",
+      addressLine2: "address_line2",
+      addressPostalCode: "address_postal_code",
+      addressState: "address_state",
+    });
+  }),
+);
+
+export function billingAddressToJSON(billingAddress: BillingAddress): string {
+  return JSON.stringify(BillingAddress$outboundSchema.parse(billingAddress));
+}
+export function billingAddressFromJSON(
+  jsonString: string,
+): SafeParseResult<BillingAddress, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BillingAddress$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BillingAddress' from JSON`,
+  );
+}

package/src/sdk/models/billing-details.ts

@@ -0,0 +1,79 @@
+/*
+ * 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 {
+  BillingAddress,
+  BillingAddress$inboundSchema,
+  BillingAddress$Outbound,
+  BillingAddress$outboundSchema,
+} from "./billing-address.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+
+export type BillingDetails = {
+  address?: BillingAddress | undefined;
+  email?: string | undefined;
+  helpEmail?: string | undefined;
+  phone?: string | undefined;
+};
+
+/** @internal */
+export const BillingDetails$inboundSchema: z.ZodMiniType<
+  BillingDetails,
+  unknown
+> = z.pipe(
+  z.object({
+    address: types.optional(BillingAddress$inboundSchema),
+    email: types.optional(types.string()),
+    help_email: types.optional(types.string()),
+    phone: types.optional(types.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "help_email": "helpEmail",
+    });
+  }),
+);
+/** @internal */
+export type BillingDetails$Outbound = {
+  address?: BillingAddress$Outbound | undefined;
+  email?: string | undefined;
+  help_email?: string | undefined;
+  phone?: string | undefined;
+};
+
+/** @internal */
+export const BillingDetails$outboundSchema: z.ZodMiniType<
+  BillingDetails$Outbound,
+  BillingDetails
+> = z.pipe(
+  z.object({
+    address: z.optional(BillingAddress$outboundSchema),
+    email: z.optional(z.string()),
+    helpEmail: z.optional(z.string()),
+    phone: z.optional(z.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      helpEmail: "help_email",
+    });
+  }),
+);
+
+export function billingDetailsToJSON(billingDetails: BillingDetails): string {
+  return JSON.stringify(BillingDetails$outboundSchema.parse(billingDetails));
+}
+export function billingDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<BillingDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BillingDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BillingDetails' from JSON`,
+  );
+}

package/src/sdk/models/billing-entity-mode-response.ts

@@ -0,0 +1,35 @@
+/*
+ * 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 {
+  BillingEntityMode,
+  BillingEntityMode$inboundSchema,
+} from "./billing-entity-mode.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+
+export type BillingEntityModeResponse = {
+  mode?: BillingEntityMode | undefined;
+};
+
+/** @internal */
+export const BillingEntityModeResponse$inboundSchema: z.ZodMiniType<
+  BillingEntityModeResponse,
+  unknown
+> = z.object({
+  mode: types.optional(BillingEntityMode$inboundSchema),
+});
+
+export function billingEntityModeResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<BillingEntityModeResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BillingEntityModeResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BillingEntityModeResponse' from JSON`,
+  );
+}

package/src/sdk/models/billing-entity-mode.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 BillingEntityMode = {
+  Off: "off",
+  Enabling: "enabling",
+  Enabled: "enabled",
+} as const;
+export type BillingEntityMode = OpenEnum<typeof BillingEntityMode>;
+
+/** @internal */
+export const BillingEntityMode$inboundSchema: z.ZodMiniType<
+  BillingEntityMode,
+  unknown
+> = openEnums.inboundSchema(BillingEntityMode);

package/src/sdk/models/billing-entity-response.ts

@@ -0,0 +1,76 @@
+/*
+ * 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 {
+  BillingDetails,
+  BillingDetails$inboundSchema,
+} from "./billing-details.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+import { Status, Status$inboundSchema } from "./status.js";
+
+export type BillingEntityResponse = {
+  billingDetails?: BillingDetails | undefined;
+  createdAt?: Date | undefined;
+  createdBy?: string | undefined;
+  environmentId?: string | undefined;
+  id?: string | undefined;
+  invoiceNumberPrefix?: string | undefined;
+  isDefault?: boolean | undefined;
+  metadata?: { [k: string]: string } | undefined;
+  name?: string | undefined;
+  status?: Status | undefined;
+  tenantId?: string | undefined;
+  updatedAt?: Date | undefined;
+  updatedBy?: string | undefined;
+};
+
+/** @internal */
+export const BillingEntityResponse$inboundSchema: z.ZodMiniType<
+  BillingEntityResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    billing_details: types.optional(BillingDetails$inboundSchema),
+    created_at: types.optional(types.date()),
+    created_by: types.optional(types.string()),
+    environment_id: types.optional(types.string()),
+    id: types.optional(types.string()),
+    invoice_number_prefix: types.optional(types.string()),
+    is_default: types.optional(types.boolean()),
+    metadata: types.optional(z.record(z.string(), types.string())),
+    name: types.optional(types.string()),
+    status: types.optional(Status$inboundSchema),
+    tenant_id: types.optional(types.string()),
+    updated_at: types.optional(types.date()),
+    updated_by: types.optional(types.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "billing_details": "billingDetails",
+      "created_at": "createdAt",
+      "created_by": "createdBy",
+      "environment_id": "environmentId",
+      "invoice_number_prefix": "invoiceNumberPrefix",
+      "is_default": "isDefault",
+      "tenant_id": "tenantId",
+      "updated_at": "updatedAt",
+      "updated_by": "updatedBy",
+    });
+  }),
+);
+
+export function billingEntityResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<BillingEntityResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BillingEntityResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BillingEntityResponse' from JSON`,
+  );
+}

package/src/sdk/models/billingterm-instalment.ts

@@ -45,6 +45,10 @@ export type BillingtermInstalment = {
   instalmentStatus?: InstalmentStatus | undefined;
   invoiceId?: string | undefined;
   invoiceLabel?: string | undefined;
+  /**
+   * InvoicedAt is when the invoice billing the instalment was finalized.
+   */
+  invoicedAt?: Date | undefined;
   kind?: InstalmentKind | undefined;
   metadata?: { [k: string]: string } | undefined;
   ownerId?: string | undefined;
@@ -79,6 +83,7 @@ export const BillingtermInstalment$inboundSchema: z.ZodMiniType<
     instalment_status: types.optional(InstalmentStatus$inboundSchema),
     invoice_id: types.optional(types.string()),
     invoice_label: types.optional(types.string()),
+    invoiced_at: types.optional(types.date()),
     kind: types.optional(InstalmentKind$inboundSchema),
     metadata: types.optional(z.record(z.string(), types.string())),
     owner_id: types.optional(types.string()),
@@ -104,6 +109,7 @@ export const BillingtermInstalment$inboundSchema: z.ZodMiniType<
       "instalment_status": "instalmentStatus",
       "invoice_id": "invoiceId",
       "invoice_label": "invoiceLabel",
+      "invoiced_at": "invoicedAt",
       "owner_id": "ownerId",
       "owner_type": "ownerType",
       "service_period_end": "servicePeriodEnd",