docs: generate JSDoc functions.md

Author: Mufti Azan Farooqi

docs/functions.md

@@ -4,6 +4,9 @@
 <dt><a href="#createLicense">createLicense(license)</a> ⇒ <code>Promise.&lt;ApiResponse.&lt;LicenseResponse&gt;&gt;</code></dt>
 <dd><p>Create a license.</p>
 </dd>
+<dt><a href="#createLicenses">createLicenses(license, count)</a> ⇒ <code>Promise.&lt;Array.&lt;ApiResponse&gt;&gt;</code></dt>
+<dd><p>Create multiple licenses</p>
+</dd>
 <dt><a href="#updateLicense">updateLicense(id, license)</a> ⇒ <code>Promise.&lt;ApiResponse.&lt;LicenseResponse&gt;&gt;</code></dt>
 <dd><p>Updates the specified license by setting the values of the existing license to the properties passed.
 Any properties not provided will be left unchanged.</p>
@@ -57,6 +60,20 @@ Create a license.
 | ------- | --------------------------------- | ------------------------ |
 | license | <code>LicenseCreateRequest</code> | License object to create |
 
+<a name="createLicenses"></a>
+
+## createLicenses(license, count) ⇒ <code>Promise.&lt;Array.&lt;ApiResponse&gt;&gt;</code>
+
+Create multiple licenses
+
+**Kind**: global function  
+**Returns**: <code>Promise.&lt;Array.&lt;ApiResponse&gt;&gt;</code> - Promise that resolves to an array of Web API responses.
+
+| Param   | Type                              | Description                  |
+| ------- | --------------------------------- | ---------------------------- |
+| license | <code>LicenseCreateRequest</code> | License object to create     |
+| count   | <code>number</code>               | Number of licenses to create |
+
 <a name="updateLicense"></a>
 
 ## updateLicense(id, license) ⇒ <code>Promise.&lt;ApiResponse.&lt;LicenseResponse&gt;&gt;</code>

src/client.ts

@@ -48,7 +48,7 @@ export default class CryptlexWebApiClient {
    * Create multiple licenses
    * @param {LicenseCreateRequest} license License object to create
    * @param {number} count Number of licenses to create
-   * @returns {Promise<ApiResponse<LicenseResponse>[]>} Promise that resolves to an array of Web API responses.
+   * @returns {Promise<ApiResponse[]>} Promise that resolves to an array of Web API responses.
    */
   createLicenses(
     license: LicenseCreateRequest,

src/http-client.ts

@@ -15,28 +15,35 @@ type AxiosErrorWithRetries = AxiosError & {
   config: AxiosRetryConfig;
 };
 
-/** Type alias for units. */
+/**
+ * @internal
+ * Type alias for units. */
 type Milliseconds = number;
 
 /**
+ * @internal
+ * @ignore
  * Default time to stall program
  */
 const DEFAULT_SLEEP_TIME: Milliseconds = 30000;
 
 /**
+ * @internal
+ * @ignore
  * Maximum allowed retries.
  */
 const MAX_RETRIES = 3;
 
 /**
+ * @internal
+ * @ignore
  * The HttpClient class abstracts any customizations on the underlying client(Axios) from the CryptlexWebApiClient class.
  */
 export class HttpClient {
   /** Axios instance */
   instance: AxiosInstance;
 
   /**
-   * @private
    * @internal
    * @param {CryptlexWebApiClientOptions} options CryptlexWebApiClientOptions
    */
@@ -53,7 +60,6 @@ export class HttpClient {
   }
 
   /**
-   * @private
    * @internal
    * Initializes interceptors for Axios client
    * @returns {void}
@@ -165,7 +171,7 @@ export class HttpClient {
 
 /**
  * @internal
- * @private
+ * @ignore
  *
  * Stalls the program.
  * @param {number} ms Time to stall in milliseconds