Skip to content

Commit 0d50e21

Browse files
committed
feat: implements apis for v2.3.0
1 parent 4e54563 commit 0d50e21

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+1441
-201
lines changed

build.gradle

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ archivesBaseName = 'kintone-java-client'
1515
description = 'API client library for Kintone REST APIs on Java.'
1616

1717
repositories {
18-
jcenter()
1918
mavenCentral()
2019
}
2120

src/main/java/com/kintone/client/AppClient.java

Lines changed: 180 additions & 100 deletions
Original file line numberDiff line numberDiff line change
@@ -1,108 +1,10 @@
11
package com.kintone.client;
22

3-
import com.kintone.client.api.app.AddAppRequest;
4-
import com.kintone.client.api.app.AddAppResponseBody;
5-
import com.kintone.client.api.app.AddFormFieldsRequest;
6-
import com.kintone.client.api.app.AddFormFieldsResponseBody;
7-
import com.kintone.client.api.app.DeleteFormFieldsRequest;
8-
import com.kintone.client.api.app.DeleteFormFieldsResponseBody;
9-
import com.kintone.client.api.app.DeployAppRequest;
10-
import com.kintone.client.api.app.DeployAppResponseBody;
11-
import com.kintone.client.api.app.EvaluateRecordAclRequest;
12-
import com.kintone.client.api.app.EvaluateRecordAclResponseBody;
13-
import com.kintone.client.api.app.GetAppAclPreviewRequest;
14-
import com.kintone.client.api.app.GetAppAclPreviewResponseBody;
15-
import com.kintone.client.api.app.GetAppAclRequest;
16-
import com.kintone.client.api.app.GetAppAclResponseBody;
17-
import com.kintone.client.api.app.GetAppActionsPreviewRequest;
18-
import com.kintone.client.api.app.GetAppActionsPreviewResponseBody;
19-
import com.kintone.client.api.app.GetAppActionsRequest;
20-
import com.kintone.client.api.app.GetAppActionsResponseBody;
21-
import com.kintone.client.api.app.GetAppCustomizePreviewRequest;
22-
import com.kintone.client.api.app.GetAppCustomizePreviewResponseBody;
23-
import com.kintone.client.api.app.GetAppCustomizeRequest;
24-
import com.kintone.client.api.app.GetAppCustomizeResponseBody;
25-
import com.kintone.client.api.app.GetAppRequest;
26-
import com.kintone.client.api.app.GetAppResponseBody;
27-
import com.kintone.client.api.app.GetAppSettingsPreviewRequest;
28-
import com.kintone.client.api.app.GetAppSettingsPreviewResponseBody;
29-
import com.kintone.client.api.app.GetAppSettingsRequest;
30-
import com.kintone.client.api.app.GetAppSettingsResponseBody;
31-
import com.kintone.client.api.app.GetAppsRequest;
32-
import com.kintone.client.api.app.GetAppsResponseBody;
33-
import com.kintone.client.api.app.GetDeployStatusRequest;
34-
import com.kintone.client.api.app.GetDeployStatusResponseBody;
35-
import com.kintone.client.api.app.GetFieldAclPreviewRequest;
36-
import com.kintone.client.api.app.GetFieldAclPreviewResponseBody;
37-
import com.kintone.client.api.app.GetFieldAclRequest;
38-
import com.kintone.client.api.app.GetFieldAclResponseBody;
39-
import com.kintone.client.api.app.GetFormFieldsPreviewRequest;
40-
import com.kintone.client.api.app.GetFormFieldsPreviewResponseBody;
41-
import com.kintone.client.api.app.GetFormFieldsRequest;
42-
import com.kintone.client.api.app.GetFormFieldsResponseBody;
43-
import com.kintone.client.api.app.GetFormLayoutPreviewRequest;
44-
import com.kintone.client.api.app.GetFormLayoutPreviewResponseBody;
45-
import com.kintone.client.api.app.GetFormLayoutRequest;
46-
import com.kintone.client.api.app.GetFormLayoutResponseBody;
47-
import com.kintone.client.api.app.GetGeneralNotificationsPreviewRequest;
48-
import com.kintone.client.api.app.GetGeneralNotificationsPreviewResponseBody;
49-
import com.kintone.client.api.app.GetGeneralNotificationsRequest;
50-
import com.kintone.client.api.app.GetGeneralNotificationsResponseBody;
51-
import com.kintone.client.api.app.GetPerRecordNotificationsPreviewRequest;
52-
import com.kintone.client.api.app.GetPerRecordNotificationsPreviewResponseBody;
53-
import com.kintone.client.api.app.GetPerRecordNotificationsRequest;
54-
import com.kintone.client.api.app.GetPerRecordNotificationsResponseBody;
55-
import com.kintone.client.api.app.GetProcessManagementPreviewRequest;
56-
import com.kintone.client.api.app.GetProcessManagementPreviewResponseBody;
57-
import com.kintone.client.api.app.GetProcessManagementRequest;
58-
import com.kintone.client.api.app.GetProcessManagementResponseBody;
59-
import com.kintone.client.api.app.GetRecordAclPreviewRequest;
60-
import com.kintone.client.api.app.GetRecordAclPreviewResponseBody;
61-
import com.kintone.client.api.app.GetRecordAclRequest;
62-
import com.kintone.client.api.app.GetRecordAclResponseBody;
63-
import com.kintone.client.api.app.GetReminderNotificationsPreviewRequest;
64-
import com.kintone.client.api.app.GetReminderNotificationsPreviewResponseBody;
65-
import com.kintone.client.api.app.GetReminderNotificationsRequest;
66-
import com.kintone.client.api.app.GetReminderNotificationsResponseBody;
67-
import com.kintone.client.api.app.GetReportsPreviewRequest;
68-
import com.kintone.client.api.app.GetReportsPreviewResponseBody;
69-
import com.kintone.client.api.app.GetReportsRequest;
70-
import com.kintone.client.api.app.GetReportsResponseBody;
71-
import com.kintone.client.api.app.GetViewsPreviewRequest;
72-
import com.kintone.client.api.app.GetViewsPreviewResponseBody;
73-
import com.kintone.client.api.app.GetViewsRequest;
74-
import com.kintone.client.api.app.GetViewsResponseBody;
75-
import com.kintone.client.api.app.UpdateAppAclRequest;
76-
import com.kintone.client.api.app.UpdateAppAclResponseBody;
77-
import com.kintone.client.api.app.UpdateAppActionsRequest;
78-
import com.kintone.client.api.app.UpdateAppActionsResponseBody;
79-
import com.kintone.client.api.app.UpdateAppCustomizeRequest;
80-
import com.kintone.client.api.app.UpdateAppCustomizeResponseBody;
81-
import com.kintone.client.api.app.UpdateAppSettingsRequest;
82-
import com.kintone.client.api.app.UpdateAppSettingsResponseBody;
83-
import com.kintone.client.api.app.UpdateFieldAclRequest;
84-
import com.kintone.client.api.app.UpdateFieldAclResponseBody;
85-
import com.kintone.client.api.app.UpdateFormFieldsRequest;
86-
import com.kintone.client.api.app.UpdateFormFieldsResponseBody;
87-
import com.kintone.client.api.app.UpdateFormLayoutRequest;
88-
import com.kintone.client.api.app.UpdateFormLayoutResponseBody;
89-
import com.kintone.client.api.app.UpdateGeneralNotificationsRequest;
90-
import com.kintone.client.api.app.UpdateGeneralNotificationsResponseBody;
91-
import com.kintone.client.api.app.UpdatePerRecordNotificationsRequest;
92-
import com.kintone.client.api.app.UpdatePerRecordNotificationsResponseBody;
93-
import com.kintone.client.api.app.UpdateProcessManagementRequest;
94-
import com.kintone.client.api.app.UpdateProcessManagementResponseBody;
95-
import com.kintone.client.api.app.UpdateRecordAclRequest;
96-
import com.kintone.client.api.app.UpdateRecordAclResponseBody;
97-
import com.kintone.client.api.app.UpdateReminderNotificationsRequest;
98-
import com.kintone.client.api.app.UpdateReminderNotificationsResponseBody;
99-
import com.kintone.client.api.app.UpdateReportsRequest;
100-
import com.kintone.client.api.app.UpdateReportsResponseBody;
101-
import com.kintone.client.api.app.UpdateViewsRequest;
102-
import com.kintone.client.api.app.UpdateViewsResponseBody;
3+
import com.kintone.client.api.app.*;
1034
import com.kintone.client.model.app.ActionId;
1045
import com.kintone.client.model.app.App;
1056
import com.kintone.client.model.app.AppAction;
7+
import com.kintone.client.model.app.AppPlugin;
1068
import com.kintone.client.model.app.AppRightEntity;
1079
import com.kintone.client.model.app.DeployApp;
10810
import com.kintone.client.model.app.DeployStatus;
@@ -235,6 +137,32 @@ public AddFormFieldsResponseBody addFormFields(AddFormFieldsRequest request) {
235137
return client.call(KintoneApi.ADD_FORM_FIELDS, request, handlers);
236138
}
237139

