@connectedxm/admin 1.4.0 → 1.4.2

package/README.md

@@ -9,12 +9,47 @@ A Javascript SDK for interacting with the ConnectedXM Admin API.
 To install the SDK, use npm or yarn:
 
 ```sh
-npm install @connectedxm/admin-sdk
-# or
-yarn add @connectedxm/admin-sdk
+npm install @connectedxm/admin
 ```
 
-## Using with React Query Hooks
+## OPTION 1: 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));
+```
+
+## OPTION: 2 Using with React Query Hooks
 
 First wrap your application in both QueryClientProvider and a ConnectedXMProvider
 
@@ -27,7 +62,7 @@ export default function App({ Component, pageProps }: AppProps) {
 
   const getToken = (): string => {
     // GETS YOUR ACCESS TOKEN FOR THE SIGNED IN USER
-    return "";
+    return "ACCESS_TOKEN";
   };
 
   return (
@@ -51,7 +86,7 @@ export default function App({ Component, pageProps }: AppProps) {
 }
 ```
 
-then inside of any component you can use the exported hook
+Inside of any react component you can use the exported react-query hook
 
 ```tsx
 const Component = ({ accountId }: { accountId: string }) => {
@@ -67,40 +102,3 @@ const Component = ({ accountId }: { accountId: string }) => {
   );
 };
 ```
-
-## 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

@@ -1356,6 +1356,7 @@ interface Organization extends BaseOrganization {
     maxImageCount: number | null;
     maxVideoMins: number | null;
     locales: string[];
+    googleServices: string | null;
 }
 interface OrganizationTrigger {
     id: number;
@@ -3524,6 +3525,7 @@ interface OrganizationUpdateInputs {
     appAdaptiveIconId?: string | null;
     appSplashScreenId?: string | null;
     locales?: string[] | null;
+    googleServices?: string | null;
 }
 interface PaymentIntentPurchaseMetadataInputs {
 }

package/dist/index.d.ts

@@ -1356,6 +1356,7 @@ interface Organization extends BaseOrganization {
     maxImageCount: number | null;
     maxVideoMins: number | null;
     locales: string[];
+    googleServices: string | null;
 }
 interface OrganizationTrigger {
     id: number;
@@ -3524,6 +3525,7 @@ interface OrganizationUpdateInputs {
     appAdaptiveIconId?: string | null;
     appSplashScreenId?: string | null;
     locales?: string[] | null;
+    googleServices?: string | null;
 }
 interface PaymentIntentPurchaseMetadataInputs {
 }

package/package.json

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