@sixtyninecommerce/admin 0.8.0 → 0.10.0

package/dist/platform/organization-settings.js

@@ -0,0 +1,42 @@
+import { NotFoundError } from '@sixtyninecommerce/core';
+import { requireHumanSession } from './guard.js';
+// Through `organization(id)`, like `members`: the engine applies the organization reads' access
+// rule there and answers null for an unknown id. A separate document rather than a field of every
+// organization read, so `get`/`list` keep working against an engine older than the field.
+export const ORGANIZATION_SETTINGS_OVERRIDES_QUERY = /* GraphQL */ `
+  query PlatformOrganizationSettingsOverrides($id: ID!) {
+    organization(id: $id) {
+      id
+      settingsOverrides {
+        channelId
+        channelCode
+        group
+        overriddenAt
+      }
+    }
+  }
+`;
+export function createOrganizationSettingsMethods(transport, config) {
+    // As in `organizations.ts`: a SuperAdmin needs no tenant, and an organization admin's
+    // workspace tenant is left alone.
+    const unscoped = (call) => ({ ...call, allowUnscoped: true });
+    return {
+        async settingsOverrides(organizationId, call) {
+            requireHumanSession(config);
+            const data = await transport.graphql({
+                api: 'admin',
+                query: ORGANIZATION_SETTINGS_OVERRIDES_QUERY,
+                variables: { id: organizationId },
+            }, unscoped(call));
+            if (!data.organization) {
+                throw new NotFoundError({
+                    code: 'ORGANIZATION_NOT_FOUND',
+                    message: `No organization has the id ${organizationId}.`,
+                    status: 404,
+                    service: 'vendure',
+                });
+            }
+            return data.organization.settingsOverrides;
+        },
+    };
+}

package/dist/platform/organization-sharing.d.ts

