@resolution/confluence-api-client 0.7.5 → 0.7.6
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/CHANGELOG.md +8 -0
- package/lib/openapi/v1/BaseConfluenceApiV1Client.d.ts +2 -2
- package/lib/openapi/v1/BaseConfluenceApiV1Client.js.map +1 -1
- package/lib/openapi/v1/models/contentBody.d.ts +87 -1
- package/lib/openapi/v1/models/contentBody.js +21 -0
- package/lib/openapi/v1/models/contentBody.js.map +1 -1
- package/lib/openapi/v1/models/space.d.ts +2 -1
- package/lib/openapi/v1/models/space.js.map +1 -1
- package/lib/openapi/v1/services/ContentBodyService.d.ts +62 -2
- package/lib/openapi/v1/services/ContentBodyService.js +104 -1
- package/lib/openapi/v1/services/ContentBodyService.js.map +1 -1
- package/package.json +3 -3
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,14 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [0.7.6](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/compare/v0.7.5...v0.7.6) (2024-10-01)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @resolution/confluence-api-client
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
6
14
|
## [0.7.5](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/compare/v0.7.4...v0.7.5) (2024-09-24)
|
|
7
15
|
|
|
8
16
|
**Note:** Version bump only for package @resolution/confluence-api-client
|
|
@@ -4,7 +4,7 @@ import type { AffectedObject, AuditRecord, AuditRecordArray, AuditRecordCreate,
|
|
|
4
4
|
import type { AsyncId, Container, Content, ContentArray, ContentBody, ContentBodyCreate, ContentChildren, ContentId, ContentRestriction, EmbeddedContent, GenericAccountId, GenericLinks, GenericUserKey, GenericUserName, Group, GroupArrayWithLinks, IconV1, LabelArray, LabelCreate, LabelV1, LongTask, LookAndFeel, Message, OperationCheckResult, Space, SpaceSettings, Theme, UserArray, UserDetails, UserV1, VersionV1, WebResourceDependencies } from "./models/common";
|
|
5
5
|
import type { ButtonLookAndFeel, ContainerLookAndFeel, ContentBlueprintDraft, ContentBodyCreateStorage, ContentChildType, ContentCreate, ContentHistory, ContentLookAndFeel, ContentMetadata, ContentUpdate, Embeddable, GlobalSpaceIdentifier, GroupArray, HeaderLookAndFeel, HorizontalHeaderLookAndFeel, MenusLookAndFeel, NavigationLookAndFeel, ScreenLookAndFeel, SearchFieldLookAndFeel, SpaceDescriptionV1, SpacePermissionV1, SuperBatchWebResources, TopNavigationLookAndFeel, UsersUserKeys } from "./models/content";
|
|
6
6
|
import type { AttachmentPropertiesUpdateBody } from "./models/contentAttachments";
|
|
7
|
-
import type { AsyncContentBody } from "./models/contentBody";
|
|
7
|
+
import type { AsyncContentBody, AsyncContentBodyArray, AsyncIdArray, ContentBodyConversionInput, ContentBodyConversionInputArray } from "./models/contentBody";
|
|
8
8
|
import type { CopyPageHierarchyRequest, CopyPageHierarchyTitleOptions, CopyPageRequest, CopyPageRequestDestination } from "./models/contentChildrenAndDescendants";
|
|
9
9
|
import type { LabelCreateArray } from "./models/contentLabels";
|
|
10
10
|
import type { MacroInstance } from "./models/contentMacroBody";
|
|
@@ -255,4 +255,4 @@ export declare class BaseConfluenceApiV1Client extends CommonHttpService {
|
|
|
255
255
|
get users(): UsersService;
|
|
256
256
|
constructor(options?: BaseConfluenceApiV1ClientOptions);
|
|
257
257
|
}
|
|
258
|
-
export type { AccountId, GroupName, AccountIdEmailRecord, AccountIdEmailRecordArray, BulkUserLookup, BulkUserLookupArray, UserAnonymous, AffectedObject, AuditRecord, AuditRecordArray, AuditRecordCreate, ChangedValue, RetentionPeriod, AsyncContentBody, AsyncId, Container, Content, ContentArray, ContentBody, ContentBodyCreate, ContentChildren, ContentId, ContentRestriction, EmbeddedContent, GenericAccountId, GenericLinks, GenericUserKey, GenericUserName, Group, GroupArrayWithLinks, IconV1, LabelArray, LabelCreate, LabelV1, LongTask, LookAndFeel, Message, OperationCheckResult, Space, SpaceSettings, Theme, UserArray, UserDetails, UserV1, VersionV1, WebResourceDependencies, AttachmentPropertiesUpdateBody, AvailableContentStates, ContentState, ContentStateBulkSetTaskUpdate, ContentStateFailure, ContentStateResponse, ContentStateRestInput, ContentStateSettings, BlueprintTemplate, BlueprintTemplateArray, ContentTemplate, ContentTemplateArray, ContentTemplateBody, ContentTemplateBodyCreate, ContentTemplateCreate, ContentTemplateUpdate, Breadcrumb, ContainerSummary, SearchPageResponseSearchResult, SearchResult, ButtonLookAndFeel, ContainerLookAndFeel, ContentBlueprintDraft, ContentBodyCreateStorage, ContentChildType, ContentCreate, ContentHistory, ContentLookAndFeel, ContentMetadata, ContentUpdate, Embeddable, GlobalSpaceIdentifier, GroupArray, HeaderLookAndFeel, HorizontalHeaderLookAndFeel, MenusLookAndFeel, NavigationLookAndFeel, ScreenLookAndFeel, SearchFieldLookAndFeel, SpaceDescriptionV1, SpacePermissionV1, SuperBatchWebResources, TopNavigationLookAndFeel, UsersUserKeys, ConnectModule, ConnectModules, DynamicModulesErrorMessage, ContentPermissionRequest, PermissionCheckResponse, PermissionSubjectWithGroupId, ContentPropertyArray, ContentPropertyCreate, ContentPropertyCreateNoKey, ContentPropertyUpdate, ContentPropertyV1, ContentRestrictionAddOrUpdateArray, ContentRestrictionArray, ContentRestrictionUpdate, CopyPageHierarchyRequest, CopyPageHierarchyTitleOptions, CopyPageRequest, CopyPageRequestDestination, GroupCreate, SpaceArray, SpaceCreate, SpaceDescriptionCreate, SpacePermissionCreate, SpaceUpdate, LabelCreateArray, LabelDetails, LabeledContent, LabeledContentPageResponse, LabeledContentType, LongTaskStatus, LongTaskStatusArray, LongTaskStatusWithLinks, LookAndFeelSelection, LookAndFeelSettings, LookAndFeelWithLinks, SystemInfoEntity, MacroInstance, PermissionSubject, SpacePermissionCustomContent, SpacePermissionRequest, SpacePermissionV2, PropertyValue, SpacePropertyArray, SpacePropertyCreate, SpacePropertyCreateNoKey, SpacePropertyUpdate, SpacePropertyV1, Relation, RelationArray, RelationData, SpaceSettingsUpdate, SpaceWatch, SpaceWatchArray, UserWatch, Watch, WatchArray, WatchUser, TaskPageResponse, TaskStatusUpdate, TaskV1, ThemeArray, ThemeNoLinks, ThemeUpdate, UserProperty, UserPropertyCreate, UserPropertyKeyArray, UserPropertyUpdate, VersionArray, VersionRestore, };
|
|
258
|
+
export type { AccountId, GroupName, AccountIdEmailRecord, AccountIdEmailRecordArray, BulkUserLookup, BulkUserLookupArray, UserAnonymous, AffectedObject, AuditRecord, AuditRecordArray, AuditRecordCreate, ChangedValue, RetentionPeriod, AsyncContentBody, AsyncContentBodyArray, AsyncIdArray, ContentBodyConversionInput, ContentBodyConversionInputArray, AsyncId, Container, Content, ContentArray, ContentBody, ContentBodyCreate, ContentChildren, ContentId, ContentRestriction, EmbeddedContent, GenericAccountId, GenericLinks, GenericUserKey, GenericUserName, Group, GroupArrayWithLinks, IconV1, LabelArray, LabelCreate, LabelV1, LongTask, LookAndFeel, Message, OperationCheckResult, Space, SpaceSettings, Theme, UserArray, UserDetails, UserV1, VersionV1, WebResourceDependencies, AttachmentPropertiesUpdateBody, AvailableContentStates, ContentState, ContentStateBulkSetTaskUpdate, ContentStateFailure, ContentStateResponse, ContentStateRestInput, ContentStateSettings, BlueprintTemplate, BlueprintTemplateArray, ContentTemplate, ContentTemplateArray, ContentTemplateBody, ContentTemplateBodyCreate, ContentTemplateCreate, ContentTemplateUpdate, Breadcrumb, ContainerSummary, SearchPageResponseSearchResult, SearchResult, ButtonLookAndFeel, ContainerLookAndFeel, ContentBlueprintDraft, ContentBodyCreateStorage, ContentChildType, ContentCreate, ContentHistory, ContentLookAndFeel, ContentMetadata, ContentUpdate, Embeddable, GlobalSpaceIdentifier, GroupArray, HeaderLookAndFeel, HorizontalHeaderLookAndFeel, MenusLookAndFeel, NavigationLookAndFeel, ScreenLookAndFeel, SearchFieldLookAndFeel, SpaceDescriptionV1, SpacePermissionV1, SuperBatchWebResources, TopNavigationLookAndFeel, UsersUserKeys, ConnectModule, ConnectModules, DynamicModulesErrorMessage, ContentPermissionRequest, PermissionCheckResponse, PermissionSubjectWithGroupId, ContentPropertyArray, ContentPropertyCreate, ContentPropertyCreateNoKey, ContentPropertyUpdate, ContentPropertyV1, ContentRestrictionAddOrUpdateArray, ContentRestrictionArray, ContentRestrictionUpdate, CopyPageHierarchyRequest, CopyPageHierarchyTitleOptions, CopyPageRequest, CopyPageRequestDestination, GroupCreate, SpaceArray, SpaceCreate, SpaceDescriptionCreate, SpacePermissionCreate, SpaceUpdate, LabelCreateArray, LabelDetails, LabeledContent, LabeledContentPageResponse, LabeledContentType, LongTaskStatus, LongTaskStatusArray, LongTaskStatusWithLinks, LookAndFeelSelection, LookAndFeelSettings, LookAndFeelWithLinks, SystemInfoEntity, MacroInstance, PermissionSubject, SpacePermissionCustomContent, SpacePermissionRequest, SpacePermissionV2, PropertyValue, SpacePropertyArray, SpacePropertyCreate, SpacePropertyCreateNoKey, SpacePropertyUpdate, SpacePropertyV1, Relation, RelationArray, RelationData, SpaceSettingsUpdate, SpaceWatch, SpaceWatchArray, UserWatch, Watch, WatchArray, WatchUser, TaskPageResponse, TaskStatusUpdate, TaskV1, ThemeArray, ThemeNoLinks, ThemeUpdate, UserProperty, UserPropertyCreate, UserPropertyKeyArray, UserPropertyUpdate, VersionArray, VersionRestore, };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BaseConfluenceApiV1Client.js","sourceRoot":"","sources":["../../../src/openapi/v1/BaseConfluenceApiV1Client.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6DAA6D;AAC7D,iEAA8D;
|
|
1
|
+
{"version":3,"file":"BaseConfluenceApiV1Client.js","sourceRoot":"","sources":["../../../src/openapi/v1/BaseConfluenceApiV1Client.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6DAA6D;AAC7D,iEAA8D;AA0M9D,kEAA+D;AAC/D,0DAAuD;AACvD,oFAAiF;AACjF,sEAAmE;AACnE,0GAAuG;AACvG,8EAA2E;AAC3E,0EAAuE;AACvE,gFAA6E;AAC7E,oFAAiF;AACjF,kFAA+E;AAC/E,sFAAmF;AACnF,8DAA2D;AAC3D,0EAAuE;AACvE,8EAA2E;AAC3E,4EAAyE;AACzE,4EAAyE;AACzE,wEAAqE;AACrE,0DAAuD;AACvD,sEAAmE;AACnE,kEAA+D;AAC/D,8EAA2E;AAC3E,gEAA6D;AAC7D,4DAAyD;AACzD,gEAA6D;AAC7D,gFAA6E;AAC7E,8EAA2E;AAC3E,0DAAuD;AACvD,0EAAuE;AACvE,gEAA6D;AAC7D,4DAAyD;AACzD,4EAAyE;AACzE,0DAAuD;AACvD,uEAAoE;AAGpE,gCAAgC;AAChC,MAAM,8BAA+B,SAAQ,gBAAgB,CAAC,qBAAqB;IAAnF;;QACE,SAAI,GAAG,gCAAgC,CAAC;IAC1C,CAAC;CAAA;AACD;;;;;;;;;;;;;;;GAeG;AACH,MAAa,yBAA0B,SAAQ,qCAAiB;IAO9D;;;OAGG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,kBAAkB,CAAC,mCAAgB,CAAC,CAAC;IACnD,CAAC;IACD;;;OAGG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,kBAAkB,CAAC,2BAAY,CAAC,CAAC;IAC/C,CAAC;IACD;;;OAGG;IACH,IAAI,kBAAkB;QACpB,OAAO,IAAI,CAAC,kBAAkB,CAAC,qDAAyB,CAAC,CAAC;IAC5D,CAAC;IACD;;;OAGG;IACH,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,kBAAkB,CAAC,uCAAkB,CAAC,CAAC;IACrD,CAAC;IACD;;;OAGG;IACH,IAAI,6BAA6B;QAC/B,OAAO,IAAI,CAAC,kBAAkB,CAAC,2EAAoC,CAAC,CAAC;IACvE,CAAC;IACD;;;;OAIG;IACH,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,kBAAkB,CAAC,+CAAsB,CAAC,CAAC;IACzD,CAAC;IACD;;;OAGG;IACH,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,kBAAkB,CAAC,2CAAoB,CAAC,CAAC;IACvD,CAAC;IACD;;;OAGG;IACH,IAAI,gBAAgB;QAClB,OAAO,IAAI,CAAC,kBAAkB,CAAC,iDAAuB,CAAC,CAAC;IAC1D,CAAC;IACD;;;OAGG;IACH,IAAI,kBAAkB;QACpB,OAAO,IAAI,CAAC,kBAAkB,CAAC,qDAAyB,CAAC,CAAC;IAC5D,CAAC;IACD;;;;OAIG;IACH,IAAI,iBAAiB;QACnB,OAAO,IAAI,CAAC,kBAAkB,CAAC,mDAAwB,CAAC,CAAC;IAC3D,CAAC;IACD;;;OAGG;IACH,IAAI,mBAAmB;QACrB,OAAO,IAAI,CAAC,kBAAkB,CAAC,uDAA0B,CAAC,CAAC;IAC7D,CAAC;IACD;;;OAGG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,kBAAkB,CAAC,+BAAc,CAAC,CAAC;IACjD,CAAC;IACD;;;OAGG;IACH,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,kBAAkB,CAAC,2CAAoB,CAAC,CAAC;IACvD,CAAC;IACD;;;OAGG;IACH,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,kBAAkB,CAAC,+CAAsB,CAAC,CAAC;IACzD,CAAC;IACD;;;OAGG;IACH,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,kBAAkB,CAAC,6CAAqB,CAAC,CAAC;IACxD,CAAC;IACD;;;OAGG;IACH,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,kBAAkB,CAAC,6CAAqB,CAAC,CAAC;IACxD,CAAC;IACD;;;;;OAKG;IACH,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,kBAAkB,CAAC,yCAAmB,CAAC,CAAC;IACtD,CAAC;IACD;;;;;;;;OAQG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,kBAAkB,CAAC,2BAAY,CAAC,CAAC;IAC/C,CAAC;IACD;;;;OAIG;IACH,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,kBAAkB,CAAC,uCAAkB,CAAC,CAAC;IACrD,CAAC;IACD;;;OAGG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,kBAAkB,CAAC,mCAAgB,CAAC,CAAC;IACnD,CAAC;IACD;;;OAGG;IACH,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,kBAAkB,CAAC,+CAAsB,CAAC,CAAC;IACzD,CAAC;IACD;;;OAGG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,kBAAkB,CAAC,iCAAe,CAAC,CAAC;IAClD,CAAC;IACD;;;OAGG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,kBAAkB,CAAC,6BAAa,CAAC,CAAC;IAChD,CAAC;IACD;;;OAGG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,kBAAkB,CAAC,iCAAe,CAAC,CAAC;IAClD,CAAC;IACD;;;OAGG;IACH,IAAI,gBAAgB;QAClB,OAAO,IAAI,CAAC,kBAAkB,CAAC,iDAAuB,CAAC,CAAC;IAC1D,CAAC;IACD;;;;OAIG;IACH,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,kBAAkB,CAAC,+CAAsB,CAAC,CAAC;IACzD,CAAC;IACD;;;OAGG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,kBAAkB,CAAC,2BAAY,CAAC,CAAC;IAC/C,CAAC;IACD;;;OAGG;IACH,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,kBAAkB,CAAC,2CAAoB,CAAC,CAAC;IACvD,CAAC;IACD;;;OAGG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,kBAAkB,CAAC,iCAAe,CAAC,CAAC;IAClD,CAAC;IACD;;;OAGG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,kBAAkB,CAAC,6BAAa,CAAC,CAAC;IAChD,CAAC;IACD;;;OAGG;IACH,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,kBAAkB,CAAC,6CAAqB,CAAC,CAAC;IACxD,CAAC;IACD;;;OAGG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,kBAAkB,CAAC,2BAAY,CAAC,CAAC;IAC/C,CAAC;IACD,YAAY,OAA0C;QACpD,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAlPjB,WAAM,GAAG,IAAI,gBAAgB,CAAC,gBAAgB,CAAC;YACvD,OAAO,EAAE,mCAAmC;YAC5C,kBAAkB,EAAE,MAAM;YAC1B,UAAU,EAAE,8BAA8B;SAC3C,CAAC,CAAC;QACO,cAAS,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC;QA8OtC,IAAI,CAAC,MAAM,CAAC,UAAU,iCACjB,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,GACxB,OAAO,EACV,CAAC;IACL,CAAC;CACF;AAzPD,8DAyPC;AACD,iDAAuB,CAAC,aAAa,CAAC,8BAA8B,CAAC,CAAC"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { type ZodTypeAny } from "zod";
|
|
2
2
|
import type { CommonValidationSchemaStorage } from "../../core/CommonValidationSchemaStorage";
|
|
3
|
-
import { type EmbeddedContent, type GenericLinks, type WebResourceDependencies } from "./common";
|
|
3
|
+
import { type AsyncId, type ContentBodyCreate, type EmbeddedContent, type GenericLinks, type WebResourceDependencies } from "./common";
|
|
4
4
|
/** @category Models */
|
|
5
5
|
export interface AsyncContentBody extends Record<string, unknown> {
|
|
6
6
|
value?: string;
|
|
@@ -34,4 +34,90 @@ export interface AsyncContentBody extends Record<string, unknown> {
|
|
|
34
34
|
};
|
|
35
35
|
_links?: GenericLinks;
|
|
36
36
|
}
|
|
37
|
+
/** @category Models */
|
|
38
|
+
export type AsyncContentBodyArray = AsyncContentBody[];
|
|
39
|
+
/** @category Models */
|
|
40
|
+
export type AsyncIdArray = AsyncId[];
|
|
41
|
+
/** @category Models */
|
|
42
|
+
export interface ContentBodyConversionInput extends Record<string, unknown> {
|
|
43
|
+
/** The name of the target format for the content body conversion. */
|
|
44
|
+
to: string;
|
|
45
|
+
/**
|
|
46
|
+
* If `false`, the cache will erase its current value and begin a new conversion.
|
|
47
|
+
* If `true`, the cache will not erase its current value, and will set the status
|
|
48
|
+
* of the async conversion to “RERUNNING”. Once the data is updated, the status
|
|
49
|
+
* will change to “COMPLETED”. Large macros that take a long time to convert and
|
|
50
|
+
* that need not be immediately up to date (e.g. a macro in which the new
|
|
51
|
+
* conversion result is the same as a previous conversion result that was
|
|
52
|
+
* completed within the last 5 minutes) should set this field to `true`. Cache
|
|
53
|
+
* values are stored per user per content body and expansions.
|
|
54
|
+
*/
|
|
55
|
+
allowCache?: boolean;
|
|
56
|
+
/**
|
|
57
|
+
* The space key used for resolving embedded content (page includes, files, and
|
|
58
|
+
* links) in the content body. For example, if the source content contains the
|
|
59
|
+
* link `<ac:link><ri:page ri:content-title="Example page" /><ac:link>` and the
|
|
60
|
+
* `spaceKeyContext=TEST` parameter is provided, then the link will be converted
|
|
61
|
+
* into a link to the "Example page" page in the "TEST" space.
|
|
62
|
+
*/
|
|
63
|
+
spaceKeyContext?: string;
|
|
64
|
+
/**
|
|
65
|
+
* The content ID used to find the space for resolving embedded content (page
|
|
66
|
+
* includes, files, and links) in the content body. For example, if the source
|
|
67
|
+
* content contains the link `<ac:link><ri:page ri:content-title="Example page"
|
|
68
|
+
* /><ac:link>` and the `contentIdContext=123` parameter is provided, then the
|
|
69
|
+
* link will be converted into a link to the "Example page" page in the same space
|
|
70
|
+
* that has the content with ID=123. Note that `spaceKeyContext` will be ignored
|
|
71
|
+
* if this parameter is provided.
|
|
72
|
+
*/
|
|
73
|
+
contentIdContext?: string;
|
|
74
|
+
/**
|
|
75
|
+
* Mode used for rendering embedded content, such as attachments. - `current`
|
|
76
|
+
* renders the embedded content using the latest version. - `version-at-save`
|
|
77
|
+
* renders the embedded content using the version at the time of save.
|
|
78
|
+
*/
|
|
79
|
+
embeddedContentRender?: "current" | "version-at-save";
|
|
80
|
+
/**
|
|
81
|
+
* A multi-value, comma-separated parameter indicating which properties of the
|
|
82
|
+
* content to expand and populate. Expands are dependent
|
|
83
|
+
* on the `to` conversion format and may be irrelevant for certain conversions
|
|
84
|
+
* (e.g. `macroRenderedOutput` is redundant when
|
|
85
|
+
* converting to `view` format).
|
|
86
|
+
*
|
|
87
|
+
* If rendering to `view` format, and the body content being converted includes
|
|
88
|
+
* arbitrary nested content (such as macros); then it is
|
|
89
|
+
* necessary to include webresource expands in the request. Webresources for
|
|
90
|
+
* content body are the batched JS and CSS dependencies for
|
|
91
|
+
* any nested dynamic content (i.e. macros).
|
|
92
|
+
*
|
|
93
|
+
* - `embeddedContent` returns metadata for nested content (e.g. page included
|
|
94
|
+
* using page include macro)
|
|
95
|
+
* - `mediaToken` returns JWT token for retrieving attachment data from Media API
|
|
96
|
+
* - `macroRenderedOutput` additionally converts body to view format
|
|
97
|
+
* - `webresource.superbatch.uris.js` returns all common JS dependencies as static
|
|
98
|
+
* URLs
|
|
99
|
+
* - `webresource.superbatch.uris.css` returns all common CSS dependencies as
|
|
100
|
+
* static URLs
|
|
101
|
+
* - `webresource.superbatch.uris.all` returns all common dependencies as static
|
|
102
|
+
* URLs
|
|
103
|
+
* - `webresource.superbatch.tags.all` returns all common JS dependencies as html
|
|
104
|
+
* `<script>` tags
|
|
105
|
+
* - `webresource.superbatch.tags.css` returns all common CSS dependencies as html
|
|
106
|
+
* `<style>` tags
|
|
107
|
+
* - `webresource.superbatch.tags.js` returns all common dependencies as html
|
|
108
|
+
* `<script>` and `<style>` tags
|
|
109
|
+
* - `webresource.uris.js` returns JS dependencies specific to conversion
|
|
110
|
+
* - `webresource.uris.css` returns CSS dependencies specific to conversion
|
|
111
|
+
* - `webresource.uris.all` returns all dependencies specific to conversion
|
|
112
|
+
* - `webresource.tags.all` returns common JS dependencies as html `<script>` tags
|
|
113
|
+
* - `webresource.tags.css` returns common CSS dependencies as html `<style>` tags
|
|
114
|
+
* - `webresource.tags.js` returns common dependencies as html `<script>` and
|
|
115
|
+
* `<style>` tags
|
|
116
|
+
*/
|
|
117
|
+
expand?: string[];
|
|
118
|
+
/** This object is used when creating or updating content. */
|
|
119
|
+
body: ContentBodyCreate;
|
|
120
|
+
}
|
|
121
|
+
/** @category Models */
|
|
122
|
+
export type ContentBodyConversionInputArray = ContentBodyConversionInput[];
|
|
37
123
|
export declare function registerContentBodyValidationSchemas(validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>): void;
|
|
@@ -57,6 +57,27 @@ function registerContentBodyValidationSchemas(validationSchemaStorage) {
|
|
|
57
57
|
})
|
|
58
58
|
.catchall(zod_1.z.unknown())
|
|
59
59
|
.describe("AsyncContentBody"));
|
|
60
|
+
validationSchemaStorage.register("AsyncContentBodyArray", zod_1.z
|
|
61
|
+
.array(validationSchemaStorage.lazy("AsyncContentBody"))
|
|
62
|
+
.describe("AsyncContentBodyArray"));
|
|
63
|
+
validationSchemaStorage.register("AsyncIdArray", zod_1.z.array(validationSchemaStorage.lazy("AsyncId")).describe("AsyncIdArray"));
|
|
64
|
+
validationSchemaStorage.register("ContentBodyConversionInput", zod_1.z
|
|
65
|
+
.object({
|
|
66
|
+
to: zod_1.z.string(),
|
|
67
|
+
allowCache: zod_1.z.boolean().optional(),
|
|
68
|
+
spaceKeyContext: zod_1.z.string().optional(),
|
|
69
|
+
contentIdContext: zod_1.z.string().optional(),
|
|
70
|
+
embeddedContentRender: zod_1.z
|
|
71
|
+
.enum(["current", "version-at-save"])
|
|
72
|
+
.optional(),
|
|
73
|
+
expand: zod_1.z.array(zod_1.z.string()).optional(),
|
|
74
|
+
body: validationSchemaStorage.lazy("ContentBodyCreate"),
|
|
75
|
+
})
|
|
76
|
+
.catchall(zod_1.z.unknown())
|
|
77
|
+
.describe("ContentBodyConversionInput"));
|
|
78
|
+
validationSchemaStorage.register("ContentBodyConversionInputArray", zod_1.z
|
|
79
|
+
.array(validationSchemaStorage.lazy("ContentBodyConversionInput"))
|
|
80
|
+
.describe("ContentBodyConversionInputArray"));
|
|
60
81
|
validationSchemaStorage.registerOnce([common_1.registerCommonValidationSchemas]);
|
|
61
82
|
}
|
|
62
83
|
exports.registerContentBodyValidationSchemas = registerContentBodyValidationSchemas;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"contentBody.js","sourceRoot":"","sources":["../../../../src/openapi/v1/models/contentBody.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAyC;AAGzC,
|
|
1
|
+
{"version":3,"file":"contentBody.js","sourceRoot":"","sources":["../../../../src/openapi/v1/models/contentBody.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAyC;AAGzC,qCAOkB;AAiIlB,SAAgB,oCAAoC,CAClD,uBAAkE;IAElE,uBAAuB,CAAC,QAAQ,CAC9B,kBAAkB,EAClB,OAAC;SACE,MAAM,CAAC;QACN,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC5B,cAAc,EAAE,OAAC;aACd,IAAI,CAAC;YACJ,MAAM;YACN,aAAa;YACb,aAAa;YACb,SAAS;YACT,QAAQ;YACR,SAAS;YACT,uBAAuB;YACvB,MAAM;YACN,kBAAkB;SACnB,CAAC;aACD,QAAQ,EAAE;QACb,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACnC,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC5B,MAAM,EAAE,OAAC;aACN,IAAI,CAAC,CAAC,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;aAC/D,QAAQ,EAAE;QACb,eAAe,EAAE,OAAC;aACf,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;aACtD,QAAQ,EAAE;QACb,WAAW,EAAE,uBAAuB;aACjC,IAAI,CAAC,yBAAyB,CAAC;aAC/B,QAAQ,EAAE;QACb,UAAU,EAAE,OAAC;aACV,MAAM,CAAC;YACN,aAAa,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;YAC7C,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YAChC,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YACrC,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;YACvC,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SAC7B,CAAC;aACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;aACrB,QAAQ,EAAE;QACb,WAAW,EAAE,OAAC;aACX,MAAM,CAAC;YACN,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YAC9B,eAAe,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YACtC,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YAClC,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SAClC,CAAC;aACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;aACrB,QAAQ,EAAE;QACb,MAAM,EAAE,uBAAuB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,QAAQ,EAAE;KAChE,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,kBAAkB,CAAC,CAChC,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,uBAAuB,EACvB,OAAC;SACE,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;SACvD,QAAQ,CAAC,uBAAuB,CAAC,CACrC,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,cAAc,EACd,OAAC,CAAC,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,CAC1E,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,4BAA4B,EAC5B,OAAC;SACE,MAAM,CAAC;QACN,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE;QACd,UAAU,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;QAClC,eAAe,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACtC,gBAAgB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACvC,qBAAqB,EAAE,OAAC;aACrB,IAAI,CAAC,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;aACpC,QAAQ,EAAE;QACb,MAAM,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;QACtC,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC,mBAAmB,CAAC;KACxD,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,4BAA4B,CAAC,CAC1C,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,iCAAiC,EACjC,OAAC;SACE,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;SACjE,QAAQ,CAAC,iCAAiC,CAAC,CAC/C,CAAC;IACF,uBAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;AAC1E,CAAC;AA1FD,oFA0FC"}
|
|
@@ -24,7 +24,8 @@ export interface SpaceCreate extends Record<string, unknown> {
|
|
|
24
24
|
name: string;
|
|
25
25
|
/**
|
|
26
26
|
* The key for the new space. Format: See [Space
|
|
27
|
-
* keys](https://confluence.atlassian.com/x/lqNMMQ).
|
|
27
|
+
* keys](https://confluence.atlassian.com/x/lqNMMQ). If `alias` is not provided,
|
|
28
|
+
* this is required.
|
|
28
29
|
*/
|
|
29
30
|
key?: string;
|
|
30
31
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"space.js","sourceRoot":"","sources":["../../../../src/openapi/v1/models/space.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAyC;AAGzC,qCAMkB;
|
|
1
|
+
{"version":3,"file":"space.js","sourceRoot":"","sources":["../../../../src/openapi/v1/models/space.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAyC;AAGzC,qCAMkB;AAsIlB,SAAgB,8BAA8B,CAC5C,uBAAkE;IAElE,uBAAuB,CAAC,QAAQ,CAC9B,aAAa,EACb,OAAC;SACE,MAAM,CAAC;QACN,IAAI,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC;QACvB,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAC1B,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,aAAa,CAAC,CAC3B,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,YAAY,EACZ,OAAC;SACE,MAAM,CAAC;QACN,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QACnE,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;QACvB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;QACvB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;QACtB,MAAM,EAAE,uBAAuB,CAAC,IAAI,CAAC,cAAc,CAAC;KACrD,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,YAAY,CAAC,CAC1B,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,aAAa,EACb,OAAC;SACE,MAAM,CAAC;QACN,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;QACzB,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC1B,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC5B,WAAW,EAAE,OAAC;aACX,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;aAChE,QAAQ,EAAE;QACb,WAAW,EAAE,OAAC;aACX,QAAQ,CACP,OAAC,CAAC,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAC/D;aACA,QAAQ,EAAE;KACd,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,aAAa,CAAC,CAC3B,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,wBAAwB,EACxB,OAAC;SACE,MAAM,CAAC;QACN,KAAK,EAAE,OAAC;aACL,MAAM,CAAC;YACN,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;YAC5B,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SACtC,CAAC;aACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;KACzB,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,wBAAwB,CAAC,CACtC,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,uBAAuB,EACvB,OAAC;SACE,MAAM,CAAC;QACN,QAAQ,EAAE,OAAC;aACR,MAAM,CAAC;YACN,IAAI,EAAE,OAAC;iBACJ,MAAM,CAAC;gBACN,OAAO,EAAE,OAAC,CAAC,KAAK,CACd,OAAC,CAAC,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CACnD;gBACD,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;aACvB,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;iBACrB,QAAQ,EAAE;YACb,KAAK,EAAE,OAAC;iBACL,MAAM,CAAC;gBACN,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;gBAC7D,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;aACvB,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;iBACrB,QAAQ,EAAE;SACd,CAAC;aACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;aACrB,QAAQ,EAAE;QACb,SAAS,EAAE,uBAAuB,CAAC,IAAI,CAAC,sBAAsB,CAAC;QAC/D,eAAe,EAAE,OAAC,CAAC,OAAO,EAAE;QAC5B,gBAAgB,EAAE,OAAC,CAAC,OAAO,EAAE;KAC9B,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,uBAAuB,CAAC,CACrC,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,aAAa,EACb,OAAC;SACE,MAAM,CAAC;QACN,IAAI,EAAE,OAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE;QAChD,WAAW,EAAE,OAAC;aACX,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;aAChE,QAAQ,EAAE;QACb,QAAQ,EAAE,OAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;QACnE,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC3B,MAAM,EAAE,OAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;KAC1C,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,aAAa,CAAC,CAC3B,CAAC;IACF,uBAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;AAC1E,CAAC;AA3GD,wEA2GC"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { CommonHttpService } from "../../core/CommonHttpService";
|
|
2
2
|
import { type AsyncId, type ContentBody, type ContentBodyCreate } from "../models/common";
|
|
3
|
-
import { type AsyncContentBody } from "../models/contentBody";
|
|
3
|
+
import { type AsyncContentBody, type AsyncContentBodyArray, type AsyncIdArray, type ContentBodyConversionInputArray } from "../models/contentBody";
|
|
4
4
|
/**
|
|
5
5
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-body
|
|
6
6
|
* @category Services
|
|
@@ -12,7 +12,8 @@ export declare class ContentBodyService extends CommonHttpService {
|
|
|
12
12
|
*
|
|
13
13
|
* Supported conversions:
|
|
14
14
|
*
|
|
15
|
-
* - storage: export_view
|
|
15
|
+
* - storage: editor, export_view, styled_view, view
|
|
16
|
+
* - editor: storage
|
|
16
17
|
*
|
|
17
18
|
* No other conversions are supported at the moment.
|
|
18
19
|
* Once a conversion is completed, it will be available for 5 minutes at the
|
|
@@ -138,6 +139,65 @@ export declare class ContentBodyService extends CommonHttpService {
|
|
|
138
139
|
/** The asyncId of the macro task to get the converted body. */
|
|
139
140
|
id: string;
|
|
140
141
|
}) => Promise<AsyncContentBody>;
|
|
142
|
+
/**
|
|
143
|
+
* Asynchronously converts content bodies from one format to another format in
|
|
144
|
+
* bulk. Use the Content body
|
|
145
|
+
* REST API to get the status of conversion tasks. Note that there is a maximum
|
|
146
|
+
* limit of 10 conversions per
|
|
147
|
+
* request to this endpoint.
|
|
148
|
+
*
|
|
149
|
+
* Supported conversions:
|
|
150
|
+
*
|
|
151
|
+
* - storage: editor, export_view, styled_view, view
|
|
152
|
+
* - editor: storage
|
|
153
|
+
*
|
|
154
|
+
* Once a conversion task is completed, it is available for polling for up to 5
|
|
155
|
+
* minutes.
|
|
156
|
+
*
|
|
157
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
158
|
+
* 'View' permission for the space, and permission to view the content if the
|
|
159
|
+
* `spaceKeyContext` or
|
|
160
|
+
* `contentIdContext` are present.
|
|
161
|
+
*
|
|
162
|
+
* @returns Returned if asynchronous tasks are created to convert content bodies. If a conversion task fails to be created, a “FAILED_TO_QUEUE” string will be returned instead of an asyncId.
|
|
163
|
+
* @path POST `/wiki/rest/api/contentbody/convert/async/bulk/tasks`
|
|
164
|
+
* @scopes-current read:confluence-content.all
|
|
165
|
+
* @scopes-beta read:content.metadata:confluence
|
|
166
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-body#api-wiki-rest-api-contentbody-convert-async-bulk-tasks-post
|
|
167
|
+
* @param params
|
|
168
|
+
*/
|
|
169
|
+
bulkAsyncConvertContentBodyRequest: ({ contentBodyConversionInputArray, }: {
|
|
170
|
+
/** An array of parameters to create content body conversion tasks. */
|
|
171
|
+
contentBodyConversionInputArray: ContentBodyConversionInputArray;
|
|
172
|
+
}) => Promise<AsyncIdArray>;
|
|
173
|
+
/**
|
|
174
|
+
* Returns the content body for the corresponding `asyncId` of a completed
|
|
175
|
+
* conversion task. If
|
|
176
|
+
* the task is not completed, the task status is returned instead.
|
|
177
|
+
*
|
|
178
|
+
* Once a conversion task is completed, the result can be obtained for up to 5
|
|
179
|
+
* minutes, or
|
|
180
|
+
* until an identical conversion request is made again with the `allowCache`
|
|
181
|
+
* parameter set to
|
|
182
|
+
* false.
|
|
183
|
+
*
|
|
184
|
+
* Note that there is a maximum limit of 50 task results per request to this
|
|
185
|
+
* endpoint.
|
|
186
|
+
*
|
|
187
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
188
|
+
* Permission to access the Confluence site ('Can use' global permission).
|
|
189
|
+
*
|
|
190
|
+
* @returns Returned if asynchronous conversion tasks are successfully found.
|
|
191
|
+
* @path GET `/wiki/rest/api/contentbody/convert/async/bulk/tasks`
|
|
192
|
+
* @scopes-current read:confluence-content.all
|
|
193
|
+
* @scopes-beta read:content.metadata:confluence
|
|
194
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-body#api-wiki-rest-api-contentbody-convert-async-bulk-tasks-get
|
|
195
|
+
* @param params
|
|
196
|
+
*/
|
|
197
|
+
bulkAsyncConvertContentBodyResponse: ({ ids, }: {
|
|
198
|
+
/** The asyncIds of the conversion tasks. */
|
|
199
|
+
ids: string[];
|
|
200
|
+
}) => Promise<AsyncContentBodyArray>;
|
|
141
201
|
/**
|
|
142
202
|
* Converts a content body from one format to another format.
|
|
143
203
|
*
|
|
@@ -23,7 +23,8 @@ class ContentBodyService extends CommonHttpService_1.CommonHttpService {
|
|
|
23
23
|
*
|
|
24
24
|
* Supported conversions:
|
|
25
25
|
*
|
|
26
|
-
* - storage: export_view
|
|
26
|
+
* - storage: editor, export_view, styled_view, view
|
|
27
|
+
* - editor: storage
|
|
27
28
|
*
|
|
28
29
|
* No other conversions are supported at the moment.
|
|
29
30
|
* Once a conversion is completed, it will be available for 5 minutes at the
|
|
@@ -114,6 +115,94 @@ class ContentBodyService extends CommonHttpService_1.CommonHttpService {
|
|
|
114
115
|
.then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("ContentBodyService.asyncConvertContentBodyResponse.response")))
|
|
115
116
|
.then(commonHttpClient.getBody);
|
|
116
117
|
};
|
|
118
|
+
/**
|
|
119
|
+
* Asynchronously converts content bodies from one format to another format in
|
|
120
|
+
* bulk. Use the Content body
|
|
121
|
+
* REST API to get the status of conversion tasks. Note that there is a maximum
|
|
122
|
+
* limit of 10 conversions per
|
|
123
|
+
* request to this endpoint.
|
|
124
|
+
*
|
|
125
|
+
* Supported conversions:
|
|
126
|
+
*
|
|
127
|
+
* - storage: editor, export_view, styled_view, view
|
|
128
|
+
* - editor: storage
|
|
129
|
+
*
|
|
130
|
+
* Once a conversion task is completed, it is available for polling for up to 5
|
|
131
|
+
* minutes.
|
|
132
|
+
*
|
|
133
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
134
|
+
* 'View' permission for the space, and permission to view the content if the
|
|
135
|
+
* `spaceKeyContext` or
|
|
136
|
+
* `contentIdContext` are present.
|
|
137
|
+
*
|
|
138
|
+
* @returns Returned if asynchronous tasks are created to convert content bodies. If a conversion task fails to be created, a “FAILED_TO_QUEUE” string will be returned instead of an asyncId.
|
|
139
|
+
* @path POST `/wiki/rest/api/contentbody/convert/async/bulk/tasks`
|
|
140
|
+
* @scopes-current read:confluence-content.all
|
|
141
|
+
* @scopes-beta read:content.metadata:confluence
|
|
142
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-body#api-wiki-rest-api-contentbody-convert-async-bulk-tasks-post
|
|
143
|
+
* @param params
|
|
144
|
+
*/
|
|
145
|
+
this.bulkAsyncConvertContentBodyRequest = ({ contentBodyConversionInputArray, }) => {
|
|
146
|
+
return this.getClientInstance()
|
|
147
|
+
.request({
|
|
148
|
+
path: "/wiki/rest/api/contentbody/convert/async/bulk/tasks",
|
|
149
|
+
method: "POST",
|
|
150
|
+
headers: {
|
|
151
|
+
"Content-Type": "application/json",
|
|
152
|
+
},
|
|
153
|
+
body: contentBodyConversionInputArray,
|
|
154
|
+
})
|
|
155
|
+
.then(this.getClientInstance().responseHandler({
|
|
156
|
+
200: {
|
|
157
|
+
"application/json": "json",
|
|
158
|
+
},
|
|
159
|
+
}))
|
|
160
|
+
.then(commonHttpClient.castResponse())
|
|
161
|
+
.then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("ContentBodyService.bulkAsyncConvertContentBodyRequest.response")))
|
|
162
|
+
.then(commonHttpClient.getBody);
|
|
163
|
+
};
|
|
164
|
+
/**
|
|
165
|
+
* Returns the content body for the corresponding `asyncId` of a completed
|
|
166
|
+
* conversion task. If
|
|
167
|
+
* the task is not completed, the task status is returned instead.
|
|
168
|
+
*
|
|
169
|
+
* Once a conversion task is completed, the result can be obtained for up to 5
|
|
170
|
+
* minutes, or
|
|
171
|
+
* until an identical conversion request is made again with the `allowCache`
|
|
172
|
+
* parameter set to
|
|
173
|
+
* false.
|
|
174
|
+
*
|
|
175
|
+
* Note that there is a maximum limit of 50 task results per request to this
|
|
176
|
+
* endpoint.
|
|
177
|
+
*
|
|
178
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
179
|
+
* Permission to access the Confluence site ('Can use' global permission).
|
|
180
|
+
*
|
|
181
|
+
* @returns Returned if asynchronous conversion tasks are successfully found.
|
|
182
|
+
* @path GET `/wiki/rest/api/contentbody/convert/async/bulk/tasks`
|
|
183
|
+
* @scopes-current read:confluence-content.all
|
|
184
|
+
* @scopes-beta read:content.metadata:confluence
|
|
185
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-body#api-wiki-rest-api-contentbody-convert-async-bulk-tasks-get
|
|
186
|
+
* @param params
|
|
187
|
+
*/
|
|
188
|
+
this.bulkAsyncConvertContentBodyResponse = ({ ids, }) => {
|
|
189
|
+
return this.getClientInstance()
|
|
190
|
+
.request({
|
|
191
|
+
path: "/wiki/rest/api/contentbody/convert/async/bulk/tasks",
|
|
192
|
+
method: "GET",
|
|
193
|
+
query: {
|
|
194
|
+
ids,
|
|
195
|
+
},
|
|
196
|
+
})
|
|
197
|
+
.then(this.getClientInstance().responseHandler({
|
|
198
|
+
200: {
|
|
199
|
+
"application/json": "json",
|
|
200
|
+
},
|
|
201
|
+
}))
|
|
202
|
+
.then(commonHttpClient.castResponse())
|
|
203
|
+
.then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("ContentBodyService.bulkAsyncConvertContentBodyResponse.response")))
|
|
204
|
+
.then(commonHttpClient.getBody);
|
|
205
|
+
};
|
|
117
206
|
/**
|
|
118
207
|
* Converts a content body from one format to another format.
|
|
119
208
|
*
|
|
@@ -194,6 +283,20 @@ class ContentBodyService extends CommonHttpService_1.CommonHttpService {
|
|
|
194
283
|
body: validationSchemaStorage_1.validationSchemaStorage.lazy("AsyncId"),
|
|
195
284
|
})
|
|
196
285
|
.describe("ContentBodyService.asyncConvertContentBodyRequest.response"));
|
|
286
|
+
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentBodyService.bulkAsyncConvertContentBodyResponse.response", zod_1.z
|
|
287
|
+
.object({
|
|
288
|
+
status: zod_1.z.literal(200),
|
|
289
|
+
mediaType: zod_1.z.literal("application/json"),
|
|
290
|
+
body: validationSchemaStorage_1.validationSchemaStorage.lazy("AsyncContentBodyArray"),
|
|
291
|
+
})
|
|
292
|
+
.describe("ContentBodyService.bulkAsyncConvertContentBodyResponse.response"));
|
|
293
|
+
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentBodyService.bulkAsyncConvertContentBodyRequest.response", zod_1.z
|
|
294
|
+
.object({
|
|
295
|
+
status: zod_1.z.literal(200),
|
|
296
|
+
mediaType: zod_1.z.literal("application/json"),
|
|
297
|
+
body: validationSchemaStorage_1.validationSchemaStorage.lazy("AsyncIdArray"),
|
|
298
|
+
})
|
|
299
|
+
.describe("ContentBodyService.bulkAsyncConvertContentBodyRequest.response"));
|
|
197
300
|
validationSchemaStorage_1.validationSchemaStorage.registerOnce([
|
|
198
301
|
common_1.registerCommonValidationSchemas,
|
|
199
302
|
contentBody_1.registerContentBodyValidationSchemas,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ContentBodyService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/ContentBodyService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,gEAAgE;AAChE,oEAAiE;AACjE,6CAK0B;AAC1B,
|
|
1
|
+
{"version":3,"file":"ContentBodyService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/ContentBodyService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,gEAAgE;AAChE,oEAAiE;AACjE,6CAK0B;AAC1B,uDAM+B;AAC/B,wEAAqE;AACrE;;;GAGG;AACH,MAAa,kBAAmB,SAAQ,qCAAiB;IAAzD;;QACE;;;;;;;;;;;;;;;;;;;;;;;WAuBG;QACH,mCAA8B,GAAG,CAAC,EAChC,EAAE,EACF,MAAM,EACN,eAAe,EACf,gBAAgB,EAChB,UAAU,EACV,qBAAqB,EACrB,iBAAiB,GAqFlB,EAAoB,EAAE;YACrB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,+CAA+C;gBACrD,MAAM,EAAE,MAAM;gBACd,UAAU,EAAE;oBACV,EAAE;iBACH;gBACD,KAAK,EAAE;oBACL,MAAM;oBACN,eAAe;oBACf,gBAAgB;oBAChB,UAAU;oBACV,qBAAqB;iBACtB;gBACD,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,UAAU,EAAE;oBACV,KAAK,EAAE;wBACL,MAAM,EAAE;4BACN,OAAO,EAAE,KAAK;yBACf;qBACF;iBACF;gBACD,IAAI,EAAE,iBAAiB;aACxB,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CACjC,iDAAuB,CAAC,SAAS,CAC/B,4DAA4D,CAC7D,CACF,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;WAmBG;QACH,oCAA+B,GAAG,CAAC,EACjC,EAAE,GAIH,EAA6B,EAAE;YAC9B,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,+CAA+C;gBACrD,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;iBACH;aACF,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CACjC,iDAAuB,CAAC,SAAS,CAC/B,6DAA6D,CAC9D,CACF,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;WA0BG;QACH,uCAAkC,GAAG,CAAC,EACpC,+BAA+B,GAIhC,EAAyB,EAAE;YAC1B,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,qDAAqD;gBAC3D,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,+BAA+B;aACtC,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CACjC,iDAAuB,CAAC,SAAS,CAC/B,gEAAgE,CACjE,CACF,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;WAuBG;QACH,wCAAmC,GAAG,CAAC,EACrC,GAAG,GAIJ,EAAkC,EAAE;YACnC,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,qDAAqD;gBAC3D,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,GAAG;iBACJ;aACF,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CACjC,iDAAuB,CAAC,SAAS,CAC/B,iEAAiE,CAClE,CACF,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;WAqBG;QACH,uBAAkB,GAAG,CAAC,EACpB,EAAE,EACF,eAAe,EACf,gBAAgB,EAChB,qBAAqB,EACrB,MAAM,EACN,iBAAiB,GAwElB,EAAwB,EAAE;YACzB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,yCAAyC;gBAC/C,MAAM,EAAE,MAAM;gBACd,UAAU,EAAE;oBACV,EAAE;iBACH;gBACD,KAAK,EAAE;oBACL,eAAe;oBACf,gBAAgB;oBAChB,qBAAqB;oBACrB,MAAM;iBACP;gBACD,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,UAAU,EAAE;oBACV,KAAK,EAAE;wBACL,MAAM,EAAE;4BACN,OAAO,EAAE,KAAK;yBACf;qBACF;iBACF;gBACD,IAAI,EAAE,iBAAiB;aACxB,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CACjC,iDAAuB,CAAC,SAAS,CAC/B,gDAAgD,CACjD,CACF,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;IA+DJ,CAAC;IA9DW,MAAM,CAAC,UAAU;QACzB,iDAAuB,CAAC,kBAAkB,CACxC,gDAAgD,EAChD,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,aAAa,CAAC;SAClD,CAAC;aACD,QAAQ,CAAC,gDAAgD,CAAC,CAC9D,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,6DAA6D,EAC7D,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,kBAAkB,CAAC;SACvD,CAAC;aACD,QAAQ,CACP,6DAA6D,CAC9D,CACJ,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,4DAA4D,EAC5D,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,SAAS,CAAC;SAC9C,CAAC;aACD,QAAQ,CAAC,4DAA4D,CAAC,CAC1E,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,iEAAiE,EACjE,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,uBAAuB,CAAC;SAC5D,CAAC;aACD,QAAQ,CACP,iEAAiE,CAClE,CACJ,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,gEAAgE,EAChE,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,cAAc,CAAC;SACnD,CAAC;aACD,QAAQ,CACP,gEAAgE,CACjE,CACJ,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,wCAA+B;YAC/B,kDAAoC;SACrC,CAAC,CAAC;IACL,CAAC;CACF;AAjjBD,gDAijBC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@resolution/confluence-api-client",
|
|
3
|
-
"version": "0.7.
|
|
3
|
+
"version": "0.7.6",
|
|
4
4
|
"description": "Confluence API Client based on OpenAPI Schema from Atlassian.",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
6
|
"types": "lib/index.d.ts",
|
|
@@ -37,10 +37,10 @@
|
|
|
37
37
|
},
|
|
38
38
|
"homepage": "https://bitbucket.org/resolutiongmbh/atlassian-api-clients#readme",
|
|
39
39
|
"dependencies": {
|
|
40
|
-
"@resolution/atlassian-api-common": "^0.7.
|
|
40
|
+
"@resolution/atlassian-api-common": "^0.7.6"
|
|
41
41
|
},
|
|
42
42
|
"publishConfig": {
|
|
43
43
|
"access": "public"
|
|
44
44
|
},
|
|
45
|
-
"gitHead": "
|
|
45
|
+
"gitHead": "0674fd0958addddd8b14938f4efc5733a51b0258"
|
|
46
46
|
}
|