@btst/plugin-affiliate 0.0.0-stage → 1.0.0

package/dist/query-keys.d.cts

@@ -0,0 +1,394 @@
+import * as _btst_stack_plugins_client from '@btst/stack/plugins/client';
+import { ResourceClient } from '@btst/stack/plugins/client';
+import { CreateAffiliateInput, UpdateAffiliateInput, ListParams, ListResult, Affiliate, AffiliateStats, AffiliatePortal, Commission, Payout, CreatePayoutInput } from './types.cjs';
+
+type AffiliateApplicationInput = Omit<CreateAffiliateInput, "userId">;
+type AffiliatePortalInput = Pick<UpdateAffiliateInput, "name" | "email" | "code" | "payoutDetails">;
+/** Shared declarations keep client hooks and server query consumers on the same keys. */
+declare const affiliateResources: {
+    affiliates: {
+        queries: {
+            list: {
+                path: string;
+                query: (params?: ListParams, _partition?: unknown) => {
+                    limit?: number;
+                    offset?: number;
+                    affiliateId?: string;
+                    status?: string;
+                    currency?: string;
+                };
+                select: (data: unknown) => ListResult<Affiliate>;
+            };
+            detail: {
+                path: string;
+                params: (id: string, _partition?: unknown) => {
+                    id: string;
+                };
+                select: (data: unknown) => {
+                    affiliate: Affiliate;
+                    stats: AffiliateStats;
+                };
+            };
+        };
+        mutations: {
+            create: {
+                path: string;
+                method: "POST";
+                input: (body: CreateAffiliateInput) => {
+                    body: CreateAffiliateInput;
+                };
+                select: (data: unknown) => Affiliate;
+                invalidates: string[];
+                refresh: false;
+            };
+            update: {
+                path: string;
+                method: "PUT";
+                input: ({ id, data }: {
+                    id: string;
+                    data: UpdateAffiliateInput;
+                }) => {
+                    params: {
+                        id: string;
+                    };
+                    body: UpdateAffiliateInput;
+                };
+                select: (data: unknown) => Affiliate;
+                invalidates: string[];
+                refresh: false;
+            };
+            delete: {
+                path: string;
+                method: "DELETE";
+                input: (id: string) => {
+                    params: {
+                        id: string;
+                    };
+                };
+                invalidates: string[];
+                refresh: false;
+            };
+        };
+    };
+    affiliatePortal: {
+        queries: {
+            detail: {
+                path: string;
+                key: (partition?: unknown) => unknown[];
+                select: (data: unknown) => AffiliatePortal;
+            };
+        };
+        mutations: {
+            apply: {
+                path: string;
+                method: "POST";
+                input: (body: AffiliateApplicationInput) => {
+                    body: AffiliateApplicationInput;
+                };
+                select: (data: unknown) => Affiliate;
+                invalidates: string[];
+                refresh: false;
+            };
+            update: {
+                path: string;
+                method: "PUT";
+                input: (body: AffiliatePortalInput) => {
+                    body: AffiliatePortalInput;
+                };
+                select: (data: unknown) => Affiliate;
+                invalidates: string[];
+                refresh: false;
+            };
+        };
+    };
+    affiliateCommissions: {
+        queries: {
+            list: {
+                path: string;
+                query: (params?: ListParams, _partition?: unknown) => {
+                    limit?: number;
+                    offset?: number;
+                    affiliateId?: string;
+                    status?: string;
+                    currency?: string;
+                };
+                select: (data: unknown) => ListResult<Commission>;
+            };
+        };
+        mutations: {
+            update: {
+                path: string;
+                method: "PUT";
+                input: ({ id, status, }: {
+                    id: string;
+                    status: "approved" | "voided";
+                }) => {
+                    params: {
+                        id: string;
+                    };
+                    body: {
+                        status: "approved" | "voided";
+                    };
+                };
+                select: (data: unknown) => Commission;
+                invalidates: string[];
+                refresh: false;
+            };
+        };
+    };
+    affiliatePayouts: {
+        queries: {
+            list: {
+                path: string;
+                query: (params?: ListParams, _partition?: unknown) => {
+                    limit?: number;
+                    offset?: number;
+                    affiliateId?: string;
+                    status?: string;
+                    currency?: string;
+                };
+                select: (data: unknown) => ListResult<Payout>;
+            };
+            export: {
+                path: string;
+                query: (params?: ListParams, _partition?: unknown) => {
+                    limit?: number;
+                    offset?: number;
+                    affiliateId?: string;
+                    status?: string;
+                    currency?: string;
+                };
+                select: (data: unknown) => {
+                    csv: string;
+                };
+            };
+        };
+        mutations: {
+            create: {
+                path: string;
+                method: "POST";
+                input: (body: CreatePayoutInput) => {
+                    body: CreatePayoutInput;
+                };
+                select: (data: unknown) => Payout;
+                invalidates: string[];
+                refresh: false;
+            };
+            update: {
+                path: string;
+                method: "PUT";
+                input: ({ id, ...body }: {
+                    id: string;
+                    status: "sent" | "failed";
+                    reference?: string;
+                }) => {
+                    params: {
+                        id: string;
+                    };
+                    body: {
+                        status: "sent" | "failed";
+                        reference?: string;
+                    };
+                };
+                select: (data: unknown) => Payout;
+                invalidates: string[];
+                refresh: false;
+            };
+        };
+    };
+};
+declare function createAffiliateQueryKeys(client: ResourceClient, headers?: HeadersInit): _btst_stack_plugins_client.ResourceQueryKeys<{
+    affiliates: {
+        queries: {
+            list: {
+                path: string;
+                query: (params?: ListParams, _partition?: unknown) => {
+                    limit?: number;
+                    offset?: number;
+                    affiliateId?: string;
+                    status?: string;
+                    currency?: string;
+                };
+                select: (data: unknown) => ListResult<Affiliate>;
+            };
+            detail: {
+                path: string;
+                params: (id: string, _partition?: unknown) => {
+                    id: string;
+                };
+                select: (data: unknown) => {
+                    affiliate: Affiliate;
+                    stats: AffiliateStats;
+                };
+            };
+        };
+        mutations: {
+            create: {
+                path: string;
+                method: "POST";
+                input: (body: CreateAffiliateInput) => {
+                    body: CreateAffiliateInput;
+                };
+                select: (data: unknown) => Affiliate;
+                invalidates: string[];
+                refresh: false;
+            };
+            update: {
+                path: string;
+                method: "PUT";
+                input: ({ id, data }: {
+                    id: string;
+                    data: UpdateAffiliateInput;
+                }) => {
+                    params: {
+                        id: string;
+                    };
+                    body: UpdateAffiliateInput;
+                };
+                select: (data: unknown) => Affiliate;
+                invalidates: string[];
+                refresh: false;
+            };
+            delete: {
+                path: string;
+                method: "DELETE";
+                input: (id: string) => {
+                    params: {
+                        id: string;
+                    };
+                };
+                invalidates: string[];
+                refresh: false;
+            };
+        };
+    };
+    affiliatePortal: {
+        queries: {
+            detail: {
+                path: string;
+                key: (partition?: unknown) => unknown[];
+                select: (data: unknown) => AffiliatePortal;
+            };
+        };
+        mutations: {
+            apply: {
+                path: string;
+                method: "POST";
+                input: (body: AffiliateApplicationInput) => {
+                    body: AffiliateApplicationInput;
+                };
+                select: (data: unknown) => Affiliate;
+                invalidates: string[];
+                refresh: false;
+            };
+            update: {
+                path: string;
+                method: "PUT";
+                input: (body: AffiliatePortalInput) => {
+                    body: AffiliatePortalInput;
+                };
+                select: (data: unknown) => Affiliate;
+                invalidates: string[];
+                refresh: false;
+            };
+        };
+    };
+    affiliateCommissions: {
+        queries: {
+            list: {
+                path: string;
+                query: (params?: ListParams, _partition?: unknown) => {
+                    limit?: number;
+                    offset?: number;
+                    affiliateId?: string;
+                    status?: string;
+                    currency?: string;
+                };
+                select: (data: unknown) => ListResult<Commission>;
+            };
+        };
+        mutations: {
+            update: {
+                path: string;
+                method: "PUT";
+                input: ({ id, status, }: {
+                    id: string;
+                    status: "approved" | "voided";
+                }) => {
+                    params: {
+                        id: string;
+                    };
+                    body: {
+                        status: "approved" | "voided";
+                    };
+                };
+                select: (data: unknown) => Commission;
+                invalidates: string[];
+                refresh: false;
+            };
+        };
+    };
+    affiliatePayouts: {
+        queries: {
+            list: {
+                path: string;
+                query: (params?: ListParams, _partition?: unknown) => {
+                    limit?: number;
+                    offset?: number;
+                    affiliateId?: string;
+                    status?: string;
+                    currency?: string;
+                };
+                select: (data: unknown) => ListResult<Payout>;
+            };
+            export: {
+                path: string;
+                query: (params?: ListParams, _partition?: unknown) => {
+                    limit?: number;
+                    offset?: number;
+                    affiliateId?: string;
+                    status?: string;
+                    currency?: string;
+                };
+                select: (data: unknown) => {
+                    csv: string;
+                };
+            };
+        };
+        mutations: {
+            create: {
+                path: string;
+                method: "POST";
+                input: (body: CreatePayoutInput) => {
+                    body: CreatePayoutInput;
+                };
+                select: (data: unknown) => Payout;
+                invalidates: string[];
+                refresh: false;
+            };
+            update: {
+                path: string;
+                method: "PUT";
+                input: ({ id, ...body }: {
+                    id: string;
+                    status: "sent" | "failed";
+                    reference?: string;
+                }) => {
+                    params: {
+                        id: string;
+                    };
+                    body: {
+                        status: "sent" | "failed";
+                        reference?: string;
+                    };
+                };
+                select: (data: unknown) => Payout;
+                invalidates: string[];
+                refresh: false;
+            };
+        };
+    };
+}>;
+
+export { affiliateResources, createAffiliateQueryKeys };
+export type { AffiliateApplicationInput, AffiliatePortalInput };