@rezamirzapour/pod-sdk 1.0.11 → 1.0.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -24,17 +24,18 @@
24
24
  ---
25
25
 
26
26
  ## Microservices Included
27
-
28
- | Service | Accessor | Swagger Tag | Description |
29
- | :--- | :--- | :--- | :--- |
30
- | **CMS Content** | `sdk.cms` | `content` | Fetch, publish, edit, draft, archive, and categorize CMS articles with generic metadata `<T, P>`. |
31
- | **CMS Product** | `sdk.product` / `sdk.cms.products` | `product` | Product catalog, price & discount range filters, barcode lookup, batch publish, and AI search. |
32
- | **CMS Tags & Tree** | `sdk.tags` / `sdk.cms.tags` | `tags` | Manage tag categories and hierarchical tag trees (nodes, parent updates, ancestors, codes). |
27
+
28
+ | Service | Accessor | Swagger Tag | Description |
29
+ | :--- | :--- | :--- | :--- |
30
+ | **CMS Content** | `sdk.cms` | `content` | Fetch, publish, edit, draft, archive, and categorize CMS articles with generic metadata `<T, P>`. |
31
+ | **CMS Product** | `sdk.product` / `sdk.cms.products` | `product` | Product catalog, price & discount range filters, barcode lookup, batch publish, and AI search. |
32
+ | **CMS Tags & Tree** | `sdk.tags` / `sdk.cms.tags` | `tags` | Manage tag categories and hierarchical tag trees (nodes, parent updates, ancestors, codes). |
33
+ | **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. |
33
34
  | **CustomPost** | `sdk.customPost` | - | Search timeline by metadata `<T>`, custom post CRUD, and high-level typed repository. |
34
35
  | **SSO** | `sdk.sso` | - | OAuth2 handshake, OTP dispatch with digital RSA signature, OTP verify, token generation, and user profile. |
35
36
  | **Captcha** | `sdk.captcha` | `captcha` | Generate SVG/PNG captcha images with configurable options and verify submitted values. |
36
37
  | **Podspace** | `sdk.podspace` | `public-apis` | Complete Cloud Storage: file/image uploads, resumable chunked uploads, folders, versions, share links, workspaces, trash, tags, & metadata. |
37
- | **Podform** | `sdk.podform` | - | Survey & form response submission, question/form structure retrieval. |
38
+ | **Podform** | `sdk.podform` | - | Survey & form response submission, question/form structure retrieval. |
38
39
  | **Notification** | `sdk.notification` | - | SMS delivery and bulk messaging with tracking. |
39
40
  | **Social** | `sdk.social` | - | User comments, reactions (likes/dislikes), rates, and social post interactions. |
40
41
  | **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);
576
577
 
577
578
  ---
578
579
 
