@configura/web-api 1.6.1 → 2.0.0-alpha.0

package/dist/CatalogueAPI.d.ts

@@ -1,46 +1,54 @@
 /** AdditionalProductConfiguration */
-export interface AdditionalProductConfiguration {
+export interface DtoAdditionalProductConfiguration {
     refKey?: string;
     selected?: boolean;
-    selOptions: Array<SelectedOption>;
-    additionalProducts?: Array<AdditionalProductConfiguration>;
+    selOptions: Array<DtoSelectedOption>;
+    additionalProducts?: Array<DtoAdditionalProductConfiguration>;
 }
 /** AdditionalProductRef */
-export interface AdditionalProductRef {
+export interface DtoAdditionalProductRef {
     refKey: string;
-    catId: CatalogueParams;
+    catId: DtoCatalogueParams;
     partNumber: string;
     refDescription?: string;
-    anchor?: MeasureParam;
-    transform?: Transform;
+    anchor?: DtoMeasureParam;
+    transform?: DtoTransform;
     optional?: boolean;
 }
 /** ApplicationArea */
-export interface ApplicationArea {
+export interface DtoApplicationArea {
     areas?: Array<string>;
     cid?: number;
     material?: string;
     preview?: string;
 }
-/** ApplicationAreasResponse */
-export interface ApplicationAreasResponse {
-    applicationAreas: Array<ApplicationArea>;
+/** DtoApplicationAreasResponse */
+export interface DtoApplicationAreasResponse {
+    applicationAreas: Array<DtoApplicationArea>;
     uuid: string;
 }
 /** AuthorizeResponse */
-export interface AuthorizeResponse {
+export interface DtoAuthorizeResponse {
     endpoint: string;
     secretToken: string;
-    apiSession: CatalogueAPISession;
+    apiSession: DtoCatalogueAPISession;
 }
 /** CatalogueAPISession */
-export interface CatalogueAPISession {
+export interface DtoCatalogueAPISession {
     expires: string;
     features?: Array<string>;
-    permissions?: Array<CataloguePermission>;
+    permissions?: Array<DtoCataloguePermission>;
 }
 /** CatalogueParams */
-export interface CatalogueParams {
+export interface DtoCatalogueParams extends DtoCatalogueParamsWithoutCid {
+    cid: number;
+}
+/** CatalogueParamsWithLang */
+export interface DtoCatalogueParamsWithLang extends DtoCatalogueParams {
+    lang: string;
+}
+/** CatalogueParamsWithoutCid */
+export interface DtoCatalogueParamsWithoutCid {
     enterprise: string;
     prdCat: string;
     prdCatVersion: string;
@@ -48,7 +56,7 @@ export interface CatalogueParams {
     priceList: string;
 }
 /** CataloguePermission */
-export interface CataloguePermission {
+export interface DtoCataloguePermission {
     cid: number;
     enterprise: string;
     prdCat: string;
@@ -57,72 +65,97 @@ export interface CataloguePermission {
     vendors?: Array<string>;
 }
 /** CategoryMap */
-export interface CategoryMap {
+export interface DtoCategoryMap {
     [index: string]: string;
 }
 /** CodeRange */
-export interface CodeRange {
+export interface DtoCodeRange {
     minValue: number;
     maxValue: number;
     increment?: number;
 }
+/** ConfAddProd */
+export interface DtoConfAddProd extends DtoConfProd {
+    refKey: string;
+    selected: boolean;
+}
+/** ConfFeature */
+export interface DtoConfFeature {
+    code: string;
+    groupCode?: string;
+    unit?: string;
+    options?: Array<DtoConfOption>;
+}
+/** ConfOption */
+export interface DtoConfOption {
+    code: string;
+    selected: boolean;
+    numericValue?: DtoValueWithUnit;
+    features?: Array<DtoConfFeature>;
+}
+/** ConfProd */
+export interface DtoConfProd {
+    features?: Array<DtoConfFeature>;
+    additionalProducts?: Array<DtoConfAddProd>;
+    prodParams?: DtoProductParamsWithLang;
+}
 /** ErrorResponse */
-export interface ErrorResponse {
+export interface DtoErrorResponse {
     error: string;
     code: number;
     eventId?: string;
 }
 /** ExportFormat - Format of the exported product, identical to the format's file extension. */
-export declare type ExportFormat = "glb" | "gltf" | "fbx" | "dwg" | "cmdrw" | "cmfav" | "cmsym";
-export declare const exportFormatNames: ExportFormat[];
+export declare type DtoExportFormat = "glb" | "gltf" | "fbx" | "dwg" | "cmdrw" | "cmfav" | "cmsym";
+export declare const dtoExportFormatNames: DtoExportFormat[];
 /** ExportRequest */
-export interface ExportRequest {
-    format: ExportFormat;
-    selOptions: Array<SelectedOption>;
-    additionalProducts?: Array<AdditionalProductConfiguration>;
+export interface DtoExportRequest {
+    format: DtoExportFormat;
+    selOptions: Array<DtoSelectedOption>;
+    additionalProducts?: Array<DtoAdditionalProductConfiguration>;
     preferUnzipped?: boolean;
 }
 /** ExportResponse */
-export interface ExportResponse {
-    exportStatus: ExportStatus;
+export interface DtoExportResponse {
+    exportStatus: DtoExportStatus;
 }
 /** ExportStatus */
-export interface ExportStatus {
+export interface DtoExportStatus {
     created: string;
     modified: string;
-    status: ExportStatusStatus;
+    status: DtoExportStatusStatus;
     url?: string;
     uuid: string;
 }
 /** ExportStatusStatus - WIP */
-export declare type ExportStatusStatus = "pending" | "running" | "finished" | "failed";
-export declare const exportStatusStatusNames: ExportStatusStatus[];
+export declare type DtoExportStatusStatus = "pending" | "running" | "finished" | "failed";
+export declare const dtoExportStatusStatusNames: DtoExportStatusStatus[];
 /** Feature */
-export interface Feature {
+export interface DtoFeature {
     code: string;
     description: string;
     functional?: boolean;
     groupCode?: string;
-    mtrlApplications?: Array<MtrlApplication>;
+    mtrlApplications?: Array<DtoMtrlApplication>;
     multiple?: boolean;
     numericOrder: boolean;
     optional?: boolean;
-    options: Array<Option>;
+    options: Array<DtoOption>;
     hideIfMainProduct?: boolean;
     hideIfAdditionalProduct?: boolean;
-    measureParams?: Array<MeasureParam>;
-    syncGroup?: SyncGroup;
+    measureParams?: Array<DtoMeasureParam>;
+    syncGroup?: DtoSyncGroup;
     unit?: string;
 }
 /** FeatureRef */
-export interface FeatureRef {
+export interface DtoFeatureRef {
     code: string;
     defaultOptionRef?: string;
     selectedOptionRef?: string;
     excludedOptionRefs?: Array<string>;
 }
 /** GetApplicationAreasParams represents the URL parameters of getApplicationAreas */
-export interface GetApplicationAreasParams {
+export interface DtoGetApplicationAreasParams {
     lang: string;
     enterprise: string;
     prdCat: string;
@@ -131,11 +164,11 @@ export interface GetApplicationAreasParams {
     priceList: string;
 }
 /** GetExportByIdParams represents the URL parameters of getExportById */
-export interface GetExportByIdParams {
+export interface DtoGetExportByIdParams {
     uuid: string;
 }
 /** GetPriceListsParams represents the URL parameters of getPriceLists */
-export interface GetPriceListsParams {
+export interface DtoGetPriceListsParams {
     lang: string;
     enterprise: string;
     prdCat: string;
@@ -143,8 +176,8 @@ export interface GetPriceListsParams {
     vendor: string;
     priceList: string;
 }
-/** GetProductParams represents the URL parameters of getProduct */
-export interface GetProductParams {
+/** DtoProductParamsWithLang represents the URL parameters of getProduct */
+export interface DtoGetProductParams {
     lang: string;
     enterprise: string;
     prdCat: string;
@@ -154,11 +187,11 @@ export interface GetProductParams {
     partNumber: string;
 }
 /** GetRenderByIdParams represents the URL parameters of getRenderById */
-export interface GetRenderByIdParams {
+export interface DtoGetRenderByIdParams {
     uuid: string;
 }
 /** GetTocFlatParams represents the URL parameters of getTocFlat */
-export interface GetTocFlatParams {
+export interface DtoGetTocFlatParams {
     lang: string;
     enterprise: string;
     prdCat: string;
@@ -167,7 +200,7 @@ export interface GetTocFlatParams {
     priceList: string;
 }
 /** GetTocTreeParams represents the URL parameters of getTocTree */
-export interface GetTocTreeParams {
+export interface DtoGetTocTreeParams {
     lang: string;
     enterprise: string;
     prdCat: string;
@@ -176,95 +209,95 @@ export interface GetTocTreeParams {
     priceList: string;
 }
 /** Level */
-export interface Level {
+export interface DtoLevel {
     code: string;
     description: string;
-    lvls?: Array<Level>;
-    prdRefs?: Array<LevelProductRef>;
+    lvls?: Array<DtoLevel>;
+    prdRefs?: Array<DtoLevelProductRef>;
 }
 /** LevelProductRef */
-export interface LevelProductRef {
+export interface DtoLevelProductRef {
     prdRef: string;
 }
 /** Measurement */
-export interface Measurement {
+export interface DtoMeasurement {
     code: string;
-    numericValue?: ValueWithUnit;
-    measureParam?: MeasureParam;
+    numericValue?: DtoValueWithUnit;
+    measureParam?: DtoMeasureParam;
 }
 /** MeasureParam */
-export interface MeasureParam {
+export interface DtoMeasureParam {
     code: string;
     anchorPoint?: string;
-    measurePriority?: Array<MeasurePriority>;
+    measurePriority?: Array<DtoMeasurePriority>;
 }
 /** MeasurePriority */
-export interface MeasurePriority {
+export interface DtoMeasurePriority {
     url: string;
 }
 /** Model */
-export interface Model {
+export interface DtoModel {
     cid: number;
-    anchor?: MeasureParam;
-    t?: Transform;
+    anchor?: DtoMeasureParam;
+    t?: DtoTransform;
     uri: string;
 }
 /** MtrlApplication */
-export interface MtrlApplication {
+export interface DtoMtrlApplication {
     areas?: Array<string>;
     material?: string;
     preview?: string;
     cid?: number;
 }
 /** Option */
-export interface Option {
-    additionalProductRefs?: Array<AdditionalProductRef>;
+export interface DtoOption {
+    additionalProductRefs?: Array<DtoAdditionalProductRef>;
     code: string;
     description: string;
-    featureRefs?: Array<FeatureRef>;
+    featureRefs?: Array<DtoFeatureRef>;
     material?: string;
-    mtrlApplications?: Array<MtrlApplication>;
-    codeRanges?: Array<CodeRange>;
+    mtrlApplications?: Array<DtoMtrlApplication>;
+    codeRanges?: Array<DtoCodeRange>;
     upcharge?: number;
     priceCodes?: Array<string>;
 }
 /** Orientation */
-export interface Orientation {
+export interface DtoOrientation {
     yaw: number;
     pitch: number;
     roll: number;
 }
 /** PartsData */
-export interface PartsData {
+export interface DtoPartsData {
     basePrice: number;
     currency: string;
     rounding?: number;
     listPrice: number;
     pkgCount: number;
-    selOptions: Array<PartsSelectedOption>;
+    selOptions: Array<DtoPartsSelectedOption>;
     styleNr: string;
-    prices?: Prices;
+    prices?: DtoPrices;
 }
 /** PartsSelectedOption */
-export interface PartsSelectedOption {
+export interface DtoPartsSelectedOption {
     code: string;
-    numericValue?: ValueWithUnit;
+    numericValue?: DtoValueWithUnit;
     description?: string;
     feature: string;
     featDesc: string;
     upcharge?: number;
     next?: {
-        [index: string]: PartsSelectedOption;
+        [index: string]: DtoPartsSelectedOption;
     };
 }
 /** Point */
-export interface Point {
+export interface DtoPoint {
     x: number;
     y: number;
     z: number;
 }
 /** PostExportParams represents the URL parameters of postExport */
-export interface PostExportParams {
+export interface DtoPostExportParams {
     lang: string;
     enterprise: string;
     prdCat: string;
@@ -274,11 +307,11 @@ export interface PostExportParams {
     partNumber: string;
 }
 /** PostPublicAccessTokenAuthorizeParams represents the URL parameters of postPublicAccessTokenAuthorize */
-export interface PostPublicAccessTokenAuthorizeParams {
+export interface DtoPostPublicAccessTokenAuthorizeParams {
     accessTokenId: string;
 }
 /** PostRenderParams represents the URL parameters of postRender */
-export interface PostRenderParams {
+export interface DtoPostRenderParams {
     lang: string;
     enterprise: string;
     prdCat: string;
@@ -288,7 +321,7 @@ export interface PostRenderParams {
     partNumber: string;
 }
 /** PostValidateParams represents the URL parameters of postValidate */
-export interface PostValidateParams {
+export interface DtoPostValidateParams {
     lang: string;
     enterprise: string;
     prdCat: string;
@@ -298,7 +331,7 @@ export interface PostValidateParams {
     partNumber: string;
 }
 /** PriceList */
-export interface PriceList {
+export interface DtoPriceList {
     code: string;
     currency: string;
     desc: string;
@@ -306,19 +339,19 @@ export interface PriceList {
     rounding: number;
 }
 /** PriceListsResponse */
-export interface PriceListsResponse {
-    priceLists: Array<PriceList>;
+export interface DtoPriceListsResponse {
+    priceLists: Array<DtoPriceList>;
     uuid: string;
 }
 /** Prices */
-export interface Prices {
+export interface DtoPrices {
     values: {
         [index: string]: number;
     };
-    parent?: Prices;
+    parent?: DtoPrices;
 }
 /** ProductCatalogueInfo */
-export interface ProductCatalogueInfo {
+export interface DtoProductCatalogueInfo {
     catDesc: string;
     catName: string;
     currency: string;
@@ -327,33 +360,41 @@ export interface ProductCatalogueInfo {
     lastModified: string;
 }
 /** ProductData */
-export interface ProductData {
+export interface DtoProductData {
     area?: string;
-    categories?: Array<CategoryMap>;
+    categories?: Array<DtoCategoryMap>;
     depth?: string;
     description?: string;
     height?: string;
     hideIfMainProduct?: boolean;
     hideIfAdditionalProduct?: boolean;
     length?: string;
-    mtrlApplications?: Array<MtrlApplication>;
-    additionalProductRefs?: Array<AdditionalProductRef>;
+    mtrlApplications?: Array<DtoMtrlApplication>;
+    additionalProductRefs?: Array<DtoAdditionalProductRef>;
     navImage?: string;
     sku: string;
-    measurements?: Array<Measurement>;
+    measurements?: Array<DtoMeasurement>;
     tags?: Array<{
         [index: string]: string;
     }>;
     volume?: string;
     weight?: string;
     width?: string;
-    models?: Array<Model>;
-    partsData: PartsData;
+    models?: Array<DtoModel>;
+    partsData: DtoPartsData;
+}
+/** ProductParams */
+export interface DtoProductParams extends DtoCatalogueParams {
+    partNumber: string;
+}
+/** ProductParamsWithLang */
+export interface DtoProductParamsWithLang extends DtoProductParams {
+    lang: string;
 }
 /** ProductRef */
-export interface ProductRef {
+export interface DtoProductRef {
     basePrice: number;
-    categories?: Array<CategoryMap>;
+    categories?: Array<DtoCategoryMap>;
     descLong: string;
     descShort: string;
     navImage: string;
@@ -362,71 +403,71 @@ export interface ProductRef {
     styleNr?: string;
 }
 /** ProductResponse */
-export interface ProductResponse {
-    rootFeatureRefs: Array<FeatureRef>;
-    features: Array<Feature>;
-    productData: ProductData;
+export interface DtoProductResponse {
+    rootFeatureRefs: Array<DtoFeatureRef>;
+    features: Array<DtoFeature>;
+    productData: DtoProductData;
     unit: string;
     uuid: string;
 }
 /** RefreshSessionTokenResponse */
-export interface RefreshSessionTokenResponse {
-    apiSession: CatalogueAPISession;
+export interface DtoRefreshSessionTokenResponse {
+    apiSession: DtoCatalogueAPISession;
 }
 /** RenderFormat */
-export declare type RenderFormat = "jpg" | "png";
-export declare const renderFormatNames: RenderFormat[];
+export declare type DtoRenderFormat = "jpg" | "png";
+export declare const dtoRenderFormatNames: DtoRenderFormat[];
 /** RenderRequest */
-export interface RenderRequest {
+export interface DtoRenderRequest {
     width: number;
     height: number;
-    format?: RenderFormat;
-    targetCameraArgs?: TargetCameraArgs;
-    selOptions: Array<SelectedOption>;
-    additionalProducts?: Array<AdditionalProductConfiguration>;
+    format?: DtoRenderFormat;
+    targetCameraArgs?: DtoTargetCameraArgs;
+    selOptions: Array<DtoSelectedOption>;
+    additionalProducts?: Array<DtoAdditionalProductConfiguration>;
 }
 /** RenderResponse */
-export interface RenderResponse {
-    renderStatus: RenderStatus;
+export interface DtoRenderResponse {
+    renderStatus: DtoRenderStatus;
 }
 /** RenderStatus */
-export interface RenderStatus {
+export interface DtoRenderStatus {
     created: string;
     modified: string;
-    status: RenderStatusStatus;
+    status: DtoRenderStatusStatus;
     url?: string;
     uuid: string;
 }
 /** RenderStatusStatus - WIP */
-export declare type RenderStatusStatus = "pending" | "running" | "finished" | "failed";
-export declare const renderStatusStatusNames: RenderStatusStatus[];
+export declare type DtoRenderStatusStatus = "pending" | "running" | "finished" | "failed";
+export declare const dtoRenderStatusStatusNames: DtoRenderStatusStatus[];
 /** SelectedOption */
-export interface SelectedOption {
+export interface DtoSelectedOption {
     code: string;
-    numericValue?: ValueWithUnit;
+    numericValue?: DtoValueWithUnit;
     next?: {
-        [index: string]: SelectedOption;
+        [index: string]: DtoSelectedOption;
     };
 }
 /** SuccessResponse */
-export interface SuccessResponse {
+export interface DtoSuccessResponse {
     uuid: string;
     success: boolean;
 }
 /** SyncGroup */
-export interface SyncGroup {
+export interface DtoSyncGroup {
     syncGroupCode: string;
-    syncMethod: SyncGroupMethods;
+    syncMethod: DtoSyncGroupMethods;
 }
 /** SyncGroupMethods */
-export declare type SyncGroupMethods = "pull" | "push" | "twoWay";
-export declare const syncGroupMethodsNames: SyncGroupMethods[];
+export declare type DtoSyncGroupMethods = "pull" | "push" | "twoWay";
+export declare const dtoSyncGroupMethodsNames: DtoSyncGroupMethods[];
 /** TargetCameraArgs */
-export interface TargetCameraArgs {
-    location?: Point;
-    target?: Point;
-    direction?: Vector;
-    normal?: Vector;
+export interface DtoTargetCameraArgs {
+    location?: DtoPoint;
+    target?: DtoPoint;
+    direction?: DtoVector;
+    normal?: DtoVector;
     yaw?: number;
     pitch?: number;
     roll?: number;
@@ -435,48 +476,48 @@ export interface TargetCameraArgs {
     minHeight?: number;
 }
 /** TOCResponse - Table Of Contents */
-export interface TOCResponse {
+export interface DtoTOCResponse {
     uuid: string;
-    prdRefs?: Array<ProductRef>;
-    prdCatInfo: ProductCatalogueInfo;
-    lvls?: Array<Level>;
+    prdRefs?: Array<DtoProductRef>;
+    prdCatInfo: DtoProductCatalogueInfo;
+    lvls?: Array<DtoLevel>;
 }
 /** Transform */
-export interface Transform {
-    pos: Vector;
-    scale: Vector;
-    rot: Orientation;
+export interface DtoTransform {
+    pos: DtoVector;
+    scale: DtoVector;
+    rot: DtoOrientation;
 }
 /** ValidateRequest */
-export interface ValidateRequest {
-    selOptions: Array<SelectedOption>;
+export interface DtoValidateRequest {
+    selOptions: Array<DtoSelectedOption>;
 }
 /** ValidateResponse */
-export interface ValidateResponse {
-    productData: ProductData;
+export interface DtoValidateResponse {
+    productData: DtoProductData;
     uuid: string;
     validated: boolean;
-    rootFeatureRefs?: Array<FeatureRef>;
+    rootFeatureRefs?: Array<DtoFeatureRef>;
 }
 /** ValueWithUnit */
-export interface ValueWithUnit {
+export interface DtoValueWithUnit {
     value: number;
     unit?: string;
 }
 /** Vector */
-export interface Vector {
+export interface DtoVector {
     x: number;
     y: number;
     z: number;
 }
-export declare type RequestOptions = {
+export declare type DtoRequestOptions = {
     method: "POST" | "GET" | "DELETE";
     headers: {
         [index: string]: string;
     };
     body?: string;
 };
-export declare class APIError<T> extends Error {
+export declare class DtoAPIError<T> extends Error {
     body?: string;
     error?: Error;
     parsed?: T;
@@ -485,24 +526,27 @@ export declare class APIError<T> extends Error {
 declare type FetchFunc = (input: RequestInfo, init?: RequestInit) => Promise<Response>;
 export declare class CatalogueAPI {
     private readonly _fetch;
-    auth: AuthorizeResponse | undefined;
+    auth: DtoAuthorizeResponse | undefined;
     constructor(_fetch?: FetchFunc);
     private _alternativeReferer;
     _saveAlternativeReferer(): void;
     hasFeature(feature: string): boolean;
-    fetch<T>(url: string, options: RequestOptions): Promise<T>;
-    postPublicAccessTokenAuthorize(params: PostPublicAccessTokenAuthorizeParams, endpoint: string): Promise<AuthorizeResponse>;
-    getApplicationAreas(params: GetApplicationAreasParams): Promise<ApplicationAreasResponse>;
-    postExport(params: PostExportParams, body: ExportRequest): Promise<ExportResponse>;
-    getPriceLists(params: GetPriceListsParams): Promise<PriceListsResponse>;
-    getProduct(params: GetProductParams): Promise<ProductResponse>;
-    postRender(params: PostRenderParams, body: RenderRequest): Promise<RenderResponse>;
-    postValidate(params: PostValidateParams, body: ValidateRequest): Promise<ValidateResponse>;
-    getTocTree(params: GetTocTreeParams): Promise<TOCResponse>;
-    getTocFlat(params: GetTocFlatParams): Promise<TOCResponse>;
-    getExportById(params: GetExportByIdParams): Promise<ExportResponse>;
-    getRenderById(params: GetRenderByIdParams): Promise<RenderResponse>;
-    postSessionTokenRefresh(): Promise<RefreshSessionTokenResponse>;
-}
+    fetch<T>(url: string, options: DtoRequestOptions): Promise<T>;
+    postPublicAccessTokenAuthorize(params: DtoPostPublicAccessTokenAuthorizeParams, endpoint: string): Promise<DtoAuthorizeResponse>;
+    getApplicationAreas(params: DtoGetApplicationAreasParams): Promise<DtoApplicationAreasResponse>;
+    postExport(params: DtoPostExportParams, body: DtoExportRequest): Promise<DtoExportResponse>;
+    getPriceLists(params: DtoGetPriceListsParams): Promise<DtoPriceListsResponse>;
+    getProduct(params: DtoGetProductParams): Promise<DtoProductResponse>;
+    postRender(params: DtoPostRenderParams, body: DtoRenderRequest): Promise<DtoRenderResponse>;
+    postValidate(params: DtoPostValidateParams, body: DtoValidateRequest): Promise<DtoValidateResponse>;
+    getTocTree(params: DtoGetTocTreeParams): Promise<DtoTOCResponse>;
+    getTocFlat(params: DtoGetTocFlatParams): Promise<DtoTOCResponse>;
+    getExportById(params: DtoGetExportByIdParams): Promise<DtoExportResponse>;
+    getRenderById(params: DtoGetRenderByIdParams): Promise<DtoRenderResponse>;
+    postSessionTokenRefresh(): Promise<DtoRefreshSessionTokenResponse>;
+}
+export declare const DTO_OPERATION_ID_TO_DEBIT_GROUP: {
+    [operation_id: string]: string;
+};
 export {};
 //# sourceMappingURL=CatalogueAPI.d.ts.map