feat: support endpoint-specific request headers

generator/generator.js

@@ -192,6 +192,14 @@ function generateAPIClass({ apiName, operations = [], generatorType }) {
         requestParams.push(`path: \`${url.replaceAll(/({.+?})/g, (_, p1) => `$${p1}`)}\``)
         requestParams.push(`method: '${method}'`)
 
+        if (
+          generatorType === 'Manage' &&
+          method === 'post' &&
+          url === '/system/members/{memberIdentifier}/tokens'
+        ) {
+          requestParams.push(`headers: { 'x-cw-usertype': 'member' }`)
+        }
+
         if (requestBody) {
           if (isMultipart) {
             usedToFormData = true

src/BaseAPI.ts

@@ -90,7 +90,7 @@ export const makeRequest =
     api: (args: RequestOptions) => Promise<unknown>
     thisObj: InstanceType<typeof Automate | typeof Manage>
   }): ((args: RequestOptions) => Promise<unknown>) =>
-  ({ path, method = 'get', params, data }: RequestOptions): Promise<unknown> => {
+  ({ path, method = 'get', params, data, contentType, responseType, headers }: RequestOptions): Promise<unknown> => {
     const retryCodes = ['ECONNRESET', 'ETIMEDOUT', 'ESOCKETTIMEDOUT']
     const boundApi = api.bind(thisObj)
 
@@ -102,7 +102,7 @@ export const makeRequest =
     const { retry, retryOptions, logger } = config
 
     if (!retry) {
-      return boundApi({ path, method, params, data })
+      return boundApi({ path, method, params, data, contentType, responseType, headers })
         .then((result: any) => {
           logger(
             'info',
@@ -120,7 +120,7 @@ export const makeRequest =
         })
     } else {
       return promiseRetry(retryOptions, (retry, number) => {
-        return boundApi({ path, method, params, data }).catch((error) => {
+        return boundApi({ path, method, params, data, contentType, responseType, headers }).catch((error) => {
           logger(
             'warn',
             `${method} ${path} ${Date.now() - startTime}ms error occurred: ${

src/Manage.ts

@@ -157,14 +157,17 @@ export default class Manage {
     data,
     contentType,
     responseType,
+    headers: requestHeaders,
   }: RequestOptions): Promise<ErrorResponse | DataResponse> {
     try {
       // For multipart uploads let the runtime set Content-Type + boundary.
       // Axios inspects FormData and builds the header itself; passing a plain
       // object with contentType: 'multipart' falls back to the caller's
       // FormData (consumers should use toFormData() from BaseAPI).
       const headers: Record<string, string> | undefined =
-        contentType === 'multipart' ? { 'Content-Type': 'multipart/form-data' } : undefined
+        contentType === 'multipart'
+          ? { ...requestHeaders, 'Content-Type': 'multipart/form-data' }
+          : requestHeaders
 
       const result = await this.instance({
         url: path,

src/Manage/SystemAPI.ts

@@ -3124,6 +3124,7 @@ export class SystemAPI extends ManageBaseAPI {
     return this.request({
       path: `/system/members/${memberIdentifier}/tokens`,
       method: 'post',
+      headers: { 'x-cw-usertype': 'member' },
     })
   }
 

src/types.ts

@@ -65,6 +65,8 @@ export type RequestOptions = {
   contentType?: ContentType
   /** Hint for how axios should decode the response; generator sets this for binary endpoints. */
   responseType?: ResponseType
+  /** Endpoint-specific headers to merge into the request. */
+  headers?: Record<string, string>
 }
 
 export type LoggingLevels = 'error' | 'warn' | 'info' | 'debug'

test/test-manage-request-options.mjs

@@ -0,0 +1,62 @@
+import assert from 'node:assert'
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+import dotenv from 'dotenv'
+import { beforeEach, describe, it } from 'mocha'
+import pkg from '../dist/index.js'
+const { ManageAPI } = pkg
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+dotenv.config({ path: path.join(__dirname, '.env') })
+
+const {
+  MANAGE_API_COMPANY = 'test-company',
+  MANAGE_API_URL = 'example.com',
+  MANAGE_API_PUBLIC_KEY = 'test-public-key',
+  MANAGE_API_PRIVATE_KEY = 'test-private-key',
+  MANAGE_API_CLIENT_ID = 'test-client-id',
+} = process.env
+
+describe('Manage request options', () => {
+  let cwm = null
+  let requestArgs = null
+
+  beforeEach(() => {
+    cwm = new ManageAPI({
+      companyId: MANAGE_API_COMPANY,
+      companyUrl: MANAGE_API_URL,
+      publicKey: MANAGE_API_PUBLIC_KEY,
+      privateKey: MANAGE_API_PRIVATE_KEY,
+      clientId: MANAGE_API_CLIENT_ID,
+      apiVersion: '2021.2',
+      logger: () => {},
+    })
+    requestArgs = null
+    cwm.instance = async (args) => {
+      requestArgs = args
+      return { data: [] }
+    }
+  })
+
+  describe('request headers', () => {
+    it('adds member user type header when creating member tokens', async () => {
+      await cwm.SystemAPI.postSystemMembersByMemberIdentifierTokens('member-id')
+
+      assert.deepStrictEqual(requestArgs.headers, { 'x-cw-usertype': 'member' })
+    })
+  })
+
+  describe('binary downloads', () => {
+    it('requests document downloads as arraybuffers', async () => {
+      await cwm.SystemAPI.getSystemDocumentsByIdDownload(123)
+
+      assert.strictEqual(requestArgs.responseType, 'arraybuffer')
+    })
+
+    it('requests invoice PDFs as arraybuffers', async () => {
+      await cwm.FinanceAPI.getFinanceInvoicesByIdPdf(456)
+
+      assert.strictEqual(requestArgs.responseType, 'arraybuffer')
+    })
+  })
+})

test/test-manage.mjs

@@ -17,17 +17,17 @@ const {
   MANAGE_API_CLIENT_ID = 'test-client-id',
 } = process.env
 
-const cwm = new ManageAPI({
-  companyId: MANAGE_API_COMPANY,
-  companyUrl: MANAGE_API_URL,
-  publicKey: MANAGE_API_PUBLIC_KEY,
-  privateKey: MANAGE_API_PRIVATE_KEY,
-  clientId: MANAGE_API_CLIENT_ID,
-  apiVersion: '2021.2',
-  logger: () => {},
-})
-
 describe('Manage', () => {
+  const cwm = new ManageAPI({
+    companyId: MANAGE_API_COMPANY,
+    companyUrl: MANAGE_API_URL,
+    publicKey: MANAGE_API_PUBLIC_KEY,
+    privateKey: MANAGE_API_PRIVATE_KEY,
+    clientId: MANAGE_API_CLIENT_ID,
+    apiVersion: '2021.2',
+    logger: () => {},
+  })
+
   describe('instance', () => {
     it('should be an instance of ManageAPI', () => {
       assert(cwm instanceof ManageAPI)