@salesforce/b2c-tooling-sdk 1.24.2 → 2.0.0

package/dist/esm/clients/scapi-scripts.generated.d.ts

@@ -0,0 +1,392 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    "/organizations/{organizationId}/code-versions": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["getCodeVersions"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/organizations/{organizationId}/code-versions/{codeVersionId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["getCodeVersion"];
+        put: operations["createCodeVersion"];
+        post?: never;
+        delete: operations["deleteCodeVersion"];
+        options?: never;
+        head?: never;
+        patch: operations["updateCodeVersion"];
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        OrganizationId: string;
+        /**
+         * Format: int32
+         * @default 0
+         */
+        Total: number;
+        ResultBase: {
+            /** Format: int32 */
+            limit: number;
+            total: components["schemas"]["Total"];
+        };
+        CodeVersion: {
+            id?: string;
+            active?: boolean;
+            cartridges?: string[];
+            compatibilityMode?: string;
+            /** Format: date-time */
+            activationTime?: string;
+            /** Format: date-time */
+            lastModificationTime?: string;
+            rollback?: boolean;
+            /** Format: int64 */
+            totalSize?: number;
+            webDavUrl?: string;
+        };
+        CodeVersionResult: {
+            data?: components["schemas"]["CodeVersion"][];
+        } & components["schemas"]["ResultBase"];
+        ErrorResponse: {
+            title: string;
+            type: string;
+            detail: string;
+            instance?: string;
+        } & {
+            [key: string]: unknown;
+        };
+    };
+    responses: {
+        /** @description Your access token is invalid or expired and can’t be used to identify a user. */
+        "401unauthorized": {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": components["schemas"]["ErrorResponse"];
+            };
+        };
+        /** @description Forbidden. Your access token is valid, but you don’t have the required permissions to access the resource. */
+        "403forbidden": {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": components["schemas"]["ErrorResponse"];
+            };
+        };
+    };
+    parameters: {
+        organizationId: components["schemas"]["OrganizationId"];
+        expand: "size"[];
+        codeVersionId: string;
+    };
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    getCodeVersions: {
+        parameters: {
+            query?: {
+                expand?: "size"[];
+            };
+            header?: never;
+            path: {
+                organizationId: components["schemas"]["OrganizationId"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description List of code versions successfully retrieved. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CodeVersionResult"];
+                };
+            };
+            /** @description Your access token is invalid or expired and can’t be used to identify a user. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Forbidden. Your access token is valid, but you don’t have the required permissions to access the resource. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
+    getCodeVersion: {
+        parameters: {
+            query?: {
+                expand?: "size"[];
+            };
+            header?: never;
+            path: {
+                organizationId: components["schemas"]["OrganizationId"];
+                codeVersionId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Code version successfully retrieved. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CodeVersion"];
+                };
+            };
+            /** @description Your access token is invalid or expired and can’t be used to identify a user. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Forbidden. Your access token is valid, but you don’t have the required permissions to access the resource. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Code version not found. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
+    createCodeVersion: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                organizationId: components["schemas"]["OrganizationId"];
+                codeVersionId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Code version successfully replaced. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CodeVersion"];
+                };
+            };
+            /** @description Code version successfully created. */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CodeVersion"];
+                };
+            };
+            /** @description Your access token is invalid or expired and can’t be used to identify a user. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Forbidden. Your access token is valid, but you don’t have the required permissions to access the resource. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description A code version with the given ID already exists. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
+    deleteCodeVersion: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                organizationId: components["schemas"]["OrganizationId"];
+                codeVersionId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Code version successfully deleted. */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description The active code version cannot be deleted. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Your access token is invalid or expired and can’t be used to identify a user. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Forbidden. Your access token is valid, but you don’t have the required permissions to access the resource. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Code version not found. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
+    updateCodeVersion: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                organizationId: components["schemas"]["OrganizationId"];
+                codeVersionId: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CodeVersion"];
+            };
+        };
+        responses: {
+            /** @description Code version successfully updated. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CodeVersion"];
+                };
+            };
+            /** @description The active code version cannot be modified. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Your access token is invalid or expired and can’t be used to identify a user. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Forbidden. Your access token is valid, but you don’t have the required permissions to access the resource. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description Code version not found. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+            /** @description A code version with the given ID already exists (when renaming). */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["ErrorResponse"];
+                };
+            };
+        };
+    };
+}

