@wix/auto_sdk_domains_domain-suggestions 1.0.8 → 1.0.10

package/build/cjs/index.d.ts

@@ -1 +1,29 @@
-export * from './src/premium-domains-v2-suggestion-domain-suggestions.context.js';
+import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { SuggestDomainsOptions, SuggestDomainsResponse } from './index.typings.js';
+export { CursorPaging, CursorPagingMetadata, Cursors, DomainSuggestion, SuggestDomainsRequest } from './index.typings.js';
+
+type SuggestionNonNullablePaths = `domain` | `premium`;
+declare function suggestDomains$1(httpClient: HttpClient): SuggestDomainsSignature;
+interface SuggestDomainsSignature {
+    /**
+     * Suggests domains that are available for purchase, based on the provided query input.
+     *
+     *  You may use this endpoint to get inspired and then call [Check Domain Availability()](/domainAvailability/check-domain-availability) to check whether a specific variation of the suggestions is also available for purchase.
+     *
+     *  The `tlds` must not include the dot. For example, `com` and not `.com`.
+     *
+     * > **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.
+     * @param - Input to base your domain suggestions on. May include
+     * letters, numbers, spaces, dots, and hyphens. Must not include the TLD.
+     *
+     * Min: 3 characters
+     * Max: 100 characters
+     */
+    (query: string, options?: SuggestDomainsOptions): Promise<NonNullablePaths<SuggestDomainsResponse, {
+        [P in SuggestionNonNullablePaths]: `suggestions.${number}.${P}`;
+    }[SuggestionNonNullablePaths]>>;
+}
+
+declare const suggestDomains: MaybeContext<BuildRESTFunction<typeof suggestDomains$1> & typeof suggestDomains$1>;
+
+export { SuggestDomainsOptions, SuggestDomainsResponse, suggestDomains };

package/build/cjs/index.js

