feat(campaigns): add campaigns.list (GET /campaigns/list)

README.md

@@ -103,7 +103,7 @@ The library supports the following [Braze API endpoints](https://www.braze.com/d
 
 - [ ] /campaigns/data_series
 - [ ] /campaigns/details
-- [ ] /campaigns/list
+- [x] /campaigns/list
 - [ ] /sends/data_series
 
 ### Canvas

src/Braze.ts

@@ -40,6 +40,13 @@ export class Braze {
 
   /* eslint-disable tsdoc/syntax */
   campaigns = {
+    /**
+     * GET /campaigns/list
+     */
+    list: (parameters?: campaigns.CampaignsListParameters) => {
+      return campaigns.list(this.apiUrl, this.apiKey, parameters)
+    },
+
     trigger: {
       schedule: {
         /**

src/campaigns/index.ts

@@ -1,2 +1,3 @@
+export * from './list'
 export * as trigger from './trigger'
 export * from './types'

src/campaigns/list.test.ts

@@ -0,0 +1,59 @@
+import { Braze } from '../Braze'
+import { get } from '../common/request'
+import type { CampaignsListResponse } from './types'
+
+jest.mock('../common/request/get')
+const mockedGet = jest.mocked(get)
+
+beforeEach(() => {
+  jest.clearAllMocks()
+})
+
+describe('campaigns.list()', () => {
+  const apiUrl = 'https://rest.iad-01.braze.com'
+  const apiKey = 'apiKey'
+
+  const braze = new Braze(apiUrl, apiKey)
+  const options = {
+    headers: {
+      Authorization: `Bearer ${apiKey}`,
+      'Content-Type': 'application/json',
+    },
+  }
+
+  const response: CampaignsListResponse = {
+    message: 'success',
+    campaigns: [
+      {
+        id: 'campaign_api_identifier',
+        last_edited: '2023-04-20T08:20:00.000Z',
+        name: 'campaign name',
+        is_api_campaign: true,
+        tags: ['tag'],
+      },
+    ],
+  }
+
+  it('calls GET /campaigns/list with no params', async () => {
+    mockedGet.mockResolvedValueOnce(response)
+    expect(await braze.campaigns.list()).toBe(response)
+    expect(mockedGet).toBeCalledWith(`${apiUrl}/campaigns/list?`, options)
+    expect(mockedGet).toBeCalledTimes(1)
+  })
+
+  it('calls GET /campaigns/list with all params', async () => {
+    mockedGet.mockResolvedValueOnce(response)
+    const params = {
+      page: 100,
+      include_archived: true,
+      sort_direction: 'desc',
+      'last_edit.time[gt]': '2023-04-20T04:20:00',
+    }
+    expect(await braze.campaigns.list(params)).toBe(response)
+    expect(mockedGet).toBeCalledWith(
+      `${apiUrl}/campaigns/list?page=100&include_archived=true&sort_direction=desc&last_edit.time%5Bgt%5D=2023-04-20T04%3A20%3A00`,
+      options,
+    )
+    expect(mockedGet).toBeCalledTimes(1)
+  })
+})

src/campaigns/list.ts

@@ -0,0 +1,21 @@
+import { buildOptions, buildParams, get } from '../common/request'
+import type { CampaignsListParameters, CampaignsListResponse } from './types'
+
+/**
+ * Export campaigns list.
+ *
+ * Use this endpoint to export a list of campaigns, each of which will include its name, campaign API identifier, whether it is an API campaign, and tags associated with the campaign.
+ *
+ * {@link https://www.braze.com/docs/api/endpoints/export/campaigns/get_campaigns/}
+ *
+ * @param apiUrl - Braze REST endpoint.
+ * @param apiKey - Braze API key.
+ * @param parameters - Request parameters.
+ * @returns - Braze response.
+ */
+export function list(apiUrl: string, apiKey: string, parameters?: CampaignsListParameters) {
+  return get(
+    `${apiUrl}/campaigns/list?${buildParams(parameters)}`,
+    buildOptions({ apiKey }),
+  ) as Promise<CampaignsListResponse>
+}

src/campaigns/types.ts

@@ -1,2 +1,31 @@
+import type { ServerResponse } from '../common/request'
+
 export * from './trigger/schedule/types'
 export * from './trigger/types'
+
+/**
+ * Request parameters for campaigns list.
+ *
+ * {@link https://www.braze.com/docs/api/endpoints/export/campaigns/get_campaigns/#request-parameters}
+ */
+export interface CampaignsListParameters {
+  page?: number
+  include_archived?: boolean
+  sort_direction?: string
+  'last_edit.time[gt]'?: string
+}
+
+/**
+ * Response body for campaigns list.
+ *
+ * {@link https://www.braze.com/docs/api/endpoints/export/campaigns/get_campaigns/#response}
+ */
+export interface CampaignsListResponse extends ServerResponse {
+  campaigns: {
+    id: string
+    last_edited: string
+    name: string
+    is_api_campaign: boolean
+    tags: string[]
+  }[]
+}