@dynatrace-sdk/client-classic-environment-v2 0.6.8 → 1.0.4

package/types/packages/client/classic-environment-v2/src/lib/apis/hub-items-api.d.ts

@@ -1,162 +0,0 @@
-import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
-import { CategoryList } from '../models/category-list';
-import { ExtensionReleaseNotes } from '../models/extension-release-notes';
-import { ItemDetails } from '../models/item-details';
-import { ItemList } from '../models/item-list';
-import { ListItemsQueryItemType } from '../models/list-items-query-item-type';
-import { RegisteredExtensionResultDto } from '../models/registered-extension-result-dto';
-import { UploadMetadataForExtensionBody } from '../models/upload-metadata-for-extension-body';
-/**
- * Install, update and manage metadata of Hub items
- */
-export declare class HubItemsClient {
-    private httpClient;
-    /**
-     * @param {HttpClient} httpClientImplementation - You can provide custom http client as a parameter to constructor of a HubItemsClient. Custom http client should implement {HttpClient} interface.
-     * @example
-     * const queryClientNodeJs = new QueryClient(yourCustomImplementation);
-     */
-    constructor(httpClientImplementation: HttpClient);
-    /**
-     * Retrieves the image associated with the given url.
-     * Can only obtain images used in hub items.
-     *
-     * **Required scope:** environment-api:hub:read
-     */
-    getImage(config: {
-        encodedUrl: string;
-        abortSignal?: AbortSignal;
-    }): Promise<void>;
-    /**
-     * Lists all the available category groupings of items
-     *
-     * **Required scope:** environment-api:hub:read
-     * @returns OK
-     */
-    listCategories(abortSignal?: AbortSignal): Promise<CategoryList>;
-    /**
-     * Registers the given extension version in the environment (using the recommended version if no other release is registered)
-     *
-     * **Required scope:** environment-api:hub:write
-     * @returns OK
-     */
-    addToEnvironment(config: {
-        /** Fully qualified name of the extension */ extensionName: string;
-        /** Version of the extension. Fallback to the evaluated recommended version when the version is not provided */ extensionVersion?: string;
-        abortSignal?: AbortSignal;
-    }): Promise<RegisteredExtensionResultDto>;
-    /**
-     * The details of the given extension
-     *
-     * **Required scope:** environment-api:hub:read
-     * @returns OK
-     */
-    getExtensionDetails(config: {
-        /** Fully qualified name of the extension */ extensionName: string;
-        abortSignal?: AbortSignal;
-    }): Promise<ItemDetails>;
-    /**
-     * Updates the given extension to the latest compatible published version
-     *
-     * **Required scope:** environment-api:hub:write
-     * @returns OK
-     */
-    update(config: {
-        /** Fully qualified name of the extension */ extensionName: string;
-        /** Version of the extension. Fallback to the evaluated recommended version when the version is not provided */ extensionVersion?: string;
-        abortSignal?: AbortSignal;
-    }): Promise<RegisteredExtensionResultDto>;
-    /**
-     * Sets or updates the release notes of the specified extension release
-     *
-     * **Required scope:** environment-api:hub:write
-     */
-    updateReleaseNotes(config: {
-        body: ExtensionReleaseNotes;
-        /** Fully qualified name of the extension */ extensionName: string;
-        /** Version of the extension release */ version: string;
-        abortSignal?: AbortSignal;
-    }): Promise<void>;
-    /**
-     * Create/Replace metadata for an extension that does not have Dynatrace distributed metadata.
-     *
-     * **Required scope:** environment-api:hub:write
-     */
-    uploadMetadataForExtension(config: {
-        body: UploadMetadataForExtensionBody;
-        /** Fully qualified name of the extension */ extensionName: string;
-        abortSignal?: AbortSignal;
-    }): Promise<void>;
-    /**
-     * Artifact of the given version of an item
-     *
-     * **Required scope:** environment-api:hub:read
-     * @returns Ok - download file
-     */
-    getArtifact(config: {
-        /** Fully qualified name of the extension1/plugin */ extension1Fqn: string;
-        /** Version of the release of the extension1/plugin */ version: string;
-        abortSignal?: AbortSignal;
-    }): Promise<void>;
-    /**
-     * The details of the given extension version 1
-     *
-     * **Required scope:** environment-api:hub:read
-     * @returns OK
-     */
-    getDetails(config: {
-        /** Fully qualified name of the extension1/plugin */ extension1Fqn: string;
-        abortSignal?: AbortSignal;
-    }): Promise<ItemDetails>;
-    /**
-     * The details of the given technology
-     *
-     * **Required scope:** environment-api:hub:read
-     * @returns OK
-     */
-    getTechnologyDetails(config: {
-        /** Slug of the technology to be fetched */ slug: string;
-        abortSignal?: AbortSignal;
-    }): Promise<ItemDetails>;
-    /**
-     * Lists all the available items in your environment
-     *
-     * **Required scope:** environment-api:hub:read
-     * @returns OK
-     */
-    listItems(config: {
-        /**
-         * The cursor for the next page of results. You can find it in the **nextPageKey** field of the previous response.
-         *
-         * The first page is always returned if you don't specify the **nextPageKey** query parameter.
-         *
-         * When the **nextPageKey** is set to obtain subsequent pages, you must omit all other query parameters.
-         */ nextPageKey?: string;
-        /**
-         * The amount of hub items in a single response payload.
-         *
-         * The maximal allowed page size is 100.
-         *
-         * If not set, 20 is used.
-         */ pageSize?: number;
-        /** If provided, will filter out results based on the given item type. */ itemType?: ListItemsQueryItemType;
-        /**
-         * Filter the results for items matching the query string within id, name, author, description or any tag.
-         * - Case insensitive
-         * - Spaces in the query string will lead to an intersection of the results of each term
-         */ query?: string;
-        /**
-         * If provided, will restrict the result to Extensions 2.0 that have the respective installed state.
-         * - Only applies if itemType filter is not set or EXTENSION2
-         */ installed?: boolean;
-        /**
-         * If provided, will filter items that belong to the given category.
-         * - This overrides the itemType or installed filters
-         * - For a list of category ids refer to /categories
-         * - Will return the items in the order of the category
-         */ categoryId?: string;
-        /** If provided, will skip the desired number of results, allowing for pagination in combination with page size */ offset?: string;
-        abortSignal?: AbortSignal;
-    }): Promise<ItemList>;
-}
-export declare const hubItemsClient: HubItemsClient;