579
- ## Deep Dive 4: CustomPost & Generic Typed Repositories
580
+ ## Deep Dive 4: CMS Content Types & Related Content Types (RAD API Swagger: tag=content-type, tag=related-content-type)
581
+
582
+ 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)).
583
+
584
+ ### Accessing Content Type Services
585
+
586
+ Access via `podSdk.contentType`, `podSdk.contentTypes`, or `podSdk.cms.contentTypes`:
587
+
588
+ ```typescript
589
+ // 1. List content types (with bracket query array format: excludeItems[]=drafts)
590
+ const contentTypes = await podSdk.contentType.getContentTypes({
591
+ excludeItems: ['drafts'],
592
+ });
593
+
594
+ // 2. Get single content type detail
595
+ const ct = await podSdk.contentType.getContentType('article');
596
+
597
+ // 3. Create a new content type
598
+ await podSdk.contentType.createContentType({
599
+ name: 'Magazine Article',
600
+ code: 'magazine_article',
601
+ type: 'ARTICLE',
602
+ description: 'Custom magazine articles schema',
603
+ tags: ['editorial'],
604
+ });
605
+
606
+ // 4. Update content type
607
+ await podSdk.contentType.updateContentType('magazine_article', {
608
+ name: 'Updated Magazine Article',
609
+ description: 'Updated description',
610
+ });
611
+
612
+ // 5. Templates & Category trees
613
+ const templates = await podSdk.contentType.getTemplates({ size: 10 });
614
+ const igs = await podSdk.contentType.getTemplateIgs({ showLatestVersion: true });
615
+ const categories = await podSdk.contentType.getTemplateCategories({ maxLevel: 3 });
616
+
617
+ // 6. Archive / Unarchive content types
618
+ await podSdk.contentType.archiveContentTypes([101, 102]);
619
+ await podSdk.contentType.unarchiveContentTypes([101]);
620
+
621
+ // 7. Multi-Invoice Percent Management
622
+ await podSdk.contentType.addMultiInvoicePercent('magazine_article', {
623
+ main: 10,
624
+ provider: 20,
625
+ seller: 70,
626
+ dealerBusinessId: [12345],
627
+ });
628
+
629
+ // 8. Related Content Types Fields
630
+ await podSdk.contentType.addRelatedContentTypes('magazine_article', [
631
+ {
632
+ code: 'author_profile',
633
+ title: 'Author Profile',
634
+ mandatory: true,
635
+ ui_type: 'DropdownList',
636
+ },
637
+ ]);
638
+ ```
639
+
640
+ ### Content Type Methods Reference (`podSdk.contentType` / `podSdk.cms.contentTypes`)
641
+
642
+ | Method | HTTP | Path | Description |
643
+ | :--- | :--- | :--- | :--- |
644
+ | `getTemplates(params)` | `GET` | `/api/core/content-types/templates` | List all attribute templates. |
645
+ | `getTemplateIgs(params)` | `GET` | `/api/core/content-types/template-igs` | List template IG classifications. |
646
+ | `getTemplateCategories(params)` | `GET` | `/api/core/content-types/template-categories` | List template category nodes. |
647
+ | `getContentTypes(params)` | `GET` | `/api/core/content-types` | List all content types. |
648
+ | `getMyContentTypes(params)` | `GET` | `/api/core/content-types/my` | List current client's content types. |
649
+ | `getContentType(uniqueId, params)` | `GET` | `/api/core/content-types/{contentTypeUniqueId}` | Get single content type. |
650
+ | `getEnabledContentType(uniqueId, params)` | `GET` | `/api/core/content-types/{contentTypeUniqueId}/enable` | Get enabled content type. |
651
+ | `getContentTypeFields(uniqueId)` | `GET` | `/api/core/content-types/{contentTypeUniqueId}/fields` | Get all fields (self & related). |
652
+ | `getBrief(params)` | `GET` | `/api/core/content-types/brief` | List brief content types. |
653
+ | `createContentType(params)` | `POST` | `/api/core/content-types` | Create new content type. |
654
+ | `updateContentType(uniqueId, params)` | `POST` | `/api/core/content-types/{unique_id}` | Update content type. |
655
+ | `updateMyContentType(uniqueId, params)` | `POST` | `/api/core/content-types/my/{unique_id}` | Update client's content type. |
656
+ | `getArchivedContentTypes(params)` | `GET` | `/api/core/content-types/archive` | List archived content types. |
657
+ | `archiveContentTypes(postIds)` | `POST` | `/api/core/content-types/archive` | Archive content types by postIds. |
658
+ | `unarchiveContentTypes(postIds)` | `POST` | `/api/core/content-types/unarchive` | Unarchive content types by postIds. |
659
+ | `getMultiInvoiceShares(uniqueId, params)` | `GET` | `/api/core/content-types/{contentTypeUniqueId}/multi-invoice-share` | List multi-invoice percentage shares. |
660
+ | `addMultiInvoicePercent(uniqueId, params)` | `POST` | `/api/core/content-types/{contentTypeUniqueId}/multi-invoice-percent` | Add multi-invoice percent config. |
661
+ | `updateMultiInvoicePercent(uniqueId, params)` | `PUT` | `/api/core/content-types/{contentTypeUniqueId}/multi-invoice-percent` | Update multi-invoice percent config. |
662
+ | `deleteMultiInvoicePercent(uniqueId, params)` | `DELETE` | `/api/core/content-types/{contentTypeUniqueId}/multi-invoice-percent` | Delete multi-invoice percent config. |
663
+ | `getRelatedContentTypes(uniqueId)` | `GET` | `/api/core/related-content-types/{contentTypeUniqueId}` | Get related content type fields. |
664
+ | `addRelatedContentTypes(uniqueId, body)` | `POST` | `/api/core/related-content-types/{contentTypeUniqueId}` | Add related content type fields. |
665
+ | `deleteRelatedContentType(uniqueId, code)` | `POST` | `/api/core/related-content-types/delete/{contentTypeUniqueId}` | Delete related content type field. |
666
+ | `updateRelatedContentTypes(uniqueId, body)` | `POST` | `/api/core/related-content-types/update/{contentTypeUniqueId}` | Update related content type fields. |
667
+
668
+ ---
669
+
670
+ ## Deep Dive 5: CustomPost & Generic Typed Repositories
580
671
 
581
672
  `CustomPost` allows persisting arbitrary JSON schemas on the POD Platform. `@rezamirzapour/pod-sdk` provides two complementary approaches:
582
673
 
