@journeybee/sdk 0.1.0 → 0.2.0

package/dist/partner-capabilities.d.ts

@@ -0,0 +1,527 @@
+type CapabilityDescriptor = {
+    contract_version: 1;
+    key: string;
+    version: number;
+    identity: {
+        source: "internal" | "mcp" | "discovery" | "openapi" | "block_builder" | "card_editor" | "navigation";
+        name: string;
+        operationId?: string;
+        method?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+        surface?: "admin" | "partner";
+    };
+    operation: {
+        kind: "read" | "write" | "destructive" | "outbound";
+        risk: "read" | "write" | "destructive" | "financial" | "outbound_communication" | "external_side_effect";
+        approval_policy: "none" | "configurable" | "mandatory";
+    };
+    access: {
+        read: boolean;
+        write: boolean;
+    };
+    actors: readonly ("api_key" | "oauth" | "user" | "service" | "partner")[];
+    requirements: {
+        modules: readonly string[];
+        program_modules: readonly string[];
+        workflow_management: boolean;
+    };
+    scope: {
+        object_definitions: readonly string[];
+        programs: readonly string[];
+        portal_membership: "not_applicable" | "required";
+    };
+    entity_kinds: readonly string[];
+    idempotency: {
+        mode: "none" | "natural" | "key_optional" | "key_required";
+        dry_run: boolean;
+        reversible: boolean;
+    };
+    presentation: {
+        title: string;
+        summary?: string;
+        domain?: string;
+        surface: "admin" | "partner" | "internal";
+    };
+};
+declare const CAPABILITIES: {
+    readonly createPartnerDeal: {
+        readonly contract_version: 1;
+        readonly key: "openapi:partner.createPartnerDeal";
+        readonly version: 1;
+        readonly identity: {
+            readonly source: "openapi";
+            readonly name: "call_endpoint";
+            readonly operationId: "createPartnerDeal";
+            readonly method: "POST";
+            readonly surface: "partner";
+        };
+        readonly operation: {
+            readonly kind: "write";
+            readonly risk: "write";
+            readonly approval_policy: "configurable";
+        };
+        readonly access: {
+            readonly read: false;
+            readonly write: true;
+        };
+        readonly actors: readonly ["partner"];
+        readonly requirements: {
+            readonly modules: readonly ["partner_api"];
+            readonly program_modules: readonly [];
+            readonly workflow_management: false;
+        };
+        readonly scope: {
+            readonly object_definitions: readonly [];
+            readonly programs: readonly [];
+            readonly portal_membership: "not_applicable";
+        };
+        readonly entity_kinds: readonly [];
+        readonly idempotency: {
+            readonly mode: "key_required";
+            readonly dry_run: false;
+            readonly reversible: true;
+        };
+        readonly presentation: {
+            readonly title: "Create a partnership deal";
+            readonly summary: "Custom fields may be required or rule-controlled — call getPartnerDealRequirements first to learn the field/rule constraints. Validation failures return per-field `details` with machine-readable `reason` codes.";
+            readonly domain: "Partner";
+            readonly surface: "partner";
+        };
+    };
+    readonly createPartnerLead: {
+        readonly contract_version: 1;
+        readonly key: "openapi:partner.createPartnerLead";
+        readonly version: 1;
+        readonly identity: {
+            readonly source: "openapi";
+            readonly name: "call_endpoint";
+            readonly operationId: "createPartnerLead";
+            readonly method: "POST";
+            readonly surface: "partner";
+        };
+        readonly operation: {
+            readonly kind: "write";
+            readonly risk: "write";
+            readonly approval_policy: "configurable";
+        };
+        readonly access: {
+            readonly read: false;
+            readonly write: true;
+        };
+        readonly actors: readonly ["partner"];
+        readonly requirements: {
+            readonly modules: readonly ["partner_api"];
+            readonly program_modules: readonly [];
+            readonly workflow_management: false;
+        };
+        readonly scope: {
+            readonly object_definitions: readonly [];
+            readonly programs: readonly [];
+            readonly portal_membership: "not_applicable";
+        };
+        readonly entity_kinds: readonly [];
+        readonly idempotency: {
+            readonly mode: "key_required";
+            readonly dry_run: false;
+            readonly reversible: true;
+        };
+        readonly presentation: {
+            readonly title: "Create a partnership lead";
+            readonly summary: "Custom fields may be required or rule-controlled — call getPartnerLeadRequirements first to learn the field/rule constraints. Validation failures return per-field `details` with machine-readable `reason` codes.";
+            readonly domain: "Partner";
+            readonly surface: "partner";
+        };
+    };
+    readonly getPartnerDeal: {
+        readonly contract_version: 1;
+        readonly key: "openapi:partner.getPartnerDeal";
+        readonly version: 1;
+        readonly identity: {
+            readonly source: "openapi";
+            readonly name: "call_endpoint";
+            readonly operationId: "getPartnerDeal";
+            readonly method: "GET";
+            readonly surface: "partner";
+        };
+        readonly operation: {
+            readonly kind: "read";
+            readonly risk: "read";
+            readonly approval_policy: "none";
+        };
+        readonly access: {
+            readonly read: true;
+            readonly write: false;
+        };
+        readonly actors: readonly ["partner"];
+        readonly requirements: {
+            readonly modules: readonly ["partner_api"];
+            readonly program_modules: readonly [];
+            readonly workflow_management: false;
+        };
+        readonly scope: {
+            readonly object_definitions: readonly [];
+            readonly programs: readonly [];
+            readonly portal_membership: "not_applicable";
+        };
+        readonly entity_kinds: readonly [];
+        readonly idempotency: {
+            readonly mode: "none";
+            readonly dry_run: false;
+            readonly reversible: true;
+        };
+        readonly presentation: {
+            readonly title: "Get a partnership deal";
+            readonly domain: "Partner";
+            readonly surface: "partner";
+        };
+    };
+    readonly getPartnerDealRequirements: {
+        readonly contract_version: 1;
+        readonly key: "openapi:partner.getPartnerDealRequirements";
+        readonly version: 1;
+        readonly identity: {
+            readonly source: "openapi";
+            readonly name: "call_endpoint";
+            readonly operationId: "getPartnerDealRequirements";
+            readonly method: "GET";
+            readonly surface: "partner";
+        };
+        readonly operation: {
+            readonly kind: "read";
+            readonly risk: "read";
+            readonly approval_policy: "none";
+        };
+        readonly access: {
+            readonly read: true;
+            readonly write: false;
+        };
+        readonly actors: readonly ["partner"];
+        readonly requirements: {
+            readonly modules: readonly ["partner_api"];
+            readonly program_modules: readonly [];
+            readonly workflow_management: false;
+        };
+        readonly scope: {
+            readonly object_definitions: readonly [];
+            readonly programs: readonly [];
+            readonly portal_membership: "not_applicable";
+        };
+        readonly entity_kinds: readonly [];
+        readonly idempotency: {
+            readonly mode: "none";
+            readonly dry_run: false;
+            readonly reversible: true;
+        };
+        readonly presentation: {
+            readonly title: "Get deal custom field requirements";
+            readonly summary: "Returns the custom fields and rules that createPartnerDeal and updatePartnerDeal enforce for this partnership — the fields (with their required flag) and active rules (visibility, locking, auto-population) a deal submission must satisfy. Deal field requirements follow the deal's owning partnership; when creating a deal from another partnership's lead (a distributor roll-up), the lead's own partnership type governs instead.";
+            readonly domain: "Partner";
+            readonly surface: "partner";
+        };
+    };
+    readonly getPartnerLead: {
+        readonly contract_version: 1;
+        readonly key: "openapi:partner.getPartnerLead";
+        readonly version: 1;
+        readonly identity: {
+            readonly source: "openapi";
+            readonly name: "call_endpoint";
+            readonly operationId: "getPartnerLead";
+            readonly method: "GET";
+            readonly surface: "partner";
+        };
+        readonly operation: {
+            readonly kind: "read";
+            readonly risk: "read";
+            readonly approval_policy: "none";
+        };
+        readonly access: {
+            readonly read: true;
+            readonly write: false;
+        };
+        readonly actors: readonly ["partner"];
+        readonly requirements: {
+            readonly modules: readonly ["partner_api"];
+            readonly program_modules: readonly [];
+            readonly workflow_management: false;
+        };
+        readonly scope: {
+            readonly object_definitions: readonly [];
+            readonly programs: readonly [];
+            readonly portal_membership: "not_applicable";
+        };
+        readonly entity_kinds: readonly [];
+        readonly idempotency: {
+            readonly mode: "none";
+            readonly dry_run: false;
+            readonly reversible: true;
+        };
+        readonly presentation: {
+            readonly title: "Get a partnership lead";
+            readonly domain: "Partner";
+            readonly surface: "partner";
+        };
+    };
+    readonly getPartnerLeadRequirements: {
+        readonly contract_version: 1;
+        readonly key: "openapi:partner.getPartnerLeadRequirements";
+        readonly version: 1;
+        readonly identity: {
+            readonly source: "openapi";
+            readonly name: "call_endpoint";
+            readonly operationId: "getPartnerLeadRequirements";
+            readonly method: "GET";
+            readonly surface: "partner";
+        };
+        readonly operation: {
+            readonly kind: "read";
+            readonly risk: "read";
+            readonly approval_policy: "none";
+        };
+        readonly access: {
+            readonly read: true;
+            readonly write: false;
+        };
+        readonly actors: readonly ["partner"];
+        readonly requirements: {
+            readonly modules: readonly ["partner_api"];
+            readonly program_modules: readonly [];
+            readonly workflow_management: false;
+        };
+        readonly scope: {
+            readonly object_definitions: readonly [];
+            readonly programs: readonly [];
+            readonly portal_membership: "not_applicable";
+        };
+        readonly entity_kinds: readonly [];
+        readonly idempotency: {
+            readonly mode: "none";
+            readonly dry_run: false;
+            readonly reversible: true;
+        };
+        readonly presentation: {
+            readonly title: "Get lead custom field requirements";
+            readonly summary: "Returns the custom fields and rules that createPartnerLead and updatePartnerLead enforce for this partnership — the fields (with their required flag) and active rules (visibility, locking, auto-population) a lead submission must satisfy.";
+            readonly domain: "Partner";
+            readonly surface: "partner";
+        };
+    };
+    readonly getPartnerMe: {
+        readonly contract_version: 1;
+        readonly key: "openapi:partner.getPartnerMe";
+        readonly version: 1;
+        readonly identity: {
+            readonly source: "openapi";
+            readonly name: "call_endpoint";
+            readonly operationId: "getPartnerMe";
+            readonly method: "GET";
+            readonly surface: "partner";
+        };
+        readonly operation: {
+            readonly kind: "read";
+            readonly risk: "read";
+            readonly approval_policy: "none";
+        };
+        readonly access: {
+            readonly read: true;
+            readonly write: false;
+        };
+        readonly actors: readonly ["partner"];
+        readonly requirements: {
+            readonly modules: readonly ["partner_api"];
+            readonly program_modules: readonly [];
+            readonly workflow_management: false;
+        };
+        readonly scope: {
+            readonly object_definitions: readonly [];
+            readonly programs: readonly [];
+            readonly portal_membership: "not_applicable";
+        };
+        readonly entity_kinds: readonly [];
+        readonly idempotency: {
+            readonly mode: "none";
+            readonly dry_run: false;
+            readonly reversible: true;
+        };
+        readonly presentation: {
+            readonly title: "Get partner identity and accessible partnerships";
+            readonly domain: "Partner";
+            readonly surface: "partner";
+        };
+    };
+    readonly listPartnerDeals: {
+        readonly contract_version: 1;
+        readonly key: "openapi:partner.listPartnerDeals";
+        readonly version: 1;
+        readonly identity: {
+            readonly source: "openapi";
+            readonly name: "call_endpoint";
+            readonly operationId: "listPartnerDeals";
+            readonly method: "GET";
+            readonly surface: "partner";
+        };
+        readonly operation: {
+            readonly kind: "read";
+            readonly risk: "read";
+            readonly approval_policy: "none";
+        };
+        readonly access: {
+            readonly read: true;
+            readonly write: false;
+        };
+        readonly actors: readonly ["partner"];
+        readonly requirements: {
+            readonly modules: readonly ["partner_api"];
+            readonly program_modules: readonly [];
+            readonly workflow_management: false;
+        };
+        readonly scope: {
+            readonly object_definitions: readonly [];
+            readonly programs: readonly [];
+            readonly portal_membership: "not_applicable";
+        };
+        readonly entity_kinds: readonly [];
+        readonly idempotency: {
+            readonly mode: "none";
+            readonly dry_run: false;
+            readonly reversible: true;
+        };
+        readonly presentation: {
+            readonly title: "List partnership deals";
+            readonly domain: "Partner";
+            readonly surface: "partner";
+        };
+    };
+    readonly listPartnerLeads: {
+        readonly contract_version: 1;
+        readonly key: "openapi:partner.listPartnerLeads";
+        readonly version: 1;
+        readonly identity: {
+            readonly source: "openapi";
+            readonly name: "call_endpoint";
+            readonly operationId: "listPartnerLeads";
+            readonly method: "GET";
+            readonly surface: "partner";
+        };
+        readonly operation: {
+            readonly kind: "read";
+            readonly risk: "read";
+            readonly approval_policy: "none";
+        };
+        readonly access: {
+            readonly read: true;
+            readonly write: false;
+        };
+        readonly actors: readonly ["partner"];
+        readonly requirements: {
+            readonly modules: readonly ["partner_api"];
+            readonly program_modules: readonly [];
+            readonly workflow_management: false;
+        };
+        readonly scope: {
+            readonly object_definitions: readonly [];
+            readonly programs: readonly [];
+            readonly portal_membership: "not_applicable";
+        };
+        readonly entity_kinds: readonly [];
+        readonly idempotency: {
+            readonly mode: "none";
+            readonly dry_run: false;
+            readonly reversible: true;
+        };
+        readonly presentation: {
+            readonly title: "List partnership leads";
+            readonly domain: "Partner";
+            readonly surface: "partner";
+        };
+    };
+    readonly updatePartnerDeal: {
+        readonly contract_version: 1;
+        readonly key: "openapi:partner.updatePartnerDeal";
+        readonly version: 1;
+        readonly identity: {
+            readonly source: "openapi";
+            readonly name: "call_endpoint";
+            readonly operationId: "updatePartnerDeal";
+            readonly method: "PATCH";
+            readonly surface: "partner";
+        };
+        readonly operation: {
+            readonly kind: "write";
+            readonly risk: "write";
+            readonly approval_policy: "configurable";
+        };
+        readonly access: {
+            readonly read: false;
+            readonly write: true;
+        };
+        readonly actors: readonly ["partner"];
+        readonly requirements: {
+            readonly modules: readonly ["partner_api"];
+            readonly program_modules: readonly [];
+            readonly workflow_management: false;
+        };
+        readonly scope: {
+            readonly object_definitions: readonly [];
+            readonly programs: readonly [];
+            readonly portal_membership: "not_applicable";
+        };
+        readonly entity_kinds: readonly [];
+        readonly idempotency: {
+            readonly mode: "key_optional";
+            readonly dry_run: false;
+            readonly reversible: true;
+        };
+        readonly presentation: {
+            readonly title: "Update a partnership deal";
+            readonly summary: "Custom fields may be required or rule-controlled — call getPartnerDealRequirements first to learn the field/rule constraints. Validation failures return per-field `details` with machine-readable `reason` codes.";
+            readonly domain: "Partner";
+            readonly surface: "partner";
+        };
+    };
+    readonly updatePartnerLead: {
+        readonly contract_version: 1;
+        readonly key: "openapi:partner.updatePartnerLead";
+        readonly version: 1;
+        readonly identity: {
+            readonly source: "openapi";
+            readonly name: "call_endpoint";
+            readonly operationId: "updatePartnerLead";
+            readonly method: "PATCH";
+            readonly surface: "partner";
+        };
+        readonly operation: {
+            readonly kind: "write";
+            readonly risk: "write";
+            readonly approval_policy: "configurable";
+        };
+        readonly access: {
+            readonly read: false;
+            readonly write: true;
+        };
+        readonly actors: readonly ["partner"];
+        readonly requirements: {
+            readonly modules: readonly ["partner_api"];
+            readonly program_modules: readonly [];
+            readonly workflow_management: false;
+        };
+        readonly scope: {
+            readonly object_definitions: readonly [];
+            readonly programs: readonly [];
+            readonly portal_membership: "not_applicable";
+        };
+        readonly entity_kinds: readonly [];
+        readonly idempotency: {
+            readonly mode: "key_optional";
+            readonly dry_run: false;
+            readonly reversible: true;
+        };
+        readonly presentation: {
+            readonly title: "Update a partnership lead";
+            readonly summary: "Custom fields may be required or rule-controlled — call getPartnerLeadRequirements first to learn the field/rule constraints. Validation failures return per-field `details` with machine-readable `reason` codes.";
+            readonly domain: "Partner";
+            readonly surface: "partner";
+        };
+    };
+};
+
+export { CAPABILITIES, type CapabilityDescriptor };