jamespot-user-api 1.0.96 → 1.0.98

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.
Files changed (68) hide show
  1. package/documentation/assets/search.js +1 -1
  2. package/documentation/classes/AdminStoreApi.html +1 -1
  3. package/documentation/classes/JApplicationApi.html +8 -8
  4. package/documentation/classes/JArticleApi.html +1 -1
  5. package/documentation/classes/JAssetReservation.html +1 -1
  6. package/documentation/classes/JAudienceApi.html +1 -1
  7. package/documentation/classes/JBaseApi.html +1 -1
  8. package/documentation/classes/JBookmarkApi.html +1 -1
  9. package/documentation/classes/JCommunityApi.html +1 -1
  10. package/documentation/classes/JConceptApi.html +2 -2
  11. package/documentation/classes/JDiapazoneApi.html +1 -1
  12. package/documentation/classes/JFileApi.html +25 -7
  13. package/documentation/classes/JFilebankApi.html +1 -1
  14. package/documentation/classes/JGroupApi.html +20 -2
  15. package/documentation/classes/JLandApi.html +1 -1
  16. package/documentation/classes/JLicenseApi.html +4 -4
  17. package/documentation/classes/JMessengerApi.html +1 -1
  18. package/documentation/classes/JSearchApi.html +6 -6
  19. package/documentation/classes/JShareApi.html +1 -1
  20. package/documentation/classes/JUserApi.html +4 -4
  21. package/documentation/classes/JWedocApi.html +1 -1
  22. package/documentation/classes/JamespotUserApi.html +1 -1
  23. package/documentation/classes/Network.html +1 -1
  24. package/documentation/classes/WindowBrowser.html +1 -1
  25. package/documentation/classes/WindowMock.html +2 -2
  26. package/documentation/enums/StudioApplicationStatus.html +1 -1
  27. package/documentation/index.html +1 -1
  28. package/documentation/interfaces/ApiError.html +1 -1
  29. package/documentation/interfaces/ApiWrapper.html +1 -1
  30. package/documentation/interfaces/BaseAutocomplete.html +1 -1
  31. package/documentation/interfaces/BaseMessage.html +1 -1
  32. package/documentation/interfaces/Category.html +1 -1
  33. package/documentation/interfaces/FileBankProps.html +1 -1
  34. package/documentation/interfaces/FolderProps.html +1 -1
  35. package/documentation/interfaces/ListFilterSpec.html +1 -1
  36. package/documentation/interfaces/OF.html +1 -1
  37. package/documentation/interfaces/ObjectListProps.html +1 -1
  38. package/documentation/interfaces/PagingResults.html +1 -1
  39. package/documentation/interfaces/Result.html +1 -1
  40. package/documentation/interfaces/RootFolderProps.html +1 -1
  41. package/documentation/interfaces/SearchCategoryModel.html +1 -1
  42. package/documentation/interfaces/SearchConfig.html +1 -1
  43. package/documentation/interfaces/SearchFacetModel.html +1 -1
  44. package/documentation/interfaces/SearchFacetValueModel.html +1 -1
  45. package/documentation/interfaces/SearchQuery.html +1 -1
  46. package/documentation/interfaces/SearchQueryFilterModel.html +1 -1
  47. package/documentation/interfaces/SearchQueryOption.html +1 -1
  48. package/documentation/interfaces/SearchQueryResult.html +1 -1
  49. package/documentation/interfaces/SearchQuerySortModel.html +1 -1
  50. package/documentation/interfaces/SearchResultCatProps.html +1 -1
  51. package/documentation/interfaces/SearchResultProps.html +1 -1
  52. package/documentation/interfaces/SpotProps.html +1 -1
  53. package/documentation/interfaces/Taxonomy.html +1 -1
  54. package/documentation/interfaces/TaxonomyCreate.html +1 -1
  55. package/documentation/interfaces/WindowInterface.html +1 -1
  56. package/documentation/modules.html +1 -1
  57. package/lib/jamespot-user-api.js +1 -1
  58. package/lib/jamespot-user-api.js.map +1 -1
  59. package/lib/src/apis/file.d.ts +59 -4
  60. package/lib/src/apis/group.d.ts +38 -5
  61. package/lib/src/types/file.d.ts +20 -2
  62. package/lib/src/types/group.d.ts +37 -5
  63. package/lib/src/types/index.d.ts +1 -0
  64. package/lib/src/types/utils.d.ts +2 -0
  65. package/lib/src/types/widgets.d.ts +143 -0
  66. package/lib/src/util/network.d.ts +1 -1
  67. package/package.json +1 -1
  68. package/documentation/interfaces/CreateGroup.html +0 -1
