@pollination-solutions/pollination-sdk 0.20.0 → 0.22.0

package/dist/api/licenses-api.d.ts

@@ -0,0 +1,451 @@
+/**
+ * pollination-server
+ * Pollination Server OpenAPI Definition
+ *
+ * The version of the OpenAPI document: 0.22.0
+ * Contact: info@pollination.cloud
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AxiosPromise, AxiosInstance } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { ActivationList } from '../models';
+import { LicensePoolAccessPolicyList } from '../models';
+import { LicensePoolList } from '../models';
+import { LicensePoolPolicySubjectList } from '../models';
+import { LicensePoolPublic } from '../models';
+import { LicensePoolUpdate } from '../models';
+import { LicensePublic } from '../models';
+/**
+ * LicensesApi - axios parameter creator
+ * @export
+ */
+export declare const LicensesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Delete the activation
+     * @summary Delete Activation
+     * @param {string} poolId
+     * @param {string} activationId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteActivation: (poolId: string, activationId: string, options?: any) => Promise<RequestArgs>;
+    /**
+     * Get license pools available to authenticated user
+     * @summary Get Available Pools
+     * @param {Array<string>} [owner] Owner of the project
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAvailablePools: (owner?: Array<string>, options?: any) => Promise<RequestArgs>;
+    /**
+     * Get the activations for the license
+     * @summary Get Activations
+     * @param {string} poolId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getLicenseActivations: (poolId: string, options?: any) => Promise<RequestArgs>;
+    /**
+     * Get the license associated with a pool
+     * @summary Get Pool License
+     * @param {string} poolId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPoolLicense: (poolId: string, options?: any) => Promise<RequestArgs>;
+    /**
+     * Grant access to the license pool
+     * @summary Grant Pool Access
+     * @param {string} poolId
+     * @param {LicensePoolAccessPolicyList} licensePoolAccessPolicyList
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    grantAccessToPool: (poolId: string, licensePoolAccessPolicyList: LicensePoolAccessPolicyList, options?: any) => Promise<RequestArgs>;
+    /**
+     * Regenerate the license associated with the pool
+     * @summary Regenerate
+     * @param {string} poolId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    regenerateLicensePool: (poolId: string, options?: any) => Promise<RequestArgs>;
+    /**
+     * Revoke access to the license pool
+     * @summary Delete Pool Access
+     * @param {string} poolId
+     * @param {LicensePoolPolicySubjectList} licensePoolPolicySubjectList
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    revokeAccessToPool: (poolId: string, licensePoolPolicySubjectList: LicensePoolPolicySubjectList, options?: any) => Promise<RequestArgs>;
+    /**
+     * Update the license pool
+     * @summary Update Pool
+     * @param {string} poolId
+     * @param {LicensePoolUpdate} licensePoolUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateLicensePool: (poolId: string, licensePoolUpdate: LicensePoolUpdate, options?: any) => Promise<RequestArgs>;
+};
+/**
+ * LicensesApi - functional programming interface
+ * @export
+ */
+export declare const LicensesApiFp: (configuration?: Configuration) => {
+    /**
+     * Delete the activation
+     * @summary Delete Activation
+     * @param {string} poolId
+     * @param {string} activationId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteActivation(poolId: string, activationId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Get license pools available to authenticated user
+     * @summary Get Available Pools
+     * @param {Array<string>} [owner] Owner of the project
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAvailablePools(owner?: Array<string>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LicensePoolList>>;
+    /**
+     * Get the activations for the license
+     * @summary Get Activations
+     * @param {string} poolId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getLicenseActivations(poolId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ActivationList>>;
+    /**
+     * Get the license associated with a pool
+     * @summary Get Pool License
+     * @param {string} poolId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPoolLicense(poolId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LicensePublic>>;
+    /**
+     * Grant access to the license pool
+     * @summary Grant Pool Access
+     * @param {string} poolId
+     * @param {LicensePoolAccessPolicyList} licensePoolAccessPolicyList
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    grantAccessToPool(poolId: string, licensePoolAccessPolicyList: LicensePoolAccessPolicyList, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LicensePoolPublic>>;
+    /**
+     * Regenerate the license associated with the pool
+     * @summary Regenerate
+     * @param {string} poolId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    regenerateLicensePool(poolId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+    /**
+     * Revoke access to the license pool
+     * @summary Delete Pool Access
+     * @param {string} poolId
+     * @param {LicensePoolPolicySubjectList} licensePoolPolicySubjectList
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    revokeAccessToPool(poolId: string, licensePoolPolicySubjectList: LicensePoolPolicySubjectList, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LicensePoolPublic>>;
+    /**
+     * Update the license pool
+     * @summary Update Pool
+     * @param {string} poolId
+     * @param {LicensePoolUpdate} licensePoolUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateLicensePool(poolId: string, licensePoolUpdate: LicensePoolUpdate, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+};
+/**
+ * LicensesApi - factory interface
+ * @export
+ */
+export declare const LicensesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Delete the activation
+     * @summary Delete Activation
+     * @param {string} poolId
+     * @param {string} activationId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteActivation(poolId: string, activationId: string, options?: any): AxiosPromise<void>;
+    /**
+     * Get license pools available to authenticated user
+     * @summary Get Available Pools
+     * @param {Array<string>} [owner] Owner of the project
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAvailablePools(owner?: Array<string>, options?: any): AxiosPromise<LicensePoolList>;
+    /**
+     * Get the activations for the license
+     * @summary Get Activations
+     * @param {string} poolId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getLicenseActivations(poolId: string, options?: any): AxiosPromise<ActivationList>;
+    /**
+     * Get the license associated with a pool
+     * @summary Get Pool License
+     * @param {string} poolId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPoolLicense(poolId: string, options?: any): AxiosPromise<LicensePublic>;
+    /**
+     * Grant access to the license pool
+     * @summary Grant Pool Access
+     * @param {string} poolId
+     * @param {LicensePoolAccessPolicyList} licensePoolAccessPolicyList
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    grantAccessToPool(poolId: string, licensePoolAccessPolicyList: LicensePoolAccessPolicyList, options?: any): AxiosPromise<LicensePoolPublic>;
+    /**
+     * Regenerate the license associated with the pool
+     * @summary Regenerate
+     * @param {string} poolId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    regenerateLicensePool(poolId: string, options?: any): AxiosPromise<any>;
+    /**
+     * Revoke access to the license pool
+     * @summary Delete Pool Access
+     * @param {string} poolId
+     * @param {LicensePoolPolicySubjectList} licensePoolPolicySubjectList
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    revokeAccessToPool(poolId: string, licensePoolPolicySubjectList: LicensePoolPolicySubjectList, options?: any): AxiosPromise<LicensePoolPublic>;
+    /**
+     * Update the license pool
+     * @summary Update Pool
+     * @param {string} poolId
+     * @param {LicensePoolUpdate} licensePoolUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateLicensePool(poolId: string, licensePoolUpdate: LicensePoolUpdate, options?: any): AxiosPromise<any>;
+};
+/**
+ * Request parameters for deleteActivation operation in LicensesApi.
+ * @export
+ * @interface LicensesApiDeleteActivationRequest
+ */
+export interface LicensesApiDeleteActivationRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof LicensesApiDeleteActivation
+     */
+    readonly poolId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof LicensesApiDeleteActivation
+     */
+    readonly activationId: string;
+}
+/**
+ * Request parameters for getAvailablePools operation in LicensesApi.
+ * @export
+ * @interface LicensesApiGetAvailablePoolsRequest
+ */
+export interface LicensesApiGetAvailablePoolsRequest {
+    /**
+     * Owner of the project
+     * @type {Array<string>}
+     * @memberof LicensesApiGetAvailablePools
+     */
+    readonly owner?: Array<string>;
+}
+/**
+ * Request parameters for getLicenseActivations operation in LicensesApi.
+ * @export
+ * @interface LicensesApiGetLicenseActivationsRequest
+ */
+export interface LicensesApiGetLicenseActivationsRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof LicensesApiGetLicenseActivations
+     */
+    readonly poolId: string;
+}
+/**
+ * Request parameters for getPoolLicense operation in LicensesApi.
+ * @export
+ * @interface LicensesApiGetPoolLicenseRequest
+ */
+export interface LicensesApiGetPoolLicenseRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof LicensesApiGetPoolLicense
+     */
+    readonly poolId: string;
+}
+/**
+ * Request parameters for grantAccessToPool operation in LicensesApi.
+ * @export
+ * @interface LicensesApiGrantAccessToPoolRequest
+ */
+export interface LicensesApiGrantAccessToPoolRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof LicensesApiGrantAccessToPool
+     */
+    readonly poolId: string;
+    /**
+     *
+     * @type {LicensePoolAccessPolicyList}
+     * @memberof LicensesApiGrantAccessToPool
+     */
+    readonly licensePoolAccessPolicyList: LicensePoolAccessPolicyList;
+}
+/**
+ * Request parameters for regenerateLicensePool operation in LicensesApi.
+ * @export
+ * @interface LicensesApiRegenerateLicensePoolRequest
+ */
+export interface LicensesApiRegenerateLicensePoolRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof LicensesApiRegenerateLicensePool
+     */
+    readonly poolId: string;
+}
+/**
+ * Request parameters for revokeAccessToPool operation in LicensesApi.
+ * @export
+ * @interface LicensesApiRevokeAccessToPoolRequest
+ */
+export interface LicensesApiRevokeAccessToPoolRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof LicensesApiRevokeAccessToPool
+     */
+    readonly poolId: string;
+    /**
+     *
+     * @type {LicensePoolPolicySubjectList}
+     * @memberof LicensesApiRevokeAccessToPool
+     */
+    readonly licensePoolPolicySubjectList: LicensePoolPolicySubjectList;
+}
+/**
+ * Request parameters for updateLicensePool operation in LicensesApi.
+ * @export
+ * @interface LicensesApiUpdateLicensePoolRequest
+ */
+export interface LicensesApiUpdateLicensePoolRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof LicensesApiUpdateLicensePool
+     */
+    readonly poolId: string;
+    /**
+     *
+     * @type {LicensePoolUpdate}
+     * @memberof LicensesApiUpdateLicensePool
+     */
+    readonly licensePoolUpdate: LicensePoolUpdate;
+}
+/**
+ * LicensesApi - object-oriented interface
+ * @export
+ * @class LicensesApi
+ * @extends {BaseAPI}
+ */
+export declare class LicensesApi extends BaseAPI {
+    /**
+     * Delete the activation
+     * @summary Delete Activation
+     * @param {LicensesApiDeleteActivationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LicensesApi
+     */
+    deleteActivation(requestParameters: LicensesApiDeleteActivationRequest, options?: any): Promise<import("axios").AxiosResponse<void>>;
+    /**
+     * Get license pools available to authenticated user
+     * @summary Get Available Pools
+     * @param {LicensesApiGetAvailablePoolsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LicensesApi
+     */
+    getAvailablePools(requestParameters?: LicensesApiGetAvailablePoolsRequest, options?: any): Promise<import("axios").AxiosResponse<LicensePoolList>>;
+    /**
+     * Get the activations for the license
+     * @summary Get Activations
+     * @param {LicensesApiGetLicenseActivationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LicensesApi
+     */
+    getLicenseActivations(requestParameters: LicensesApiGetLicenseActivationsRequest, options?: any): Promise<import("axios").AxiosResponse<ActivationList>>;
+    /**
+     * Get the license associated with a pool
+     * @summary Get Pool License
+     * @param {LicensesApiGetPoolLicenseRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LicensesApi
+     */
+    getPoolLicense(requestParameters: LicensesApiGetPoolLicenseRequest, options?: any): Promise<import("axios").AxiosResponse<LicensePublic>>;
+    /**
+     * Grant access to the license pool
+     * @summary Grant Pool Access
+     * @param {LicensesApiGrantAccessToPoolRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LicensesApi
+     */
+    grantAccessToPool(requestParameters: LicensesApiGrantAccessToPoolRequest, options?: any): Promise<import("axios").AxiosResponse<LicensePoolPublic>>;
+    /**
+     * Regenerate the license associated with the pool
+     * @summary Regenerate
+     * @param {LicensesApiRegenerateLicensePoolRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LicensesApi
+     */
+    regenerateLicensePool(requestParameters: LicensesApiRegenerateLicensePoolRequest, options?: any): Promise<import("axios").AxiosResponse<any>>;
+    /**
+     * Revoke access to the license pool
+     * @summary Delete Pool Access
+     * @param {LicensesApiRevokeAccessToPoolRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LicensesApi
+     */
+    revokeAccessToPool(requestParameters: LicensesApiRevokeAccessToPoolRequest, options?: any): Promise<import("axios").AxiosResponse<LicensePoolPublic>>;
+    /**
+     * Update the license pool
+     * @summary Update Pool
+     * @param {LicensesApiUpdateLicensePoolRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof LicensesApi
+     */
+    updateLicensePool(requestParameters: LicensesApiUpdateLicensePoolRequest, options?: any): Promise<import("axios").AxiosResponse<any>>;
+}