@wix/auto_sdk_seo_robots-txt 1.0.0

package/build/cjs/index.d.ts

@@ -0,0 +1,30 @@
+import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { GetRobotsTxtOptions, GetRobotsTxtResponse, UpdateRobotsTxtOptions, UpdateRobotsTxtResponse, RobotsTxtUpdatedEnvelope } from './index.typings.js';
+export { ActionEvent, BaseEventMetadata, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, GetRobotsTxtRequest, IdentificationData, IdentificationDataIdOneOf, MessageEnvelope, RestoreInfo, RobotsTxt, UpdateRobotsTxtRequest, WebhookIdentityType } from './index.typings.js';
+
+declare function getRobotsTxt$1(httpClient: HttpClient): GetRobotsTxtSignature;
+interface GetRobotsTxtSignature {
+    /**
+     * Get the Robots.txt file content.
+     * Returns the content and whether it's the default.
+     * @returns The response of the Robots.txt file request
+     */
+    (options?: GetRobotsTxtOptions | undefined): Promise<GetRobotsTxtResponse>;
+}
+declare function updateRobotsTxt$1(httpClient: HttpClient): UpdateRobotsTxtSignature;
+interface UpdateRobotsTxtSignature {
+    /**
+     * Update the Robots.txt file content.
+     * You may set an empty string as the file content.
+     * In order to reset the content to Wix's default, send `default: true`.
+     */
+    (options?: UpdateRobotsTxtOptions | undefined): Promise<UpdateRobotsTxtResponse>;
+}
+declare const onRobotsTxtUpdated$1: EventDefinition<RobotsTxtUpdatedEnvelope, "wix.promote.seo.robots_txt_updated">;
+
+declare const getRobotsTxt: MaybeContext<BuildRESTFunction<typeof getRobotsTxt$1> & typeof getRobotsTxt$1>;
+declare const updateRobotsTxt: MaybeContext<BuildRESTFunction<typeof updateRobotsTxt$1> & typeof updateRobotsTxt$1>;
+/** */
+declare const onRobotsTxtUpdated: BuildEventDefinition<typeof onRobotsTxtUpdated$1>;
+
+export { GetRobotsTxtOptions, GetRobotsTxtResponse, RobotsTxtUpdatedEnvelope, UpdateRobotsTxtOptions, UpdateRobotsTxtResponse, getRobotsTxt, onRobotsTxtUpdated, updateRobotsTxt };

package/build/cjs/index.js

