@tirdad/sdk 2.1.47 → 2.1.48

package/src/sdk/models/replace-commitment-billing-terms-op.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import {
+  ReplaceBillingTermsRequest,
+  ReplaceBillingTermsRequest$Outbound,
+  ReplaceBillingTermsRequest$outboundSchema,
+} from "./replace-billing-terms-request.js";
+
+export type ReplaceCommitmentBillingTermsRequest = {
+  /**
+   * Commitment ID
+   */
+  id: string;
+  /**
+   * Billing terms
+   */
+  body: ReplaceBillingTermsRequest;
+};
+
+/** @internal */
+export type ReplaceCommitmentBillingTermsRequest$Outbound = {
+  id: string;
+  body: ReplaceBillingTermsRequest$Outbound;
+};
+
+/** @internal */
+export const ReplaceCommitmentBillingTermsRequest$outboundSchema: z.ZodMiniType<
+  ReplaceCommitmentBillingTermsRequest$Outbound,
+  ReplaceCommitmentBillingTermsRequest
+> = z.object({
+  id: z.string(),
+  body: ReplaceBillingTermsRequest$outboundSchema,
+});
+
+export function replaceCommitmentBillingTermsRequestToJSON(
+  replaceCommitmentBillingTermsRequest: ReplaceCommitmentBillingTermsRequest,
+): string {
+  return JSON.stringify(
+    ReplaceCommitmentBillingTermsRequest$outboundSchema.parse(
+      replaceCommitmentBillingTermsRequest,
+    ),
+  );
+}

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

@@ -16,6 +16,10 @@ import {
   BillingPeriod,
   BillingPeriod$inboundSchema,
 } from "./billing-period.js";
