@propeller-commerce/propeller-sdk-v2 0.11.4 → 0.12.1

package/dist/cjs/type/ProductSearchSortInput.d.ts

@@ -0,0 +1,11 @@
+import { ProductSortField } from '../enum/ProductSortField';
+import { SortOrder } from '../enum/SortOrder';
+/**
+ Input object for ProductSearchSortInput
+ */
+export interface ProductSearchSortInput {
+    /** Available sortable fields */
+    field: ProductSortField;
+    /** Sort ordering ['desc' or 'asc'] */
+    order?: SortOrder;
+}

package/dist/cjs/type/ProductSearchSortInput.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/type/ProductSearchTextFilterInput.d.ts

@@ -0,0 +1,14 @@
+import { AttributeType } from '../enum/AttributeType';
+/**
+ Input object for ProductSearchTextFilterInput
+ */
+export interface ProductSearchTextFilterInput {
+    /** ID (UUID) of the attribute */
+    id: string;
+    /** Text filter value */
+    values: string[];
+    /** Text filter exclude */
+    exclude: boolean;
+    /** Text filter type */
+    type?: AttributeType;
+}

package/dist/cjs/type/ProductSearchTextFilterInput.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/type/ProductsRawResponse.d.ts

@@ -0,0 +1,20 @@
+import { Product } from './Product';
+/**
+ Object class for ProductsRawResponse
+ */
+export interface ProductsRawResponse {
+    /** Items returned by the query for the current page. */
+    items: Product[];
+    /** Total number of items found */
+    itemsFound: number;
+    /** Number of items to skip */
+    offset?: number;
+    /** Current page number (1-based) */
+    page?: number;
+    /** Total number of pages */
+    pages: number;
+    /** Starting index for current page */
+    start: number;
+    /** Ending index for current page */
+    end: number;
+}

package/dist/cjs/type/ProductsRawResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/type/RawProductSearchInput.d.ts

@@ -0,0 +1,38 @@
+import { ProductStatus } from '../enum/ProductStatus';
+/**
+ Input object for RawProductSearchInput
+ */
+export interface RawProductSearchInput {
+    /** Search term for names, descriptions, or SKU */
+    term?: string;
+    /** Filter by SKUs */
+    skus?: string[];
+    /** Filter by product statuses */
+    statuses?: ProductStatus[];
+    /** Filter by manufacturers */
+    manufacturers?: string[];
+    /** Filter by suppliers */
+    suppliers?: string[];
+    /** Filter by category ID */
+    categoryId?: number;
+    /** Filter by cluster IDs */
+    clusterIds?: number[];
+    /** Filter by specific product IDs */
+    productIds?: number[];
+    /** Is product hidden? */
+    hidden?: boolean;
+    /** Browse catalog as a specific User. Permissions, orderlists, favorite will be merged with the logged in user. */
+    userId?: number;
+    /** Browse catalog as a specific Company. Permissions, orderlists, favorite will be merged with the logged in user. */
+    companyId?: number;
+    /** Whether to apply orderlist filtering */
+    applyOrderlists?: boolean;
+    /** Order list IDs to apply for filtering */
+    orderlistIds?: number[];
+    /** Page number for pagination */
+    page?: number;
+    /** Number of items per page */
+    offset?: number;
+    /** Language for search and sorting */
+    language?: string;
+}

package/dist/cjs/type/RawProductSearchInput.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/type/ReindexJobDetail.d.ts

@@ -0,0 +1,13 @@
+/**
+ Object class for ReindexJobDetail
+ */
+export interface ReindexJobDetail {
+    /** name field */
+    name: string;
+    /** state field */
+    state: string;
+    /** Job progress as JSON string */
+    progress?: string;
+    /** Job data as JSON string */
+    data?: string;
+}

package/dist/cjs/type/ReindexJobDetail.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/type/ReindexLockResponse.d.ts