@@ -609,7 +700,7 @@ export async function getPublishedPosts() {
609
700
 
610
701
  ---
611
702
 
612
- ## Deep Dive 5: Podspace Cloud Storage (Official Swagger API)
703
+ ## Deep Dive 6: Podspace Cloud Storage (Official Swagger API)
613
704
 
614
705
  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.
615
706
 
package/dist/index.d.mts CHANGED
@@ -2854,6 +2854,363 @@ interface GetTagTreeResponse {
2854
2854
  metadata?: any[];
2855
2855
  [key: string]: any;
2856
2856
  }
2857
+ interface AttributeTemplateField {
2858
+ id?: number;
2859
+ name?: string;
2860
+ code?: string;
2861
+ type?: string;
2862
+ mandatory?: boolean;
2863
+ defaultValue?: string;
2864
+ guide?: string;
2865
+ uiType?: string;
2866
+ multiValue?: boolean;
2867
+ [key: string]: any;
2868
+ }
2869
+ interface AttributeTemplate {
2870
+ id?: number;
2871
+ name?: string | number;
2872
+ code?: string | number;
2873
+ attributes?: AttributeTemplateField[];
2874
+ validation?: boolean;
2875
+ description?: string;
2876
+ [key: string]: any;
2877
+ }
2878
+ interface GetContentTypeTemplatesParams {
2879
+ offset?: number;
2880
+ size?: number;
2881
+ guildCode?: string;
2882
+ attributeTemplateCode?: string;
2883
+ attributeTemplateName?: string;
2884
+ firstId?: string | number;
2885
+ lastId?: string | number;
2886
+ [key: string]: any;
2887
+ }
2888
+ interface TemplateIgLocation {
2889
+ id?: number;
2890
+ nodeCode?: string;
2891
+ parentId?: number;
2892
+ title?: string;
2893
+ level?: number;
2894
+ [key: string]: any;
2895
+ }
2896
+ interface TemplateIgItem {
2897
+ igIrdi?: string;
2898
+ title?: string;
2899
+ uniqueCode?: string;
2900
+ location?: TemplateIgLocation;
2901
+ [key: string]: any;
2902
+ }
2903
+ interface GetTemplateIgsParams {
2904
+ baseNodeId?: number;
2905
+ igCode?: string;
2906
+ query?: string;
2907
+ showLatestVersion?: boolean;
2908
+ [key: string]: any;
2909
+ }
2910
+ interface TemplateCategoryNode {
2911
+ id?: number;
2912
+ nodeCode?: string;
2913
+ parentId?: number;
2914
+ title?: string | number;
2915
+ description?: string;
2916
+ level?: number;
2917
+ conceptIrdi?: string;
2918
+ hierarchicalCode?: string;
2919
+ [key: string]: any;
2920
+ }
2921
+ interface GetTemplateCategoriesParams {
2922
+ baseNodeId?: number;
2923
+ maxLevel?: number;
2924
+ includeBaseNode?: boolean;
2925
+ [key: string]: any;
2926
+ }
2927
+ interface ContentTypeItem {
2928
+ id?: number;
2929
+ entityId?: number;
2930
+ name?: string;
2931
+ uniqueId?: string;
2932
+ code?: string;
2933
+ type?: string;
2934
+ description?: string;
2935
+ enable?: boolean;
2936
+ metadata?: {
2937
+ ig?: string;
2938
+ fields?: any[];
2939
+ related_content_types?: any[];
2940
+ related_product_types?: any[];
2941
+ multiInvoicePercent?: any[];
2942
+ type?: string;
2943
+ tagTreeCategoryId?: number;
2944
+ tagTreeCategoryIds?: number[];
2945
+ requiredTag?: boolean;
2946
+ requiredTagTree?: boolean;
2947
+ image?: string;
2948
+ icon?: string;
2949
+ ownerId?: string | number;
2950
+ isPublic?: boolean;
2951
+ isGuest?: boolean;
2952
+ permissionType?: string | boolean;
2953
+ activityInfo?: boolean;
2954
+ showFileMetadataDetail?: boolean;
2955
+ folderForContentFiles?: string;
2956
+ isTokenIssuedByClient?: boolean;
2957
+ financialLevel?: number;
2958
+ tags?: string[];
2959
+ tagTrees?: any;
2960
+ webhookConfigs?: any;
2961
+ created?: any;
2962
+ updated?: any;
2963
+ [key: string]: any;
2964
+ };
2965
+ [key: string]: any;
2966
+ }
2967
+ interface ContentTypeFieldItem {
2968
+ title?: string;
2969
+ code?: string;
2970
+ type?: string;
2971
+ fields?: any[];
2972
+ [key: string]: any;
2973
+ }
2974
+ interface BriefContentType {
2975
+ name?: string;
2976
+ data?: string;
2977
+ uniqueId?: string;
2978
+ [key: string]: any;
2979
+ }
2980
+ interface GetContentTypesParams {
2981
+ offset?: number;
2982
+ size?: number;
2983
+ type?: string;
2984
+ name?: string;
2985
+ uniqueId?: string;
2986
+ ig?: string;
2987
+ isCustom?: boolean;
2988
+ excludeItems?: string | string[];
2989
+ permissionType?: string;
2990
+ [key: string]: any;
2991
+ }
2992
+ interface GetMyContentTypesParams {
2993
+ offset?: number;
2994
+ size?: number;
2995
+ type?: string;
2996
+ name?: string;
2997
+ uniqueId?: string;
2998
+ ig?: string;
2999
+ isCustom?: boolean;
3000
+ permissionType?: string;
3001
+ [key: string]: any;
3002
+ }
3003
+ interface GetOneContentTypeParams {
3004
+ excludeItems?: string | string[];
3005
+ [key: string]: any;
3006
+ }
3007
+ interface CreateContentTypeParams {
3008
+ name: string;
3009
+ code: string;
3010
+ type: string;
3011
+ description: string;
3012
+ ig?: string;
3013
+ tagTreeCategoryId?: number;
3014
+ tagTreeCategoryIds?: number[];
3015
+ tags?: string[];
3016
+ tagTrees?: string[] | number[];
3017
+ webhookServices?: string[];
3018
+ webhookUrls?: string[];
3019
+ webhookDurations?: number[];
3020
+ webhookEnables?: boolean[];
3021
+ webhookHeaders?: string[];
3022
+ ownerId?: number;
3023
+ allFields?: boolean;
3024
+ excludeFields?: string[];
3025
+ requiredTag?: boolean;
3026
+ requiredTagTree?: boolean;
3027
+ icon?: string;
3028
+ image?: string;
3029
+ permissionType?: string;
3030
+ isPublic?: string | boolean;
3031
+ isGuest?: string | boolean;
3032
+ uploadFolder?: string;
3033
+ activityInfo?: boolean;
3034
+ showFileMetadataDetail?: boolean;
3035
+ folderForContentFiles?: string;
3036
+ isTokenIssuedByClient?: boolean;
3037
+ financialLevel?: number;
3038
+ [key: string]: any;
3039
+ }
3040
+ interface UpdateContentTypeParams {
3041
+ name: string;
3042
+ description: string;
3043
+ code?: string;
3044
+ ig?: string;
3045
+ tagTreeCategoryId?: number;
3046
+ tagTreeCategoryIds?: number[];
3047
+ tags?: string[];
3048
+ tagTrees?: string[] | number[];
3049
+ webhookServices?: string[];
3050
+ webhookUrls?: string[];
3051
+ webhookDurations?: number[];
3052
+ webhookEnables?: boolean[];
3053
+ webhookHeaders?: string[];
3054
+ ownerId?: number;
3055
+ requiredTag?: boolean;
3056
+ requiredTagTree?: boolean;
3057
+ icon?: string;
3058
+ image?: string;
3059
+ permissionType?: string;
3060
+ isPublic?: string | boolean;
3061
+ isGuest?: string | boolean;
3062
+ uploadFolder?: string;
3063
+ activityInfo?: boolean;
3064
+ showFileMetadataDetail?: boolean;
3065
+ folderForContentFiles?: string;
3066
+ isTokenIssuedByClient?: boolean;
3067
+ financialLevel?: number;
3068
+ [key: string]: any;
3069
+ }
3070
+ interface UpdateMyContentTypeParams {
3071
+ name: string;
3072
+ description: string;
3073
+ code?: string;
3074
+ ig?: string;
3075
+ tagTreeCategoryId?: number;
3076
+ tagTreeCategoryIds?: number[];
3077
+ tags?: string[];
3078
+ tagTrees?: string[] | number[];
3079
+ webhookServices?: string[];
3080
+ webhookUrls?: string[];
3081
+ webhookDurations?: number[];
3082
+ webhookEnables?: boolean[];
3083
+ webhookHeaders?: string[];
3084
+ requiredTag?: boolean;
3085
+ requiredTagTree?: boolean;
3086
+ icon?: string;
3087
+ image?: string;
3088
+ permissionType?: string;
3089
+ isPublic?: string | boolean;
3090
+ isGuest?: string | boolean;
3091
+ activityInfo?: boolean;
3092
+ showFileMetadataDetail?: boolean;
3093
+ folderForContentFiles?: string;
3094
+ isTokenIssuedByClient?: boolean;
3095
+ financialLevel?: number;
3096
+ [key: string]: any;
3097
+ }
3098
+ interface GetArchivedContentTypesParams {
3099
+ offset?: number;
3100
+ size?: number;
3101
+ type?: string;
3102
+ uniqueId?: string;
3103
+ postIds?: (number | string)[];
3104
+ permissionType?: string;
3105
+ [key: string]: any;
3106
+ }
3107
+ interface ArchiveContentTypesParams {
3108
+ postIds: (number | string)[];
3109
+ [key: string]: any;
3110
+ }
3111
+ interface UnarchiveContentTypesParams {
3112
+ postIds: (number | string)[];
3113
+ [key: string]: any;
3114
+ }
3115
+ interface GetBriefContentTypesParams {
3116
+ search?: string;
3117
+ [key: string]: any;
3118
+ }
3119
+ interface MultiInvoiceDealerItem {
3120
+ businessId?: number;
3121
+ businessShare?: number;
3122
+ businessShareType?: string;
3123
+ [key: string]: any;
3124
+ }
3125
+ interface MultiInvoicePercentItem {
3126
+ main?: number;
3127
+ provider?: number;
3128
+ seller?: number;
3129
+ enable?: boolean;
3130
+ businessLevel?: number;
3131
+ priceUniqueId?: string;
3132
+ uniqueId?: string;
3133
+ sellerShareType?: string;
3134
+ providerShareType?: string;
3135
+ mainBusiness?: {
3136
+ share?: number;
3137
+ shareType?: string;
3138
+ };
3139
+ providerBusiness?: {
3140
+ share?: number;
3141
+ shareType?: string;
3142
+ };
3143
+ sellerBusiness?: {
3144
+ share?: number;
3145
+ shareType?: string;
3146
+ };
3147
+ dealers?: MultiInvoiceDealerItem[];
3148
+ clientMetadata?: string;
3149
+ [key: string]: any;
3150
+ }
3151
+ interface GetMultiInvoiceShareParams {
3152
+ excludeItems?: string | string[];
3153
+ [key: string]: any;
3154
+ }
3155
+ interface MultiInvoicePercentParams {
3156
+ main: number;
3157
+ provider: number;
3158
+ seller: number;
3159
+ enable?: boolean;
3160
+ mainShareType?: string;
3161
+ providerShareType?: string;
3162
+ sellerShareType?: string;
3163
+ dealerBusinessId?: (number | string)[];
3164
+ dealerBusinessShareType?: string[];
3165
+ dealerBusinessShare?: number[];
3166
+ clientMetadata?: string;
3167
+ uniqueId?: string;
3168
+ businessLevel?: number;
3169
+ [key: string]: any;
3170
+ }
3171
+ interface DeleteMultiInvoicePercentParams {
3172
+ uniqueId?: string;
3173
+ [key: string]: any;
3174
+ }
3175
+ interface RelatedContentTypeField {
3176
+ title?: string;
3177
+ code: string;
3178
+ placeholder?: string;
3179
+ requiredMessage?: string;
3180
+ mandatory?: boolean;
3181
+ default_value?: string;
3182
+ guide?: string;
3183
+ ui_type?: string;
3184
+ multiValue?: boolean;
3185
+ query?: string;
3186
+ enable?: boolean;
3187
+ showEndUser?: string | boolean;
3188
+ [key: string]: any;
3189
+ }
3190
+ interface AddRelatedContentTypesBody {
3191
+ fields: RelatedContentTypeField[];
3192
+ [key: string]: any;
3193
+ }
3194
+ interface UpdateRelatedContentTypesBody {
3195
+ fields: RelatedContentTypeField[];
3196
+ [key: string]: any;
3197
+ }
3198
+ interface DeleteRelatedContentTypeParams {
3199
+ code: string;
3200
+ [key: string]: any;
3201
+ }
3202
+ interface CmsGenericResponse<T = any> {
3203
+ referenceNumber?: string;
3204
+ hasError: boolean;
3205
+ errorCode?: number;
3206
+ refId?: string;
3207
+ message?: string | any[];
3208
+ count?: number;
3209
+ aggregations?: number;
3210
+ result: T;
3211
+ metadata?: any[];
3212
+ [key: string]: any;
3213
+ }
2857
3214
 
2858
3215
  declare class CmsDataFormatter {
2859
3216
  private podspaceUrl;
@@ -3111,6 +3468,139 @@ declare class CmsTagService {
3111
3468
  updateTagTreeCode(categoryId: string | number, id: number | string, code: string, options?: CmsRequestOptions): Promise<any>;
3112
3469
  }
3113
3470
 
3471
+ interface CmsContentTypeServiceOptions {
3472
+ baseUrl?: string;
3473
+ clientId: string;
3474
+ apiToken?: string;
3475
+ revalidate?: number | string;
3476
+ http?: NextHttp;
3477
+ }
3478
+ declare class CmsContentTypeService {
3479
+ private http;
3480
+ private clientId;
3481
+ private apiToken;
3482
+ private revalidate;
3483
+ constructor(options: CmsContentTypeServiceOptions);
3484
+ private normalizeParams;
3485
+ private get commonHeaders();
3486
+ private get managingHeaders();
3487
+ /**
3488
+ * Retrieves list of all attribute templates.
3489
+ * Swagger: GET /api/core/content-types/templates
3490
+ */
3491
+ getTemplates(params?: GetContentTypeTemplatesParams, options?: CmsRequestOptions): Promise<CmsGenericResponse<AttributeTemplate[]>>;
3492
+ /**
3493
+ * Retrieves classification IG lists (end user).
3494
+ * Swagger: GET /api/core/content-types/template-igs
3495
+ */
3496
+ getTemplateIgs(params?: GetTemplateIgsParams, options?: CmsRequestOptions): Promise<CmsGenericResponse<TemplateIgItem[]>>;
3497
+ /**
3498
+ * Retrieves template category lists (end user).
3499
+ * Swagger: GET /api/core/content-types/template-categories
3500
+ */
3501
+ getTemplateCategories(params?: GetTemplateCategoriesParams, options?: CmsRequestOptions): Promise<CmsGenericResponse<TemplateCategoryNode[]>>;
3502
+ /**
3503
+ * Retrieves list of all content types.
3504
+ * Swagger: GET /api/core/content-types
3505
+ */
3506
+ getContentTypes(params?: GetContentTypesParams, options?: CmsRequestOptions): Promise<CmsGenericResponse<ContentTypeItem[]>>;
3507
+ /**
3508
+ * Retrieves list of current client's content types.
3509
+ * Swagger: GET /api/core/content-types/my
3510
+ */
3511
+ getMyContentTypes(params?: GetMyContentTypesParams, options?: CmsRequestOptions): Promise<CmsGenericResponse<ContentTypeItem[]>>;
3512
+ /**
3513
+ * Retrieves a single content type by unique ID.
3514
+ * Swagger: GET /api/core/content-types/{contentTypeUniqueId}
3515
+ */
3516
+ getContentType(contentTypeUniqueId: string, params?: GetOneContentTypeParams, options?: CmsRequestOptions): Promise<CmsGenericResponse<ContentTypeItem>>;
3517
+ /**
3518
+ * Retrieves an enabled content type by unique ID.
3519
+ * Swagger: GET /api/core/content-types/{contentTypeUniqueId}/enable
3520
+ */
3521
+ getEnabledContentType(contentTypeUniqueId: string, params?: GetOneContentTypeParams, options?: CmsRequestOptions): Promise<CmsGenericResponse<ContentTypeItem>>;
3522
+ /**
3523
+ * Retrieves all fields (self and related) of a content type.
3524
+ * Swagger: GET /api/core/content-types/{contentTypeUniqueId}/fields
3525
+ */
3526
+ getContentTypeFields(contentTypeUniqueId: string, options?: CmsRequestOptions): Promise<CmsGenericResponse<ContentTypeFieldItem[]>>;
3527
+ /**
3528
+ * Retrieves brief list of content types.
3529
+ * Swagger: GET /api/core/content-types/brief
3530
+ */
3531
+ getBrief(params?: GetBriefContentTypesParams, options?: CmsRequestOptions): Promise<CmsGenericResponse<BriefContentType[]>>;
3532
+ /**
3533
+ * Creates a new content type.
3534
+ * Swagger: POST /api/core/content-types
3535
+ */
3536
+ createContentType(params: CreateContentTypeParams, options?: CmsRequestOptions): Promise<CmsGenericResponse<ContentTypeItem>>;
3537
+ /**
3538
+ * Updates an existing content type.
3539
+ * Swagger: POST /api/core/content-types/{unique_id}
3540
+ */
3541
+ updateContentType(uniqueId: string, params: UpdateContentTypeParams, options?: CmsRequestOptions): Promise<CmsGenericResponse<ContentTypeItem>>;
3542
+ /**
3543
+ * Updates current client's content type.
3544
+ * Swagger: POST /api/core/content-types/my/{unique_id}
3545
+ */
3546
+ updateMyContentType(uniqueId: string, params: UpdateMyContentTypeParams, options?: CmsRequestOptions): Promise<CmsGenericResponse<ContentTypeItem>>;
3547
+ /**
3548
+ * Retrieves all archived content types.
3549
+ * Swagger: GET /api/core/content-types/archive
3550
+ */
3551
+ getArchivedContentTypes(params?: GetArchivedContentTypesParams, options?: CmsRequestOptions): Promise<CmsGenericResponse<ContentTypeItem[]>>;
3552
+ /**
3553
+ * Archives content types by postIds.
3554
+ * Swagger: POST /api/core/content-types/archive
3555
+ */
3556
+ archiveContentTypes(postIdsOrParams: (number | string)[] | ArchiveContentTypesParams, options?: CmsRequestOptions): Promise<CmsGenericResponse<any>>;
3557
+ /**
3558
+ * Unarchives content types by postIds.
3559
+ * Swagger: POST /api/core/content-types/unarchive
3560
+ */
3561
+ unarchiveContentTypes(postIdsOrParams: (number | string)[] | UnarchiveContentTypesParams, options?: CmsRequestOptions): Promise<CmsGenericResponse<any>>;
3562
+ /**
3563
+ * Retrieves list of multi invoice shares for a content type.
3564
+ * Swagger: GET /api/core/content-types/{contentTypeUniqueId}/multi-invoice-share
3565
+ */
3566
+ getMultiInvoiceShares(contentTypeUniqueId: string, params?: GetMultiInvoiceShareParams, options?: CmsRequestOptions): Promise<CmsGenericResponse<MultiInvoicePercentItem[]>>;
3567
+ /**
3568
+ * Adds multi invoice percent configuration.
3569
+ * Swagger: POST /api/core/content-types/{contentTypeUniqueId}/multi-invoice-percent
3570
+ */
3571
+ addMultiInvoicePercent(contentTypeUniqueId: string, params: MultiInvoicePercentParams, options?: CmsRequestOptions): Promise<CmsGenericResponse<any>>;
3572
+ /**
3573
+ * Updates multi invoice percent configuration.
3574
+ * Swagger: PUT /api/core/content-types/{contentTypeUniqueId}/multi-invoice-percent
3575
+ */
3576
+ updateMultiInvoicePercent(contentTypeUniqueId: string, params: MultiInvoicePercentParams, options?: CmsRequestOptions): Promise<CmsGenericResponse<any>>;
3577
+ /**
3578
+ * Deletes multi invoice percent configuration.
3579
+ * Swagger: DELETE /api/core/content-types/{contentTypeUniqueId}/multi-invoice-percent
3580
+ */
3581
+ deleteMultiInvoicePercent(contentTypeUniqueId: string, params?: DeleteMultiInvoicePercentParams, options?: CmsRequestOptions): Promise<CmsGenericResponse<any>>;
3582
+ /**
3583
+ * Retrieves related content type fields.
3584
+ * Swagger: GET /api/core/related-content-types/{contentTypeUniqueId}
3585
+ */
3586
+ getRelatedContentTypes(contentTypeUniqueId: string, options?: CmsRequestOptions): Promise<CmsGenericResponse<RelatedContentTypeField[]>>;
3587
+ /**
3588
+ * Adds new related-content-type fields.
3589
+ * Swagger: POST /api/core/related-content-types/{contentTypeUniqueId}
3590
+ */
3591
+ addRelatedContentTypes(contentTypeUniqueId: string, body: AddRelatedContentTypesBody | RelatedContentTypeField[], options?: CmsRequestOptions): Promise<CmsGenericResponse<any>>;
3592
+ /**
3593
+ * Deletes a related-content-type field.
3594
+ * Swagger: POST /api/core/related-content-types/delete/{contentTypeUniqueId}
3595
+ */
3596
+ deleteRelatedContentType(contentTypeUniqueId: string, codeOrParams: string | DeleteRelatedContentTypeParams, options?: CmsRequestOptions): Promise<CmsGenericResponse<any>>;
3597
+ /**
3598
+ * Updates related-content-type fields.
3599
+ * Swagger: POST /api/core/related-content-types/update/{contentTypeUniqueId}
3600
+ */
3601
+ updateRelatedContentTypes(contentTypeUniqueId: string, body: UpdateRelatedContentTypesBody | RelatedContentTypeField[], options?: CmsRequestOptions): Promise<CmsGenericResponse<any>>;
3602
+ }
3603
+
3114
3604
  interface CmsServiceOptions {
3115
3605
  baseUrl: string;
3116
3606
  clientId: string;
@@ -3134,6 +3624,11 @@ declare class CmsService {
3134
3624
  * Swagger: tag=tags
3135
3625
  */
3136
3626
  readonly tags: CmsTagService;
3627
+ /**
3628
+ * Dedicated CMS Content Type & Related Content Type sub-service.
3629
+ * Swagger: tag=content-type, tag=related-content-type
3630
+ */
3631
+ readonly contentTypes: CmsContentTypeService;
3137
3632
  constructor(options: CmsServiceOptions);
3138
3633
  private normalizeParams;
3139
3634
  private get commonHeaders();
@@ -3370,6 +3865,8 @@ declare class PodSdk {
3370
3865
  readonly cms: CmsService;
3371
3866
  readonly product: CmsProductService;
3372
3867
  readonly tags: CmsTagService;
3868
+ readonly contentType: CmsContentTypeService;
3869
+ readonly contentTypes: CmsContentTypeService;
3373
3870
  readonly iums: IumsService;
3374
3871
  readonly urls: Required<PodUrlsConfig>;
3375
3872
  constructor(config?: PodSdkConfig);
@@ -3463,4 +3960,4 @@ declare const podSwaggerDocument: any;
3463
3960
  declare function encodeBase64(str: string): string;
3464
3961
  declare function generatePodSignatureHeader(keyId: string, privateKeyPem?: string): Promise<string>;
3465
3962
 
3466
- export { type AccessLevel, type AddCommentParams, type AddContentParams, type AddCustomPostParams, type AddCustomPostResponse, type AddProductParams, type ApiPageLink, type ApiPageList, type ApiSimplePageList, type ArchiveParams, type ArchiveProductParams, type BatchPublishParams, type BatchPublishProductParams, type BatchUnpublishParams, type BatchUnpublishProductParams, type Business, type CachePolicy, CaptchaService, type CaptchaServiceOptions, type CheckCaptchaOptions, type CheckCaptchaResponse, CmsDataFormatter, type CmsMetadata, CmsProductService, type CmsProductServiceOptions, type CmsRequestOptions, CmsService, type CmsServiceOptions, CmsTagService, type CmsTagServiceOptions, type CommentItem, type ContentBody, type CreateFolderParams, type CreateLinkParams, type CreateTagCategoryParams, type CreateTagTreeItemParams, type CreateUserGroupParams, type CreateWorkspaceParams, type CustomPostCrudConfig, CustomPostCrudService, type CustomPostItem, CustomPostService, type CustomPostServiceOptions, DEFAULT_POD_URLS, type DownloadFileParams, type DownloadImageParams, type DownloadThumbnailParams, type DownloadZipParams, type EditContentParams, type EditProductParams, type FileVersion, type FinalizeResumableParams, type FormattedGetContentResponse, type FormattedGetProductResponse, type FormattedProductSubject, type FormattedSubject, type GenerateCaptchaResponse, type GetBookmarksParams, type GetCategoriesParams, type GetCategoryResponse, type GetCommentListParams, type GetCommentsParams, type GetContentByEntityIdParams, type GetContentParams, type GetContentResponse, type GetCustomPostParams, type GetCustomPostResponse, type GetFolderChildrenParams, type GetInfOfGraduatedByGraduateDateResponse, type GetProductByEntityIdParams, type GetProductParams, type GetProductResponse, type GetReactionsParams, type GetSessionClassInCurrentDayResponse, type GetTagCategoriesResponse, type GetTagTreeParams, type GetTagTreeResponse, type GetUploadLinkParams, type HandshakeResponse, type IumsResponse, IumsService, type IumsServiceOptions, type LikeCommentParams, type LikePostParams, type MakePublicParams, type MetaContent, type Metadata, NotificationService, type NotificationServiceOptions, type OpenApiBodyKind, type OpenApiHttpMethod, type OpenApiResponseKind, type OpenApiSecurityKind, POD_OPENAPI_DOCUMENT, POD_OPENAPI_ENDPOINTS, type PaginationParams, type PodFormCreationDto, type PodFormDownloadLinkParams, type PodFormExportParams, type PodFormField, type PodFormFolderDto, type PodFormGetParams, type PodFormId, type PodFormItem, type PodFormJson, type PodFormListParams, type PodFormOtpParams, type PodFormPaymentListParams, type PodFormPreviewParams, type PodFormRequestOptions, type PodFormResponse, type PodFormResponseCreationDto, type PodFormResponseInitiationDto, type PodFormResponseListParams, PodFormService, type PodFormServiceOptions, type PodFormSettingsUpdateDto, type PodFormTemplateDto, type PodFormUpdateDto, type PodOpenApiEndpoint, type PodOpenApiOptions, type PodResponse, PodSdk, type PodSdkConfig, type PodUrlsConfig, PodspaceBookmarksService, type PodspaceBookmarksServiceOptions, PodspaceFilesService, type PodspaceFilesServiceOptions, PodspaceFoldersService, type PodspaceFoldersServiceOptions, PodspaceLinksService, type PodspaceLinksServiceOptions, PodspaceMeService, type PodspaceMeServiceOptions, PodspaceMetadataService, type PodspaceMetadataServiceOptions, type PodspaceRequestOptions, type PodspaceRestResponse, PodspaceResumableService, type PodspaceResumableServiceOptions, PodspaceService, type PodspaceServiceOptions, PodspaceSharesService, type PodspaceSharesServiceOptions, PodspaceTagsService, type PodspaceTagsServiceOptions, PodspaceTrashService, type PodspaceTrashServiceOptions, PodspaceUploadDownloadService, type PodspaceUploadDownloadServiceOptions, type PodspaceUploadResponse, type PodspaceUploadResult, type PodspaceUser, PodspaceUserGroupsService, type PodspaceUserGroupsServiceOptions, PodspaceWorkspacesService, type PodspaceWorkspacesServiceOptions, type ProductBody, type ProductItem, type ProductItemWithFormatted, type Rate, type ReplaceFileParams, type ResultItem, type ResultItemWithFormatted, SANDBOX_POD_URLS, type SearchFilesParams, type SearchTimelineByMetadataParam, type SearchTimelineParamMetaQuery, type SearchTimelineResponse, type SearchTimelineResultItem, type SendOtpOptions, type SendSmsParams, type SendSmsResponse, type SeoType, type Share, type ShareAccess, type ShareEntityParams, type ShareType, type SocialResponse, SocialService, type SocialServiceOptions, type SpaceEntity, type SpaceFile, type SpaceFolder, SsoService, type SsoServiceOptions, type SsoUserProfile, type Subject, type TagCategoryItem, type TagCategoryListParams, type TagTreeAncestorsParams, type TagTreeMetadata, type TagtreesType, type ThumbnailStatus, type TimelineResponse, type TimelineSearchBody, type TokenResponse, type UpdateCustomPostParams, type UpdateLinkParams, type UpdateTagCategoryParams, type UpdateTagTreeItemParams, type UpdateWorkspaceParams, type UploadFileParams, type UploadImageBase64Params, type UploadMultipleFilesParams, type UserGroup, type UserPlan, type UserPostInfo, type UserUsageReport, type VerifyResponse, type Workspace, type WorkspaceMember, createPodOpenApiDocument, createPodSdk, PodSdk as default, encodeBase64, generatePodSignatureHeader, podSwaggerDocument, resolvePodUrls };
3963
+ export { type AccessLevel, type AddCommentParams, type AddContentParams, type AddCustomPostParams, type AddCustomPostResponse, type AddProductParams, type AddRelatedContentTypesBody, type ApiPageLink, type ApiPageList, type ApiSimplePageList, type ArchiveContentTypesParams, type ArchiveParams, type ArchiveProductParams, type AttributeTemplate, type AttributeTemplateField, type BatchPublishParams, type BatchPublishProductParams, type BatchUnpublishParams, type BatchUnpublishProductParams, type BriefContentType, type Business, type CachePolicy, CaptchaService, type CaptchaServiceOptions, type CheckCaptchaOptions, type CheckCaptchaResponse, CmsContentTypeService, type CmsContentTypeServiceOptions, CmsDataFormatter, type CmsGenericResponse, type CmsMetadata, CmsProductService, type CmsProductServiceOptions, type CmsRequestOptions, CmsService, type CmsServiceOptions, CmsTagService, type CmsTagServiceOptions, type CommentItem, type ContentBody, type ContentTypeFieldItem, type ContentTypeItem, type CreateContentTypeParams, type CreateFolderParams, type CreateLinkParams, type CreateTagCategoryParams, type CreateTagTreeItemParams, type CreateUserGroupParams, type CreateWorkspaceParams, type CustomPostCrudConfig, CustomPostCrudService, type CustomPostItem, CustomPostService, type CustomPostServiceOptions, DEFAULT_POD_URLS, type DeleteMultiInvoicePercentParams, type DeleteRelatedContentTypeParams, type DownloadFileParams, type DownloadImageParams, type DownloadThumbnailParams, type DownloadZipParams, type EditContentParams, type EditProductParams, type FileVersion, type FinalizeResumableParams, type FormattedGetContentResponse, type FormattedGetProductResponse, type FormattedProductSubject, type FormattedSubject, type GenerateCaptchaResponse, type GetArchivedContentTypesParams, type GetBookmarksParams, type GetBriefContentTypesParams, type GetCategoriesParams, type GetCategoryResponse, type GetCommentListParams, type GetCommentsParams, type GetContentByEntityIdParams, type GetContentParams, type GetContentResponse, type GetContentTypeTemplatesParams, type GetContentTypesParams, type GetCustomPostParams, type GetCustomPostResponse, type GetFolderChildrenParams, type GetInfOfGraduatedByGraduateDateResponse, type GetMultiInvoiceShareParams, type GetMyContentTypesParams, type GetOneContentTypeParams, type GetProductByEntityIdParams, type GetProductParams, type GetProductResponse, type GetReactionsParams, type GetSessionClassInCurrentDayResponse, type GetTagCategoriesResponse, type GetTagTreeParams, type GetTagTreeResponse, type GetTemplateCategoriesParams, type GetTemplateIgsParams, type GetUploadLinkParams, type HandshakeResponse, type IumsResponse, IumsService, type IumsServiceOptions, type LikeCommentParams, type LikePostParams, type MakePublicParams, type MetaContent, type Metadata, type MultiInvoiceDealerItem, type MultiInvoicePercentItem, type MultiInvoicePercentParams, NotificationService, type NotificationServiceOptions, type OpenApiBodyKind, type OpenApiHttpMethod, type OpenApiResponseKind, type OpenApiSecurityKind, POD_OPENAPI_DOCUMENT, POD_OPENAPI_ENDPOINTS, type PaginationParams, type PodFormCreationDto, type PodFormDownloadLinkParams, type PodFormExportParams, type PodFormField, type PodFormFolderDto, type PodFormGetParams, type PodFormId, type PodFormItem, type PodFormJson, type PodFormListParams, type PodFormOtpParams, type PodFormPaymentListParams, type PodFormPreviewParams, type PodFormRequestOptions, type PodFormResponse, type PodFormResponseCreationDto, type PodFormResponseInitiationDto, type PodFormResponseListParams, PodFormService, type PodFormServiceOptions, type PodFormSettingsUpdateDto, type PodFormTemplateDto, type PodFormUpdateDto, type PodOpenApiEndpoint, type PodOpenApiOptions, type PodResponse, PodSdk, type PodSdkConfig, type PodUrlsConfig, PodspaceBookmarksService, type PodspaceBookmarksServiceOptions, PodspaceFilesService, type PodspaceFilesServiceOptions, PodspaceFoldersService, type PodspaceFoldersServiceOptions, PodspaceLinksService, type PodspaceLinksServiceOptions, PodspaceMeService, type PodspaceMeServiceOptions, PodspaceMetadataService, type PodspaceMetadataServiceOptions, type PodspaceRequestOptions, type PodspaceRestResponse, PodspaceResumableService, type PodspaceResumableServiceOptions, PodspaceService, type PodspaceServiceOptions, PodspaceSharesService, type PodspaceSharesServiceOptions, PodspaceTagsService, type PodspaceTagsServiceOptions, PodspaceTrashService, type PodspaceTrashServiceOptions, PodspaceUploadDownloadService, type PodspaceUploadDownloadServiceOptions, type PodspaceUploadResponse, type PodspaceUploadResult, type PodspaceUser, PodspaceUserGroupsService, type PodspaceUserGroupsServiceOptions, PodspaceWorkspacesService, type PodspaceWorkspacesServiceOptions, type ProductBody, type ProductItem, type ProductItemWithFormatted, type Rate, type RelatedContentTypeField, type ReplaceFileParams, type ResultItem, type ResultItemWithFormatted, SANDBOX_POD_URLS, type SearchFilesParams, type SearchTimelineByMetadataParam, type SearchTimelineParamMetaQuery, type SearchTimelineResponse, type SearchTimelineResultItem, type SendOtpOptions, type SendSmsParams, type SendSmsResponse, type SeoType, type Share, type ShareAccess, type ShareEntityParams, type ShareType, type SocialResponse, SocialService, type SocialServiceOptions, type SpaceEntity, type SpaceFile, type SpaceFolder, SsoService, type SsoServiceOptions, type SsoUserProfile, type Subject, type TagCategoryItem, type TagCategoryListParams, type TagTreeAncestorsParams, type TagTreeMetadata, type TagtreesType, type TemplateCategoryNode, type TemplateIgItem, type TemplateIgLocation, type ThumbnailStatus, type TimelineResponse, type TimelineSearchBody, type TokenResponse, type UnarchiveContentTypesParams, type UpdateContentTypeParams, type UpdateCustomPostParams, type UpdateLinkParams, type UpdateMyContentTypeParams, type UpdateRelatedContentTypesBody, type UpdateTagCategoryParams, type UpdateTagTreeItemParams, type UpdateWorkspaceParams, type UploadFileParams, type UploadImageBase64Params, type UploadMultipleFilesParams, type UserGroup, type UserPlan, type UserPostInfo, type UserUsageReport, type VerifyResponse, type Workspace, type WorkspaceMember, createPodOpenApiDocument, createPodSdk, PodSdk as default, encodeBase64, generatePodSignatureHeader, podSwaggerDocument, resolvePodUrls };