feat: adding unit tests for publishedWithCursor methods for Asset and Entry, adding function level comments for new publishedWithCursor methods [CAPI-2387]

Author: ebefarooqui

lib/create-environment-api.ts

@@ -853,6 +853,24 @@ export default function createEnvironmentApi(makeRequest: MakeRequest) {
       }).then((data) => wrapEntryCollection(makeRequest, data))
     },
 
+    /**
+     * Gets a collection of published Entries with cursor based pagination
+     * @param query - Object with cursor pagination parameters. Check the <a href="https://www.contentful.com/developers/docs/references/content-management-api/#/introduction/cursor-pagination">REST API reference</a> for more details.
+     * @return Promise for a collection of published Entries
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment-id>'))
+     * .then((environment) => environment.getPublishedEntriesWithCursor())
+     * .then((response) => console.log(response.items))
+     * .catch(console.error)
+     * ```
+     */
     getPublishedEntriesWithCursor(query: BasicCursorPaginationOptions = {}) {
       const raw = this.toPlainObject() as EnvironmentProps
       const normalizedQueryParams = normalizeCursorPaginationParameters(query)
@@ -1127,6 +1145,24 @@ export default function createEnvironmentApi(makeRequest: MakeRequest) {
       }).then((data) => wrapAssetCollection(makeRequest, data))
     },
 
+    /**
+     * Gets a collection of published Assets with cursor based pagination
+     * @param query - Object with cursor pagination parameters. Check the <a href="https://www.contentful.com/developers/docs/references/content-management-api/#/introduction/cursor-pagination">REST API reference</a> for more details.
+     * @return Promise for a collection of published Assets
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     *
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * client.getSpace('<space_id>')
+     * .then((space) => space.getEnvironment('<environment-id>'))
+     * .then((environment) => environment.getPublishedAssetsWithCursor())
+     * .then((response) => console.log(response.items))
+     * .catch(console.error)
+     * ```
+     */
     getPublishedAssetsWithCursor(query: BasicCursorPaginationOptions = {}) {
       const raw = this.toPlainObject() as EnvironmentProps
       const normalizedQueryParams = normalizeCursorPaginationParameters(query)

test/unit/create-environment-api.test.ts

@@ -287,6 +287,21 @@ describe('A createEnvironmentApi', () => {
     })
   })
 
+    test('API call getPublishedEntriesWithCursor', async () => {
+    return makeGetPaginatedCollectionTest(setup, {
+      entityType: 'entry',
+      mockToReturn: mockCursorPaginatedCollection<EntryProps>(entryMock),
+      methodToTest: 'getPublishedEntriesWithCursor',
+    })
+  })
+
+  test('API call getPublishedEntriesWithCursor fails', async () => {
+    return makeEntityMethodFailingTest(setup, {
+      methodToTest: 'getPublishedEntriesWithCursor',
+    })
+  })
+  
+
   test('API call createEntry', async () => {
     const { api, makeRequest, entitiesMock } = setup(Promise.resolve(entryMock))
     entitiesMock.entry.wrapEntry.mockReturnValue(entryMock)
@@ -373,6 +388,20 @@ describe('A createEnvironmentApi', () => {
     })
   })
 
+   test('API call getPublishedAssetsWithCursor', async () => {
+    return makeGetPaginatedCollectionTest(setup, {
+      entityType: 'asset',
+      mockToReturn: mockCursorPaginatedCollection<AssetProps>(assetMock),
+      methodToTest: 'getPublishedAssetsWithCursor',
+    })
+  })
+
+  test('API call getPublishedAssetsWithCursor fails', async () => {
+    return makeEntityMethodFailingTest(setup, {
+      methodToTest: 'getPublishedAssetsWithCursor',
+    })
+  })
+
   test('API call createAsset', async () => {
     return makeCreateEntityTest(setup, {
       entityType: 'asset',