@@ -0,0 +1,11 @@
+/**
+ Object class for ReindexLockResponse
+ */
+export interface ReindexLockResponse {
+    /** isLocked field */
+    isLocked: boolean;
+    /** reindexId field */
+    reindexId?: string;
+    /** ttlSeconds field */
+    ttlSeconds?: number;
+}

package/dist/cjs/type/ReindexLockResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/type/ReindexProgress.d.ts

@@ -0,0 +1,45 @@
+/**
+ Object class for ReindexProgress
+ */
+export interface ReindexProgress {
+    /** phase field */
+    phase?: string;
+    /** totalBatches field */
+    totalBatches: number;
+    /** queuedBatches field */
+    queuedBatches: number;
+    /** completedBatches field */
+    completedBatches: number;
+    /** failedBatches field */
+    failedBatches: number;
+    /** activeBatches field */
+    activeBatches: number;
+    /** waitingBatches field */
+    waitingBatches: number;
+    /** totalDocs field */
+    totalDocs: number;
+    /** totalProducts field */
+    totalProducts?: number;
+    /** totalClusters field */
+    totalClusters?: number;
+    /** totalCategories field */
+    totalCategories?: number;
+    /** progressPercent field */
+    progressPercent: number;
+    /** startedAt field */
+    startedAt?: number;
+    /** Verified parent document count after indexing */
+    indexedDocs?: number;
+    /** Verified product count after indexing */
+    indexedProducts?: number;
+    /** Verified cluster count after indexing */
+    indexedClusters?: number;
+    /** Verified category count after indexing */
+    indexedCategories?: number;
+    /** Percentage of expected documents actually indexed */
+    docSuccessRate?: number;
+    /** error field */
+    error?: string;
+    /** failedJob field */
+    failedJob?: string;
+}

package/dist/cjs/type/ReindexProgress.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/type/ReindexStatusResponse.d.ts

@@ -0,0 +1,13 @@
+import { ReindexJobDetail } from './ReindexJobDetail';
+import { ReindexProgress } from './ReindexProgress';
+/**
+ Object class for ReindexStatusResponse
+ */
+export interface ReindexStatusResponse {
+    /** reindexId field */
+    reindexId: string;
+    /** progress field */
+    progress?: ReindexProgress;
+    /** jobs field */
+    jobs?: ReindexJobDetail[];
+}

package/dist/cjs/type/ReindexStatusResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/type/RestApiKey.d.ts

@@ -0,0 +1,19 @@
+/**
+ Object class for RestApiKey
+ */
+export interface RestApiKey {
+    /** Unique identifier for the API key */
+    id: string;
+    /** Name of the API key */
+    name: string;
+    /** The client ID */
+    clientId: string;
+    /** The client secret */
+    clientSecret: string;
+    /** Whether the API key is active */
+    active: boolean;
+    /** Timestamp when the API key was created */
+    createdAt: string;
+    /** Timestamp when the API key was last modified */
+    lastModifiedAt: string;
+}

package/dist/cjs/type/RestApiKey.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/type/RestApiKeyCreateInput.d.ts

@@ -0,0 +1,9 @@
+/**
+ Input object for RestApiKeyCreateInput
+ */
+export interface RestApiKeyCreateInput {
+    /** Name for the API key */
+    name: string;
+    /** Whether the API key is active */
+    active: boolean;
+}

package/dist/cjs/type/RestApiKeyCreateInput.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/type/RestApiKeyResponse.d.ts

@@ -0,0 +1,20 @@
+import { RestApiKey } from './RestApiKey';
+/**
+ Object class for RestApiKeyResponse
+ */
+export interface RestApiKeyResponse {
+    /** List of items of type RestApiKey */
+    items: RestApiKey[];
+    /** Total number of items found */
+    itemsFound: number;
+    /** The amount of items to show per page */
+    offset: number;
+    /** The current page */
+    page: number;
+    /** Total amount of pages */
+    pages: number;
+    /** Start position of the current page */
+    start: number;
+    /** End position of the current page */
+    end: number;
+}

