@rezamirzapour/pod-sdk 1.0.9 → 1.0.11

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/dist/index.d.mts CHANGED
@@ -134,45 +134,38 @@ declare class SsoService {
134
134
  /**
135
135
  * Types for Captcha service
136
136
  */
137
- interface GenerateCaptchaOptions {
138
- /** Width of captcha image (default: 200) */
139
- width?: number;
140
- /** Height of captcha image (default: 80) */
141
- height?: number;
142
- /** Length of captcha code (default: 5) */
143
- length?: number;
144
- /** Type of captcha (e.g., 'numeric', 'alphanumeric') */
145
- type?: string;
146
- /** Output format: 'svg' or 'png' (default: 'svg') */
147
- format?: 'svg' | 'png';
148
- /** Add noise to image (default: true) */
149
- noise?: boolean;
150
- /** Background color (hex) */
151
- bgColor?: string;
152
- /** Font color (hex) */
153
- fontColor?: string;
154
- /** Font size */
155
- fontSize?: number;
156
- }
157
137
  interface GenerateCaptchaResponse {
158
- /** Unique identifier for this captcha */
159
- captchaId: string;
160
- /** Captcha image as data URI or SVG string */
161
- image: string;
162
- /** Expiration timestamp (Unix epoch) */
163
- expiresAt: number;
164
- /** Mime type of image */
165
- mimeType: string;
138
+ referenceNumber: number;
139
+ hasError: boolean;
140
+ errorCode: number;
141
+ refId: string;
142
+ message: any[];
143
+ count: number;
144
+ aggregations: number;
145
+ result: ResultData;
146
+ metaData: any[];
147
+ }
148
+ interface ResultData {
149
+ hash: string;
150
+ expireTime: number;
151
+ challenge: string;
152
+ url: string;
166
153
  }
167
154
  interface CheckCaptchaOptions {
168
155
  /** The captcha value entered by user */
169
- captchaValue: string;
156
+ value: string;
157
+ hash: string;
170
158
  }
171
159
  interface CheckCaptchaResponse {
172
- /** Whether captcha is valid */
173
- valid: boolean;
174
- /** Optional message */
175
- message?: string;
160
+ hasError: boolean;
161
+ errorCode: number;
162
+ message: any[];
163
+ result: boolean | any[];
164
+ metaData?: any[];
165
+ refId?: string;
166
+ referenceNumber?: number;
167
+ count?: number;
168
+ aggregations?: number;
176
169
  }
177
170
 
178
171
  interface CaptchaServiceOptions {
@@ -183,16 +176,15 @@ interface CaptchaServiceOptions {
183
176
  declare class CaptchaService {
184
177
  private http;
185
178
  private clientId;
186
- private accessToken;
187
179
  constructor(options: CaptchaServiceOptions);
188
180
  /**
189
181
  * Get a new captcha image
190
182
  */
191
- get(options?: GenerateCaptchaOptions): Promise<PodResponse<GenerateCaptchaResponse>>;
183
+ get(): Promise<GenerateCaptchaResponse>;
192
184
  /**
193
185
  * Check if the entered captcha value is valid
194
186
  */
195
- check(captchaId: string, options: CheckCaptchaOptions): Promise<PodResponse<CheckCaptchaResponse>>;
187
+ check(options: CheckCaptchaOptions): Promise<CheckCaptchaResponse>;
196
188
  }
197
189
 
198
190
  interface SearchTimelineParamMetaQuery<T extends object = any> {
@@ -2755,6 +2747,7 @@ interface CmsRequestOptions<TSubject = any> {
2755
2747
  cache?: RequestCache;
2756
2748
  headers?: HeadersInit;
2757
2749
  signal?: AbortSignal;
2750
+ queryArrayFormat?: 'repeat' | 'comma' | 'brackets' | 'indices';
2758
2751
  }
2759
2752
  interface TagCategoryItem {
2760
2753
  id: number;
@@ -2889,6 +2882,7 @@ declare class CmsProductService {
2889
2882
  private apiToken;
2890
2883
  private revalidate;
2891
2884
  constructor(options: CmsProductServiceOptions);
2885
+ private normalizeParams;
2892
2886
  private get commonHeaders();
2893
2887
  private get managingHeaders();
2894
2888
  /**
@@ -3141,6 +3135,7 @@ declare class CmsService {
3141
3135
  */
3142
3136
  readonly tags: CmsTagService;
3143
3137
  constructor(options: CmsServiceOptions);
3138
+ private normalizeParams;
3144
3139
  private get commonHeaders();
3145
3140
  private get managingHeaders();
3146
3141
  /**
@@ -3420,6 +3415,47 @@ declare const SANDBOX_POD_URLS: Required<PodUrlsConfig>;
3420
3415
  */
3421
3416
  declare function resolvePodUrls(urls?: PodUrlsConfig, sandbox?: boolean): Required<PodUrlsConfig>;
3422
3417
 
3418
+ type OpenApiHttpMethod = 'get' | 'post' | 'put' | 'patch' | 'delete' | 'head';
3419
+ type OpenApiBodyKind = 'json' | 'form' | 'multipart' | 'binary';
3420
+ type OpenApiResponseKind = 'json' | 'binary' | 'empty';
3421
+ type OpenApiSecurityKind = 'apiToken' | 'bearer' | 'basic' | 'clientId' | 'podFormToken' | 'cmsPublic' | 'cmsManage' | 'signature' | 'none';
3422
+ interface PodOpenApiOptions {
3423
+ /** Overrides the generated document title. */
3424
+ title?: string;
3425
+ /** Overrides the API document version. */
3426
+ version?: string;
3427
+ /** Uses the SDK sandbox URL set as the Swagger servers. */
3428
+ sandbox?: boolean;
3429
+ /** Applies the same URL overrides accepted by `PodSdk`. */
3430
+ urls?: PodUrlsConfig;
3431
+ }
3432
+ interface PodOpenApiEndpoint {
3433
+ tag: string;
3434
+ method: OpenApiHttpMethod;
3435
+ path: string;
3436
+ operationId: string;
3437
+ summary: string;
3438
+ /** SDK methods backed by this HTTP operation (aliases included). */
3439
+ sdkMethods?: string[];
3440
+ query?: string[];
3441
+ body?: OpenApiBodyKind;
3442
+ bodyRequired?: boolean;
3443
+ response?: OpenApiResponseKind;
3444
+ security?: OpenApiSecurityKind;
3445
+ deprecated?: boolean;
3446
+ }
3447
+ /**
3448
+ * Canonical registry for every HTTP operation exposed by the SDK services.
3449
+ * It is exported so consumers can build filtered documentation or API clients.
3450
+ */
3451
+ declare const POD_OPENAPI_ENDPOINTS: readonly PodOpenApiEndpoint[];
3452
+ /** Creates a Swagger UI compatible OpenAPI 3 document for all POD SDK services. */
3453
+ declare function createPodOpenApiDocument(options?: PodOpenApiOptions): any;
3454
+ /** Default production Swagger document. */
3455
+ declare const POD_OPENAPI_DOCUMENT: any;
3456
+ /** Familiar Swagger-oriented alias for consumers. */
3457
+ declare const podSwaggerDocument: any;
3458
+
3423
3459
  /**
3424
3460
  * Cryptographic and encoding utilities for POD Platform services.
3425
3461
  * Uses standard Web Crypto API (supported natively in Node.js 18+, Browsers, and Edge).
@@ -3427,4 +3463,4 @@ declare function resolvePodUrls(urls?: PodUrlsConfig, sandbox?: boolean): Requir
3427
3463
  declare function encodeBase64(str: string): string;
3428
3464
  declare function generatePodSignatureHeader(keyId: string, privateKeyPem?: string): Promise<string>;
3429
3465
 
3430
- 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 GenerateCaptchaOptions, 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 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 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, createPodSdk, PodSdk as default, encodeBase64, generatePodSignatureHeader, resolvePodUrls };
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 };
package/dist/index.d.ts CHANGED
@@ -134,45 +134,38 @@ declare class SsoService {
134
134
  /**
135
135
  * Types for Captcha service
136
136
  */
137
- interface GenerateCaptchaOptions {
138
- /** Width of captcha image (default: 200) */
139
- width?: number;
140
- /** Height of captcha image (default: 80) */
141
- height?: number;
142
- /** Length of captcha code (default: 5) */
143
- length?: number;
144
- /** Type of captcha (e.g., 'numeric', 'alphanumeric') */
145
- type?: string;
146
- /** Output format: 'svg' or 'png' (default: 'svg') */
147
- format?: 'svg' | 'png';
148
- /** Add noise to image (default: true) */
149
- noise?: boolean;
150
- /** Background color (hex) */
151
- bgColor?: string;
152
- /** Font color (hex) */
153
- fontColor?: string;
154
- /** Font size */
155
- fontSize?: number;
156
- }
157
137
  interface GenerateCaptchaResponse {
158
- /** Unique identifier for this captcha */
159
- captchaId: string;
160
- /** Captcha image as data URI or SVG string */
161
- image: string;
162
- /** Expiration timestamp (Unix epoch) */
163
- expiresAt: number;
164
- /** Mime type of image */
165
- mimeType: string;
138
+ referenceNumber: number;
139
+ hasError: boolean;
140
+ errorCode: number;
141
+ refId: string;
142
+ message: any[];
143
+ count: number;
144
+ aggregations: number;
145
+ result: ResultData;
146
+ metaData: any[];
147
+ }
148
+ interface ResultData {
149
+ hash: string;
150
+ expireTime: number;
151
+ challenge: string;
152
+ url: string;
166
153
  }
167
154
  interface CheckCaptchaOptions {
168
155
  /** The captcha value entered by user */
169
- captchaValue: string;
156
+ value: string;
157
+ hash: string;
170
158
  }
171
159
  interface CheckCaptchaResponse {
172
- /** Whether captcha is valid */
173
- valid: boolean;
174
- /** Optional message */
175
- message?: string;
160
+ hasError: boolean;
161
+ errorCode: number;
162
+ message: any[];
163
+ result: boolean | any[];
164
+ metaData?: any[];
165
+ refId?: string;
166
+ referenceNumber?: number;
167
+ count?: number;
168
+ aggregations?: number;
176
169
  }
177
170
 
178
171
  interface CaptchaServiceOptions {
@@ -183,16 +176,15 @@ interface CaptchaServiceOptions {
183
176
  declare class CaptchaService {
184
177
  private http;
185
178
  private clientId;
186
- private accessToken;
187
179
  constructor(options: CaptchaServiceOptions);
188
180
  /**
189
181
  * Get a new captcha image
190
182
  */
191
- get(options?: GenerateCaptchaOptions): Promise<PodResponse<GenerateCaptchaResponse>>;
183
+ get(): Promise<GenerateCaptchaResponse>;
192
184
  /**
193
185
  * Check if the entered captcha value is valid
194
186
  */
195
- check(captchaId: string, options: CheckCaptchaOptions): Promise<PodResponse<CheckCaptchaResponse>>;
187
+ check(options: CheckCaptchaOptions): Promise<CheckCaptchaResponse>;
196
188
  }
197
189
 
198
190
  interface SearchTimelineParamMetaQuery<T extends object = any> {
@@ -2755,6 +2747,7 @@ interface CmsRequestOptions<TSubject = any> {
2755
2747
  cache?: RequestCache;
2756
2748
  headers?: HeadersInit;
2757
2749
  signal?: AbortSignal;
2750
+ queryArrayFormat?: 'repeat' | 'comma' | 'brackets' | 'indices';
2758
2751
  }
2759
2752
  interface TagCategoryItem {
2760
2753
  id: number;
@@ -2889,6 +2882,7 @@ declare class CmsProductService {
2889
2882
  private apiToken;
2890
2883
  private revalidate;
2891
2884
  constructor(options: CmsProductServiceOptions);
2885
+ private normalizeParams;
2892
2886
  private get commonHeaders();
2893
2887
  private get managingHeaders();
2894
2888
  /**
@@ -3141,6 +3135,7 @@ declare class CmsService {
3141
3135
  */
3142
3136
  readonly tags: CmsTagService;
3143
3137
  constructor(options: CmsServiceOptions);
3138
+ private normalizeParams;
3144
3139
  private get commonHeaders();
3145
3140
  private get managingHeaders();
3146
3141
  /**
@@ -3420,6 +3415,47 @@ declare const SANDBOX_POD_URLS: Required<PodUrlsConfig>;
3420
3415
  */
3421
3416
  declare function resolvePodUrls(urls?: PodUrlsConfig, sandbox?: boolean): Required<PodUrlsConfig>;
3422
3417
 
3418
+ type OpenApiHttpMethod = 'get' | 'post' | 'put' | 'patch' | 'delete' | 'head';
3419
+ type OpenApiBodyKind = 'json' | 'form' | 'multipart' | 'binary';
3420
+ type OpenApiResponseKind = 'json' | 'binary' | 'empty';
3421
+ type OpenApiSecurityKind = 'apiToken' | 'bearer' | 'basic' | 'clientId' | 'podFormToken' | 'cmsPublic' | 'cmsManage' | 'signature' | 'none';
3422
+ interface PodOpenApiOptions {
3423
+ /** Overrides the generated document title. */
3424
+ title?: string;
3425
+ /** Overrides the API document version. */
3426
+ version?: string;
3427
+ /** Uses the SDK sandbox URL set as the Swagger servers. */
3428
+ sandbox?: boolean;
3429
+ /** Applies the same URL overrides accepted by `PodSdk`. */
3430
+ urls?: PodUrlsConfig;
3431
+ }
3432
+ interface PodOpenApiEndpoint {
3433
+ tag: string;
3434
+ method: OpenApiHttpMethod;
3435
+ path: string;
3436
+ operationId: string;
3437
+ summary: string;
3438
+ /** SDK methods backed by this HTTP operation (aliases included). */
3439
+ sdkMethods?: string[];
3440
+ query?: string[];
3441
+ body?: OpenApiBodyKind;
3442
+ bodyRequired?: boolean;
3443
+ response?: OpenApiResponseKind;
3444
+ security?: OpenApiSecurityKind;
3445
+ deprecated?: boolean;
3446
+ }
3447
+ /**
3448
+ * Canonical registry for every HTTP operation exposed by the SDK services.
3449
+ * It is exported so consumers can build filtered documentation or API clients.
3450
+ */
3451
+ declare const POD_OPENAPI_ENDPOINTS: readonly PodOpenApiEndpoint[];
3452
+ /** Creates a Swagger UI compatible OpenAPI 3 document for all POD SDK services. */
3453
+ declare function createPodOpenApiDocument(options?: PodOpenApiOptions): any;
3454
+ /** Default production Swagger document. */
3455
+ declare const POD_OPENAPI_DOCUMENT: any;
3456
+ /** Familiar Swagger-oriented alias for consumers. */
3457
+ declare const podSwaggerDocument: any;
3458
+
3423
3459
  /**
3424
3460
  * Cryptographic and encoding utilities for POD Platform services.
3425
3461
  * Uses standard Web Crypto API (supported natively in Node.js 18+, Browsers, and Edge).
@@ -3427,4 +3463,4 @@ declare function resolvePodUrls(urls?: PodUrlsConfig, sandbox?: boolean): Requir
3427
3463
  declare function encodeBase64(str: string): string;
3428
3464
  declare function generatePodSignatureHeader(keyId: string, privateKeyPem?: string): Promise<string>;
3429
3465
 
3430
- 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 GenerateCaptchaOptions, 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 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 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, createPodSdk, PodSdk as default, encodeBase64, generatePodSignatureHeader, resolvePodUrls };
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 };