pinata 2.5.2 → 2.5.3

package/dist/index.d.mts

@@ -175,6 +175,73 @@ type SignatureResponse = {
     signature: string;
 };
 
+type NetworkIdentifier = "base" | "base-sepolia" | "eip155:8453" | "eip155:84532";
+interface PaymentRequirement {
+    asset: string;
+    pay_to: string;
+    network: NetworkIdentifier;
+    amount: string;
+    description?: string;
+}
+interface PaymentInstruction {
+    id: string;
+    version: number;
+    payment_requirements: PaymentRequirement[];
+    name: string;
+    description?: string;
+    created_at: string;
+}
+interface CreatePaymentInstructionRequest {
+    name: string;
+    payment_requirements: PaymentRequirement[];
+    description?: string;
+}
+interface UpdatePaymentInstructionRequest {
+    name?: string;
+    payment_requirements?: PaymentRequirement[];
+    description?: string;
+}
+interface PaymentInstructionListQuery {
+    limit?: number;
+    pageToken?: string;
+    cid?: string;
+    name?: string;
+    id?: string;
+}
+interface PaymentInstructionListResponse {
+    data: {
+        payment_instructions: PaymentInstruction[];
+        next_page_token?: string;
+    };
+}
+interface PaymentInstructionResponse {
+    data: PaymentInstruction;
+}
+interface PaymentInstructionDeleteResponse {
+    data: {};
+}
+interface CidListQuery {
+    limit?: number;
+    pageToken?: string;
+}
+interface CidListResponse {
+    data: {
+        cids: string[];
+        next_page_token?: string;
+    };
+}
+interface CidAssociation {
+    payment_instruction_id: string;
+    cid: string;
+    created_at: string;
+}
+interface CidAssociationResponse {
+    data: CidAssociation;
+}
+interface CidRemoveResponse {
+    data: {};
+}
+
 declare const analyticsDateInterval: (config: PinataConfig | undefined, options?: TimeIntervalAnalyticsQuery) => Promise<TimeIntervalAnalyticsResponse>;
 
 declare const analyticsTopUsage: (config: PinataConfig | undefined, options?: TopAnalyticsQuery) => Promise<TopAnalyticsResponse>;
