@nutanix-scratch/licensing-js-client 4.0.1-alpha.1

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

@@ -0,0 +1,292 @@
+/**
+ * Licenses service.
+ * @version 4.0.1-alpha-1
+ * @class LicensesApi
+ */
+export class LicensesApi {
+    /**
+    * Make the default {@link ApiClient} class available for developers to be able to extend it and bring
+    * their own fetch methods into the SDK
+    */
+    static get ApiClient(): typeof ApiClient;
+    /**
+     * Constructs a new LicensesApi.
+     * @alias module:api/LicensesApi
+     * @class
+     * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+     * default to {@link module:ApiClient#instance} if unspecified.
+     */
+    constructor(apiClient?: any);
+    apiClient: any;
+    /**
+     * Get allowances for a cluster
+     * API to fetch allowances for a particular cluster.
+     * @param { String } extId Prism Central or Prism Element UUID.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<GetClusterAllowanceApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetClusterAllowanceApiResponse } and HTTP response
+     */
+    getClusterAllowanceByClusterId(extId: string, ...args: any): Promise<GetClusterAllowanceApiResponse>;
+    /**
+     * List license entitlements for a cluster
+     * API to fetch entitlements for a particular cluster.
+     * @param { String } extId Prism Central or Prism Element UUID.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<GetClusterEntitlementApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetClusterEntitlementApiResponse } and HTTP response
+     */
+    getClusterEntitlementByClusterId(extId: string, ...args: any): Promise<GetClusterEntitlementApiResponse>;
+    /**
+     * Get license violation for a cluster
+     * API to fetch violations for a particular cluster.
+     * @param { String } extId Prism Central or Prism Element UUID.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<GetClusterViolationApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetClusterViolationApiResponse } and HTTP response
+     */
+    getClusterViolationByClusterId(extId: string, ...args: any): Promise<GetClusterViolationApiResponse>;
+    /**
+     * List license compliances for a cluster
+     * API to fetch compliances for a particular cluster.
+     * @param { String } extId Prism Central or Prism Element UUID.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<GetComplianceApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetComplianceApiResponse } and HTTP response
+     */
+    getComplianceByClusterId(extId: string, ...args: any): Promise<GetComplianceApiResponse>;
+    /**
+     * Get applied license inventory by license ID
+     * API to fetch license details for a particular license identifier.
+     * @param { String } extId License ID to be fetched, Example: LIC-01485985
+     * @param {Object} args Additional Arguments
+     * @return {Promise<GetLicenseApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetLicenseApiResponse } and HTTP response
+     */
+    getLicenseById(extId: string, ...args: any): Promise<GetLicenseApiResponse>;
+    /**
+     * Get license configurations for a cluster
+     * API to fetch setting details for a particular cluster.
+     * @param { String } extId Prism Central or Prism Element UUID.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<GetSettingApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetSettingApiResponse } and HTTP response
+     */
+    getSettingByClusterId(extId: string, ...args: any): Promise<GetSettingApiResponse>;
+    /**
+     * List allowances
+     * API to fetch allowances.
+     * @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'.<br>
+     * The filter can be applied to the following fields:<br>
+     * - clusterExtId<br>
+     * - extId<br>
+     * - isDeleted<br>
+     * - name<br>
+     * - type
+     * @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. The following expansion keys are supported.
+- allowanceDetails
+
+     * @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.
+- clusterExtId
+- extId
+- name
+- type
+
+     * @param {Object} args Additional Arguments
+     * @return {Promise<ListClusterAllowancesApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListClusterAllowancesApiResponse } and HTTP response
+     */
+    listAllowances(opts: {
+        $page: number;
+        $limit: number;
+        $filter: string;
+        $expand: string;
+        $select: string;
+    }, ...args: any): Promise<ListClusterAllowancesApiResponse>;
+    /**
+     * List license compliances
+     * API to fetch list of compliances across clusters.
+     * @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'.<br>
+     * The filter can be applied to the following fields:<br>
+     * - clusterExtId<br>
+     * - isDeleted<br>
+     * - type
+     * @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. The following expansion keys are supported.
+- compliance
+
+     * @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.
+- clusterExtId
+- type
+
+     * @param {Object} args Additional Arguments
+     * @return {Promise<ListCompliancesApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListCompliancesApiResponse } and HTTP response
+     */
+    listCompliances(opts: {
+        $page: number;
+        $limit: number;
+        $filter: string;
+        $expand: string;
+        $select: string;
+    }, ...args: any): Promise<ListCompliancesApiResponse>;
+    /**
+     * List license entitlements
+     * API to fetch entitlements list.
+     * @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'.<br>
+     * The filter can be applied to the following fields:<br>
+     * - clusterExtId<br>
+     * - extId<br>
+     * - isDeleted<br>
+     * - name<br>
+     * - type
+     * @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. The following expansion keys are supported.
+- entitlementDetails
+
+     * @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.
+- clusterExtId
+- extId
+- name
+- type
+
+     * @param {Object} args Additional Arguments
+     * @return {Promise<ListClusterEntitlementsApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListClusterEntitlementsApiResponse } and HTTP response
+     */
+    listEntitlements(opts: {
+        $page: number;
+        $limit: number;
+        $filter: string;
+        $expand: string;
+        $select: string;
+    }, ...args: any): Promise<ListClusterEntitlementsApiResponse>;
+    /**
+     * List license features
+     * API to fetch features list.
+     * @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'.<br>
+     * The filter can be applied to the following fields:<br>
+     * - licenseCategory<br>
+     * - licenseSubCategory<br>
+     * - licenseType<br>
+     * - name<br>
+     * - scope<br>
+     * - type<br>
+     * - value
+     * @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.<br>
+     * The orderby can be applied to the following fields:<br>
+     * - licenseCategory<br>
+     * - licenseType<br>
+     * - name
+     * @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.
+- licenseCategory
+- licenseSubCategory
+- licenseType
+- name
+- type
+- value
+
+     * @param {Object} args Additional Arguments
+     * @return {Promise<ListFeaturesApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListFeaturesApiResponse } and HTTP response
+     */
+    listFeatures(opts: {
+        $page: number;
+        $limit: number;
+        $filter: string;
+        $orderby: string;
+        $select: string;
+    }, ...args: any): Promise<ListFeaturesApiResponse>;
+    /**
+     * List applied license inventory
+     * API to fetch license list along with consumption details using expansion.
+     * @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'.<br>
+     * The filter can be applied to the following fields:<br>
+     * - category<br>
+     * - extId<br>
+     * - isDeleted<br>
+     * - meter<br>
+     * - subCategory<br>
+     * - type
+     * @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. The following expansion keys are supported.
+- consumptionDetails
+
+     * @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.
+- category
+- meter
+- subCategory
+- type
+
+     * @param {Object} args Additional Arguments
+     * @return {Promise<ListLicensesApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListLicensesApiResponse } and HTTP response
+     */
+    listLicenses(opts: {
+        $page: number;
+        $limit: number;
+        $filter: string;
+        $expand: string;
+        $select: string;
+    }, ...args: any): Promise<ListLicensesApiResponse>;
+    /**
+     * List license configurations
+     * API to fetch settings list.
+     * @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 {Object} args Additional Arguments
+     * @return {Promise<ListSettingsApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListSettingsApiResponse } and HTTP response
+     */
+    listSettings(opts: {
+        $page: number;
+        $limit: number;
+    }, ...args: any): Promise<ListSettingsApiResponse>;
+    /**
+     * List license violations
+     * API to fetch violations list.
+     * @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 {Object} args Additional Arguments
+     * @return {Promise<ListClusterViolationsApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListClusterViolationsApiResponse } and HTTP response
+     */
+    listViolations(opts: {
+        $page: number;
+        $limit: number;
+    }, ...args: any): Promise<ListClusterViolationsApiResponse>;
+    #private;
+}
+import GetClusterAllowanceApiResponse from "../models/licensing/v4/config/GetClusterAllowanceApiResponse";
+import GetClusterEntitlementApiResponse from "../models/licensing/v4/config/GetClusterEntitlementApiResponse";
+import GetClusterViolationApiResponse from "../models/licensing/v4/config/GetClusterViolationApiResponse";
+import GetComplianceApiResponse from "../models/licensing/v4/config/GetComplianceApiResponse";
+import GetLicenseApiResponse from "../models/licensing/v4/config/GetLicenseApiResponse";
+import GetSettingApiResponse from "../models/licensing/v4/config/GetSettingApiResponse";
+import ListClusterAllowancesApiResponse from "../models/licensing/v4/config/ListClusterAllowancesApiResponse";
+import ListCompliancesApiResponse from "../models/licensing/v4/config/ListCompliancesApiResponse";
+import ListClusterEntitlementsApiResponse from "../models/licensing/v4/config/ListClusterEntitlementsApiResponse";
+import ListFeaturesApiResponse from "../models/licensing/v4/config/ListFeaturesApiResponse";
+import ListLicensesApiResponse from "../models/licensing/v4/config/ListLicensesApiResponse";
+import ListSettingsApiResponse from "../models/licensing/v4/config/ListSettingsApiResponse";
+import ListClusterViolationsApiResponse from "../models/licensing/v4/config/ListClusterViolationsApiResponse";
+import { ApiClient } from "../ApiClient";