@nutanix-scratch/licensing-js-client 4.2.1 → 4.3.2

package/dist/es/apis/licensekeys-endpoints.d.ts

@@ -1,6 +1,6 @@
 /**
  * LicenseKeys service.
- * @version 4.2.1
+ * @version 4.3.2
  * @class LicenseKeysApi
  */
 export class LicenseKeysApi {
@@ -39,6 +39,15 @@ export class LicenseKeysApi {
      * @return {Promise<AssignLicenseKeysApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link AssignLicenseKeysApiResponse } and HTTP response
      */
     assignLicenseKeys(body: Required<Pick<LicenseKeyAssignmentSpec, 'licenseKeyAssignments'>> & Partial<LicenseKeyAssignmentSpec>, ...args: any): Promise<AssignLicenseKeysApiResponse>;
+    /**
+     * Allows to link license keys together
+     * Associate parent and child license key.
+     * @param { Required<Pick<AssociateLicenseKeySpec, 'keyAssociations'>> & Partial<AssociateLicenseKeySpec> } body specification
+     * @param { String } extId Path parameter for the license key ID.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<AssociateLicenseKeysApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link AssociateLicenseKeysApiResponse } and HTTP response
+     */
+    associateLicenseKeys(extId: string, body: Required<Pick<AssociateLicenseKeySpec, 'keyAssociations'>> & Partial<AssociateLicenseKeySpec>, ...args: any): Promise<AssociateLicenseKeysApiResponse>;
     /**
      * Delete license key
      * Deletes the license key based on the provided external identifier.
@@ -64,7 +73,7 @@ export class LicenseKeysApi {
      * @param { Number } opts.$limit A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
 
      * @param { String } opts.$filter A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions.<br>
-     * For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'.
+     * For example, filter **$filter=name eq 'karbon-ntnx-1.0'** would filter the result on cluster name 'karbon-ntnx1.0', filter **$filter=startswith(name, 'C')** would filter on cluster name starting with 'C'.
      * @param { String } opts.$orderby A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in descending order.
      * @param { String } opts.$expand A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved. Each expanded item is evaluated relative to the entity containing the property being expanded. Other query options can be applied to an expanded property by appending a semicolon-separated list of query options, enclosed in parentheses, to the property name. Permissible system query options are $filter, $select and $orderby.
      * @param { String } opts.$select A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned.
@@ -79,13 +88,49 @@ export class LicenseKeysApi {
         $expand: string;
         $select: string;
     }, ...args: any): Promise<ListLicenseKeysApiResponse>;
+    /**
+     * List reclaim license tokens.
+     * Fetches the reclaim license tokens for all reclaimed operations.
+     * @param {Object} opts Optional parameters defined for the operation
+     * @param { Number } opts.$page A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results.
+
+     * @param { Number } opts.$limit A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
+
+     * @param { String } opts.$filter A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions.<br>
+     * For example, filter **$filter=name eq 'karbon-ntnx-1.0'** would filter the result on cluster name 'karbon-ntnx1.0', filter **$filter=startswith(name, 'C')** would filter on cluster name starting with 'C'.
+     * @param { String } opts.$orderby A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in descending order.
+     * @param { String } opts.$select A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<ListReclaimLicenseTokensApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListReclaimLicenseTokensApiResponse } and HTTP response
+     */
+    listReclaimLicenseTokens(opts: {
+        $page: number;
+        $limit: number;
+        $filter: string;
+        $orderby: string;
+        $select: string;
+    }, ...args: any): Promise<ListReclaimLicenseTokensApiResponse>;
+    /**
+     * Reclaim license key
+     * Reclaim license key from the cluster.
+     * @param { Required<Pick<ReclaimLicenseKeySpec, 'quantity'>> & Partial<ReclaimLicenseKeySpec> } body specification
+     * @param { String } extId Path parameter for the license key ID.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<ReclaimLicenseKeyApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ReclaimLicenseKeyApiResponse } and HTTP response
+     */
+    reclaimLicenseKey(extId: string, body: Required<Pick<ReclaimLicenseKeySpec, 'quantity'>> & Partial<ReclaimLicenseKeySpec>, ...args: any): Promise<ReclaimLicenseKeyApiResponse>;
     #private;
 }
 import LicenseKey from "../models/licensing/v4/config/LicenseKey";
 import AddLicenseKeyApiResponse from "../models/licensing/v4/config/AddLicenseKeyApiResponse";
 import LicenseKeyAssignmentSpec from "../models/licensing/v4/config/LicenseKeyAssignmentSpec";
 import AssignLicenseKeysApiResponse from "../models/licensing/v4/config/AssignLicenseKeysApiResponse";
+import AssociateLicenseKeySpec from "../models/licensing/v4/config/AssociateLicenseKeySpec";
+import AssociateLicenseKeysApiResponse from "../models/licensing/v4/config/AssociateLicenseKeysApiResponse";
 import DeleteLicenseKeyApiResponse from "../models/licensing/v4/config/DeleteLicenseKeyApiResponse";
 import GetLicenseKeyApiResponse from "../models/licensing/v4/config/GetLicenseKeyApiResponse";
 import ListLicenseKeysApiResponse from "../models/licensing/v4/config/ListLicenseKeysApiResponse";
+import ListReclaimLicenseTokensApiResponse from "../models/licensing/v4/config/ListReclaimLicenseTokensApiResponse";
+import ReclaimLicenseKeySpec from "../models/licensing/v4/config/ReclaimLicenseKeySpec";
+import ReclaimLicenseKeyApiResponse from "../models/licensing/v4/config/ReclaimLicenseKeyApiResponse";
 import { ApiClient } from "../ApiClient";