@wix/auto_sdk_sites_site-actions 1.0.0

package/build/internal/es/src/site-actions-v1-site-actions-site-actions.types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=site-actions-v1-site-actions-site-actions.types.js.map

package/build/internal/es/src/site-actions-v1-site-actions-site-actions.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"site-actions-v1-site-actions-site-actions.types.js","sourceRoot":"","sources":["../../../../src/site-actions-v1-site-actions-site-actions.types.ts"],"names":[],"mappings":""}

package/build/internal/es/src/site-actions-v1-site-actions-site-actions.universal.d.ts

@@ -0,0 +1,164 @@
+/**
+ * A package is group of instances of Wix services that a reseller offers to a
+ * customer as part of a single transaction.
+ */
+export interface EmptyEntity {
+}
+export interface PublishSiteRequest {
+}
+export interface PublishSiteResponse {
+}
+export interface DeployStandalonePagesRequest {
+}
+export interface DeployStandalonePagesResponse {
+}
+export interface DuplicateSiteRequest {
+    /**
+     * ID of the site to duplicated.
+     * @format GUID
+     */
+    sourceSiteId: string;
+    /**
+     * Display name for the new site.
+     * @minLength 1
+     * @maxLength 40
+     */
+    siteDisplayName: string;
+}
+export interface DuplicateSiteResponse {
+    /**
+     * ID of the new site.
+     * @format GUID
+     */
+    newSiteId?: string;
+}
+export interface BulkDeleteSiteRequest {
+    /**
+     * Site IDs.
+     *
+     * Min: 1 site ID <br>
+     * Max: 20 site IDs
+     * @format GUID
+     * @minSize 1
+     * @maxSize 20
+     */
+    ids: string[];
+}
+export interface BulkDeleteSiteResponse {
+    /** List of deletion results. */
+    results?: BulkSiteResult[];
+    /** Summary of deletion data. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkSiteResult {
+    /** Result of deletion request per site describing the success or failure of each deletion. */
+    itemMetadata?: ItemMetadata;
+}
+export interface ItemMetadata {
+    /** Site ID. */
+    _id?: string | null;
+    /** Index of the site in the request array. Allows for correlation between request and response. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for the site. When `false`, the action failed and an `error` object is populated. */
+    success?: boolean;
+    /** Details about the error. */
+    error?: ApplicationError;
+}
+export interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of error. */
+    description?: string;
+}
+export interface BulkActionMetadata {
+    /** Number of sites that were deleted successfully. */
+    totalSuccesses?: number;
+    /** Number of sites that were not deleted successfully. */
+    totalFailures?: number;
+}
+export interface DuplicateSiteResponseNonNullableFields {
+    newSiteId: string;
+}
+interface ApplicationErrorNonNullableFields {
+    code: string;
+    description: string;
+}
+interface ItemMetadataNonNullableFields {
+    originalIndex: number;
+    success: boolean;
+    error?: ApplicationErrorNonNullableFields;
+}
+interface BulkSiteResultNonNullableFields {
+    itemMetadata?: ItemMetadataNonNullableFields;
+}
+interface BulkActionMetadataNonNullableFields {
+    totalSuccesses: number;
+    totalFailures: number;
+}
+export interface BulkDeleteSiteResponseNonNullableFields {
+    results: BulkSiteResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+/**
+ * Publishes a site.
+ *
+ * Publishing a site makes any changes previously saved on the site available on the internet.
+ * After publishing, changes to your site appear in the [site's history](https://support.wix.com/en/article/viewing-and-managing-your-site-history).
+ *
+ * When you call this API, you must pass a header called `wix-site-id` whose value is the ID of the site you want to publish. Learn more about
+ * working with [API keys and site IDs](https://dev.wix.com/docs/rest/articles/getting-started/api-keys#create-and-use-api-keys).
+ *
+ * >**Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.
+ * @public
+ * @permissionId METASITE.UPDATE
+ * @fqn wix.site.v1.SitePublisher.PublishSite
+ */
+export declare function publishSite(): Promise<void>;
+/**
+ * Duplicates a site with a new site name.
+ *
+ * > **Note:** When you duplicate a site, some business-related content such as store orders, contacts, invoices, and 3rd-party app settings are not be included.
+ * > The duplicated site won’t have a domain or any Premium capabilities.
+ *
+ * Any installed apps that can be used only on sites with a Premium Plan, will be copied to the duplicated site and
+ * will appear unactivated. Once the site is upgraded, the app will be available for use.
+ *
+ * > **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.
+ * @param sourceSiteId - ID of the site to duplicated.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options
+ * @requiredField options.siteDisplayName
+ * @requiredField sourceSiteId
+ * @permissionId my-account.duplicate-site
+ * @fqn com.wix.site.actions.SiteActionsService.DuplicateSite
+ */
+export declare function duplicateSite(sourceSiteId: string, options: DuplicateSiteOptions): Promise<DuplicateSiteResponse & DuplicateSiteResponseNonNullableFields>;
+export interface DuplicateSiteOptions {
+    /**
+     * Display name for the new site.
+     * @minLength 1
+     * @maxLength 40
+     */
+    siteDisplayName: string;
+}
+/**
+ * This endpoint enables you to delete multiple sites.
+ *
+ * This is not a permanent delete. Sites are moved to the trash bin and can be restored through site collaborators.
+ *
+ * Learn more about [deleting multiple sites](https://support.wix.com/en/article/moving-a-site-to-trash).
+ *
+ * > **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.
+ * @param ids - Site IDs.
+ *
+ * Min: 1 site ID <br>
+ * Max: 20 site IDs
+ * @public
+ * @documentationMaturity preview
+ * @requiredField ids
+ * @permissionId my-account.delete-site
+ * @fqn com.wix.site.actions.SiteActionsService.BulkDeleteSite
+ */
+export declare function bulkDeleteSite(ids: string[]): Promise<BulkDeleteSiteResponse & BulkDeleteSiteResponseNonNullableFields>;
+export {};

package/build/internal/es/src/site-actions-v1-site-actions-site-actions.universal.js

@@ -0,0 +1,123 @@
+import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';
+import { renameKeysFromSDKRequestToRESTRequest, renameKeysFromRESTResponseToSDKResponse, } from '@wix/sdk-runtime/rename-all-nested-keys';
+import * as ambassadorWixSiteActionsV1SiteActions from './site-actions-v1-site-actions-site-actions.http.js';
+/**
+ * Publishes a site.
+ *
+ * Publishing a site makes any changes previously saved on the site available on the internet.
+ * After publishing, changes to your site appear in the [site's history](https://support.wix.com/en/article/viewing-and-managing-your-site-history).
+ *
+ * When you call this API, you must pass a header called `wix-site-id` whose value is the ID of the site you want to publish. Learn more about
+ * working with [API keys and site IDs](https://dev.wix.com/docs/rest/articles/getting-started/api-keys#create-and-use-api-keys).
+ *
+ * >**Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.
+ * @public
+ * @permissionId METASITE.UPDATE
+ * @fqn wix.site.v1.SitePublisher.PublishSite
+ */
+export async function publishSite() {
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[0];
+    const payload = renameKeysFromSDKRequestToRESTRequest({});
+    const reqOpts = ambassadorWixSiteActionsV1SiteActions.publishSite(payload);
+    sideEffects?.onSiteCall?.();
+    try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+    }
+    catch (err) {
+        const transformedError = sdkTransformError(err, {
+            spreadPathsToArguments: {},
+            explicitPathsToArguments: {},
+            singleArgumentUnchanged: false,
+        }, []);
+        sideEffects?.onError?.(err);
+        throw transformedError;
+    }
+}
+/**
+ * Duplicates a site with a new site name.
+ *
+ * > **Note:** When you duplicate a site, some business-related content such as store orders, contacts, invoices, and 3rd-party app settings are not be included.
+ * > The duplicated site won’t have a domain or any Premium capabilities.
+ *
+ * Any installed apps that can be used only on sites with a Premium Plan, will be copied to the duplicated site and
+ * will appear unactivated. Once the site is upgraded, the app will be available for use.
+ *
+ * > **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.
+ * @param sourceSiteId - ID of the site to duplicated.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options
+ * @requiredField options.siteDisplayName
+ * @requiredField sourceSiteId
+ * @permissionId my-account.duplicate-site
+ * @fqn com.wix.site.actions.SiteActionsService.DuplicateSite
+ */
+export async function duplicateSite(sourceSiteId, options) {
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[2];
+    const payload = renameKeysFromSDKRequestToRESTRequest({
+        sourceSiteId: sourceSiteId,
+        siteDisplayName: options?.siteDisplayName,
+    });
+    const reqOpts = ambassadorWixSiteActionsV1SiteActions.duplicateSite(payload);
+    sideEffects?.onSiteCall?.();
+    try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+        return renameKeysFromRESTResponseToSDKResponse(result.data);
+    }
+    catch (err) {
+        const transformedError = sdkTransformError(err, {
+            spreadPathsToArguments: {},
+            explicitPathsToArguments: {
+                sourceSiteId: '$[0]',
+                siteDisplayName: '$[1].siteDisplayName',
+            },
+            singleArgumentUnchanged: false,
+        }, ['sourceSiteId', 'options']);
+        sideEffects?.onError?.(err);
+        throw transformedError;
+    }
+}
+/**
+ * This endpoint enables you to delete multiple sites.
+ *
+ * This is not a permanent delete. Sites are moved to the trash bin and can be restored through site collaborators.
+ *
+ * Learn more about [deleting multiple sites](https://support.wix.com/en/article/moving-a-site-to-trash).
+ *
+ * > **Important:** This call requires an account level API key and cannot be authenticated with the standard authorization header.
+ * @param ids - Site IDs.
+ *
+ * Min: 1 site ID <br>
+ * Max: 20 site IDs
+ * @public
+ * @documentationMaturity preview
+ * @requiredField ids
+ * @permissionId my-account.delete-site
+ * @fqn com.wix.site.actions.SiteActionsService.BulkDeleteSite
+ */
+export async function bulkDeleteSite(ids) {
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[1];
+    const payload = renameKeysFromSDKRequestToRESTRequest({ ids: ids });
+    const reqOpts = ambassadorWixSiteActionsV1SiteActions.bulkDeleteSite(payload);
+    sideEffects?.onSiteCall?.();
+    try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+        return renameKeysFromRESTResponseToSDKResponse(result.data);
+    }
+    catch (err) {
+        const transformedError = sdkTransformError(err, {
+            spreadPathsToArguments: {},
+            explicitPathsToArguments: { ids: '$[0]' },
+            singleArgumentUnchanged: false,
+        }, ['ids']);
+        sideEffects?.onError?.(err);
+        throw transformedError;
+    }
+}
+//# sourceMappingURL=site-actions-v1-site-actions-site-actions.universal.js.map