@@ -247,6 +314,22 @@ declare const uploadUrl: (config: PinataConfig | undefined, url: string, network
 
 declare const uploadCid: (config: PinataConfig | undefined, cid: string, options?: UploadCIDOptions) => Promise<PinByCIDResponse>;
 
+declare const listPaymentInstructions: (config: PinataConfig | undefined, options?: PaymentInstructionListQuery) => Promise<PaymentInstructionListResponse>;
+
+declare const createPaymentInstruction: (config: PinataConfig | undefined, request: CreatePaymentInstructionRequest) => Promise<PaymentInstructionResponse>;
+
+declare const getPaymentInstruction: (config: PinataConfig | undefined, id: string) => Promise<PaymentInstructionResponse>;
+
+declare const updatePaymentInstruction: (config: PinataConfig | undefined, id: string, request: UpdatePaymentInstructionRequest) => Promise<PaymentInstructionResponse>;
+
+declare const deletePaymentInstruction: (config: PinataConfig | undefined, id: string) => Promise<PaymentInstructionDeleteResponse>;
+
+declare const listCids: (config: PinataConfig | undefined, paymentInstructionId: string, options?: CidListQuery) => Promise<CidListResponse>;
+
+declare const addCid: (config: PinataConfig | undefined, paymentInstructionId: string, cid: string) => Promise<CidAssociationResponse>;
+
+declare const removeCid: (config: PinataConfig | undefined, paymentInstructionId: string, cid: string) => Promise<CidRemoveResponse>;
+
 declare class Analytics {
     config: PinataConfig | undefined;
     requests: AnalyticsRequests;
@@ -587,6 +670,20 @@ declare class Signatures {
     updateConfig(newConfig: PinataConfig): void;
 }
 
+declare class X402 {
+    config: PinataConfig | undefined;
+    constructor(config?: PinataConfig);
+    updateConfig(newConfig: PinataConfig): void;
+    listPaymentInstructions(options?: PaymentInstructionListQuery): Promise<PaymentInstructionListResponse>;
+    createPaymentInstruction(request: CreatePaymentInstructionRequest): Promise<PaymentInstructionResponse>;
+    getPaymentInstruction(id: string): Promise<PaymentInstructionResponse>;
+    updatePaymentInstruction(id: string, request: UpdatePaymentInstructionRequest): Promise<PaymentInstructionResponse>;
+    deletePaymentInstruction(id: string): Promise<PaymentInstructionDeleteResponse>;
+    listCids(paymentInstructionId: string, options?: CidListQuery): Promise<CidListResponse>;
+    addCid(paymentInstructionId: string, cid: string): Promise<CidAssociationResponse>;
+    removeCid(paymentInstructionId: string, cid: string): Promise<CidRemoveResponse>;
+}
+
 declare class PinataSDK {
     config: PinataConfig | undefined;
     files: Files;
@@ -596,6 +693,7 @@ declare class PinataSDK {
     groups: Groups;
     analytics: Analytics;
     signatures: Signatures;
+    x402: X402;
     constructor(config?: PinataConfig);
     setNewHeaders(headers: Record<string, string>): void;
     setNewJwt(jwt: string): void;
@@ -606,4 +704,4 @@ declare function getFileIdFromUrl(url: string): string;
 
 declare const formatConfig: (config: PinataConfig | undefined) => PinataConfig | undefined;
 
-export { AccessLinkOptions, type AnalyticsQuery, CidVersion, type DataEndponts, DeleteResponse, type Endpoints, FileListItem, FileListQuery, FileListResponse, GetCIDResponse, type GetGroupOptions, type GroupCIDOptions, type GroupListResponse, type GroupOptions, type GroupQueryOptions, type GroupResponseItem, JsonBody, type KeyListItem, type KeyListQuery, type KeyListResponse, type KeyOptions, type KeyPermissions, type KeyResponse, OptimizeImageOptions, PinByCIDResponse, PinQueueItem, PinQueueQuery, PinQueueResponse, type PinataConfig, PinataSDK, type PinningEndpoints, type ResourcePermission, type RevokeKeyResponse, type SignatureOptions, type SignatureResponse, SignedUploadUrlOptions, SwapCidOptions, SwapCidResponse, SwapHistoryOptions, type TimeIntervalAnalyticsQuery, type TimeIntervalAnalyticsResponse, type TimePeriodItem, type TopAnalyticsItem, type TopAnalyticsQuery, type TopAnalyticsResponse, UpdateFileOptions, type UpdateGroupFilesResponse, type UpdateGroupOptions, UploadCIDOptions, UploadOptions, UploadResponse, type UserPinnedDataResponse, VectorizeFileResponse, VectorizeQuery, VectorizeQueryResponse, addToGroup, analyticsDateInterval, analyticsTopUsage, convertIPFSUrl, createAccessLink, createGroup, createKey, createSignedUploadURL, deleteFile, deleteFileVectors, deleteGroup, deletePinRequest, 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 };
+export { AccessLinkOptions, type AnalyticsQuery, type CidAssociation, type CidAssociationResponse, type CidListQuery, type CidListResponse, type CidRemoveResponse, CidVersion, type CreatePaymentInstructionRequest, type DataEndponts, DeleteResponse, type Endpoints, FileListItem, FileListQuery, FileListResponse, GetCIDResponse, type GetGroupOptions, type GroupCIDOptions, type GroupListResponse, type GroupOptions, type GroupQueryOptions, type GroupResponseItem, JsonBody, type KeyListItem, type KeyListQuery, type KeyListResponse, type KeyOptions, type KeyPermissions, type KeyResponse, type NetworkIdentifier, OptimizeImageOptions, type PaymentInstruction, type PaymentInstructionDeleteResponse, type PaymentInstructionListQuery, type PaymentInstructionListResponse, type PaymentInstructionResponse, type PaymentRequirement, PinByCIDResponse, PinQueueItem, PinQueueQuery, PinQueueResponse, type PinataConfig, PinataSDK, type PinningEndpoints, type ResourcePermission, type RevokeKeyResponse, type SignatureOptions, type SignatureResponse, SignedUploadUrlOptions, SwapCidOptions, SwapCidResponse, SwapHistoryOptions, type TimeIntervalAnalyticsQuery, type TimeIntervalAnalyticsResponse, type TimePeriodItem, type TopAnalyticsItem, type TopAnalyticsQuery, type TopAnalyticsResponse, UpdateFileOptions, type UpdateGroupFilesResponse, type UpdateGroupOptions, type UpdatePaymentInstructionRequest, UploadCIDOptions, UploadOptions, UploadResponse, type UserPinnedDataResponse, VectorizeFileResponse, VectorizeQuery, VectorizeQueryResponse, addCid, addToGroup, analyticsDateInterval, analyticsTopUsage, convertIPFSUrl, createAccessLink, createGroup, createKey, createPaymentInstruction, createSignedUploadURL, deleteFile, deleteFileVectors, deleteGroup, deletePaymentInstruction, deletePinRequest, deleteSwap, formatConfig, getCid, getFileIdFromUrl, getGroup, getPaymentInstruction, listCids, listFiles, listGroups, listKeys, listPaymentInstructions, pinnedFileCount, queue, removeCid, removeFromGroup, revokeKeys, swapCid, swapHistory, testAuthentication, totalStorageUsage, updateFile, updateGroup, updatePaymentInstruction, uploadBase64, uploadCid, uploadFile, uploadFileArray, uploadJson, uploadUrl, vectorizeFile, vectorizeQuery };

package/dist/index.d.ts

@@ -175,6 +175,73 @@ type SignatureResponse = {
     signature: string;
 };
 
+type NetworkIdentifier = "base" | "base-sepolia" | "eip155:8453" | "eip155:84532";
+interface PaymentRequirement {
+    asset: string;
+    pay_to: string;
+    network: NetworkIdentifier;
+    amount: string;
+    description?: string;
+}
+interface PaymentInstruction {
+    id: string;
+    version: number;
+    payment_requirements: PaymentRequirement[];
+    name: string;
+    description?: string;
+    created_at: string;
+}
+interface CreatePaymentInstructionRequest {
+    name: string;
+    payment_requirements: PaymentRequirement[];
+    description?: string;
+}
+interface UpdatePaymentInstructionRequest {
+    name?: string;
+    payment_requirements?: PaymentRequirement[];
+    description?: string;
+}
+interface PaymentInstructionListQuery {
+    limit?: number;
+    pageToken?: string;
+    cid?: string;
+    name?: string;
+    id?: string;
+}
+interface PaymentInstructionListResponse {
+    data: {
+        payment_instructions: PaymentInstruction[];
+        next_page_token?: string;
+    };
+}
+interface PaymentInstructionResponse {
+    data: PaymentInstruction;
+}
+interface PaymentInstructionDeleteResponse {
+    data: {};
+}
+interface CidListQuery {
+    limit?: number;
+    pageToken?: string;
+}
+interface CidListResponse {
+    data: {
+        cids: string[];
+        next_page_token?: string;
+    };
+}
+interface CidAssociation {
+    payment_instruction_id: string;
+    cid: string;
+    created_at: string;
+}
+interface CidAssociationResponse {
+    data: CidAssociation;
+}
+interface CidRemoveResponse {
+    data: {};
+}
+
 declare const analyticsDateInterval: (config: PinataConfig | undefined, options?: TimeIntervalAnalyticsQuery) => Promise<TimeIntervalAnalyticsResponse>;
 
 declare const analyticsTopUsage: (config: PinataConfig | undefined, options?: TopAnalyticsQuery) => Promise<TopAnalyticsResponse>;
@@ -247,6 +314,22 @@ declare const uploadUrl: (config: PinataConfig | undefined, url: string, network
 
 declare const uploadCid: (config: PinataConfig | undefined, cid: string, options?: UploadCIDOptions) => Promise<PinByCIDResponse>;
 
+declare const listPaymentInstructions: (config: PinataConfig | undefined, options?: PaymentInstructionListQuery) => Promise<PaymentInstructionListResponse>;
+
+declare const createPaymentInstruction: (config: PinataConfig | undefined, request: CreatePaymentInstructionRequest) => Promise<PaymentInstructionResponse>;
+
+declare const getPaymentInstruction: (config: PinataConfig | undefined, id: string) => Promise<PaymentInstructionResponse>;
+
+declare const updatePaymentInstruction: (config: PinataConfig | undefined, id: string, request: UpdatePaymentInstructionRequest) => Promise<PaymentInstructionResponse>;
+
+declare const deletePaymentInstruction: (config: PinataConfig | undefined, id: string) => Promise<PaymentInstructionDeleteResponse>;
+
+declare const listCids: (config: PinataConfig | undefined, paymentInstructionId: string, options?: CidListQuery) => Promise<CidListResponse>;
+
+declare const addCid: (config: PinataConfig | undefined, paymentInstructionId: string, cid: string) => Promise<CidAssociationResponse>;
+
+declare const removeCid: (config: PinataConfig | undefined, paymentInstructionId: string, cid: string) => Promise<CidRemoveResponse>;
+
 declare class Analytics {
     config: PinataConfig | undefined;
     requests: AnalyticsRequests;
@@ -587,6 +670,20 @@ declare class Signatures {
     updateConfig(newConfig: PinataConfig): void;
 }
 
+declare class X402 {
+    config: PinataConfig | undefined;
+    constructor(config?: PinataConfig);
+    updateConfig(newConfig: PinataConfig): void;
+    listPaymentInstructions(options?: PaymentInstructionListQuery): Promise<PaymentInstructionListResponse>;
+    createPaymentInstruction(request: CreatePaymentInstructionRequest): Promise<PaymentInstructionResponse>;
+    getPaymentInstruction(id: string): Promise<PaymentInstructionResponse>;
+    updatePaymentInstruction(id: string, request: UpdatePaymentInstructionRequest): Promise<PaymentInstructionResponse>;
+    deletePaymentInstruction(id: string): Promise<PaymentInstructionDeleteResponse>;
+    listCids(paymentInstructionId: string, options?: CidListQuery): Promise<CidListResponse>;
+    addCid(paymentInstructionId: string, cid: string): Promise<CidAssociationResponse>;
+    removeCid(paymentInstructionId: string, cid: string): Promise<CidRemoveResponse>;
+}
+
 declare class PinataSDK {
     config: PinataConfig | undefined;
     files: Files;
@@ -596,6 +693,7 @@ declare class PinataSDK {
     groups: Groups;
     analytics: Analytics;
     signatures: Signatures;
+    x402: X402;
     constructor(config?: PinataConfig);
     setNewHeaders(headers: Record<string, string>): void;
     setNewJwt(jwt: string): void;
@@ -606,4 +704,4 @@ declare function getFileIdFromUrl(url: string): string;
 
 declare const formatConfig: (config: PinataConfig | undefined) => PinataConfig | undefined;
 
-export { AccessLinkOptions, type AnalyticsQuery, CidVersion, type DataEndponts, DeleteResponse, type Endpoints, FileListItem, FileListQuery, FileListResponse, GetCIDResponse, type GetGroupOptions, type GroupCIDOptions, type GroupListResponse, type GroupOptions, type GroupQueryOptions, type GroupResponseItem, JsonBody, type KeyListItem, type KeyListQuery, type KeyListResponse, type KeyOptions, type KeyPermissions, type KeyResponse, OptimizeImageOptions, PinByCIDResponse, PinQueueItem, PinQueueQuery, PinQueueResponse, type PinataConfig, PinataSDK, type PinningEndpoints, type ResourcePermission, type RevokeKeyResponse, type SignatureOptions, type SignatureResponse, SignedUploadUrlOptions, SwapCidOptions, SwapCidResponse, SwapHistoryOptions, type TimeIntervalAnalyticsQuery, type TimeIntervalAnalyticsResponse, type TimePeriodItem, type TopAnalyticsItem, type TopAnalyticsQuery, type TopAnalyticsResponse, UpdateFileOptions, type UpdateGroupFilesResponse, type UpdateGroupOptions, UploadCIDOptions, UploadOptions, UploadResponse, type UserPinnedDataResponse, VectorizeFileResponse, VectorizeQuery, VectorizeQueryResponse, addToGroup, analyticsDateInterval, analyticsTopUsage, convertIPFSUrl, createAccessLink, createGroup, createKey, createSignedUploadURL, deleteFile, deleteFileVectors, deleteGroup, deletePinRequest, 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 };
+export { AccessLinkOptions, type AnalyticsQuery, type CidAssociation, type CidAssociationResponse, type CidListQuery, type CidListResponse, type CidRemoveResponse, CidVersion, type CreatePaymentInstructionRequest, type DataEndponts, DeleteResponse, type Endpoints, FileListItem, FileListQuery, FileListResponse, GetCIDResponse, type GetGroupOptions, type GroupCIDOptions, type GroupListResponse, type GroupOptions, type GroupQueryOptions, type GroupResponseItem, JsonBody, type KeyListItem, type KeyListQuery, type KeyListResponse, type KeyOptions, type KeyPermissions, type KeyResponse, type NetworkIdentifier, OptimizeImageOptions, type PaymentInstruction, type PaymentInstructionDeleteResponse, type PaymentInstructionListQuery, type PaymentInstructionListResponse, type PaymentInstructionResponse, type PaymentRequirement, PinByCIDResponse, PinQueueItem, PinQueueQuery, PinQueueResponse, type PinataConfig, PinataSDK, type PinningEndpoints, type ResourcePermission, type RevokeKeyResponse, type SignatureOptions, type SignatureResponse, SignedUploadUrlOptions, SwapCidOptions, SwapCidResponse, SwapHistoryOptions, type TimeIntervalAnalyticsQuery, type TimeIntervalAnalyticsResponse, type TimePeriodItem, type TopAnalyticsItem, type TopAnalyticsQuery, type TopAnalyticsResponse, UpdateFileOptions, type UpdateGroupFilesResponse, type UpdateGroupOptions, type UpdatePaymentInstructionRequest, UploadCIDOptions, UploadOptions, UploadResponse, type UserPinnedDataResponse, VectorizeFileResponse, VectorizeQuery, VectorizeQueryResponse, addCid, addToGroup, analyticsDateInterval, analyticsTopUsage, convertIPFSUrl, createAccessLink, createGroup, createKey, createPaymentInstruction, createSignedUploadURL, deleteFile, deleteFileVectors, deleteGroup, deletePaymentInstruction, deletePinRequest, deleteSwap, formatConfig, getCid, getFileIdFromUrl, getGroup, getPaymentInstruction, listCids, listFiles, listGroups, listKeys, listPaymentInstructions, pinnedFileCount, queue, removeCid, removeFromGroup, revokeKeys, swapCid, swapHistory, testAuthentication, totalStorageUsage, updateFile, updateGroup, updatePaymentInstruction, uploadBase64, uploadCid, uploadFile, uploadFileArray, uploadJson, uploadUrl, vectorizeFile, vectorizeQuery };