package/types/packages/client/classic-environment-v2/src/lib/models/category-list.d.ts

@@ -1,15 +0,0 @@
-import { Category, _CategoryTransformation } from './category';
-export interface CategoryList {
-    /**
-     * A list of available categories.
-     */
-    items?: Category[];
-}
-/** @ignore */
-export declare namespace _CategoryListTransformation {
-    interface AsJson {
-        items?: _CategoryTransformation.AsJson[];
-    }
-    function fromJson(model: AsJson): CategoryList;
-    function toJson(model: CategoryList): AsJson;
-}

package/types/packages/client/classic-environment-v2/src/lib/models/category.d.ts

@@ -1,27 +0,0 @@
-/**
- * A list of available categories.
- */
-export interface Category {
-    /**
-     * Id of the category
-     */
-    id?: string;
-    /**
-     * Name of the category
-     */
-    name?: string;
-    /**
-     * Description of the category
-     */
-    description?: string;
-}
-/** @ignore */
-export declare namespace _CategoryTransformation {
-    interface AsJson {
-        id?: string;
-        name?: string;
-        description?: string;
-    }
-    function fromJson(model: AsJson): Category;
-    function toJson(model: Category): AsJson;
-}

package/types/packages/client/classic-environment-v2/src/lib/models/cyber-ark-config.d.ts

