@rezamirzapour/pod-sdk 1.0.10 → 1.0.12

package/README.md

@@ -24,17 +24,18 @@
 ---
 
 ## Microservices Included
-
-| Service | Accessor | Swagger Tag | Description |
-| :--- | :--- | :--- | :--- |
-| **CMS Content** | `sdk.cms` | `content` | Fetch, publish, edit, draft, archive, and categorize CMS articles with generic metadata `<T, P>`. |
-| **CMS Product** | `sdk.product` / `sdk.cms.products` | `product` | Product catalog, price & discount range filters, barcode lookup, batch publish, and AI search. |
-| **CMS Tags & Tree** | `sdk.tags` / `sdk.cms.tags` | `tags` | Manage tag categories and hierarchical tag trees (nodes, parent updates, ancestors, codes). |
+
+| Service | Accessor | Swagger Tag | Description |
+| :--- | :--- | :--- | :--- |
+| **CMS Content** | `sdk.cms` | `content` | Fetch, publish, edit, draft, archive, and categorize CMS articles with generic metadata `<T, P>`. |
+| **CMS Product** | `sdk.product` / `sdk.cms.products` | `product` | Product catalog, price & discount range filters, barcode lookup, batch publish, and AI search. |
+| **CMS Tags & Tree** | `sdk.tags` / `sdk.cms.tags` | `tags` | Manage tag categories and hierarchical tag trees (nodes, parent updates, ancestors, codes). |
+| **CMS Content Types** | `sdk.contentType` / `sdk.cms.contentTypes` | `content-type` / `related-content-type` | Content type schema management, attribute templates, IGs, multi-invoice percentages, and related content type fields. |
 | **CustomPost** | `sdk.customPost` | - | Search timeline by metadata `<T>`, custom post CRUD, and high-level typed repository. |
 | **SSO** | `sdk.sso` | - | OAuth2 handshake, OTP dispatch with digital RSA signature, OTP verify, token generation, and user profile. |
 | **Captcha** | `sdk.captcha` | `captcha` | Generate SVG/PNG captcha images with configurable options and verify submitted values. |
 | **Podspace** | `sdk.podspace` | `public-apis` | Complete Cloud Storage: file/image uploads, resumable chunked uploads, folders, versions, share links, workspaces, trash, tags, & metadata. |
-| **Podform** | `sdk.podform` | - | Survey & form response submission, question/form structure retrieval. |
+| **Podform** | `sdk.podform` | - | Survey & form response submission, question/form structure retrieval. |
 | **Notification** | `sdk.notification` | - | SMS delivery and bulk messaging with tracking. |
 | **Social** | `sdk.social` | - | User comments, reactions (likes/dislikes), rates, and social post interactions. |
 | **IUMS** | `sdk.iums` | - | Student and user identity inspection by national code or student ID. |
@@ -576,7 +577,97 @@ const ancestors = await podSdk.tags.getTagTreeAncestors('technology', nodeId);
 
 ---
 
