@connectedxm/admin 1.3.11 → 1.4.0

package/README.md

@@ -1,3 +1,106 @@
 # @connectedxm/admin-sdk
 
 A Javascript SDK for interacting with the ConnectedXM Admin API.
+
+# Getting Started
+
+## Installation
+
+To install the SDK, use npm or yarn:
+
+```sh
+npm install @connectedxm/admin-sdk
+# or
+yarn add @connectedxm/admin-sdk
+```
+
+## Using with React Query Hooks
+
+First wrap your application in both QueryClientProvider and a ConnectedXMProvider
+
+```tsx
+import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
+import { ConnectedXMProvider } from "@connectedxm/admin";
+
+export default function App({ Component, pageProps }: AppProps) {
+  const [queryClient] = React.useState(new QueryClient());
+
+  const getToken = (): string => {
+    // GETS YOUR ACCESS TOKEN FOR THE SIGNED IN USER
+    return "";
+  };
+
+  return (
+    <QueryClientProvider client={queryClient}>
+      <ConnectedXMProvider
+        queryClient={queryClient}
+        organizationId={YOUR_ORGANIZATION_ID}
+        apiUrl="https://admin-api.connected.dev"
+        getToken={GetAccessToken}
+
+        // OPTIONAL TRIGGERS
+        // onNotAuthorized={}
+        // onModuleForbidden={}
+        // onNotFound={}
+        // onMutationError={}
+      >
+        {" YOUR APP GOES HERE"}
+      </ConnectedXMProvider>
+    </QueryClientProvider>
+  );
+}
+```
+
+then inside of any component you can use the exported hook
+
+```tsx
+const Component = ({ accountId }: { accountId: string }) => {
+  const { data: account, isLoading, isError, error } = useGetAccount(accountId);
+
+  if (isLoading) return <Loader />;
+  if (isError) return <ErrorComponent error={error} />;
+
+  return (
+    <div>
+      <p>{account.name}</p>
+    </div>
+  );
+};
+```
+
+## Using the Functions directly
+
+Here's a basic example of how to use the SDK to fetch user data:
+
+```typescript
+import { AddAccountTier, AdminApiParams, GetAccount } from "@connectedxm/admin";
+
+const ORGANIZATION_ID = "ORGANIZATION_ID";
+const API_KEY = "API_KEY";
+
+const ACCOUNT_ID = "INPUT_AN_ACCOUNT_ID";
+const NEW_TIER_ID = "INPUT_AN_ACCOUNT_TIER_ID";
+
+const adminApiParams: AdminApiParams = {
+  apiUrl: "https://admin-api.connected.dev",
+  apiKey: API_KEY,
+  organizationId: ORGANIZATION_ID,
+};
+
+// Example: Get account
+let { data: account } = await GetAccount({
+  accountId: ACCOUNT_ID,
+  adminApiParams,
+});
+
+console.log(JSON.stringify(account, null, 2));
+
+// Example: Add account tier
+let { data } = await AddAccountTier({
+  adminApiParams,
+  accountId: ACCOUNT_ID,
+  tierId: NEW_TIER_ID,
+});
+
+console.log(JSON.stringify(data, null, 2));
+```

package/dist/index.d.mts

@@ -2560,7 +2560,7 @@ interface Lead extends BaseLead {
 interface ConnectedXMClientContextState {
     queryClient: QueryClient;
     organizationId: string;
-    apiUrl: "https://admin-api.connectedxm.com" | "https://staging-admin-api.connectedxm.com" | "http://localhost:4001";
+    apiUrl: "https://admin-api.connected.dev" | "https://staging-admin-api.connected.dev" | "http://localhost:4001";
     authenticated: boolean;
     setAuthenticated: (authenticated: boolean) => void;
     getToken: () => Promise<string | undefined>;
@@ -4090,9 +4090,10 @@ declare function MergeInfinitePages<TData>(data: InfiniteData<ConnectedXMRespons
 declare const TransformPrice: (value: number, withDollar?: boolean, freeText?: string) => string | undefined;
 
 interface AdminApiParams {
-    apiUrl: "https://admin-api.connectedxm.com" | "https://staging-admin-api.connectedxm.com" | "http://localhost:4001";
+    apiUrl: "https://admin-api.connected.dev" | "https://staging-admin-api.connected.dev" | "http://localhost:4001";
     organizationId: string;
-    getToken: () => Promise<string | undefined> | string | undefined;
+    getToken?: () => Promise<string | undefined> | string | undefined;
+    apiKey?: string;
     getExecuteAs?: () => Promise<string | undefined> | string | undefined;
 }
 /**

package/dist/index.d.ts

@@ -2560,7 +2560,7 @@ interface Lead extends BaseLead {
 interface ConnectedXMClientContextState {
     queryClient: QueryClient;
     organizationId: string;
-    apiUrl: "https://admin-api.connectedxm.com" | "https://staging-admin-api.connectedxm.com" | "http://localhost:4001";
+    apiUrl: "https://admin-api.connected.dev" | "https://staging-admin-api.connected.dev" | "http://localhost:4001";
     authenticated: boolean;
     setAuthenticated: (authenticated: boolean) => void;
     getToken: () => Promise<string | undefined>;
@@ -4090,9 +4090,10 @@ declare function MergeInfinitePages<TData>(data: InfiniteData<ConnectedXMRespons
 declare const TransformPrice: (value: number, withDollar?: boolean, freeText?: string) => string | undefined;
 
 interface AdminApiParams {
-    apiUrl: "https://admin-api.connectedxm.com" | "https://staging-admin-api.connectedxm.com" | "http://localhost:4001";
+    apiUrl: "https://admin-api.connected.dev" | "https://staging-admin-api.connected.dev" | "http://localhost:4001";
     organizationId: string;
-    getToken: () => Promise<string | undefined> | string | undefined;
+    getToken?: () => Promise<string | undefined> | string | undefined;
+    apiKey?: string;
     getExecuteAs?: () => Promise<string | undefined> | string | undefined;
 }
 /**

package/dist/index.js

@@ -2139,13 +2139,14 @@ var import_react = __toESM(require("react"));
 // src/AdminAPI.ts
 var import_axios = __toESM(require("axios"));
 var GetAdminAPI = async (params) => {
-  const token = await params.getToken();
+  const token = !!params.getToken && await params.getToken();
   const executeAs = params.getExecuteAs ? await params.getExecuteAs() : void 0;
   return import_axios.default.create({
     baseURL: params.apiUrl,
     headers: {
       organization: params.organizationId,
       authorization: token,
+      "api-key": params.apiKey,
       executeAs
     }
   });

package/dist/index.mjs

@@ -10,13 +10,14 @@ import React from "react";
 // src/AdminAPI.ts
 import axios from "axios";
 var GetAdminAPI = async (params) => {
-  const token = await params.getToken();
+  const token = !!params.getToken && await params.getToken();
   const executeAs = params.getExecuteAs ? await params.getExecuteAs() : void 0;
   return axios.create({
     baseURL: params.apiUrl,
     headers: {
       organization: params.organizationId,
       authorization: token,
+      "api-key": params.apiKey,
       executeAs
     }
   });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@connectedxm/admin",
-  "version": "1.3.11",
+  "version": "1.4.0",
   "description": "Admin API javascript SDK",
   "author": "ConnectedXM Inc.",
   "repository": {