file.types.ts

import type {
  BaseLemonsqueezyResponse,
  LemonsqueezyDataType,
  PaginatedBaseLemonsqueezyResponse,
  SharedLemonsqueezyOptions,
} from "~/shared";

/**
 * @docs https://docs.lemonsqueezy.com/api/files#the-file-object
 */
export interface LemonsqueezyFile {
  attributes: {
    /**
     * An ISO-8601 formatted date-time string indicating when the object was created
     *
     * @see https://en.wikipedia.org/wiki/ISO_8601
     */
    createdAt: Date;
    /**
     * The unique URL to download the file. Note: for security reasons, download URLs are signed, expire after 1 hour and are rate-limited to 10 downloads per day per IP address
     */
    download_url: string;
    /**
     * The file extension of the file (e.g. `pdf`)
     */
    extension: string;
    /**
     * The unique identifier (UUID) for this file
     */
    identifier: string;
    /**
     * The name of the file (e.g. `example.pdf`)
     */
    name: string;
    /**
     * The human-readable size of the file (e.g. `5.5 MB`)
     */
    size_formatted: string;
    /**
     * A positive integer in bytes representing the size of the file
     */
    size: number;
    /**
     * An integer representing the order of this file when displayed
     */
    sort: number;
    /**
     * The status of the file. Either `draft` or `published`
     */
    status: "draft" | "published";
    /**
     * An ISO-8601 formatted date-time string indicating when the object was last updated
     *
     * @see https://en.wikipedia.org/wiki/ISO_8601
     */
    updatedAt: Date;
    /**
     * The ID of the variant this file belongs to
     */
    variant_id: number;
    /**
     * The software version of this file (if one exists, e.g. `1.0.0`)
     */
    version: string;
  };
  type: LemonsqueezyDataType.files;
  id: string;
}

export interface ListAllFilesOptions extends SharedLemonsqueezyOptions {
  /**
   * Only return files belonging to the variant with this ID
   */
  variantId?: string;
}

export type ListAllFilesResult = PaginatedBaseLemonsqueezyResponse<
  Array<LemonsqueezyFile>
>;

export interface RetrieveFileOptions extends SharedLemonsqueezyOptions {
  id: string;
}

export type RetrieveFileResult = BaseLemonsqueezyResponse<LemonsqueezyFile>;