@@ -1,22 +0,0 @@
-import { ExternalVaultConfig, _ExternalVaultConfigTransformation } from './external-vault-config';
-export interface CyberArkConfig extends ExternalVaultConfig {
-    centralPolicyManagerUrl?: string;
-    certificate?: string;
-    applicationId?: string;
-    safeName?: string;
-    folderName?: string;
-    accountName?: string;
-}
-/** @ignore */
-export declare namespace _CyberArkConfigTransformation {
-    interface AsJson extends _ExternalVaultConfigTransformation.AsJson {
-        centralPolicyManagerUrl?: string;
-        certificate?: string;
-        applicationId?: string;
-        safeName?: string;
-        folderName?: string;
-        accountName?: string;
-    }
-    function fromJson(model: AsJson): CyberArkConfig;
-    function toJson(model: CyberArkConfig): AsJson;
-}

package/types/packages/client/classic-environment-v2/src/lib/models/cyber-ark-dto.d.ts

@@ -1,38 +0,0 @@
-import { ExternalVault, _ExternalVaultTransformation } from './external-vault';
-/**
- * Synchronization credentials with CyberArk Vault using IP based access authentication method, which means adding location's IP addresses (used in monitor synchronizing credentials) to whitelist in CyberArk.
- */
-export interface CyberArkDto extends ExternalVault {
-    /**
-     * [Optional] Certificate used for authentication to CyberArk application. ID of certificate credential saved in Dynatrace CV.
-     */
-    certificate?: string;
-    /**
-     * Application ID connected to CyberArk Vault.
-     */
-    applicationId?: string;
-    /**
-     * Safe name connected to CyberArk Vault.
-     */
-    safeName?: string;
-    /**
-     * [Optional] Folder name where credentials in CyberArk Vault are stored. Default folder name is 'Root'.
-     */
-    folderName?: string;
-    /**
-     * Account name which stores username and password to retrieve and synchronize with Dynatrace Credential Vault. This is NOT the name of the account logged into CyberArk Central Policy Manager.
-     */
-    accountName?: string;
-}
-/** @ignore */
-export declare namespace _CyberArkDtoTransformation {
-    interface AsJson extends _ExternalVaultTransformation.AsJson {
-        certificate?: string;
-        applicationId?: string;
-        safeName?: string;
-        folderName?: string;
-        accountName?: string;
-    }
-    function fromJson(model: AsJson): CyberArkDto;
-    function toJson(model: CyberArkDto): AsJson;
-}

package/types/packages/client/classic-environment-v2/src/lib/models/description-block-type.d.ts

@@ -1,13 +0,0 @@
-/**
- * Type of the data, either markdown or gallery.
- */
-export declare enum DescriptionBlockType {
-    Gallery = "GALLERY",
-    Markdown = "MARKDOWN"
-}
-/** @ignore */
-export declare namespace _DescriptionBlockTypeTransformation {
-    type AsJson = DescriptionBlockType;
-    const toJson: (value: DescriptionBlockType) => AsJson;
-    const fromJson: (value: AsJson) => DescriptionBlockType;
-}

package/types/packages/client/classic-environment-v2/src/lib/models/description-block.d.ts

@@ -1,36 +0,0 @@
-import { DescriptionBlockType, _DescriptionBlockTypeTransformation } from './description-block-type';
-import { Image, _ImageTransformation } from './image';
-/**
- * Represents a section of data describing the given capability.
- */
-export interface DescriptionBlock {
-    type?: DescriptionBlockType;
-    /**
-     * Title of the description block.
-     */
-    title?: string;
-    /**
-     * Source of the description block (in case of markdown).
-     */
-    source?: string;
-    /**
-     * Collection of images (in case of gallery).
-     */
-    images?: Image[];
-    /**
-     * Optional identifier of special description blocks.
-     */
-    sourceId?: string;
-}
-/** @ignore */
-export declare namespace _DescriptionBlockTransformation {
-    interface AsJson {
-        type?: _DescriptionBlockTypeTransformation.AsJson;
-        title?: string;
-        source?: string;
-        images?: _ImageTransformation.AsJson[];
-        sourceId?: string;
-    }
-    function fromJson(model: AsJson): DescriptionBlock;
-    function toJson(model: DescriptionBlock): AsJson;
-}