package/dist/cjs/type/RestApiKeyResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/type/RestApiKeySearchInput.d.ts

@@ -0,0 +1,21 @@
+import { DateSearchInput } from './DateSearchInput';
+import { RestApiKeySortInput } from './RestApiKeySortInput';
+/**
+ Input object for RestApiKeySearchInput
+ */
+export interface RestApiKeySearchInput {
+    /** Pagination page number */
+    page: number;
+    /** Pagination offset number */
+    offset: number;
+    /** Search by date created */
+    createdAt?: DateSearchInput;
+    /** Search by date changed */
+    lastModifiedAt?: DateSearchInput;
+    /** Inputs to sort by */
+    sortInputs?: RestApiKeySortInput[];
+    /** Filter by specific IDs */
+    ids?: string[];
+    /** Filter by active status */
+    active?: boolean;
+}

package/dist/cjs/type/RestApiKeySearchInput.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/type/RestApiKeySortInput.d.ts

@@ -0,0 +1,11 @@
+import { RestApiKeySortField } from '../enum/RestApiKeySortField';
+import { SortOrder } from '../enum/SortOrder';
+/**
+ Input object for RestApiKeySortInput
+ */
+export interface RestApiKeySortInput {
+    /** Field to sort by */
+    field: RestApiKeySortField;
+    /** Sort order direction */
+    order: SortOrder;
+}

package/dist/cjs/type/RestApiKeySortInput.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/type/RestApiKeyUpdateInput.d.ts

@@ -0,0 +1,9 @@
+/**
+ Input object for RestApiKeyUpdateInput
+ */
+export interface RestApiKeyUpdateInput {
+    /** Name for the API key */
+    name?: string;
+    /** Whether the API key is active */
+    active?: boolean;
+}

package/dist/cjs/type/RestApiKeyUpdateInput.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/type/SearchFieldsInput.d.ts

@@ -7,4 +7,6 @@ export interface SearchFieldsInput {
     fieldNames: ProductSearchableField[];
     /** Search boost value */
     boost: number;
+    /** Partial matching boost value for ngram/edge-ngram fields. When omitted, defaults to ceil(boost * 0.5) */
+    partialBoost?: number;
 }

package/dist/cjs/type/Shipment.d.ts

@@ -1,3 +1,4 @@
+import { Source } from './Source';
 import { ShipmentStatus } from '../enum/ShipmentStatus';
 import { ShipmentItem } from './ShipmentItem';
 import { TrackAndTrace } from './TrackAndTrace';
@@ -21,4 +22,8 @@ export interface Shipment {
     items?: ShipmentItem[];
     /** Track and traces */
     trackAndTraces?: TrackAndTrace[];
+    /** List of shipment sources.
+  
+  Identifies the origin system or channel of this shipment. Useful for matching a shipment to an external record when updating. */
+    sources: Source[];
 }

package/dist/cjs/type/ShipmentCreateInput.d.ts

@@ -1,3 +1,4 @@
+import { SourceInput } from './SourceInput';
 import { ShipmentStatus } from '../enum/ShipmentStatus';
 import { ShipmentCreateItemInput } from './ShipmentCreateItemInput';
 import { ShipmentCreateTrackAndTraceInput } from './ShipmentCreateTrackAndTraceInput';
@@ -15,4 +16,8 @@ export interface ShipmentCreateInput {
     items?: ShipmentCreateItemInput[];
     /** Track and traces */
     trackAndTraces?: ShipmentCreateTrackAndTraceInput[];
+    /** List of shipment sources.
+  
+  Identifies the origin system or channel of this shipment. Useful for matching a shipment to an external record when updating. */
+    sources?: SourceInput[];
 }

package/dist/cjs/type/ShipmentUpdateInput.d.ts