140+
/**
141+
* Adds Plug-ins to an App. This API updates the pre-live settings. After using this API, use the
142+
* Deploy App Settings API to deploy the settings to the live App.
143+
*
144+
* @param app the App ID
145+
* @param ids the Plug-in IDs that will be added to the App
146+
* @return the revision number of the App settings
147+
*/
148+
public long addPlugins(long app, List<String> ids) {
149+
AddAppPluginsRequest req = new AddAppPluginsRequest();
150+
req.setApp(app);
151+
req.setIds(ids);
152+
return addPlugins(req).getRevision();
153+
}
154+
155+
/**
156+
* Adds Plug-ins to an App. This API updates the pre-live settings. After using this API, use the
157+
* Deploy App Settings API to deploy the settings to the live App.
158+
*
159+
* @param request the request parameters. See {@link AddAppPluginsRequest}
160+
* @return the response data. See {@link AddAppPluginsResponseBody}
161+
*/
162+
public AddAppPluginsResponseBody addPlugins(AddAppPluginsRequest request) {
163+
return client.call(KintoneApi.ADD_APP_PLUGINS, request, handlers);
164+
}
165+
238166
/**
239167
* Deletes fields from a form of an App. This API updates the pre-live settings. After using this
240168
* API, use the Deploy App Settings API to deploy the settings to the live App.
@@ -362,6 +290,53 @@ public EvaluateRecordAclResponseBody evaluateRecordAcl(EvaluateRecordAclRequest
362290
return client.call(KintoneApi.EVALUATE_RECORD_ACL, request, handlers);
363291
}
364292

293+
/**
294+
* Gets notes for app administrators and their settings.
295+
*
296+
* @param app the App ID
297+
* @return the response data. See {@link GetAdminNotesResponseBody}
298+
*/
299+
public GetAdminNotesResponseBody getAdminNotes(long app) {
300+
GetAdminNotesRequest req = new GetAdminNotesRequest();
301+
req.setApp(app);
302+
return this.getAdminNotes(req);
303+
}
304+
305+
/**
306+
* Gets notes for app administrators and their settings.
307+
*
308+
* @param request the request parameters. See {@link GetAdminNotesRequest}
309+
* @return the response data. See {@link GetAdminNotesResponseBody}
310+
*/
311+
public GetAdminNotesResponseBody getAdminNotes(GetAdminNotesRequest request) {
312+
return client.call(KintoneApi.GET_APP_ADMIN_NOTES, request, handlers);
313+
}
314+
315+
/**
316+
* Gets notes for app administrators and their settings. This API retrieves the pre-live settings
317+
* that have not yet been deployed to the live App.
318+
*
319+
* @param app the App ID
320+
* @return the response data. See {@link GetAdminNotesPreviewResponseBody}
321+
*/
322+
public GetAdminNotesPreviewResponseBody getAdminNotesPreview(long app) {
323+
GetAdminNotesPreviewRequest req = new GetAdminNotesPreviewRequest();
324+
req.setApp(app);
325+
return this.getAdminNotesPreview(req);
326+
}
327+
328+
/**
329+
* Gets notes for app administrators and their settings. This API retrieves the pre-live settings
330+
* that have not yet been deployed to the live App.
331+
*
332+
* @param request the request parameters. See {@link GetAdminNotesPreviewRequest}
333+
* @return the response data. See {@link GetAdminNotesPreviewResponseBody}
334+
*/
335+
public GetAdminNotesPreviewResponseBody getAdminNotesPreview(
336+
GetAdminNotesPreviewRequest request) {
337+
return client.call(KintoneApi.GET_APP_ADMIN_NOTES_PREVIEW, request, handlers);
338+
}
339+
365340
/**
366341
* Gets general information of an App, including the name, description, related Space, creator and
367342
* updater information.
@@ -988,6 +963,77 @@ public GetPerRecordNotificationsPreviewResponseBody getPerRecordNotificationsPre
988963
return client.call(KintoneApi.GET_PRE_RECORD_NOTIFICATIONS_PREVIEW, request, handlers);
989964
}
990965

966+
/**
967+
* Gets the list of Plug-ins added to an App.
968+
*
969+
* @param app the App ID
970+
* @return a list of AppPlugin objects.
971+
*/
972+
public List<AppPlugin> getPlugins(long app) {
973+
return getPlugins(app, null);
974+
}
975+
976+
/**
977+
* Gets the list of Plug-ins added to an App.
978+
*
979+
* @param app the App ID
980+
* @param lang the localization language setting
981+
* @return a list of AppPlugin objects.
982+
*/
983+
public List<AppPlugin> getPlugins(long app, String lang) {
984+
GetAppPluginsRequest req = new GetAppPluginsRequest();
985+
req.setApp(app);
986+
req.setLang(lang);
987+
return getPlugins(req).getPlugins();
988+
}
989+
990+
/**
991+
* Gets the list of Plug-ins added to an App.
992+
*
993+
* @param request the request parameters. See {@link GetAppPluginsRequest}
994+
* @return the response data. See {@link GetAppPluginsResponseBody}
995+
*/
996+
public GetAppPluginsResponseBody getPlugins(GetAppPluginsRequest request) {
997+
return client.call(KintoneApi.GET_APP_PLUGINS, request, handlers);
998+
}
999+
1000+
/**
1001+
* Gets the list of Plug-ins added to an App. This API retrieves the pre-live settings that have
1002+
* not yet been deployed to the live App.
1003+
*
1004+
* @param app the App ID
1005+
* @return a list of AppPlugin objects.
1006+
*/
1007+
public List<AppPlugin> getPluginsPreview(long app) {
1008+
return getPluginsPreview(app, null);
1009+
}
1010+
1011+
/**
1012+
* Gets the list of Plug-ins added to an App. This API retrieves the pre-live settings that have
1013+
* not yet been deployed to the live App.
1014+
*
1015+
* @param app the App ID
1016+
* @param lang the localization language setting
1017+
* @return a list of AppPlugin objects.
1018+
*/
1019+
public List<AppPlugin> getPluginsPreview(long app, String lang) {
1020+
GetAppPluginsPreviewRequest req = new GetAppPluginsPreviewRequest();
1021+
req.setApp(app);
1022+
req.setLang(lang);
1023+
return getPluginsPreview(req).getPlugins();
1024+
}
1025+
1026+
/**
1027+
* Gets the list of Plug-ins added to an App. This API retrieves the pre-live settings that have
1028+
* not yet been deployed to the live App.
1029+
*
1030+
* @param request the request parameters. See {@link GetAppPluginsPreviewRequest}
1031+
* @return the response data. See {@link GetAppPluginsPreviewResponseBody}
1032+
*/
1033+
public GetAppPluginsPreviewResponseBody getPluginsPreview(GetAppPluginsPreviewRequest request) {
1034+
return client.call(KintoneApi.GET_APP_PLUGINS_PREVIEW, request, handlers);
1035+
}
1036+
9911037
/**
9921038
* Gets the process management settings of an App.
9931039
*
@@ -1357,6 +1403,30 @@ public GetViewsPreviewResponseBody getViewsPreview(GetViewsPreviewRequest reques
13571403
return client.call(KintoneApi.GET_VIEWS_PREVIEW, request, handlers);
13581404
}
13591405

1406+
/**
1407+
* Changes the Space to which an App belongs.
1408+
*
1409+
* @param app the App ID
1410+
* @param space the Space ID of where the App will be moved to.
1411+
*/
1412+
public void move(long app, Long space) {
1413+
MoveAppRequest req = new MoveAppRequest();
1414+
req.setApp(app);
1415+
req.setSpace(space);
1416+
move(req);
1417+
}
1418+
1419+
/**
1420+
* Changes the Space to which an App belongs.
1421+
*
1422+
* @param request the request parameters. See {@link MoveAppRequest}
1423+
* @return the response data. To remove an App from its current space, null can be specified. See
1424+
* {@link MoveAppResponseBody}
1425+
*/
1426+
public MoveAppResponseBody move(MoveAppRequest request) {
1427+
return client.call(KintoneApi.MOVE_APP_TO_SPACE, request, handlers);
1428+
}
1429+
13601430
/**
13611431
* Cancel all changes made to the pre-live settings. The pre-live settings will be reverted back
13621432
* to the current settings of the live app.
@@ -1378,6 +1448,16 @@ public void revertApp(long app, Long revision) {
13781448
deployApp(app, revision, true);
13791449
}
13801450

1451+
/**
1452+
* Updates the notes for App administrators and their settings.
1453+
*
1454+
* @param request the request parameters. See {@link UpdateAdminNotesRequest}
1455+
* @return the response data. See {@link UpdateAdminNotesResponseBody}
1456+
*/
1457+
public UpdateAdminNotesResponseBody updateAdminNotes(UpdateAdminNotesRequest request) {
1458+
return client.call(KintoneApi.UPDATE_APP_ADMIN_NOTES, request, handlers);
1459+
}
1460+
13811461
/**
13821462
* Updates the App permissions of an App.
13831463
*

0 commit comments

Comments
 (0)