@zimbra/api-client 89.0.0 → 91.0.0

package/dist/schema.graphql

@@ -328,6 +328,10 @@ type AuthResponse {
 	authToken: [AuthToken]
 	twoFactorAuthRequired: TwoFactorAuthRequired
 	trustedDevicesEnabled: TrustedDevicesEnabled
+	zimbraPrefPasswordRecoveryAddress: StringContent
+	zimbraPrefPrimaryTwoFactorAuthMethod: StringContent
+	zimbraTwoFactorAuthMethodAllowed: [String]
+	zimbraTwoFactorAuthMethodEnabled: [String]
 	lifetime: Float
 	session: Session
 	skin: [Skin]
@@ -353,6 +357,10 @@ type EnableTwoFactorAuthResponse {
 	csrfToken: [CsrfToken]
 }
 
+type SendTwoFactorAuthCodeResponse {
+	status: [StringContent]
+}
+
 type ProfileImageChangeResponse {
 	itemId: ID
 }
@@ -464,6 +472,10 @@ type ShareNotification {
 	content: String
 }
 
+type DLSubscribe {
+	content: String
+}
+
 type MessageAttributes {
 	isEncrypted: Boolean
 	isSigned: Boolean
@@ -488,6 +500,7 @@ interface MailItem {
 	invitations: [InviteInfo] # inv
 	sortField: String # sf, Sort field used for cursor-based pagination
 	share: [ShareNotification] # shr
+	subscribe: [DLSubscribe] # dlSub
 	replyType: String #rt
 }
 
@@ -497,6 +510,7 @@ type ClientInfoAttributes {
 	zimbraWebClientSkipLogoff: Boolean
 	zimbraFeatureResetPasswordStatus: ResetPasswordStatus
 	zimbraHelpModernURL: String
+	zimbraClassicWebClientDisabled: Boolean
 }
 
 type ClientInfoType {
@@ -538,6 +552,7 @@ type MessageInfo implements MailItem {
 	attachments: [MimePart]
 	inlineAttachments: [MimePart]
 	share: [ShareNotification] # shr
+	subscribe: [DLSubscribe] # dlSub
 	replyType: String #rt
 	attributes: MessageAttributes
 	isEncrypted: Boolean
@@ -546,6 +561,7 @@ type MessageInfo implements MailItem {
 	local: Boolean
 	part: String
 	meta: [CustomMetadataMeta]
+	_attrs: [CustomHeader]
 }
 
 type Conversation implements MailItem {
@@ -571,8 +587,10 @@ type Conversation implements MailItem {
 	numMessages: Float # n, Number of messages in this conversation
 	unread: Float # u
 	share: [ShareNotification] # shr
+	subscribe: [DLSubscribe] # dlSub
 	replyType: String #rt
 	meta: [CustomMetadataMeta]
+	_attrs: [CustomHeader]
 }
 
 type MsgWithGroupInfo implements MailItem {
@@ -589,6 +607,7 @@ type MsgWithGroupInfo implements MailItem {
 	folderId: ID # l
 	subject: String # su
 	emailAddresses: [EmailAddress]
+	_attrs: [CustomHeader]
 	excerpt: String # fr
 	conversationId: ID # cid
 	flags: String # f
@@ -600,6 +619,7 @@ type MsgWithGroupInfo implements MailItem {
 	invitations: [InviteInfo] # inv
 	sortField: String # sf, Sort field used for cursor-based pagination
 	share: [ShareNotification] # shr
+	subscribe: [DLSubscribe] # dlSub
 	replyType: String #rt
 }
 
@@ -1192,7 +1212,7 @@ type DLSAttrs {
 	zimbraHideInGal: String
 }
 
- type DLS {
+type DLS {
 	d: String
 	dynamic: Boolean
 	id: String
@@ -1201,18 +1221,74 @@ type DLSAttrs {
 	name: String
 	ref: String
 	_attrs: DLSAttrs
- }
+}
 
-  type DLSDetails {
+type DLSDetails {
 	dls: [DLS]
- }
+}
+
+type DLOwner {
+	id: String
+	name: String
+	type: String
+}
+
+type DLOwners {
+	owner: [DLOwner]
+}
+
+type DLAttributes {
+	description: String
+	displayName: String
+	mail: String
+	zimbraDistributionListSubscriptionPolicy: String
+	zimbraDistributionListUnsubscriptionPolicy: String
+	zimbraHideInGal: String
+	zimbraMailAlias: String
+	zimbraMailStatus: String
+	zimbraNotes: String
+}
+
+type SubscribeDistributionList {
+	status: String
+}
+
+type DLGrantee {
+	id: ID
+	type: String
+	name: String
+}
+
+type DLRight {
+	right: String
+	grantee: [DLGrantee]
+}
+
+type DLRights {
+	right: [DLRight]
+}
+
+type DLDetails {
+	dynamic: Boolean
+	id: String
+	isMember: Boolean
+	isOwner: Boolean
+	name: String
+	owners: [DLOwners]
+	rights: [DLRights]
+	_attrs: DLAttributes
+}
+
+type DL {
+	dl: [DLDetails]
+}
 
-  type DLDetails {
+type DLMembersDetails {
 	dlm: [Dlm]
 	dlGroupMember: [DlGroupMember]
 	more: Boolean,
 	total: Int
- }
+}
 
 type HabGroup {
 	name: String
@@ -1406,6 +1482,7 @@ type AccountInfoAttrs {
 	zimbraFeatureFiltersEnabled: Boolean
 	zimbraFeatureReadReceiptsEnabled: Boolean
 	zimbraFeatureSharingEnabled: Boolean
+	zimbraFeatureSharedFolderMobileSyncEnabled: Boolean
 	zimbraFeatureManageZimlets: Boolean
 	zimbraFeatureTwoFactorAuthAvailable: Boolean
 	zimbraFeatureTwoFactorAuthRequired: Boolean
@@ -1413,6 +1490,8 @@ type AccountInfoAttrs {
 	zimbraFeatureZulipChatEnabled: Boolean
 	zimbraFeatureDocumentEditingEnabled: Boolean
 	zimbraTwoFactorAuthEnabled: Boolean
+	zimbraTwoFactorAuthMethodAllowed: [String]
+	zimbraTwoFactorAuthMethodEnabled: [String]
 	zimbraFeatureTrustedDevicesEnabled: Boolean
 	zimbraFeatureAntispamEnabled: Boolean
 	zimbraFeatureAppSpecificPasswordsEnabled: Boolean
@@ -1547,6 +1626,7 @@ type Preferences {
 	zimbraPrefCalendarAlwaysShowMiniCal: Boolean
 	zimbraPrefComposeDirection: String
 	zimbraPrefComposeFormat: Mode
+	zimbraPrefForwardReplyInOriginalFormat: Boolean
 	zimbraPrefHtmlEditorDefaultFontColor: String
 	zimbraPrefHtmlEditorDefaultFontFamily: String
 	zimbraPrefHtmlEditorDefaultFontSize: String
@@ -1595,6 +1675,7 @@ type Preferences {
 	zimbraPrefTagTreeOpen: Boolean
 	zimbraPrefPowerPasteEnabled: Boolean
 	zimbraPrefDisplayTimeInMailList: Boolean
+	zimbraPrefPrimaryTwoFactorAuthMethod: String
 }
 
 type GetAppointmentResponse {
@@ -1706,6 +1787,11 @@ type SaveDraftResponse {
 	message: [MessageInfo]
 }
 
+type CustomHeader {
+	key: String
+	value: String
+}
+
 type CustomMetadataAttrs {
 	key: String
 	value: String
@@ -1733,6 +1819,7 @@ type Contact {
 	attributes: ContactAttributes
 	members: [ContactListMember]
 	certificate: [SmimeCert]
+	isOwner: Boolean
 }
 
 type OtherContactAttribute {
@@ -1995,6 +2082,7 @@ type ShareInfo {
 	rights: String
 	view: FolderView
 	mid: ID
+	activeSyncDisabled: Boolean
 }
 
 type MailboxMetadataAttrs {
@@ -2228,6 +2316,12 @@ input SendMessageInput {
 	emailAddresses: [MailItemEmailAddressInput] #e
 	attachments: [AttachmentInput] #attach
 	inlineAttachments: [MimePartInput] #attach
+	header: [HeaderInput] #header
+}
+
+input HeaderInput {
+	name: String #name
+	_content: String #value
 }
 
 input SaveSMimeCertInputUpload {
@@ -2604,6 +2698,7 @@ input PreferencesInput {
 	zimbraPrefCalendarAlwaysShowMiniCal: Boolean
 	zimbraPrefComposeDirection: String
 	zimbraPrefComposeFormat: Mode
+	zimbraPrefForwardReplyInOriginalFormat: Boolean
 	zimbraPrefExternalSendersType: ExternalSendersType
 	zimbraPrefHtmlEditorDefaultFontColor: String
 	zimbraPrefHtmlEditorDefaultFontFamily: String
@@ -2648,6 +2743,7 @@ input PreferencesInput {
 	zimbraPrefTagTreeOpen: Boolean
 	zimbraPrefPowerPasteEnabled: Boolean
 	zimbraPrefDisplayTimeInMailList: Boolean
+	zimbraPrefPrimaryTwoFactorAuthMethod: String
 }
 
 input ModifyIdentityInput {
@@ -2973,6 +3069,8 @@ input ExternalAccountModifyAttrsInput {
 
 input EnableTwoFactorAuthInput {
 	name: String!
+	method: String!
+	email: String
 	password: String
 	twoFactorCode: String
 	authToken: String
@@ -2980,6 +3078,11 @@ input EnableTwoFactorAuthInput {
 	ignoreSameSite: Boolean
 }
 
+input SendTwoFactorAuthCodeInput {
+	action: String!
+	authToken: String!
+}
+
 input ExternalAccountImportInput {
 	accountType: AccountType
 	id: ID!
@@ -3113,6 +3216,46 @@ input SaveDocumentInput {
 	document: SaveDocumentInput
 }
 
+input DLActionAttrInput {
+	attributeName: String
+	content: String
+}
+
+input DLActionGranteeInput {
+	by: String
+	type: String
+	_content: String
+}
+
+input DLActionRightInput {
+	right: String
+	grantee: [DLActionGranteeInput]
+}
+
+input SubRequestInput {
+	op: String
+	_content: String
+}
+
+input DLActionInput {
+	operation: String
+	attributes: [DLActionAttrInput]
+	right: DLActionRightInput
+	owner: [DLActionGranteeInput]
+	subsReq: SubRequestInput
+	distributionListMembers: [MethodInput]
+}
+
+input DLSelectorInput {
+	by: String
+	_content: String
+}
+
+input DistributionListActionInput {
+	action: DLActionInput
+	dl: DLSelectorInput
+}
+
 type SaveDocument {
 	id: ID
 	version: Int
@@ -3393,11 +3536,17 @@ type Query {
 		attrs: String
 		ownerOf: Int
 	): DLSDetails
+	getDistributionList(
+		needOwners: Boolean
+		needRights: String
+		dl: String
+		by: String
+	): DL
 	getDistributionListMembers(
 		limit: Int
 		offset: Int
 		dl: String
-	): DLDetails
+	): DLMembersDetails
 	getCustomMetadata(id: ID!, section: String): CustomMetadata
 	getMailboxMetadata(section: String): MailboxMetadata
 	getMessage(
@@ -3462,7 +3611,8 @@ type Query {
 		sortBy: SortBy
 		types: SearchType
 		resultMode: String
-		inDumpster: Boolean
+		inDumpster: Boolean,
+		header: [MailItemHeaderInput]
 	): SearchResponse
 
 	searchCalendarResources(
@@ -3612,7 +3762,7 @@ type Mutation {
 	enableTwoFactorAuth(
 		options: EnableTwoFactorAuthInput!
 	): EnableTwoFactorAuthResponse
-	disableTwoFactorAuth: Boolean
+	disableTwoFactorAuth(method: String!): Boolean
 	messageAction(ids: [ID!]!, op: String!): Boolean
 	modifyExternalAccount(
 		id: ID!
@@ -3667,6 +3817,9 @@ type Mutation {
 	sendDeliveryReport(messageId: ID!): Boolean
 	sendInviteReply(inviteReply: InviteReplyInput!): InviteReplyResponse
 	sendShareNotification(shareNotification: ShareNotificationInput!): Boolean
+	sendTwoFactorAuthCode(
+		options: SendTwoFactorAuthCodeInput!
+	): SendTwoFactorAuthCodeResponse
 	setCustomMetadata(customMetaData: CustomMetadataInput!): Boolean
 	setMailboxMetadata(
 		section: String
@@ -3691,6 +3844,8 @@ type Mutation {
 	cancelPendingAccountOnlyRemoteWipeSync(deviceId: String): Device
 	remoteWipeSync(deviceId: String): Device
 	cancelPendingRemoteWipeSync(deviceId: String): Device
+	subscribeDistributionList(op: String!, by: String, dl: String!): String
+	distributionListAction(dlActions: DistributionListActionInput!): Boolean
 }
 
 schema {

package/dist/src/apollo/types.d.ts

@@ -4,3 +4,11 @@ export interface LocalBatchLinkOptions extends BatchLink.Options {
     context?: any;
     schema: GraphQLSchema;
 }
+export interface EmailAddress {
+    __typename?: 'EmailAddress';
+    address?: string;
+    displayName?: string;
+    isGroup?: boolean | null;
+    name?: string;
+    type?: string;
+}

package/dist/src/batch-client/index.d.ts

@@ -1,5 +1,5 @@
 import { JsonRequestOptions } from '../request/types';
-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';
+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';
 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';
 import { Notifier } from './notifier';
 export declare class ZimbraBatchClient {
@@ -54,9 +54,10 @@ export declare class ZimbraBatchClient {
     deleteExternalAccount: ({ id }: ExternalAccountDeleteInput) => Promise<boolean>;
     deleteIdentity: (identity: DeleteIdentityInput) => Promise<boolean>;
     deleteSignature: (options: SignatureInput) => Promise<boolean>;
-    disableTwoFactorAuth: () => Promise<boolean>;
+    disableTwoFactorAuth: (method: string) => Promise<boolean>;
     discoverRights: ({ right }: DiscoverRightOptions) => Promise<any>;
     dismissCalendarItem: (appointment: any, task: any) => Promise<boolean>;
+    distributionListAction: ({ action, dl }: DistributionListActionInput) => Promise<boolean>;
     documentAction: (options: ActionOptions) => Promise<any>;
     documentActionResponse: (type: ActionType, options: ActionOptions) => Promise<any>;
     downloadAttachment: ({ id, part }: any) => Promise<{
@@ -72,7 +73,7 @@ export declare class ZimbraBatchClient {
         content: any;
         isSecure: any;
     }>;
-    enableTwoFactorAuth: ({ name, password, authToken, twoFactorCode, csrfTokenSecured, ignoreSameSite }: EnableTwoFactorAuthInput) => Promise<any>;
+    enableTwoFactorAuth: ({ name, email, method, password, authToken, twoFactorCode, csrfTokenSecured, ignoreSameSite }: EnableTwoFactorAuthInput) => Promise<any>;
     endSessionBeaconRequest: (options: JsonRequestOptions) => void;
     folderAction: (options: ActionOptions) => Promise<boolean>;
     forwardAppointment: (body: ForwardAppointmentInput) => Promise<boolean>;
@@ -93,6 +94,7 @@ export declare class ZimbraBatchClient {
     getCustomMetadata: ({ id, section }: GetCustomMetadataOptions) => Promise<{}>;
     getDataSources: () => Promise<{}>;
     getDeviceStatus: () => Promise<any>;
+    getDistributionList: (dl: String, needOwners: Boolean, needRights: String, by: String) => Promise<any>;
     getDistributionListMembers: (limit: String, offset: String, dl: String) => Promise<any>;
     getDocumentShareURL: (options: GetDocumentShareURLOptions) => Promise<any>;
     getFilterRules: () => Promise<any>;
@@ -127,7 +129,7 @@ export declare class ZimbraBatchClient {
     itemAction: (options: ActionOptions) => Promise<boolean>;
     jsonRequest: (options: JsonRequestOptions) => Promise<any>;
     listDocumentRevisions: ({ id, version, count }: any) => Promise<any>;
-    login: ({ username, password, recoveryCode, tokenType, persistAuthTokenCookie, twoFactorCode, deviceTrusted, csrfTokenSecured, ignoreSameSite }: LoginOptions) => Promise<{}>;
+    login: ({ username, password, recoveryCode, tokenType, persistAuthTokenCookie, twoFactorCode, deviceTrusted, csrfTokenSecured, ignoreSameSite }: LoginOptions) => Promise<any>;
     logout: () => Promise<boolean>;
     messageAction: (options: ActionOptions) => Promise<boolean>;
     modifyAppointment: (accountName: string, appointment: CalendarItemInput) => Promise<any>;
@@ -170,6 +172,7 @@ export declare class ZimbraBatchClient {
     sendInviteReply: (requestOptions: InviteReplyInput) => Promise<any>;
     sendMessage: (message: SendMessageInput, accountName: string, sign: Boolean, encrypt: Boolean) => Promise<any>;
     sendShareNotification: (body: ShareNotificationInput) => Promise<boolean>;
+    sendTwoFactorAuthCode: ({ action, authToken }: SendTwoFactorAuthCodeInput) => Promise<any>;
     setCsrfToken: (csrfToken: string) => void;
     setCustomMetadata: (variables: any) => Promise<boolean>;
     setJwtToken: (jwtToken: string) => void;
@@ -177,6 +180,7 @@ export declare class ZimbraBatchClient {
     setUserAgent: (userAgent: Object) => void;
     shareInfo: (options: ShareInfoOptions) => Promise<any>;
     snoozeCalendarItem: (appointment: any, task: any) => Promise<boolean>;
+    subscribeDistributionList: (op: String, by: String, dl: String) => Promise<any>;
     taskFolders: () => Promise<any>;
     testExternalAccount: ({ accountType, ...accountInfo }: ExternalAccountTestInput) => Promise<{}>;
     uploadMessage: (message: string) => any;

package/dist/src/normalize/entities.d.ts

@@ -61,3 +61,5 @@ export declare const ZimletConfigHostEntity: Entity;
 export declare const ZimletConfigEntity: Entity;
 export declare const ActionData: Entity;
 export declare const DocumentActionData: Entity;
+export declare const DLActionAttrEntity: Entity;
+export declare const DLActionEntity: Entity;