@chainpatrol/sdk 0.2.2 → 0.3.0

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+import { AssetCheckInput, AssetCheckOutput, AssetListInput, AssetListOutput, ReportCreateInput } from '@chainpatrol/validation';
+
 declare const ContinueAtOwnRisk = "CHAINPATROL_CONTINUE_AT_OWN_RISK";
 declare const IgnorelistUpdated = "CHAINPATROL_IGNORELIST_UPDATED";
 declare const CloseCurrentTab = "CHAINPATROL_CLOSE_CURRENT_TAB";
@@ -45,6 +47,11 @@ type ChainPatrolClientOptions = {
     apiKey: string;
     baseUrl?: string;
 };
+type ApiRequest = {
+    path: string[];
+    method: "GET" | "POST" | "PUT" | "DELETE";
+    body?: unknown;
+};
 type AssetType = "URL" | "PAGE" | "ADDRESS";
 type AssetStatus = "ALLOWED" | "BLOCKED" | "UNKNOWN";
 declare class ChainPatrolClient {
@@ -52,95 +59,20 @@ declare class ChainPatrolClient {
     private readonly apiKey;
     private readonly logger;
     constructor(options: ChainPatrolClientOptions);
-    private fetch;
+    fetch<TResult = unknown>(req: ApiRequest): Promise<TResult>;
     get asset(): {
-        check: (req: {
-            /**
-             * Asset content. Could be a domain, URL, or crypto address.
-             */
-            content: string;
-        }) => Promise<{
-            /**
-             * "ALLOWED" - the asset is on the allowlist
-             * "BLOCKED" - the asset is on the blocklist
-             * "UNKNOWN" - the asset's status is not known
-             */
-            status: AssetStatus;
-            /**
-             * If the asset is allowed or blocked, this will be the reason why.
-             * ChainPatrol aggregates data from multiple sources, so this will
-             * tell you which source blocked or allowed the asset.
-             *
-             * ex. 'eth-phishing-detect' - the asset is on MetaMask's blocklist
-             *     'reported' - the asset is on ChainPatrol's blocklist because
-             *                  it was reported by a user
-             */
-            reason?: string;
-        }>;
-        list: (req: {
-            /**
-             * Asset type
-             */
-            type: AssetType;
-            /**
-             * Status of the assets to retrieve
-             */
-            status: AssetStatus;
-            /**
-             * The start date to list assets from. This should be in the format `YYYY-MM-DD` and is inclusive.
-             */
-            startDate?: string;
-            /**
-             * The end date to list assets from. This should be in the format `YYYY-MM-DD` and is inclusive.
-             */
-            endDate?: string;
-        }) => Promise<{
-            content: string;
-            type: AssetType;
-            status: AssetStatus;
-        }[]>;
+        check: (req: AssetCheckInput) => Promise<AssetCheckOutput>;
+        list: (req: AssetListInput) => Promise<AssetListOutput>;
     };
     get report(): {
-        create: (req: {
-            /** Report title */
-            title: string;
-            /** Report description */
-            description: string;
-            /** List of assets to report with the proposed status */
-            assets: {
-                content: string;
-                status: AssetStatus;
-            }[];
-            /** Organization slug (provide this or `discordGuildId`) */
-            organizationSlug?: string;
-            /** Discord guild ID (provide this or `organizationSlug`) */
-            discordGuildId?: string;
-            /** Optional raw input of the assets */
-            rawAssetsInput?: string;
-            /** Optional List of URLs of images to attach to the report */
-            attachmentUrls?: string[];
-            /** Optional contact information of the reporter */
-            contactInfo?: string;
-            /** Optional ID of the reporter if they are a member on ChainPatrol */
-            reporterId?: number;
-            /**
-             * Optional information about the reporter if they are reporting from
-             * a platform other than ChainPatrol
-             */
-            externalReporter?: {
-                platform: string;
-                platformIdentifier: string;
-                avatarUrl?: string;
-                displayName?: string;
-            };
-        }) => Promise<{
+        create: (req: ReportCreateInput) => Promise<{
             id: number;
-            createdAt: string;
+            createdAt: Date;
             organization: {
-                id: number;
                 slug: string;
                 name: string;
-            };
+                id: number;
+            } | null;
         }>;
     };
 }