@adobe/aio-commerce-lib-webhooks 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# @adobe/aio-commerce-lib-webhooks
+
+## 0.1.0
+
+### Minor Changes
+
+- [#273](https://github.com/adobe/aio-commerce-sdk/pull/273) [`660cf05`](https://github.com/adobe/aio-commerce-sdk/commit/660cf058d2439de82b3e22376c3d494b2a83045f) Thanks [@oshmyheliuk](https://github.com/oshmyheliuk)! - Added a new package to manage Commerce webhooks.
+  This package provides utilities to manage webhooks in Adobe Commerce such as subscribing, unsubscribing, and listing webhooks.
+
+### Patch Changes
+
+- [#186](https://github.com/adobe/aio-commerce-sdk/pull/186) [`cb9c11d`](https://github.com/adobe/aio-commerce-sdk/commit/cb9c11dfd243d3034763374fe5416645015b46a9) Thanks [@obarcelonap](https://github.com/obarcelonap)! - Provide type-safe helpers for Adobe Commerce webhook operations
+
+- Updated dependencies []:
+  - @adobe/aio-commerce-lib-api@1.0.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Adobe
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,20 @@
+# `@adobe/aio-commerce-lib-webhooks`
+
+> [!WARNING]
+> This package is a work in progress and is not yet ready for use. You may be able to install it, but if you do, expect breaking changes.
+
+This package provides an interface to interact with the Adobe Commerce Webhooks API.
+
+## Installation
+
+```shell
+pnpm add @adobe/aio-commerce-lib-webhooks
+```
+
+## Usage
+
+See the [Usage Guide](./docs/usage.md) for more information.
+
+## Contributing
+
+This package is part of the Adobe Commerce SDK monorepo. See the [Contributing Guide](https://github.com/adobe/aio-commerce-sdk/blob/main/.github/CONTRIBUTING.md) and [Development Guide](https://github.com/adobe/aio-commerce-sdk/blob/main/.github/DEVELOPMENT.md) for development setup and guidelines.

package/dist/cjs/api/index.cjs

@@ -0,0 +1,201 @@
+/**
+ * @license
+ *
+ * Copyright 2026 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+//#region \0rolldown/runtime.js
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") {
+		for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+			key = keys[i];
+			if (!__hasOwnProp.call(to, key) && key !== except) {
+				__defProp(to, key, {
+					get: ((k) => from[k]).bind(null, key),
+					enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+				});
+			}
+		}
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+
+//#endregion
+let _adobe_aio_commerce_lib_api = require("@adobe/aio-commerce-lib-api");
+let valibot = require("valibot");
+valibot = __toESM(valibot);
+
+//#region source/api/webhooks/schema.ts
+function nonEmptyString(fieldName) {
+	return valibot.pipe(valibot.string(`Expected a string for ${fieldName}`), valibot.nonEmpty(`${fieldName} must not be empty`));
+}
+function optionalString(fieldName) {
+	return valibot.optional(valibot.string(`Expected a string for ${fieldName}`));
+}
+/** Schema for a webhook field mapping ({ name, source? }). */
+const WebhookFieldSchema = valibot.object({
+	name: nonEmptyString("field name"),
+	source: optionalString("field source")
+});
+/** Schema for a conditional webhook rule ({ field, operator, value }). */
+const WebhookRuleSchema = valibot.object({
+	field: nonEmptyString("rule field"),
+	operator: nonEmptyString("rule operator"),
+	value: valibot.string("Expected a string for rule value")
+});
+/** Schema for a custom HTTP header ({ name, value }). */
+const WebhookHeaderSchema = valibot.object({
+	name: nonEmptyString("header name"),
+	value: nonEmptyString("header value")
+});
+/** Schema for Developer Console OAuth credentials. */
+const DeveloperConsoleOAuthSchema = valibot.object({
+	client_id: nonEmptyString("client_id"),
+	client_secret: nonEmptyString("client_secret"),
+	org_id: nonEmptyString("org_id"),
+	environment: optionalString("environment")
+});
+/**
+* Schema for the webhook payload sent to POST /webhooks/subscribe.
+* Matches the `webhook` property of the request body.
+* Required fields per the Commerce API: webhook_method, webhook_type, batch_name, hook_name, url.
+*/
+const WebhookSubscribeParamsSchema = valibot.object({
+	webhook_method: nonEmptyString("webhook_method"),
+	webhook_type: nonEmptyString("webhook_type"),
+	batch_name: nonEmptyString("batch_name"),
+	batch_order: valibot.optional(valibot.number()),
+	hook_name: nonEmptyString("hook_name"),
+	url: nonEmptyString("url"),
+	priority: valibot.optional(valibot.number()),
+	required: valibot.optional(valibot.boolean()),
+	soft_timeout: valibot.optional(valibot.number()),
+	timeout: valibot.optional(valibot.number()),
+	method: optionalString("method"),
+	fallback_error_message: optionalString("fallback_error_message"),
+	ttl: valibot.optional(valibot.number()),
+	fields: valibot.optional(valibot.array(WebhookFieldSchema, "Expected an array of field objects")),
+	rules: valibot.optional(valibot.array(WebhookRuleSchema, "Expected an array of rule objects")),
+	headers: valibot.optional(valibot.array(WebhookHeaderSchema, "Expected an array of header objects")),
+	developer_console_oauth: valibot.optional(DeveloperConsoleOAuthSchema)
+});
+/**
+* Schema for the parameters sent to POST /webhooks/unsubscribe.
+* Required: webhook_method, webhook_type, batch_name, hook_name.
+*/
+const WebhookUnsubscribeParamsSchema = valibot.object({
+	webhook_method: nonEmptyString("webhook_method"),
+	webhook_type: nonEmptyString("webhook_type"),
+	batch_name: nonEmptyString("batch_name"),
+	hook_name: nonEmptyString("hook_name")
+});
+
+//#endregion
+//#region source/api/webhooks/endpoints.ts
+/**
+* Returns a list of all subscribed webhooks in the Commerce instance.
+* @see https://developer.adobe.com/commerce/extensibility/webhooks/api/#get-a-list-of-all-subscribed-webhooks
+*
+* @param httpClient - The {@link AdobeCommerceHttpClient} to use to make the request.
+* @param fetchOptions - The {@link Options} to use to make the request.
+*/
+function getWebhookList(httpClient, fetchOptions) {
+	return httpClient.get("webhooks/list", fetchOptions).json();
+}
+/**
+* Subscribes a webhook in the Commerce instance.
+* @see https://developer.adobe.com/commerce/extensibility/webhooks/api/#subscribe-a-webhook
+*
+* @param httpClient - The {@link AdobeCommerceHttpClient} to use to make the request.
+* @param params - The webhook payload (webhook_method, webhook_type, batch_name, hook_name, url, etc.).
+* @param fetchOptions - The {@link Options} to use to make the request.
+*
+* @throws A {@link CommerceSdkValidationError} If the parameters are in the wrong format.
+* @throws An {@link HTTPError} If the status code is not 2XX.
+*/
+function subscribeWebhook(httpClient, params, fetchOptions) {
+	const validatedParams = valibot.parse(WebhookSubscribeParamsSchema, params);
+	return httpClient.post("webhooks/subscribe", {
+		...fetchOptions,
+		json: { webhook: validatedParams }
+	}).json();
+}
+/**
+* Unsubscribes a webhook from the Commerce instance.
+* @see https://developer.adobe.com/commerce/extensibility/webhooks/api/#unsubscribe-a-webhook
+*
+* @param httpClient - The {@link AdobeCommerceHttpClient} to use to make the request.
+* @param params - The webhook identifiers (webhook_method, webhook_type, batch_name, hook_name).
+* @param fetchOptions - The {@link Options} to use to make the request.
+*
+* @throws A {@link CommerceSdkValidationError} If the parameters are in the wrong format.
+* @throws An {@link HTTPError} If the status code is not 2XX.
+*/
+function unsubscribeWebhook(httpClient, params, fetchOptions) {
+	const validatedParams = valibot.parse(WebhookUnsubscribeParamsSchema, params);
+	return httpClient.post("webhooks/unsubscribe", {
+		...fetchOptions,
+		json: { webhook: validatedParams }
+	}).json();
+}
+/**
+* Returns the list of webhooks supported in Adobe Commerce as a Cloud Service (SaaS only).
+* @see https://developer.adobe.com/commerce/extensibility/webhooks/api/#get-supported-webhooks-for-saas
+*
+* @param httpClient - The {@link AdobeCommerceHttpClient} to use to make the request.
+* @param fetchOptions - The {@link Options} to use to make the request.
+*/
+function getSupportedWebhookList(httpClient, fetchOptions) {
+	return httpClient.get("webhooks/supportedList", fetchOptions).json();
+}
+
+//#endregion
+//#region source/lib/api-client.ts
+/**
+* Creates a new API client for the Commerce Webhooks API.
+* @param params - The parameters to build the Commerce HTTP client.
+*/
+function createCommerceWebhooksApiClient(params) {
+	return _adobe_aio_commerce_lib_api.ApiClient.create(new _adobe_aio_commerce_lib_api.AdobeCommerceHttpClient(params), {
+		getWebhookList,
+		subscribeWebhook,
+		unsubscribeWebhook,
+		getSupportedWebhookList
+	});
+}
+/**
+* Creates a customized Commerce Webhooks API client with a user-specified set of endpoint functions.
+* @param params - The parameters to build the Commerce HTTP client.
+* @param functions - The API functions to include in the client.
+*/
+function createCustomCommerceWebhooksApiClient(params, functions) {
+	return _adobe_aio_commerce_lib_api.ApiClient.create(new _adobe_aio_commerce_lib_api.AdobeCommerceHttpClient(params), functions);
+}
+
+//#endregion
+exports.__toESM = __toESM;
+exports.createCommerceWebhooksApiClient = createCommerceWebhooksApiClient;
+exports.createCustomCommerceWebhooksApiClient = createCustomCommerceWebhooksApiClient;
+exports.getSupportedWebhookList = getSupportedWebhookList;
+exports.getWebhookList = getWebhookList;
+exports.subscribeWebhook = subscribeWebhook;
+exports.unsubscribeWebhook = unsubscribeWebhook;

package/dist/cjs/api/index.d.cts

@@ -0,0 +1,199 @@
+/**
+ * @license
+ *
+ * Copyright 2026 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import * as _adobe_aio_commerce_lib_api0 from "@adobe/aio-commerce-lib-api";
+import { AdobeCommerceHttpClient, ApiFunction, CommerceHttpClientParams } from "@adobe/aio-commerce-lib-api";
+import { Options } from "ky";
+import * as v from "valibot";
+
+//#region source/api/webhooks/schema.d.ts
+/**
+ * Schema for the webhook payload sent to POST /webhooks/subscribe.
+ * Matches the `webhook` property of the request body.
+ * Required fields per the Commerce API: webhook_method, webhook_type, batch_name, hook_name, url.
+ */
+declare const WebhookSubscribeParamsSchema: v.ObjectSchema<{
+  readonly webhook_method: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+  readonly webhook_type: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+  readonly batch_name: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+  readonly batch_order: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
+  readonly hook_name: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+  readonly url: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+  readonly priority: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
+  readonly required: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
+  readonly soft_timeout: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
+  readonly timeout: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
+  readonly method: v.OptionalSchema<v.StringSchema<`Expected a string for ${string}`>, undefined>;
+  readonly fallback_error_message: v.OptionalSchema<v.StringSchema<`Expected a string for ${string}`>, undefined>;
+  readonly ttl: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
+  readonly fields: v.OptionalSchema<v.ArraySchema<v.ObjectSchema<{
+    readonly name: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+    readonly source: v.OptionalSchema<v.StringSchema<`Expected a string for ${string}`>, undefined>;
+  }, undefined>, "Expected an array of field objects">, undefined>;
+  readonly rules: v.OptionalSchema<v.ArraySchema<v.ObjectSchema<{
+    readonly field: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+    readonly operator: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+    readonly value: v.StringSchema<"Expected a string for rule value">;
+  }, undefined>, "Expected an array of rule objects">, undefined>;
+  readonly headers: v.OptionalSchema<v.ArraySchema<v.ObjectSchema<{
+    readonly name: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+    readonly value: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+  }, undefined>, "Expected an array of header objects">, undefined>;
+  readonly developer_console_oauth: v.OptionalSchema<v.ObjectSchema<{
+    readonly client_id: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+    readonly client_secret: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+    readonly org_id: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+    readonly environment: v.OptionalSchema<v.StringSchema<`Expected a string for ${string}`>, undefined>;
+  }, undefined>, undefined>;
+}, undefined>;
+/**
+ * Schema for the parameters sent to POST /webhooks/unsubscribe.
+ * Required: webhook_method, webhook_type, batch_name, hook_name.
+ */
+declare const WebhookUnsubscribeParamsSchema: v.ObjectSchema<{
+  readonly webhook_method: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+  readonly webhook_type: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+  readonly batch_name: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+  readonly hook_name: v.SchemaWithPipe<readonly [v.StringSchema<`Expected a string for ${string}`>, v.NonEmptyAction<string, `${string} must not be empty`>]>;
+}, undefined>;
+/**
+ * The parameters for POST /webhooks/subscribe.
+ * @see https://developer.adobe.com/commerce/extensibility/webhooks/api/#subscribe-a-webhook
+ */
+type WebhookSubscribeParams = v.InferInput<typeof WebhookSubscribeParamsSchema>;
+/**
+ * The parameters for POST /webhooks/unsubscribe.
+ * @see https://developer.adobe.com/commerce/extensibility/webhooks/api/#unsubscribe-a-webhook
+ */
+type WebhookUnsubscribeParams = v.InferInput<typeof WebhookUnsubscribeParamsSchema>;
+//#endregion
+//#region source/api/webhooks/types.d.ts
+/** A field mapping in a Commerce webhook subscription. */
+type CommerceWebhookField = {
+  name: string;
+  source?: string;
+};
+/** A conditional rule in a Commerce webhook subscription. */
+type CommerceWebhookRule = {
+  field: string;
+  operator: string;
+  value: string;
+};
+/** A custom HTTP header in a Commerce webhook subscription. */
+type CommerceWebhookHeader = {
+  name: string;
+  value: string;
+};
+/** Developer Console OAuth credentials attached to a webhook. */
+type CommerceWebhookDeveloperConsoleOAuth = {
+  client_id: string;
+  client_secret: string;
+  org_id: string;
+  environment?: string;
+};
+/** A single Commerce webhook subscription as returned by GET /webhooks/list. */
+type CommerceWebhook = {
+  webhook_method: string;
+  webhook_type: string;
+  batch_name: string;
+  batch_order?: number;
+  hook_name: string;
+  url: string;
+  priority?: number;
+  required?: boolean;
+  soft_timeout?: number;
+  timeout?: number;
+  method?: string;
+  fallback_error_message?: string;
+  ttl?: number;
+  fields?: CommerceWebhookField[];
+  rules?: CommerceWebhookRule[];
+  headers?: CommerceWebhookHeader[];
+  developer_console_oauth?: CommerceWebhookDeveloperConsoleOAuth;
+};
+/** The response type for GET /webhooks/list. */
+type CommerceWebhookManyResponse = CommerceWebhook[];
+/** A single entry from GET /webhooks/supportedList (SaaS only). */
+type CommerceSupportedWebhook = {
+  name: string;
+};
+/** The response type for GET /webhooks/supportedList. */
+type CommerceSupportedWebhookManyResponse = CommerceSupportedWebhook[];
+//#endregion
+//#region source/api/webhooks/endpoints.d.ts
+/**
+ * Returns a list of all subscribed webhooks in the Commerce instance.
+ * @see https://developer.adobe.com/commerce/extensibility/webhooks/api/#get-a-list-of-all-subscribed-webhooks
+ *
+ * @param httpClient - The {@link AdobeCommerceHttpClient} to use to make the request.
+ * @param fetchOptions - The {@link Options} to use to make the request.
+ */
+declare function getWebhookList(httpClient: AdobeCommerceHttpClient, fetchOptions?: Options): Promise<CommerceWebhookManyResponse>;
+/**
+ * Subscribes a webhook in the Commerce instance.
+ * @see https://developer.adobe.com/commerce/extensibility/webhooks/api/#subscribe-a-webhook
+ *
+ * @param httpClient - The {@link AdobeCommerceHttpClient} to use to make the request.
+ * @param params - The webhook payload (webhook_method, webhook_type, batch_name, hook_name, url, etc.).
+ * @param fetchOptions - The {@link Options} to use to make the request.
+ *
+ * @throws A {@link CommerceSdkValidationError} If the parameters are in the wrong format.
+ * @throws An {@link HTTPError} If the status code is not 2XX.
+ */
+declare function subscribeWebhook(httpClient: AdobeCommerceHttpClient, params: WebhookSubscribeParams, fetchOptions?: Options): Promise<void>;
+/**
+ * Unsubscribes a webhook from the Commerce instance.
+ * @see https://developer.adobe.com/commerce/extensibility/webhooks/api/#unsubscribe-a-webhook
+ *
+ * @param httpClient - The {@link AdobeCommerceHttpClient} to use to make the request.
+ * @param params - The webhook identifiers (webhook_method, webhook_type, batch_name, hook_name).
+ * @param fetchOptions - The {@link Options} to use to make the request.
+ *
+ * @throws A {@link CommerceSdkValidationError} If the parameters are in the wrong format.
+ * @throws An {@link HTTPError} If the status code is not 2XX.
+ */
+declare function unsubscribeWebhook(httpClient: AdobeCommerceHttpClient, params: WebhookUnsubscribeParams, fetchOptions?: Options): Promise<void>;
+/**
+ * Returns the list of webhooks supported in Adobe Commerce as a Cloud Service (SaaS only).
+ * @see https://developer.adobe.com/commerce/extensibility/webhooks/api/#get-supported-webhooks-for-saas
+ *
+ * @param httpClient - The {@link AdobeCommerceHttpClient} to use to make the request.
+ * @param fetchOptions - The {@link Options} to use to make the request.
+ */
+declare function getSupportedWebhookList(httpClient: AdobeCommerceHttpClient, fetchOptions?: Options): Promise<CommerceSupportedWebhookManyResponse>;
+//#endregion
+//#region source/lib/api-client.d.ts
+/**
+ * Creates a new API client for the Commerce Webhooks API.
+ * @param params - The parameters to build the Commerce HTTP client.
+ */
+declare function createCommerceWebhooksApiClient(params: CommerceHttpClientParams): _adobe_aio_commerce_lib_api0.ApiClientRecord<AdobeCommerceHttpClient, {
+  getWebhookList: typeof getWebhookList;
+  subscribeWebhook: typeof subscribeWebhook;
+  unsubscribeWebhook: typeof unsubscribeWebhook;
+  getSupportedWebhookList: typeof getSupportedWebhookList;
+}>;
+/**
+ * An API client for the Commerce Webhooks API.
+ * @see {@link createCommerceWebhooksApiClient}
+ */
+type CommerceWebhooksApiClient = ReturnType<typeof createCommerceWebhooksApiClient>;
+/**
+ * Creates a customized Commerce Webhooks API client with a user-specified set of endpoint functions.
+ * @param params - The parameters to build the Commerce HTTP client.
+ * @param functions - The API functions to include in the client.
+ */
+declare function createCustomCommerceWebhooksApiClient<TFunctions extends Record<string, ApiFunction<AdobeCommerceHttpClient, any[], any>>>(params: CommerceHttpClientParams, functions: TFunctions): _adobe_aio_commerce_lib_api0.ApiClientRecord<AdobeCommerceHttpClient, TFunctions>;
+//#endregion
+export { type CommerceSupportedWebhook, type CommerceSupportedWebhookManyResponse, type CommerceWebhook, type CommerceWebhookDeveloperConsoleOAuth, type CommerceWebhookField, type CommerceWebhookHeader, type CommerceWebhookManyResponse, type CommerceWebhookRule, type CommerceWebhooksApiClient, type WebhookSubscribeParams, type WebhookUnsubscribeParams, createCommerceWebhooksApiClient, createCustomCommerceWebhooksApiClient, getSupportedWebhookList, getWebhookList, subscribeWebhook, unsubscribeWebhook };