@serve.zone/interfaces 5.4.3 → 5.4.5

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 (59) hide show
  1. package/dist_ts/index.d.ts +2 -1
  2. package/dist_ts/index.js +3 -2
  3. package/dist_ts/platform/ai.d.ts +18 -0
  4. package/dist_ts/platform/ai.js +2 -0
  5. package/dist_ts/platform/backup.d.ts +9 -0
  6. package/dist_ts/platform/backup.js +2 -0
  7. package/dist_ts/platform/database.d.ts +7 -0
  8. package/dist_ts/platform/database.js +2 -0
  9. package/dist_ts/platform/email.d.ts +57 -0
  10. package/dist_ts/platform/email.js +2 -0
  11. package/dist_ts/platform/index.d.ts +13 -0
  12. package/dist_ts/platform/index.js +14 -0
  13. package/dist_ts/platform/letter.d.ts +21 -0
  14. package/dist_ts/platform/letter.js +2 -0
  15. package/dist_ts/platform/logging.d.ts +5 -0
  16. package/dist_ts/platform/logging.js +2 -0
  17. package/dist_ts/platform/objectstorage.d.ts +6 -0
  18. package/dist_ts/platform/objectstorage.js +2 -0
  19. package/dist_ts/platform/pushnotification.d.ts +13 -0
  20. package/dist_ts/platform/pushnotification.js +2 -0
  21. package/dist_ts/platform/sip.d.ts +6 -0
  22. package/dist_ts/platform/sip.js +2 -0
  23. package/dist_ts/platform/sms.d.ts +25 -0
  24. package/dist_ts/platform/sms.js +2 -0
  25. package/dist_ts/platform/types.d.ts +58 -0
  26. package/dist_ts/platform/types.js +2 -0
  27. package/dist_ts/platformservice/aibridge.d.ts +1 -0
  28. package/dist_ts/platformservice/letter.d.ts +1 -0
  29. package/dist_ts/platformservice/mta.d.ts +4 -0
  30. package/dist_ts/platformservice/pushnotification.d.ts +1 -0
  31. package/dist_ts/platformservice/sms.d.ts +2 -0
  32. package/dist_ts/requests/config.d.ts +5 -0
  33. package/dist_ts/requests/index.d.ts +2 -1
  34. package/dist_ts/requests/index.js +3 -2
  35. package/dist_ts/requests/platform.d.ts +98 -0
  36. package/dist_ts/requests/platform.js +2 -0
  37. package/package.json +8 -9
  38. package/readme.md +192 -5
  39. package/ts/index.ts +2 -0
  40. package/ts/platform/ai.ts +23 -0
  41. package/ts/platform/backup.ts +10 -0
  42. package/ts/platform/database.ts +8 -0
  43. package/ts/platform/email.ts +73 -0
  44. package/ts/platform/index.ts +27 -0
  45. package/ts/platform/letter.ts +26 -0
  46. package/ts/platform/logging.ts +5 -0
  47. package/ts/platform/objectstorage.ts +6 -0
  48. package/ts/platform/pushnotification.ts +18 -0
  49. package/ts/platform/sip.ts +6 -0
  50. package/ts/platform/sms.ts +34 -0
  51. package/ts/platform/types.ts +82 -0
  52. package/ts/platformservice/aibridge.ts +3 -1
  53. package/ts/platformservice/letter.ts +3 -1
  54. package/ts/platformservice/mta.ts +5 -0
  55. package/ts/platformservice/pushnotification.ts +3 -1
  56. package/ts/platformservice/sms.ts +3 -0
  57. package/ts/requests/config.ts +5 -0
  58. package/ts/requests/index.ts +3 -1
  59. package/ts/requests/platform.ts +148 -0
