@tirdad/sdk 2.1.43 → 2.1.45

package/src/funcs/webhook-events-post-webhook-events-commitment-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";
+
+/**
+ * commitment.updated
+ *
+ * @remarks
+ * Fired when a commitment's descriptive fields are updated. Doc-only for parsing.
+ */
+export function webhookEventsPostWebhookEventsCommitmentUpdated(
+  client: TirdadCore,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.WebhookDtoCommitmentWebhookPayload,
+    | TirdadError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    options,
+  ));
+}
+
+async function $do(
+  client: TirdadCore,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.WebhookDtoCommitmentWebhookPayload,
+      | TirdadError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const path = pathToFunc("/webhook-events/commitment.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/commitment.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.WebhookDtoCommitmentWebhookPayload,
+    | TirdadError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.WebhookDtoCommitmentWebhookPayload$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

@@ -69,7 +69,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0",
-  sdkVersion: "2.1.43",
+  sdkVersion: "2.1.45",
   genVersion: "2.948.4",
-  userAgent: "speakeasy-sdk/typescript 2.1.43 2.948.4 1.0 @tirdad/sdk",
+  userAgent: "speakeasy-sdk/typescript 2.1.45 2.948.4 1.0 @tirdad/sdk",
 } as const;

package/src/sdk/accounting-periods.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { accountingPeriodsQueryAccountingPeriod } from "../funcs/accounting-periods-query-accounting-period.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import { unwrapAsync } from "../types/fp.js";
+import * as models from "./models/index.js";
+
+export class AccountingPeriods extends ClientSDK {
+  /**
+   * Query accounting periods
+   *
+   * @remarks
+   * Use when listing the monthly accounting periods revenue recognition posts to, by period status or a period start range. Returns a paginated list.
+   */
+  async queryAccountingPeriod(
+    request: models.AccountingperiodFilter,
+    options?: RequestOptions,
+  ): Promise<models.ListAccountingPeriodsResponse> {
+    return unwrapAsync(accountingPeriodsQueryAccountingPeriod(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/commitments.ts

@@ -0,0 +1,121 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { commitmentsCreateCommitment } from "../funcs/commitments-create-commitment.js";
+import { commitmentsGetCommitment } from "../funcs/commitments-get-commitment.js";
+import { commitmentsPreviewCommitment } from "../funcs/commitments-preview-commitment.js";
+import { commitmentsQueryCommitment } from "../funcs/commitments-query-commitment.js";
+import { commitmentsTerminateCommitment } from "../funcs/commitments-terminate-commitment.js";
+import { commitmentsUpdateCommitment } from "../funcs/commitments-update-commitment.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import { unwrapAsync } from "../types/fp.js";
+import * as models from "./models/index.js";
+
+export class Commitments extends ClientSDK {
+  /**
+   * Create commitment
+   *
+   * @remarks
+   * Creates a commitment on a subscription: a minimum spend or quantity over a term, with optional committed and overage rates.
+   */
+  async createCommitment(
+    request: models.CreateCommitmentRequest,
+    options?: RequestOptions,
+  ): Promise<models.CommitmentResponse> {
+    return unwrapAsync(commitmentsCreateCommitment(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Preview commitment
+   *
+   * @remarks
+   * Validates a commitment and returns its computed value without creating it.
+   */
+  async previewCommitment(
+    request: models.CreateCommitmentRequest,
+    options?: RequestOptions,
+  ): Promise<models.CommitmentResponse> {
+    return unwrapAsync(commitmentsPreviewCommitment(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Query commitments
+   *
+   * @remarks
+   * Lists commitments with filtering and sorting. Returns a paginated list.
+   */
+  async queryCommitment(
+    request: models.CommitmentFilter,
+    options?: RequestOptions,
+  ): Promise<models.ListCommitmentsResponse> {
+    return unwrapAsync(commitmentsQueryCommitment(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get commitment
+   *
+   * @remarks
+   * Loads a single commitment by ID.
+   */
+  async getCommitment(
+    id: string,
+    options?: RequestOptions,
+  ): Promise<models.CommitmentResponse> {
+    return unwrapAsync(commitmentsGetCommitment(
+      this,
+      id,
+      options,
+    ));
+  }
+
+  /**
+   * Update commitment
+   *
+   * @remarks
+   * Updates the descriptive fields of a commitment. Economic terms are immutable.
+   */
+  async updateCommitment(
+    id: string,
+    body: models.UpdateCommitmentRequest,
+    options?: RequestOptions,
+  ): Promise<models.CommitmentResponse> {
+    return unwrapAsync(commitmentsUpdateCommitment(
+      this,
+      id,
+      body,
+      options,
+    ));
+  }
+
+  /**
+   * Terminate commitment
+   *
+   * @remarks
+   * Ends a commitment early, effective at the given time or now.
+   */
+  async terminateCommitment(
+    id: string,
+    body?: models.TerminateCommitmentRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<models.CommitmentResponse> {
+    return unwrapAsync(commitmentsTerminateCommitment(
+      this,
+      id,
+      body,
+      options,
+    ));
+  }
+}

package/src/sdk/contracts.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { contractsGetContract } from "../funcs/contracts-get-contract.js";
+import { contractsQueryContract } from "../funcs/contracts-query-contract.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import { unwrapAsync } from "../types/fp.js";
+import * as models from "./models/index.js";
+
+export class Contracts extends ClientSDK {
+  /**
+   * Query contracts
+   *
+   * @remarks
+   * Use when searching revenue recognition contracts by customer, subscription or contract status. Returns a paginated list.
+   */
+  async queryContract(
+    request: models.ContractFilter,
+    options?: RequestOptions,
+  ): Promise<models.ListContractsResponse> {
+    return unwrapAsync(contractsQueryContract(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get contract
+   *
+   * @remarks
+   * Use when you need to load a single revenue recognition contract with the subscriptions it covers. Contracts are derived from subscriptions and are read-only.
+   */
+  async getContract(
+    id: string,
+    options?: RequestOptions,
+  ): Promise<models.ContractResponse> {
+    return unwrapAsync(contractsGetContract(
+      this,
+      id,
+      options,
+    ));
+  }
+}

package/src/sdk/events.ts

@@ -2,6 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { eventsDeleteEvents } from "../funcs/events-delete-events.js";
 import { eventsGetEvent } from "../funcs/events-get-event.js";
 import { eventsGetUsageAnalytics } from "../funcs/events-get-usage-analytics.js";
 import { eventsGetUsageByMeter } from "../funcs/events-get-usage-by-meter.js";
@@ -65,6 +66,23 @@ export class Events extends ClientSDK {
     ));
   }
 
+  /**
+   * Delete events
+   *
+   * @remarks
+   * Hard-deletes ingested events and the meter usage they produced for the named customers and period, optionally narrowed by feature or by exact event id. Refused when anything in scope has already been invoiced. Irreversible.
+   */
+  async deleteEvents(
+    request: models.DeleteEventsRequest,
+    options?: RequestOptions,
+  ): Promise<models.DeleteEventsResponseResponse> {
+    return unwrapAsync(eventsDeleteEvents(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Get event
    *

package/src/sdk/journal-entries.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { journalEntriesGetJournalEntry } from "../funcs/journal-entries-get-journal-entry.js";
+import { journalEntriesQueryJournalEntry } from "../funcs/journal-entries-query-journal-entry.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import { unwrapAsync } from "../types/fp.js";
+import * as models from "./models/index.js";
+
+export class JournalEntries extends ClientSDK {
+  /**
+   * Query journal entries
+   *
+   * @remarks
+   * Use when listing journal entries by period, event type, account, customer, contract, performance obligation or source. Returns a paginated list with lines.
+   */
+  async queryJournalEntry(
+    request: models.JournalFilter,
+    options?: RequestOptions,
+  ): Promise<models.ListJournalEntriesResponse> {
+    return unwrapAsync(journalEntriesQueryJournalEntry(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get journal entry
+   *
+   * @remarks
+   * Use when you need one revenue recognition journal entry with its debit and credit lines. The journal is derived from billing and recognition and is read-only.
+   */
+  async getJournalEntry(
+    id: string,
+    options?: RequestOptions,
+  ): Promise<models.JournalEntryResponse> {
+    return unwrapAsync(journalEntriesGetJournalEntry(
+      this,
+      id,
+      options,
+    ));
+  }
+}

package/src/sdk/models/accounting-period-response.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 { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import {
+  AccountingPeriodStatus,
+  AccountingPeriodStatus$inboundSchema,
+} from "./accounting-period-status.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+import { Status, Status$inboundSchema } from "./status.js";
+
+export type AccountingPeriodResponse = {
+  createdAt?: Date | undefined;
+  id?: string | undefined;
+  periodEnd?: Date | undefined;
+  periodStart?: Date | undefined;
+  periodStatus?: AccountingPeriodStatus | undefined;
+  status?: Status | undefined;
+  updatedAt?: Date | undefined;
+};
+
+/** @internal */
+export const AccountingPeriodResponse$inboundSchema: z.ZodMiniType<
+  AccountingPeriodResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    created_at: types.optional(types.date()),
+    id: types.optional(types.string()),
+    period_end: types.optional(types.date()),
+    period_start: types.optional(types.date()),
+    period_status: types.optional(AccountingPeriodStatus$inboundSchema),
+    status: types.optional(Status$inboundSchema),
+    updated_at: types.optional(types.date()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "created_at": "createdAt",
+      "period_end": "periodEnd",
+      "period_start": "periodStart",
+      "period_status": "periodStatus",
+      "updated_at": "updatedAt",
+    });
+  }),
+);
+
+export function accountingPeriodResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AccountingPeriodResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AccountingPeriodResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AccountingPeriodResponse' from JSON`,
+  );
+}

package/src/sdk/models/accounting-period-status.ts

@@ -0,0 +1,24 @@
+/*
+ * 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 AccountingPeriodStatus = {
+  Open: "open",
+  Closed: "closed",
+} as const;
+export type AccountingPeriodStatus = OpenEnum<typeof AccountingPeriodStatus>;
+
+/** @internal */
+export const AccountingPeriodStatus$inboundSchema: z.ZodMiniType<
+  AccountingPeriodStatus,
+  unknown
+> = openEnums.inboundSchema(AccountingPeriodStatus);
+/** @internal */
+export const AccountingPeriodStatus$outboundSchema: z.ZodMiniType<
+  string,
+  AccountingPeriodStatus
+> = openEnums.outboundSchema(AccountingPeriodStatus);

package/src/sdk/models/accountingperiod-filter.ts

@@ -0,0 +1,100 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import {
+  AccountingPeriodStatus,
+  AccountingPeriodStatus$outboundSchema,
+} from "./accounting-period-status.js";
+import {
+  FilterCondition,
+  FilterCondition$Outbound,
+  FilterCondition$outboundSchema,
+} from "./filter-condition.js";
+import {
+  SortCondition,
+  SortCondition$Outbound,
+  SortCondition$outboundSchema,
+} from "./sort-condition.js";
+import { Status, Status$outboundSchema } from "./status.js";
+
+export const AccountingperiodFilterOrder = {
+  Asc: "asc",
+  Desc: "desc",
+} as const;
+export type AccountingperiodFilterOrder = ClosedEnum<
+  typeof AccountingperiodFilterOrder
+>;
+
+export type AccountingperiodFilter = {
+  accountingPeriodIds?: Array<string> | undefined;
+  endTime?: Date | undefined;
+  expand?: string | undefined;
+  filters?: Array<FilterCondition> | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: AccountingperiodFilterOrder | undefined;
+  periodStatuses?: Array<AccountingPeriodStatus> | undefined;
+  sort?: Array<SortCondition> | undefined;
+  startTime?: Date | undefined;
+  status?: Status | undefined;
+};
+
+/** @internal */
+export const AccountingperiodFilterOrder$outboundSchema: z.ZodMiniEnum<
+  typeof AccountingperiodFilterOrder
+> = z.enum(AccountingperiodFilterOrder);
+
+/** @internal */
+export type AccountingperiodFilter$Outbound = {
+  accounting_period_ids?: Array<string> | undefined;
+  end_time?: string | undefined;
+  expand?: string | undefined;
+  filters?: Array<FilterCondition$Outbound> | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: string | undefined;
+  period_statuses?: Array<string> | undefined;
+  sort?: Array<SortCondition$Outbound> | undefined;
+  start_time?: string | undefined;
+  status?: string | undefined;
+};
+
+/** @internal */
+export const AccountingperiodFilter$outboundSchema: z.ZodMiniType<
+  AccountingperiodFilter$Outbound,
+  AccountingperiodFilter
+> = z.pipe(
+  z.object({
+    accountingPeriodIds: z.optional(z.array(z.string())),
+    endTime: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
+    expand: z.optional(z.string()),
+    filters: z.optional(z.array(FilterCondition$outboundSchema)),
+    limit: z.optional(z.int()),
+    offset: z.optional(z.int()),
+    order: z.optional(AccountingperiodFilterOrder$outboundSchema),
+    periodStatuses: z.optional(z.array(AccountingPeriodStatus$outboundSchema)),
+    sort: z.optional(z.array(SortCondition$outboundSchema)),
+    startTime: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
+    status: z.optional(Status$outboundSchema),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      accountingPeriodIds: "accounting_period_ids",
+      endTime: "end_time",
+      periodStatuses: "period_statuses",
+      startTime: "start_time",
+    });
+  }),
+);
+
+export function accountingperiodFilterToJSON(
+  accountingperiodFilter: AccountingperiodFilter,
+): string {
+  return JSON.stringify(
+    AccountingperiodFilter$outboundSchema.parse(accountingperiodFilter),
+  );
+}

package/src/sdk/models/active-window.ts

@@ -0,0 +1,54 @@
+/*
+ * 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 {
+  Bucket,
+  Bucket$inboundSchema,
+  Bucket$Outbound,
+  Bucket$outboundSchema,
+} from "./bucket.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+
+export type ActiveWindow = {
+  end?: Bucket | undefined;
+  start?: Bucket | undefined;
+};
+
+/** @internal */
+export const ActiveWindow$inboundSchema: z.ZodMiniType<ActiveWindow, unknown> =
+  z.object({
+    end: types.optional(Bucket$inboundSchema),
+    start: types.optional(Bucket$inboundSchema),
+  });
+/** @internal */
+export type ActiveWindow$Outbound = {
+  end?: Bucket$Outbound | undefined;
+  start?: Bucket$Outbound | undefined;
+};
+
+/** @internal */
+export const ActiveWindow$outboundSchema: z.ZodMiniType<
+  ActiveWindow$Outbound,
+  ActiveWindow
+> = z.object({
+  end: z.optional(Bucket$outboundSchema),
+  start: z.optional(Bucket$outboundSchema),
+});
+
+export function activeWindowToJSON(activeWindow: ActiveWindow): string {
+  return JSON.stringify(ActiveWindow$outboundSchema.parse(activeWindow));
+}
+export function activeWindowFromJSON(
+  jsonString: string,
+): SafeParseResult<ActiveWindow, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ActiveWindow$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ActiveWindow' from JSON`,
+  );
+}

package/src/sdk/models/amortization-method.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 AmortizationMethod = {
+  Daily: "daily",
+  PeriodEven: "period_even",
+  PeriodEvenProrated: "period_even_prorated",
+} as const;
+export type AmortizationMethod = OpenEnum<typeof AmortizationMethod>;
+
+/** @internal */
+export const AmortizationMethod$inboundSchema: z.ZodMiniType<
+  AmortizationMethod,
+  unknown
+> = openEnums.inboundSchema(AmortizationMethod);