Merge pull request #279 from zendesk/victor.piolin/brands

feat: implement fetch all brands api

Author: Vico1993

__tests__/services/zendesk-api-service.spec.ts

@@ -1167,4 +1167,51 @@ describe("ZendeskService", () => {
             expect(result).toEqual([viewSample]);
         });
     });
+
+    describe("getBrands", () => {
+        const brandSample = {
+            active: true,
+            brand_url: "https://example.zendesk.com/api/v2/brands/123.json",
+            created_at: "2023-01-01T00:00:00Z",
+            default: false,
+            has_help_center: true,
+            help_center_state: "enabled"
+        };
+
+        it("should fetch brands with the correct data", async () => {
+            requestMock.mockResolvedValueOnce({ brands: [brandSample] });
+
+            const result = await service.getBrands();
+
+            expect(requestMock).toHaveBeenCalledWith({
+                url: `/api/v2/brands`
+            });
+            expect(result).toEqual([brandSample]);
+        });
+
+        it("should continue calling the API until next_page disappears", async () => {
+            requestMock
+                .mockResolvedValueOnce({ brands: [brandSample], next_page: "next_page" })
+                .mockResolvedValueOnce({ brands: [] });
+
+            const result = await service.getBrands();
+
+            expect(requestMock).toHaveBeenCalledTimes(2);
+            expect(requestMock).toHaveBeenNthCalledWith(1, {
+                url: `/api/v2/brands`
+            });
+            expect(requestMock).toHaveBeenNthCalledWith(2, {
+                url: "next_page"
+            });
+            expect(result).toEqual([brandSample]);
+        });
+
+        it("should only call the API one time with fetchAllBrands set to false", async () => {
+            requestMock.mockResolvedValueOnce({ brands: [brandSample], next_page: "next_page" });
+
+            await service.getBrands(false);
+
+            expect(requestMock).toHaveBeenCalledTimes(1);
+        });
+    });
 });

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@zendesk/zaf-toolbox",
-    "version": "1.4.0",
+    "version": "1.5.0",
     "description": "A toolbox for ZAF application built with 🩷 by Zendesk Labs",
     "main": "lib/src/index.js",
     "types": "lib/src/index.d.ts",

src/models/index.ts

@@ -9,4 +9,5 @@ export * from "@models/whats-app-template";
 export * from "@models/zendesk-user";
 export * from "@models/custom-objects";
 export * from "@models/zendesk-api";
+export * from "@models/zendesk-brands";
 export * from "@models/zendesk-view";

src/models/zendesk-brands.ts

@@ -0,0 +1,57 @@
+import { IZendeskResponse } from "./zendesk-api";
+
+export type HelpCenterState = "enabled" | "disabled" | "restricted";
+
+export interface IBrandLogo {
+    content_type?: string;
+    content_url?: string;
+    deleted?: boolean;
+    file_name?: string;
+    height?: string;
+    id?: number;
+    inline?: boolean;
+    mapped_content_url?: string;
+    size?: number;
+    thumbnails?: {
+        content_type: string;
+        content_url: string;
+        deleted: boolean;
+        file_name: string;
+        height: string;
+        id: number;
+        inline: boolean;
+        mapped_content_url: string;
+        size: number;
+        url: string;
+        width: string;
+    }[];
+    url?: string;
+    width?: string;
+}
+
+export interface IZendeskBrand {
+    active: boolean;
+    brand_url: string;
+    created_at: string;
+    default: boolean;
+    has_help_center: boolean;
+    help_center_state: HelpCenterState;
+    host_mapping: string;
+    id: number;
+    is_deleted: boolean;
+    logo: IBrandLogo | null;
+    name: string;
+    signature_template: string;
+    subdomain: string;
+    ticket_form_ids: number[];
+    updated_at: string;
+    url: string;
+}
+
+export interface IBrandsResponse extends IZendeskResponse {
+    brands: IZendeskBrand[];
+}
+
+export interface IBrandResponse extends IZendeskResponse {
+    brand: IZendeskBrand;
+}

src/services/zendesk-api-service.ts

@@ -32,7 +32,9 @@ import {
     IBulkJobResponse,
     ITicketsResults,
     IZendeskView,
-    IViewsResponse
+    IViewsResponse,
+    IZendeskBrand,
+    IBrandsResponse
 } from "@models/index";
 import { buildUrlParams } from "@utils/build-url-params";
 import {
@@ -723,4 +725,22 @@ export class ZendeskApiService {
             (response) => response.views
         );
     }
+
+    /**
+     * BRANDS SECTION
+     */
+
+    /**
+     * Fetch all brands
+     *
+     * @param fetchAllBrands Whether to fetch all pages or just the first. Defaults to true
+     * @returns Promise resolving to array of brands
+     */
+    public async getBrands(fetchAllBrands = true): Promise<IZendeskBrand[]> {
+        return this.fetchAllPaginatedResults<IBrandsResponse, IZendeskBrand>(
+            "/api/v2/brands",
+            fetchAllBrands,
+            (response) => response.brands
+        );
+    }
 }