refactor: use @returns instead of @return to match typedocs standard

Author: axe312ger

lib/create-app-definition-api.ts

@@ -25,7 +25,7 @@ export default function createAppDefinitionApi(makeRequest: MakeRequest) {
   return {
     /**
      * Sends an update to the server with any changes made to the object's properties
-     * @return Object returned from the server with updated changes.
+     * @returns Object returned from the server with updated changes.
      * @example
      * ```javascript
      * const contentful = require('contentful-management')
@@ -57,7 +57,7 @@ export default function createAppDefinitionApi(makeRequest: MakeRequest) {
 
     /**
      * Deletes this object on the server.
-     * @return Promise for the deletion. It contains no data, but the Promise error case should be handled.
+     * @returns Promise for the deletion. It contains no data, but the Promise error case should be handled.
      * @example
      * ```javascript
      * const contentful = require('contentful-management')
@@ -85,7 +85,7 @@ export default function createAppDefinitionApi(makeRequest: MakeRequest) {
     /**
      * Gets an app bundle
      * @param id - AppBundle ID
-     * @return Promise for an AppBundle
+     * @returns Promise for an AppBundle
      * @example
      * ```javascript
      * const contentful = require('contentful-management')
@@ -115,7 +115,7 @@ export default function createAppDefinitionApi(makeRequest: MakeRequest) {
 
     /**
      * Gets a collection of AppBundles
-     * @return Promise for a collection of AppBundles
+     * @returns Promise for a collection of AppBundles
      * @example
      * ```javascript
      * const contentful = require('contentful-management')
@@ -142,7 +142,7 @@ export default function createAppDefinitionApi(makeRequest: MakeRequest) {
     /**
      * Creates an app bundle
      * @param Object representation of the App Bundle to be created
-     * @return Promise for the newly created AppBundle
+     * @returns Promise for the newly created AppBundle
      * @example
      * ```javascript
      * const contentful = require('contentful-management')
@@ -172,7 +172,7 @@ export default function createAppDefinitionApi(makeRequest: MakeRequest) {
     /**
      * Gets a list of App Installations across an org for given organization and App Definition
      * If a spaceId is provided in the query object, it will return the App Installations for that specific space.
-     * @return Promise for the newly created AppBundle
+     * @returns Promise for the newly created AppBundle
      * @example
      * ```javascript
      * const contentful = require('contentful-management')
@@ -202,7 +202,7 @@ export default function createAppDefinitionApi(makeRequest: MakeRequest) {
     /**
      * Creates or updates a resource provider
      * @param data representation of the ResourceProvider
-     * @return Promise for the newly created or updated ResourceProvider
+     * @returns Promise for the newly created or updated ResourceProvider
      * @example
      * ```javascript
      * const contentful = require('contentful-management')
@@ -244,7 +244,7 @@ export default function createAppDefinitionApi(makeRequest: MakeRequest) {
     },
     /**
      * Gets a Resource Provider
-     * @return Promise for a Resource Provider
+     * @returns Promise for a Resource Provider
      * @example
      * ```javascript
      * const contentful = require('contentful-management')

lib/create-contentful-api.ts

@@ -54,7 +54,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
     /**
      * Gets all environment templates for a given organization with the lasted version
      * @param organizationId - Organization ID
-     * @return Promise for a collection of EnvironmentTemplates
+     * @returns Promise for a collection of EnvironmentTemplates
      * ```javascript
      * const contentful = require('contentful-management')
      *
@@ -83,7 +83,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
      * @param params.organizationId - Organization ID
      * @param params.environmentTemplateId - Environment template ID
      * @param [params.version] - Template version number to return a specific version of the environment template
-     * @return Promise for a EnvironmentTemplate
+     * @returns Promise for a EnvironmentTemplate
      * ```javascript
      * const contentful = require('contentful-management')
      *
@@ -124,7 +124,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
      * Creates an environment template
      * @param organizationId - Organization ID
      * @param environmentTemplateData - Object representation of the environment template to be created
-     * @return Promise for the newly created EnvironmentTemplate
+     * @returns Promise for the newly created EnvironmentTemplate
      * @example
      * ```javascript
      * const contentful = require('contentful-management')
@@ -151,7 +151,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
     },
     /**
      * Gets all spaces
-     * @return Promise for a collection of Spaces
+     * @returns Promise for a collection of Spaces
      * ```javascript
      * const contentful = require('contentful-management')
      *
@@ -177,7 +177,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
     /**
      * Gets a space
      * @param spaceId - Space ID
-     * @return Promise for a Space
+     * @returns Promise for a Space
      * ```javascript
      * const contentful = require('contentful-management')
      *
@@ -202,7 +202,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
      * Creates a space
      * @param spaceData - Object representation of the Space to be created
      * @param organizationId - Organization ID, if the associated token can manage more than one organization.
-     * @return Promise for the newly created Space
+     * @returns Promise for the newly created Space
      * @example
      * ```javascript
      * const contentful = require('contentful-management')
@@ -233,7 +233,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
     /**
      * Gets an organization
      * @param  id - Organization ID
-     * @return Promise for a Organization
+     * @returns Promise for a Organization
      * @example
      * ```javascript
      * const contentful = require('contentful-management')
@@ -257,7 +257,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
 
     /**
      * Gets a collection of Organizations
-     * @return Promise for a collection of Organizations
+     * @returns Promise for a collection of Organizations
      * @example
      * ```javascript
      * const contentful = require('contentful-management')
@@ -283,7 +283,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
 
     /**
      * Gets the authenticated user
-     * @return Promise for a User
+     * @returns Promise for a User
      * @example
      * ```javascript
      * const contentful = require('contentful-management')
@@ -396,7 +396,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
     },
     /**
      * Gets App Definition
-     * @return Promise for App Definition
+     * @returns Promise for App Definition
      * @example
      * ```javascript
      * const contentful = require('contentful-management')
@@ -424,7 +424,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
     /**
      * Creates a personal access token
      * @param data - personal access token config
-     * @return Promise for a Token
+     * @returns Promise for a Token
      * @example
      * ```javascript
      * const contentful = require('contentful-management')
@@ -465,7 +465,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
      *
      * Gets a personal access token
      * @param tokenId - personal access token config
-     * @return Promise for a Token
+     * @returns Promise for a Token
      * @example
      * ```javascript
      * const contentful = require('contentful-management')
@@ -491,7 +491,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
      * @deprecated - use getAccessTokens instead
      *
      * Gets all personal access tokens
-     * @return Promise for a Token
+     * @returns Promise for a Token
      * @example
      * ```javascript
      * const contentful = require('contentful-management')
@@ -516,7 +516,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
     /**
      * Gets a users access token
      * @param tokenId - users access token config
-     * @return Promise for a Token
+     * @returns Promise for a Token
      * @example
      * ```javascript
      * const contentful = require('contentful-management')
@@ -540,7 +540,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
 
     /**
      * Gets all user access tokens
-     * @return Promise for a Token
+     * @returns Promise for a Token
      * @example
      * ```javascript
      * const contentful = require('contentful-management')
@@ -565,7 +565,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
     /**
      * Retrieves a list of redacted versions of access tokens for an organization, accessible to owners or administrators of an organization.
      *
-     * @return Promise for a Token
+     * @returns Promise for a Token
      * @example
      * ```javascript
      * const contentful = require('contentful-management')
@@ -595,7 +595,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
      *
      * @param organizationId - Id of an organization
      * @param query - Query parameters
-     * @return Promise of a collection of usages
+     * @returns Promise of a collection of usages
      * @example
      * ```javascript
      *
@@ -631,7 +631,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
      *
      * @param organizationId - Id of an organization
      * @param query - Query parameters
-     * @return Promise of a collection of usages
+     * @returns Promise of a collection of usages
      * ```javascript
      * const contentful = require('contentful-management')
      *
@@ -665,7 +665,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
     /**
      * Make a custom request to the Contentful management API's /spaces endpoint
      * @param opts - axios request options (https://github.com/mzabriskie/axios)
-     * @return Promise for the response data
+     * @returns Promise for the response data
      * ```javascript
      * const contentful = require('contentful-management')
      *

lib/create-entry-api.ts

@@ -36,7 +36,7 @@ export default function createEntryApi(makeRequest: MakeRequest) {
   return {
     /**
      * Sends an update to the server with any changes made to the object's properties
-     * @return Object returned from the server with updated changes.
+     * @returns Object returned from the server with updated changes.
      * @example
      * ```javascript
      * const contentful = require('contentful-management')
@@ -69,7 +69,7 @@ export default function createEntryApi(makeRequest: MakeRequest) {
 
     /**
      * Sends an JSON patch to the server with any changes made to the object's properties
-     * @return Object returned from the server with updated changes.
+     * @returns Object returned from the server with updated changes.
      * @example
      * ```javascript
      * const contentful = require('contentful-management')
@@ -108,7 +108,7 @@ export default function createEntryApi(makeRequest: MakeRequest) {
 
     /**
      * Deletes this object on the server.
-     * @return Promise for the deletion. It contains no data, but the Promise error case should be handled.
+     * @returns Promise for the deletion. It contains no data, but the Promise error case should be handled.
      * @example
      * ```javascript
      * const contentful = require('contentful-management')
@@ -133,7 +133,7 @@ export default function createEntryApi(makeRequest: MakeRequest) {
 
     /**
      * Publishes the object
-     * @return Object returned from the server with updated metadata.
+     * @returns Object returned from the server with updated metadata.
      * @example
      * ```javascript
      * const contentful = require('contentful-management')
@@ -163,7 +163,7 @@ export default function createEntryApi(makeRequest: MakeRequest) {
 
     /**
      * Unpublishes the object
-     * @return Object returned from the server with updated metadata.
+     * @returns Object returned from the server with updated metadata.
      * @example
      * ```javascript
      * const contentful = require('contentful-management')
@@ -193,7 +193,7 @@ export default function createEntryApi(makeRequest: MakeRequest) {
 
     /**
      * Archives the object
-     * @return Object returned from the server with updated metadata.
+     * @returns Object returned from the server with updated metadata.
      * @example
      * ```javascript
      * const contentful = require('contentful-management')
@@ -222,7 +222,7 @@ export default function createEntryApi(makeRequest: MakeRequest) {
 
     /**
      * Unarchives the object
-     * @return Object returned from the server with updated metadata.
+     * @returns Object returned from the server with updated metadata.
      * @example
      * ```javascript
      * const contentful = require('contentful-management')