@zimbra/api-client 88.0.0 → 90.0.0

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.
@@ -328,6 +328,10 @@ type AuthResponse {
328
328
  authToken: [AuthToken]
329
329
  twoFactorAuthRequired: TwoFactorAuthRequired
330
330
  trustedDevicesEnabled: TrustedDevicesEnabled
331
+ zimbraPrefPasswordRecoveryAddress: StringContent
332
+ zimbraPrefPrimaryTwoFactorAuthMethod: StringContent
333
+ zimbraTwoFactorAuthMethodAllowed: [String]
334
+ zimbraTwoFactorAuthMethodEnabled: [String]
331
335
  lifetime: Float
332
336
  session: Session
333
337
  skin: [Skin]
@@ -353,6 +357,10 @@ type EnableTwoFactorAuthResponse {
353
357
  csrfToken: [CsrfToken]
354
358
  }
355
359
 
360
+ type SendTwoFactorAuthCodeResponse {
361
+ status: [StringContent]
362
+ }
363
+
356
364
  type ProfileImageChangeResponse {
357
365
  itemId: ID
358
366
  }
@@ -464,6 +472,10 @@ type ShareNotification {
464
472
  content: String
465
473
  }
466
474
 
475
+ type DLSubscribe {
476
+ content: String
477
+ }
478
+
467
479
  type MessageAttributes {
468
480
  isEncrypted: Boolean
469
481
  isSigned: Boolean
@@ -488,6 +500,7 @@ interface MailItem {
488
500
  invitations: [InviteInfo] # inv
489
501
  sortField: String # sf, Sort field used for cursor-based pagination
490
502
  share: [ShareNotification] # shr
503
+ subscribe: [DLSubscribe] # dlSub
491
504
  replyType: String #rt
492
505
  }
493
506
 
@@ -538,6 +551,7 @@ type MessageInfo implements MailItem {
538
551
  attachments: [MimePart]
539
552
  inlineAttachments: [MimePart]
540
553
  share: [ShareNotification] # shr
554
+ subscribe: [DLSubscribe] # dlSub
541
555
  replyType: String #rt
542
556
  attributes: MessageAttributes
543
557
  isEncrypted: Boolean
@@ -571,6 +585,7 @@ type Conversation implements MailItem {
571
585
  numMessages: Float # n, Number of messages in this conversation
572
586
  unread: Float # u
573
587
  share: [ShareNotification] # shr
588
+ subscribe: [DLSubscribe] # dlSub
574
589
  replyType: String #rt
575
590
  meta: [CustomMetadataMeta]
576
591
  }
@@ -600,6 +615,7 @@ type MsgWithGroupInfo implements MailItem {
600
615
  invitations: [InviteInfo] # inv
601
616
  sortField: String # sf, Sort field used for cursor-based pagination
602
617
  share: [ShareNotification] # shr
618
+ subscribe: [DLSubscribe] # dlSub
603
619
  replyType: String #rt
604
620
  }
605
621
 
@@ -1008,8 +1024,12 @@ type ImportanceCondition {
1008
1024
  negative: Boolean
1009
1025
  }
1010
1026
 
1027
+ type MethodCondition {
1028
+ _content: String
1029
+ }
1030
+
1011
1031
  type InviteCondition {
1012
- methods: [String]
1032
+ method: [MethodCondition]
1013
1033
  index: Int
1014
1034
  negative: Boolean
1015
1035
  }
@@ -1188,7 +1208,7 @@ type DLSAttrs {
1188
1208
  zimbraHideInGal: String
1189
1209
  }
1190
1210
 
1191
- type DLS {
1211
+ type DLS {
1192
1212
  d: String
1193
1213
  dynamic: Boolean
1194
1214
  id: String
@@ -1197,18 +1217,74 @@ type DLSAttrs {
1197
1217
  name: String
1198
1218
  ref: String
1199
1219
  _attrs: DLSAttrs
1200
- }
1220
+ }
1201
1221
 
1202
- type DLSDetails {
1222
+ type DLSDetails {
1203
1223
  dls: [DLS]
1204
- }
1224
+ }
1225
+
1226
+ type DLOwner {
1227
+ id: String
1228
+ name: String
1229
+ type: String
1230
+ }
1231
+
1232
+ type DLOwners {
1233
+ owner: [DLOwner]
1234
+ }
1235
+
1236
+ type DLAttributes {
1237
+ description: String
1238
+ displayName: String
1239
+ mail: String
1240
+ zimbraDistributionListSubscriptionPolicy: String
1241
+ zimbraDistributionListUnsubscriptionPolicy: String
1242
+ zimbraHideInGal: String
1243
+ zimbraMailAlias: String
1244
+ zimbraMailStatus: String
1245
+ zimbraNotes: String
1246
+ }
1247
+
1248
+ type SubscribeDistributionList {
1249
+ status: String
1250
+ }
1251
+
1252
+ type DLGrantee {
1253
+ id: ID
1254
+ type: String
1255
+ name: String
1256
+ }
1257
+
1258
+ type DLRight {
1259
+ right: String
1260
+ grantee: [DLGrantee]
1261
+ }
1262
+
1263
+ type DLRights {
1264
+ right: [DLRight]
1265
+ }
1266
+
1267
+ type DLDetails {
1268
+ dynamic: Boolean
1269
+ id: String
1270
+ isMember: Boolean
1271
+ isOwner: Boolean
1272
+ name: String
1273
+ owners: [DLOwners]
1274
+ rights: [DLRights]
1275
+ _attrs: DLAttributes
1276
+ }
1205
1277
 
1206
- type DLDetails {
1278
+ type DL {
1279
+ dl: [DLDetails]
1280
+ }
1281
+
1282
+ type DLMembersDetails {
1207
1283
  dlm: [Dlm]
1208
1284
  dlGroupMember: [DlGroupMember]
1209
1285
  more: Boolean,
1210
1286
  total: Int
1211
- }
1287
+ }
1212
1288
 
1213
1289
  type HabGroup {
1214
1290
  name: String
@@ -1409,6 +1485,8 @@ type AccountInfoAttrs {
1409
1485
  zimbraFeatureZulipChatEnabled: Boolean
1410
1486
  zimbraFeatureDocumentEditingEnabled: Boolean
1411
1487
  zimbraTwoFactorAuthEnabled: Boolean
1488
+ zimbraTwoFactorAuthMethodAllowed: [String]
1489
+ zimbraTwoFactorAuthMethodEnabled: [String]
1412
1490
  zimbraFeatureTrustedDevicesEnabled: Boolean
1413
1491
  zimbraFeatureAntispamEnabled: Boolean
1414
1492
  zimbraFeatureAppSpecificPasswordsEnabled: Boolean
@@ -1442,6 +1520,7 @@ type AccountInfoAttrs {
1442
1520
  zimbraFeatureExportFolderEnabled: Boolean
1443
1521
  zimbraFeatureGroupCalendarEnabled: Boolean
1444
1522
  zimbraFeatureDistributionListExpandMembersEnabled: Boolean
1523
+ zimbraFeatureDistributionListFolderEnabled: Boolean
1445
1524
  }
1446
1525
 
1447
1526
  type AccountCos {
@@ -1542,6 +1621,7 @@ type Preferences {
1542
1621
  zimbraPrefCalendarAlwaysShowMiniCal: Boolean
1543
1622
  zimbraPrefComposeDirection: String
1544
1623
  zimbraPrefComposeFormat: Mode
1624
+ zimbraPrefForwardReplyInOriginalFormat: Boolean
1545
1625
  zimbraPrefHtmlEditorDefaultFontColor: String
1546
1626
  zimbraPrefHtmlEditorDefaultFontFamily: String
1547
1627
  zimbraPrefHtmlEditorDefaultFontSize: String
@@ -1590,6 +1670,7 @@ type Preferences {
1590
1670
  zimbraPrefTagTreeOpen: Boolean
1591
1671
  zimbraPrefPowerPasteEnabled: Boolean
1592
1672
  zimbraPrefDisplayTimeInMailList: Boolean
1673
+ zimbraPrefPrimaryTwoFactorAuthMethod: String
1593
1674
  }
1594
1675
 
1595
1676
  type GetAppointmentResponse {
@@ -1728,6 +1809,7 @@ type Contact {
1728
1809
  attributes: ContactAttributes
1729
1810
  members: [ContactListMember]
1730
1811
  certificate: [SmimeCert]
1812
+ isOwner: Boolean
1731
1813
  }
1732
1814
 
1733
1815
  type OtherContactAttribute {
@@ -2599,6 +2681,7 @@ input PreferencesInput {
2599
2681
  zimbraPrefCalendarAlwaysShowMiniCal: Boolean
2600
2682
  zimbraPrefComposeDirection: String
2601
2683
  zimbraPrefComposeFormat: Mode
2684
+ zimbraPrefForwardReplyInOriginalFormat: Boolean
2602
2685
  zimbraPrefExternalSendersType: ExternalSendersType
2603
2686
  zimbraPrefHtmlEditorDefaultFontColor: String
2604
2687
  zimbraPrefHtmlEditorDefaultFontFamily: String
@@ -2643,6 +2726,7 @@ input PreferencesInput {
2643
2726
  zimbraPrefTagTreeOpen: Boolean
2644
2727
  zimbraPrefPowerPasteEnabled: Boolean
2645
2728
  zimbraPrefDisplayTimeInMailList: Boolean
2729
+ zimbraPrefPrimaryTwoFactorAuthMethod: String
2646
2730
  }
2647
2731
 
2648
2732
  input ModifyIdentityInput {
@@ -2734,9 +2818,13 @@ input ImportanceConditionInput {
2734
2818
  }
2735
2819
 
2736
2820
  input InviteConditionInput {
2737
- methods: [String]
2738
- index: Int
2739
- negative: Boolean
2821
+ method: [MethodInput]
2822
+ index: Int
2823
+ negative: Boolean
2824
+ }
2825
+
2826
+ input MethodInput {
2827
+ _content: String
2740
2828
  }
2741
2829
 
2742
2830
  input MimeHeaderConditionInput {
@@ -2964,6 +3052,8 @@ input ExternalAccountModifyAttrsInput {
2964
3052
 
2965
3053
  input EnableTwoFactorAuthInput {
2966
3054
  name: String!
3055
+ method: String!
3056
+ email: String
2967
3057
  password: String
2968
3058
  twoFactorCode: String
2969
3059
  authToken: String
@@ -2971,6 +3061,11 @@ input EnableTwoFactorAuthInput {
2971
3061
  ignoreSameSite: Boolean
2972
3062
  }
2973
3063
 
3064
+ input SendTwoFactorAuthCodeInput {
3065
+ action: String!
3066
+ authToken: String!
3067
+ }
3068
+
2974
3069
  input ExternalAccountImportInput {
2975
3070
  accountType: AccountType
2976
3071
  id: ID!
@@ -3104,6 +3199,46 @@ input SaveDocumentInput {
3104
3199
  document: SaveDocumentInput
3105
3200
  }
3106
3201
 
3202
+ input DLActionAttrInput {
3203
+ attributeName: String
3204
+ content: String
3205
+ }
3206
+
3207
+ input DLActionGranteeInput {
3208
+ by: String
3209
+ type: String
3210
+ _content: String
3211
+ }
3212
+
3213
+ input DLActionRightInput {
3214
+ right: String
3215
+ grantee: [DLActionGranteeInput]
3216
+ }
3217
+
3218
+ input SubRequestInput {
3219
+ op: String
3220
+ _content: String
3221
+ }
3222
+
3223
+ input DLActionInput {
3224
+ operation: String
3225
+ attributes: [DLActionAttrInput]
3226
+ right: DLActionRightInput
3227
+ owner: [DLActionGranteeInput]
3228
+ subsReq: SubRequestInput
3229
+ distributionListMembers: [MethodInput]
3230
+ }
3231
+
3232
+ input DLSelectorInput {
3233
+ by: String
3234
+ _content: String
3235
+ }
3236
+
3237
+ input DistributionListActionInput {
3238
+ action: DLActionInput
3239
+ dl: DLSelectorInput
3240
+ }
3241
+
3107
3242
  type SaveDocument {
3108
3243
  id: ID
3109
3244
  version: Int
@@ -3384,11 +3519,17 @@ type Query {
3384
3519
  attrs: String
3385
3520
  ownerOf: Int
3386
3521
  ): DLSDetails
3522
+ getDistributionList(
3523
+ needOwners: Boolean
3524
+ needRights: String
3525
+ dl: String
3526
+ by: String
3527
+ ): DL
3387
3528
  getDistributionListMembers(
3388
3529
  limit: Int
3389
3530
  offset: Int
3390
3531
  dl: String
3391
- ): DLDetails
3532
+ ): DLMembersDetails
3392
3533
  getCustomMetadata(id: ID!, section: String): CustomMetadata
3393
3534
  getMailboxMetadata(section: String): MailboxMetadata
3394
3535
  getMessage(
@@ -3603,7 +3744,7 @@ type Mutation {
3603
3744
  enableTwoFactorAuth(
3604
3745
  options: EnableTwoFactorAuthInput!
3605
3746
  ): EnableTwoFactorAuthResponse
3606
- disableTwoFactorAuth: Boolean
3747
+ disableTwoFactorAuth(method: String!): Boolean
3607
3748
  messageAction(ids: [ID!]!, op: String!): Boolean
3608
3749
  modifyExternalAccount(
3609
3750
  id: ID!
@@ -3658,6 +3799,9 @@ type Mutation {
3658
3799
  sendDeliveryReport(messageId: ID!): Boolean
3659
3800
  sendInviteReply(inviteReply: InviteReplyInput!): InviteReplyResponse
3660
3801
  sendShareNotification(shareNotification: ShareNotificationInput!): Boolean
3802
+ sendTwoFactorAuthCode(
3803
+ options: SendTwoFactorAuthCodeInput!
3804
+ ): SendTwoFactorAuthCodeResponse
3661
3805
  setCustomMetadata(customMetaData: CustomMetadataInput!): Boolean
3662
3806
  setMailboxMetadata(
3663
3807
  section: String
@@ -3682,6 +3826,8 @@ type Mutation {
3682
3826
  cancelPendingAccountOnlyRemoteWipeSync(deviceId: String): Device
3683
3827
  remoteWipeSync(deviceId: String): Device
3684
3828
  cancelPendingRemoteWipeSync(deviceId: String): Device
3829
+ subscribeDistributionList(op: String!, by: String, dl: String!): String
3830
+ distributionListAction(dlActions: DistributionListActionInput!): Boolean
3685
3831
  }
3686
3832
 
3687
3833
  schema {
@@ -1,5 +1,5 @@
1
1
  import { JsonRequestOptions } from '../request/types';
2
- import { AddMsgInput, CalendarItemInput, CounterAppointmentInput, CreateContactInput, CreateIdentityInput, CreateMountpointInput, CreateTagInput, DeleteAppointmentInput, DeleteIdentityInput, EnableTwoFactorAuthInput, ExternalAccountAddInput, ExternalAccountImportInput, ExternalAccountTestInput, FilterInput, FolderActionChangeColorInput, FolderActionCheckCalendarInput, ForwardAppointmentInput, ForwardAppointmentInviteInput, GetRightsInput, GrantRightsInput, InviteReplyInput, ModifyContactInput, ModifyIdentityInput, PreferencesInput, RevokeRightsInput, SaveSMimeCertInputUpload, SearchFolderInput, SendMessageInput, ShareNotificationInput, SignatureInput, WhiteBlackListInput, ZimletPreferenceInput } from '../schema/generated-schema-types';
2
+ import { AddMsgInput, CalendarItemInput, CounterAppointmentInput, CreateContactInput, CreateIdentityInput, CreateMountpointInput, CreateTagInput, DeleteAppointmentInput, DeleteIdentityInput, DistributionListActionInput, EnableTwoFactorAuthInput, ExternalAccountAddInput, ExternalAccountImportInput, ExternalAccountTestInput, FilterInput, FolderActionChangeColorInput, FolderActionCheckCalendarInput, ForwardAppointmentInput, ForwardAppointmentInviteInput, GetRightsInput, GrantRightsInput, InviteReplyInput, ModifyContactInput, ModifyIdentityInput, PreferencesInput, RevokeRightsInput, SaveSMimeCertInputUpload, SearchFolderInput, SendMessageInput, SendTwoFactorAuthCodeInput, ShareNotificationInput, SignatureInput, WhiteBlackListInput, ZimletPreferenceInput } from '../schema/generated-schema-types';
3
3
  import { ActionOptions, ActionType, ApplyFilterRulesOptions, AppointmentOptions, AutoCompleteGALOptions, AutoCompleteOptions, ChangePasswordOptions, CreateFolderOptions, CreateSearchFolderOptions, DiscoverRightOptions, ExternalAccountDeleteInput, ExternalAccountModifyInput, FreeBusyOptions, GetContactFrequencyOptions, GetContactOptions, GetConversationOptions, GetCustomMetadataOptions, GetDocumentShareURLOptions, GetFolderOptions, GetMailboxMetadataOptions, GetMessageOptions, GetSMimePublicCertsOptions, LoginOptions, ModifyProfileImageOptions, NoOpOptions, RecoverAccountOptions, RelatedContactsOptions, ResetPasswordOptions, SaveDocumentInput, SearchCalendarResourcesOptions, SearchOptions, SetRecoveryAccountOptions, ShareInfoOptions, WorkingHoursOptions, ZimbraClientOptions } from './types';
4
4
  import { Notifier } from './notifier';
5
5
  export declare class ZimbraBatchClient {
@@ -54,9 +54,10 @@ export declare class ZimbraBatchClient {
54
54
  deleteExternalAccount: ({ id }: ExternalAccountDeleteInput) => Promise<boolean>;
55
55
  deleteIdentity: (identity: DeleteIdentityInput) => Promise<boolean>;
56
56
  deleteSignature: (options: SignatureInput) => Promise<boolean>;
57
- disableTwoFactorAuth: () => Promise<boolean>;
57
+ disableTwoFactorAuth: (method: string) => Promise<boolean>;
58
58
  discoverRights: ({ right }: DiscoverRightOptions) => Promise<any>;
59
59
  dismissCalendarItem: (appointment: any, task: any) => Promise<boolean>;
60
+ distributionListAction: ({ action, dl }: DistributionListActionInput) => Promise<boolean>;
60
61
  documentAction: (options: ActionOptions) => Promise<any>;
61
62
  documentActionResponse: (type: ActionType, options: ActionOptions) => Promise<any>;
62
63
  downloadAttachment: ({ id, part }: any) => Promise<{
@@ -72,7 +73,7 @@ export declare class ZimbraBatchClient {
72
73
  content: any;
73
74
  isSecure: any;
74
75
  }>;
75
- enableTwoFactorAuth: ({ name, password, authToken, twoFactorCode, csrfTokenSecured, ignoreSameSite }: EnableTwoFactorAuthInput) => Promise<any>;
76
+ enableTwoFactorAuth: ({ name, email, method, password, authToken, twoFactorCode, csrfTokenSecured, ignoreSameSite }: EnableTwoFactorAuthInput) => Promise<any>;
76
77
  endSessionBeaconRequest: (options: JsonRequestOptions) => void;
77
78
  folderAction: (options: ActionOptions) => Promise<boolean>;
78
79
  forwardAppointment: (body: ForwardAppointmentInput) => Promise<boolean>;
@@ -93,6 +94,7 @@ export declare class ZimbraBatchClient {
93
94
  getCustomMetadata: ({ id, section }: GetCustomMetadataOptions) => Promise<{}>;
94
95
  getDataSources: () => Promise<{}>;
95
96
  getDeviceStatus: () => Promise<any>;
97
+ getDistributionList: (dl: String, needOwners: Boolean, needRights: String, by: String) => Promise<any>;
96
98
  getDistributionListMembers: (limit: String, offset: String, dl: String) => Promise<any>;
97
99
  getDocumentShareURL: (options: GetDocumentShareURLOptions) => Promise<any>;
98
100
  getFilterRules: () => Promise<any>;
@@ -127,7 +129,7 @@ export declare class ZimbraBatchClient {
127
129
  itemAction: (options: ActionOptions) => Promise<boolean>;
128
130
  jsonRequest: (options: JsonRequestOptions) => Promise<any>;
129
131
  listDocumentRevisions: ({ id, version, count }: any) => Promise<any>;
130
- login: ({ username, password, recoveryCode, tokenType, persistAuthTokenCookie, twoFactorCode, deviceTrusted, csrfTokenSecured, ignoreSameSite }: LoginOptions) => Promise<{}>;
132
+ login: ({ username, password, recoveryCode, tokenType, persistAuthTokenCookie, twoFactorCode, deviceTrusted, csrfTokenSecured, ignoreSameSite }: LoginOptions) => Promise<any>;
131
133
  logout: () => Promise<boolean>;
132
134
  messageAction: (options: ActionOptions) => Promise<boolean>;
133
135
  modifyAppointment: (accountName: string, appointment: CalendarItemInput) => Promise<any>;
@@ -170,6 +172,7 @@ export declare class ZimbraBatchClient {
170
172
  sendInviteReply: (requestOptions: InviteReplyInput) => Promise<any>;
171
173
  sendMessage: (message: SendMessageInput, accountName: string, sign: Boolean, encrypt: Boolean) => Promise<any>;
172
174
  sendShareNotification: (body: ShareNotificationInput) => Promise<boolean>;
175
+ sendTwoFactorAuthCode: ({ action, authToken }: SendTwoFactorAuthCodeInput) => Promise<any>;
173
176
  setCsrfToken: (csrfToken: string) => void;
174
177
  setCustomMetadata: (variables: any) => Promise<boolean>;
175
178
  setJwtToken: (jwtToken: string) => void;
@@ -177,6 +180,7 @@ export declare class ZimbraBatchClient {
177
180
  setUserAgent: (userAgent: Object) => void;
178
181
  shareInfo: (options: ShareInfoOptions) => Promise<any>;
179
182
  snoozeCalendarItem: (appointment: any, task: any) => Promise<boolean>;
183
+ subscribeDistributionList: (op: String, by: String, dl: String) => Promise<any>;
180
184
  taskFolders: () => Promise<any>;
181
185
  testExternalAccount: ({ accountType, ...accountInfo }: ExternalAccountTestInput) => Promise<{}>;
182
186
  uploadMessage: (message: string) => any;
@@ -61,3 +61,5 @@ export declare const ZimletConfigHostEntity: Entity;
61
61
  export declare const ZimletConfigEntity: Entity;
62
62
  export declare const ActionData: Entity;
63
63
  export declare const DocumentActionData: Entity;
64
+ export declare const DLActionAttrEntity: Entity;
65
+ export declare const DLActionEntity: Entity;