polar/example/convex/_generated/api.d.ts

/* eslint-disable */
/**
 * Generated `api` utility.
 *
 * THIS CODE IS AUTOMATICALLY GENERATED.
 *
 * To regenerate, run `npx convex dev`.
 * @module
 */

import type * as example from "../example.js";
import type * as http from "../http.js";

import type {
  ApiFromModules,
  FilterApi,
  FunctionReference,
} from "convex/server";
/**
 * A utility for referencing Convex functions in your app's API.
 *
 * Usage:
 * ```js
 * const myFunctionReference = api.myModule.myFunction;
 * ```
 */
declare const fullApi: ApiFromModules<{
  example: typeof example;
  http: typeof http;
}>;
declare const fullApiWithMounts: typeof fullApi;

export declare const api: FilterApi<
  typeof fullApiWithMounts,
  FunctionReference<any, "public">
>;
export declare const internal: FilterApi<
  typeof fullApiWithMounts,
  FunctionReference<any, "internal">
>;

export declare const components: {
  polar: {
    lib: {
      getBenefit: FunctionReference<
        "query",
        "internal",
        { id: string },
        {
          _creationTime: number;
          _id: string;
          createdAt: string;
          deletable: boolean;
          description: string;
          id: string;
          modifiedAt: string | null;
          organizationId: string;
          properties: Record<string, any>;
          selectable: boolean;
          type?: string;
        } | null
      >;
      getBenefitGrant: FunctionReference<
        "query",
        "internal",
        { id: string },
        {
          _creationTime: number;
          _id: string;
          benefitId: string;
          createdAt: string;
          grantedAt: string | null;
          id: string;
          isGranted: boolean;
          isRevoked: boolean;
          modifiedAt: string | null;
          orderId: string | null;
          properties: Record<string, any>;
          revokedAt: string | null;
          subscriptionId: string | null;
          userId: string;
        } | null
      >;
      getOrder: FunctionReference<
        "query",
        "internal",
        { id: string },
        {
          _creationTime: number;
          _id: string;
          amount: number;
          billingReason: string;
          checkoutId: string | null;
          createdAt: string;
          currency: string;
          id: string;
          metadata: Record<string, any>;
          modifiedAt: string | null;
          productId: string | null;
          productPriceId: string;
          subscriptionId: string | null;
          taxAmount: number;
          userId: string | null;
        } | null
      >;
      getProduct: FunctionReference<
        "query",
        "internal",
        { id: string },
        {
          _creationTime: number;
          _id: string;
          createdAt: string;
          description: string | null;
          id: string;
          isArchived: boolean;
          isRecurring: boolean;
          medias: Array<{
            checksumEtag: string | null;
            checksumSha256Base64: string | null;
            checksumSha256Hex: string | null;
            createdAt: string;
            id: string;
            isUploaded: boolean;
            lastModifiedAt: string | null;
            mimeType: string;
            name: string;
            organizationId: string;
            path: string;
            publicUrl: string;
            service?: string;
            size: number;
            sizeReadable: string;
            storageVersion: string | null;
            version: string | null;
          }>;
          modifiedAt: string | null;
          name: string;
          organizationId: string;
          prices: Array<{
            amountType?: string;
            createdAt: string;
            id: string;
            isArchived: boolean;
            modifiedAt: string | null;
            priceAmount?: number;
            priceCurrency?: string;
            productId: string;
            recurringInterval?: string;
            type?: string;
          }>;
        } | null
      >;
      getSubscription: FunctionReference<
        "query",
        "internal",
        { id: string },
        {
          _creationTime: number;
          _id: string;
          amount: number | null;
          cancelAtPeriodEnd: boolean;
          checkoutId: string | null;
          createdAt: string;
          currency: string | null;
          currentPeriodEnd: string | null;
          currentPeriodStart: string;
          endedAt: string | null;
          id: string;
          metadata: Record<string, any>;
          modifiedAt: string | null;
          priceId: string;
          productId: string;
          recurringInterval: string;
          startedAt: string | null;
          status: string;
          userId: string;
        } | null
      >;
      listBenefits: FunctionReference<
        "query",
        "internal",
        any,
        Array<{
          _creationTime: number;
          _id: string;
          createdAt: string;
          deletable: boolean;
          description: string;
          id: string;
          modifiedAt: string | null;
          organizationId: string;
          properties: Record<string, any>;
          selectable: boolean;
          type?: string;
        }>
      >;
      listProducts: FunctionReference<
        "query",
        "internal",
        { includeArchived: boolean },
        Array<{
          _creationTime: number;
          _id: string;
          createdAt: string;
          description: string | null;
          id: string;
          isArchived: boolean;
          isRecurring: boolean;
          medias: Array<{
            checksumEtag: string | null;
            checksumSha256Base64: string | null;
            checksumSha256Hex: string | null;
            createdAt: string;
            id: string;
            isUploaded: boolean;
            lastModifiedAt: string | null;
            mimeType: string;
            name: string;
            organizationId: string;
            path: string;
            publicUrl: string;
            service?: string;
            size: number;
            sizeReadable: string;
            storageVersion: string | null;
            version: string | null;
          }>;
          modifiedAt: string | null;
          name: string;
          organizationId: string;
          prices: Array<{
            amountType?: string;
            createdAt: string;
            id: string;
            isArchived: boolean;
            modifiedAt: string | null;
            priceAmount?: number;
            priceCurrency?: string;
            productId: string;
            recurringInterval?: string;
            type?: string;
          }>;
        }>
      >;
      listUserBenefitGrants: FunctionReference<
        "query",
        "internal",
        { userId: string },
        Array<{
          _creationTime: number;
          _id: string;
          benefitId: string;
          createdAt: string;
          grantedAt: string | null;
          id: string;
          isGranted: boolean;
          isRevoked: boolean;
          modifiedAt: string | null;
          orderId: string | null;
          properties: Record<string, any>;
          revokedAt: string | null;
          subscriptionId: string | null;
          userId: string;
        }>
      >;
      listUserSubscriptions: FunctionReference<
        "query",
        "internal",
        { userId: string },
        Array<{
          _creationTime: number;
          _id: string;
          amount: number | null;
          cancelAtPeriodEnd: boolean;
          checkoutId: string | null;
          createdAt: string;
          currency: string | null;
          currentPeriodEnd: string | null;
          currentPeriodStart: string;
          endedAt: string | null;
          id: string;
          metadata: Record<string, any>;
          modifiedAt: string | null;
          priceId: string;
          product?: {
            _creationTime: number;
            _id: string;
            createdAt: string;
            description: string | null;
            id: string;
            isArchived: boolean;
            isRecurring: boolean;
            medias: Array<{
              checksumEtag: string | null;
              checksumSha256Base64: string | null;
              checksumSha256Hex: string | null;
              createdAt: string;
              id: string;
              isUploaded: boolean;
              lastModifiedAt: string | null;
              mimeType: string;
              name: string;
              organizationId: string;
              path: string;
              publicUrl: string;
              service?: string;
              size: number;
              sizeReadable: string;
              storageVersion: string | null;
              version: string | null;
            }>;
            modifiedAt: string | null;
            name: string;
            organizationId: string;
            prices: Array<{
              amountType?: string;
              createdAt: string;
              id: string;
              isArchived: boolean;
              modifiedAt: string | null;
              priceAmount?: number;
              priceCurrency?: string;
              productId: string;
              recurringInterval?: string;
              type?: string;
            }>;
          };
          productId: string;
          recurringInterval: string;
          startedAt: string | null;
          status: string;
          userId: string;
        }>
      >;
      updateBenefit: FunctionReference<
        "mutation",
        "internal",
        {
          benefit: {
            createdAt: string;
            deletable: boolean;
            description: string;
            id: string;
            modifiedAt: string | null;
            organizationId: string;
            properties: Record<string, any>;
            selectable: boolean;
            type?: string;
          };
        },
        any
      >;
      updateBenefitGrant: FunctionReference<
        "mutation",
        "internal",
        {
          benefitGrant: {
            benefitId: string;
            createdAt: string;
            grantedAt: string | null;
            id: string;
            isGranted: boolean;
            isRevoked: boolean;
            modifiedAt: string | null;
            orderId: string | null;
            properties: Record<string, any>;
            revokedAt: string | null;
            subscriptionId: string | null;
            userId: string;
          };
        },
        any
      >;
      updateOrder: FunctionReference<
        "mutation",
        "internal",
        {
          order: {
            amount: number;
            billingReason: string;
            checkoutId: string | null;
            createdAt: string;
            currency: string;
            id: string;
            metadata: Record<string, any>;
            modifiedAt: string | null;
            productId: string | null;
            productPriceId: string;
            subscriptionId: string | null;
            taxAmount: number;
            userId: string | null;
          };
        },
        any
      >;
      updateProduct: FunctionReference<
        "mutation",
        "internal",
        {
          product: {
            createdAt: string;
            description: string | null;
            id: string;
            isArchived: boolean;
            isRecurring: boolean;
            medias: Array<{
              checksumEtag: string | null;
              checksumSha256Base64: string | null;
              checksumSha256Hex: string | null;
              createdAt: string;
              id: string;
              isUploaded: boolean;
              lastModifiedAt: string | null;
              mimeType: string;
              name: string;
              organizationId: string;
              path: string;
              publicUrl: string;
              service?: string;
              size: number;
              sizeReadable: string;
              storageVersion: string | null;
              version: string | null;
            }>;
            modifiedAt: string | null;
            name: string;
            organizationId: string;
            prices: Array<{
              amountType?: string;
              createdAt: string;
              id: string;
              isArchived: boolean;
              modifiedAt: string | null;
              priceAmount?: number;
              priceCurrency?: string;
              productId: string;
              recurringInterval?: string;
              type?: string;
            }>;
          };
        },
        any
      >;
      updateSubscription: FunctionReference<
        "mutation",
        "internal",
        {
          subscription: {
            amount: number | null;
            cancelAtPeriodEnd: boolean;
            checkoutId: string | null;
            createdAt: string;
            currency: string | null;
            currentPeriodEnd: string | null;
            currentPeriodStart: string;
            endedAt: string | null;
            id: string;
            metadata: Record<string, any>;
            modifiedAt: string | null;
            priceId: string;
            productId: string;
            recurringInterval: string;
            startedAt: string | null;
            status: string;
            userId: string;
          };
        },
        any
      >;
    };
  };
};