package/ts/requests/platform.ts ADDED
@@ -0,0 +1,148 @@
1
+ import * as plugins from '../plugins.js';
2
+ import type { IIdentity } from '../data/user.js';
3
+ import type {
4
+ IPlatformBinding,
5
+ IPlatformCapability,
6
+ IPlatformProviderConfig,
7
+ TPlatformBindingStatus,
8
+ } from '../platform/types.js';
9
+
10
+ export interface IReq_Any_Cloudly_GetPlatformDesiredState
11
+ extends plugins.typedrequestInterfaces.implementsTR<
12
+ plugins.typedrequestInterfaces.ITypedRequest,
13
+ IReq_Any_Cloudly_GetPlatformDesiredState
14
+ > {
15
+ method: 'getPlatformDesiredState';
16
+ request: {
17
+ identity: IIdentity;
18
+ };
19
+ response: {
20
+ capabilities: IPlatformCapability[];
21
+ providerConfigs: IPlatformProviderConfig[];
22
+ bindings: IPlatformBinding[];
23
+ };
24
+ }
25
+
26
+ export interface IReq_Any_Cloudly_GetPlatformCapabilities
27
+ extends plugins.typedrequestInterfaces.implementsTR<
28
+ plugins.typedrequestInterfaces.ITypedRequest,
29
+ IReq_Any_Cloudly_GetPlatformCapabilities
30
+ > {
31
+ method: 'getPlatformCapabilities';
32
+ request: {
33
+ identity: IIdentity;
34
+ };
35
+ response: {
36
+ capabilities: IPlatformCapability[];
37
+ };
38
+ }
39
+
40
+ export interface IReq_Any_Cloudly_GetPlatformProviderConfigs
41
+ extends plugins.typedrequestInterfaces.implementsTR<
42
+ plugins.typedrequestInterfaces.ITypedRequest,
43
+ IReq_Any_Cloudly_GetPlatformProviderConfigs
44
+ > {
45
+ method: 'getPlatformProviderConfigs';
46
+ request: {
47
+ identity: IIdentity;
48
+ capability?: IPlatformProviderConfig['capability'];
49
+ };
50
+ response: {
51
+ providerConfigs: IPlatformProviderConfig[];
52
+ };
53
+ }
54
+
55
+ export interface IReq_Any_Cloudly_UpsertPlatformProviderConfig
56
+ extends plugins.typedrequestInterfaces.implementsTR<
57
+ plugins.typedrequestInterfaces.ITypedRequest,
58
+ IReq_Any_Cloudly_UpsertPlatformProviderConfig
59
+ > {
60
+ method: 'upsertPlatformProviderConfig';
61
+ request: {
62
+ identity: IIdentity;
63
+ providerConfig: IPlatformProviderConfig;
64
+ };
65
+ response: {
66
+ providerConfig: IPlatformProviderConfig;
67
+ };
68
+ }
69
+
70
+ export interface IReq_Any_Cloudly_DeletePlatformProviderConfigById
71
+ extends plugins.typedrequestInterfaces.implementsTR<
72
+ plugins.typedrequestInterfaces.ITypedRequest,
73
+ IReq_Any_Cloudly_DeletePlatformProviderConfigById
74
+ > {
75
+ method: 'deletePlatformProviderConfigById';
76
+ request: {
77
+ identity: IIdentity;
78
+ providerConfigId: string;
79
+ };
80
+ response: {
81
+ success: boolean;
82
+ };
83
+ }
84
+
85
+ export interface IReq_Any_Cloudly_GetPlatformBindings
86
+ extends plugins.typedrequestInterfaces.implementsTR<
87
+ plugins.typedrequestInterfaces.ITypedRequest,
88
+ IReq_Any_Cloudly_GetPlatformBindings
89
+ > {
90
+ method: 'getPlatformBindings';
91
+ request: {
92
+ identity: IIdentity;
93
+ serviceId?: string;
94
+ capability?: IPlatformBinding['capability'];
95
+ };
96
+ response: {
97
+ bindings: IPlatformBinding[];
98
+ };
99
+ }
100
+
101
+ export interface IReq_Any_Cloudly_UpsertPlatformBinding
102
+ extends plugins.typedrequestInterfaces.implementsTR<
103
+ plugins.typedrequestInterfaces.ITypedRequest,
104
+ IReq_Any_Cloudly_UpsertPlatformBinding
105
+ > {
106
+ method: 'upsertPlatformBinding';
107
+ request: {
108
+ identity: IIdentity;
109
+ binding: IPlatformBinding;
110
+ };
111
+ response: {
112
+ binding: IPlatformBinding;
113
+ };
114
+ }
115
+
116
+ export interface IReq_Any_Cloudly_UpdatePlatformBindingStatus
117
+ extends plugins.typedrequestInterfaces.implementsTR<
118
+ plugins.typedrequestInterfaces.ITypedRequest,
119
+ IReq_Any_Cloudly_UpdatePlatformBindingStatus
120
+ > {
121
+ method: 'updatePlatformBindingStatus';
122
+ request: {
123
+ identity: IIdentity;
124
+ bindingId: string;
125
+ status: TPlatformBindingStatus;
126
+ endpoints?: IPlatformBinding['endpoints'];
127
+ credentials?: IPlatformBinding['credentials'];
128
+ errorText?: string;
129
+ };
130
+ response: {
131
+ binding: IPlatformBinding;
132
+ };
133
+ }
134
+
135
+ export interface IReq_Any_Cloudly_DeletePlatformBindingById
136
+ extends plugins.typedrequestInterfaces.implementsTR<
137
+ plugins.typedrequestInterfaces.ITypedRequest,
138
+ IReq_Any_Cloudly_DeletePlatformBindingById
139
+ > {
140
+ method: 'deletePlatformBindingById';
141
+ request: {
142
+ identity: IIdentity;
143
+ bindingId: string;
144
+ };
145
+ response: {
146
+ success: boolean;
147
+ };
148
+ }