-## Deep Dive 4: CustomPost & Generic Typed Repositories
+## Deep Dive 4: CMS Content Types & Related Content Types (RAD API Swagger: tag=content-type, tag=related-content-type)
+
+Manage CMS content type schemas, classification templates, multi-invoice percentages, and related content type field definitions ([Swagger documentation](https://rad-services.pod.ir/api/documentation?tag=content-type)).
+
+### Accessing Content Type Services
+
+Access via `podSdk.contentType`, `podSdk.contentTypes`, or `podSdk.cms.contentTypes`:
+
+```typescript
+// 1. List content types (with bracket query array format: excludeItems[]=drafts)
+const contentTypes = await podSdk.contentType.getContentTypes({
+  excludeItems: ['drafts'],
+});
+
+// 2. Get single content type detail
+const ct = await podSdk.contentType.getContentType('article');
+
+// 3. Create a new content type
+await podSdk.contentType.createContentType({
+  name: 'Magazine Article',
+  code: 'magazine_article',
+  type: 'ARTICLE',
+  description: 'Custom magazine articles schema',
+  tags: ['editorial'],
+});
+
+// 4. Update content type
+await podSdk.contentType.updateContentType('magazine_article', {
+  name: 'Updated Magazine Article',
+  description: 'Updated description',
+});
+
+// 5. Templates & Category trees
+const templates = await podSdk.contentType.getTemplates({ size: 10 });
+const igs = await podSdk.contentType.getTemplateIgs({ showLatestVersion: true });
+const categories = await podSdk.contentType.getTemplateCategories({ maxLevel: 3 });
+
+// 6. Archive / Unarchive content types
+await podSdk.contentType.archiveContentTypes([101, 102]);
+await podSdk.contentType.unarchiveContentTypes([101]);
+
+// 7. Multi-Invoice Percent Management
+await podSdk.contentType.addMultiInvoicePercent('magazine_article', {
+  main: 10,
+  provider: 20,
+  seller: 70,
+  dealerBusinessId: [12345],
+});
+
+// 8. Related Content Types Fields
+await podSdk.contentType.addRelatedContentTypes('magazine_article', [
+  {
+    code: 'author_profile',
+    title: 'Author Profile',
+    mandatory: true,
+    ui_type: 'DropdownList',
+  },
+]);
+```
+
+### Content Type Methods Reference (`podSdk.contentType` / `podSdk.cms.contentTypes`)
+
+| Method | HTTP | Path | Description |
+| :--- | :--- | :--- | :--- |
+| `getTemplates(params)` | `GET` | `/api/core/content-types/templates` | List all attribute templates. |
+| `getTemplateIgs(params)` | `GET` | `/api/core/content-types/template-igs` | List template IG classifications. |
+| `getTemplateCategories(params)` | `GET` | `/api/core/content-types/template-categories` | List template category nodes. |
+| `getContentTypes(params)` | `GET` | `/api/core/content-types` | List all content types. |
+| `getMyContentTypes(params)` | `GET` | `/api/core/content-types/my` | List current client's content types. |
+| `getContentType(uniqueId, params)` | `GET` | `/api/core/content-types/{contentTypeUniqueId}` | Get single content type. |
+| `getEnabledContentType(uniqueId, params)` | `GET` | `/api/core/content-types/{contentTypeUniqueId}/enable` | Get enabled content type. |
+| `getContentTypeFields(uniqueId)` | `GET` | `/api/core/content-types/{contentTypeUniqueId}/fields` | Get all fields (self & related). |
+| `getBrief(params)` | `GET` | `/api/core/content-types/brief` | List brief content types. |
+| `createContentType(params)` | `POST` | `/api/core/content-types` | Create new content type. |
+| `updateContentType(uniqueId, params)` | `POST` | `/api/core/content-types/{unique_id}` | Update content type. |
+| `updateMyContentType(uniqueId, params)` | `POST` | `/api/core/content-types/my/{unique_id}` | Update client's content type. |
+| `getArchivedContentTypes(params)` | `GET` | `/api/core/content-types/archive` | List archived content types. |
+| `archiveContentTypes(postIds)` | `POST` | `/api/core/content-types/archive` | Archive content types by postIds. |
+| `unarchiveContentTypes(postIds)` | `POST` | `/api/core/content-types/unarchive` | Unarchive content types by postIds. |
+| `getMultiInvoiceShares(uniqueId, params)` | `GET` | `/api/core/content-types/{contentTypeUniqueId}/multi-invoice-share` | List multi-invoice percentage shares. |
+| `addMultiInvoicePercent(uniqueId, params)` | `POST` | `/api/core/content-types/{contentTypeUniqueId}/multi-invoice-percent` | Add multi-invoice percent config. |
+| `updateMultiInvoicePercent(uniqueId, params)` | `PUT` | `/api/core/content-types/{contentTypeUniqueId}/multi-invoice-percent` | Update multi-invoice percent config. |
+| `deleteMultiInvoicePercent(uniqueId, params)` | `DELETE` | `/api/core/content-types/{contentTypeUniqueId}/multi-invoice-percent` | Delete multi-invoice percent config. |
+| `getRelatedContentTypes(uniqueId)` | `GET` | `/api/core/related-content-types/{contentTypeUniqueId}` | Get related content type fields. |
+| `addRelatedContentTypes(uniqueId, body)` | `POST` | `/api/core/related-content-types/{contentTypeUniqueId}` | Add related content type fields. |
+| `deleteRelatedContentType(uniqueId, code)` | `POST` | `/api/core/related-content-types/delete/{contentTypeUniqueId}` | Delete related content type field. |
+| `updateRelatedContentTypes(uniqueId, body)` | `POST` | `/api/core/related-content-types/update/{contentTypeUniqueId}` | Update related content type fields. |
+
+---
+
+## Deep Dive 5: CustomPost & Generic Typed Repositories
 
 `CustomPost` allows persisting arbitrary JSON schemas on the POD Platform. `@rezamirzapour/pod-sdk` provides two complementary approaches:
 
@@ -609,7 +700,7 @@ export async function getPublishedPosts() {
 
 ---
 
-## Deep Dive 5: Podspace Cloud Storage (Official Swagger API)
+## Deep Dive 6: Podspace Cloud Storage (Official Swagger API)
 
 The **Podspace** module provides complete enterprise integration with the official POD Podspace Cloud Storage service ([Swagger documentation: `podspace.sandpod.ir/api/docs`](http://podspace.sandpod.ir/api/docs)). It supports standard and resumable uploads, public/private files, dynamic CDN image transformations, folder hierarchy, file versioning, public share links, trash recovery, team workspaces, user groups, and custom metadata.