@@ -0,0 +1,279 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// index.ts
+var index_exports = {};
+__export(index_exports, {
+  WebhookIdentityType: () => WebhookIdentityType,
+  getRobotsTxt: () => getRobotsTxt4,
+  onRobotsTxtUpdated: () => onRobotsTxtUpdated2,
+  updateRobotsTxt: () => updateRobotsTxt4
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/promote-seo-v2-robots-txt-robots-txt.public.ts
+var import_rename_all_nested_keys2 = require("@wix/sdk-runtime/rename-all-nested-keys");
+var import_timestamp = require("@wix/sdk-runtime/transformations/timestamp");
+var import_transform_paths = require("@wix/sdk-runtime/transformations/transform-paths");
+var import_sdk_types = require("@wix/sdk-types");
+
+// src/promote-seo-v2-robots-txt-robots-txt.universal.ts
+var import_transform_error = require("@wix/sdk-runtime/transform-error");
+var import_rename_all_nested_keys = require("@wix/sdk-runtime/rename-all-nested-keys");
+
+// src/promote-seo-v2-robots-txt-robots-txt.http.ts
+var import_rest_modules = require("@wix/sdk-runtime/rest-modules");
+var import_rest_modules2 = require("@wix/sdk-runtime/rest-modules");
+function resolveComWixpressPromoteSeoRobotsServerV2RobotsServiceV2Url(opts) {
+  const domainToMappings = {
+    "www._base_domain_": [
+      {
+        srcPath: "/_api/promote-seo-robots-server",
+        destPath: "/api"
+      },
+      {
+        srcPath: "/_api/promote-seo-robots-server/v2/robots",
+        destPath: "/v2/robots"
+      },
+      {
+        srcPath: "/_api/promote-seo-robots-server/v2/ads",
+        destPath: "/v2/ads"
+      },
+      {
+        srcPath: "/_api/promote-seo-robots-server/v2/llms",
+        destPath: "/v2/llms"
+      }
+    ],
+    "api._api_base_domain_": [
+      {
+        srcPath: "/promote-seo-robots-server",
+        destPath: ""
+      }
+    ],
+    "manage._base_domain_": [
+      {
+        srcPath: "/_api/promote-seo-robots-server",
+        destPath: "/api"
+      },
+      {
+        srcPath: "/_api/promote-seo-robots-server/v2/robots",
+        destPath: "/v2/robots"
+      },
+      {
+        srcPath: "/_api/promote-seo-robots-server/v2/ads",
+        destPath: "/v2/ads"
+      },
+      {
+        srcPath: "/_api/promote-seo-robots-server/v2/llms",
+        destPath: "/v2/llms"
+      }
+    ],
+    "www.wixapis.com": [
+      {
+        srcPath: "/promote-seo-robots-server/v2/robots",
+        destPath: "/v2/robots"
+      },
+      {
+        srcPath: "/promote-seo-robots-server/v2/ads",
+        destPath: "/v2/ads"
+      },
+      {
+        srcPath: "/promote-seo-txt-file-server/v2/ads",
+        destPath: "/v2/ads"
+      },
+      {
+        srcPath: "/promote-seo-txt-file-server/v2/robots",
+        destPath: "/v2/robots"
+      },
+      {
+        srcPath: "/promote-seo-robots-server/v2/llms",
+        destPath: "/v2/llms"
+      }
+    ],
+    "*.dev.wix-code.com": [
+      {
+        srcPath: "/promote/marketing/v2/ads",
+        destPath: "/v2/ads"
+      },
+      {
+        srcPath: "/promote/seo/v2/llms",
+        destPath: "/v2/llms"
+      },
+      {
+        srcPath: "/promote/seo/v2/robots",
+        destPath: "/v2/robots"
+      }
+    ],
+    _: [
+      {
+        srcPath: "/promote/marketing/v2/ads",
+        destPath: "/v2/ads"
+      },
+      {
+        srcPath: "/promote/seo/v2/llms",
+        destPath: "/v2/llms"
+      },
+      {
+        srcPath: "/promote/seo/v2/robots",
+        destPath: "/v2/robots"
+      }
+    ]
+  };
+  return (0, import_rest_modules2.resolveUrl)(Object.assign(opts, { domainToMappings }));
+}
+var PACKAGE_NAME = "@wix/auto_sdk_seo_robots-txt";
+function getRobotsTxt(payload) {
+  function __getRobotsTxt({ host }) {
+    const metadata = {
+      entityFqdn: "wix.promote.seo.v2.robots_txt",
+      method: "GET",
+      methodFqn: "com.wixpress.promote.seo.robots.server.v2.RobotsServiceV2.GetRobotsTxt",
+      packageName: PACKAGE_NAME,
+      url: resolveComWixpressPromoteSeoRobotsServerV2RobotsServiceV2Url({
+        protoPath: "/v2/robots",
+        data: payload,
+        host
+      }),
+      params: (0, import_rest_modules.toURLSearchParams)(payload)
+    };
+    return metadata;
+  }
+  return __getRobotsTxt;
+}
+function updateRobotsTxt(payload) {
+  function __updateRobotsTxt({ host }) {
+    const metadata = {
+      entityFqdn: "wix.promote.seo.v2.robots_txt",
+      method: "PUT",
+      methodFqn: "com.wixpress.promote.seo.robots.server.v2.RobotsServiceV2.UpdateRobotsTxt",
+      packageName: PACKAGE_NAME,
+      url: resolveComWixpressPromoteSeoRobotsServerV2RobotsServiceV2Url({
+        protoPath: "/v2/robots",
+        data: payload,
+        host
+      }),
+      data: payload
+    };
+    return metadata;
+  }
+  return __updateRobotsTxt;
+}
+
+// src/promote-seo-v2-robots-txt-robots-txt.universal.ts
+var WebhookIdentityType = /* @__PURE__ */ ((WebhookIdentityType2) => {
+  WebhookIdentityType2["UNKNOWN"] = "UNKNOWN";
+  WebhookIdentityType2["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+  WebhookIdentityType2["MEMBER"] = "MEMBER";
+  WebhookIdentityType2["WIX_USER"] = "WIX_USER";
+  WebhookIdentityType2["APP"] = "APP";
+  return WebhookIdentityType2;
+})(WebhookIdentityType || {});
+async function getRobotsTxt2(options) {
+  const { httpClient, sideEffects } = arguments[1];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+    subdomain: options?.subdomain
+  });
+  const reqOpts = getRobotsTxt(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: { subdomain: "$[0].subdomain" },
+        singleArgumentUnchanged: false
+      },
+      ["options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+async function updateRobotsTxt2(options) {
+  const { httpClient, sideEffects } = arguments[1];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+    robotsTxt: options?.robotsTxt
+  });
+  const reqOpts = updateRobotsTxt(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: { robotsTxt: "$[0].robotsTxt" },
+        singleArgumentUnchanged: false
+      },
+      ["options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+
+// src/promote-seo-v2-robots-txt-robots-txt.public.ts
+function getRobotsTxt3(httpClient) {
+  return (options) => getRobotsTxt2(
+    options,
+    // @ts-ignore
+    { httpClient }
+  );
+}
+function updateRobotsTxt3(httpClient) {
+  return (options) => updateRobotsTxt2(
+    options,
+    // @ts-ignore
+    { httpClient }
+  );
+}
+var onRobotsTxtUpdated = (0, import_sdk_types.EventDefinition)(
+  "wix.promote.seo.robots_txt_updated",
+  true,
+  (event) => (0, import_rename_all_nested_keys2.renameKeysFromRESTResponseToSDKResponse)(
+    (0, import_transform_paths.transformPaths)(event, [
+      {
+        transformFn: import_timestamp.transformRESTTimestampToSDKTimestamp,
+        paths: [{ path: "metadata.eventTime" }]
+      }
+    ])
+  )
+)();
+
+// src/promote-seo-v2-robots-txt-robots-txt.context.ts
+var import_rest_modules3 = require("@wix/sdk-runtime/rest-modules");
+var import_event_definition_modules = require("@wix/sdk-runtime/event-definition-modules");
+var getRobotsTxt4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(getRobotsTxt3);
+var updateRobotsTxt4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(updateRobotsTxt3);
+var onRobotsTxtUpdated2 = (0, import_event_definition_modules.createEventModule)(onRobotsTxtUpdated);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  WebhookIdentityType,
+  getRobotsTxt,
+  onRobotsTxtUpdated,
+  updateRobotsTxt
+});
+//# sourceMappingURL=index.js.map