package/types/packages/client/classic-environment-v2/src/lib/models/extension-release-feature-sets.d.ts

@@ -1,15 +0,0 @@
-import { FeatureSetDetails, _FeatureSetDetailsTransformation } from './feature-set-details';
-/**
- * Feature sets contained in the given release
- */
-export interface ExtensionReleaseFeatureSets {
-    [propName: string]: FeatureSetDetails | undefined;
-}
-/** @ignore */
-export declare namespace _ExtensionReleaseFeatureSetsTransformation {
-    interface AsJson {
-        [propName: string]: _FeatureSetDetailsTransformation.AsJson | undefined;
-    }
-    function fromJson(model: AsJson): ExtensionReleaseFeatureSets;
-    function toJson(model: ExtensionReleaseFeatureSets): AsJson;
-}

package/types/packages/client/classic-environment-v2/src/lib/models/extension-release-notes.d.ts

@@ -1,17 +0,0 @@
-/**
- * Releases notes for an extension.
- */
-export interface ExtensionReleaseNotes {
-    /**
-     * Release notes in markdown format
-     */
-    markdown?: string;
-}
-/** @ignore */
-export declare namespace _ExtensionReleaseNotesTransformation {
-    interface AsJson {
-        markdown?: string;
-    }
-    function fromJson(model: AsJson): ExtensionReleaseNotes;
-    function toJson(model: ExtensionReleaseNotes): AsJson;
-}

package/types/packages/client/classic-environment-v2/src/lib/models/extension-release.d.ts

@@ -1,69 +0,0 @@
-import { AssetInfo, _AssetInfoTransformation } from './asset-info';
-import { ExtensionReleaseFeatureSets, _ExtensionReleaseFeatureSetsTransformation } from './extension-release-feature-sets';
-/**
- * Extensions releases information
- */
-export interface ExtensionRelease {
-    /**
-     * Version number of the extension.
-     */
-    version?: string;
-    /**
-     * Sha256 hash for the distributed extension.
-     */
-    artifactSha256?: string;
-    /**
-     * Release notes for the extension.
-     */
-    releaseNotes?: string;
-    /**
-     * The description why the extension was unpublished.
-     */
-    unpublishedDescription?: string;
-    /**
-     * The severity of unpublished extension. 5 indicates an error state
-     */
-    unpublishedSeverity?: number;
-    featureSets?: ExtensionReleaseFeatureSets;
-    /**
-     * Available data sources for the given release
-     */
-    dataSources?: string[];
-    /**
-     * Configured feature sets for an installed release
-     */
-    configuredFeatureSets?: string[];
-    minClusterVersion?: number;
-    /**
-     * Assets types and its count
-     */
-    assetsInfo?: AssetInfo[];
-    /**
-     * Represents whether this version is active version
-     */
-    active?: boolean;
-    distributed?: boolean;
-    unpublished?: boolean;
-    registered?: boolean;
-}
-/** @ignore */
-export declare namespace _ExtensionReleaseTransformation {
-    interface AsJson {
-        version?: string;
-        artifactSha256?: string;
-        releaseNotes?: string;
-        unpublishedDescription?: string;
-        unpublishedSeverity?: number;
-        featureSets?: _ExtensionReleaseFeatureSetsTransformation.AsJson;
-        dataSources?: string[];
-        configuredFeatureSets?: string[];
-        minClusterVersion?: number;
-        assetsInfo?: _AssetInfoTransformation.AsJson[];
-        active?: boolean;
-        distributed?: boolean;
-        unpublished?: boolean;
-        registered?: boolean;
-    }
-    function fromJson(model: AsJson): ExtensionRelease;
-    function toJson(model: ExtensionRelease): AsJson;
-}

package/types/packages/client/classic-environment-v2/src/lib/models/extension1-details.d.ts

