@arrowsphere/api-client 1.0.3 → 2.1.1

package/build/licenses/entities/license/licenseFindResult.d.ts

@@ -1,34 +1,287 @@
-import { AbstractLicense, LicenseData, LicenseFields } from './abstractLicense';
-/**
- * License result fields.
- */
-export declare enum LicenseFindResultFields {
-    COLUMN_HIGHLIGHT = "highlight"
-}
+import { ActiveSeatsFindResultData, ActiveSeatsFindResultDataKeywords, ActiveSeatsFindResultDataSortParameters, ActiveSeatsFindResult, ActiveSeatsFindResultDataFiltersParameters } from './activeSeatsFindResult';
+import { AbstractEntity } from '../../../abstractEntity';
+import { Rules } from 'validatorjs';
+import { ConfigFindResultData, ConfigFindResultDataFiltersParameters, ConfigFindResultDataKeywords, ConfigFindResultDataSortParameters } from './configFindResult';
+import { DataKeywords, FiltersParameters, SortParameters } from '../../licensesClient';
+import { WarningFindResultData, WarningFindResultDataFiltersParameters, WarningFindResultDataKeywords, WarningFindResultDataSortParameters } from './warningFindResult';
+import { PriceFindResult, PriceFindResultData, PriceFindResultDataFiltersParameters, PriceFindResultDataKeywords, PriceFindResutDataSortParameters } from './priceFindResult';
 /**
  * Highlight response object.
  */
 export declare type Highlight = {
-    [key in LicenseFields]?: string[];
+    [key in LicenseFindResultFields]?: string[];
 };
 /**
- * License result data. Combination of {@link LicenseData} and extra result specific fields.
+ * Fields that can be present in License response and request data.
  */
