@asstio-dev/storefront 0.9.2 → 0.11.0

package/src/schema.d.ts

@@ -4,6 +4,40 @@
  */
 
 export interface paths {
+    "/v1/brands": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Brands with a page on this market (some product of the brand is sold here), by name. Empty when the site has no brand facet or the market no brand URL pattern. productCount counts product families with a variant of the brand sold here. */
+        get: operations["ListBrands"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/brands/{slugOrId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** A brand page's data by current slug, historical slug or id: name, description, logo, website, the brand's default responsible parties and the facet link for its listing. redirectTo is set for a historical slug. */
+        get: operations["GetBrand"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/cart": {
         parameters: {
             query?: never;
@@ -325,7 +359,7 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Ids, slugs, URLs and lastmod for sitemap.xml and selective revalidation. type=product|collection, ?since= is inclusive. */
+        /** Ids, slugs, URLs and lastmod for sitemap.xml and selective revalidation. type=product|collection|brand, ?since= is inclusive. */
         get: operations["GetSitemap"];
         put?: never;
         post?: never;
@@ -368,9 +402,50 @@ export interface components {
             valueKeys: string[] | null;
             values: string[] | null;
         };
+        BrandDetailDto: {
+            alternateUrls: {
+                [key: string]: string;
+            };
+            description: null | components["schemas"]["DescriptionDto"];
+            facet: null | components["schemas"]["FacetLinkDto"];
+            id: string;
+            logo: null | components["schemas"]["MediaDescriptorDto"];
+            name: string;
+            /** Format: int64 */
+            productCount: number | string;
+            redirectTo: null | string;
+            responsible: components["schemas"]["ResponsibleDto"];
+            slug: string;
+            /** Format: date-time */
+            updatedAt: string;
+            url: string;
+            websiteUrl: null | string;
+        };
         BrandDto: {
             facet: null | components["schemas"]["FacetLinkDto"];
+            id?: null | string;
             label: string;
+            logo?: null | components["schemas"]["MediaDescriptorDto"];
+            slug?: null | string;
+            url?: null | string;
+        };
+        BrandListItemDto: {
+            id: string;
+            logo: null | components["schemas"]["MediaDescriptorDto"];
+            name: string;
+            /** Format: int64 */
+            productCount: number | string;
+            slug: string;
+            url: string;
+        };
+        BrandPageDto: {
+            items: components["schemas"]["BrandListItemDto"][];
+            /** Format: int32 */
+            page: number | string;
+            /** Format: int32 */
+            pageSize: number | string;
+            /** Format: int64 */
+            total: number | string;
         };
         BundleComponentDto: {
             product: components["schemas"]["ProductCardDto"];
@@ -731,6 +806,18 @@ export interface components {
             gross: string;
             vat: components["schemas"]["VatAmountDto"][];
         };
+        PartyDto: {
+            city: null | string;
+            countryCode: string;
+            email: null | string;
+            legalName: string;
+            name: string;
+            phone: null | string;
+            postalCode: null | string;
+            region: null | string;
+            street: null | string;
+            url: null | string;
+        };
         PriceDto: {
             amount: string;
             compareAt: null | string;
@@ -773,6 +860,7 @@ export interface components {
             options: components["schemas"]["OptionDto"][];
             redirectTo: null | string;
             related: components["schemas"]["RelatedGroupDto"][];
+            responsible: components["schemas"]["ResponsibleDto"];
             seo: components["schemas"]["SeoDto"];
             shortDescription: null | string;
             sku: string;
@@ -802,6 +890,11 @@ export interface components {
             label: string;
             products: components["schemas"]["ProductCardDto"][];
         };
+        ResponsibleDto: {
+            euResponsiblePerson: null | components["schemas"]["PartyDto"];
+            importer: null | components["schemas"]["PartyDto"];
+            manufacturer: null | components["schemas"]["PartyDto"];
+        };
         SeoDto: {
             description: null | string;
             title: string;
@@ -909,12 +1002,14 @@ export interface components {
             product: string;
         };
         VariantDto: {
+            brand: null | components["schemas"]["BrandDto"];
             hasOwnImages: boolean;
             id: string;
             image: null | components["schemas"]["MediaDescriptorDto"];
             images: components["schemas"]["MediaDescriptorDto"][];
             inStock: boolean;
             price: null | components["schemas"]["PriceDto"];
+            responsible: components["schemas"]["ResponsibleDto"];
             selectedOptions: {
                 [key: string]: string;
             };
@@ -958,6 +1053,175 @@ export interface components {
 }
 export type $defs = Record<string, never>;
 export interface operations {
+    ListBrands: {
+        parameters: {
+            query?: {
+                /** @description 1-based page. page × pageSize must not exceed 10000 (default pageSize 100, max 1000). */
+                page?: number;
+                /** @description Items per page, 1–1000. Out of range is a 400 with code INVALID_PAGE. */
+                pageSize?: number;
+            };
+            header: {
+                /** @description Publishable, preview or secret site key. Required on every request; secret keys are server-side only. */
+                "X-Site-Key": string;
+                /** @description Market code (e.g. "se"). Omit for the site's default market. */
+                "X-Market"?: string;
+                /** @description BCP-47 language tag. Omit to use the market's language. */
+                "Accept-Language"?: string;
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["BrandPageDto"];
+                };
+            };
+            /** @description problem+json. MARKET_UNKNOWN (no such market on this site) or INVALID_PAGE. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+            /** @description problem+json. SITE_KEY_MISSING or SITE_KEY_INVALID. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+            /** @description problem+json. SECRET_KEY_FROM_BROWSER: a secret key was sent from a browser. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+            /** @description problem+json. SITE_INACTIVE, or NOT_FOUND for an unrouted path. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+            /** @description problem+json. RATE_LIMITED; retryAfterSeconds and the Retry-After header say how long to wait. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+            /** @description problem+json. SITE_REGISTRY_WARMING or INDEX_UNAVAILABLE — retry, the request was not wrong. */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+        };
+    };
+    GetBrand: {
+        parameters: {
+            query?: never;
+            header: {
+                /** @description Publishable, preview or secret site key. Required on every request; secret keys are server-side only. */
+                "X-Site-Key": string;
+                /** @description Market code (e.g. "se"). Omit for the site's default market. */
+                "X-Market"?: string;
+                /** @description BCP-47 language tag. Omit to use the market's language. */
+                "Accept-Language"?: string;
+            };
+            path: {
+                slugOrId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["BrandDetailDto"];
+                };
+            };
+            /** @description problem+json. MARKET_UNKNOWN (no such market on this site) or INVALID_PAGE. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+            /** @description problem+json. SITE_KEY_MISSING or SITE_KEY_INVALID. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+            /** @description problem+json. SECRET_KEY_FROM_BROWSER: a secret key was sent from a browser. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+            /** @description problem+json. BRAND_NOT_FOUND, or SITE_INACTIVE when the site itself is not live. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+            /** @description problem+json. RATE_LIMITED; retryAfterSeconds and the Retry-After header say how long to wait. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+            /** @description problem+json. SITE_REGISTRY_WARMING or INDEX_UNAVAILABLE — retry, the request was not wrong. */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["StorefrontProblem"];
+                };
+            };
+        };
+    };
     GetCart: {
         parameters: {
             query?: never;