@@ -1,9 +1,42 @@
1
- import { ApiWrapper, Category, CreateGroup, GroupWidget, jObjectLittle, PagingResults } from '../types';
1
+ import { ApiReturn, Category, CreateGroup, Format, GroupList, GroupProperties, GroupView, GroupWidget, jObjectLittle, PagingResults, UpdateGroup } from '../types';
2
2
  import { JBaseApi } from './base';
3
3
  export declare class JGroupApi extends JBaseApi {
4
- create({ type, widgets, ...group }: CreateGroup): Promise<ApiWrapper<string>>;
5
- getApplications(): Promise<ApiWrapper<Record<string, GroupWidget>>>;
6
- getCategories(): Promise<ApiWrapper<Category[]>>;
4
+ /**
5
+ * Create a group from scratch
6
+ * @param group
7
+ * @param format return format
8
+ * @returns
9
+ */
10
+ create<T extends Format = undefined>(group: CreateGroup, format?: T): Promise<import("../types").ApiWrapper<ApiReturn<T, jObjectLittle, GroupList, GroupView, jObjectLittle>, string[]>>;
11
+ /**
12
+ * Update a group
13
+ * @param group group to update. The uri is mandatory and identify the group to update
14
+ * @param format return format
15
+ * @returns
16
+ */
17
+ update<T extends Format = undefined>(group: UpdateGroup, format?: T): Promise<import("../types").ApiWrapper<ApiReturn<T, jObjectLittle, GroupList, GroupView, string>, string[]>>;
18
+ /**
19
+ * Get a spot
20
+ * @param idSpot
21
+ * @param format
22
+ * @returns
23
+ */
24
+ getSpot<T extends Format = undefined>(idSpot: number | string, format?: T): Promise<import("../types").ApiWrapper<ApiReturn<T, jObjectLittle, GroupList, GroupView, string>, string[]>>;
25
+ /**
26
+ * Get the properties of a group that are not within the model
27
+ * @param idSpot
28
+ * @returns
29
+ */
30
+ getProperties(idSpot: number | string): Promise<import("../types").ApiWrapper<GroupProperties, string[]>>;
31
+ /**
32
+ * Get the available applications that can be added to a group
33
+ */
34
+ getApplications(): Promise<import("../types").ApiWrapper<Record<string, GroupWidget>, string[]>>;
35
+ /**
36
+ * Get the available group categories
37
+ * @returns
38
+ */
39
+ getCategories(): Promise<import("../types").ApiWrapper<Category[], string[]>>;
7
40
  /**
8
41
  * Get the members of a group
9
42
  * @param idSpot spot id
@@ -12,5 +45,5 @@ export declare class JGroupApi extends JBaseApi {
12
45
  * @param page page number
13
46
  * @return array of User
14
47
  */
15
- getObjectListJamespotSpotMembers(idSpot: number | string, query?: string, limit?: number, page?: number): Promise<ApiWrapper<PagingResults<jObjectLittle>>>;
48
+ getObjectListJamespotSpotMembers(idSpot: number | string, query?: string, limit?: number, page?: number): Promise<import("../types").ApiWrapper<PagingResults<jObjectLittle>, string[]>>;
16
49
  }
