feat: implement getBrands method

Author: nguyentoanit

src/operations/profiles/profile-operation.ts

@@ -6,6 +6,7 @@ import {
   ProfileResponse,
   RegisterProfileResponse,
   ProfileRegistrationResponse,
+  Brand,
 } from './types'
 import { Decode, DecodeArray } from '../../decorators'
 import { AmazonMarketplaceAdvertisingCountryCodeType } from '../commons/types'
@@ -80,4 +81,16 @@ export class ProfileOperation extends Operation {
       registerBrand,
     )
   }
+
+  /**
+   * Gets an array of Brand data objects for the Brand associated with the profile ID passed in the header.
+   * For more information about Brands, see Brand Services.
+   *
+   * @returns
+   * @memberof ProfileOperation
+   */
+  @DecodeArray(Brand)
+  public getBrands() {
+    return this.client.get<Brand[]>(`${this.version}/brands`)
+  }
 }

src/operations/profiles/types.test.ts

@@ -77,3 +77,15 @@ describe('ProfileRegistrationResponse', () => {
     expect(isRight(res)).toBeFalsy()
   })
 })
+
+describe('Brand', () => {
+  it('should pass', () => {
+    const res = t.Brand.decode({
+      brandId: 'string',
+      brandEntityId: 'string',
+      brandRegistryName: 'string',
+    })
+
+    expect(isRight(res)).toBeTruthy()
+  })
+})

src/operations/profiles/types.ts

@@ -156,3 +156,21 @@ export const RegisterProfileResponse = t.intersection([
 ])
 
 export type RegisterProfileResponse = t.TypeOf<typeof RegisterProfileResponse>
+
+export const Brand = t.strict({
+  /**
+   * The Brand identifier.
+   */
+  brandId: t.string,
+
+  /**
+   * The Brand entity identifier.
+   */
+  brandEntityId: t.string,
+
+  /**
+   * The Brand name.
+   */
+  brandRegistryName: t.string,
+})
+export type Brand = t.TypeOf<typeof Brand>

test/operations/profiles/profile-operation.test.ts

@@ -80,4 +80,17 @@ describe('ProfileOperation', () => {
       expect(res.code).toBe(RegisterProfileResponseStatusEnum.SUCCESS)
     })
   })
+
+  /**
+   * TODO: Need check again on Production API. Sandbox API return an error:
+   * ResourceNotFoundError: Could not find resource for full path: https://advertising-api-test.amazon.com/v2/brands
+   */
+  describe.skip('getBrands', () => {
+    it(`should return an array of brands`, async () => {
+      const [brand] = await profileOperation.getBrands()
+
+      expect(brand.brandId).toBe('2973802954634317')
+      expect(brand.brandRegistryName).toBe('yay')
+    })
+  })
 })