/** * This file was auto-generated by openapi-typescript and ts-morph. * Do not make direct changes to the file. */ export interface paths { readonly "/consent": { readonly parameters: { readonly query?: never; readonly header: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: components["parameters"]["Accept"]; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly "Content-Type": components["parameters"]["ContentType"]; }; readonly path?: never; readonly cookie?: never; }; /** * Set Cookie Consent Preferences * @description Sets the status of a customer's consent to allow data collection by cookies and scripts according to the following consent categories: * * 1. Analytics — These cookies provide statistical information on site usage so the store owner can improve the website over time. * 2. Functional — These cookies enable enhanced functionality, such as videos and live chat. If a shopper does not allow these, then some or all of these functions may not work properly. * 3. Targeting; Advertising — These cookies allow merchants to create profiles or personalize content to enhance users' shopping experience. * * * This endpoint only works if the cookie consent feature is enabled. It is assumed the shopper has not consented to anything until a value is explicitly set. The request body must be populated with a complete set of allowed and denied categories. * * Once set, consent preferences will be saved as a cookie for guest shoppers. Consent preferences will be persisted to a shopper's account to be used for future sessions once they have logged in. Consent preferences can also be managed using the [Update customer consent](/docs/rest-management/customers/customer-consent#update-customer-consent) endpoint. * * > #### Note * > * Substitute your storefront domain for `yourstore.example.com`. * */ readonly post: operations["postCookieConsent"]; }; } export type webhooks = Record; export interface components { schemas: { /** * ConsentPreferences * @description List of allowed and denied consent categories. Must be populated with a complete set of allowed and denied categories. * * Configurable categories are: * * 1 - Analytics * 2 - Functional * 3 - Targeting; Advertising * * For further definition of these categories, see [Scripts API](/docs/integrations/scripts). */ readonly ConsentPreferences: { /** @description Explicitly allowed consent categories. Allowed values are 1, 2, 3. */ readonly allow: readonly (1 | 2 | 3)[]; /** @description Denied consent categories. Allowed values are 2, 3, 4. */ readonly deny: readonly (1 | 2 | 3)[]; }; }; responses: never; parameters: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept: string; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly ContentType: string; }; requestBodies: never; headers: never; pathItems: never; } export type $defs = Record; export interface operations { readonly postCookieConsent: { readonly parameters: { readonly query?: never; readonly header?: { /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. */ readonly Accept?: components["parameters"]["Accept"]; /** @description The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. */ readonly "Content-Type"?: components["parameters"]["ContentType"]; }; readonly path?: never; readonly cookie?: never; }; /** @description Data sent to the [Update customer consent](/docs/rest-management/customers/customer-consent#update-customer-consent) endpoint when creating a customer during checkout. */ readonly requestBody: { readonly content: { readonly "application/json": components["schemas"]["ConsentPreferences"]; }; }; readonly responses: { /** @description Consent Settings Saved */ readonly 200: { headers: { readonly [name: string]: unknown; }; content?: never; }; /** @description Invalid input */ readonly 400: { headers: { readonly [name: string]: unknown; }; content?: never; }; }; }; }