-export declare type LicenseFindResultData = LicenseData & {
+export declare enum LicenseFindResultFields {
+    COLUMN_ACCEPT_EULA = "accept_eula",
+    COLUMN_ACTIVE_SEATS = "active_seats",
+    COLUMN_AUTO_RENEW = "auto_renew",
+    COLUMN_BASE_SEAT = "base_seat",
+    COLUMN_CATEGORY = "category",
+    COLUMN_CLOUD_TYPE = "cloud_type",
+    COLUMN_CONFIGS = "configs",
+    COLUMN_WARNINGS = "warnings",
+    COLUMN_CUSTOMER_NAME = "customer_name",
+    COLUMN_CUSTOMER_REF = "customer_ref",
+    COLUMN_END_DATE = "end_date",
+    COLUMN_FRIENDLY_NAME = "friendly_name",
+    COLUMN_ID = "id",
+    COLUMN_IS_ENABLED = "isEnabled",
+    COLUMN_LAST_UPDATE = "lastUpdate",
+    COLUMN_MARKETPLACE = "marketplace",
+    COLUMN_MESSAGE = "message",
+    COLUMN_OFFER = "offer",
+    COLUMN_PARENT_LINE_ID = "parent_line_id",
+    COLUMN_PARENT_ORDER_REF = "parent_order_ref",
+    COLUMN_PARTNER_REF = "partner_ref",
+    COLUMN_PERIODICITY = "periodicity",
+    COLUMN_PRICE = "price",
+    COLUMN_RESELLER_NAME = "reseller_name",
+    COLUMN_RESELLER_REF = "reseller_ref",
+    COLUMN_SEAT = "seat",
+    COLUMN_SERVICE_REF = "service_ref",
+    COLUMN_SKU = "sku",
+    COLUMN_START_DATE = "start_date",
+    COLUMN_STATUS_CODE = "status_code",
+    COLUMN_STATUS_LABEL = "status_label",
+    COLUMN_SUBSCRIPTION_ID = "subscription_id",
+    COLUMN_SUBSIDIARY_NAME = "subsidiary_name",
+    COLUMN_TERM = "term",
+    COLUMN_TRIAL = "trial",
+    COLUMN_TYPE = "type",
+    COLUMN_UOM = "uom",
+    COLUMN_VENDOR_CODE = "vendor_code",
+    COLUMN_VENDOR_NAME = "vendor_name",
+    COLUMN_VENDOR_SUBSCRIPTION_ID = "vendor_subscription_id",
+    COLUMN_HIGHLIGHT = "highlight"
+}
+/**
+ * License data fields and their corresponding types
+ */
+export declare type LicenseFindResultData = {
+    [LicenseFindResultFields.COLUMN_ACCEPT_EULA]: boolean;
+    [LicenseFindResultFields.COLUMN_ACTIVE_SEATS]: ActiveSeatsFindResultData;
+    [LicenseFindResultFields.COLUMN_AUTO_RENEW]: boolean;
+    [LicenseFindResultFields.COLUMN_BASE_SEAT]: number;
+    [LicenseFindResultFields.COLUMN_CATEGORY]: string;
+    [LicenseFindResultFields.COLUMN_CLOUD_TYPE]: string;
+    [LicenseFindResultFields.COLUMN_CONFIGS]: Array<ConfigFindResultData> | null | undefined;
+    [LicenseFindResultFields.COLUMN_WARNINGS]: Array<WarningFindResultData> | null | undefined;
+    [LicenseFindResultFields.COLUMN_CUSTOMER_NAME]: string;
+    [LicenseFindResultFields.COLUMN_CUSTOMER_REF]: string;
+    [LicenseFindResultFields.COLUMN_END_DATE]: string;
+    [LicenseFindResultFields.COLUMN_FRIENDLY_NAME]: string | null;
+    [LicenseFindResultFields.COLUMN_ID]: number;
+    [LicenseFindResultFields.COLUMN_IS_ENABLED]: boolean;
+    [LicenseFindResultFields.COLUMN_LAST_UPDATE]: string | null;
+    [LicenseFindResultFields.COLUMN_MARKETPLACE]: string;
+    [LicenseFindResultFields.COLUMN_MESSAGE]: string;
+    [LicenseFindResultFields.COLUMN_OFFER]: string;
+    [LicenseFindResultFields.COLUMN_PARENT_LINE_ID]: number | null;
+    [LicenseFindResultFields.COLUMN_PARENT_ORDER_REF]: string | null;
+    [LicenseFindResultFields.COLUMN_PARTNER_REF]: string;
+    [LicenseFindResultFields.COLUMN_PERIODICITY]: number;
+    [LicenseFindResultFields.COLUMN_PRICE]: PriceFindResultData;
+    [LicenseFindResultFields.COLUMN_RESELLER_NAME]: string;
+    [LicenseFindResultFields.COLUMN_RESELLER_REF]: string;
+    [LicenseFindResultFields.COLUMN_SEAT]: number;
+    [LicenseFindResultFields.COLUMN_SERVICE_REF]: string;
+    [LicenseFindResultFields.COLUMN_SKU]: string;
+    [LicenseFindResultFields.COLUMN_START_DATE]: string;
+    [LicenseFindResultFields.COLUMN_STATUS_CODE]: number;
+    [LicenseFindResultFields.COLUMN_STATUS_LABEL]: string;
+    [LicenseFindResultFields.COLUMN_SUBSCRIPTION_ID]: string;
+    [LicenseFindResultFields.COLUMN_SUBSIDIARY_NAME]: string;
+    [LicenseFindResultFields.COLUMN_TERM]: number;
+    [LicenseFindResultFields.COLUMN_TRIAL]: boolean;
+    [LicenseFindResultFields.COLUMN_TYPE]: string;
+    [LicenseFindResultFields.COLUMN_UOM]: string;
+    [LicenseFindResultFields.COLUMN_VENDOR_CODE]: string;
+    [LicenseFindResultFields.COLUMN_VENDOR_NAME]: string;
+    [LicenseFindResultFields.COLUMN_VENDOR_SUBSCRIPTION_ID]: string | null;
     [LicenseFindResultFields.COLUMN_HIGHLIGHT]?: Highlight;
 };
-export declare class LicenseFindResult extends AbstractLicense {
+export declare type LicenceFindDataKeywords = {
+    [LicenseFindResultFields.COLUMN_ACCEPT_EULA]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_ACTIVE_SEATS]?: ActiveSeatsFindResultDataKeywords;
+    [LicenseFindResultFields.COLUMN_AUTO_RENEW]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_BASE_SEAT]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_CATEGORY]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_CLOUD_TYPE]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_CONFIGS]?: ConfigFindResultDataKeywords;
+    [LicenseFindResultFields.COLUMN_WARNINGS]?: WarningFindResultDataKeywords;
+    [LicenseFindResultFields.COLUMN_CUSTOMER_NAME]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_CUSTOMER_REF]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_END_DATE]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_FRIENDLY_NAME]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_ID]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_IS_ENABLED]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_LAST_UPDATE]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_MARKETPLACE]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_MESSAGE]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_OFFER]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_PARENT_LINE_ID]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_PARENT_ORDER_REF]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_PARTNER_REF]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_PERIODICITY]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_PRICE]?: PriceFindResultDataKeywords;
+    [LicenseFindResultFields.COLUMN_RESELLER_NAME]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_RESELLER_REF]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_SEAT]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_SERVICE_REF]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_SKU]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_START_DATE]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_STATUS_CODE]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_STATUS_LABEL]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_SUBSCRIPTION_ID]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_SUBSIDIARY_NAME]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_TERM]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_TRIAL]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_TYPE]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_UOM]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_VENDOR_CODE]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_VENDOR_NAME]?: DataKeywords;
+    [LicenseFindResultFields.COLUMN_VENDOR_SUBSCRIPTION_ID]?: DataKeywords;
+};
+export declare type LicenceFindDataSortParameters = {
+    [LicenseFindResultFields.COLUMN_ACCEPT_EULA]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_ACTIVE_SEATS]?: ActiveSeatsFindResultDataSortParameters;
+    [LicenseFindResultFields.COLUMN_AUTO_RENEW]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_BASE_SEAT]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_CATEGORY]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_CLOUD_TYPE]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_CONFIGS]?: ConfigFindResultDataSortParameters;
+    [LicenseFindResultFields.COLUMN_WARNINGS]?: WarningFindResultDataSortParameters;
+    [LicenseFindResultFields.COLUMN_CUSTOMER_NAME]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_CUSTOMER_REF]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_END_DATE]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_FRIENDLY_NAME]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_ID]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_IS_ENABLED]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_LAST_UPDATE]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_MARKETPLACE]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_MESSAGE]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_OFFER]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_PARENT_LINE_ID]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_PARENT_ORDER_REF]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_PARTNER_REF]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_PERIODICITY]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_PRICE]?: PriceFindResutDataSortParameters;
+    [LicenseFindResultFields.COLUMN_RESELLER_NAME]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_RESELLER_REF]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_SEAT]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_SERVICE_REF]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_SKU]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_START_DATE]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_STATUS_CODE]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_STATUS_LABEL]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_SUBSCRIPTION_ID]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_SUBSIDIARY_NAME]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_TERM]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_TRIAL]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_TYPE]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_UOM]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_VENDOR_CODE]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_VENDOR_NAME]?: SortParameters;
+    [LicenseFindResultFields.COLUMN_VENDOR_SUBSCRIPTION_ID]?: SortParameters;
+};
+export declare type LicenceFindDataFiltersParameters = {
+    [LicenseFindResultFields.COLUMN_ACCEPT_EULA]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_ACTIVE_SEATS]?: ActiveSeatsFindResultDataFiltersParameters;
+    [LicenseFindResultFields.COLUMN_AUTO_RENEW]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_BASE_SEAT]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_CATEGORY]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_CLOUD_TYPE]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_CONFIGS]?: ConfigFindResultDataFiltersParameters;
+    [LicenseFindResultFields.COLUMN_WARNINGS]?: WarningFindResultDataFiltersParameters;
+    [LicenseFindResultFields.COLUMN_CUSTOMER_NAME]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_CUSTOMER_REF]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_END_DATE]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_FRIENDLY_NAME]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_ID]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_IS_ENABLED]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_LAST_UPDATE]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_MARKETPLACE]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_MESSAGE]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_OFFER]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_PARENT_LINE_ID]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_PARENT_ORDER_REF]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_PARTNER_REF]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_PERIODICITY]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_PRICE]?: PriceFindResultDataFiltersParameters;
+    [LicenseFindResultFields.COLUMN_RESELLER_NAME]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_RESELLER_REF]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_SEAT]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_SERVICE_REF]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_SKU]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_START_DATE]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_STATUS_CODE]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_STATUS_LABEL]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_SUBSCRIPTION_ID]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_SUBSIDIARY_NAME]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_TERM]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_TRIAL]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_TYPE]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_UOM]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_VENDOR_CODE]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_VENDOR_NAME]?: FiltersParameters;
+    [LicenseFindResultFields.COLUMN_VENDOR_SUBSCRIPTION_ID]?: FiltersParameters;
+};
+export declare class LicenseFindResult extends AbstractEntity<LicenseFindResultData> {
     #private;
+    protected VALIDATION_RULES: Rules;
     /**
      * LicenseFindResult constructor.
      *
      * @param data - License find result data from the response.
      */
     constructor(data: LicenseFindResultData);
+    get id(): number;
+    get acceptEula(): boolean;
+    get activeSeats(): ActiveSeatsFindResult;
+    get autoRenew(): boolean;
+    get baseSeat(): number;
+    get category(): string;
+    get classification(): string;
+    get configs(): Array<ConfigFindResultData> | null | undefined;
+    get warnings(): Array<WarningFindResultData> | null | undefined;
+    get customerName(): string;
+    get customerRef(): string;
+    get endDate(): string;
+    get friendlyName(): string | null;
+    get enabled(): boolean;
+    get lastUpdate(): string | null;
+    get marketplace(): string;
+    get message(): string;
+    get offer(): string;
+    get parentLineId(): number | null;
+    get parentOrderRef(): string | null;
+    get partnerRef(): string;
+    get periodicity(): number;
+    get price(): PriceFindResult;
+    get resellerName(): string;
+    get resellerRef(): string;
+    get seat(): number;
+    get serviceRef(): string;
+    get sku(): string;
+    get startDate(): string;
+    get statusCode(): number;
+    get statusLabel(): string;
+    get subscriptionId(): string;
+    get subsidiaryName(): string;
+    get term(): number;
+    isTrial(): boolean;
+    get type(): string;
+    get uom(): string;
+    get vendorCode(): string;
+    get vendorName(): string;
+    get vendorSubscriptionId(): string | null;
     get highlight(): Highlight;
     /**
-     * Plain JSON object representation of the License result entity.
-     * @returns {@link LicenseFindResultData}
+     * Plain JSON object representation of the license entity.
+     * @returns {@link LicenseData}
      */
     toJSON(): LicenseFindResultData;
 }