Add metadata support to users (#82)

Author: bmealhouse

src/resources/Users.ts

@@ -1,12 +1,18 @@
 import { Except } from "type-fest";
 import { AboundBaseResource } from "./base/AboundBaseResource";
-import { DeepPartial, Notes, Pagination } from "./base/AboundResource";
+import {
+  DeepPartial,
+  Metadata,
+  Notes,
+  Pagination,
+} from "./base/AboundResource";
 import { AboundBulkResponse, AboundResponse } from "./base/AboundResponse";
 
 // request body
 export interface UserRequest {
   email?: string;
   foreignId?: string;
+  metadata?: Metadata;
   notes?: Notes;
   profile?: UserProfile;
   business?: UserBusiness;

src/resources/base/AboundResource.ts

@@ -5,6 +5,8 @@ import { AboundBulkResponse, AboundResponse } from "./AboundResponse";
 // see https://github.com/typescript-eslint/typescript-eslint/issues/2063#issuecomment-675156492
 export type EmptyObject = Record<string, never>;
 
+export type Metadata = Record<string, string>;
+
 export type Notes = string | Record<string, unknown>;
 
 export interface Pagination extends Record<string, unknown> {

tests/resources/users.spec.ts

@@ -18,6 +18,9 @@ describe("Abound Users", () => {
       const createdUser: AboundResponse<User> = await abound.users.create({
         email: "[email protected]",
         foreignId: "tj_miller",
+        metadata: {
+          title: "Board member of Pied Piper",
+        },
         notes: "Board member of Pied Piper",
         profile: {
           firstName: "Erlich",
@@ -57,6 +60,9 @@ Object {
   },
   "email": "[email protected]",
   "foreignId": "tj_miller",
+  "metadata": Object {
+    "title": "Board member of Pied Piper",
+  },
   "notes": "Board member of Pied Piper",
   "profile": Object {
     "address": "3338 Thunder Road",