@shopware/api-client

/** * This file is auto-generated. Do not make direct changes to the file. * Instead override it in your shopware.d.ts file. * * Shopware API version: 6.6.6.0 * */ type GenericRecord = | never | null | string | string[] | number | { [key: string]: GenericRecord; }; export type components = { schemas: Schemas; }; export type Schemas = { AbstractDynamicPageOpenedPayload: { /** @default true */ opened?: boolean; /** The type of the current dynamic page */ type: string; }; AclRole: { app?: components["schemas"]["App"]; /** Format: date-time */ readonly createdAt?: string; /** Format: date-time */ deletedAt?: string; description?: string; id: string; integrations?: components["schemas"]["Integration"][]; name: string; privileges?: GenericRecord[]; /** Format: date-time */ readonly updatedAt?: string; users?: components["schemas"]["User"][]; }; AclRoleJsonApi: components["schemas"]["resource"] & { /** Format: date-time */ readonly createdAt?: string; /** Format: date-time */ deletedAt?: string; description?: string; id: string; name: string; privileges?: GenericRecord[]; relationships?: { app?: { data?: { /** @example d2a57dc1d883fd21fb9951699df71cc7 */ id?: string; /** @example app */ type?: string; }; links?: { /** * Format: uri-reference * @example /acl-role/87857e66337bf79fa25f363fefba38a1/app */ related?: string; }; }; integrations?: { data?: { /** @example 415320131958c70f4f250ca4d7e63bbd */ id?: string; /** @example integration */ type?: string; }[]; links?: { /** * Format: uri-reference * @example /acl-role/87857e66337bf79fa25f363fefba38a1/integrations */ related?: string; }; }; users?: { data?: { /** @example 9bc65c2abec141778ffaa729489f3e87 */ id?: string; /** @example user */ type?: string; }[]; links?: { /** * Format: uri-reference * @example /acl-role/87857e66337bf79fa25f363fefba38a1/users */ related?: string; }; }; }; /** Format: date-time */ readonly updatedAt?: string; }; AclUserRole: { aclRole?: components["schemas"]["AclRole"]; aclRoleId: string; /** Format: date-time */ readonly createdAt?: string; id?: string; /** Format: date-time */ readonly updatedAt?: string; user?: components["schemas"]["User"]; userId: string; }; AdvancedSearchAction: { active?: boolean; config?: components["schemas"]["AdvancedSearchConfig"]; configId: string; /** Format: date-time */ readonly createdAt?: string; id: string; name: string; searchTerms?: components["schemas"]["AdvancedSearchActionSearchTerm"][]; type: string; typeConfig?: GenericRecord; /** Format: date-time */ readonly updatedAt?: string; /** Format: date-time */ validFrom?: string; /** Format: date-time */ validTo?: string; }; AdvancedSearchActionJsonApi: components["schemas"]["resource"] & { active?: boolean; configId: string; /** Format: date-time */ readonly createdAt?: string; id: string; name: string; relationships?: { config?: { data?: { /** @example 2245023265ae4cf87d02c8b6ba991139 */ id?: string; /** @example advanced_search_config */ type?: string; }; links?: { /** * Format: uri-reference * @example /advanced-search-action/2a6023897ca55437c49e4a41b8f76f77/config */ related?: string; }; }; searchTerms?: { data?: { /** @example 952c07f523c564f09844ca7f880c2467 */ id?: string; /** @example advanced_search_action_search_term */ type?: string; }[]; links?: { /** * Format: uri-reference * @example /advanced-search-action/2a6023897ca55437c49e4a41b8f76f77/searchTerms */ related?: string; }; }; }; type: string; typeConfig?: GenericRecord; /** Format: date-time */ readonly updatedAt?: string; /** Format: date-time */ validFrom?: string; /** Format: date-time */ validTo?: string; }; AdvancedSearchActionSearchTerm: { action?: components["schemas"]["AdvancedSearchAction"]; actionId: string; /** Format: date-time */ readonly createdAt?: string; id: string; salesChannel?: components["schemas"]["SalesChannel"]; salesChannelId: string; term: string; /** Format: date-time */ readonly updatedAt?: string; }; AdvancedSearchActionSearchTermJsonApi: components["schemas"]["resource"] & { actionId: string; /** Format: date-time */ readonly createdAt?: string; id: string; relationships?: { action?: { data?: { /** @example 418c5509e2171d55b0aee5c2ea4442b5 */ id?: string; /** @example advanced_search_action */ type?: string; }; links?: { /** * Format: uri-reference * @example /advanced-search-action-search-term/a7e591b2d328bc4e62fbd4fd300da858/action */ related?: string; }; }; salesChannel?: { data?: { /** @example ec3712a84143b57e0db620eaac6e55b8 */ id?: string; /** @example sales_channel */ type?: string; }; links?: { /** * Format: uri-reference * @example /advanced-search-action-search-term/a7e591b2d328bc4e62fbd4fd300da858/salesChannel */ related?: string; }; }; }; salesChannelId: string; term: string; /** Format: date-time */ readonly updatedAt?: string; }; AdvancedSearchBoosting: { active?: boolean; /** Format: float */ boost: number; config?: components["schemas"]["AdvancedSearchConfig"]; configId: string; /** Format: date-time */ readonly createdAt?: string; entityStream?: components["schemas"]["AdvancedSearchEntityStream"]; entityStreamId?: string; id: string; name: string; productStream?: components["schemas"]["ProductStream"]; productStreamId?: string; /** Format: date-time */ readonly updatedAt?: string; /** Format: date-time */ validFrom?: string; /** Format: date-time */ validTo?: string; }; AdvancedSearchBoostingJsonApi: components["schemas"]["resource"] & { active?: boolean; /** Format: float */ boost: number; configId: string; /** Format: date-time */ readonly createdAt?: string; entityStreamId?: string; id: string; name: string; productStreamId?: string; relationships?: { config?: { data?: { /** @example 2245023265ae4cf87d02c8b6ba991139 */ id?: string; /** @example advanced_search_config */ type?: string; }; links?: { /** * Format: uri-reference * @example /advanced-search-boosting/594f5cafa4dccca1634893a5a0a86ec9/config */ related?: string; }; }; entityStream?: { data?: { /** @example 62acf68da615789a0175ef827f74acbb */ id?: string; /** @example advanced_search_entity_stream */ type?: string; }; links?: { /** * Format: uri-reference * @example /advanced-search-boosting/594f5cafa4dccca1634893a5a0a86ec9/entityStream */ related?: string; }; }; productStream?: { data?: { /** @example 49561f6faa0badfce831a183d2ec7c2f */ id?: string; /** @example product_stream */ type?: string; }; links?: { /** * Format: uri-reference * @example /advanced-search-boosting/594f5cafa4dccca1634893a5a0a86ec9/productStream */ related?: string; }; }; }; /** Format: date-time */ readonly updatedAt?: string; /** Format: date-time */ validFrom?: string; /** Format: date-time */ validTo?: string; }; AdvancedSearchConfig: { andLogic?: boolean; boostings?: components["schemas"]["AdvancedSearchBoosting"][]; /** Format: date-time */ readonly createdAt?: string; esEnabled?: boolean; fields?: components["schemas"]["AdvancedSearchConfigField"][]; hitCount?: { category?: { /** Format: int64 */ maxSearchCount?: number; /** Format: int64 */ maxSuggestCount?: number; }; product?: { /** Format: int64 */ maxSearchCount?: number; /** Format: int64 */ maxSuggestCount?: number; }; product_manufacturer?: { /** Format: int64 */ maxSearchCount?: number; /** Format: int64 */ maxSuggestCount?: number; }; }; id: string; /** Format: int64 */ minSearchLength?: number; salesChannel?: components["schemas"]["SalesChannel"]; salesChannelId: string; /** Format: date-time */ readonly updatedAt?: string; }; AdvancedSearchConfigField: { config?: components["schemas"]["AdvancedSearchConfig"]; configId: string; /** Format: date-time */ readonly createdAt?: string; customField?: components["schemas"]["CustomField"]; customFieldId?: string; entity: string; field: string; id: string; /** Format: int64 */ ranking?: number; searchable?: boolean; tokenize?: boolean; /** Format: date-time */ readonly updatedAt?: string; }; AdvancedSearchConfigFieldJsonApi: components["schemas"]["resource"] & { configId: string; /** Format: date-time */ readonly createdAt?: string; customFieldId?: string; entity: string; field: string; id: string; /** Format: int64 */ ranking?: number; relationships?: { config?: { data?: { /** @example 2245023265ae4cf87d02c8b6ba991139 */ id?: string; /** @example advanced_search_config */ type?: string; }; links?: { /** * Format: uri-reference * @example /advanced-search-config-field/34ed84349128fa95e8aa7d3a69bd99c9/config */ related?: string; }; }; customField?: { data?: { /** @example ed2028a1c479c7e0065da597452d9c11 */ id?: string; /** @example custom_field */ type?: string; }; links?: { /** * Format: uri-reference * @example /advanced-search-config-field/34ed84349128fa95e8aa7d3a69bd99c9/customField */ related?: string; }; }; }; searchable?: boolean; tokenize?: boolean; /** Format: date-time */ readonly updatedAt?: string; }; AdvancedSearchConfigJsonApi: components["schemas"]["resource"] & { andLogic?: boolean; /** Format: date-time */ readonly createdAt?: string; esEnabled?: boolean; hitCount?: { category?: { /** Format: int64 */ maxSearchCount?: number; /** Format: int64 */ maxSuggestCount?: number; }; product?: { /** Format: int64 */ maxSearchCount?: number; /** Format: int64 */ maxSuggestCount?: number; }; product_manufacturer?: { /** Format: int64 */ maxSearchCount?: number; /** Format: int64 */ maxSuggestCount?: number; }; }; id: string; /** Format: int64 */ minSearchLength?: number; relationships?: { boostings?: { data?: { /** @example 8e571802e4ea39b214104ca60e13b5a6 */ id?: string; /** @example advanced_search_boosting */ type?: string; }[]; links?: { /** * Format: uri-reference * @example /advanced-search-config/63246bc46dc5b3716c6f5f92044238e4/boostings */ related?: string; }; }; fields?: { data?: { /** @example d05b6ed7d2345020440df396d6da7f73 */ id?: string; /** @example advanced_search_config_field */ type?: string; }[]; links?: { /** * Format: uri-reference * @example /advanced-search-config/63246bc46dc5b3716c6f5f92044238e4/fields */ related?: string; }; }; salesChannel?: { data?: { /** @example ec3712a84143b57e0db620eaac6e55b8 */ id?: string; /** @example sales_channel */ type?: string; }; links?: { /** * Format: uri-reference * @example /advanced-search-config/63246bc46dc5b3716c6f5f92044238e4/salesChannel */ related?: string; }; }; }; salesChannelId: string; /** Format: date-time */ readonly updatedAt?: string; }; AdvancedSearchEntityStream: { readonly apiFilter?: GenericRecord; boosting?: components["schemas"]["AdvancedSearchBoosting"]; /** Format: date-time */ readonly createdAt?: string; filters?: components["schemas"]["AdvancedSearchEntityStreamFilter"][]; id: string; readonly invalid?: boolean; type: string; /** Format: date-time */ readonly updatedAt?: string; }; AdvancedSearchEntityStreamFilter: { /** Format: date-time */ readonly createdAt?: string; entityStream?: components["schemas"]["AdvancedSearchEntityStream"]; entityStreamId: string; field?: string; id: string; operator?: string; parameters?: GenericRecord; parent?: components["schemas"]["AdvancedSearchEntityStreamFilter"]; parentId?: string; /** Format: int64 */ position?: number; queries?: components["schemas"]["AdvancedSearchEntityStreamFilter"][]; type: string; /** Format: date-time */ readonly updatedAt?: string; value?: string; }; AdvancedSearchEntityStreamFilterJsonApi: components["schemas"]["resource"] & { /** Format: date-time */ readonly createdAt?: string; entityStreamId: string; field?: string; id: string; operator?: string; parameters?: GenericRecord; parentId?: string; /** Format: int64 */ position?: number; relationships?: { entityStream?: { data?: { /** @example 62acf68da615789a0175ef827f74acbb */ id?: string; /** @example advanced_search_entity_stream */ type?: string; }; links?: { /** * Format: uri-reference * @example /advanced-search-entity-stream-filter/910af2160df3a00f3843e6e06940790f/entityStream */ related?: string; }; }; parent?: { data?: { /** @example d0e45878043844ffc41aac437e86b602 */ id?: string; /** @example advanced_search_entity_stream_filter */ type?: string; }; links?: { /** * Format: uri-reference * @example /advanced-search-entity-stream-filter/910af2160df3a00f3843e6e06940790f/parent */ related?: string; }; }; queries?: { data?: { /** @example 5da7eb4247add5dbd5776c9c0b38460a */ id?: string; /** @example advanced_search_entity_stream_filter */ type?: string; }[]; links?: { /** * Format: uri-reference * @example /advanced-search-entity-stream-filter/910af2160df3a00f3843e6e06940790f/queries */ related?: string; }; }; }; type: string; /** Format: date-time */ readonly updatedAt?: string; value?: string; }; AdvancedSearchEntityStreamJsonApi: components["schemas"]["resource"] & { readonly apiFilter?: GenericRecord; /** Format: date-time */ readonly createdAt?: string; id: string; readonly invalid?: boolean; relationships?: { boosting?: { data?: { /** @example 6ab105abdd48ced24ce7b0e516ca0970 */ id?: string; /** @example advanced_search_boosting */ type?: string; }; links?: { /** * Format: uri-reference * @example /advanced-search-entity-stream/8bc027ef6b979dafaf6e1691bf314134/boosting */ related?: string; }; }; filters?: { data?: { /** @example 2c9885d2b0c7e26971f60a90f33cf718 */ id?: string; /** @example advanced_search_entity_stream_filter */ type?: string; }[]; links?: { /** * Format: uri-reference * @example /advanced-search-entity-stream/8bc027ef6b979dafaf6e1691bf314134/filters */ related?: string; }; }; }; type: string; /** Format: date-time */ readonly updatedAt?: string; }; AdvancedSearchSynonym: { /** Format: date-time */ readonly createdAt?: string; id: string; language?: components["schemas"]["Language"]; languageId?: string; left: string[]; right?: string[]; /** Format: date-time */ readonly updatedAt?: string; }; AdvancedSearchSynonymJsonApi: components["schemas"]["resource"] & { /** Format: date-time */ readonly createdAt?: string; id: string; languageId?: string; left: string[]; relationships?: { language?: { data?: { /** @example 8512ae7d57b1396273f76fe6ed341a23 */ id?: string; /** @example language */ type?: string; }; links?: { /** * Format: uri-reference * @example /advanced-search-synonym/f8fe978e49caae961d38f793b4901801/language */ related?: string; }; }; }; right?: string[]; /** Format: date-time */ readonly updatedAt?: string; }; AggregationEntity: { /** The entity definition e.g "product_manufacturer". */ definition: string; /** The field you want to aggregate over. */ field: string; /** Give your aggregation an identifier, so you can find it easier */ name: string; /** * The type of aggregation * @enum {string} */ type: "entity"; }; AggregationFilter: { filter: components["schemas"]["Filters"][]; /** Give your aggregation an identifier, so you can find it easier */ name: string; /** * The type of aggregation * @enum {string} */ type: "filter"; }; AggregationHistogram: { /** The field you want to aggregate over. */ field: string; /** The format of the histogram */ format?: string; /** The interval of the histogram */ interval?: number; /** Give your aggregation an identifier, so you can find it easier */ name: string; /** The timezone of the histogram */ timeZone?: string; /** * The type of aggregation * @enum {string} */ type: "histogram"; }; AggregationMetrics: { field: string; name: string; /** @enum {string} */ type: "avg" | "count" | "max" | "min" | "stats" | "sum"; }; AggregationRange: { /** The field you want to aggregate over. */ field: string; /** Give your aggregation an identifier, so you can find it easier */ name: string; /** The ranges of the aggregation */ ranges: ( | { /** The lower bound of the range */ from: number; /** The upper bound of the range */ to: number; } | { /** The lower bound of the range */ from: string; } | { /** The upper bound of the range */ to: string; } )[]; /** * The type of aggregation * @enum {string} */ type: "range"; }; AggregationTerms: { /** The field you want to aggregate over. */ field: string; /** The number of terms to return */ limit?: number; /** Give your aggregation an identifier, so you can find it easier */ name: string; /** Sorting the aggregation result. */ sort?: components["schemas"]["Sort"][]; /** * The type of aggregation * @enum {string} */ type: "terms"; }; Aggregations: ( | components["schemas"]["AggregationMetrics"] | (components["schemas"]["AggregationEntity"] & components["schemas"]["SubAggregations"]) | (components["schemas"]["AggregationFilter"] & components["schemas"]["SubAggregations"]) | (components["schemas"]["AggregationTerms"] & components["schemas"]["SubAggregations"]) | (components["schemas"]["AggregationHistogram"] & components["schemas"]["SubAggregations"]) | (components["schemas"]["AggregationRange"] & components["schemas"]["SubAggregations"]) )[]; App: { aclRole?: components["schemas"]["AclRole"]; aclRoleId: string; actionButtons?: components["schemas"]["AppActionButton"][]; active?: boolean; allowDisable?: boolean; allowedHosts?: string[]; appShippingMethods?: components["schemas"]["AppShippingMethod"][]; author?: string; baseAppUrl?: string; checkoutGatewayUrl?: string; cmsBlocks?: components["schemas"]["AppCmsBlock"][]; configurable?: boolean; cookies?: GenericRecord[]; copyright?: string; /** Format: date-time */ readonly createdAt?: string; customFields?: GenericRecord; customFieldSets?: components["schemas"]["CustomFieldSet"][]; description?: string; extensions?: { storefrontConfig?: { data?: { /** @example bd1f4963443684177aac2b302cded7ac */ id?: string; /** @example saas_app_storefront_config */ type?: string; }[]; links?: { /** * Format: uri-reference * @example /app/ac863f346e618f9a959b5c95d5d28941/storefrontConfig */ related?: string; }; }; }; flowActions?: components["schemas"]["AppFlowAction"][]; flowEvents?: components["schemas"]["AppFlowEvent"][]; /** Runtime field, cannot be used as part of the criteria. */ readonly icon?: string; id: string; integration?: components["schemas"]["Integration"]; integrationId: string; label: string; license?: string; mainModule?: GenericRecord; modules?: GenericRecord[]; name: string; path: string; paymentMethods?: components["schemas"]["AppPaymentMethod"][]; privacy?: string; privacyPolicyExtensions?: string; selfManaged?: boolean; sourceConfig?: GenericRecord; sourceType?: string; taxProviders?: components["schemas"]["TaxProvider"][]; /** Format: int64 */ templateLoadPriority?: number; templates?: components["schemas"]["AppTemplate"][]; translated: { aclRoleId: string; author: string; baseAppUrl: string; checkoutGatewayUrl: string; copyright: string; description: string; icon: string; integrationId: string; label: string; license: string; name: string; path: string; privacy: string; privacyPolicyExtensions: string; sourceType: string; version: string; }; /** Format: date-time */ readonly updatedAt?: string; version: string; webhooks?: components["schemas"]["Webhook"][]; }; AppActionButton: { action: string; app?: components["schemas"]["App"]; appId: string; /** Format: date-time */ readonly createdAt?: string; entity: string; id: string; label: string; translated: { action: string; appId: string; entity: string; label: string; url: string; view: string; }; /** Format: date-time */ readonly updatedAt?: string; url: string; view: string; }; AppActionButtonJsonApi: components["schemas"]["resource"] & { action: string; appId: string; /** Format: date-time */ readonly createdAt?: string; entity: string; id: string; label: string; relationships?: { app?: { data?: { /** @example d2a57dc1d883fd21fb9951699df71cc7 */ id?: string; /** @example app */ type?: string; }; links?: { /** * Format: uri-reference * @example /app-action-button/5c44158189757c2cf5f047ce1fe3e634/app */ related?: string; }; }; }; translated: { action: string; appId: string; entity: string; label: string; url: string; view: string; }; /** Format: date-time */ readonly updatedAt?: string; url: string; view: string; }; AppAdministrationSnippet: { appId: string; /** Format: date-time */ readonly createdAt?: string; id: string; localeId: string; /** Format: date-time */ readonly updatedAt?: string; value: string; }; AppAdministrationSnippetJsonApi: components["schemas"]["resource"] & { appId: string; /** Format: date-time */ readonly createdAt?: string; id: string; localeId: string; /** Format: date-time */ readonly updatedAt?: string; value: string; }; AppCmsBlock: { app?: components["schemas"]["App"]; appId: string; block: GenericRecord; /** Format: date-time */ readonly createdAt?: string; id: string; label: string; name: string; styles: string; template: string; translated: { appId: string; label: string; name: string; styles: string; template: string; }; /** Format: date-time */ readonly updatedAt?: string; }; AppCmsBlockJsonApi: components["schemas"]["resource"] & { appId: string; block: GenericRecord; /** Format: date-time */ readonly createdAt?: string; id: string; label: string; name: string; relationships?: { app?: { data?: { /** @example d2a57dc1d883fd21fb9951699df71cc7 */ id?: string; /** @example app */ type?: string; }; links?: { /** * Format: uri-reference * @example /app-cms-block/954814c609e0fd182bf61e99769a25f7/app */ related?: string; }; }; }; styles: string; template: string; translated: { appId: string; label: string; name: string; styles: string; template: string; }; /** Format: date-time */ readonly updatedAt?: string; }; AppFlowAction: { app?: components["schemas"]["App"]; appId: string; badge?: string; config?: GenericRecord; /** Format: date-time */ readonly createdAt?: string; customFields?: GenericRecord; delayable?: boolean; description?: string; flowSequences?: components["schemas"]["FlowSequence"][]; headers?: GenericRecord; headline?: string; /** Runtime field, cannot be used as part of the criteria. */ readonly icon?: string; iconRaw?: string; id: string; label: string; name: string; parameters?: GenericRecord; requirements?: string[]; swIcon?: string; translated: { appId: string; badge: string; description: string; headline: string; icon: string; iconRaw: string; label: string; name: string; swIcon: string; url: string; }; /** Format: date-time */ readonly updatedAt?: string; url: string; }; AppFlowActionJsonApi: components["schemas"]["resource"] & { appId: string; badge?: string; config?: GenericRecord; /** Format: date-time */ readonly createdAt?: string; customFields?: GenericRecord; delayable?: boolean; description?: string; headers?: GenericRecord; headline?: string; /** Runtime field, cannot be used as part of the criteria. */ readonly icon?: string; iconRaw?: string; id: string; label: string; name: string; parameters?: GenericRecord; relationships?: { app?: { data?: { /** @example d2a57dc1d883fd21fb9951699df71cc7 */ id?: string; /** @example app */ type?: string; }; links?: { /** * Format: uri-reference * @example /app-flow-action/d976e1ecc9f1084ec17f507c84f92278/app */ related?: string; }; }; flowSequences?: { data?: { /** @example 3a0d70b6dd3624074e5e15cd07e7fa90 */ id?: string; /** @example flow_sequence */ type?: string; }[]; links?: { /** * Format: uri-reference * @example /app-flow-action/d976e1ecc9f1084ec17f507c84f92278/flowSequences */ related?: string; }; }; }; requirements?: string[]; swIcon?: string; translated: { appId: string; badge: string; description: string; headline: string; icon: string; iconRaw: string; label: string; name: string; swIcon: string; url: string; }; /** Format: date-time */ readonly updatedAt?: string; url: string; }; AppFlowEvent: { app?: components["schemas"]["App"]; appId: string; aware: string[]; /** Format: date-time */ readonly createdAt?: string; customFields?: GenericRecord; flows?: components["schemas"]["Flow"][]; id: string; name: string; /** Format: date-time */ readonly updatedAt?: string; }; AppFlowEventJsonApi: components["schemas"]["resource"] & { appId: string; aware: string[]; /** Format: date-time */ readonly createdAt?: string; customFields?: GenericRecord; id: string; name: string; relationships?: { app?: { data?: { /** @example d2a57dc1d883fd21fb9951699df71cc7 */ id?: string; /** @example app */ type?: string; }; links?: { /** * Format: uri-reference * @example /app-flow-event/ee419db2bca734414b0df87b3a919831/app */ related?: string; }; }; flows?: { data?: { /** @example 0db2dd944f9ee9a131f44b79d331d371 */ id?: string; /** @example flow */ type?: string; }[]; links?: { /** * Format: uri-reference * @example /app-flow-event/ee419db2bca734414b0df87b3a919831/flows */ related?: string; }; }; }; /** Format: date-time */ readonly updatedAt?: string; }; AppJsonApi: components["schemas"]["resource"] & { aclRoleId: string; active?: boolean; allowDisable?: boolean; allowedHosts?: string[]; author?: string; baseAppUrl?: string; checkoutGatewayUrl?: string; configurable?: boolean; cookies?: GenericRecord[]; copyright?: string; /** Format: date-time */ readonly createdAt?: string; customFields?: GenericRecord; description?: string; extensions?: { storefrontConfig?: { data?: { /** @example bd1f4963443684177aac2b302cded7ac */ id?: string; /** @example saas_app_storefront_config */ type?: string; }[]; links?: { /** * Format: uri-reference * @example /app/ac863f346e618f9a959b5c95d5d28941/storefrontConfig */ related?: string; }; }; }; /** Runtime field, cannot be used as part of the criteria. */ readonly icon?: string; id: string; integrationId: string; label: string; license?: string; mainModule?: GenericRecord; modules?: GenericRecord[]; name: string; path: string; privacy?: string; privacyPolicyExtensions?: string; relationships?: { aclRole?: { data?: { /** @example 250aa1c64b973365fd6fd489eefbdefc */ id?: string; /** @example acl_role */ type?: string; }; links?: { /** * Format: uri-reference * @example /app/ac863f346e618f9a959b5c95d5d28941/aclRole */ related?: string; }; }; actionButtons?: { data?: { /** @example 2c7967427ed432e546ef1c0cb8d5da9e */ id?: string; /** @example app_action_button */ type?: string; }[]; links?: { /** * Format: uri-reference * @example /app/ac863f346e618f9a959b5c95d5d28941/actionButtons */ related?: string; }; }; appShippingMethods?: { data?: { /** @example 1ad05ee47064647ee5b2dc8c12b1041c */ id?: string; /** @example app_shipping_method */ type?: string; }[]; links?: { /** * Format: uri-reference * @example /app/ac863f346e618f9a959b5c95d5d28941/appShippingMethods */ related?: string; }; }; cmsBlocks?: { data?: { /** @example 3636c4901eab836dfb837e1a9a37d3c0 */ id?: string; /** @example app_cms_block */ type?: string; }[]; links?: { /** * Format: uri-reference * @example /app/ac863f346e618f9a959b5c95d5d28941/cmsBlocks */ related?: string; }; }; customFieldSets?: { data?: { /** @example 9b29ba872ce510f033b31364c8602760 */ id?: string; /** @example custom_field_set */ type?: string; }[]; links?: { /** * Format: uri-reference * @example /app/ac863f346e618f9a959b5c95d5d28941/customFieldSets */ related?: string; }; }; flowActions?: { data?: { /** @example 8d83a8af9d1b8b85dae9bdb76b7dbe7f */ id?: string; /** @example app_flow_action */ type?: string; }[]; links?: { /** * Format: uri-reference * @example /app/ac863f346e618f9a959b5c95d5d28941/flowActions */ related?: string; }; }; flowEvents?: { data?: { /** @example 045e9ec14eafd26d17854fb4fe7c9cae */ id?: string; /** @example app_flow_event */ type?: string; }[]; links?: { /** * Format: uri-reference * @example /app/ac863f346e618f9a959b5c95d5d28941/flowEvents */ related?: string; }; }; integration?: { data?: { /** @example 776ea3bf11df5829827f7afb43c37174 */ id?: string; /** @example integration */ type?: string; }; links?: { /** * Format: uri-reference * @example /app/ac863f346e618f9a959b5c95d5d28941/integration */ related?: string; }; }; paymentMethods?: { data?: { /** @example b631b1ab565525e892f9cdc1242cca14 */ id?: string; /** @example app_payment_method */ type?: string; }[]; links?: { /** * Format: uri-reference * @example /app/ac863f346e618f9a959b5c95d5d28941/paymentMethods */ related?: string; }; }; taxProviders?: { data?: { /** @example 01a1a9d428b6402dc8255d99c787a00e */ id?: string; /** @example tax_provider */ type?: string; }[]; links?: { /** * Format: uri-reference * @example /app/ac863f346e618f9a959b5c95d5d28941/taxProviders */ related?: string; }; }; templates?: { data?: { /** @example fed36e93a0509e20f2dc96cbbd85b678 */ id?: string; /** @example app_template */ type?: string; }[]; links?: { /** * Format: uri-reference * @example /app/ac863f346e618f9a959b5c95d5d28941/templates */ related?: string; }; }; webhooks?: { data?: { /** @example c10f40999b74c408263f790b30e70efe */ id?: string; /** @example webhook */ type?: string; }[]; links?: { /** * Format: uri-reference * @example /app/ac863f346e618f9a959b5c95d5d28941/webhooks */ related?: string; }; }; }; selfManaged?: boolean; sourceConfig?: GenericRecord; sourceType?: string; /** Format: int64 */ templateLoadPriority?: number; translated: { aclRoleId: string; author: string; baseAppUrl: string; checkoutGatewayUrl: string; copyright: string; description: string; icon: string; integrationId: string; label: string; license: string; name: string; path: string; privacy: string; privacyPolicyExtensions: string; sourceType: string; version: string; }; /** Format: date-time */ readonly updatedAt?: string; version: string; }; AppPaymentMethod: { app?: components["schemas"]["App"]; appId?: string; appName: string; captureUrl?: string; /** Format: date-time */ readonly createdAt?: string; finalizeUrl?: string; id: string; identifier: string; originalMedia?: components["schemas"]["Media"]; originalMediaId?: string; paymentMethod?: components["schemas"]["PaymentMethod"]; paymentMethodId: string; payUrl?: string; recurringUrl?: string; refundUrl?: string; /** Format: date-time */ readonly updatedAt?: string; validateUrl?: string; }; AppPaymentMethodJsonApi: components["schemas"]["resource"] & { appId?: string; appName: string; captureUrl?: string; /** Format: date-time */ readonly createdAt?: string; finalizeUrl?: string; id: string; identifier: string; originalMediaId?: string; paymentMethodId: string; payUrl?: string; recurringUrl?: string; refundUrl?: string; relationships?: { app?: { data?: { /** @example d2a57dc1d883fd21fb9951699df71cc7 */ id?: string; /** @example app */ type?: string; }; links?: { /** * Format: uri-reference * @example /app-payment-method/84f7c932de07ae9a57398d64828a7eae/app */ related?: string; }; }; originalMedia?: { data?: { /** @example 56386c66f82d9cd5639a5a7447971ead */ id?: string; /** @example media */ type?: string; }; links?: { /** * Format: uri-reference * @example /app-payment-method/84f7c932de07ae9a57398d64828a7eae/originalMedia */ related?: string; }; }; paymentMethod?: { data?: { /** @example 68ec1eeea9f1b7744e231b5bd0d97df0 */ id?: string; /** @example payment_method */ type?: string; }; links?: { /** * Format: uri-reference * @example /app-payment-method/84f7c932de07ae9a57398d64828a7eae/paymentMethod */ related?: string; }; }; }; /** Format: date-time */ readonly updatedAt?: string; validateUrl?: string; }; AppScriptCondition: { active: boolean; app?: components["schemas"]["App"]; appId: string; config?: GenericRecord; /** Format: date-time */ readonly createdAt?: string; group?: string; id: string; identifier: string; name: string; ruleConditions?: components["schemas"]["RuleCondition"][]; script?: string; translated: { appId: string; group: string; identifier: string; name: string; script: string; }; /** Format: date-time */ readonly updatedAt?: string; }; AppScriptConditionJsonApi: components["schemas"]["resource"] & { active: boolean; appId: string; config?: GenericRecord; /** Format: date-time */ readonly createdAt?: string; group?: string; id: string; identifier: string; name: string; relationships?: { app?: { data?: { /** @example d2a57dc1d883fd21fb9951699df71cc7 */ id?: string; /** @example app */ type?: string; }; links?: { /** * Format: uri-reference * @example /app-script-condition/145c18275de1a9701ba31357e0bce9b5/app */ related?: string; }; }; ruleConditions?: { data?: { /** @example 24bfabce4195894c9aed9b8bcfb0b748 */ id?: string; /** @example rule_condition */ type?: string; }[]; links?: { /** * Format: uri-reference * @example /app-script-condition/145c18275de1a9701ba31357e0bce9b5/ruleConditions */ related?: string; }; }; }; script?: string; translated: { appId: string; group: string; identifier: string; name: string; script: string; }; /** Format: date-time */ readonly updatedAt?: string; }; AppShippingMethod: { app?: components["schemas"]["App"]; appId?: string; appName: string; /** Format: date-time */ readonly createdAt?: string; id: string; identifier: string; originalMedia?: components["schemas"]["Media"]; originalMediaId?: string; shippingMethod?: components["schemas"]["ShippingMethod"]; shippingMethodId: string; /** Format: date-time */ readonly updatedAt?: string; }; AppShippingMethodJsonApi: components["schemas"]["resource"] & { appId?: string; appName: string; /** Format: date-time */ readonly createdAt?: string; id: string; identifier: string; originalMediaId?: string; relationships?: { app?: { data?: { /** @example d2a57dc1d883fd21fb9951699df71cc7 */ id?: string; /** @example app */ type?: string; }; links?: { /** * Format: uri-reference * @example /app-shipping-method/de94cc387f2598e321fc402da2abda66/app */ related?: string; }; }; originalMedia?: { data?: { /** @example 56386c66f82d9cd5639a5a7447971ead */ id?: string; /** @example media */ type?: string; }; links?: { /** * Format: uri-reference * @example /app-shipping-method/de94cc387f2598e321fc402da2abda66/originalMedia */ related?: string; }; }; shippingMethod?: { data?: { /** @example e97bfcdc0cae44bc9e4ab35762eaf0e1 */ id?: string; /** @example shipping_method */ type?: string; }; links?: { /** * Format: uri-reference * @example /app-shipping-method/de94cc387f2598e321fc402da2abda66/shippingMethod */ related?: string; }; }; }; shippingMethodId: string; /** Format: date-time */ readonly updatedAt?: string; }; AppTemplate: { active: boolean; app?: components["schemas"]["App"]; appId: string; /** Format: date-time */ readonly createdAt?: string; id: string; path: string; template: string; /** Format: date-time */ readonly updatedAt?: string; }; AppTemplateJsonApi: components["schemas"]["resource"] & { active: boolean; appId: string; /** Format: date-time */ readonly createdAt?: string; id: string; path: string; relationships?: { app?: { data?: { /** @example d2a57dc1d883fd21fb9951699df71cc7 */ id?: string; /** @example app */ type?: string; }; links?: { /** * Format: uri-reference * @example /app-template/ca9106b8b82ff55b6fdce530ccb952a7/app */ related?: string; }; }; }; template: string; /** Format: date-time */ readonly updatedAt?: string; }; Association: { [key: string]: components["schemas"]["Criteria"]; }; AttendeeInsights: { /** Sum of the cart net in base currency */ cartSum?: number; /** Id of the attendee */ id?: string; /** Sum of all quantities in the cart which were added during the appointment */ productCount?: number; }; B2bBusinessPartner: { /** Format: date-time */ readonly createdAt?: string; customer?: components["schemas"]["Customer"]; customerId?: string; customFields?: GenericRecord; defaultRole?: components["schemas"]["B2bComponentsRole"]; defaultRoleId?: string; id: string; /** Format: date-time */ readonly updatedAt?: string; }; B2bBusinessPartnerJsonApi: components["schemas"]["resource"] & { /** Format: date-time */ readonly createdAt?: string; customerId?: string; customFields?: GenericRecord; defaultRoleId?: string; id: string; relationships?: { customer?: { data?: { /** @example 91ec1f9324753048c0096d036a694f86 */ id?: string; /** @example customer */ type?: string; }; links?: { /** * Format: uri-reference * @example /b2b-business-partner/7ba58cf5989d881e8226f193613ed414/customer */ related?: string; }; }; defaultRole?: { data?: { /** @example 2944ea414640901d532eba5106eb706b */ id?: string; /** @example b2b_components_role */ type?: string; }; links?: { /** * Format: uri-reference * @example /b2b-business-partner/7ba58cf5989d881e8226f193613ed414/defaultRole */ related?: string; }; }; }; /** Format: date-time */ readonly updatedAt?: string; }; B2bComponentsApprovalRule: { active: boolean; affectedRole?: components["schemas"]["B2bComponentsRole"]; affectedRoleId?: string; businessPartnerCustomer?: components["schemas"]["Customer"]; businessPartnerCustomerId?: string; conditions: GenericRecord; /** Format: date-time */ readonly createdAt?: string; description?: string; id: string; name: string; /** Format: int64 */ priority: number; reviewerRole?: components["schemas"]["B2bComponentsRole"]; reviewerRoleId?: string; /** Format: date-time */ readonly updatedAt?: string; }; B2bComponentsApprovalRuleAppScriptCondition: { active: boolean; app?: components["schemas"]["App"]; appId: string; config?: GenericRecord; /** Format: date-time */ readonly createdAt?: string; group?: string; id: string; identifier: string; name: string; script?: string; translated: { appId: string; group: string; identifier: string; name: string; script: string; }; /** Format: date-time */ readonly updatedAt?: string; }; B2bComponentsApprovalRuleAppScriptConditionJsonApi: components["schemas"]["resource"] & { active: boolean; appId: string; config?: GenericRecord; /** Format: date-time */ readonly createdAt?: string; group?: string; id: string; identifier: string; name: string; relationships?: { app?: { data?: { /** @example d2a57dc1d883fd21fb9951699df71cc7 */ id?: string; /** @example app */ type?: string; }; links?: { /** * Format: uri-reference * @example /b2b-components-approval-rule-app-script-condition/031e11005a97d52a5c7950ff98b5f2bb/app */ related?: string; }; }; }; script?: string; translated: { appId: string; group: string; identifier: string; name: string; script: string; }; /** Format: date-time */ readonly updatedAt?: string; }; B2bComponentsApprovalRuleJsonApi: components["schemas"]["resource"] & { active: boolean; affectedRoleId?: string; businessPartnerCustomerId?: string; conditions: GenericRecord; /** Format: date-time */ readonly createdAt?: string; description?: string; id: string; name: string; /** Format: int64 */ priority: number; relationships?: { affectedRole?: { data?: { /** @example 33237c6057eedd7b8c978f77270af3b1 */ id?: string; /** @example b2b_components_role */ type?: string; }; links?: { /** * Format: uri-reference * @example /b2b-components-approval-rule/7181d2e3f46190b96b7cb8242c761a03/affectedRole