UNPKG

@kontent-ai/management-sdk

Version:

Official Kontent.ai management SDK

github.com/kontent-ai/management-sdk-js

kontent-ai/management-sdk-js

148 lines (147 loc) • 15.3 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
import { IHttpCancelRequestToken } from '@kontent-ai/core-sdk'; import { AssetElementsBuilder, AssetRenditionModels, CollectionModels, CustomAppModels, LanguageVariantElementsBuilder, LanguageVariantModels, PreviewModels, ProjectUserModels, SpaceModels, WebSpotlightModels } from '../models'; import { IManagementClientConfig } from '../config'; import { ContentItemContracts, LanguageVariantContracts } from '../contracts'; import { AssetFolderModels, AssetModels, ContentTypeElementsBuilder, ContentTypeModels, ContentTypeSnippetElements, ContentTypeSnippetModels, LanguageModels, TaxonomyModels, WebhookModels, WorkflowModels } from '../models'; import { AddAssetFoldersQuery, AddAssetQuery, AddContentItemQuery, AddContentTypeQuery, AddContentTypeSnippetQuery, AddLanguageQuery, AddTaxonomyQuery, AddWebhookQuery, AssetIdentifierQuery, CancelScheduledPublishingOfLanguageVariantQuery, ContentItemIdentifierQuery, ContentTypeCodenameAndIdIdentifierQuery, ContentTypeIdentifierQuery, CreateNewVersionOfLanguageVariantQuery, DataQuery, DataQueryOptional, DeleteAssetQuery, DeleteContentItemQuery, DeleteContentTypeQuery, DeleteContentTypeSnippetQuery, DeleteLanguageVariantQuery, DeleteTaxonomyQuery, DeleteWebhookQuery, GetTaxonomyQuery, GetWebhookQuery, LanguageIdAndCodenameIdentifierQuery, LanguageIdentifierQuery, ListAssetFoldersQuery, ListAssetsQuery, ListContentItemsQuery, ListContentTypeSnippetsQuery, ListContentTypesQuery, ListLanguagesQuery, ListLanguageVariantsOfContentTypeQuery, ListLanguageVariantsOfContentTypeWithComponentsQuery, ListLanguageVariantsOfItemQuery, ListLanguageVariantsBySpaceQuery, ListTaxonomiesQuery, ListWebhooksQuery, ModifyAssetFoldersQuery, ModifyContentTypeQuery, ModifyContentTypeSnippetQuery, ModifyLanguageQuery, EnvironmentIdentifierQuery, EnvironmentInformationQuery, PublishLanguageVariantQuery, TaxonomyIdentifierQuery, UnpublishLanguageVariantQuery, UpdateContentItemQuery, UploadBinaryFileQuery, UpsertAssetQuery, UpsertContentItemQuery, UpsertLanguageVariantQuery, ViewAssetsQuery, ViewContentItemQuery, ViewContentTypeQuery, ViewContentTypeSnippetQuery, ViewLanguageQuery, ViewLanguageVariantQuery, WebhookIdentifierQuery, ModifyTaxonomyQuery, PostQuery, ActionQuery, PatchQuery, PutQuery, DeleteQuery, GetQuery, CancelScheduledUnpublishingOfLanguageVariantQuery, EnableWebhookQuery, DisableWebhookQuery, ListCollectionsQuery, CollectionIdentifierQuery, ListLanguageVariantsByCollectionQuery, SetCollectionsQuery, UploadAssetFromUrlQuery, ListSubscriptionProjectsQuery, ViewSubscriptionProjectQuery, ListSubscriptionUsersQuery, UserIdentifierQuery, ViewSubscriptionUserQuery, ActivateUserInAllProjectsQuery, DeactivateUserInAllProjectsQuery, ListRolesQuery, InviteProjectUserQuery, ChangeUserRolesQuery, RoleIdentifierQuery, ViewRoleQuery, ListAssetRenditionsQuery, ModifyAssetRenditionQuery, AddAssetRenditionQuery, RenditionIdentifierQuery, ViewAssetRenditionQuery, ChangeWorkflowOfLanguageOrVariantQuery, ListWorkflowsQuery, WorkflowIdentifierQuery, DeleteWorkflowQuery, AddWorkflowQuery, UpdateWorkflowQuery, StartEnvironmentValidationQuery, TaskIdentifierQuery, CheckEnvironmentValidationQuery, ListEnvironmentValidationIssuesQuery, AddSpaceQuery, DeleteSpaceQuery, ListSpacesQuery, ModifySpaceQuery, ViewSpaceQuery, SpaceIdentifierQuery, GetPreviewConfigurationQuery, ModifyPreviewConfigurationQuery, GetLivePreviewConfigurationQuery, ChangeLivePreviewConfigurationQuery, ActivateWebSpotlightQuery, DeactivateWebSpotlightQuery, CheckWebSpotlightStatusQuery, ListCustomAppsQuery, AddCustomAppQuery, CustomAppsIdentifierQuery, GetCustomAppQuery, ModifyCustomAppQuery, DeleteCustomAppQuery, FilterItemsWithVariantsQuery, BulkGetItemsWithVariantsQuery } from '../queries'; import { ManagementQueryService, IMappingService } from '../services'; import { IManagementClient } from './imanagement-client.interface'; import { CancelToken } from 'axios'; import { GetEnvironmentCloningStateQuery } from '../queries/environments'; import { DeleteEnvironmentQuery } from '../queries/environments/delete-environment-query'; import { EnvironmentModels } from '../models/environments/environment.models'; import { CloneEnvironmentQuery } from '../queries/environments/clone-environment-query'; import { MarkEnvironmentAsProductionQuery } from '../queries/environments/mark-environment-as-production-query'; import { ModifyEnvironmentQuery } from '../queries/environments/modify-environment-query'; export declare class ManagementClient implements IManagementClient<CancelToken> { protected readonly config: IManagementClientConfig; protected readonly queryService: ManagementQueryService; private httpService; readonly mappingService: IMappingService; constructor(config: IManagementClientConfig); filterItemsWithVariants(): DataQuery<FilterItemsWithVariantsQuery, LanguageVariantModels.IFilterItemsWithVariantsData>; bulkGetItemsWithVariants(): DataQuery<BulkGetItemsWithVariantsQuery, LanguageVariantModels.IBulkGetItemsWithVariantsData>; createCancelToken(): IHttpCancelRequestToken<CancelToken>; post(): ActionQuery<DataQuery<PostQuery, any>>; patch(): ActionQuery<DataQuery<PatchQuery, any>>; put(): ActionQuery<DataQuery<PutQuery, any>>; delete(): ActionQuery<DeleteQuery>; get(): ActionQuery<GetQuery>; createNewVersionOfLanguageVariant(): ContentItemIdentifierQuery<LanguageIdAndCodenameIdentifierQuery<CreateNewVersionOfLanguageVariantQuery>>; unpublishLanguageVariant(): ContentItemIdentifierQuery<LanguageIdAndCodenameIdentifierQuery<DataQueryOptional<UnpublishLanguageVariantQuery, WorkflowModels.IUnpublishLanguageVarianthData>>>; cancelSheduledPublishingOfLanguageVariant(): ContentItemIdentifierQuery<LanguageIdAndCodenameIdentifierQuery<CancelScheduledPublishingOfLanguageVariantQuery>>; cancelSheduledUnpublishingOfLanguageVariant(): ContentItemIdentifierQuery<LanguageIdAndCodenameIdentifierQuery<CancelScheduledUnpublishingOfLanguageVariantQuery>>; changeWorkflowOfLanguageVariant(): ContentItemIdentifierQuery<LanguageIdAndCodenameIdentifierQuery<DataQuery<ChangeWorkflowOfLanguageOrVariantQuery, WorkflowModels.IChangeWorkflowOfLanguageVariantData>>>; listWorkflows(): ListWorkflowsQuery; deleteWorkflow(): WorkflowIdentifierQuery<DeleteWorkflowQuery>; addWorkflow(): DataQuery<AddWorkflowQuery, WorkflowModels.IAddWorkflowData>; updateWorkflow(): WorkflowIdentifierQuery<DataQuery<UpdateWorkflowQuery, WorkflowModels.IUpdateWorkflowData>>; publishLanguageVariant(): ContentItemIdentifierQuery<LanguageIdAndCodenameIdentifierQuery<DataQueryOptional<PublishLanguageVariantQuery, WorkflowModels.IPublishLanguageVariantData>>>; listContentTypeSnippets(): ListContentTypeSnippetsQuery; viewContentTypeSnippet(): ContentTypeIdentifierQuery<ViewContentTypeSnippetQuery>; deleteContentTypeSnippet(): ContentTypeIdentifierQuery<DeleteContentTypeSnippetQuery>; addContentTypeSnippet(): DataQuery<AddContentTypeSnippetQuery, (builder: ContentTypeSnippetElements) => ContentTypeSnippetModels.IAddContentTypeSnippetData>; viewLanguageVariant(): ContentItemIdentifierQuery<LanguageIdAndCodenameIdentifierQuery<ViewLanguageVariantQuery>>; upsertLanguageVariant(): ContentItemIdentifierQuery<LanguageIdAndCodenameIdentifierQuery<DataQuery<UpsertLanguageVariantQuery, (builder: LanguageVariantElementsBuilder) => LanguageVariantContracts.IUpsertLanguageVariantPostContract>>>; deleteLanguageVariant(): ContentItemIdentifierQuery<LanguageIdAndCodenameIdentifierQuery<DeleteLanguageVariantQuery>>; startEnvironmentValidation(): StartEnvironmentValidationQuery; checkEnvironmentValidation(): TaskIdentifierQuery<CheckEnvironmentValidationQuery>; listEnvironmentValidationIssues(): TaskIdentifierQuery<ListEnvironmentValidationIssuesQuery>; deleteContentType(): ContentTypeIdentifierQuery<DeleteContentTypeQuery>; addContentType(): DataQuery<AddContentTypeQuery, (builder: ContentTypeElementsBuilder) => ContentTypeModels.IAddContentTypeData>; modifyContentTypeSnippet(): ContentTypeIdentifierQuery<DataQuery<ModifyContentTypeSnippetQuery, ContentTypeSnippetModels.IModifyContentTypeSnippetData[]>>; modifyContentType(): ContentTypeIdentifierQuery<DataQuery<ModifyContentTypeQuery, ContentTypeModels.IModifyContentTypeData[]>>; modifyTaxonomy(): TaxonomyIdentifierQuery<DataQuery<ModifyTaxonomyQuery, TaxonomyModels.IModifyTaxonomyData[]>>; viewContentType(): ContentTypeIdentifierQuery<ViewContentTypeQuery>; listContentTypes(): ListContentTypesQuery; listAssetRenditions(): AssetIdentifierQuery<ListAssetRenditionsQuery>; addAssetRendition(): AssetIdentifierQuery<DataQuery<AddAssetRenditionQuery, AssetRenditionModels.IAddAssetRenditionData>>; modifyAssetRendition(): AssetIdentifierQuery<RenditionIdentifierQuery<DataQuery<ModifyAssetRenditionQuery, AssetRenditionModels.IModifyAssetRenditionData>>>; viewAssetRendition(): AssetIdentifierQuery<RenditionIdentifierQuery<ViewAssetRenditionQuery>>; deleteTaxonomy(): TaxonomyIdentifierQuery<DeleteTaxonomyQuery>; addTaxonomy(): DataQuery<AddTaxonomyQuery, TaxonomyModels.IAddTaxonomyRequestModel>; listTaxonomies(): ListTaxonomiesQuery; getTaxonomy(): TaxonomyIdentifierQuery<GetTaxonomyQuery>; deleteAsset(): AssetIdentifierQuery<DeleteAssetQuery>; upsertAsset(): AssetIdentifierQuery<DataQuery<UpsertAssetQuery, (builder: AssetElementsBuilder) => AssetModels.IUpsertAssetRequestData>>; addAsset(): DataQuery<AddAssetQuery, (builder: AssetElementsBuilder) => AssetModels.IAddAssetRequestData>; uploadBinaryFile(): DataQuery<UploadBinaryFileQuery, AssetModels.IUploadBinaryFileRequestData>; uploadAssetFromUrl(): DataQuery<UploadAssetFromUrlQuery, AssetModels.IUploadAssetFromUrlRequestData>; viewAsset(): AssetIdentifierQuery<ViewAssetsQuery>; listAssets(): ListAssetsQuery; listContentItems(): ListContentItemsQuery; viewContentItem(): ContentItemIdentifierQuery<ViewContentItemQuery>; addContentItem(): DataQuery<AddContentItemQuery, ContentItemContracts.IAddContentItemPostContract>; updateContentItem(): ContentItemIdentifierQuery<DataQuery<UpdateContentItemQuery, ContentItemContracts.IUpdateContentItemPostContract>>; upsertContentItem(): ContentItemIdentifierQuery<DataQuery<UpsertContentItemQuery, ContentItemContracts.IUpsertContentItemPostContract>>; deleteContentItem(): ContentItemIdentifierQuery<DeleteContentItemQuery>; listLanguageVariantsOfItem(): ContentItemIdentifierQuery<ListLanguageVariantsOfItemQuery>; listLanguageVariantsOfContentType(): ContentTypeCodenameAndIdIdentifierQuery<ListLanguageVariantsOfContentTypeQuery>; listLanguageVariantsByCollection(): CollectionIdentifierQuery<ListLanguageVariantsByCollectionQuery>; listLanguageVariantsBySpace(): SpaceIdentifierQuery<ListLanguageVariantsBySpaceQuery>; listLanguageVariantsOfContentTypeWithComponents(): ContentTypeCodenameAndIdIdentifierQuery<ListLanguageVariantsOfContentTypeWithComponentsQuery>; listLanguages(): ListLanguagesQuery; viewLanguage(): LanguageIdentifierQuery<ViewLanguageQuery>; addLanguage(): DataQuery<AddLanguageQuery, LanguageModels.IAddLanguageData>; modifyLanguage(): LanguageIdentifierQuery<DataQuery<ModifyLanguageQuery, LanguageModels.IModifyLanguageData[]>>; deleteWebhook(): WebhookIdentifierQuery<DeleteWebhookQuery>; addWebhook(): DataQuery<AddWebhookQuery, WebhookModels.IAddWebhookData>; enableWebhook(): WebhookIdentifierQuery<EnableWebhookQuery>; disableWebhook(): WebhookIdentifierQuery<DisableWebhookQuery>; getWebhook(): WebhookIdentifierQuery<GetWebhookQuery>; listWebhooks(): ListWebhooksQuery; environmentInformation(): EnvironmentInformationQuery; listAssetFolders(): ListAssetFoldersQuery; addAssetFolders(): DataQuery<AddAssetFoldersQuery, AssetFolderModels.IAddAssetFoldersData>; modifyAssetFolders(): DataQuery<ModifyAssetFoldersQuery, AssetFolderModels.IModifyAssetFolderData[]>; listCollections(): ListCollectionsQuery; setCollections(): DataQuery<SetCollectionsQuery, CollectionModels.ISetCollectionData[]>; createLanguageVariantEditUrl(data: { variantId: string; languageCodename: string; elementCodename?: string; nestedItemId?: string; nestedItemElementCodename?: string; }): string; listSubscriptionProjects(): ListSubscriptionProjectsQuery; listSubscriptionUsers(): ListSubscriptionUsersQuery; viewSubscriptionProject(): EnvironmentIdentifierQuery<ViewSubscriptionProjectQuery>; viewSubscriptionUser(): UserIdentifierQuery<ViewSubscriptionUserQuery>; activateUserInAllProjects(): UserIdentifierQuery<ActivateUserInAllProjectsQuery>; deactivateUserInAllProjects(): UserIdentifierQuery<DeactivateUserInAllProjectsQuery>; listRoles(): ListRolesQuery; viewRole(): RoleIdentifierQuery<ViewRoleQuery>; getPreviewConfiguration(): GetPreviewConfigurationQuery; modifyPreviewConfiguration(): DataQuery<ModifyPreviewConfigurationQuery, PreviewModels.IModifyPreviewConfigurationData>; getLivePreviewConfiguration(): GetLivePreviewConfigurationQuery; changeLivePreviewConfiguration(): DataQuery<ChangeLivePreviewConfigurationQuery, PreviewModels.IChangeLivePreviewConfigurationData>; inviteUser(): DataQuery<InviteProjectUserQuery, ProjectUserModels.IInviteUserData>; changeUserRoles(): UserIdentifierQuery<DataQuery<ChangeUserRolesQuery, ProjectUserModels.IChangeUserRoleData>>; getEnvironmentCloningState(): GetEnvironmentCloningStateQuery; deleteEnvironment(): DeleteEnvironmentQuery; modifyEnvironment(): DataQuery<ModifyEnvironmentQuery, EnvironmentModels.IModifyEnvironmentData[]>; cloneEnvironment(): DataQuery<CloneEnvironmentQuery, EnvironmentModels.ICloneEnvironmentData>; markEnvironmentAsProduction(): DataQuery<MarkEnvironmentAsProductionQuery, EnvironmentModels.IMarkEnvironmentAsProductionData>; addSpace(): DataQuery<AddSpaceQuery, SpaceModels.IAddSpaceData>; deleteSpace(): SpaceIdentifierQuery<DeleteSpaceQuery>; listSpaces(): ListSpacesQuery; modifySpace(): SpaceIdentifierQuery<DataQuery<ModifySpaceQuery, SpaceModels.IModifySpaceData[]>>; viewSpace(): SpaceIdentifierQuery<ViewSpaceQuery>; /** * @deprecated Web Spotlight has been discontinued and this method will be removed in a future version. */ activateWebSpotlight(): DataQuery<ActivateWebSpotlightQuery, WebSpotlightModels.IActivateWebSpotlightData>; /** * @deprecated Web Spotlight has been discontinued and this method will be removed in a future version. */ deactivateWebSpotlight(): DeactivateWebSpotlightQuery; /** * @deprecated Web Spotlight has been discontinued and this method will be removed in a future version. */ checkWebSpotlightStatus(): CheckWebSpotlightStatusQuery; modifyCustomApp(): CustomAppsIdentifierQuery<DataQuery<ModifyCustomAppQuery, CustomAppModels.ModifyCustomAppOperation[]>>; deleteCustomApp(): CustomAppsIdentifierQuery<DeleteCustomAppQuery>; addCustomApp(): DataQuery<AddCustomAppQuery, CustomAppModels.IAddCustomAppData>; listCustomApps(): ListCustomAppsQuery; getCustomApp(): CustomAppsIdentifierQuery<GetCustomAppQuery>; }