@@ -1,3 +1,4 @@
+import { SourceInput } from './SourceInput';
 import { ShipmentStatus } from '../enum/ShipmentStatus';
 /**
  Input object for ShipmentUpdateInput
@@ -9,4 +10,8 @@ export interface ShipmentUpdateInput {
     expectedDeliveryAt?: string;
     /** Shipment status */
     status?: ShipmentStatus;
+    /** List of shipment sources.
+  
+  Identifies the origin system or channel of this shipment. Useful for matching a shipment to an external record when updating. */
+    sources?: SourceInput[];
 }

package/dist/cjs/type/SparePartsMachineProductSearchInput.d.ts

@@ -72,4 +72,6 @@ export interface SparePartsMachineProductSearchInput {
     lastModifiedAt?: DateSearchInput;
     /** List of product SKUs */
     skus?: string[];
+    /** [Deprecated] Category path for hierarchical navigation. */
+    path?: string;
 }

package/dist/cjs/type/StartReindexResponse.d.ts

@@ -0,0 +1,11 @@
+/**
+ Object class for StartReindexResponse
+ */
+export interface StartReindexResponse {
+    /** reindexId field */
+    reindexId: string;
+    /** newCollection field */
+    newCollection: string;
+    /** alias field */
+    alias: string;
+}

package/dist/cjs/type/StartReindexResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/type/SurchargeProduct.d.ts

@@ -1,3 +1,4 @@
+import { Product } from './Product';
 import { Surcharge } from './Surcharge';
 /**
  Object class for SurchargeProduct
@@ -9,4 +10,8 @@ export interface SurchargeProduct {
     productId?: number;
     /** The surcharge object */
     surcharge: Surcharge;
+    /** Complete product information for the surcharged item.
+  
+  Detailed product data for the product that this surcharge applies to. */
+    product?: Product;
 }

package/dist/cjs/type/Tenant.d.ts

@@ -26,4 +26,10 @@ export interface Tenant {
     quoteDefaultExpiryPeriodDays?: number;
     /** All channels belonging to this tenant */
     channels: Channel[];
+    /** [SETTING] Default application UI language for this tenant as a 2-character code (e.g. EN, NL).
+  Used when no user-specific language preference is available. */
+    defaultAppLanguage: string;
+    /** [SETTING] Default data language for this tenant as a 2-character code (e.g. EN, NL).
+  Applied to localized data fields when no explicit language is requested. */
+    defaultDataLanguage?: string;
 }

package/dist/cjs/type/TenantCreateInput.d.ts

@@ -21,4 +21,10 @@ export interface TenantCreateInput {
     allowQuoteInvalidation?: ALLOW_QUOTE_INVALIDATION;
     /** Default number of days before quotes expire within this tenant */
     quoteDefaultExpiryPeriodDays?: number;
+    /** [SETTING] Default application UI language for this tenant as a 2-character code (e.g. EN, NL).
+  Used when no user-specific language preference is available. */
+    defaultAppLanguage: string;
+    /** [SETTING] Default data language for this tenant as a 2-character code (e.g. EN, NL).
+  Applied to localized data fields when no explicit language is requested. */
+    defaultDataLanguage?: string;
 }

package/dist/cjs/type/TenantUpdateInput.d.ts

@@ -16,4 +16,10 @@ export interface TenantUpdateInput {
     allowQuoteInvalidation?: ALLOW_QUOTE_INVALIDATION;
     /** Default number of days before quotes expire within this tenant */
     quoteDefaultExpiryPeriodDays?: number;
+    /** [SETTING] Default application UI language for this tenant as a 2-character code (e.g. EN, NL).
+  Used when no user-specific language preference is available. */
+    defaultAppLanguage?: string;
+    /** [SETTING] Default data language for this tenant as a 2-character code (e.g. EN, NL).
+  Applied to localized data fields when no explicit language is requested. */
+    defaultDataLanguage?: string;
 }

package/dist/cjs/type/UpdateCategoryInput.d.ts

