@tirdad/sdk 2.1.46 → 2.1.48

package/src/funcs/webhook-events-post-webhook-events-billing-terms-created.ts

@@ -0,0 +1,144 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { TirdadCore } from "../core.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.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 { TirdadError } from "../sdk/models/tirdad-error.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * billing_terms.created
+ *
+ * @remarks
+ * Fired when billing terms are saved against an entity (like a commitment). Doc-only for parsing.
+ */
+export function webhookEventsPostWebhookEventsBillingTermsCreated(
+  client: TirdadCore,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.WebhookDtoBillingTermsWebhookPayload,
+    | TirdadError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    options,
+  ));
+}
+
+async function $do(
+  client: TirdadCore,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.WebhookDtoBillingTermsWebhookPayload,
+      | TirdadError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const path = pathToFunc("/webhook-events/billing_terms.created")();
+
+  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: "post_/webhook-events/billing_terms.created",
+    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,
+    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 [result] = await M.match<
+    models.WebhookDtoBillingTermsWebhookPayload,
+    | TirdadError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.WebhookDtoBillingTermsWebhookPayload$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/webhook-events-post-webhook-events-billing-terms-updated.ts

@@ -0,0 +1,144 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { TirdadCore } from "../core.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.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 { TirdadError } from "../sdk/models/tirdad-error.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * billing_terms.updated
+ *
+ * @remarks
+ * Fired when an entity's (like a commitment's) billing terms are replaced. Doc-only for parsing.
+ */
+export function webhookEventsPostWebhookEventsBillingTermsUpdated(
+  client: TirdadCore,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.WebhookDtoBillingTermsWebhookPayload,
+    | TirdadError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    options,
+  ));
+}
+
+async function $do(
+  client: TirdadCore,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.WebhookDtoBillingTermsWebhookPayload,
+      | TirdadError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const path = pathToFunc("/webhook-events/billing_terms.updated")();
+
+  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: "post_/webhook-events/billing_terms.updated",
+    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,
+    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 [result] = await M.match<
+    models.WebhookDtoBillingTermsWebhookPayload,
+    | TirdadError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.WebhookDtoBillingTermsWebhookPayload$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/webhook-events-post-webhook-events-payment-attempt-failed.ts

@@ -0,0 +1,144 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { TirdadCore } from "../core.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.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 { TirdadError } from "../sdk/models/tirdad-error.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * payment.attempt.failed
+ *
+ * @remarks
+ * Fired when one charge attempt is declined and the payment stays open for retry. Doc-only for parsing.
+ */
+export function webhookEventsPostWebhookEventsPaymentAttemptFailed(
+  client: TirdadCore,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.WebhookDtoPaymentAttemptWebhookPayload,
+    | TirdadError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    options,
+  ));
+}
+
+async function $do(
+  client: TirdadCore,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.WebhookDtoPaymentAttemptWebhookPayload,
+      | TirdadError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const path = pathToFunc("/webhook-events/payment.attempt.failed")();
+
+  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: "post_/webhook-events/payment.attempt.failed",
+    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,
+    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 [result] = await M.match<
+    models.WebhookDtoPaymentAttemptWebhookPayload,
+    | TirdadError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.WebhookDtoPaymentAttemptWebhookPayload$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -19,6 +19,14 @@ export const ServerList = [
    * India Region
    */
   "https://api.cloud.flexprice.io/v1",
+  /**
+   * Canada Region
+   */
+  "https://canada.api.flexprice.io/v1",
+  /**
+   * EU Region
+   */
+  "https://eu.api.flexprice.io/v1",
 ] as const;
 
 export type SDKOptions = {
@@ -69,7 +77,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0",
-  sdkVersion: "2.1.46",
+  sdkVersion: "2.1.48",
   genVersion: "2.948.4",
-  userAgent: "speakeasy-sdk/typescript 2.1.46 2.948.4 1.0 @tirdad/sdk",
+  userAgent: "speakeasy-sdk/typescript 2.1.48 2.948.4 1.0 @tirdad/sdk",
 } as const;

package/src/sdk/commitments.ts

@@ -3,10 +3,15 @@
  */
 
 import { commitmentsCreateCommitment } from "../funcs/commitments-create-commitment.js";
+import { commitmentsGetCommitmentBillingTerms } from "../funcs/commitments-get-commitment-billing-terms.js";
 import { commitmentsGetCommitment } from "../funcs/commitments-get-commitment.js";
+import { commitmentsListCommitmentInstalments } from "../funcs/commitments-list-commitment-instalments.js";
+import { commitmentsPreviewCommitmentBillingTerms } from "../funcs/commitments-preview-commitment-billing-terms.js";
 import { commitmentsPreviewCommitment } from "../funcs/commitments-preview-commitment.js";
 import { commitmentsQueryCommitment } from "../funcs/commitments-query-commitment.js";
+import { commitmentsReplaceCommitmentBillingTerms } from "../funcs/commitments-replace-commitment-billing-terms.js";
 import { commitmentsTerminateCommitment } from "../funcs/commitments-terminate-commitment.js";
+import { commitmentsTriggerCommitmentInstalment } from "../funcs/commitments-trigger-commitment-instalment.js";
 import { commitmentsUpdateCommitment } from "../funcs/commitments-update-commitment.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import { unwrapAsync } from "../types/fp.js";
@@ -100,11 +105,106 @@ export class Commitments extends ClientSDK {
     ));
   }
 
