pinata 1.10.0 → 2.0.1

package/dist/index.d.ts

@@ -6,22 +6,52 @@ type PinataConfig = {
     endpointUrl?: string;
     uploadUrl?: string;
 };
-type AuthTestResponse = {
-    message: string;
+
+type AnalyticsQuery = {
+    gateway_domain: string;
+    start_date: string;
+    end_date: string;
+    cid?: string;
+    file_name?: string;
+    user_agent?: string;
+    country?: string;
+    region?: string;
+    referer?: string;
+    limit?: number;
+    sort_order?: "asc" | "desc";
 };
-type UploadResponse = {
-    id: string;
-    name: string;
-    cid: string;
-    size: number;
-    created_at: string;
-    number_of_files: number;
-    mime_type: string;
-    user_id: string;
-    group_id: string | null;
-    is_duplicate: true | null;
-    vectorized: true | null;
+type TopAnalyticsQuery = AnalyticsQuery & {
+    sort_by: "requests" | "bandwidth";
+    attribute: "cid" | "country" | "region" | "user_agent" | "referer" | "file_name";
+};
+type TopAnalyticsResponse = {
+    data: TopAnalyticsItem[];
+};
+type TopAnalyticsItem = {
+    value: string;
+    requests: number;
+    bandwidth: number;
+};
+type TimeIntervalAnalyticsQuery = AnalyticsQuery & {
+    sort_by?: "requests" | "bandwidth";
+    date_interval: "day" | "week";
+};
+type TimePeriodItem = {
+    period_start_time: string;
+    requests: number;
+    bandwidth: number;
+};
+type TimeIntervalAnalyticsResponse = {
+    total_requests: number;
+    total_bandwidth: number;
+    time_periods: TimePeriodItem[];
 };
+type UserPinnedDataResponse = {
+    pin_count: number;
+    pin_size_total: number;
+    pin_size_with_replications_total: number;
+};
+
 type FileObject = {
     name: string;
     size: number;
@@ -39,13 +69,6 @@ type UpdateFileOptions = {
     name?: string;
     keyvalues?: Record<string, string>;
 };
-type UploadOptions = {
-    metadata?: PinataMetadata;
-    keys?: string;
-    groupId?: string;
-    vectorize?: boolean;
-    url?: string;
-};
 type DeleteResponse = {
     id: string;
     status: string;
@@ -77,16 +100,17 @@ type FileListQuery = {
     limit?: number;
     pageToken?: string;
 };
-type PinJobQuery = {
+type PinQueueQuery = {
     sort?: "ASC" | "DSC";
     status?: "prechecking" | "retrieving" | "expired" | "over_free_limit" | "over_max_size" | "invalid_object" | "bad_host_node";
     ipfs_pin_hash?: string;
     limit?: number;
-    offset?: number;
+    pageToken?: string;
 };
-type PinJobItem = {
+type PinQueueItem = {
     id: string;
-    ipfs_pin_hash: string;
+    cid?: string;
+    ipfs_pin_hash?: string;
     date_queued: string;
     name: string;
     status: string;
@@ -100,9 +124,40 @@ type PinJobItem = {
         version: number;
     };
 };
-type PinJobResponse = {
-    rows: PinJobItem[];
+type PinQueueResponse = {
+    rows: PinQueueItem[];
+    next_page_token: string;
+};
+type SwapCidOptions = {
+    cid: string;
+    swapCid: string;
+};
+type SwapHistoryOptions = {
+    cid: string;
+    domain: string;
+};
+type SwapCidResponse = {
+    mapped_cid: string;
+    created_at: string;
+};
+type VectorizeFileResponse = {
+    status: boolean;
+};
+type VectorizeQuery = {
+    groupId: string;
+    query: string;
+    returnFile?: boolean;
+};
+type VectorQueryMatch = {
+    file_id: string;
+    cid: string;
+    score: number;
+};
+type VectorizeQueryResponse = {
+    count: number;
+    matches: VectorQueryMatch[];
 };
+
 type ContentType = "application/json" | "application/xml" | "text/plain" | "text/html" | "text/css" | "text/javascript" | "application/javascript" | "image/jpeg" | "image/png" | "image/gif" | "image/svg+xml" | "audio/mpeg" | "audio/ogg" | "video/mp4" | "application/pdf" | "application/octet-stream" | string | null;
 type GetCIDResponse = {
     data?: JSON | string | Blob | null;
@@ -121,56 +176,54 @@ type OptimizeImageOptions = {
     onError?: boolean;
     metadata?: "keep" | "copyright" | "none";
 };
-type SignedUrlOptions = {
+type AccessLinkOptions = {
     cid: string;
     date?: number;
     expires: number;
     gateway?: string;
 };
-type AnalyticsQuery = {
-    gateway_domain: string;
-    start_date: string;
-    end_date: string;
-    cid?: string;
-    file_name?: string;
-    user_agent?: string;
-    country?: string;
-    region?: string;
-    referer?: string;
-    limit?: number;
-    sort_order?: "asc" | "desc";
+type ContainsCIDResponse = {
+    containsCid: boolean;
+    cid: string | null;
 };
-type TopAnalyticsQuery = AnalyticsQuery & {
-    sort_by: "requests" | "bandwidth";
-    attribute: "cid" | "country" | "region" | "user_agent" | "referer" | "file_name";
+
+type GroupOptions = {
+    name: string;
+    isPublic?: boolean;
 };
-type TopAnalyticsResponse = {
-    data: TopAnalyticsItem[];
+type UpdateGroupOptions = {
+    groupId: string;
+    name?: string;
+    isPublic?: boolean;
 };
-type TopAnalyticsItem = {
-    value: string;
-    requests: number;
-    bandwidth: number;
+type GetGroupOptions = {
+    groupId: string;
 };
-type TimeIntervalAnalyticsQuery = AnalyticsQuery & {
-    sort_by?: "requests" | "bandwidth";
-    date_interval: "day" | "week";
+type GroupListResponse = {
+    groups: GroupResponseItem[];
+    next_page_token: string;
 };
-type TimePeriodItem = {
-    period_start_time: string;
-    requests: number;
-    bandwidth: number;
+type GroupResponseItem = {
+    id: string;
+    is_public: boolean;
+    name: string;
+    createdAt: string;
 };
-type TimeIntervalAnalyticsResponse = {
-    total_requests: number;
-    total_bandwidth: number;
-    time_periods: TimePeriodItem[];
+type GroupQueryOptions = {
+    name?: string;
+    limit?: number;
+    pageToken?: string;
+    isPublic?: boolean;
 };
-type UserPinnedDataResponse = {
-    pin_count: number;
-    pin_size_total: number;
-    pin_size_with_replications_total: number;
+type GroupCIDOptions = {
+    groupId: string;
+    files: string[];
+};
+type UpdateGroupFilesResponse = {
+    id: string;
+    status: string;
 };
+
 type KeyPermissions = {
     admin?: boolean;
     endpoints?: Endpoints;
@@ -240,82 +293,38 @@ type RevokeKeyResponse = {
     key: string;
     status: string;
 };
-type GroupOptions = {
-    name: string;
-    isPublic?: boolean;
-};
-type UpdateGroupOptions = {
-    groupId: string;
-    name?: string;
-    isPublic?: boolean;
-};
-type GetGroupOptions = {
-    groupId: string;
-};
-type GroupListResponse = {
-    groups: GroupResponseItem[];
-    next_page_token: string;
-};
-type GroupResponseItem = {
-    id: string;
-    is_public: boolean;
-    name: string;
-    createdAt: string;
-};
-type GroupQueryOptions = {
-    name?: string;
-    limit?: number;
-    pageToken?: string;
-    isPublic?: boolean;
-};
-type GroupCIDOptions = {
-    groupId: string;
-    files: string[];
-};
-type UpdateGroupFilesResponse = {
-    id: string;
-    status: string;
-};
+
 type SignatureOptions = {
     cid: string;
     signature: string;
+    address: string;
 };
 type SignatureResponse = {
     cid: string;
     signature: string;
 };
-type SwapCidOptions = {
-    cid: string;
-    swapCid: string;
-};
-type SwapHistoryOptions = {
+
+type UploadResponse = {
+    id: string;
+    name: string;
     cid: string;
-    domain: string;
-};
-type SwapCidResponse = {
-    mapped_cid: string;
+    size: number;
     created_at: string;
+    number_of_files: number;
+    mime_type: string;
+    group_id: string | null;
+    keyvalues: {
+        [key: string]: string;
+    };
+    vectorized: boolean;
+    network: string;
 };
-type ContainsCIDResponse = {
-    containsCid: boolean;
-    cid: string | null;
-};
-type VectorizeFileResponse = {
-    status: boolean;
-};
-type VectorizeQuery = {
-    groupId: string;
-    query: string;
-    returnFile?: boolean;
-};
-type VectorQueryMatch = {
-    file_id: string;
-    cid: string;
-    score: number;
-};
-type VectorizeQueryResponse = {
-    count: number;
-    matches: VectorQueryMatch[];
+type UploadOptions = {
+    metadata?: PinataMetadata;
+    keys?: string;
+    groupId?: string;
+    vectorize?: boolean;
+    url?: string;
 };
 type SignedUploadUrlOptions = {
     date?: number;
@@ -325,104 +334,210 @@ type SignedUploadUrlOptions = {
     keyvalues?: Record<string, string>;
     vectorize?: boolean;
 };
+type UploadCIDOptions = {
+    metadata?: PinataMetadata;
+    peerAddresses?: string[];
+    keys?: string;
+    groupId?: string;
+};
+type PinByCIDResponse = {
+    id: string;
+    cid: string;
+    status: "prechecking" | "retrieving";
+    name: string;
+};
 
-declare class PinataSDK {
+declare const analyticsDateInterval: (config: PinataConfig | undefined, options?: TimeIntervalAnalyticsQuery) => Promise<TimeIntervalAnalyticsResponse>;
+
+declare const analyticsTopUsage: (config: PinataConfig | undefined, options?: TopAnalyticsQuery) => Promise<TopAnalyticsResponse>;
+
+declare const testAuthentication: (config: PinataConfig | undefined) => Promise<string>;
+
+declare const deleteFile: (config: PinataConfig | undefined, files: string[], privacy: "public" | "private") => Promise<DeleteResponse[]>;
+
+declare const deleteFileVectors: (config: PinataConfig | undefined, fileId: string) => Promise<VectorizeFileResponse>;
+
+declare const deleteSwap: (config: PinataConfig | undefined, cid: string, network: "public" | "private") => Promise<string>;
+
+declare const listFiles: (config: PinataConfig | undefined, privacy: "private" | "public", options?: FileListQuery) => Promise<FileListResponse>;
+
+declare const pinnedFileCount: (config: PinataConfig | undefined) => Promise<number>;
+
+declare const swapCid: (config: PinataConfig | undefined, options: SwapCidOptions, network: "public" | "private") => Promise<SwapCidResponse>;
+
+declare const swapHistory: (config: PinataConfig | undefined, options: SwapHistoryOptions, network: "public" | "private") => Promise<SwapCidResponse[]>;
+
+declare const totalStorageUsage: (config: PinataConfig | undefined) => Promise<number>;
+
+declare const updateFile: (config: PinataConfig | undefined, options: UpdateFileOptions, privacy: "public" | "private") => Promise<FileListItem>;
+
+declare const vectorizeFile: (config: PinataConfig | undefined, fileId: string) => Promise<VectorizeFileResponse>;
+
+declare const vectorizeQuery: (config: PinataConfig | undefined, options: VectorizeQuery) => Promise<VectorizeQueryResponse | GetCIDResponse>;
+
+declare const queue: (config: PinataConfig | undefined, options?: PinQueueQuery) => Promise<PinQueueResponse>;
+
+declare const getCid: (config: PinataConfig | undefined, cid: string, gatewayType?: "ipfs" | "files", options?: OptimizeImageOptions) => Promise<GetCIDResponse>;
+
+declare const convertIPFSUrl: (config: PinataConfig | undefined, url: string, gatewayPrefix?: string) => Promise<string>;
+
+declare const createAccessLink: (config: PinataConfig | undefined, options: AccessLinkOptions, imgOpts: OptimizeImageOptions) => Promise<string>;
+
+declare const addToGroup: (config: PinataConfig | undefined, options: GroupCIDOptions, privacy: "public" | "private") => Promise<UpdateGroupFilesResponse[]>;
+
+declare const createGroup: (config: PinataConfig | undefined, options: GroupOptions, privacy: "public" | "private") => Promise<GroupResponseItem>;
+
+declare const deleteGroup: (config: PinataConfig | undefined, options: GetGroupOptions, privacy: "public" | "private") => Promise<string>;
+
+declare const getGroup: (config: PinataConfig | undefined, options: GetGroupOptions, privacy: "public" | "private") => Promise<GroupResponseItem>;
+
+declare const listGroups: (config: PinataConfig | undefined, privacy: "public" | "private", options?: GroupQueryOptions) => Promise<GroupListResponse>;
+
+declare const removeFromGroup: (config: PinataConfig | undefined, options: GroupCIDOptions, privacy: "public" | "private") => Promise<UpdateGroupFilesResponse[]>;
+
+declare const updateGroup: (config: PinataConfig | undefined, options: UpdateGroupOptions, privacy: "public" | "private") => Promise<GroupResponseItem>;
+
+declare const createKey: (config: PinataConfig | undefined, options: KeyOptions) => Promise<KeyResponse>;
+
+declare const listKeys: (config: PinataConfig | undefined, options?: KeyListQuery) => Promise<KeyListItem[]>;
+
+declare const revokeKeys: (config: PinataConfig | undefined, keys: string[]) => Promise<RevokeKeyResponse[]>;
+
+declare const uploadBase64: (config: PinataConfig | undefined, base64String: string, network: "private" | "public", options?: UploadOptions) => Promise<UploadResponse>;
+
+declare const createSignedUploadURL: (config: PinataConfig | undefined, options: SignedUploadUrlOptions, network: "public" | "private") => Promise<string>;
+
+declare const uploadFile: (config: PinataConfig | undefined, file: File, network: "public" | "private", options?: UploadOptions) => Promise<UploadResponse>;
+
+declare const uploadFileArray: (config: PinataConfig | undefined, files: File[], network: "public" | "private", options?: UploadOptions) => Promise<UploadResponse>;
+
+declare const uploadJson: <T extends JsonBody>(config: PinataConfig | undefined, jsonData: T, network: "public" | "private", options?: UploadOptions) => Promise<UploadResponse>;
+
+declare const uploadUrl: (config: PinataConfig | undefined, url: string, network: "public" | "private", options?: UploadOptions) => Promise<UploadResponse>;
+
+declare const uploadCid: (config: PinataConfig | undefined, cid: string, options?: UploadCIDOptions) => Promise<PinByCIDResponse>;
+
+declare class Analytics {
     config: PinataConfig | undefined;
-    files: Files;
-    upload: Upload;
-    gateways: Gateways;
-    keys: Keys;
-    groups: Groups;
-    analytics: Analytics;
+    requests: AnalyticsRequests;
+    bandwidth: AnalyticsBandwidth;
     constructor(config?: PinataConfig);
-    setNewHeaders(headers: Record<string, string>): void;
-    setNewJwt(jwt: string): void;
-    testAuthentication(): Promise<AuthTestResponse>;
+    updateConfig(newConfig: PinataConfig): void;
+    summary(options: {
+        domain: string;
+        start: string;
+        end: string;
+        interval: "day" | "week";
+    }): TimeIntervalAnalyticsBuilder;
 }
-declare class Files {
-    config: PinataConfig | undefined;
+
+declare class AnalyticsFilter {
+    protected config: PinataConfig | undefined;
+    protected query: TopAnalyticsQuery;
+    constructor(config: PinataConfig | undefined, domain: string, start: string, end: string);
+    cid(cid?: string): this;
+    fileName(fileName?: string): this;
+    userAgent(userAgent?: string): this;
+    country(country?: string): this;
+    region(region?: string): this;
+    referer(referer?: string): this;
+    limit(limit: number): this;
+    sort(order: "asc" | "desc"): this;
+    days(numberOfDays: number): this;
+    then(onfulfilled?: ((value: TopAnalyticsResponse) => any) | null): Promise<any>;
+}
+
+declare class AnalyticsBandwidth extends AnalyticsFilter {
     constructor(config?: PinataConfig);
     updateConfig(newConfig: PinataConfig): void;
-    list(): FilterFiles;
-    delete(files: string[]): Promise<DeleteResponse[]>;
-    update(options: UpdateFileOptions): Promise<FileListItem>;
-    addSwap(options: SwapCidOptions): Promise<SwapCidResponse>;
-    getSwapHistory(options: SwapHistoryOptions): Promise<SwapCidResponse[]>;
-    deleteSwap(cid: string): Promise<string>;
-    vectorize(fileId: string): Promise<VectorizeFileResponse>;
-    queryVectors(options: VectorizeQuery): Promise<VectorizeQueryResponse | GetCIDResponse>;
-    deleteVectors(fileId: string): Promise<VectorizeFileResponse>;
+    customDates(start?: string, end?: string): this;
+    from(domain: string): this;
 }
-declare class UploadBuilder<T> {
-    private config;
-    private uploadFunction;
-    private args;
-    private metadata;
-    private keys;
-    private groupId;
-    private vector;
-    private uploadUrl;
-    constructor(config: PinataConfig | undefined, uploadFunction: (config: PinataConfig | undefined, ...args: any[]) => Promise<T>, ...args: any[]);
-    addMetadata(metadata: PinataMetadata): UploadBuilder<T>;
-    key(jwt: string): UploadBuilder<T>;
-    vectorize(): UploadBuilder<T>;
-    url(url: string): UploadBuilder<T>;
-    group(groupId: string): UploadBuilder<T>;
-    then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null | undefined, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null | undefined): Promise<TResult1 | TResult2>;
+
+declare class AnalyticsBuilder<T extends AnalyticsQuery, R> {
+    protected config: PinataConfig | undefined;
+    protected query: T;
+    private requestCount;
+    private lastRequestTime;
+    private readonly MAX_REQUESTS_PER_MINUTE;
+    private readonly MINUTE_IN_MS;
+    constructor(config: PinataConfig | undefined, query: T);
+    cid(cid: string): this;
+    fileName(fileName: string): this;
+    userAgent(userAgent: string): this;
+    country(country: string): this;
+    region(region: string): this;
+    referer(referer: string): this;
+    limit(limit: number): this;
+    sort(order: "asc" | "desc"): this;
+    protected getAnalytics(): Promise<R>;
+    then(onfulfilled?: ((value: R) => any) | null): Promise<any>;
 }
-declare class Upload {
-    config: PinataConfig | undefined;
+
+declare class AnalyticsRequests extends AnalyticsFilter {
     constructor(config?: PinataConfig);
     updateConfig(newConfig: PinataConfig): void;
-    file(file: FileObject, options?: UploadOptions): UploadBuilder<UploadResponse>;
-    base64(base64String: string, options?: UploadOptions): UploadBuilder<UploadResponse>;
-    url(url: string, options?: UploadOptions): UploadBuilder<UploadResponse>;
-    json(data: object, options?: UploadOptions): UploadBuilder<UploadResponse>;
-    createSignedURL(options: SignedUploadUrlOptions): Promise<string>;
+    customDates(start?: string, end?: string): this;
+    from(domain: string): this;
 }
-declare class FilterFiles {
+
+declare class TimeIntervalAnalyticsBuilder extends AnalyticsBuilder<TimeIntervalAnalyticsQuery, TimeIntervalAnalyticsResponse> {
+    constructor(config: PinataConfig | undefined, domain: string, start: string, end: string, dateInterval: "day" | "week");
+    sortBy(sortBy: "requests" | "bandwidth"): this;
+    protected getAnalytics(): Promise<TimeIntervalAnalyticsResponse>;
+    all(): Promise<TimeIntervalAnalyticsResponse>;
+}
+
+declare class FilterGroups {
     private config;
     private query;
-    private currentPageToken;
-    constructor(config: PinataConfig | undefined);
-    name(name: string): FilterFiles;
-    group(group: string): FilterFiles;
-    cid(cid: string): FilterFiles;
-    mimeType(mimeType: string): FilterFiles;
-    order(order: "ASC" | "DESC"): FilterFiles;
-    limit(limit: number): FilterFiles;
-    cidPending(cidPending: boolean): FilterFiles;
-    metadata(keyvalues: Record<string, string>): FilterFiles;
-    noGroup(noGroup: boolean): FilterFiles;
-    pageToken(pageToken: string): FilterFiles;
-    then(onfulfilled?: ((value: FileListResponse) => any) | null): Promise<any>;
+    private privacy;
+    private nextPageToken;
+    constructor(config: PinataConfig | undefined, privacy: "private" | "public");
+    name(name: string): FilterGroups;
+    limit(limit: number): FilterGroups;
+    isPublic(isPublic: boolean): FilterGroups;
+    pageToken(pageToken: string): FilterGroups;
+    then(onfulfilled?: ((value: GroupListResponse) => any) | null): Promise<GroupListResponse>;
     private fetchPage;
-    [Symbol.asyncIterator](): AsyncGenerator<FileListItem, void, unknown>;
-    all(): Promise<FileListItem[]>;
+    [Symbol.asyncIterator](): AsyncGenerator<GroupResponseItem, void, unknown>;
+    all(): Promise<GroupResponseItem[]>;
 }
-declare class Gateways {
+
+declare class PublicGroups {
     config: PinataConfig | undefined;
     constructor(config?: PinataConfig);
     updateConfig(newConfig: PinataConfig): void;
-    get(cid: string): OptimizeImageGetCid;
-    createSignedURL(options: SignedUrlOptions): OptimizeImageCreateSignedURL;
+    create(options: GroupOptions): Promise<GroupResponseItem>;
+    list(): FilterGroups;
+    get(options: GetGroupOptions): Promise<GroupResponseItem>;
+    addFiles(options: GroupCIDOptions): Promise<UpdateGroupFilesResponse[]>;
+    removeFiles(options: GroupCIDOptions): Promise<UpdateGroupFilesResponse[]>;
+    update(options: UpdateGroupOptions): Promise<GroupResponseItem>;
+    delete(options: GetGroupOptions): Promise<string>;
 }
-declare class OptimizeImageGetCid {
-    private config;
-    private cid;
-    private options;
-    constructor(config: PinataConfig | undefined, cid: string);
-    optimizeImage(options: OptimizeImageOptions): OptimizeImageGetCid;
-    then(onfulfilled?: ((value: GetCIDResponse) => any) | null): Promise<any>;
+
+declare class PrivateGroups {
+    config: PinataConfig | undefined;
+    constructor(config?: PinataConfig);
+    updateConfig(newConfig: PinataConfig): void;
+    create(options: GroupOptions): Promise<GroupResponseItem>;
+    list(): FilterGroups;
+    get(options: GetGroupOptions): Promise<GroupResponseItem>;
+    addFiles(options: GroupCIDOptions): Promise<UpdateGroupFilesResponse[]>;
+    removeFiles(options: GroupCIDOptions): Promise<UpdateGroupFilesResponse[]>;
+    update(options: UpdateGroupOptions): Promise<GroupResponseItem>;
+    delete(options: GetGroupOptions): Promise<string>;
 }
-declare class OptimizeImageCreateSignedURL {
-    private config;
-    private urlOpts;
-    private imgOpts;
-    constructor(config: PinataConfig | undefined, urlOpts: SignedUrlOptions);
-    optimizeImage(options: OptimizeImageOptions): OptimizeImageCreateSignedURL;
-    then(onfulfilled?: ((value: string) => any) | null): Promise<any>;
+
+declare class Groups {
+    config: PinataConfig | undefined;
+    public: PublicGroups;
+    private: PrivateGroups;
+    constructor(config?: PinataConfig);
+    updateConfig(newConfig: PinataConfig): void;
 }
+
 declare class Keys {
     config: PinataConfig | undefined;
     constructor(config?: PinataConfig);
@@ -431,6 +546,7 @@ declare class Keys {
     list(): FilterKeys;
     revoke(keys: string[]): Promise<RevokeKeyResponse[]>;
 }
+
 declare class FilterKeys {
     private config;
     private query;
@@ -444,96 +560,236 @@ declare class FilterKeys {
     [Symbol.asyncIterator](): AsyncGenerator<KeyListItem, void, unknown>;
     all(): Promise<KeyListItem[]>;
 }
-declare class Groups {
+
+declare class Gateways {
     config: PinataConfig | undefined;
+    public: PublicGateways;
+    private: PrivateGateways;
     constructor(config?: PinataConfig);
     updateConfig(newConfig: PinataConfig): void;
-    create(options: GroupOptions): Promise<GroupResponseItem>;
-    list(): FilterGroups;
-    get(options: GetGroupOptions): Promise<GroupResponseItem>;
-    addFiles(options: GroupCIDOptions): Promise<UpdateGroupFilesResponse[]>;
-    removeFiles(options: GroupCIDOptions): Promise<UpdateGroupFilesResponse[]>;
-    update(options: UpdateGroupOptions): Promise<GroupResponseItem>;
-    delete(options: GetGroupOptions): Promise<string>;
 }
-declare class FilterGroups {
+
+declare class OptimizeImageCreateAccessLink {
+    private config;
+    private urlOpts;
+    private imgOpts;
+    constructor(config: PinataConfig | undefined, urlOpts: AccessLinkOptions);
+    optimizeImage(options: OptimizeImageOptions): OptimizeImageCreateAccessLink;
+    then(onfulfilled?: ((value: string) => any) | null): Promise<any>;
+}
+
+declare class OptimizeImageGetCid {
+    private config;
+    private cid;
+    private gatewayType?;
+    private options;
+    constructor(config: PinataConfig | undefined, cid: string, gatewayType?: "ipfs" | "files");
+    optimizeImage(options: OptimizeImageOptions): OptimizeImageGetCid;
+    then(onfulfilled?: ((value: GetCIDResponse) => any) | null): Promise<any>;
+}
+
+declare class PrivateGateways {
+    private config;
+    constructor(config: PinataConfig | undefined);
+    get(cid: string): OptimizeImageGetCid;
+    createAccessLink(options: AccessLinkOptions): OptimizeImageCreateAccessLink;
+}
+
+declare class PublicGateways {
+    private config;
+    constructor(config: PinataConfig | undefined);
+    get(cid: string): OptimizeImageGetCid;
+    convert(url: string, gatewayPrefix?: string): Promise<string>;
+}
+
+declare class FilterFiles {
     private config;
     private query;
-    private nextPageToken;
+    private currentPageToken;
+    private privacy;
+    constructor(config: PinataConfig | undefined, privacy: "private" | "public");
+    name(name: string): FilterFiles;
+    group(group: string): FilterFiles;
+    cid(cid: string): FilterFiles;
+    mimeType(mimeType: string): FilterFiles;
+    order(order: "ASC" | "DESC"): FilterFiles;
+    limit(limit: number): FilterFiles;
+    cidPending(cidPending: boolean): FilterFiles;
+    keyvalues(keyvalues: Record<string, string>): FilterFiles;
+    noGroup(noGroup: boolean): FilterFiles;
+    pageToken(pageToken: string): FilterFiles;
+    then(onfulfilled?: ((value: FileListResponse) => any) | null): Promise<any>;
+    private fetchPage;
+    [Symbol.asyncIterator](): AsyncGenerator<FileListItem, void, unknown>;
+    all(): Promise<FileListItem[]>;
+}
+
+declare class FilterQueue {
+    private config;
+    private query;
+    private currentPageToken;
+    private requestCount;
+    private lastRequestTime;
+    private readonly MAX_REQUESTS_PER_MINUTE;
+    private readonly MINUTE_IN_MS;
     constructor(config: PinataConfig | undefined);
-    name(name: string): FilterGroups;
-    limit(limit: number): FilterGroups;
-    isPublic(isPublic: boolean): FilterGroups;
-    pageToken(pageToken: string): FilterGroups;
-    then(onfulfilled?: ((value: GroupListResponse) => any) | null): Promise<GroupListResponse>;
+    cid(cid: string): FilterQueue;
+    status(status: "prechecking" | "retrieving" | "expired" | "over_free_limit" | "over_max_size" | "invalid_object" | "bad_host_node"): FilterQueue;
+    pageLimit(limit: number): FilterQueue;
+    pageToken(pageToken: string): FilterQueue;
     private fetchPage;
-    [Symbol.asyncIterator](): AsyncGenerator<GroupResponseItem, void, unknown>;
-    all(): Promise<GroupResponseItem[]>;
+    sort(sort: "ASC" | "DSC"): FilterQueue;
+    then(onfulfilled?: ((value: PinQueueResponse) => any) | null): Promise<any>;
+    private rateLimit;
+    [Symbol.asyncIterator](): AsyncGenerator<PinQueueItem, void, unknown>;
+    all(): Promise<PinQueueItem[]>;
 }
-declare class Analytics {
+
+declare class PublicFiles {
+    private config;
+    constructor(config?: PinataConfig);
+    list(): FilterFiles;
+    get(id: string): Promise<FileListItem>;
+    delete(files: string[]): Promise<DeleteResponse[]>;
+    update(options: UpdateFileOptions): Promise<FileListItem>;
+    addSwap(options: SwapCidOptions): Promise<SwapCidResponse>;
+    getSwapHistory(options: SwapHistoryOptions): Promise<SwapCidResponse[]>;
+    deleteSwap(cid: string): Promise<string>;
+    queue(): FilterQueue;
+}
+
+declare class PrivateFiles {
+    private config;
+    constructor(config?: PinataConfig);
+    list(): FilterFiles;
+    get(id: string): Promise<FileListItem>;
+    delete(files: string[]): Promise<DeleteResponse[]>;
+    update(options: UpdateFileOptions): Promise<FileListItem>;
+    addSwap(options: SwapCidOptions): Promise<SwapCidResponse>;
+    getSwapHistory(options: SwapHistoryOptions): Promise<SwapCidResponse[]>;
+    deleteSwap(cid: string): Promise<string>;
+    vectorize(fileId: string): Promise<VectorizeFileResponse>;
+    queryVectors(options: VectorizeQuery): Promise<VectorizeQueryResponse | GetCIDResponse>;
+    deleteVectors(fileId: string): Promise<VectorizeFileResponse>;
+}
+
+declare class Files {
     config: PinataConfig | undefined;
-    requests: AnalyticsRequests;
-    bandwidth: AnalyticsBandwidth;
+    public: PublicFiles;
+    private: PrivateFiles;
     constructor(config?: PinataConfig);
     updateConfig(newConfig: PinataConfig): void;
-    summary(options: {
-        domain: string;
-        start: string;
-        end: string;
-        interval: "day" | "week";
-    }): TimeIntervalAnalyticsBuilder;
 }
-declare class AnalyticsFilter {
-    protected config: PinataConfig | undefined;
-    protected query: TopAnalyticsQuery;
-    constructor(config: PinataConfig | undefined, domain: string, start: string, end: string);
-    cid(cid?: string): this;
-    fileName(fileName?: string): this;
-    userAgent(userAgent?: string): this;
-    country(country?: string): this;
-    region(region?: string): this;
-    referer(referer?: string): this;
-    limit(limit: number): this;
-    sort(order: "asc" | "desc"): this;
-    days(numberOfDays: number): this;
-    then(onfulfilled?: ((value: TopAnalyticsResponse) => any) | null): Promise<any>;
+
+declare class UploadBuilder<T> {
+    private config;
+    private uploadFunction;
+    private args;
+    private metadata;
+    private keys;
+    private groupId;
+    private vector;
+    private uploadUrl;
+    private peerAddresses;
+    constructor(config: PinataConfig | undefined, uploadFunction: (config: PinataConfig | undefined, ...args: any[]) => Promise<T>, ...args: any[]);
+    name(name: string): UploadBuilder<T>;
+    keyvalues(keyvalues: Record<string, string>): UploadBuilder<T>;
+    key(jwt: string): UploadBuilder<T>;
+    vectorize(): UploadBuilder<T>;
+    url(url: string): UploadBuilder<T>;
+    group(groupId: string): UploadBuilder<T>;
+    peerAddress(peerAddresses: string[]): UploadBuilder<T>;
+    then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null | undefined, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null | undefined): Promise<TResult1 | TResult2>;
 }
-declare class AnalyticsRequests extends AnalyticsFilter {
+
+declare class PublicUpload {
+    config: PinataConfig | undefined;
     constructor(config?: PinataConfig);
     updateConfig(newConfig: PinataConfig): void;
-    customDates(start?: string, end?: string): this;
-    from(domain: string): this;
+    file(file: FileObject, options?: UploadOptions): UploadBuilder<UploadResponse>;
+    fileArray(files: FileObject[], options?: UploadOptions): UploadBuilder<UploadResponse>;
+    base64(base64String: string, options?: UploadOptions): UploadBuilder<UploadResponse>;
+    url(url: string, options?: UploadOptions): UploadBuilder<UploadResponse>;
+    json(data: object, options?: UploadOptions): UploadBuilder<UploadResponse>;
+    cid(cid: string, options?: UploadCIDOptions): UploadBuilder<PinByCIDResponse>;
+    createSignedURL(options: SignedUploadUrlOptions): Promise<string>;
 }
-declare class AnalyticsBandwidth extends AnalyticsFilter {
+
+declare class PrivateUpload {
+    config: PinataConfig | undefined;
     constructor(config?: PinataConfig);
     updateConfig(newConfig: PinataConfig): void;
-    customDates(start?: string, end?: string): this;
-    from(domain: string): this;
+    file(file: FileObject, options?: UploadOptions): UploadBuilder<UploadResponse>;
+    base64(base64String: string, options?: UploadOptions): UploadBuilder<UploadResponse>;
+    url(url: string, options?: UploadOptions): UploadBuilder<UploadResponse>;
+    json(data: object, options?: UploadOptions): UploadBuilder<UploadResponse>;
+    createSignedURL(options: SignedUploadUrlOptions): Promise<string>;
 }
-declare class AnalyticsBuilder<T extends AnalyticsQuery, R> {
-    protected config: PinataConfig | undefined;
-    protected query: T;
-    private requestCount;
-    private lastRequestTime;
-    private readonly MAX_REQUESTS_PER_MINUTE;
-    private readonly MINUTE_IN_MS;
-    constructor(config: PinataConfig | undefined, query: T);
-    cid(cid: string): this;
-    fileName(fileName: string): this;
-    userAgent(userAgent: string): this;
-    country(country: string): this;
-    region(region: string): this;
-    referer(referer: string): this;
-    limit(limit: number): this;
-    sort(order: "asc" | "desc"): this;
-    protected getAnalytics(): Promise<R>;
-    then(onfulfilled?: ((value: R) => any) | null): Promise<any>;
+
+declare class Upload {
+    config: PinataConfig | undefined;
+    public: PublicUpload;
+    private: PrivateUpload;
+    constructor(config?: PinataConfig);
+    updateConfig(newConfig: PinataConfig): void;
 }
-declare class TimeIntervalAnalyticsBuilder extends AnalyticsBuilder<TimeIntervalAnalyticsQuery, TimeIntervalAnalyticsResponse> {
-    constructor(config: PinataConfig | undefined, domain: string, start: string, end: string, dateInterval: "day" | "week");
-    sortBy(sortBy: "requests" | "bandwidth"): this;
-    protected getAnalytics(): Promise<TimeIntervalAnalyticsResponse>;
-    all(): Promise<TimeIntervalAnalyticsResponse>;
+
+declare class PublicSignatures {
+    config: PinataConfig | undefined;
+    constructor(config?: PinataConfig);
+    updateConfig(newConfig: PinataConfig): void;
+    add(options: SignatureOptions): Promise<SignatureResponse>;
+    get(cid: string): Promise<SignatureResponse>;
+    delete(cid: string): Promise<string>;
 }
 
-export { type AnalyticsQuery, type AuthTestResponse, type ContainsCIDResponse, type ContentType, type DataEndponts, type DeleteResponse, type Endpoints, type FileListItem, type FileListQuery, type FileListResponse, type FileObject, type GetCIDResponse, type GetGroupOptions, type GroupCIDOptions, type GroupListResponse, type GroupOptions, type GroupQueryOptions, type GroupResponseItem, type JsonBody, type KeyListItem, type KeyListQuery, type KeyListResponse, type KeyOptions, type KeyPermissions, type KeyResponse, type OptimizeImageOptions, type PinJobItem, type PinJobQuery, type PinJobResponse, type PinataConfig, type PinataMetadata, PinataSDK, type PinningEndpoints, type RevokeKeyResponse, type SignatureOptions, type SignatureResponse, type SignedUploadUrlOptions, type SignedUrlOptions, type SwapCidOptions, type SwapCidResponse, type SwapHistoryOptions, type TimeIntervalAnalyticsQuery, type TimeIntervalAnalyticsResponse, type TimePeriodItem, type TopAnalyticsItem, type TopAnalyticsQuery, type TopAnalyticsResponse, type UpdateFileOptions, type UpdateGroupFilesResponse, type UpdateGroupOptions, type UploadOptions, type UploadResponse, type UserPinnedDataResponse, type VectorQueryMatch, type VectorizeFileResponse, type VectorizeQuery, type VectorizeQueryResponse };
+declare class Signatures {
+    config: PinataConfig | undefined;
+    public: PublicSignatures;
+    constructor(config?: PinataConfig);
+    updateConfig(newConfig: PinataConfig): void;
+}
+
+declare class PinataSDK {
+    config: PinataConfig | undefined;
+    files: Files;
+    upload: Upload;
+    gateways: Gateways;
+    keys: Keys;
+    groups: Groups;
+    analytics: Analytics;
+    signatures: Signatures;
+    constructor(config?: PinataConfig);
+    setNewHeaders(headers: Record<string, string>): void;
+    setNewJwt(jwt: string): void;
+    testAuthentication(): Promise<string>;
+}
+
+interface ErrorDetails {
+    error?: string;
+    code?: string;
+    metadata?: Record<string, any>;
+}
+declare class PinataError extends Error {
+    statusCode?: number | undefined;
+    details?: ErrorDetails | undefined;
+    constructor(message: string, statusCode?: number | undefined, details?: ErrorDetails | undefined);
+}
+declare class NetworkError extends PinataError {
+    constructor(message: string, statusCode?: number, details?: ErrorDetails);
+}
+declare class AuthenticationError extends PinataError {
+    constructor(message: string, statusCode?: number, details?: ErrorDetails);
+}
+declare class ValidationError extends PinataError {
+    constructor(message: string, details?: ErrorDetails);
+}
+
+declare function containsCID(input: string): Promise<ContainsCIDResponse>;
+declare function convertToDesiredGateway(sourceUrl: string, desiredGatewayPrefix: string | undefined): Promise<string>;
+
+declare function getFileIdFromUrl(url: string): string;
+
+declare const formatConfig: (config: PinataConfig | undefined) => PinataConfig | undefined;
+
+export { type AccessLinkOptions, type AnalyticsQuery, AuthenticationError, type ContainsCIDResponse, type ContentType, type DataEndponts, type DeleteResponse, type Endpoints, type FileListItem, type FileListQuery, type FileListResponse, type FileObject, type GetCIDResponse, type GetGroupOptions, type GroupCIDOptions, type GroupListResponse, type GroupOptions, type GroupQueryOptions, type GroupResponseItem, type JsonBody, type KeyListItem, type KeyListQuery, type KeyListResponse, type KeyOptions, type KeyPermissions, type KeyResponse, NetworkError, type OptimizeImageOptions, type PinByCIDResponse, type PinQueueItem, type PinQueueQuery, type PinQueueResponse, type PinataConfig, PinataError, type PinataMetadata, PinataSDK, type PinningEndpoints, type RevokeKeyResponse, type SignatureOptions, type SignatureResponse, type SignedUploadUrlOptions, type SwapCidOptions, type SwapCidResponse, type SwapHistoryOptions, type TimeIntervalAnalyticsQuery, type TimeIntervalAnalyticsResponse, type TimePeriodItem, type TopAnalyticsItem, type TopAnalyticsQuery, type TopAnalyticsResponse, type UpdateFileOptions, type UpdateGroupFilesResponse, type UpdateGroupOptions, type UploadCIDOptions, type UploadOptions, type UploadResponse, type UserPinnedDataResponse, ValidationError, type VectorQueryMatch, type VectorizeFileResponse, type VectorizeQuery, type VectorizeQueryResponse, addToGroup, analyticsDateInterval, analyticsTopUsage, containsCID, convertIPFSUrl, convertToDesiredGateway, createAccessLink, createGroup, createKey, createSignedUploadURL, deleteFile, deleteFileVectors, deleteGroup, deleteSwap, formatConfig, getCid, getFileIdFromUrl, getGroup, listFiles, listGroups, listKeys, pinnedFileCount, queue, removeFromGroup, revokeKeys, swapCid, swapHistory, testAuthentication, totalStorageUsage, updateFile, updateGroup, uploadBase64, uploadCid, uploadFile, uploadFileArray, uploadJson, uploadUrl, vectorizeFile, vectorizeQuery };