@@ -1,3 +1,4 @@
+import { SourceInput } from './SourceInput';
 import { YesNo } from '../enum/YesNo';
 import { LocalizedStringInput } from './LocalizedStringInput';
 /**
@@ -6,14 +7,17 @@ import { LocalizedStringInput } from './LocalizedStringInput';
 export interface UpdateCategoryInput {
     /** Localized category name as it is available in
       the supported language defaults to the category's default language. */
+    /** @deprecated Deprecated in the schema; kept for backward compatibility. Will be removed in a future major. */
     name?: LocalizedStringInput[];
     /** The long description for this category,
       this field can contain html formatting,
       this field can be translated is case of multilingual catalog. */
+    /** @deprecated Deprecated in the schema; kept for backward compatibility. Will be removed in a future major. */
     description?: LocalizedStringInput[];
     /** The short description for this category,
       this field can contain html formatting,
       this field can be translated is case of multilingual catalog. */
+    /** @deprecated Deprecated in the schema; kept for backward compatibility. Will be removed in a future major. */
     shortDescription?: LocalizedStringInput[];
     /** The category's parent Category when available */
     parent?: number;
@@ -27,4 +31,32 @@ export interface UpdateCategoryInput {
     metadataCanonicalUrls?: LocalizedStringInput[];
     /** Category hidden status */
     hidden?: YesNo;
+    /** Localized names shown to end users in catalog and navigation surfaces. The catalogue's default language must be present.
+  
+  Every entry must declare a distinct language. Cannot be combined with the single-language counterpart on the same input. */
+    names?: LocalizedStringInput[];
+    /** Localized long-form descriptions shown on category landing surfaces.
+  
+  Every entry must declare a distinct language. Each localized value is capped at 300,000 characters. Cannot be combined with the single-language counterpart on the same input. */
+    descriptions?: LocalizedStringInput[];
+    /** Localized short descriptions surfaced in listings and tiles.
+  
+  Every entry must declare a distinct language. Each localized value is capped at 300,000 characters. Cannot be combined with the single-language counterpart on the same input. */
+    shortDescriptions?: LocalizedStringInput[];
+    /** URL-friendly identifiers, one per language, used in human-readable links.
+  
+  Every entry must declare a distinct language. Each value must be a lowercase URL-friendly slug. Cannot be combined with the single-language counterpart on the same input. */
+    slugs?: LocalizedStringInput[];
+    /** Globally unique identifier of the parent category. Omitted for root categories.
+  
+  Cannot be combined with the legacy `parent` field on the same input. */
+    parentUuid?: string;
+    /** Generates missing slugs from the localized names when set; existing slugs are preserved.
+  
+  When enabled, slugs are regenerated from the localized names for any language whose slug is not explicitly supplied. */
+    autoGenerateSlugs?: boolean;
+    /** Pairs of external system names and the identifiers each system assigned to the record.
+  
+  Replaces the existing list of external sources entirely. */
+    sources?: SourceInput[];
 }

package/dist/cjs/type/UpdateOrderStatusInput.d.ts