@@ -1,8 +1,15 @@
1
+ export declare type UploadConfig = {
2
+ attrName: string;
3
+ token: string;
4
+ file?: File | null;
5
+ url?: string;
6
+ };
1
7
  export declare type FileResponse = {
2
8
  id: string;
3
9
  name: string;
4
- type: 'fileTmp';
5
- token: string;
10
+ type: string;
11
+ token?: string;
12
+ crop?: FileCropConfig;
6
13
  size: string;
7
14
  mediaKey: string;
8
15
  imagesize: {
@@ -10,3 +17,14 @@ export declare type FileResponse = {
10
17
  height: number;
11
18
  };
12
19
  };
20
+ export declare type FileCropConfig = {
21
+ x: number;
22
+ y: number;
23
+ width: number;
24
+ height: number;
25
+ rotation: number;
26
+ killSize?: boolean;
27
+ };
28
+ export declare type FileCropReturnType = Omit<FileResponse, 'token'> & {
29
+ crop: FileCropConfig;
30
+ };
@@ -1,12 +1,32 @@
1
- export interface CreateGroup {
1
+ import { jObjectLittle } from './utils';
2
+ export declare type CreateGroup = {
3
+ type: string;
2
4
  title: string;
3
5
  description: string;
4
6
  privacy: string;
5
- idCategory?: string;
6
- type: string;
7
+ edito: string;
8
+ language: string;
9
+ idCategory: string;
10
+ idCommunity?: string;
11
+ };
12
+ export declare type SpotBannerImage = {
13
+ id: string;
14
+ name: string;
15
+ size: string;
16
+ };
17
+ export declare type UpdateGroup = CreateGroup & GroupProperties & {
18
+ uri: string;
19
+ image?: string;
20
+ spotBanner?: [] | Record<string, SpotBannerImage>;
21
+ token?: string;
7
22
  uriCommunity?: string;
8
- widgets: Array<string>;
9
- }
23
+ };
24
+ export declare type GroupProperties = {
25
+ edit_access?: '' | 'author';
26
+ commentLevel?: '-1' | '1' | '2' | '3';
27
+ user_level_signup?: '' | '1' | '2' | '3';
28
+ nounsubscribe?: '' | '1';
29
+ };
10
30
  export declare type GroupWidget = {
11
31
  idWidget: string;
12
32
  title: string;
@@ -20,3 +40,15 @@ export interface Category {
20
40
  idorder: number;
21
41
  label: string;
22
42
  }
43
+ export declare type GroupList = jObjectLittle & {
44
+ description: string;
45
+ privacy: string;
46
+ edito: string;
47
+ language: string;
48
+ idCategory: string;
49
+ };
50
+ export declare type GroupView = GroupList & {
51
+ image?: string;
52
+ spotBanner?: [] | Record<string, SpotBannerImage>;
53
+ uriCommunity?: string;
54
+ };
@@ -13,3 +13,4 @@ export * from './taxonomy';
13
13
  export * from './user';
14
14
  export * from './utils';
15
15
  export * from './wedoc';
16
+ export * from './widgets';
@@ -92,3 +92,5 @@ export declare type MaybeWithCsrf<T> = T & {
92
92
  export declare type MaybeWithToken<T> = T & {
93
93
  token?: string | undefined;
94
94
  };
95
+ export declare type Format = 'raw-little' | 'raw-list' | 'raw-view' | undefined;
96
+ export declare type ApiReturn<T extends Format, Little, List = Little, View = List, Default = {}> = T extends 'raw-little' ? Little : T extends 'raw-list' ? List : T extends 'raw-view' ? View : Default;
@@ -0,0 +1,143 @@
1
+ export declare type WidgetWrapperProps<T = WidgetTypes> = {
2
+ title: string;
3
+ widget: T;
4
+ position?: WidgetVector;
5
+ };
6
+ export declare type WidgetWrapperExtendedProps = {
7
+ isMandatory?: boolean;
8
+ isMainTitle?: boolean;
9
+ isCover?: boolean;
10
+ doSomethingAfterIsMounted?: boolean;
11
+ };
12
+ export declare type WidgetDefaultProps = {
13
+ width?: number | undefined;
14
+ inplace: boolean;
15
+ isComponentVisible?: boolean;
16
+ mode: WidgetDisplayMode;
17
+ isMounted?: () => void;
18
+ onClick?: () => void;
19
+ onChange: (content: CombinedWidgetContent) => void;
20
+ onStateChange?: (state: WidgetStateProps) => void;
21
+ };
22
+ export declare const widgetRefNames: readonly ["widget-article-button", "widget-article-gallery", "widget-article-title", "widget-article-text", "widget-article-attachment", "widget-article-image"];
23
+ export declare type WidgetType<T = CombinedWidgetContent> = {
24
+ name: typeof widgetRefNames[number];
25
+ uniqid: string;
26
+ content: T;
27
+ };
28
+ export declare type WidgetArticleButtonType = WidgetType<WidgetButtonContent> & {
29
+ name: 'widget-article-button';
30
+ };
31
+ export declare type WidgetArticleGalleryType = WidgetType<WidgetArticleGalleryContent> & {
32
+ name: 'widget-article-gallery';
33
+ };
34
+ export declare type WidgetArticleTitleType = WidgetType<WidgetTitleContent> & {
35
+ name: 'widget-article-title';
36
+ };
37
+ export declare type WidgetArticleTextType = WidgetType<WidgetTextContent> & {
38
+ name: 'widget-article-text';
39
+ };
40
+ export declare type WidgetArticleImageType = WidgetType<WidgetImageContent> & {
41
+ name: 'widget-article-image';
42
+ };
43
+ export declare type WidgetArticleAttachmentType = WidgetType<WidgetArticleAttachmentContent> & {
44
+ name: 'widget-article-attachment';
45
+ };
46
+ export declare type WidgetTypes = WidgetArticleButtonType | WidgetArticleGalleryType | WidgetArticleTitleType | WidgetArticleTextType | WidgetArticleAttachmentType | WidgetArticleImageType;
47
+ export declare type CSSTextAlignType = 'left' | 'right' | 'center' | 'justify';
48
+ export declare type CSSBackgroundPosition = 'top' | 'bottom' | 'center' | 'left' | 'right';
49
+ export declare type CSSBackgroundSize = 'auto' | 'contain' | 'cover';
50
+ export declare type VariantSizeType = 'sm' | 'md' | 'lg';
51
+ export declare type VariantType = 'contained' | 'outlined';
52
+ export declare type WidgetArticleGalleryContent = {
53
+ gap?: string;
54
+ horizontalNumber?: string;
55
+ widgets?: WidgetWrapperProps<WidgetArticleImageType>[];
56
+ galleryDisplay?: 'portrait' | 'landscape';
57
+ };
58
+ export declare type WidgetTitleContent = {
59
+ widgets?: WidgetWrapperProps[];
60
+ text?: string;
61
+ textAlign?: CSSTextAlignType;
62
+ heading?: string;
63
+ color?: string;
64
+ backgroundColor?: string;
65
+ };
66
+ export declare type WidgetTextContent = {
67
+ text?: string;
68
+ color?: string;
69
+ fontSize?: string;
70
+ lineHeight?: string;
71
+ linkColor?: string;
72
+ };
73
+ export declare type WidgetButtonContent = {
74
+ text?: string;
75
+ color?: string;
76
+ backgroundColor?: string;
77
+ borderRadius?: string;
78
+ fontSize?: string;
79
+ buttonSize?: VariantSizeType;
80
+ variant?: VariantType;
81
+ };
82
+ export declare type WidgetImageContent = {
83
+ file?: WidgetFileType;
84
+ useFilter?: boolean;
85
+ displayAs?: 'image' | 'background';
86
+ backgroundPosition?: CSSBackgroundPosition;
87
+ backgroundSize?: CSSBackgroundSize;
88
+ borderRadius?: string;
89
+ widgets?: WidgetWrapperProps[];
90
+ };
91
+ export declare type WidgetArticleAttachmentContent = {
92
+ files?: WidgetFileType[];
93
+ fileDisplay?: 'list' | 'gallery';
94
+ };
95
+ export declare type CombinedWidgetContent = {
96
+ widgets?: WidgetWrapperProps[];
97
+ } & (WidgetTextContent | WidgetImageContent | WidgetTitleContent | WidgetButtonContent | WidgetArticleGalleryContent | WidgetArticleAttachmentContent);
98
+ export declare type WidgetContentKeys = keyof CombinedWidgetContent;
99
+ export declare type WidgetStateProps = {
100
+ busy?: boolean | undefined;
101
+ loading?: boolean | undefined;
102
+ initialized?: boolean | undefined;
103
+ mounted?: boolean | undefined;
104
+ };
105
+ export declare type WidgetDefinitionProps = {
106
+ label: string;
107
+ description: string;
108
+ name: typeof widgetRefNames[number];
109
+ img: string;
110
+ available: boolean;
111
+ panel: {
112
+ useWrapper: boolean;
113
+ useEditor: boolean;
114
+ useWidgets: boolean;
115
+ };
116
+ };
117
+ export declare type WidgetVector = {
118
+ x: number;
119
+ y: number;
120
+ };
121
+ export declare type WidgetFileType = {
122
+ id: number;
123
+ filename: string;
124
+ mimetype: string;
125
+ dimension: {
126
+ width: number;
127
+ height: number;
128
+ };
129
+ };
130
+ export declare type WidgetDisplayMode = 'edit' | 'view';
131
+ export declare type WidgetModalProps = {
132
+ title?: string;
133
+ view?: any;
134
+ };
135
+ export declare type WidgetsRootState = {
136
+ widgets: WidgetsState;
137
+ };
138
+ export declare type WidgetsState = {
139
+ token?: string | undefined;
140
+ ids: Record<string, WidgetWrapperProps>;
141
+ states: Record<string, WidgetStateProps>;
142
+ modal: WidgetModalProps | undefined;
143
+ };
@@ -17,7 +17,7 @@ export declare class Network {
17
17
  getHostname(): Promise<string>;
18
18
  fetch({ o, f, ...body }: OF, signal?: AbortSignal | null): FetchReturnType;
19
19
  post<T, U = string[]>(body: OF, signal?: AbortSignal): Promise<ApiWrapper<T, U>>;
20
- postFile(body: FormData): Promise<FileResponse>;
20
+ postFile(body: FormData): Promise<ApiWrapper<FileResponse, string[]>>;
21
21
  postCSRF<T, U = string[]>(body: OF): Promise<ApiWrapper<T, U>>;
22
22
  maybePostCSRF<T, U = string[]>(body: MaybeWithCsrf<OF>): Promise<ApiWrapper<T, U>>;
23
23
  postToken<T, U = string[]>(body: OF): Promise<ApiWrapper<T, U>>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "jamespot-user-api",
3
- "version": "1.0.96",
3
+ "version": "1.0.98",
4
4
  "scripts": {
5
5
  "build": "npx webpack --env NODE_ENV=production",
6
6
  "build-dev-vm": "npx webpack --env NODE_ENV=development --env NODE_BUILD=VM",
@@ -1 +0,0 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CreateGroup | jamespot-user-api</title><meta name="description" content="Documentation for jamespot-user-api"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">jamespot-user-api</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">jamespot-user-api</a></li><li><a href="CreateGroup.html">CreateGroup</a></li></ul><h1>Interface CreateGroup</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">CreateGroup</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CreateGroup.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CreateGroup.html#idCategory" class="tsd-kind-icon">id<wbr/>Category</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CreateGroup.html#privacy" class="tsd-kind-icon">privacy</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CreateGroup.html#title" class="tsd-kind-icon">title</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CreateGroup.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CreateGroup.html#uriCommunity" class="tsd-kind-icon">uri<wbr/>Community</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CreateGroup.html#widgets" class="tsd-kind-icon">widgets</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="description" class="tsd-anchor"></a><h3 class="tsd-anchor-link">description<a href="#description" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/cde81f8/src/types/group.ts#L3">types/group.ts:3</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="idCategory" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> id<wbr/>Category<a href="#idCategory" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">id<wbr/>Category<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/cde81f8/src/types/group.ts#L5">types/group.ts:5</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="privacy" class="tsd-anchor"></a><h3 class="tsd-anchor-link">privacy<a href="#privacy" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">privacy<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/cde81f8/src/types/group.ts#L4">types/group.ts:4</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="title" class="tsd-anchor"></a><h3 class="tsd-anchor-link">title<a href="#title" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">title<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/cde81f8/src/types/group.ts#L2">types/group.ts:2</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link">type<a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/cde81f8/src/types/group.ts#L6">types/group.ts:6</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="uriCommunity" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> uri<wbr/>Community<a href="#uriCommunity" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">uri<wbr/>Community<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/cde81f8/src/types/group.ts#L7">types/group.ts:7</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="widgets" class="tsd-anchor"></a><h3 class="tsd-anchor-link">widgets<a href="#widgets" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">widgets<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Jamespot/jamespot-user-api/blob/cde81f8/src/types/group.ts#L8">types/group.ts:8</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="CreateGroup.html" class="tsd-kind-icon">Create<wbr/>Group</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CreateGroup.html#description" class="tsd-kind-icon">description</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CreateGroup.html#idCategory" class="tsd-kind-icon">id<wbr/>Category</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CreateGroup.html#privacy" class="tsd-kind-icon">privacy</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CreateGroup.html#title" class="tsd-kind-icon">title</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CreateGroup.html#type" class="tsd-kind-icon">type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CreateGroup.html#uriCommunity" class="tsd-kind-icon">uri<wbr/>Community</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CreateGroup.html#widgets" class="tsd-kind-icon">widgets</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>