@flexprice/sdk 2.1.20 → 2.1.25

package/src/sdk/models/create-alert-settings-request.ts

@@ -0,0 +1,74 @@
+/*
+ * 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 {
+  AlertEntityType,
+  AlertEntityType$outboundSchema,
+} from "./alert-entity-type.js";
+import {
+  AlertSettings,
+  AlertSettings$Outbound,
+  AlertSettings$outboundSchema,
+} from "./alert-settings.js";
+
+export type CreateAlertSettingsRequest = {
+  config: AlertSettings;
+  /**
+   * entity_id is the id of the monitored entity: subscription id, subscription_line_item id, or
+   *
+   * @remarks
+   * group id, matching entity_type.
+   */
+  entityId: string;
+  entityType: AlertEntityType;
+  /**
+   * parent_entity_id is the subscription id that owns a line-item or group alert. Required when
+   *
+   * @remarks
+   * entity_type is "subscription_line_item" or "group"; omitted for subscription-level alerts.
+   */
+  parentEntityId?: string | undefined;
+  parentEntityType?: AlertEntityType | undefined;
+};
+
+/** @internal */
+export type CreateAlertSettingsRequest$Outbound = {
+  config: AlertSettings$Outbound;
+  entity_id: string;
+  entity_type: string;
+  parent_entity_id?: string | undefined;
+  parent_entity_type?: string | undefined;
+};
+
+/** @internal */
+export const CreateAlertSettingsRequest$outboundSchema: z.ZodMiniType<
+  CreateAlertSettingsRequest$Outbound,
+  CreateAlertSettingsRequest
+> = z.pipe(
+  z.object({
+    config: AlertSettings$outboundSchema,
+    entityId: z.string(),
+    entityType: AlertEntityType$outboundSchema,
+    parentEntityId: z.optional(z.string()),
+    parentEntityType: z.optional(AlertEntityType$outboundSchema),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      entityId: "entity_id",
+      entityType: "entity_type",
+      parentEntityId: "parent_entity_id",
+      parentEntityType: "parent_entity_type",
+    });
+  }),
+);
+
+export function createAlertSettingsRequestToJSON(
+  createAlertSettingsRequest: CreateAlertSettingsRequest,
+): string {
+  return JSON.stringify(
+    CreateAlertSettingsRequest$outboundSchema.parse(createAlertSettingsRequest),
+  );
+}

package/src/sdk/models/create-checkout-session-request.ts

@@ -0,0 +1,93 @@
+/*
+ * 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 {
+  CheckoutAction,
+  CheckoutAction$outboundSchema,
+} from "./checkout-action.js";
+import {
+  CheckoutConfiguration,
+  CheckoutConfiguration$Outbound,
+  CheckoutConfiguration$outboundSchema,
+} from "./checkout-configuration.js";
+import {
+  CheckoutPaymentProviderConfig,
+  CheckoutPaymentProviderConfig$Outbound,
+  CheckoutPaymentProviderConfig$outboundSchema,
+} from "./checkout-payment-provider-config.js";
+import {
+  CheckoutPaymentProvider,
+  CheckoutPaymentProvider$outboundSchema,
+} from "./checkout-payment-provider.js";
+
+export type CreateCheckoutSessionRequest = {
+  action: CheckoutAction;
+  cancelUrl?: string | undefined;
+  configuration?: CheckoutConfiguration | undefined;
+  customerExternalId: string;
+  failureUrl?: string | undefined;
+  idempotencyKey?: string | undefined;
+  metadata?: { [k: string]: string } | undefined;
+  paymentProvider: CheckoutPaymentProvider;
+  paymentProviderConfig?: CheckoutPaymentProviderConfig | undefined;
+  successUrl?: string | undefined;
+};
+
+/** @internal */
+export type CreateCheckoutSessionRequest$Outbound = {
+  action: string;
+  cancel_url?: string | undefined;
+  configuration?: CheckoutConfiguration$Outbound | undefined;
+  customer_external_id: string;
+  failure_url?: string | undefined;
+  idempotency_key?: string | undefined;
+  metadata?: { [k: string]: string } | undefined;
+  payment_provider: string;
+  payment_provider_config?: CheckoutPaymentProviderConfig$Outbound | undefined;
+  success_url?: string | undefined;
+};
+
+/** @internal */
+export const CreateCheckoutSessionRequest$outboundSchema: z.ZodMiniType<
+  CreateCheckoutSessionRequest$Outbound,
+  CreateCheckoutSessionRequest
+> = z.pipe(
+  z.object({
+    action: CheckoutAction$outboundSchema,
+    cancelUrl: z.optional(z.string()),
+    configuration: z.optional(CheckoutConfiguration$outboundSchema),
+    customerExternalId: z.string(),
+    failureUrl: z.optional(z.string()),
+    idempotencyKey: z.optional(z.string()),
+    metadata: z.optional(z.record(z.string(), z.string())),
+    paymentProvider: CheckoutPaymentProvider$outboundSchema,
+    paymentProviderConfig: z.optional(
+      CheckoutPaymentProviderConfig$outboundSchema,
+    ),
+    successUrl: z.optional(z.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      cancelUrl: "cancel_url",
+      customerExternalId: "customer_external_id",
+      failureUrl: "failure_url",
+      idempotencyKey: "idempotency_key",
+      paymentProvider: "payment_provider",
+      paymentProviderConfig: "payment_provider_config",
+      successUrl: "success_url",
+    });
+  }),
+);
+
+export function createCheckoutSessionRequestToJSON(
+  createCheckoutSessionRequest: CreateCheckoutSessionRequest,
+): string {
+  return JSON.stringify(
+    CreateCheckoutSessionRequest$outboundSchema.parse(
+      createCheckoutSessionRequest,
+    ),
+  );
+}