@@ -1,18 +1,205 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+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 });
 };
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./src/premium-domains-v2-suggestion-domain-suggestions.context.js"), exports);
+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, {
+  suggestDomains: () => suggestDomains4
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/premium-domains-v2-suggestion-domain-suggestions.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/premium-domains-v2-suggestion-domain-suggestions.http.ts
+var import_rest_modules = require("@wix/sdk-runtime/rest-modules");
+var import_rest_modules2 = require("@wix/sdk-runtime/rest-modules");
+function resolveComWixpressPremiumDomainSearchSuggestV2DomainSearchServiceUrl(opts) {
+  const domainToMappings = {
+    "www._base_domain_": [
+      {
+        srcPath: "/domain-search/v2",
+        destPath: "/v2"
+      },
+      {
+        srcPath: "/v2/suggest-domains",
+        destPath: "/v2/suggest-domains"
+      }
+    ],
+    "manage._base_domain_": [
+      {
+        srcPath: "/v2/check-domain-availability",
+        destPath: "/v2/check-domain-availability"
+      },
+      {
+        srcPath: "/v2/suggest-domains",
+        destPath: "/v2/suggest-domains"
+      }
+    ],
+    "premium._base_domain_": [
+      {
+        srcPath: "/v2/check-domain-availability",
+        destPath: "/v2/check-domain-availability"
+      },
+      {
+        srcPath: "/v2/suggest-domains",
+        destPath: "/v2/suggest-domains"
+      }
+    ],
+    "www.wixapis.com": [
+      {
+        srcPath: "/domain-search/v2",
+        destPath: "/v2"
+      },
+      {
+        srcPath: "/premium/domains/v2/check-domain-availability",
+        destPath: "/v2/check-domain-availability"
+      },
+      {
+        srcPath: "/premium/domains/v2/suggest-domains",
+        destPath: "/v2/suggest-domains"
+      }
+    ],
+    "editor._base_domain_": [
+      {
+        srcPath: "/v2/check-domain-availability",
+        destPath: "/v2/check-domain-availability"
+      },
+      {
+        srcPath: "/v2/suggest-domains",
+        destPath: "/v2/suggest-domains"
+      }
+    ],
+    "blocks._base_domain_": [
+      {
+        srcPath: "/v2/check-domain-availability",
+        destPath: "/v2/check-domain-availability"
+      },
+      {
+        srcPath: "/v2/suggest-domains",
+        destPath: "/v2/suggest-domains"
+      }
+    ],
+    "create.editorx": [
+      {
+        srcPath: "/v2/check-domain-availability",
+        destPath: "/v2/check-domain-availability"
+      },
+      {
+        srcPath: "/v2/suggest-domains",
+        destPath: "/v2/suggest-domains"
+      }
+    ],
+    "*.dev.wix-code.com": [
+      {
+        srcPath: "/premium/domains/v2/check-domain-availability",
+        destPath: "/v2/check-domain-availability"
+      },
+      {
+        srcPath: "/premium/domains/v2/suggest-domains",
+        destPath: "/v2/suggest-domains"
+      }
+    ],
+    _: [
+      {
+        srcPath: "/premium/domains/v2/check-domain-availability",
+        destPath: "/v2/check-domain-availability"
+      },
+      {
+        srcPath: "/premium/domains/v2/suggest-domains",
+        destPath: "/v2/suggest-domains"
+      }
+    ]
+  };
+  return (0, import_rest_modules2.resolveUrl)(Object.assign(opts, { domainToMappings }));
+}
+var PACKAGE_NAME = "@wix/auto_sdk_domains_domain-suggestions";
+function suggestDomains(payload) {
+  function __suggestDomains({ host }) {
+    const metadata = {
+      entityFqdn: "wix.premium.domains.v2.suggestion",
+      method: "GET",
+      methodFqn: "com.wixpress.premium.domain.search.suggest.v2.DomainSearchService.SuggestDomains",
+      packageName: PACKAGE_NAME,
+      url: resolveComWixpressPremiumDomainSearchSuggestV2DomainSearchServiceUrl(
+        { protoPath: "/v2/suggest-domains", data: payload, host }
+      ),
+      params: (0, import_rest_modules.toURLSearchParams)(payload)
+    };
+    return metadata;
+  }
+  return __suggestDomains;
+}
+
+// src/premium-domains-v2-suggestion-domain-suggestions.universal.ts
+async function suggestDomains2(query, options) {
+  const { httpClient, sideEffects } = arguments[2];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+    query,
+    tlds: options?.tlds,
+    limit: options?.limit,
+    paging: options?.paging,
+    maxLength: options?.maxLength
+  });
+  const reqOpts = suggestDomains(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: {
+          query: "$[0]",
+          tlds: "$[1].tlds",
+          limit: "$[1].limit",
+          paging: "$[1].paging",
+          maxLength: "$[1].maxLength"
+        },
+        singleArgumentUnchanged: false
+      },
+      ["query", "options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+
+// src/premium-domains-v2-suggestion-domain-suggestions.public.ts
+function suggestDomains3(httpClient) {
+  return (query, options) => suggestDomains2(
+    query,
+    options,
+    // @ts-ignore
+    { httpClient }
+  );
+}
+
+// src/premium-domains-v2-suggestion-domain-suggestions.context.ts
+var import_rest_modules3 = require("@wix/sdk-runtime/rest-modules");
+var suggestDomains4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(suggestDomains3);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  suggestDomains
+});
 //# sourceMappingURL=index.js.map