package/build/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../index.ts","../../src/promote-seo-v2-robots-txt-robots-txt.public.ts","../../src/promote-seo-v2-robots-txt-robots-txt.universal.ts","../../src/promote-seo-v2-robots-txt-robots-txt.http.ts","../../src/promote-seo-v2-robots-txt-robots-txt.context.ts"],"sourcesContent":["export * from './src/promote-seo-v2-robots-txt-robots-txt.context.js';\n","import { renameKeysFromRESTResponseToSDKResponse } from '@wix/sdk-runtime/rename-all-nested-keys';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { EventDefinition, HttpClient } from '@wix/sdk-types';\nimport {\n  GetRobotsTxtOptions,\n  GetRobotsTxtResponse,\n  RobotsTxtUpdatedEnvelope,\n  UpdateRobotsTxtOptions,\n  UpdateRobotsTxtResponse,\n  getRobotsTxt as universalGetRobotsTxt,\n  updateRobotsTxt as universalUpdateRobotsTxt,\n} from './promote-seo-v2-robots-txt-robots-txt.universal.js';\n\nexport const __metadata = { PACKAGE_NAME: '@wix/seo' };\n\nexport function getRobotsTxt(httpClient: HttpClient): GetRobotsTxtSignature {\n  return (options?: GetRobotsTxtOptions) =>\n    universalGetRobotsTxt(\n      options,\n      // @ts-ignore\n      { httpClient }\n    );\n}\n\ninterface GetRobotsTxtSignature {\n  /**\n   * Get the Robots.txt file content.\n   * Returns the content and whether it's the default.\n   * @returns The response of the Robots.txt file request\n   */\n  (options?: GetRobotsTxtOptions | undefined): Promise<GetRobotsTxtResponse>;\n}\n\nexport function updateRobotsTxt(\n  httpClient: HttpClient\n): UpdateRobotsTxtSignature {\n  return (options?: UpdateRobotsTxtOptions) =>\n    universalUpdateRobotsTxt(\n      options,\n      // @ts-ignore\n      { httpClient }\n    );\n}\n\ninterface UpdateRobotsTxtSignature {\n  /**\n   * Update the Robots.txt file content.\n   * You may set an empty string as the file content.\n   * In order to reset the content to Wix's default, send `default: true`.\n   */\n  (\n    options?: UpdateRobotsTxtOptions | undefined\n  ): Promise<UpdateRobotsTxtResponse>;\n}\n\nexport const onRobotsTxtUpdated = EventDefinition(\n  'wix.promote.seo.robots_txt_updated',\n  true,\n  (event: RobotsTxtUpdatedEnvelope) =>\n    renameKeysFromRESTResponseToSDKResponse(\n      transformPaths(event, [\n        {\n          transformFn: transformRESTTimestampToSDKTimestamp,\n          paths: [{ path: 'metadata.eventTime' }],\n        },\n      ])\n    )\n)<RobotsTxtUpdatedEnvelope>();\n\nexport {\n  ActionEvent,\n  BaseEventMetadata,\n  DomainEvent,\n  DomainEventBodyOneOf,\n  EntityCreatedEvent,\n  EntityDeletedEvent,\n  EntityUpdatedEvent,\n  EventMetadata,\n  GetRobotsTxtOptions,\n  GetRobotsTxtRequest,\n  GetRobotsTxtResponse,\n  IdentificationData,\n  IdentificationDataIdOneOf,\n  MessageEnvelope,\n  RestoreInfo,\n  RobotsTxt,\n  RobotsTxtUpdatedEnvelope,\n  UpdateRobotsTxtOptions,\n  UpdateRobotsTxtRequest,\n  UpdateRobotsTxtResponse,\n  WebhookIdentityType,\n} from './promote-seo-v2-robots-txt-robots-txt.universal.js';\n","import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';\nimport {\n  renameKeysFromSDKRequestToRESTRequest,\n  renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\nimport { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport * as ambassadorWixPromoteSeoV2RobotsTxt from './promote-seo-v2-robots-txt-robots-txt.http.js';\n\nexport interface RobotsTxt {\n  /**\n   * The robots.txt file content\n   * @maxLength 720000\n   */\n  content?: string;\n  /** The Wix default robots.txt file content */\n  default?: boolean;\n  /**\n   * The subdomain of the requested robots.txt file ,e.g. www, es, fr. default is www.\n   * @maxLength 63\n   */\n  subdomain?: string;\n}\n\n/** The request to get the Robots.txt file content */\nexport interface GetRobotsTxtRequest {\n  /** The subdomain of the requested robots.txt file ,e.g. www, es, fr. default is www. */\n  subdomain?: string;\n}\n\n/** The response of the Robots.txt file request */\nexport interface GetRobotsTxtResponse {\n  robotsTxt?: RobotsTxt;\n}\n\n/** The request to update the content of the Robots.txt file */\nexport interface UpdateRobotsTxtRequest {\n  /**\n   * Provided content will override existing content.\n   * Use `default:true` to reset the content to default, no `content` is required in that case\n   */\n  robotsTxt?: RobotsTxt;\n}\n\nexport interface UpdateRobotsTxtResponse {\n  /** updated robots.txt file */\n  robotsTxt?: RobotsTxt;\n}\n\nexport interface DomainEvent extends DomainEventBodyOneOf {\n  createdEvent?: EntityCreatedEvent;\n  updatedEvent?: EntityUpdatedEvent;\n  deletedEvent?: EntityDeletedEvent;\n  actionEvent?: ActionEvent;\n  /** Event ID. With this ID you can easily spot duplicated events and ignore them. */\n  _id?: string;\n  /**\n   * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.\n   * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.\n   */\n  entityFqdn?: string;\n  /**\n   * Event action name, placed at the top level to make it easier for users to dispatch messages.\n   * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.\n   */\n  slug?: string;\n  /** ID of the entity associated with the event. */\n  entityId?: string;\n  /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */\n  eventTime?: Date | null;\n  /**\n   * Whether the event was triggered as a result of a privacy regulation application\n   * (for example, GDPR).\n   */\n  triggeredByAnonymizeRequest?: boolean | null;\n  /** If present, indicates the action that triggered the event. */\n  originatedFrom?: string | null;\n  /**\n   * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.\n   * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.\n   */\n  entityEventSequence?: string | null;\n}\n\n/** @oneof */\nexport interface DomainEventBodyOneOf {\n  createdEvent?: EntityCreatedEvent;\n  updatedEvent?: EntityUpdatedEvent;\n  deletedEvent?: EntityDeletedEvent;\n  actionEvent?: ActionEvent;\n}\n\nexport interface EntityCreatedEvent {\n  entity?: string;\n}\n\nexport interface RestoreInfo {\n  deletedDate?: Date | null;\n}\n\nexport interface EntityUpdatedEvent {\n  /**\n   * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\n   * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\n   * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.\n   */\n  currentEntity?: string;\n}\n\nexport interface EntityDeletedEvent {\n  /** Entity that was deleted. */\n  deletedEntity?: string | null;\n}\n\nexport interface ActionEvent {\n  body?: string;\n}\n\nexport interface MessageEnvelope {\n  /**\n   * App instance ID.\n   * @format GUID\n   */\n  instanceId?: string | null;\n  /**\n   * Event type.\n   * @maxLength 150\n   */\n  eventType?: string;\n  /** The identification type and identity data. */\n  identity?: IdentificationData;\n  /** Stringify payload. */\n  data?: string;\n}\n\nexport interface IdentificationData extends IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n  /** @readonly */\n  identityType?: WebhookIdentityTypeWithLiterals;\n}\n\n/** @oneof */\nexport interface IdentificationDataIdOneOf {\n  /**\n   * ID of a site visitor that has not logged in to the site.\n   * @format GUID\n   */\n  anonymousVisitorId?: string;\n  /**\n   * ID of a site visitor that has logged in to the site.\n   * @format GUID\n   */\n  memberId?: string;\n  /**\n   * ID of a Wix user (site owner, contributor, etc.).\n   * @format GUID\n   */\n  wixUserId?: string;\n  /**\n   * ID of an app.\n   * @format GUID\n   */\n  appId?: string;\n}\n\nexport enum WebhookIdentityType {\n  UNKNOWN = 'UNKNOWN',\n  ANONYMOUS_VISITOR = 'ANONYMOUS_VISITOR',\n  MEMBER = 'MEMBER',\n  WIX_USER = 'WIX_USER',\n  APP = 'APP',\n}\n\n/** @enumType */\nexport type WebhookIdentityTypeWithLiterals =\n  | WebhookIdentityType\n  | 'UNKNOWN'\n  | 'ANONYMOUS_VISITOR'\n  | 'MEMBER'\n  | 'WIX_USER'\n  | 'APP';\n\nexport interface BaseEventMetadata {\n  /**\n   * App instance ID.\n   * @format GUID\n   */\n  instanceId?: string | null;\n  /**\n   * Event type.\n   * @maxLength 150\n   */\n  eventType?: string;\n  /** The identification type and identity data. */\n  identity?: IdentificationData;\n}\n\nexport interface EventMetadata extends BaseEventMetadata {\n  /** Event ID. With this ID you can easily spot duplicated events and ignore them. */\n  _id?: string;\n  /**\n   * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.\n   * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.\n   */\n  entityFqdn?: string;\n  /**\n   * Event action name, placed at the top level to make it easier for users to dispatch messages.\n   * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.\n   */\n  slug?: string;\n  /** ID of the entity associated with the event. */\n  entityId?: string;\n  /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */\n  eventTime?: Date | null;\n  /**\n   * Whether the event was triggered as a result of a privacy regulation application\n   * (for example, GDPR).\n   */\n  triggeredByAnonymizeRequest?: boolean | null;\n  /** If present, indicates the action that triggered the event. */\n  originatedFrom?: string | null;\n  /**\n   * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.\n   * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.\n   */\n  entityEventSequence?: string | null;\n}\n\nexport interface RobotsTxtUpdatedEnvelope {\n  entity: RobotsTxt;\n  metadata: EventMetadata;\n}\n\n/** @permissionScope Manage Stores\n * @permissionScopeId SCOPE.STORES.MANAGE-STORES\n * @permissionId wix-seo.read\n * @webhook\n * @eventType wix.promote.seo.robots_txt_updated\n * @serviceIdentifier com.wixpress.promote.seo.robots.server.v2.RobotsServiceV2\n * @slug updated\n * @documentationMaturity preview\n */\nexport declare function onRobotsTxtUpdated(\n  handler: (event: RobotsTxtUpdatedEnvelope) => void | Promise<void>\n): void;\n\ntype RobotsTxtNonNullablePaths = `content` | `default` | `subdomain`;\n\n/**\n * Get the Robots.txt file content.\n * Returns the content and whether it's the default.\n * @public\n * @documentationMaturity preview\n * @permissionId wix-seo.read\n * @applicableIdentity APP\n * @applicableIdentity MEMBER\n * @returns The response of the Robots.txt file request\n * @fqn com.wixpress.promote.seo.robots.server.v2.RobotsServiceV2.GetRobotsTxt\n */\nexport async function getRobotsTxt(\n  options?: GetRobotsTxtOptions\n): Promise<\n  NonNullablePaths<\n    GetRobotsTxtResponse,\n    {\n      [P in RobotsTxtNonNullablePaths]: `robotsTxt.${P}`;\n    }[RobotsTxtNonNullablePaths]\n  >\n> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[1] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({\n    subdomain: options?.subdomain,\n  });\n\n  const reqOpts = ambassadorWixPromoteSeoV2RobotsTxt.getRobotsTxt(payload);\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: { subdomain: '$[0].subdomain' },\n        singleArgumentUnchanged: false,\n      },\n      ['options']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n\nexport interface GetRobotsTxtOptions {\n  /** The subdomain of the requested robots.txt file ,e.g. www, es, fr. default is www. */\n  subdomain?: string;\n}\n\n/**\n * Update the Robots.txt file content.\n * You may set an empty string as the file content.\n * In order to reset the content to Wix's default, send `default: true`.\n * @public\n * @documentationMaturity preview\n * @permissionId wix-seo.edit\n * @fqn com.wixpress.promote.seo.robots.server.v2.RobotsServiceV2.UpdateRobotsTxt\n */\nexport async function updateRobotsTxt(\n  options?: UpdateRobotsTxtOptions\n): Promise<\n  NonNullablePaths<\n    UpdateRobotsTxtResponse,\n    {\n      [P in RobotsTxtNonNullablePaths]: `robotsTxt.${P}`;\n    }[RobotsTxtNonNullablePaths]\n  >\n> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[1] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({\n    robotsTxt: options?.robotsTxt,\n  });\n\n  const reqOpts = ambassadorWixPromoteSeoV2RobotsTxt.updateRobotsTxt(payload);\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: { robotsTxt: '$[0].robotsTxt' },\n        singleArgumentUnchanged: false,\n      },\n      ['options']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n\nexport interface UpdateRobotsTxtOptions {\n  /**\n   * Provided content will override existing content.\n   * Use `default:true` to reset the content to default, no `content` is required in that case\n   */\n  robotsTxt?: RobotsTxt;\n}\n","import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveComWixpressPromoteSeoRobotsServerV2RobotsServiceV2Url(\n  opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n  const domainToMappings = {\n    'www._base_domain_': [\n      {\n        srcPath: '/_api/promote-seo-robots-server',\n        destPath: '/api',\n      },\n      {\n        srcPath: '/_api/promote-seo-robots-server/v2/robots',\n        destPath: '/v2/robots',\n      },\n      {\n        srcPath: '/_api/promote-seo-robots-server/v2/ads',\n        destPath: '/v2/ads',\n      },\n      {\n        srcPath: '/_api/promote-seo-robots-server/v2/llms',\n        destPath: '/v2/llms',\n      },\n    ],\n    'api._api_base_domain_': [\n      {\n        srcPath: '/promote-seo-robots-server',\n        destPath: '',\n      },\n    ],\n    'manage._base_domain_': [\n      {\n        srcPath: '/_api/promote-seo-robots-server',\n        destPath: '/api',\n      },\n      {\n        srcPath: '/_api/promote-seo-robots-server/v2/robots',\n        destPath: '/v2/robots',\n      },\n      {\n        srcPath: '/_api/promote-seo-robots-server/v2/ads',\n        destPath: '/v2/ads',\n      },\n      {\n        srcPath: '/_api/promote-seo-robots-server/v2/llms',\n        destPath: '/v2/llms',\n      },\n    ],\n    'www.wixapis.com': [\n      {\n        srcPath: '/promote-seo-robots-server/v2/robots',\n        destPath: '/v2/robots',\n      },\n      {\n        srcPath: '/promote-seo-robots-server/v2/ads',\n        destPath: '/v2/ads',\n      },\n      {\n        srcPath: '/promote-seo-txt-file-server/v2/ads',\n        destPath: '/v2/ads',\n      },\n      {\n        srcPath: '/promote-seo-txt-file-server/v2/robots',\n        destPath: '/v2/robots',\n      },\n      {\n        srcPath: '/promote-seo-robots-server/v2/llms',\n        destPath: '/v2/llms',\n      },\n    ],\n    '*.dev.wix-code.com': [\n      {\n        srcPath: '/promote/marketing/v2/ads',\n        destPath: '/v2/ads',\n      },\n      {\n        srcPath: '/promote/seo/v2/llms',\n        destPath: '/v2/llms',\n      },\n      {\n        srcPath: '/promote/seo/v2/robots',\n        destPath: '/v2/robots',\n      },\n    ],\n    _: [\n      {\n        srcPath: '/promote/marketing/v2/ads',\n        destPath: '/v2/ads',\n      },\n      {\n        srcPath: '/promote/seo/v2/llms',\n        destPath: '/v2/llms',\n      },\n      {\n        srcPath: '/promote/seo/v2/robots',\n        destPath: '/v2/robots',\n      },\n    ],\n  };\n\n  return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_seo_robots-txt';\n\n/**\n * Get the Robots.txt file content.\n * Returns the content and whether it's the default.\n */\nexport function getRobotsTxt(payload: object): RequestOptionsFactory<any> {\n  function __getRobotsTxt({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.promote.seo.v2.robots_txt',\n      method: 'GET' as any,\n      methodFqn:\n        'com.wixpress.promote.seo.robots.server.v2.RobotsServiceV2.GetRobotsTxt',\n      packageName: PACKAGE_NAME,\n      url: resolveComWixpressPromoteSeoRobotsServerV2RobotsServiceV2Url({\n        protoPath: '/v2/robots',\n        data: payload,\n        host,\n      }),\n      params: toURLSearchParams(payload),\n    };\n\n    return metadata;\n  }\n\n  return __getRobotsTxt;\n}\n\n/**\n * Update the Robots.txt file content.\n * You may set an empty string as the file content.\n * In order to reset the content to Wix's default, send `default: true`.\n */\nexport function updateRobotsTxt(payload: object): RequestOptionsFactory<any> {\n  function __updateRobotsTxt({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.promote.seo.v2.robots_txt',\n      method: 'PUT' as any,\n      methodFqn:\n        'com.wixpress.promote.seo.robots.server.v2.RobotsServiceV2.UpdateRobotsTxt',\n      packageName: PACKAGE_NAME,\n      url: resolveComWixpressPromoteSeoRobotsServerV2RobotsServiceV2Url({\n        protoPath: '/v2/robots',\n        data: payload,\n        host,\n      }),\n      data: payload,\n    };\n\n    return metadata;\n  }\n\n  return __updateRobotsTxt;\n}\n","import {\n  getRobotsTxt as publicGetRobotsTxt,\n  updateRobotsTxt as publicUpdateRobotsTxt,\n} from './promote-seo-v2-robots-txt-robots-txt.public.js';\nimport { createRESTModule } from '@wix/sdk-runtime/rest-modules';\nimport { createEventModule } from '@wix/sdk-runtime/event-definition-modules';\nimport {\n  BuildRESTFunction,\n  MaybeContext,\n  BuildEventDefinition,\n} from '@wix/sdk-types';\nimport { onRobotsTxtUpdated as publicOnRobotsTxtUpdated } from './promote-seo-v2-robots-txt-robots-txt.public.js';\n\nexport const getRobotsTxt: MaybeContext<\n  BuildRESTFunction<typeof publicGetRobotsTxt> & typeof publicGetRobotsTxt\n> = /*#__PURE__*/ createRESTModule(publicGetRobotsTxt);\nexport const updateRobotsTxt: MaybeContext<\n  BuildRESTFunction<typeof publicUpdateRobotsTxt> & typeof publicUpdateRobotsTxt\n> = /*#__PURE__*/ createRESTModule(publicUpdateRobotsTxt);\n/** */\nexport const onRobotsTxtUpdated: BuildEventDefinition<\n  typeof publicOnRobotsTxtUpdated\n> = createEventModule(publicOnRobotsTxtUpdated);\n\nexport { WebhookIdentityType } from './promote-seo-v2-robots-txt-robots-txt.universal.js';\nexport {\n  RobotsTxt,\n  GetRobotsTxtRequest,\n  GetRobotsTxtResponse,\n  UpdateRobotsTxtRequest,\n  UpdateRobotsTxtResponse,\n  DomainEvent,\n  DomainEventBodyOneOf,\n  EntityCreatedEvent,\n  RestoreInfo,\n  EntityUpdatedEvent,\n  EntityDeletedEvent,\n  ActionEvent,\n  MessageEnvelope,\n  IdentificationData,\n  IdentificationDataIdOneOf,\n  BaseEventMetadata,\n  EventMetadata,\n  RobotsTxtUpdatedEnvelope,\n  GetRobotsTxtOptions,\n  UpdateRobotsTxtOptions,\n} from './promote-seo-v2-robots-txt-robots-txt.universal.js';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA,sBAAAA;AAAA,EAAA,0BAAAC;AAAA,EAAA,uBAAAC;AAAA;AAAA;;;ACAA,IAAAC,iCAAwD;AACxD,uBAAqD;AACrD,6BAA+B;AAC/B,uBAA4C;;;ACH5C,6BAAoD;AACpD,oCAGO;;;ACJP,0BAAkC;AAClC,IAAAC,uBAA2B;AAI3B,SAAS,6DACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,qBAAqB;AAAA,MACnB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,yBAAyB;AAAA,MACvB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,sBAAsB;AAAA,MACpB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,GAAG;AAAA,MACD;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,aAAO,iCAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAMd,SAAS,aAAa,SAA6C;AACxE,WAAS,eAAe,EAAE,KAAK,GAAQ;AACrC,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WACE;AAAA,MACF,aAAa;AAAA,MACb,KAAK,6DAA6D;AAAA,QAChE,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,YAAQ,uCAAkB,OAAO;AAAA,IACnC;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAOO,SAAS,gBAAgB,SAA6C;AAC3E,WAAS,kBAAkB,EAAE,KAAK,GAAQ;AACxC,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WACE;AAAA,MACF,aAAa;AAAA,MACb,KAAK,6DAA6D;AAAA,QAChE,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,IACR;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;ADwBO,IAAK,sBAAL,kBAAKC,yBAAL;AACL,EAAAA,qBAAA,aAAU;AACV,EAAAA,qBAAA,uBAAoB;AACpB,EAAAA,qBAAA,YAAS;AACT,EAAAA,qBAAA,cAAW;AACX,EAAAA,qBAAA,SAAM;AALI,SAAAA;AAAA,GAAA;AA8FZ,eAAsBC,cACpB,SAQA;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,cAAU,qEAAsC;AAAA,IACpD,WAAW,SAAS;AAAA,EACtB,CAAC;AAED,QAAM,UAA6C,aAAa,OAAO;AAEvE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,eAAO,uEAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,uBAAmB,uBAAAC;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,EAAE,WAAW,iBAAiB;AAAA,QACxD,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,SAAS;AAAA,IACZ;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;AAgBA,eAAsBC,iBACpB,SAQA;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,cAAU,qEAAsC;AAAA,IACpD,WAAW,SAAS;AAAA,EACtB,CAAC;AAED,QAAM,UAA6C,gBAAgB,OAAO;AAE1E,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,eAAO,uEAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,uBAAmB,uBAAAD;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,EAAE,WAAW,iBAAiB;AAAA,QACxD,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,SAAS;AAAA,IACZ;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;;;ADzWO,SAASE,cAAa,YAA+C;AAC1E,SAAO,CAAC,YACNA;AAAA,IACE;AAAA;AAAA,IAEA,EAAE,WAAW;AAAA,EACf;AACJ;AAWO,SAASC,iBACd,YAC0B;AAC1B,SAAO,CAAC,YACNA;AAAA,IACE;AAAA;AAAA,IAEA,EAAE,WAAW;AAAA,EACf;AACJ;AAaO,IAAM,yBAAqB;AAAA,EAChC;AAAA,EACA;AAAA,EACA,CAAC,cACC;AAAA,QACE,uCAAe,OAAO;AAAA,MACpB;AAAA,QACE,aAAa;AAAA,QACb,OAAO,CAAC,EAAE,MAAM,qBAAqB,CAAC;AAAA,MACxC;AAAA,IACF,CAAC;AAAA,EACH;AACJ,EAA4B;;;AGhE5B,IAAAC,uBAAiC;AACjC,sCAAkC;AAQ3B,IAAMC,gBAEK,2DAAiBA,aAAkB;AAC9C,IAAMC,mBAEK,2DAAiBA,gBAAqB;AAEjD,IAAMC,0BAET,mDAAkB,kBAAwB;","names":["getRobotsTxt","onRobotsTxtUpdated","updateRobotsTxt","import_rename_all_nested_keys","import_rest_modules","WebhookIdentityType","getRobotsTxt","sdkTransformError","updateRobotsTxt","getRobotsTxt","updateRobotsTxt","import_rest_modules","getRobotsTxt","updateRobotsTxt","onRobotsTxtUpdated"]}

package/build/cjs/index.typings.d.ts

@@ -0,0 +1,269 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
+interface RobotsTxt {
+    /**
+     * The robots.txt file content
+     * @maxLength 720000
+     */
+    content?: string;
+    /** The Wix default robots.txt file content */
+    default?: boolean;
+    /**
+     * The subdomain of the requested robots.txt file ,e.g. www, es, fr. default is www.
+     * @maxLength 63
+     */
+    subdomain?: string;
+}
+/** The request to get the Robots.txt file content */
+interface GetRobotsTxtRequest {
+    /** The subdomain of the requested robots.txt file ,e.g. www, es, fr. default is www. */
+    subdomain?: string;
+}
+/** The response of the Robots.txt file request */
+interface GetRobotsTxtResponse {
+    robotsTxt?: RobotsTxt;
+}
+/** The request to update the content of the Robots.txt file */
+interface UpdateRobotsTxtRequest {
+    /**
+     * Provided content will override existing content.
+     * Use `default:true` to reset the content to default, no `content` is required in that case
+     */
+    robotsTxt?: RobotsTxt;
+}
+interface UpdateRobotsTxtResponse {
+    /** updated robots.txt file */
+    robotsTxt?: RobotsTxt;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+interface RobotsTxtUpdatedEnvelope {
+    entity: RobotsTxt;
+    metadata: EventMetadata;
+}
+/** @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionId wix-seo.read
+ * @webhook
+ * @eventType wix.promote.seo.robots_txt_updated
+ * @serviceIdentifier com.wixpress.promote.seo.robots.server.v2.RobotsServiceV2
+ * @slug updated
+ * @documentationMaturity preview
+ */
+declare function onRobotsTxtUpdated(handler: (event: RobotsTxtUpdatedEnvelope) => void | Promise<void>): void;
+type RobotsTxtNonNullablePaths = `content` | `default` | `subdomain`;
+/**
+ * Get the Robots.txt file content.
+ * Returns the content and whether it's the default.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId wix-seo.read
+ * @applicableIdentity APP
+ * @applicableIdentity MEMBER
+ * @returns The response of the Robots.txt file request
+ * @fqn com.wixpress.promote.seo.robots.server.v2.RobotsServiceV2.GetRobotsTxt
+ */
+declare function getRobotsTxt(options?: GetRobotsTxtOptions): Promise<NonNullablePaths<GetRobotsTxtResponse, {
+    [P in RobotsTxtNonNullablePaths]: `robotsTxt.${P}`;
+}[RobotsTxtNonNullablePaths]>>;
+interface GetRobotsTxtOptions {
+    /** The subdomain of the requested robots.txt file ,e.g. www, es, fr. default is www. */
+    subdomain?: string;
+}
+/**
+ * Update the Robots.txt file content.
+ * You may set an empty string as the file content.
+ * In order to reset the content to Wix's default, send `default: true`.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId wix-seo.edit
+ * @fqn com.wixpress.promote.seo.robots.server.v2.RobotsServiceV2.UpdateRobotsTxt
+ */
+declare function updateRobotsTxt(options?: UpdateRobotsTxtOptions): Promise<NonNullablePaths<UpdateRobotsTxtResponse, {
+    [P in RobotsTxtNonNullablePaths]: `robotsTxt.${P}`;
+}[RobotsTxtNonNullablePaths]>>;
+interface UpdateRobotsTxtOptions {
+    /**
+     * Provided content will override existing content.
+     * Use `default:true` to reset the content to default, no `content` is required in that case
+     */
+    robotsTxt?: RobotsTxt;
+}
+
+export { type ActionEvent, type BaseEventMetadata, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type GetRobotsTxtOptions, type GetRobotsTxtRequest, type GetRobotsTxtResponse, type IdentificationData, type IdentificationDataIdOneOf, type MessageEnvelope, type RestoreInfo, type RobotsTxt, type RobotsTxtUpdatedEnvelope, type UpdateRobotsTxtOptions, type UpdateRobotsTxtRequest, type UpdateRobotsTxtResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, getRobotsTxt, onRobotsTxtUpdated, updateRobotsTxt };