package/src/sdk/models/create-credit-grant-request.ts

@@ -26,6 +26,7 @@ import {
 } from "./credit-grant-scope.js";
 
 export type CreateCreditGrantRequest = {
+  addonId?: string | undefined;
   cadence: CreditGrantCadence;
   /**
    * amount in the currency =  number of credits * conversion_rate
@@ -63,6 +64,7 @@ export type CreateCreditGrantRequest = {
 
 /** @internal */
 export type CreateCreditGrantRequest$Outbound = {
+  addon_id?: string | undefined;
   cadence: string;
   conversion_rate?: string | undefined;
   credits: string;
@@ -88,6 +90,7 @@ export const CreateCreditGrantRequest$outboundSchema: z.ZodMiniType<
   CreateCreditGrantRequest
 > = z.pipe(
   z.object({
+    addonId: z.optional(z.string()),
     cadence: CreditGrantCadence$outboundSchema,
     conversionRate: z.optional(z.string()),
     credits: z.string(),
@@ -110,6 +113,7 @@ export const CreateCreditGrantRequest$outboundSchema: z.ZodMiniType<
   }),
   z.transform((v) => {
     return remap$(v, {
+      addonId: "addon_id",
       conversionRate: "conversion_rate",
       endDate: "end_date",
       expirationDuration: "expiration_duration",

package/src/sdk/models/create-customer-request.ts

@@ -43,6 +43,10 @@ export type CreateCustomerRequest = {
    * address_state is the state, province, or region name with maximum 100 characters
    */
   addressState?: string | undefined;
+  /**
+   * contact is an optional contact number for the customer (e.g. phone)
+   */
+  contact?: string | undefined;
   /**
    * email is the customer's email address and must be a valid email format if provided
    */
@@ -64,7 +68,11 @@ export type CreateCustomerRequest = {
   /**
    * name is the full name or company name of the customer
    */
-  name?: string | undefined;
+  name: string;
+  /**
+   * onboarding_workflow_name is given if a custom onboarding workflow is to be triggered for this customer
+   */
+  onboardingWorkflowName?: string | undefined;
   /**
    * skip_onboarding_workflow when true, prevents the customer onboarding workflow from being triggered
    *
@@ -77,6 +85,13 @@ export type CreateCustomerRequest = {
    * tax_rate_overrides contains tax rate configurations to be linked to this customer
    */
   taxRateOverrides?: Array<TaxRateOverride> | undefined;
+  /**
+   * timezone is the customer's IANA timezone name (e.g. "Asia/Kolkata", "America/New_York")
+   *
+   * @remarks
+   * Defaults to "UTC" if not provided
+   */
+  timezone?: string | undefined;
 };
 
 /** @internal */
@@ -87,15 +102,18 @@ export type CreateCustomerRequest$Outbound = {
   address_line2?: string | undefined;
   address_postal_code?: string | undefined;
   address_state?: string | undefined;
+  contact?: string | undefined;
   email?: string | undefined;
   external_id: string;
   integration_entity_mapping?:
     | Array<CreateEntityIntegrationMappingRequest$Outbound>
     | undefined;
   metadata?: { [k: string]: string } | undefined;
-  name?: string | undefined;
+  name: string;
+  onboarding_workflow_name?: string | undefined;
   skip_onboarding_workflow?: boolean | undefined;
   tax_rate_overrides?: Array<TaxRateOverride$Outbound> | undefined;
+  timezone?: string | undefined;
 };
 
 /** @internal */
@@ -110,15 +128,18 @@ export const CreateCustomerRequest$outboundSchema: z.ZodMiniType<
     addressLine2: z.optional(z.string()),
     addressPostalCode: z.optional(z.string()),
     addressState: z.optional(z.string()),
+    contact: z.optional(z.string()),
     email: z.optional(z.string()),
     externalId: z.string(),
     integrationEntityMapping: z.optional(
       z.array(CreateEntityIntegrationMappingRequest$outboundSchema),
     ),
     metadata: z.optional(z.record(z.string(), z.string())),
-    name: z.optional(z.string()),
+    name: z.string(),
+    onboardingWorkflowName: z.optional(z.string()),
     skipOnboardingWorkflow: z.optional(z.boolean()),
     taxRateOverrides: z.optional(z.array(TaxRateOverride$outboundSchema)),
+    timezone: z.optional(z.string()),
   }),
   z.transform((v) => {
     return remap$(v, {
@@ -130,6 +151,7 @@ export const CreateCustomerRequest$outboundSchema: z.ZodMiniType<
       addressState: "address_state",
       externalId: "external_id",
       integrationEntityMapping: "integration_entity_mapping",
+      onboardingWorkflowName: "onboarding_workflow_name",
       skipOnboardingWorkflow: "skip_onboarding_workflow",
       taxRateOverrides: "tax_rate_overrides",
     });

package/src/sdk/models/create-entitlement-request.ts

@@ -4,10 +4,26 @@
 
 import * as z from "zod/v4-mini";
 import { remap as remap$ } from "../../lib/primitives.js";
+import {
+  EntitlementAggregationMode,
+  EntitlementAggregationMode$outboundSchema,
+} from "./entitlement-aggregation-mode.js";
 import {
   EntitlementEntityType,
   EntitlementEntityType$outboundSchema,
 } from "./entitlement-entity-type.js";
+import {
+  EntitlementGrantAllocationBehavior,
+  EntitlementGrantAllocationBehavior$outboundSchema,
+} from "./entitlement-grant-allocation-behavior.js";
+import {
+  EntitlementGrantDurationUnit,
+  EntitlementGrantDurationUnit$outboundSchema,
+} from "./entitlement-grant-duration-unit.js";
+import {
+  EntitlementGrantMeasure,
+  EntitlementGrantMeasure$outboundSchema,
+} from "./entitlement-grant-measure.js";
 import {
   EntitlementUsageResetPeriod,
   EntitlementUsageResetPeriod$outboundSchema,
@@ -15,11 +31,18 @@ import {
 import { FeatureType, FeatureType$outboundSchema } from "./feature-type.js";
 
 export type CreateEntitlementRequest = {
+  aggregationMode?: EntitlementAggregationMode | undefined;
+  configValue?: { [k: string]: any } | undefined;
   endDate?: Date | undefined;
   entityId?: string | undefined;
   entityType?: EntitlementEntityType | undefined;
   featureId: string;
   featureType: FeatureType;
+  grantAllocationBehavior?: EntitlementGrantAllocationBehavior | undefined;
+  grantDurationUnit?: EntitlementGrantDurationUnit | undefined;
+  grantDurationValue?: number | undefined;
+  grantMeasure?: EntitlementGrantMeasure | undefined;
+  grantQuota?: string | undefined;
   isEnabled?: boolean | undefined;
   isSoftLimit?: boolean | undefined;
   parentEntitlementId?: string | undefined;
@@ -32,11 +55,18 @@ export type CreateEntitlementRequest = {
 
 /** @internal */
 export type CreateEntitlementRequest$Outbound = {
+  aggregation_mode?: string | undefined;
+  config_value?: { [k: string]: any } | undefined;
   end_date?: string | undefined;
   entity_id?: string | undefined;
   entity_type?: string | undefined;
   feature_id: string;
   feature_type: string;
+  grant_allocation_behavior?: string | undefined;
+  grant_duration_unit?: string | undefined;
+  grant_duration_value?: number | undefined;
+  grant_measure?: string | undefined;
+  grant_quota?: string | undefined;
   is_enabled?: boolean | undefined;
   is_soft_limit?: boolean | undefined;
   parent_entitlement_id?: string | undefined;
@@ -53,11 +83,20 @@ export const CreateEntitlementRequest$outboundSchema: z.ZodMiniType<
   CreateEntitlementRequest
 > = z.pipe(
   z.object({
+    aggregationMode: z.optional(EntitlementAggregationMode$outboundSchema),
+    configValue: z.optional(z.record(z.string(), z.any())),
     endDate: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
     entityId: z.optional(z.string()),
     entityType: z.optional(EntitlementEntityType$outboundSchema),
     featureId: z.string(),
     featureType: FeatureType$outboundSchema,
+    grantAllocationBehavior: z.optional(
+      EntitlementGrantAllocationBehavior$outboundSchema,
+    ),
+    grantDurationUnit: z.optional(EntitlementGrantDurationUnit$outboundSchema),
+    grantDurationValue: z.optional(z.int()),
+    grantMeasure: z.optional(EntitlementGrantMeasure$outboundSchema),
+    grantQuota: z.optional(z.string()),
     isEnabled: z.optional(z.boolean()),
     isSoftLimit: z.optional(z.boolean()),
     parentEntitlementId: z.optional(z.string()),
@@ -69,11 +108,18 @@ export const CreateEntitlementRequest$outboundSchema: z.ZodMiniType<
   }),
   z.transform((v) => {
     return remap$(v, {
+      aggregationMode: "aggregation_mode",
+      configValue: "config_value",
       endDate: "end_date",
       entityId: "entity_id",
       entityType: "entity_type",
       featureId: "feature_id",
       featureType: "feature_type",
+      grantAllocationBehavior: "grant_allocation_behavior",
+      grantDurationUnit: "grant_duration_unit",
+      grantDurationValue: "grant_duration_value",
+      grantMeasure: "grant_measure",
+      grantQuota: "grant_quota",
       isEnabled: "is_enabled",
       isSoftLimit: "is_soft_limit",
       parentEntitlementId: "parent_entitlement_id",

package/src/sdk/models/create-invoice-request.ts

@@ -77,6 +77,15 @@ export type CreateInvoiceRequest = {
    * due_date is the date by which payment is expected
    */
   dueDate?: Date | undefined;
+  /**
+   * force_sync_invoice, when true, attempts to synchronously sync this invoice to
+   *
+   * @remarks
+   * Moyasar (if enabled) before returning, instead of relying solely on the async
+   * Kafka + Temporal vendor-sync pipeline. Only honored by CreateOneOffInvoice.
+   * Best-effort: sync failures do not fail invoice creation.
+   */
+  forceSyncInvoice?: boolean | undefined;
   /**
    * idempotency_key is an optional key used to prevent duplicate invoice creation
    */
@@ -161,6 +170,7 @@ export type CreateInvoiceRequest$Outbound = {
   customer_id: string;
   description?: string | undefined;
   due_date?: string | undefined;
+  force_sync_invoice?: boolean | undefined;
   idempotency_key?: string | undefined;
   invoice_coupons?: Array<InvoiceCoupon$Outbound> | undefined;
   invoice_number?: string | undefined;
@@ -198,6 +208,7 @@ export const CreateInvoiceRequest$outboundSchema: z.ZodMiniType<
     customerId: z.string(),
     description: z.optional(z.string()),
     dueDate: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
+    forceSyncInvoice: z.optional(z.boolean()),
     idempotencyKey: z.optional(z.string()),
     invoiceCoupons: z.optional(z.array(InvoiceCoupon$outboundSchema)),
     invoiceNumber: z.optional(z.string()),
@@ -229,6 +240,7 @@ export const CreateInvoiceRequest$outboundSchema: z.ZodMiniType<
       billingReason: "billing_reason",
       customerId: "customer_id",
       dueDate: "due_date",
+      forceSyncInvoice: "force_sync_invoice",
       idempotencyKey: "idempotency_key",
       invoiceCoupons: "invoice_coupons",
       invoiceNumber: "invoice_number",

package/src/sdk/models/create-payment-request.ts

@@ -8,6 +8,11 @@ import {
   PaymentDestinationType,
   PaymentDestinationType$outboundSchema,
 } from "./payment-destination-type.js";
+import {
+  PaymentGatewayOptions,
+  PaymentGatewayOptions$Outbound,
+  PaymentGatewayOptions$outboundSchema,
+} from "./payment-gateway-options.js";
 import {
   PaymentGatewayType,
   PaymentGatewayType$outboundSchema,
@@ -23,6 +28,7 @@ export type CreatePaymentRequest = {
   currency: string;
   destinationId: string;
   destinationType: PaymentDestinationType;
+  gatewayOptions?: PaymentGatewayOptions | undefined;
   idempotencyKey?: string | undefined;
   metadata?: { [k: string]: string } | undefined;
   paymentGateway?: PaymentGatewayType | undefined;
@@ -40,6 +46,7 @@ export type CreatePaymentRequest$Outbound = {
   currency: string;
   destination_id: string;
   destination_type: string;
+  gateway_options?: PaymentGatewayOptions$Outbound | undefined;
   idempotency_key?: string | undefined;
   metadata?: { [k: string]: string } | undefined;
   payment_gateway?: string | undefined;
@@ -61,6 +68,7 @@ export const CreatePaymentRequest$outboundSchema: z.ZodMiniType<
     currency: z.string(),
     destinationId: z.string(),
     destinationType: PaymentDestinationType$outboundSchema,
+    gatewayOptions: z.optional(PaymentGatewayOptions$outboundSchema),
     idempotencyKey: z.optional(z.string()),
     metadata: z.optional(z.record(z.string(), z.string())),
     paymentGateway: z.optional(PaymentGatewayType$outboundSchema),
@@ -75,6 +83,7 @@ export const CreatePaymentRequest$outboundSchema: z.ZodMiniType<
       cancelUrl: "cancel_url",
       destinationId: "destination_id",
       destinationType: "destination_type",
+      gatewayOptions: "gateway_options",
       idempotencyKey: "idempotency_key",
       paymentGateway: "payment_gateway",
       paymentMethodId: "payment_method_id",

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

@@ -0,0 +1,108 @@
+/*
+ * 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 {
+  BillingPeriod,
+  BillingPeriod$inboundSchema,
+  BillingPeriod$outboundSchema,
+} from "./billing-period.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+
+export type CreateSubscriptionParams = {
+  billingPeriod?: BillingPeriod | undefined;
+  currency?: string | undefined;
+  endDate?: Date | undefined;
+  lookupKey?: string | undefined;
+  metadata?: { [k: string]: string } | undefined;
+  planId?: string | undefined;
+  startDate?: Date | undefined;
+  subscriptionId?: string | undefined;
+};
+
+/** @internal */
+export const CreateSubscriptionParams$inboundSchema: z.ZodMiniType<
+  CreateSubscriptionParams,
+  unknown
+> = z.pipe(
+  z.object({
+    billing_period: types.optional(BillingPeriod$inboundSchema),
+    currency: types.optional(types.string()),
+    end_date: types.optional(types.date()),
+    lookup_key: types.optional(types.string()),
+    metadata: types.optional(z.record(z.string(), types.string())),
+    plan_id: types.optional(types.string()),
+    start_date: types.optional(types.date()),
+    subscription_id: types.optional(types.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "billing_period": "billingPeriod",
+      "end_date": "endDate",
+      "lookup_key": "lookupKey",
+      "plan_id": "planId",
+      "start_date": "startDate",
+      "subscription_id": "subscriptionId",
+    });
+  }),
+);
+/** @internal */
+export type CreateSubscriptionParams$Outbound = {
+  billing_period?: string | undefined;
+  currency?: string | undefined;
+  end_date?: string | undefined;
+  lookup_key?: string | undefined;
+  metadata?: { [k: string]: string } | undefined;
+  plan_id?: string | undefined;
+  start_date?: string | undefined;
+  subscription_id?: string | undefined;
+};
+
+/** @internal */
+export const CreateSubscriptionParams$outboundSchema: z.ZodMiniType<
+  CreateSubscriptionParams$Outbound,
+  CreateSubscriptionParams
+> = z.pipe(
+  z.object({
+    billingPeriod: z.optional(BillingPeriod$outboundSchema),
+    currency: z.optional(z.string()),
+    endDate: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
+    lookupKey: z.optional(z.string()),
+    metadata: z.optional(z.record(z.string(), z.string())),
+    planId: z.optional(z.string()),
+    startDate: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
+    subscriptionId: z.optional(z.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      billingPeriod: "billing_period",
+      endDate: "end_date",
+      lookupKey: "lookup_key",
+      planId: "plan_id",
+      startDate: "start_date",
+      subscriptionId: "subscription_id",
+    });
+  }),
+);
+
+export function createSubscriptionParamsToJSON(
+  createSubscriptionParams: CreateSubscriptionParams,
+): string {
+  return JSON.stringify(
+    CreateSubscriptionParams$outboundSchema.parse(createSubscriptionParams),
+  );
+}
+export function createSubscriptionParamsFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateSubscriptionParams, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateSubscriptionParams$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateSubscriptionParams' from JSON`,
+  );
+}