@@ -0,0 +1,172 @@
+import type { Transport } from '@sixtyninecommerce/core';
+import type { AdminClientConfig } from '../client.js';
+import type { Call } from '../types.js';
+/**
+ * The kinds of data the platform can share across an organization's stores
+ * (multi-region spec §6), in the engine's catalog order. The catalog only
+ * grows, so a newer engine may answer a kind this SDK does not name yet.
+ */
+export type OrganizationSharingKind = 'catalog' | 'collections' | 'customer_groups' | 'stock_locations' | 'customers' | 'settings.email' | 'settings.branding' | 'settings.returns' | 'settings.reviews' | 'settings.quotes' | 'settings.age_verification' | 'settings.tax_display' | 'settings.numbering_formats' | 'settings.seo' | 'entitlements' | 'tax_classes' | 'roles' | 'cms_templates' | 'events_api';
+/** Where one organization stands on one sharing kind. */
+export interface OrganizationSharingKindState {
+    kind: OrganizationSharingKind | (string & {});
+    /** What the organization's Sharing policy page calls it. */
+    name: string;
+    /** The platform (a SuperAdmin) allows this organization to share the kind. */
+    allowed: boolean;
+    /** The organization shares it. Only ever true while `allowed`. */
+    enabled: boolean;
+    /** Member stores cannot override the organization's value. Only ever true while `enabled`. */
+    locked: boolean;
+    /** Whether the kind can be locked at all. `settings.tax_display` never can. */
+    lockable: boolean;
+    /** The multi-region phase that makes the kind take effect; until then it is only a setting. */
+    phase: number;
+    /**
+     * Shared by every organization with no policy (today `entitlements` and
+     * `roles`): always `allowed` and `enabled`, never `locked`. `allow`,
+     * `disallow` and `set` on it are refused `ORGANIZATION_SHARING_KIND_ALWAYS_ON`.
+     */
+    alwaysOn: boolean;
+}
+/**
+ * A settings kind being switched off in the background: more member stores use
+ * the organization's values than one request copies into, so a job copies them
+ * in batches, then switches the kind off about 35 s after the last copy (while
+ * `storesDone` equals `storesTotal` the run is still `running`). Until then the
+ * kind stays on for every store, and changing it is refused
+ * `ORGANIZATION_SETTINGS_SWITCH_OFF_CONFLICT` (409 `ConflictError`).
+ */
+export interface OrganizationSettingsSwitchOff {
+    id: string;
+    organizationId: string;
+    kind: OrganizationSharingKind | (string & {});
+    /**
+     * `running` (the kind is still on), `completed` (it is off; every store kept
+     * the organization's values) or `failed` (it is still on; switch it off again
+     * to retry). A string on the wire: a newer engine may add a status.
+     */
+    status: 'running' | 'completed' | 'failed' | (string & {});
+    /** Stores copied into so far. */
+    storesDone: number;
+    /** Stores copied into so far plus the ones still to copy, as of the last batch. */
+    storesTotal: number;
+    /** A failed run's code, such as `ORGANIZATION_SETTINGS_COPY_FAILED`. */
+    errorCode: string | null;
+    /** A failed run's message for the organization admin. */
+    errorMessage: string | null;
+    createdAt: string;
+    updatedAt: string;
+    /** When it completed or failed. */
+    finishedAt: string | null;
+}
+/**
+ * One settings kind and its latest background switch-off while that agrees with
+ * the kind: a `running` run always, a `failed` one while the kind is still on, a
+ * `completed` one while it is off, and a settled one only until the kind's
+ * policy changes again. Null otherwise, and when it never needed one.
+ */
+export interface OrganizationSettingsKindSwitchOff {
+    kind: OrganizationSharingKind | (string & {});
+    switchOff: OrganizationSettingsSwitchOff | null;
+}
+export interface OrganizationSharingKindInput {
+    organizationId: string;
+    kind: OrganizationSharingKind | (string & {});
+}
+/** Only the flags given change; an omitted one stays as it is. */
+export interface SetOrganizationSharingKindInput extends OrganizationSharingKindInput {
+    enabled?: boolean;
+    locked?: boolean;
+}
+/**
+ * `admin.platform.organizations.sharing` — the organization's sharing policy,
+ * two gates deep (multi-region spec §6, §9): the platform ALLOWS a kind, and
+ * the organization admin ENABLES an allowed kind and LOCKS a lockable one for
+ * every member store.
+ *
+ * `allow` and `disallow` are SuperAdmin-only. `get` and `set` also answer the
+ * organization admin for its own organization, with the workspace channel as
+ * the tenant (see `admin.platform.organizations`). Every method answers the
+ * kind's state after the call; `get` answers every kind, the ones not allowed
+ * included. Unknown organization: `ORGANIZATION_NOT_FOUND` (404); a kind the
+ * engine does not know: `ORGANIZATION_SHARING_KIND_INVALID` (400); an
+ * `alwaysOn` kind to `allow`, `disallow` or `set`:
+ * `ORGANIZATION_SHARING_KIND_ALWAYS_ON` (422 `BusinessRuleError`).
+ *
+ * **Kinds the platform has not released yet.** A kind whose `phase` is later
+ * than the engine's released one can be read, switched off and withdrawn, but
+ * allowing it, switching it on or locking it is refused
+ * `ORGANIZATION_SHARING_KIND_NOT_YET_AVAILABLE` (422 `BusinessRuleError`): no
+ * store, worker or dashboard of that release handles it yet. It is refused,
+ * never queued: allow the kind again once the platform ships it.
+ */
+export interface OrganizationSharingModule {
+    get(organizationId: string, call?: Call): Promise<OrganizationSharingKindState[]>;
+    /**
+     * Starts switched off and unlocked. Allowing an allowed kind changes nothing.
+     * A kind the platform has not released yet: `ORGANIZATION_SHARING_KIND_NOT_YET_AVAILABLE` (422).
+     */
+    allow(input: OrganizationSharingKindInput, call?: Call): Promise<OrganizationSharingKindState>;
+    /**
+     * Refused with `ORGANIZATION_SHARING_KIND_ENABLED_CONFLICT` (409) while the
+     * organization has the kind switched on. Withdrawing a kind that is not
+     * allowed changes nothing.
+     */
+    disallow(input: OrganizationSharingKindInput, call?: Call): Promise<OrganizationSharingKindState>;
+    /**
+     * Refusals: `ORGANIZATION_SHARING_KIND_NOT_ALLOWED` (403) for a kind the
+     * platform has not allowed; `ORGANIZATION_SHARING_KIND_NOT_YET_AVAILABLE` (422)
+     * to switch on or lock a kind the platform has not released yet (switching it
+     * off stays open); `ORGANIZATION_SHARING_LOCK_INVALID` (400) to lock
+     * a kind that cannot be locked; `ORGANIZATION_SHARING_DISABLED_LOCK_INVALID`
+     * (400) for any change that would leave the kind locked while off — send
+     * `{ enabled: false, locked: false }` to switch a locked kind off;
+     * `ORGANIZATION_SHARING_KIND_IN_USE_CONFLICT` (409) to switch off a kind
+     * something still depends on; `ORGANIZATION_TAX_MODE_MISMATCH` (422
+     * `BusinessRuleError`) to switch `catalog` on while a member store's
+     * `pricesIncludeTax` differs from the organization's (the message names the
+     * stores); `ORGANIZATION_ACCESS_DENIED` (403) for another organization.
+     * While `catalog` is on, a change of `pricesIncludeTax` on the organization's
+     * workspace or any member store is refused with
+     * `ORGANIZATION_TAX_MODE_LOCKED` (422).
+     *
+     * Switching a `settings.*` kind off first copies the organization's current
+     * values into every member store that uses them, in the same call, so their
+     * customers see no change. A failed copy changes nothing (422):
+     * `ORGANIZATION_SETTINGS_COPY_FAILED`, `ORGANIZATION_SETTINGS_COPY_UNAVAILABLE`,
+     * `ORGANIZATION_SETTINGS_NOT_COPIED`. When more stores use them than one
+     * request copies into, the answer comes at once with the kind still
+     * `enabled`: the switch-off runs in the background ({@link switchOffs}). While
+     * it runs, `set` and `disallow` on that kind are refused
+     * `ORGANIZATION_SETTINGS_SWITCH_OFF_CONFLICT` (409).
+     */
+    set(input: SetOrganizationSharingKindInput, call?: Call): Promise<OrganizationSharingKindState>;
+    /**
+     * Each settings kind's latest background switch-off while it agrees with the
+     * kind (see {@link OrganizationSettingsKindSwitchOff}), in catalog order: poll
+     * it while one is `running` to show "n of m stores". Not a history: a failed
+     * run whose kind was switched off later reads null. Same callers as `get`.
+     * Needs a platform release that runs switch-offs in the background: an older
+     * engine fails the call as a whole.
+     */
+    switchOffs(organizationId: string, call?: Call): Promise<OrganizationSettingsKindSwitchOff[]>;
+    /**
+     * One background switch-off by id; null when there is none, or it belongs to
+     * another organization (to an organization admin). Same callers and release
+     * as {@link switchOffs}.
+     */
+    switchOff(id: string, call?: Call): Promise<OrganizationSettingsSwitchOff | null>;
+}
+/**
+ * Its own document, never part of `STATE_FIELDS`: `get`, `allow`, `disallow`
+ * and `set` keep working against an engine that predates background
+ * switch-offs, which would fail any document selecting `switchOff` whole.
+ */
+export declare const ORGANIZATION_SETTINGS_SWITCH_OFFS_QUERY = "\n  query PlatformOrganizationSettingsSwitchOffs($organizationId: ID!) {\n    organizationSharingPolicy(organizationId: $organizationId) {\n      kind\n      switchOff { \n  id\n  organizationId\n  kind\n  status\n  storesDone\n  storesTotal\n  errorCode\n  errorMessage\n  createdAt\n  updatedAt\n  finishedAt\n }\n    }\n  }\n";
+export declare const ORGANIZATION_SETTINGS_SWITCH_OFF_QUERY = "\n  query PlatformOrganizationSettingsSwitchOff($id: ID!) {\n    organizationSettingsSwitchOff(id: $id) { \n  id\n  organizationId\n  kind\n  status\n  storesDone\n  storesTotal\n  errorCode\n  errorMessage\n  createdAt\n  updatedAt\n  finishedAt\n }\n  }\n";
+export declare const ORGANIZATION_SHARING_POLICY_QUERY = "\n  query PlatformOrganizationSharingPolicy($organizationId: ID!) {\n    organizationSharingPolicy(organizationId: $organizationId) { \n  kind\n  name\n  allowed\n  enabled\n  locked\n  lockable\n  phase\n  alwaysOn\n }\n  }\n";
+export declare const ALLOW_ORGANIZATION_SHARING_KIND_MUTATION = "\n  mutation PlatformAllowOrganizationSharingKind($organizationId: ID!, $kind: String!) {\n    allowOrganizationSharingKind(organizationId: $organizationId, kind: $kind) { \n  kind\n  name\n  allowed\n  enabled\n  locked\n  lockable\n  phase\n  alwaysOn\n }\n  }\n";
+export declare const DISALLOW_ORGANIZATION_SHARING_KIND_MUTATION = "\n  mutation PlatformDisallowOrganizationSharingKind($organizationId: ID!, $kind: String!) {\n    disallowOrganizationSharingKind(organizationId: $organizationId, kind: $kind) { \n  kind\n  name\n  allowed\n  enabled\n  locked\n  lockable\n  phase\n  alwaysOn\n }\n  }\n";
+export declare const SET_ORGANIZATION_SHARING_KIND_MUTATION = "\n  mutation PlatformSetOrganizationSharingKind(\n    $organizationId: ID!\n    $kind: String!\n    $enabled: Boolean\n    $locked: Boolean\n  ) {\n    setOrganizationSharingKind(\n      organizationId: $organizationId\n      kind: $kind\n      enabled: $enabled\n      locked: $locked\n    ) { \n  kind\n  name\n  allowed\n  enabled\n  locked\n  lockable\n  phase\n  alwaysOn\n }\n  }\n";
+export declare function createOrganizationSharingModule(transport: Transport, config: AdminClientConfig): OrganizationSharingModule;

