import {z} from 'zod' export type GetApiV3CommitmentsArgs = {page?: number | undefined, limit?: number | undefined, filter?: string | undefined}; export type GetApiV3CommitmentsOptions = {baseUrl?: string | undefined, customHeader?: string | undefined, fetch?: typeof fetch | undefined}; export const metricsDto = z.object({amount: z.string(), units: z.string()}); export const totalsDto = z.object({}); export const periodAmountsDto = z.object({cumulative: z.string(), remaining: z.string(), trueUp: z.string()}); export const eventTypeOverageDto = z.object({eventTypeId: z.string(), eventTypeName: z.string().optional(), cumulative: metricsDto, overages: metricsDto}); export const commitmentPeriodDto = z.object({periodId: z.string(), periodDate: z.string(), amounts: periodAmountsDto, eventTypes: z.array(eventTypeOverageDto), finalizedAt: z.string().nullable().optional(), lastCalculatedAt: z.string().optional(), createdAt: z.string(), updatedAt: z.string()}); export const stepDto = z.object({id: z.string(), sequence: z.number(), effectiveCommitmentValue: z.string(), effectivePrepaidValue: z.string(), prepaidEnabled: z.boolean(), commitmentUnitType: z.enum(["DOLLARS", "UNITS"]), pricePriority: z.enum(["LOW", "HIGH"]), billingTermIds: z.array(z.string()), enteredAt: z.string().optional()}); export const scheduleDto = z.object({id: z.string(), sequence: z.number(), startDate: z.string(), endDate: z.string(), commitmentInterval: z.enum(["DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "YEARLY"]).optional(), prepaymentScheduleType: z.enum(["FULL_UPFRONT", "PER_COMMITMENT_PERIOD", "SPLIT_ACROSS_BILLING_PERIODS"]).optional(), steps: z.array(stepDto)}); export const commitmentDto = z.object({id: z.string(), contractId: z.string(), customerId: z.string(), prepaidEnabled: z.boolean(), prepaidValue: z.string().optional(), commitmentValue: z.string(), commitmentUnitType: z.enum(["DOLLARS", "UNITS"]), commitmentStartDate: z.string().optional(), commitmentEndDate: z.string().optional(), commitmentPeriodInterval: z.enum(["DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "YEARLY"]).optional(), commitmentCustomInterval: z.string().optional(), nextSequentialCommitmentId: z.string().optional(), pricePriority: z.enum(["LOW", "HIGH"]).optional(), prepaymentScheduleType: z.enum(["FULL_UPFRONT", "PER_COMMITMENT_PERIOD", "SPLIT_ACROSS_BILLING_PERIODS"]).optional(), eventTypesIncluded: z.array(z.string()), currentCumulative: metricsDto, totals: totalsDto.optional(), periods: z.array(commitmentPeriodDto).optional(), createdAt: z.string(), updatedAt: z.string(), deletedAt: z.string().optional(), trueUpBehavior: z.enum(["DEFAULT", "NEVER"]).optional(), schedules: z.array(scheduleDto).optional()}); export const integratorsApiError = z.object({code: z.number(), message: z.string(), details: z.object({}).optional()}); export const getApiV3CommitmentsResponse = z.object({payload: z.object({data: z.array(commitmentDto).optional(), limit: z.number().optional(), totalItems: z.number().optional(), currentPage: z.number().optional()}), success: z.boolean(), message: z.string(), error: integratorsApiError}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * List commitments * * GET /v3/commitments */ export const getApiV3Commitments = async (args: GetApiV3CommitmentsArgs, options?: GetApiV3CommitmentsOptions) => { const {baseUrl = "https://integrators.prod.api.tabsplatform.com", fetch: fetchFn = fetch, customHeader} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.page != null) query.append("page", String(args.page)) if (args.limit != null) query.append("limit", String(args.limit)) if (args.filter != null) query.append("filter", String(args.filter)) if (customHeader !== undefined) headers.set("Authorization", customHeader) const url = `${baseUrl.replace(/\/+$/, '')}/v3/commitments${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(getApiV3CommitmentsResponse, await res.json()) };