import {z} from 'zod' export type GetApiAccountsPlansPlanIdPurchasesArgs = {planId: string, offset?: number | undefined, limit?: number | undefined}; export type GetApiAccountsPlansPlanIdPurchasesOptions = {baseUrl?: string | undefined, BasicAuth?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const bTAPIApplicationSummaryInfo = z.object({applicationOwnerType: z.number().int().optional(), clientId: z.string().optional(), description: z.string().optional(), href: z.string().optional(), id: z.string().optional(), name: z.string().optional(), state: z.number().int().optional(), viewRef: z.string().optional()}); export const bTAddressInfo = z.object({address: z.string().optional(), city: z.string().optional(), country: z.string().optional(), countryCode: z.string().optional(), id: z.string().optional(), state: z.string().optional(), stateCode: z.string().optional(), zip: z.string().optional()}); export const bTCardInfo = z.object({billingAddress: bTAddressInfo.optional(), expMonth: z.number().int().optional(), expYear: z.number().int().optional(), last4: z.string().optional(), name: z.string().optional(), paymentMethodId: z.string().optional(), type: z.string().optional()}); export const nextCharge = z.object({amount: z.number().int().optional(), currentPeriodEnd: z.string().optional(), interval: z.string().optional(), total: z.number().int().optional()}); export const bTCompanySummaryInfo = z.object({admin: z.boolean().optional(), awsCmkKmsArn: z.string().optional(), description: z.string().optional(), domainPrefix: z.string().optional(), enterpriseBaseUrl: z.string().optional(), enterpriseSubtype: z.number().int().optional(), href: z.string().optional(), id: z.string().optional(), image: z.string().optional(), name: z.string().optional(), noPublicDocuments: z.boolean().optional(), ownerId: z.string().optional(), secondaryDomainPrefixes: z.array(z.string()).optional(), state: z.number().int().optional(), type: z.number().int().optional(), viewRef: z.string().optional()}); export const globalPermissionInfo = z.object({accessReports: z.boolean().optional(), adminEnterprise: z.boolean().optional(), allowAccessToPublicLibraries: z.boolean().optional(), allowAppStoreAccess: z.boolean().optional(), allowManagingPublicLibraries: z.boolean().optional(), allowPublicDocumentsAccess: z.boolean().optional(), approveReleases: z.boolean().optional(), branchLockPermissions: z.boolean().optional(), createDocumentsInRoot: z.boolean().optional(), createProject: z.boolean().optional(), createReleases: z.boolean().optional(), createTasks: z.boolean().optional(), deletePermanently: z.boolean().optional(), enableLabs: z.boolean().optional(), exportFiles: z.boolean().optional(), importFiles: z.boolean().optional(), makePersonalCopies: z.boolean().optional(), manageGuestUsers: z.boolean().optional(), manageNonGeometricItems: z.boolean().optional(), manageRbac: z.boolean().optional(), manageStandardContentMetadata: z.boolean().optional(), manageUsers: z.boolean().optional(), manageWorkflows: z.boolean().optional(), shareForAnonymousAccess: z.boolean().optional(), transferDocumentsFromEnterprise: z.boolean().optional(), useRevisionTools: z.boolean().optional()}); export const bTUserSummaryInfo = z.object({jsonType: z.string(), href: z.string().optional(), id: z.string().optional(), name: z.string().optional(), viewRef: z.string().optional(), image: z.string().optional(), isOnshapeSupport: z.boolean().optional(), state: z.number().int().optional(), documentationName: z.string().optional(), email: z.string().optional(), firstName: z.string().optional(), lastName: z.string().optional(), canMakePersonalCopies: z.boolean().optional(), company: bTCompanySummaryInfo.optional(), companyUserState: z.number().int().optional(), confirmationRequested: z.boolean().optional(), documentationNameOverride: z.string().optional(), globalPermissions: globalPermissionInfo.optional(), invitationState: z.number().int().optional(), isExternal: z.boolean().optional(), isGuest: z.boolean().optional(), isLight: z.boolean().optional(), lastLoginTime: z.string().optional(), personalMessageAllowed: z.boolean().optional(), scheduledRemovalDate: z.string().optional(), showOffBoardingNotification: z.boolean().optional(), source: z.number().int().optional()}); export const bTDiscountInfo = z.object({accountBalance: z.number().int().optional(), amountOff: z.number().int().optional(), couponType: z.number().int().optional(), couponValidMonths: z.number().int().optional(), createdAt: z.string().optional(), createdBy: bTUserSummaryInfo.optional(), expiresAt: z.string().optional(), href: z.string().optional(), id: z.string().optional(), name: z.string().optional(), ownerId: z.string().optional(), percentOff: z.number().int().optional(), planId: z.string().optional(), trialEndDate: z.string().optional(), usedAt: z.string().optional(), viewRef: z.string().optional()}); export const bTBillingPlanInfo = z.object({amountCents: z.number().int().optional(), applicationId: z.string().optional(), clientId: z.string().optional(), companyPlan: z.boolean().optional(), consumableQuantity: z.number().int().optional(), deprecated: z.boolean().optional(), description: z.string().optional(), discountInfo: bTDiscountInfo.optional(), group: z.string().optional(), hidden: z.boolean().optional(), href: z.string().optional(), id: z.string().optional(), interval: z.string().optional(), name: z.string().optional(), onshapePlan: z.boolean().optional(), planType: z.number().int().optional(), trialPeriodDays: z.number().int().optional(), viewRef: z.string().optional()}); export const proratedCharges = z.object({amount: z.number().int().optional(), date: z.string().optional(), description: z.string().optional()}); export const bTPlanSubscriberInfo = z.object({email: z.string().optional(), firstName: z.string().optional(), href: z.string().optional(), id: z.string().optional(), image: z.string().optional(), lastName: z.string().optional(), name: z.string().optional(), state: z.number().int().optional(), viewRef: z.string().optional()}); export const bTPurchaseInfo = z.object({accountId: z.string().optional(), actualAmountPaidCents: z.number().int().optional(), amountCents: z.number().int().optional(), apiAllocationByPlan: z.number().int().optional(), apiAllocationEndDate: z.string().optional(), apiAllocationOverride: z.number().int().optional(), apiAllocationStartDate: z.string().optional(), application: bTAPIApplicationSummaryInfo.optional(), canceledAt: z.string().optional(), card: bTCardInfo.optional(), clientId: z.string().optional(), couponAmountOff: z.number().int().optional(), couponPercentOff: z.number().int().optional(), createdBy: z.string().optional(), currency: z.string().optional(), duration: z.number().int().optional(), durationMonths: z.number().int().optional(), group: z.string().optional(), href: z.string().optional(), id: z.string().optional(), lastModified: z.string().optional(), lastModifiedBy: z.string().optional(), lightSeats: z.number().int().optional(), name: z.string().optional(), nextCharge: nextCharge.optional(), overageEnabled: z.boolean().optional(), paymentType: z.number().int().optional(), pendingCancelation: z.boolean().optional(), plan: bTBillingPlanInfo.optional(), planId: z.string().optional(), planName: z.string().optional(), planType: z.number().int().optional(), preTrialPlanId: z.string().optional(), proratedCharges: z.array(proratedCharges).optional(), proratedTotal: z.number().int().optional(), purchaseDate: z.string().optional(), resellerName: z.string().optional(), seats: z.number().int().optional(), state: z.number().int().optional(), subscribers: z.array(bTPlanSubscriberInfo).optional(), subscriptionBeginAt: z.string().optional(), subscriptionEndAt: z.string().optional(), subscriptionId: z.string().optional(), subscriptionType: z.number().int().optional(), taxAmountCents: z.number().int().optional(), trialEnd: z.string().optional(), trialInitiatedBy: z.string().optional(), viewRef: z.string().optional()}); export const bTListResponseBTPurchaseInfo = z.object({href: z.string().optional(), items: z.array(bTPurchaseInfo).optional(), next: z.string().optional(), previous: z.string().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 }; /** * Get a list of all app purchases made for the specified plan. * * GET /accounts/plans/{planId}/purchases */ export const getApiAccountsPlansPlanIdPurchases = async (args: GetApiAccountsPlansPlanIdPurchasesArgs, options?: GetApiAccountsPlansPlanIdPurchasesOptions) => { const {baseUrl = "https://api.onshape.com/api/v17", fetch: fetchFn = fetch, BasicAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json;charset=UTF-8; qs=0.09") if (args.offset != null) query.append("offset", String(args.offset)) if (args.limit != null) query.append("limit", String(args.limit)) if (BasicAuth !== undefined) headers.set('authorization', `Basic ${btoa(`${BasicAuth.username}:${BasicAuth.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/accounts/plans/${encodeURIComponent(String(args.planId))}/purchases${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(bTListResponseBTPurchaseInfo, await res.json()) };