import {z} from 'zod' export type PageLimit = number; export type PageCursor = string; export type ContractStatus = 'ACTIVE' | 'IN_EFFECT' | 'CANCELLED' | 'ENDED' | 'AMENDED'; export type GetApiContractsArgs = {limit?: PageLimit | undefined, cursor?: PageCursor | undefined, subsidiary_id?: string | undefined, status?: ContractStatus | undefined, 'start_date.gt'?: string | undefined, 'start_date.gte'?: string | undefined, 'start_date.lt'?: string | undefined, 'start_date.lte'?: string | undefined, 'end_date.gt'?: string | undefined, 'end_date.gte'?: string | undefined, 'end_date.lt'?: string | undefined, 'end_date.lte'?: string | undefined, customer_id?: string | undefined}; export type GetApiContractsOptions = {baseUrl?: string | undefined, bearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const productType = z.enum(["PRODUCT", "BUNDLE"]); export const currencyCode = z.string(); export const monetaryAmount = z.object({amount: z.string(), currency: currencyCode}); export const fixedRecurringPrice = z.object({amount: monetaryAmount, interval_months: z.number().int().gte(1).lte(12), type: z.string()}); export const oneTimePrice = z.object({amount: monetaryAmount, type: z.string()}); export const perUnitBilling = z.object({type: z.string(), amount: monetaryAmount, units: z.number().int().gte(1)}); export const tier = z.object({up_to: z.number().int().gte(1), flat_price: monetaryAmount.optional(), per_unit_price: monetaryAmount.optional()}); export const tieredBilling = z.object({type: z.string(), mode: z.enum(["GRADUATED", "METERED"]), tiers: z.array(tier)}); export const billingScheme = z.discriminatedUnion("type", [perUnitBilling, tieredBilling]); export const usagePrice = z.object({interval_months: z.number().int().gte(1).lte(12), type: z.string(), billing_scheme: billingScheme}); export const price = z.discriminatedUnion("type", [fixedRecurringPrice, oneTimePrice, usagePrice]); export const roundedMonetaryAmount = z.object({amount: z.string(), currency: currencyCode}); export const revenuePattern = z.enum(["DAILY", "EVEN_PERIOD", "PROGRESS"]); export const progressMeasure = z.literal("MILESTONES"); export const milestoneValueMode = z.enum(["PERCENTAGE", "AMOUNT"]); export const contractMilestoneStatus = z.enum(["OPEN", "DUE_THIS_PERIOD", "OVERDUE", "COMPLETED", "CANCELLED"]); export const externalReference = z.object({type: z.string(), id: z.string(), url: z.string().optional()}); export const contractMilestoneCancellation = z.object({effective_date: z.string(), credit_memo_id: z.string().nullable().optional()}); export const contractMilestone = z.object({id: z.string(), key: z.string(), name: z.string(), sequence: z.number().int(), percentage: z.string().nullable().optional(), allocated_amount: roundedMonetaryAmount.nullable().optional(), amount: roundedMonetaryAmount.nullable().optional(), expected_date: z.string().nullable().optional(), status: contractMilestoneStatus, completed_date: z.string().nullable().optional(), memo: z.string().nullable().optional(), external_references: z.array(externalReference), cancellation: contractMilestoneCancellation.nullable().optional()}); export const progressPlan = z.object({measure: progressMeasure, value_mode: milestoneValueMode, as_of_date: z.string(), milestones: z.array(contractMilestone)}); export const amountDiscount = z.object({amount_off: roundedMonetaryAmount, type: z.string().optional()}); export const percentageDiscount = z.object({percentage_off: z.number().gte(0).lte(100), type: z.string().optional()}); export const discount = z.discriminatedUnion("type", [amountDiscount, percentageDiscount]); export const countryCode = z.string(); export const taxRate = z.object({percentage: z.string(), tax_amount: roundedMonetaryAmount.optional(), country: countryCode, type: z.enum(["VAT", "SALES_TAX"]), description: z.string()}); export const fieldAssignments = z.array(z.object({field_id: z.string(), field_value_id: z.string()})); export const accountCode = z.string(); export const usageCommitment = z.object({amount: roundedMonetaryAmount, revenue_account: accountCode}); export const bundleInvoiceDisplay = z.enum(["BUNDLE_AND_COMPONENTS", "BUNDLE_LINE_ONLY"]); export const contractItemBundleComponent = z.object({id: z.string(), product_id: z.string(), product_name: z.string(), quantity: z.string(), revenue_pattern: revenuePattern, allocated_amount: roundedMonetaryAmount}); export const contractItemBundle = z.object({invoice_display: bundleInvoiceDisplay, components: z.array(contractItemBundleComponent)}); export const contractItem = z.object({id: z.string(), product_id: z.string(), product_type: productType, price: price, quantity: z.string(), total_value: roundedMonetaryAmount, revenue_pattern: revenuePattern.optional(), progress_plan: progressPlan.nullable().optional(), discount: discount.optional(), tax_rate: taxRate.optional(), start_date: z.string(), end_date: z.string().optional(), status: z.enum(["AMENDED", "ACTIVE"]), amending: z.string().optional(), fields: fieldAssignments.optional(), external_references: z.array(externalReference), usage_minimum_commitment: usageCommitment.optional(), description: z.string().optional(), bundle: contractItemBundle.optional(), declared_ssp: monetaryAmount.nullable().optional()}); export const contractStatus = z.enum(["ACTIVE", "IN_EFFECT", "CANCELLED", "ENDED", "AMENDED"]); export const monthlyInvoicing = z.object({payment_terms: z.number().int().gte(0), interval: z.string(), day: z.number().int().gte(1).lte(31)}); export const monthlyProratedInvoicing = z.object({payment_terms: z.number().int().gte(0), interval: z.string(), day: z.number().int().gte(1).lte(31)}); export const quarterlyInvoicing = z.object({payment_terms: z.number().int().gte(0), interval: z.string(), month_day: z.string()}); export const semiAnnualInvoicing = z.object({payment_terms: z.number().int().gte(0), interval: z.string(), month_day: z.string()}); export const yearlyInvoicing = z.object({payment_terms: z.number().int().gte(0), interval: z.string(), month_day: z.string()}); export const invoicing = z.discriminatedUnion("interval", [monthlyInvoicing, monthlyProratedInvoicing, quarterlyInvoicing, semiAnnualInvoicing, yearlyInvoicing]); export const usageInvoicingFrequency = z.enum(["MONTHLY", "QUARTERLY", "SEMI_ANNUAL", "YEARLY"]); export const paymentTerms = z.number().int().gte(0); export const usageInvoiceDate = z.enum(["FIRST_DAY_OF_NEXT_CYCLE", "LAST_DAY_OF_CURRENT_CYCLE"]); export const usageInvoiceCycle = z.enum(["CALENDAR", "SUBSCRIPTION_ANNIVERSARY"]); export const usageInvoicing = z.object({frequency: usageInvoicingFrequency, payment_terms: paymentTerms, invoice_date: usageInvoiceDate, cycle: usageInvoiceCycle}); export const minimumCommitmentInvoicingFrequency = z.enum(["MONTHLY", "MONTHLY_PRORATED", "QUARTERLY", "SEMI_ANNUAL", "YEARLY"]); export const minimumCommitmentInvoicing = z.object({frequency: minimumCommitmentInvoicingFrequency, payment_terms: paymentTerms}); export const usageConfiguration = z.object({usage_invoicing: usageInvoicing, minimum_commitment_invoicing: minimumCommitmentInvoicing.optional(), minimum_commitment_cycle: z.enum(["MONTHLY", "CONTRACT"]).optional(), contract_level_minimum_commitment: usageCommitment.optional()}); export const exchangeRate = z.object({base: currencyCode, target: currencyCode, rate: z.string(), date: z.string()}); export const customerAddress = z.object({id: z.string().optional(), line1: z.string(), line2: z.string().nullable().optional(), city: z.string(), state: z.string().nullable().optional(), zip_code: z.string(), country: countryCode}); export const emailSelectionMode = z.enum(["ALL_CUSTOMER_EMAILS", "SELECTED_EMAILS"]); export const emailRecipientType = z.enum(["MAIN_SENDER", "CC", "BCC"]); export const emailRecipient = z.object({customer_email_id: z.string(), recipient_type: emailRecipientType}); export const emailRecipients = z.array(emailRecipient); export const emailSelection = z.object({mode: emailSelectionMode, recipients: emailRecipients.nullable().optional()}); export const contract = z.object({id: z.string(), customer_id: z.string(), subsidiary_id: z.string(), name: z.string(), items: z.array(contractItem), status: contractStatus, start_date: z.string(), end_date: z.string().optional(), close_date: z.string(), invoicing: invoicing, usage_configuration: usageConfiguration.optional(), total_value: roundedMonetaryAmount, external_references: z.array(externalReference).optional(), exchange_rate: exchangeRate.optional(), metadata: z.record(z.string(), z.string()).optional(), purchase_order_number: z.string().optional(), shipping_customer_id: z.string().nullable().optional(), billing_address: customerAddress.nullable().optional(), shipping_address: customerAddress.nullable().optional(), email_selection: emailSelection}); export const pageCursor = z.string(); export const pagination = z.object({next_cursor: pageCursor.optional()}); export const getApiContractsResponse = z.object({contracts: z.array(contract), pagination: pagination.optional()}); 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 }; /** * Lists all contracts * * GET /contracts */ export const getApiContracts = async (args: GetApiContractsArgs, options?: GetApiContractsOptions) => { const {baseUrl = "https://api.rillet.com", fetch: fetchFn = fetch, bearerAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.limit != null) query.append("limit", String(args.limit)) if (args.cursor != null) query.append("cursor", String(args.cursor)) if (args.subsidiary_id != null) query.append("subsidiary_id", String(args.subsidiary_id)) if (args.status != null) query.append("status", String(args.status)) if (args['start_date.gt'] != null) query.append("start_date.gt", String(args['start_date.gt'])) if (args['start_date.gte'] != null) query.append("start_date.gte", String(args['start_date.gte'])) if (args['start_date.lt'] != null) query.append("start_date.lt", String(args['start_date.lt'])) if (args['start_date.lte'] != null) query.append("start_date.lte", String(args['start_date.lte'])) if (args['end_date.gt'] != null) query.append("end_date.gt", String(args['end_date.gt'])) if (args['end_date.gte'] != null) query.append("end_date.gte", String(args['end_date.gte'])) if (args['end_date.lt'] != null) query.append("end_date.lt", String(args['end_date.lt'])) if (args['end_date.lte'] != null) query.append("end_date.lte", String(args['end_date.lte'])) if (args.customer_id != null) query.append("customer_id", String(args.customer_id)) if (bearerAuth !== undefined) headers.set('authorization', `Bearer ${bearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/contracts${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(getApiContractsResponse, await res.json()) };