Groups

TypeScript types for the Pinata Groups SDK, including GroupOptions, GroupResponseItem, list filters, and add and remove file payload shapes.

GroupOptions

export type GroupOptions = {
	name: string;
	isPublic?: boolean;
};

UpdateGroupOptions

export type UpdateGroupOptions = {
	groupId: string;
	name?: string;
	isPublic?: boolean;
};

GetGroupOptions

export type GetGroupOptions = {
	groupId: string;
};

GroupListResponse

export type GroupListResponse = {
	groups: GroupResponseItem[];
	next_page_token: string;
};

GroupResponseItem

export type GroupResponseItem = {
	id: string;
	is_public: boolean;
	name: string;
	createdAt: string;
};

GroupQueryOptions

export type GroupQueryOptions = {
	name?: string;
	limit?: number;
	pageToken?: string;
	isPublic?: boolean;
};

GroupCIDOptions

export type GroupCIDOptions = {
	groupId: string;
	files: string[];
};

UpdateGroupFilesResponse

export type UpdateGroupFilesResponse = {
	id: string;
	status: string;
};