@@ -1,18 +0,0 @@
-import { Extension1Release, _Extension1ReleaseTransformation } from './extension1-release';
-/**
- * Additional details of the extension version 1.
- */
-export interface Extension1Details {
-    /**
-     * A list of versions for the extension version 1.
-     */
-    releases?: Extension1Release[];
-}
-/** @ignore */
-export declare namespace _Extension1DetailsTransformation {
-    interface AsJson {
-        releases?: _Extension1ReleaseTransformation.AsJson[];
-    }
-    function fromJson(model: AsJson): Extension1Details;
-    function toJson(model: Extension1Details): AsJson;
-}

package/types/packages/client/classic-environment-v2/src/lib/models/extension1-release.d.ts

@@ -1,32 +0,0 @@
-/**
- * Extension version 1 release details.
- */
-export interface Extension1Release {
-    /**
-     * The version number of the extension version 1 release.
-     */
-    version?: string;
-    /**
-     * The title of the extension version 1.
-     */
-    artifactTitle?: string;
-    /**
-     * SHA-256 hash of the extension version 1.
-     */
-    artifactSha256?: string;
-    /**
-     * The associated release notes.
-     */
-    releaseNotes?: string;
-}
-/** @ignore */
-export declare namespace _Extension1ReleaseTransformation {
-    interface AsJson {
-        version?: string;
-        artifactTitle?: string;
-        artifactSha256?: string;
-        releaseNotes?: string;
-    }
-    function fromJson(model: AsJson): Extension1Release;
-    function toJson(model: Extension1Release): AsJson;
-}

package/types/packages/client/classic-environment-v2/src/lib/models/extension2-details.d.ts

@@ -1,28 +0,0 @@
-import { ExtensionRelease, _ExtensionReleaseTransformation } from './extension-release';
-/**
- * Additional details of the extension.
- */
-export interface Extension2Details {
-    /**
-     * Recommended version of this extension to use. This is the latest compatible published release.
-     */
-    recommendedCatalogVersion?: string | null;
-    /**
-     * Fully qualified name of the extension.
-     */
-    extensionName?: string;
-    /**
-     * Releases for the extension.
-     */
-    releases?: ExtensionRelease[];
-}
-/** @ignore */
-export declare namespace _Extension2DetailsTransformation {
-    interface AsJson {
-        recommendedCatalogVersion?: string | null;
-        extensionName?: string;
-        releases?: _ExtensionReleaseTransformation.AsJson[];
-    }
-    function fromJson(model: AsJson): Extension2Details;
-    function toJson(model: Extension2Details): AsJson;
-}

package/types/packages/client/classic-environment-v2/src/lib/models/image.d.ts

@@ -1,27 +0,0 @@
-/**
- * Information about the image details of a capability.
- */
-export interface Image {
-    /**
-     * Title of the image.
-     */
-    title?: string;
-    /**
-     * Alternate text for the image.
-     */
-    alt?: string;
-    /**
-     * Url of the image.
-     */
-    src?: string;
-}
-/** @ignore */
-export declare namespace _ImageTransformation {
-    interface AsJson {
-        title?: string;
-        alt?: string;
-        src?: string;
-    }
-    function fromJson(model: AsJson): Image;
-    function toJson(model: Image): AsJson;
-}

package/types/packages/client/classic-environment-v2/src/lib/models/item-details-type.d.ts

@@ -1,14 +0,0 @@
-/**
- * Represents the type of item. It can be TECHNOLOGY, EXTENSION1 or EXTENSION2.
- */
-export declare enum ItemDetailsType {
-    Extension1 = "EXTENSION1",
-    Extension2 = "EXTENSION2",
-    Technology = "TECHNOLOGY"
-}
-/** @ignore */
-export declare namespace _ItemDetailsTypeTransformation {
-    type AsJson = ItemDetailsType;
-    const toJson: (value: ItemDetailsType) => AsJson;
-    const fromJson: (value: AsJson) => ItemDetailsType;
-}

package/types/packages/client/classic-environment-v2/src/lib/models/item-details.d.ts

