jamespot-user-api 1.0.166 → 1.0.167
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/documentation/assets/search.js +1 -1
- package/documentation/classes/AdminLicenseApi.html +11 -11
- package/documentation/classes/AdminStoreApi.html +1 -1
- package/documentation/classes/AdminUtilsApi.html +1 -1
- package/documentation/classes/JApplicationApi.html +8 -8
- package/documentation/classes/JArticleApi.html +1 -1
- package/documentation/classes/JAssetReservation.html +1 -1
- package/documentation/classes/JAudienceApi.html +2 -2
- package/documentation/classes/JBaseApi.html +1 -1
- package/documentation/classes/JBbbApi.html +1 -0
- package/documentation/classes/JBookmarkApi.html +1 -1
- package/documentation/classes/JBusinessNetworkingApi.html +1 -1
- package/documentation/classes/JCommunityApi.html +1 -1
- package/documentation/classes/JDiapazoneApi.html +1 -1
- package/documentation/classes/JFaqApi.html +1 -1
- package/documentation/classes/JFileApi.html +5 -5
- package/documentation/classes/JFilebankApi.html +1 -1
- package/documentation/classes/JGlobalApi.html +1 -1
- package/documentation/classes/JGroupApi.html +14 -14
- package/documentation/classes/JIAApi.html +1 -1
- package/documentation/classes/JLandApi.html +1 -1
- package/documentation/classes/JMessengerApi.html +1 -1
- package/documentation/classes/JObjectApi.html +1 -1
- package/documentation/classes/JSearchApi.html +6 -6
- package/documentation/classes/JShareApi.html +1 -1
- package/documentation/classes/JSocialActionApi.html +1 -1
- package/documentation/classes/JTaxonomyApi.html +2 -2
- package/documentation/classes/JUserApi.html +7 -7
- package/documentation/classes/JWedocApi.html +1 -1
- package/documentation/classes/JWidgetApi.html +1 -1
- package/documentation/classes/JamespotUserApi.html +1 -1
- package/documentation/classes/Network.html +1 -1
- package/documentation/classes/TVDisplayApi.html +1 -1
- package/documentation/classes/WindowBrowser.html +1 -1
- package/documentation/enums/Format.html +1 -0
- package/documentation/enums/GroupModerateStatus.html +1 -1
- package/documentation/enums/StudioApplicationStatus.html +1 -1
- package/documentation/enums/WidgetsName.html +1 -0
- package/documentation/index.html +1 -1
- package/documentation/interfaces/AccessRightObject.html +1 -1
- package/documentation/interfaces/AdminLicenseUser.html +1 -1
- package/documentation/interfaces/ApiDefaultWrapper.html +1 -1
- package/documentation/interfaces/ApiWrapper.html +1 -1
- package/documentation/interfaces/BaseMessage.html +1 -1
- package/documentation/interfaces/Category.html +1 -1
- package/documentation/interfaces/FileBankProps.html +1 -1
- package/documentation/interfaces/FolderProps.html +1 -1
- package/documentation/interfaces/ListFilterSpec.html +1 -1
- package/documentation/interfaces/OF.html +1 -1
- package/documentation/interfaces/ObjectListProps.html +1 -1
- package/documentation/interfaces/PagingResults.html +1 -1
- package/documentation/interfaces/RootFolderProps.html +1 -1
- package/documentation/interfaces/SearchCategoryModel.html +1 -1
- package/documentation/interfaces/SearchCategoryValue.html +1 -1
- package/documentation/interfaces/SearchConfig.html +1 -1
- package/documentation/interfaces/SearchFacetModel.html +1 -1
- package/documentation/interfaces/SearchFacetValueModel.html +1 -1
- package/documentation/interfaces/SearchQuery.html +1 -1
- package/documentation/interfaces/SearchQueryFilterModel.html +1 -1
- package/documentation/interfaces/SearchQueryOption.html +1 -1
- package/documentation/interfaces/SearchQueryResult.html +1 -1
- package/documentation/interfaces/SearchQuerySortModel.html +1 -1
- package/documentation/interfaces/SearchResultCatProps.html +1 -1
- package/documentation/interfaces/SearchResultPropsApp.html +1 -1
- package/documentation/interfaces/SearchResultPropsObject.html +1 -1
- package/documentation/interfaces/SpotProps.html +1 -1
- package/documentation/interfaces/TaxonomyCreate.html +1 -1
- package/documentation/interfaces/WidgetType.html +1 -0
- package/documentation/interfaces/WindowInterface.html +1 -1
- package/documentation/modules.html +8 -12
- package/jest.config.ts +3 -2
- package/lib/jamespot-user-api.js +1 -1
- package/lib/jamespot-user-api.js.map +1 -1
- package/lib/jest.config.d.ts +1 -0
- package/lib/jest.config.vm.d.ts +1 -0
- package/lib/src/apis/article/article.d.ts +10 -7
- package/lib/src/apis/assetReservation/assetReservation.d.ts +4 -4
- package/lib/src/apis/bbb/bbb.d.ts +7 -0
- package/lib/src/apis/bbb/bbb.mock.d.ts +3 -0
- package/lib/src/apis/bbb/bbb.test.d.ts +1 -0
- package/lib/src/apis/bookmark/bookmark.d.ts +11 -11
- package/lib/src/apis/businessNetworking/businessNetworking.d.ts +2 -2
- package/lib/src/apis/community.d.ts +2 -2
- package/lib/src/apis/faq/faq.d.ts +15 -15
- package/lib/src/apis/file/file.d.ts +4 -4
- package/lib/src/apis/group/group.d.ts +18 -5
- package/lib/src/apis/index.d.ts +1 -0
- package/lib/src/apis/jamespotUserApi.d.ts +2 -0
- package/lib/src/apis/mediaLibrary/mediaLibrary.d.ts +1 -1
- package/lib/src/apis/search/search.d.ts +5 -2
- package/lib/src/apis/socialAction/socialAction.d.ts +4 -4
- package/lib/src/apis/taxonomy/taxonomy.d.ts +26 -2
- package/lib/src/apis/taxonomy/types.d.ts +2 -2
- package/lib/src/apis/user/user.d.ts +937 -8
- package/lib/src/apis/user/user.mock.d.ts +3 -2
- package/lib/src/types/article.d.ts +152945 -48
- package/lib/src/types/asei.d.ts +1 -1
- package/lib/src/types/assetReservation.d.ts +1 -1
- package/lib/src/types/autocomplete.d.ts +261 -9
- package/lib/src/types/bbb.d.ts +39 -0
- package/lib/src/types/businessContact.d.ts +18 -0
- package/lib/src/types/faq.d.ts +4 -5
- package/lib/src/types/file.d.ts +2 -2
- package/lib/src/types/group.d.ts +34 -5
- package/lib/src/types/hook.d.ts +6 -6
- package/lib/src/types/index.d.ts +2 -0
- package/lib/src/types/mediaLibrary.d.ts +2 -2
- package/lib/src/types/meeting.d.ts +1 -1
- package/lib/src/types/pollSurvey.d.ts +1 -1
- package/lib/src/types/quizz.d.ts +1 -1
- package/lib/src/types/search.d.ts +2 -1
- package/lib/src/types/socialEvent.d.ts +1 -1
- package/lib/src/types/support.d.ts +1 -1
- package/lib/src/types/surveyDate.d.ts +1 -1
- package/lib/src/types/tvDisplay.d.ts +2 -2
- package/lib/src/types/user.d.ts +0 -114
- package/lib/src/types/utils.d.ts +330 -55
- package/lib/src/types/widgets.d.ts +94410 -227
- package/lib/src/util/Test.d.ts +3640 -4
- package/lib/src/util/object.d.ts +2 -2
- package/package.json +1 -1
- package/phpunitMock/bigBlueButtonGetPublicWebinarData-success.json +10 -0
- package/phpunitMock/bigBlueButtonPublicWebinarFullname-success.json +9 -0
- package/phpunitMock/businessContactQueryList-default.json +54 -0
- package/phpunitMock/widgetCheckListRespond-article.json +1 -1
- package/documentation/interfaces/BaseAutocomplete.html +0 -1
package/lib/jest.config.d.ts
CHANGED
package/lib/jest.config.vm.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { JBaseApi } from '../base';
|
|
2
|
-
import { AddCommentParams, ApiWrapper, BaseMessages, UpdateCommentParams,
|
|
2
|
+
import { AddCommentParams, ApiWrapper, BaseMessages, UpdateCommentParams, FormatList, jArticleList, jArticleLittle, jFileLittle, MaybeWithToken, PagingResults, UserRead, FormatExtension } from '../../types';
|
|
3
3
|
import { ArticleCreation, ArticleGetConfig, ArticleListConfig, GetCommentsParams } from '../../types/article';
|
|
4
4
|
import { jCommentLittle } from '../../types/comment';
|
|
5
5
|
export type DraftSerializedForm = {
|
|
@@ -8,22 +8,25 @@ export type DraftSerializedForm = {
|
|
|
8
8
|
}[];
|
|
9
9
|
export declare class JArticleApi extends JBaseApi {
|
|
10
10
|
list<T extends jArticleLittle = jArticleLittle>(config: ArticleListConfig): Promise<ApiWrapper<PagingResults<T>>>;
|
|
11
|
-
get<T extends jArticleLittle = jArticleLittle>(config: ArticleGetConfig,
|
|
12
|
-
|
|
11
|
+
get<T extends jArticleLittle = jArticleLittle>(config: ArticleGetConfig, params?: {
|
|
12
|
+
signal?: AbortSignal;
|
|
13
|
+
formatExtension?: FormatExtension;
|
|
14
|
+
}): Promise<ApiWrapper<T, BaseMessages>>;
|
|
15
|
+
create<R extends jArticleLittle = jArticleLittle, P extends ArticleCreation = ArticleCreation>(article: MaybeWithToken<P>, format?: FormatList): Promise<ApiWrapper<Array<R>, BaseMessages>>;
|
|
13
16
|
update<T extends {
|
|
14
17
|
uri: string;
|
|
15
18
|
}, U extends jArticleLittle = jArticleList>(article: T): Promise<ApiWrapper<U, BaseMessages>>;
|
|
16
19
|
delete(id: number): Promise<ApiWrapper<boolean, BaseMessages>>;
|
|
17
20
|
count(type: string): Promise<ApiWrapper<number>>;
|
|
18
|
-
getAttachments(id: number, type: string, format?:
|
|
21
|
+
getAttachments(id: number, type: string, format?: FormatList): Promise<ApiWrapper<jFileLittle[]>>;
|
|
19
22
|
permalink(permalinkId: string): Promise<ApiWrapper<jArticleLittle>>;
|
|
20
23
|
saveAsDraft(form: Record<string, unknown>, contentType: string, idDraft?: string): Promise<ApiWrapper<{
|
|
21
24
|
idDraft: string;
|
|
22
25
|
msg: string;
|
|
23
26
|
}>>;
|
|
24
|
-
getComments<T extends jCommentLittle = jCommentLittle>(params: GetCommentsParams, format?:
|
|
25
|
-
addComment<T extends jCommentLittle = jCommentLittle>(params: AddCommentParams, format?:
|
|
26
|
-
updateComment<T extends jCommentLittle = jCommentLittle>(params: UpdateCommentParams, format?:
|
|
27
|
+
getComments<T extends jCommentLittle = jCommentLittle>(params: GetCommentsParams, format?: FormatList): Promise<ApiWrapper<T[]>>;
|
|
28
|
+
addComment<T extends jCommentLittle = jCommentLittle>(params: AddCommentParams, format?: FormatList): Promise<ApiWrapper<T>>;
|
|
29
|
+
updateComment<T extends jCommentLittle = jCommentLittle>(params: UpdateCommentParams, format?: FormatList): Promise<ApiWrapper<T>>;
|
|
27
30
|
deleteComment(idComment: number): Promise<ApiWrapper<void>>;
|
|
28
31
|
getRead(uri: string): Promise<ApiWrapper<{
|
|
29
32
|
count: number;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { JBaseApi } from '../base';
|
|
2
|
-
import { ApiPagingResults, ApiWrapper, BaseMessages, Filters, Orders } from '../../types/utils';
|
|
2
|
+
import { ApiPagingResults, ApiWrapper, BaseMessages, Filters, FormatList, Orders } from '../../types/utils';
|
|
3
3
|
import { AssetReservationConfiguration, BookableAssetList, ReservationList } from '../../types/assetReservation';
|
|
4
4
|
export declare class JAssetReservation extends JBaseApi {
|
|
5
5
|
configuration(): Promise<ApiWrapper<AssetReservationConfiguration>>;
|
|
@@ -12,20 +12,20 @@ export declare class JAssetReservation extends JBaseApi {
|
|
|
12
12
|
description?: string;
|
|
13
13
|
}): Promise<ApiWrapper<ReservationList, BaseMessages>>;
|
|
14
14
|
getReservations({ format, ...params }: {
|
|
15
|
-
format?:
|
|
15
|
+
format?: FormatList;
|
|
16
16
|
uri: string;
|
|
17
17
|
dateStart: string;
|
|
18
18
|
dateEnd: string;
|
|
19
19
|
}): Promise<ApiWrapper<ReservationList[], BaseMessages>>;
|
|
20
20
|
cancelReservation(id: number): Promise<ApiWrapper<ReservationList, BaseMessages>>;
|
|
21
21
|
bookByDate({ format, ...params }: {
|
|
22
|
-
format?:
|
|
22
|
+
format?: FormatList;
|
|
23
23
|
date: string;
|
|
24
24
|
hourStart: string;
|
|
25
25
|
hourEnd: string;
|
|
26
26
|
}): Promise<ApiWrapper<BookableAssetList[], BaseMessages>>;
|
|
27
27
|
getList({ format, ...params }: {
|
|
28
|
-
format?:
|
|
28
|
+
format?: FormatList;
|
|
29
29
|
query?: string;
|
|
30
30
|
limit?: number;
|
|
31
31
|
page?: number;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { ApiWrapper, PublicWebinarData, GetPublicWebinarDataRequest } from '../../types';
|
|
2
|
+
import { PublicWebinarUrl, PublicWebinarFullnameRequest } from '../../types/bbb';
|
|
3
|
+
import { JBaseApi } from '../base';
|
|
4
|
+
export declare class JBbbApi extends JBaseApi {
|
|
5
|
+
publicWebinarFullname(params: PublicWebinarFullnameRequest): Promise<ApiWrapper<PublicWebinarUrl>>;
|
|
6
|
+
getPublicWebinarData(params: GetPublicWebinarDataRequest): Promise<ApiWrapper<PublicWebinarData>>;
|
|
7
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -10,16 +10,7 @@ export interface ListFilterSpec {
|
|
|
10
10
|
export declare class JBookmarkApi extends JBaseApi {
|
|
11
11
|
getFormattedList<T extends keyof BookmarkTypes>(filterSpecs: ListFilterSpec, format: T): Promise<ApiWrapper<PagingResults<BookmarkTypes[T]>, import("../../types").BaseMessages>>;
|
|
12
12
|
addFormattedLink<T extends keyof BookmarkTypes>(targetId: number, targetType: string, format: T): Promise<ApiWrapper<BookmarkTypes[T], import("../../types").BaseMessages>>;
|
|
13
|
-
addBookmark(bookmark: Pick<BookmarkTypes[keyof BookmarkTypes], 'bookmarkLabel' | 'bookmarkMeta' | 'bookmarkUrl'>, format?: keyof BookmarkTypes): Promise<ApiWrapper<import("../../types").
|
|
14
|
-
type: string;
|
|
15
|
-
id: number;
|
|
16
|
-
mainType: string;
|
|
17
|
-
uri: string;
|
|
18
|
-
title: string;
|
|
19
|
-
_url: string;
|
|
20
|
-
dateCreation?: string | undefined;
|
|
21
|
-
dateModified?: string | null | undefined;
|
|
22
|
-
}> | import("../../types").BookmarkRawList<{
|
|
13
|
+
addBookmark(bookmark: Pick<BookmarkTypes[keyof BookmarkTypes], 'bookmarkLabel' | 'bookmarkMeta' | 'bookmarkUrl'>, format?: keyof BookmarkTypes): Promise<ApiWrapper<import("../../types").BookmarkRawList<{
|
|
23
14
|
type: string;
|
|
24
15
|
id: number;
|
|
25
16
|
mainType: string;
|
|
@@ -43,7 +34,16 @@ export declare class JBookmarkApi extends JBaseApi {
|
|
|
43
34
|
}>;
|
|
44
35
|
dateCreation: import("zod").ZodString;
|
|
45
36
|
dateModified: import("zod").ZodString;
|
|
46
|
-
}, import("zod").ZodUnion<[import("zod").ZodNumber, import("zod").ZodNullable<import("zod").ZodString>, import("zod").ZodNullable<import("zod").ZodString>, import("zod").ZodNullable<import("zod").ZodString>, import("zod").ZodString, import("zod").ZodNumber, import("zod").ZodNullable<import("zod").ZodString>, import("zod").ZodString, import("zod").ZodString]>, "strip"
|
|
37
|
+
}, import("zod").ZodUnion<[import("zod").ZodNumber, import("zod").ZodNullable<import("zod").ZodString>, import("zod").ZodNullable<import("zod").ZodString>, import("zod").ZodNullable<import("zod").ZodString>, import("zod").ZodString, import("zod").ZodNumber, import("zod").ZodNullable<import("zod").ZodString>, import("zod").ZodString, import("zod").ZodString]>, "strip">> | import("../../types").BookmarkList<{
|
|
38
|
+
type: string;
|
|
39
|
+
id: number;
|
|
40
|
+
mainType: string;
|
|
41
|
+
uri: string;
|
|
42
|
+
title: string;
|
|
43
|
+
_url: string;
|
|
44
|
+
dateCreation?: string | undefined;
|
|
45
|
+
dateModified?: string | null | undefined;
|
|
46
|
+
}>, BaseMessagesOne>>;
|
|
47
47
|
delete(bookmarkId: number): Promise<ApiWrapper<null, BaseMessagesOne>>;
|
|
48
48
|
rename(bookmarkID: number, bookmarkLabel: string, bookmarkUrl?: string): Promise<ApiWrapper<null, BaseMessagesOne>>;
|
|
49
49
|
move(bookmarkID: number, bookmarkReference: number, position: 'before' | 'after'): Promise<ApiWrapper<null, BaseMessagesOne>>;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { JBaseApi } from '../base';
|
|
2
|
-
import { ApiWrapper,
|
|
2
|
+
import { ApiWrapper, FormatList, jObjectLittle } from '../../types';
|
|
3
3
|
export declare class JBusinessNetworkingApi extends JBaseApi {
|
|
4
|
-
getInfos<T extends jObjectLittle = jObjectLittle>(id: number, format?:
|
|
4
|
+
getInfos<T extends jObjectLittle = jObjectLittle>(id: number, format?: FormatList): Promise<ApiWrapper<T>>;
|
|
5
5
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import { ApiReturn, CommunityAutocomplete,
|
|
1
|
+
import { ApiReturn, CommunityAutocomplete, FormatList } from '../types';
|
|
2
2
|
import { JBaseApi } from './base';
|
|
3
3
|
export declare class JCommunityApi extends JBaseApi {
|
|
4
|
-
get<T extends
|
|
4
|
+
get<T extends FormatList = undefined>(idCommunity: string | number, format?: T): Promise<import("../types").ApiWrapper<ApiReturn<T, {
|
|
5
5
|
type: string;
|
|
6
6
|
id: number;
|
|
7
7
|
mainType: string;
|
|
@@ -1,30 +1,30 @@
|
|
|
1
1
|
import { JBaseApi } from '../base';
|
|
2
|
-
import { ApiWrapper, CreateFaqCategory, CreateFaqTheme, EditFaqCategory, ExtendedFaqCategory, FaqAccess, FaqList, FaqView, FaqHookProperties, FaqItemList, FaqTaxonomy, jArticleLittle, Orders, PagingResults, DeleteFaqTheme, EditFaqTheme, ApiDefaultWrapper,
|
|
2
|
+
import { ApiWrapper, CreateFaqCategory, CreateFaqTheme, EditFaqCategory, ExtendedFaqCategory, FaqAccess, FaqList, FaqView, FaqHookProperties, FaqItemList, FaqTaxonomy, jArticleLittle, Orders, PagingResults, DeleteFaqTheme, EditFaqTheme, ApiDefaultWrapper, FormatList, CreateFaqEntry, FaqItemView, AddFaqEntry, EditFaqEntry, MoveFaqEntry, MoveFaqTheme } from '../../types';
|
|
3
3
|
export declare class JFaqApi extends JBaseApi {
|
|
4
|
-
getCategoriesList<T extends ExtendedFaqCategory<FaqList> = ExtendedFaqCategory<FaqList>>(format?:
|
|
5
|
-
createCategory<T extends jArticleLittle = FaqView>(params: Omit<CreateFaqCategory, 'type'>, format?:
|
|
6
|
-
updateCategory<T extends jArticleLittle = FaqView>(params: Omit<EditFaqCategory, 'type'>, format?:
|
|
7
|
-
getCategory<T extends jArticleLittle = FaqView>(id: number, format?:
|
|
4
|
+
getCategoriesList<T extends ExtendedFaqCategory<FaqList> = ExtendedFaqCategory<FaqList>>(format?: FormatList, orders?: Orders): Promise<ApiWrapper<PagingResults<T>>>;
|
|
5
|
+
createCategory<T extends jArticleLittle = FaqView>(params: Omit<CreateFaqCategory, 'type'>, format?: FormatList): Promise<ApiWrapper<Array<T>>>;
|
|
6
|
+
updateCategory<T extends jArticleLittle = FaqView>(params: Omit<EditFaqCategory, 'type'>, format?: FormatList): Promise<ApiWrapper<T>>;
|
|
7
|
+
getCategory<T extends jArticleLittle = FaqView>(id: number, format?: FormatList): Promise<ApiWrapper<T>>;
|
|
8
8
|
deleteCategory(id: number): Promise<ApiWrapper<boolean>>;
|
|
9
|
-
checkItem<T extends FaqItemList>(query: string, page?: number, format?:
|
|
9
|
+
checkItem<T extends FaqItemList>(query: string, page?: number, format?: FormatList): Promise<ApiWrapper<PagingResults<T & {
|
|
10
10
|
_percent: number;
|
|
11
11
|
}>>>;
|
|
12
12
|
getTaxonomy(): Promise<ApiWrapper<FaqTaxonomy>>;
|
|
13
13
|
getHookProperties(properties?: Array<keyof FaqHookProperties>): Promise<ApiWrapper<FaqHookProperties>>;
|
|
14
14
|
getAccess(): Promise<ApiWrapper<FaqAccess>>;
|
|
15
|
-
createTheme<T extends jArticleLittle = FaqView>(params: CreateFaqTheme, format?:
|
|
16
|
-
deleteTheme<T extends jArticleLittle = FaqView>(params: DeleteFaqTheme, format?:
|
|
17
|
-
updateTheme(params: EditFaqTheme, format?:
|
|
18
|
-
getEntry<T extends jArticleLittle = FaqItemView>(uri: string, format?:
|
|
15
|
+
createTheme<T extends jArticleLittle = FaqView>(params: CreateFaqTheme, format?: FormatList): Promise<ApiWrapper<T>>;
|
|
16
|
+
deleteTheme<T extends jArticleLittle = FaqView>(params: DeleteFaqTheme, format?: FormatList): Promise<ApiWrapper<T>>;
|
|
17
|
+
updateTheme(params: EditFaqTheme, format?: FormatList): Promise<ApiDefaultWrapper>;
|
|
18
|
+
getEntry<T extends jArticleLittle = FaqItemView>(uri: string, format?: FormatList): Promise<ApiWrapper<T>>;
|
|
19
19
|
deleteEntry(id: number): Promise<ApiWrapper<boolean>>;
|
|
20
|
-
createEntry<T extends jArticleLittle = FaqItemView>(params: Omit<CreateFaqEntry, 'type'>, format?:
|
|
21
|
-
addEntry<T extends jArticleLittle = FaqView>(params: AddFaqEntry, format?:
|
|
22
|
-
updateEntry<T extends jArticleLittle = FaqItemView>(params: Omit<EditFaqEntry, 'type'>, format?:
|
|
23
|
-
moveEntry<T extends jArticleLittle = FaqView>(params: MoveFaqEntry, format?:
|
|
20
|
+
createEntry<T extends jArticleLittle = FaqItemView>(params: Omit<CreateFaqEntry, 'type'>, format?: FormatList): Promise<ApiWrapper<Array<T>>>;
|
|
21
|
+
addEntry<T extends jArticleLittle = FaqView>(params: AddFaqEntry, format?: FormatList): Promise<ApiWrapper<T>>;
|
|
22
|
+
updateEntry<T extends jArticleLittle = FaqItemView>(params: Omit<EditFaqEntry, 'type'>, format?: FormatList): Promise<ApiWrapper<T>>;
|
|
23
|
+
moveEntry<T extends jArticleLittle = FaqView>(params: MoveFaqEntry, format?: FormatList): Promise<ApiWrapper<{
|
|
24
24
|
source?: T;
|
|
25
25
|
target: T;
|
|
26
26
|
}>>;
|
|
27
|
-
moveTheme<T extends jArticleLittle = FaqView>(params: MoveFaqTheme, format?:
|
|
27
|
+
moveTheme<T extends jArticleLittle = FaqView>(params: MoveFaqTheme, format?: FormatList): Promise<ApiWrapper<{
|
|
28
28
|
source: T;
|
|
29
29
|
target: T;
|
|
30
30
|
}>>;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ApiWrapper, FileCropConfig, UploadConfig, jObjectLittle, jArticleLittle, jFileLittle, UserDownload } from '../../types';
|
|
1
|
+
import { ApiWrapper, FileCropConfig, UploadConfig, jObjectLittle, jArticleLittle, jFileLittle, UserDownload, FormatList } from '../../types';
|
|
2
2
|
import { JBaseApi } from '../base';
|
|
3
3
|
export declare class JFileApi extends JBaseApi {
|
|
4
4
|
/**
|
|
@@ -43,9 +43,9 @@ export declare class JFileApi extends JBaseApi {
|
|
|
43
43
|
}, import("../../types").BaseMessages>;
|
|
44
44
|
token: string;
|
|
45
45
|
}[]>;
|
|
46
|
-
get<T extends jFileLittle>(idFile: number, format?:
|
|
47
|
-
getParent<T extends jArticleLittle>(idFile: number, format?:
|
|
48
|
-
getWithHash<T extends jFileLittle>(idFile: number, hash: string, format?:
|
|
46
|
+
get<T extends jFileLittle>(idFile: number, format?: FormatList): Promise<ApiWrapper<T>>;
|
|
47
|
+
getParent<T extends jArticleLittle>(idFile: number, format?: FormatList): Promise<ApiWrapper<T>>;
|
|
48
|
+
getWithHash<T extends jFileLittle>(idFile: number, hash: string, format?: FormatList): Promise<ApiWrapper<T>>;
|
|
49
49
|
duplicate(idFile: number, title: string, publishTo?: string[]): Promise<ApiWrapper<{
|
|
50
50
|
idFile: number;
|
|
51
51
|
article: jObjectLittle;
|
|
@@ -1,19 +1,32 @@
|
|
|
1
1
|
import { Category, CreateGroup, GroupList, GroupListConfig, GroupProperties, GroupUserLevel, GroupView, GroupWidget, ResetNotificationConfiguration, UpdateGroup, UserLevelAndRight } from '../../types/group';
|
|
2
2
|
import { JBaseApi } from '../base';
|
|
3
|
-
import { ApiReturn, ApiWrapper, BaseMessages,
|
|
3
|
+
import { ApiReturn, ApiWrapper, BaseMessages, FormatList, jUserLittle, PagingResults } from '../../types';
|
|
4
4
|
export declare class JGroupApi extends JBaseApi {
|
|
5
5
|
/**
|
|
6
6
|
* autocomplete return a list of groups
|
|
7
7
|
* @param query <string>
|
|
8
8
|
*/
|
|
9
|
-
autocomplete(query: string): Promise<
|
|
9
|
+
autocomplete(query: string): Promise<{
|
|
10
|
+
type: string;
|
|
11
|
+
id: string;
|
|
12
|
+
mainType: string;
|
|
13
|
+
uri: string;
|
|
14
|
+
title: string;
|
|
15
|
+
name: string;
|
|
16
|
+
shortUri: string;
|
|
17
|
+
label: string;
|
|
18
|
+
cssClass: string;
|
|
19
|
+
cssColor: string;
|
|
20
|
+
class: string;
|
|
21
|
+
idspot: string;
|
|
22
|
+
}[]>;
|
|
10
23
|
/**
|
|
11
24
|
* Create a group from scratch
|
|
12
25
|
* @param group
|
|
13
26
|
* @param format return format
|
|
14
27
|
* @returns
|
|
15
28
|
*/
|
|
16
|
-
create<T extends
|
|
29
|
+
create<T extends FormatList = undefined>(group: CreateGroup, format?: T): Promise<ApiWrapper<ApiReturn<T, {
|
|
17
30
|
type: string;
|
|
18
31
|
id: number;
|
|
19
32
|
mainType: string;
|
|
@@ -38,7 +51,7 @@ export declare class JGroupApi extends JBaseApi {
|
|
|
38
51
|
* @param format return format
|
|
39
52
|
* @returns
|
|
40
53
|
*/
|
|
41
|
-
update<T extends
|
|
54
|
+
update<T extends FormatList = undefined>(group: UpdateGroup, format?: T): Promise<ApiWrapper<ApiReturn<T, {
|
|
42
55
|
type: string;
|
|
43
56
|
id: number;
|
|
44
57
|
mainType: string;
|
|
@@ -54,7 +67,7 @@ export declare class JGroupApi extends JBaseApi {
|
|
|
54
67
|
* @param format
|
|
55
68
|
* @returns
|
|
56
69
|
*/
|
|
57
|
-
getSpot<T extends
|
|
70
|
+
getSpot<T extends FormatList = undefined>(idSpot: number | string, format?: T): Promise<ApiWrapper<ApiReturn<T, {
|
|
58
71
|
type: string;
|
|
59
72
|
id: number;
|
|
60
73
|
mainType: string;
|
package/lib/src/apis/index.d.ts
CHANGED
|
@@ -4,6 +4,7 @@ export * from './article/article';
|
|
|
4
4
|
export * from './assetReservation/assetReservation';
|
|
5
5
|
export * from './audience/audience';
|
|
6
6
|
export * from './base';
|
|
7
|
+
export * from './bbb/bbb';
|
|
7
8
|
export * from './bookmark/bookmark';
|
|
8
9
|
export * from './businessNetworking/businessNetworking';
|
|
9
10
|
export * from './community';
|
|
@@ -31,6 +31,7 @@ import { JSocialActionApi } from './socialAction/socialAction';
|
|
|
31
31
|
import { JBusinessNetworkingApi } from './businessNetworking/businessNetworking';
|
|
32
32
|
import { JIAApi } from './jia/jia';
|
|
33
33
|
import { JWidgetApi } from './widget/widget';
|
|
34
|
+
import { JBbbApi } from './bbb/bbb';
|
|
34
35
|
/**
|
|
35
36
|
* In browser usage, 'window' should be the window object.
|
|
36
37
|
* In server side usage, 'window' object given must implement the fetch method, used by the Apis.
|
|
@@ -52,6 +53,7 @@ export declare class JamespotUserApi {
|
|
|
52
53
|
asei: JAseiApi;
|
|
53
54
|
assetReservation: JAssetReservation;
|
|
54
55
|
audience: JAudienceApi;
|
|
56
|
+
bbb: JBbbApi;
|
|
55
57
|
bookmark: JBookmarkApi;
|
|
56
58
|
businessNetworking: JBusinessNetworkingApi;
|
|
57
59
|
community: JCommunityApi;
|
|
@@ -5,7 +5,7 @@ export declare class JMediaLibraryApi extends JBaseApi {
|
|
|
5
5
|
getAccess(): Promise<ApiWrapper<boolean>>;
|
|
6
6
|
getFoldersStatsList(filters?: Filters, orders?: Orders, page?: number): Promise<ApiWrapper<PagingResults<MediaLibraryFolderStats>>>;
|
|
7
7
|
getFilesStatsList(filters?: Filters, orders?: Orders, page?: number): Promise<ApiWrapper<PagingResults<MediaLibraryFilesStats>>>;
|
|
8
|
-
getStats(
|
|
8
|
+
getStats(): Promise<ApiWrapper<MediaLibraryStats>>;
|
|
9
9
|
readFolder(uri: string): Promise<ApiWrapper<boolean>>;
|
|
10
10
|
readFile(uri: string): Promise<ApiWrapper<boolean>>;
|
|
11
11
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ApiWrapper, SearchConfig, SearchQuery, SearchQueryResult, SearchResultCatProps, SearchLastQuery, SearchAdminConfig } from '../../types';
|
|
1
|
+
import { ApiWrapper, SearchConfig, SearchQuery, SearchQueryResult, SearchResultCatProps, SearchLastQuery, SearchAdminConfig, FormatExtension } from '../../types';
|
|
2
2
|
import { JBaseApi } from '../base';
|
|
3
3
|
export declare class JSearchApi extends JBaseApi {
|
|
4
4
|
/**
|
|
@@ -30,7 +30,10 @@ export declare class JSearchApi extends JBaseApi {
|
|
|
30
30
|
|
|
31
31
|
* // Todo add query.facets (to be specified first)
|
|
32
32
|
*/
|
|
33
|
-
searchQuery(query: SearchQuery,
|
|
33
|
+
searchQuery(query: SearchQuery, params?: {
|
|
34
|
+
signal?: AbortSignal;
|
|
35
|
+
formatExtension?: FormatExtension;
|
|
36
|
+
}): Promise<ApiWrapper<SearchQueryResult>>;
|
|
34
37
|
/**
|
|
35
38
|
* return the five last keywords typed in the searchbar by the user
|
|
36
39
|
*/
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { JBaseApi } from '../base';
|
|
2
|
-
import { AddRemoveActionParams, ApiWrapper,
|
|
2
|
+
import { AddRemoveActionParams, ApiWrapper, FormatList, jLinkLittle, jUserList, jUserLittle } from '../../types';
|
|
3
3
|
import { GetActionUsersParams } from '../../types';
|
|
4
4
|
export declare class JSocialActionApi extends JBaseApi {
|
|
5
|
-
getUsers<T extends jUserLittle = jUserList>(params: GetActionUsersParams, format?:
|
|
6
|
-
add<T extends jLinkLittle = jLinkLittle>(params: AddRemoveActionParams, format?:
|
|
7
|
-
remove(params: AddRemoveActionParams, format?:
|
|
5
|
+
getUsers<T extends jUserLittle = jUserList>(params: GetActionUsersParams, format?: FormatList): Promise<ApiWrapper<T[]>>;
|
|
6
|
+
add<T extends jLinkLittle = jLinkLittle>(params: AddRemoveActionParams, format?: FormatList): Promise<ApiWrapper<T>>;
|
|
7
|
+
remove(params: AddRemoveActionParams, format?: FormatList): Promise<ApiWrapper<boolean>>;
|
|
8
8
|
}
|
|
@@ -12,7 +12,31 @@ export declare class JTaxonomyApi extends JBaseApi {
|
|
|
12
12
|
* @param idTaxonomy taxonomy id
|
|
13
13
|
* @param query search characters
|
|
14
14
|
*/
|
|
15
|
-
autocomplete(idTaxonomy: string, query: string): Promise<ApiWrapper<
|
|
15
|
+
autocomplete(idTaxonomy: string, query: string): Promise<ApiWrapper<{
|
|
16
|
+
type: string;
|
|
17
|
+
id: string;
|
|
18
|
+
mainType: string;
|
|
19
|
+
uri: string;
|
|
20
|
+
title: string;
|
|
21
|
+
name: string;
|
|
22
|
+
shortUri: string;
|
|
23
|
+
label: string;
|
|
24
|
+
cssClass: string;
|
|
25
|
+
cssColor: string;
|
|
26
|
+
class: string;
|
|
27
|
+
}[], import("../../types").BaseMessages>>;
|
|
16
28
|
autocompleteList<T = jObjectAutocomplete>({ format, ...payload }: AutoCompleteList): Promise<ApiWrapper<PagingResults<T>, import("../../types").BaseMessages>>;
|
|
17
|
-
autocompleteHierarchy(payload: AutocompleteHierarchy): Promise<ApiWrapper<PagingResults<
|
|
29
|
+
autocompleteHierarchy(payload: AutocompleteHierarchy): Promise<ApiWrapper<PagingResults<{
|
|
30
|
+
type: string;
|
|
31
|
+
id: string;
|
|
32
|
+
mainType: string;
|
|
33
|
+
uri: string;
|
|
34
|
+
title: string;
|
|
35
|
+
name: string;
|
|
36
|
+
shortUri: string;
|
|
37
|
+
label: string;
|
|
38
|
+
cssClass: string;
|
|
39
|
+
cssColor: string;
|
|
40
|
+
class: string;
|
|
41
|
+
}>, import("../../types").BaseMessages>>;
|
|
18
42
|
}
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
import { Filter, jObjectLittle } from '../../types';
|
|
1
|
+
import { Filter, FormatList, jObjectLittle } from '../../types';
|
|
2
2
|
export type jTaxonomyLittle = jObjectLittle;
|
|
3
3
|
export interface TaxonomyCreate {
|
|
4
4
|
type: 'taxonomyClose' | 'taxonomyOpen';
|
|
5
5
|
title: string;
|
|
6
6
|
concepts: Array<string>;
|
|
7
|
-
format?:
|
|
7
|
+
format?: FormatList;
|
|
8
8
|
}
|
|
9
9
|
export type AutoCompleteList = {
|
|
10
10
|
query?: string;
|