package/build/internal/es/src/site-actions-v1-site-actions-site-actions.universal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"site-actions-v1-site-actions-site-actions.universal.js","sourceRoot":"","sources":["../../../../src/site-actions-v1-site-actions-site-actions.universal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACvF,OAAO,EACL,qCAAqC,EACrC,uCAAuC,GACxC,MAAM,yCAAyC,CAAC;AAEjD,OAAO,KAAK,qCAAqC,MAAM,qDAAqD,CAAC;AAqH7G;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW;IAC/B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC,EAAE,CAAC,CAAC;IAE1D,MAAM,OAAO,GAAG,qCAAqC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAE3E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE;YAC5B,uBAAuB,EAAE,KAAK;SAC/B,EACD,EAAE,CACH,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,YAAoB,EACpB,OAA6B;IAE7B,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC;QACpD,YAAY,EAAE,YAAY;QAC1B,eAAe,EAAE,OAAO,EAAE,eAAe;KAC1C,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,qCAAqC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAE7E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE;gBACxB,YAAY,EAAE,MAAM;gBACpB,eAAe,EAAE,sBAAsB;aACxC;YACD,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,cAAc,EAAE,SAAS,CAAC,CAC5B,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC;AAWD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,GAAa;IAEb,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,OAAO,GAAG,qCAAqC,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC;IAEpE,MAAM,OAAO,GAAG,qCAAqC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAE9E,WAAW,EAAE,UAAU,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACjD,WAAW,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC;QAEjC,OAAO,uCAAuC,CAAC,MAAM,CAAC,IAAI,CAAE,CAAC;IAC/D,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,GAAG,EACH;YACE,sBAAsB,EAAE,EAAE;YAC1B,wBAAwB,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE;YACzC,uBAAuB,EAAE,KAAK;SAC/B,EACD,CAAC,KAAK,CAAC,CACR,CAAC;QACF,WAAW,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,gBAAgB,CAAC;IACzB,CAAC;AACH,CAAC"}