package/dist/platform/organization-sharing.js

@@ -0,0 +1,120 @@
+import { requireHumanSession } from './guard.js';
+const STATE_FIELDS = /* GraphQL */ `
+  kind
+  name
+  allowed
+  enabled
+  locked
+  lockable
+  phase
+  alwaysOn
+`;
+const SWITCH_OFF_FIELDS = /* GraphQL */ `
+  id
+  organizationId
+  kind
+  status
+  storesDone
+  storesTotal
+  errorCode
+  errorMessage
+  createdAt
+  updatedAt
+  finishedAt
+`;
+/**
+ * Its own document, never part of `STATE_FIELDS`: `get`, `allow`, `disallow`
+ * and `set` keep working against an engine that predates background
+ * switch-offs, which would fail any document selecting `switchOff` whole.
+ */
+export const ORGANIZATION_SETTINGS_SWITCH_OFFS_QUERY = /* GraphQL */ `
+  query PlatformOrganizationSettingsSwitchOffs($organizationId: ID!) {
+    organizationSharingPolicy(organizationId: $organizationId) {
+      kind
+      switchOff { ${SWITCH_OFF_FIELDS} }
+    }
+  }
+`;
+export const ORGANIZATION_SETTINGS_SWITCH_OFF_QUERY = /* GraphQL */ `
+  query PlatformOrganizationSettingsSwitchOff($id: ID!) {
+    organizationSettingsSwitchOff(id: $id) { ${SWITCH_OFF_FIELDS} }
+  }
+`;
+export const ORGANIZATION_SHARING_POLICY_QUERY = /* GraphQL */ `
+  query PlatformOrganizationSharingPolicy($organizationId: ID!) {
+    organizationSharingPolicy(organizationId: $organizationId) { ${STATE_FIELDS} }
+  }
+`;
+export const ALLOW_ORGANIZATION_SHARING_KIND_MUTATION = /* GraphQL */ `
+  mutation PlatformAllowOrganizationSharingKind($organizationId: ID!, $kind: String!) {
+    allowOrganizationSharingKind(organizationId: $organizationId, kind: $kind) { ${STATE_FIELDS} }
+  }
+`;
+export const DISALLOW_ORGANIZATION_SHARING_KIND_MUTATION = /* GraphQL */ `
+  mutation PlatformDisallowOrganizationSharingKind($organizationId: ID!, $kind: String!) {
+    disallowOrganizationSharingKind(organizationId: $organizationId, kind: $kind) { ${STATE_FIELDS} }
+  }
+`;
+export const SET_ORGANIZATION_SHARING_KIND_MUTATION = /* GraphQL */ `
+  mutation PlatformSetOrganizationSharingKind(
+    $organizationId: ID!
+    $kind: String!
+    $enabled: Boolean
+    $locked: Boolean
+  ) {
+    setOrganizationSharingKind(
+      organizationId: $organizationId
+      kind: $kind
+      enabled: $enabled
+      locked: $locked
+    ) { ${STATE_FIELDS} }
+  }
+`;
+export function createOrganizationSharingModule(transport, config) {
+    // As in `organizations.ts`: a SuperAdmin needs no tenant, and an
+    // organization admin's workspace tenant is left alone.
+    const unscoped = (call) => ({ ...call, allowUnscoped: true });
+    const write = async (field, query, variables, call) => {
+        requireHumanSession(config);
+        const data = await transport.graphql({ api: 'admin', query, variables }, unscoped(call));
+        return data[field];
+    };
+    return {
+        async get(organizationId, call) {
+            requireHumanSession(config);
+            const data = await transport.graphql({ api: 'admin', query: ORGANIZATION_SHARING_POLICY_QUERY, variables: { organizationId } }, unscoped(call));
+            return data.organizationSharingPolicy;
+        },
+        allow(input, call) {
+            return write('allowOrganizationSharingKind', ALLOW_ORGANIZATION_SHARING_KIND_MUTATION, { organizationId: input.organizationId, kind: input.kind }, call);
+        },
+        disallow(input, call) {
+            return write('disallowOrganizationSharingKind', DISALLOW_ORGANIZATION_SHARING_KIND_MUTATION, { organizationId: input.organizationId, kind: input.kind }, call);
+        },
+        set(input, call) {
+            // Named field by field: `enabled: false` is a value and is sent; an
+            // omitted flag stays off the wire, which the engine reads as "unchanged".
+            return write('setOrganizationSharingKind', SET_ORGANIZATION_SHARING_KIND_MUTATION, {
+                organizationId: input.organizationId,
+                kind: input.kind,
+                enabled: input.enabled,
+                locked: input.locked,
+            }, call);
+        },
+        async switchOffs(organizationId, call) {
+            requireHumanSession(config);
+            const data = await transport.graphql({
+                api: 'admin',
+                query: ORGANIZATION_SETTINGS_SWITCH_OFFS_QUERY,
+                variables: { organizationId },
+            }, unscoped(call));
+            // Only the settings kinds can be switched off in the background.
+            return data.organizationSharingPolicy.filter((entry) => entry.kind.startsWith('settings.'));
+        },
+        async switchOff(id, call) {
+            requireHumanSession(config);
+            const data = await transport.graphql({ api: 'admin', query: ORGANIZATION_SETTINGS_SWITCH_OFF_QUERY, variables: { id } }, unscoped(call));
+            return data.organizationSettingsSwitchOff;
+        },
+    };
+}