+  /**
+   * Get billing terms
+   *
+   * @remarks
+   * Returns the commitment's current billing terms with its scheduled and invoiced instalments in billing order. Invoiced instalments may come from terms an edit replaced. Cancelled instalments are listed by the instalments endpoint.
+   */
+  async getCommitmentBillingTerms(
+    id: string,
+    options?: RequestOptions,
+  ): Promise<models.BillingTermsResponse> {
+    return unwrapAsync(commitmentsGetCommitmentBillingTerms(
+      this,
+      id,
+      options,
+    ));
+  }
+
+  /**
+   * Edit billing terms
+   *
+   * @remarks
+   * Replaces the whole set of billing terms of an active commitment. Its scheduled instalments are cancelled and the new terms generate instalments for what the invoiced ones leave of the commitment total; invoiced instalments and their invoices are kept. A term without bill_on or start_date starts at the billing period holding now, or at the commitment start once its term has ended. Returns the new terms with the scheduled and invoiced instalments in billing order.
+   */
+  async replaceCommitmentBillingTerms(
+    id: string,
+    body: models.ReplaceBillingTermsRequest,
+    options?: RequestOptions,
+  ): Promise<models.BillingTermsResponse> {
+    return unwrapAsync(commitmentsReplaceCommitmentBillingTerms(
+      this,
+      id,
+      body,
+      options,
+    ));
+  }
+
+  /**
+   * Preview billing terms edit
+   *
+   * @remarks
+   * Returns what editing the billing terms would produce, without saving anything: the new terms with the invoiced and new instalments in billing order.
+   */
+  async previewCommitmentBillingTerms(
+    id: string,
+    body: models.ReplaceBillingTermsRequest,
+    options?: RequestOptions,
+  ): Promise<models.BillingTermsResponse> {
+    return unwrapAsync(commitmentsPreviewCommitmentBillingTerms(
+      this,
+      id,
+      body,
+      options,
+    ));
+  }
+
+  /**
+   * List instalments
+   *
+   * @remarks
+   * Lists the instalments of the commitment in billing order. Without a status filter every instalment is listed, cancelled ones included.
+   */
+  async listCommitmentInstalments(
+    id: string,
+    status?: Array<string> | undefined,
+    options?: RequestOptions,
+  ): Promise<models.ListInstalmentsResponse> {
+    return unwrapAsync(commitmentsListCommitmentInstalments(
+      this,
+      id,
+      status,
+      options,
+    ));
+  }
+
+  /**
+   * Trigger instalment
+   *
+   * @remarks
+   * Bills a manual instalment of an active commitment on bill_on, now by default, which must fall within the commitment term. The instalment goes on the first subscription invoice at or after that date, or on its own invoice once due when its instalment_invoicing, the term's or else the commitment's, is separate_invoice. Either way it waits while the subscription is trialing or paused. Until it is triggered, a manual instalment waits at the end of the term, and bill_on can only move earlier; edit the billing terms to bill it later.
+   */
+  async triggerCommitmentInstalment(
+    id: string,
+    instalmentId: string,
+    body?: models.TriggerInstalmentRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<models.BillingtermInstalment> {
+    return unwrapAsync(commitmentsTriggerCommitmentInstalment(
+      this,
+      id,
+      instalmentId,
+      body,
+      options,
+    ));
+  }
+
   /**
    * Terminate commitment
    *
    * @remarks
-   * Ends a commitment early, effective at the given time or now.
+   * Ends a commitment immediately. effective_at defaults to now and cannot be in the future. Under billing terms, its scheduled instalments are cancelled, and those already due by effective_at are billed together as one settlement; later instalments are not billed and nothing is refunded. The settlement and a fixed cancellation fee, when given, are billed together on one one-off invoice.
    */
   async terminateCommitment(
     id: string,

package/src/sdk/events.ts

@@ -37,6 +37,11 @@ export class Events extends ClientSDK {
    *
    * @remarks
    * Use when building analytics views (e.g. usage by feature or customer over time). Supports filtering, grouping, and time-series breakdown.
+   * Groups and regular-meter time-series points contain usage-proportional cost allocations, not independently priced charges.
+   * Source/property filters return the unfiltered usage charge for the same time range multiplied by filtered quantity / full quantity; groups split that filtered share. Filtered costs exclude commitments and true-up.
+   * When full quantity is zero, no proportional rate is defined; costs retain direct per-group/per-bucket pricing.
+   * Analytics are eventually consistent: concurrent ingestion or late events can make filtered allocations approximate across separate reads. These allocations are not an invoice preview.
+   * For non-additive meters such as MAX, quantities use the meter's aggregation, so individual group shares can change when filtering or grouping changes.
    */
   async getUsageAnalytics(
     request: models.GetUsageAnalyticsRequest,