@@ -23,10 +23,13 @@ export interface UpdateOrderStatusInput {
     /** Marks if the order is deletable */
     isDeletable?: boolean;
     /** Marks if the order is exportable */
+    /** @deprecated Deprecated in the schema; kept for backward compatibility. Will be removed in a future major. */
     isExportable?: boolean;
     /** Marks if the order is confirmable */
+    /** @deprecated Deprecated in the schema; kept for backward compatibility. Will be removed in a future major. */
     isConfirmable?: boolean;
     /** Marks if the order can be archived */
+    /** @deprecated Deprecated in the schema; kept for backward compatibility. Will be removed in a future major. */
     isArchivable?: boolean;
     /** The IDs of the next possible order statuses */
     nextStatusesIds?: number[];

package/dist/cjs/type/UpdateProductInput.d.ts

@@ -1,3 +1,4 @@
+import { SourceInput } from './SourceInput';
 import { ProductStatus } from '../enum/ProductStatus';
 import { YesNo } from '../enum/YesNo';
 import { LocalizedStringInput } from './LocalizedStringInput';
@@ -56,6 +57,7 @@ export interface UpdateProductInput {
     /** The taxonomy the product belongs to */
     taxonomy?: string;
     /** The short name for the product, used for abbreviated orderlines */
+    /** @deprecated Deprecated in the schema; kept for backward compatibility. Will be removed in a future major. */
     shortName?: string;
     /** The package description of this product per language */
     packageDescriptions?: LocalizedStringInput[];
@@ -87,4 +89,20 @@ export interface UpdateProductInput {
     packageUnitQuantity?: string;
     /** Product hidden status */
     hidden?: YesNo;
+    /** Localized slugs */
+    slugs?: LocalizedStringInput[];
+    /** Cluster ID if assigned to a cluster */
+    clusterId?: number;
+    /** Product width */
+    width?: number;
+    /** Product height */
+    height?: number;
+    /** Product depth */
+    depth?: number;
+    /** Product weight */
+    weight?: number;
+    /** Whether to auto-generate slugs from names. When true (default), slugs are always regenerated for languages with names unless explicitly provided. When false, slugs are only generated for languages without existing slugs in the database. */
+    autoGenerateSlugs?: boolean;
+    /** Source/SourceId combinations for external system lookup (replaces existing sources) */
+    sources?: SourceInput[];
 }

package/dist/cjs/type/ValuesetItemSearchInput.d.ts

@@ -1,3 +1,4 @@
+import { ValuesetItemTermField } from '../enum/ValuesetItemTermField';
 import { ValuesetItemSortInput } from './ValuesetItemSortInput';
 /**
  Input object for ValuesetItemSearchInput
@@ -17,4 +18,16 @@ export interface ValuesetItemSearchInput {
     extras?: string[];
     /** Inputs to sort by */
     sortInputs?: ValuesetItemSortInput[];
+    /** Free-text search term to filter by.
+  
+  Performs a case-insensitive partial-match search across value set item fields. Use this to find items that match a specific keyword or phrase (e.g. "Nether" to match the description "Netherlands"). */
+    term?: string;
+    /** Fields to search in when using the term filter.
+  
+  Specifies which fields should be included in the full-text search when a term is provided. Defaults to searching in all fields. Array must contain unique values and be non-empty when provided. */
+    termFields?: ValuesetItemTermField[];
+    /** Languages to search in when using the term filter.
+  
+  Specifies which languages should be included in the full-text search when a term is provided. All languages are included by default. Array must contain unique values and be non-empty when provided. */
+    termLanguages?: string[];
 }

package/dist/cjs/type/ValuesetSearchInput.d.ts

@@ -1,3 +1,4 @@
+import { ValuesetTermField } from '../enum/ValuesetTermField';
 import { ValuesetType } from '../enum/ValuesetType';
 import { DateSearchInput } from './DateSearchInput';
 import { ValuesetSortInput } from './ValuesetSortInput';
@@ -21,4 +22,16 @@ export interface ValuesetSearchInput {
     type?: ValuesetType;
     /** Inputs to sort by */
     sortInputs?: ValuesetSortInput[];
+    /** Free-text search term to filter by.
+  
+  Performs a case-insensitive partial-match search across value set fields. Use this to find value sets that match a specific keyword or phrase. */
+    term?: string;
+    /** Fields to search in when using the term filter.
+  
+  Specifies which fields should be included in the full-text search when a term is provided. Defaults to searching in all fields. Array must contain unique values and be non-empty when provided. */
+    termFields?: ValuesetTermField[];
+    /** Languages to search in when using the term filter.
+  
+  Specifies which languages should be included in the full-text search when a term is provided. All languages are included by default. Array must contain unique values and be non-empty when provided. */
+    termLanguages?: string[];
 }