@outseta/react 0.2.3 → 0.2.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@outseta/react",
-  "version": "0.2.3",
+  "version": "0.2.5",
   "description": "React hooks and components for the Outseta API",
   "license": "MIT",
   "repository": {
@@ -17,14 +17,9 @@
       "import": "./dist/index.js"
     }
   },
-  "scripts": {
-    "build": "rimraf dist && bun build src/index.ts --outdir dist --target browser --format esm --packages external",
-    "typecheck": "tsc --noEmit",
-    "lint": "eslint src --ignore-pattern generated"
-  },
   "dependencies": {
-    "@outseta/api-client": "*",
-    "@tanstack/react-query": "^5.0.0"
+    "@tanstack/react-query": "^5.0.0",
+    "@outseta/api-client": "0.2.5"
   },
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0"
@@ -41,5 +36,10 @@
   "publishConfig": {
     "access": "public",
     "provenance": true
+  },
+  "scripts": {
+    "build": "rimraf dist && bun build src/index.ts --outdir dist --target browser --format esm --packages external",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src --ignore-pattern generated"
   }
-}
+}

package/src/generated/activity/activity.ts

@@ -27,10 +27,12 @@ type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
 
 
 /**
- * @summary Retrieves all the activities. One or multiple parameters can be defined to filter the results.
-ActivityType=[100,101] where ActivityUpdated = 100 and AcccountUpdated = 101
+ * One or multiple parameters can be defined to filter the results.
+ActivityType=[100,101] where ActivityUpdated = 100 and AcccountUpdated = 101.
 Results will be limited to the last year unless ActivityDateTime is specified,
-possibly with ActivityDateTime__gt/ActivityDateTime__gte and ActivityDateTime__lt/ActivityDateTime__lte
+possibly with ActivityDateTime__gt/ActivityDateTime__gte and
+ActivityDateTime__lt/ActivityDateTime__lte.
+ * @summary Retrieve all activities, optionally filtered.
  */
 export const activityGetAll = (
     params?: ActivityGetAllParams,
@@ -78,10 +80,7 @@ export type ActivityGetAllQueryError = void
 
 
 /**
- * @summary Retrieves all the activities. One or multiple parameters can be defined to filter the results.
-ActivityType=[100,101] where ActivityUpdated = 100 and AcccountUpdated = 101
-Results will be limited to the last year unless ActivityDateTime is specified,
-possibly with ActivityDateTime__gt/ActivityDateTime__gte and ActivityDateTime__lt/ActivityDateTime__lte
+ * @summary Retrieve all activities, optionally filtered.
  */
 
 export function useActivityGetAll<TData = Awaited<ReturnType<typeof activityGetAll>>, TError = void>(
@@ -102,10 +101,11 @@ export function useActivityGetAll<TData = Awaited<ReturnType<typeof activityGetA
 
 
 /**
- * @summary Record custom events associated to an account, person or deal. These activities show up
-on the activity feed of the corresponding entity and can be leveraged to trigger drip
-campaigns and other automation. For integration with drip campaigns make sure that what
-you pass in the Title property matches the start / stop value specified for the campaign.
+ * These activities show up on the activity feed of the corresponding entity and can be
+leveraged to trigger drip campaigns and other automation. For integration with drip
+campaigns make sure that what you pass in the Title property matches the start / stop
+value specified for the campaign.
+ * @summary Record a custom event associated to an account, person or deal.
  */
 export const activityAddCustomActivity = (
     activityAddCustomActivityBody: ActivityAddCustomActivityBody,
@@ -154,10 +154,7 @@ const {mutation: mutationOptions, request: requestOptions} = options ?
     export type ActivityAddCustomActivityMutationError = void
 
     /**
- * @summary Record custom events associated to an account, person or deal. These activities show up
-on the activity feed of the corresponding entity and can be leveraged to trigger drip
-campaigns and other automation. For integration with drip campaigns make sure that what
-you pass in the Title property matches the start / stop value specified for the campaign.
+ * @summary Record a custom event associated to an account, person or deal.
  */
 export const useActivityAddCustomActivity = <TError = void,
     TContext = unknown>(options?: { mutation?:UseMutationOptions<Awaited<ReturnType<typeof activityAddCustomActivity>>, TError,{data: ActivityAddCustomActivityBody}, TContext>, request?: SecondParameter<typeof customFetch>}

package/src/generated/attribute/attribute.ts

@@ -0,0 +1,163 @@
+// @ts-nocheck
+import {
+  useQuery
+} from '@tanstack/react-query';
+import type {
+  QueryFunction,
+  QueryKey,
+  UseQueryOptions,
+  UseQueryResult
+} from '@tanstack/react-query';
+
+import type {
+  Definition
+} from '../outsetaAPI.schemas';
+
+import { customFetch } from '../../mutator';
+
+
+type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
+
+
+
+/**
+ * entityType is the name of an EntityType enum value, for example: Account, Person,
+Deal. Definitions describe the labels, system names, and control types of
+the custom attributes that have been added to that entity.
+ * @summary Returns all custom attribute definitions for the given entity type.
+ */
+export const definitionGetAllDefinitions = (
+    entityType: string | null,
+ options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
+) => {
+      
+      
+      return customFetch<Definition[]>(
+      {url: `/api/v1/attributes/${entityType}/definitions`, method: 'GET', signal
+    },
+      options);
+    }
+  
+
+
+
+export const getDefinitionGetAllDefinitionsQueryKey = (entityType?: string | null,) => {
+    return [
+    `/api/v1/attributes/${entityType}/definitions`
+    ] as const;
+    }
+
+    
+export const getDefinitionGetAllDefinitionsQueryOptions = <TData = Awaited<ReturnType<typeof definitionGetAllDefinitions>>, TError = unknown>(entityType: string | null, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof definitionGetAllDefinitions>>, TError, TData>, request?: SecondParameter<typeof customFetch>}
+) => {
+
+const {query: queryOptions, request: requestOptions} = options ?? {};
+
+  const queryKey =  queryOptions?.queryKey ?? getDefinitionGetAllDefinitionsQueryKey(entityType);
+
+  
+
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof definitionGetAllDefinitions>>> = ({ signal }) => definitionGetAllDefinitions(entityType, requestOptions, signal);
+
+      
+
+      
+
+   return  { queryKey, queryFn, enabled: !!(entityType), ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof definitionGetAllDefinitions>>, TError, TData> & { queryKey: QueryKey }
+}
+
+export type DefinitionGetAllDefinitionsQueryResult = NonNullable<Awaited<ReturnType<typeof definitionGetAllDefinitions>>>
+export type DefinitionGetAllDefinitionsQueryError = unknown
+
+
+/**
+ * @summary Returns all custom attribute definitions for the given entity type.
+ */
+
+export function useDefinitionGetAllDefinitions<TData = Awaited<ReturnType<typeof definitionGetAllDefinitions>>, TError = unknown>(
+ entityType: string | null, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof definitionGetAllDefinitions>>, TError, TData>, request?: SecondParameter<typeof customFetch>}
+  
+ ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } {
+
+  const queryOptions = getDefinitionGetAllDefinitionsQueryOptions(entityType,options)
+
+  const query = useQuery(queryOptions) as  UseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey ;
+
+  return query;
+}
+
+
+
+
+/**
+ * The entityType segment of the URL must match the type the definition belongs to
+(e.g. Account, Person, Deal).
+ * @summary Returns a single custom attribute definition by UID.
+ */
+export const definitionGetDefinition = (
+    definitionUid: string | null,
+ options?: SecondParameter<typeof customFetch>,signal?: AbortSignal
+) => {
+      
+      
+      return customFetch<Definition>(
+      {url: `/api/v1/attributes/definitions/${definitionUid}`, method: 'GET', signal
+    },
+      options);
+    }
+  
+
+
+
+export const getDefinitionGetDefinitionQueryKey = (definitionUid?: string | null,) => {
+    return [
+    `/api/v1/attributes/definitions/${definitionUid}`
+    ] as const;
+    }
+
+    
+export const getDefinitionGetDefinitionQueryOptions = <TData = Awaited<ReturnType<typeof definitionGetDefinition>>, TError = void>(definitionUid: string | null, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof definitionGetDefinition>>, TError, TData>, request?: SecondParameter<typeof customFetch>}
+) => {
+
+const {query: queryOptions, request: requestOptions} = options ?? {};
+
+  const queryKey =  queryOptions?.queryKey ?? getDefinitionGetDefinitionQueryKey(definitionUid);
+
+  
+
+    const queryFn: QueryFunction<Awaited<ReturnType<typeof definitionGetDefinition>>> = ({ signal }) => definitionGetDefinition(definitionUid, requestOptions, signal);
+
+      
+
+      
+
+   return  { queryKey, queryFn, enabled: !!(definitionUid), ...queryOptions} as UseQueryOptions<Awaited<ReturnType<typeof definitionGetDefinition>>, TError, TData> & { queryKey: QueryKey }
+}
+
+export type DefinitionGetDefinitionQueryResult = NonNullable<Awaited<ReturnType<typeof definitionGetDefinition>>>
+export type DefinitionGetDefinitionQueryError = void
+
+
+/**
+ * @summary Returns a single custom attribute definition by UID.
+ */
+
+export function useDefinitionGetDefinition<TData = Awaited<ReturnType<typeof definitionGetDefinition>>, TError = void>(
+ definitionUid: string | null, options?: { query?:UseQueryOptions<Awaited<ReturnType<typeof definitionGetDefinition>>, TError, TData>, request?: SecondParameter<typeof customFetch>}
+  
+ ):  UseQueryResult<TData, TError> & { queryKey: QueryKey } {
+
+  const queryOptions = getDefinitionGetDefinitionQueryOptions(definitionUid,options)
+
+  const query = useQuery(queryOptions) as  UseQueryResult<TData, TError> & { queryKey: QueryKey };
+
+  query.queryKey = queryOptions.queryKey ;
+
+  return query;
+}
+
+
+
+