package/dist/esm/clients/scapi-scripts.generated.js

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export {};
+//# sourceMappingURL=scapi-scripts.generated.js.map

package/dist/esm/clients/scapi-scripts.generated.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scapi-scripts.generated.js","sourceRoot":"","sources":["../../../src/clients/scapi-scripts.generated.ts"],"names":[],"mappings":"AAAA;;;GAGG"}

package/dist/esm/clients/scapi-scripts.js

@@ -0,0 +1,12 @@
+import { buildScapiClient } from './scapi-client-factory.js';
+export const SCAPI_SCRIPTS_READ_SCOPES = ['sfcc.scripts'];
+export const SCAPI_SCRIPTS_RW_SCOPES = ['sfcc.scripts.rw'];
+export function createScapiScriptsClient(config, auth) {
+    return buildScapiClient({
+        pathSegment: 'dx/scripts/v1',
+        domainKey: 'scapi-scripts',
+        defaultScopes: SCAPI_SCRIPTS_RW_SCOPES,
+        logPrefix: 'SCAPI-SCRIPTS',
+    }, config, auth);
+}
+//# sourceMappingURL=scapi-scripts.js.map

package/dist/esm/clients/scapi-scripts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scapi-scripts.js","sourceRoot":"","sources":["../../../src/clients/scapi-scripts.ts"],"names":[],"mappings":"AAQA,OAAO,EAAC,gBAAgB,EAAyB,MAAM,2BAA2B,CAAC;AASnF,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,cAAc,CAAC,CAAC;AAC1D,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,iBAAiB,CAAC,CAAC;AAI3D,MAAM,UAAU,wBAAwB,CAAC,MAAgC,EAAE,IAAkB;IAC3F,OAAO,gBAAgB,CACrB;QACE,WAAW,EAAE,eAAe;QAC5B,SAAS,EAAE,eAAe;QAC1B,aAAa,EAAE,uBAAuB;QACtC,SAAS,EAAE,eAAe;KAC3B,EACD,MAAM,EACN,IAAI,CACL,CAAC;AACJ,CAAC"}

package/dist/esm/clients/scapi-sites.d.ts

@@ -0,0 +1,26 @@
+import type { Client } from 'openapi-fetch';
+import type { AuthStrategy } from '../auth/types.js';
+import type { paths, components } from './scapi-sites.generated.js';
+import { type ScapiClientConfig } from './scapi-client-factory.js';
+import { buildTenantScope, toOrganizationId, normalizeTenantId } from './custom-apis.js';
+import type { ScopeCascade } from './middleware.js';
+export { toOrganizationId, normalizeTenantId, buildTenantScope };
+export type { paths, components };
+export type ScapiSitesClient = Client<paths>;
+export type ScapiSitesError = components['schemas']['ErrorResponse'];
+export type Site = components['schemas']['Site'];
+export type Sites = components['schemas']['Sites'];
+export type SiteSearchResult = components['schemas']['SiteSearchResult'];
+export type SiteCustomCartridges = components['schemas']['SiteCustomCartridges'];
+/**
+ * Per-operation scope cascade for SCAPI Sites.
+ *
+ * The Sites API exposes both read and cartridge-path write operations and
+ * supports both a read-only (`sfcc.sites`) and read-write (`sfcc.sites.rw`) scope. A given API
+ * client may have been granted only one of them, so reads try `rw` first
+ * (which also grants read) and fall back to the read-only scope. Write
+ * operations use the rw tier exclusively.
+ */
+export declare const SCAPI_SITES_CASCADE: ScopeCascade;
+export type ScapiSitesClientConfig = ScapiClientConfig;
+export declare function createScapiSitesClient(config: ScapiSitesClientConfig, auth: AuthStrategy): ScapiSitesClient;