package/dist/platform/organizations.d.ts

@@ -0,0 +1,205 @@
+import { type Page, type Transport } from '@sixtyninecommerce/core';
+import type { AdminClientConfig } from '../client.js';
+import type { Call, ListOptions } from '../types.js';
+import { type OrganizationMembershipMethods } from './organization-membership.js';
+import { type OrganizationSettingsMethods } from './organization-settings.js';
+import { type OrganizationSharingModule } from './organization-sharing.js';
+/** How member stores share customers (multi-region spec §7.3). Values only grow. */
+export type OrganizationCustomerPolicy = 'none' | 'shared_login' | 'shared_record';
+/** Whether every shared product reaches every member store, or a chosen assortment does. */
+export type OrganizationAssortmentMode = 'all' | 'selected';
+/**
+ * A group of stores run together (multi-region spec §5.1). Its workspace is a
+ * channel of its own, `org-<code>`, which owns every record the organization
+ * shares with its member stores.
+ */
+export interface Organization {
+    id: string;
+    /** Immutable: it is the workspace channel's code (`org-<code>`) and every organization role's. */
+    code: string;
+    name: string;
+    hubChannelId: string;
+    /**
+     * The workspace channel. Null only when that channel was hard-deleted
+     * underneath the organization — the link carries no foreign key.
+     * `pricesIncludeTax` is the organization's tax mode: every member store
+     * enters prices the same way (a store with the other mode is refused
+     * `ORGANIZATION_TAX_MODE_MISMATCH`), so it is the mode to start a new
+     * member store from.
+     */
+    hubChannel: {
+        id: string;
+        code: string;
+        pricesIncludeTax: boolean;
+    } | null;
+    /** ISO 4217 code that analytics roll member stores up into. */
+    reportingCurrencyCode: string;
+    /** A string on the wire: a newer server may answer a value this SDK does not name yet. */
+    customerPolicy: OrganizationCustomerPolicy | (string & {});
+    assortmentMode: OrganizationAssortmentMode | (string & {});
+    /** Member stores that still exist. */
+    memberCount: number;
+    /** ISO-8601 UTC. */
+    createdAt: string;
+    updatedAt: string;
+}
+export interface CreateOrganizationInput {
+    /**
+     * 2–40 characters of lowercase letters, digits and single hyphens. It can
+     * never change: it becomes the workspace channel code `org-<code>`, its
+     * storage prefix and every organization role code.
+     */
+    code: string;
+    name: string;
+    /** A Vendure `LanguageCode`, such as `en` or `nl`. */
+    defaultLanguageCode: string;
+    /** A Vendure `CurrencyCode`, such as `EUR`. */
+    defaultCurrencyCode: string;
+    /**
+     * ISO 3166-1 alpha-2. Picks the most specific zone containing it for any
+     * zone id not given. Send a country, or both zone ids — neither is refused
+     * with `ORGANIZATION_ZONE_INVALID`.
+     */
+    country?: string;
+    defaultTaxZoneId?: string;
+    defaultShippingZoneId?: string;
+    /** Defaults to true. */
+    pricesIncludeTax?: boolean;
+    /** Defaults to `defaultCurrencyCode`. */
+    reportingCurrencyCode?: string;
+}
+/** Only the fields given change. The code and the workspace channel never do. */
+export interface UpdateOrganizationInput {
+    id: string;
+    name?: string;
+    reportingCurrencyCode?: string;
+    assortmentMode?: OrganizationAssortmentMode;
+}
+/** A plugin entitlement granted to every member store of an organization. */
+export interface OrganizationPluginEntitlement {
+    id: string;
+    organizationId: string;
+    pluginKey: string;
+    /** ISO-8601 UTC. */
+    connectedAt: string;
+    connectedByUserId: string | null;
+    notes: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface SetOrganizationEntitlementInput {
+    organizationId: string;
+    /** An external plugin key from the platform's plugin catalog, such as `mollie`. */
+    pluginKey: string;
+    /** `true` grants the plugin to every member store; `false` revokes it. */
+    connected: boolean;
+    /**
+     * Operator notes, at most 512 characters. Omitted keeps the notes already
+     * stored; `''` clears them.
+     */
+    notes?: string;
+}
+/**
+ * `admin.platform.organizations.entitlements` — the organization tier of plugin
+ * entitlements. SuperAdmin only.
+ */
+export interface OrganizationEntitlementsModule {
+    /** The organization's own grants, by plugin key. Unknown id: `ORGANIZATION_NOT_FOUND`. */
+    list(organizationId: string, call?: Call): Promise<OrganizationPluginEntitlement[]>;
+    /**
+     * Grant or revoke a plugin for every member store at once, and answer the
+     * organization's grants after the change. Member stores' Engine reads see it
+     * immediately; the plugins service's entitlement gates follow within its
+     * 60-second cache. A store's OWN grant of the same plugin is untouched by a
+     * revoke here. Refused with `INVALID_PLUGIN_KEY`, `INVALID_ENTITLEMENT_NOTES`
+     * (both `ValidationError`) or `ORGANIZATION_NOT_FOUND`.
+     */
+    set(input: SetOrganizationEntitlementInput, call?: Call): Promise<OrganizationPluginEntitlement[]>;
+}
+/**
+ * `admin.platform.organizations` — creating and editing organizations
+ * (multi-region spec §5.1, §9).
+ *
+ * Every method needs a human session: an API token or an app credential is
+ * refused with `PLATFORM_REQUIRES_SESSION` before anything is sent.
+ *
+ * Two kinds of caller:
+ *
+ * - **A SuperAdmin** can call everything, with or without a tenant on the
+ *   client — these are platform-wide operations.
+ * - **An organization admin** (`ManageOrganization`, not a SuperAdmin) can
+ *   call `get`, `getByCode`, `list`, `update`, `members` and
+ *   `settingsOverrides` for its OWN
+ *   organization, and only with the organization's workspace channel as the
+ *   tenant:
+ *   `admin.withTenant({ scope: { kind: 'channel', code: 'org-<code>' } })`, or
+ *   the same `tenant` per call. The server tells whose organization it is from
+ *   the active channel, so anywhere else it is a `PermissionDeniedError` (403):
+ *   `FORBIDDEN` from no tenant or a channel where the caller holds no
+ *   `ManageOrganization`, `ORGANIZATION_ACCESS_DENIED` for another
+ *   organization — whether or not that one exists. `list` answers just its
+ *   own organization; `sharing.get` and `sharing.set` answer the same way.
+ *   `create`, `registerWorkspace`, `join`, `entitlements.*`, `sharing.allow`
+ *   and `sharing.disallow` stay SuperAdmin-only.
+ *
+ *   This SDK resolves a channel code through the CMS channel mirror, where
+ *   `create` registers the workspace. A workspace the mirror does not hold is
+ *   refused `CHANNEL_NOT_FOUND` (404) before the request is sent;
+ *   `registerWorkspace` puts it there.
+ *
+ * None of the writes is deduplicated by an idempotency key (they are Admin
+ * API mutations). `create` is safe to repeat anyway: a second create on the
+ * same code is refused with `ORGANIZATION_CODE_TAKEN` (a `ConflictError`, 409),
+ * so read it back with `getByCode`.
+ */
+export interface PlatformOrganizationsModule extends OrganizationMembershipMethods, OrganizationSettingsMethods {
+    /**
+     * Creates the organization with its workspace channel, the seller that owns
+     * it and its two roles (`org-<code>-admin`, `org-<code>-viewer`), in one
+     * transaction, then registers the workspace in the CMS channel mirror. A
+     * registration that fails does not fail the create — the organization
+     * exists; repair it with {@link registerWorkspace}. SuperAdmin only.
+     * Refusals: `ORGANIZATION_CODE_TAKEN`, `HUB_CHANNEL_CODE_TAKEN`,
+     * `ORGANIZATION_ROLE_CODE_TAKEN` (409); `ORGANIZATION_CODE_INVALID`,
+     * `ORGANIZATION_NAME_INVALID`, `ORGANIZATION_LANGUAGE_INVALID`,
+     * `ORGANIZATION_ZONE_INVALID`, `ORGANIZATION_REPORTING_CURRENCY_INVALID` (400).
+     */
+    create(input: CreateOrganizationInput, call?: Call): Promise<Organization>;
+    /**
+     * Registers the organization's workspace channel in the CMS channel mirror,
+     * which is how a client scoped to `org-<code>` resolves it — the repair for a
+     * `create` whose registration failed. Safe to repeat: a registered workspace
+     * answers the same. SuperAdmin only. Refusals: `ORGANIZATION_NOT_FOUND`,
+     * `ORGANIZATION_WORKSPACE_NOT_FOUND` (404);
+     * `ORGANIZATION_WORKSPACE_REGISTRATION_FAILED` (422 `BusinessRuleError`: the
+     * CMS did not confirm it — try again later).
+     */
+    registerWorkspace(id: string, call?: Call): Promise<Organization>;
+    /**
+     * Name, reporting currency and assortment. Refusals: `ORGANIZATION_NOT_FOUND`
+     * (404), `ORGANIZATION_ACCESS_DENIED` (403), `ORGANIZATION_NAME_INVALID`,
+     * `ORGANIZATION_REPORTING_CURRENCY_INVALID`,
+     * `ORGANIZATION_ASSORTMENT_MODE_INVALID` (400).
+     */
+    update(input: UpdateOrganizationInput, call?: Call): Promise<Organization>;
+    /**
+     * Organizations by name. Pages default to 50; the server caps a page at 100
+     * and walking on with `.next()` or `for await` still reaches every one.
+     */
+    list(options?: ListOptions): Promise<Page<Organization>>;
+    /** Null when no organization has that id. */
+    get(id: string, call?: Call): Promise<Organization | null>;
+    /** The organization code, not the `org-` workspace channel code. Null when none has it. */
+    getByCode(code: string, call?: Call): Promise<Organization | null>;
+    entitlements: OrganizationEntitlementsModule;
+    sharing: OrganizationSharingModule;
+}
+export declare const ORGANIZATIONS_QUERY = "\n  query PlatformOrganizations($options: OrganizationListOptions) {\n    organizations(options: $options) {\n      totalItems\n      items { \n  id\n  code\n  name\n  hubChannelId\n  hubChannel {\n    id\n    code\n    pricesIncludeTax\n  }\n  reportingCurrencyCode\n  customerPolicy\n  assortmentMode\n  memberCount\n  createdAt\n  updatedAt\n }\n    }\n  }\n";
+export declare const ORGANIZATION_QUERY = "\n  query PlatformOrganization($id: ID!) {\n    organization(id: $id) { \n  id\n  code\n  name\n  hubChannelId\n  hubChannel {\n    id\n    code\n    pricesIncludeTax\n  }\n  reportingCurrencyCode\n  customerPolicy\n  assortmentMode\n  memberCount\n  createdAt\n  updatedAt\n }\n  }\n";
+export declare const ORGANIZATION_BY_CODE_QUERY = "\n  query PlatformOrganizationByCode($code: String!) {\n    organizationByCode(code: $code) { \n  id\n  code\n  name\n  hubChannelId\n  hubChannel {\n    id\n    code\n    pricesIncludeTax\n  }\n  reportingCurrencyCode\n  customerPolicy\n  assortmentMode\n  memberCount\n  createdAt\n  updatedAt\n }\n  }\n";
+export declare const CREATE_ORGANIZATION_MUTATION = "\n  mutation PlatformCreateOrganization($input: CreateOrganizationInput!) {\n    createOrganization(input: $input) { \n  id\n  code\n  name\n  hubChannelId\n  hubChannel {\n    id\n    code\n    pricesIncludeTax\n  }\n  reportingCurrencyCode\n  customerPolicy\n  assortmentMode\n  memberCount\n  createdAt\n  updatedAt\n }\n  }\n";
+export declare const REGISTER_ORGANIZATION_WORKSPACE_MUTATION = "\n  mutation PlatformRegisterOrganizationWorkspace($id: ID!) {\n    registerOrganizationWorkspace(id: $id) { \n  id\n  code\n  name\n  hubChannelId\n  hubChannel {\n    id\n    code\n    pricesIncludeTax\n  }\n  reportingCurrencyCode\n  customerPolicy\n  assortmentMode\n  memberCount\n  createdAt\n  updatedAt\n }\n  }\n";
+export declare const UPDATE_ORGANIZATION_MUTATION = "\n  mutation PlatformUpdateOrganization($input: UpdateOrganizationInput!) {\n    updateOrganization(input: $input) { \n  id\n  code\n  name\n  hubChannelId\n  hubChannel {\n    id\n    code\n    pricesIncludeTax\n  }\n  reportingCurrencyCode\n  customerPolicy\n  assortmentMode\n  memberCount\n  createdAt\n  updatedAt\n }\n  }\n";
+export declare const ORGANIZATION_ENTITLEMENTS_QUERY = "\n  query PlatformOrganizationPluginEntitlements($organizationId: ID!) {\n    organizationPluginEntitlements(organizationId: $organizationId) { \n  id\n  organizationId\n  pluginKey\n  connectedAt\n  connectedByUserId\n  notes\n  createdAt\n  updatedAt\n }\n  }\n";
+export declare const SET_ORGANIZATION_ENTITLEMENT_MUTATION = "\n  mutation PlatformSetOrganizationPluginEntitlement(\n    $organizationId: ID!\n    $pluginKey: String!\n    $connected: Boolean!\n    $notes: String\n  ) {\n    setOrganizationPluginEntitlement(\n      organizationId: $organizationId\n      pluginKey: $pluginKey\n      connected: $connected\n      notes: $notes\n    ) { \n  id\n  organizationId\n  pluginKey\n  connectedAt\n  connectedByUserId\n  notes\n  createdAt\n  updatedAt\n }\n  }\n";
+export declare function createPlatformOrganizationsModule(transport: Transport, config: AdminClientConfig): PlatformOrganizationsModule;