package/meta/package.json

@@ -0,0 +1,3 @@
+{
+  "main": "../build/cjs/meta.js"
+}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@wix/auto_sdk_sites_site-actions",
+  "version": "1.0.0",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "keywords": [],
+  "sideEffects": false,
+  "main": "./build/cjs/index.js",
+  "types": "./build/es/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./build/es/index.js",
+      "require": "./build/cjs/index.js",
+      "types": "./build/es/index.d.ts"
+    },
+    "./package.json": "./package.json",
+    "./meta": {
+      "import": "./build/es/meta.js",
+      "require": "./build/cjs/meta.js",
+      "types": "./build/es/meta.d.ts"
+    }
+  },
+  "files": [
+    "build",
+    "meta",
+    "service-plugins"
+  ],
+  "dependencies": {
+    "@wix/sdk-runtime": "^0.3.42",
+    "@wix/sdk-types": "^1.13.9"
+  },
+  "devDependencies": {
+    "typescript": "^5.3.2"
+  },
+  "scripts": {
+    "build": "tsc -b tsconfig.json tsconfig.esm.json tsconfig.internal.json tsconfig.internal.esm.json",
+    "test": ":"
+  },
+  "wix": {
+    "artifact": {
+      "artifactId": "auto-sdk-sites-site-actions",
+      "groupId": "com.wixpress.public-sdk-dependencies"
+    },
+    "sdkDependency": {
+      "fqdnNamespace": "siteActions",
+      "fqdn": "wix.site_actions.v1.site_actions"
+    }
+  },
+  "falconPackageHash": "d45d6551032bd0a14c5eef5d18c0d20ea7c8e0446db70c5aef41133b"
+}