package/build/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oGAAkF"}
+{"version":3,"sources":["../../index.ts","../../src/premium-domains-v2-suggestion-domain-suggestions.universal.ts","../../src/premium-domains-v2-suggestion-domain-suggestions.http.ts","../../src/premium-domains-v2-suggestion-domain-suggestions.public.ts","../../src/premium-domains-v2-suggestion-domain-suggestions.context.ts"],"sourcesContent":["export * from './src/premium-domains-v2-suggestion-domain-suggestions.context.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 ambassadorWixPremiumDomainsV2Suggestion from './premium-domains-v2-suggestion-domain-suggestions.http.js';\n\nexport interface DomainSuggestion {\n  /**\n   * Suggested domain name including TLD.\n   * @format HOSTNAME\n   */\n  domain?: string;\n  /** Whether the domain has a higher price due to its perceived value or demand. */\n  premium?: boolean;\n}\n\nexport interface SuggestDomainsRequest {\n  /**\n   * Input to base your domain suggestions on. May include\n   * letters, numbers, spaces, dots, and hyphens. Must not include the TLD.\n   *\n   * Min: 3 characters\n   * Max: 100 characters\n   * @minLength 3\n   * @maxLength 100\n   */\n  query: string;\n  /**\n   * [Top-level domains](https://en.wikipedia.org/wiki/Top-level_domain). Must\n   * not include the dot. For example, `com`, not `.com`. Not all TLDs can be\n   * connected to Wix sites. Supported TLDS include `com`, `net`, and `org`.\n   * Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for more\n   * information.\n   *\n   * Max: 10 TLDs\n   * @maxSize 10\n   * @maxLength 63\n   */\n  tlds?: string[];\n  /**\n   * Number of domain suggestions to return. __Deprecated__: This field will be\n   * removed on March 1, 2025. Use `paging.limit` instead.\n   *\n   * Min: `1`\n   * Max: `20`\n   * Default: `10`\n   * @min 1\n   * @max 20\n   * @deprecated Number of domain suggestions to return. __Deprecated__: This field will be\n   * removed on March 1, 2025. Use `paging.limit` instead.\n   *\n   * Min: `1`\n   * Max: `20`\n   * Default: `10`\n   * @replacedBy paging.limit\n   * @targetRemovalDate 2025-03-01\n   */\n  limit?: number | null;\n  /** Cursor paging options. */\n  paging?: CursorPaging;\n  /**\n   * Maximum number of characters for the domain name, excluding the TLD.\n   *\n   * Min: `3`\n   * Max: `63`\n   * Default: `63`\n   * @min 3\n   * @max 63\n   */\n  maxLength?: number | null;\n}\n\nexport interface CursorPaging {\n  /**\n   * Maximum number of domains to return in the results.\n   *\n   * Min: `0`\n   * Max: `20`\n   * @min 1\n   * @max 20\n   */\n  limit?: number | null;\n  /**\n   * Pointer to the next or previous page in the list of results.\n   *\n   * You can get the relevant cursor token\n   * from the `pagingMetadata` object in the previous call's response.\n   * Not relevant for the first request.\n   * @maxLength 10000\n   */\n  cursor?: string | null;\n}\n\nexport interface SuggestDomainsResponse {\n  /** List of suggested available domains. */\n  suggestions?: DomainSuggestion[];\n  /** Metadata about the returned list of suggested domains. */\n  pagingMetadata?: CursorPagingMetadata;\n}\n\nexport interface CursorPagingMetadata {\n  /** Number of domains returned in the response. */\n  count?: number | null;\n  /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n  cursors?: Cursors;\n  /**\n   * Indicates if there are more results after the current page.\n   * If `true`, another page of results can be retrieved.\n   * If `false`, this is the last page.\n   */\n  hasNext?: boolean | null;\n}\n\nexport interface Cursors {\n  /** Cursor pointing to next page in the list of results. */\n  next?: string | null;\n  /** Cursor pointing to previous page in the list of results. */\n  prev?: string | null;\n}\n\ntype SuggestionNonNullablePaths = `domain` | `premium`;\n\n/**\n * Suggests domains that are available for purchase, based on the provided query input.\n *\n *  You may use this endpoint to get inspired and then call [Check Domain Availability()](/domainAvailability/check-domain-availability) to check whether a specific variation of the suggestions is also available for purchase.\n *\n *  The `tlds` must not include the dot. For example, `com` and not `.com`.\n *\n * > **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.\n * @param query - Input to base your domain suggestions on. May include\n * letters, numbers, spaces, dots, and hyphens. Must not include the TLD.\n *\n * Min: 3 characters\n * Max: 100 characters\n * @public\n * @requiredField query\n * @permissionId DOMAINS.PUBLIC_API_PERMISSION\n * @fqn com.wixpress.premium.domain.search.suggest.v2.DomainSearchService.SuggestDomains\n */\nexport async function suggestDomains(\n  query: string,\n  options?: SuggestDomainsOptions\n): Promise<\n  NonNullablePaths<\n    SuggestDomainsResponse,\n    {\n      [P in SuggestionNonNullablePaths]: `suggestions.${number}.${P}`;\n    }[SuggestionNonNullablePaths]\n  >\n> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[2] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({\n    query: query,\n    tlds: options?.tlds,\n    limit: options?.limit,\n    paging: options?.paging,\n    maxLength: options?.maxLength,\n  });\n\n  const reqOpts =\n    ambassadorWixPremiumDomainsV2Suggestion.suggestDomains(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: {\n          query: '$[0]',\n          tlds: '$[1].tlds',\n          limit: '$[1].limit',\n          paging: '$[1].paging',\n          maxLength: '$[1].maxLength',\n        },\n        singleArgumentUnchanged: false,\n      },\n      ['query', 'options']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n\nexport interface SuggestDomainsOptions {\n  /**\n   * [Top-level domains](https://en.wikipedia.org/wiki/Top-level_domain). Must\n   * not include the dot. For example, `com`, not `.com`. Not all TLDs can be\n   * connected to Wix sites. Supported TLDS include `com`, `net`, and `org`.\n   * Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for more\n   * information.\n   *\n   * Max: 10 TLDs\n   * @maxSize 10\n   * @maxLength 63\n   */\n  tlds?: string[];\n  /**\n   * Number of domain suggestions to return. __Deprecated__: This field will be\n   * removed on March 1, 2025. Use `paging.limit` instead.\n   *\n   * Min: `1`\n   * Max: `20`\n   * Default: `10`\n   * @min 1\n   * @max 20\n   * @deprecated Number of domain suggestions to return. __Deprecated__: This field will be\n   * removed on March 1, 2025. Use `paging.limit` instead.\n   *\n   * Min: `1`\n   * Max: `20`\n   * Default: `10`\n   * @replacedBy paging.limit\n   * @targetRemovalDate 2025-03-01\n   */\n  limit?: number | null;\n  /** Cursor paging options. */\n  paging?: CursorPaging;\n  /**\n   * Maximum number of characters for the domain name, excluding the TLD.\n   *\n   * Min: `3`\n   * Max: `63`\n   * Default: `63`\n   * @min 3\n   * @max 63\n   */\n  maxLength?: number | null;\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 resolveComWixpressPremiumDomainSearchSuggestV2DomainSearchServiceUrl(\n  opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n  const domainToMappings = {\n    'www._base_domain_': [\n      {\n        srcPath: '/domain-search/v2',\n        destPath: '/v2',\n      },\n      {\n        srcPath: '/v2/suggest-domains',\n        destPath: '/v2/suggest-domains',\n      },\n    ],\n    'manage._base_domain_': [\n      {\n        srcPath: '/v2/check-domain-availability',\n        destPath: '/v2/check-domain-availability',\n      },\n      {\n        srcPath: '/v2/suggest-domains',\n        destPath: '/v2/suggest-domains',\n      },\n    ],\n    'premium._base_domain_': [\n      {\n        srcPath: '/v2/check-domain-availability',\n        destPath: '/v2/check-domain-availability',\n      },\n      {\n        srcPath: '/v2/suggest-domains',\n        destPath: '/v2/suggest-domains',\n      },\n    ],\n    'www.wixapis.com': [\n      {\n        srcPath: '/domain-search/v2',\n        destPath: '/v2',\n      },\n      {\n        srcPath: '/premium/domains/v2/check-domain-availability',\n        destPath: '/v2/check-domain-availability',\n      },\n      {\n        srcPath: '/premium/domains/v2/suggest-domains',\n        destPath: '/v2/suggest-domains',\n      },\n    ],\n    'editor._base_domain_': [\n      {\n        srcPath: '/v2/check-domain-availability',\n        destPath: '/v2/check-domain-availability',\n      },\n      {\n        srcPath: '/v2/suggest-domains',\n        destPath: '/v2/suggest-domains',\n      },\n    ],\n    'blocks._base_domain_': [\n      {\n        srcPath: '/v2/check-domain-availability',\n        destPath: '/v2/check-domain-availability',\n      },\n      {\n        srcPath: '/v2/suggest-domains',\n        destPath: '/v2/suggest-domains',\n      },\n    ],\n    'create.editorx': [\n      {\n        srcPath: '/v2/check-domain-availability',\n        destPath: '/v2/check-domain-availability',\n      },\n      {\n        srcPath: '/v2/suggest-domains',\n        destPath: '/v2/suggest-domains',\n      },\n    ],\n    '*.dev.wix-code.com': [\n      {\n        srcPath: '/premium/domains/v2/check-domain-availability',\n        destPath: '/v2/check-domain-availability',\n      },\n      {\n        srcPath: '/premium/domains/v2/suggest-domains',\n        destPath: '/v2/suggest-domains',\n      },\n    ],\n    _: [\n      {\n        srcPath: '/premium/domains/v2/check-domain-availability',\n        destPath: '/v2/check-domain-availability',\n      },\n      {\n        srcPath: '/premium/domains/v2/suggest-domains',\n        destPath: '/v2/suggest-domains',\n      },\n    ],\n  };\n\n  return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_domains_domain-suggestions';\n\n/**\n * Suggests domains that are available for purchase, based on the provided query input.\n *\n *  You may use this endpoint to get inspired and then call [Check Domain Availability()](/domainAvailability/check-domain-availability) to check whether a specific variation of the suggestions is also available for purchase.\n *\n *  The `tlds` must not include the dot. For example, `com` and not `.com`.\n *\n * > **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.\n */\nexport function suggestDomains(payload: object): RequestOptionsFactory<any> {\n  function __suggestDomains({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.premium.domains.v2.suggestion',\n      method: 'GET' as any,\n      methodFqn:\n        'com.wixpress.premium.domain.search.suggest.v2.DomainSearchService.SuggestDomains',\n      packageName: PACKAGE_NAME,\n      url: resolveComWixpressPremiumDomainSearchSuggestV2DomainSearchServiceUrl(\n        { protoPath: '/v2/suggest-domains', data: payload, host }\n      ),\n      params: toURLSearchParams(payload),\n    };\n\n    return metadata;\n  }\n\n  return __suggestDomains;\n}\n","import { HttpClient, NonNullablePaths } from '@wix/sdk-types';\nimport {\n  SuggestDomainsOptions,\n  SuggestDomainsResponse,\n  suggestDomains as universalSuggestDomains,\n} from './premium-domains-v2-suggestion-domain-suggestions.universal.js';\n\nexport const __metadata = { PACKAGE_NAME: '@wix/domains' };\n\ntype SuggestionNonNullablePaths = `domain` | `premium`;\n\nexport function suggestDomains(\n  httpClient: HttpClient\n): SuggestDomainsSignature {\n  return (query: string, options?: SuggestDomainsOptions) =>\n    universalSuggestDomains(\n      query,\n      options,\n      // @ts-ignore\n      { httpClient }\n    );\n}\n\ninterface SuggestDomainsSignature {\n  /**\n   * Suggests domains that are available for purchase, based on the provided query input.\n   *\n   *  You may use this endpoint to get inspired and then call [Check Domain Availability()](/domainAvailability/check-domain-availability) to check whether a specific variation of the suggestions is also available for purchase.\n   *\n   *  The `tlds` must not include the dot. For example, `com` and not `.com`.\n   *\n   * > **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.\n   * @param - Input to base your domain suggestions on. May include\n   * letters, numbers, spaces, dots, and hyphens. Must not include the TLD.\n   *\n   * Min: 3 characters\n   * Max: 100 characters\n   */\n  (query: string, options?: SuggestDomainsOptions): Promise<\n    NonNullablePaths<\n      SuggestDomainsResponse,\n      {\n        [P in SuggestionNonNullablePaths]: `suggestions.${number}.${P}`;\n      }[SuggestionNonNullablePaths]\n    >\n  >;\n}\n\nexport {\n  CursorPaging,\n  CursorPagingMetadata,\n  Cursors,\n  DomainSuggestion,\n  SuggestDomainsOptions,\n  SuggestDomainsRequest,\n  SuggestDomainsResponse,\n} from './premium-domains-v2-suggestion-domain-suggestions.universal.js';\n","import { suggestDomains as publicSuggestDomains } from './premium-domains-v2-suggestion-domain-suggestions.public.js';\nimport { createRESTModule } from '@wix/sdk-runtime/rest-modules';\nimport { BuildRESTFunction, MaybeContext } from '@wix/sdk-types';\n\nexport const suggestDomains: MaybeContext<\n  BuildRESTFunction<typeof publicSuggestDomains> & typeof publicSuggestDomains\n> = /*#__PURE__*/ createRESTModule(publicSuggestDomains);\n\nexport {\n  DomainSuggestion,\n  SuggestDomainsRequest,\n  CursorPaging,\n  SuggestDomainsResponse,\n  CursorPagingMetadata,\n  Cursors,\n  SuggestDomainsOptions,\n} from './premium-domains-v2-suggestion-domain-suggestions.universal.js';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA,wBAAAA;AAAA;AAAA;;;ACAA,6BAAoD;AACpD,oCAGO;;;ACJP,0BAAkC;AAClC,IAAAC,uBAA2B;AAI3B,SAAS,qEACP,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,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,IACF;AAAA,IACA,yBAAyB;AAAA,MACvB;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,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,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,IACF;AAAA,IACA,kBAAkB;AAAA,MAChB;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,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,IACF;AAAA,EACF;AAEA,aAAO,iCAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAWd,SAAS,eAAe,SAA6C;AAC1E,WAAS,iBAAiB,EAAE,KAAK,GAAQ;AACvC,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WACE;AAAA,MACF,aAAa;AAAA,MACb,KAAK;AAAA,QACH,EAAE,WAAW,uBAAuB,MAAM,SAAS,KAAK;AAAA,MAC1D;AAAA,MACA,YAAQ,uCAAkB,OAAO;AAAA,IACnC;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;ADKA,eAAsBC,gBACpB,OACA,SAQA;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,cAAU,qEAAsC;AAAA,IACpD;AAAA,IACA,MAAM,SAAS;AAAA,IACf,OAAO,SAAS;AAAA,IAChB,QAAQ,SAAS;AAAA,IACjB,WAAW,SAAS;AAAA,EACtB,CAAC;AAED,QAAM,UACoC,eAAe,OAAO;AAEhE,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;AAAA,UACxB,OAAO;AAAA,UACP,MAAM;AAAA,UACN,OAAO;AAAA,UACP,QAAQ;AAAA,UACR,WAAW;AAAA,QACb;AAAA,QACA,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,SAAS,SAAS;AAAA,IACrB;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;;;AEzLO,SAASC,gBACd,YACyB;AACzB,SAAO,CAAC,OAAe,YACrBA;AAAA,IACE;AAAA,IACA;AAAA;AAAA,IAEA,EAAE,WAAW;AAAA,EACf;AACJ;;;ACpBA,IAAAC,uBAAiC;AAG1B,IAAMC,kBAEK,2DAAiBA,eAAoB;","names":["suggestDomains","import_rest_modules","suggestDomains","sdkTransformError","suggestDomains","import_rest_modules","suggestDomains"]}

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

@@ -1 +1,179 @@
-export * from './src/premium-domains-v2-suggestion-domain-suggestions.universal.js';
+import { NonNullablePaths } from '@wix/sdk-types';
+
+interface DomainSuggestion {
+    /**
+     * Suggested domain name including TLD.
+     * @format HOSTNAME
+     */
+    domain?: string;
+    /** Whether the domain has a higher price due to its perceived value or demand. */
+    premium?: boolean;
+}
+interface SuggestDomainsRequest {
+    /**
+     * Input to base your domain suggestions on. May include
+     * letters, numbers, spaces, dots, and hyphens. Must not include the TLD.
+     *
+     * Min: 3 characters
+     * Max: 100 characters
+     * @minLength 3
+     * @maxLength 100
+     */
+    query: string;
+    /**
+     * [Top-level domains](https://en.wikipedia.org/wiki/Top-level_domain). Must
+     * not include the dot. For example, `com`, not `.com`. Not all TLDs can be
+     * connected to Wix sites. Supported TLDS include `com`, `net`, and `org`.
+     * Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for more
+     * information.
+     *
+     * Max: 10 TLDs
+     * @maxSize 10
+     * @maxLength 63
+     */
+    tlds?: string[];
+    /**
+     * Number of domain suggestions to return. __Deprecated__: This field will be
+     * removed on March 1, 2025. Use `paging.limit` instead.
+     *
+     * Min: `1`
+     * Max: `20`
+     * Default: `10`
+     * @min 1
+     * @max 20
+     * @deprecated Number of domain suggestions to return. __Deprecated__: This field will be
+     * removed on March 1, 2025. Use `paging.limit` instead.
+     *
+     * Min: `1`
+     * Max: `20`
+     * Default: `10`
+     * @replacedBy paging.limit
+     * @targetRemovalDate 2025-03-01
+     */
+    limit?: number | null;
+    /** Cursor paging options. */
+    paging?: CursorPaging;
+    /**
+     * Maximum number of characters for the domain name, excluding the TLD.
+     *
+     * Min: `3`
+     * Max: `63`
+     * Default: `63`
+     * @min 3
+     * @max 63
+     */
+    maxLength?: number | null;
+}
+interface CursorPaging {
+    /**
+     * Maximum number of domains to return in the results.
+     *
+     * Min: `0`
+     * Max: `20`
+     * @min 1
+     * @max 20
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get the relevant cursor token
+     * from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     * @maxLength 10000
+     */
+    cursor?: string | null;
+}
+interface SuggestDomainsResponse {
+    /** List of suggested available domains. */
+    suggestions?: DomainSuggestion[];
+    /** Metadata about the returned list of suggested domains. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of domains returned in the response. */
+    count?: number | null;
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
+    /**
+     * Indicates if there are more results after the current page.
+     * If `true`, another page of results can be retrieved.
+     * If `false`, this is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /** Cursor pointing to next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to previous page in the list of results. */
+    prev?: string | null;
+}
+type SuggestionNonNullablePaths = `domain` | `premium`;
+/**
+ * Suggests domains that are available for purchase, based on the provided query input.
+ *
+ *  You may use this endpoint to get inspired and then call [Check Domain Availability()](/domainAvailability/check-domain-availability) to check whether a specific variation of the suggestions is also available for purchase.
+ *
+ *  The `tlds` must not include the dot. For example, `com` and not `.com`.
+ *
+ * > **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.
+ * @param query - Input to base your domain suggestions on. May include
+ * letters, numbers, spaces, dots, and hyphens. Must not include the TLD.
+ *
+ * Min: 3 characters
+ * Max: 100 characters
+ * @public
+ * @requiredField query
+ * @permissionId DOMAINS.PUBLIC_API_PERMISSION
+ * @fqn com.wixpress.premium.domain.search.suggest.v2.DomainSearchService.SuggestDomains
+ */
+declare function suggestDomains(query: string, options?: SuggestDomainsOptions): Promise<NonNullablePaths<SuggestDomainsResponse, {
+    [P in SuggestionNonNullablePaths]: `suggestions.${number}.${P}`;
+}[SuggestionNonNullablePaths]>>;
+interface SuggestDomainsOptions {
+    /**
+     * [Top-level domains](https://en.wikipedia.org/wiki/Top-level_domain). Must
+     * not include the dot. For example, `com`, not `.com`. Not all TLDs can be
+     * connected to Wix sites. Supported TLDS include `com`, `net`, and `org`.
+     * Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for more
+     * information.
+     *
+     * Max: 10 TLDs
+     * @maxSize 10
+     * @maxLength 63
+     */
+    tlds?: string[];
+    /**
+     * Number of domain suggestions to return. __Deprecated__: This field will be
+     * removed on March 1, 2025. Use `paging.limit` instead.
+     *
+     * Min: `1`
+     * Max: `20`
+     * Default: `10`
+     * @min 1
+     * @max 20
+     * @deprecated Number of domain suggestions to return. __Deprecated__: This field will be
+     * removed on March 1, 2025. Use `paging.limit` instead.
+     *
+     * Min: `1`
+     * Max: `20`
+     * Default: `10`
+     * @replacedBy paging.limit
+     * @targetRemovalDate 2025-03-01
+     */
+    limit?: number | null;
+    /** Cursor paging options. */
+    paging?: CursorPaging;
+    /**
+     * Maximum number of characters for the domain name, excluding the TLD.
+     *
+     * Min: `3`
+     * Max: `63`
+     * Default: `63`
+     * @min 3
+     * @max 63
+     */
+    maxLength?: number | null;
+}
+
+export { type CursorPaging, type CursorPagingMetadata, type Cursors, type DomainSuggestion, type SuggestDomainsOptions, type SuggestDomainsRequest, type SuggestDomainsResponse, suggestDomains };

package/build/cjs/index.typings.js

@@ -1,18 +1,191 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+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 });
 };
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./src/premium-domains-v2-suggestion-domain-suggestions.universal.js"), exports);
+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.typings.ts
+var index_typings_exports = {};
+__export(index_typings_exports, {
+  suggestDomains: () => suggestDomains2
+});
+module.exports = __toCommonJS(index_typings_exports);
+
+// src/premium-domains-v2-suggestion-domain-suggestions.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/premium-domains-v2-suggestion-domain-suggestions.http.ts
+var import_rest_modules = require("@wix/sdk-runtime/rest-modules");
+var import_rest_modules2 = require("@wix/sdk-runtime/rest-modules");
+function resolveComWixpressPremiumDomainSearchSuggestV2DomainSearchServiceUrl(opts) {
+  const domainToMappings = {
+    "www._base_domain_": [
+      {
+        srcPath: "/domain-search/v2",
+        destPath: "/v2"
+      },
+      {
+        srcPath: "/v2/suggest-domains",
+        destPath: "/v2/suggest-domains"
+      }
+    ],
+    "manage._base_domain_": [
+      {
+        srcPath: "/v2/check-domain-availability",
+        destPath: "/v2/check-domain-availability"
+      },
+      {
+        srcPath: "/v2/suggest-domains",
+        destPath: "/v2/suggest-domains"
+      }
+    ],
+    "premium._base_domain_": [
+      {
+        srcPath: "/v2/check-domain-availability",
+        destPath: "/v2/check-domain-availability"
+      },
+      {
+        srcPath: "/v2/suggest-domains",
+        destPath: "/v2/suggest-domains"
+      }
+    ],
+    "www.wixapis.com": [
+      {
+        srcPath: "/domain-search/v2",
+        destPath: "/v2"
+      },
+      {
+        srcPath: "/premium/domains/v2/check-domain-availability",
+        destPath: "/v2/check-domain-availability"
+      },
+      {
+        srcPath: "/premium/domains/v2/suggest-domains",
+        destPath: "/v2/suggest-domains"
+      }
+    ],
+    "editor._base_domain_": [
+      {
+        srcPath: "/v2/check-domain-availability",
+        destPath: "/v2/check-domain-availability"
+      },
+      {
+        srcPath: "/v2/suggest-domains",
+        destPath: "/v2/suggest-domains"
+      }
+    ],
+    "blocks._base_domain_": [
+      {
+        srcPath: "/v2/check-domain-availability",
+        destPath: "/v2/check-domain-availability"
+      },
+      {
+        srcPath: "/v2/suggest-domains",
+        destPath: "/v2/suggest-domains"
+      }
+    ],
+    "create.editorx": [
+      {
+        srcPath: "/v2/check-domain-availability",
+        destPath: "/v2/check-domain-availability"
+      },
+      {
+        srcPath: "/v2/suggest-domains",
+        destPath: "/v2/suggest-domains"
+      }
+    ],
+    "*.dev.wix-code.com": [
+      {
+        srcPath: "/premium/domains/v2/check-domain-availability",
+        destPath: "/v2/check-domain-availability"
+      },
+      {
+        srcPath: "/premium/domains/v2/suggest-domains",
+        destPath: "/v2/suggest-domains"
+      }
+    ],
+    _: [
+      {
+        srcPath: "/premium/domains/v2/check-domain-availability",
+        destPath: "/v2/check-domain-availability"
+      },
+      {
+        srcPath: "/premium/domains/v2/suggest-domains",
+        destPath: "/v2/suggest-domains"
+      }
+    ]
+  };
+  return (0, import_rest_modules2.resolveUrl)(Object.assign(opts, { domainToMappings }));
+}
+var PACKAGE_NAME = "@wix/auto_sdk_domains_domain-suggestions";
+function suggestDomains(payload) {
+  function __suggestDomains({ host }) {
+    const metadata = {
+      entityFqdn: "wix.premium.domains.v2.suggestion",
+      method: "GET",
+      methodFqn: "com.wixpress.premium.domain.search.suggest.v2.DomainSearchService.SuggestDomains",
+      packageName: PACKAGE_NAME,
+      url: resolveComWixpressPremiumDomainSearchSuggestV2DomainSearchServiceUrl(
+        { protoPath: "/v2/suggest-domains", data: payload, host }
+      ),
+      params: (0, import_rest_modules.toURLSearchParams)(payload)
+    };
+    return metadata;
+  }
+  return __suggestDomains;
+}
+
+// src/premium-domains-v2-suggestion-domain-suggestions.universal.ts
+async function suggestDomains2(query, options) {
+  const { httpClient, sideEffects } = arguments[2];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+    query,
+    tlds: options?.tlds,
+    limit: options?.limit,
+    paging: options?.paging,
+    maxLength: options?.maxLength
+  });
+  const reqOpts = suggestDomains(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: {
+          query: "$[0]",
+          tlds: "$[1].tlds",
+          limit: "$[1].limit",
+          paging: "$[1].paging",
+          maxLength: "$[1].maxLength"
+        },
+        singleArgumentUnchanged: false
+      },
+      ["query", "options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  suggestDomains
+});
 //# sourceMappingURL=index.typings.js.map