bolbol-sdk 1.0.2 → 2.0.0

package/dist/scope/BolbolAcademyScope.js

@@ -2,24 +2,30 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BolbolAcademyScope = void 0;
 // Mirrors Bolbol API src/controller/academy. One method per controller.
+//
+// The academy provides the environment: its collections, series, items and
+// assets, and the pricings it sells them with. How to learn on top of a
+// published collection version - learning kits, components, packages - is
+// teacher content (BolbolTeacherScope).
 class BolbolAcademyScope {
     http;
     constructor(http) {
         this.http = http;
     }
-    // Public directory: approved academies across all users - the read-side
-    // feed behind every Academies browse grid. It is NOT scoped to the caller's
-    // own academies (that is `account.list`). Only approved academies that are
-    // not scheduled for deletion come back.
     uid = {
         // Looks uids up in this academy: whether a REAL uid names an entity of
         // the stated kind, and which real uid an earlier upload gave a LOCAL
-        // one (`local:{entity}:{hash}`, see UidMappingType). The Academy CLI
-        // calls it before an upload - its `entity-uid` check, and to finish
-        // rewriting local uids an earlier upload resolved.
+        // one (`local:{entity}:{hash}`, see UidMappingType). The kinds are the
+        // academy project's: Collection, Series, Item, Asset, Pricing. The
+        // Academy CLI calls it before an upload - its `entity-uid` check, and
+        // to finish rewriting local uids an earlier upload resolved.
         // POST /academy/:academy_uid/uid/check - AcademyUidCheck
         check: (academy_uid, request) => this.http.post(`/academy/${encodeURIComponent(academy_uid)}/uid/check`, { body: request }),
     };
+    // Public directory: approved academies across all users - the read-side
+    // feed behind every Academies browse grid. It is NOT scoped to the caller's
+    // own academies (that is `account.list`). Only approved academies that are
+    // not scheduled for deletion come back.
     directory = {
         // The one list endpoint. Pass any combination of the filters; omit them
         // all for the whole directory.
@@ -37,7 +43,7 @@ class BolbolAcademyScope {
         // POST /academy - AcademyAccountCreate
         create: (request) => this.http.post("/academy", { body: request }),
         // PUT /academy/:academy_uid - AcademyAccountUpdate
-        update: (academy_uid, request = {}) => this.http.put(`/academy/${encodeURIComponent(academy_uid)}`, { body: request }),
+        update: (academy_uid, request) => this.http.put(`/academy/${encodeURIComponent(academy_uid)}`, { body: request }),
         photo: {
             // `user_file_uid: null` removes the photo; the previous file is
             // deleted either way.
@@ -45,13 +51,16 @@ class BolbolAcademyScope {
             update: (academy_uid, request) => this.http.patch(`/academy/${encodeURIComponent(academy_uid)}/photo`, { body: request }),
         },
         setting: {
+            // Which of the academy's pricings students pay to follow it (null =
+            // free). Answers the academy row. Data entry only for now: nothing
+            // charges it yet.
             membership: {
                 // PATCH /academy/:academy_uid/setting/membership - AcademyUpdateSettingMembership
                 update: (academy_uid, request) => this.http.patch(`/academy/${encodeURIComponent(academy_uid)}/setting/membership`, { body: request }),
             },
             // How this academy admits students - today just whether joining
-            // needs approval. Separate from `membership`, whose shape is shared
-            // with collections.
+            // needs approval. Separate from `membership`, which is about what
+            // following costs.
             student: {
                 // PATCH /academy/:academy_uid/setting/student - AcademyUpdateSettingStudent
                 update: (academy_uid, request) => this.http.patch(`/academy/${encodeURIComponent(academy_uid)}/setting/student`, { body: request }),
@@ -113,26 +122,12 @@ class BolbolAcademyScope {
             // Edits transcript / summary only - the file and its order are
             // untouched.
             // PUT /academy/:academy_uid/asset/:asset_uid/attachment/:user_file_uid - AcademyAssetAttachmentUpdate
-            update: (academy_uid, asset_uid, user_file_uid, request = {}) => this.http.put(`/academy/${encodeURIComponent(academy_uid)}/asset/${encodeURIComponent(asset_uid)}/attachment/${encodeURIComponent(user_file_uid)}`, { body: request }),
+            update: (academy_uid, asset_uid, user_file_uid, request) => this.http.put(`/academy/${encodeURIComponent(academy_uid)}/asset/${encodeURIComponent(asset_uid)}/attachment/${encodeURIComponent(user_file_uid)}`, { body: request }),
             // Detaching also cascade-deletes the underlying UserFile - the join
             // row is the only owner reference the file has.
             // DELETE /academy/:academy_uid/asset/:asset_uid/attachment/:user_file_uid - AcademyAssetAttachmentRemove
             remove: (academy_uid, asset_uid, user_file_uid) => this.http.delete(`/academy/${encodeURIComponent(academy_uid)}/asset/${encodeURIComponent(asset_uid)}/attachment/${encodeURIComponent(user_file_uid)}`),
         },
-        // The asset's own annotations - selections on its attachments'
-        // transcripts and summaries (latest version), each filed under one of
-        // the academy's groups with name / color / value metadata. Shown
-        // wherever the asset is: its preview and every item based on it.
-        annotation: {
-            // GET /academy/:academy_uid/asset/:asset_uid/annotation - AcademyAssetAnnotationList
-            list: (academy_uid, asset_uid) => this.http.get(`/academy/${encodeURIComponent(academy_uid)}/asset/${encodeURIComponent(asset_uid)}/annotation`),
-            // POST /academy/:academy_uid/asset/:asset_uid/annotation - AcademyAssetAnnotationAdd
-            add: (academy_uid, asset_uid, request) => this.http.post(`/academy/${encodeURIComponent(academy_uid)}/asset/${encodeURIComponent(asset_uid)}/annotation`, { body: request }),
-            // PUT /academy/:academy_uid/asset/:asset_uid/annotation/:annotation_uid - AcademyAssetAnnotationUpdate
-            update: (academy_uid, asset_uid, annotation_uid, request) => this.http.put(`/academy/${encodeURIComponent(academy_uid)}/asset/${encodeURIComponent(asset_uid)}/annotation/${encodeURIComponent(annotation_uid)}`, { body: request }),
-            // DELETE /academy/:academy_uid/asset/:asset_uid/annotation/:annotation_uid - AcademyAssetAnnotationRemove
-            remove: (academy_uid, asset_uid, annotation_uid) => this.http.delete(`/academy/${encodeURIComponent(academy_uid)}/asset/${encodeURIComponent(asset_uid)}/annotation/${encodeURIComponent(annotation_uid)}`),
-        },
         // The items linked to this asset - the inverse of the item's own asset
         // picker. Editing, deleting and unlinking go through the item
         // endpoints; only the listing is asset-scoped.
@@ -141,68 +136,6 @@ class BolbolAcademyScope {
             list: (academy_uid, asset_uid) => this.http.get(`/academy/${encodeURIComponent(academy_uid)}/asset/${encodeURIComponent(asset_uid)}/item`),
         },
     };
-    // The academy's user-defined classification axes - for example "Tense",
-    // "Register". Each type carries its own set of values (CategoryValue
-    // rows), and items are tagged by picking any number of values across
-    // any number of types. Replaces the single-category link that used to
-    // live on item_version.
-    categoryType = {
-        // GET /academy/:academy_uid/category-type - AcademyCategoryTypeList
-        // Returns every CategoryType AND every CategoryValue for the
-        // academy, so the Console's Categories tab can draw its selects
-        // from a single call - narrowed to one skill / task when asked (the
-        // item form asks for the item's task).
-        list: (academy_uid, request = {}) => this.http.get(`/academy/${encodeURIComponent(academy_uid)}/category-type`, { query: request }),
-        // POST /academy/:academy_uid/category-type - AcademyCategoryTypeCreate
-        create: (academy_uid, request) => this.http.post(`/academy/${encodeURIComponent(academy_uid)}/category-type`, { body: request }),
-        // PUT /academy/:academy_uid/category-type/:category_type_uid - AcademyCategoryTypeUpdate
-        update: (academy_uid, category_type_uid, request) => this.http.put(`/academy/${encodeURIComponent(academy_uid)}/category-type/${encodeURIComponent(category_type_uid)}`, { body: request }),
-        // DELETE /academy/:academy_uid/category-type/:category_type_uid - AcademyCategoryTypeDelete
-        delete: (academy_uid, category_type_uid) => this.http.delete(`/academy/${encodeURIComponent(academy_uid)}/category-type/${encodeURIComponent(category_type_uid)}`),
-        // Versioning on the CategoryType itself - same shape as collection
-        // and series.
-        version: {
-            // GET /academy/:academy_uid/category-type/:category_type_uid/version - AcademyCategoryTypeVersionList
-            list: (academy_uid, category_type_uid) => this.http.get(`/academy/${encodeURIComponent(academy_uid)}/category-type/${encodeURIComponent(category_type_uid)}/version`),
-            // Discards the unpublished draft (409 when the latest is published).
-            // DELETE /academy/:academy_uid/category-type/:category_type_uid/version/latest - AcademyCategoryTypeVersionDelete
-            deleteLast: (academy_uid, category_type_uid) => this.http.delete(`/academy/${encodeURIComponent(academy_uid)}/category-type/${encodeURIComponent(category_type_uid)}/version/latest`),
-        },
-        value: {
-            // GET /academy/:academy_uid/category-type/:category_type_uid/value - AcademyCategoryValueList
-            list: (academy_uid, category_type_uid) => this.http.get(`/academy/${encodeURIComponent(academy_uid)}/category-type/${encodeURIComponent(category_type_uid)}/value`),
-            // POST /academy/:academy_uid/category-type/:category_type_uid/value - AcademyCategoryValueCreate
-            create: (academy_uid, category_type_uid, request) => this.http.post(`/academy/${encodeURIComponent(academy_uid)}/category-type/${encodeURIComponent(category_type_uid)}/value`, { body: request }),
-            // PUT /academy/:academy_uid/category-type/:category_type_uid/value/:category_value_uid - AcademyCategoryValueUpdate
-            update: (academy_uid, category_type_uid, category_value_uid, request) => this.http.put(`/academy/${encodeURIComponent(academy_uid)}/category-type/${encodeURIComponent(category_type_uid)}/value/${encodeURIComponent(category_value_uid)}`, { body: request }),
-            // DELETE /academy/:academy_uid/category-type/:category_type_uid/value/:category_value_uid - AcademyCategoryValueDelete
-            delete: (academy_uid, category_type_uid, category_value_uid) => this.http.delete(`/academy/${encodeURIComponent(academy_uid)}/category-type/${encodeURIComponent(category_type_uid)}/value/${encodeURIComponent(category_value_uid)}`),
-            // Replaces the value's concepts (in order; `[]` clears them),
-            // pinning each at its latest version. On a published value it
-            // forks a draft first, like the vocabulary does.
-            // PUT /academy/:academy_uid/category-type/:category_type_uid/value/:category_value_uid/concept - AcademyCategoryValueUpdateConcepts
-            updateConcepts: (academy_uid, category_type_uid, category_value_uid, request) => this.http.put(`/academy/${encodeURIComponent(academy_uid)}/category-type/${encodeURIComponent(category_type_uid)}/value/${encodeURIComponent(category_value_uid)}/concept`, { body: request }),
-            version: {
-                // GET /academy/:academy_uid/category-type/:category_type_uid/value/:category_value_uid/version - AcademyCategoryValueVersionList
-                list: (academy_uid, category_type_uid, category_value_uid) => this.http.get(`/academy/${encodeURIComponent(academy_uid)}/category-type/${encodeURIComponent(category_type_uid)}/value/${encodeURIComponent(category_value_uid)}/version`),
-                // DELETE /academy/:academy_uid/category-type/:category_type_uid/value/:category_value_uid/version/latest - AcademyCategoryValueVersionDelete
-                deleteLast: (academy_uid, category_type_uid, category_value_uid) => this.http.delete(`/academy/${encodeURIComponent(academy_uid)}/category-type/${encodeURIComponent(category_type_uid)}/value/${encodeURIComponent(category_value_uid)}/version/latest`),
-            },
-            // The value's word list, backed by category_value_vocabulary.
-            // Adding or removing an entry on a published value forks a new
-            // draft version (rules/Versioning.md).
-            vocabulary: {
-                // GET /academy/:academy_uid/category-type/:category_type_uid/value/:category_value_uid/vocabulary - AcademyCategoryValueVocabularyList
-                list: (academy_uid, category_type_uid, category_value_uid) => this.http.get(`/academy/${encodeURIComponent(academy_uid)}/category-type/${encodeURIComponent(category_type_uid)}/value/${encodeURIComponent(category_value_uid)}/vocabulary`),
-                // POST /academy/:academy_uid/category-type/:category_type_uid/value/:category_value_uid/vocabulary - AcademyCategoryValueVocabularyAdd
-                add: (academy_uid, category_type_uid, category_value_uid, request) => this.http.post(`/academy/${encodeURIComponent(academy_uid)}/category-type/${encodeURIComponent(category_type_uid)}/value/${encodeURIComponent(category_value_uid)}/vocabulary`, { body: request }),
-                // PUT /academy/:academy_uid/category-type/:category_type_uid/value/:category_value_uid/vocabulary/order - AcademyCategoryValueVocabularyReorder
-                reorder: (academy_uid, category_type_uid, category_value_uid, request) => this.http.put(`/academy/${encodeURIComponent(academy_uid)}/category-type/${encodeURIComponent(category_type_uid)}/value/${encodeURIComponent(category_value_uid)}/vocabulary/order`, { body: request }),
-                // DELETE /academy/:academy_uid/category-type/:category_type_uid/value/:category_value_uid/vocabulary/:word_meaning_id - AcademyCategoryValueVocabularyRemove
-                remove: (academy_uid, category_type_uid, category_value_uid, word_meaning_id) => this.http.delete(`/academy/${encodeURIComponent(academy_uid)}/category-type/${encodeURIComponent(category_type_uid)}/value/${encodeURIComponent(category_value_uid)}/vocabulary/${word_meaning_id}`),
-            },
-        },
-    };
     // The academy's student roster. There is nothing here to CREATE an
     // enrolment with: a membership is written when a join request or an
     // invitation is approved, which goes through `request`.
@@ -244,17 +177,21 @@ class BolbolAcademyScope {
         },
     };
     // An academy's collections, each answered with its latest version's
-    // content. Edits to a published version land on a new draft version.
+    // content. Edits to a published version land on a new draft version. The
+    // pricing settings sit on the collection's identity row instead and change
+    // only through `setting.pricing.update` (or `create`).
     collection = {
         // GET /academy/:academy_uid/collection - AcademyCollectionList
         list: (academy_uid) => this.http.get(`/academy/${encodeURIComponent(academy_uid)}/collection`),
+        // The pricing settings may ride along, so a collection can be priced
+        // as it is created.
         // POST /academy/:academy_uid/collection - AcademyCollectionCreate
         create: (academy_uid, request) => this.http.post(`/academy/${encodeURIComponent(academy_uid)}/collection`, { body: request }),
         // GET /academy/:academy_uid/collection/:collection_uid - AcademyCollectionGet
         get: (academy_uid, collection_uid) => this.http.get(`/academy/${encodeURIComponent(academy_uid)}/collection/${encodeURIComponent(collection_uid)}`),
-        // language_id, exam_id and the membership setting are not editable here.
+        // language_id, exam_id and the pricing settings are not editable here.
         // PUT /academy/:academy_uid/collection/:collection_uid - AcademyCollectionUpdate
-        update: (academy_uid, collection_uid, request = {}) => this.http.put(`/academy/${encodeURIComponent(academy_uid)}/collection/${encodeURIComponent(collection_uid)}`, { body: request }),
+        update: (academy_uid, collection_uid, request) => this.http.put(`/academy/${encodeURIComponent(academy_uid)}/collection/${encodeURIComponent(collection_uid)}`, { body: request }),
         // DELETE /academy/:academy_uid/collection/:collection_uid - AcademyCollectionDelete
         delete: (academy_uid, collection_uid) => this.http.delete(`/academy/${encodeURIComponent(academy_uid)}/collection/${encodeURIComponent(collection_uid)}`),
         // Uploads a zipped Academy project and applies it declaratively onto
@@ -262,19 +199,26 @@ class BolbolAcademyScope {
         // are left alone, differences go through the SAME per-entity table
         // calls the create/update controllers use (versioning preserved), uids
         // in the project but not on the server are created, uids on the server
-        // but not in the project are soft-deleted. The server unzips to a temp
-        // folder and deletes it on success or failure. No timeout: the work
-        // grows with the project (a first upload creates every entity).
+        // but not in the project are soft-deleted. Only the academy project's
+        // folders are read: pricing/, collection/, series/, item/, asset/. The
+        // server unzips to a temp folder and deletes it on success or failure.
+        // No timeout: the work grows with the project (a first upload creates
+        // every entity).
         // POST /academy/:academy_uid/collection/upload - AcademyCollectionUpload
         upload: (academy_uid, request) => this.http.post(`/academy/${encodeURIComponent(academy_uid)}/collection/upload`, { body: request, timeoutMs: null }),
         setting: {
-            membership: {
-                // PATCH /academy/:academy_uid/collection/:collection_uid/setting/membership - AcademyCollectionUpdateSettingMembership
-                update: (academy_uid, collection_uid, request) => this.http.patch(`/academy/${encodeURIComponent(academy_uid)}/collection/${encodeURIComponent(collection_uid)}/setting/membership`, { body: request }),
+            // Which of the academy's pricings a user pays to take the
+            // collection and a teacher pays to license it, the two commission
+            // pricings, and the two percentages copied into the commission
+            // contracts. Only the fields sent change; writes the identity row
+            // (no draft fork) and answers the collection.
+            pricing: {
+                // PATCH /academy/:academy_uid/collection/:collection_uid/setting/pricing - AcademyCollectionUpdateSettingPricing
+                update: (academy_uid, collection_uid, request) => this.http.patch(`/academy/${encodeURIComponent(academy_uid)}/collection/${encodeURIComponent(collection_uid)}/setting/pricing`, { body: request }),
             },
         },
-        // The preview's counts: students, and the distinct assets, annotation
-        // groups and category types / values the latest version uses.
+        // The preview's counts: students, skills, tasks, series and items, and
+        // the distinct assets the latest version uses.
         // GET /academy/:academy_uid/collection/:collection_uid/count - AcademyCollectionCount
         count: (academy_uid, collection_uid) => this.http.get(`/academy/${encodeURIComponent(academy_uid)}/collection/${encodeURIComponent(collection_uid)}/count`),
         // Who holds this collection - its students. Owner-only and paged; the
@@ -303,7 +247,7 @@ class BolbolAcademyScope {
             list: (academy_uid, collection_uid, request = {}) => this.http.get(`/academy/${encodeURIComponent(academy_uid)}/collection/${encodeURIComponent(collection_uid)}/version/series`, { query: request }),
             // Series and item counts per task, on the latest version - what a
             // tree draws its task headings from before paging any series in.
-            // GET /academy/:academy_uid/collection/:collection_uid/version/series/count - AcademyCollectionVersionSeriesVersionCount
+            // GET /academy/:academy_uid/collection/:collection_uid/version/series/count - AcademyCollectionVersion_SeriesVersionCount
             count: (academy_uid, collection_uid) => this.http.get(`/academy/${encodeURIComponent(academy_uid)}/collection/${encodeURIComponent(collection_uid)}/version/series/count`),
             // POST /academy/:academy_uid/collection/:collection_uid/version/series - AcademyCollectionVersion_SeriesVersionAdd
             add: (academy_uid, collection_uid, request) => this.http.post(`/academy/${encodeURIComponent(academy_uid)}/collection/${encodeURIComponent(collection_uid)}/version/series`, { body: request }),
@@ -321,7 +265,10 @@ class BolbolAcademyScope {
         },
     };
     // An academy's items, each answered with its latest version's content.
-    // Edits to a published version land on a new draft version.
+    // Edits to a published version land on a new draft version. An item is
+    // the question only: how to learn it (mindsets, concepts, category values,
+    // annotations, vocabulary, answers, ambiguities) is teacher content on a
+    // published collection version (BolbolTeacherScope `component`).
     item = {
         // `exam_skill_id` / `exam_skill_task_id` narrow the list to the scope
         // the admin tree is opened at. Both omitted, the call returns the whole
@@ -339,8 +286,8 @@ class BolbolAcademyScope {
         // GET /academy/:academy_uid/item/:item_uid/preview - AcademyItemPreview
         preview: (academy_uid, item_uid) => this.http.get(`/academy/${encodeURIComponent(academy_uid)}/item/${encodeURIComponent(item_uid)}/preview`),
         // `type` also decides which shape `detail` must have, and is immutable
-        // afterwards. The asset and category ride along here because there is
-        // no item to save them against yet.
+        // afterwards. The asset rides along here because there is no item to
+        // save it against yet.
         // POST /academy/:academy_uid/item - AcademyItemCreate
         create: (academy_uid, request) => this.http.post(`/academy/${encodeURIComponent(academy_uid)}/item`, { body: request }),
         // The body is strict: sending `type`, `exam_skill_id` or any other
@@ -354,23 +301,6 @@ class BolbolAcademyScope {
         // the author had typed into the item form but not yet saved.
         // PUT /academy/:academy_uid/item/:item_uid/asset - AcademyItemUpdateAsset
         updateAsset: (academy_uid, item_uid, request) => this.http.put(`/academy/${encodeURIComponent(academy_uid)}/item/${encodeURIComponent(item_uid)}/asset`, { body: request }),
-        // Pins (or clears, with null) the item's mindset at the mindset's
-        // latest version. Productive types only (400 otherwise). Separate from
-        // `update` for the same reason `updateAsset` is.
-        // PUT /academy/:academy_uid/item/:item_uid/mindset - AcademyItemUpdateMindset
-        updateMindset: (academy_uid, item_uid, request) => this.http.put(`/academy/${encodeURIComponent(academy_uid)}/item/${encodeURIComponent(item_uid)}/mindset`, { body: request }),
-        // Replaces the item's concepts (in order; `[]` clears them), pinning
-        // each at its latest version. Productive types only (400 otherwise).
-        // Separate from `update` for the same reason `updateAsset` is.
-        // PUT /academy/:academy_uid/item/:item_uid/concept - AcademyItemUpdateConcepts
-        updateConcepts: (academy_uid, item_uid, request) => this.http.put(`/academy/${encodeURIComponent(academy_uid)}/item/${encodeURIComponent(item_uid)}/concept`, { body: request }),
-        // Sets (or clears, with null) the item's category. Separate from
-        // `update` for the same reason `updateAsset` is.
-        // Replaces the full CategoryValue tag set on the item. Changing it
-        // forks a new draft version of the item (see rules/Versioning.md),
-        // which is why it lives beside the other item-version mutations.
-        // PUT /academy/:academy_uid/item/:item_uid/categories - AcademyItemUpdateCategories
-        updateCategories: (academy_uid, item_uid, request) => this.http.put(`/academy/${encodeURIComponent(academy_uid)}/item/${encodeURIComponent(item_uid)}/categories`, { body: request }),
         // DELETE /academy/:academy_uid/item/:item_uid - AcademyItemDelete
         delete: (academy_uid, item_uid) => this.http.delete(`/academy/${encodeURIComponent(academy_uid)}/item/${encodeURIComponent(item_uid)}`),
         version: {
@@ -380,66 +310,6 @@ class BolbolAcademyScope {
             // DELETE /academy/:academy_uid/item/:item_uid/version/latest - AcademyItemVersionDelete
             deleteLast: (academy_uid, item_uid) => this.http.delete(`/academy/${encodeURIComponent(academy_uid)}/item/${encodeURIComponent(item_uid)}/version/latest`),
         },
-        // The item's word list, on its latest version. An entry is addressed by
-        // `word_meaning_id`, not a uid: it is a link row over shared `word`
-        // schema catalog rows, whose numeric ids are their public handles.
-        vocabulary: {
-            // Entries in order.
-            // GET /academy/:academy_uid/item/:item_uid/vocabulary - AcademyItemVocabularyList
-            list: (academy_uid, item_uid) => this.http.get(`/academy/${encodeURIComponent(academy_uid)}/item/${encodeURIComponent(item_uid)}/vocabulary`),
-            // A new entry lands at the end of the list; the backend assigns `sort_order`.
-            // POST /academy/:academy_uid/item/:item_uid/vocabulary - AcademyItemVocabularyAdd
-            add: (academy_uid, item_uid, request) => this.http.post(`/academy/${encodeURIComponent(academy_uid)}/item/${encodeURIComponent(item_uid)}/vocabulary`, { body: request }),
-            // There is no per-entry update: the word and meaning ARE the entry, so
-            // position is the only editable thing. Position in `word_meaning_ids`
-            // IS the order.
-            // PUT /academy/:academy_uid/item/:item_uid/vocabulary/order - AcademyItemVocabularyReorder
-            reorder: (academy_uid, item_uid, request) => this.http.put(`/academy/${encodeURIComponent(academy_uid)}/item/${encodeURIComponent(item_uid)}/vocabulary/order`, { body: request }),
-            // Drops the link row only. The word and its meaning are shared catalog
-            // rows and are left untouched.
-            // DELETE /academy/:academy_uid/item/:item_uid/vocabulary/:word_meaning_id - AcademyItemVocabularyRemove
-            remove: (academy_uid, item_uid, word_meaning_id) => this.http.delete(`/academy/${encodeURIComponent(academy_uid)}/item/${encodeURIComponent(item_uid)}/vocabulary/${word_meaning_id}`),
-        },
-        // The item's ambiguity annotations, on its latest version. Same
-        // append-only shape as `vocabulary`: a new annotation lands at the end
-        // of the list and is addressed by its own `ambiguity_uid` for removal.
-        ambiguity: {
-            // Entries in `sort_order` then id.
-            // GET /academy/:academy_uid/item/:item_uid/ambiguity - AcademyItemAmbiguityList
-            list: (academy_uid, item_uid) => this.http.get(`/academy/${encodeURIComponent(academy_uid)}/item/${encodeURIComponent(item_uid)}/ambiguity`),
-            // POST /academy/:academy_uid/item/:item_uid/ambiguity - AcademyItemAmbiguityAdd
-            add: (academy_uid, item_uid, request) => this.http.post(`/academy/${encodeURIComponent(academy_uid)}/item/${encodeURIComponent(item_uid)}/ambiguity`, { body: request }),
-            // PUT /academy/:academy_uid/item/:item_uid/ambiguity/:ambiguity_uid - AcademyItemAmbiguityUpdate
-            update: (academy_uid, item_uid, ambiguity_uid, request) => this.http.put(`/academy/${encodeURIComponent(academy_uid)}/item/${encodeURIComponent(item_uid)}/ambiguity/${encodeURIComponent(ambiguity_uid)}`, { body: request }),
-            // DELETE /academy/:academy_uid/item/:item_uid/ambiguity/:ambiguity_uid - AcademyItemAmbiguityRemove
-            remove: (academy_uid, item_uid, ambiguity_uid) => this.http.delete(`/academy/${encodeURIComponent(academy_uid)}/item/${encodeURIComponent(item_uid)}/ambiguity/${encodeURIComponent(ambiguity_uid)}`),
-        },
-        // Sample / model answers for a productive item (Writing or Speaking).
-        // `list` returns `[]` when the item has none, so a shared UI tab can
-        // render uniformly.
-        productive_answer: {
-            // GET /academy/:academy_uid/item/:item_uid/productive-answer - AcademyItemProductiveAnswerList
-            list: (academy_uid, item_uid) => this.http.get(`/academy/${encodeURIComponent(academy_uid)}/item/${encodeURIComponent(item_uid)}/productive-answer`),
-            // POST /academy/:academy_uid/item/:item_uid/productive-answer - AcademyItemProductiveAnswerAdd
-            add: (academy_uid, item_uid, request) => this.http.post(`/academy/${encodeURIComponent(academy_uid)}/item/${encodeURIComponent(item_uid)}/productive-answer`, { body: request }),
-            // PUT /academy/:academy_uid/item/:item_uid/productive-answer/:answer_uid - AcademyItemProductiveAnswerUpdate
-            update: (academy_uid, item_uid, answer_uid, request) => this.http.put(`/academy/${encodeURIComponent(academy_uid)}/item/${encodeURIComponent(item_uid)}/productive-answer/${encodeURIComponent(answer_uid)}`, { body: request }),
-            // DELETE /academy/:academy_uid/item/:item_uid/productive-answer/:answer_uid - AcademyItemProductiveAnswerRemove
-            remove: (academy_uid, item_uid, answer_uid) => this.http.delete(`/academy/${encodeURIComponent(academy_uid)}/item/${encodeURIComponent(item_uid)}/productive-answer/${encodeURIComponent(answer_uid)}`),
-        },
-        // The academy's annotations on the item's latest version - selections
-        // on its question text or on a productive answer structure's text,
-        // each with name / color / value metadata. Learners see them too.
-        annotation: {
-            // GET /academy/:academy_uid/item/:item_uid/annotation - AcademyItemAnnotationList
-            list: (academy_uid, item_uid) => this.http.get(`/academy/${encodeURIComponent(academy_uid)}/item/${encodeURIComponent(item_uid)}/annotation`),
-            // POST /academy/:academy_uid/item/:item_uid/annotation - AcademyItemAnnotationAdd
-            add: (academy_uid, item_uid, request) => this.http.post(`/academy/${encodeURIComponent(academy_uid)}/item/${encodeURIComponent(item_uid)}/annotation`, { body: request }),
-            // PUT /academy/:academy_uid/item/:item_uid/annotation/:annotation_uid - AcademyItemAnnotationUpdate
-            update: (academy_uid, item_uid, annotation_uid, request) => this.http.put(`/academy/${encodeURIComponent(academy_uid)}/item/${encodeURIComponent(item_uid)}/annotation/${encodeURIComponent(annotation_uid)}`, { body: request }),
-            // DELETE /academy/:academy_uid/item/:item_uid/annotation/:annotation_uid - AcademyItemAnnotationRemove
-            remove: (academy_uid, item_uid, annotation_uid) => this.http.delete(`/academy/${encodeURIComponent(academy_uid)}/item/${encodeURIComponent(item_uid)}/annotation/${encodeURIComponent(annotation_uid)}`),
-        },
         // The item's file bucket, on its latest version. Uploading and attaching
         // are two steps: the user-file upload stores the bytes with
         // `in_use = false`, and `add` creates the join row that flips the file to
@@ -453,7 +323,7 @@ class BolbolAcademyScope {
             add: (academy_uid, item_uid, request) => this.http.post(`/academy/${encodeURIComponent(academy_uid)}/item/${encodeURIComponent(item_uid)}/attachment`, { body: request }),
             // Edits transcript / summary only - the file and its order are untouched.
             // PUT /academy/:academy_uid/item/:item_uid/attachment/:user_file_uid - AcademyItemAttachmentUpdate
-            update: (academy_uid, item_uid, user_file_uid, request = {}) => this.http.put(`/academy/${encodeURIComponent(academy_uid)}/item/${encodeURIComponent(item_uid)}/attachment/${encodeURIComponent(user_file_uid)}`, { body: request }),
+            update: (academy_uid, item_uid, user_file_uid, request) => this.http.put(`/academy/${encodeURIComponent(academy_uid)}/item/${encodeURIComponent(item_uid)}/attachment/${encodeURIComponent(user_file_uid)}`, { body: request }),
             // Detaching also cascade-deletes the underlying UserFile - the join row
             // is the only owner reference the file has.
             // DELETE /academy/:academy_uid/item/:item_uid/attachment/:user_file_uid - AcademyItemAttachmentRemove
@@ -524,111 +394,57 @@ class BolbolAcademyScope {
             autoAssign: (academy_uid, series_uid, request) => this.http.post(`/academy/${encodeURIComponent(academy_uid)}/series/${encodeURIComponent(series_uid)}/item-version/auto-assign`, { body: request }),
         },
     };
-    // The academy's annotation groups (Vocabulary, Grammar, ...): defined once,
-    // picked for every annotation the academy adds.
-    annotation_group = {
-        // GET /academy/:academy_uid/annotation-group - AcademyAnnotationGroupList
-        list: (academy_uid) => this.http.get(`/academy/${encodeURIComponent(academy_uid)}/annotation-group`),
-        // POST /academy/:academy_uid/annotation-group - AcademyAnnotationGroupCreate
-        create: (academy_uid, request) => this.http.post(`/academy/${encodeURIComponent(academy_uid)}/annotation-group`, { body: request }),
-        // PUT /academy/:academy_uid/annotation-group/:annotation_group_uid - AcademyAnnotationGroupUpdate
-        update: (academy_uid, annotation_group_uid, request) => this.http.put(`/academy/${encodeURIComponent(academy_uid)}/annotation-group/${encodeURIComponent(annotation_group_uid)}`, { body: request }),
-        // DELETE /academy/:academy_uid/annotation-group/:annotation_group_uid - AcademyAnnotationGroupDelete
-        delete: (academy_uid, annotation_group_uid) => this.http.delete(`/academy/${encodeURIComponent(academy_uid)}/annotation-group/${encodeURIComponent(annotation_group_uid)}`),
-        // Versioning on the group itself - same shape as categoryType.
-        version: {
-            // GET /academy/:academy_uid/annotation-group/:annotation_group_uid/version - AcademyAnnotationGroupVersionList
-            list: (academy_uid, annotation_group_uid) => this.http.get(`/academy/${encodeURIComponent(academy_uid)}/annotation-group/${encodeURIComponent(annotation_group_uid)}/version`),
-            // Discards the unpublished draft (409 when the latest is published).
-            // DELETE /academy/:academy_uid/annotation-group/:annotation_group_uid/version/latest - AcademyAnnotationGroupVersionDelete
-            deleteLast: (academy_uid, annotation_group_uid) => this.http.delete(`/academy/${encodeURIComponent(academy_uid)}/annotation-group/${encodeURIComponent(annotation_group_uid)}/version/latest`),
-        },
-    };
-    // The academy's mindsets: a situation ("Sport / outdoor activity") with
-    // the numbered topics worth asking about in it. Versioned like
-    // categoryType; a productive item pins one version
-    // (`item.updateMindset`).
-    mindset = {
-        // GET /academy/:academy_uid/mindset - AcademyMindsetList
-        list: (academy_uid, request = {}) => this.http.get(`/academy/${encodeURIComponent(academy_uid)}/mindset`, { query: request }),
-        // GET /academy/:academy_uid/mindset/:mindset_uid - AcademyMindsetGet
-        get: (academy_uid, mindset_uid) => this.http.get(`/academy/${encodeURIComponent(academy_uid)}/mindset/${encodeURIComponent(mindset_uid)}`),
-        // POST /academy/:academy_uid/mindset - AcademyMindsetCreate
-        create: (academy_uid, request) => this.http.post(`/academy/${encodeURIComponent(academy_uid)}/mindset`, { body: request }),
-        // PUT /academy/:academy_uid/mindset/:mindset_uid - AcademyMindsetUpdate
-        update: (academy_uid, mindset_uid, request) => this.http.put(`/academy/${encodeURIComponent(academy_uid)}/mindset/${encodeURIComponent(mindset_uid)}`, { body: request }),
-        // 409 while the latest version of a live item still pins it.
-        // DELETE /academy/:academy_uid/mindset/:mindset_uid - AcademyMindsetDelete
-        delete: (academy_uid, mindset_uid) => this.http.delete(`/academy/${encodeURIComponent(academy_uid)}/mindset/${encodeURIComponent(mindset_uid)}`),
-        // Versioning on the mindset itself - same shape as categoryType.
-        version: {
-            // GET /academy/:academy_uid/mindset/:mindset_uid/version - AcademyMindsetVersionList
-            list: (academy_uid, mindset_uid) => this.http.get(`/academy/${encodeURIComponent(academy_uid)}/mindset/${encodeURIComponent(mindset_uid)}/version`),
-            // Discards the unpublished draft (409 when the latest is published,
-            // or when an item version pins it).
-            // DELETE /academy/:academy_uid/mindset/:mindset_uid/version/latest - AcademyMindsetVersionDelete
-            deleteLast: (academy_uid, mindset_uid) => this.http.delete(`/academy/${encodeURIComponent(academy_uid)}/mindset/${encodeURIComponent(mindset_uid)}/version/latest`),
-        },
-        // The mindset's numbered topics, on its latest version. A change to a
-        // published version forks a draft first, so every call answers the
-        // whole mindset (the topics' uids change with the fork).
-        topic: {
-            // POST /academy/:academy_uid/mindset/:mindset_uid/topic - AcademyMindsetTopicAdd
-            add: (academy_uid, mindset_uid, request) => this.http.post(`/academy/${encodeURIComponent(academy_uid)}/mindset/${encodeURIComponent(mindset_uid)}/topic`, { body: request }),
-            // Position in `topic_uids` IS the order.
-            // PUT /academy/:academy_uid/mindset/:mindset_uid/topic/order - AcademyMindsetTopicReorder
-            reorder: (academy_uid, mindset_uid, request) => this.http.put(`/academy/${encodeURIComponent(academy_uid)}/mindset/${encodeURIComponent(mindset_uid)}/topic/order`, { body: request }),
-            // PUT /academy/:academy_uid/mindset/:mindset_uid/topic/:topic_uid - AcademyMindsetTopicUpdate
-            update: (academy_uid, mindset_uid, topic_uid, request) => this.http.put(`/academy/${encodeURIComponent(academy_uid)}/mindset/${encodeURIComponent(mindset_uid)}/topic/${encodeURIComponent(topic_uid)}`, { body: request }),
-            // DELETE /academy/:academy_uid/mindset/:mindset_uid/topic/:topic_uid - AcademyMindsetTopicRemove
-            remove: (academy_uid, mindset_uid, topic_uid) => this.http.delete(`/academy/${encodeURIComponent(academy_uid)}/mindset/${encodeURIComponent(mindset_uid)}/topic/${encodeURIComponent(topic_uid)}`),
-        },
-    };
-    // The academy's concepts: an idea tied to a task ("Giving an opinion")
-    // with its explanation and the numbered scenarios it applies in. Versioned
-    // like mindset; a productive item pins several, one version each
-    // (`item.updateConcepts`).
-    concept = {
-        // GET /academy/:academy_uid/concept - AcademyConceptList
-        list: (academy_uid, request = {}) => this.http.get(`/academy/${encodeURIComponent(academy_uid)}/concept`, { query: request }),
-        // GET /academy/:academy_uid/concept/:concept_uid - AcademyConceptGet
-        get: (academy_uid, concept_uid) => this.http.get(`/academy/${encodeURIComponent(academy_uid)}/concept/${encodeURIComponent(concept_uid)}`),
-        // POST /academy/:academy_uid/concept - AcademyConceptCreate
-        create: (academy_uid, request) => this.http.post(`/academy/${encodeURIComponent(academy_uid)}/concept`, { body: request }),
-        // PUT /academy/:academy_uid/concept/:concept_uid - AcademyConceptUpdate
-        update: (academy_uid, concept_uid, request) => this.http.put(`/academy/${encodeURIComponent(academy_uid)}/concept/${encodeURIComponent(concept_uid)}`, { body: request }),
-        // 409 while the latest version of a live item still pins it.
-        // DELETE /academy/:academy_uid/concept/:concept_uid - AcademyConceptDelete
-        delete: (academy_uid, concept_uid) => this.http.delete(`/academy/${encodeURIComponent(academy_uid)}/concept/${encodeURIComponent(concept_uid)}`),
-        // Versioning on the concept itself - same shape as mindset.
-        version: {
-            // GET /academy/:academy_uid/concept/:concept_uid/version - AcademyConceptVersionList
-            list: (academy_uid, concept_uid) => this.http.get(`/academy/${encodeURIComponent(academy_uid)}/concept/${encodeURIComponent(concept_uid)}/version`),
-            // Discards the unpublished draft (409 when the latest is published,
-            // or when an item version pins it).
-            // DELETE /academy/:academy_uid/concept/:concept_uid/version/latest - AcademyConceptVersionDelete
-            deleteLast: (academy_uid, concept_uid) => this.http.delete(`/academy/${encodeURIComponent(academy_uid)}/concept/${encodeURIComponent(concept_uid)}/version/latest`),
-        },
-        // The concept's numbered scenarios, on its latest version. A change to a
-        // published version forks a draft first, so every call answers the
-        // whole concept (the scenarios' uids change with the fork).
-        scenario: {
-            // POST /academy/:academy_uid/concept/:concept_uid/scenario - AcademyConceptScenarioAdd
-            add: (academy_uid, concept_uid, request) => this.http.post(`/academy/${encodeURIComponent(academy_uid)}/concept/${encodeURIComponent(concept_uid)}/scenario`, { body: request }),
-            // Position in `scenario_uids` IS the order.
-            // PUT /academy/:academy_uid/concept/:concept_uid/scenario/order - AcademyConceptScenarioReorder
-            reorder: (academy_uid, concept_uid, request) => this.http.put(`/academy/${encodeURIComponent(academy_uid)}/concept/${encodeURIComponent(concept_uid)}/scenario/order`, { body: request }),
-            // PUT /academy/:academy_uid/concept/:concept_uid/scenario/:scenario_uid - AcademyConceptScenarioUpdate
-            update: (academy_uid, concept_uid, scenario_uid, request) => this.http.put(`/academy/${encodeURIComponent(academy_uid)}/concept/${encodeURIComponent(concept_uid)}/scenario/${encodeURIComponent(scenario_uid)}`, { body: request }),
-            // DELETE /academy/:academy_uid/concept/:concept_uid/scenario/:scenario_uid - AcademyConceptScenarioRemove
-            remove: (academy_uid, concept_uid, scenario_uid) => this.http.delete(`/academy/${encodeURIComponent(academy_uid)}/concept/${encodeURIComponent(concept_uid)}/scenario/${encodeURIComponent(scenario_uid)}`),
+    // The academy's pricings (Bolbol API rules/Pricing.md): named price lists,
+    // each with one region per country plus at most one fallback region for
+    // every other country. A collection's pricing settings and the academy's
+    // membership setting each name one of them. Prices are whole eggs.
+    pricing = {
+        // `search` narrows by uid or name.
+        // GET /academy/:academy_uid/pricing - AcademyPricingList
+        list: (academy_uid, request = {}) => this.http.get(`/academy/${encodeURIComponent(academy_uid)}/pricing`, { query: request }),
+        // A new pricing has no regions yet - add them through `region.create`.
+        // POST /academy/:academy_uid/pricing - AcademyPricingCreate
+        create: (academy_uid, request) => this.http.post(`/academy/${encodeURIComponent(academy_uid)}/pricing`, { body: request }),
+        // The pricing with its regions.
+        // GET /academy/:academy_uid/pricing/:pricing_uid - AcademyPricingGet
+        get: (academy_uid, pricing_uid) => this.http.get(`/academy/${encodeURIComponent(academy_uid)}/pricing/${encodeURIComponent(pricing_uid)}`),
+        // Name and notes only; the regions have their own calls.
+        // PUT /academy/:academy_uid/pricing/:pricing_uid - AcademyPricingUpdate
+        update: (academy_uid, pricing_uid, request) => this.http.put(`/academy/${encodeURIComponent(academy_uid)}/pricing/${encodeURIComponent(pricing_uid)}`, { body: request }),
+        // Soft delete. 409 PRICING_IN_USE while a collection's pricing setting
+        // or the academy's membership setting still names it.
+        // DELETE /academy/:academy_uid/pricing/:pricing_uid - AcademyPricingDelete
+        delete: (academy_uid, pricing_uid) => this.http.delete(`/academy/${encodeURIComponent(academy_uid)}/pricing/${encodeURIComponent(pricing_uid)}`),
+        // A pricing's regions, addressed by their numeric `pricing_region_id`.
+        // `country_id: null` is the fallback region; a free region carries no
+        // amounts.
+        region: {
+            // GET /academy/:academy_uid/pricing/:pricing_uid/region - AcademyPricingRegionList
+            list: (academy_uid, pricing_uid) => this.http.get(`/academy/${encodeURIComponent(academy_uid)}/pricing/${encodeURIComponent(pricing_uid)}/region`),
+            // 409 PRICING_REGION_EXISTS for a country the pricing already has, or
+            // a second fallback region.
+            // POST /academy/:academy_uid/pricing/:pricing_uid/region - AcademyPricingRegionCreate
+            create: (academy_uid, pricing_uid, request) => this.http.post(`/academy/${encodeURIComponent(academy_uid)}/pricing/${encodeURIComponent(pricing_uid)}/region`, { body: request }),
+            // PUT /academy/:academy_uid/pricing/:pricing_uid/region/:pricing_region_id - AcademyPricingRegionUpdate
+            update: (academy_uid, pricing_uid, pricing_region_id, request) => this.http.put(`/academy/${encodeURIComponent(academy_uid)}/pricing/${encodeURIComponent(pricing_uid)}/region/${pricing_region_id}`, { body: request }),
+            // Hard delete. Contracts signed at this region keep their own copy
+            // of its values.
+            // DELETE /academy/:academy_uid/pricing/:pricing_uid/region/:pricing_region_id - AcademyPricingRegionDelete
+            delete: (academy_uid, pricing_uid, pricing_region_id) => this.http.delete(`/academy/${encodeURIComponent(academy_uid)}/pricing/${encodeURIComponent(pricing_uid)}/region/${pricing_region_id}`),
         },
     };
-    // Concept versions by uid, as a learner is posed them - what an item's
-    // `concept_version_uids` (or a concept's `version_uid`) point at.
-    conceptVersion = {
-        // GET /academy/:academy_uid/concept-version/preview - AcademyConceptVersionPreview
-        preview: (academy_uid, request) => this.http.get(`/academy/${encodeURIComponent(academy_uid)}/concept-version/preview`, { query: request }),
+    // The contracts the academy is one end of (Bolbol API rules/Pricing.md):
+    // append-only price agreements the server writes itself - today when a
+    // teacher licenses one of the academy's collections or builds a package on
+    // it. Read-only: nothing here writes a contract.
+    contract = {
+        // `role` narrows to the contracts the academy produced or consumed,
+        // `type` to one contract type.
+        // GET /academy/:academy_uid/contract - AcademyContractList
+        list: (academy_uid, request = {}) => this.http.get(`/academy/${encodeURIComponent(academy_uid)}/contract`, { query: request }),
+        // 403 unless the academy is one of the contract's two ends.
+        // GET /academy/:academy_uid/contract/:contract_uid - AcademyContractGet
+        get: (academy_uid, contract_uid) => this.http.get(`/academy/${encodeURIComponent(academy_uid)}/contract/${encodeURIComponent(contract_uid)}`),
     };
 }
 exports.BolbolAcademyScope = BolbolAcademyScope;