add members client

lib/b2b/members.ts

@@ -0,0 +1,112 @@
+import { Member, SearchOperator, ResultsMetadata } from "./shared_b2b";
+import { BaseResponse, request, fetchConfig } from "../shared";
+
+export interface CreateMemberRequest {
+  organization_id: string;
+  email_address: string;
+  name?: string;
+  trusted_metadata?: Record<string, any>; // eslint-disable-line @typescript-eslint/no-explicit-any
+  untrusted_metadata?: Record<string, any>; // eslint-disable-line @typescript-eslint/no-explicit-any
+  create_member_as_pending?: boolean;
+}
+
+export interface CreateMemberResponse extends BaseResponse {
+  member_id: string;
+  member: Member;
+}
+
+export interface UpdateMemberRequest {
+  organization_id: string;
+  member_id: string;
+  name?: string;
+  trusted_metadata?: Record<string, any>; // eslint-disable-line @typescript-eslint/no-explicit-any
+  untrusted_metadata?: Record<string, any>; // eslint-disable-line @typescript-eslint/no-explicit-any
+}
+
+export interface UpdateMemberResponse extends BaseResponse {
+  member_id: string;
+  member: Member;
+}
+
+export type MemberSearchOperand =
+  | {
+  filter_name: "member_ids";
+  filter_value: string[];
+}
+  | {
+  filter_name: "member_emails";
+  filter_value: string[];
+}
+  | {
+  filter_name: "member_email_fuzzy";
+  filter_value: string;
+}
+  | {
+  filter_name: "status";
+  filter_value: "active" | "pending";
+};
+
+export interface SearchOrganizationMemberRequest {
+  organization_ids: string[];
+  limit?: number;
+  query?: {
+    operator: SearchOperator;
+    operands: MemberSearchOperand[];
+  };
+  cursor?: string | null;
+}
+
+export interface SearchOrganizationMemberResponse extends BaseResponse {
+  members: Member[];
+  results_metadata: ResultsMetadata;
+}
+
+export interface DeleteMemberRequest {
+  member_id: string;
+  organization_id: string;
+}
+
+export interface DeleteMemberResponse extends BaseResponse {
+  member_id: string;
+}
+
+export class Members {
+  private base_path: string;
+  private fetchConfig: fetchConfig;
+
+  constructor(fetchConfig: fetchConfig, parent_path: string) {
+    this.fetchConfig = fetchConfig;
+    this.base_path = `${parent_path}`;
+  }
+
+  create(data: CreateMemberRequest): Promise<CreateMemberResponse> {
+    return request(this.fetchConfig, {
+      method: "POST",
+      url: `${this.base_path}/${data.organization_id}/members`,
+      data,
+    });
+  }
+
+  update(data: UpdateMemberRequest): Promise<UpdateMemberResponse> {
+    return request(this.fetchConfig, {
+      method: "PUT",
+      url: `${this.base_path}/${data.organization_id}/members/${data.member_id}`,
+      data,
+    });
+  }
+
+  delete(data: DeleteMemberRequest): Promise<DeleteMemberResponse> {
+    return request(this.fetchConfig, {
+      method: "DELETE",
+      url: `${this.base_path}/${data.organization_id}/members/${data.member_id}`,
+    });
+  }
+
+  search(data: SearchOrganizationMemberRequest): Promise<SearchOrganizationMemberResponse> {
+    return request(this.fetchConfig, {
+      method: "POST",
+      url: `${this.base_path}/members/search`,
+      data,
+    });
+  }
+}

test/b2b/members.test.ts

