@zimbra/api-client 103.0.0 → 103.0.1-PREAPPS-8281.27b2a1a.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.
@@ -1670,6 +1670,7 @@ type Preferences {
1670
1670
  zimbraPrefComposeDirection: String
1671
1671
  zimbraPrefComposeFormat: Mode
1672
1672
  zimbraPrefForwardReplyInOriginalFormat: Boolean
1673
+ zimbraPrefMandatorySpellCheckEnabled: Boolean
1673
1674
  zimbraPrefHtmlEditorDefaultFontColor: String
1674
1675
  zimbraPrefHtmlEditorDefaultFontFamily: String
1675
1676
  zimbraPrefHtmlEditorDefaultFontSize: String
@@ -2764,6 +2765,7 @@ input PreferencesInput {
2764
2765
  zimbraPrefComposeDirection: String
2765
2766
  zimbraPrefComposeFormat: Mode
2766
2767
  zimbraPrefForwardReplyInOriginalFormat: Boolean
2768
+ zimbraPrefMandatorySpellCheckEnabled: Boolean
2767
2769
  zimbraPrefExternalSendersType: ExternalSendersType
2768
2770
  zimbraPrefHtmlEditorDefaultFontColor: String
2769
2771
  zimbraPrefHtmlEditorDefaultFontFamily: String
@@ -3531,6 +3533,16 @@ input DiscoverRightInput {
3531
3533
  _content: String
3532
3534
  }
3533
3535
 
3536
+ type Misspelling {
3537
+ word: String
3538
+ suggestions: [String]
3539
+ }
3540
+
3541
+ type CheckSpellingResponse {
3542
+ available: Boolean
3543
+ misspelled: [Misspelling]
3544
+ }
3545
+
3534
3546
  # Zimbra GraphQL Queries
3535
3547
  # - [[SOAP API Reference]](https://files.zimbra.com/docs/soap_api/8.7.11/api-reference/index.html)
3536
3548
  # - [[SOAP Documentation]](https://github.com/Zimbra/zm-mailbox/blob/develop/store/docs/soap.txt)
@@ -3724,6 +3736,11 @@ type Query {
3724
3736
  taskFolders: [Folder]
3725
3737
 
3726
3738
  getTag: [Tag]
3739
+
3740
+ checkSpelling(
3741
+ text: String!
3742
+ ignore: [String]
3743
+ ): CheckSpellingResponse
3727
3744
  }
3728
3745
 
3729
3746
  type Mutation {
@@ -3937,6 +3954,7 @@ type Mutation {
3937
3954
  subscribeDistributionList(op: String!, by: String, dl: String!): String
3938
3955
  distributionListAction(dlActions: DistributionListActionInput!): Boolean
3939
3956
  bounceMessage(message: RedirectMessgeInput): Boolean
3957
+ addToSpellCheckDictionary(word: String): Boolean
3940
3958
  }
3941
3959
 
3942
3960
  schema {
@@ -1,6 +1,6 @@
1
1
  import { JsonRequestOptions } from '../request/types';
2
2
  import { ActionOpResponse, 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, RedirectMessgeInput, RevokeRightsInput, SaveSMimeCertInputUpload, SearchFolderInput, SendMessageInput, SendTwoFactorAuthCodeInput, ShareNotificationInput, SignatureInput, WhiteBlackListInput, ZimletPreferenceInput } from '../schema/generated-schema-types';
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';
3
+ import { ActionOptions, ActionType, ApplyFilterRulesOptions, AppointmentOptions, AutoCompleteGALOptions, AutoCompleteOptions, ChangePasswordOptions, CheckSpellingOptions, 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 {
6
6
  localStoreClient: any;
@@ -188,6 +188,11 @@ export declare class ZimbraBatchClient {
188
188
  taskFolders: () => Promise<any>;
189
189
  testExternalAccount: ({ accountType, ...accountInfo }: ExternalAccountTestInput) => Promise<{}>;
190
190
  uploadMessage: (message: string) => any;
191
+ checkSpelling: ({ text, ignore }: CheckSpellingOptions) => Promise<{
192
+ available: any;
193
+ misspelled: any;
194
+ }>;
195
+ addToSpellCheckDictionary: (word: string) => Promise<boolean>;
191
196
  private batchDataHandler;
192
197
  private checkAndUpdateSessionId;
193
198
  private dataHandler;
@@ -317,3 +317,11 @@ export interface DiscoverRightInput {
317
317
  export interface DiscoverRightOptions {
318
318
  right: Array<DiscoverRightInput>;
319
319
  }
320
+ export interface CheckSpellingOptions {
321
+ text: string;
322
+ ignore: Array<string>;
323
+ }
324
+ export interface Misspelled {
325
+ word: string;
326
+ suggestions: string;
327
+ }
@@ -788,6 +788,11 @@ export type CancelRuleInfo = {
788
788
  ridZ?: Maybe<Scalars['String']['output']>;
789
789
  tz?: Maybe<Scalars['String']['output']>;
790
790
  };
791
+ export type CheckSpellingResponse = {
792
+ __typename?: 'CheckSpellingResponse';
793
+ available?: Maybe<Scalars['Boolean']['output']>;
794
+ misspelled?: Maybe<Array<Maybe<Misspelling>>>;
795
+ };
791
796
  export type ClientInfoAttributes = {
792
797
  __typename?: 'ClientInfoAttributes';
793
798
  zimbraClassicWebClientDisabled?: Maybe<Scalars['Boolean']['output']>;
@@ -2356,6 +2361,11 @@ export type MimePartInput = {
2356
2361
  truncated?: InputMaybe<Scalars['Boolean']['input']>;
2357
2362
  url?: InputMaybe<Scalars['String']['input']>;
2358
2363
  };
2364
+ export type Misspelling = {
2365
+ __typename?: 'Misspelling';
2366
+ suggestions?: Maybe<Array<Maybe<Scalars['String']['output']>>>;
2367
+ word?: Maybe<Scalars['String']['output']>;
2368
+ };
2359
2369
  export declare enum Mode {
2360
2370
  Html = "html",
2361
2371
  Text = "text"
@@ -2419,6 +2429,7 @@ export type Mutation = {
2419
2429
  action?: Maybe<Scalars['Boolean']['output']>;
2420
2430
  addExternalAccount?: Maybe<Scalars['ID']['output']>;
2421
2431
  addMessage?: Maybe<MessageInfo>;
2432
+ addToSpellCheckDictionary?: Maybe<Scalars['Boolean']['output']>;
2422
2433
  allowDeviceSync?: Maybe<Device>;
2423
2434
  applyFilterRules?: Maybe<Array<Maybe<Scalars['String']['output']>>>;
2424
2435
  blockDeviceSync?: Maybe<Device>;
@@ -2539,6 +2550,9 @@ export type MutationAddExternalAccountArgs = {
2539
2550
  export type MutationAddMessageArgs = {
2540
2551
  message: AddMsgInput;
2541
2552
  };
2553
+ export type MutationAddToSpellCheckDictionaryArgs = {
2554
+ word?: InputMaybe<Scalars['String']['input']>;
2555
+ };
2542
2556
  export type MutationAllowDeviceSyncArgs = {
2543
2557
  deviceId?: InputMaybe<Scalars['String']['input']>;
2544
2558
  };
@@ -3060,6 +3074,7 @@ export type Preferences = {
3060
3074
  zimbraPrefMailSendReadReceipts?: Maybe<PrefMailSendReadReceipts>;
3061
3075
  zimbraPrefMailToasterEnabled?: Maybe<Scalars['Boolean']['output']>;
3062
3076
  zimbraPrefMailTrustedSenderList?: Maybe<Array<Maybe<Scalars['String']['output']>>>;
3077
+ zimbraPrefMandatorySpellCheckEnabled?: Maybe<Scalars['Boolean']['output']>;
3063
3078
  zimbraPrefMarkMsgRead?: Maybe<Scalars['Int']['output']>;
3064
3079
  zimbraPrefMessageViewHtmlPreferred?: Maybe<Scalars['Boolean']['output']>;
3065
3080
  zimbraPrefOutOfOfficeExternalReply?: Maybe<Scalars['String']['output']>;
@@ -3132,6 +3147,7 @@ export type PreferencesInput = {
3132
3147
  zimbraPrefMailSendReadReceipts?: InputMaybe<PrefMailSendReadReceipts>;
3133
3148
  zimbraPrefMailToasterEnabled?: InputMaybe<Scalars['Boolean']['input']>;
3134
3149
  zimbraPrefMailTrustedSenderList?: InputMaybe<Array<InputMaybe<Scalars['String']['input']>>>;
3150
+ zimbraPrefMandatorySpellCheckEnabled?: InputMaybe<Scalars['Boolean']['input']>;
3135
3151
  zimbraPrefMarkMsgRead?: InputMaybe<Scalars['Int']['input']>;
3136
3152
  zimbraPrefMessageViewHtmlPreferred?: InputMaybe<Scalars['Boolean']['input']>;
3137
3153
  zimbraPrefOutOfOfficeExternalReply?: InputMaybe<Scalars['String']['input']>;
@@ -3190,6 +3206,7 @@ export type Query = {
3190
3206
  accountInfo?: Maybe<AccountInfo>;
3191
3207
  autoComplete?: Maybe<AutoCompleteResponse>;
3192
3208
  autoCompleteGAL?: Maybe<AutoCompleteGalResponse>;
3209
+ checkSpelling?: Maybe<CheckSpellingResponse>;
3193
3210
  clientInfo?: Maybe<ClientInfoType>;
3194
3211
  discoverRights?: Maybe<DiscoverRights>;
3195
3212
  downloadAttachment?: Maybe<Attachment>;
@@ -3255,6 +3272,10 @@ export type QueryAutoCompleteGalArgs = {
3255
3272
  needExp?: InputMaybe<Scalars['Boolean']['input']>;
3256
3273
  type?: InputMaybe<GalSearchType>;
3257
3274
  };
3275
+ export type QueryCheckSpellingArgs = {
3276
+ ignore?: InputMaybe<Array<InputMaybe<Scalars['String']['input']>>>;
3277
+ text: Scalars['String']['input'];
3278
+ };
3258
3279
  export type QueryClientInfoArgs = {
3259
3280
  by?: InputMaybe<Scalars['String']['input']>;
3260
3281
  domain?: InputMaybe<Scalars['String']['input']>;