@nutanix-scratch/iam-js-client 4.0.1-beta.1 → 4.0.1

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

@@ -1,230 +0,0 @@
-/**
- * ServiceAccount service.
- * @version 4.0.1-beta-1
- * @class ServiceAccountApi
- */
-export class ServiceAccountApi {
-    /**
-    * 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 ServiceAccountApi.
-     * @alias module:api/ServiceAccountApi
-     * @class
-     * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
-     * default to {@link module:ApiClient#instance} if unspecified.
-     */
-    constructor(apiClient?: any);
-    apiClient: any;
-    /**
-     * Create API key
-     * Create API key
-     * @param {ApiKey} body specification
-     * @param { String } extId External identifier of the service account
-     * @param {Object} args Additional Arguments
-     * @return {Promise<CreateApiKeyApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link CreateApiKeyApiResponse } and HTTP response
-     */
-    createApiKey(extId: string, body: ApiKey, ...args: any): Promise<CreateApiKeyApiResponse>;
-    /**
-     * Create service account
-     * Create service account
-     * @param {ServiceAccount} body specification
-     * @param {Object} args Additional Arguments
-     * @return {Promise<CreateServiceAccountApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link CreateServiceAccountApiResponse } and HTTP response
-     */
-    createServiceAccount(body: ServiceAccount, ...args: any): Promise<CreateServiceAccountApiResponse>;
-    /**
-     * Create service account key
-     * Create service account cert/key
-     * @param {ServiceAccountKey} body specification
-     * @param { String } extId External identifier of the service account
-     * @param {Object} args Additional Arguments
-     * @return {Promise<CreateServiceAccountKeyApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link CreateServiceAccountKeyApiResponse } and HTTP response
-     */
-    createServiceAccountKey(extId: string, body: ServiceAccountKey, ...args: any): Promise<CreateServiceAccountKeyApiResponse>;
-    /**
-     * Get API key
-     * View API key
-     * @param { String } svcAccExtId External identifier of the service account
-     * @param { String } extId External identifier of the API key
-     * @param {Object} args Additional Arguments
-     * @return {Promise<GetApiKeyApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetApiKeyApiResponse } and HTTP response
-     */
-    getApiKeyById(svcAccExtId: string, extId: string, ...args: any): Promise<GetApiKeyApiResponse>;
-    /**
-     * List API keys
-     * List API keys
-     * @param { String } extId External identifier of the service account
-     * @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.  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 will lead to no results being returned.
-
-     * @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 URL conventions.<br>
-     * For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter 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 on the following fields:<br>
-     * - createdBy<br>
-     * - name<br>
-     * - status
-     * @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 desc order.<br>
-     * The orderby can be applied to the following fields:<br>
-     * - createdTime<br>
-     * - expiryTime<br>
-     * - lastUsedTime<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 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.
-- apiKey
-- createdBy
-- createdTime
-- customOptions
-- description
-- expiryTime
-- extId
-- lastUsedTime
-- links
-- name
-- scope
-- status
-- tenantId
-
-     * @param {Object} args Additional Arguments
-     * @return {Promise<ListApiKeyApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListApiKeyApiResponse } and HTTP response
-     */
-    getApiKeyList(extId: string, opts: {
-        $page: number;
-        $limit: number;
-        $filter: string;
-        $orderby: string;
-        $select: string;
-    }, ...args: any): Promise<ListApiKeyApiResponse>;
-    /**
-     * Get service account
-     * View service account
-     * @param { String } extId External identifier of the service account
-     * @param {Object} args Additional Arguments
-     * @return {Promise<GetServiceAccountApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetServiceAccountApiResponse } and HTTP response
-     */
-    getServiceAccountById(extId: string, ...args: any): Promise<GetServiceAccountApiResponse>;
-    /**
-     * Get service account key
-     * View service account cert/key
-     * @param { String } svcAccExtId External identifier of the service account
-     * @param { String } extId External identifier of the service account key
-     * @param {Object} args Additional Arguments
-     * @return {Promise<GetServiceAccountKeyApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetServiceAccountKeyApiResponse } and HTTP response
-     */
-    getServiceAccountKeyById(svcAccExtId: string, extId: string, ...args: any): Promise<GetServiceAccountKeyApiResponse>;
-    /**
-     * List service account keys
-     * List service account certs/keys
-     * @param { String } extId External identifier of the service account
-     * @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.  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 will lead to no results being returned.
-
-     * @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 URL conventions.<br>
-     * For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter 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 on the following fields:<br>
-     * - createdBy<br>
-     * - name<br>
-     * - serialNumber
-     * @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 desc order.<br>
-     * The orderby can be applied to the following fields:<br>
-     * - createdTime<br>
-     * - expiryTime<br>
-     * - name<br>
-     * - serialNumber
-     * @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 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.
-- certificate
-- createdBy
-- createdTime
-- description
-- expiryTime
-- extId
-- links
-- name
-- privateKey
-- serialNumber
-- tenantId
-
-     * @param {Object} args Additional Arguments
-     * @return {Promise<ListServiceAccountKeyApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListServiceAccountKeyApiResponse } and HTTP response
-     */
-    getServiceAccountKeyList(extId: string, opts: {
-        $page: number;
-        $limit: number;
-        $filter: string;
-        $orderby: string;
-        $select: string;
-    }, ...args: any): Promise<ListServiceAccountKeyApiResponse>;
-    /**
-     * List service accounts
-     * List all service accounts
-     * @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.  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 will lead to no results being returned.
-
-     * @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 URL conventions.<br>
-     * For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter 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 on the following fields:<br>
-     * - createdBy<br>
-     * - emailId<br>
-     * - name
-     * @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 desc order.<br>
-     * The orderby can be applied to the following fields:<br>
-     * - createdTime<br>
-     * - emailId<br>
-     * - lastUpdatedTime<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 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.
-- createdBy
-- createdTime
-- description
-- emailId
-- extId
-- lastUpdatedTime
-- links
-- name
-- nutanixAccessKeys
-- nutanixApiKeys
-- tenantId
-
-     * @param {Object} args Additional Arguments
-     * @return {Promise<ListServiceAccountApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListServiceAccountApiResponse } and HTTP response
-     */
-    getServiceAccountList(opts: {
-        $page: number;
-        $limit: number;
-        $filter: string;
-        $orderby: string;
-        $select: string;
-    }, ...args: any): Promise<ListServiceAccountApiResponse>;
-    /**
-     * Revoke API key
-     * Revoke API key
-     * @param { String } svcAccExtId External identifier of the service account
-     * @param { String } extId External identifier of the API key
-     * @param {Object} args Additional Arguments
-     * @return {Promise<RevokeApiKeyApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link RevokeApiKeyApiResponse } and HTTP response
-     */
-    revokeApiKey(svcAccExtId: string, extId: string, ...args: any): Promise<RevokeApiKeyApiResponse>;
-    #private;
-}
-import ApiKey from "../models/iam/v4/authn/ApiKey";
-import CreateApiKeyApiResponse from "../models/iam/v4/authn/CreateApiKeyApiResponse";
-import ServiceAccount from "../models/iam/v4/authn/ServiceAccount";
-import CreateServiceAccountApiResponse from "../models/iam/v4/authn/CreateServiceAccountApiResponse";
-import ServiceAccountKey from "../models/iam/v4/authn/ServiceAccountKey";
-import CreateServiceAccountKeyApiResponse from "../models/iam/v4/authn/CreateServiceAccountKeyApiResponse";
-import GetApiKeyApiResponse from "../models/iam/v4/authn/GetApiKeyApiResponse";
-import ListApiKeyApiResponse from "../models/iam/v4/authn/ListApiKeyApiResponse";
-import GetServiceAccountApiResponse from "../models/iam/v4/authn/GetServiceAccountApiResponse";
-import GetServiceAccountKeyApiResponse from "../models/iam/v4/authn/GetServiceAccountKeyApiResponse";
-import ListServiceAccountKeyApiResponse from "../models/iam/v4/authn/ListServiceAccountKeyApiResponse";
-import ListServiceAccountApiResponse from "../models/iam/v4/authn/ListServiceAccountApiResponse";
-import RevokeApiKeyApiResponse from "../models/iam/v4/authn/RevokeApiKeyApiResponse";
-import { ApiClient } from "../ApiClient";