@@ -1,98 +0,0 @@
-import { DescriptionBlock, _DescriptionBlockTransformation } from './description-block';
-import { Extension1Details, _Extension1DetailsTransformation } from './extension1-details';
-import { Extension2Details, _Extension2DetailsTransformation } from './extension2-details';
-import { ItemDetailsType, _ItemDetailsTypeTransformation } from './item-details-type';
-import { RelatedItem, _RelatedItemTransformation } from './related-item';
-import { TechnologyDetails, _TechnologyDetailsTransformation } from './technology-details';
-/**
- * Public metadata for an item.
- */
-export interface ItemDetails {
-    type?: ItemDetailsType;
-    /**
-     * Unique Id of the item.
-     */
-    itemId?: string;
-    /**
-     * Name of the item.
-     */
-    name?: string;
-    /**
-     * Description of the item.
-     */
-    description?: string;
-    /**
-     * Grouping of items with keywords.
-     */
-    tags?: string[];
-    /**
-     * Name of the author of the item.
-     */
-    authorName?: string;
-    /**
-     * Url for the author's logo.
-     */
-    authorLogo?: string;
-    /**
-     * Checks if the item is compatible with the cluster version.
-     */
-    clusterCompatible?: boolean;
-    /**
-     * The minimum cluster version required to use this item.
-     */
-    clusterMinVersion?: number;
-    /**
-     * The maximum supported cluster version for this item.
-     */
-    clusterMaxVersion?: number;
-    /**
-     * The reason why the item is not compatible with the cluster version.
-     */
-    notCompatibleReason?: string;
-    descriptionBlocks?: DescriptionBlock[];
-    /**
-     * An absolute link to a documentation page explaining the item.
-     */
-    documentationLink?: string;
-    /**
-     * An absolute link to a marketing page promoting how the item can be used with dynatrace.
-     */
-    marketingLink?: string;
-    technologyDetails?: TechnologyDetails;
-    extension1Details?: Extension1Details;
-    extension2Details?: Extension2Details;
-    /**
-     * The logo of the item. Can be a URL or Base64 encoded. Intended for <image> html tags.
-     */
-    logo?: string;
-    /**
-     * Related items.
-     */
-    relatedItems?: RelatedItem[];
-}
-/** @ignore */
-export declare namespace _ItemDetailsTransformation {
-    interface AsJson {
-        type?: _ItemDetailsTypeTransformation.AsJson;
-        itemId?: string;
-        name?: string;
-        description?: string;
-        tags?: string[];
-        authorName?: string;
-        authorLogo?: string;
-        clusterCompatible?: boolean;
-        clusterMinVersion?: number;
-        clusterMaxVersion?: number;
-        notCompatibleReason?: string;
-        descriptionBlocks?: _DescriptionBlockTransformation.AsJson[];
-        documentationLink?: string;
-        marketingLink?: string;
-        technologyDetails?: _TechnologyDetailsTransformation.AsJson;
-        extension1Details?: _Extension1DetailsTransformation.AsJson;
-        extension2Details?: _Extension2DetailsTransformation.AsJson;
-        logo?: string;
-        relatedItems?: _RelatedItemTransformation.AsJson[];
-    }
-    function fromJson(model: AsJson): ItemDetails;
-    function toJson(model: ItemDetails): AsJson;
-}

package/types/packages/client/classic-environment-v2/src/lib/models/item-list.d.ts

@@ -1,32 +0,0 @@
-import { ItemOverview, _ItemOverviewTransformation } from './item-overview';
-export interface ItemList {
-    /**
-     * A list of available items.
-     */
-    items?: ItemOverview[];
-    /**
-     * The total number of entries in the result.
-     */
-    totalCount: number;
-    /**
-     * The number of entries per page.
-     */
-    pageSize?: number;
-    /**
-     * The cursor for the next page of results. Has the value of `null` on the last page.
-     *
-     * Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
-     */
-    nextPageKey?: string;
-}
-/** @ignore */
-export declare namespace _ItemListTransformation {
-    interface AsJson {
-        items?: _ItemOverviewTransformation.AsJson[];
-        totalCount: number;
-        pageSize?: number;
-        nextPageKey?: string;
-    }
-    function fromJson(model: AsJson): ItemList;
-    function toJson(model: ItemList): AsJson;
-}