@@ -0,0 +1,167 @@
+import { Members } from '../../lib/b2b/members';
+import { MOCK_FETCH_CONFIG, mockRequest } from "../helpers";
+import { SearchOperator } from "../../lib/b2b/shared_b2b";
+
+jest.mock("../../lib/shared");
+
+const members = new Members(MOCK_FETCH_CONFIG, 'organizations');
+
+describe('members.create', () => {
+  test('success', () => {
+    mockRequest((req) => {
+      expect(req).toEqual({
+        method: 'POST',
+        path: 'organizations/organization-id-1234/members',
+        data: {
+          organization_id: 'organization-id-1234',
+          email_address: '[email protected]',
+          create_member_as_pending: true,
+        },
+      });
+
+      const data = {
+        request_id: 'request-id-test-55555555-5555-4555-8555-555555555555',
+        member_id: 'member-id-1234',
+        status_code: 200,
+      };
+      return { status: 200, data };
+    });
+
+    return expect(
+      members.create({
+        organization_id: 'organization-id-1234',
+        email_address: '[email protected]',
+        create_member_as_pending: true,
+      }),
+    ).resolves.toMatchObject({
+      request_id: 'request-id-test-55555555-5555-4555-8555-555555555555',
+      member_id: 'member-id-1234',
+      status_code: 200,
+    });
+  });
+});
+
+describe('members.update', () => {
+  test('success', () => {
+    mockRequest((req) => {
+      expect(req).toEqual({
+        method: 'PUT',
+        path: 'organizations/organization-id-1234/members/member-id-1234',
+        data: {
+          member_id: 'member-id-1234',
+          organization_id: 'organization-id-1234',
+          name: 'new name',
+        },
+      });
+
+      const data = {
+        request_id: 'request-id-test-55555555-5555-4555-8555-555555555555',
+        member_id: 'member-id-1234',
+        status_code: 200,
+      };
+      return { status: 200, data };
+    });
+
+    return expect(
+      members.update({
+        member_id: 'member-id-1234',
+        organization_id: 'organization-id-1234',
+        name: 'new name',
+      }),
+    ).resolves.toMatchObject({
+      request_id: 'request-id-test-55555555-5555-4555-8555-555555555555',
+      member_id: 'member-id-1234',
+      status_code: 200,
+    });
+  });
+});
+
+describe('members.search', () => {
+  test('success', () => {
+    mockRequest((req) => {
+      expect(req).toEqual({
+        method: 'POST',
+        path: 'organizations/members/search',
+        data: {
+          organization_ids: ['organization_id'],
+          limit: 200,
+          query: {
+            operator: SearchOperator.OR,
+            operands: [
+              { filter_name: 'member_ids', filter_value: ['member-id-1234'] },
+            ],
+          },
+        },
+      });
+
+      const data = {
+        request_id: 'request-id-test-55555555-5555-4555-8555-555555555555',
+        results: [
+          {
+            member_id: 'member-id-1234',
+          },
+        ],
+        results_metadata: {
+          total: 0,
+          next_cursor: null,
+        },
+        status_code: 200,
+      };
+      return { status: 200, data };
+    });
+
+    return expect(
+      members.search({
+        organization_ids: ['organization_id'],
+        limit: 200,
+        query: {
+          operator: SearchOperator.OR,
+          operands: [
+            { filter_name: 'member_ids', filter_value: ['member-id-1234'] },
+          ],
+        },
+      }),
+    ).resolves.toMatchObject({
+      request_id: 'request-id-test-55555555-5555-4555-8555-555555555555',
+      results: [
+        {
+          member_id: 'member-id-1234',
+        },
+      ],
+      results_metadata: {
+        total: 0,
+        next_cursor: null,
+      },
+      status_code: 200,
+    });
+  });
+});
+
+describe('members.delete', () => {
+  test('success', () => {
+    mockRequest((req) => {
+      expect(req).toEqual({
+        method: 'DELETE',
+        path: 'organizations/organization-id-1234/members/member-id-1234',
+      });
+
+      const data = {
+        request_id: 'request-id-test-55555555-5555-4555-8555-555555555555',
+        member_id: 'member-id-1234',
+        status_code: 200,
+      };
+      return { status: 200, data };
+    });
+
+    return expect(
+      members.delete({
+        member_id: 'member-id-1234',
+        organization_id: 'organization-id-1234',
+      }),
+    ).resolves.toMatchObject({
+      request_id: 'request-id-test-55555555-5555-4555-8555-555555555555',
+      member_id: 'member-id-1234',
+      status_code: 200,
+    });
+  });
+});