+import {
+  CommitmentResponse,
+  CommitmentResponse$inboundSchema,
+} from "./commitment-response.js";
 import {
   CouponAssociationResponse,
   CouponAssociationResponse$inboundSchema,
@@ -114,6 +118,10 @@ export type SubscriptionResponseV2 = {
    */
   commitmentAmount?: string | undefined;
   commitmentDuration?: BillingPeriod | undefined;
+  /**
+   * Commitments are included when "commitments" is in expand parameter
+   */
+  commitments?: Array<CommitmentResponse> | undefined;
   /**
    * CouponAssociations are included when "coupon_associations" is in expand parameter
    */
@@ -275,6 +283,7 @@ export const SubscriptionResponseV2$inboundSchema: z.ZodMiniType<
     collection_method: types.optional(types.string()),
     commitment_amount: types.optional(types.string()),
     commitment_duration: types.optional(BillingPeriod$inboundSchema),
+    commitments: types.optional(z.array(CommitmentResponse$inboundSchema)),
     coupon_associations: types.optional(
       z.array(CouponAssociationResponse$inboundSchema),
     ),

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

@@ -24,6 +24,10 @@ import {
   CheckoutSessionResponse,
   CheckoutSessionResponse$inboundSchema,
 } from "./checkout-session-response.js";
+import {
+  CommitmentResponse,
+  CommitmentResponse$inboundSchema,
+} from "./commitment-response.js";
 import {
   CouponAssociationResponse,
   CouponAssociationResponse$inboundSchema,
@@ -127,6 +131,10 @@ export type SubscriptionResponse = {
    */
   commitmentAmount?: string | undefined;
   commitmentDuration?: BillingPeriod | undefined;
+  /**
+   * Commitments are the commitments created with the subscription; set on create only.
+   */
+  commitments?: Array<CommitmentResponse> | undefined;
   /**
    * CouponAssociations are the coupon associations for this subscription
    */
@@ -281,6 +289,7 @@ export const SubscriptionResponse$inboundSchema: z.ZodMiniType<
     collection_method: types.optional(types.string()),
     commitment_amount: types.optional(types.string()),
     commitment_duration: types.optional(BillingPeriod$inboundSchema),
+    commitments: types.optional(z.array(CommitmentResponse$inboundSchema)),
     coupon_associations: types.optional(
       z.array(CouponAssociationResponse$inboundSchema),
     ),

package/src/sdk/models/terminate-commitment-request.ts

@@ -4,15 +4,23 @@
 
 import * as z from "zod/v4-mini";
 import { remap as remap$ } from "../../lib/primitives.js";
+import {
+  CancellationFeeInput,
+  CancellationFeeInput$Outbound,
+  CancellationFeeInput$outboundSchema,
+} from "./cancellation-fee-input.js";
 
 export type TerminateCommitmentRequest = {
-  cancellationFee?: string | undefined;
+  cancellationFee?: CancellationFeeInput | undefined;
+  /**
+   * EffectiveAt defaults to now; within a second after a billing period edge it is taken as that edge.
+   */
   effectiveAt?: Date | undefined;
 };
 
 /** @internal */
 export type TerminateCommitmentRequest$Outbound = {
-  cancellation_fee?: string | undefined;
+  cancellation_fee?: CancellationFeeInput$Outbound | undefined;
   effective_at?: string | undefined;
 };
 
@@ -22,7 +30,7 @@ export const TerminateCommitmentRequest$outboundSchema: z.ZodMiniType<
   TerminateCommitmentRequest
 > = z.pipe(
   z.object({
-    cancellationFee: z.optional(z.string()),
+    cancellationFee: z.optional(CancellationFeeInput$outboundSchema),
     effectiveAt: z.optional(
       z.pipe(z.date(), z.transform(v => v.toISOString())),
     ),

package/src/sdk/models/trigger-commitment-instalment-op.ts

@@ -0,0 +1,60 @@
+/*
+ * 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 {
+  TriggerInstalmentRequest,
+  TriggerInstalmentRequest$Outbound,
+  TriggerInstalmentRequest$outboundSchema,
+} from "./trigger-instalment-request.js";
+
+export type TriggerCommitmentInstalmentRequest = {
+  /**
+   * Commitment ID
+   */
+  id: string;
+  /**
+   * Instalment ID
+   */
+  instalmentId: string;
+  /**
+   * Trigger request
+   */
+  body?: TriggerInstalmentRequest | undefined;
+};
+
+/** @internal */
+export type TriggerCommitmentInstalmentRequest$Outbound = {
+  id: string;
+  instalment_id: string;
+  body?: TriggerInstalmentRequest$Outbound | undefined;
+};
+
+/** @internal */
+export const TriggerCommitmentInstalmentRequest$outboundSchema: z.ZodMiniType<
+  TriggerCommitmentInstalmentRequest$Outbound,
+  TriggerCommitmentInstalmentRequest
+> = z.pipe(
+  z.object({
+    id: z.string(),
+    instalmentId: z.string(),
+    body: z.optional(TriggerInstalmentRequest$outboundSchema),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      instalmentId: "instalment_id",
+    });
+  }),
+);
+
+export function triggerCommitmentInstalmentRequestToJSON(
+  triggerCommitmentInstalmentRequest: TriggerCommitmentInstalmentRequest,
+): string {
+  return JSON.stringify(
+    TriggerCommitmentInstalmentRequest$outboundSchema.parse(
+      triggerCommitmentInstalmentRequest,
+    ),
+  );
+}

package/src/sdk/models/trigger-instalment-request.ts

@@ -0,0 +1,41 @@
+/*
+ * 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 TriggerInstalmentRequest = {
+  /**
+   * BillOn within a second after a billing period edge is taken as that edge.
+   */
+  billOn?: string | undefined;
+};
+
+/** @internal */
+export type TriggerInstalmentRequest$Outbound = {
+  bill_on?: string | undefined;
+};
+
+/** @internal */
+export const TriggerInstalmentRequest$outboundSchema: z.ZodMiniType<
+  TriggerInstalmentRequest$Outbound,
+  TriggerInstalmentRequest
+> = z.pipe(
+  z.object({
+    billOn: z.optional(z.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      billOn: "bill_on",
+    });
+  }),
+);
+
+export function triggerInstalmentRequestToJSON(
+  triggerInstalmentRequest: TriggerInstalmentRequest,
+): string {
+  return JSON.stringify(
+    TriggerInstalmentRequest$outboundSchema.parse(triggerInstalmentRequest),
+  );
+}

package/src/sdk/models/update-commitment-request.ts

@@ -6,6 +6,10 @@ import * as z from "zod/v4-mini";
 import { remap as remap$ } from "../../lib/primitives.js";
 
 export type UpdateCommitmentRequest = {
+  /**
+   * EndDate can't be changed yet; terminate the commitment to end it.
+   */
+  endDate?: Date | undefined;
   invoiceDescription?: string | undefined;
   invoiceLabel?: string | undefined;
   metadata?: { [k: string]: string } | undefined;
@@ -14,6 +18,7 @@ export type UpdateCommitmentRequest = {
 
 /** @internal */
 export type UpdateCommitmentRequest$Outbound = {
+  end_date?: string | undefined;
   invoice_description?: string | undefined;
   invoice_label?: string | undefined;
   metadata?: { [k: string]: string } | undefined;
@@ -26,6 +31,7 @@ export const UpdateCommitmentRequest$outboundSchema: z.ZodMiniType<
   UpdateCommitmentRequest
 > = z.pipe(
   z.object({
+    endDate: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
     invoiceDescription: z.optional(z.string()),
     invoiceLabel: z.optional(z.string()),
     metadata: z.optional(z.record(z.string(), z.string())),
@@ -33,6 +39,7 @@ export const UpdateCommitmentRequest$outboundSchema: z.ZodMiniType<
   }),
   z.transform((v) => {
     return remap$(v, {
+      endDate: "end_date",
       invoiceDescription: "invoice_description",
       invoiceLabel: "invoice_label",
     });

package/src/sdk/models/webhook-dto-billing-instalment-webhook-payload.ts

@@ -0,0 +1,53 @@
+/*
+ * 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 {
+  BillingtermInstalment,
+  BillingtermInstalment$inboundSchema,
+} from "./billingterm-instalment.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+import {
+  WebhookEventName,
+  WebhookEventName$inboundSchema,
+} from "./webhook-event-name.js";
+
+export type WebhookDtoBillingInstalmentWebhookPayload = {
+  eventType?: WebhookEventName | undefined;
+  instalment?: BillingtermInstalment | undefined;
+};
+
+/** @internal */
+export const WebhookDtoBillingInstalmentWebhookPayload$inboundSchema:
+  z.ZodMiniType<WebhookDtoBillingInstalmentWebhookPayload, unknown> = z.pipe(
+    z.object({
+      event_type: types.optional(WebhookEventName$inboundSchema),
+      instalment: types.optional(BillingtermInstalment$inboundSchema),
+    }),
+    z.transform((v) => {
+      return remap$(v, {
+        "event_type": "eventType",
+      });
+    }),
+  );
+
+export function webhookDtoBillingInstalmentWebhookPayloadFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  WebhookDtoBillingInstalmentWebhookPayload,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      WebhookDtoBillingInstalmentWebhookPayload$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'WebhookDtoBillingInstalmentWebhookPayload' from JSON`,
+  );
+}

package/src/sdk/models/webhook-dto-billing-terms-webhook-payload.ts

@@ -0,0 +1,61 @@
+/*
+ * 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 {
+  BillingTermOwnerType,
+  BillingTermOwnerType$inboundSchema,
+} from "./billing-term-owner-type.js";
+import {
+  BillingtermTerm,
+  BillingtermTerm$inboundSchema,
+} from "./billingterm-term.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+import {
+  WebhookEventName,
+  WebhookEventName$inboundSchema,
+} from "./webhook-event-name.js";
+
+export type WebhookDtoBillingTermsWebhookPayload = {
+  billingTerms?: Array<BillingtermTerm> | undefined;
+  eventType?: WebhookEventName | undefined;
+  ownerId?: string | undefined;
+  ownerType?: BillingTermOwnerType | undefined;
+};
+
+/** @internal */
+export const WebhookDtoBillingTermsWebhookPayload$inboundSchema: z.ZodMiniType<
+  WebhookDtoBillingTermsWebhookPayload,
+  unknown
+> = z.pipe(
+  z.object({
+    billing_terms: types.optional(z.array(BillingtermTerm$inboundSchema)),
+    event_type: types.optional(WebhookEventName$inboundSchema),
+    owner_id: types.optional(types.string()),
+    owner_type: types.optional(BillingTermOwnerType$inboundSchema),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "billing_terms": "billingTerms",
+      "event_type": "eventType",
+      "owner_id": "ownerId",
+      "owner_type": "ownerType",
+    });
+  }),
+);
+
+export function webhookDtoBillingTermsWebhookPayloadFromJSON(
+  jsonString: string,
+): SafeParseResult<WebhookDtoBillingTermsWebhookPayload, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      WebhookDtoBillingTermsWebhookPayload$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WebhookDtoBillingTermsWebhookPayload' from JSON`,
+  );
+}

package/src/sdk/models/webhook-dto-invoice-line-item.ts

@@ -17,6 +17,7 @@ import { SDKValidationError } from "./sdk-validation-error.js";
 export type WebhookDtoInvoiceLineItem = {
   adjustedEntitlementQuantity?: string | undefined;
   amount?: string | undefined;
+  billingInstalmentId?: string | undefined;
   commitmentInfo?: CommitmentInfo | undefined;
   currency?: string | undefined;
   displayName?: string | undefined;
@@ -49,6 +50,7 @@ export const WebhookDtoInvoiceLineItem$inboundSchema: z.ZodMiniType<
   z.object({
     adjusted_entitlement_quantity: types.optional(types.string()),
     amount: types.optional(types.string()),
+    billing_instalment_id: types.optional(types.string()),
     commitment_info: types.optional(CommitmentInfo$inboundSchema),
     currency: types.optional(types.string()),
     display_name: types.optional(types.string()),
@@ -75,6 +77,7 @@ export const WebhookDtoInvoiceLineItem$inboundSchema: z.ZodMiniType<
   z.transform((v) => {
     return remap$(v, {
       "adjusted_entitlement_quantity": "adjustedEntitlementQuantity",
+      "billing_instalment_id": "billingInstalmentId",
       "commitment_info": "commitmentInfo",
       "display_name": "displayName",
       "entity_id": "entityId",

package/src/sdk/models/webhook-event-name.ts

@@ -28,6 +28,12 @@ export const WebhookEventName = {
   CommitmentCreated: "commitment.created",
   CommitmentUpdated: "commitment.updated",
   CommitmentTerminated: "commitment.terminated",
+  BillingTermsCreated: "billing_terms.created",
+  BillingTermsUpdated: "billing_terms.updated",
+  BillingInstalmentCreated: "billing_instalment.created",
+  BillingInstalmentUpdated: "billing_instalment.updated",
+  BillingInstalmentCancelled: "billing_instalment.cancelled",
+  BillingInstalmentInvoiced: "billing_instalment.invoiced",
   WalletCreated: "wallet.created",
   WalletUpdated: "wallet.updated",
   WalletTerminated: "wallet.terminated",

package/src/sdk/webhook-events.ts

@@ -2,6 +2,12 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { webhookEventsPostWebhookEventsBillingInstalmentCancelled } from "../funcs/webhook-events-post-webhook-events-billing-instalment-cancelled.js";
+import { webhookEventsPostWebhookEventsBillingInstalmentCreated } from "../funcs/webhook-events-post-webhook-events-billing-instalment-created.js";
+import { webhookEventsPostWebhookEventsBillingInstalmentInvoiced } from "../funcs/webhook-events-post-webhook-events-billing-instalment-invoiced.js";
+import { webhookEventsPostWebhookEventsBillingInstalmentUpdated } from "../funcs/webhook-events-post-webhook-events-billing-instalment-updated.js";
+import { webhookEventsPostWebhookEventsBillingTermsCreated } from "../funcs/webhook-events-post-webhook-events-billing-terms-created.js";
+import { webhookEventsPostWebhookEventsBillingTermsUpdated } from "../funcs/webhook-events-post-webhook-events-billing-terms-updated.js";
 import { webhookEventsPostWebhookEventsCheckoutSessionCompleted } from "../funcs/webhook-events-post-webhook-events-checkout-session-completed.js";
 import { webhookEventsPostWebhookEventsCheckoutSessionExpired } from "../funcs/webhook-events-post-webhook-events-checkout-session-expired.js";
 import { webhookEventsPostWebhookEventsCheckoutSessionFailed } from "../funcs/webhook-events-post-webhook-events-checkout-session-failed.js";
@@ -73,6 +79,96 @@ import { unwrapAsync } from "../types/fp.js";
 import * as models from "./models/index.js";
 
 export class WebhookEvents extends ClientSDK {
+  /**
+   * billing_instalment.cancelled
+   *
+   * @remarks
+   * Fired when a billing instalment is cancelled. Doc-only for parsing.
+   */
+  async postWebhookEventsBillingInstalmentCancelled(
+    options?: RequestOptions,
+  ): Promise<models.WebhookDtoBillingInstalmentWebhookPayload> {
+    return unwrapAsync(webhookEventsPostWebhookEventsBillingInstalmentCancelled(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * billing_instalment.created
+   *
+   * @remarks
+   * Fired when a billing instalment is scheduled for an entity (like a commitment). Doc-only for parsing.
+   */
+  async postWebhookEventsBillingInstalmentCreated(
+    options?: RequestOptions,
+  ): Promise<models.WebhookDtoBillingInstalmentWebhookPayload> {
+    return unwrapAsync(webhookEventsPostWebhookEventsBillingInstalmentCreated(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * billing_instalment.invoiced
+   *
+   * @remarks
+   * Fired when the invoice carrying a billing instalment is finalized. Doc-only for parsing.
+   */
+  async postWebhookEventsBillingInstalmentInvoiced(
+    options?: RequestOptions,
+  ): Promise<models.WebhookDtoBillingInstalmentWebhookPayload> {
+    return unwrapAsync(webhookEventsPostWebhookEventsBillingInstalmentInvoiced(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * billing_instalment.updated
+   *
+   * @remarks
+   * Fired when a trigger moves a billing instalment's bill date, or a voided invoice puts it back on schedule. Doc-only for parsing.
+   */
+  async postWebhookEventsBillingInstalmentUpdated(
+    options?: RequestOptions,
+  ): Promise<models.WebhookDtoBillingInstalmentWebhookPayload> {
+    return unwrapAsync(webhookEventsPostWebhookEventsBillingInstalmentUpdated(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * billing_terms.created
+   *
+   * @remarks
+   * Fired when billing terms are saved against an entity (like a commitment). Doc-only for parsing.
+   */
+  async postWebhookEventsBillingTermsCreated(
+    options?: RequestOptions,
+  ): Promise<models.WebhookDtoBillingTermsWebhookPayload> {
+    return unwrapAsync(webhookEventsPostWebhookEventsBillingTermsCreated(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * billing_terms.updated
+   *
+   * @remarks
+   * Fired when an entity's (like a commitment's) billing terms are replaced. Doc-only for parsing.
+   */
+  async postWebhookEventsBillingTermsUpdated(
+    options?: RequestOptions,
+  ): Promise<models.WebhookDtoBillingTermsWebhookPayload> {
+    return unwrapAsync(webhookEventsPostWebhookEventsBillingTermsUpdated(
+      this,
+      options,
+    ));
+  }
+
   /**
    * checkout.session.completed
    *